Annexes

Dépendances et compatibilité des versions

Version de PHP et MySQL

Voici un tableau qui récapitule, pour chaque version du logiciel, les différentes versions de PHP et MySQL (ou MariaDB) qui sont officiellement supportées et testées.

Toute utilisation d'une version inférieure de PHP ne fonctionnera pas, c'est certain.
Les versions de PHP supérieures à celles indiquées fonctionnent sûrement sans problème la plupart du temps, mais n'ont pas encore été testées et ne sont donc pas supportées officiellement.

Version de Loxya PHP (versions testées) MySQL MariaDB
0.16.x (nov. 2021) 7.3 >= 5.7.9 >= 10.2.7
0.17.x (janv. 2022) 7.3 >= 5.7.9 >= 10.2.7
0.18.x (mars 2022) 7.4 >= 5.7.9 >= 10.2.7
0.19.x (juil. 2022) 7.4 >= 5.7.9 >= 10.2.7
0.20.x (mars 2023) 8.0 ou 8.1 >= 5.7.9 >= 10.2.7
0.21.x (mai 2023) 8.0 ou 8.1 >= 5.7.9 >= 10.2.7
0.22.x (août 2023) 8.0 ou 8.1 >= 5.7.9 >= 10.2.7
0.23.x (nov. 2023) 8.0 ou 8.1 >= 5.7.9 >= 10.2.7
0.24.x (mai 2024) 8.1, 8.2 ou 8.3 >= 5.7.9 >= 10.2.7

Notes :

  • Le numéro de la version du logiciel installé se trouve dans le fichier src/VERSION.
  • L'information de la (les) version(s) de PHP officiellement supportée(s) pour la version installée est affichée dans le fichier composer.json, dans require.php-64bits.

Modules PHP requis

Les extensions PHP (modules) requis par le logiciel sont les suivants :

bcmath, curl, dom, fileinfo, gettext, iconv, intl, json, mbstring, pcre, PDO, pdo_mysql, openssl, et xml.

Ajouter un logo en en-tête des PDF

