This documentation supports the 23.3 version of BMC Helix Innovation Suite (AR System and BMC Helix Innovation Studio).

To view an earlier version, select the version from the Product version menu.

Example: Automating service requests for payslips by using UiPath RPA

Use the BMC Sample Request Payslip with UiPath <version> sample service in the BMC Helix Digital Workplace Catalogapplication to automate service requests for payslips.

Scenario

Ajay, an application business analyst, wants to create a service to automate user requests for payslips. He uses the content package to create the service.

Ajay creates a UiPath connector configuration. He creates a UiPath (RPA) process by using a sample script. Ajay configures the process to fetch a payslip from a payroll system and send the payslip to the user through an email. He updates the BMC Sample Request Payslip with UiPath <version> service in the BMC Helix Digital Workplace Catalog application. He then publishes the service and makes it available for users.

The following image describes the actions to create a service to automate user requests for payslips:

22_1_uipath_service_workflow

The following video (2:46) explains how to automate a payslip service request using UiPath:

 https://youtu.be/gvq9jUnXYs4

Before you begin

Make sure that you have completed the following actions:

  • Downloaded the following files:
    • BMC Sample Request PaySlip Process.zip
    • BMC Sample Request Payslip Definitions
    • Sample Payslip.zip
      For information about the content package and files to download, see PDFs, videos, and API documentation.
  • Imported the BMC Sample Request PaySlip Process <version>.zip file to UiPath.
  • Imported the BMC Sample Request Payslip Definitions file to your BMC Helix Digital Workplace Catalog application in BMC Helix Innovation Studio.
    The BMC Sample Request Payslip Definitions file contains the rule definition that is used by the BMC Sample Request Payslip with UiPath <version> service workflow.
  • Configured a webhook callback URL with the UiPathConfig name.
    Learn about configuring a webhook callback at Adding a UiPath connector configuration.

Task 1: To create a UiPath connector configuration

  1. Log in to BMC Helix Innovation Studio.
  2. Navigate to the Administration tab.
  3. Select Connectors > UiPath, and click Add new setting.

  4. Enter the values for the following fields:

    FieldDescription
    Connection IDID for the connection.
    You can specify an alphanumeric ID such as UiPath-12.
    Client KeyKey to log in to your UiPath account
    NameName for the connection
    Account Logical Name

    Unique URL that is derived from the company name that you specify during signup or from your first name and last name

    Client IDValue of the Application ID obtained after creating an Orchestrator application in UiPath
    URL

    UiPath server endpoint URL

    Trust All CertificatesIf you want to trust your certificates, specify the value as True, else do not specify any value.
    Organization UnitIdThe ID of the modern folder where your UiPath processes are located
    Tenant Logical NameTenant associated with your UiPath account
    Callback URLURL that was populated automatically when you configured the webhook callback
    Callback Auth Key or User NameAuthorization GUID or string that you added while configuring the webhook callback URL for the UiPath connector, such as UiP-12345

    Callback PasswordPassword for the account you are using

    Learn about User KeyAccount Logical Name, and Tenant Logical Name at Consuming Cloud API Open link .

  5. Click Save.

Task 2: To define the UiPath process

  1. Visit  UiPath Open link and sign into the portal with your user credentials.
  2. In UiPath, create RequestPaySlip process by using the BMC Sample Request PaySlip Process.zip sample process.

  3. In the process, update the values for the arguments.

    Important

    Make sure that the arguments in the process and the input variables in the service workflow are the same.

    The following image shows an example of arguments:


  4. Update the values for the process variables such as host.

    The following image shows an example of variables:

  5. In the jsonObject variable, specify the following value:

    Important

    Make sure that in the UiPath studio you import the UiPath web API activities package.

  6. In the filePath variable, configure the path for sample payslips.
    Specify the path where you downloaded the Sample Payslip.zip file.
  7. To receive a callback from the process, configure the HTTP header.
    The following image shows an example of the HTTP header:

  8. Configure the REST service as shown in the following image:

    Make sure that you specify the following parameter values: 

    ParameterValue
    Input section
    AcceptFormatJSON
    MethodPOST
    Options section
    BodyConvert the JSON body in string format.

    Make sure that you use the following JSON object structure:

    JObject.FromObject(
    New With {
    key.processCorrelationId=processCorrelationId,
    key.resourceType="com.bmc.arsys.rx.application.process.command.SignalProcessInstanceCommand",
    key.signalInputValues=New With {
    key.Result="Success",
    key.ProcessResult="Process Successfully Completed"
    }
    })

