Add/Update Multiple Users

Operation Name

Function Overview

Adds/updates user based on input data.
Affiliating the data to specified user is also available.

Data Model

XML type.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.
Input data	Required	Not available	Select a component on the script canvas.

Required settings

Item names	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a global resource. For more details on global resource settings, refer to "Global resource properties". [Add]: Adds a new global resource. [Edit list]: Enables to edit the global resource settings in "Edit resource list".
Update row that matches the value of key	Optional	Not available	Search input data of items that [Search key] is selected as criteria, then select whether to update if matching account exists. [Not checked]:(Default) Delivers input data to Mapper without update. [Checked]: Updates input data of items that [Update object] is selected.
Search key/update object	Required	-	Specify the item regarded as search key and the item regarded as update object.
Search key/update object/Search key	Optional	Not available	Select the item regarded as search key. [Checked]: Regards as a search key. [Not checked]:(Default) Not regards as a search key.	Criteria will be a match with corresponding item of input data. If multiple rows are selected, it will be AND criteria.
Search key/update object/update object	Optional	Not available	Select the item regarded as update object. [Checked]: Regards as an update object. [Not checked]:(Default) Not regards as an update object.
Search key/update object/Item name	Required	Not available	Item name(English) will be displayed.
Search key/update object/Item name(Japanese)	Required	Not available	Item name(Japanese) will be displayed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input schema

<?xml version="1.0" encoding="Shift_JIS"?>
<activedirectory>
<user>
  <cn></cn>
  <sn></sn>
  <givenName></givenName>
  <displayName></displayName>
  <userPrincipalName></userPrincipalName>
  <sAMAccountName></sAMAccountName>
  <unicodePwd></unicodePwd>
  <groupNameIncludedMember></groupNameIncludedMember>
  <userAccountControl>
      <passwdNotreqd></passwdNotreqd>
      <dontExpirePassword></dontExpirePassword>
      <encryptedTextPwdAllowed></encryptedTextPwdAllowed>
      <accountDisable></accountDisable>
  </userAccountControl>
  <accountExpires></accountExpires>
  <description></description>
  <physicalDeliveryOfficeName></physicalDeliveryOfficeName>
  <telephoneNumber></telephoneNumber>
  <mail></mail>
  <wWWHomePage></wWWHomePage>
  <c></c>
  <postalCode></postalCode>
  <st></st>
  <l></l>
  <postOfficeBox></postOfficeBox>
  <streetAddress></streetAddress>
  <profilePath></profilePath>
  <scriptPath></scriptPath>
  <homeDirectory></homeDirectory>
  <homePhone></homePhone>
  <pager></pager>
  <mobile></mobile>
  <facsimileTelephoneNumber></facsimileTelephoneNumber>
  <ipPhone></ipPhone>
  <info></info>
  <company></company>
  <department></department>
  <title></title>
</user>
</activedirectory>

Item name	Item name(Japanese)	Remarks
cn	Common name	Common name cannot be updated, therefore it cannot be used as [Update object]. Maximum character string length for settings is 64 characters.
sn	Last name	Maximum character string length for settings during registeration is 29 characters, during update is 64 characters.
givenName	First name	Maximum character string length for settings during registeration is 28 characters, during update is 64 characters.
displayName	Display name	Maximum character string length for settings during registeration is 64 characters, during update is 256 characters.
userPrincipalName	User logon name	Register or update cannot be done with user logon name that already exists. Maximum character string length for settings during registeration is 256 characters, during update is 1015 characters.
sAMAccountName	pre-Windows 2000 logon name	Register or update cannot be done with user logon name(Pre-Windows2000) that already exists. Maximum character string length for settings is 20 characters.
unicodePwd	Password	Password can be omitted during the registration, however it cannot be omitted during update. Maximum character string length for settings is 127 characters. For setting value, it is necessary to meet the requirement for password policy set up in Active Directory.
groupNameIncludedMember	Belonging group name	Specify affiliated group name. If specifying multiple groups, set up by using "," (comma) to separate and enclose it with ""(double quotation). Because "," is used as delimiter, Group name that includes "," cannot be specified. It cannot be used as [Search key].
userAccountControl	Account options	[Search key] and [Update object] cannot be used because they are parent element.
passwdNotreqd	User must change password at next logon	Set up "true" or "false"(Regardless of captital letters/small letters).
dontExpirePassword	Password never expires	Set up "true" or "false"(Regardless of captital letters/small letters).
encryptedTextPwdAllowed	Store password using reversible encryption	Set up "true" or "false"(Regardless of captital letters/small letters).
accountDisable	Account disabled	Set up "true" or "false"(Regardless of captital letters/small letters).
accountExpires	Account expiration date	Format is set up as "yyyy/MM/dd". It cannot be used as [Search key].
description	Description
physicalDeliveryOfficeName	Office
telephoneNumber	Telephone number	Maximum character string length for settings is 64 characters.
mail	E-mail
wWWHomePage	Web page
c	Country/Region	For more detailes on set point, refer to Set point for Countries".
postalCode	Zip/Postal Code	Maximum character string length for settings is 40 characters.
st	State/province
l	City
postOfficeBox	P.O. Box	Maximum character string length for settings is 40 characters.
streetAddress	Street
profilePath	Profile path
scriptPath	Logon script
homeDirectory	Local path	Enter a valid path for "<drive letter>:\<directory>" format.
homePhone	Home telephone	Maximum character string length for settings is 64 characters.
pager	Pager	Maximum character string length for settings is 64 characters.
mobile	Mobile phone	Maximum character string length for settings is 64 characters.
facsimileTelephoneNumber	Fax	Maximum character string length for settings is 64 characters.
ipPhone	IP phone	Maximum character string length for settings is 64 characters.
info	Notes
company	Company	Maximum character string length for settings is 64 characters.
department	Department	Maximum character string length for settings is 64 characters.
title	Title	Maximum character string length for settings is 64 characters.

