Skip to main content

MGCLatticeWorkflowActionService

Custom service for workflow operations including submit, approve, reject, delegate, and recall actions.

Methods​

new​

Initializes a new instance of the MGCLatticeWorkflowActionService class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeWorkflowActionService class.

  • Visibility: public
  • Returns: MGCLatticeWorkflowActionService A new MGCLatticeWorkflowActionService instance.

No parameters.

faultMessage​

Returns the text of a workflow instance's latest fault, as the workflow history shows it: the arguments of its last Fault tracking record, joined.

  • Visibility: public
  • Returns: str The fault text, at most 1000 characters; empty when the instance has no fault record.
NameTypeOptionalDescription
_trackingStatusRecIdRecIdNoThe WorkflowTrackingStatusTable record of the instance.

guidText​

Formats a GUID the way every Guid-typed member serializes on the wire: lower case, without braces.

  • Visibility: public
  • Returns: str The GUID text, for example be1322c8-....
NameTypeOptionalDescription
_guidGuidNoThe GUID.

submitToWorkflow​

Submits a document to a workflow of the given type, the way the document's own Submit does: the document checks first, then its status change together with the workflow activation. Supported document table: PurchReqTable (purchase requisitions, workflow type PurchReqReview); any other table is refused, because submitting it would start a workflow without the document's own submit logic.

  • Visibility: public
  • Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract; on success DocumentId is the correlation id of the workflow instance (lower case, without braces), the key the work-item actions, recallWorkflow and getWorkflowStatus take.
NameTypeOptionalDescription
_requestMGCLatticeWorkflowSubmitRequestContractNoThe request containing WorkflowTypeName, RecordRecId or DocumentNumber, TableName, Comment, and standard header fields.

approveWorkItem​

Approves a pending workflow work item.

  • Visibility: public
  • Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details.
NameTypeOptionalDescription
_requestMGCLatticeWorkflowActionRequestContractNoThe request containing WorkItemRecId, Comment, and standard header fields.

rejectWorkItem​

Rejects a pending workflow work item, returning it to the submitter.

  • Visibility: public
  • Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details.
NameTypeOptionalDescription
_requestMGCLatticeWorkflowActionRequestContractNoThe request containing WorkItemRecId, Comment, and standard header fields.

delegateWorkItem​

Delegates a pending workflow work item to another user.

  • Visibility: public
  • Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details.
NameTypeOptionalDescription
_requestMGCLatticeWorkflowActionRequestContractNoThe request containing WorkItemRecId, DelegateToUserId, Comment, and standard header fields.

recallWorkflow​

Recalls (cancels) an active workflow instance using the workflow correlation ID.

  • Visibility: public
  • Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details.
NameTypeOptionalDescription
_requestMGCLatticeWorkflowRecallRequestContractNoThe request containing WorkflowCorrelationId, Comment, and standard header fields.

getWorkflowStatus​

Queries the current workflow tracking status of a document.

  • Visibility: public
  • Returns: MGCLatticeStatusQueryResponseContract An MGCLatticeStatusQueryResponseContract with the workflow tracking status and detail information.
NameTypeOptionalDescription
_requestMGCLatticeStatusQueryRequestContractNoThe request containing DocumentId - the workflow correlation id submitToWorkflow returns, the source record's RecId, or the source document's number (a purchase requisition number, resolved as submitToWorkflow does) - and standard header fields.

submitToWorkflowBatch​

Submits multiple records to workflow in a single bulk operation.

  • Visibility: public
  • Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.
NameTypeOptionalDescription
_requestsListNoList of MGCLatticeWorkflowSubmitRequestContract.

approveWorkItemBatch​

Approves multiple work items in a single bulk operation.

  • Visibility: public
  • Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.
NameTypeOptionalDescription
_requestsListNoList of MGCLatticeWorkflowActionRequestContract.

rejectWorkItemBatch​

Rejects multiple work items in a single bulk operation.

  • Visibility: public
  • Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.
NameTypeOptionalDescription
_requestsListNoList of MGCLatticeWorkflowActionRequestContract.

delegateWorkItemBatch​

Delegates multiple work items in a single bulk operation.

  • Visibility: public
  • Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.
NameTypeOptionalDescription
_requestsListNoList of MGCLatticeWorkflowActionRequestContract.

recallWorkflowBatch​

Recalls multiple workflows in a single bulk operation.

  • Visibility: public
  • Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.
NameTypeOptionalDescription
_requestsListNoList of MGCLatticeWorkflowRecallRequestContract.