Pour ajouter le logo de votre structure en en-tête des fiches de sortie, des devis et des factures, il faut :

  1. Ajouter le fichier du logo dans le dossier src/public/img/. Ce fichier doit être une image du type JPEG ou PNG. Dans l'idéal, cette image ne devrait avoir une résolution d'au moins 400x250 pixels (notez aussi le rapport d'affichage, qui devrait rester plus large que haut).
  2. Assurez-vous que le fichier est bien accessible en lecture par l'utilisateur système du serveur web (par ex. www-data).
  3. Ensuite, dans le fichier de configuration (voir ci-dessous), insérer la clé companyData.logo avec comme valeur le nom de ce fichier.
    Pour exemple, voici un extrait du fichier de configuration modifié pour ajouter un logo votre_logo.jpg :
    },
    "companyData": {
        "name": "Votre société",
        "logo": "votre_logo.jpg",
        "street": "32, rue du matoss",
        (...)

Paramétrer l'envoi d'e-mails ( Premium)

Dans le fichier /src/App/Config/settings.json, vous pouvez ajouter une section qui permettra au logiciel d’envoyer des e-mails, grâce à la fonction mail du serveur, ou alors via un serveur SMTP, ou encore en utilisant l’API de Mailjet (service d’envoi d’e-mails). Cette section se présente ainsi :

    "email": {
        "from": {
            "email": "notifications@example.com",
            "name": "Notifications Exemple"
        },
        "driver": "mail",
        "smtp": {
            "host": "your.smtp.com",
            "port": 465,
            "username": "notifications@example.com",
            "password": "mot-de-passe-smtp",
            "security": "ssl"
        },
        "mailjet": {
            "apiKey": "Clé d’API de Mailjet",
            "apiSecretKey": "Clé secrète pour l’API de Mailjet"
        }
    },

Il faut bien sûr ne pas oublier d’utiliser la bonne valeur de driver ("mail", "smtp" ou "mailjet") selon le service choisi et renseigné.

Retrouvez le détail de chaque paramètre du fichier de configuration dans cette section.

Pour tester ces paramètres en envoyant un e-mail de test, vous pouvez utiliser la commande suivante dans un terminal, en vous plaçant dans le dossier racine du projet :

./bin/console test:email votre-adresse@exemple.com

Vous devriez ensuite recevoir un e-mail à l'adresse donnée dont le sujet est « Test de la configuration Loxya », et le corps du message « L'envoi des e-mails depuis Loxya fonctionne correctement ! ». Si ce n'est pas le cas, alors le message d'erreur affiché dans votre terminal vous donnera plus d'informations sur l'origine du problème.

Configurer les notifications ( Premium)

Une fois que l’envoi des e-mails est configuré (voir point précédent), vous pouvez activer et paramétrer les notifications elles-mêmes. Pour cela, il faut utiliser la section suivante dans le fichier /src/App/Config/settings.json :

    "notifications": {
        "overdue": {
            "enabled": true,
            "days": [1, 15, 22, 27, 30],
            "lookBackMaxMonths": 2
        },
        "preparers": {
            "enabled": true,
            "daysBefore": 1
        }
    },

Vous pouvez activer les notifications suivantes en mettant à true les paramètres enabled de :

  • overdue : Envoi d’une notification au bénéficiaire d’un événement ou d’une réservation, tant qu’il n’a pas retourné l’intégralité du matériel.
  • preparers : Envoi d’une notification au préparateur de commande assigné à un événement, quelques jours avant le début de cet événement.

Bien entendu, pour que l’envoi des notifications fonctionne, il faut paramétrer une tâche CRON (voir ci-dessous).

Retrouvez le détail de chaque paramètre du fichier de configuration dans cette section.

Tâches CRON

Certaines tâches doivent être exécutées régulièrement par le logiciel, comme par exemple l’envoi de notifications par e-mail, ou le "nettoyage" de données obsolètes.

Dans le fichier src/App/Config/CRON.json se trouve la liste des tâches à créer, avec :

  • time : La récurrence à utiliser. Par exemple, "daily" signifie une fois par jour (à vous de choisir l’heure précise).
  • command : La commande à exécuter, grâce à bin/console (en spécifiant le chemin complet). Par exemple :
    /var/www/loxya/bin/console notifications:reminders.

Choisir un scanner de code-barre ( Premium)

Les codes-barres des unités de matériel sont générés par l'application (variante Premium uniquement).

Ce sont des codes-barres 2D, au format PDF417. Voici un exemple :

Dans un éditeur de texte, en scannant ce code-barre avec votre douchette, vous devriez voir apparaître la chaîne de caractères suivante :
^#[00000000001|00000000002]#$

Si c'est le cas, alors votre douchette est correctement paramétrée 👍.
Sinon, il faudrait la configurer pour le format PDF417 et la langue qui correspond à la disposition de votre clavier.

Authentification unique (SSO) via CAS ou SAML2 ( Premium)

Vous avez la possibilité d’utiliser un système d’authentification unique via un serveur CAS, et / ou SAML2.

Pour cela, vous devez bien sûr autoriser l'instance du logiciel à accéder à votre serveur CAS ou SAML2, et le paramétrer correctement. Ensuite, vous pouvez activer la fonctionnalité en renseignant la section suivante du fichier /src/App/Config/settings.json :

    "auth": {
        "cookie": "auth",
        "CAS": {
            "enabled": true,
            "host": "your.cas.server",
            "uri": "/cas",
            "port": 8080,
            "cert": false,
            "attributes": {
                "pseudo": "givenName",
                "email": ["mail", "email"],
                "firstName": "firstName",
                "lastName": "lastName",
                "group": "group"
            },
            "groupsMapping": {
                "MonGroupeBeneficiaireCAS": "visitor"
            },
            "beneficiaryGroups": ["MonGroupeBeneficiaireCAS"],
            "defaultGroup": null,
            "nonCASUserLinking": true
        },
        "SAML2": {
            "enabled": true,
            "signRequests": false,
            "signingCert": {
                "key": "La clé du certificat de votre instance du logiciel",
                "cert": "Le certificat de votre instance du logiciel, encodé en base64"
            },
            "idp": {
                "entityId": "URL de l'Identity Provider",
                "singleSignOnServiceUrl": "URL du service de login",
                "singleLogoutServiceUrl": "URL du service de logout",
                "signingCert": "Le certificat de votre Identity Provider"
            },
            "attributes": {
                "pseudo": "givenName",
                "email": ["mail", "email"],
                "firstName": "first_name",
                "lastName": "last_name",
                "group": "group"
            },
            "beneficiaryGroups": ["MonGroupeBeneficiaireSAML2"],
            "groupsMapping": {
                "Administrateur": "admin",
                "MonGroupeBeneficiaireSAML2": "visitor"
            },
            "defaultGroup": null,
            "nonSAMLUserLinking": true,
            "disableUnsolicitedRequests": false,
            "proxyVars": false
        }
    },

Retrouvez le détail de chaque paramètre du fichier de configuration dans cette section.

Coefficient de tarif dégressif

Lors de l'étape 2 de l'assistant d'installation, une formule a été définie pour appliquer un tarif dégressif aux événements.

Par défaut, cette formule est la suivante : ((daysCount - 1) * 0.75) + 1. On peut traduire ceci par la phrase :

« Le premier jour est à plein tarif, et les jours supplémentaires sont à 3/4 du tarif »

Vous pouvez modifier cette formule en modifiant le fichier de configuration pour qu'elle corresponde à vos besoins.

Il s'agit du contenu d'une fonction PHP. Cette fonction n'accepte qu'une seule variable, daysCount qui correspond au nombre de jours d'un événement.

Vous êtes libre de composer votre formule comme vous le voulez. Si vous souhaitez ne pas appliquer de tarif dégressif, il suffit d'inscrire daysCount (ce qui veut dire que le tarif sera toujours exactement proportionnel au nombre de jours de l'événement).

