Skip to main content

NCR Counterpoint to iPaaS.com Message Mapping Documentation

Field-level mapping documentation for the NCR Counterpoint Message collections.

Summary

This mapping collection brings messages from NCR Counterpoint into iPaaS.com. A Counterpoint message is an internal note one Counterpoint user sends to one or more others, such as a reminder for store staff or a notice from head office. Each message becomes an iPaaS.com message carrying its subject as the message text, its body as the message details, the time it was sent, a severity taken from the importance the sender gave it, and whether Counterpoint shows it as a popup.

ID Format

  • Manual Sync id: the Counterpoint message id, a number such as 100000000000101. This collection reads inbound from Counterpoint, so the id entered on the Manual Sync page is the message's Counterpoint-side id, not an iPaaS.com value.

  • External ID saved after transfer: once a message has been transferred, iPaaS.com records its Counterpoint message id as the external ID on a dedicated platform-managed external-ID record, for example 100000000000101. That record, not any field on the message itself, is what routes a later transfer of the same Counterpoint message to an update of the same iPaaS.com message rather than adding it a second time.

Deleted Record Support

This collection does not carry deletions. A message removed in Counterpoint is kept in iPaaS.com. See NCR Counterpoint Known Limitations.

Mapping Collection Status

  • Status: Enabled. No mapping filter is applied.

  • Trigger Events: message/created and message/updated, raised by NCR Counterpoint once the optional Messages feature has been installed in the Counterpoint database and the subscriptions enabled in Inbound Data Flows. Until then, messages transfer only through Manual Sync, which works without the feature.

Duplicate or Conflicting Records

This collection has no Collision Handling Method. A message is matched only through its external ID: a Counterpoint message that has already been transferred updates the iPaaS.com message it is linked to, and one that has not been transferred is added as a new iPaaS.com message.

System Caveats

NCR Counterpoint Caveats

  • Importance has three values: Counterpoint records a message's importance as N (normal), L (low) or H (high). The shipped Severity formula treats only H as a warning, so low and normal importance both arrive as Info. Subscribers or their MiSP who want a different split can change the formula.

  • The subject is short: Counterpoint stores a message subject as text of up to 50 characters, so the iPaaS.com message text is never longer than 50 characters. The full body arrives in Details.

  • Send times carry no time zone: Counterpoint records the time a message was sent without a time zone. The shipped MessageCreatedTime formula treats it as a local time when converting it for iPaaS.com. Subscribers or their MiSP should confirm in a staging environment that the time shown in iPaaS.com matches the time the message was sent before relying on it in production.

iPaaS.com Caveats

  • Recipients are not carried: the Counterpoint users a message was sent to are not mapped to iPaaS.com users. The iPaaS.com message is recorded without recipients.

  • IsPopup is a custom field: the IsPopup mapping writes to an iPaaS.com message custom field of that name, which must exist in iPaaS.com for the mapping to be kept.

Integration Flow

  1. No records are transferred as prerequisites for this collection.

  2. The message is read from Counterpoint by its message id, either from the trigger event or from the id entered on the Manual Sync page.

  3. The message is sent to iPaaS.com, added as a new message or, where the Counterpoint message is already linked, updating the message it is linked to.

Mappings

Add/Update NCR Counterpoint Message TO iPaaS.com

Mapping Type

Source Field (NCR Counterpoint)

Destination Field (iPaaS.com)

Description

Field

IS_POPUP

IsPopup

Optional. Whether the message was sent as a popup (Y or N), into the iPaaS.com message custom field IsPopup.

Static

"Transfer"

Type

Required. Every message is recorded with the type Transfer.

Dynamic Formula

Formula

Severity

Required. Warning for high importance, Info otherwise.

Dynamic Formula

Formula

MessageCreatedTime

Required. The time the message was sent.

Field

SUBJ

Text

Required. The message subject, up to 50 characters.

Field

MSG_TXT

Details

Required. The message body, in full.

IsPopup — Field

Source: IS_POPUP · Destination: IsPopup

This is an optional field, and it is a custom field rather than one of the message's standard fields. Whether the message was sent as a popup in Counterpoint: Y for a popup, N otherwise. It is carried across unchanged into the iPaaS.com message custom field IsPopup, which must exist in iPaaS.com for this mapping to be kept. Subscribers or their MiSP who have no use for it can remove the mapping.

Type — Static

Source: "Transfer" · Destination: Type

This is a required field. Every message from NCR Counterpoint is recorded in iPaaS.com with the type Transfer, which marks it as a message that arrived through an integration. iPaaS.com also accepts Event, Billing Notification, System Status and Other; subscribers or their MiSP can change the value if another type suits how they sort their messages.

Severity — Dynamic Formula

Destination: Severity

if (IMPORTANCE == "H")
    return "Warning";
return "Info";

This is a required field. Counterpoint records the importance the sender gave a message as N (normal), L (low) or H (high). A high-importance message arrives in iPaaS.com as a Warning; a normal or low-importance message arrives as Info. Subscribers or their MiSP who want low importance to arrive differently can extend the formula; iPaaS.com also accepts Verbose, Error, None and Critical.

MessageCreatedTime — Dynamic Formula

Destination: MessageCreatedTime

DateTimeOffsetFromLocalDateTime(SENT_DT)

This is a required field. The time the message was sent in Counterpoint. Counterpoint records it without a time zone, so the formula treats it as a local time when converting it for iPaaS.com. Subscribers or their MiSP should confirm in a staging environment that the time shown in iPaaS.com matches the time the message was sent before relying on it in production.

Text — Field

Source: SUBJ · Destination: Text

This is a required field. The message subject as written in Counterpoint, carried across unchanged as the iPaaS.com message text. Counterpoint stores a subject as text of up to 50 characters, so the text is never longer than that.

Details — Field

Source: MSG_TXT · Destination: Details

This is a required field. The body of the message as written in Counterpoint, carried across in full as the iPaaS.com message details. Counterpoint keeps the body as plain text with no length limit.

Error Handling

Errors raised while transferring these records surface at Dashboard / Integration Monitoring / Error Logs. The specific messages, their causes and their resolutions are documented in NCR Counterpoint Error Messages. A record stopped by an error is requeued and retried automatically, but each retry fails the same way until the cause is corrected. Correct the cause, then transfer the record again through Manual Sync rather than waiting for the next retry.

Testing & Validation

  1. Confirm the iPaaS.com message custom field IsPopup exists, or remove the IsPopup mapping.

  2. Send a message in Counterpoint, then transfer it through Manual Sync by its message id and confirm it appears in iPaaS.com with its subject, body and send time.

  3. Send a high-importance message and confirm it arrives as a Warning.

  4. Install the optional Messages feature in a staging Counterpoint database, enable message/created and message/updated in Inbound Data Flows, and confirm a newly sent message transfers on its own.

  5. Transfer the same message a second time and confirm it updates the existing iPaaS.com message rather than adding another.

Additional Notes

  • Messages do not transfer on their own until the Messages feature is installed: at the time this documentation was written, the message trigger events and database trigger are not created by the standard installer. Until the Counterpoint-side step has been carried out and the subscriptions enabled, a message sent in NCR Counterpoint does not appear in iPaaS.com until a Manual Sync is run for it.

These and other runtime behaviors are documented in NCR Counterpoint Known Limitations.


Related Documents

Did this answer your question?