Task 3: To define Request Payslip service

  1. Log in to BMC Helix Digital Workplace Catalog.
  2. On the Services tab, click Services.
    The service BMC Sample Request Payslip with UiPath <version> is displayed in the Service Management console.
  3. Select the service, click Actions, and click Edit Service Name.

  4. Update the service name, and click Save.
    For example, Request Payslip.

Task 4: To define the Request Payslip service workflow

  1. In the BMC Helix Digital Workplace Catalogapplication, in the Service Management console, select the Request Payslip service.
  2. Click Actions, and click Open.
  3. In the Service Options pane, click Edit corresponding to the Workflow option.

  4. In the Workflow and Questions pane, in the Workflow section, click Edit.


    The following workflow is displayed in the Workflow designer:


    The following elements are used in the workflow:

    ElementLabelDescription
    Create DocumentProcess InputsAccesses the attributes within the schema of the UiPathParams document definition.
    Specify the document node values that are used as input to run the RPA process.
    Run UiPath ProcessRun UiPath Process

    Triggers a UiPath process.

    Specify the process name and jobs count in the element properties.

    Receive TaskReceive Process StatusAdds wait steps in the workflow and waits for process completion.
    TimerNAInterrupts a wait step after time out.
    Send In App NotificationSend notification on process failureSends the process status to the administrator through a notification.
    Send In App NotificationSend notification on successful process executionSends the process status to the service requester through a notification.


  5. If required, update the workflow input variables.
    The following input variables are available:


  6. Map the payslipMonth and year input variables to the service questionnaire so that user responses to service questions are used as variable values.
  7. Select the Create Document element with the Process Inputs label, and make sure that you specify the keys in the document nodes in the same manner as you specify in the process script input variables.

  8. Select the Run UiPath Process element and update the following properties:

    PropertyDescription
    Connection IDConnection ID of your UiPath connector that you configured in Task 1.
    File ID or nameName of the process, RequestPaySlip.
    Jobs CountThe number of times you want to run a job that is to run the UiPath process.
  9. Save the changes.

Task 5: To define the Request Payslip service questionnaire

  1. In the BMC Helix Digital Workplace CatalogService Management console, select the service.
  2. Click Actions and click Open.
  3. In the Service Options pane, click Edit corresponding to the Workflow option.

  4. In the Workflow and Questions pane, in the Questions section, click Edit.

    The Questions designer displays the questions that the user must answer to retrieve the payslip for a specific period (month and year) as shown in the following images:



  5. In the Questions designer, add questions corresponding to any additional input variables that you have added in the workflow to receive inputs from the service requester.
  6. Save the changes.

Task 6: To define the Request Payslip rule

  1. Log in to BMC Helix Innovation Studio.
  2. Navigate to the Workspace tab, and select the BMC Helix Digital Workplace Catalogapplication.
  3. In the application, select Rules, and click the UiPathCallbackRule rule.
    The following image shows an example rule:

  4. In the rule, update the Qualification and Signal Process element properties.

Task 7: To publish the Request Payslip service

  1. In the BMC Helix Digital Workplace Catalogapplication, in the Service Management console, select the Request Payslip service.
  2. In the Service Options pane, click , and click Publish.

After you publish the service, the service is available to users.

Task 8: To test the Request Payslip service

  1. Log in to BMC Helix Digital Workplaceapplication.
  2. Submit a payslip request by using the Request Payslip service.

  3. Verify that you receive an email with the payslip attached.

Result

The Request Payslip service is available to the users. Users can submit payslip requests by using this service and their requests are processed automatically.

Was this page helpful? Yes No Submitting... Thank you

Comments