cxtms 1.9.13

package/schemas/workflows/common/condition.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Condition",
+  "description": "Condition evaluation patterns for workflow execution control",
+  "definitions": {
+    "condition": {
+      "type": "object",
+      "properties": {
+        "expression": {
+          "type": "string",
+          "description": "NCalc expression that evaluates to boolean"
+        }
+      },
+      "required": ["expression"],
+      "additionalProperties": false
+    },
+    "conditionArray": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/condition"
+      },
+      "description": "Array of conditions (all must be true)"
+    },
+    "simpleCondition": {
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Simple condition expression string"
+        },
+        {
+          "$ref": "#/definitions/condition"
+        }
+      ]
+    }
+  },
+  "x-examples": {
+    "singleCondition": {
+      "expression": "[status] = 'Active'"
+    },
+    "multipleConditions": [
+      { "expression": "[isValid] = true" },
+      { "expression": "[amount] > 0" }
+    ],
+    "complexExpression": {
+      "expression": "([status] = 'Completed' || [status] = 'Failed') && [notifyUser] = true"
+    }
+  }
+}

package/schemas/workflows/common/expression.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "NCalc Expression",
+  "description": "NCalc expression patterns for workflow conditions and calculations",
+  "definitions": {
+    "expression": {
+      "type": "string",
+      "description": "NCalc expression string",
+      "x-examples": [
+        "[orderTotal] > 1000",
+        "[status] = 'Approved'",
+        "isNullOrEmpty([value?]) = false",
+        "[status] = 'Completed' || [status] = 'Failed'",
+        "format('{0:F2}', [weight])",
+        "convertWeight([value], [fromUnit], [toUnit])",
+        "formatDate([date], 'MM.dd.yyyy hh:mm', 'en-US')",
+        "sum([collection], [each.property])",
+        "distinct([collection])",
+        "length([array])",
+        "All([items], [item.isValid])",
+        "Any([items], [item.status] = 'Complete')",
+        "contains([text], 'search')",
+        "base64(format('{0}:{1}', [user], [password]))",
+        "replace([value], 'pattern', 'replacement')",
+        "lower([value])",
+        "upper([value])",
+        "trim(first(split([string], '(')))",
+        "join([array], [item.name], ', ')"
+      ]
+    },
+    "templateExpression": {
+      "type": "string",
+      "description": "Template expression with variable substitution",
+      "x-examples": [
+        "{{ orderId }}",
+        "{{ customer.name }}",
+        "{{ order?.customValues?.isConsolidated? }}",
+        "Order-{{ orderNumber }}-{{ Date.Now.ToString('yyyyMMdd') }}"
+      ]
+    },
+    "safeNavigation": {
+      "type": "string",
+      "description": "Path with optional chaining using ?",
+      "x-examples": [
+        "order?.customer?.email?",
+        "items?[0]?.name?",
+        "activity?.step?.output?"
+      ]
+    },
+    "variableConverters": {
+      "type": "string",
+      "description": "Variable type converters",
+      "enum": [
+        "string",
+        "int",
+        "decimal",
+        "bool",
+        "datetime",
+        "luceneString",
+        "emptyIfNull",
+        "nullIfEmpty",
+        "transliterate",
+        "parseJson",
+        "toJson"
+      ],
+      "x-examples": [
+        "[int orderId]",
+        "[decimal amount]",
+        "[string value]",
+        "[bool isActive]",
+        "[datetime createdDate]",
+        "[luceneString searchTerm]"
+      ]
+    }
+  }
+}

package/schemas/workflows/common/mapping.json

