@cxtms/cx-schema 1.9.67 → 1.9.241

package/schemas/schemas.json

@@ -108,13 +108,39 @@
               "label": {
                 "$ref": "#/definitions/localized"
               },
+              "description": {
+                "$ref": "#/definitions/localized",
+                "description": "Localized tooltip shown for the column header and column selector"
+              },
               "showAs": {
                 "$ref": "#/definitions/component",
                 "description": "Custom component for column rendering"
               },
               "isHidden": {
-                "type": "boolean",
-                "description": "Whether column is hidden"
+                "oneOf": [
+                  { "type": "boolean" },
+                  { "$ref": "#/definitions/templateExpression" }
+                ],
+                "description": "Whether column is hidden; true excludes it from rendering/export"
+              },
+              "isVisible": {
+                "oneOf": [
+                  { "type": "boolean" },
+                  { "$ref": "#/definitions/templateExpression" }
+                ],
+                "description": "Whether column is visible; false excludes it from rendering/export"
+              },
+              "path": {
+                "type": "string",
+                "description": "GraphQL/data path for this column when different from name"
+              },
+              "exportPath": {
+                "type": "string",
+                "description": "Export field key; overrides path and name when building DataGrid export headers and mappings"
+              },
+              "exportTemplate": {
+                "type": "string",
+                "description": "Template expression for export-only formatted value; exposed in DataGrid context store exportTemplates"
               },
               "enableEdit": {
                 "type": "boolean",
@@ -127,6 +153,41 @@
               "onEdit": {
                 "$ref": "#/definitions/actionsList",
                 "description": "Action array executed sequentially when the cell value changes. Receives changedValues and value variables."
+              },
+              "excludeFromQuery": {
+                "type": "boolean",
+                "description": "Exclude this column from GraphQL query and export configuration"
+              },
+              "subQueries": {
+                "type": "array",
+                "description": "Additional GraphQL field paths to include in the query without rendering them as columns",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "props": {
+                "type": "object",
+                "description": "Column behavior/export options such as orderByProperty, allowOrderBy, allowFilter, allowSelect, and filterByProperty",
+                "properties": {
+                  "allowOrderBy": { "type": "boolean" },
+                  "allowFilter": {
+                    "oneOf": [
+                      { "type": "boolean" },
+                      { "$ref": "#/definitions/templateExpression" }
+                    ],
+                    "description": "Boolean or template expression controlling whether this column appears in the filter picker"
+                  },
+                  "allowSelect": { "type": "boolean" },
+                  "orderByProperty": {
+                    "type": "string",
+                    "description": "Property path used for ordering instead of the displayed column name"
+                  },
+                  "filterByProperty": {
+                    "type": "string",
+                    "description": "Property path used for filtering instead of the displayed column name"
+                  }
+                },
+                "additionalProperties": true
               }
             }
           }
@@ -135,6 +196,10 @@
           "type": "string",
           "description": "Filter expression for this view"
         },
+        "search": {
+          "type": "string",
+          "description": "Default search term seeded once when the grid first loads this view. Supports template expressions; URL search parameters and user input take precedence."
+        },
         "childViews": {
           "type": "array",
           "description": "Nested child views",
@@ -142,9 +207,43 @@
             "$ref": "#/definitions/dataGridView"
           }
         },
+        "stickyColumns": {
+          "type": "object",
+          "description": "User-pinned DataGrid columns for this view. Left-pinned columns render first, normal columns render next, and right-pinned columns render last.",
+          "properties": {
+            "left": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Column names pinned to the left edge in pin order"
+            },
+            "right": {
+              "type": "array",
+              "items": { "type": "string" },
+              "description": "Column names pinned to the right edge in pin order"
+            }
+          },
+          "additionalProperties": false
+        },
         "showHeader": {
           "type": "boolean",
           "description": "Whether to show header for child views"
+        },
+        "enableResize": {
+          "type": "boolean",
+          "description": "Enable drag-to-resize columns for this view. Overrides the grid-level enableResize option."
+        },
+        "includeEntityKeysInExport": {
+          "type": "boolean",
+          "description": "Include the grid entityKeys/primary keys in exports for this view so re-import can match rows by ID. Defaults to the grid option, then true."
+        },
+        "pageSize": {
+          "type": "number",
+          "description": "Rows per page for this view"
+        },
+        "paginationPosition": {
+          "type": "string",
+          "enum": ["top", "bottom"],
+          "description": "Render pagination controls above or below the grid rows. Defaults to bottom."
         }
       },
       "required": ["name"]