Le fichier de configuration en détail

Ce fichier est créé automatiquement par l'assistant d'installation, mais en cas de modification il est bon de savoir à quoi servent ses composantes.

Important
Veillez bien à ne pas casser la structure du fichier de configuration, car cela pourrait rendre le logiciel complètement inutilisable.

Voici un exemple de contenu de ce fichier de configuration principal, expliqué ligne par ligne dans un tableau, en dessous :

{
    "baseUrl": "https://example-loxya.net",
    "enableCORS": false,
    "displayErrorDetails": false,
    "useRouterCache": true,
    "JWTSecret": "super_long_secret_string_to_never_commit",
    "httpAuthHeader": "Authorization",
    "maxItemsPerPage": 100,
    "sessionExpireHours": 12,
    "defaultLang": "fr",
    "billingMode": "partial",
    "degressiveRateFunction": "((daysCount - 1) * 0.75) + 1",
    "healthcheck": false,
    "colorSwatches": null,
    "proxy": {
        "enabled": false,
        "host": "proxy.loxya.test",
        "port": 3128
    },
    "currency": {
        "symbol": "€",
        "name": "Euro",
        "iso": "EUR",
        "symbol_intl": "€",
        "decimal_digits": 2,
        "rounding": 0
    },
    "db": {
        "driver": "mysql",
        "host": "localhost",
        "port": 3306,
        "database": "loxya",
        "username": "myuser",
        "password": "mypassword",
        "charset": "utf8mb4",
        "collation": "utf8mb4_unicode_ci",
        "prefix": ""
    },
    "companyData": {
        "name": "Votre société",
        "logo": "votre_logo.jpg",
        "street": "32, rue du matoss",
        "zipCode": "75000",
        "locality": "Paris",
        "country": "France",
        "phone": "+33 (0)1 23 45 67 89",
        "email": "contact@your-company.com",
        "vatNumber": "FR78945612300",
        "vatRate": 20,
        "legalNumbers": [
            {
                "name": "SIRET",
                "value": "123 456 789 00001"
            },
            {
                "name": "APE",
                "value": "947A"
            }
        ]
    },
    "logger": {
        "timezone": "Europe/Paris",
        "level": 100,
        "max_files": 3
    },
    "maxFileUploadSize": 26214400,
    "authorizedFileTypes": ["application/pdf", "application/zip", "text/csv", "..."],

    //////////////////////////////////////////////////
    // La suite est spécifique à la variante Premium :
    //////////////////////////////////////////////////

    "handScanner": {
        "scanTimeout": 100,
        "inputLayout": "azerty"
    },
    "colorSwatches": [
        "#f5006b",
        "#06b5a9",
        "#0004ff",
        "#f8ad14",
        "#ffe78e",
        "#9fde3f",
        "#ff0000",
        "#ff6e21",
        "#909090"
    ],
    "notifications": {
        "overdue": {
            "enabled": false,
            "days": [1, 15, 22, 27, 30],
            "lookBackMaxMonths": 2
        },
        "preparers": {
            "enabled": false,
            "daysBefore": 1
        }
    },
    "email": {
        "from": {
            "email": "noreply@example.com",
            "name": "Notification Loxya"
        },
        "driver": "mail",
        "smtp": {
            "host": "localhost",
            "port": 1025,
            "username": null,
            "password": null,
            "security": ""
        },
        "mailjet": {
            "apiKey": "mailjet-api-key",
            "apiSecretKey": "mailjet-api-secret"
        }
    },
    "auth": {
        "cookie": "auth",
        "CAS": {
            "enabled": false,
            "host": "cas.robert2.local",
            "port": 8080,
            "uri": "/cas",
            "cert": false,
            "attributes": {
                "pseudo": "givenName",
                "email": ["mail", "email"],
                "firstName": "first_name",
                "lastName": "last_name",
                "group": "group"
            },
            "beneficiaryGroups": null,
            "groupsMapping": {},
            "defaultGroup": null,
            "nonCASUserLinking": true
        },
        "SAML2": {
            "enabled": false,
            "signRequests": false,
            "signingCert": {
                "key": null,
                "cert": null
            },
            "idp": {
                "entityId": null,
                "singleSignOnServiceUrl": null,
                "singleLogoutServiceUrl": null,
                "signingCert": null
            },
            "attributes": {
                "pseudo": "givenName",
                "email": ["mail", "email"],
                "firstName": "first_name",
                "lastName": "last_name",
                "group": "group"
            },
            "beneficiaryGroups": null,
            "groupsMapping": {},
            "defaultGroup": null,
            "nonSAMLUserLinking": true,
            "disableUnsolicitedRequests": false,
            "proxyVars": false
        }
    }
}
Clé Description Type de valeur Valeur par défaut
baseUrl Adresse web (URL) de l'application string [URL actuel]
enableCORS Activer le "Cross Origin Resource Sharing" boolean false
displayErrorDetails Afficher le détail des erreurs (stack trace) boolean false
useRouterCache Utiliser le cache du router de Slim3 boolean true
JWTSecret Passphrase utilisée pour la création du JWT (Json Web Token) string [Valeur aléatoire]
httpAuthHeader Nom du header utilisé pour l'authentification des requêtes string "Authorization"
maxItemsPerPage Nombre d'enregistrements retournés par pages pour la pagination integer 100
sessionExpireHours Nombre d'heures avant expiration d'une session utilisateur.
Attention, ne pas utiliser la valeur 0, car cela risque de faire planter le login !		 integer 12
defaultLang Langue de l'interface par défaut (en étant non connecté) "fr" ou "en" "fr"
billingMode Le mode d'utilisation de la facturation. Trois valeurs possibles :
- all : facturation de tous les événements,
- partial : facturation des événements facturables uniquement,
- none : pas de facturation du tout (mode prêt)		 string "partial"
degressiveRateFunction Fonction mathématique (PHP) permettant d'appliquer un tarif dégressif.
La chaîne daysCount est remplacée par le nombre de jours de l'événement ou réservation.		 string ((daysCount - 1) * 0.75) + 1
healthcheck Détermine si la route /healthcheck est activée ou non.
Cette route permet de savoir si l'API est accessible. Elle retourne la date de dernière modification.		 boolean false
colorSwatches Liste des couleurs personnalisées, à utiliser dans le color-picker de de l'étape 1 de l'édition des événements.
Exemple : ["#f5006b", "#06b5a9", "#365576"].		 array (ou null) null
proxy Utilisation d'un proxy : un objet contenant les données du proxy object
→ proxy.enabled Activation du proxy ou non boolean false
→ proxy.host Nom d'hôte du proxy string
→ proxy.port Numéro du port du proxy number
currency Devise utilisée pour les montants : un objet décrivant la devise object
→ currency.symbol Symbole de la devise string "€"
→ currency.name Nom lisible de la devise string "Euro"
→ currency.iso Code ISO de la devise string "EUR"
db Informations de connection à la base de données MySQL object
→ db.host Le nom du serveur hôte à utiliser pour la connexion MySQL string "localhost"
→ db.username Le nom de l'utilisateur MySQL à utiliser pour la connexion à la base de données string "root"
→ db.password Le mot de passe de l'utilisateur MySQL string ""
→ db.database Le nom de la base de données string "robert2"
→ db.prefix Un préfixe éventuel à ajouter devant chaque nom de table de la base de données string ""
companyData Informations de la société pour la création des documents (devis, factures...) object
→ companyData.name Raison sociale (nom) de la société string ""
→ companyData.logo Nom du fichier (image JPG ou PNG) du logo la société, à placer dans le dossier src/public/img/ string (ou null) null
→ companyData.street Adresse postale (rue et numéro) de la société string ""
→ companyData.zipCode Code postal de la société string ""
→ companyData.locality Localité (ville ou village) de la société string ""
→ companyData.country Pays de la société string ""
→ companyData.phone Numéro de téléphone de la société string ""
→ companyData.email Adresse email de contact de la société string ""
→ companyData.vatNumber Numéro de TVA intracommunautaire de la société string ""
→ companyData.vatRate Taux de TVA applicable dans les factures number (float) 0.0
→ companyData.legalNumbers Numéros légaux supplémentaires pour affichage sur les documents (devis et factures) object
    → companyData.legalNumbers.0.name Type du premier numéro légal (nom ou acronyme) string "SIRET"
    → companyData.legalNumbers.0.value Valeur du premier numéro légal string ""
    → companyData.legalNumbers.1.name Type du second numéro légal (nom ou acronyme) string "APE"
    → companyData.legalNumbers.1.value Valeur du second numéro légal string ""