@@ -0,0 +1,173 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Mapping",
+  "description": "Input/output mapping patterns for workflow data flow",
+  "definitions": {
+    "outputMapping": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Output variable name"
+        },
+        "mapping": {
+          "type": "string",
+          "description": "Path to extract value from result"
+        }
+      },
+      "required": ["name", "mapping"],
+      "additionalProperties": false
+    },
+    "variableMapping": {
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "Simple template expression"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "expression": {
+              "type": "string",
+              "description": "NCalc expression"
+            }
+          },
+          "additionalProperties": true
+        },
+        {
+          "type": "object",
+          "properties": {
+            "switch": {
+              "type": "object",
+              "properties": {
+                "expression": {
+                  "type": "string"
+                }
+              }
+            },
+            "cases": {
+              "type": "object",
+              "additionalProperties": true
+            },
+            "default": {}
+          }
+        },
+        {
+          "type": "object",
+          "properties": {
+            "extends": {
+              "type": "string",
+              "description": "Extend an existing object"
+            },
+            "defaultIfNull": {},
+            "mapping": {}
+          }
+        },
+        {
+          "type": "object",
+          "properties": {
+            "foreach": {
+              "type": "string",
+              "description": "Expression evaluating to array collection to iterate (e.g., 'stepName.result?.items?')"
+            },
+            "item": {
+              "type": "string",
+              "description": "Variable name for current item (default: 'item')"
+            },
+            "index": {
+              "type": "string",
+              "description": "Variable name for current index"
+            },
+            "conditions": {
+              "oneOf": [
+                {
+                  "type": "string",
+                  "description": "Single NCalc filter expression (e.g., '[item.isActive] = true')"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "oneOf": [
+                      { "type": "string" },
+                      {
+                        "type": "object",
+                        "properties": {
+                          "expression": { "type": "string" }
+                        }
+                      }
+                    ]
+                  },
+                  "description": "Array of condition expressions (all must be true)"
+                }
+              ],
+              "description": "Filter conditions — only items matching all conditions are included"
+            },
+            "continueOnError": {
+              "type": "boolean",
+              "description": "Skip items that cause errors and continue"
+            },
+            "mapping": {
+              "type": "object",
+              "description": "Object defining the output shape — each key maps to a template expression or nested value directive",
+              "additionalProperties": true
+            }
+          },
+          "required": ["foreach", "mapping"],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "coalesce": {
+              "type": "array",
+              "items": {},
+              "description": "Return first non-null value"
+            }
+          }
+        }
+      ]
+    },
+    "pathExpression": {
+      "type": "string",
+      "description": "Dot-notation path to access nested values",
+      "x-examples": [
+        "activityName.stepName.outputVariable",
+        "orders.items?[0]?.jobs[0]?.jobId",
+        "order?.customValues?.isConsolidated?",
+        "orders?[orderType=\"ParcelShipment\"]?[0]?",
+        "carriers[contactId=(carrierId)]",
+        "charges[applyToContactId=(carrierId)]",
+        "commodities[**]",
+        "commodities[**][-1]"
+      ]
+    }
+  },
+  "x-examples": {
+    "simpleMapping": {
+      "name": "orderId",
+      "mapping": "getOrder.order.orderId"
+    },
+    "safeNavMapping": {
+      "name": "customValue",
+      "mapping": "order?.customValues?.value?"
+    },
+    "templateMapping": "Order_{{ order.orderNumber }}.pdf",
+    "switchMapping": {
+      "switch": {
+        "expression": "[orderType]"
+      },
+      "cases": {
+        "Air": "air-template",
+        "Ocean": "ocean-template"
+      },
+      "default": "default-template"
+    },
+    "foreachMapping": {
+      "foreach": "items?",
+      "mapping": {
+        "id": "{{ item.id }}",
+        "name": "{{ item.name }}"
+      }
+    }
+  }
+}

package/schemas/workflows/common/step.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Workflow Step",
+  "description": "A single step (task) within a workflow activity or event handler",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "description": "Task type identifier (e.g., 'Utilities/Log@1', 'GraphQL/Query@1')"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "Task-specific input parameters",
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "description": "Output mappings from task results"
+    },
+    "conditions": {
+      "oneOf": [
+        { "type": "string" },
+        { "type": "array" }
+      ],
+      "description": "Conditions for step execution"
+    },
+    "continueOnError": {
+      "type": "boolean",
+      "description": "Whether to continue workflow on step error"
+    }
+  },
+  "required": ["task"],
+  "additionalProperties": true
+}

package/schemas/workflows/flow/aggregation.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Flow Aggregation",
+  "description": "Aggregation definition for Flow workflows. Defines reusable data queries for use in transition conditions.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Unique name for the aggregation. Referenced in conditions."
+    },
+    "expression": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^(all|any|sum|count|first|last|distinct|groupBy)\\s*\\(",
+      "description": "Aggregation expression using supported functions: all(), any(), sum(), count(), first(), last(), distinct(), groupBy()."
+    },
+    "parameter": {
+      "type": "string",
+      "description": "Optional parameter name for parameterized aggregations."
+    }
+  },
+  "required": ["name", "expression"],
+  "additionalProperties": false,
+  "x-examples": [
+    {
+      "name": "allItemsReceived",
+      "expression": "all(Order.Commodities, item.ReceivedQuantity >= item.Quantity)"
+    },
+    {
+      "name": "totalWeight",
+      "expression": "sum(Order.Commodities, item.Weight)"
+    },
+    {
+      "name": "itemCount",
+      "expression": "count(Order.Commodities)"
+    },
+    {
+      "name": "chargesByType",
+      "expression": "sum(Order.Charges, item.Amount)",
+      "parameter": "chargeType"
+    }
+  ]
+}

package/schemas/workflows/flow/entity.json

