(Example) Start an AgilePoint Workflow Through UiPath

This document shows how to start an AgilePoint NX process (workflow) with UiPath.

Note: This document provides general documentation for the AgilePoint NX UiPath Sudio component. However, it provides the information using an example scenario as the basis for the documentation. In most cases, the values that are provided in this document are for example purposes.

Background and Setup

Prerequisites

  • AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
  • Download the Customer Enquiry app from the AgilePoint NX App Store.

    For more information, refer to How to Get the App.

    This app is used for example purposes because it is available for free from the AgilePoint NX App Store. In a production environment, use an app that is appropriate for your use case.

    Customer Enquiry is an app that lets customers submit questions about a company, or its products or services.

  • A UiPath account.
  • UiPath Studio installed on your machine.

Step 1: Configure a Workflow in UiPath Studio

To configure a workflow in UiPath Studio, do the procedure in this topic.

Prerequisites

  • Download the UIPath.AgilePoint.Activities component from https://go.uipath.com/.
  • Install UIPath.AgilePoint.Activities component in UiPath Studio.
  • Get the credentials for an AgilePoint NX user account with permission to edit and run your AgilePoint NX app.
  • Create a process named CustomerEnquiryProcess in UiPath Studio.

    This is an example value that is specific to the scenario in this document. In a production environment, use a value that is appropriate to your use case.

How to Start

  1. Open UiPath Studio.

    UiPath Studio screen
  2. Click CustomerEnquiryProcess.

    UiPath Studio screen
  3. On the Design tab, in the Available section, drag the Start Workflow activity to the right pane.

    UiPath Studio screen

    This screen shows.


    UiPath Studio screen

Procedure

  1. On the right pane, click Configure Workflow.
    Figure: Customer Enquiry Process screen

    Customer Enquiry Process screen
  2. On the Start Workflow screen, in the AgilePoint Server URL field, enter the REST URL for your AgilePoint Server instance.

    For more information, refer to Find your AgilePoint Server Instance REST URL.

    Figure: Start Workflow screen

    Start Workflow screen
  3. In the User Name field, enter the user name for an AgilePoint NX user with permission run your AgilePoint NX app.
    Figure: Start Workflow screen

    Start Workflow screen
  4. In the Password field, enter the password for your AgilePoint NX user.
    Figure: Start Workflow screen

    Start Workflow screen
  5. Click Load Process Models.
    Figure: Start Workflow screen

    Start Workflow screen
  6. In the Process Model Name list, select Customer Enquiry.

    Customer Enquiry is an app you can download from AgilePoint NX App Store.

    For more information, refer to How to Get the App.

    Figure: Start Workflow screen

    Start Workflow screen
  7. Click Process Data.
    Figure: Start Workflow screen

    Start Workflow screen
  8. On the Set Process Data screen, enter the value for each field on the screen.

    The values in the Name field are the Xpath of the Customer Enquiry form fields in the Customer Enquiry app.

    Figure: Set Process Data screen

    Set Process Data screen
  9. Click OK.

    This screen shows.

    Figure: Customer Enquiry Process screen

    Customer Enquiry Process screen

Step 2: Publish a Process in UiPath Studio

To publish a process in UiPath Studio, do the procedure in this topic.

How to Start

  1. In UiPath Studio, on the Design tab, click Publish

    UiPath Studio screen

Procedure

  1. On the Publish Project screen, click Publish.
    Figure: Publish Project screen

    Publish Project screen

    When the process is published, this message shows.

    Figure: Process Publish Message screen

    Process Publish Message screen

Step 3: Deploy the Process in UiPath Orchestator

To deploy the process in UiPath Orchestator, do the procedure in this topic.

Prerequisites

  • Create a service named DevelopmentService in UiPath Orchestrator.

    This is an example value that is specific to the scenario in this document. In a production environment, use a value that is appropriate to your use case.

How to Start

  1. Go to https://platform.uipath.com.

Procedure

  1. On the UiPath Orchestator Home screen, in the left pane, click SERVICES.
    Figure: UiPath Orchestator Home screen

    UiPath Orchestrator Home screen
  2. On the Services screen, click DevelopmentService.

    This is an example value that is specific to the scenario in this document. In a production environment, use a value that is appropriate to your use case.

    Figure: Services screen

    Services screen
  3. On the Development Service screen, in the left pane, click PROCESSES.
    Figure: Development Service screen

    Development Service screen
  4. On the Processes screen, click Add Add icon.
    Figure: Processes screen

    Processes screen
  5. On the Deploy Process screen, in the Package Name field, select CustomerEnquiryProcess.

    This is an example value that is specific to the scenario in this document. In a production environment, use a value that is appropriate to your use case.

    Figure: Deploy Process screen

    Deploy Process screen
  6. Click Create.

    The UiPath Orchestator shows your deployed process.

    Figure: Deployed Processes screen

    Deployed Processes screen

Step 4: Start a Job in UiPath Orchestator

To start a job in UiPath Orchestator, do the procedure in this topic.

Prerequisites

  • Create a robot named Robot in UiPath Orchestrator.

    This is an example value that is specific to the scenario in this document. In a production environment, use a value that is appropriate to your use case.

Procedure

  1. On the Development Service screen, in the left pane, click JOBS.
    Figure: Development Service screen

    Development Service screen
  2. On the Jobs screen, click Start Job.
    Figure: Jobs screen

    Jobs screen
  3. On the Start Job screen, in the Process field, select CustomerEnquiryProcess_env1.
    Figure: Start Job screen

    Start Job screen
  4. On the Specific Robot tab, select Robot.

    This is an example value that is specific to the scenario in this document. In a production environment, use a value that is appropriate to your use case.

    Figure: Start Job screen

    Start Job Specific Robot screen
  5. Click Start.

    The UiPath Orchestator shows your executed process.

    Figure: Executed Processes screen

    Executed Processes screen

Step 5: (Optional) View the Records in Your eForm

To view the records you created in UiPath Orchestator, do the procedure in this topic.

How to Start

  1. On the AgilePoint NX Portal, click Work Center Work Center icon.

    Work Center screen
  2. On the Work Center screen, click Inbox Inbox icon.

    Inbox screen

Procedure

  1. Click the Processes I Started tab.

    Processes I Started screen
  2. On the Processes I Started tab, click Customer Enquiry > eForms Report View eForms Report View icon.

    eForm report View
  3. The View form shows the records you created in UiPath Orchestator.

    Customer Enquiry Form

How to Get the App

This example is based on the Customer Enquiry app from the AgilePoint NX App Store. Use this procedure to get the app.

Prerequisites

Good to Know

  • This procedure is optional. It is provided so you can test the example with an out-of-the-box app.
  • This is part of the Background and Setup procedures, but many users preferred this step to appear after the example, not before it.

Get the App

  1. Click App Store App Store icon.

    App Store
  2. In CATEGORY section, click Marketing.

    App Store screen
  3. Click the Customer Enquiry app.

    Marketing Apps screen
  4. On the Customer Enquiry screen, click Add.

    Customer Enquiry screen
  5. On the Trust App screen, click Trust it.
  6. Click Return to site.