logger Paramétrage du logging (fichiers de logs du système, voir dans /src/var/logs) object
→ logger.timezone La timezone à utiliser pour l'horodatage dans les fichiers de log string "Europe/Paris"
→ logger.level Le niveau de log à utiliser (voir cette documentation.) number 250
→ logger.max_files Le nombre maximum de fichiers de log à conserver number 10

Les éléments suivants sont spécifiques à la variante Premium :

Clé Description Type de valeur Valeur par défaut
handScanner Paramétrage du scanner de code-barres object
→ handScanner.scanTimeout Le temps (en millisecondes) permettant de détecter un scan de code-barre number 100
→ handScanner.inputLayout Le type de clavier à émuler (doit être similaire à celui utilisé par les utilisateurs) string "qwerty"
notifications Paramétrage des notifications object
→ notifications.overdue Notifications en cas de non retour du matériel à temps par les bénéficiaires object
    → notifications.overdue.enabled Activation de ce type de notification boolean false
    → notifications.overdue.days Liste du nombre de jours après lesquels il faut envoyer une notification tant que le matériel n'est pas restitué. Après la dernière valeur, une notification est envoyée tous les jours. array [1,15,22,27,30]
    → notifications.overdue.lookBackMaxMonths Nombre maximum de mois pendant lesquels une notification est envoyée tous les jours après le dernier jour spécifié dans days (voir ci-dessus). number 2