@@ -169,6 +268,10 @@
             "type": "string"
           }
         },
+        "includeEntityKeysInExport": {
+          "type": "boolean",
+          "description": "Default export behavior: when true or omitted, missing entityKeys are prepended to export headers so ID-first imports can update existing rows"
+        },
         "navigationType": {
           "type": "string",
           "enum": ["navigate", "dialog", "store"],
@@ -202,6 +305,10 @@
           "type": "string",
           "description": "Default view name"
         },
+        "defaultExpandedRows": {
+          "type": "boolean",
+          "description": "Pre-expand parent rows on first load when childViews are configured; preserves user collapse/expand choices on refresh"
+        },
         "onRowClick": {
           "oneOf": [
             { "$ref": "#/definitions/actionsList" },
@@ -340,13 +447,29 @@
         "fieldType": { "type": "string" },
         "isCustomField": { "type": "boolean", "description": "Whether this is a custom field" },
         "isInactive": { "type": "boolean" },
+        "priority": {
+          "type": "integer",
+          "default": 0,
+          "description": "Module-level field override precedence; highest active priority wins for duplicate entity field names"
+        },
         "props": {
           "type": "object",
           "description": "Additional field properties",
           "properties": {
             "showAs": { "$ref": "#/definitions/component" },
             "allowOrderBy": { "type": "boolean" },
-            "allowFilter": { "type": "boolean" },
+            "allowFilter": {
+              "oneOf": [
+                { "type": "boolean" },
+                { "$ref": "#/definitions/templateExpression" }
+              ],
+              "description": "Boolean or template expression controlling whether this field appears in the filter picker"
+            },
+            "allowSelect": { "type": "boolean" },
+            "filterByProperty": {
+              "type": "string",
+              "description": "Property path used for filtering instead of the displayed field name"
+            },
             "filter": {
               "type": "object",
               "description": "Field-level filter selector configuration",
@@ -604,7 +727,11 @@
 
       "timeline-grid": {
         "$ref": "components/timelineGrid.json"
-      }
+      },
+      "avatar": { "$ref": "components/avatar.json" },
+      "infoLine": { "$ref": "components/infoLine.json" },
+      "progressBar": { "$ref": "components/progressBar.json" },
+      "planner": { "$ref": "components/planner.json" }
     }
   }
 }

package/schemas/workflows/flow/entity.json

@@ -17,7 +17,9 @@
         "Attachment",
         "OrderCommodity",
         "TrackingEvent",
-        "JobOrder"
+        "JobOrder",
+        "OrderMove",
+        "DispatchRoute"
       ],
       "description": "The entity name whose lifecycle this flow manages"
     },

package/schemas/workflows/input.json

@@ -65,7 +65,7 @@
           "description": "Item type for array inputs (e.g., 'number', 'text')"
         },
         "schema": {
-          "description": "Input validation schema. Can be a type assertion (e.g., {type: 'string'}), an object field list (multiline string), or an array field list with types/conditions.",
+          "description": "Input validation/OpenAPI schema. For PublicApi body inputs, supports recursive schema fields such as type, properties, required, items, format, description, and enum.",
           "oneOf": [
             {
               "type": "string",

package/schemas/workflows/output.json

@@ -26,7 +26,7 @@
         },
         "schema": {
           "type": "object",
-          "description": "JSON Schema describing the response structure",
+          "description": "Recursive OpenAPI schema describing the response structure. Supports type, properties, required, items, format, description, and enum.",
           "additionalProperties": true
         }
       },

package/schemas/workflows/tasks/all.json

@@ -40,6 +40,9 @@
     {
       "$ref": "csv.json"
     },
+    {
+      "$ref": "dispatch-routes.json"
+    },
     {
       "$ref": "document-render.json"
     },
@@ -100,12 +103,18 @@
     {
       "$ref": "number.json"
     },
+    {
+      "$ref": "organization-config.json"
+    },
     {
       "$ref": "order-tracking-event.json"
     },
     {
       "$ref": "order.json"
     },
+    {
+      "$ref": "order-move.json"
+    },
     {
       "$ref": "payment.json"
     },

package/schemas/workflows/tasks/commodity.json

@@ -67,6 +67,14 @@
         "partial": {
           "type": "boolean",
           "description": "Partial update (patch)"
+        },
+        "cascadeToChildren": {
+          "type": "boolean",
+          "description": "For Commodity/Update: copy inputs.entity/customValues to direct child commodities after updating this commodity"
+        },
+        "promoteParentWhenAllChildren": {
+          "type": "boolean",
+          "description": "For Commodity/Update: copy inputs.entity/customValues to the parent once every direct non-deleted sibling has the same custom-value keys"
         }
       },
       "additionalProperties": true

