Create a service fulfillment step type
Expand the coverage of service fulfillment use cases beyond those supported by step types in base system. Using a service fulfillment step type, catalog item owners can define multiple steps that are part of the request fulfilment process.
Before you begin
Role required: admin
About this task
The following step types are available in the base system.
- Task
- Custom approval
- Manager approval
Procedure
- Set up a data store to store information needed for running the step. This information is provided by a catalog item owner while defining the request fulfillment process. Do one of the following.
| Option | Description |
|---|---|
| When additional input is required from the catalog item owner for a step type | Create a table by extending the Service Fulfillment Step [sc_service_fulfillment_step] table and add fields to store the additional input. For example, to create a step type for email notifications, the email id and body are the additional input provided by the catalog item owner while defining the steps. So, fields for email id and body should be added to the extended table to store the input.Note: Ensure that the new table has similar ACLs as that of the Service Fulfillment Step [sc_service_fulfillment_step] table. Note: Ensure that the new table has the canCreate, canUpdate, and canRead application access enabled. For tables extending the Service Fulfillment Step [sc_service_fulfillment_step] table, the Domain master attribute should be added and its value should be set as service_fulfillment_stage. The domain of a service fulfillment step is then inherited from the catalog item. |
| When no input is required for a step type | Use the Service Fulfillment Step \[sc\_service\_fulfillment\_step\] base table. For example, a department head approval does not require any additional input from the catalog item owner and does not need a new table. |
Create a record producer to store the values provided by the catalog item owner to the data store (base table or extended table) of that step. For information about creating a record producer, see Create a record producer.
Note:
- The Service Fulfillment Steps - Properties set variable set is automatically added to the record producer and it should not be removed from the record producer.
- All additional columns defined in the extended table should have corresponding variables mapped in the record producer.
- Configure the Record Producer form to display the Allow edit option and Save Options field. Also, select the Allow edit option and set the value of the Save Options field to Save in Destination.
- Ensure that the record producer is not restricted for the users with catalog_builder_editor role.
- Create a subflow to perform a sequence of actions by copying the Template: Service Fulfillment Steps subflow and then defining your subflow. For information about subflows, see Subflows.
| Parameter | Type | Description |
|---|---|---|
| requested\_item | Reference | RITM record |
| service\_fulfillment\_step\_data | Reference | Step data record. Update the state to one of the following values before ending the subflow:- canceled - failed - completed |
| service\_fulfillment\_step | Reference | Step defined on a catalog item. It must refer to a table in which the record producer defined in the step configuration inserts a record.Do not update the step record. |
For information about subflow field types, see [Field types](../../platform-administration/r_FieldTypes.md).
Create a step configuration to define the behavior and display of a service fulfillment step type.
Navigate to Service Catalog > Catalog Administration > Service Fulfillment Step Configurations.
Click New.
On the form, fill in the fields.
| Field | Description | |
|---|---|---|
| Name | Name of the step configuration. | |
| Application | Application scope in which the step configuration is supported. | |
| Active | Option to enable the service fulfillment support for the flow. | |
| Order | Order of the step configuration.Based on the order of step configurations, the corresponding service fulfillment step types are displayed in the list in the Steps region of the Fulfillment step. The step type corresponding to the step configuration with the least order is displayed beside the list and step types for all other step configurations are included in the list based on their order. Image omitted: step-type-order.png Hideorder of service fulfillment step types</p></td></tr><tr><td> | Hides the step type corresponding to this step configuration in the list in the Steps region of the Fulfillment step. No impact on existing steps. |
| Short description | Description of the step configuration. | |
| Producer | Record producer that creates an instance of the step type in the step’s data store. | |
| Service fulfillment subflow | Subflow triggered during the request fulfillment process. | |
| Dynamic title | Text that should be displayed for the corresponding service fulfillment step in the Steps region of the Fulfillment step. If you don’t provide any value, the step configuration name is displayed. To display dynamic text, you can include the field name from the step's data store (base table or the extended table) where the associated record producer creates a record. For example, in the base system, the Dynamic title field for the Custom approval step configuration contains the following value: Here, approval_title is the field from the Service Fulfillment Approval Step [sc_service_fulfillment_approval_step] table where the associated record producer, Add custom approval, creates a record. |
4. Click **Submit**.
Parent Topic:Setting up the Catalog Builder