Get Nintex RPA Wizard ID step

Use the Get Nintex RPA Wizard ID step to retrieve the ID of a specified Nintex RPA Wizard, allowing subsequent steps such as the Add Nintex RPA Task step to reference and execute the correct automation.

Drag the Get Nintex RPA Wizard ID step from the Nintex RPA category, Favorites bar, or the Recent category onto the canvas.

Example of a Get Nintex RPA Wizard ID step in a workflow

  1. From the Toolbox click the Nintex RPA category, and then drag the Get Nintex RPA Wizard ID step onto the canvas.

  2. Select the added step and click the expand / collapse toggle to expand the Configuration Panel. You can also double click the step to expand the panel.

  3. Select the Get Nintex RPA Wizard ID tab. Use this tab to configure the steps properties.

    4. The following table explains the available options:

    Option Explanation How to Use
    Pick Service and SmartObject

    Use this to select the Nintex RPA SmartObject, that is linked to your RPA server. This allows the step to link to the Wizard from the RPA server.

    Click the menu and click Browse to browse to a specific SmartObject.

    Click the edit button to make changes to the field.
    Properties

    Use this to add properties and detail that must be retrieved from the Nintex RPA Wizard.Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.

    Click the property field to add a value by typing or dragging it.

    Click the Add button to add the property field.

    To delete a property, select it and click the trash can.
    Filters

    The filter allows you to specify parameters and filters to return data.

    Applying filters is optional. Use operators such as Equal, Not Equal, Starts With, Ends With, and Contains.

    Parameters are sometimes required - it depends on the SmartObject method selected. If the method has parameters, you probably need to provide values for those parameters to execute the method.

    Click the Add Filter link to add filters.

    Select filter values from the drop-down menu.

    Click the operator button to select the operator.

    Click Add to add additional filter properties

    Type values or create dynamic values by dragging Functions, Fields, SmartObjects and Workflow-related items from the Context Browser into the fields.

    To delete properties, select them and click the Trash bin.

    Create Reference Use this to create a reference to the retrieved Wizard ID to use in the Add Nintex RPATask step in a workflow.

    Click the Create link to create a reference.

    Click the Edit link to edit the reference name. If you edited the reference name and want to reset it, click the Reset Name link.
    Map to Variables

    The Output mappings for the Get Nintex RPA Wizard ID step are listed in this section. These mappings are used to store any return values from the Get Nintex RPA Wizard ID step. The return property can be mapped to a Variable, XML field or another SmartObject property.

    Click Add to add Variable Properties.
  4. From the menu select Browse and navigate to the SmartObject.

  5. Select the SmartObject and click OK.

    6. For more information about the different browse states and errors, see the Browse States topic.

    For more information on how to use the breadcrumb bar, see the How to use the Breadcrumb topic.

  6. Click the Add Filter button to add a filter to return the data from the Nintex RPA Wizard

  7. Select the filter property and add the value to filter the property by.

  8. To delete filters, select them and click the Trash bin
  9. To create a reference click Create. Reuse this reference in the current step or from another step in your workflow.

  10. To edit the auto-generated reference title, click Edit.
  11. To locate the added reference, expand the Context Browser, select Fields and then expand the Reference section.
  12. To create a variable click Add under the Properties Field.
  13. Select the property and then select or create a variable to map the property to.

  14. With the step selected, select the Properties tab.

    15. The following table explains the options available on this tab:

    Option Explanation How to Use
    Title / Name By default, each step on the canvas has a step title. You can change this title to suit your workflow logic and show it on the canvas by checking the Show Label box. Enter a value into the Title/Name field.
    Reset link Use the link to reset any changes to the title. Click the Reset link to reset the Title/Name field to default value.
    Show Label Allows you to see the step label on the canvas. The label shows the value of the title. Check the check box to display step label on the canvas.
    Description Allows you to add a detailed description for the step. Enter a value into the Create New field.
    Notes Allows you to add additional notes for the step. Enter a value into the Notes field.
  15. Click the Errors tab.

    16. Different types of exceptions can occur on a step, such as:

    Type Description
    Known exceptions Any SmartWizard or standard wizard that has Boolean options for handling known exceptions have these options displayed as check boxes in the Known exceptions section of the Exceptions tab.
    Unhandled exceptions Any unknown runtime exceptions.

    The tab contains the following known exception:

    Exception Explanation How to Use
    Continue on error On step execution and an error occurs, continue to the next step in the workflow. Check the check box to continue the workflow.

    The tab contains the following unhandled exceptions:

    Exception Explanation
    Log Exception Logs the exception to the error log.
    Force error when required SmartObject inputs are missing Will forcefully throw an error if a SmartObject method has input missing.
    Continue on error Will force the workflow to continue running the SmartObject method, even if it runs into an error.
    The exceptions in the table above is an example of those available in Workflow steps. The exceptions available depend on the Workflow step used in the design canvas.

  16. Your changes are automatically saved.