Data model reference
Core Mongo fields for apps, events, connectors, and connector–event mappings in GIP
All schemas below live under @libs/dip-v2 (src/models/). Soft-delete and audit fields from the shared base model apply unless noted. For HTTP create/update payloads, prefer ACS DTOs in apps/app-connector-service/src/dto/.
App (AppModel)
| Field | Type | Meaning |
|---|---|---|
name | string | Display name. |
description | string | Optional description. |
isEnabled | boolean | Whether the app is active. |
inboundEnabled / outboundEnabled | boolean | Feature flags for ingress vs published traffic. |
accessType | public | private | Tenant visibility model (AppAccessEnum). |
logoSrc | string | Optional logo URL. |
enrichment | boolean | Enrichment feature flag at app level. |
ssoEnterpriseId | string | Owning enterprise. |
refId | string | External / catalog reference id. |
refPublicAppId | ObjectId | When set, this app was created from the given public app. |
Virtual: appConfig resolves to AppConfigurationModel by appId.
App configuration (AppConfigurationModel)
One row per app per enterprise (unique index on appId + ssoEnterpriseId).
| Field | Meaning |
|---|---|
appId | FK to app. |
ssoEnterpriseId | Tenant. |
isEnabled | Master switch for config (used when validating connectors). |
outboundAuth | Optional API key style auth for outbound. |
inboundAuth | Inbound authentication profile: baseUrl, authType (static / dynamic / no_auth), nested auth/token/request/refresh/error blocks. |
Event (EventsModel)
| Field | Meaning |
|---|---|
name | Human-readable name. |
eventCode | Stable code used by ingress routing. |
eventCodePath | JSON path to read code from payload when applicable. |
direction | inbound or outbound (EventsDirectionEnum). |
appId | Owning app. |
ssoEnterpriseId | Tenant. |
publishConfig / listenerConfig | Config: optional kafkaTopicName, operation, endpoint (url + auth). |
refDocPath | Path for reference document extraction. |
refPublicEventId | Link back to public event when cloned from catalog. |
Connector (ConnectorModel)
| Field | Meaning |
|---|---|
name | Label. |
outboundAppId | Source app (events emitted from here). |
inboundAppId | Target app (events consumed here). |
ssoEnterpriseId | Tenant. |
isEnabled | Whether routing is active. |
Connector–event mapping (ConnectorEventMappingModel)
Central object for “when outbound event X fires on this connector, run pipeline into inbound event Y.”
| Field | Meaning |
|---|---|
connectorId | Parent connector. |
outboundEventId | Source event id. |
inboundEventId | Destination event id. |
priority | Numeric ordering when multiple mappings match (default 0). |
template | Template body / handle (string). |
templateId | ERP-oriented template identifier (e.g. tpl-1). |
filter | Optional ERP-oriented filter string (separate from structured filters). |
isEnabled | Toggle mapping participation. |
toggleAllowed | Whether operators may disable this mapping in UI (false = mandatory). |
filters | Structured AND / OR lists of { key, operator, value?, priority? } for payload gating. |
isSequential | When true, sequential processing key applies (ordering with other mappings). |
sequentialKey | JSON dot path in the inbound payload for the store (or grouping) id; required when isSequential is true. |
transactionDatePath | JSON dot path to the business transaction date for isSequential mappings (GIP blackout and job transactionDate); required when isSequential is true. See GIP blackout window. |
isRetryable | Whether job-level retry is allowed. |
maxRetry | Max egress cron retries (0–7; omitted ⇒ default 7 at job level). |
retryOnStatusCode | HTTP status allow-list for keeping a job retryable on HTTP failures. |
tasks | ObjectId array referencing EventTask documents (the task tree). |
See also Task types reference for what each referenced task does.
Event task (EventTaskModel)
| Field | Meaning |
|---|---|
name / description | Labels for UI and logs. |
type | EventTaskTypeEnum (enrich, transform, filter, mapping, dispatch, extract, http). |
parentId | Parent task in tree; null for root. |
connectorEventMappingId | Owning mapping. |
config | Type-specific JSON (TaskConfigDto shape). |
continueOnFailure | Soft-fail behaviour for downstream steps. |
Related
- Public apps and default connectors — how defaults seed these collections.
- Task tree —
parentIdrules.