package/schemas/workflows/tasks/contact-address.json

@@ -39,6 +39,10 @@
       "type": "object",
       "description": "Contact address operation inputs",
       "properties": {
+        "organizationId": {
+          "type": "string",
+          "description": "Organization/tenant ID for scoped operations and imports"
+        },
         "contactId": {
           "type": "string",
           "description": "Parent contact ID"
@@ -47,6 +51,27 @@
           "type": "string",
           "description": "Address ID (for update/delete)"
         },
+        "fileUrl": {
+          "type": "string",
+          "description": "URL for import source file"
+        },
+        "fileType": {
+          "type": "string",
+          "description": "Import file type, such as Csv or Excel"
+        },
+        "stream": {
+          "description": "Import stream payload"
+        },
+        "matchByFields": {
+          "type": "array",
+          "description": "Business-key fields used after ID-first ContactAddressId/contactAddressId matching. When supplied, imports selectively fetch existing address candidates using row-level Lucene filters instead of loading all addresses for the contact.",
+          "items": { "type": "string" }
+        },
+        "columnMappings": {
+          "type": "object",
+          "description": "Import column-to-field mappings",
+          "additionalProperties": { "type": "string" }
+        },
         "entity": {
           "type": "object",
           "description": "Address entity data",

package/schemas/workflows/tasks/dispatch-routes.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Dispatch Route Tasks",
+  "description": "Dispatch route workflow operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": ["DispatchRoutes/Generate@1"],
+      "description": "Task type identifier"
+    },
+    "name": { "type": "string", "description": "Step name identifier" },
+    "description": { "type": "string", "description": "Step description" },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": { "expression": { "type": "string" } },
+        "required": ["expression"]
+      }
+    },
+    "continueOnError": { "type": "boolean" },
+    "inputs": {
+      "type": "object",
+      "description": "Dispatch route generation inputs",
+      "properties": {
+        "organizationId": { "type": "string", "description": "Organization ID" },
+        "dispatchRouteStatusId": { "type": "string", "description": "Status assigned to generated routes" },
+        "routeDate": { "type": "string", "description": "Route date in yyyy-MM-dd format; defaults to today UTC when omitted" },
+        "dispatchRouteTemplateId": { "type": "string", "description": "Optional template ID; omit to generate all matching templates" }
+      },
+      "required": ["organizationId", "dispatchRouteStatusId"],
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "description": "Task outputs",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": { "type": "string" },
+          "mapping": { "type": "string" }
+        },
+        "required": ["name", "mapping"]
+      }
+    }
+  },
+  "required": ["task", "name", "inputs"],
+  "additionalProperties": true,
+  "x-example": {
+    "task": "DispatchRoutes/Generate@1",
+    "name": "GenerateDispatchRoutes",
+    "inputs": {
+      "organizationId": "{{ inputs.organizationId }}",
+      "dispatchRouteStatusId": "{{ inputs.dispatchRouteStatusId }}",
+      "routeDate": "{{ inputs.routeDate }}"
+    },
+    "outputs": [
+      { "name": "createdCount", "mapping": "createdCount" },
+      { "name": "skippedCount", "mapping": "skippedCount" },
+      { "name": "createdRouteIds", "mapping": "createdRouteIds" }
+    ]
+  }
+}

package/schemas/workflows/tasks/edi.json

@@ -124,6 +124,21 @@
             }
           }
         },
