System variables

For the SuperOffice Analyze package you have a selection of system variabel which should and can be change for better performance and use of your solution.

You access system variabeles from:

System Administration -> System -> Variables.

All SuperOffice Analyze related variables are in the SO Editon group. You should spend some time looking through all of them.

Note! For a new installation, variables marked as this, MUST always be considdered carefully.

 

System variable

Purpose

access_group

Select the groups that should always be accessible. Access granted here is added to the privileges already granted through access_mode.

Data from user's own primary group will always be accessible unless access_mode is set to Private.

Use the system variables build in capability to be set system wide, for an organizaton, for a user group or for a single user. Using a combination is often very effective.

Possible values:
list of user groups in SuperOffice (multiple select).

Default: none

access_group_available

The groups selected here represent all groups that are possible to observe. This setting overrides all other access settings. If the users primary group isn't listed here the user will not see data belonging to users from that group - not even his own data.

PS! This mecanisme is only active when one or more groups other than DISABLED have been selected.

Data tables implementing the ba_asc4 or ba_grp4 access control functions are affected. All data tables in the SuperOffice Analyze package are therefore affected.

Possible values:
list of user groups in SuperOffice (multiple select).

Default: Diabled

access_group_exclude

Data belonging to associates that have primary membership to these groups will not be visible.

This setting overrides the settings in access_group, meaning that if the same group is contributed by both access_group and access_group_exclude it will be excluded because access_group_exclude takes priority.

The users own primary group will always be accessible unless access_mode is set to Private.

Possible values:
list of user groups in SuperOffice (multiple select).

Default: Disabled

access_mode
Must always be set for new installations!

Set access mode based on group membership.

PS! The privileges granted by access_group come in addition to privileges granted here.

Possible values:
0 = Open, user can see everything, no access filtering is applied.
1 = Restricted, user can see data belonging to any associate that has membership in any group he is a member of.
2 = Tight, user can only see data belonging to associates that are members of his primary group.
3 = Private, user can only see his own data.

These settings are implemented through the table-valued database functions ba_asc4 and ba_grp4. If you need access filtering beyond the standard, then this is where you should start. Better keep your tongue straight - You have been warned J

Use the system variables build in capability to be set system wide, for an organizaton, for a user group or for a single user. Using a combination is often very effective.

Default: Private

currency_budget

The system has to be told which currency the budgets are in. This information enables the system to display all sale and budget data in the selected currency runtime.

Possible values:
Any currency selected from the currency table.

Default: Euro

currency_default

This currency is selected as default if the system is unsuccessful in determining the currency based on the currency_preference setting. Ensure that the external system references are populated with the correct values. Also verify the OwnCurrency, Base Currency are correctly configured using the SuperOffice Admin client.
Currency must be enabled in SuperOffice.

Possible values:
list of active currencies in SuperOffice

Default: Euro

currency_preference

When the Currency startup parameter is set to "Users default currency", currency_preference  determines how the system decides what the default currency should be.

That decision can be based on these criteria:

1) OurCurrency
Determines the default currency based on the OwnCurrency preference.

2) BaseCurrency
Determines the default currency based on the BaseCurrency preference.

3) National
Sets the default currency based on the national currency of the user. User is usually given a nationality and each nationality has a currency.

Possible values:
OurCurrencyId|OurCurrency
BaseCurrencyId|BaseCurrency
National|National

Default:
OurCurrency

date_all_endperiod
Must always be set for new installations!
 

Sets the end date when the ALL option is selected in the Sale date parameter in the dSaleBudget data table.
Ensure it’s set to a date a few years into the future.

Possible values:
Any valid date

Default:
2015-12-31

date_all_startperiod
Must always be set for new installations!
 

Same as above but the start date.

Ensure it is set to a date in the past.

Default:
2012-01-01

date_range_limit

Limits the scope of data for the dAppointment and dSale data tables. Only historic data is affected. Often data older than 3-5 years is obsolete. Please consider that the more history you include, the higher the load on the servers, and the longer the response times will be.

Possible values:

-1|Current year
-2|2 years of history
-3|3 years of history
-4|4 years of history
-5|5 years of history
-6|6 years of history
-7|7 years of history
-8|8 years of history
-9|9 years of history
-10|10 years of history
-50|Unlimited

