Service Catalog category

reference brazil Updated Sep 10, 2026 13 min read test-steps-service-catalog-category.md
Raw file servicenow.com

Validate single catalog item transactions as well as requester and fulfiller flows in Service Catalog.

Activation of the Automated Test Framework for Service Catalog

These test steps require activation of the The Automated Test Framework Service Catalog (com.glide.automated_testing_impl.service_catalog) plugin, which is active by default on new instances. Administrators may need to activate the plugin on instances upgraded from earlier versions.

Support for parametrized tests

Service Catalog step configurations support parametrized tests. For more information on parametrized tests, refer to Parameterized tests.

Variable editor support

After opening a record that supports variable editor (requested item, catalog task, or incident), you can add step configurations to set variable values, or validate variable states or values. Use the step configurations in the following order to support variable editor.

  1. Step configurations to order a catalog item or record producer in the Service Catalog category.
  2. Open an Existing Record step configuration in the Form category.
  3. Set Variable Values, Validate Variable Values, or Variable State Validation step configuration in the Service Catalog category.

Note: Custom variables and custom variable with labels are not supported for Set Variable Values, Validate Variable Values, and Variable State Validation step configurations.

Open a Catalog Item

Open a catalog item.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Catalog Item

Catalog item that you want to open.Note: You should have access to this catalog item.

## Open a Record Producer

Open a record producer.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Record Producer

Record producer that you want to open.Note: You should have access to the record producer.

## Set Variable Values

Set variable values for the current catalog item or the record producer.

For a catalog item, use this step after opening a catalog item page using the Open a Catalog Item step, and before using the Order Catalog Item step. For a record producer, use this step after opening a record producer page using the Open a Record Producer step, and before using the Submit Record Producer step.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.Note: Use the condition builder to set the field value. The condition builder displays an appropriate control for the field data type. For example, a reference field displays a Lookup record control.

Item

Catalog item or record producer for which you want to set variable values.

Variable Values

List of variables and the values that you want to set for them.Note: You can set the value for multiple variables.

## Set Catalog Item Quantity

Set the quantity for the current catalog item.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Item

Catalog item whose quantity you want to set.

Quantity

Quantity you want to set for the catalog item.

## Validate Variable Values

Validate variable values on the current catalog item or record producer.

For a catalog item, use this step after opening a catalog item page using the Open a Catalog Item step, and before using the Order Catalog Item step. For a record producer, use this step after opening a record producer page using the Open a Record Producer step, and before using the Submit Record Producer step.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Timeout

Number of seconds allowed before the step fails. If the validation fails, the system repeats the step until it reaches the duration of the timeout. If the validation fails after the timeout duration has passed, the step fails.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.Note: Use the condition builder to set the field value. The condition builder displays an appropriate control for the field data type. For example, a reference field displays a Lookup record control.

Item

Catalog item or record producer whose variables should be validated.

Catalog Conditions

Conditions for variable validation. If the conditions are met, the test passes.Note: The label of a variable associated with a variable set reflects the variable set name. The format is variable_set_name » variable_name.

## Variable State Validation

Validate the state of variables. Possible variable states are mandatory, not mandatory, read only, not read only, visible, and not visible.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Timeout

Number of seconds allowed before the step fails. If the validation fails, the system repeats the step until it reaches the duration of the timeout. If the validation fails after the timeout duration has passed, the step fails.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Catalog item

Catalog item for which you want to validate the state.Note: You should have access to this catalog item.

Visible

List of the catalog item variables that must be visible for the step to pass.

Not visible

List of the catalog item variables that must be hidden for the step to pass.

Read only

List of the catalog item variables that must be read-only for the step to pass.

Not read only

List of the catalog item variables that must not be read-only for the step to pass.

Mandatory

List of the catalog item variables that must be mandatory for the step to pass.

Not mandatory

List of the catalog item variables that must not be mandatory for the step to pass.

## Validate Price and Recurring Price

Validate price and recurring price of a catalog item. Use this step after opening a catalog item page using the Open a Catalog Item step, and before using the Order Catalog Item step.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Price

Price of the catalog item for the step to pass.

Recurring price

Recurring price of the catalog item for the step to pass.

Recurring price frequency

Recurring price frequency of the catalog item for the step to pass.

## Add Item to Shopping Cart

Add a catalog item to the shopping cart. Use this step after opening a catalog item page using the Open a Catalog Item step. After this step, you cannot use any other steps on the catalog item.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Timeout

Number of seconds allowed before the step fails. If the validation fails, the system repeats the step until it reaches the duration of the timeout. If the validation fails after the timeout duration has passed, the step fails.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Assert Type

Criteria for the test to pass.- Successfully added item to Shopping Cart

Test passes only if the catalog item is successfully added to the shopping cart.

  • Cannot add item to Shopping Cart

Test passes only if the catalog item cannot be added to the shopping cart.

|Field|Description| |-----|-----------| |cart\_item\_id|The sys\_id of the added catalog item.|

Order Catalog Item

Clicks Order Now for a catalog item. Use this step after opening a catalog item page using the Open a Catalog Item step.

After this step, you cannot use any other steps on the catalog item. If the two-step checkout is false, a request is generated for the catalog item. If the two-step checkout is true, you are redirected to the cart preview page.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Timeout

Number of seconds allowed before the step fails. If the validation fails, the system repeats the step until it reaches the duration of the timeout. If the validation fails after the timeout duration has passed, the step fails.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Assert type

Criteria for the test to pass.- Successfully ordered Catalog Item

Test passes only if the catalog item is successfully ordered.

  • Cannot order Catalog Item

Test passes only if the catalog item cannot be ordered.

|Field|Description| |-----|-----------| |request\_id|The sys\_id of the created catalog request.| |cart|the sys\_id of the cart holding the catalog item.|

Submit Record Producer

Submits the current record producer. Use this step after opening the record producer page using the Open a Record producer step. After this step, you cannot use any other steps on the catalog item.

Field

Description

Execution order

Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them in. You can change this default order by editing the Execution order values.

Active

Option to activate this test step for use.

Timeout

Number of seconds allowed before the step fails. If the validation fails, the system repeats the step until it reaches the duration of the timeout. If the validation fails after the timeout duration has passed, the step fails.

Application

Application scope in which the system runs this step.

Test

Read-only name of the test that you're adding the step to.

Step config

Read-only name of the step.

Description

Description of the test step. This field value is automatically set based on the field values of the test step. This field appears after the test step is submitted.

Notes

Notes about the test step.

Assert Type

Criteria for the test to pass.- Successfully submitted Record Producer

Test passes only if the record producer is submitted successfully.

  • Cannot submit Record Producer

Test passes only if the record producer cannot be submitted.

|Field|Description| |-----|-----------| |record\_id|The sys\_id of target record of the record producer.|
Search documentation
Search document titles and file paths on the brazil branch