Notification Send Addition
Notification Send Addition
Notification Send Addition is a jXchange service designed to allow ENS publishers to send content-managed alerts with full service capabilities exclusively to enrolled ENS recipients and recipient distribution groups.
Message Flow
In jXchange, the Notification Send Addition service uses a typical exchange of
MType messages to send
content-managed alerts with full service capabilities exclusively to enrolled ENS recipients
and recipient distribution groups.
Primary Request
The consumer forwards the NotSndAddRq_MType message to the
service provider.
The message contains the following simple elements:
- AlrtName
- AlrtTestType
- ConsumerProd
- InstRtId
- PubVer
The message contains the following complex elements:
AlrtSndInfoRec_CTypeCustom_CTypeMsgRqHdr_CType
The message contains the following array:
ErrOvrRdInfoArray_AType
Primary Response
The service provider returns the NotSndAddRs_MType message to the
consumer.
The message contains the following simple elements:
- AlrtPkgId
- RsStat
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
Notification Send Addition Behavior
The Notification Send Addition
(NotSndAdd) operation behavior is as follows.
The Notification Send Addition root request message
(NotSndAddRq_MType) requires the Institution Routing Identification
(InstRtId), Consumer Product (ConsumerProd),
and Alert Name (AlrtName) simple elements. The Alert Send Information
Record complex (AlrtSndInfoRec_CType) is also required.
The Notification Send Addition root request message (NotSndAddRq_MType)
optionally allows for the Publisher Version (PubVer) and Alert Test
Type (AlrtTestType) simple elements. The Alert Test Type
(AlrtTestType) simple element default value is
~false~. The absence of the Publisher Version
(PubVer) simple element conveys to the service provider to assign the
default publisher version configured in the ENS application.
The Alert Send Information Record complex (AlrtSndInfoRec_CType)
encapsulates the elements required to create a successful alert send request. The Send Every
Subscriber (SndEvrySub) simple element and Send Alert Array
(SndAlrtArray_AType) are part of a documented choice statement, whereas
they are optional but at least one is required. The Alert Send Information Record complex
(AlrtSndInfoRec_CType) optionally allows for the Override Reply to Email
Address (OvrrdReplyToEmailAddr) simple element, Send Delay Time Date
(SndDlyTimeDt) simple element, and the Alert Data Information Array
(AlrtDataInfoArray_AType). The Send Every Subscriber
(SndEvrySub) simple element's default value is
~false~. The Send Delay Time Date
(SndDlyTimeDt) simple element uses UTC format as governed by ISO 8601
time format.
The Send Alert Record complex (SndAlrtRec_CType) encapsulates a documented
choice statement, whereas the Consumer Recipient Identification
(ConsmRecipId) simple element optionally along with the Consumer
Recipient Account Identification (ConsmRecipAcctId) simple element or
the Distribution Group Identification (DistGroupId) simple element are
optional, but at least one identifier is required.
The Alert Data Information Array (AlrtDataInfoArray_AType) provides a
matched pair substitution to the service provider. The array is optional. However, the Name
(Name) and Value (Val) simple elements are
required. The Value (Val) simple element allows for a null value by
incorporating the JHANull attribute behavior.
The Notification Send Addition root response message (NotSndAddRs_MType)
returns an Alert Package Identification (AlrtPkgId) simple element upon
a successful addition request.
Adhere to the tenets related to an Addition Service.
Adhere to the tenets related to Fault and Warnings conveyed in the message as related to business faults.
Adhere to the tenets related to Backwards Compatibility.
NotSndAddRq_MType
NotSndAddRq_MType is a message
MType element.
Contains:
AlrtSndInfoRec_CTypeCustom_CTypeErrOvrRdInfoArray_ATypeMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- AlrtName
- The name assigned to an alert package.
- AlrtTestType
- Answers the question: Should the alert be treated as a test?
Canonical values are:
- false
- true
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- 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.
- PubVer
- The version as related to a publisher's configuration and library contents in Enterprise Notification System (ENS).
AlrtSndInfoRec_CType
AlrtSndInfoRec_CType is a complex
CType element.
Contains:
AlrtDataInfoArray_ATypeCustom_CTypeSndAlrtArray_AType
Simple Elements
The following simple elements are contained within this complex.
- OvrrdReplyToEmailAddr
- Email address.
- SndDlyTimeDt
- The date and time that an alert is delayed. Expressed in ISO 8601 time format and should contain either Zulu time or local time and the UTC offset. Format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm].
- SndEvrySub
- Answers the question: Should the alert be sent to all
subscribers? Canonical values are:
- false
- true
AlrtDataInfoArray_AType
AlrtDataInfoArray_AType is an
array AType element. This is an array of data matched pair
substitution.
Contains:
AlrtDataInfoRec_CType
AlrtDataInfoRec_CType
AlrtDataInfoRec_CType is a
complex CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- Name
- The name of a name value pair.
- Val
- The value of a name value pair.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SndAlrtArray_AType
SndAlrtArray_AType is an array
AType element. This is an array of sending alerts.
Contains:
SndAlrtRec_CType
SndAlrtRec_CType
SndAlrtRec_CType is a complex
CType element.
Contains:
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ConsmRecipAcctId
- The number or character that identifies an account record.
- ConsmRecipId
- The identifier assigned to a publisher's alert recipient.
- DistGroupId
- An identifier assigned to an alert distribution group.
- RecipConId
- An identifier assigned to a recipient's alert contacts.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
ErrOvrRdInfoArray_AType
ErrOvrRdInfoArray_AType is an array
AType element. This is an array of overrides for
faults.
Contains:
ErrOvrRd_CType
ErrOvrRd_CType
ErrOvrRd_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 following simple elements are contained within this complex.
- BusSvcType
- The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
- ErrCode
- The error code.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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.
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
NotSndAddRs_MType
NotSndAddRs_MType is an
MType message.
Contains:
Custom_CTypeMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- AlrtPkgId
- An identifier assigned to an alert package.
- RsStat
- The status of the response. Canonical values are:
- Fail
- Success
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 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.