invantive documentation
Forums d'Invantive SupportConnectez-vous/inscrivez-vous

Settings.xml

[!warning] Obsolète à partir de la version 28.0 Cette rubrique décrit le format XML du fichier de paramètres et la transition vers le format JSON. La prise en charge du format XML prend fin avec la version 28.0 d'Invantive UniversalSQL, prévue vers le début de 2028. Cette rubrique et tout son contenu peuvent alors être supprimés ; Settings décrit le format qui subsiste.

Jusqu'à la version 26.0 incluse, les bases de données virtuelles étaient définies à l'aide du fichier settings.xml et d'autres fichiers correspondant au motif settings*.xml. À partir de la version 27.0, Invantive UniversalSQL lit à la place les définitions de bases de données depuis settings*.json, comme décrit dans Settings. Les fichiers XML existants sont migrés automatiquement.

Les concepts sont inchangés : le chemin de recherche, la fusion de plusieurs fichiers et la signification des groupes de bases de données, des bases de données et des conteneurs de données sont les mêmes dans les deux formats. Seule la notation diffère.

Pourquoi le format a changé

Le format XML date de 2009 et présente deux problèmes que résout un changement de format.

  • Outils : la lecture ou la génération d'un fichier de paramètres nécessite XPath et/ou XSLT. La plupart des langages analysent le JSON sans bibliothèques supplémentaires. La génération d'un fichier de paramètres par client ou par environnement devient un exercice de modèles de texte plutôt qu'un exercice XML.
  • Éléments obsolètes : le format XML conserve beaucoup d'historique sur les concepts de connectivité aux bases de données. De nombreux éléments ne sont plus pris en charge ou ne sont plus pertinents. Le format JSON utilise les concepts actuels, de sorte que ce que vous lisez correspond à la signification du terme.

Format utilisé

Release Behaviour
26.0 et antérieures settings*.xml est utilisé ; un fichier settings*.json est ignoré.
26.1 (BÊTA de 27.0) settings*.json est utilisé ; un settings*.xml portant le même nom est ignoré et sert à créer la variante JSON.
27.0 settings*.json est utilisé ; un settings*.xml portant le même nom est ignoré et sert à créer la variante JSON.
28.0 settings*.json est utilisé ; le format XML n'est plus pris en charge ni utilisé pour créer la variante JSON.

La version 26.1 est la BÊTA de la version 27.0 et se comporte de manière identique à celle-ci : dans la numérotation des versions d'Invantive, un deuxième nombre pair désigne une version de production et un deuxième nombre impair désigne la BÊTA de la prochaine version de production. La version 27.0 est donc la première version de production lisant settings*.json.

La priorité s'applique par nom de fichier. Un settings-acme.json remplace settings-acme.xml, tandis qu'un settings-other.xml sans équivalent JSON est toujours lu et migré.

Migration

Des efforts ont été faits pour rendre la migration aussi simple que possible.

La première fois qu'un produit de la version 27.0 lit un fichier settings*.xml pour lequel il n'existe aucun fichier .json portant le même nom, il crée à côté de lui ce fichier JSON fonctionnellement identique. Le fichier XML reste inchangé. Les propriétés obsolètes sont ignorées.

Les fichiers produits par la découverte automatique (settings-discovery*.xml) ne sont jamais migrés, car ils sont associés à une version majeure spécifique.

Seul le fichier de découverte de la version en cours d'exécution, settings-discovery-<version>.json dans le dossier des bases de données, est lu. Tout fichier de découverte au format XML, settings-discovery*.xml quelle que soit sa version, ainsi que tout settings-discovery-<version>.json d'une autre version, est ignoré : chaque version écrit le sien, et un fichier plus ancien répertorierait une seconde fois les mêmes bases sous d'anciens noms. Tous les autres fichiers settings*.xml et settings*.json sont lus.

Après la migration, modifiez le fichier JSON. Les modifications apportées au fichier XML ne prennent plus effet à partir de la version 26.1.

Un fichier migré contient un membre migration enregistrant le fichier dont il est dérivé, par qui, sur quelle machine, quand et avec quelle version du produit. Ce membre est absent d'un fichier de paramètres écrit à la main ; sa présence permet donc d'identifier un fichier migré :

{ "migration":
  { "sourceFileNamePath": "C:\\Users\\john.doe\\invantive\\settings.xml"
  , "migratedBy": "ACME\\john.doe"
  , "migratedOn": "WS0001"
  , "migrationDate": "2026-08-05T08:15:00.4608219Z"
  , "migratedUsing": "27.0.1.1234"
  }
}

Suppression des fichiers XML

Lorsqu'un environnement n'utilise que la version 27.0 ou une version plus récente, tous les fichiers settings*.xml peuvent être supprimés en toute sécurité une fois le fichier au format JSON créé. Conservez un fichier XML seulement tant qu'un produit de la version 26.0 ou antérieure lit le même dossier, en gardant à l'esprit qu'un tel produit ignore toute modification apportée au fichier JSON.

Différences de notation

Les deux formats décrivent exactement les mêmes bases de données. Les différences sont :

  • <connection> est désigné par database (singulier) ou databases (pluriel).
  • <database> est désigné par dataContainer (singulier) ou dataContainers (pluriel).
  • Les éléments <database> et <credentials> partagent un même tableau dataContainers, dans lequel le membre kind indique lequel des deux est un conteneur de données, à l'aide de la valeur dataContainer ou credentials.
  • Les éléments répétés deviennent des tableaux avec un nom au pluriel : <group> devient groups, <provider> devient providers, <attribute> devient attributes et <failover> devient failovers.
  • Les noms des membres sont systématiquement camelCase, donc PasswordLabel en XML correspond à passwordLabel en JSON.

