Configuration

5 min

Qu'allez-vous trouver ici ?

Comment configurer la librairie OIP Core ?

Quels sont les différents éléments configurables dans l'OIP Core ?

Comment lancer l'OIP Core ?

Configuration de base

Vous devez créer un fichier oip.config.mjs à la racine de votre projet.

/** @type {import('@fasstech/oip-core').ExternalConfig} */
export default {
  debug: true,
  database: {
    url: process.env.OIP_MONGO_DB_URL
  },
  rabbitMQ: {
    name: 'fasst-oip-core'
  },
  views: {
    config: 'viewsConfig',
    viewIds,
    actionIds
  },
  pubsub,
  entities: {
    CustomEntity: {
      entity: customEntity,
      actions: {
        loadHandler: CustomEntity_loadHandler,
        saveHandler: CustomEntity_saveHandler
      }
    }
  }
};

Name		Type	Required	Description
debug		Boolean	false
database		Object	true
	url	String	-
rabbitMQ		Object	false
views		Object	true
	config	String	-
	viewIds	Object	-
	actionIds	Object	-
pubsub		class PubSub	false	Propriété qui permet d'utiliser les subscscription graphql
entities		Object	false	Liste des entités custom
entities [NOM-ENTITE]		String	true	Nom de l'entité custom qui sera utilisé pour la récupération de celle ci
	entity	Object	true	La fonction de l'entité custom lié à cette entité
	actions	Object	true	Les actions liées à l'entité
	actions.loadHandler	Object	true	action qui permet de charger les données liés à l'entité
	actions.saveHandler	Object	true	Actions qui permet d'intégrer les données dans l'entité parent

Lancer L'OIP-Core

Pour lancer L'OIP, il faut appeler la fonction start de l'OIP au lancement de l'application.

import OIP from '@fasstech/oip-core';

export default application = async () => {
    const app = express();
    const server = http.createServer(app);
    [...]
    // Votre configuration de l'OIP est prise en compte
    // Démarrage de l'OIP
    OIP.start();
    [...]
}

Variables d'environnement

Variables obligatoires

ROOT_DIR : répertoire racine du projet

CIPHER_IV : vecteur d'initialisation utilisé par l'algorithme de chiffrement

CIPHER_KEY : clé utilisée par l'algorithme de chiffrement

Variables non obligatoires

ENABLE_IFC_PERF : (disponibilité >= 2.11) modifie la manière dont sont gérées les entités Employee et SeverancePayHypothesisResult.

La variable d'environnement ENABLE_IFC_PERF doit être utilisée avec précaution. Une fois activée, l'appel à la fonction save sur les entités Employee et SeverancePayHypothesisResult va écrire directement en base de données.