Component: com.avoka.livecycle.createUserCreateGroup 1.0
CreateUserCreateGroup Service
Create User Create Group: Normally we use the Administration pages (adminui) of LiveCycle to create new users and groups. This service enables
us to create new users and new groups from within processes. In many staff induction processes people are required to fill-in a form
describing the new staff member. This form is then manually entered into the user database by a data entry person.
This double entry of data (once into the form) and then again into the back-end office systems is labour-intensive and
is prone to error. By being able to add users into LiveCycle from within a process we can automate this. At this stage
this service is unable to add users and groups to an ActiveDirectory (or LDAP) database. It is only able to add users and
groups to LiveCycle's built-in user/group database.
Operation Title: Create User (createUser)
Create User: Create a new user in the Livecycle ES database passing in the following parameters.
| Input Parameter |
Type |
Description |
Editor |
| Login Name |
java.lang.String |
A login name, at most 50 chars long. Must be unique to user management system. This is mandatory. |
|
| Password |
java.lang.String |
Must be at least 8 characters long. This is mandatory. |
|
| Common Name |
java.lang.String |
A human readable common name of the user. This is not necessarily unique. If left blank the login name is used here. |
|
| Canonical Name |
java.lang.String |
The formal, or canonical, name of the user. This must be unique to the LiveCycle ES domain that the user is being created in. If left blank the login name is used here. |
|
| Description |
java.lang.String |
A textual, informal description of the new user. |
|
| Email Address |
java.lang.String |
An email address for the new user. This is not necessarily unique to the user management system. |
|
| Given Name |
java.lang.String |
The given name of the user. |
|
| Family Name |
java.lang.String |
The family name of the new user. |
|
| Initials |
java.lang.String |
User initials. |
|
| Organisation Name |
java.lang.String |
A textual representation of the organisation that contains the new group. This is treated by LiveCycle as free text; and is not necessarily unique to the user management system. |
|
| Address |
java.lang.String |
The address of the new user. This is treated by LiveCycle as free text. |
|
| Telephone Number |
java.lang.String |
The telephone number of the new user. This is treated by LiveCycle as free text. |
|
| Assign Workspace Permission |
boolean |
By checking this box you are granting the new user the permission to use LiveCycle workspace. |
|
| Member of Group |
java.lang.String |
By adding the PrincipalID of a group in this field you are making the newly created user a member of this group. |
|
| Output Parameter |
Type |
Description |
| User Identifier |
java.lang.String |
The ID of the newly created user. |
Operation Title: Create Group (createGroup)
Create Group: Create a new group in the Livecycle ES database using the supplied parameters.
| Input Parameter |
Type |
Description |
Editor |
| Common Name |
java.lang.String |
A human readable representation of the group. This is not necessarily unique. If this field is left blank the Group canonical name is used here. |
|
| Canonical Name |
java.lang.String |
The formal, or canonical, name of the group. his must be unique to the LiveCycle ES domain that the user is being created in. This field is mandatory. |
|
| Description |
java.lang.String |
A textual, informal description of the new group. This field is treated by LiveCycle as free text. |
|
| Email Address |
java.lang.String |
An email address for the new group. This is not necessarily unique to the user management system. |
|
| Organisation Name |
java.lang.String |
A textual representation of the organisation that contains the new group. This is not necessarily unique to the user management system and is treated by LiveCycle as free text.. |
|
| Output Parameter |
Type |
Description |
| Group Identifier |
java.lang.String |
The ID of the newly created group. |
Operation Title: Remove User From Local Group (removeUserFromLocalGroup)
Remove User From Local Group: This operation allows us to remove a user from the membership list of a group. It does not delete the user. Like group/user creation LiveCycle only provides an administration console for removing users from the LiveCycle user database. Once again this operation can only affect groups/users that are "local" to the LiveCycle user database i.e. it cannot update an LDAP or Active Directory database.
| Input Parameter |
Type |
Description |
Editor |
| User Principal ID |
java.lang.String |
The principal ID of the user to remove from the group. Every user/group has a principal ID (this can be found using the Avoka Lookup Service). This is mandatory. |
|
| Group Principal ID |
java.lang.String |
The principal ID of the group to remove the user from. Every user/group has a principal ID (this can be found using the Avoka Lookup Service). This is mandatory. |
|
Operation Title: Delete Local User (deleteLocalUser)
Delete Local User: This operation allows us to remove a user from the LiveCycle user database. Like group/user creation LiveCycle only provides an administration console for removing users from the LiveCycle user database. Once again this operation can only affect groups/users that are "local" to the LiveCycle user database i.e. it cannot update an LDAP or Active Directory database.
| Input Parameter |
Type |
Description |
Editor |
| User Principal ID |
java.lang.String |
The principal ID of the user to delete. Every user/group has a principal ID (this can be found using the Avoka Lookup Service). This is mandatory. |
|
Operation Title: Reset Local User Password (resetUserPassword)
Reset Local User Password: Resets the password for a LiveCycle user. Once again this operation can only affect groups/users that are "local" to the LiveCycle user database i.e. it cannot update an LDAP or Active Directory database.
| Input Parameter |
Type |
Description |
Editor |
| User Principal ID |
java.lang.String |
The principal ID of the user to have the password reset. Every user/group has a principal ID (this can be found using the Avoka Lookup Service). This is mandatory. |
|
| New Password |
java.lang.String |
Must be at least 8 characters long. This is mandatory. |
|
For how to configure license information for this component service - Create User Create Group, please click on the following link:
Avoka LiveCycle ES Component License Configuration
Please send us any questions or comments on this documentation regarding Create User Create Group by clicking on the following link:
Feedback
Licence Configuration:
| Parameter |
Type |
Description |
| License Key |
java.lang.String |
The license key provided to you when you purchased a production license for this Solution Component. If blank this Solution Component will assume evaluation mode and allow 100 invocations or 6 hours up-time. |
| License Organisation |
java.lang.String |
The organization name you provided to Avoka for which you are licensing this Solution Component. |