Find Users

Operation Name

Find Users

Function Overview

Finds users on DataSpider BPM.

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.  
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".
  
Search string Optional Available Input a part of the name or email address of the user you want to search.
  • If you omit to input, it will search from all of users.
Organization Optional Available Inputs organization that user you are searching for is allocated.
  • If omitting input, It will search users from all of organizations
Search Setting
Item name Required/Optional Use of variables Description Remarks
Page size Optional Available Inputs the number of users that you want to acquire within a single request.
  • Default value is "1000", if you omit than value will be set up as "1000".
  • In case of input values other than numerical value, it will be set up as default value.
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

None.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>ID of the searched user</column>
    <column>Name of the searched user</column>
    <column>Email of the searched user</column>
  </row>
  <row>
    :
  </row>
</table>

Loading Schema on Mapper

Schema will be loaded automatically.
For more detail, refer to "Edit schema".

Mass Data Processing

Mass data processing is supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
count Returns the number of searched users.
  • Default value is 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, the class of error will be stored.
  • Default value is null.
  • Class of error is in following format.
    Example: "java.io.FileNotFoundException"
  • Depending on version for the DataSpider Servista, stored contents may alter.
error_message When an error occurs, the message of error will be stored.
  • Default value is null.
  • Depending on version for the DataSpider Servista, stored contents may alter.
error_trace When an error occurs, the trace information of error will be stored.
  • Default value is null.
  • Depending on version for the DataSpider Servista or executing client application, stored contents may alter.

Specification Limits

Main Exceptions

Exception name Cause Measure
ResourceNotFoundException
Resource definition cannot be found. Name:[]		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition cannot be found. Name:[<Global resource name>]		 Selected resource definition in [Destination] cannot be found. Confirm the global resource specified in [Destination].
InvalidPropertyConfigurationException
<Property name> is not specified.		 [<Property name>] is not specified. Specify [<Property name>].
AuthenticationException [Email] or [Password] for the global resource is false. Confirm the global resource setting.
GroupNotFoundException Organization specified in [Organization] does not exist. Confirm [Organization] setting.