→ notifications.preparers Notifications des préparateurs de commande avant un événement object
    → notifications.preparers.enabled Activation de ce type de notification boolean false
    → notifications.preparers.daysBefore Nombre de jours avant la date de l'événement pour envoyer la notification. number 1
email Paramétrage de l'envoi des e-mails object
→ email.from Nom et adresse e-mail de l'expéditeur.
Peut aussi être une simple chaîne de caractère (devant être une adresse e-mail valide).		 object (ou string) ""
    → email.from.email Adresse e-mail de l'expéditeur string
    → email.from.name Nom de l'expéditeur string
→ email.driver Type de système à utiliser pour l'envoi des e-mails. Peut être soit mail, soit smtp, soit mailjet (voir ci-dessous) string "mail"
→ email.smtp Pour une utilisation du système d'envoi smtp (voir ci-dessus) object
    → email.smtp.host Nom d'hôte du serveur SMTP à utiliser string "localhost"
    → email.smtp.port Numéro du port SMTP à utiliser number 1025
    → email.smtp.username Nom d'utilisateur pour le compte SMTP à utiliser string (ou null) null
    → email.smtp.password Mot de passe pour le compte SMTP string (ou null) null
    → email.smtp.security Type de cryptage à utiliser pour SMTP. Peut être une chaîne vide, ou tls, ou ssl string ""
→ email.mailjet Pour une utilisation de l'API de Mailjet pour envoyer les e-mails object
    → email.mailjet.apiKey Votre clé d'API fournie par Mailjet string (ou null) null
    → email.mailjet.apiSecretKey Votre clé secrète fournie par Mailjet string (ou null) null