Output schema

<?xml version="1.0" encoding="Shift_JIS"?>
<activedirectory>
<user>
  <cn></cn>
  <sn></sn>
  <givenName></givenName>
  <displayName></displayName>
  <userPrincipalName></userPrincipalName>
  <sAMAccountName></sAMAccountName>
  <unicodePwd></unicodePwd>
  <groupNameIncludedMember></groupNameIncludedMember>
  <userAccountControl>
      <passwdNotreqd></passwdNotreqd>
      <dontExpirePassword></dontExpirePassword>
      <encryptedTextPwdAllowed></encryptedTextPwdAllowed>
      <accountDisable></accountDisable>
  </userAccountControl>
  <accountExpires></accountExpires>
  <description></description>
  <physicalDeliveryOfficeName></physicalDeliveryOfficeName>
  <telephoneNumber></telephoneNumber>
  <mail></mail>
  <wWWHomePage></wWWHomePage>
  <c></c>
  <postalCode></postalCode>
  <st></st>
  <l></l>
  <postOfficeBox></postOfficeBox>
  <streetAddress></streetAddress>
  <profilePath></profilePath>
  <scriptPath></scriptPath>
  <homeDirectory></homeDirectory>
  <homePhone></homePhone>
  <pager></pager>
  <mobile></mobile>
  <facsimileTelephoneNumber></facsimileTelephoneNumber>
  <ipPhone></ipPhone>
  <info></info>
  <company></company>
  <department></department>
  <title></title>
</user>
</activedirectory>

Item name	Item name(Japanese)	Remarks
cn	Common name
sn	Last name
givenName	First name
displayName	Display name
userPrincipalName	User logon name
sAMAccountName	pre-Windows 2000 logon name
unicodePwd	Password	Due to Active Directory specifications, password information cannot be obatained and it cannot set up.
groupNameIncludedMember	Belonging group name
userAccountControl	Account options	Cannot set up due to parent element.
passwdNotreqd	User must change password at next logon	Set up "true" or "false"(small letter).
dontExpirePassword	Password never expires	Set up "true" or "false"(small letter).
encryptedTextPwdAllowed	Store password using reversible encryption	Set up "true" or "false"(small letter).
accountDisable	Account disabled	Set up "true" or "false"(small letter).
accountExpires	Account expiration date
description	Description
physicalDeliveryOfficeName	Office
telephoneNumber	Telephone number
mail	E-mail
wWWHomePage	Web page
c	Country/Region	For more detailes on set point, refer to Set point for Countries".
postalCode	Zip/Postal Code
st	State/province
l	City
postOfficeBox	P.O. Box
streetAddress	Street
profilePath	Profile path
scriptPath	Logon script
homeDirectory	Local path
homePhone	Home telephone
pager	Pager
mobile	Mobile phone
facsimileTelephoneNumber	Fax
ipPhone	IP phone
info	Notes
company	Company
department	Department
title	Title

Item without attribute will be set up as ""(null characters).
If multiple output information exists, Setting order will be unsettled.

Loading Schema on Mapper

Schema is loaded automatically.

For details, refer to "Edit Schema".

Mass Data Processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
register_count	Stores the number of data that are registered.	Default value is null.
update_count	Stores the number of data that are updated.	Default value is null.
skip_count	Stores the number of data that did not registered/updated.	Default value is null.
message_category	Stores the category of message code corresponding to the occured error.	Default value is null.
message_code	Stores the code of message code corresponding to the occured error.	Default value is null.
message_level	Stores the severity of message code corresponding to the occured error.	Default value is null.
error_type	When an error occurs, the type of error occurred will be stored.	Default value is null. Error is represented in the format depicted below. Example :"java.io.FileNotFoundException" The message may vary depending on the DataSpider Servista version.
error_message	When an error occurs, the message of error occurred will be stored.	Default value is null. The message may vary depending on the DataSpider Servista version.
error_trace	When an error occurs, the trace of error occurred will be stored.	Default value is null. The message may vary depending on the DataSpider Servista version or the client application used.

Content of Process Per Settings