@@ -0,0 +1,129 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Flow Entity",
+  "description": "Entity configuration for Flow workflows. Specifies the entity whose lifecycle is managed by the flow.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "enum": [
+        "Order",
+        "Commodity",
+        "AccountingTransaction",
+        "Workflow",
+        "OrganizationConfig",
+        "Contact",
+        "AppModule",
+        "Attachment",
+        "OrderCommodity",
+        "TrackingEvent",
+        "JobOrder"
+      ],
+      "description": "The entity name whose lifecycle this flow manages"
+    },
+    "type": {
+      "type": "string",
+      "description": "The entity subtype. Required for Order, AccountingTransaction, and Contact entities."
+    },
+    "includes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Navigation paths for related data to load with the entity. Supports dot-notation for nested relationships (e.g., 'Customer.BillingAddress')."
+    },
+    "query": {
+      "type": "string",
+      "description": "GraphQL-style query string specifying the default fields to load for the entity. States can override this with their own query."
+    }
+  },
+  "required": ["name"],
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "name": { "const": "Order" }
+        }
+      },
+      "then": {
+        "required": ["type"],
+        "properties": {
+          "type": {
+            "enum": [
+              "Brokerage",
+              "ParcelShipment",
+              "Quote",
+              "WarehouseReceipt",
+              "AirShipmentOrder",
+              "OceanShipmentOrder",
+              "LoadOrder",
+              "DeliveryOrder"
+            ]
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "name": { "const": "AccountingTransaction" }
+        }
+      },
+      "then": {
+        "required": ["type"],
+        "properties": {
+          "type": {
+            "enum": ["Invoice", "Bill", "CreditMemo"]
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "name": { "const": "Contact" }
+        }
+      },
+      "then": {
+        "required": ["type"],
+        "properties": {
+          "type": {
+            "enum": ["Customer", "Carrier", "Vendor", "Driver", "Employee"]
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "name": { "const": "Commodity" }
+        }
+      },
+      "then": {
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "CommodityType code. Optional — if omitted, the flow applies to all commodity types."
+          }
+        }
+      }
+    }
+  ],
+  "additionalProperties": false,
+  "x-examples": [
+    {
+      "name": "Order",
+      "type": "Brokerage",
+      "includes": ["Commodities", "Customer.BillingAddress", "Charges"],
+      "query": "{ commodities { id, quantity }, customer { name, email } }"
+    },
+    {
+      "name": "Contact",
+      "type": "Customer"
+    },
+    {
+      "name": "Commodity",
+      "includes": ["commodityStatus", "commodityEvents.trackingEvent.eventDefinition"]
+    }
+  ]
+}

package/schemas/workflows/flow/state.json

@@ -0,0 +1,105 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Flow State",
+  "description": "State definition for Flow workflows. Each state represents a status in the entity lifecycle.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The state name. Must match an existing status entity name."
+    },
+    "stage": {
+      "type": "string",
+      "description": "Stage grouping for this state (e.g., 'Processing', 'Completed'). Used for organizing states in the UI."
+    },
+    "parent": {
+      "type": "string",
+      "description": "Parent state name for hierarchical organization. Child states inherit parent transitions."
+    },
+    "isInitial": {
+      "type": "boolean",
+      "default": false,
+      "description": "Indicates this is the initial state for new entities. At most one state can be marked as initial."
+    },
+    "isFinal": {
+      "type": "boolean",
+      "default": false,
+      "description": "Indicates this is a final/terminal state. Final states cannot be transition sources."
+    },
+    "requireConfirmation": {
+      "type": "boolean",
+      "default": false,
+      "description": "Requires user confirmation before transitioning to this state."
+    },
+    "onEnter": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "task": { "type": "string" },
+          "name": { "type": "string" },
+          "inputs": { "type": "object", "additionalProperties": true },
+          "outputs": { "type": "array" },
+          "conditions": { "oneOf": [{ "type": "string" }, { "type": "array" }] },
+          "continueOnError": { "type": "boolean" }
+        },
+        "required": ["task"],
+        "additionalProperties": true
+      },
+      "description": "Steps to execute when entering this state. Executed after the transition steps."
+    },
+    "onExit": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "task": { "type": "string" },
+          "name": { "type": "string" },
+          "inputs": { "type": "object", "additionalProperties": true },
+          "outputs": { "type": "array" },
+          "conditions": { "oneOf": [{ "type": "string" }, { "type": "array" }] },
+          "continueOnError": { "type": "boolean" }
+        },
+        "required": ["task"],
+        "additionalProperties": true
+      },
+      "description": "Steps to execute when exiting this state. Executed before the transition steps."
+    },
+    "query": {
+      "type": "string",
+      "description": "GraphQL-style query string specifying fields to load when entity is in this state. Overrides the entity-level query."
+    }
+  },
+  "required": ["name"],
+  "additionalProperties": false,
+  "x-examples": [
+    {
+      "name": "Draft",
+      "stage": "Entry",
+      "isInitial": true
+    },
+    {
+      "name": "Shipped",
+      "stage": "Fulfillment",
+      "onEnter": [
+        {
+          "task": "SendEmail@1",
+          "inputs": {
+            "template": "shipped_notification"
+          }
+        }
+      ]
+    },
+    {
+      "name": "Delivered",
+      "stage": "Complete",
+      "isFinal": true
+    },
+    {
+      "name": "AwaitingPickup",
+      "parent": "Active",
+      "requireConfirmation": true
+    }
+  ]
+}