Search User Member

Operation Name

Search User Member

Function Overview

Acquires user member corresponding to specified search criteria.

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.  
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 criteria Optional - Specify search criteria.

Operation is available with button below.
  • [Add]:
    Adds a search criteria.
  • [Up]:
    Moves the order of the selected search criteria upwards by one.
  • [Down]:
    Moves the order of the selected search criteria downwards by one.
  • [Delete]:
    Deletes a search criteria.
 
Search criteria/Item Required Not Available Select searcing item.
  • [Group name]:(Default)
  • [Group name(pre-Windows2000)]:
  • [Group type]:
  • [Description]:
  • [e-mail]:
  • [Memo]:
  • Diplay name can be changed at [Search item settings].
  • If [Group type] is selected, select [same as next character string] at [Range].
Search criteria/Range Required Not Available Select searcing range.
  • [involve in next character string]:(default)
  • [same as next character string]:
  • [begin with next character string]:
  • [finish with next character string]:
 
Search criteria/Content Required Not Available Select searcing content.
  • Searches without distinction of Uppercase/Lowercase letter when English character is entered.
Property action
Item name Description Remarks
Search item settings Sets item to [Item] of [Search criteria] by starting Search item setting wizard.  
Data processing method
Item name Required/Optional Use of variables Description Remarks
Data processing method Required Not Available Select a data processing method.
  • [Use script settings]:(default)
    Applies the setting of mass data processing set up 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="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>
English Name Japanese Name 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
  • Password Information cannot be gotten and set because of Specification of Active Directory.
groupNameIncludedMember Belonging group name
  • Separate multiple belonging groups using comma, enclose each with ""(double quotation).
userAccountControl Account options
  • Not set, since it is the parent element.
passwdNotreqd User must change password at next logon
  • Set "true" or "false"(a lower-case letter).
dontExpirePassword Password never expires
  • Set "true" or "false"(a lower-case letter).
encryptedTextPwdAllowed Store password using reversible encryption
  • Set "true" or "false"(a lower-case letter).
accountDisable Account disabled
  • Set "true" or "false"(a lower-case letter).
accountExpires Account expiration date  
description Description  
physicalDeliveryOfficeName Office  
telephoneNumber Telephone number  
mail E-mail  
wWWHomePage Web page  
c Country/Region
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  

Loading Schema on Mapper

Schema is loaded automatically/manually.
For more ditails, 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
execute_count Stores the number of search data.
  • 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 Returns the error type when error occurred.
  • 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_type Returns the error type when error occurred.
  • Default value is null.
  • The message may vary depending on the DataSpider Servista version.
error_trace Returns the trace information when error occurred.
  • Default value is null.
  • The message may vary depending on the DataSpider Servista version or the client application used.

How to search if multiple condition is set

Same item is searched under OR condition, and different item is searched under AND condition.
For example:
Item Range Content How to research
Entry name
Entry name
same as next character string
begin with next character string
Suzuki Ichiro
Tanaka
Entry name="Suzuki Ichiro" OR Entry name="Tanaka*"
Entry name
Phone number
same as next character string
begin with next character string
Suzuki Ichiro
03
Entry name="Suzuki Ichiro" AND Phone number="03*"

Specification Limits

Main Exceptions

Exception name Cause Solution
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. Confirm the global resource specified in [Destination].
InvalidPropertyConfigurationException
Required item of resource is not specified.
Required item of resource selected in [Destination] is not specified. Specify required item of resource.
InvalidPropertyConfigurationException
Search criteria(content) is not entered.
[Content] of [Search criteria] is not entered. Enter [Content] of [Search criteria], or delete from [Search criteria].
java.rmi.UnmarshalException Certificate is not imported in $DATASPIDER_HOME/jre/lib/security/cacerts. It is required to import Certificate in $DATASPIDER_HOME/jre/lib/security/cacerts.