User Service

The User service checks the Sterling B2B Integrator database account profiles for permissions that may restrict a user's access to a business process, Web template, or resource.

The following table provides an overview of the User service:

Category Description
System name UserServiceType
Graphical Process Modeler (GPM) categories All Services, System
Description Checks the Sterling B2B Integrator database account profiles for permissions that might restrict a user's access to a business process, Web template, or resource.
Preconfigured? Yes
Requires third-party files? No
Platform availability All supported Sterling B2B Integrator platforms
Related services No

How the User Service Works

The User service is used by both Sterling B2B Integrator and by business processes that reference a User service:
  • For Sterling B2B Integrator, the User service provides security by verifying permissions set for a user when the user is attempting to run a restricted business process.
  • A business process uses the User service to extract user data from the Sterling B2B Integrator database for use within the business process as it runs. The user data can be as little as a last name or as much as all the data in the user profile set-up by the system administrator. A business process can also reference the User service to help route documents from person to person.

Implementing the User Service

To implement the User service, complete the following tasks:
  1. Create a User service configuration. See Managing Services and Adapters.
  2. Configure the User service. See Configuring the User Service.
  3. Use the User service in a business process.

Configuring the User Service

To configure the User service, you must specify settings for the following fields in the GPM:

Field Description
Config Name of the service configuration.
MethodName Action that this configuration of the service performs with the database. Valid values are:
  • getEmail – Obtain the e-mail address associated with the user.
  • getEntityID – Obtain only the entity ID associated with the user.
  • getFirstname – Obtain only the first name of the user.
  • getFullname – Obtain the first and last name of the user.
  • getLastname – Obtain the last name of the user.
  • getPager – Obtain the pager number of the user.
  • getParentID – Obtain the manager's name of the user.
  • getUserToken – Obtain the entire user account profile.
  • hasGroup – Check for groups associated with the user. Requires a value to be typed in the MethodParm field.
  • hasPermission – Check for permissions associated with the user. Requires a value to be typed in the MethodParm field.
MethodParm Specific permission or group name associated with the user. Required for both hasGroup and hasPermission method names.
UserName User name that identifies the account profile on which the MethodName parameter conducts the configured action.

Output Results

The following are examples of output results after the User service runs.
  • Single MethodName return:
    <UserService>
       		<methodName>return value</methodName> 
    </UserService>
  • User service returning the MethodName getEmail:
    <UserService>
       		<getEmail>janedoe@company.com</getEmail> 
    </UserService>

The getUserToken method is the only method that returns a node structure within the method. The following is an example of a User service returning the MethodName getUserToken, which includes the user token node structure:

<UserService> 
        <getUserToken> 
             <usertoken> 
                <username> </username> 
                <firstname> </firstname>
                <lastname></lastname>
                <fullname></fullname>
                <email></email>
                <parentid></parentid>
                <groups>
                    <group></group>
                </groups>
                 <permissions>
                    <perm></perm> 
</permissions> 
</usertoken> 
        </getUserToken> 
</UserService>