Process Arguments

Process Arguments let you set up input and output variables for your automation processes. You can use them to send data into a process or get results back, especially when you're using the client API.

How to Use Process Arguments

Every process in Robotiq.ai has a "Process Arguments" step. This is where you set up the variables your process will use.

Step 1: Open the Process Arguments Editor

  1. Open your process.
  2. Right-click the "Process Arguments" step.
  3. Choose "Edit" to open the editor window.

Step 2: Add Arguments

You can add two kinds of arguments:

  • Input Arguments: These variables change each time the process runs. They send data into the process.

Output Arguments: These variables give information about what the process did. They send data out of the process.

Click the "Add argument" button.

  • Pick the argument type (Input or Output).
  • Set the variable type:
    • Integer
    • Decimal
    • Boolean
    • String
    • DateTime
  • Type in a default value for the argument.
  • Do these steps again to add more arguments.

Important: Always set default values for your arguments. These values are used when you're building and testing. For output arguments, a default value helps show if the process failed before it could set a real value.

Step 3: Confirm Changes

  1. After you've added all arguments, click "Confirm".
  2. Save your process. All changes to Process Arguments will be saved.

When to Use Process Arguments

  • Development: Default values make sure your process has data to work with while you build and test it.
  • Unattended Modes (Test or Production): When you run processes without someone watching them (like in Test or Production stages), you set the input arguments for each run. This happens when you create a job using the API or set up a Scheduler.
  • API Communication: Output arguments are mainly used for APIs to share the results of the robot's work.

Related Articles

  • Processes - Learn how to create and manage your automation processes.
  • Global variables - Understand the difference between process arguments and global variables.

Need Help?

Can't find what you're looking for? Join the Robotiq Community to get help from other users and the Robotiq team.
 

Was this article helpful?