Update row that match value of the key	Search key	Update object	Matched data	Process
No update	Not selected	Not selected/selected	Yes/no	Register all items of input data that have been set
No update	Selected	Not selected/selected	No	Register all items of input data that have been set
No update	Selected	Not selected/selected	Yes	Give input data to Mapper without register/update
Update	Not selected	Not selected/selected	Yes/no	Register all items of input data that have been set
Update	Selected	Not selected	No	Register all items of input data that have been set
Update	Selected	Selected	No	Register all items of input data that have been set
Update	Selected	Selected	Yes	Update items that [Update object] are selected If target inputa data is"", set point will be deleted
Update	Selected	Not selected	Yes	Nothing will update because [Update object] are not selected

If input data corresponding to selected [Search key] is not set up, it will not become search criteria.
Registeration/update process are executed 1 row at a time for process and become definite. Therefore, even if error occurs during the process, previous registeration/update data will still be reflected.

Specification Limits

Account is created by "Users".

If value of cn(Common name) element for input data is not set up, common name will be created and registered from value of sn(Last name), givenName(First name), and displayName(Display name)element as follows.

sn(Last name)	givenName(First name)	displayName(Display name)	Value of a common name
Set up	Set up	Set up/not set up	<value of last name> + " " + <value of first name> (" " is half-width space)
Set up	Not set up	Set up/not set up	<value of last name>
Not set up	Set up	Set up/not set up	<value of fist name>
Not set up	Not set up	Set up	<value of displayed name>

If [User must change password at next logon] and [Password never expires] are specified to register/update, [Password never expires] will be prioritized to set up in Active Directory.

If registered without setting up password, [User must change password at next logon] will be set up at Active Directory.

[User must change password at next logon] cannot update it as not set.
(Specification settings of Active Directory is not relseased)

If multiple accounts corresponding to search criteria exists, all of them will be recognized as update object.

Account can be identified by specifying it in search criteria, since [User logon name(Pre-Windows2000)] is unique attribute in the Active Directory.

If account matching to the search criteria does not have one of the following items, the process will be skipped.
- User logon name
- User logon name(Pre-Windows2000)
When adding user with checked [Include child domain as operation target] in global resource, "jp.synctrust.util.account.context.ContextException" error may occur if an account which matches to the name set in [Common name], [User logon name] or [User logon name(Pre-windows2000)] is registered to the child domain. In this case, uncheck [Include child domain as operation target].

Main Exceptions

Exception name	Cause	Solution
InputDataNotFoundException	[Input data] is not specified.	Specify [Input data] or draw a data flow.
ResourceNotFoundException Resource definition could not be found. Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition could not be found. Name:[<name of global resource>]	Resource definition selected in [Destination] is not found.	Confirm the global resource specified at [Destination].
InvalidPropertyConfigurationException Required items for resource is not speficied.	Required items for resource selected in [Destination] is not specified.	Specify required items for resources.
InvalidPropertyConfigurationException Required items are not specified.	Required items are not specified.	Specify required items.
InvalidPropertyConfigurationException Value of element for common name, last name, first name, and display name is not set up.	Value of all the elements cn(Common name), sn(Last name), givenName(First bane), and displayName(Displayed name) for input data are not set up.	Set up one value for any of common name, last name, first name, displayed name.
InvalidPropertyConfigurationException It exceeds the maximum length.	Input item's character string length exceeds the maximum length.	Enter value of character string length within range of settings.
InvalidPropertyConfigurationException Set point is false. User logon name(Pre-Windows2000)	[User logon name (Pre-Windows2000)] has fallowing characters that cannot be entered. ". , / \ [ ] : ; \| = + * ? < > ""	Enter correct value in [User logon name (Pre-Windows2000)].
InvalidPropertyConfigurationException Set point is false. Account expiration date	Value of [Account expiration date] is false.	Enter "yyyy/MM/dd" format with correct value in [Account expiration date].
InvalidPropertyConfigurationException Set up 10 figures.	Value of [Account expiration date] is not entered with 10 figures.	Enter "yyyy/MM/dd" format with correct value in [Account expiration date].
InvalidPropertyConfigurationException Set point is false. Country	Value of [Country/region] is false.	Enter correct value in [Country/region].
InvalidPropertyConfigurationException Enter with half-width English.	The value of [Country/region] is not entered with half-width english.	Only enter hald-width English in [Country/region].
InvalidPropertyConfigurationException Enter 2 figures.	The value of [Country/region] is not entered with two figures.	Enter only two english hald-width characters in [Country/region].
InvalidPropertyConfigurationException Common name cannot be updated.	Matching account with [Search key] has already been registered and [Common name] us specified as [Update object].	Confirm the content settings.
jp.synctrust.util.account.context.ContextException It cannot register due to the existence of matching account.	Matching account with [Common name], [User logon name] or [User logon name(Pre-Windows2000)] has already been registered.	Confirm the content settings.
java.rmi.UnmarshalException	Certificate is not imported in $DATASPIDER_HOME/jre/lib/security/cacerts.	It is necessary to import certificate in $DATASPIDER_HOME/jre/lib/security/cacerts.