Skip to main content

NCR Counterpoint to iPaaS.com Ecommerce Category Mapping Documentation

Field-level mapping documentation for the NCR Counterpoint Ecommerce Category collections.

Summary

This mapping collection brings the ecommerce categories maintained in NCR Counterpoint into iPaaS.com. It carries the category's display description as its name, its long-form HTML description, its place in the category hierarchy, and the display sequence number that controls the order categories are presented in.

ID Format

  • Manual Sync id: the Counterpoint ecommerce category id — this collection reads inbound from Counterpoint, so the id entered on the Manual Sync page is the category's Counterpoint-side identifier, not an iPaaS.com value.

  • External ID saved after transfer: once a category has been transferred, iPaaS.com records the Counterpoint ecommerce category id as the external ID on a dedicated platform-managed external-ID record. That record — not any field on the category record itself — is the primary match that routes a subsequent transfer of the same category to an update rather than adding it a second time. It is also what the hierarchy lookup resolves against when a child category needs to find its parent.

Deleted Record Support

This family does not itself carry deletions. Where a separate Delete collection exists for this entity it handles removals from Counterpoint to iPaaS.com; otherwise a removal in Counterpoint is not propagated. See NCR Counterpoint Known Limitations.

Mapping Collection Status

  • Status: Enabled. A mapping filter is applied, which narrows which categories transfer.

  • Trigger Events: see Transfer Methods in the collection description; automatic transfers require the relevant Outbound/Inbound Data Flow subscriptions to be enabled.

System Caveats

NCR Counterpoint Caveats

  • A category saved without a description cannot transfer: Counterpoint holds the display description as text of up to 25 characters and permits it to be empty. Because Name reads that description and is required, a category saved with no description produces an empty name and iPaaS.com rejects the record. Subscribers or their MiSP who find categories failing to transfer should check that every category carries a description in Counterpoint, or replace this mapping with a formula that falls back to another populated value when the description is blank.

  • The long-form description is passed through as-is: whatever markup Counterpoint holds is what iPaaS.com stores, without conversion. Subscribers whose destination system renders this text should confirm it handles the markup Counterpoint produces.

  • The display sequence number may be empty: Counterpoint holds it as a whole number and permits it to be empty. Categories saved without one transfer with that value empty and iPaaS.com accepts them — ordering is then left to whatever the destination system applies by default.

Integration Flow

  1. No records are transferred as prerequisites for this collection. The records it references are expected to exist already.

  2. The record is sent to iPaaS.com, where subsequent transfers are routed by the external ID recorded on transfer.

Mappings

Add/Update NCR Counterpoint Ecommerce Category TO iPaaS.com

Mapping Filter

!(CATEG_ID  ==  "0")

Filter Description.

The filter excludes the single category whose id is 0. NCR Counterpoint uses that id for its own uncategorized placeholder rather than for a real merchandising category, so it is held back and never reaches iPaaS.com. Every other ecommerce category transfers. Subscribers who want the uncategorized placeholder represented in iPaaS.com should review this filter before enabling the collection.

Mapping Type

Source Field (NCR Counterpoint)

Destination Field (iPaaS.com)

Description

Field

DESCR

Name

Required. IPaaS.com rejects the category without it.

Field

HTML_DESCR

Description

Optional. .

Dynamic Formula

return await GetSpaceportIdAsync(PARENT_ID, "Product Category", SpaceportSystemId);

ParentId

Optional. .

Name — Field

Source: DESCR · Destination: Name

This is a required field — iPaaS.com rejects the category without it. The category's display description as maintained in NCR Counterpoint, carried across unchanged and used as the category name in iPaaS.com.

Counterpoint stores this as text of up to 25 characters and permits it to be empty. That combination matters here: a category saved in Counterpoint with no description produces an empty name, and iPaaS.com rejects the record because the field is required. Subscribers or their MiSP who find categories failing to transfer should check that every category carries a description in Counterpoint, or replace this mapping with a formula that falls back to another populated value when the description is blank.

Description — Field

Source: HTML_DESCR · Destination: Description

This is an optional field. The long-form HTML description maintained against the category in NCR Counterpoint, carried across as-is. Categories saved without one transfer with this field empty, and the transfer succeeds either way.

The value is passed through without conversion, so whatever markup Counterpoint holds is what iPaaS.com stores. Subscribers whose destination system renders this text should confirm it handles the markup Counterpoint produces.

ParentId — Dynamic Formula

Source: return await GetSpaceportIdAsync(PARENT_ID, "Product Category", SpaceportSystemId); · Destination: ParentId

This is an optional field. Rebuilds the category hierarchy inside iPaaS.com. The formula takes the parent category id recorded against this category in NCR Counterpoint and looks up the matching category that has already been transferred into iPaaS.com, returning that category's iPaaS.com id.

When the parent has not been transferred yet — or the category is a top-level one with no parent in Counterpoint — the mapping resolves to empty and the category transfers as a top-level category. The transfer is not rejected.

This lookup does not pull the parent category across on its own. A child category whose parent has not yet transferred therefore lands at the top level rather than under its parent, and nothing is reported to say so. Subscribers or their MiSP who need the hierarchy intact should re-run the affected categories once the full set has transferred; the subsequent update resolves the parent and moves the category into place. Where a hierarchy is being loaded for the first time, transferring parents before their children avoids the situation entirely.

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 not retried automatically; it must be resolved manually.

Testing & Validation

  1. Replace every placeholder value called out above with one from the target Counterpoint installation, and confirm each exists in Counterpoint.

  2. Transfer a single record through Manual Sync and confirm it appears in Counterpoint as expected.

  3. Confirm any child records transferred with the parent.

  4. Enable the relevant triggers and confirm a new record transfers automatically, and that a change updates the same Counterpoint record rather than creating a second one.

  5. Attempt a transfer with a missing required field and confirm the expected error appears at Dashboard / Integration Monitoring / Error Logs.

Additional Notes

At the time this documentation was written, a category whose parent has not yet transferred lands at the top level rather than under its parent, and nothing is reported to say so. The hierarchy lookup resolves the parent among the categories already in iPaaS.com; where the parent is absent — or where the category is a top-level one with no parent in Counterpoint — the value resolves to empty and the category transfers as a top-level category rather than being rejected. This lookup does not pull the parent category across on its own. Subscribers or their MiSP who need the hierarchy intact should re-run the affected categories once the full set has transferred; the subsequent update resolves the parent and moves the category into place. Where a hierarchy is being loaded for the first time, transferring parents before their children avoids the situation entirely.

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


Related Documents

Did this answer your question?