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:
|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.|
|Requires third-party files?||No|
|Platform availability||All supported Sterling B2B Integrator platforms|
How the User Service Works
- 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
- Create a User service configuration. See Managing Services and Adapters.
- Configure the User service. See Configuring the User Service.
- 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:
|Config||Name of the service configuration.|
|MethodName||Action that this configuration of the service performs
with the database. Valid values are:
|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.|
- Single MethodName return:
<UserService> <methodName>return value</methodName> </UserService>
- User service returning the MethodName getEmail:
<UserService> <getEmail>firstname.lastname@example.org</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>