Configure an iterator

A new home for the Coupa Supply Chain documentation

Starting with Supply Chain 42, our documentation will be located on Coupa Compass. The help here will continue to be accessible for the foreseeable future, but will no longer be updated. If you need a Compass user account, contact your company’s Designated Support Contact (DSC).

You can access new and updated Supply Chain documentation in the following location on Compass:

https://compass.coupa.com/en-us/products/supply-chain-design-and-planning

Configure an iterator

An iterator is an action configured to run on each record in a table. You can configure iterators to use a global parameter or a local variable. Each method achieves similar results, but only the local variable method allows you to specify a data type for the parameter value.

Create an iterator using a global parameter

Create a parent and child relationship between two macros. The child macro should consist of one or more actions that you want to iterate on each record in a data set.
Define a global variable in the embedded macro and configure the macro to iterate against a specified data set:
1. In the Layout Designer pane, in the Projects section, select the parent macro.
2. On the design surface, select the embedded macro.
3. In the edit ribbon, select Edit the action.
  The properties dialog box for the embedded macro is displayed.
4. On the Iterate tab, in the Iterate Over section, select Add Statement.
  In the statement editor, an empty box is displayed.
5. In the box, type the global variable. Ensure the name begins with two at signs (@@). For example, "@@venref".
6. Click .
  A box with a list of tables from the specified connection is displayed.
7. Select a table.
  A box with a list of columns from the selected table is displayed.
8. Select a column.
9. If you want to limit how many times the macro can iterate, type a number in the Only The First ___ Records box.
  You can specify any number for a maximum value. The default value is 100,000.
10. Adjust additional properties as necessary.
11. Click OK.
  On the design surface, the iterator symbol is now displayed with the child macro.
Configure each action in the child macro that you want to execute on the data set to process the global variable:
1. In the Projects section, select the child macro.
2. On the design surface, select an action.
3. In the edit ribbon, select Edit the action.
  The properties dialog box of the action is displayed.
4. On the Configure tab, specify the global variable for any property that acts upon the processed data. Enclose the variable in curly brackets. For example, "{@@venref}".
5. Click OK.
6. Repeat these steps for each action in the child macro that you want to process the local variable.
Use an event to configure how you want to execute the parent macro.
Click Save.
When the parent macro runs, the child macro iterates against each record in the specified data set.

Create an iterator using a local variable

Create a parent and child relationship between two macros. The child macro should consist of one or more actions that you want to iterate on each record in a data set.
Define a local variable in the parent macro:
1. In the Layout Designer pane, in the Projects section, select the parent macro.
2. Click , and choose Properties.
  The Macro Properties dialog box is displayed.
3. On the Parameters tab, select Add Local Variable.
4. In the Parameter Properties dialog box, provide values for the following:
  - Parameter Type — ensure this is set to Local Variable.
  - Name — type a name for the local variable. Ensure the name begins with a single at sign (@). For example, "@venref".
  - Data Type — specify a data type.
  - Initial Value — leave this blank.
5. Close the dialog boxes.
Configure each action in the child macro that you want to execute on the data set to process the local variable:
1. In the Projects section, select the child macro.
2. On the design surface, select an action.
3. In the edit ribbon, select Edit the action.
  The properties dialog box of the action is displayed.
4. On the Configure tab, specify the local variable for any property that acts upon the processed data. Enclose the variable in curly brackets. For example, "{@venref}".
5. Click OK.
6. Repeat these steps for each action in the child macro that you want to process the local variable.
Configure the child macro to iterate against a specified data set:
1. In the Projects section, select the parent macro again.
2. On the design surface, select the embedded macro.
3. In the edit ribbon, select Edit the action.
  The properties dialog box for the embedded macro is displayed.
4. On the Parameter Values tab, in the Please specify a value for __ box, type the local variable. Enclose the variable in curly brackets. For example, "{@venref}".
5. On the Iterate tab, in the Iterate Over section, select Add Statement.
  In the statement editor, an empty box is displayed.
6. In the box, type the local variable. For example, "@venref".
7. Click .
  A box with a list of tables from the specified connection is displayed.
8. Select a table.
  A box with a list of columns from the selected table is displayed.
9. Select a column.
10. If you want to limit how many times the macro can iterate, type a number in the Only The First ___ Records box.
  You can specify any number for a maximum value. The default value is 100,000.
11. Adjust additional properties as necessary.
12. Click OK.
  On the design surface, the iterator symbol is now displayed with the child macro.
Use an event to configure how you want to execute the parent macro.
Click Save.
When the parent macro runs, the child macro iterates against each record in the specified data set.

Last modified: Friday May 12, 2023

Is this useful?

Yes No