Editing CIMcloud Generic Inquiries in Acumatica

Overview

CIMcloud uses Acumatica Generic Inquiries (GIs) to retrieve data from Acumatica and sync it to the CIMcloud platform. In some cases, you may want to change an existing CIMcloud GI to turn on, turn off, or add a field mapping.

This article explains how to locate, back up, and edit a CIMcloud GI in Acumatica. It also explains which changes are safe to make yourself and which require CIMcloud.

Before You Begin

Before changing any CIMcloud GI, confirm the following:

• You have read this entire article.
• The change is one of the lower-risk changes listed below. If it is not, contact CIMcloud before making it.
• You will create a -CORE backup copy first.
• You understand that CIMcloud support for issues caused by the change is billable, as described in the warning above.

If you are unsure whether a change is safe, submit a support ticket before making it. Reviewing a planned change costs much less than repairing a broken sync.

Lower-Risk vs. High-Risk Changes

Lower-risk changes (covered by this article):

• Turning an existing mapping off by unchecking Active in the Results Grid.
• Adding a new mapping in the Results Grid using a table alias that already exists in the GI.

High-risk changes (contact CIMcloud first):

• Adding, removing, or renaming tables on the Tables tab.
• Adding, removing, or changing relations (joins) on the Relations tab.
• Changing conditions, parameters, grouping, or sort order.
• Changing the Caption or Data Field of an existing mapping.
• Renaming, deleting, or deactivating a CIMcloud GI.
• Editing the -CORE backup copy.

High-risk changes often break the integration without any error message.

Locate the Generic Inquiry

• Identify the GI that needs to change.
• In Acumatica, search for CIMcloud- in the search bar. This lists the GIs installed by CIMcloud.
• Open the GI.

Create a Backup Copy of the Generic Inquiry

Before making any changes, create a backup copy of the standard CIMcloud GI.

• Follow Acumatica’s instructions for copying a GI: Copying a Predefined Inquiry.
• Name the copy by adding -CORE to the end of the original name.
  • Original: CIMcloud-Products
  • Backup: CIMcloud-Products-CORE
• Save the backup.

Important: Make your changes in the original CIMcloud- GI, not in the -CORE copy. The CIMcloud integration reads from the original. Editing the original means you do not need any configuration changes in CIMcloud.

Do not edit or delete the -CORE copy. CIMcloud uses it as the reference for the standard configuration when finding or undoing changes. Without it, discovery takes longer and costs more.

Record a Baseline

Before editing, click View Inquiry on the original GI and record:

• The total number of rows returned.
• A few sample records you can check again after the change, such as a specific item, price, or customer.

Open the Generic Inquiry for Editing

• With the GI open, click Customization in the upper-right corner.
• Select Edit Generic Inquiry.

Access the Results Grid

• Select the Results Grid tab.
• The Results Grid contains the field mappings CIMcloud uses during sync.

Disable an Existing Mapping

If a field should no longer sync:

• Find the mapping in the Results Grid.
• Uncheck Active for that row.
• Save the GI.

The mapping is left out of future syncs.

Add a New Mapping

To sync an additional field to CIMcloud:

• In the Results Grid, click + to add a row.
• Set Object to the existing table alias that contains the field. Review the Tables and Relations tabs to see which aliases are available, but do not change them.
• Set Data Field to the Acumatica field you want to sync.
• Set Caption to the CIMcloud field that will receive the data.
• Click Save.

Verify the Change

• Click View Inquiry.
• Confirm the new or removed field appears as expected.
• Compare the total row count and your sample records to the baseline.

The row count should not change when you only add or turn off a mapping. If the row count changed, or sample records show different values, undo your change and submit a support ticket before data syncs to the website.

Mapping Best Practices

• Use only existing table aliases.
• Make sure the Caption exactly matches the CIMcloud field being mapped.
• Make one change at a time, and verify each before making the next.
• Keep a record of what you changed and when.

Sync Behavior

Changes to a CIMcloud GI take effect immediately. The next sync from Acumatica uses the updated mappings.

Refreshing Previously Synced Data

Changing a GI does not automatically refresh data that has already synced to the CIMcloud website.

If previously synced records need to be refreshed, submit a support ticket with the name of the GI you changed. CIMcloud Support will determine whether a data refresh is needed and the next steps.

Reporting a Problem After a Change

If website data is missing or incorrect after a GI change, submit a support ticket that includes:

• The name of each GI you changed.
• What you changed (tables, relations, conditions, or mappings added, removed, or edited).
• When you made the change.
• What result you expected, and what you see instead.
• Confirmation that the -CORE backup still exists and has not been edited.

Complete details shorten billable discovery. Do not try further fixes to the GI while CIMcloud is investigating.