Enterprise Event Search

Enterprise Event Search is a jXchange service that allows the data subscriber to search and retrieve the waiting events from Enterprise Event System.

Message Flow

In Enterprise Event, the Enterprise Event Search service uses a typical exchange of request/response messages to search and retrieve events that are waiting from the system.

Primary Request The consumer forwards the EESEventSrchRq_MType message to the service provider. The message contains:

• JESSrchMsgRqHdr_CType

Primary Response

The service provider returns the EESEventAddRs_MType message to the consumer. The message contains:

• JESSrchMsgRsHdr_CType

EESEventSrchRq_MType

EESEventSrchRq_MType is a message MType element. Contains:

• JESSrchMsgRqHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

SubscrpId

An identifier of a subscription for enterprise events.

JESSrchMsgRqHdr_CType

JESSrchMsgRqHdr_CType is a complex CType element. This is the default message request header for JHA enterprise search services. Contains:

• JESHdr_CType

Simple Elements

The simple elements contained within this complex are listed below.

Cursor

This is 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

This is the maximum number of records when multiple records are returned.

JESHdr_CType

JESHdr_CType is a complex CType element. Contains:

• OrigConsumerInfo_CType

Simple Elements

The simple elements contained within this complex are listed below.

AuditUsrId

This is 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

This is 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.

BusCorrelId

The correlation identification as related to business functions and activities.

ConsumerProd

This is the name of the product which is consuming the service (business product name) for the Soap Header Fault. The canonical values are:

• 4|sight
• Argo
• Episys Explorer
• Experience
• iTalk
• jXchange
• OnBoard
• StreamLine
• Synergy

ConsumerRqDtTime

This is a date/time stamp that confirms the message request was made.

jXLogTrackingId

This is 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.

ValidConsmName

The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.

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.

OrigConsumerInfo_CType

OrigConsumerInfo_CType is a complex CType element. Contains:

• AuthenUsrCred_CType

Simple Elements

The simple elements contained within this complex are listed below.

MachNameIPAddr

Specifies the machine name used with the current channel, which may be the DNS name of the computer or IP Address.

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.
http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf

Simple Elements

The simple elements contained within this complex are listed below.

Security

This element defines the wsse:Security SOAP header element per Section 4.

EESEventSrchRs_MType

EESEventSrchRs_MType is a message MType element. Contains:

• EESEventInfoArray_AType
• JESSrchMsgRsHdr_CType

Simple Elements

The simple elements contained within this message are listed below.

SubscrpId

An identifier of a subscription for enterprise events.

JESSrchMsgRsHdr_CType

JESSrchMsgRsHdr_CType is a complex CType element. This is the default message response header for JHA enterprise services. Contains:

• JESHdr_CType
• MsgRecInfoArray_AType

Simple Elements

The simple elements contained within this complex are listed below.

Cursor

This is 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

This element indicates if there are more records that could be returned. Canonical values are:

• false
• true

SentRec

This is the number of records sent in the response.

TotRec

This element indicates the total records the request selected, which could be larger than MaxRec.

JESHdr_CType

JESHdr_CType is a complex CType element. Contains:

• OrigConsumerInfo_CType

Simple Elements

The simple elements contained within this complex are listed below.

AuditUsrId

This is 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

This is 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.

BusCorrelId

The correlation identification as related to business functions and activities.

ConsumerProd

This is the name of the product which is consuming the service (business product name) for the Soap Header Fault. The canonical values are:

• 4|sight
• Argo
• Episys Explorer
• Experience
• iTalk
• jXchange
• OnBoard
• StreamLine
• Synergy

ConsumerRqDtTime

This is a date/time stamp that confirms the message request was made.

jXLogTrackingId

This is 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.

ValidConsmName

The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.

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.

OrigConsumerInfo_CType

OrigConsumerInfo_CType is a complex CType element. Contains:

• AuthenUsrCred_CType

Simple Elements

The simple elements contained within this complex are listed below.

MachNameIPAddr

Specifies the machine name used with the current channel, which may be the DNS name of the computer or IP Address.

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.
http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf

Simple Elements

The simple elements contained within this complex are listed below.

Security

This element defines the wsse:Security SOAP header element per Section 4.

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 simple elements contained within this complex are listed below.

ErrCat

This is the Soap Header Fault error category.

ErrCode

This is the Soap Header Fault error code.

ErrDesc

This is 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

This is the Soap Header Fault error location. This is typically the program that generated the error condition.

EESEventInfoArray_AType

EESEventInfoArray_AType is an array AType element. This is an array of Enterprise Event Service events. Contains:

• EESEventInfo_CType

EESEventInfo_CType

EESEventInfo_CType is a complex CType element. Contains:

• Custom_CType

EESIdHistInfoArray_AType

EventDataInfoArray_AType

Simple Elements

The simple elements contained within this complex are listed below.

BusCorrelId

The correlation identification as related to business functions and activities.

EventAppId

Identifies the application within a specific consumer product that created the logging message.

EventNum

The EES defined number associated with a defined event in the EED.

EventProcId

Identifies the process for a consumer application that has created the logging message.

EventProd

This is the name of the product which is consuming the service (business product name) for the Soap Header Fault. The canonical values are:

• 4|sight
• Argo
• Episys Explorer
• Experience
• iTalk
• jXchange
• OnBoard
• StreamLine
• Synergy

EventThreadID

An element when the consumer product is executed in a multi-threaded environment.

EventTimeDt

This is the date and time an event was delivered.

EventUniqueId

The unique ID assigned by EES when the event is first published.

EventUsrId

This is 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.

EventWsId

This is 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.

InstId

Identifies the institution that has created the logging message.

ProdEnv

An identification provided by the consumer that defines the environment in which the application is operating.

SystemId

The workstation ID that the consumer would like written to the audit as performing the requested service for Soap Header Fault. It will vary, but it could be the same as the user ID.

WorkflowCorrelId

The correlation identification as related to workflow functions and activities.

Custom_CType

Custom_CType is a complex CType element. This element is optional.

EESIdHistInfoArray_AType

EESIdHistInfoArray_AType is an array AType element. This is an array of historical EES IDs associated with an enterprise event. Contains:

• EESIdHistInfo_CType

EESIdHistInfo_CType

EESIdHistInfo_CType is a complex CType element.

Simple Elements

The simple elements contained within this complex are listed below.

EESHistId

An EES identifier for Enterprise Event Systems.

EventDataInfoArray_AType

EventDataInfoArray_AType is an array AType element. This is an array of enterprise event data name value pairs. Contains:

• EventDataInfo_CType

EventDataInfo_CType

EventDataInfo_CType is a complex CType element.

Simple Elements

The simple elements contained within this complex are listed below.

Name

The name of a name value pair.

Val

The value of a name value pair.

PrevVal

The previous value of a name value pair