Submit Catalog Item Request action
Summarize
Summary of Submit Catalog Item Request action
The Submit Catalog Item Request action enables ServiceNow customers to create a requested item (screqitem) as part of a Service Catalog Request (screquest). This action is available within Workflow Studio as a core ServiceNow action and can be added to flows by users with theflowdesigneroradminroles. It streamlines the submission of catalog item requests directly within automated workflows.
Show less
Inputs
- Catalog Item: Select the catalog item to request. Additional dynamic inputs appear based on the catalog item selected (e.g., Preferred Email address for email account requests).
- Quantity: Specify the number of items requested.
- Special Instructions: Provide any textual instructions related to the request.
- Delivery Address: Indicate where the item should be delivered.
- Requested for: Identify the user for whom the item is requested.
- Don't fail on error: Choose whether the flow should continue if the action encounters an error.
- Wait for Completion: Decide if the flow should pause until the action completes before proceeding.
- Enable timeout: When waiting for completion, optionally set a timeout duration to avoid indefinite waiting.
- Duration: Specify the length of the wait time (hours, minutes, seconds) when timeout is enabled.
- Schedule: Define a work schedule to calculate wait time for timeout, respecting business hours.
Note: Some Service Catalog variable types are not supported as inputs, such as list collector lookup, multiple choice lookup, and select box.
Outputs
- Error Message: Provides an error message string if the action fails.
- Requested Item: Returns the document ID of the created requested item.
- Status: Numeric code indicating the action result: 0 (success), 1 (error), or 2 (timeout).
Design considerations
- Use the String Replace transform function to escape quotation marks in string data pills to prevent JSON formatting errors when working with complex string variables.
- Apply transform functions to validate and format data pill inputs to ensure data integrity before submission.
Practical application for ServiceNow customers
By incorporating the Submit Catalog Item Request action into flows, ServiceNow customers can automate catalog item submissions efficiently within their service delivery processes. The configurable inputs and output handling allow precise control over request details, error management, and flow execution timing. Utilizing transform functions enhances data reliability and prevents common errors related to string formatting. Overall, this action facilitates smoother, automated catalog requests aligned with business schedules and user needs.
Create a requested item [sc_req_item] on a Service Catalog Request [sc_request].
Roles and availability
Available as a Workflow Studio ServiceNow core action. Users with the flow_designer or admin role can add an action to a flow and define configuration details.
Inputs
| Input | Description |
|---|---|
| Catalog Item | Name of the requested catalog item. Extra inputs may be added dynamically, depending on which catalog item is selected. For example, when the requested catalog item is a new email account, a field for Preferred Email address appears. Note: The following Service Catalog variable types are not supported.
|
| Quantity | Number of items requested. |
| Special Instructions | Text describing any special instructions about the item request. |
| Delivery Address | Location where the requested item should be delivered. |
| Requested for | User that the item is requested for. |
| Don't fail on error | Option to determine whether to fail the flow if the action produces an error. |
| Wait for Completion | Option to force the flow to wait until the action has been completed before continuing. |
| Enable timeout | Option to limit the amount of time that the flow waits for the action to be completed before continuing.
Note: Use the Enable timeout option to prevent this action from
continuing to run. If the condition to continue is never met, a timeout value specifies when the system skips the Wait for Condition action and go to the next item in the flow. You must set a Duration value
to enable a timeout. You can also select a Schedule if you want to compute the duration end date based on a specific work schedule. This field appears only when the Wait for Completion option is selected. |
| Duration | Amount of time that the flow waits before continuing when the Enable timeout option is selected. Enter the time to wait in hours, minutes, and seconds. If you leave this field empty, the flow does not wait. This field appears only when the Wait for Completion option is selected. |
| Schedule | Schedule used to compute the timeout duration when the Enable timeout option is selected. For example, waiting for 10 hours as part of an 8-5 weekdays schedule causes the flow to wait for one or more business days. If you leave this field empty, the timeout runs without a schedule. This field appears only when the Wait for Completion option is selected. |
Output
| Field | Description | Data Type |
|---|---|---|
| Error Message | Message that displays if the action produces an error. | String |
| Requested Item | Document ID for the requested item. | Document ID |
| Status | The completion status of the action as a numeric value.
|
Choice |
Example
Design considerations
Follow these design considerations when creating flows that contain Submit a Catalog Item Request actions.
- Escape quotation marks from string data pills with the String Replace transform function
- Complex string variables are converted into JSON format when stored in the system. To prevent any JSON formatting errors, you can use a Replace String transform function to escape the quotation marks present in any string data pills you use for catalog variables. See String transform functions.
- Use transform functions to validate data pills
- Whenever you use a data pill to provide data for an action input, you can use a transform function to validate the data. See Transform functions for a list of available transform functions.