Create a user

Users are individuals who manage orders by using order management applications. A user with appropriate permissions such as a call center lead must be able to create users for the organization.

Solution

The following section describes APIs, user exits, services, and other components.

A user can be created by using the "Create User" related task on the home page.

To create a user, the following mandatory parameters must be entered or selected:
  • Organization: The getOrganizationList API is called to populate the organizations.
  • User name: A text value. This is used to recognize the user in the system.
  • Login: A text value. This is the value that the user must enter when logging in to the application.
  • Email Address: The email address to contact the user. The email address is important as this attribute is used to send the user, an email that contains a generated password.
  • Menu: The getMenuList API is called to populate the menu group to which the user can be assigned. However, menu options are not applicable to a Sterling™ Call Center user.
  • Locale: The getLocaleList API is called to populate the locales for the user. The Locale drives all display logic across the application specific to the user
  • Department: The getOrganizationList API is called to retrieve the list of organizations and the departments. Based on the organization selected by the user, the corresponding departments are retrieved.
  • Team: The getOrganizationList API is called to retrieve the list of organizations. The selected organization is passed as input to the getTeamList API to populate the teams configured for the user's organization.

The following additional information can be captured while creating the user:

  • Classification of the user as an active user or supervisor
  • The maximum number of customers that can be assigned to the user
  • User's contact address
  • User roles
  • Alert queue assignments

A user must be assigned to queues to receive alerts. The getQueueList API is called to retrieve the available queues that are based on the user's organization and the default organization.

The user roles drive the access permissions across the application. Therefore, a user must be assigned to a role. Only those roles that the currently logged in user can assign to a new user are displayed. The getUserGroupList API retrieves the user roles.

The user can add contact information. When the user chooses to add an address, the Contact Information window is displayed. The user can enter the details and save the information. The contact information is passed in the ContactPersonInfo element while saving the user record. The address capture panel is reused to capture the actual mailing address portion of the contact information. The logic that is used in the address capture panel handles all globalization and custom fields. The email address entered while creating the user is automatically populated in the Contact Information window.

When the user saves the record, all the data entered to create the user is passed to the createUserHierarchy API. If the createUserHierarchy API is called with GeneratePassword attribute set to Y, the YCPGeneratePasswordUE user exit is called to generate the password. The YCD_Send_Generated_Password_8.5 service is triggered to send an email, containing the login and password to the newly created user.

Implementation

The following section describes the rules that you must configure.

Creating users is a permission controlled task. A new user can be created for an organization and assigned to only those groups to which the logged-in user has access. For information about administering user group permissions, see Administering user group permissions.

For more information about the APIs, see the Javadoc.

End-user impact

None.