Default:          
4 years of history

display_deleted_elements

Decides whether or not deleted elements in parameter lists are displayed. Note that deleted elements cannot always be ignored in hierarchical parameter lists because of dependencies.

Possible values:
0|No
1|Yes

Default: No

display_in_primary_group_only

This setting affects the behavior of the access filtering mechanism and the Organization hierarchy parameter list.

If enabled, associates are only displayed in their primary group.

If disabled, associates are displayed in the groups they have membership in. If an associate has secondary membership to 5 other groups, he will appear in his primary group and the 5 other groups that he is also member of.

Possible values:
0|No
1|Yes

Default:
Yes

display_org_param_mode_appointment

This setting affects the way data is filtered when using the organization parameter for the APPOINTMENT data table (dAppointment). It can base its filtering on the ASSOCIATE and his current primary group (associate.group_idx). Or it can go directly on the APPOINTMENT table using the column appointment.group_idx.

You should use the same comparable setting as for display_org_param_mode_sale.

Possible values:
a|Associate
app|Appointment

Default:
Associate

display_org_param_mode_sale

This setting affects the way data is filtered when using the organization parameter for the SALE data table (dSale). It can base its filtering on the ASSOCIATE and his current primary group (associate.group_idx). Or it can go directly on the SALE table using the column sale.group_idx.

You should use the same comparable setting as for display_org_param_mode_appointment.

Possible values:
a|Associate
s|Sale

Default:
Associate

im_budget_associate

Must point to the budget sheet where sale data is stored.

Possible values:
Any budget sheet defined in the system.

Default:
SuperOffice budget pr. Associates (id= 90000)

im_budget_associate_activity

Must point to the budget sheet where activity data is stored.

Possible values:
Any budget sheet defined in the system.

Default:
SuperOffice budget pr. associates activity (id= 90001)

invisible_groups

The groups selected will not be visible in the Organization and Group parameters.

Possible values:
Any user group defined in SuperOffice.

Default:
none

solocale

Sets the default language for the solocale() function. It will use this value if none is found in usr6 (fw_user.er6t).

It is used to decode SuperOffice language strings in the format US:"One";NO:"En". The function uses this information to display the appropriate language string.

This column is always populated by the User Sync. If the usr6 isn’t populated then you should consider setting up the user sync. In the PRO edition It can be customized and scheduled to run automatically.

Possible values:
NO|Norwegian
US|USEnglish
SV|Swedish
DA|Danish
NL|Dutch
GE|German
FI|Finnish
CZ|Czech
IT|Italian
PL|Polish
ES|Spanish
FR|French
RU|Russian
JP|Japanese
CN|Chinese

Default:
Norwegian

string_inactive_element

Defines a suffix indicating that the element is no longer active in SuperOffice. It can be a person or a category and several other dimensions.

Default value: *

string_not_available

Defines a string that is displayed when the data for that column/row cannot be retrieved from the database. For example if a contact has no category.

Possible values:
Any character(s)

Default: -

url_web
Must always be set for new installations!

Url using SO protocol for web client. Needs to be set up for your specific installation.

Possible values:
url with substitution tags (free text)

Default: (must be modified)
http://www.soweb.com/soweb/Default.aspx?<dialog>[dialog=stop]?<dialog>_id=<id>

url_windows

Url using SO protocol for windows client. Usually no changes are needed here.

Possible values:
string with substitution tags (free text)

Default:
superoffice:<dialog>.activate?<dialog>_id=<id>

client_type
Must always be set for new installations!

Select whether to use windows client or web client for owl-link integration. The URL will be generated to trigger either the SO-protocol for the Windows client, or use the http-protocol to trigger the web-dialogs in the web-based client. The generated URL's are based on the prototypes from url_windows and url_web.

If you have licenses for both windows and web, you should set it up using this preference.

Possible values:
Windows | Web

Default:
Windows

Must always be set for new installations!

user_import_domain
Must always be set for new installations!

The users name is prefixed with this setting when creating new users during user import. Make sure it contains the correct domain name.
If this setting is incorrect the windows authentication will not work.

The user name is created in this format:  <user_import_domain>\<user name>

This is where the bolded part is set.
 

 

For a complete description of the Customer Service specific system variables click here