User synchronization

Setting up User synchronization (available from v 4.1.2)

 

Make your own adjustments

The basic definition is included in the SuperOffice Analyze package. Once the package is installed you may go to:

1) System Administration -> System -> Import

2) User synchronization  -> Edit -> Settings

3) This dialog allows for many different ways of syncing the users. One rule set is included, but you may create as many as you wish. Press the "Add" button at the bottom of the page to add another rule.

 

 

The dialog: Settings

Groups from the source system
All groups are included unless you select one or more groups. All users having primary group membership in the selected groups are included in that rule.
Press the X next to the groups name to remove it.

Business Analyze groups
In the default setting "Create source group in Business Analyze" a group with the same name as in SuperOffice is created in Business Analyze. If the groups from the source system don't exist, they will be created the first time the synchronization is run.

If you choose to assign the users to a preselected group in Business Analyze, you must first create the group. Go to System Administration -> Organization -> Groups. Press the New button.

Default desktop
Here you may select the default desktop.

Business Analyze licenses
All users need minimum Platform User (fw) to log on.

 

PS!: For Cloud users:

Make sure you click the one named "usSuperOfficeCRM-ONLINE".

 

The dialog: Notification

Select administrators
Select which system administrator that shal receive an email notification. More than one may be selected.
 

Select report types
If Error report is select you will be informed if an error occours.
If Start report is selected you will be informed every time the User synchronization starts.
If End report is select you will be informed every time the User synchronizatino ends.
In a typical production environment End report and Error report is recommended.
Press the Save button to store your settings.

 

Press the Synchronize now link to initiate the User synchronization.

 

 

Automatic scheduling of the User synchronization (requires Analyze PRO)

1) Go to System administration -> Analysis Dashboard -> Data Central.

 

2) Click the Caching tab and check the checkbox to enable caching.

3) Define when and how often you want the User synchronization to occour. The settings in the screenshot above is typical for a production environment - it will execute 0700, 1100 and 1300 hours every business day of the week.
The schedule dialog shown above is flexible and many combinations are possible.

4) Click Save when done.

5) Verify that the excution times are as expected.
Click on execution details to see when the first Synchronization will occour. If no times are displayed it may be because the Business Analyze Data sync service isn't running. Please make sure it's installed and configured correctly. More info

6) If windows authentication is desired, the user name is normally associated with a domain. Go to System Administration -> Variables -> So Edition -> user_import_domain.  By default this setting is empty.
Click the pencil icon, and a new dialog appears that allows you to enter the name of the domain. This feature was introduced in the package released in March 2013. See below.


 

 

How the User synchronization uses External System References

When modifying the standard data tables or creating your own, it is often usefull to access certain references. Let's say you have a column in a data table that should show the logged-on user's sales. To obtain the associate_id of the loggen on user, you could use the scripting engine expression =u(ext1); in the sql statement of the data table. Here are a list of the other values you have access to when using the shipped User synchronization.
And remember, you can always test your scripting engine expressions if you go to System Administration -> Analysis Dashboard -> Scripting Engine expression tester.
This is how the SuperOfficeAnalyze package utilize the user's external references:

Reference #1: User's associate_id
This value may also be accessed runtime through the scripting engine expression =u(ext1);

Reference #2: User's primary group id
This value may also be accessed runtime through the scripting engine expression =u(ext2);

Reference #3: User's person_id
This value may also be accessed runtime through the scripting engine expression =u(ext3);

Reference #6: User's locale preference for interpreting SuperOffice multilanguage strings
This value may also be accessed runtime through the scripting engine expression =u(ext6);

Reference #7: User's ejuser.id (only relevant if user is using Customer Service)
Used to populate the value token setting for "Logged-on user" in the CS Users parameter.
This value may also be accessed runtime through the scripting engine expression =u(ext7);
This reference is not used for Packages made for 7.5 and newer. It uses associate_id instead.

Reference #8: User's ejuser.usergroup (only relevant if user is using Customer Service)
Used to populate the value token setting for "Users's group" in the CS Users parameter.
This value may also be accessed runtime through the scripting engine expression =u(ext8);

Reference #9: User's ejuser.default_category  (only relevant if user is using Customer Service)
Used to populate the value token setting for "User's default category"  in the CS Category parameter. If this value is selected the desktop starts up with the users default category selected.
This value may also be accessed runtime through the scripting engine expression =u(ext9);

You mat access these values for each user. Go to System Administration -> Organization -> Users, and select a user. Click the External system reference to expand the details. After synchronization it should look something like this: