Example: Automating service requests for payslips by using Blue Prism RPA

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

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 packages and files to download, see PDFs-videos-and-API-documentation.
• Imported the BMC Sample Request PaySlip Process.zip file to Blue Prism.
• 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 Blue Prism <version> service workflow.

• Configured a webhook callback URL with the BlueprismConfig name.
  Learn about configuring a webhook callback at Adding-a-Blue-Prism-connector-configuration.

Task 1: To create a Blue Prism connector configuration

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

4. Enter the values for the following fields:

   Field	Description
   Connection ID	ID for the connection. You can specify an alphanumeric ID such as BluePrismConnection-12.
   Name	Name for the connection.
   URL	Blue Prism server endpoint URL. For example, http://<host name>:8181/ Important: To get the URL, you must expose an RPA process as a web service in Blue Prism and use a digital worker or Resource Pool hostname in the URL.
   User	User name of the user who has the permission to assign and run a process.
   Password	Password for login.
   Trust All Certificates	If you want to trust your certificates, specify the value as True; else, do not specify any value.

5. Click Save.

Task 2: To define the Blue Prism process

1. Visit Blue Prism and log in to the portal with your user credentials.

2. In Blue Prism, create a RequestPaySlip process by using the BMC Sample Request PaySlip Process.zip sample process.
3. In the Blue Prism process, update the Email-SMTP::Configure object input properties.
   The following image shows an example of the input properties:
   

1. Update the values for the Blue Prism process input variables.

   Important

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

   The following image shows an example of variables:
   

2. In the filePath variable, configure the path for sample payslips.
   Specify the path where you downloaded the Sample Payslip.zip file.
3. In Blue Prism, in the Web API Service section, in the IS-Callback web API service, update the Base URL value.
   The following image shows an example of the web API service:
   

Task 3: To define a 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 Blue Prism <version> is displayed in the Service Management console.

1. Select the service, click Actions, and click Edit Service Name.
   

1. 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.
   

1. 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:

   Element	Label	Description
   Create Document	Process Inputs	Accesses the attributes within the schema of the BlueprismParameters document definition. Specify the document node values that are used as input to run the RPA process.
   Run Blue Prism Process	Run Blue Prism Process	Triggers a Blue Prism process. Specify the process name in the element properties.
   Receive Task	Receive Process Status	Adds wait steps in the workflow and waits for process completion.
   Timer	NA	Interrupts a wait step after time out.
   Send In App Notification	Send notification on process failure	Sends the process status to the administrator through a notification.
   Send In App Notification	Send notification on successful process execution	Sends the process status to the service requester through a notification.

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

You must map the payslipMonth and Year input variables to the service questionnaire so that user responses to service questions are used as variable values.

1. 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.

2. Select the Run Blue Prism Process element and update the following properties:

   Property	Description
   Connection ID	Connection ID of your Blue Prism connector that you configured in Task 1.
   Process Name	Name of the process, RequestPaySlip.

3. 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.
   

1. In the Workflow and Questions pane, in the Questions section, click Edit.
   
   The Questions Designer displays the questions that the users must answer to retrieve the payslip for a specific period (month and year) as shown in the following figures:
   
   
   
   

1. 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.

1. 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 BlueprismCallbackRule rule.
   The following image shows an example rule:
   

1. If required, 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 Workplace application.
2. Submit a payslip request by using the Request Payslip service.
   

1. 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.