Broadcast Add
Broadcast Add is a jXchange service that allows publishers to add one or more entries to EES. This message is designed to translate an BrdCstAdd to an EESAdd.
Message Flow
In Enterprise Event, the Broadcast Add service uses a typical exchange of request/response messages to add one or more entries to the system by translating BrdCstAdd to EESAdd.
Primary Request
The consumer forwards the BrdCstAddRq_MType message to the service provider. The message
contains:
BrdCstInfoArray_ATypeErrOvrRdInfoArray_ATypeJESMsgRqHdr_CType
Primary Response
The service provider returns the BrdCstAddRs_MType message to the consumer. The message contains:
BrdCstRsInfoArray_AType
JESMsgRsHdr_CType
Broadcast Add Service Behavior
If the add message is missing any key values, an error is returned.
The Broadcast Event Manager (BEM) repository is expected to behave on a first in, first out method.
The BEM application creates a date/time stamp for each event when the event is registered in the BEM repository.
The BEM application may return an error message if the BrdCastAdd message contains the element EventPkgContent with a size greater than the BEM application can tolerate for stored packages. This must be clearly conveyed to the provider who is submitting the BrdCastAdd message so they can resubmit the BrdCastAdd message with the element EventRef. The reasonable size of the event package content is 16K.
The BEM application generates a standard event expiration date when the provider does not provide one. The suggested default is fourteen calendar days from the time an accepted registration of an event is received. An expired event equates to a deleted registered event, and should not be returned in the BrdCstSrch request. The BEM application is not responsible for the integrity of any data files delivered. The provider is responsible for the validation of the data files registered. There are XSD contracts that correlate with the events that deliver off-line batch files available to all providers.
BrdCstAddRq_MType
BrdCstAddRq_MType is a message MType element.
Contains:
BrdCstInfoArray_AType
ErrOvrRdInfoArray_AType
JESMsgRqHdr_CType
BrdCstInfoArray_AType
BrdCstInfoArray_AType is an array AType element. This is an array of broadcast events.
Contains:
BrdCstInfoRec_CType
BrdCstInfoRec_CType
BrdCstInfoRec_CType is a complex CType element.
Simple Elements
The simple elements contained within this complex are listed below.
EventCode
This is the code of the event that occurred. The event codes for the Broadcast Event are provided in the
canonical values. The event codes for ESM are located in the Enterprise Event Dictionary, referred to as
EED. Canonical values are:
- AcctAnlysStmt
- AcctAnlysStmtUpd
- AcctRelCodeDetail
- AcctRelCodeDetailUpd
- AcctStmt
- AcctStmtUpd
- AcctTitleDetail
- AcctTitleDetailUpd
- AllItemsTrn
- AllItemsTrnUpd
- CollatTrackItem
- CollatTrackItemDesc
- CollatTrackItemDescUpd
- CollatTrackItemUpd
- CurrTrnDetail
- CurrTrnDetailUpd
- CustAcctDetail
- CustAcctDetailUpd
- CustDetail
- CustDetailUpd
- Cust_Acct
- Cust_AcctUpd
- Cust_Email
- Cust_EmailUpd
- Cust_FileMainDetail
- Cust_FileMainDetailUpd
- Cust_IdVerifyDetail
- Cust_IdVerifyDetailUpd
- Cust_OffCodeDetail
- Cust_OffCodeDetailUpd
- Cust_Phone
- Cust_PhoneUpd
- Cust_SynapUserDefDetail
- Cust_SynapUserDefDetailUpd
- Cust_UserDefDetail
- Cust_UserDefDetailUpd
- DepAcct
- DepAcctHist
- DepAcctHistUpd
- DepAcctMemo
- DepAcctMemoUpd
- DepAcctUpd
- DepTrn
- DepTrnUpd
- Dep_AcctSweepDetail
- Dep_AcctSweepDetailUpd
- Dep_AcctTitle
- Dep_AcctTitleUpd
- Dep_AcctWavDetail
- Dep_AcctWavDetailUpd
- Dep_EFTDesc
- Dep_EFTDescUpd
- Dep_MemoPostRmk
- Dep_MemoPostRmkUpd
- Dep_StopChkDetail
- Dep_StopChkDetailUpd
- Dep_SynapUserDefDetail
- Dep_SynapUserDefDetailUpd
- Dep_TrnCodeDetail
- Dep_TrnCodeDetailUpd
- Dep_UserDefDetail
- Dep_UserDefDetailUpd
- Dep_XferDetail
- Dep_XferDetailUpd
- EFTCard
- EFTCardUpd
- EFTCardAcctId
- EFTCardAcctIdUpd
- EFTDescDetail
- EFTDescDetailUpd
- EmailDetail
- EmailDetailUpd
- EscrwDetail
- EscrwDetailUpd
- FASB91Acct
- FASB91AcctUpd
- FedActNotif
- FedShutDown
- FedStartUp
- GLAcct
- GLAcctMonthBalDetail
- GLAcctMonthBalDetailUpd
- GLAcctQtrBalDetail
- GLAcctQtrBalDetailUpd
- jXchange™ Release 2014.0
- GLAcctUpd
- GLTrn
- GLTrnUpd
- InstAppProcDetail
- InstAppProcDetailUpd
- InstBrDetail
- InstBrDetailUpd
- InstDetail
- InstDetailUpd
- IntRateIdxDetail
- IntRateIdxDetailUpd
- LnAcct
- LnAcctHist
- LnAcctUpd
- LnAcctHistUpd
- LnAcctMemo
- LnAcctMemoUpd
- LnAcctUpd
- LnBilDetail
- LnBilDetailUpd
- LnFeeDetail
- LnFeeDetailUpd
- LnGLAppTrn
- LnGLAppTrnUpd
- LnPmtSchedDetail
- LnPmtSchedDetailUpd
- LnTrn
- LnTrnUpd
- Ln_AcctTitle
- Ln_AcctTitleUpd
- Ln_EFTDesc
- Ln_EFTDescUpd
- Ln_MemoPostRmk
- Ln_MemoPostRmkUpd
- Ln_OffCodeDetail
- Ln_OffCodeDetailUpd
- jXchange™ Release 2014.0
- Ln_SynapUserDefDetail
- Ln_SynapUserDefDetailUpd
- Ln_UserDefDetail
- Ln_UserDefDetailUpd
- Ln_XferDetail
- Ln_XferDetailUpd
- LOCDetail
- LOCDetailUpd
- MemoPostRmkDetail
- MemoPostRmkDetailUpd
- OffCodeDetail
- OffCodeDetailUpd
- PhoneDetail
- PhoneDetailUpd
- PlnCodeDetail
- PlnCodeDetailUpd
- ProdCodeDetail
- ProdCodeDetailUpd
- SafeDepAcct
- SafeDepAcctUpd
- SafeDep_AcctTitle
- SafeDep_AcctTitleUpd
- SafeDep_UserDefDetail
- SafeDep_UserDefDetailUpd
- TimeDepAcct
- TimeDepAcctHist
- TimeDepAcctHistUpd
- TimeDepAcctMemo
- TimeDepAcctMemoUpd
- TimeDepAcctUpd
- TimeDepTrn
- TimeDepTrnUpd
- TimeDep_AcctTitle
- TimeDep_AcctTitleUpd
- TimeDep_EFTDesc
- TimeDep_EFTDescUpd
- jXchange™ Release 2014.0
- TimeDep_MemoPostRmk
- TimeDep_MemoPostRmkUpd
- TimeDep_StopChkDetail
- TimeDep_StopChkDetailUpd
- TimeDep_SynapUserDefDetail
- TimeDep_SynapUserDefDetailUpd
- TimeDep_TaxPlnDetail
- TimeDep_TaxPlnDetailUpd
- TimeDep_UserDefDetail
- TimeDep_UserDefDetailUpd
- TrckAcct
- TrckAcctUpd
EventExpDt
This is an expiration date for a specific event.
EventExpTerm
This is the expiration period for a specific event.
EventExpTermUnit
This is the expiration unit of time for a specific event. Canonical values are:
- Days
- Indefinite
- Months
- NA
- Years EventPkgContent
This is the package that contains the actual data for the referenced event.
EventRef
This is a URI location where an events object is located.
EventSupsd
This field indicates whether or not the event being written should supersede all previously stored events with the equivalent keys. Canonical values are:
- false
- true
PrvdFamName
The category or group that the event owner is associated with. Canonical values are:
Card Services
CkImg
Core
CrCardServices
DocImg
Fraud
HumanCapMgmt
JES
OLB
PltFm
Wires
VR
PrvdName
The owner name who submitted an event. Canonical values are:CIF2020
Episys
iTalk
jXchange
ODI
Passport
SilverLake
YellowHammer
PrvdSrcEnv
This is an identification provided by the provider of the event that defines the environment in which the institution is operating. Canonical values are:
- Prod
PrvdSrcId
This is an ID that identifies the provider of the broadcast event. The routing transit or ABA nine digit number is recommended for financial institutions as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErroOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.
Simple Elements
The simple elements contained within this complex are listed below.
ErrCode
This is the Soap Header Fault error code.
JESMsgRqHdr_CType
JESMsgRqHdr_CType is a complex CType element.
Contains:
JESHdrof typeJESHdr_CType
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.
BrdCstAddRs_MType
BrdCstAddRs_MType is a message MType element.
Contains:
BrdCstRsInfoArray_ATypeJESMsgRsHdr_CType
Simple Elements
The simple elements contained within this message are listed below.
RsStat
This is the status of the response. Canonical values are:
- Fail
- Success
BrdCstRsInfoArray_AType
BrdCstRsInfoArray_AType is an array AType element. This is an array of broadcast event responses.
Contains:
BrdCstRsInfoRec_CType
BrdCstRsInfoRec_CType
BrdCstRsInfoRec_CType is a complex CType element.
Simple Elements
The simple elements contained within this complex are listed below.
EventCode
This is the code of the event that occurred. The event codes for the Broadcast Event are provided in the
canonical values. The event codes for ESM are located in the Enterprise Event Dictionary, referred to as
EED. Canonical values are:
- AcctAnlysStmt
- AcctAnlysStmtUpd
- AcctRelCodeDetail
- AcctRelCodeDetailUpd
- AcctStmt
- AcctStmtUpd
- AcctTitleDetail
- AcctTitleDetailUpd
- AllItemsTrn
- AllItemsTrnUpd
- CollatTrackItem
- CollatTrackItemDesc
- CollatTrackItemDescUpd
- CollatTrackItemUpd
- CurrTrnDetail
- CurrTrnDetailUpd
- CustAcctDetail
- CustAcctDetailUpd
- CustDetail
- CustDetailUpd
- Cust_Acct
- Cust_AcctUpd
- Cust_Email
- Cust_EmailUpd
- Cust_FileMainDetail
- Cust_FileMainDetailUpd
- Cust_IdVerifyDetail
- Cust_IdVerifyDetailUpd
- Cust_OffCodeDetail
- Cust_OffCodeDetailUpd
- Cust_Phone
- Cust_PhoneUpd
- Cust_SynapUserDefDetail
- Cust_SynapUserDefDetailUpd
- Cust_UserDefDetail
- Cust_UserDefDetailUpd
- DepAcct
- DepAcctHist
- DepAcctHistUpd
- DepAcctMemo
- DepAcctMemoUpd
- DepAcctUpd
- DepTrn
- DepTrnUpd
- Dep_AcctSweepDetail
- Dep_AcctSweepDetailUpd
- Dep_AcctTitle
- Dep_AcctTitleUpd
- Dep_AcctWavDetail
- Dep_AcctWavDetailUpd
- Dep_EFTDesc
- Dep_EFTDescUpd
- Dep_MemoPostRmk
- Dep_MemoPostRmkUpd
- Dep_StopChkDetail
- Dep_StopChkDetailUpd
- Dep_SynapUserDefDetail
- Dep_SynapUserDefDetailUpd
- Dep_TrnCodeDetail
- Dep_TrnCodeDetailUpd
- Dep_UserDefDetail
- Dep_UserDefDetailUpd
- Dep_XferDetail
- Dep_XferDetailUpd
- EFTCard
- EFTCardUpd
- EFTCardAcctId
- EFTCardAcctIdUpd
- EFTDescDetail
- EFTDescDetailUpd
- EmailDetail
- EmailDetailUpd
- EscrwDetail
- EscrwDetailUpd
- FASB91Acct
- FASB91AcctUpd
- FedActNotif
- FedShutDown
- FedStartUp
- GLAcct
- GLAcctMonthBalDetail
- GLAcctMonthBalDetailUpd
- GLAcctQtrBalDetail
- GLAcctQtrBalDetailUpd
- GLAcctUpd
- GLTrn
- GLTrnUpd
- InstAppProcDetail
- InstAppProcDetailUpd
- InstBrDetail
- InstBrDetailUpd
- InstDetail
- InstDetailUpd
- IntRateIdxDetail
- IntRateIdxDetailUpd
- LnAcct
- LnAcctHist
- LnAcctUpd
- LnAcctHistUpd
- LnAcctMemo
- LnAcctMemoUpd
- LnAcctUpd
- LnBilDetail
- LnBilDetailUpd
- LnFeeDetail
- LnFeeDetailUpd
- LnGLAppTrn
- LnGLAppTrnUpd
- LnPmtSchedDetail
- LnPmtSchedDetailUpd
- LnTrn
- LnTrnUpd
- Ln_AcctTitle
- Ln_AcctTitleUpd
- Ln_EFTDesc
- Ln_EFTDescUpd
- Ln_MemoPostRmk
- Ln_MemoPostRmkUpd
- Ln_OffCodeDetail
- Ln_OffCodeDetailUpd
- Ln_SynapUserDefDetail
- Ln_SynapUserDefDetailUpd
- Ln_UserDefDetail
- Ln_UserDefDetailUpd
- Ln_XferDetail
- Ln_XferDetailUpd
- LOCDetail
- LOCDetailUpd
- MemoPostRmkDetail
- MemoPostRmkDetailUpd
- OffCodeDetail
- OffCodeDetailUpd
- PhoneDetail
- PhoneDetailUpd
- PlnCodeDetail
- PlnCodeDetailUpd
- ProdCodeDetail
- ProdCodeDetailUpd
- SafeDepAcct
- SafeDepAcctUpd
- SafeDep_AcctTitle
- SafeDep_AcctTitleUpd
- SafeDep_UserDefDetail
- SafeDep_UserDefDetailUpd
- TimeDepAcct
- TimeDepAcctHist
- TimeDepAcctHistUpd
- TimeDepAcctMemo
- TimeDepAcctMemoUpd
- TimeDepAcctUpd
- TimeDepTrn
- TimeDepTrnUpd
- TimeDep_AcctTitle
- TimeDep_AcctTitleUpd
- TimeDep_EFTDesc
- TimeDep_EFTDescUpd
- TimeDep_MemoPostRmk
- TimeDep_MemoPostRmkUpd
- TimeDep_StopChkDetail
- TimeDep_StopChkDetailUpd
- TimeDep_SynapUserDefDetail
- TimeDep_SynapUserDefDetailUpd
- TimeDep_TaxPlnDetail
- TimeDep_TaxPlnDetailUpd
- TimeDep_UserDefDetail
- TimeDep_UserDefDetailUpd
- TrckAcct
- TrckAcctUpd
EventId
This is a unique identifier provided by service provider for registered events.
PrvdFamName
The category or group that the event owner is associated with. Canonical values are:
Card Services
CkImg
Core
CrCardServices
DocImg
Fraud
HumanCapMgmt
JES
OLB
PltFm
Wires
VR
PrvdName
The owner name who submitted an event. Canonical values are:CIF2020
Episys
iTalk
jXchange
ODI
Passport
SilverLake
YellowHammer
PrvdSrcEnv
This is an identification provided by the provider of the event that defines the environment in which the institution is operating. Canonical values are:
- Prod
PrvdSrcId This is an ID that identifies the provider of the broadcast event. The routing transit or ABA nine digit number is recommended for financial institutions as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number.
JESMsgRsHdr_CType
JESMsgRsHdr_CType is a complex CType element. This element is optional.
Contains:
JESHdrof typeJESHdr_CTypeMsgRecInfoArrayof typeMsgRecInfoArray_AType
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.