Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Workflow Instance Search

Enterprise SOAP API > API by Reference > jXchange Enterprise Services > Workflow Instance Search

Workflow Instance Search

Workflow Instance Search is a jXchange service designed to allow consumers to perform a search for running workflow instances.

Message Flow

In jXchange, the Workflow Instance Search service uses a typical exchange of MType messages to allow consumers to search for running workflow instances.

Primary Request

The Third Party Consumer forwards the WorkflowInstcSrchRq_MType message to the Service Provider. The message contains:

  • AssocBusCorrelID
  • AssocUsr
  • AssocWorkflowCorrelId
  • AttachId
  • AttachIdType
  • CatCode
  • ExclUnassign
  • QueCode
  • WorkflowInstcId
  • WorkflowName
  • Custom_CType
  • SrchMsgRqHdr_CType
  • VrblNameValRec_CType

Primary Response

The Service Provider returns the WorkflowInstcSrchRs_MType message to the Third Party Consumer. The message contains:

  • AssocBusCorrelID
  • AssocUsr
  • AssocWorkflowCorrelId
  • AttachId
  • AttachIdType
  • CatCode
  • ExclUnassign
  • QueCode
  • WorkflowInstcId
  • WorkflowName
  • Custom_CType
  • SrchMsgRsHdr_CType
  • VrblNameValRec_CType
  • WorkflowInstcSrchInfoArray_AType

Workflow Instance Search Behavior

All of the search filters should work if any or all of the elements are provided. WorkflowName and CatCode can use Exact, Starts With, or Contains. The default for these two simple elements is Exact.

Included in the search filters are AssocBusCorrelID and AssocWorkflowCorrelId.

WorkflowInstcSrchRq_MType

WorkflowInstcSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRqHdr_CType
  • VrblNameValRec_CType
  • VrblNameValRecArray_AType

VrblNameValRec_CType Deprecation Details

This complex was deprecated effective 2018-01-01.

The Variable Name Value Record was replaced by the Variable Name Value Record Array.

Simple Elements

The following simple elements are contained within this message.

AssocBusCorrelID
The correlation identification as related to business functions and activities.
AssocUsr
The IMS subject.
AssocWorkflowCorrelId
The correlation identification as related to workflow functions and activities.
AttachId
The unique ID associated with the attachment.
AttachIdType
The type of the unique key. Canonical values are:
  • ChkImg
  • DogImg
  • File
  • URI
CatCode
The category code of published jhaEnterprise Workflow.
ExclUnassign
Exclude jhaEnterprise Workflow instances that are not currently associated with an IMS subject (user). Canonical values are:
  • false
  • true
InstcCmpltEndDt
The date that designates the ending point for date selections.
InstcCmpltStartDt
The date that designates the starting point for date selections.
InstcInitEndDt
The date that designates the ending point for date selections.
InstcInitStartDt
The date that designates the starting point for date selections.
QueCode
The queue code of a workflow instance.
WorkflowInstcId
The identification of the workflow instance.
WorkflowName
The published name of the workflow.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MaxRec
The maximum number of records when multiple records are returned.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

VrblNameValRec_CType

VrblNameValRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

VrblName
The name provided to a variable.
VrblVal
The variable value.

VrblNameValRecArray_AType

VrblNameValRecArray_AType is an array AType element. This is an array of variable names and values.

Contains:

  • VrblNameValRec_CType

VrblNameValRec_CType

VrblNameValRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

VrblName
The name provided to a variable.
VrblVal
The variable value.

WorkflowInstcSrchRs_MType

WorkflowInstcSrchRs_MType is a message MType element.

Contains:

  • Custom_CType
  • SrchMsgRsHdr_CType
  • VrblNameValRec_CType
  • VrblNameValRecArray_AType
  • WorkflowInstcSrchInfoArray_AType

VrblNameValRec_CType Deprecation Details

This complex was deprecated effective 2018-01-01.

The Variable Name Value Record was replaced by the Variable Name Value Record Array.

Simple Elements

The following simple elements are contained within this message.

AssocBusCorrelID
The correlation identification as related to business functions and activities.
AssocUsr
The IMS subject.
AssocWorkflowCorrelId
The correlation identification as related to workflow functions and activities.
AttachId
The unique ID associated with the attachment.
AttachIdType
The type of the unique key. Canonical values are:
  • ChkImg
  • DogImg
  • File
  • URI
CatCode
The category code of published jhaEnterprise Workflow.
ExclUnassign
Exclude jhaEnterprise Workflow instances that are not currently associated with an IMS subject (user). Canonical values are:
  • false
  • true
InstcCmpltEndDt
The date that designates the ending point for date selections.
InstcCmpltStartDt
The date that designates the starting point for date selections.
InstcInitEndDt
The date that designates the ending point for date selections.
InstcInitStartDt
The date that designates the starting point for date selections.
QueCode
The queue code of a workflow instance.
WorkflowInstcId
The identification of the workflow instance.
WorkflowName
The published name of the workflow.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MoreRec
Indicates if there are more records that could be returned. Canonical values are:
  • false
  • true
SentRec
The number of records sent in the response.
TotRec
Indicates the total records the request selected, which could be larger than MaxRec.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The Soap Header Fault error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

VrblNameValRec_CType

VrblNameValRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

VrblName
The name provided to a variable.
VrblVal
The variable value.

VrblNameValRecArray_AType

VrblNameValRecArray_AType is an array AType element. This is an array of variable names and values.

Contains:

  • VrblNameValRec_CType

VrblNameValRec_CType

VrblNameValRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

VrblName
The name provided to a variable.
VrblVal
The variable value.

WorkflowInstcSrchInfoArray_AType

WorkflowInstcSrchInfoArray_AType is an array AType element. This is an array of responses for a workflow instances search.

Contains:

  • WorkflowInstcSrchInfo_CType

WorkflowInstcSrchInfo_CType

WorkflowInstcSrchInfo_CType is a custom CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

AssocBusCorrelID
The correlation identification as related to business functions and activities.
AssocWorkflowCorrelId
The correlation identification as related to workflow functions and activities.
CatCodeDesc
The description of the category code.
CatCode
The category code of published jhaEnterprise Workflow.
WorkflowDesc
The description of the workflow.
WorkflowInstcDueTimeDt
The due date/time for the workflow instance.
WorkflowInstcEndTimeDt
The date/time a workflow ended or completed.
WorkflowInstcId
The identification of the workflow instance.
WorkflowInstcPry
The workflow instance priority. Canonical values are:
  • High
  • Low
  • Norm
WorkflowInstcStartTimeDt
The start date/time for the workflow instance.
WorkflowName
The published name of the workflow.
WorkflowStatType
The status of a workflow instance. Canonical values are:
  • Act
  • Cmplt
  • Err
  • Susp
  • Ter
WorkflowVer
The version of the published workflow.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022