Structure

Les fichiers de paramètres ont la structure suivante au format XML ; la spécification complète est disponible dans invantive-databases.xsd en pièce jointe.

classDiagram
direction TB

class settings:::classDiagram {
  +VersionUpdatedBy: string
  +VersionUpdatedOn: string
  +VersionUpdateDate: dateTime
  +version: string
  +default: string
}

class group:::classDiagram {
  +name: string
  +comment: string
  +shortDescription: string
  +description: string
  +id: string
  +sortingOrder: int
  +createdBy: string
  +createdOn: string
  +creationDate: dateTime
  +iconResourceName16: string
  +iconResourceName32: string
}

class connection:::classDiagram {
  +name: string
  +id: string
  +description: string
  +shortDescription: string
  +comment: string
  +sqlTrace: boolean = false
  +starred: boolean = false
  +sortingOrder: int
  +authentication: AuthenticationModeType
  +IconResourceName16: string
  +manual: boolean = false
  +createdBy: string
  +createdOn: string
  +creationDate: dateTime
  +lastUsedDate: dateTime
  +forceNative: boolean = false
  +dataCacheConnectionString: string
  +iuidSource: string
  +dataDictionaryConnectionString: string
}

class provider:::classDiagram {
  +createdBy: string
  +createdOn: string
  +creationDate: dateTime
  +comment: string
  +order: int
  +file: string
  +class: string
}

class attribute:::classDiagram {
  +code: string
  +value: string
}

class credentials:::classDiagram {
  +database: string
  +server: string
  +datacontainers: string
  +order: int
  +createdBy: string
  +createdOn: string
  +creationDate: dateTime
  +description: string
  +comment: string
  +defaultUserLogonCode: string
  +userLogonCodeMode: EditabilityType
  +defaultPassword: string
  +PasswordLabel: string
  +PasswordHint: string
  +UserLogonCodeLabel: string
  +UserLogonCodeHint: string
  +passwordMode: EditabilityType
}

class database:::classDiagram {
  +connectionString: string
  +AllowConnectionStringRewrite: boolean = true
  +AllowConnectionPooling: boolean = true
  +order: int
  +createdBy: string
  +createdOn: string
  +creationDate: dateTime
  +description: string
  +comment: string
  +alias: string
  +provider: string
  +defaultUserLogonCode: string
  +userLogonCodeMode: EditabilityType
  +defaultPassword: string
  +PasswordLabel: string
  +PasswordHint: string
  +UserLogonCodeLabel: string
  +UserLogonCodeHint: string
  +passwordMode: EditabilityType
}

settings "1" *-- "0..*" group : group
group "1" *-- "0..*" connection : connection

connection "1" *-- "0..*" provider : provider
provider "1" *-- "0..*" attribute : attribute

connection "1" *-- "0..*" database : database

connection "1" *-- "0..*" credentials : credentials

Une base de données se compose d'un ou plusieurs conteneurs de données. Les conteneurs de données peuvent être définis à l'aide de :

Avec EditabilityType étant l'un des éléments suivants :

  • Auto,
  • ReadOnly,
  • Hidden,

Avec AuthenticationModeType, l'un des éléments suivants :

  • Default,
  • Database,
  • Application.

Les éléments suivants ont été exclus de la structure car ils sont obsolètes, mais les fichiers XML qui les contiennent seront toujours acceptés :

  • type de nœud de basculement,
  • conteneurs de données des services web Invantive,
  • attributes on connection: encryptedDataCacheConnectionString, encryptedDataDictionaryConnectionString, PasswordLabel, PasswordHint, UserLogonCodeLabel, UserLogonCodeHint, passwordMode, userLogonCodeMode, defaultUserLogonCode, defaultPassword, enableRequestLogging,
  • attribut sur database : encryptedConnectionString,
  • attribut sur settings : sqlTrace, enableRequestLogging, forcedefault.

Exemples

La définition de base de données suivante fournit une base PostgreSQL, les API cloud du Parlement néerlandais ainsi que les conteneurs de données Exact Online et Salesforce d'une base de données gérée Invantive Cloud. La même définition au format JSON est affichée dans Settings.

<?xml version="1.0" encoding="utf-8"?>
<settings 
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
 version="5"
>
  <group 
   name="ACME" 
   sortingOrder="0"
   shortDescription="ACME"
  >
    <connection 
     name="ACME" 
     sortingOrder="10"
     authentication="Database"
    >
      <database
       order="10"
       alias="db"
       provider="PostgreSql"
       userLogonCodeMode="Hidden"
       passwordMode="Hidden"
       connectionString="Server=host.acme.eu;Database=xxacme;User Id=xxacme_user;Password=secret;CommandTimeout=3600"
       AllowConnectionStringRewrite="false"
      />
      <database
        order="20"
        alias="twk"
        provider="TweedeKamerNl"
        AllowConnectionPooling="false" />
      <credentials
       order="30"
       description="Exact Online and Salesforce database"
       database="acme-exact-online-salesforce"
       datacontainers="*"
       userLogonCodeMode="Hidden"
       passwordMode="Hidden"
       defaultUserLogonCode="john.doe@acme.eu"
       defaultPassword="secret"
      />        
    </connection>
  </group>
</settings>