IMS Documentation

Integration Center

Integration Center is the IMS 9.4.4 administration screen for configurable outbound integrations. It combines endpoint setup, source-data preview, current health and synchronization history in one place.

Open the screenIntegration → Integration Center. The Integration menu is controlled by the Integrated Reports Group Policy permission.

Three working tabs

TabUse it for
OverviewSee Active Integrations, Success Today, Failed Today, Last Run and the latest status recorded for each configured integration.
IntegrationsCreate, clone, edit and activate endpoint definitions; preview the data returned by the configured source view.
Sync LogFilter synchronization attempts, inspect HTTP/result details and copy the response for troubleshooting.

Overview

The top counters summarize the current day and the latest integration run. The grid below shows the integration Code/Name, Data Type, Trigger, Active state, Business Date, Health/status and Last Run when those values are available.

SUCCESS is shown in green and FAILED in red. Use Refresh to reload the counters and latest status data.

Create or edit an integration

Open the Integrations tab and select an existing row, or click New. The editor is divided into General, Source, Endpoint, Schedule and Advanced Settings.

FieldBehavior
Integration CodeUnique endpoint code. For a new integration it accepts only A-Z, 0-9 and underscore. The code cannot be changed after the record is saved.
Integration NameRequired descriptive name.
Data TypeSALES, INVENTORY, TRAFFIC, INSIGHT or OTHER.
ActiveOnly active integrations are eligible for execution by the integration engine.
Source ViewDatabase view used as the integration data source. The name can contain letters, digits, underscore and dot.
Payload ModeCurrently fixed to GROUPED in the screen.
Batch SizeDisplayed by the current editor but not user-editable in IMS 9.4.4.
Endpoint URLRequired absolute HTTP or HTTPS destination URL.
HTTP MethodPOST, PUT or PATCH.
Auth TypeNONE, BEARER or HEADER.
Auth HeaderRequired when Auth Type is HEADER.
API KeyRequired for BEARER/HEADER authentication. IMS encrypts the saved key.
Trigger TypeMORNING_SHIFT or MANUAL.
Advanced SettingsRequired JSON configuration used by the integration engine to determine dates and construct the outbound payload.
Stored API keysWhen editing an existing integration, the API Key box is intentionally blank. Leave it blank to keep the encrypted key already stored. Enter a value only when the key must be replaced. Choosing Auth Type NONE clears the stored key.

Source view and Preview Source

The integration engine filters the Source View by __business_date, groups rows by __request_key, sends them to the row's __target_code target and counts distinct __record_key values as the records sent.

Use Preview Date and Preview Source before activating a new endpoint. Preview returns up to 200 rows for the selected business date in a read-only grid and uses the same source-view naming validation as the integration engine.

Required integration metadataA Source View used by this framework must provide the integration metadata columns expected by the engine: __business_date, __target_code, __request_key and __record_key, in addition to the business fields referenced by the payload JSON.

Advanced Settings JSON

New integrations start with date_offset=-1, retry_days=6 and empty payload field/group arrays. The engine also recognizes an optional start_date.

SettingMeaning in the current engine
date_offsetMoves the final Business Date relative to the trigger execution date. The new-record default of -1 targets the previous day.
retry_daysExtends the run backward by this many days so missed/failed business dates can be revisited.
start_dateOptional earliest Business Date. The retry window will not go earlier than this date.
payload.root_fieldsColumns written once at the root of the JSON object.
payload.groupsNested array definitions. Each group supplies a name and fields; an optional group_by array combines rows by the listed columns.

The Settings field must not be blank. The saved value is stored as JSON; malformed JSON is rejected when IMS saves it to the database.

Complete the payload definition before executionThe new-record template intentionally starts with empty payload.root_fields and payload.groups arrays. Before an endpoint can run successfully, define at least the payload group structure and make sure every field named in the JSON exists in the Source View. The current payload builder starts from the first configured group.

Triggers and execution

MORNING_SHIFT endpoints are selected by the background integration engine when that trigger runs. For each active endpoint, the engine calculates the Business Date window from the Advanced Settings, reads the Source View and submits one request per __request_key.

MANUAL is a supported trigger classification, but Integration Center itself does not provide a Run button in IMS 9.4.4. The screen is used to configure, preview and monitor the endpoint.

On a normal rerun, a request key that already has a successful log entry for the same integration and Business Date is skipped, preventing the same successful request from being resent by the standard engine path.

Clone an endpoint

Select an integration and click Clone. IMS prepares a new record using the current configuration, proposes _COPY on the Integration Code and Copy on the name. If the source endpoint has an encrypted API key, the clone keeps that key unless you type a replacement.

Sync Log

The Sync Log initially covers the last seven days. Filter by Integration, Status (SUCCESS/FAILED), Target and date range, then click Refresh. Clear Filters restores the seven-day window and all-status/all-integration view. The current log query returns the newest 2,000 matching rows at most.

Grid valueWhat it tells you
Date / Integration / TargetBusiness Date, endpoint code and destination/target identifier for the request.
Status / AttemptFinal result and attempt sequence for that request key.
Records / Source RowsDistinct record count sent and total source rows used to build the request.
HTTPHTTP status code returned by the endpoint when available.
Started / CompletedExecution timing recorded by the integration engine.

Select a log row to see its Request Key, Sync Type, Started/Completed times, Response Message and Result Data. Result Data is formatted as JSON when possible. Copy Response copies Result Data first; if it is empty, IMS copies the Response Message instead.

Troubleshooting sequenceStart with Overview → open the failed row in Sync Log → check HTTP status and Response Message/Result Data → use Preview Source for the same Business Date → confirm endpoint authentication only if the source data is correct.