PointFire 2013 v1.0 Installation Guide

PointFire 2013

Multilingual User Interface for SharePoint Server 2013

PointFire 2013 v1.0 Installation Guide

Version: v1.0

Build Date: August 8, 2013

Prepared by:

Address: IceFire Studios Corp.

20 James St. Suite 100A

Ottawa, Ontario, K2P 0T6

Tel: +1 (888) WSS PLUS (North America)

+1 (613) 826 0747 (International)

Email: [email protected]

Web: www.icefire.ca

Support: community.icefire.ca

mailto:[email protected]

http://www.icefire.ca/

http://community.icefire.ca/

Contents Overview.................................................................................................................................... 1

BEFORE YOU START ................................................................................................................... 2

STEP ONE – DOWNLOAD & INSTALL SHAREPOINT LANGUAGE PACKS ....................................... 2

STEP TWO – DOWNLOAD & INSTALL POINTFIRE LANGUAGE PACKS .......................................... 2

STEP THREE – DOWNLOAD & INSTALL POINTFIRE ...................................................................... 3

STEP FOUR – WEB.CONFIG SETTINGS ........................................................................................ 5

STEP FIVE - ACTIVATE POINTFIRE FEATURE .............................................................................. 10

UPGRADING ............................................................................................................................. 10

TROUBLESHOOTING ................................................................................................................. 10

P O I N T F I R E 2 0 1 3 v 1 . 0 I N S T A L L A T I O N G U I D E

Page 1

Overview

This guide will take you through the steps to install a fresh copy of PointFire 2013 v1.0 installation on your SharePoint

2013 Web Front End server or farm.

This guide will assume that you want to use English and French on your English based server installation. If you wish to

use more languages, simply repeat any steps involving languages for each added language.

If you are looking to upgrade a PointFire 2010 v1.0 deployment to PointFire 2013 v1.0, please refer to the PointFire 2010

v1.0 to PointFire 2013 v1.0 Upgrade Guide for instructions.

*Upgrade is not available for beta

If you experience any issues with your upgrade, feel free to contact our support team by submitting a ticket on our

support center @ http://community.icefire.ca



Page 2

BEFORE YOU START You can install the PointFire components on any web front end in the farm. However make sure that the account that is

being used has sufficient permissions to deploy the solution across the farm, including database access. If in doubt,

choose the server on which the Central Administration server is running. Ensure that the SharePoint 2013 Timer service

and Administration service are running. The PowerShell scripts, assemblies and other PointFire components are digitally

signed, and you may have to accept this signature the first time.

STEP ONE – DOWNLOAD & INSTALL SHAREPOINT LANGUAGE PACKS At this point you should download and install the desired SharePoint 2013 language packs.

Notes:

You will need to run the SharePoint Configuration Wizard after each language pack you install.

Language pack installation is in the language of the language pack. If the download and installation take place

with an English interface, then you are installing the English language pack.

You do not need a language pack for the SharePoint base language.

Language packs for SharePoint Foundation are different from those for SharePoint Server etc.

Language Packs have Service Packs.

STEP TWO – DOWNLOAD & INSTALL POINTFIRE LANGUAGE PACKS PointFire 2013 Language packs are available for most languages, and are now optional. They are also compatible with

PointFire 2010 language packs. If you need to use a PointFire 2010 language pack, edit DeployLanguagePack.bat,

updating /14/ to /15/

In PointFire 2013, PointFire language packs are now optional and most of the user interface is translated with internal

language resources. However, coverage of the user interface is more complete when language packs are installed.


Page 3

Next, you will need to download and install the PointFire 2013 Language Packs you plan to use. Uncompress the zip file

and run the “DeployLanguagePack.bat” file to install the language pack. Repeat this step for each language pack.

Language Packs: http://community.icefire.ca/index.php?/Knowledgebase/List/Index/5/pointfire-2013-language-packs

STEP THREE – DOWNLOAD & INSTALL POINTFIRE At this point you want to run the PointFire2013.exe to begin installing PointFire. Follow the on screen instructions.

It is recommended that you do this installation on the server that has Central Administration.

