Show/Hide Toolbars

 PhraseExpander 5 Manual

Navigation: Reference > Company Deployment

Company deployment

Scroll Prev Top Next More

If you are deploying PhraseExpander on many computers in an organization, you can share the same settings on all machines by using the PhraseExpander static configuration file.

 

Create a file called PhraseExpander.exe.config and place it in the same folder where PhraseExpander is installed.

 

To create the configuration file

1.Open Notepad

2.Copy and paste the sample configuration file below

3.Customize the settings as shown in the table below

4.Save the file as PhraseExpander.exe.config

5.Copy the created configuration file in the installation folder

 

Here's a sample of the PhraseExpander.exe.config configuration file (to copy in the installation folder):

 

<?xml version="1.0"?>

<configuration>

   <appSettings>

    <add key="SettingsFolder" value="d:\userprofiles\%USERNAME%\PhraseExpander\SettingsFolder"/>

    <add key="DefaultDb" value="d:\userprofiles\%USERNAME%\PhraseExpander\PhraseExpanderData.pedb"/>

    <add key="AutoupdateLinked" value="readonly"/>

    <add key="PreventGlossaryUnlinkingForReadonlyUsers" value="false"/>

    <add key="PreventCustomEditForReadonlyUsers" value="false"/>

    <add key="SendUsageStats" value="true"/>

    <add key="BackupAutomatic" value="true"/>

    <add key="BackupDeleteOlder" value="true"/>

    <add key="BackupDays" value="10"/>

    <add key="BackupFolder" value="d:\userprofiles\%USERNAME%\PhraseExpander\Backup"/>

    <add key="UseClipboard" value=""/>

    <add key="BlockUpdatesCheck" value="false"/>

    <add key="AllowOnlyInApps" value=""/>

    <add key="HideSplashScreen" value=""/>

    <add key="HideAllNotifications" value=""/>

    <add key="MaxSuggestions" value=""/>

    <add key="ConfirmationKey" value=""/>

    <add key="AutoexportStatsPath" value=""/>

    <add key="ReadabilityGradeThreshold" value=""/>

    <add key="ReadabilityExclusionRegex" value=""/>

  </appSettings>

</configuration>

 

 

Option

Description

SettingsFolder

The folder that contains the PhraseExpander settings. If you set this, all the users logged on the same computer will share the same settings (leave blank for default settings).

DefaultDb

The default DB you want to open every time PhraseExpander starts (leave blank for default settings). If the file doesn't exist, PhraseExpander will try and create a new one.

AutoupdateLinked

(enterprise only)

 

Automatically updates linked glossaries when there are remote changes. If the setting is configured here, users will not be able to change it (leave blank for default settings, the user will be able to customize it).

 

The available settings are

true: the glossary will be updated only if it doesn't contain local changes

force: the glossary will be updated with the remote version even if it contains local changes (local changes will be lost)

readonly (enterprise only): only the glossaries with read-only access with be automatically updates. The remote changes will be always applied overriding any local changes

 

NOTE: The update will be executed when the window is minimized.

PreventGlossaryUnlinkingForReadonlyUsers

(enterprise only)

 

If set to true, the user will not be able to unlink from linked read-only glossaries (leave blank for default settings, the user will be able to unlink from read-only glossaries).

PreventCustomEditForReadonlyUsers

(enterprise only)

 

If set to true, the user will not be able to invoke the custom edit in the Input Form for a variable, if the template is contained in a linked read-only glossary (leave blank for default settings, the user will be able to unlink from readonly glossaries).

SendUsageStats

Sends anonymous usage statistics. If you don't want to send any information, set it to false (leave blank for default settings, the user will be able to customize it).

BackupFolder

The folder where backups are stored (leave blank for default settings, the user will be able to customize it).

BackupAutomatic

If set to true, it automatically performs a backup of the PhraseExpander database (leave blank for default settings, the user will be able to customize it).

BackupDeleteOlder

If set to true, PhraseExpander will delete backups that are older than BackupDays days (leave blank for default settings, the user will be able to customize it).

BackupDays

PhraseExpander will keep the backups for the specified number of days (leave blank for default settings, the user will be able to customize it).

UseClipboard

If set to true, PhraseExpander will always use the Clipboard to send the text (leave blank for default settings, the user will be able to customize it).

BlockUpdatesCheck

If set to true, PhraseExpander will never check for updates and the option will be disabled (leave blank or set to false for default settings, the user will be able to customize it).

AllowOnlyInApps

Enter the name of the applications EXE file you want PhraseExpander to be active in, separated by a semicolon. If you set a value here, PhraseExpander will work only in specific application. E.g. winword.exe;excel.exe (if a value is set, the user will not be able to customize it in the Options dialog).

HideSplashScreen

If set to true, PhraseExpander will not display the splash screen when PhraseExpander is started (leave blank for default settings, if a value is set, the user will not be able to customize it in the Options dialog).

HideAllNotifications

If set to true, PhraseExpander will hide all notifications shown in the Notifications section in the General tab in the Options, e.g. when a new abbreviation is triggered, if the application is in the ignore list, etc.. (leave blank for default settings, if a value is set, the user will not be able to customize it in the Options dialog).

MaxSuggestions

Number between 1 and 10: define the maximum number of suggestions that PhraseExpander will display (leave blank for default settings, if a value is set, the user will not be able to customize it in the Options dialog).

ConfirmationKey

Define the default confirmation key (leave blank for default settings, the user will be able to customize it). Allowed values are SHIFT, CTRL, ENTER, SPACE TAB, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, HOME, END

AutoexportStatsPath

(enterprise only)

 

Set the path to automatically export usages stats to a central location. For example \\shrared\PhraseExpander\UsageStats

 

Make sure that the path exists and people have read/write access to it.

 

You can collect the stats for each user here.

 

PhraseExpander will create a new CSV file every day with the following name

YYYYMMdd - usernane - machine name - PhraseExpander usage stats.csv

 

Where:

YYYYMMdd: represents the last day of stats included in the file

username: is the Windows username

machine name: is the name of the machine

 

 

Each file can contain the stats for one or more days, based on the when the previous stats file was previously sent to the server.

ReadabilityGradeThreshold

(enterprise only)

 

Specify a threshold for the readability score. If it's specified, the readability score in the Input Form will be displayed in red (if the score is above the threshold) or in green (if it's below)

ReadabilityExclusionRegex

(enterprise only)

 

If you add a regex expression here, PhraseExpander will exclude the text matched by the regex when calculating the reading score.The excluded text can be shown highlighted (through an option in the Input form)

 

For example, this is the regex you can use to exclude the text between round brackets

 

\([^)]*\)

 

 

NOTE: Make sure that the Regex expression is properly escaped (to be inserted into an attribute of an XML file) or the application will not load

 

 

NOTE: in the SettingsFolder, DefaultDb and BackupFolder, environment variables can be used (e.g. %APPDATA%\PhraseExpander). You can also use the $APP_PATH$ placeholder to refer to the folder from which PhraseExpander is run

 

DEFAULT SETTING: you don't need to set all the parameters in the config file. If you want to leave a setting up to the user, you can remove the key or leave it blank. If the value is set, the user will not be able to modify it.

 

IMPORTANT: you need to ensure that the database file and the settings file is unique for each user. You cannot share a database. To share data you need to use shared glossaries.

 

Created with Help & Manual 7 and styled with Premium Pack Version 3 © by EC Software