Configuration
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.