Platform Order Attributes and Lifecycle

Platform Order Attributes

Platform Order Attributes are divided into the following categories:

• Core: These are pre-defined attributes by the CoreOS Platform. Although, some of these attributes are optional.
• System: These are system-defined attributes that indicate the current order state. These attributes can only be updated by the Order Orchestrator.
• Custom: These attributes are defined and configured by the Tenant depending on the use case. With these attributes, the Tenant can set up custom validations and mark them as indexed or non-indexed.

Creating Platform Custom Order Attribute

To create a Platform Order Custom Attribute, call the POST /order/config/attributes endpoint and pass the following parameters in the request body:

The following sample payload shows how to create Platform Order Custom Attributes named stringValidations and intValidations:

{
  "attributes": [
    {
      "name": "stringValidations",
      "description": "string",
      "indexed": true,
      "dataType": "string",
      "validation": {
        "range": {
          "min": 0,
          "max": 5
        },
        "regex": "string",
        "valueOneOf": [
          "string123",
          "string124"
        ],
        "required": false
      }
    },
    {
      "name": "intValidations",
      "description": "int",
      "indexed": true,
      "dataType": "number",
      "defaultValue": 1,
      "validation": {
        "range": {
          "min": 0,
          "max": 5
        },
        "valueOneOf": [
          0,1,2,3,4,5
        ],
        "required": true
      }
    }
  ]
}

Platform Order Lifecycle

A Platform Order has the following five lifecycle states:

• Initiated: This is the state where the Client Order and its respective Work Orders are registered in Platform Order Service and are awaiting validation confirmation from the external plugin (if configured).
• Created: Once the Order is validated using the external plugins (if configured) then entries are created for Work Order. This state means one of the following:
  • The Order is validated but awaiting the ‘Ready To Process’ signal.
  • The Order is validated and is ‘Ready To Process’ but not yet picked up by Order Orchestrator.
• In-progress: This state signifies that at least one Work Order of the Order is being processed, i.e., a job has been created for this Work Order by the orchestrator and at least one Work Order is in the ‘In-progress’ state.
• Executed: This state signifies that all the Work Orders of the Order have been ‘Completed’.
• Closed: This state signifies one of the following:
  • The order was executed and all post-execution processes (for example, billing, payment, collection) for the Order have been ‘Completed’.
  • The Order validation 'Failed'.
  • The Order was ‘Canceled’ before the execution was started.

Platform Order Service provides the Tenant an option to configure sub-states under Initiated, Executed, and Closed states and the rules governing the corresponding state and sub-state transition.

State transition Rules

• The state transition to and from the Initiated state will be managed and triggered by the Platform Order Service only.
• If the Order is already set as Ready To Process, state transition to and from the Created state will be managed and triggered by the Platform Order Service only.
• If the Order is not set as Ready To Process, the state transition from Created to In-progress state will be triggered by setting the order as Ready To Process through an external API call.
• A state transition from the In-progress state to Executed state will be managed and triggered by Order Service only.