Validate through an external application

After validating that the WFM Suite has been correctly deployed, validate the suite through an external application. You can use these steps for the WFM Clocks Suite as well.
Note: These steps use Postman as an external application.
  1. Enable Scopes within the API Gateway. See Enabling Scopes.
  2. Create an ION API user. See Creating a user for the external integration.
  3. Provide the user with adequate security role access to the necessary team hierarchy. See Handling employee for the designated ION API user.
    Note: In this scenario, the user has been given GENERAL ACCESS to the WORKBRAIN_ROOT team. This is a testing scenario as this setup allows access to all employees.
  4. Update the user with these scenarios to further test the suite through the external application:
    1. Update the user as a SUPERVISOR for a team hierarchy that is not WORKBRAIN_ROOT. In this scenario, the user can view data for employees in that team only.
    2. Update the user so the user is not a supervisor. In this scenario, the user can only view their own data.
  5. Create an authorized app so that ION API can be accessed externally. See Creating an authorized app in ION API Gateway.
  6. Use the credentials file from Creating an authorized app in ION API Gateway to populate the Postman Authorization to obtain an OAuth 2.0 token.
  7. In Postman, create a Collection and then a Request.
    Note: A collection holds a set of web service requests. A request retrieves information from another system using a web service. Refer to the Postman documentation for instructions.
  8. Within the new Postman request, click Authorization and specify this information:
    Type
    Select OAuth 2.0.
    Add authorization data to
    Select Request Headers.
  9. Click Get New Access Token and specify this information:
    Token Name
    Provide any unique name. For example: ION API token or for Clocks, Clock API token.
    Grant Type
    Select Password Credentials from the drop-down field.
    Access Token URL
    Specify a URL by concatenating the information in the pu and ot fields in the credentials file. For example:

    https://mingle.xxx:443/WFMXXX/as/token.oauth2

    Client ID
    Specify the information in the ci field of the credentials file.
    Client Secret
    Specify the information in the cs field of the credentials file.
    Username
    Specify the information in the saak field of the credentials file.
    Password
    Specify the information in the sask field of the credentials file.
    Scope
    Specify Infor-WFMPublic for Workforce Management.

    Specify Infor-WFMClocks for Workforce Management Clocks.

    Client Authentication
    Select the default of Send as Basic Auth Header.
  10. Click Get New Access Token and then Use Token.
  11. Navigate to New Request.
  12. In the Enter your request URL field, specify the request URL and click Send.
    Below is an example of a WFM API call:

    https://<SERVERNAME>/<TENANTNAME>/WFM/public/services/api/public/v1/common/employees/{emp-name}/employee-schedule-details?workDateFrom=2023-08-23&workDateTo=2023-08-31

    Below is an example of a WFM Clocks API call:

    https://<SERVERNAME>/<TENANTNAME>/WFMCLOCKS/public/services/api/public/v1/clocks/reader-groups/VIRTUAL READER GROUP

  13. Verify the response returns data and the status 200 OK.
  14. Test additional API calls as required.