auth Paramétrage de l'authentification object
→ auth.cookie Nom du cookie à utiliser pour le stockage de session. string "auth"
→ auth.CAS Paramétrage de l'authentification CAS. object
    → auth.CAS.enabled Pour activer l'authentification unifiée (SSO) via un serveur CAS. boolean false
    → auth.CAS.host Nom complet du serveur CAS hôte. string "cas.robert2.local"
    → auth.CAS.port Numéro du port pour accéder au serveur CAS. number 8443
    → auth.CAS.uri Chemin vers l'authentification sur le serveur CAS. string "/cas"
    → auth.CAS.cert Pour activer ou non la récupération du certificat SSL. boolean false
    → auth.CAS.attributes Paramétrage fin de la correspondance des attributs CAS pour la création des utilisateurs dans Loxya. Peuvent être soit une chaîne de caractère, soit un tableau. Si c'est un tableau, le premier attribut trouvé avec une valeur non nulle sera utilisé. object
        → auth.CAS.attributes.pseudo Les noms des attributs CAS à utiliser pour construire le pseudo de l'utilisateur. string (ou array) "givenName"
        → auth.CAS.attributes.email Les noms des attributs CAS à utiliser pour construire l'adresse email de l'utilisateur. string (ou array) ["mail", "email"]
        → auth.CAS.attributes.group Les noms des attributs CAS à utiliser pour choisir le groupe de l'utilisateur. string (ou array) "group"
        → auth.CAS.attributes.firstName Les noms des attributs CAS à utiliser pour construire le prénom de l'utilisateur. string (ou array) "first_name"
        → auth.CAS.attributes.lastName Les noms des attributs CAS à utiliser pour construire le nom de famille de l'utilisateur. string (ou array) "last_name"
    → auth.CAS.beneficiaryGroups Un (ou plusieurs) groupe(s) CAS dont la présence permettra de créer un bénéficiaire en même temps que l'utilisateur. string (ou array) (ou null) null
    → auth.CAS.groupsMapping Un tableau de correspondance entre les groupes CAS et les groupes des utilisateurs de Loxya.
Par exemple : { "Administrateur": "admin", "Etudiant": "external" }		 object {}
    → auth.CAS.defaultGroup Le groupe utilisateur de Loxya à utiliser si aucun groupe CAS n'a été trouvé dans groupsMapping (voir ci-dessus).
Si null, l'utilisateur ne sera pas autorisé à se connecter.		 string (ou null) null
    → auth.CAS.nonCASUserLinking Quand un utilisateur se connecte via CAS pour la première fois alors qu'un utilisateur existe déjà avec la même adresse e-mail, détermine si le système doit le lier à son compte CAS ou non. boolean true
→ auth.SAML2 Paramétrage de l'authentification SAML 2.0. object
    → auth.SAML2.enabled Pour activer l'authentification unifiée (SSO) en utilisant SAML 2.0. boolean false
    → auth.SAML2.signRequests Détermine si les requêtes envoyées au fournisseur d'identité (IDP) doivent être signées ou non. boolean false
    → auth.SAML2.signingCert Le certificat qui sera utilisé pour signer les requêtes et les réponses au fournisseur d'identité (IDP).
Obligatoire, même si la signature des requête est désactivée.		 object
        → auth.SAML2.signingCert.key Le contenu d'un fichier "signinCert.key" valide (généré via openssl). string null
        → auth.SAML2.signingCert.cert Le contenu d'un fichier "signinCert.crt" valide (généré via openssl). string null
    → auth.SAML2.ipd Configuration du fournisseur d'identité (IdP). object
        → auth.SAML2.ipd.entityId Identifiant (URI) du fournisseur d'identité. string null
        → auth.SAML2.ipd.singleSignOnServiceUrl L'URL de l'endpoint SSO (= Connexion) du fournisseur d'identité. string null
        → auth.SAML2.ipd.singleLogoutServiceUrl L'URL de l'endpoint SLS (= Déconnexion) du fournisseur d'identité. string null
        → auth.SAML2.ipd.signingCert Le contenu du certificat public du fournisseur d'identité. string null
    → auth.SAML2.attributes Paramétrage fin de la correspondance des attributs SAML2 pour la création des utilisateurs dans Loxya. Peuvent être soit une chaîne de caractère, soit un tableau. Si c'est un tableau, le premier attribut trouvé avec une valeur non nulle sera utilisé. object
        → auth.SAML2.attributes.pseudo Les noms des attributs SAML2 à utiliser pour construire le pseudo de l'utilisateur. string (ou array) "givenName"
        → auth.SAML2.attributes.email Les noms des attributs SAML2 à utiliser pour construire l'adresse email de l'utilisateur. string (ou array) ["mail", "email"]
        → auth.SAML2.attributes.group Les noms des attributs SAML2 à utiliser pour choisir le groupe de l'utilisateur. string (ou array) "group"
        → auth.SAML2.attributes.firstName Les noms des attributs SAML2 à utiliser pour construire le prénom de l'utilisateur. string (ou array) "first_name"
        → auth.SAML2.attributes.lastName Les noms des attributs SAML2 à utiliser pour construire le nom de famille de l'utilisateur. string (ou array) "last_name"
    → auth.SAML2.beneficiaryGroups Un (ou plusieurs) groupe(s) SAML2 dont la présence permettra de créer un bénéficiaire en même temps que l'utilisateur. string (ou array) (ou null) null
    → auth.SAML2.groupsMapping Un tableau de correspondance entre les groupes SAML2 et les groupes des utilisateurs de Loxya.
