Add/Update Users

Operation Name

Add/Update Users

Function Overview

Adds and updates users on DataSpider BPM.

Adds and updates the users specified in the input data, and outputs the users to the output data that failed to add or update.

Data Model

Table Model 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 the component on the script canvas.

Required settings

Item name	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 the "Edit resource list".
Update users with the same Email	Optional	Not available	Select whether to update, if user(s) with the same name exists.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select the data processing method. [Use script settings]:(default) Applies the setting of mass data processing setup in script property to the adapter. [Disable]: Mass data processing is not performed. [Enable]: Mass data processing is performed.

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="UTF-8" ?>
<table>
  <row>
    <column>Email of a user to add or update/email</column>
    <column>Name of a user to add or update/name</column>
    <column>Email of a user to update/emailToUpdate</column>
    <column>Password of a user to add or update/password</column>
    <column>Organization of a user to add or update/group</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Column name/label	Description	Remarks
row	-	Repeats accordingly to the number of users to add or update.
column	Email of a user to add or update/email	Enter the email address of the user to add or update.	Receives the user information with this value as the key upon updating, and updates the following.
	Name of a user to add or update/name	Enter the name of the user to add or update.	If you enter "null" or empty string upon updating, the information will not be updated.
	Email of a user to update/emailToUpdate	Enter the email address of the user to update.	Does not enter the value upon addition. If you enter "null" or empty string upon updating, the information will not be updated.
	Password of a user to add or update/password	Enter the password of the user to add or update.	If you enter "null" or empty string upon updating, the information will not be updated.
	Organization of a user to add or update/group	Enter the organization of the user to add or update.	If you enter "null" or empty string upon updating, the information will not be updated.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>Email of a user failed to add or update/email</column>
    <column>Name of the user failed to register/update/name</column>
    <column>Email address of the user failed to update/emailToUpdate</column>
    <column>Password of the user failed to register/update/password</column>
    <column>Organization of the user failed to register/update/group</column>
  </row>
  <row>
    :
  </row>
</table>

Element name	Column name/label	Description
Row	-	Repeats accordingly to the number or users failed to add or update.
Column	Email of a user failed to add or update/email	Outputs the email address of the user failed to add or update.
	Name of the user failed to register/update/name	Outputs the name of the user failed to add or update.
	Email address of the user failed to update/emailToUpdate	Outputs the email address of the user failed to update.
	Password of the user failed to add or update/password	Outputs the password of the user failed to add or update.
	Organization of the user failed to add or update/group	Outputs the organization of the user failed to add or update.

Loading Schema on Mapper

Loading schema on Mapper

See "Edit Schema" for any details.

Mass Data Processing

Mass data processing is supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
add_count	Returns the number of users added.	The value defaults to null.
update_count	Returns the number of users updated.	The value defaults to null.
failure_count	Returns the number of users failed to add or update.	The value defaults to null.
message_category	Stores the category of message code corresponding to the occurred error.	Default value is null.
message_code	Stores the code of message code corresponding to the occurred error.	Default value is null.
message_level	Stores the severity of message code corresponding to the occurred error.	Default value is null.
error_type	When an error occurs, its corresponding types of the message code is stored.	The value defaults to null. Error is represented in the format depicted below. Example:"java.io.FileNotFoundException" The message may vary depending on DataSpider Servista version.
error_message	When an error occurs, its corresponding error message is stored.	The value defaults to null. The message may vary depending on DataSpider Servista version.
error_trace	When an error occurs, its corresponding trace information is stored.	The value defaults to null. The message may vary depending on DataSpider Servista version or the client application used.

Specification Limits

An executing user needs to have user management authority.

An add and update process is executed by one line at a time. Therefore, even if error occurs during the process, the data which have been added and updated are reflected.

If an error occurs during the process, outputs the result data of a line that error occurred, and the process will continue.

BASIC authentication is supported and OAuth authentication is not supported.

If you checked DataSpider BPM server's [System Settings]-[SSO (SAML)]-[Disable Password Authentication], only users who have system management authority can connect to DataSpider BPM server.

If you are updating organization, leave from the currently attributed organizations, and newly add to the organizations you prefer.

Main Exceptions

Exception name	Cause	Measure
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 Resources>]	Resource definition selected in [Destination] is not found.	Please check the global resource specified in [Destination].
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify [<Property name>].
AuthenticationException	[Email] or [Password] of the global resource is false.	Please check the global resource settings.