Published Workflow Search
Published Workflow Search is a jXchange service designed to allow consumers to perform a search in Workflow for all published workflows.
Message Flow
In jXchange, the Published Workflow
Search service uses a typical exchange of MType
messages to allow consumers
to search in Workflow for all published workflows using a workflow name
and category code filters.
Primary Request
The Third Party Consumer forwards the
PubWorkflowSrchRq_MType
message to the Service Provider. The message contains:
CatCode
Custom_CType
SrchMsgRqHdr_CType
WorkflowName
Primary Response
The Service Provider returns the
PubWorkflowSrchRs_MType
message to the Third Party Consumer. The message contains:
CatCode
Custom_CType
PubWorkflowSrchRecArray_AType
SrchMsgRsHdr_CType
WorkflowName
Published Workflow Search Behavior
The Published Workflow Search service allows a consumer to search jhaEnterprise Workflow for all published workflows using a workflow name and category code filters.
The PubWorkflowSrchRec_CType
complex was updated with the
~Rstr~ attribute. This provides authority to the package returned for
the Published Workflow Search.
The PubWorkflowSrchRs_MType
message response is an array of workflows that
are available to start including the workflow name, description, version, category code,
category description, and an array of entry variables that can be passed to the starting of a
workflow. The entry variables array contains the variable names, if the workflow requires the
variable to be passed, a description, and a regular expression that can be used by the sender
to evaluate if the variable value will be accepted.
PubWorkflowSrchRq_MType
PubWorkflowSrchRq_MType
is a message
MType
element.
Contains:
Custom_CType
SrchMsgRqHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- CatCode
- The category code of published jhaEnterprise Workflow.
- 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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
PubWorkflowSrchRs_MType
PubWorkflowSrchRs_MType
is a message
MType
element.
Contains:
Custom_CType
PubWorkflowSrchRecArray_AType
SrchMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
- CatCode
- The category code of published jhaEnterprise Workflow.
- WorkflowName
- The published name of the workflow.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
PubWorkflowSrchRecArray_AType
PubWorkflowSrchRecArray_AType
is an array AType
element. This is an array of responses for a published workflow
search.
Contains:
PubWorkflowSrchRec_CType
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.