+        "freeText": {
+          "type": "array",
+          "description": "Free text segments (FTX). Each entry produces one FTX segment in the EDIFACT message.",
+          "items": {
+            "type": "object",
+            "properties": {
+              "qualifier": { "type": "string", "description": "Text subject code qualifier (4451). Common values: AAA (General), AAI (Instructions), CCI (Customs/Compliance), DOC (Document), BLC (B/L Clause)." },
+              "functionCode": { "type": "string", "description": "Free text function code (4453)." },
+              "textReferenceCode": { "type": "string", "description": "C107/4441 free text value code. When qualifier=CCI: MFS (Manifest Filer Status), ENS (Entry Summary Declaration), HBL (House Bill Indicator). When qualifier=DOC: SMI (Single Message Indicator). When qualifier=BLC: clause code (01-45, CB, CC, etc.)." },
+              "text": { "type": "string", "description": "C108/4440 free text value, line 1 (max 512 chars)." },
+              "text2": { "type": "string", "description": "C108/4440 free text value, line 2 (max 512 chars)." },
+              "text3": { "type": "string", "description": "C108/4440 free text value, line 3 (max 512 chars). When textReferenceCode=MFS: Manifest Filer Identification (SCAC). When textReferenceCode=HBL: To Order Shipment indicator (TOS)." }
+            }
+          }
+        },
         "equipment": {
           "type": "array",
           "description": "Container/equipment details",

package/schemas/workflows/tasks/export.json

@@ -48,6 +48,27 @@
           "type": "string",
           "description": "Output file name"
         },
+        "headers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Optional ordered list of flattened field/header paths to include"
+        },
+        "columnMappings": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Optional map of field/header path to output display label"
+        },
+        "exportTemplates": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Optional map of output header name to NCalc expression evaluated against each original row"
+        },
         "columns": {
           "type": "array",
           "items": {

package/schemas/workflows/tasks/httpRequest.json

@@ -40,6 +40,10 @@
           "type": "string",
           "description": "Request URL"
         },
+        "params": {
+          "type": "object",
+          "description": "URL query parameters. Keys and values are automatically URL-encoded and appended to the URL. Use when query string parameters come from workflow variables."
+        },
         "method": {
           "type": "string",
           "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"],

package/schemas/workflows/tasks/import.json

@@ -43,6 +43,11 @@
         "format": {
           "type": "string",
           "description": "Import format (e.g., csv)"
+        },
+        "columnMappings": {
+          "type": "object",
+          "description": "Optional map of internal field paths to inbound CSV/XLSX column headers. Example: {\"contact.name\": \"Customer Name\"}",
+          "additionalProperties": { "type": "string" }
         }
       },
       "additionalProperties": true

package/schemas/workflows/tasks/order-move.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Order Move Tasks",
+  "type": "object",
+  "properties": {
+    "task": { "type": "string", "enum": ["OrderMove/Create@1", "OrderMove/Update@1", "OrderMove/Delete@1"] },
+    "name": { "type": "string" },
+    "description": { "type": "string" },
+    "conditions": { "type": "array", "items": { "type": "object", "properties": { "expression": { "type": "string" } }, "required": ["expression"] } },
+    "continueOnError": { "type": "boolean" },
+    "inputs": {
+      "type": "object",
+      "properties": {
+        "organizationId": {},
+        "orderMoveId": {},
+        "orderMove": {
+          "type": "object",
+          "properties": {
+            "orderId": {}, "sequence": {}, "name": {}, "assignedDriverContactId": {},
+            "orderMoveStatusId": {}, "startDate": {}, "endDate": {}, "customValues": { "type": "object" },
+            "orderMoveLegs": { "type": "array", "items": { "type": "object" } }
+          },
+          "additionalProperties": true
+        }
+      },
+      "required": ["organizationId"],
+      "additionalProperties": true
+    },
+    "outputs": { "type": "array", "items": { "type": "object", "additionalProperties": true } }
+  },
+  "required": ["task", "name", "inputs"],
+  "allOf": [
+    { "if": { "properties": { "task": { "const": "OrderMove/Create@1" } } }, "then": { "properties": { "inputs": { "required": ["organizationId", "orderMove"] } } } },
+    { "if": { "properties": { "task": { "enum": ["OrderMove/Update@1", "OrderMove/Delete@1"] } } }, "then": { "properties": { "inputs": { "required": ["organizationId", "orderMoveId"] } } } },
+    { "if": { "properties": { "task": { "const": "OrderMove/Update@1" } } }, "then": { "properties": { "inputs": { "required": ["organizationId", "orderMoveId", "orderMove"] } } } }
+  ],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/order.json

@@ -131,6 +131,12 @@
               "items": { "type": "string" },
               "description": "Fields to match existing commodities."
             },
