Use the Fulfillment Pattern editor to describe the structure of a group of related products in a product catalog and to configure the logical sequence of steps that must be performed to fulfill order items associated with the fulfillment pattern.
The following fields are common to all of the Fulfillment Pattern editor tabs:
| Field | Use |
|---|---|
| Description | Edit the display name of the fulfillment pattern. |
| Namespace | Select an existing namespace or enter a unique namespace in which to include the fulfillment pattern. Design Studio uses the last saved namespace as the default. |
When configuring fulfillment patterns in the Fulfillment Pattern editor, refer to the following topics:
Use the Details tab to select an existing fulfillment pattern on which to base the corresponding fulfillment pattern and to identify with which fulfillment modes the fulfillment pattern is associated.
Note:
See "Fulfillment Pattern Editor" for information about fields that appear on both Fulfillment Pattern editor tabs.| Field | Use |
|---|---|
| Extends | Select an existing specification if you want the new fulfillment pattern to inherit the functionality of an existing fulfillment pattern.
Inheritance by extension dictates that the contents of this fulfillment pattern's orchestration plan is augmented with the sum contents of all ancestor fulfillment pattern orchestration plans. The child fulfillment pattern includes all order components and transitions associated with parent fulfillment patterns. Do any of the following:
|
| Default Fulfillment State Map | Select or create the fulfillment state map that should be used as a default when creating a new fulfillment state mapping from the order component list on the Orchestration tab. See "Fulfillment Pattern Editor Order Components Subtab" for more information. |
| Fulfillment Modes | Associate the fulfillment pattern with one or more fulfillment modes to represent the types of orders on which this product will appear. You configure the order components, transitions, and process durations for each fulfillment mode on the Fulfillment Pattern editor Orchestration Plan tab.
Do any of the following:
See "Working with Fulfillment Modes" for more information. |
| Point of No Return values list | Displays the point of no return values created for this fulfillment pattern. It also displays point of no return values inherited from other fulfillment patterns in the hierarchy established by the Extends field. Inherited points of no return indicate the entity from which they are inherited and can only be edited in the source entity.
Do any of the following:
|
Use the Orchestration Plan tab to configure the order components, dependencies, and process durations for each fulfillment mode associated with the fulfillment pattern.
The following fields are common to multiple subtabs on the Fulfillment Pattern editor Orchestration Plan tab:
Note:
See "Fulfillment Pattern Editor" for information about fields that appear on both Fulfillment Pattern editor tabs.| Field | Use |
|---|---|
| Fulfillment Mode | A fulfillment mode denotes whether the order is intended for delivery to fulfillment systems, for testing purposes only, to request a target fulfillment system, and so forth. A fulfillment pattern can be associated with multiple fulfillment modes, each configured differently.
Click the Fulfillment Mode menu to access additional fulfillment modes associated with the fulfillment pattern, and configure the order components, transitions, and process durations for every fulfillment mode listed in the menu. See "Working with Fulfillment Modes" for more information. |
When modeling fulfillment patterns, refer to the following topics for additional information:
Use the Order Components subtab to select all of the order components to which an order item associated with the corresponding fulfillment pattern can be added when OSM creates an orchestration plan, to specify the time OSM can expect to process a single order item for the associated order component, to include any order items that do not share the same fulfillment pattern, and to add order items to an order component only when the condition evaluates to true.
Use the Order Components area to select all of the order components to which an order item associated with the corresponding fulfillment pattern can be added when OSM creates an orchestration plan.
| Field | Use |
|---|---|
| Base Component
Functions Search |
Use these fields to limit the number of order components that appear in the Order Components area. The Order Components subtab displays all order component specifications defined in the workspace. Use Base Component to limit the display to a single root-level order component and its dependencies. Use Functions to limit the scope to executable order components (order components associated with a process). Enter a value in the Search field to search for a specific order component. |
| Order components list | Displays the order components that meet the criteria selected in the Base Component, Functions, and Search fields. A check preceding the order component indicates that it is an order component executed by the fulfillment pattern. You can right-click in this box and select any of the following functions:
When you select one of the options to create a new fulfillment state mapping, the fulfillment pattern and fulfillment mode criteria are entered by default in the new mapping. If all of the following conditions are met, the new mapping will also contain the order item, orchestration sequence, orchestration stage, and order component criteria.
You can make any changes you like to the default data values provided in the mapping. |
| Open
New |
Select any order component in the list and click New to create and add a new order component to the list. Click Open to open the order component in the Order Component Specification editor. |
For each order component you select in the Order Components area, you can also define its processing duration, whether the order items included in order components are associated by additional properties (such as component IDs), and the conditions that dictate whether the order items are added to the order component.
OSM uses either the fulfillment pattern selected order component duration or the order component specification duration, whichever is longer, to determine the start times for order components. See "Order Component Specification Editor Duration Tab" for more information.
If Use Calculated Start Date is enabled, the order component will not start until the calculated start date is reached. If the current date and time are greater than calculated start date, then the calculated start date is ignored.
If Use Calculated Start Date is disabled, the order component starts as soon as all preceding dependencies are resolved.
The calculated start dates are only used if there is sufficient time to meet the date. Otherwise, the order component begins immediately.
See "Order Component Specification Editor Details Tab" for more information about Use Calculated Start Date.
OSM uses several configured durations to calculate the start times for order components. See OSM Modeling Guide for more information.
| Field | Use |
|---|---|
| Processing Duration | Use the Duration subtab to specify the time OSM can expect to process a single order item for the associated order component for this fulfillment pattern. Highlight an order component in the Order Components area and define a specific duration in the Processing Duration field, or create an XQuery expression in the Duration Expression field to run against a specific order item property. |
| Duration Expression | Enter an XQuery expression or a pointer to determine the processing duration based on a specific order item property. See "About Creating XQuery Expressions with Design Studio" for more information about entering information into XQuery controls.
See "About Fulfillment Pattern Component Duration XQuery Expressions" for more information. |
| Order Item Associations | Use the Order Item Associations subtab to include order items that do not share the same fulfillment pattern in the order component.
Select an order component in the Order Components area and do any of the following:
You can select the following options in the Order Item Associations subtab:
By default, Fulfillment Pattern is selected. You can also group order items into an order component when those order items share a common component ID or property correlation. If you select Property Correlation, enter an XQuery expression to select the order item property. See "Fulfillment Pattern Editor Orchestration Plan Tab" and "About Associating Order Items Using Property Correlations XQuery Expressions" for more information. |
| Conditions | Use the Conditions subtab to add order items to an order component only when the condition evaluates to true. Select an order component in the Order Components area and click Add to open the Add Condition dialog box, where you can specify a name for a new condition.
Click Select to open the Select a Condition dialog box, where you can select a previously created condition to associate with the corresponding order component. Select any condition and click Remove to delete it from the list. Select any condition from the Conditions list and enter the XQuery expression to run against the order item. See "Fulfillment Pattern Editor Orchestration Plan Tab" and "About Order Item Specification Condition XQuery Expressions" for more information. |
| Point of No Return | Associate a point of no return with one or more common fulfillment states for the currently selected order component. Select a point of no return from the list, and then select each of the fulfillment states to which that point of no return should apply. Note that a point of no return must be associated with each fulfillment state that can cause it. Selecting a parent fulfillment state indicates that a point of no return will also be set for the children of that fulfillment state. The list of points of no return is populated with the values listed in the Fulfillment Pattern Editor Details tab. |
Use the Dependencies subtab to configure dependencies (the logical sequence between order components) within the corresponding fulfillment pattern or between order components on other fulfillment patterns and order components on the corresponding fulfillment pattern.
| Field | Use |
|---|---|
| Dependencies area | Lists the dependencies that have been defined for the fulfillment pattern for the selected Fulfillment Mode. Do any of the following:
|
| Inherited From | Denotes the source of the dependency when this fulfillment pattern inherits from a parent fulfillment pattern.
The parent fulfillment pattern is defined in the Extends field in the Fulfillment Pattern Editor Details tab. |
| From Fulfillment Pattern
From Component To Component |
Configure these values on the From/To Components Subtab in the Selected Dependency area. |
Use the From/To Components subtab in the Selected Dependency area to specify the order components to which the dependency applies.
Note:
You must select a row in the Dependencies table before you can define the fields on this subtab.| Field | Use |
|---|---|
| From Fulfillment Pattern | Click Select or New to configure a dependency between order components on a different fulfillment pattern with order components on the corresponding fulfillment pattern. Click Open to review the fulfillment pattern in the Fulfillment Pattern editor. |
| From Order Component | Specify the source order component.
Select an order component and click Open to review the order component in the Order Component Specification editor. Click New to create a new order component to add to the From Order Component list. |
| To Order Component | Specify the target order component that starts after all conditions associated with the dependent order items for the source order component have been met.
Select an order component and click Open to review the order component in the Order Component Specification editor. Click New to create a new order component to add to the To Order Component list. |
Use the Order Item Dependency subtab in the Selected Dependency area to specify which order items in the source and target order components have dependencies.
Note:
You must select a row in the Dependencies table before you can define the fields on this tab.By default, an order item in the To Component field in the Dependencies table has a dependency when the same order item exists in the From Component field. However, you can use order item dependencies if you want to create a dependency on two different order items. For example, order items in a shipping order component may not be identical to order items in an install order component, but a dependency between those order items exists.
| Field | Use |
|---|---|
| Order Item | This is the default option. |
| Fulfillment Pattern | Select this option to set a dependency based on fulfillment pattern. |
| Property Correlation | Select this option to set a dependency based on order item property correlation. If you select this option, enter an XQuery expression to select the order item property that order items in the To Order Component field must share with order items in the From Order Component field.
Note: See "Fulfillment Pattern Editor Orchestration Plan Tab" and "About Order Item Dependency Property Correlation XQuery Expressions" for more information. |
Use the Wait Condition subtab in the Selected Dependency area to specify the conditions that must be satisfied before the transition can occur.
Note:
You must select a row in the Dependencies table before you can define the fields on this subtab.| Field | Use |
|---|---|
| Task State Completed | Select this option to specify that the transition should wait until the subprocess task associated with the order component reaches the completed state. |
| Data Change Notification | Select this option to specify that a notification is to be generated when a data value changes if that data value change passes the condition expression. This field indicates that the dependency target order component cannot execute until the value you select for the data change notification property of the order item changes. For example, you can configure a data change notification on a status field in the order template so that if the status changes to Failed, OSM generates a fallout notification to an administrator.
When you select Data Change Notification, you also define the following fields:
|
| Wait Delay area | Use the Wait Delay area to configure a delay that supplements the information defined in the Wait For Condition area. You configure the Wait Delay against either the Task State or the Data Change Notification wait condition options. After the conditions defined in the Wait For Condition area are met, OSM further delays the execution of the corresponding target order component using the information defined here.
The wait delay setting defers the start of the waiting order component after the dependencies have been resolved. For example, you can use this to defer the resolution of the condition until two days after a task completion. Do one of the following:
|
| Duration fields | Use these fields to set a static amount of time to delay. Only available if the Duration option is selected. |
| Duration Expression | Create an XQuery expression in the Duration Expression field to run against a specific order item property. See "About Creating XQuery Expressions with Design Studio" for more information about entering information into XQuery controls.
If the Duration option is selected, write the XQuery expression to return a string in the xs:duration format (for example,"PT15M"). See "About Wait Delay Duration XQuery Expressions" for more information. If the Date Time Expression option is selected, write the XQuery expression to return a string in the xs:dateTime format (for example, "2012-09-15T15:30:00-4:00"). See "About Wait Delay Date and Time XQuery Expressions" for more information. |
For cartridges that target OSM server version 7.2.0 or earlier, use the Duration subtab to specify the minimum process duration for the associated fulfillment pattern.
Note:
OSM uses several configured durations to calculate the start times for order components. See OSM Modeling Guide for more information.For cartridges that target OSM server version 7.2.2 or later, the Duration subtab has no effect on fulfillment patterns. If you configure any values and deploy the cartridge to OSM server 7.2.2 or later, you will get a warning that the configured values on the Duration subtab are ignored.
| Field | Use |
|---|---|
| Duration | Define a specific duration in the Duration field, or create an XQuery expression in the Duration Expression field to run against a specific order item property.
This is used when the calculated duration for an order item based on order component durations and dependencies is less than the minimum processing duration value for the fulfillment pattern that the order item maps to. You can override the fulfillment pattern process duration by specifying the processing duration for individual order components. |
| Duration Expression | Enter an XQuery expression or a pointer to determine the processing duration based on a specific order item property. See "About Creating XQuery Expressions with Design Studio" for more information about entering information into XQuery controls.
See "About Fulfillment Pattern Duration XQuery Expressions" for more information. |
Use the Realization tab to select the conceptual model fulfillment pattern that is realized by this OSM fulfillment pattern.
| Field | Use |
|---|---|
| Realization | Specifies the conceptual model fulfillment pattern that is realized by this fulfillment pattern. See "About Fulfillment Patterns" for more information about conceptual model fulfillment patterns.
Do any of the following:
|