Zwing Docs

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)

FieldTypeMeaning
namestringDisplay name.
descriptionstringOptional description.
isEnabledbooleanWhether the app is active.
inboundEnabled / outboundEnabledbooleanFeature flags for ingress vs published traffic.
accessTypepublic | privateTenant visibility model (AppAccessEnum).
logoSrcstringOptional logo URL.
enrichmentbooleanEnrichment feature flag at app level.
ssoEnterpriseIdstringOwning enterprise.
refIdstringExternal / catalog reference id.
refPublicAppIdObjectIdWhen 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).

FieldMeaning
appIdFK to app.
ssoEnterpriseIdTenant.
isEnabledMaster switch for config (used when validating connectors).
outboundAuthOptional API key style auth for outbound.
inboundAuthInbound authentication profile: baseUrl, authType (static / dynamic / no_auth), nested auth/token/request/refresh/error blocks.

Event (EventsModel)

FieldMeaning
nameHuman-readable name.
eventCodeStable code used by ingress routing.
eventCodePathJSON path to read code from payload when applicable.
directioninbound or outbound (EventsDirectionEnum).
appIdOwning app.
ssoEnterpriseIdTenant.
publishConfig / listenerConfigConfig: optional kafkaTopicName, operation, endpoint (url + auth).
refDocPathPath for reference document extraction.
refPublicEventIdLink back to public event when cloned from catalog.

Connector (ConnectorModel)

FieldMeaning
nameLabel.
outboundAppIdSource app (events emitted from here).
inboundAppIdTarget app (events consumed here).
ssoEnterpriseIdTenant.
isEnabledWhether routing is active.

Connector–event mapping (ConnectorEventMappingModel)

Central object for “when outbound event X fires on this connector, run pipeline into inbound event Y.”

FieldMeaning
connectorIdParent connector.
outboundEventIdSource event id.
inboundEventIdDestination event id.
priorityNumeric ordering when multiple mappings match (default 0).
templateTemplate body / handle (string).
templateIdERP-oriented template identifier (e.g. tpl-1).
filterOptional ERP-oriented filter string (separate from structured filters).
isEnabledToggle mapping participation.
toggleAllowedWhether operators may disable this mapping in UI (false = mandatory).
filtersStructured AND / OR lists of { key, operator, value?, priority? } for payload gating.
isSequentialWhen true, sequential processing key applies (ordering with other mappings).
sequentialKeyJSON dot path in the inbound payload for the store (or grouping) id; required when isSequential is true.
transactionDatePathJSON dot path to the business transaction date for isSequential mappings (GIP blackout and job transactionDate); required when isSequential is true. See GIP blackout window.
isRetryableWhether job-level retry is allowed.
maxRetryMax egress cron retries (0–7; omitted ⇒ default 7 at job level).
retryOnStatusCodeHTTP status allow-list for keeping a job retryable on HTTP failures.
tasksObjectId array referencing EventTask documents (the task tree).

See also Task types reference for what each referenced task does.

Event task (EventTaskModel)

FieldMeaning
name / descriptionLabels for UI and logs.
typeEventTaskTypeEnum (enrich, transform, filter, mapping, dispatch, extract, http).
parentIdParent task in tree; null for root.
connectorEventMappingIdOwning mapping.
configType-specific JSON (TaskConfigDto shape).
continueOnFailureSoft-fail behaviour for downstream steps.
Edit on GitHub