Download: http://community.icefire.ca/index.php?/Knowledgebase/List/Index/18/pointfire-2013

http://community.icefire.ca/index.php?/Knowledgebase/List/Index/5/pointfire-2010-language-packs

http://community.icefire.ca/index.php?/Knowledgebase/List/Index/18/pointfire-2013


Page 4

Once completed you have the option to run the deployment script and to view the readme. You should ensure you run

the deployment script. Check the readme file for details about the current version’s deployment options and scripts.


Page 5

There are currently three options for deployment:

1) Use the PointFire Deployment Manager (PFConfig)

This is the simplest solution in most cases. It will let you edit the configuration and deploy the solution and

configuration across the farm to selected web applications. See details below.

2) Use the install.bat PowerShell installation

This batch file launches a PowerShell script that will deploy PointFire on all web applications. You can edit this

script to suit your needs. Please note that it is a signed script and any modification will invalidate the code

signature and may require different PowerShell execution policies to run.

3) Use the ists.bat STS installation

If you’re accustomed to the old STSADM method of adding and deploying solutions, this batch file is available

and can also be modified.

STEP FOUR – WEB.CONFIG SETTINGS The PointFire Deployment Manager (PFConfig, formerly known as PointFire Configuration Manager) will automatically

make required changes to configurations, let you adjust the application settings, and then let you deploy the solution

and settings that you want across the farm. In particular, you need to check that the list of languages is the one that you

want, and you need to determine whether to allow site settings to override application settings. PFConfig also has the

option to upgrade or retract an existing PointFire solution. It automatically detects whether the solution is already


Page 6

deployed, whether it requires an upgrade, and whether the required administration and timer services are running.

If in the future you wish to change these application settings, use the PFConfig tool to retract the PointFire solution, and

then use it again to change the configuration keys and redeploy the solution. None of your content nor site-specific

settings should change when the solution is retracted and redeployed, but the application-level settings will be the ones

that you set. PFConfig provides a graphical interface for setting PointFire configuration keys that will be deployed across

the farm. Alternatively, you can change the values of the configuration keys that will be deployed by editing the file

named “configkeys.xml” in the PointFire 2013 directory.


Page 7

The value of PFLicence is treated differently if there are multiple keys. Licensing requires on key per web front end. In

the past, entering different PFlicence keys for different web front ends required manual editing of web.config files. This

is no longer the case. You must now enter all of your licence keys, separated by a semicolon character and no spaces, in

the order in which they were issued to you when using the Deployment Manager. However the web.config files on all

WFEs will now show the final licence key of the group and this should not be edited. The web.config file will be identical

on all the web front ends of the same application.

Please note that the PFConfig Deployment tool sometimes does but does not necessarily remember what settings were

used previously. When you use it, note down the previous versions of the keys, either from the appropriate web.config

file prior to retraction, or from the PFInstall-xxxx.txt files that are placed in the PointFire 2013 directory. These files also

record whether any of your configuration keys were invalid and disregarded, and other information about deployment.

Note: PFConfig will override any changes to settings that you may have made directly by editing web.config files,

including licence keys.


Page 8

When initially run, PFConfig will only provide the option to deploy PointFire. You will be given the option of which

applications on your farm to deploy it to. On subsequent runs, the option to retract or upgrade PointFire will be given

depending on what version is already installed.

If you are not using PFConfig, you will need to make the following web.config modifications.

1. Add the PointFire module to the “modules” node just before the closing tag:

<add name="PointFire2013" type="PointFire2013.PFHttpModule, PointFire2013, Version=1.0.0.0, Culture=neutral, PublicKeyToken=aa723fd590a9b1d4" />

2. Add PointFire Configuration keys to the appSettings section before the end appSettings tag:


Page 9

