XML configuration

All IM configuration can be imported or exported in XML, either through the UI or through API. This page describes the general principles governing this XML representation, and conventions used throughout this Technical documentation.

Access control

In addition to the standard CRUD Rights required to manipulate entities, additional sys.<service trigram>-conf-import and sys.<service trigram>-conf-export rights are required to import and and export configuration for each service (e.g. sys.idm-conf-import and sys.idm-conf-import for IDM).

UI Import and Export

Global Configuration Import and Export

XML configuration can be imported for each service through the Admin Portal by clicking on "System" → "Configurations" and perform an import/export.

For each service, the Import tab provides a link to download the relevant XML schemata. They can be imported in most XML-capable text editors to enable validation and completion.

Single-type Import And Export

In the Admin Portal, each Configuration list (e.g. Attributes, Identity Types,…) provides the ability to Export select Configurations and Import configurations of the correct type.

API Import and Export

The API provides the same capabilities as the UI. Please refer to the Developer Documentation.

Namespaces

IM configuration uses many namespaces. The table below lists all used namespaces, their use and their Canonical Prefixes.

For the sake of brevity, throughout this Technical Configuration guide, namespaces will be referenced using their Canonical Prefixes, and XML namespace prefix declarations will always be omitted.

Canonical Prefix	Namespace	Usage
`xs`	`http://www.w3.org/2001/XMLSchema`	Schema for XML schemata. Provides the base types such as `xs:string`.
`xsi`	`http://www.w3.org/2001/XMLSchema-instance`	Provides the `xsi:type` attribute used to specify a specific type for an element.
`kit`	`http://www.memority.com/toolkit/1_0`	Provides the `kit:Dataset` root element (see below)
`rule`	`http://www.memority.com/toolkit/rule/1_0`	Builtin and Groovy Rules
`search`	`http://www.memority.com/toolkit/search-expression/1_0`	Search Expressions
`security`	`http://www.memority.com/toolkit/security/1_0`	Security configuration, Such as Authentication Levels
`settings`	`http://www.memority.com/toolkit/addons/settings/1_0`	Settings configuration
`ctdcore`	`http://www.memority.com/citadel/core/1_0`	Abstract base types.
`ctd`	`http://www.memority.com/citadel/1_0"`	Entities shared across all services
`ctdtnt`	`http://www.memority.com/citadel/tnt/1_0`	Tenant configuration
`ctdbum`	`http://www.memority.com/citadel/bum/1_0`	Business Management (BUM) configuration (Features,…)
`bpmn`	`http://www.omg.org/spec/BPMN/20100524/MODEL`	Workflows: BPMN namespace
`activiti`	`http://activiti.org/bpmn`	Workflows: Activiti BPMN extensions
`ctdbpmn`	`http://www.memority.com/citadel/bpmn/1_0`	Workflows: IM BPMN extensions
`i18n`	`http://www.memority.com/toolkit/addons/i18n/1_0`	Internationalization configuration
`ctdidm`	`http://www.memority.com/citadel/idm/1_0`	Identity Management (IDM) configuration (Data model,…)
`notify`	`http://www.memority.com/toolkit/addons/notify/1_0`	Notifications (NTF) configuration
`ctdrep`	`http://www.memority.com/citadel/rep/1_0`	Reporting (REP) configuration

The `kit:DataSet` root element

This is the root element of all Import/Export XML files:

XML

<kit:DataSet tenant="..." env="..." stack="...">
    <!-- Entities to import -->
</kit:DataSet>

In order to prevent human errors, it sports three attributes (tenant, env and stack) describing the intended target import environment. Those are checked at import and the file will be rejected if there is a mismatch.

The tenant, env and stack will be obtained at tenant creation.