Setting up the mapping array for users: mapping-user
This part of the array is used to set up which attributes and columns to synchronize with FormFlow. If an attribute contains more than one item, you need to specify which item to use.
Example:
-
givenName[0]– the value in the key no. zero will be used. -
givenName[1]– the value in the key no. 1. -
givenName[all]– all items will be used.
If the attribute has only one item, this option is of course not needed.
Example for Active Directory
'mapping-user'=>array(
// login name
'LOGIN_USER' => 'sAMAccountName',
/*'PASSWORD_USER' => 'userpassword',*/
//the setting for enabling or disabling the user – for more details, see chapter Enabling or disabling a user.
'ENABLED_USER' => 'userAccountControl',
//expiry setting for the user account. In most cases, this line is commented out
//'EXPIRES_USER' => 'accountExpires',
//immediate superior – for more settings, see Setting up the immediate superior and the global substitute
'PARENT_USER' => 'manager',
//user uid – another ID key for the user. This line is usually not needed
'UID_USER' => 'description',
//global substitute – for more settings, see Setting up the immediate superior and the global substitute
//'GLOBAL_SUBSTITUTE_USER' => 'substitute',
//title before the name
//'PRE_TITLE_USER' => 'title[0]',
//user's name
'FIRST_NAME_USER' => 'givenName',
//user's middle name
'MIDDLE_NAME_USER' => 'initials',
//surname
'SURNAME_USER' => 'sn',
//user's first name
//'BIRTH_NAME_USER' => 'initials',
//title after the name
'POST_TITLE_USER' => 'title[1]',
//user uid – another ID key for the user. This line is usually not needed
'UID_USER' => 'workforceID[0]',
//date of birth
//'BIRTH_DATE_USER' => 'S602Birth',
//user's e-mail address
'EMAIL_USER' => 'mail',
//user's telephone number
'PHONE_USER' => 'telephoneNumber',
//user's mobile phone number
'MOBILE_PHONE_USER' => 'mobile',
//fax number
'FAX_USER' => 'facsimileTelephoneNumber',
//company name
'COMPANY_USER' => 'company',
//job title
'JOB_USER' => 'title',
//department
'DEPARTMENT_USER' => 'department',
//note for the user
'NOTE_USER' => 'description',
//immediate superior – for more settings, see Setting up the immediate superior and the global substitute
'PARENT_USER' => 'manager',
),Enabling or disabling a user: synchro-user-enabled
| Leave this attribute commented out, if you are synchronizing FormFlow with Active Directory! |
This setting determines which value of the loginDisabled attribute will be used for an enabled user and which for a disabled one.
'synchro-user-enabled'=>array(
'ENABLED' => 'FALSE', // enabled user
'DISABLED' => 'TRUE' // disabled user
),The attribute loginDisabled (disable the account) is a standard attribute in Directory. If this item is checked on the tab, the user account is disabled.
You might receive a different attribute for synchronization of enabled and disabled attributes, and it might work the other way around. Set up this attribute in the mapping entry field the following way:
ENABLED_USER ( 'ENABLED_USER' => 'loginAktive', )Then set up synchro-user-enabled.
'synchro-user-enabled'=>array(
'ENABLED' => 'TRUE', // enabled user
'DISABLED' => 'FALSE' // disabled user
),Enabling or disabling users based on expiry: EXPIRES_USER
You will not find this column in the XG_user table and it most cases it is not set. The attribute value specifies whether the account has expired or not. If it has expired, the user will be disabled, even if the ENABLED_USER attribute is set to enabled.
Setting up the immediate superior and the global substitute: synchro-user-mapp-parent-global-to-setting
Specify a value determining the user who is the immediate superior or the global substitute for the user.
'synchro-user-mapp-parent-global-to-setting'=>array(
/*DN_NAME_SUSY, LOGIN_USER, UID_USER*/
'PARENT_USER' => 'DN_NAME_SUSY',
'GLOBAL_SUBSTITUTE_USER' => 'DN_NAME_SUSY'
),If the value of the immediate superior or global substitute is in the following form: cn=Admin,o=Software602
it is a dn name, and therefore you should assign PARENT_USER DN_NAME_SUSY.
If the value is Admin, it is most likely a LOGIN_USER.
Setting up the mapping array for the first synchronization of a user: first-synchro-user
Use this to set up the attributes to synchronize a user who exists in both Directory and FormFlow but has not been synchronized yet.
To synchronize users by e-mail only, simply enter:
'EMAIL_USER' => 'mail'To synchronize users by both e-mail and login, enter the following:
'EMAIL_USER' => 'mail', 'LOGIN_USER' => 'cn'Example:
'first-synchro-user'=>array(
'LOGIN_USER' => 'cn',
),Setting up the mapping array for a user’s home address: mapping-user-address-home
Set up which items to synchronize for a user’s home address.
Example:
'mapping-user-address-home'=>array(
'STREET_UADR' => 'homePostalAddress', // street name
'CITY_UADR' => 'homeCity', // city name
'STATE_UADR' => 'homeState', // state name
'ZIP_CODE_UADR' => 'homeZipCode', // ZIP code
'COUNTRY_UADR' => 'co' // country name
),Setting up the mapping array for a user’s business address: mapping-user-address-business
Set up which items to synchronize for a user’s business address.
Example:
'mapping-user-address-business'=>array(
'STREET_UADR' => 'street', // street name
'CITY_UADR' => 'physicalDeliveryOfficeName',// city name
'STATE_UADR' => 'st', // state name
'ZIP_CODE_UADR' => 'postalCode',// ZIP code
'COUNTRY_UADR' => 'co'// country name
),Setting up the mapping array for deleted users: synchro-user-delete
Set up which item in the whole array to consider if the user is already deleted. If the user is deleted in the Directory, FormFlow will set them as disabled.
We do not recommend changing this item.
Example:
'synchro-user-delete'=>'synchro-user-enabled',Setting up the mapping array for disabled users: synchro-user-enabled-is-attr-emtpy
Set up what value to set in the ENABLED_USER parameter, if this attribute does not exist in the Directory.
If it is set to 0, then all users without this attribute will be set to disabled.
Occasionally, Directory happens to not send the ENABLED_USER (loginDisabled) parameter. In such cases, the parameter from this setting is used.
Example:
'synchro-user-enabled-is-attr-emtpy'=>0,