Par exemple : { "Administrateur": "admin", "Etudiant": "external" }		 object {}
    → auth.SAML2.defaultGroup Le groupe utilisateur de Loxya à utiliser si aucun groupe SAML2 n'a été trouvé dans groupsMapping (voir ci-dessus).
Si null, l'utilisateur ne sera pas autorisé à se connecter.		 string (ou null) null
    → auth.SAML2.nonSAMLUserLinking Quand un utilisateur se connecte via SAML2 pour la première fois alors qu'un utilisateur existe déjà avec la même adresse e-mail, détermine si le système doit le lier à son compte SAML2 ou non. boolean true
    → auth.SAML2.disableUnsolicitedRequests Détermine si Loxya doit prendre en charge les requêtes de connexion / déconnexion provenant du fournisseur d'identité sans que l'utilisateur soit passé par Loxya. boolean false
    → auth.SAML2.proxyVars Permet d'utiliser les headers X-Forwarded-* / HTTP_X_FORWARDED_PROTO pour déterminer le port / domaine / protocole. Ceci est utile notamment si l'application tourne derriere un load balancer qui met fin au protocole SSL. boolean false

Personnaliser les devis et factures

Il est possible de personnaliser la présentation des devis et factures, en modifiant les fichiers suivants :

  • Pour les devis : src/views/pdf/estimate-default.twig
  • Pour les factures : src/views/pdf/invoice-default.twig.

Il s'agit d'un fichier écrit en HTML, il faut donc maîtriser ce langage. Le système de template utilisé est Twig 3 . Le système fourni des variables permettant d'afficher les diverses données de la facture. Pour utiliser une variable, il suffit d'écrire son nom entre double-accolades, comme ceci : {{ variable }}, ou {{ variable['name'] }}.

Voici la liste des variables disponibles :

Variable Description Type
number Numéro de la facture. string
date Date de la facture. DateTime*
currency Devise de la facture (code ISO, par ex. EUR). string
currencyName Nom de la devise de la facture (p. ex. Euro). string
dailyAmount Montant total par jour. float**
degressiveRate Coefficient du tarif dégressif (voir fichier de config). float**
daysCount Nombre de jours (durée) de l'événement. integer
discountableDailyAmount Montant remisable total par jour. float**
discountRate Taux de remise appliqué (voir fichier de config). float**
dailyTotalDiscount Montant total de la remise par jour H.T.. float**
hasVat Est-ce que la TVA est utilisée ? boolean
vatRate Taux de T.V.A. applicable float**
vatAmount Montant de la T.V.A. float**
dailyTotalWithoutDiscount Montant total par jour H.T. sans remise. float**
dailyTotalDiscountable Montant remisable total par jour H.T.. float**
dailyTotalWithoutTaxes Montant total par jour H.T. avec remise. float**
dailyTotalTaxes Montant des taxes par jour float**
dailyTotalWithTaxes Montant total par jour T.T.C. float**
totalWithoutTaxes Montant total de la facture H.T.. float**
totalWithTaxes Montant total de la facture T.T.C.. float**
totalReplacement Valeur de remplacement totale. float**
locale Langue utilisée pour les traductions (fr, ou en). string

company
Informations de votre société (voir ci-dessous).
Array
company[name] Nom de votre société. string
company[street] Adresse de votre société (rue et n°). string
company[zipCode] Code postal de votre société. string
company[locality] Ville de votre société. string
company[country] Pays de votre société. string
company[phone] Numéro de téléphone de votre société. string
company[email] Adresse e-mail de contact de votre société. string
company[vatNumber] Le numéro de T.V.A. de votre société. string
company[legalNumbers] Numéros spéciaux de votre société.
(Par exemple, n° SIRET ou code APE, voir fichier de config).
Pour chaque numéro, les clés name et value sont disponibles.		 Array

