... Please view the article for a scenario where Lookup DSC is demonstrated: [Find Out Details About the Last Form User].
h3. Component: com.avoka.livecycle.lookup 1.0
h2. Lookup Service
Lookup: The *Lookup Service* is able to query LiveCycle's user management system to find information about a particular group or user. If LiveCycle happens to be synchronized with an LDAP directory then this service can find information about LDAP users and groups as well. This is extremely useful, simple utility where we know the person's login ID, and need to find out his/her emails address, or we know the name of a group but don't know who that group's members are (or their email addresses). If we can find that user or group, this service can give us their directory information as well (e.g. Phone number, Address, Organisation etc.).
h3. Operation Title: Lookup User (lookupUser)
Lookup User: Find a user using specified search parameters. Should these search parameters actually find more than one user then only the first matching user gets returned.
|| Input Parameter || Type || Description || Editor ||
| Type of Query | java.lang.String | This specifies what field you want to use to lookup for a user: Auto, Email, User Principal ID, Login ID, or UserAndDomain.| [Input GUI|#lookupUserInput.jpg] |
| Any User Identifier | java.lang.String | This field is required when you select 'Auto' query type. The identifier specified will be used in trying to lookup for the workflow user first as a user Principal ID, followed by login ID, user canonical name, and user email address, in respective order.\\
This 'mode' allows you to lookup for workflow user with any user identifier that you have and you are not sure of what it is. The identifier will be used to try to lookup for the workflow user with matching user principal ID, matching user login ID, or matching user email address in respective order. That is, the identifier provided will be used as a user principal ID to lookup for a matching workflow user. If no matching user is found, it will then be used as a user login ID, and lastly as an email address, to try to find a matching workflow user.| [Input GUI|#lookupUserInput.jpg] |
| User Canonical Name | java.lang.String | This field is required when you select 'UserAndDomain' query type. Together with domain name, it will be used in looking up for the workflow user with matching user canonical name and domain name.\\
User Canonical Name and Domain Name uniquely identify a user in the Adobe user manager system.| [Input GUI|#lookupUserInput.jpg] |
| Domain Name | java.lang.String | This field is required when you select 'UserAndDomain' query type. Together with user canonical name, it will be used in looking up for the workflow user with matching user canonical name and domain name.| [Input GUI|#lookupUserInput.jpg] |
| User Principal ID | java.lang.String | This field is required when you select 'User Principal ID' query type, to lookup for the workflow user with matching User Principal ID.\\
The principal ID is a universally unique identifier (UUID) consists of a long string of hexadecimal digits generated by an algorithm to ensure of its uniqueness. This is an example of a UUID: \\16A5386E-6B5F-EDD0-FECE-293A97CC854A| [Input GUI|#lookupUserInput.jpg] |
| Email | java.lang.String | This field is required when you select 'Email' query type, to lookup for the workflow user with matching email address.\\
Since it is possible that more than one users have the same email address, this query type could match more than one workflow users, and only the first workflow user will be returned.| [Input GUI|#lookupUserInput.jpg] |
| Login ID | java.lang.String | This field is required when you select 'Login ID' query type, to lookup for the workflow user with matching login ID.\\
Login ID is also used by the adobe user manager systems as a universally unique user ID string.| [Input GUI|#lookupUserInput.jpg] |
| Test | Test Panel | If the input user search parameters were literal values (as opposed to XPath expressions accessing variable values) then this panel can be used to test their efficacy. Pressing the 'Test' button will produce results in the display pane.| [Test GUI|#lookupUserTest.jpg] |
|| Output Parameter || Type || Description ||
| Family Name | java.lang.String | The family name of the user. Specify the process variable in which the family name of the user should be stored. |
| Given Name | java.lang.String | The user's given name. Specify the process variable in which the given name of the user should be stored. |
| User Common Name | java.lang.String | The user's common name. Specify the process variable in which the common name of the user should be stored. |
| Telephone | java.lang.String | The user's phone number. Specify the process variable in which the telephone of the user should be stored. |
| Login Id | java.lang.String | The user's login ID. Specify the process variable in which the Login ID of the user should be stored. |
| Initials | java.lang.String | The user's initials. Specify the process variable in which the initials of the user should be stored. |
| Description | java.lang.String | A description of the user. Specify the process variable in which the user description of the user should be stored. |
| Email Address | java.lang.String | The user's email address. Specify the process variable in which the email of the user should be stored. |
| Organization | java.lang.String | The name of the user's organisation. Specify the process variable in which the organization of the user should be stored. |
| PrincipalId | java.lang.String | The unique ID of the user, in the user database. Specify the process variable in which the User UID of the user should be stored. |
| User Canonical Name | java.lang.String | The user's canonical name (is unique to user's domain). Specify the process variable in which the canonical name of the user should be stored. |
| Domain Name | java.lang.String | The name of the user's domain, in the user DB. Specify the process variable in which the domain name of the user should be stored. |
| Domain Common Name | java.lang.String | The common name of the user's domain, in the user DB. Specify the process variable in which the domain common name of the user should be stored. |
| Domain Status | java.lang.String | The status of the user's domain, in the user DB. Specify the process variable in which the domain status of the user should be stored. |
| Domain Principal Id | java.lang.String | The unique ID of the user's domain, in the user DB. Specify the process variable in which the domain Principal ID of the user should be stored. |
| Found | java.lang.String | Whether or not the user was found. Specify the process variable in which the result of looking up for the user should be stored. Boolean value of true will be stored if the user is found, otherwise false will be stored. |
| Status | java.lang.String | The status of the user's domain in the database, e.g. 'CURRENT'. Specify the process variable in which the status of the user is should be stored. |
| Is Disabled | boolean | Whether or not the user is disabled. |
| Is Local | boolean | Whether or not the user is locally 'owned', in the user DB. Specify the process variable which stores whether or not the found user is local to the system. |
| Is Locked | boolean | Whether or not the user data is locked, in the user DB. |
| Is System | boolean | Whether or not the user is a system default user. Specify the process variable which stores whether or not the found user belongs, instrinically, to the system. |
| Locale | java.lang.String | The user's locale. |
| Timezone | java.lang.String | The user's timezone. Specify the process variable in which the timezone of the user should be stored. |
h3. Operation Title: Lookup Group (lookupGroup)
Lookup Group: Find a group using specified search parameters. Should these search parameters actually find more than one group then only the first matching group gets returned.
|| Input Parameter || Type || Description || Editor ||
| Type of Query | java.lang.String | This specifies what field you want to use to lookup for a group: Auto, Group Principal ID, Group And Domain, Group Common Name, or Group Email.| [Input GUI|#lookupGroupInput.jpg] |
| Any Group Identifier | java.lang.String | This field is required when you select 'Auto' query type. The identifier specified will be used in trying to lookup for the workflow group first as a group Principal ID, followed by group group common name, and group email address, in that order.| [Input GUI|#lookupGroupInput.jpg] |
| Group Principal ID | java.lang.String | This field is required when you select 'Group Principal ID' query type, to lookup for the workflow group with matching Group Principal ID.| [Input GUI|#lookupGroupInput.jpg] |
| Group Canonical Name | java.lang.String | This field is required when you select 'Group And Domain' query type. Together with domain name, it will be used in looking up for the workflow group with matching group canonical name and domain name.| [Input GUI|#lookupGroupInput.jpg] |
| Domain Name | java.lang.String | This field is required when you select 'Group And Domain' query type. Together with group canonical name, it will be used in looking up for the workflow group with matching group canonical name and domain name.| [Input GUI|#lookupGroupInput.jpg] |
| Common Name | java.lang.String | This field is required when you select 'Group Common Name' query type, to lookup for the workflow group with matching group common name.| [Input GUI|#lookupGroupInput.jpg] |
| Email Address | java.lang.String | This field is required when you select 'Group Email' query type, to lookup for the workflow group with matching email address.| [Input GUI|#lookupGroupInput.jpg] |
| Group Members Delimiter | java.lang.String | A string consisting of one or more characters used as a delimitor to concatenate group member properties.| [Input GUI|#lookupGroupInput.jpg] |
| Test | Test Panel | If the input group search parameters were literal values (as opposed to XPath expressions accessing variable values) then this panel can be used to test their efficacy. Pressing the 'Test' button will produce results in the display pane.| [Test GUI|#lookupGroupTest.jpg] |
|| Output Parameter || Type || Description ||
| Found | boolean | Specify the process variable in which the result of looking up for the group should be stored. Boolean value of true will be stored if the group is found, otherwise false will be stored. |
| Group Type | java.lang.String | Specify the process variable in which the group type should be stored. The group type is either PRINCIPALS (group containing other groups or users in the workflow system) or ROLE (group containing groups or users who has been assigned this role). |
| Common Name | java.lang.String | The common name of the group. Specify the process variable in which the sync state of the group should be stored. |
| Canonical Name | java.lang.String | The canonical name of the group, unique but usually human readable. Specify the process variable in which the group canonical name should be stored. |
| Principal ID | java.lang.String | The unique ID of the Group, usually system generated. Specify the process variable in which the group principal ID should be stored. |
| Description | java.lang.String | A description of the group. Specify the process variable in which the group description should be stored. |
| Email | java.lang.String | The email address of the group. Specify the process variable in which the group email should be stored. |
| Organization | java.lang.String | The organisation name. Specify the process variable in which the group organization should be stored. |
| Status | java.lang.String | The group status in the database, e.g. 'CURRENT'. Specify the process variable in which the group status, whether the the group is current or obsolete, should be stored. |
| Domain Name | java.lang.String | Each group must reside in a domain. Specify the process variable in which the domain name of the group should be stored. |
| Domain Common Name | java.lang.String | The common name of the group's domain. Specify the process variable in which the domain common name of the group should be stored. |
| Domain Status | java.lang.String | The status of the group's domain in the database, e.g. 'CURRENT'. Specify the process variable in which the domain status of the group should be stored. |
| Domain Principal Id | java.lang.String | The unique id of the domain. Specify the process variable in which the domain principal ID of the group should be stored. |
| Member Principal Id List | java.lang.String | A string containing the unique IDs of each group member. Each ID is separated by the Group Members Delimiter. Specify the process variable in which the concatenated group member principal IDs with the specified deliminator should be stored. |
| Member Common Name List | java.lang.String | A string containing the common names of each group member. Each member common name is separated by the Group Members Delimiter. Specify the process variable in which the concatenated group member common names with the specified deliminator should be stored. |
| Member Email List | java.lang.String | A string containing the email addresses of each group member. Each member email address is separated by the Group Members Delimiter. Specify the process variable in which the concatenated group member emails with the specified deliminator should be stored. |
| Member Login List | java.lang.String | A string containing the LogIn of each group member. Each member LogIn is separated by the Group Members Delimiter. Specify the process variable in which the concatenated group member LogIns with the specified deliminator should be stored. Note: if one of the members of the group is also a group, then the LogIn would be "n/a" |
| Group Is Local | boolean | Group was not defined external to Livecycle. Specify the process variable which stores whether or not the found group is local to the system. |
| Is System Group | boolean | Whether or not the group is a system group. Specify the process variable which stores whether or not the found group belongs, instrinically, to the system. |
| Visibility Integer | int | The visibility of the group. Specify the process variable which stores the visibility integr value of the group. |
h5.
{panel:borderStyle=solid}
For how to configure license information for this component service - Lookup, please click on the following link:
[Avoka LiveCycle ES Component License Configuration]
Please send us any questions or comments on this documentation regarding Lookup by clicking on the following link:
[Feedback|mailto:docfeedback@avoka.com?subject=DSC Documentation Feedback on Service: Lookup] |
Lookup DSC
