Since the Self-Service Customer does not rely on Managed Services as part of Integration design and maintenance, the following Projects must be used as parent Projects on all CIC implementations. They are available for checkout from https://cleo.plan.io/svn/b2bcloud
- com.cleo.b2bcloud.core.selfservice.stage
- com.cleo.b2bcloud.core.selfservice.prod
The b2bcloud.core Project provides important resources to be used with all CIC implementations. Contents include Exit Point Events and Business Processes that should be assigned on the server once this Project has been deployed. There are also Business Processes that can be used as part of Inbound and Outbound EDI Route Processes, Connection Business Processes, as well as for error notifications.
Note: All other Core and Trading Partner Projects in your Studio Workbench should depend on this Project.
Create E-Mail Endpoints (in Prod)
Create the following Endpoints in the production environment. The failed document from the Integration Engine needs to be sent to the Standard Protocol Engine while invoking the Email Endpoint. (Use the Business Process name/ID and document number as the file name to uniquely identify the document/BPS).
Note: Endpoints should be named exactly as shown below.
| Endpoint Name |
Parameters and Recommended Values |
| ClarifyErrorEmailProd |
- Username should be customer’s email authorized to send emails on customer’s mail server (e.g. cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "PROD - Clarify Error Email"
- Body should be "Clarify encountered an error in the business process. Please verify auditor logs."
|
| ClarifyForcedErrorProd |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "PROD - Clarify Forced Error"
- Body should be "Clarify forced error encountered. Please review auditor logs."
|
| ClarifyNoOutboundRouteFoundProd |
- Username should be customer’s email authorized to send emails on customer’s mail server (e.g. cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "PROD - Clarify No Outbound Route Found"
- Body should be "Please review the BPS B2BCloud_NoOutboundRouteError_v2BPS"
|
Create E-Mail Endpoints (in Stage)
Create the following endpoints in the Stage environment. All endpoints should be named exactly as shown here.
| Endpoint Name |
Parameters and Recommended Values |
| ClarifyErrorEmailStage |
- Username should be customer’s email authorized to send emails on customer’s mail server (e.g. cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "STAGE - Clarify Error Email"
- Body should be "Clarify encountered an error in the business process. Please verify auditor logs."
|
| ClarifyForcedErrorStage |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "STAGE - Clarify Forced Error"
- Body should be "Clarify forced error encountered. Please review auditor logs."
|
| ClarifyNoOutboundRouteFoundStage |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "STAGE - Clarify No Outbound Route Found"
- Body should be "Please review the BPS B2BCloud_NoOutboundRouteError_v2BPS"
|
Create E-Mail Endpoints (for Exit Points) in Stage and Prod
Create the following Endpoints related to exit points in both stage and prod environment (if applicable).
| Endpoint Name |
Parameters and Recommended Values |
| ClarifyDuplicateInterchangeExitPoint |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "Clarify Duplicate Interchange Found"
- Body should be "Please review the BPS B2BCloud_DuplicateInterchangeEventBPS.bps."
|
| ClarifyInboundAckErrorExitPoint |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "Clarify Inbound Acknowledgement Error"
- Body should be "Please review audit logs for B2BCloud_InboundAcknowledgementErrorHandler."
|
| ClarifyEDIRouteNotFoundExitPoint |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "Clarify EDI Route Not Found"
- Body should be "Please review auditor logs for BPS B2BCloud_EDIRouteNotFoundEventBPS"
|
| ClarifyRouteErrorExitPoint |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "Clarify encountered Route Errors"
- Body should be "Please review auditor logs for B2BCloud_RouteErrorsBPS."
|
| ClarifyRouteProcessBindingNotFoundExitPoint |
- Username should be customer’s email authorized to send emails on customer’s mail server (for example, cicalerts@domain.com)
- Password should be for the above email account
- Mail server should be customer’s email server
- To email should be customer’s support email account
- Reply To should be customer’s support email account unless customer wants to use a different account
- Subject should be "Clarify encountered Route Process Binding Error"
- Body should be "Please review auditor logs for B2BCloud_EDIRouteProcessBindingNotFoundBPS"
|
Related Topics:
Important Business Processes
The b2bcloud.core Projects (stage/prod) include Exit Point Events and Business Processes that should be assigned on the server once these Projects have been deployed. For single Clarify environments, use only the exit points from the prod Project.
There are also Business Processes that can be used as part of Inbound and Outbound EDI Route Processes, Connection Business Processes, as well as for error notifications.
- B2BCloud_OutboundHarmonyConnectionBPS – Used on EDI Envelopers as the Connection Business Process. Contains the necessary parameters required to integrate with the CIC Harmony implementation.
- B2BCloud_StandardErrorWithAttachmentBPS – This is the standard error notification and should only be used on Business Processes that will not pass a User Reference value. The only parameter is bpsName.
- B2BCloud_NoOutboundRouteErrorV2BPS – This is the error notification when there are no Outbound Routes configured for an outbound document. This BP must be invoked inside the Version 2 DARS as shown below.
