Service Catalog in Service Portal category

  • Release version: Australia
  • Updated March 12, 2026
  • 23 minutes to read

    • Validate catalog item transactions and requester flows from Service Portal.

    Activation of the Automated Test Framework for Service Catalog in Service Portal

    These ATF test steps require activation of the Automated Test Framework Service Catalog Service Portal (com.glide.automated_testing_impl.service_catalog_portal) 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 in Service Portal step configurations support parametrized tests. For more information on parametrized tests, refer to Parameterized tests.

    Open a Record Producer (SP)

    Open a record producer in the Service Portal.

    Table 1. Inputs
    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.
    Portal Portal for which you want to test this step.
    Page Service Catalog page associated with the test step.
    Record Producer Record producer that you want to open.
    Note:
    You should have access to the record producer.
    Query Parameters URL query parameters for the page, such as sys_id.

    Open a Catalog Item (SP)

    Open a catalog item in the Service Portal.

    Table 2. Inputs
    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.
    Portal Portal for which you want to test this step.
    Page Service Catalog page associated with the test step.
    Catalog Item Catalog item that you want to open.
    Note:
    You should have access to this catalog item.
    Query Parameters URL query parameters for the page, such as sys_id.

    Open an Order Guide (SP)

    Open an order guide in the Service Portal.

    Table 3. Inputs
    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.
    Portal Portal for which you want to test this step.
    Page Service Catalog page associated with the test step.
    Order Guide Order guide that you want to open.
    Note:
    You should have access to this order guide.
    Query Parameters URL query parameters for the page, such as sys_id.

    Add row to multi-row variable set (SP)

    Add a row to a multi-row variable set included in the current catalog item in Service Portal. You can use this step configuration only when the current catalog item contains a multi-row variable set.

    Use this step after the Open a Catalog Item(SP) step, Open a Record Producer(SP) step, or Open an Order Guide (SP) step. If a contextual value has been used for the Open a Catalog Item(SP) step, Open a Record Producer(SP) step, or Open an Order Guide (SP) step, set the catalog item in this step.

    Table 4. Inputs
    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.
    Notes Notes about the test step.
    Catalog Item Catalog item whose multi-row variable set requires an addition of a row. If an item is not already selected, you can either search for the item, or insert a reference to the contextual value of the item from a list of available parameters.
    Multi-Row Variable Set Multi-row variable set for which a row should be added.

    Save current row of multi-row variable set (SP)

    Save the current row of a multi-row variable set included in the current catalog item in Service Portal. You can use this step configuration only when the current catalog item contains a multi-row variable set. Use this step after the Add row to multi-row variable set (SP) step.

    Table 5. Inputs
    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.
    Notes Notes about the test step.
    Assert Type Criteria for the test to pass.
    Successfully saved row to a multi-row variable set
    Test passes only if the current row of the multi-row variable is saved.
    Cannot save a row to multi-row variable set
    Test passes only if the current row of the multi-row variable is not saved.

    Set Variable Values (SP)

    Set variable values for a catalog item or record producer in the Service Portal. For a catalog item, use this step after using the Open a Catalog Item (SP) step, and before using the Order Catalog Item (SP) step.

    For a record producer, use this step after using the Open a Record Producer (SP) step, and before using the Submit Record Producer (SP) step.

    Table 6. Inputs
    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.
    Multi-Row Variable Set Multi-row variable set for which variable values should be set.
    Note:
    Use the Add row to multi-row variable set (SP) step configuration prior to the current step configuration.
    Variable Values List of variables and the values that you want to set for them.
    Note:
    You can set the value for multiple variables.
    Note:
    Custom variables and custom variable with labels are not supported for Set Variable Values step configuration.

    Validate Variable Values (SP)

    Validates variable values of a catalog item or record producer in Service Portal. For a catalog item, use this step after using the Open a Catalog Item (SP) step, and before using the Order Catalog Item (SP) step.

    For a record producer, use this step after using the Open a Record Producer (SP) step, and before using the Submit Record Producer (SP) step.

    Table 7. Inputs
    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.
    Multi-Row Variable Set Multi-row variable set for which variable values should be validated.
    Note:
    Use the Add row to multi-row variable set (SP) step configuration prior to the current step configuration.
    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.
    Note:
    Custom variables and custom variable with labels are not supported for Validate Variable Values step configuration.

    Variable State Validation (SP)

    Validates the state of variables in Service Portal. Possible variable states are mandatory, not mandatory, read only, not read only, visible, and not visible.

    Table 8. Inputs
    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.
    Item Catalog item or record producer whose variables should be validated.
    Multi-Row Variable Set Multi-row variable set for which variable states should be validated.
    Note:
    Use the Add row to multi-row variable set (SP) step configuration prior to the current step configuration.
    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.
    Note:
    Custom variables and custom variable with labels are not supported for Variable State Validation step configuration.

    Validate Price and Recurring Price (SP)

    Validate the price and recurring price of a catalog item in Service Portal. Use this step after using the Open a Catalog Item (SP) step, and before using the Order Catalog Item (SP) step. This step is not applicable for a record producer.

    Table 9. Inputs
    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.

    Navigate within Order Guide (SP)

    Navigate within an order guide.

    Table 10. Inputs
    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.
    Guide Step Order guide step to which you want to navigate:
    • Describe Needs
    • Choose Options
    • Summary
    Assert Type Criteria for the test to pass.
    Navigation Successful
    Test passes only if the navigation is successful.
    Navigation Failed
    Test passes only if the navigation fails.

    Set Catalog Item Quantity (SP)

    Set the quantity for a catalog item in Service Portal. This step is not applicable for a record producer. Use this step after using the Open a Catalog Item (SP) step, and before using the Order Catalog Item (SP) step.

    Table 11. Inputs
    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.
    Quantity Quantity of the catalog item that you want to order.

    Validate Order Guide Items (SP)

    Validate items included in the order guide.

    Table 12. Inputs
    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 Items Catalog items that you want to validate.
    Note:
    You should have access to these catalog items.

    Review Order Guide Summary (SP)

    Review the order guide summary in the Service Portal.

    Table 13. Inputs
    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 Items Catalog items that you want to review.
    Note:
    You should have access to these catalog items.
    Price Price of the catalog item for the step to pass.

    Review Item in Order Guide (SP)

    Review individual items in the order guide and choose whether or not to include the item.

    Table 14. Inputs
    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 that you want to review.
    Note:
    You should have access to this catalog item.
    Included Selected if the catalog item should be included in the order guide, otherwise unselected.

    Add Item to Shopping Cart (SP)

    Add the current catalog item to the shopping cart in Service Portal. Use this step after using the Open a Catalog Item (SP) step.

    Table 15. Inputs
    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.
    Table 16. Outputs
    Field Description
    cart_item_id The sys_id of the added catalog item.

    Add Order Guide to Shopping Cart (SP)

    Add an order guide to the shopping cart.

    Table 17. Input
    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.
    Cannot add order guide to shopping cart
    Test passes only if the order guide cannot be added to the shopping cart.
    Successfully added order guide to shopping cart
    Test passes only if the order guide is successfully added to the shopping cart.

    Order a Catalog Item (SP)

    Click Order Now for the current catalog item in the Service Portal. Use this step after using the Open a Catalog Item (SP) 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.

    Table 18. Inputs
    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.
    Table 19. Outputs
    Field Description
    table The table to which the submitted request belongs.
    record_id The sys_id of the submitted request.

    Submit an Order Guide (SP)

    Click Order Now to order an order guide. Do not add more than one record producer to the order guide.

    Table 20. Inputs
    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.
    Cannot order the Order Guide
    Test passes only if the order guide cannot be ordered.
    Successfully ordered the Order Guide
    Test passes only if the order guide is successfully ordered.
    Table 21. Outputs
    Field Description
    table The table containing the submitted order guide.
    record_id The sys_id of the submitted order guide.

    Submit Record Producer (SP)

    Submit the current record producer in the Service Portal. Use this step after using the Open a Record producer (SP) step. After this step, you cannot use any other steps on the record producer.

    Table 22. Inputs
    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.
    Table 23. Outputs
    Field Description
    table The table containing target record of the record producer.