booking
Informations de l'événement à facturer (voir ci-dessous).
Array
booking[title] Titre (nom) de l'événement. string
booking[start_date] Date de début de l'événement. DateTime*
booking[end_date] Date de fin de l'événement. DateTime*
booking[location] Localisation (lieu) de l'événement. string
booking[beneficiaries] La liste des bénéficiaires de l'événement.
Dans la vue par défaut, seul le 1er bénéficiaire de la liste (le 0) est utilisé.		 Array
booking[beneficiaries][0][full_name] Nom complet du bénéficiaire. string
booking[beneficiaries][0][street] Adresse (rue et numéro) du bénéficiaire. string
booking[beneficiaries][0][postal_code] Code postal du bénéficiaire. string
booking[beneficiaries][0][locality] Ville du bénéficiaire. string

categoriesSubTotals
Sous-totaux par catégories (voir ci-dessous).
Array
categoriesSubTotals[x][name] Nom de la catégorie. string
categoriesSubTotals[x][quantity] Quantité de matériel dans la catégorie. integer
categoriesSubTotals[x][subTotal] Montant total pour la catégorie. float**

materials
Détail du matériel, trié par sous-catégories (voir ci-dessous).
Array
materials[x][subCategory] Nom de la sous-catégorie. string
materials[x][materialsList] Liste du matériel de la sous-catégorie (voir ci-dessous). Array
materials[x][materialsList][x][reference] Référence du matériel. string
materials[x][materialsList][x][name] Nom du matériel. string
materials[x][materialsList][x][quantity] Quantité du matériel alloué. integer
materials[x][materialsList][x][unit_price] Tarif de location (unité). float**
materials[x][materialsList][x][replacement_price] Prix de remplacement total du matériel. float**
materials[x][materialsList][x][total_price] Montant total pour le matériel. float**

Personnaliser les fiches de sortie

De même que pour les devis et factures, il est possible de modifier le fichier suivant pour personnaliser les fiches de sortie :

  • src/views/pdf/event-summary-default.twig

Voici la liste des variables disponibles :

Variable Description Type
date Date du jour DateTime*
currency Devise de la facture (code ISO, par ex. EUR). string
currencyName Nom de la devise de la facture (p. ex. Euro). string
materialDisplayMode Le classement utilisé pour la liste du matériel string
replacementAmount Valeur de remplacement totale. float**
locale Langue utilisée pour les traductions (fr, ou en). string

company
Informations de votre société.
Array
company[name] Nom de votre société. string
company[street] Adresse de votre société (rue et n°). string
company[zipCode] Code postal de votre société. string
company[locality] Ville de votre société. string
company[country] Pays de votre société. string
company[phone] Numéro de téléphone de votre société. string
company[email] Adresse e-mail de contact de votre société. string
company[vatNumber] Le numéro de T.V.A. de votre société. string
company[legalNumbers] Numéros spéciaux de votre société.
(Par exemple, n° SIRET ou code APE, voir fichier de config).
Pour chaque numéro, les clés name et value sont disponibles.		 Array

event
Informations de l'événement à facturer.
Array
event[title] Titre (nom) de l'événement. string
event[start_date] Date de début de l'événement. DateTime*
event[end_date] Date de fin de l'événement. DateTime*
event[location] Localisation (lieu) de l'événement. string
event[beneficiaries] La liste des bénéficiaires de l'événement.
Dans la vue par défaut, seul le 1er bénéficiaire de la liste (le 0) est utilisé.		 Array
event[beneficiaries][0][full_name] Nom complet du bénéficiaire. string
event[beneficiaries][0][street] Adresse (rue et numéro) du bénéficiaire. string
event[beneficiaries][0][postal_code] Code postal du bénéficiaire. string
event[beneficiaries][0][locality] Ville du bénéficiaire. string

materialList
Liste du matériel (le tri dépend de materialDisplayMode).
Array
materialList[x][name] Nom de la sous-catégorie, ou du parc. string
materialList[x][materials] Liste du matériel de la sous-catégorie ou du parc. Array
materialList[x][materials][x][reference] Référence du matériel. string
materialList[x][materials][x][name] Nom du matériel. string
materialList[x][materials][x][quantity] Quantité du matériel alloué. integer
materialList[x][materials][x][rentalPrice] Tarif de location (unité). float**
materialList[x][materials][x][replacementPrice] Prix de remplacement total du matériel. float**
materialList[x][materials][x][total] Montant total pour le matériel. float**

* Les variables du type DateTime peuvent être formatées avec le filtre format_date() de Twig .
** Les variables du type float peuvent être formatées avec le filtre format_currency() de Twig si on veut un montant en devise, ou bien le filtre format_percent_number() si on veut un nombre en %.