Managing Arguments

Arguments are used to pass data from a project to another. In a global sense, they resemble variables, as they store data dynamically and pass it on. Variables pass data between activities, while arguments pass data between automations. As a result, they enable you to reuse certain projects time and again.

Studio supports a large number of argument types, which coincide with the types of variables. Therefore, you can create Generic Value, String, Boolean, Object, Array, or DataTable arguments and you can also browse for .Net types, just as you do in the case of variables.

Additionally, arguments have specific directions (In, Out, In/Out, Property) that tell the application where the information stored in them is supposed to go.

Important:

If there are both a variable and an argument with the same name, the variable is always defaulted to and used at runtime.
Passing complex In arguments (for example, of type System.Data.DataTable) to an Invoke Workflow File activity that is not isolated acts as if a reference is passed, which means any changes to the object inside the invoked workflow change the object in the main workflow. Built-in argument types (for example, Boolean) are always passed as values.

Please take into consideration that if you create an In/Out argument with an In value when used in the Invoke Workflow activity, and then change the value to Out, you may notice that an error is thrown when executing the project. This is because the Invoke Workflow activity did not return the values by reference. Use a Global Handler in your project to get access to the exact values the arguments had inside the invoked workflow.

Lastly, these arguments can be used to integrate with other tools in your company, as they are exposed in Orchestrator too. This means that any process you create can now receive input parameters through the Orchestrator API or interface, as well as return an output to all of the aforementioned. More information is available here.

Creating Arguments

Argument names should be in upper CamelCase with a prefix stating the argument direction, such as in_DefaultTimeout, in_FileName, out_TextResult, io_RetryNumber. You can check out our Workflow Design Naming Conventions recommendations for more details.

From the Body of an Activity

From the Activities panel, drag an activity to the Designer panel. Right-click a field and select Create In Argument or Create Out Argument from the context menu. Alternatively, press Ctrl+M or Ctrl+Shift+M. The Set Arg field is displayed.
Fill in the name and press Enter. The argument is created and visible in the field. Check its direction and type in the Arguments panel.

From Expressions

Alternatively, arguments can be created from expressions directly in an activity input field or the Expression Editor:

Select a part of the expression and press Ctrl+M or Ctrl+Shift+M. The Set Arg field is displayed.
Fill in the name and press Enter. The argument is created. Check its type and direction in the Arguments panel.

Arguments created in these ways automatically receive the type according to the activity. For example, if you create an argument in the Data Table field of a Write Range activity, the argument's type is set to DataTable. If you create an argument in the Text field of a Write Line activity, the argument's type is set to String.

From the Properties Panel

In the Properties panel of any activity, right-click a field that can be edited, and select Create In Argument or Create Out Argument from the context menu. Alternatively, press Ctrl+M or Ctrl+Shift+M. The Set Arg field is displayed.
Fill in the name and press Enter. The argument is created and visible in the field. Check its direction and type in the Arguments panel.

The argument type is automatically generated depending on the selected property.

From the Arguments Panel

In the Designer panel, click Arguments. The Arguments panel is displayed.
Click the Create Argument line, and fill in the name. A new argument is created.

Note: By default, all arguments are of String type and have an In direction.

Removing Arguments

To remove an argument, in the Arguments panel, either right-click the argument and select Delete, or select the argument and press the Delete key.