External system references in Business Analyze On-Premise

1 post / 0 new
Erik's picture
External system references in Business Analyze On-Premise

Business Analyze has columns in its internal database that allows it to integrate into other systems. In the SuperOffice Analyze package this is used extensively, and allows Business Analyze to know certain important facts about the SuperOffice user.
When the included User sync is used, it populates the external reference columns in a certain way that is essential for system to work as intended. See http://services.businessanalyze.com/community/node/77 for more details on that subject.
If you intend to use the external reference fields for further system integration, perhaps into other systems, you need to know which fields are available. And it doesn't hurt to know how the predefined fields are used either.
You can always easily see the details for any specific user if you go to System administration -> Organization -> Users and select a user. See screen shot below:

You can find these values in the "SuperOffice Analyze System" --> "User Sync. Data" dashboard.
Associate Id (Usr1t) = Reference #1
Primary Group Id (Usr2t) = Reference #2
Person Id (Usr3t) = Reference #3
Language (Usr6t) = Reference #6
Usr7t = Reference #7
Usr8t = Reference #8
Usr9t = Reference #9

The fields and their purpose:


#1 Associate id (required by SuperOffice Analyze & Customer Service packages)
Used to identify a superoffice user. Is the primary key in the associate table in the SuperOffice database.
This information is used by the SuperOffice Analyze package when filtering access rights. For further details go to http://services.businessanalyze.com/community/node/33 and http://services.businessanalyze.com/community/node/12

#2 Primary user group id (required by SuperOffice Analyze package)
Used track the users primary group id. In SuperOffice a user can be member of many groups but he may only have one primary group membership. This information is used by the SuperOffice Analyze package when filtering access rights.

#3 Person id (Optional)
Contains the person_id from the person table in the SuperOffice database. Was used in earlier version of the package to have easy access to this info in data tables, so no additional joins where required in certain scenarios. It is no longer required by the standard package, but is included for compatibility reasons.

# 6 Locale (required by SuperOffice Analyze package)
The SuperOffice Analyze package has built in functions to decode SuperOffice multi language string that may be used in certain columns in the SuperOffice database. The information provided here tells the function which language to display for the user. The language is obtained from the abbrev2 column in the country table. Change the SQL statement in the usSuperOfficeCRM data table, used by the User sync, if you have other ways of obtaining this setting. For further details about User sync go to http://services.businessanalyze.com/community/node/142

#7 Ejuser id (required by Customer Service package)
Used to identify the Customer service user. Enables the CS User parameter to implement the "Logged-on user" setting.

#8 Hierarchy id (required by Customer Service package)
Contains the value from the usergroup column in the ejuser table. Enables the parameter CS Users to implement "User's group" setting. See screenshot below:

#9 Default category id (required by Customer Service package)
Used to automatically set the correct value for the "User's default category" selection in the CS category parameter. See screen shot below.

If you need to make changes to the User sync data table definition, the columns are clearly named according to function. The relevant columns are named Usr<n>t. Where n is number from 1 to 10. See partial column extract from the usSuperOfficeCRM data table below:

External reference columns can be very useful to refer in data table definition, parameter definitions, dval expressions, drill down conditions and other places in dashboard development. See http://services.businessanalyze.com/community/node/149 for complete reference on tags related to the user. For complete reference of all scripting engine tags go to http://services.businessanalyze.com/community/node/141