+            "commodityMatchConflict": {
+              "type": "string",
+              "enum": ["Link", "Error"],
+              "default": "Link",
+              "description": "Handling when a matched top-level commodity already belongs to another order of the same type. Link reuses it; Error skips it and records an import error."
+            },
             "createEventDefinitions": {
               "type": "boolean",
               "description": "Auto-create missing tracking event definitions during import. Default: true."

package/schemas/workflows/tasks/organization-config.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Organization Config Tasks",
+  "description": "Organization configuration workflow operations",
+  "type": "object",
+  "properties": {
+    "task": {
+      "type": "string",
+      "enum": [
+        "OrganizationConfig/Update@1"
+      ],
+      "description": "Task type identifier"
+    },
+    "name": {
+      "type": "string",
+      "description": "Step name identifier"
+    },
+    "description": {
+      "type": "string",
+      "description": "Step description"
+    },
+    "conditions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "expression": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "expression"
+        ]
+      }
+    },
+    "continueOnError": {
+      "type": "boolean"
+    },
+    "inputs": {
+      "type": "object",
+      "description": "OrganizationConfig update inputs",
+      "properties": {
+        "organizationId": {
+          "oneOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Organization ID"
+        },
+        "organizationConfigId": {
+          "oneOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "OrganizationConfig ID to update"
+        },
+        "organizationConfig": {
+          "type": "object",
+          "description": "Dynamic OrganizationConfig values to update",
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "organizationId",
+        "organizationConfigId",
+        "organizationConfig"
+      ],
+      "additionalProperties": true
+    },
+    "outputs": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "mapping": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name",
+          "mapping"
+        ]
+      }
+    }
+  },
+  "required": [
+    "task"
+  ],
+  "additionalProperties": true
+}

package/schemas/workflows/tasks/tracking-event.json

@@ -37,7 +37,7 @@
     },
     "inputs": {
       "type": "object",
-      "description": "TrackingEvent/Create inputs (organizationId, eventDefinitionId or eventDefinitionName, orderId/commodityId/commodityIds, description, location, includeInTracking, sendEmail, eventDate, customValues, skipIfExists, eventDefinitionValues) OR TrackingEvent/Import inputs",
+      "description": "TrackingEvent/Create inputs (organizationId, eventDefinitionId or eventDefinitionName, order/commodity/dispatch-route target, description, location, includeInTracking, sendEmail, eventDate, customValues, skipIfExists, eventDefinitionValues) OR TrackingEvent/Import inputs",
       "properties": {
         "organizationId": {
           "type": ["integer", "string"],
@@ -45,7 +45,7 @@
         },
         "orderId": {
           "type": ["integer", "string"],
-          "description": "Target order ID. Required for TrackingEvent/Import@1; for TrackingEvent/Create@1 at least one of orderId, commodityId, or commodityIds must be provided."
+          "description": "Target order ID. TrackingEvent/Import@1 requires exactly one of orderId, dispatchRouteId, or dispatchRouteStopId. TrackingEvent/Create@1 requires at least one supported target."
         },
         "commodityId": {
           "type": ["integer", "string"],
@@ -58,6 +58,14 @@
             "type": ["integer", "string"]
           }
         },
+        "dispatchRouteId": {
+          "type": ["integer", "string"],
+          "description": "Target dispatch route ID. For TrackingEvent/Import@1 it is mutually exclusive with orderId and dispatchRouteStopId."
+        },
+        "dispatchRouteStopId": {
+          "type": ["integer", "string"],
+          "description": "Target dispatch route stop ID. For TrackingEvent/Import@1 it is mutually exclusive with orderId and dispatchRouteId."
+        },
         "eventDefinitionId": {
           "type": ["integer", "string"],
           "description": "(TrackingEvent/Create@1) ID of an existing event definition. Required if eventDefinitionName is not provided."
@@ -148,7 +156,7 @@
         },
         "skipIfExists": {
           "type": ["boolean", "string"],
-          "description": "(TrackingEvent/Import@1) Skip event if duplicate found via matchByFields. Default: true. (TrackingEvent/Create@1) Skip if an event with the same event definition already exists on the target order or commodity."
+          "description": "(TrackingEvent/Import@1) Skip event if duplicate found via matchByFields. Default: true. (TrackingEvent/Create@1) Skip if an event with the same event definition already exists on a target order, commodity, dispatch route, or dispatch route stop."
         },
         "createEventDefinitions": {
           "type": ["boolean", "string"],