The following set of keys indicates the recommended settings, but you should learn what each does and set them according to your requirements: <add key="PFAllowAllListMUI" value="TRUE" /> <add key="PFAutoAddTransList" value="TRUE" /> <add key="PFAutoUpgradeFilter" value="FALSE" /> <add key="PFCustomTopLevelSite" value="" /> <add key="PFEnableDebugLog" value="TRUE" /> <add key="PFEnableDST" value="FALSE" /> <add key="PFEnableErrorLog" value="TRUE" /> <add key="PFEnableSiteSettings" value="TRUE" /> <add key="PFEnableSourceTranslation" value="FALSE" /> <add key="PFEnableWebLog" value="TRUE" /> <add key="PFEscapeHandling" value="TRUE" /> <add key="PFExcludedPaths" value="login.aspx;" /> <add key="PFFilterDefault" value="ON" /> <add key="PFForcePageView" value="FALSE" /> <add key="PFHideFilterControl" value="FALSE" /> <add key="PFHideListItemMenus" value="FALSE" /> <add key="PFHideListSettingsMenus" value="FALSE" /> <add key="PFHidePersonalMenus" value="FALSE" /> <add key="PFHidePointFireLists" value="FALSE" /> <add key="PFHideSiteActionsMenus" value="FALSE" /> <add key="PFHtmlStrictMode" value="TRUE" /> <add key="PFItemLanguageRequired" value="TRUE" /> <add key="PFLanguageCookieDomain" value="" /> <add key="PFLanguageCookieExpires" value="30" /> <add key="PFLanguageCookiePath" value="" /> <add key="PFLanguageCookieSecure" value="FALSE" /> <add key="PFLanguageCookieAggressive" value="TRUE" /> <add key="PFLanguages" value="1033;1036" /> <add key="PFLicense" value="" /> <add key="PFOutputCacheCompatibility" value="TRUE" /> <add key="PFSDKCompatibility" value="FALSE" /> <add key="PFTranslateMetadata" value="TRUE" /> <add key="PFTranslateListBoxes" value="TRUE" /> <add key="PFTranslateWebPart" value="ALL" /> <add key="PFTranslateWikiContent" value="TRUE" /> <add key="PFXMLNodes" value=" " /> <add key="PFXMLAttributes" value=" " />


Page 10

STEP FIVE - ACTIVATE POINTFIRE FEATURE If the feature is not already activated on your site(s), ensure you do so now from the Site Features section of the Site

Settings page.

UPGRADING There are currently two options for upgrading from an earlier release of PointFire 2013 v1.0:

1) Use the PointFire Deployment Manager (PFConfig)

This is the simplest solution in most cases. It will let you detect whether your version of PointFire requires

upgrading, then let you update the solution across the farm. If your license is expired, it may prompt you for a

current license before upgrading.

2) Use the upgrade.bat PowerShell upgrading script

This batch file launches a PowerShell script that will update the PointFire solution on the farm. You can edit this

script to suit your needs.

For upgrading from PointFire 2010, see the PointFire 2010 v1.0 to PointFire 2013 Upgrade Guide.

TROUBLESHOOTING If you are experiencing issues getting PointFire functioning correctly, please look to the following troubleshooting tips.

1. PointFire menus appear but no content translates when changing language.

a. In this case the PointFire httpModule from Step Four is likely missing from the “modules” section of the

web.config.

b. This could also be caused by having missing SharePoint or PointFire language packs. Please ensure you

have each language pack you intend to support for each product installed.

2. When clicking PointFire related menus nothing happens or a JavaScript error is triggered.

a. In this case the PointFire httpModule from Step Four is likely missing from the “modules” section of the

web.config.

3. I’ve installed language packs but the language is not shown in the Language Choice menu.

a. You may be missing the value from your web.config or have not set the multilingual site settings to TRUE

for the language you are missing.

b. You may also need to activate the Language in SharePoint from the “Language settings” page found in

Site Settings. This should be done automatically by PointFire, but if you did not specify the language in

web.config and/or site settings this may not occur..


Page 11

If you are experiencing any issues with your upgrade, please submit a ticket on our site: http://community.icefire.ca.

For further information about using PointFire 2013 v1.0, please refer to the PointFire 2013 v1.0 User Guide.

For further information about PointFire 2013 v1.0 Administration, please refer to the PointFire 2013 v1.0

Administrators Guide.


Documents

PointFire 2013 v1.0 Installation Guide