Managing Packet Parameters

Packet parameters allow users to populate multiple reports in a packet at the same time with shared values. Setting up packet parameters can make packets much more flexible by allowing users to change dates, numbers, text, and other values in multiple reports with a single setting.

Example

A user has a packet that contains 10 reports, and wants to be able to change the Start Period for all 10 reports at once.

The user creates a packet parameter with a Type of Period and a Default value of Current Month, then modifies each of the 10 reports to use this packet parameter in the Start Period field.

When the packet is run, the Start Period parameter is populated with Current Month in all 10 reports. If the user changes the default value of the packet parameter from Current Month to Previous Month, all of the reports populate the Start Period parameter with Previous Month instead when the packet is run.

Packets can be set up with business rules by using settings described below, such as Minimum value, Maximum value, and Restricted characters. These settings can help to ensure that users only use values that make sense.

Understanding Packet Parameter Types

There are several types of packet parameter you can leverage, and each type offers different options. The following packet parameter types are available:

▪ Checkbox—This parameter type allows you to set a binary value. The following option is available when using this parameter type:

▪ Default value—Select either True or False.

▪ Date—This parameter type allows you to set a date or relative date. The following options are available when using this parameter type:

▪ Required—Select this check box to make this packet parameter required in order to run the packet.

▪ Minimum value—Enter the minimum date that can be entered for this parameter, or leave this field blank to apply no restriction. You can also use a variable to apply a relative date.

▪ Maximum value—Enter the maximum date that can be entered for this parameter, or leave this field blank to apply no restriction. You can also use a variable to apply a relative date.

▪ Default value—Enter the default date to use for this parameter. You can also use a variable to apply a relative date.

▪ Period—This parameter type allows you to set a period or relative period. The following options are available when using this parameter type:

▪ Required—Select this check box to make this packet parameter required in order to run the packet.

▪ Minimum value—Enter the minimum period that can be entered for this parameter, or leave this field blank to apply no restriction. You can also use a variable to apply a relative period.

▪ Maximum value—Enter the maximum period that can be entered for this parameter, or leave this field blank to apply no restriction. You can also use a variable to apply a relative period.

▪ Default value—Enter the default period to use for this parameter. You can also use a variable to apply a relative period.

▪ Number—This parameter type allows you to set a numeric value. The following options are available when using this parameter type:

▪ Required—Select this check box to make this packet parameter required in order to run the packet.

▪ Minimum value—Enter the minimum number that can be entered for this parameter, or leave this field blank to apply no restriction.

▪ Maximum value—Enter the maximum number that can be entered for this parameter, or leave this field blank to apply no restriction.

▪ Increment value—Enter the value by which the number should increment. Ensure that all possible values are divisible by this amount. For example, an Increment value of 0.1 would allow values such as 0.1, 0.2, and 0.3, but not 0.25.

▪ Default value—Enter the default number to use for this parameter.

▪ Text—This parameter type allows you to set a string of text. The following options are available when using this parameter type:

▪ Required—Select this check box to make this packet parameter required in order to run the packet.

▪ Character limit—Enter the maximum number of characters that can be included in the entered text, or leave this field blank to apply no restriction.

▪ Restricted characters—Enter any characters that should be considered invalid. Any character entered in this field will be restricted, including commas and spaces.

▪ Default value—Enter the default text to use for this parameter.

▪ Get options from API—This parameter type allows you to set one or more values retrieved by an API.

Note

All report parameters in Report Gateway come from APIs. If you want to include a specific parameter from a report, use the Get options from API packet parameter type.

The following options are available when using this parameter type:

▪ Application—Select the application from which the API will be run.

▪ Client ID—Select a valid client ID for the application.

▪ Username—Select a valid user name for the application.

▪ Database—Select a valid database for the application.

▪ API—Select an API from the list of APIs available for the selected application and data context.

▪ Required—Select this check box to make this packet parameter required in order to run the packet.

▪ Allow multiple—Select this check box to allow entering more than one value in the Default value field.

▪ Default value—Enter the default value to use for this parameter. If the Allow multiple check box is selected, you can select multiple values.

Adding Packet Parameters

To add a new packet parameter to a packet, follow these steps:

1. Open the packet for which you want to create a packet parameter.

2. On the Manage Packet page, in the Packet parameters section, click Add.

3. In the Parameter name field, enter a name for the packet parameter.

4. In the Parameter type field, select a parameter type. For more information on each parameter type, refer to the "Understanding Packet Parameter Types" section above.

5. Complete the remaining fields for the packet parameter. These fields are different for each parameter type. Refer to the "Understanding Packet Parameter Types" section above for explanations of these fields.

6. Click Add. Your parameter appears in the Packet parameters section.

After you have created the packet parameter, you must update the reports in your packet to use the packet parameter. To do so, follow these steps:

1. On the Manage Packet page, in the Packet contents section, click the Edit icon on the card of the report you want to edit.

2. In the Presets section of the Edit report drawer, locate the field you want to populate using a packet parameter.

3. Click the Variable icon.

4. In the Variable type field, select Packet parameter.

5. In the Parameter field, select the packet parameter you created.

6. Click Use variable.

7. Repeat the steps above for each report parameter that should use a packet parameter.

Modifying Packet Parameters

To modify an existing packet parameter, follow these steps:

1. Open the packet that contains the packet parameter you want to modify.

2. In the Packet parameters section, click Edit.

3. In the Edit packet parameters drawer, modify your packet parameters in any of the following ways as needed:

▪ To reorder the packet parameters, click and hold on the 6 dot icon, then drag the parameter to a different position.

▪ To edit the details of a packet parameter, click the Edit icon next to it, then edit the fields as needed. Refer to the instructions above for more information.

4. Click Done.

After packet parameters have been modified, users can revert them to their default values by clicking Reset to defaults in the Packet parameters section. If you want to change a packet parameter before scheduling the packet, you must delete the original packet parameter and create a new one.

Deleting Packet Parameters

To delete an existing packet parameter, follow these steps:

1. Open the packet that contains the packet parameter you want to delete.

2. In the Packet parameters section, click the Delete icon next to the packet parameter you want to delete.