OS1 Services
Order Service
Platform Order Attributes and Lifecycle
6 min
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 platform 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 indexed these are attributes that users can utilize to apply filters and retrieve specific data non indexed users are not permitted to apply filters on these attributes and query the order data true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type đŸ’¡ platform order orchestrator the platform order orchestrator allows tenants to pre configure workflows for executing work orders these workflows are based on the work order type and are designed to create subsequent jobs necessary for fulfilling larger work orders by utilizing the assigned workflow, current status, and external plugins, the platform order orchestrator determines the next action required for seamless execution creating platform custom order attribute to create a platform order custom attribute, call the post /config/attributes endpoint and pass the following parameters in the request body true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type note some of the core platform order attributes can be updated these attributes are listed below dropdetails contact location ordersummary invoicenumber orderdescription totalweight totalitems totalordercost readytoprocess (false to true only) the following sample payload shows how to create platform order custom attributes named stringvalidations and intvalidations { "attributes" \[ { "name" "maxattempts", "datatype" "number", "indexed" false, "validation" { "required" false }, "defaultvalue" 1, "securitylevel" "open", "delete" false }, { "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 lifecycle states and sub states initiated order created request has been accepted created order has been created in the system (i e workorder & container are created) inprogress\ scheduled a job is created for a work order of that order inprogress\ assigned job corresponding to work order has been added to a dispatch inprogress\ active job corresponding to the work order has been started onhold\ onhold tenant wants to restrict any further actions to be taken by the operations (for ex payment issues for an order / damage issue for an order) executed\ success all instruction of the work order has been successfully completed, now order is remaining for non operational activities (for ex billing) executed\ partial instruction of the work order has been partially completed, now order is remaining for non operational activities (for ex billing) executed\ failed all instruction of the work order has been failed, now order is remaining for non operational activities (for ex billing) executed\ canceled cancellation request has been processed, now order is remaining for non operational activities (for ex billing) closed\ success all instruction of the work order has been successfully completed & no further activities pending closed\ partial instruction of the work order has been partially completed, no further activities pending closed\ failed all instruction of the work order has been failed, no further activities pending closed\ canceled cancellation request raised by a client is processed, no further activities pending platform order service provides the tenant with an option to configure sub states under any of the six lifecycle states and the rules governing the corresponding state and sub state transition