Documentation de la solution web de gestion OpenFlyers - User contributions [en]

API OpenFlyers

2025-02-13T18:22:20Z

Lhenry: /* Script client : Authorization Code */

=Présentation=
L'objet de cette page est de décrire l'API OpenFlyers.

;Description de l'API
OpenFlyers possède une API basée sur [[Wikipedia-en:OAuth#OAuth_2.0|OAuth2]] qui permet à des serveurs extérieurs, dûment [[#Enregistrer-un-client|enregistrés]], de mettre en œuvre un processus d'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]] et/ou de récupération des résultats des requêtes SQL de la [[Bibliothèque-des-rapports|bibliothèque des rapports]] ou des rapports personnalisés sous la forme de fichiers CSV.

OAuth2 propose plusieurs mécanismes pour permettre l'authentification. Un mécanisme d'authentification détermine la séquence exacte des étapes impliquées dans le processus d'authentification d'OAuth2. OpenFlyers met à disposition deux mécanismes d'authentification :
*[[#Authorization Code|Authorization Code]] basé sur la méthode d'authentification par code d'autorisation et qui correspond au mécanisme associé à l'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]],
*[[#Client Credentials|Client Credentials]] basé sur la méthode d'authentification avec les identifiants clients et qui est utilisé dans un contexte d'automatisme sans autorisation de l'utilisateur au préalable.

Dans les chapitres qui suivent, le terme ''ressource'' fait référence à la définition OAuth2. Une ressource dans OAuth2 est un élément qui peut être :
*une ou des données comme des photos, des documents, des contacts ou des informations personnelles,
*un ou plusieurs services comme des transferts de fonds, la récupération de rapports ou l'ajout d'articles sur un blog,
*toute ressource nécessitant un accès restreint.

OpenFlyers définit plusieurs [[#Utiliser-l'API|types de ressources]] :
*les [[#Récupérer-les-informations-de-l'utilisateur-connecté|informations de l'utilisateur connecté]],
*les [[#Récupérer les rapports génériques|rapports génériques]] ou [[#Récupérer les rapports personnalisés|personnalisés]] au format CSV.

OAuth2 dispose de ''scopes''. Un scope est un privilège définit de manière explicite permettant l'accès à une ressource protégée. OpenFlyers met à disposition une [[#Liste des scopes disponibles|liste de scopes]] utilisables à travers l'API.

Deux protocoles de sécurité sont présents dans l'API OpenFlyers :
*[[#Authentification-TLS-Mutuelle-(mTLS)|mTLS]] : il permet d'authentifier le client avec un certificat TLS, en plus d'authentifier le serveur avec un certificat. Ce protocole permet d'éviter les usurpations d'identité.
*[[#HTTP-Signature|HTTP-Signature]] : il permet de signer les en-têtes et le corps (lorsqu'il y en a un) des messages échangés afin d'en garantir leur intégrité.

;Premiers pas - Client de démonstration
Un client de démonstration est disponible pour comprendre les mécanismes décrits ci-dessous.

L'utilisation de ce client de démonstration est décrite dans la procédure [[#Utiliser-le-client|Utiliser le client]] de cette page.

Le client de démonstration est lui-même accessible à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le code source du client de démonstration est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

L'utilisation du code source est décrite dans la procédure [[#Créer-un-client-à-partir-du-code-source|Créer un client à partir du code source]].

=Définitions=
==Authentification TLS Mutuelle (mTLS)==
En général dans une communication TLS, seul le serveur a l'obligation de fournir un certificat. Il est également possible pour le client de fournir un certificat. Ce principe s'appelle l'authentification mutuelle et est mise en place avec Mutual TLS (ou [[Wikipedia-en:Mutual_authentication#mTLS|mTLS]]).

OpenFlyers associe un certificat pour l'authentification mutuelle unique à chaque client OAuth2.

;Envoyer un certificat client
Côté client, le code suivant peut être utilisé pour fournir à cURL le certificat et la clé correspondante ainsi que le certificat du CA d'OpenFlyers à utiliser pour la connexion :
<php>curl_setopt_array($request, [
CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
CURLOPT_CAINFO => $caCertificatePath,
CURLOPT_SSLCERT => $certificatePath,
CURLOPT_SSLKEY => $keyPath
]);</php>

'''À noter''' : le certificat du CA d'OpenFlyers est nécessaire pour assurer la validité des certificats utilisés.

==HTTP Signature==
HTTP Signature utilise le principe de la signature numérique pour garantir l'authenticité et l'intégrité du message HTTP.

La signature est générée à l'aide d'une clé privée et vérifiée à l'aide de la clé publique correspondante ou d'un certificat contenant cette clé publique.

HTTP Signature utilise deux en-têtes HTTP :
*Signature : contient la signature et ses métadonnées.
*Digest : contient le corps du message haché.

===Digest===
Le ''digest'' est calculé comme ceci : <code>digest = base64encode(sha256(corps du message))</code>

Et l'en-tête est structuré de la manière suivante : <code>Digest: SHA-256=<digest></code>

Un autre algorithme de hachage peut être utilisé, SHA-256 reste cependant le plus répendu.

;Exemple en php
<php>$digestHeader = 'Digest: SHA-256=' . base64_encode(hash('sha256', $postData, true));</php>

===Signature===
L'en-tête HTTP de signature est structuré de la manière suivante : <code>Signature: keyId="<keyId>",algorithm="<algo>",headers="<signed_headers>",signature="<signature>"</code>

Le champ ''keyId'' correspond à un identifiant permettant l'identification de la clé utilisée pour vérifier la signature. Pour l'API d'OpenFlyers, sa valeur correspond à l'empreinte SHA-1 du certificat au format PEM à utiliser pour vérifier la signature.

L'algorithme ''algo'' correspond à celui utilisé pour générer la signature, exemple : <code>rsa-sha256</code>.

La valeur de ''signed_headers'' correspond à la liste des en-têtes inclus dans la signature séparés d'un espace. Exemple : <code>date digest (request-target)</code>

Pour générer la signature, une chaîne de caractères appelée <code>signing string</code> contenant les en-têtes au format <code>lowercase_header_name: value</code> séparés par une nouvelle ligne au format LF (<code>\n</code>) est d'abord générée. Exemple avec les en-têtes "date" et "(request-target)" :

<pre>(request-target): post /some/uri\ndate: Tue, 07 Jun 2014 20:51:35 GMT</pre>

La signature est ensuite générée comme ceci : <code>base64encode(algo(signing string))</code>

;Exemple en php
<syntaxhighlight lang="php">function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}

// trim extra whitespace
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, $privateKey, 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}</syntaxhighlight>
Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.

La variable ''$headersToSign'' est un tableau formaté de la manière suivante :
<syntaxhighlight lang="php">[
$headerName => $headerValue,
...
]</syntaxhighlight>

'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.

=Client OAuth2=
Une fois le client OAuth2 configuré sur OpenFlyers, il faut l'utiliser avec un client créé au préalable pour communiquer avec le serveur d'autorisation et l'API.

Plusieurs [https://oauth.net/code/ bibliothèques] simplifiant la création d'un client sont disponibles.

Des scripts client basiques écrits en php sont aussi fournis pour les mécanismes [[#Script-client-:-authorization-code|''authorization_code'']] et [[#Script-client-:-client-credentials|''client_credentials'']]

==Authorization Code==
Ce flux OAuth2 se déroule en plusieurs étapes :
*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
*Le navigateur de l'utilisateur est redirigé vers l'URL fournie durant la demande ou durant l'enregistrement du client.
*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
*Le client peut utiliser ce code d'accès :
**Comme preuve d'authentification pour une solution SSO (Single Sign-On).
**Pour accéder à des données sur le serveur distant en utilisant l'API.

+-----------+ +------+ +-----------+ +-------------+ +-----------+
|Utilisateur| |Client| |Navigateur | | Serveur | | Serveur |
+-----+-----+ +--+---+ +-----+-----+ |Autorisation | | Ressources|
| | | +------+------+ +-----+-----+
| | | | |
| | Demande|d'autorisation | |
| +------------------------->+------------------------------>| |
| | | | |
| |Authentification + Formulaire d'autorisation | |
|<---------------------------+--------------------------+<------------------------------+ |
| | | | |
| | Autorisation | | |
+----------------------------+------------------------->+------------------------------>| |
| | | | |
| | Code|d'autorisation | |
| |<-------------------------+<------------------------------+ |
| | | | |
| | Demande de|token | |
| +--------------------------+------------------------------>| |
| | | | |
| | Access (+|Refresh) token | |
| |<-------------------------+-------------------------------+ |
| | | | |
| | | Requête vers API | |
| +--------------------------+-------------------------------+------------------------------>|
| | | | |
| | | | |
| | | |<------------------------------+
| | | | Vérification d'autorisation |
| | | +------------------------------>|
| | | | |
| | | Données/Réponse | |
| |<-------------------------+-------------------------------+-------------------------------+
| | | | |

===Générer les codes pour PKCE===
Pour faire fonctionner le client OAuth2, il faut générer deux codes pour l'extension PKCE :
*Un ''code_verifier'' échangé pendant la demande de jeton d'accès.
*Un ''code_challenge'' dérivé du ''code_verifier'' et échangé pendant la demande d'autorisation.

;Générer le ''code_verifier''
<syntaxhighlight lang="php">function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}</syntaxhighlight>

Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.

;Générer le ''code_challenge''
<syntaxhighlight lang="php">function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}</syntaxhighlight>

Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.

===Demande d'autorisation===
Pour initier la demande d'autorisation, rediriger le navigateur de l'utilisateur vers l'URL : <code>GET https://openflyers.com/nom-de-plateforme/oauth/authorize.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également les paramètres suivants :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|response_type||string||Le type de réponse envoyée par le serveur. Doit utiliser la valeur "code" (sans guillements) pour ce mécanisme.
|-
|redirect_uri||string||L'URI (ou l'URL) fourni pendant l'enregistrement du client et vers lequel l'utilisateur est redirigé après la demande d'autorisation.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparés par des espaces.
|-
|state||string||Chaîne de caractère aléatoire utilisée pour éviter les [https://fr.wikipedia.org/wiki/Cross-site_request_forgery attaques CSRF]. '''Fortement recommandé'''.
|-
|code_challenge||string||Code nécessaire pour le fonctionnement de l'extension [[#Générer-les-codes-pour-PKCE|PKCE]].
|-
|code_challenge_method||string||Méthode utilisée pour générer le ''code_challenge''. Ici, la valeur est "S256".
|}

===Demande de jeton d'accès===
Après avoir répondu à la demande, l'utilisateur est redirigé vers l'URI fourni pendant l'enregistrement du client. Si la demande est acceptée, un code temporaire : ''code'' est fourni, ainsi que le paramètre ''state'' fourni pendant la demande avec la même valeur. Si la demande est refusée, un code d'erreur est renvoyé.
;Si le paramètre ''state'' a une valeur différente de celle envoyée avec la demande, c'est peut-être une tentative d'attaque et il faut refuser la réponse.

Echanger ce ''code'' contre un jeton d'accès via l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont également nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|code||string||Le code temporaire reçu dans la réponse à la demande d'autorisation.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, sa valeur doit être ''authorization_code''
|-
|redirect_uri||string||L'URI (ou l'URL) de redirection fourni pendant l'enregistrement du client.
|-
|code_verifier||string||Le ''code_verifier'' utilisé pour générer le ''code_challenge'' de la demande d'autorisation.
|}

Si la requête est correcte, un jeton d'accès (Access Token) ainsi qu'un jeton de rafraîchissement (Refresh Token) sont fournis en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

===Script client : Authorization Code===
Voici un exemple simple de client OAuth2 pour le mécanisme d'authentification par code d'autorisation (Authorization Code).

Fichier de configuration ''config.authcode.json'' :
<syntaxhighlight lang="javascript">{
"client_id": "",
"client_secret": "",
"authorize_uri": "https://openflyers.com/nom-de-plateforme/oauth/authorize.php",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</syntaxhighlight>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/AuthCodeDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script PHP :
<syntaxhighlight lang="php"><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.authcode.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the Authorization Server and the Resource Server
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $refresh = false, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
// required when a refresh token request is issued
// because there is only one header in the response
// while there are two for regular auth requests
if (!$refresh) {
list($firstResponseHeaders, $secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 3);
if (!$responseBody) {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}
} else {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $secondResponseHeaders);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function takes a code_verifier and outputs the corresponding code_challenge
*
* @param string $codeVerifier the generated code_verifier
*
* @return string the computed code_challenge
*/
function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}

/**
* This function takes an optional string length and outputs a random code_verifier string
*
* @param int $length the length of the output code_verifier. Default = 128
*
* @return string the code_verifier
* @throws Exception
*/
function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}

/**
* This function calculates the entropy of a given string
*
* @param string $string the string for which to calculate the entropy
* @param string $charset a string with all the usable characters. Default = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~
*
* @return float|int
*/
function computeEntropy(string $string, string $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~')
{
$chars = str_split($charset);
$probs = [];

foreach ($chars as $char) {
$probs[$char] = floatval(substr_count($string, $char)) / strlen($string);
}

$sum = 0.0;
foreach ($probs as $prob) {
$sum += $prob != 0 ? $prob * log($prob, 2) : 0.0;
}

return -$sum;
}

/**
* This function calculates the ideal (maximum) entropy for a string of a given length
*
* @param int $length length of the string. Default = 128
*
* @return float|int
*/
function idealEntropy(int $length = 128)
{
$prob = 1.0 / $length;

return -1.0 * $length * $prob * log($prob, 2);
}

/**
* This function is used to initiate the authentication code flow.
*
* @param string $clientID the client's ID
* @param string $redirectURL the URL where to redirect after auth
* @param string $authorizeURL the target URL to request authorization
*
* @throws Exception
*/
function login(string $clientID, string $redirectURL, string $authorizeURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

// This unguessable string is used to prevent csrf attacks
$_SESSION['state'] = bin2hex(random_bytes(16));

// Generate code_verifier and code_challenge for PKCE
$_SESSION['code_verifier'] = generateCodeVerifier();
$_SESSION['code_challenge'] = computeCodeChallenge($_SESSION['code_verifier']);

// required parameters for the redirection, redirect_uri is where the browser should be redirected
// when the user grants (or denies) access, scope are the authorizations (rights) requested
$params = [
'response_type' => 'code',
'client_id' => $clientID,
'redirect_uri' => $redirectURL,
'scope' => 'default.login',
'state' => $_SESSION['state'],
'code_challenge' => $_SESSION['code_challenge'],
'code_challenge_method' => 'S256'
];

// redirecting the browser to the AS authorization endpoint to obtain the authorization code
header('Location: ' . $authorizeURL . '?' . http_build_query($params));
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
// Building query array for resource dumping
$repoQueryParameters = [
'resource_type' => 'user_information',
'client_id' => $config['client_id']
];
switch ($_POST['action']) {
case 'login':
login($config['client_id'], $baseURL, $config['authorize_uri']);
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server to retreive user information
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Displaying user information
echo '<pre>';
echo $resourceBody;
echo '</pre>';

// Automatic refreshing token once access token is expired
if (strpos($firstHeaderLine, "401")) {
$errorBody = json_decode($resourceBody, true);
if ($errorBody['error'] == 'access_denied' && isset($errorBody['hint'])) {
if ($errorBody['hint'] == 'Access token could not be verified') {
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'refresh_token',
'refresh_token' => $localToken['refresh_token'],
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret']
],
false,
true,
true
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
}
}
}
}
break;
}
}

// Once the browser has been redirected to the AS to ask for the user's authorization, assuming it has been granted,
// the browser will get back here with a "code" parameter in the query string
if (isset($_GET['code'])) {
// The AS MUST redirect the browser here with the exact same state parameter we sent it before, so we check if it is indeed the same
// to detect if the oauth flow has been tampered with
if (!isset($_GET['state']) || $_SESSION['state'] != $_GET['state']) {
header('Location: ' . $baseURL . '?error=invalid_state');
die();
}

// We communicate directly with the AS to exchange the code received against an access token.
// The id/secret pair is send to authenticate the client, the redirect_uri is sent to verify the code's validity
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'authorization_code',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'redirect_uri' => $baseURL,
'code' => $_GET['code'],
'code_verifier' => $_SESSION['code_verifier']
]
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
die();
}</syntaxhighlight>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Client Credentials==
Ce mécanisme d'autorisation est adapté pour l'automatisation. Il fonctionne de la manière suivante :
*Le client effectue la demande de jeton d'accès au serveur d'autorisation en fournissant ses identifiants.
*Le serveur authentifie le client avec les identifiants fournis et renvoie un jeton d'accès.
*Le client utilise ce jeton d'accès pour accéder à des données via l'API.

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Demande token | |
+--------------------------------->| |
| | |
| Access token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de jeton d'accès===
Pour obtenir un jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être ''client_credentials''.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparé par des espaces.
|}

;Ce mécanisme a la particularité de ne pas nécessiter d'URI de redirection, il n'est donc pas utile d'en renseigner un lors de l'enregistrement d'un client.

Si la requête est correcte, un jeton d'accès (Access Token) est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw"
}</javascript>

===Script client : Client Credentials===
Voici un exemple simple d'un client OAuth2 pour le mécanisme d'authentification par les identifiants client (Client Credentials).

Fichier de configuration ''config.clientcred.json'' :
<javascript>{
"client_id": "",
"client_secret": "",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"revoke_uri": "https://openflyers.com/nom-de-plateforme/oauth/revoke.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/ClientCredDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/ClientCredDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script php :
<php><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.clientcred.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

$replacementListItems = [
1 => "year",
2 => "validityTypeId",
3 => "icao",
4 => "profileId",
7 => "accountingId",
8 => "paymentType",
9 => "startDate",
10 => "endDate",
11 => "occupiedSeat",
12 => "date",
13 => "activityTypeId",
14 => "age",
15 => "resourceId",
16 => "personId",
17 => "accountId",
20 => "rightPlacePersonId",
21 => "month",
22 => "numberMonth",
23 => "oneValidityTypeId",
];

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the RS
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
list($responseHeader, $responseBody) = explode("\r\n\r\n", $response, 2);

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $responseHeader);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
global $replacementListItems;
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<label for="report_id">Report ID: </label>';
echo '<input type="number" id="report_id" name="report_id"><br><br>';
foreach ($replacementListItems as $value) {
echo '<label for="' . $value . '">' . $value . ': </label>';
echo '<input type="text" id="' . $value . '" name="' . $value . '"><br><br>';
}
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
$replacementList = [];
// Building replacement list
foreach ($replacementListItems as $key => $value) {
$replacementList[$value] = (isset($_POST[$value]) && strlen($_POST[$value]) > 0) ? $_POST[$value] : null;
}
// Building query array
$repoQueryParameters = [
'resource_type' => 'generic_report',
'client_id' => $config['client_id'],
'report_id' => (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0) ? $_POST['report_id'] : null,
'replacementList' => $replacementList
];
switch ($_POST['action']) {
case 'login':
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'client_credentials',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'scope' => 'genericreports.readonly reports.readonly'
]
);
// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Building form for download CSV button
echo '<form method="post">';
foreach ($_POST as $key => $value) {
if ($key == "action") {
$value = "download";
}
echo '<input type="hidden" id="' . $key . '" name="' . $key . '" value="' . $value . '">';
}
if (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0 && !isset(json_decode($resourceBody, true)['error'])) {
echo '<button>Download as CSV</button>';
}
echo '</form>';

// Displaying requested content
echo '<pre>';
echo (strpos($firstHeaderLine, "200")) ? json_decode($resourceBody) : $resourceBody;
echo '</pre>';
break;
case 'download':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
$resourceHeaders = explode("\r\n", $resourceHeader);
array_shift($resourceHeaders);

// Dumping headers to insert them in current page
foreach ($resourceHeaders as $key => $value) {
header($value);
}
echo json_decode($resourceBody);
break;
}
}</php>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme et tester l'implémentation d'un serveur, il n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Refresh Token==
Refresh Token (ou jeton de rafraîchissement en français) est un mécanisme d'autorisation particulier. Il ne peut fonctionner en tant que tel, il fonctionne de pair avec [[#Authorization-Code|Authorization Code]]. Lorsqu'un jeton d'accès arrive est arrivé en fin de vie, si le client y est autorisé, il peut faire une demande de renouvellement de son jeton d'accès auprès du serveur d'autorisation en présentant son jeton de rafraîchissement. Le serveur d'autorisation vérifie la validité et génère un autre jeton d'accès qu'il transmet au client, sans que l'utilisateur final n'aît à se connecter de nouveau.

Le principe de fonctionnement du rafraîchissement d'un jeton est le suivant :
* Le jeton d'accès du client est arrivé à péremption. Le client effectue une demande de renouvellement en transmettant son Refresh Token au serveur d'autorisation.
* Le serveur d'autorisation vérifie la validité des informations, "consomme" le jeton de rafraîchissement et génère une nouvelle paire de jetons
* Le client reçoit sa nouvelle paire et utilise le nouveau jeton d'accès pour accéder aux ressources

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Refresh Token | |
+--------------------------------->| |
| | |
| Access (+ Refresh) token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de renouvellement d'un jeton===
Pour obtenir un renouvellement de jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant ''client_id'' reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase ''client_secret'' reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être "refresh_token" (sans guillements).
|-
|scope||string||('''OPTIONNEL''') Liste des droits demandés par le client, séparés par des espaces.
|}

Si la requête est correcte, un jeton d'accès ''access_token'' est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

==Liste des scopes disponibles==
Un scope sur OAuth2 correspond à un droit d'accès sur une ressource particulière. Chaque scope est unique et indique de manière explicite le privilège qu'il donne. Il n'y a aucune restriction d'utilisation des scopes par rapport aux mécanismes. Chaque scope peut être utilisé avec n'importe quel mécanisme. Il n'y a que des recommandations vis à vis de leur utilisation. OpenFlyers définit une liste de scopes dédiée aux ressources accessibles par les clients. Ces scopes sont les suivants :
{| class="wikitable"
!Nom!!Description
|-
|default.login||Comportement par défaut lorsqu'aucun scope n'est précisé ou qu'un scope est invalide. Ce scope est recommandé pour '''Authorization Code'''.
|-
|genericreports.readonly||Accéder aux rapports génériques autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|-
|reports.readonly||Accéder aux rapports personnalisés autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|}
==Prolonger la durée de vie de la session du client de démonstration==
La session du client de démonstration est initiée avec la méthode PHP [https://www.php.net/manual/en/function.session-start.php session_start]. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).

Pour permettre à la session de rester active même après la fermeture du navigateur, il faut utiliser la méthode PHP [https://www.php.net/manual/en/function.session-set-cookie-params.php session_set_cookie_params]. Cette méthode donne la possibilité de définir une durée de vie pour les différents cookies associés à la session.
<php>// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days
$oauth2DemoSessionLifeTime = time() + (86400 * 30);
session_set_cookie_params($oauth2DemoSessionLifeTime);</php>

NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.

==Révocation de token==
Pour initier la demande de révocation, rediriger le navigateur de l'utilisateur vers l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/revoke.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également le paramètre suivant:
{| class="wikitable"
!Nom!!Type!!Description
|-
|access_token||string||Le jeton d'accès (Chaîne de caractère unique permettant de prouver qu'un client OAuth a le droit d'accéder à une ressource.)
|}
<php> apiRequest(
$config['revoke_uri'],
['access_token' => $_SESSION['auth_token']['access_token']],
null,
false
);</php>

La demande de révocation se fait quand l'utilisateur clique sur le bouton '''Se déconnecter''' pour l'un des deux Clients '''Authorization Code''' et '''Client Credentials'''.

Si les jetons sont révoqués, l'utilisateur ne peut pas accéder à la plateforme OpenFlyers, il doit se reconnecter.

==Utiliser l'API==
Une fois un jeton d'accès obtenu, les données sont accessibles par une requête POST exécutée vers l'URL : <code>https://openflyers.com/nom-de-plateforme/oauth/resources.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée. La requête POST doit respecter une structure particulière. Cette structure diffère en fonction du type de ressource souhaité et chaque ressource ne peut être accédée qu'[[#Liste-des-scopes-disponibles|avec le scope qui lui est associé]]. Le jeton d'accès doit être renseigné dans l'en-tête HTTP ''Authorization'' en y indiquant la valeur complète du jeton d'accès reçu précédé du type de jeton reçu : <code>Authorization: <token_type> <access_token></code>.

===Récupérer les informations de l'utilisateur connecté===
Ce type de ressource est nommé '''user_information'''. Cette ressource n'est accessible qu'avec le scope '''default.login'''. Cette ressource permet la récupération des informations de l'utilisateur connecté, en d'autre termes, l'utilisateur connecté lors de l'étape d'autorisation et correspondant à celui ayant émis la demande de jeton d'accès. À l'heure actuelle, seul l'identifiant de l'utilisateur connecté est retourné. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''user_information'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"user_information",
"client_id":"d2615fe2020ec476"
}</javascript>

La réponse est retournée dans un conteneur JSON.

===Récupérer les rapports génériques===
Ce type de ressource est nommé '''generic_report'''. Cette ressource n'est accessible qu'avec le scope '''genericreports.readonly'''. Cette ressource permet la récupération des rapports génériques au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''generic_report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"generic_report",
"client_id":"d2615fe2020ec476",
"report_id":135,
"replacementList":{
"year":2018
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

===Récupérer les rapports personnalisés===
Ce type de ressource est nommé '''report'''. Cette ressource n'est accessible qu'avec le scope '''reports.readonly'''. Cette ressource permet la récupération des rapports personnalisés au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"report",
"client_id":"d2615fe2020ec476",
"report_id":1,
"replacementList":{
"year":2020
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

=Procédures=
==Créer un client à partir du code source==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

;Télécharger Le code source du client de démonstration :

Le code source est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

Le code source est structuré de la manière suivante :

[[File:Oauth2 src demo folder.png|800px]]

* Le dossier '''css''' contient tout le matériel nécessaire à la stylisation de la page web.
* Le dossier '''img''' contient les images affichées sur la page web.
* Le dossier '''ssl''' est le dossier contenant tous les certificats et les clé privées associées à chaque client. Il doit respecter une structure particulière décrite ci-dessous.
* Le fichier '''ClientDemo.php''' contient la classe '''ClientDemo'''. Cette classe contient toutes les méthodes nécessaires au fonctionnement du client de démonstration OAuth2.
* Le fichier '''index.php''' est le fichier à appeler depuis le navigateur. Ce fichier correspond au fichier qui gère les appels à la classe '''ClientDemo''' et exécute les méthodes dans l'ordre.

Le dossier '''ssl''' doit respecter la structure suivante :

[[File:Oauth2 demo tree.png]]

;[[#Générer des certificats|Générer les certificats]] :
Après la génération des certificats, les clés privées 'auth.key' et 'sign.key' remplacent celles présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo'.

;[[#Enregistrer un client|Enregistrer les clients]] :

*Deux clients doivent être créés :
**Le premier pour le mécanisme d'autorisation '''Authorization Code''',
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/AuthCodeDemo/auth.key",
"sign_cert": "path_to_client/ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/AuthCodeDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/ClientCredDemo/auth.key",
"sign_cert": "path_to_client/ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/ClientCredDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Enregistrer un client==
Pour utiliser l'API OAuth2, il faut enregistrer un client OAuth2 auprès d'OpenFlyers. Pour ceci, suivre les étapes suivantes :

;Pour le mécanisme d'authentification Client Credentials
*Créer un [[Gestion-des-profils#Ajouter-un-profil|nouveau profil]]. Ce profil doit permettre de gérer les droits du client OAuth2. Choisir un nom explicite, par exemple "Client OAuth rapports".

*Sélectionner les droits à assigner à ce profil. Ces droits limitent les données auxquelles le client OAuth2 a accès.
**Sélectionner les droits relatifs à l'enregistrement de clients OAuth2 dans l'onglet '''Admin''' (colonne '''Associé aux clients OAuth2''').
**Sélectionner les rapports accessibles par le profil précédemment créé.

*Créer un nouvel utilisateur à partir du panneau de gestion. Cet utilisateur est virtuel et représente le serveur sur lequel fonctionne le client OAuth2.
**''Des identifiant et nom explicites sont recommandés (exemple : "serv1_oauth_client")''
**'''Attention''' : tout utilisateur désactivé et associé à un client OAuth2 rend le client inactif, il faut donc changer l'utilisateur associé au client pour réactiver le client.

;Pour le mécanisme d'authentification Authorization Code
*Aller dans '''Admin > Utilisateurs > Profils'''
*Dans l'onglet '''Généralités''', cocher la case relative à la colonne '''Connexion depuis l'extérieur (OAuth2)''' pour le profil souhaité.

;Créer un nouveau client OAuth2
*Aller dans '''Admin > Transferts > Exports > API OAuth2'''
[[File:Oauth2 manage.png|800px]]
*Cliquer sur le bouton Ajouter '''+''' ou '''Ajouter un client'''
[[File:Oauth2 client creation.png|800px]]
*Choisir un nom pour le client.
*Sélectionner le mécanisme d'autorisation utilisé par le client :
**'''Authorization Code''': permet d'utiliser OAuth2 comme solution SSO ou accéder à des données utilisateurs. Cette méthode peut être couplée avec le mécanisme de mémorisation de connexion (''Refresh Token'').
**'''Client Credentials''': permet d'utiliser OAuth2 dans un contexte d'automatisme.
*Saisir l'URI de redirection vers le client pour le mécanisme ''Authorization Code''.
*Sélectionner l'utilisateur virtuel créé précédemment pour le mécanisme ''Client Credentials''.
*[[#Générer-des-certificats|Générer deux CSR]] afin d'obtenir deux certificats signés et les saisir :
**'''Certificate Signing Request pour le certificat d'authentification''' est utilisé pour l'authentification mutuelle avec mTLS (auth_cert.csr.pem).
**'''Certificate Signing Request pour le certificat de signature''' est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).

[[File:PublicKeysCopyScreen.png|900px]]

*Cliquer sur '''Enregistrer'''.

NB: La validité des certificats générés s'étend sur une période de '''3 années'''.

;Sauvegarder le couple ID/passphrase
Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles,
et Mettre ces identifiants dans le fichier '''config.clientcred.json'''.
[[File:Oauth2 client created.png]]

[[File:ConfigCredJsonScreen.png|600px]]

;Télécharger les certificats crt
Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets '''Certificat d'authentification''' et '''Certificat de signature''' et les mettre dans le dossier '''/ssl''' du client OAuth2.
[[File:Oauth2 client certificates.png]]

;Téléchargez les certificats du serveur.
*Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.
[[File:DownloadServerCertifScreen.png|900px]]
*Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.
*Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:
**Sous Linux, copier le certificat CA d'OpenFlyers dans le dossier <code>/usr/local/share/ca-certificates</code> et exécuter la commande <code>sudo update-ca-certificates</code>
**Sous Windows,
***Double-cliquer sur le certificat CA d'OpenFlyers téléchargé depuis l'interface d'enregistrement des clients OAuth2
***Cliquer sur '''Installer un certificat...'''
***Choisir l'emplacement de stockage (utilisateur ou ordinateur) et cliquer sur '''Suivant''' puis '''Suivant''' et enfin '''Terminer'''

==Générer des certificats==
L'API OAuth2 implémente [https://tools.ietf.org/html/draft-cavage-http-signatures-10 HTTP Signature] et l'[[Wikipedia-en:Mutual_authentication#mTLS|authentification TLS mutuelle]]. Ces mécanismes utilisent chacun une paire certificat/clé privée différente.

Pour obtenir ces certificats, il faut d'abord générer des Certificate Signing Request (CSR).

La procédure est la suivante :
*[[OpenSSL#Installer-OpenSSL-dans-un-environnement-Windows|Télécharger OpenSSL pour Windows]] ou [[OpenSSL#Utiliser-Openssl-d'Apache-sous-WAMP|utiliser Openssl d'Apache sous WAMP]].
*Utiliser les deux fichiers de configuration ''sign_cert.conf'' et ''auth_cert.conf'' ci-dessous et les remplir.

;Fichier de configuration OpenSSL - sign_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
keyUsage = digitalSignature # pour quelles opérations la clé peut-elle être utilisée</pre>

;Fichier de configuration OpenSSL - auth_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
extendedKeyUsage = clientAuth # pour quelles opérations la clé peut-elle être utilisée</pre>

Exécuter les commandes suivantes :
*<bash>openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</bash>
*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>

Ces commandes prennent chacune en entrée le fichier de configuration et génèrent une clé privée et un Certificate Signing Request.

Une fois ces CSR obtenus :
*Les renseigner dans les champs prévus à cet effet lors de la [[#Enregistrer-un-client|création d'un client]] et télécharger les certificats signés depuis l'interface une fois le client créé.
*Garder la clé privée confidentielle. Une fuite poserait un risque de sécurité. Elle va de paire avec le certificat distribué par l'autorité de certification OpenFlyers.

==Mettre en place une connexion à l'API OpenFlyers sur un serveur mutualisé==
;Note
La procédure ci-après est destinée à une mise en place lorsqu'il n'y a pas d'accès SSH en ligne de commande mais uniquement un accès FTP. Dans ce cas, la création des clés privées et publics est effectuée "en local". Dans la procédure suivante elle est effectuée depuis un PC sous '''Windows'''.

;Prérequis
*Posséder les accès FTP :
**Hôte : XXXXXXXXXXXXXXXXXX
**Login : XXXXXXXX
**Mot de passe : XXXXXXXX
**Port : XX (par exemple 21)
*Télécharger Le code source du client de démonstration à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

;Procédure
*[[#Générer des certificats|Générer les certificats]] en local.
*Remplacer les clés privées 'auth.key' et 'sign.key' présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo' par les clés générées.
*[[#Enregistrer un client|Enregistrer les deux clients]] :
**Le premier pour le mécanisme d'autorisation '''Authorization Code'''.
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion.
*Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion.
*Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "./ssl/AuthCodeDemo/auth.key",
"sign_cert": "./ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "./ssl/AuthCodeDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "./ssl/ClientCredDemo/auth.key",
"sign_cert": "./ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "./ssl/ClientCredDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.

*Transférer le fichier "oauth-demo" vers le serveur mutualisé :
**Télécharger [http://filezilla-project.org/download.php?type=client FileZilla].
**Lancer FileZilla.
**Entrer l'URl du serveur mutualisé dans le champ '''Hôte'''.
**Entrer le login dans le champ '''Nom d'utilisateur'''.
**Entrer le mot de passe dans le champ '''Mot de passe'''.
**Entrer le port dans le champ '''Port'''.
**Cliquer sur le bouton Connexion.
**Accéder à l'emplacement du répertoire "oauth-demo" en local à gauche dans l'onglet "Site local".
**Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet '''Site distant''' à droite.
**Glisser et déposer le oauth-demo à l'emplacement choisi.
[[File:Transfer OauthDemo To Shared Server.png|800px]]
*Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php
*Modifier la valeur '''URI de redirection vers le client''' du client '''AuthCodeDemo''' précédemment créé en remplaçant l'ancienne URL par la nouvelle.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Récupérer les données d'un utilisateur==
*Cliquer sur le bouton '''Récupérer les informations utilisateur''', l'identifiant de l'utilisateur s'affiche.
*Utiliser l'identifiant récupérer afin de récupérer toute information associée à cet utilisateur en [[Gestion-des-rapports#Ajouter-un-rapport|créant de nouveaux rapports personnalisés]]

==Utiliser le client==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le client de démonstration se présente de la manière suivante.

[[File:Oauth2-client-demo.png]]

La démonstration est composée de deux colonnes. La première, nommée '''Authorization Code''' correspond [[#Authorization Code|au mécanisme d'autorisation du même nom]]. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée '''Client Credentials''' correspond elle aussi [[#Client Credentials|au mécanisme d'autorisation du même nom]]. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.

;Le mécanisme '''Authorization Code'''
*Cliquer sur le bouton '''Se connecter''' (ce qui redirige le navigateur vers la page de connexion du logiciel OpenFlyers).
*Renseigner les identifiants de l'administrateur pour s'y connecter.
*Nom d'utilisateur : '''admini'''.
*Mot de passe : '''azerty'''.

Une fois les informations saisies, la page suivante est affichée.

[[File:Oauth authorize demo.png]]

*Cliquer sur le bouton '''Autoriser l'application''' pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).

La première colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un nouveau bouton '''Récupèrer les informations utilisateurs''' qui permet de récupérer les informations de l'utilisateur connecté.

;Le mécanisme '''Client Credentials'''
*Cliquer sur le bouton de connexion '''Se connecter''': contrairement à celui du mécanisme '''Authorization Code''', ne redirige pas le navigateur vers la page de connexion du logiciel OpenFlyers. Le bouton de connexion utilise les identifiants du client, ici le couple clé privée/clé publique, pour initier la connexion avec le serveur d'autorisation et obtenir un jeton d'accès.

Une fois la connexion établie, la seconde colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un menu déroulant '''Rapport à récupèrer''' et un nouveau bouton '''Récupèrer le rapport''' qui permet de récupérer les rapports génériques et personnalisés.

Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.

[[File:Oauth2 connected demo.png]]

=Troubleshooting=
==500 Internal Server Error en récupérant le rapport==
La démo utilise les valeurs par défaut pour extraire les rapports. Une erreur 500 indique une "Erreur de syntaxe ou violation d'accès" lors de l'exécution de la requête du rapport. Cela se produit parce que le rapport n'a pas de valeurs par défaut associées, étant donné qu'il n'a jamais été visualisé dans l'interface web. Pour résoudre ce problème, il vous suffit de visualiser le rapport et de cocher la case "Mémoriser ce choix".

==Erreur "File not found."==
Cette erreur se produit lorsque l'URI utilisé n'existe pas sur le serveur OpenFlyers. Vérifier les URIs mis en place dans les fichiers de configuration et essayer de nouveau.

==int_rsa_verify : longueur de signature incorrecte==
Ce problème pourrait survenir si les fichiers ca.cert et sign_cert_server.cert ne proviennent pas du même serveur que celui du client oauth2.
La solution est :

*D'essayer depuis le début l'étape de [[#Générer-des-certificats|génération]] et de [[#Enregistrer-un-client|configuration des certificats]] avec jsut la modification du client existant.

;Si cela ne fonctionne pas:

*Essayez de créer [[#Enregistrer-un-client|un nouveau client]] et refaites la configuration des certificats.

API OpenFlyers

2025-02-13T18:21:32Z

Lhenry: /* Générer les codes pour PKCE */

=Présentation=
L'objet de cette page est de décrire l'API OpenFlyers.

;Description de l'API
OpenFlyers possède une API basée sur [[Wikipedia-en:OAuth#OAuth_2.0|OAuth2]] qui permet à des serveurs extérieurs, dûment [[#Enregistrer-un-client|enregistrés]], de mettre en œuvre un processus d'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]] et/ou de récupération des résultats des requêtes SQL de la [[Bibliothèque-des-rapports|bibliothèque des rapports]] ou des rapports personnalisés sous la forme de fichiers CSV.

OAuth2 propose plusieurs mécanismes pour permettre l'authentification. Un mécanisme d'authentification détermine la séquence exacte des étapes impliquées dans le processus d'authentification d'OAuth2. OpenFlyers met à disposition deux mécanismes d'authentification :
*[[#Authorization Code|Authorization Code]] basé sur la méthode d'authentification par code d'autorisation et qui correspond au mécanisme associé à l'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]],
*[[#Client Credentials|Client Credentials]] basé sur la méthode d'authentification avec les identifiants clients et qui est utilisé dans un contexte d'automatisme sans autorisation de l'utilisateur au préalable.

Dans les chapitres qui suivent, le terme ''ressource'' fait référence à la définition OAuth2. Une ressource dans OAuth2 est un élément qui peut être :
*une ou des données comme des photos, des documents, des contacts ou des informations personnelles,
*un ou plusieurs services comme des transferts de fonds, la récupération de rapports ou l'ajout d'articles sur un blog,
*toute ressource nécessitant un accès restreint.

OpenFlyers définit plusieurs [[#Utiliser-l'API|types de ressources]] :
*les [[#Récupérer-les-informations-de-l'utilisateur-connecté|informations de l'utilisateur connecté]],
*les [[#Récupérer les rapports génériques|rapports génériques]] ou [[#Récupérer les rapports personnalisés|personnalisés]] au format CSV.

OAuth2 dispose de ''scopes''. Un scope est un privilège définit de manière explicite permettant l'accès à une ressource protégée. OpenFlyers met à disposition une [[#Liste des scopes disponibles|liste de scopes]] utilisables à travers l'API.

Deux protocoles de sécurité sont présents dans l'API OpenFlyers :
*[[#Authentification-TLS-Mutuelle-(mTLS)|mTLS]] : il permet d'authentifier le client avec un certificat TLS, en plus d'authentifier le serveur avec un certificat. Ce protocole permet d'éviter les usurpations d'identité.
*[[#HTTP-Signature|HTTP-Signature]] : il permet de signer les en-têtes et le corps (lorsqu'il y en a un) des messages échangés afin d'en garantir leur intégrité.

;Premiers pas - Client de démonstration
Un client de démonstration est disponible pour comprendre les mécanismes décrits ci-dessous.

L'utilisation de ce client de démonstration est décrite dans la procédure [[#Utiliser-le-client|Utiliser le client]] de cette page.

Le client de démonstration est lui-même accessible à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le code source du client de démonstration est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

L'utilisation du code source est décrite dans la procédure [[#Créer-un-client-à-partir-du-code-source|Créer un client à partir du code source]].

=Définitions=
==Authentification TLS Mutuelle (mTLS)==
En général dans une communication TLS, seul le serveur a l'obligation de fournir un certificat. Il est également possible pour le client de fournir un certificat. Ce principe s'appelle l'authentification mutuelle et est mise en place avec Mutual TLS (ou [[Wikipedia-en:Mutual_authentication#mTLS|mTLS]]).

OpenFlyers associe un certificat pour l'authentification mutuelle unique à chaque client OAuth2.

;Envoyer un certificat client
Côté client, le code suivant peut être utilisé pour fournir à cURL le certificat et la clé correspondante ainsi que le certificat du CA d'OpenFlyers à utiliser pour la connexion :
<php>curl_setopt_array($request, [
CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
CURLOPT_CAINFO => $caCertificatePath,
CURLOPT_SSLCERT => $certificatePath,
CURLOPT_SSLKEY => $keyPath
]);</php>

'''À noter''' : le certificat du CA d'OpenFlyers est nécessaire pour assurer la validité des certificats utilisés.

==HTTP Signature==
HTTP Signature utilise le principe de la signature numérique pour garantir l'authenticité et l'intégrité du message HTTP.

La signature est générée à l'aide d'une clé privée et vérifiée à l'aide de la clé publique correspondante ou d'un certificat contenant cette clé publique.

HTTP Signature utilise deux en-têtes HTTP :
*Signature : contient la signature et ses métadonnées.
*Digest : contient le corps du message haché.

===Digest===
Le ''digest'' est calculé comme ceci : <code>digest = base64encode(sha256(corps du message))</code>

Et l'en-tête est structuré de la manière suivante : <code>Digest: SHA-256=<digest></code>

Un autre algorithme de hachage peut être utilisé, SHA-256 reste cependant le plus répendu.

;Exemple en php
<php>$digestHeader = 'Digest: SHA-256=' . base64_encode(hash('sha256', $postData, true));</php>

===Signature===
L'en-tête HTTP de signature est structuré de la manière suivante : <code>Signature: keyId="<keyId>",algorithm="<algo>",headers="<signed_headers>",signature="<signature>"</code>

Le champ ''keyId'' correspond à un identifiant permettant l'identification de la clé utilisée pour vérifier la signature. Pour l'API d'OpenFlyers, sa valeur correspond à l'empreinte SHA-1 du certificat au format PEM à utiliser pour vérifier la signature.

L'algorithme ''algo'' correspond à celui utilisé pour générer la signature, exemple : <code>rsa-sha256</code>.

La valeur de ''signed_headers'' correspond à la liste des en-têtes inclus dans la signature séparés d'un espace. Exemple : <code>date digest (request-target)</code>

Pour générer la signature, une chaîne de caractères appelée <code>signing string</code> contenant les en-têtes au format <code>lowercase_header_name: value</code> séparés par une nouvelle ligne au format LF (<code>\n</code>) est d'abord générée. Exemple avec les en-têtes "date" et "(request-target)" :

<pre>(request-target): post /some/uri\ndate: Tue, 07 Jun 2014 20:51:35 GMT</pre>

La signature est ensuite générée comme ceci : <code>base64encode(algo(signing string))</code>

;Exemple en php
<syntaxhighlight lang="php">function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}

// trim extra whitespace
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, $privateKey, 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}</syntaxhighlight>
Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.

La variable ''$headersToSign'' est un tableau formaté de la manière suivante :
<syntaxhighlight lang="php">[
$headerName => $headerValue,
...
]</syntaxhighlight>

'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.

=Client OAuth2=
Une fois le client OAuth2 configuré sur OpenFlyers, il faut l'utiliser avec un client créé au préalable pour communiquer avec le serveur d'autorisation et l'API.

Plusieurs [https://oauth.net/code/ bibliothèques] simplifiant la création d'un client sont disponibles.

Des scripts client basiques écrits en php sont aussi fournis pour les mécanismes [[#Script-client-:-authorization-code|''authorization_code'']] et [[#Script-client-:-client-credentials|''client_credentials'']]

==Authorization Code==
Ce flux OAuth2 se déroule en plusieurs étapes :
*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
*Le navigateur de l'utilisateur est redirigé vers l'URL fournie durant la demande ou durant l'enregistrement du client.
*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
*Le client peut utiliser ce code d'accès :
**Comme preuve d'authentification pour une solution SSO (Single Sign-On).
**Pour accéder à des données sur le serveur distant en utilisant l'API.

+-----------+ +------+ +-----------+ +-------------+ +-----------+
|Utilisateur| |Client| |Navigateur | | Serveur | | Serveur |
+-----+-----+ +--+---+ +-----+-----+ |Autorisation | | Ressources|
| | | +------+------+ +-----+-----+
| | | | |
| | Demande|d'autorisation | |
| +------------------------->+------------------------------>| |
| | | | |
| |Authentification + Formulaire d'autorisation | |
|<---------------------------+--------------------------+<------------------------------+ |
| | | | |
| | Autorisation | | |
+----------------------------+------------------------->+------------------------------>| |
| | | | |
| | Code|d'autorisation | |
| |<-------------------------+<------------------------------+ |
| | | | |
| | Demande de|token | |
| +--------------------------+------------------------------>| |
| | | | |
| | Access (+|Refresh) token | |
| |<-------------------------+-------------------------------+ |
| | | | |
| | | Requête vers API | |
| +--------------------------+-------------------------------+------------------------------>|
| | | | |
| | | | |
| | | |<------------------------------+
| | | | Vérification d'autorisation |
| | | +------------------------------>|
| | | | |
| | | Données/Réponse | |
| |<-------------------------+-------------------------------+-------------------------------+
| | | | |

===Générer les codes pour PKCE===
Pour faire fonctionner le client OAuth2, il faut générer deux codes pour l'extension PKCE :
*Un ''code_verifier'' échangé pendant la demande de jeton d'accès.
*Un ''code_challenge'' dérivé du ''code_verifier'' et échangé pendant la demande d'autorisation.

;Générer le ''code_verifier''
<syntaxhighlight lang="php">function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}</syntaxhighlight>

Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.

;Générer le ''code_challenge''
<syntaxhighlight lang="php">function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}</syntaxhighlight>

Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.

===Demande d'autorisation===
Pour initier la demande d'autorisation, rediriger le navigateur de l'utilisateur vers l'URL : <code>GET https://openflyers.com/nom-de-plateforme/oauth/authorize.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également les paramètres suivants :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|response_type||string||Le type de réponse envoyée par le serveur. Doit utiliser la valeur "code" (sans guillements) pour ce mécanisme.
|-
|redirect_uri||string||L'URI (ou l'URL) fourni pendant l'enregistrement du client et vers lequel l'utilisateur est redirigé après la demande d'autorisation.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparés par des espaces.
|-
|state||string||Chaîne de caractère aléatoire utilisée pour éviter les [https://fr.wikipedia.org/wiki/Cross-site_request_forgery attaques CSRF]. '''Fortement recommandé'''.
|-
|code_challenge||string||Code nécessaire pour le fonctionnement de l'extension [[#Générer-les-codes-pour-PKCE|PKCE]].
|-
|code_challenge_method||string||Méthode utilisée pour générer le ''code_challenge''. Ici, la valeur est "S256".
|}

===Demande de jeton d'accès===
Après avoir répondu à la demande, l'utilisateur est redirigé vers l'URI fourni pendant l'enregistrement du client. Si la demande est acceptée, un code temporaire : ''code'' est fourni, ainsi que le paramètre ''state'' fourni pendant la demande avec la même valeur. Si la demande est refusée, un code d'erreur est renvoyé.
;Si le paramètre ''state'' a une valeur différente de celle envoyée avec la demande, c'est peut-être une tentative d'attaque et il faut refuser la réponse.

Echanger ce ''code'' contre un jeton d'accès via l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont également nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|code||string||Le code temporaire reçu dans la réponse à la demande d'autorisation.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, sa valeur doit être ''authorization_code''
|-
|redirect_uri||string||L'URI (ou l'URL) de redirection fourni pendant l'enregistrement du client.
|-
|code_verifier||string||Le ''code_verifier'' utilisé pour générer le ''code_challenge'' de la demande d'autorisation.
|}

Si la requête est correcte, un jeton d'accès (Access Token) ainsi qu'un jeton de rafraîchissement (Refresh Token) sont fournis en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

===Script client : Authorization Code===
Voici un exemple simple de client OAuth2 pour le mécanisme d'authentification par code d'autorisation (Authorization Code).

Fichier de configuration ''config.authcode.json'' :
<javascript>{
"client_id": "",
"client_secret": "",
"authorize_uri": "https://openflyers.com/nom-de-plateforme/oauth/authorize.php",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/AuthCodeDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script PHP :
<php><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.authcode.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the Authorization Server and the Resource Server
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $refresh = false, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
// required when a refresh token request is issued
// because there is only one header in the response
// while there are two for regular auth requests
if (!$refresh) {
list($firstResponseHeaders, $secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 3);
if (!$responseBody) {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}
} else {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $secondResponseHeaders);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function takes a code_verifier and outputs the corresponding code_challenge
*
* @param string $codeVerifier the generated code_verifier
*
* @return string the computed code_challenge
*/
function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}

/**
* This function takes an optional string length and outputs a random code_verifier string
*
* @param int $length the length of the output code_verifier. Default = 128
*
* @return string the code_verifier
* @throws Exception
*/
function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}

/**
* This function calculates the entropy of a given string
*
* @param string $string the string for which to calculate the entropy
* @param string $charset a string with all the usable characters. Default = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~
*
* @return float|int
*/
function computeEntropy(string $string, string $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~')
{
$chars = str_split($charset);
$probs = [];

foreach ($chars as $char) {
$probs[$char] = floatval(substr_count($string, $char)) / strlen($string);
}

$sum = 0.0;
foreach ($probs as $prob) {
$sum += $prob != 0 ? $prob * log($prob, 2) : 0.0;
}

return -$sum;
}

/**
* This function calculates the ideal (maximum) entropy for a string of a given length
*
* @param int $length length of the string. Default = 128
*
* @return float|int
*/
function idealEntropy(int $length = 128)
{
$prob = 1.0 / $length;

return -1.0 * $length * $prob * log($prob, 2);
}

/**
* This function is used to initiate the authentication code flow.
*
* @param string $clientID the client's ID
* @param string $redirectURL the URL where to redirect after auth
* @param string $authorizeURL the target URL to request authorization
*
* @throws Exception
*/
function login(string $clientID, string $redirectURL, string $authorizeURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

// This unguessable string is used to prevent csrf attacks
$_SESSION['state'] = bin2hex(random_bytes(16));

// Generate code_verifier and code_challenge for PKCE
$_SESSION['code_verifier'] = generateCodeVerifier();
$_SESSION['code_challenge'] = computeCodeChallenge($_SESSION['code_verifier']);

// required parameters for the redirection, redirect_uri is where the browser should be redirected
// when the user grants (or denies) access, scope are the authorizations (rights) requested
$params = [
'response_type' => 'code',
'client_id' => $clientID,
'redirect_uri' => $redirectURL,
'scope' => 'default.login',
'state' => $_SESSION['state'],
'code_challenge' => $_SESSION['code_challenge'],
'code_challenge_method' => 'S256'
];

// redirecting the browser to the AS authorization endpoint to obtain the authorization code
header('Location: ' . $authorizeURL . '?' . http_build_query($params));
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
// Building query array for resource dumping
$repoQueryParameters = [
'resource_type' => 'user_information',
'client_id' => $config['client_id']
];
switch ($_POST['action']) {
case 'login':
login($config['client_id'], $baseURL, $config['authorize_uri']);
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server to retreive user information
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Displaying user information
echo '<pre>';
echo $resourceBody;
echo '</pre>';

// Automatic refreshing token once access token is expired
if (strpos($firstHeaderLine, "401")) {
$errorBody = json_decode($resourceBody, true);
if ($errorBody['error'] == 'access_denied' && isset($errorBody['hint'])) {
if ($errorBody['hint'] == 'Access token could not be verified') {
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'refresh_token',
'refresh_token' => $localToken['refresh_token'],
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret']
],
false,
true,
true
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
}
}
}
}
break;
}
}

// Once the browser has been redirected to the AS to ask for the user's authorization, assuming it has been granted,
// the browser will get back here with a "code" parameter in the query string
if (isset($_GET['code'])) {
// The AS MUST redirect the browser here with the exact same state parameter we sent it before, so we check if it is indeed the same
// to detect if the oauth flow has been tampered with
if (!isset($_GET['state']) || $_SESSION['state'] != $_GET['state']) {
header('Location: ' . $baseURL . '?error=invalid_state');
die();
}

// We communicate directly with the AS to exchange the code received against an access token.
// The id/secret pair is send to authenticate the client, the redirect_uri is sent to verify the code's validity
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'authorization_code',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'redirect_uri' => $baseURL,
'code' => $_GET['code'],
'code_verifier' => $_SESSION['code_verifier']
]
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
die();
}</php>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Client Credentials==
Ce mécanisme d'autorisation est adapté pour l'automatisation. Il fonctionne de la manière suivante :
*Le client effectue la demande de jeton d'accès au serveur d'autorisation en fournissant ses identifiants.
*Le serveur authentifie le client avec les identifiants fournis et renvoie un jeton d'accès.
*Le client utilise ce jeton d'accès pour accéder à des données via l'API.

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Demande token | |
+--------------------------------->| |
| | |
| Access token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de jeton d'accès===
Pour obtenir un jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être ''client_credentials''.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparé par des espaces.
|}

;Ce mécanisme a la particularité de ne pas nécessiter d'URI de redirection, il n'est donc pas utile d'en renseigner un lors de l'enregistrement d'un client.

Si la requête est correcte, un jeton d'accès (Access Token) est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw"
}</javascript>

===Script client : Client Credentials===
Voici un exemple simple d'un client OAuth2 pour le mécanisme d'authentification par les identifiants client (Client Credentials).

Fichier de configuration ''config.clientcred.json'' :
<javascript>{
"client_id": "",
"client_secret": "",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"revoke_uri": "https://openflyers.com/nom-de-plateforme/oauth/revoke.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/ClientCredDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/ClientCredDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script php :
<php><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.clientcred.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

$replacementListItems = [
1 => "year",
2 => "validityTypeId",
3 => "icao",
4 => "profileId",
7 => "accountingId",
8 => "paymentType",
9 => "startDate",
10 => "endDate",
11 => "occupiedSeat",
12 => "date",
13 => "activityTypeId",
14 => "age",
15 => "resourceId",
16 => "personId",
17 => "accountId",
20 => "rightPlacePersonId",
21 => "month",
22 => "numberMonth",
23 => "oneValidityTypeId",
];

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the RS
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
list($responseHeader, $responseBody) = explode("\r\n\r\n", $response, 2);

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $responseHeader);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
global $replacementListItems;
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<label for="report_id">Report ID: </label>';
echo '<input type="number" id="report_id" name="report_id"><br><br>';
foreach ($replacementListItems as $value) {
echo '<label for="' . $value . '">' . $value . ': </label>';
echo '<input type="text" id="' . $value . '" name="' . $value . '"><br><br>';
}
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
$replacementList = [];
// Building replacement list
foreach ($replacementListItems as $key => $value) {
$replacementList[$value] = (isset($_POST[$value]) && strlen($_POST[$value]) > 0) ? $_POST[$value] : null;
}
// Building query array
$repoQueryParameters = [
'resource_type' => 'generic_report',
'client_id' => $config['client_id'],
'report_id' => (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0) ? $_POST['report_id'] : null,
'replacementList' => $replacementList
];
switch ($_POST['action']) {
case 'login':
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'client_credentials',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'scope' => 'genericreports.readonly reports.readonly'
]
);
// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Building form for download CSV button
echo '<form method="post">';
foreach ($_POST as $key => $value) {
if ($key == "action") {
$value = "download";
}
echo '<input type="hidden" id="' . $key . '" name="' . $key . '" value="' . $value . '">';
}
if (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0 && !isset(json_decode($resourceBody, true)['error'])) {
echo '<button>Download as CSV</button>';
}
echo '</form>';

// Displaying requested content
echo '<pre>';
echo (strpos($firstHeaderLine, "200")) ? json_decode($resourceBody) : $resourceBody;
echo '</pre>';
break;
case 'download':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
$resourceHeaders = explode("\r\n", $resourceHeader);
array_shift($resourceHeaders);

// Dumping headers to insert them in current page
foreach ($resourceHeaders as $key => $value) {
header($value);
}
echo json_decode($resourceBody);
break;
}
}</php>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme et tester l'implémentation d'un serveur, il n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Refresh Token==
Refresh Token (ou jeton de rafraîchissement en français) est un mécanisme d'autorisation particulier. Il ne peut fonctionner en tant que tel, il fonctionne de pair avec [[#Authorization-Code|Authorization Code]]. Lorsqu'un jeton d'accès arrive est arrivé en fin de vie, si le client y est autorisé, il peut faire une demande de renouvellement de son jeton d'accès auprès du serveur d'autorisation en présentant son jeton de rafraîchissement. Le serveur d'autorisation vérifie la validité et génère un autre jeton d'accès qu'il transmet au client, sans que l'utilisateur final n'aît à se connecter de nouveau.

Le principe de fonctionnement du rafraîchissement d'un jeton est le suivant :
* Le jeton d'accès du client est arrivé à péremption. Le client effectue une demande de renouvellement en transmettant son Refresh Token au serveur d'autorisation.
* Le serveur d'autorisation vérifie la validité des informations, "consomme" le jeton de rafraîchissement et génère une nouvelle paire de jetons
* Le client reçoit sa nouvelle paire et utilise le nouveau jeton d'accès pour accéder aux ressources

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Refresh Token | |
+--------------------------------->| |
| | |
| Access (+ Refresh) token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de renouvellement d'un jeton===
Pour obtenir un renouvellement de jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant ''client_id'' reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase ''client_secret'' reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être "refresh_token" (sans guillements).
|-
|scope||string||('''OPTIONNEL''') Liste des droits demandés par le client, séparés par des espaces.
|}

Si la requête est correcte, un jeton d'accès ''access_token'' est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

==Liste des scopes disponibles==
Un scope sur OAuth2 correspond à un droit d'accès sur une ressource particulière. Chaque scope est unique et indique de manière explicite le privilège qu'il donne. Il n'y a aucune restriction d'utilisation des scopes par rapport aux mécanismes. Chaque scope peut être utilisé avec n'importe quel mécanisme. Il n'y a que des recommandations vis à vis de leur utilisation. OpenFlyers définit une liste de scopes dédiée aux ressources accessibles par les clients. Ces scopes sont les suivants :
{| class="wikitable"
!Nom!!Description
|-
|default.login||Comportement par défaut lorsqu'aucun scope n'est précisé ou qu'un scope est invalide. Ce scope est recommandé pour '''Authorization Code'''.
|-
|genericreports.readonly||Accéder aux rapports génériques autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|-
|reports.readonly||Accéder aux rapports personnalisés autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|}
==Prolonger la durée de vie de la session du client de démonstration==
La session du client de démonstration est initiée avec la méthode PHP [https://www.php.net/manual/en/function.session-start.php session_start]. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).

Pour permettre à la session de rester active même après la fermeture du navigateur, il faut utiliser la méthode PHP [https://www.php.net/manual/en/function.session-set-cookie-params.php session_set_cookie_params]. Cette méthode donne la possibilité de définir une durée de vie pour les différents cookies associés à la session.
<php>// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days
$oauth2DemoSessionLifeTime = time() + (86400 * 30);
session_set_cookie_params($oauth2DemoSessionLifeTime);</php>

NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.

==Révocation de token==
Pour initier la demande de révocation, rediriger le navigateur de l'utilisateur vers l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/revoke.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également le paramètre suivant:
{| class="wikitable"
!Nom!!Type!!Description
|-
|access_token||string||Le jeton d'accès (Chaîne de caractère unique permettant de prouver qu'un client OAuth a le droit d'accéder à une ressource.)
|}
<php> apiRequest(
$config['revoke_uri'],
['access_token' => $_SESSION['auth_token']['access_token']],
null,
false
);</php>

La demande de révocation se fait quand l'utilisateur clique sur le bouton '''Se déconnecter''' pour l'un des deux Clients '''Authorization Code''' et '''Client Credentials'''.

Si les jetons sont révoqués, l'utilisateur ne peut pas accéder à la plateforme OpenFlyers, il doit se reconnecter.

==Utiliser l'API==
Une fois un jeton d'accès obtenu, les données sont accessibles par une requête POST exécutée vers l'URL : <code>https://openflyers.com/nom-de-plateforme/oauth/resources.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée. La requête POST doit respecter une structure particulière. Cette structure diffère en fonction du type de ressource souhaité et chaque ressource ne peut être accédée qu'[[#Liste-des-scopes-disponibles|avec le scope qui lui est associé]]. Le jeton d'accès doit être renseigné dans l'en-tête HTTP ''Authorization'' en y indiquant la valeur complète du jeton d'accès reçu précédé du type de jeton reçu : <code>Authorization: <token_type> <access_token></code>.

===Récupérer les informations de l'utilisateur connecté===
Ce type de ressource est nommé '''user_information'''. Cette ressource n'est accessible qu'avec le scope '''default.login'''. Cette ressource permet la récupération des informations de l'utilisateur connecté, en d'autre termes, l'utilisateur connecté lors de l'étape d'autorisation et correspondant à celui ayant émis la demande de jeton d'accès. À l'heure actuelle, seul l'identifiant de l'utilisateur connecté est retourné. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''user_information'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"user_information",
"client_id":"d2615fe2020ec476"
}</javascript>

La réponse est retournée dans un conteneur JSON.

===Récupérer les rapports génériques===
Ce type de ressource est nommé '''generic_report'''. Cette ressource n'est accessible qu'avec le scope '''genericreports.readonly'''. Cette ressource permet la récupération des rapports génériques au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''generic_report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"generic_report",
"client_id":"d2615fe2020ec476",
"report_id":135,
"replacementList":{
"year":2018
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

===Récupérer les rapports personnalisés===
Ce type de ressource est nommé '''report'''. Cette ressource n'est accessible qu'avec le scope '''reports.readonly'''. Cette ressource permet la récupération des rapports personnalisés au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"report",
"client_id":"d2615fe2020ec476",
"report_id":1,
"replacementList":{
"year":2020
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

=Procédures=
==Créer un client à partir du code source==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

;Télécharger Le code source du client de démonstration :

Le code source est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

Le code source est structuré de la manière suivante :

[[File:Oauth2 src demo folder.png|800px]]

* Le dossier '''css''' contient tout le matériel nécessaire à la stylisation de la page web.
* Le dossier '''img''' contient les images affichées sur la page web.
* Le dossier '''ssl''' est le dossier contenant tous les certificats et les clé privées associées à chaque client. Il doit respecter une structure particulière décrite ci-dessous.
* Le fichier '''ClientDemo.php''' contient la classe '''ClientDemo'''. Cette classe contient toutes les méthodes nécessaires au fonctionnement du client de démonstration OAuth2.
* Le fichier '''index.php''' est le fichier à appeler depuis le navigateur. Ce fichier correspond au fichier qui gère les appels à la classe '''ClientDemo''' et exécute les méthodes dans l'ordre.

Le dossier '''ssl''' doit respecter la structure suivante :

[[File:Oauth2 demo tree.png]]

;[[#Générer des certificats|Générer les certificats]] :
Après la génération des certificats, les clés privées 'auth.key' et 'sign.key' remplacent celles présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo'.

;[[#Enregistrer un client|Enregistrer les clients]] :

*Deux clients doivent être créés :
**Le premier pour le mécanisme d'autorisation '''Authorization Code''',
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/AuthCodeDemo/auth.key",
"sign_cert": "path_to_client/ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/AuthCodeDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/ClientCredDemo/auth.key",
"sign_cert": "path_to_client/ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/ClientCredDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Enregistrer un client==
Pour utiliser l'API OAuth2, il faut enregistrer un client OAuth2 auprès d'OpenFlyers. Pour ceci, suivre les étapes suivantes :

;Pour le mécanisme d'authentification Client Credentials
*Créer un [[Gestion-des-profils#Ajouter-un-profil|nouveau profil]]. Ce profil doit permettre de gérer les droits du client OAuth2. Choisir un nom explicite, par exemple "Client OAuth rapports".

*Sélectionner les droits à assigner à ce profil. Ces droits limitent les données auxquelles le client OAuth2 a accès.
**Sélectionner les droits relatifs à l'enregistrement de clients OAuth2 dans l'onglet '''Admin''' (colonne '''Associé aux clients OAuth2''').
**Sélectionner les rapports accessibles par le profil précédemment créé.

*Créer un nouvel utilisateur à partir du panneau de gestion. Cet utilisateur est virtuel et représente le serveur sur lequel fonctionne le client OAuth2.
**''Des identifiant et nom explicites sont recommandés (exemple : "serv1_oauth_client")''
**'''Attention''' : tout utilisateur désactivé et associé à un client OAuth2 rend le client inactif, il faut donc changer l'utilisateur associé au client pour réactiver le client.

;Pour le mécanisme d'authentification Authorization Code
*Aller dans '''Admin > Utilisateurs > Profils'''
*Dans l'onglet '''Généralités''', cocher la case relative à la colonne '''Connexion depuis l'extérieur (OAuth2)''' pour le profil souhaité.

;Créer un nouveau client OAuth2
*Aller dans '''Admin > Transferts > Exports > API OAuth2'''
[[File:Oauth2 manage.png|800px]]
*Cliquer sur le bouton Ajouter '''+''' ou '''Ajouter un client'''
[[File:Oauth2 client creation.png|800px]]
*Choisir un nom pour le client.
*Sélectionner le mécanisme d'autorisation utilisé par le client :
**'''Authorization Code''': permet d'utiliser OAuth2 comme solution SSO ou accéder à des données utilisateurs. Cette méthode peut être couplée avec le mécanisme de mémorisation de connexion (''Refresh Token'').
**'''Client Credentials''': permet d'utiliser OAuth2 dans un contexte d'automatisme.
*Saisir l'URI de redirection vers le client pour le mécanisme ''Authorization Code''.
*Sélectionner l'utilisateur virtuel créé précédemment pour le mécanisme ''Client Credentials''.
*[[#Générer-des-certificats|Générer deux CSR]] afin d'obtenir deux certificats signés et les saisir :
**'''Certificate Signing Request pour le certificat d'authentification''' est utilisé pour l'authentification mutuelle avec mTLS (auth_cert.csr.pem).
**'''Certificate Signing Request pour le certificat de signature''' est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).

[[File:PublicKeysCopyScreen.png|900px]]

*Cliquer sur '''Enregistrer'''.

NB: La validité des certificats générés s'étend sur une période de '''3 années'''.

;Sauvegarder le couple ID/passphrase
Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles,
et Mettre ces identifiants dans le fichier '''config.clientcred.json'''.
[[File:Oauth2 client created.png]]

[[File:ConfigCredJsonScreen.png|600px]]

;Télécharger les certificats crt
Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets '''Certificat d'authentification''' et '''Certificat de signature''' et les mettre dans le dossier '''/ssl''' du client OAuth2.
[[File:Oauth2 client certificates.png]]

;Téléchargez les certificats du serveur.
*Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.
[[File:DownloadServerCertifScreen.png|900px]]
*Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.
*Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:
**Sous Linux, copier le certificat CA d'OpenFlyers dans le dossier <code>/usr/local/share/ca-certificates</code> et exécuter la commande <code>sudo update-ca-certificates</code>
**Sous Windows,
***Double-cliquer sur le certificat CA d'OpenFlyers téléchargé depuis l'interface d'enregistrement des clients OAuth2
***Cliquer sur '''Installer un certificat...'''
***Choisir l'emplacement de stockage (utilisateur ou ordinateur) et cliquer sur '''Suivant''' puis '''Suivant''' et enfin '''Terminer'''

==Générer des certificats==
L'API OAuth2 implémente [https://tools.ietf.org/html/draft-cavage-http-signatures-10 HTTP Signature] et l'[[Wikipedia-en:Mutual_authentication#mTLS|authentification TLS mutuelle]]. Ces mécanismes utilisent chacun une paire certificat/clé privée différente.

Pour obtenir ces certificats, il faut d'abord générer des Certificate Signing Request (CSR).

La procédure est la suivante :
*[[OpenSSL#Installer-OpenSSL-dans-un-environnement-Windows|Télécharger OpenSSL pour Windows]] ou [[OpenSSL#Utiliser-Openssl-d'Apache-sous-WAMP|utiliser Openssl d'Apache sous WAMP]].
*Utiliser les deux fichiers de configuration ''sign_cert.conf'' et ''auth_cert.conf'' ci-dessous et les remplir.

;Fichier de configuration OpenSSL - sign_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
keyUsage = digitalSignature # pour quelles opérations la clé peut-elle être utilisée</pre>

;Fichier de configuration OpenSSL - auth_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
extendedKeyUsage = clientAuth # pour quelles opérations la clé peut-elle être utilisée</pre>

Exécuter les commandes suivantes :
*<bash>openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</bash>
*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>

Ces commandes prennent chacune en entrée le fichier de configuration et génèrent une clé privée et un Certificate Signing Request.

Une fois ces CSR obtenus :
*Les renseigner dans les champs prévus à cet effet lors de la [[#Enregistrer-un-client|création d'un client]] et télécharger les certificats signés depuis l'interface une fois le client créé.
*Garder la clé privée confidentielle. Une fuite poserait un risque de sécurité. Elle va de paire avec le certificat distribué par l'autorité de certification OpenFlyers.

==Mettre en place une connexion à l'API OpenFlyers sur un serveur mutualisé==
;Note
La procédure ci-après est destinée à une mise en place lorsqu'il n'y a pas d'accès SSH en ligne de commande mais uniquement un accès FTP. Dans ce cas, la création des clés privées et publics est effectuée "en local". Dans la procédure suivante elle est effectuée depuis un PC sous '''Windows'''.

;Prérequis
*Posséder les accès FTP :
**Hôte : XXXXXXXXXXXXXXXXXX
**Login : XXXXXXXX
**Mot de passe : XXXXXXXX
**Port : XX (par exemple 21)
*Télécharger Le code source du client de démonstration à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

;Procédure
*[[#Générer des certificats|Générer les certificats]] en local.
*Remplacer les clés privées 'auth.key' et 'sign.key' présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo' par les clés générées.
*[[#Enregistrer un client|Enregistrer les deux clients]] :
**Le premier pour le mécanisme d'autorisation '''Authorization Code'''.
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion.
*Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion.
*Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "./ssl/AuthCodeDemo/auth.key",
"sign_cert": "./ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "./ssl/AuthCodeDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "./ssl/ClientCredDemo/auth.key",
"sign_cert": "./ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "./ssl/ClientCredDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.

*Transférer le fichier "oauth-demo" vers le serveur mutualisé :
**Télécharger [http://filezilla-project.org/download.php?type=client FileZilla].
**Lancer FileZilla.
**Entrer l'URl du serveur mutualisé dans le champ '''Hôte'''.
**Entrer le login dans le champ '''Nom d'utilisateur'''.
**Entrer le mot de passe dans le champ '''Mot de passe'''.
**Entrer le port dans le champ '''Port'''.
**Cliquer sur le bouton Connexion.
**Accéder à l'emplacement du répertoire "oauth-demo" en local à gauche dans l'onglet "Site local".
**Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet '''Site distant''' à droite.
**Glisser et déposer le oauth-demo à l'emplacement choisi.
[[File:Transfer OauthDemo To Shared Server.png|800px]]
*Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php
*Modifier la valeur '''URI de redirection vers le client''' du client '''AuthCodeDemo''' précédemment créé en remplaçant l'ancienne URL par la nouvelle.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Récupérer les données d'un utilisateur==
*Cliquer sur le bouton '''Récupérer les informations utilisateur''', l'identifiant de l'utilisateur s'affiche.
*Utiliser l'identifiant récupérer afin de récupérer toute information associée à cet utilisateur en [[Gestion-des-rapports#Ajouter-un-rapport|créant de nouveaux rapports personnalisés]]

==Utiliser le client==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le client de démonstration se présente de la manière suivante.

[[File:Oauth2-client-demo.png]]

La démonstration est composée de deux colonnes. La première, nommée '''Authorization Code''' correspond [[#Authorization Code|au mécanisme d'autorisation du même nom]]. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée '''Client Credentials''' correspond elle aussi [[#Client Credentials|au mécanisme d'autorisation du même nom]]. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.

;Le mécanisme '''Authorization Code'''
*Cliquer sur le bouton '''Se connecter''' (ce qui redirige le navigateur vers la page de connexion du logiciel OpenFlyers).
*Renseigner les identifiants de l'administrateur pour s'y connecter.
*Nom d'utilisateur : '''admini'''.
*Mot de passe : '''azerty'''.

Une fois les informations saisies, la page suivante est affichée.

[[File:Oauth authorize demo.png]]

*Cliquer sur le bouton '''Autoriser l'application''' pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).

La première colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un nouveau bouton '''Récupèrer les informations utilisateurs''' qui permet de récupérer les informations de l'utilisateur connecté.

;Le mécanisme '''Client Credentials'''
*Cliquer sur le bouton de connexion '''Se connecter''': contrairement à celui du mécanisme '''Authorization Code''', ne redirige pas le navigateur vers la page de connexion du logiciel OpenFlyers. Le bouton de connexion utilise les identifiants du client, ici le couple clé privée/clé publique, pour initier la connexion avec le serveur d'autorisation et obtenir un jeton d'accès.

Une fois la connexion établie, la seconde colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un menu déroulant '''Rapport à récupèrer''' et un nouveau bouton '''Récupèrer le rapport''' qui permet de récupérer les rapports génériques et personnalisés.

Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.

[[File:Oauth2 connected demo.png]]

=Troubleshooting=
==500 Internal Server Error en récupérant le rapport==
La démo utilise les valeurs par défaut pour extraire les rapports. Une erreur 500 indique une "Erreur de syntaxe ou violation d'accès" lors de l'exécution de la requête du rapport. Cela se produit parce que le rapport n'a pas de valeurs par défaut associées, étant donné qu'il n'a jamais été visualisé dans l'interface web. Pour résoudre ce problème, il vous suffit de visualiser le rapport et de cocher la case "Mémoriser ce choix".

==Erreur "File not found."==
Cette erreur se produit lorsque l'URI utilisé n'existe pas sur le serveur OpenFlyers. Vérifier les URIs mis en place dans les fichiers de configuration et essayer de nouveau.

==int_rsa_verify : longueur de signature incorrecte==
Ce problème pourrait survenir si les fichiers ca.cert et sign_cert_server.cert ne proviennent pas du même serveur que celui du client oauth2.
La solution est :

*D'essayer depuis le début l'étape de [[#Générer-des-certificats|génération]] et de [[#Enregistrer-un-client|configuration des certificats]] avec jsut la modification du client existant.

;Si cela ne fonctionne pas:

*Essayez de créer [[#Enregistrer-un-client|un nouveau client]] et refaites la configuration des certificats.

API OpenFlyers

2025-02-13T18:20:28Z

Lhenry: /* Signature */

=Présentation=
L'objet de cette page est de décrire l'API OpenFlyers.

;Description de l'API
OpenFlyers possède une API basée sur [[Wikipedia-en:OAuth#OAuth_2.0|OAuth2]] qui permet à des serveurs extérieurs, dûment [[#Enregistrer-un-client|enregistrés]], de mettre en œuvre un processus d'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]] et/ou de récupération des résultats des requêtes SQL de la [[Bibliothèque-des-rapports|bibliothèque des rapports]] ou des rapports personnalisés sous la forme de fichiers CSV.

OAuth2 propose plusieurs mécanismes pour permettre l'authentification. Un mécanisme d'authentification détermine la séquence exacte des étapes impliquées dans le processus d'authentification d'OAuth2. OpenFlyers met à disposition deux mécanismes d'authentification :
*[[#Authorization Code|Authorization Code]] basé sur la méthode d'authentification par code d'autorisation et qui correspond au mécanisme associé à l'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]],
*[[#Client Credentials|Client Credentials]] basé sur la méthode d'authentification avec les identifiants clients et qui est utilisé dans un contexte d'automatisme sans autorisation de l'utilisateur au préalable.

Dans les chapitres qui suivent, le terme ''ressource'' fait référence à la définition OAuth2. Une ressource dans OAuth2 est un élément qui peut être :
*une ou des données comme des photos, des documents, des contacts ou des informations personnelles,
*un ou plusieurs services comme des transferts de fonds, la récupération de rapports ou l'ajout d'articles sur un blog,
*toute ressource nécessitant un accès restreint.

OpenFlyers définit plusieurs [[#Utiliser-l'API|types de ressources]] :
*les [[#Récupérer-les-informations-de-l'utilisateur-connecté|informations de l'utilisateur connecté]],
*les [[#Récupérer les rapports génériques|rapports génériques]] ou [[#Récupérer les rapports personnalisés|personnalisés]] au format CSV.

OAuth2 dispose de ''scopes''. Un scope est un privilège définit de manière explicite permettant l'accès à une ressource protégée. OpenFlyers met à disposition une [[#Liste des scopes disponibles|liste de scopes]] utilisables à travers l'API.

Deux protocoles de sécurité sont présents dans l'API OpenFlyers :
*[[#Authentification-TLS-Mutuelle-(mTLS)|mTLS]] : il permet d'authentifier le client avec un certificat TLS, en plus d'authentifier le serveur avec un certificat. Ce protocole permet d'éviter les usurpations d'identité.
*[[#HTTP-Signature|HTTP-Signature]] : il permet de signer les en-têtes et le corps (lorsqu'il y en a un) des messages échangés afin d'en garantir leur intégrité.

;Premiers pas - Client de démonstration
Un client de démonstration est disponible pour comprendre les mécanismes décrits ci-dessous.

L'utilisation de ce client de démonstration est décrite dans la procédure [[#Utiliser-le-client|Utiliser le client]] de cette page.

Le client de démonstration est lui-même accessible à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le code source du client de démonstration est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

L'utilisation du code source est décrite dans la procédure [[#Créer-un-client-à-partir-du-code-source|Créer un client à partir du code source]].

=Définitions=
==Authentification TLS Mutuelle (mTLS)==
En général dans une communication TLS, seul le serveur a l'obligation de fournir un certificat. Il est également possible pour le client de fournir un certificat. Ce principe s'appelle l'authentification mutuelle et est mise en place avec Mutual TLS (ou [[Wikipedia-en:Mutual_authentication#mTLS|mTLS]]).

OpenFlyers associe un certificat pour l'authentification mutuelle unique à chaque client OAuth2.

;Envoyer un certificat client
Côté client, le code suivant peut être utilisé pour fournir à cURL le certificat et la clé correspondante ainsi que le certificat du CA d'OpenFlyers à utiliser pour la connexion :
<php>curl_setopt_array($request, [
CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
CURLOPT_CAINFO => $caCertificatePath,
CURLOPT_SSLCERT => $certificatePath,
CURLOPT_SSLKEY => $keyPath
]);</php>

'''À noter''' : le certificat du CA d'OpenFlyers est nécessaire pour assurer la validité des certificats utilisés.

==HTTP Signature==
HTTP Signature utilise le principe de la signature numérique pour garantir l'authenticité et l'intégrité du message HTTP.

La signature est générée à l'aide d'une clé privée et vérifiée à l'aide de la clé publique correspondante ou d'un certificat contenant cette clé publique.

HTTP Signature utilise deux en-têtes HTTP :
*Signature : contient la signature et ses métadonnées.
*Digest : contient le corps du message haché.

===Digest===
Le ''digest'' est calculé comme ceci : <code>digest = base64encode(sha256(corps du message))</code>

Et l'en-tête est structuré de la manière suivante : <code>Digest: SHA-256=<digest></code>

Un autre algorithme de hachage peut être utilisé, SHA-256 reste cependant le plus répendu.

;Exemple en php
<php>$digestHeader = 'Digest: SHA-256=' . base64_encode(hash('sha256', $postData, true));</php>

===Signature===
L'en-tête HTTP de signature est structuré de la manière suivante : <code>Signature: keyId="<keyId>",algorithm="<algo>",headers="<signed_headers>",signature="<signature>"</code>

Le champ ''keyId'' correspond à un identifiant permettant l'identification de la clé utilisée pour vérifier la signature. Pour l'API d'OpenFlyers, sa valeur correspond à l'empreinte SHA-1 du certificat au format PEM à utiliser pour vérifier la signature.

L'algorithme ''algo'' correspond à celui utilisé pour générer la signature, exemple : <code>rsa-sha256</code>.

La valeur de ''signed_headers'' correspond à la liste des en-têtes inclus dans la signature séparés d'un espace. Exemple : <code>date digest (request-target)</code>

Pour générer la signature, une chaîne de caractères appelée <code>signing string</code> contenant les en-têtes au format <code>lowercase_header_name: value</code> séparés par une nouvelle ligne au format LF (<code>\n</code>) est d'abord générée. Exemple avec les en-têtes "date" et "(request-target)" :

<pre>(request-target): post /some/uri\ndate: Tue, 07 Jun 2014 20:51:35 GMT</pre>

La signature est ensuite générée comme ceci : <code>base64encode(algo(signing string))</code>

;Exemple en php
<syntaxhighlight lang="php">function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}

// trim extra whitespace
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, $privateKey, 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}</syntaxhighlight>
Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.

La variable ''$headersToSign'' est un tableau formaté de la manière suivante :
<syntaxhighlight lang="php">[
$headerName => $headerValue,
...
]</syntaxhighlight>

'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.

=Client OAuth2=
Une fois le client OAuth2 configuré sur OpenFlyers, il faut l'utiliser avec un client créé au préalable pour communiquer avec le serveur d'autorisation et l'API.

Plusieurs [https://oauth.net/code/ bibliothèques] simplifiant la création d'un client sont disponibles.

Des scripts client basiques écrits en php sont aussi fournis pour les mécanismes [[#Script-client-:-authorization-code|''authorization_code'']] et [[#Script-client-:-client-credentials|''client_credentials'']]

==Authorization Code==
Ce flux OAuth2 se déroule en plusieurs étapes :
*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
*Le navigateur de l'utilisateur est redirigé vers l'URL fournie durant la demande ou durant l'enregistrement du client.
*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
*Le client peut utiliser ce code d'accès :
**Comme preuve d'authentification pour une solution SSO (Single Sign-On).
**Pour accéder à des données sur le serveur distant en utilisant l'API.

+-----------+ +------+ +-----------+ +-------------+ +-----------+
|Utilisateur| |Client| |Navigateur | | Serveur | | Serveur |
+-----+-----+ +--+---+ +-----+-----+ |Autorisation | | Ressources|
| | | +------+------+ +-----+-----+
| | | | |
| | Demande|d'autorisation | |
| +------------------------->+------------------------------>| |
| | | | |
| |Authentification + Formulaire d'autorisation | |
|<---------------------------+--------------------------+<------------------------------+ |
| | | | |
| | Autorisation | | |
+----------------------------+------------------------->+------------------------------>| |
| | | | |
| | Code|d'autorisation | |
| |<-------------------------+<------------------------------+ |
| | | | |
| | Demande de|token | |
| +--------------------------+------------------------------>| |
| | | | |
| | Access (+|Refresh) token | |
| |<-------------------------+-------------------------------+ |
| | | | |
| | | Requête vers API | |
| +--------------------------+-------------------------------+------------------------------>|
| | | | |
| | | | |
| | | |<------------------------------+
| | | | Vérification d'autorisation |
| | | +------------------------------>|
| | | | |
| | | Données/Réponse | |
| |<-------------------------+-------------------------------+-------------------------------+
| | | | |

===Générer les codes pour PKCE===
Pour faire fonctionner le client OAuth2, il faut générer deux codes pour l'extension PKCE :
*Un ''code_verifier'' échangé pendant la demande de jeton d'accès.
*Un ''code_challenge'' dérivé du ''code_verifier'' et échangé pendant la demande d'autorisation.

;Générer le ''code_verifier''
<php>function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}</php>

Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.

;Générer le ''code_challenge''
<php>function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}</php>

Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.

===Demande d'autorisation===
Pour initier la demande d'autorisation, rediriger le navigateur de l'utilisateur vers l'URL : <code>GET https://openflyers.com/nom-de-plateforme/oauth/authorize.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également les paramètres suivants :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|response_type||string||Le type de réponse envoyée par le serveur. Doit utiliser la valeur "code" (sans guillements) pour ce mécanisme.
|-
|redirect_uri||string||L'URI (ou l'URL) fourni pendant l'enregistrement du client et vers lequel l'utilisateur est redirigé après la demande d'autorisation.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparés par des espaces.
|-
|state||string||Chaîne de caractère aléatoire utilisée pour éviter les [https://fr.wikipedia.org/wiki/Cross-site_request_forgery attaques CSRF]. '''Fortement recommandé'''.
|-
|code_challenge||string||Code nécessaire pour le fonctionnement de l'extension [[#Générer-les-codes-pour-PKCE|PKCE]].
|-
|code_challenge_method||string||Méthode utilisée pour générer le ''code_challenge''. Ici, la valeur est "S256".
|}

===Demande de jeton d'accès===
Après avoir répondu à la demande, l'utilisateur est redirigé vers l'URI fourni pendant l'enregistrement du client. Si la demande est acceptée, un code temporaire : ''code'' est fourni, ainsi que le paramètre ''state'' fourni pendant la demande avec la même valeur. Si la demande est refusée, un code d'erreur est renvoyé.
;Si le paramètre ''state'' a une valeur différente de celle envoyée avec la demande, c'est peut-être une tentative d'attaque et il faut refuser la réponse.

Echanger ce ''code'' contre un jeton d'accès via l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont également nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|code||string||Le code temporaire reçu dans la réponse à la demande d'autorisation.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, sa valeur doit être ''authorization_code''
|-
|redirect_uri||string||L'URI (ou l'URL) de redirection fourni pendant l'enregistrement du client.
|-
|code_verifier||string||Le ''code_verifier'' utilisé pour générer le ''code_challenge'' de la demande d'autorisation.
|}

Si la requête est correcte, un jeton d'accès (Access Token) ainsi qu'un jeton de rafraîchissement (Refresh Token) sont fournis en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

===Script client : Authorization Code===
Voici un exemple simple de client OAuth2 pour le mécanisme d'authentification par code d'autorisation (Authorization Code).

Fichier de configuration ''config.authcode.json'' :
<javascript>{
"client_id": "",
"client_secret": "",
"authorize_uri": "https://openflyers.com/nom-de-plateforme/oauth/authorize.php",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/AuthCodeDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script PHP :
<php><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.authcode.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the Authorization Server and the Resource Server
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $refresh = false, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
// required when a refresh token request is issued
// because there is only one header in the response
// while there are two for regular auth requests
if (!$refresh) {
list($firstResponseHeaders, $secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 3);
if (!$responseBody) {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}
} else {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $secondResponseHeaders);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function takes a code_verifier and outputs the corresponding code_challenge
*
* @param string $codeVerifier the generated code_verifier
*
* @return string the computed code_challenge
*/
function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}

/**
* This function takes an optional string length and outputs a random code_verifier string
*
* @param int $length the length of the output code_verifier. Default = 128
*
* @return string the code_verifier
* @throws Exception
*/
function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}

/**
* This function calculates the entropy of a given string
*
* @param string $string the string for which to calculate the entropy
* @param string $charset a string with all the usable characters. Default = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~
*
* @return float|int
*/
function computeEntropy(string $string, string $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~')
{
$chars = str_split($charset);
$probs = [];

foreach ($chars as $char) {
$probs[$char] = floatval(substr_count($string, $char)) / strlen($string);
}

$sum = 0.0;
foreach ($probs as $prob) {
$sum += $prob != 0 ? $prob * log($prob, 2) : 0.0;
}

return -$sum;
}

/**
* This function calculates the ideal (maximum) entropy for a string of a given length
*
* @param int $length length of the string. Default = 128
*
* @return float|int
*/
function idealEntropy(int $length = 128)
{
$prob = 1.0 / $length;

return -1.0 * $length * $prob * log($prob, 2);
}

/**
* This function is used to initiate the authentication code flow.
*
* @param string $clientID the client's ID
* @param string $redirectURL the URL where to redirect after auth
* @param string $authorizeURL the target URL to request authorization
*
* @throws Exception
*/
function login(string $clientID, string $redirectURL, string $authorizeURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

// This unguessable string is used to prevent csrf attacks
$_SESSION['state'] = bin2hex(random_bytes(16));

// Generate code_verifier and code_challenge for PKCE
$_SESSION['code_verifier'] = generateCodeVerifier();
$_SESSION['code_challenge'] = computeCodeChallenge($_SESSION['code_verifier']);

// required parameters for the redirection, redirect_uri is where the browser should be redirected
// when the user grants (or denies) access, scope are the authorizations (rights) requested
$params = [
'response_type' => 'code',
'client_id' => $clientID,
'redirect_uri' => $redirectURL,
'scope' => 'default.login',
'state' => $_SESSION['state'],
'code_challenge' => $_SESSION['code_challenge'],
'code_challenge_method' => 'S256'
];

// redirecting the browser to the AS authorization endpoint to obtain the authorization code
header('Location: ' . $authorizeURL . '?' . http_build_query($params));
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
// Building query array for resource dumping
$repoQueryParameters = [
'resource_type' => 'user_information',
'client_id' => $config['client_id']
];
switch ($_POST['action']) {
case 'login':
login($config['client_id'], $baseURL, $config['authorize_uri']);
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server to retreive user information
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Displaying user information
echo '<pre>';
echo $resourceBody;
echo '</pre>';

// Automatic refreshing token once access token is expired
if (strpos($firstHeaderLine, "401")) {
$errorBody = json_decode($resourceBody, true);
if ($errorBody['error'] == 'access_denied' && isset($errorBody['hint'])) {
if ($errorBody['hint'] == 'Access token could not be verified') {
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'refresh_token',
'refresh_token' => $localToken['refresh_token'],
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret']
],
false,
true,
true
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
}
}
}
}
break;
}
}

// Once the browser has been redirected to the AS to ask for the user's authorization, assuming it has been granted,
// the browser will get back here with a "code" parameter in the query string
if (isset($_GET['code'])) {
// The AS MUST redirect the browser here with the exact same state parameter we sent it before, so we check if it is indeed the same
// to detect if the oauth flow has been tampered with
if (!isset($_GET['state']) || $_SESSION['state'] != $_GET['state']) {
header('Location: ' . $baseURL . '?error=invalid_state');
die();
}

// We communicate directly with the AS to exchange the code received against an access token.
// The id/secret pair is send to authenticate the client, the redirect_uri is sent to verify the code's validity
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'authorization_code',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'redirect_uri' => $baseURL,
'code' => $_GET['code'],
'code_verifier' => $_SESSION['code_verifier']
]
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
die();
}</php>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Client Credentials==
Ce mécanisme d'autorisation est adapté pour l'automatisation. Il fonctionne de la manière suivante :
*Le client effectue la demande de jeton d'accès au serveur d'autorisation en fournissant ses identifiants.
*Le serveur authentifie le client avec les identifiants fournis et renvoie un jeton d'accès.
*Le client utilise ce jeton d'accès pour accéder à des données via l'API.

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Demande token | |
+--------------------------------->| |
| | |
| Access token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de jeton d'accès===
Pour obtenir un jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être ''client_credentials''.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparé par des espaces.
|}

;Ce mécanisme a la particularité de ne pas nécessiter d'URI de redirection, il n'est donc pas utile d'en renseigner un lors de l'enregistrement d'un client.

Si la requête est correcte, un jeton d'accès (Access Token) est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw"
}</javascript>

===Script client : Client Credentials===
Voici un exemple simple d'un client OAuth2 pour le mécanisme d'authentification par les identifiants client (Client Credentials).

Fichier de configuration ''config.clientcred.json'' :
<javascript>{
"client_id": "",
"client_secret": "",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"revoke_uri": "https://openflyers.com/nom-de-plateforme/oauth/revoke.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/ClientCredDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/ClientCredDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script php :
<php><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.clientcred.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

$replacementListItems = [
1 => "year",
2 => "validityTypeId",
3 => "icao",
4 => "profileId",
7 => "accountingId",
8 => "paymentType",
9 => "startDate",
10 => "endDate",
11 => "occupiedSeat",
12 => "date",
13 => "activityTypeId",
14 => "age",
15 => "resourceId",
16 => "personId",
17 => "accountId",
20 => "rightPlacePersonId",
21 => "month",
22 => "numberMonth",
23 => "oneValidityTypeId",
];

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the RS
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
list($responseHeader, $responseBody) = explode("\r\n\r\n", $response, 2);

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $responseHeader);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
global $replacementListItems;
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<label for="report_id">Report ID: </label>';
echo '<input type="number" id="report_id" name="report_id"><br><br>';
foreach ($replacementListItems as $value) {
echo '<label for="' . $value . '">' . $value . ': </label>';
echo '<input type="text" id="' . $value . '" name="' . $value . '"><br><br>';
}
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
$replacementList = [];
// Building replacement list
foreach ($replacementListItems as $key => $value) {
$replacementList[$value] = (isset($_POST[$value]) && strlen($_POST[$value]) > 0) ? $_POST[$value] : null;
}
// Building query array
$repoQueryParameters = [
'resource_type' => 'generic_report',
'client_id' => $config['client_id'],
'report_id' => (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0) ? $_POST['report_id'] : null,
'replacementList' => $replacementList
];
switch ($_POST['action']) {
case 'login':
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'client_credentials',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'scope' => 'genericreports.readonly reports.readonly'
]
);
// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Building form for download CSV button
echo '<form method="post">';
foreach ($_POST as $key => $value) {
if ($key == "action") {
$value = "download";
}
echo '<input type="hidden" id="' . $key . '" name="' . $key . '" value="' . $value . '">';
}
if (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0 && !isset(json_decode($resourceBody, true)['error'])) {
echo '<button>Download as CSV</button>';
}
echo '</form>';

// Displaying requested content
echo '<pre>';
echo (strpos($firstHeaderLine, "200")) ? json_decode($resourceBody) : $resourceBody;
echo '</pre>';
break;
case 'download':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
$resourceHeaders = explode("\r\n", $resourceHeader);
array_shift($resourceHeaders);

// Dumping headers to insert them in current page
foreach ($resourceHeaders as $key => $value) {
header($value);
}
echo json_decode($resourceBody);
break;
}
}</php>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme et tester l'implémentation d'un serveur, il n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Refresh Token==
Refresh Token (ou jeton de rafraîchissement en français) est un mécanisme d'autorisation particulier. Il ne peut fonctionner en tant que tel, il fonctionne de pair avec [[#Authorization-Code|Authorization Code]]. Lorsqu'un jeton d'accès arrive est arrivé en fin de vie, si le client y est autorisé, il peut faire une demande de renouvellement de son jeton d'accès auprès du serveur d'autorisation en présentant son jeton de rafraîchissement. Le serveur d'autorisation vérifie la validité et génère un autre jeton d'accès qu'il transmet au client, sans que l'utilisateur final n'aît à se connecter de nouveau.

Le principe de fonctionnement du rafraîchissement d'un jeton est le suivant :
* Le jeton d'accès du client est arrivé à péremption. Le client effectue une demande de renouvellement en transmettant son Refresh Token au serveur d'autorisation.
* Le serveur d'autorisation vérifie la validité des informations, "consomme" le jeton de rafraîchissement et génère une nouvelle paire de jetons
* Le client reçoit sa nouvelle paire et utilise le nouveau jeton d'accès pour accéder aux ressources

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Refresh Token | |
+--------------------------------->| |
| | |
| Access (+ Refresh) token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de renouvellement d'un jeton===
Pour obtenir un renouvellement de jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant ''client_id'' reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase ''client_secret'' reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être "refresh_token" (sans guillements).
|-
|scope||string||('''OPTIONNEL''') Liste des droits demandés par le client, séparés par des espaces.
|}

Si la requête est correcte, un jeton d'accès ''access_token'' est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

==Liste des scopes disponibles==
Un scope sur OAuth2 correspond à un droit d'accès sur une ressource particulière. Chaque scope est unique et indique de manière explicite le privilège qu'il donne. Il n'y a aucune restriction d'utilisation des scopes par rapport aux mécanismes. Chaque scope peut être utilisé avec n'importe quel mécanisme. Il n'y a que des recommandations vis à vis de leur utilisation. OpenFlyers définit une liste de scopes dédiée aux ressources accessibles par les clients. Ces scopes sont les suivants :
{| class="wikitable"
!Nom!!Description
|-
|default.login||Comportement par défaut lorsqu'aucun scope n'est précisé ou qu'un scope est invalide. Ce scope est recommandé pour '''Authorization Code'''.
|-
|genericreports.readonly||Accéder aux rapports génériques autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|-
|reports.readonly||Accéder aux rapports personnalisés autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|}
==Prolonger la durée de vie de la session du client de démonstration==
La session du client de démonstration est initiée avec la méthode PHP [https://www.php.net/manual/en/function.session-start.php session_start]. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).

Pour permettre à la session de rester active même après la fermeture du navigateur, il faut utiliser la méthode PHP [https://www.php.net/manual/en/function.session-set-cookie-params.php session_set_cookie_params]. Cette méthode donne la possibilité de définir une durée de vie pour les différents cookies associés à la session.
<php>// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days
$oauth2DemoSessionLifeTime = time() + (86400 * 30);
session_set_cookie_params($oauth2DemoSessionLifeTime);</php>

NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.

==Révocation de token==
Pour initier la demande de révocation, rediriger le navigateur de l'utilisateur vers l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/revoke.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également le paramètre suivant:
{| class="wikitable"
!Nom!!Type!!Description
|-
|access_token||string||Le jeton d'accès (Chaîne de caractère unique permettant de prouver qu'un client OAuth a le droit d'accéder à une ressource.)
|}
<php> apiRequest(
$config['revoke_uri'],
['access_token' => $_SESSION['auth_token']['access_token']],
null,
false
);</php>

La demande de révocation se fait quand l'utilisateur clique sur le bouton '''Se déconnecter''' pour l'un des deux Clients '''Authorization Code''' et '''Client Credentials'''.

Si les jetons sont révoqués, l'utilisateur ne peut pas accéder à la plateforme OpenFlyers, il doit se reconnecter.

==Utiliser l'API==
Une fois un jeton d'accès obtenu, les données sont accessibles par une requête POST exécutée vers l'URL : <code>https://openflyers.com/nom-de-plateforme/oauth/resources.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée. La requête POST doit respecter une structure particulière. Cette structure diffère en fonction du type de ressource souhaité et chaque ressource ne peut être accédée qu'[[#Liste-des-scopes-disponibles|avec le scope qui lui est associé]]. Le jeton d'accès doit être renseigné dans l'en-tête HTTP ''Authorization'' en y indiquant la valeur complète du jeton d'accès reçu précédé du type de jeton reçu : <code>Authorization: <token_type> <access_token></code>.

===Récupérer les informations de l'utilisateur connecté===
Ce type de ressource est nommé '''user_information'''. Cette ressource n'est accessible qu'avec le scope '''default.login'''. Cette ressource permet la récupération des informations de l'utilisateur connecté, en d'autre termes, l'utilisateur connecté lors de l'étape d'autorisation et correspondant à celui ayant émis la demande de jeton d'accès. À l'heure actuelle, seul l'identifiant de l'utilisateur connecté est retourné. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''user_information'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"user_information",
"client_id":"d2615fe2020ec476"
}</javascript>

La réponse est retournée dans un conteneur JSON.

===Récupérer les rapports génériques===
Ce type de ressource est nommé '''generic_report'''. Cette ressource n'est accessible qu'avec le scope '''genericreports.readonly'''. Cette ressource permet la récupération des rapports génériques au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''generic_report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"generic_report",
"client_id":"d2615fe2020ec476",
"report_id":135,
"replacementList":{
"year":2018
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

===Récupérer les rapports personnalisés===
Ce type de ressource est nommé '''report'''. Cette ressource n'est accessible qu'avec le scope '''reports.readonly'''. Cette ressource permet la récupération des rapports personnalisés au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"report",
"client_id":"d2615fe2020ec476",
"report_id":1,
"replacementList":{
"year":2020
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

=Procédures=
==Créer un client à partir du code source==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

;Télécharger Le code source du client de démonstration :

Le code source est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

Le code source est structuré de la manière suivante :

[[File:Oauth2 src demo folder.png|800px]]

* Le dossier '''css''' contient tout le matériel nécessaire à la stylisation de la page web.
* Le dossier '''img''' contient les images affichées sur la page web.
* Le dossier '''ssl''' est le dossier contenant tous les certificats et les clé privées associées à chaque client. Il doit respecter une structure particulière décrite ci-dessous.
* Le fichier '''ClientDemo.php''' contient la classe '''ClientDemo'''. Cette classe contient toutes les méthodes nécessaires au fonctionnement du client de démonstration OAuth2.
* Le fichier '''index.php''' est le fichier à appeler depuis le navigateur. Ce fichier correspond au fichier qui gère les appels à la classe '''ClientDemo''' et exécute les méthodes dans l'ordre.

Le dossier '''ssl''' doit respecter la structure suivante :

[[File:Oauth2 demo tree.png]]

;[[#Générer des certificats|Générer les certificats]] :
Après la génération des certificats, les clés privées 'auth.key' et 'sign.key' remplacent celles présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo'.

;[[#Enregistrer un client|Enregistrer les clients]] :

*Deux clients doivent être créés :
**Le premier pour le mécanisme d'autorisation '''Authorization Code''',
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/AuthCodeDemo/auth.key",
"sign_cert": "path_to_client/ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/AuthCodeDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/ClientCredDemo/auth.key",
"sign_cert": "path_to_client/ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/ClientCredDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Enregistrer un client==
Pour utiliser l'API OAuth2, il faut enregistrer un client OAuth2 auprès d'OpenFlyers. Pour ceci, suivre les étapes suivantes :

;Pour le mécanisme d'authentification Client Credentials
*Créer un [[Gestion-des-profils#Ajouter-un-profil|nouveau profil]]. Ce profil doit permettre de gérer les droits du client OAuth2. Choisir un nom explicite, par exemple "Client OAuth rapports".

*Sélectionner les droits à assigner à ce profil. Ces droits limitent les données auxquelles le client OAuth2 a accès.
**Sélectionner les droits relatifs à l'enregistrement de clients OAuth2 dans l'onglet '''Admin''' (colonne '''Associé aux clients OAuth2''').
**Sélectionner les rapports accessibles par le profil précédemment créé.

*Créer un nouvel utilisateur à partir du panneau de gestion. Cet utilisateur est virtuel et représente le serveur sur lequel fonctionne le client OAuth2.
**''Des identifiant et nom explicites sont recommandés (exemple : "serv1_oauth_client")''
**'''Attention''' : tout utilisateur désactivé et associé à un client OAuth2 rend le client inactif, il faut donc changer l'utilisateur associé au client pour réactiver le client.

;Pour le mécanisme d'authentification Authorization Code
*Aller dans '''Admin > Utilisateurs > Profils'''
*Dans l'onglet '''Généralités''', cocher la case relative à la colonne '''Connexion depuis l'extérieur (OAuth2)''' pour le profil souhaité.

;Créer un nouveau client OAuth2
*Aller dans '''Admin > Transferts > Exports > API OAuth2'''
[[File:Oauth2 manage.png|800px]]
*Cliquer sur le bouton Ajouter '''+''' ou '''Ajouter un client'''
[[File:Oauth2 client creation.png|800px]]
*Choisir un nom pour le client.
*Sélectionner le mécanisme d'autorisation utilisé par le client :
**'''Authorization Code''': permet d'utiliser OAuth2 comme solution SSO ou accéder à des données utilisateurs. Cette méthode peut être couplée avec le mécanisme de mémorisation de connexion (''Refresh Token'').
**'''Client Credentials''': permet d'utiliser OAuth2 dans un contexte d'automatisme.
*Saisir l'URI de redirection vers le client pour le mécanisme ''Authorization Code''.
*Sélectionner l'utilisateur virtuel créé précédemment pour le mécanisme ''Client Credentials''.
*[[#Générer-des-certificats|Générer deux CSR]] afin d'obtenir deux certificats signés et les saisir :
**'''Certificate Signing Request pour le certificat d'authentification''' est utilisé pour l'authentification mutuelle avec mTLS (auth_cert.csr.pem).
**'''Certificate Signing Request pour le certificat de signature''' est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).

[[File:PublicKeysCopyScreen.png|900px]]

*Cliquer sur '''Enregistrer'''.

NB: La validité des certificats générés s'étend sur une période de '''3 années'''.

;Sauvegarder le couple ID/passphrase
Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles,
et Mettre ces identifiants dans le fichier '''config.clientcred.json'''.
[[File:Oauth2 client created.png]]

[[File:ConfigCredJsonScreen.png|600px]]

;Télécharger les certificats crt
Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets '''Certificat d'authentification''' et '''Certificat de signature''' et les mettre dans le dossier '''/ssl''' du client OAuth2.
[[File:Oauth2 client certificates.png]]

;Téléchargez les certificats du serveur.
*Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.
[[File:DownloadServerCertifScreen.png|900px]]
*Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.
*Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:
**Sous Linux, copier le certificat CA d'OpenFlyers dans le dossier <code>/usr/local/share/ca-certificates</code> et exécuter la commande <code>sudo update-ca-certificates</code>
**Sous Windows,
***Double-cliquer sur le certificat CA d'OpenFlyers téléchargé depuis l'interface d'enregistrement des clients OAuth2
***Cliquer sur '''Installer un certificat...'''
***Choisir l'emplacement de stockage (utilisateur ou ordinateur) et cliquer sur '''Suivant''' puis '''Suivant''' et enfin '''Terminer'''

==Générer des certificats==
L'API OAuth2 implémente [https://tools.ietf.org/html/draft-cavage-http-signatures-10 HTTP Signature] et l'[[Wikipedia-en:Mutual_authentication#mTLS|authentification TLS mutuelle]]. Ces mécanismes utilisent chacun une paire certificat/clé privée différente.

Pour obtenir ces certificats, il faut d'abord générer des Certificate Signing Request (CSR).

La procédure est la suivante :
*[[OpenSSL#Installer-OpenSSL-dans-un-environnement-Windows|Télécharger OpenSSL pour Windows]] ou [[OpenSSL#Utiliser-Openssl-d'Apache-sous-WAMP|utiliser Openssl d'Apache sous WAMP]].
*Utiliser les deux fichiers de configuration ''sign_cert.conf'' et ''auth_cert.conf'' ci-dessous et les remplir.

;Fichier de configuration OpenSSL - sign_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
keyUsage = digitalSignature # pour quelles opérations la clé peut-elle être utilisée</pre>

;Fichier de configuration OpenSSL - auth_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
extendedKeyUsage = clientAuth # pour quelles opérations la clé peut-elle être utilisée</pre>

Exécuter les commandes suivantes :
*<bash>openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</bash>
*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>

Ces commandes prennent chacune en entrée le fichier de configuration et génèrent une clé privée et un Certificate Signing Request.

Une fois ces CSR obtenus :
*Les renseigner dans les champs prévus à cet effet lors de la [[#Enregistrer-un-client|création d'un client]] et télécharger les certificats signés depuis l'interface une fois le client créé.
*Garder la clé privée confidentielle. Une fuite poserait un risque de sécurité. Elle va de paire avec le certificat distribué par l'autorité de certification OpenFlyers.

==Mettre en place une connexion à l'API OpenFlyers sur un serveur mutualisé==
;Note
La procédure ci-après est destinée à une mise en place lorsqu'il n'y a pas d'accès SSH en ligne de commande mais uniquement un accès FTP. Dans ce cas, la création des clés privées et publics est effectuée "en local". Dans la procédure suivante elle est effectuée depuis un PC sous '''Windows'''.

;Prérequis
*Posséder les accès FTP :
**Hôte : XXXXXXXXXXXXXXXXXX
**Login : XXXXXXXX
**Mot de passe : XXXXXXXX
**Port : XX (par exemple 21)
*Télécharger Le code source du client de démonstration à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

;Procédure
*[[#Générer des certificats|Générer les certificats]] en local.
*Remplacer les clés privées 'auth.key' et 'sign.key' présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo' par les clés générées.
*[[#Enregistrer un client|Enregistrer les deux clients]] :
**Le premier pour le mécanisme d'autorisation '''Authorization Code'''.
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion.
*Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion.
*Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "./ssl/AuthCodeDemo/auth.key",
"sign_cert": "./ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "./ssl/AuthCodeDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "./ssl/ClientCredDemo/auth.key",
"sign_cert": "./ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "./ssl/ClientCredDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.

*Transférer le fichier "oauth-demo" vers le serveur mutualisé :
**Télécharger [http://filezilla-project.org/download.php?type=client FileZilla].
**Lancer FileZilla.
**Entrer l'URl du serveur mutualisé dans le champ '''Hôte'''.
**Entrer le login dans le champ '''Nom d'utilisateur'''.
**Entrer le mot de passe dans le champ '''Mot de passe'''.
**Entrer le port dans le champ '''Port'''.
**Cliquer sur le bouton Connexion.
**Accéder à l'emplacement du répertoire "oauth-demo" en local à gauche dans l'onglet "Site local".
**Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet '''Site distant''' à droite.
**Glisser et déposer le oauth-demo à l'emplacement choisi.
[[File:Transfer OauthDemo To Shared Server.png|800px]]
*Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php
*Modifier la valeur '''URI de redirection vers le client''' du client '''AuthCodeDemo''' précédemment créé en remplaçant l'ancienne URL par la nouvelle.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Récupérer les données d'un utilisateur==
*Cliquer sur le bouton '''Récupérer les informations utilisateur''', l'identifiant de l'utilisateur s'affiche.
*Utiliser l'identifiant récupérer afin de récupérer toute information associée à cet utilisateur en [[Gestion-des-rapports#Ajouter-un-rapport|créant de nouveaux rapports personnalisés]]

==Utiliser le client==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le client de démonstration se présente de la manière suivante.

[[File:Oauth2-client-demo.png]]

La démonstration est composée de deux colonnes. La première, nommée '''Authorization Code''' correspond [[#Authorization Code|au mécanisme d'autorisation du même nom]]. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée '''Client Credentials''' correspond elle aussi [[#Client Credentials|au mécanisme d'autorisation du même nom]]. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.

;Le mécanisme '''Authorization Code'''
*Cliquer sur le bouton '''Se connecter''' (ce qui redirige le navigateur vers la page de connexion du logiciel OpenFlyers).
*Renseigner les identifiants de l'administrateur pour s'y connecter.
*Nom d'utilisateur : '''admini'''.
*Mot de passe : '''azerty'''.

Une fois les informations saisies, la page suivante est affichée.

[[File:Oauth authorize demo.png]]

*Cliquer sur le bouton '''Autoriser l'application''' pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).

La première colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un nouveau bouton '''Récupèrer les informations utilisateurs''' qui permet de récupérer les informations de l'utilisateur connecté.

;Le mécanisme '''Client Credentials'''
*Cliquer sur le bouton de connexion '''Se connecter''': contrairement à celui du mécanisme '''Authorization Code''', ne redirige pas le navigateur vers la page de connexion du logiciel OpenFlyers. Le bouton de connexion utilise les identifiants du client, ici le couple clé privée/clé publique, pour initier la connexion avec le serveur d'autorisation et obtenir un jeton d'accès.

Une fois la connexion établie, la seconde colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un menu déroulant '''Rapport à récupèrer''' et un nouveau bouton '''Récupèrer le rapport''' qui permet de récupérer les rapports génériques et personnalisés.

Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.

[[File:Oauth2 connected demo.png]]

=Troubleshooting=
==500 Internal Server Error en récupérant le rapport==
La démo utilise les valeurs par défaut pour extraire les rapports. Une erreur 500 indique une "Erreur de syntaxe ou violation d'accès" lors de l'exécution de la requête du rapport. Cela se produit parce que le rapport n'a pas de valeurs par défaut associées, étant donné qu'il n'a jamais été visualisé dans l'interface web. Pour résoudre ce problème, il vous suffit de visualiser le rapport et de cocher la case "Mémoriser ce choix".

==Erreur "File not found."==
Cette erreur se produit lorsque l'URI utilisé n'existe pas sur le serveur OpenFlyers. Vérifier les URIs mis en place dans les fichiers de configuration et essayer de nouveau.

==int_rsa_verify : longueur de signature incorrecte==
Ce problème pourrait survenir si les fichiers ca.cert et sign_cert_server.cert ne proviennent pas du même serveur que celui du client oauth2.
La solution est :

*D'essayer depuis le début l'étape de [[#Générer-des-certificats|génération]] et de [[#Enregistrer-un-client|configuration des certificats]] avec jsut la modification du client existant.

;Si cela ne fonctionne pas:

*Essayez de créer [[#Enregistrer-un-client|un nouveau client]] et refaites la configuration des certificats.

Validités

2024-10-02T17:28:03Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter l'utilisation des validités dans la [[Accueil|version 4 d'OpenFlyers]].

Il existe également une page qui traite du [[paramétrage des validités]].

==Définitions==
Le terme '''validité''' est utilisé par OpenFlyers pour désigner tout ce qui peut constituer une attestation, autorisation, brevet, certificat, diplôme, échelon, expérience acquise, grade, licence, permis, qualification, etc.

Les '''types de validités''' permettent de [[#Paramètres-de-configuration|définir des validités]] qui seront attribuées aux utilisateurs.

La détention par un utilisateur de validités requises peut être vérifié :
*A la connexion de l'utilisateur
*Lors d'une réservation faite pour un utilisateur par lui-même ou un autre utilisateur. OpenFlyers vérifie les validités de l'utilisateur concerné par la réservation.
*Lors d'une saisie d'activité (par exemple lors de la saisie d'un vol pour l'aéronautique).

===Documents-validités===
Document associé à la validité d'un utilisateur et qui permet de démontrer la réelle détention de la validité par un utilisateur. Pour qu'un document soit associable à une validité, le type de validité doit avoir le paramètre [[Paramétrage-des-validités#Associer-un-document|Associer un document]].

Pour un tel type de validité, la [[Paramétrage-des-validités#Certification|certification]] est en général activée pour permettre la validation du document par un gestionnaire.

===Validité à expérience===
Un type de validité est une validité à expérience lorsque le champ de paramétrage du type de validité [[#Formule-d'expérience|formule d'expérience]] contient une formule. Dans ce cas, la validité n'est pas attribuable à un utilisateur. C'est l'expérience de l'utilisateur, c'est à dire son activité passée vérifiée par la formule d'expérience, qui définit si l'utilisateur détient cette validité.

===Validité à vendre===
Une validité à vendre est une validité qui est couplée à un [[Gestion-des-produits-et-des-ventes#Configuration-d'un-produit-Validité|produit en vente]].

===Validité complète===

Une validité est complète lorsque tous les points suivants sont réunis :

* Si la date d'expiration est requise, elle doit être renseignée.
* Si le code identifiant est requis, il doit être renseigné.
* Si la date d'obtention est requise, elle doit être renseignée.
* Si un document peut être associé, les pages obligatoires (s'il y en a) doivent être téléversées.

===Validité contrat===
Une validité contrat est un validité qui a été déclarée comme contrat. Un contrat est une validité avec un document défini, le but est de permettre de mettre en ligne un document que les utilisateurs doivent signer.

Un utilisateur qui n'a pas signé ses contrats ne peux pas se connecter. Il a la possibilité de signer ses contrats lors de ses tentatives de connexion.

Un contrat signé est stocké en base de données avec le nom et l'adresse IP du signataire ainsi que la date et l'heure de signature.

Suivre [[Paramétrage-des-validités#Paramétrer-une-validité-comme-contrat|cette procédure]] pour mettre en place des contrats.

Voir également la procédure de [[Connexion#Signer-des-validités-contrats|signature des validités-contrats]].

=Alertes sur les validités=
==Alerte à la connexion==
Les validités contrôlées à la connexion sont uniquement :
*celles possédées par l'utilisateur qui se connecte et qui sont soumises à échéance
*les validités à expérience récente.

Ainsi, les validités sans échéance ne sont pas contrôlées.

OpenFlyers affiche un message d'alerte pour les validités dont la date d'échéance est expirée ou va expirer dans un délai inférieur à la période d'alerte définie dans la fiche utilisateur. L'utilisateur a la possibilité de cliquer sur la case à cocher "Ne plus le rappeler" afin de ne plus avoir de message de rappel. Dans ce cas, lors des connexions ultérieures, il n'aura plus de message de rappel. Il peut cependant réactiver cette alerte en la réactivant dans la colonne "Alertes" de la ligne correspondante dans '''Planning > Données > Personnelles > Validités'''. Cette réactivation est automatique lors d'une modification de la validité.

==Alertes lors d'une réservation ou une saisie d'activité==
Les [[Gestion-des-activités#Alertes|alertes suivantes sont générées lors de la saisie d'une activité]] ou d'une réservation.

Les validités périmées apparaissent systématiquement lors de la saisie d'une réservation ou d'une activité comme à la connexion. Leur affichage ne dépend pas du type de ressource. C'est juste un rappel.

Ce rappel est notamment utile lorsqu'une personne effectue une réservation ou une saisie de vol pour le compte d'un tiers. Cela lui permet d'être informé et d'informer ce tiers de sa situation.

==Alertes sur la page listant les validités d'un utilisateur==
*Alerte de cellule vide alors qu'elle devrait être remplie : la cellule affiche une bordure et un panneau rouges.
*[[#Alertes-d'expiration|Alertes d'expiration]]

==[[Envoi-des-emails#Email-de-rappel-d'échéance-de-validité|Email de rappel d'échéance de validité]]==

=Certifier des validités=
La certification permet à une structure d'attester qu'une validité saisie dans OpenFlyers a été vérifiée.

Lorsqu'un document est associé à une validité, cela permet d'indiquer que le document a été vérifié et que les données saisies correspondantes à la validité sont conformes au document téléversé. Cela permet également d'indiquer que le document est valide.

Un document-validité, une fois certifié, n'est plus modifiable, ni par l'utilisateur à qui correspond la validité ni par un gestionnaire de la structure. Cela permet de garantir la pérennité et l'inviolabilité de la certification.

Un document-validité peut être certifié de 2 façons :
*Soit manuellement par un gestionnaire disposant des droits de certification du document
*Soit par un robot dans le cas où le robot dispose d'un modèle du type de document à certifier.

Voir le [[Paramétrage-des-validités#Certification|paramétrage de la certification d'un type de validité]] pour définir les validités qui peuvent être certifiées et la colonne [[Gestion-des-profils#Types-de-validités-que-l'utilisateur-peut-gérer-et-certifier|Types de validités que l'utilisateur peut gérer et certifier]] dans la gestion des profils pour définir ceux qui peuvent certifier.

==Certification manuelle==
;Pré-requis
Pour pouvoir certifier une validité, un utilisateur doit disposer du [[Gestion-des-profils#Types-de-validités-que-l'utilisateur-peut-gérer-et-certifier|droit de certifier la validité concernée]]

;Procédure
Pour certifier manuellement une validité, il faut soit :
*Passer par l'interface de gestion des [[#Validités-en-attente-de-certification|validités en attente de certification]] :
**Vérifier les informations des validités en attente, corriger si besoin
**Quand une validités est conforme, cliquer sur certifier
*Passer par le menu de gestion individuelle des validités des utilisateurs :
**Aller sur la page de gestion des validités des utilisateurs dans '''Gestion > Utilisateurs > Actifs'''
**Chercher l'utilisateur dont la validité est à certifier puis dans la colonne action cliquer sur l'icône "Editer les validités de l'utilisateur"
**Sur la page qui s'ouvre, contrôler les informations de la validité puis cliquer sur le bouton dans la colonne "Certifier"

==Certification automatique==
===Certification automatique à partir du numéro de licence délivré par la [https://www.ffa-aero.fr Fédération Française Aéronautique]===
Cette certification est active lorsque le type de validité est paramétré avec le [[Paramétrage-des-validités#Certification|type de certification '''Par API FFA''']].

;Certification automatique
Lorsque la validité est nécessaire, à la connexion, lors de la réservation en solo ou lors d'une saisie d'activité en solo, si la validité n'est pas déjà certifiée ou si elle est périmée, le robot OpenFlyers interroge l'API SMILE FFA pour vérifier la validité de la licence.

;Réactualisation manuelle
Il est possible de forcer la réactualisation de la certification en appuyant sur l'icône de mise à jour qui apparaît dans la colonne '''Actions''' de la liste des validités, cela permet d'appeler le robot OpenFlyers qui interroge l'API SMILE FFA pour vérifier la validité de la licence.

Le bouton n'est actif que si l'une des conditions suivantes est rencontrée :
*La date d'échéance de la validité est dépassée
*La date courante est supérieure ou égale au 1er octobre et l'année de la date d'échéance est l'année en cours

;Interrogation de l'API SMILE FFA par le robot OpenFlyers
*Si la date actuelle est comprise entre le 1er octobre et le 31 décembre, le robot interroge l'API SMILE FFA pour l'année suivante (N+1).
*Si la licence est valide pour l'année suivante, le robot certifie automatiquement la validité en mettant à jour la date d'échéance de la validité au 31/12 de l'année suivante.
*Si la licence n'est pas valide pour l'année suivante ou si la date actuelle est antérieure au 1er octobre, le robot OpenFlyers interroge à nouveau l'API SMILE FFA pour l'année en cours afin de vérifier la validité de la licence:
**Si la licence est valide, le robot certifie automatiquement la validité en mettant à jour la date d'échéance de la validité au 31/12 de l'année renvoyée par l'API FFA
**Si la licence n'est pas valide, le robot certifie automatiquement la validité en mettant à jour la date d'échéance de la validité au 31/12 de l'année précédente à l'année courante.

Un document peut-être associé à la validité. Il n'est pas pris en compte pour la certification.

===Certification automatique de l'attestation délivrée par la [https://www.ffa-aero.fr Fédération Française Aéronautique]===
Cette certification est active lorsque le type de validité est paramétré avec le [[Paramétrage-des-validités#Certification|type de certification '''Possible par robot (FFA)''']].

Le robot d'OpenFlyers est capable d'analyser les fichiers PDF correspondant aux attestations de licence délivrées par la [https://www.ffa-aero.fr Fédération Française Aéronautique (FFA)]. Chaque pilote licencié à la FFA peut récupérer ce document sur le site web [http://projet.ff-aero.fr/SMILE_II/ SMILE]. Le robot extrait du document :
*Le numéro de licence de l'utilisateur
*Les noms et prénom de l'utilisateur
*La date de naissance de l'utilisateur
*La date de début de validité la licence FFA
*La date de fin de validité de la licence FFA
*La présence de l'assurance "Individuelle Accident de base" avec l'attribut "Oui"

Ces informations lui permettent de valider que le document est conforme et correspond à l'utilisateur pour qui le document a été téléversé. Il se base sur le nom et la date de naissance.

Lorsque la correspondance est établie, il met à jour la validité avec les données suivantes :
*Le numéro de licence
*La date de début de validité
*La date de fin de validité

Quand un document est sélectionné les champs mis à jour disparaissent dans le formulaire de saisie, car les données seront extraite du document.

===Licence de pilote privé (PPL)===
''(en développement)''

La certification de ce type de validité n'est en fonction que lorsque la [[Paramétrage-des-validités#Certification|certification]] de ce type de validité est activé avec le choix '''Possible par OCR'''.

Un deuxième robot d'OpenFlyers permet d'analyser les fichiers PDF ou JPEG qui correspondent aux Licences de Pilote Privé (PPL).

Les champs détéctés par le robot sont :
*Les noms et prénoms
*Le numéro de la licence
*L'intitulé de la licence
*La date de validité de la licence

Déroulement de la procédure :
*Quand un document est téléversé, la détéction commence automatiquement.
*A l'issue du traitment, quatre champs remplis des données résultantes du traitement par le robot apparaîssent. Des boutons de confirmations apparaîssent aussi en dessous de chaque champ :
*A ce stade, l'utilisateur est amené à '''effectuer certaines actions''' avant de pouvoir valider le formulaire de saisie. '''Il doit vérifier si les résultats sont correctes puis les confirmer ou les corriger''' sinon :
**Si l'utilisateur corrige le champ, le bouton de confirmation est remplacé par le message "Vous avez corrigé ce champ".
**Si l'utilisateur remet le résultat initial dans le champ, le bouton de confirmation réapparaît sous le champ à la place du message.
**Si l'utilisateur est en train de modifier un champ, des points de suspension sont affichés en dessou du champ réspectif.
Les champs sont toujours modifiables. C'est-à-dire, l'utilisateur peut corriger un champ même après l'appui sur le bouton de confirmation.

Dans tous les cas, la validation du formulaire n'est possible que si l'utilisateur a '''corrigé''' ou '''validé''' tous les champs.

=Consulter et gérer ses validités ou celles d'un tiers=

L'interface de gestion des validités est accessible :
*côté planning : '''Planning > Données > Personnelles > Validités'''
*côté Gestion :
*'''Gestion > Utilisateurs > Validités'''
*'''Gestion > Utilisateurs > Actifs''' et cliquer sur l’icône représentant une check-list dans la colonne '''Actions'''.

Conditions pour consulter et gérer ses validités :
*Pour consulter ses validités un utilisateur doit posséder le droit [[Gestion-des-profils#Voir-ses-validités|Voir ses validités]].
*Un utilisateur peut gérer pour lui-même les validités qui sont définies dans le droit [[Gestion des profils#Type-de-validité-que-l'utilisateur-peut-gérer-pour-lui-même|Type de validité que l'utilisateur peut gérer pour lui-même]].
*Pour qu'un utilisateur soit autorisé à ajouter une nouvelle validité, il doit détenir le droit [[Gestion-des-profils#Ajout-et-gestion-de-ses-validités|Ajout et gestion de ses validités]].
*Pour qu'un utilisateur soit autorisé à renouveler une validité détenue ou à mettre à jour le '''Code identifiant''', la '''Date d'obtention''', la '''Limite de validité''' (d'une validité non achetable) ou à supprimer une validité, il doit détenir le droit [[Gestion-des-profils#Ajout-et-gestion-de-ses-validités|Ajout et gestion de ses validités]] ou le droit [[Gestion-des-profils#Gestion-de-ses-validités-détenues|Gestion de ses validités détenues]].
*Pour qu'un utilisateur soit autorisé à acheter ou renouveler une validité-produit, il doit détenir le droit [[Gestion des profils#Achat-ventes-libres|Achat ventes libres]] et le produit associé à la validité doit être en vente libre.

Conditions pour consulter et gérer les validités d'un tiers :
*Un utilisateur peut consulter et gérer les validités qui sont définies dans le droit [[Gestion des profils#Type-de-validité-que-l'utilisateur-peut-gérer-pour-lui-même|Types de validités que l'utilisateur peut gérer et certifier]].
*Pour qu'un utilisateur soit autorisé à ajouter une validité à vendre à un autre utilisateur, il doit détenir le droit [[Gestion-des-profils#Acheter-pour-les-tiers|Acheter pour les tiers]]

Il est possible d'afficher uniquement les validités nécessaires en sélectionnant un filtre :

[[File:selecteur-validités.png]]

Il est donc possible d'afficher uniquement :
*les validités qui peuvent être certifiées
*les validités effectives ([[#Prise-en-compte-d'une-validité|prises en compte]])

Si les validités de tous les utilisateurs sont affichées, il est possible d'afficher uniquement les validités d'un certain type grâce au sélecteur présent en haut à droite de la page. Si tous les types de validités sont affichés, alors il est uniquement possible d'afficher les validités qui peuvent être certifiées.

Pour renouveler une validité détenue, il faut éditer la validité en appuyant sur l'icône crayon qui apparaît dans la colonne '''Actions'''. Une fois sur le formulaire d'édition de la validité concernée un bouton '''Renouveler la validité''' est affiché. Cliquer dessus puis valider.

Lorsqu'un type de validité est configuré pour y [[Paramétrage-des-validités#Associer-un-document|associer un document]], l'utilisateur peut [[#Téléverser-un-fichier|téléverser un fichier]]. Une fois le fichier téléversé, il est téléchargeable.

Dans le tableau de la liste des validités, l'utilisateur concerné, peut voir qui et quand ont été certifiées ses validités. Il retrouve aussi les [[#Validité-contrat|validités-contrats]] qu'il a [[Connexion#Signer-des-validités-contrats|signé à la connexion]].

Si l'utilisateur peut gérer les validités de tiers, une liste déroulante '''Utilisateur''' apparaît au-dessus du tableau. Si la valeur '''Tous''' est sélectionné seules les validités à certifier sont affichées. De plus, une colonne ''Nom du titulaire'' est ajoutée et la colonne ''Alerte ?'' ainsi que le champ ''délai de prévenance'' sont cachés. Si on sélectionne un utilisateur autre que soi-même la colonne ''Alerte ?'' et le champ ''délai de prévenance'' sont cachés.

Remarques :
*Les validités arrivées à échéance apparaissent sur fond orange.
*Lorsqu'une validité n'est pas certifiée la cellule '''Etat de certification''' apparaît sur fond orange.
*La mise à jour de la date d'échéance d'une validité réactive automatiquement la cellule de la colonne [[#Alertes-d'expiration|Alertes ?]] si celle-ci n'est pas modifié lors de la saisie dans le formulaire.
*Une validité-produit déjà détenue ne peut pas être supprimée.

==Alertes d'expiration==
Il existe deux types d'alertes liées à l'expiration d'un validité :
*Lorsque la date limite d'une validité est bientôt atteinte, une '''alerte avant échéance''' apparaît. Celle-ci s'affiche sous la forme d'une cellule à bordure orange et contenant un panneau orange.
*Lorsque la date limite d'une validité est dépassée, une '''alerte de validité expirée''' apparaît. Celle-ci s'affiche sous la forme d'une cellule à bordure et contenant un panneau rouges.

La case '''Alerte ?''' dans le formulaire de gestion d'une validité permet à un utilisateur d'activer ou désactiver les '''rappels à la connexion''' des validités arrivant à expiration ou ayant expiré.

Le délai de rappel des validités arrivant à expiration est visible dans le champ '''Délai de prévenance en semaines avant chaque échéance''' sous le tableau listant les validités d'un utilisateur. L'utilisateur connecté peut modifier son propre délai. Dans ce cas, ce champ affiche un menu déroulant dans lequel l'utilisateur connecté peut changer le délai. Par ailleurs, pour chaque activité, la case '''Alerte''' doit être cochée.

==Ajouter une validité à un utilisateur==
*[[#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|Accéder à l'interface de gestion des validités]]
*Sélectionner la validité à ajouter et valider.
*Saisir les données dans le formulaire et valider

Si la validité est une [[#Validité-à-vendre|validité à vendre]], l'utilisateur sera automatiquement débité du montant correspondant. Les écritures comptables générées correspondantes sont validées. L'objectif est d'empêcher la réversibilité de cette opération par un utilisateur qui aurait souscrit à une validité. Cela permet de garantir la traçabilité des engagements.

Il est néanmoins possible de [[#Supprimer_la_validité_d'un_utilisateur|supprimer une validité]] à vendre indument attribuée.

Il est également possible de débrayer la vente an cliquant sur le toggle-switch '''Débrayer la vente''' afin que le compte ne soit pas débité. Cela nécessite d'avoir le [[Gestion-des-profils#Débrayage-des-ventes-de-validités|droit de débrayage]].

===Téléverser un fichier===
Lorsqu'un type de validité est configuré pour y [[Paramétrage-des-validités#Associer-un-document|associer un document]], le téléversement des fichiers se fait comme suit :
*L'utilisateur téléverse le fichier
Ensuite :
*S'il s'agit d'un fichier image, il est stocké en base de données.
*S'il s'agit d'un PDF contenant du texte, le PDF est stocké en base de données.
*S'il s'agit d'un PDF qui contient une seule image, celle-ci est extraite du PDF et est stockée en base de données.
*S'il s'agit d'un PDF qui contient plusieurs images, seule la première image est extraite du PDF et stockée en base de données.
*Si le fichier est vide (ne contient ni texte ni image), une alerte utilisateur [[Alertes-utilisateur#Le-contenu-du-fichier-est-vide.-Le-fichier-n'as-pas-pu-être-téléchargé|indiquant que le contenu du fichier est vide]] est affichée à l'écran. Le fichier ne peut pas être téléversé.
Dans un cas particulier où l'image encapsulée dans le PDF se compose de plusieurs masques transparents, OpenFlyers convertit l'ensemble de la page du PDF en une image jpeg. Dans le cas où plusieurs images sont encapsulées dans le fichier sur plusieurs pages, seule la première page est extraite.

Les fichiers téléversés sont stockés directement en base de données sous réserve d'être conforme aux règles de téléversement ci-dessous :
*Formats des fichiers autorisés : GIF, JPEG, PNG et PDF. Si le fichier téléversé n'est pas dans l'un de ces formats, [[Alertes-utilisateur#Ce-n'est-pas-un-fichier-de-type-:-gif,-jpeg,-png,-pdf|un message d'alerte correspondant]] s'affiche à l'écran.
*Poids maximal autorisé au moment du téléversement : 10 Mo.
*Poids maximal autorisé pour le stockage : 500 ko. Si le fichier téléversé dépasse les 500 Ko, il est redimensionné dans le cas où c'est une image. Si le fichier est toujours trop gros, alors il est refusé et le [[Alertes-utilisateur#La-taille-maximale-d'un-fichier-est-500ko|message d'alerte correspondant]] s'affiche.

Récapitulatif :

[[File:traitement-apres-televersement.png|800px]]

==Modifier la validité d'un utilisateur==
*[[#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|Accéder à l'interface de gestion des validités]]
*Les modifications s'effectuent via le formulaire d'édition d'une validité accessible depuis l'icône crayon dans la colonne '''Actions''' du tableau.

''Note :''
*Avant de faire un enregistrement en base de données, OpenFlyers vérifie s'il y a des modifications par rapport au dernier enregistrement actif de la même validité pour le même utilisateur.
*Les cellules non renseignées sont en rouges. Lors de l'édition via le formulaire, les champs associés sont également en surbrillance rouge.

Dans le cas d'une [[#Validité-à-vendre|validité à vendre]], la limite de validité n'est pas modifiable. Afin de l'augmenter, il faut passer par un renouvellement. Il est également possible de la modifier manuellement (à condition de disposer du [[Gestion-des-profils#Débrayage-des-ventes-de-validités|droit de débrayage]]) en cliquant sur l'interrupteur '''Débrayer la vente'''.

==Supprimer la validité d'un utilisateur==
*[[#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|Accéder à l'interface de gestion des validités]]
*Les suppressions s'effectuent directement sur la ligne de la validité concernée en cliquant sur l'icône poubelle de la validité associée.

;Dans le cas où la ligne de la validité concernée ne dispose pas de l'icône poubelle
Cela veut dire que [[Gestion des produits et des ventes#Configuration_du_produit_Validité_"Cotisation"|la validité est à vendre]]. Il faut effectuer la procédure suivante :
*Si l'utilisateur a été indument débité, il faut [[Utilisation de la comptabilité#Annuler_l'effet_d'une_écriture_comptable|annuler l'effet d'une écriture comptable]] correspond au montant facturé qui n'aurait pas du l'être
Supprimer la vente de validité de façon temporaire :
*'''Admin > Ventes > Produits > Validités à vendre'''
*Repérer la ligne qui lie le type de validité concerné avec un produit
*Copier la '''Formule de calcul de la date d'expiration''' de la ligne concernée et la coller dans un fichier texte temporaire pour la récupérer ultérieurement
*Noter le nom du produit associé
*Supprimer la ligne
*Supprimer la validité de l'utilisateur concerné (cf. début de la présente procédure)
Remettre en place la vente du type de validité :
*'''Admin > Ventes > Produits > Validités à vendre'''
Sur la dernière ligne :
*Champ '''Validité''' : sélectionner le nom du type de validité concerné
*Champ '''Produit''' : sélectionner le nom du produit associé
*Champ '''Formule de calcul de la date d'expiration''' : recoller la formule de calcul
*Cliquer le bouton '''Ajouter'''.

=Contrôle des validités=
==Contrôle des validités à la connexion==
Dès que l'utilisateur est identifié, un contrôle de ses validités est effectué. Les validités contrôlées sont uniquement celles que possède l'utilisateur et qui sont soumises à échéance ou les validités à expérience récente.

Le paramétrage du contrôle des validités s'effectue au travers de 2 champs :
*le champ '''[[Paramétrage-des-validités#Alerte-à-la-connexion|Alerte à la connexion]]''' qui définit le comportement que l'application OpenFlyers doit adopter à la connexion
*le champ '''[[Paramétrage-des-validités#Soumise-à-échéance|Soumise à échéance]]''' qui doit être attribué. S'il n'y a pas d'échéance, alors il n'y a pas de contrôle de validité de l'échéance à la connexion

==Contrôle des validités lors de la saisie d'une réservation==
Lors d'une réservation, OpenFlyers contrôle les validités détenues par la personne occupant la 1ère place dans la ressource '''et seulement s'il n'y a qu'une seule personne pour cette réservation'''. OpenFlyers vérifie également pour cette personne si des validités ne vont pas expirés avant la date de fin de la réservation. Les validités détenues doivent correspondre aux validités demandées pour le type de ressource correspondant à la ressource réservée et aux validités demandées pour les types d'activités sélectionnés.

Il y a 3 comportement possibles :
*Pas de contrôle des validités.
*Une [[Présentation-générale-des-alertes#Alerte-orange|alerte non bloquante]] dans le cas où il manque une ou plusieurs validités.
*Une [[Présentation-générale-des-alertes#Alerte-rouge|alerte bloquante]] dans le cas où il manque une ou plusieurs validités.

Le comportement est le même pour toutes les validités.

==Contrôle des validités lors de la saisie d'une activité==
Lors de la saisie d'une activité, OpenFlyers effectue 2 contrôles :
#'''S'il n'y a qu'une seule personne pour cette activité''', le logiciel vérifie la présence des validités requises pour la ressource utilisée et les types d'activités sélectionnés. Il y a 2 comportements possibles pour chaque validité manquante :
#*Une [[Présentation-générale-des-alertes#Alerte-orange|alerte non bloquante]].
#*Une [[Présentation-générale-des-alertes#Alerte-rouge|alerte bloquante]].
#:Il y a un [[Paramétrage-des-validités#Paramétrer-le-contrôle-des-validités-pour-la-saisie-des-activités|paramétrage général]] qui définit si toute validité manquante doit entrainer un blocage. Si ce n'est pas le cas, alors cela dépend du paramétrage associé à chaque type de validité grâce à la case à cocher [[Paramétrage-des-validités#Validité-bloquante-pour-la-saisie-des-activités-(si-requise)|Validité bloquante pour la saisie des activités (si requise)]].
#OpenFlyers affiche une alerte pour les validités périmées [[#Contrôle_des_validités_à_la_connexion|comme à la connexion]].

=Débrayer la vente d'une validité=
Débrayer la vente d'une validité consiste à modifier la date limite d'une validité sans déclencher de vente afin que l'utilisateur concerné ne soit pas débité.

;Prérequis :
Pour pouvoir débrayer la vente d'une validité, le gestionnaire doit disposer du droit [[Gestion-des-profils#Débrayage-des-ventes-de-validités|débrayage des ventes de validités]].

;Procédure pour attribuer une nouvelle validité sans la vendre :
*'''Gestion > Utilisateurs > Utilisateurs > Validités'''
*Sélectionner en haut à gauche, dans la liste des utilisateurs, l'utilisateur concerné
*Sélectionner en haut à droite, dans la liste des validités, la validité à attribuer
Si la validité est une validité à vendre, alors apparait à côté de la liste, un interrupteur
*Cliquer sur cet interrupteur '''Débrayer la vente'''
Le bouton '''Acheter''' se transforme en '''Ajouter'''
*Cliquer sur le bouton '''Ajouter'''
*Compléter le formulaire, notamment la '''Limite de validité'''
*Cliquer sur le bouton '''Enregistrer'''

;Procédure pour modifier la limite validité d'une validité déjà attribuée sans la vendre :
*'''Gestion > Utilisateurs > Utilisateurs > Validités'''
*Sélectionner en haut à gauche, dans la liste des utilisateurs, l'utilisateur concerné
Les validités attribuées à l'utilisateur apparaissent
*A droite de la ligne de la validité à modifier, cliquer sur le pictogramme avec le symbole de l'euro barré et un crayon
Le formulaire d'édition de la validité apparait
*Modifier le champ '''Limite de validité'''
*Cliquer sur le bouton '''Enregistrer'''

=Historique des validités=
Une validité possède un historique contenant tous les états par lesquels elle est passée.
Chaque changement effectué sur une validité entraîne automatiquement une entrée dans l'historique.

L'historique d'une validité est conservé même si la validité est supprimée, il sera consultable si une nouvelle validité du même type est créée pour le même utilisateur.

Il est possible de consulter les anciens fichiers contenus par la validité mêmes s'ils ont été remplacés.

Les fichiers validités téléversés sont comparés. S'ils sont identiques, alors seul l'ancien fichier est conservé. Cela permet de limiter l'augmentation de la taille de la base de données.

==Afficher l'historique des validités==
Pour afficher l'historique des validité :
*Aller sur l'[[#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|interface de gestion des validités d'un utilisateur]].
*Cliquer sur le nom de la validité dans la colonne de gauche du tableau pour ouvrir la page d'historique.
L'historique s'affiche chronologiquement, du changement le plus récent au plus ancien.

=Lister les détenteurs d'un type de validité=
*Aller sur '''Admin > Utilisateurs > Types de validités'''
*Cliquer sur l'icône symbolisant une liste dans la colonne '''Liste''' de la ligne correspondante à la validité concernée.

Le tableau liste les personnes ayant la validité correspondante.

Lorsque la validité est soumise à échéance, la liste fait ressortir en rouge sur fond gris les dates d'échéances périmées.

Lorsque la validité est une validité à expérience, la liste contient uniquement les utilisateurs remplissant les critères de la formule d'expérience.

=Prise en compte d'une validité=

Une validité prend effet lorsque tous les points suivants sont réunis :

* La validité doit être [[#Validité-complète|complète]].
* Si une date d'expiration est présente, elle ne doit pas être dépassée.
* Si la [[#Certifier-des-validités|certification]] est possible, la validité doit être certifiée.

=Validités en attente de certification=

*[[#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|Accéder à l'interface de gestion des validités]]
*Par défaut le filtre ''Utilisateur'' est sélectionné sur ''Tous'' ce qui permet de visualiser toutes les validités que l'utilisateur peut certifier.

Il est possible de consulter et modifier les renseignements rentrés par les utilisateurs, dans le cas où les informations sont valides, l'utilisateur peut certifier la validité.

Une fois certifiée, la validité reste encore visible 24h, ainsi il est encore possible de corriger la validité si une erreur apparaît.

Cette page est accessible en suivant le lien contenu dans [[Envoi-des-emails#E-mail-de-demande-de-certification-de-validité|l'e-mail de notification]] envoyé automatiquement aux utilisateurs disposant du [[Gestion-des-profils#Types-de-validités-que-l'utilisateur-peut-gérer-et-certifier|droit de certifier la validité concernée]].

Trucs et astuces

2024-10-02T17:28:03Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__
=Présentation=
L'objet de cette page est de présenter des trucs et astuces généraux et indépendants de l'utilisation d'[[Accueil|OpenFlyers]] .

=Administration réseau=
==Trouver l'adresse IP du routeur==
Pour connaître l'adresse IP d'une passerelle (box ou routeur).
===Trouver l'adresse IP du routeur freebox à distance===
*Aller sur le site de [http://www.free.fr free].
*Cliquer sur '''Mon compte'''
*Saisir l'identifiant et le mot de passe du compte pour lequel on souhaite connaitre l'adresse IP
*Aller sur '''Ma Freebox > Afficher mon adresse IP'''
*L'adresse IP est indiquée dans le champ '''Votre adresse IP :'''
Cette adresse IP dite "fixe" est présente avec le message '''Ceci est votre adresse IP, pour les abonnés dégroupés ainsi que les abonnés IPADSL ayant demandé une IP Fixe'''

===Trouver l'adresse IP du routeur sous Windows===
*[[#Ouvrir_une_console_sous_Windows|Ouvrir une console]]
*Taper ''ipconfig /all'' pour afficher la structure de la connexion au réseau.
*L'adresse du routeur est indiquée à la ligne '''passerelle par défaut''' de la '''carte Ethernet''' du PC pour une connexion par câble RJ45 ou sous la '''carte WLAN''' pour une connexion sans fil (par exemple wifi).

===Trouver l'adresse IP du routeur par l'interface graphique de Windows 7===
*Cliquer sur le bouton '''Démarrer'''
*cliquer sur '''Panneau de configuration'''
*Cliquer sur '''Réseau et Internet'''
*Cliquer sur '''Centre de réseau et partage'''
*Cliquer sur '''Afficher l'intégralité du réseau''' dan
*Survoler l’icône Passerelle : l'adresse IP du matériel apparait dans le popup

[[File:Reseau_W7.jpg]]

===Sous Linux===
*Ouvrir une console
*Taper « netstat -r -n »
*L'adresse IP est dans la colonne Passerelle (Gateway en Anglais)

[[File:Reseau_Linux.jpg]]

==Monitoring d'une freebox==
*http://mafreebox.freebox.fr/pub/fbx_info.txt

=Connexion à un routeur=
==Connexion à distance à une livebox==
Prérequis :
*la livebox doit avoir été configurée pour permettre une contrôle à distance
*Il faut connaitre l'adresse IP externe de la livebox, soit parce qu'elle est fixe, soit parce qu'un service Dynamic DNS a été mis en place

*Dans un navigateur saisir l'URL pour accéder à la livebox. Cette URL doit être écrite avec "https://" suivie de l'adresse IP externe de la livebox suivie de ":10000" qui correspond au port par défaut proposée par la livebox lors de la mise en place d'une connexion à distance. Cela donne une URL sous la forme : https://X.X.X.X:10000
*Dans le champ '''identifiant''', saisir l'identifiant créé pour la connexion à distance
*Dans le champ '''mot de passe''', saisir le mot de passe créé pour la connexion à distance
*Cliquer sur le bouton '''s'identifier'''

=Console=
Une console est une fenêtre en ligne de commande.
==Copier/Coller dans une console==
====Copier/Coller dans une console sous Windows====
Vous pouvez faire un copier/coller en utilisant le bouton droit de la souris dans la fenêtre de l'invite de commandes puis en choisissant '''sélectionner''' et ensuite en appuyant sur le bouton gauche et en le laissant appuyer tout en sélectionnant la zone souhaitée)

====Copier/Coller dans une console sous Mac====
Pour faire un copier/coller de ces informations et nous les communiquer, il suffit d'utiliser commande-C dans le terminal.

==Ouvrir une console==
===Ouvrir une console sous Mac===
Sous OSX (mac) il faut lancer un Terminal. Pour cela 2 solutions :
*Taper "terminal" dans spotlight
ou
*lancer l'application qui est dans Applications > Utilitaires.

===Ouvrir une console sous Windows 7===
*Cliquer sur le bouton '''Démarrer'''
*Dans le champs '''Rechercher''' taper ''cmd'' puis sélectionner le fichier '''cmd.exe'''.
*Taper sur la touche "Entrer" pour ouvrir la console DOS.

===Ouvrir une console sous Windows 8===
*Aller avec le pointeur de la souris dans le coin inférieur gauche de l'écran
*Le petit rectangle '''Accueil''' doit s'afficher : cliquer sur le bouton droit de la souris
*Un menu contextuel doit s'afficher : cliquer sur l'item '''Exécuter'''
*Une fenêtre '''Exécuter''' doit s'ouvrir. Taper ''cmd'' dans le champ '''Ouvrir''' et valider avec la touche "Entrer" pour ouvrir la console DOS.

=Editer un fichier texte=
Nous recommandons l'utilisation de l'outil [[Wikipedia-en:Notepad%2B%2B|Notepad++]] pour visualiser ou modifier un fichier texte depuis un ordinateur sous système d'exploitation Windows.

=Effectuer une copie d'écran=
Nous recommandons l'utilisation de l'outil [[Wikipedia-en:Greenshot|Greenshot]] pour effectuer une copie d'écran depuis un ordinateur sous système d'exploitation Windows.

Une fois le logiciel installé et lancé, il suffit d'appuyer sur la touche "Imp. écr" du clavier pour lancer la copie d'écran. Greenshot vous permettra alors de sélectionner la zone à copier puis vous proposera de sauvegarder le fichier.

Lorsque la copie d'écran doit être envoyée par e-mail ou ajouter dans un rapport de bug, il est indispensable de la communiquer sous son format d'origine c'est à dire au format png ou jpg. Surtout, ne mettez pas vos copies d'écran dans un document texte : cela rend son exploitation difficile.

=Modifier le comportement de la souris=
Voici les procédures pour modifier le comportement de la souris, et notamment le "clic molette" dont nous recommandons l'usage dans la [[Documentation utilisateur#Clic_droit_et_clic_molette|version 3]] d'OpenFlyers :
*Sur Windows : http://windows.microsoft.com/fr-fr/windows/change-mouse-settings#1TC=windows-7
*Sur Mac OS : http://support.apple.com/fr-fr/HT2490

=[[Navigateurs]]=

=Tableurs=
Les procédures suivantes décrites pour LibreOffice sont normalement identiques sous OpenOffice et existent également sous Word ou Excel mais avec des commandes différentes.

==Afficher uniquement un certain type de lignes sous LibreOffice==
Cas pratique : lors de l'import des à nouveaux, lorsqu'il existe plusieurs types de comptes par utilisateur, il peut être intéressant de n'afficher que les lignes d'un seul type de compte à la fois

Dans LibreOffice, une fois que le document à traiter est ouvert :
*'''Données > AutoFiltre'''
Cela fait apparaitre à droite de chaque cellule de la première colonne une flèche
*Cliquer sur la flèche correspondante à la cellule dont on souhaite restreindre les types de données visibles (exemple : cellule "account_type_name" pour ne faire apparaitre qu'un seul type de compte)
*Sélectionner/désélectionner les types de données à faire apparaitre/disparaitre

==Afficher un total d'heures sous LibreOffice==
Cas pratique : lorsqu'on effectue une somme de plusieurs heures, si cette somme dépasse 24h l'affichage par défaut est incohérent.

Dans LibreOffice :
*Survoler la cellule qui contient le total des heures
*Clic droit
*Dans le menu contextuel '''Formater des cellules'''
*Onglet '''Nombres'''
*Dans le tableau '''Catégorie''', sélectionner '''Heure'''
*Dans le tableau '''Format''', sélectionner celui dont le format dans la cellule description correspond à [HH]:MM:SS au lieu de celui qui se met par défaut (HH:MM:SS).
*Cliquer sur le bouton '''OK'''.

==Changer le format d'affichage des dates dans une colonne sous Excel 2016==
*Positionner le pointeur de la souris sur la lettre de la colonne concernée
*Effectuer un clic droit pour faire apparaitre le menu contextuel
*Sélectionner '''Format de cellule''' pour faire apparaitre une boite de dialogue intitulée '''Format de cellule'''
*Laisser sélectionné le premier onglet '''Nombre'''
*Dans le champ '''Catégorie''', sélectionner "Date"
*Dans le champ '''Type''', sélectionner le format souhaité si existant (penser à utiliser l'ascenseur du champ pour faire défiler l'intégralité des formats proposés)
*Si le format souhaité est inexistant :
**Dans le champ '''Catégorie''', sélectionner '''Personnalisée'''
**Dans le champ '''Type''', renseigner le format souhaiter.
Pour construire le format souhaité, il suffit en général de s'inspirer des formats existants. Exemple de format pour les dates tel que demandé pour l'import des utilisateurs dans OpenFlyers : "aaaa-mm-jj"
*Cliquer sur le bouton '''OK'''

==Changer le format d'affichage des dates dans une colonne sous LibreOffice==
*Positionner le pointeur de la souris sur la lettre de la colonne concernée
*Effectuer un clic droit pour faire apparaitre le menu contextuel
*Sélectionner '''Formater les cellules...''' pour faire apparaitre une boite de dialogue intitulée '''Formatage des cellules'''
*Laisser sélectionné le premier onglet '''Nombres'''
*Dans le champ '''Catégorie''', sélectionner "Date"
*Dans le champ '''Format''', sélectionner le format souhaité si existant (penser à utiliser l'ascenseur du champ pour faire défiler l'intégralité des formats proposés)
*Si le format souhaité est inexistant, dans le champ '''Description de format''', renseigner le format souhaité
Pour construire le format souhaité, il suffit en général de s'inspirer des formats existants. Exemple de format pour les dates tel que demandé pour l'import des utilisateurs dans OpenFlyers : "YYYY-MM-DD"
*Cliquer sur le bouton '''OK'''

==Exporter au format csv pour OpenFlyers sous LibreOffice==
Dans OpenFlyers, l'encodage de caractère par défaut utilisé est l'UTF-8 et la séparation entre les champs est le point-virgule. Voici comment effectuer un export de fichier .csv respectant ces éléments :
*Sélectionner '''Fichier > Enregistrer sous...'''
*Choisir le répertoire et le nom de fichier
*Dans le champ '''Type''' sélectionner '''Texte CSV (.csv) (*.csv)'''
*Cocher '''Éditer les paramètres du filtre'''
*Cliquer sur le bouton '''Enregistrer'''
Dans la fenêtre '''Export de fichiers texte''' :
*Dans le champ '''Jeu de caractères''' taper la lettre "U" puis sélectionner '''Unicode (UTF-8)'''
*Appuyer sur la touche TAB pour éditer le champ suivant, cela permet non seulement de mettre le focus dans le champ mais également de sélectionner tout le contenu de la cellule
*Dans le champ '''Séparateur de champ''', taper ";"
*Appuyer sur la touche TAB
*Taper sur la touche "Supprimer" du clavier de sorte à vider le contenu du champ '''Séparateur de texte'''
*Cliquer sur le bouton '''OK'''

==Importer un fichier csv sous LibreOffice avec des dates et/ou des heures==
Lors de l'import d'un fichier csv dans LibreOffice, il faut vider le champ '''Séparateur de chaîne de caractères''' pour que lors de l'import effectif du fichier les colonnes contenant des dates et/ou des heures soient reconnues comme telles.

[[File:Paramétrer_la_prise_en_compte_des_dates_dans_les_fichiers_csv_avec_libreoffice.png]]

Les colonnes correctement reconnues ont le texte aligné à droite.

Par défaut, les heures (=durées) se retrouvent formatées sous la forme ''HH:MM:SS''.

[[File:Résultat import avec date et heure dans libreoffice.png]]

=Télécharger une pièce jointe avec Gmail=
*Aller sur son compte Gmail depuis un navigateur : https://mail.google.com
*Cliquer sur l'email reçu contenant la ou les pièce(s) jointe(s) à télécharger
Les pièces jointes sont en bas de la page avec un titre au-dessus qui indique le nombre de pièces jointes : '''X pièces jointes'''
*Survoler avec le pointeur de la souris la pièce jointe souhaitée
3 boutons apparaissent
*Cliquer sur le bouton le plus à gauche symbolisé par une flèche vers le bas et intitulé '''Télécharger'''
Si le navigateur ouvre une fenêtre contextuelle demandant '''Que doit-on faire avec ce fichier ?''' :
*Sélectionner '''Enregistrer le fichier'''
*Cliquer sur bouton '''OK'''
[[File:Pièce jointe gmail.jpg|900px]]

Le fichier est enregistré dans le répertoire de sauvegarde paramétré par défaut ou utilisé la fois précédente.

Dans Firefox, il peut être retrouvé en cliquant en haut à droite du navigateur sur le pictogramme symbolisant une flèche vers le bas.

Dans Chrome, il peut être retrouvé en cliquant sur le bouton représentant le fichier téléchargé qui doit apparaitre en bas de la fenêtre.

Technologies de géolocalisation aéronautique

2024-10-02T17:28:02Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter :
*les différentes solutions technologiques de géolocalisation pour l'aéronautique en terme :
**de transmission de données
**d'installation à bord d'un aéronef
*les avantages et inconvénients de chaque type de solution
*les ordres de grandeur des coûts d'achat (hors main d’œuvre pour l'installation) et d'exploitation

=Principe de la géolocalisation=
*Un appareil mobile (dans notre cas un aéronef) est équipé d'un récepteur de position par satellite (GPS, GLONASS, GALILEO, ...) lui permettant de connaitre sa position géographique en 3 dimensions
*D'un dispositif de transmission permettant d'envoyer cette position à une station au sol
*Cette station au sol renvoie les données de géolocalisation à un serveur accessible depuis le réseau internet permettant son exploitation par des solutions logicielles notamment sur des applications de cartographie permettant d'afficher la position de l'aéronef.
[[File:Aircraft-position-generic-transmission-scheme.png|center]]

=Réception de la position par GNS=
Deux réseaux de système de navigation global sont opérationnels
*GPS: gérè par les États Unis
*GLONASS: gèré par les Force Spatiales de la Fédération Russe

La constellation GALILEO lancée par un consortium Européen est prévu d'être disponible en 2016

La réception à bord d'un aéronef se fait par le biais d'une antenne incluse dans un équipement ou extérieure à cet équipement et reliée à un boitier incluant l’électronique de décodage et de calcul de position.
[[File:Aircraft-GPS-various-receptions-scheme.png|center]]

Les combinaisons possibles sont les suivantes :
*Équipement aéronautique certifié, fixé à l’intérieur de l'aéronef et relié à une antenne extérieur
Il est préférable d'avoir une antenne GPS extérieure à l'aéronef afin de garantir une meilleure réception des signaux satellites.
*Antenne extérieure à l'aéronef certifiée et reliée à un équipement non certifié installé dans l'aéronef grâce à un support prévu à cet effet
*Boitier de réception connecté à une tablette ou à un smartphone par liaison sans fil (Bluetooth, wifi, ...)
*Boitier autonome incluant l'antenne

=Modes de transmission de données adaptés à l'aéronautique=
==Transmission ACARS==
[[File:Aircraft-position-acars-transmission-scheme.png|center]]

Le mode de communication [[Wikipedia-en:Aircraft_Communications_Addressing_and_Reporting_System|ACARS]] date de la fin des années 70. Il utilise plusieurs modes de transmission : VHF, HF ou Satellite. C'est un module dénommé Management Unit (MU) ou Communication Management Unit (CMU) qui détermine le meilleur mode de transmission selon la situation de l'aéronef. Les autres équipements électroniques de l'aéronef peuvent se connecter sur le MU/CMU pour échanger des données avec l'extérieur de l'aéronef. Ce mode de communication permet d'échanger tout type de données et non pas uniquement la position de l'aéronef. De plus, c'est un mode de communication bidirectionnel : l'aéronef peut aussi bien émettre que recevoir des données. Il est communément déployé sur les avions de lignes.

Les successeurs de cette technologie au travers du projet [[Wikipedia-en:Future_Air_Navigation_System|FANS]] et de l'[[Wikipedia-en:Aeronautical_Telecommunications_Network|ATN]] constituent sans doute le futur de la transmission d'information depuis et vers un aéronef car ils permettent d'envisager des échanges basés sur le protocole [[Wikipedia-en:Internet protocol suite|TCP/IP]].

===Avantages de la transmission ACARS===
Ce mode de transmission permet d'adapter le mode réel de transmission en fonction du réseau disponible et ainsi d'augmenter les chances d'avoir une couverture de disponible.

===Inconvénients de la transmission ACARS===
Il nécessite l'implémentation d'un composant coûteux, volumineux (prévu pour être dans un ou plusieurs racks de soute avionique) et lourd (de l'ordre de 5kg).

===Coût de la transmission ACARS===
*Installation : non chiffré.
*Transmission : 5 € à 50 € par Heure de vol.

==Transmission ADS-B==
[[File:Aircraft-position-ads-b-transmission-scheme.png|center]]

L'[[Wikipedia-en:Automatic_dependent_surveillance-broadcast|ADS-B]] (Automatic Dependent Surveillance - Broadcast) est une technologie en cours de déploiement en Europe. A l'origine, l'ADS était uniquement utilisée dans certains espaces aériens ou l'implémentation de radars sols étaient impossible comme en Atlantique Nord dans les espaces aériens océaniques de Gander et Shanwick.

Il s'agit d'un protocole d'émission radio envoyé par les aéronefs pour indiquer leur position aux contrôleurs aérien. On parle alors d'ADS-B out. D'un point de vu cockpit, l'ADS-B est totalement transparent pour le pilote. Il peut simplement le désactiver au travers d'une interface spécifique mais normalement l'émission doit être permanente.

Ultérieurement, l'ADS-B devrait servir à une nouvelle génération de TCAS pour l'ATSAW (Airborne Traffic Situational AWareness). On parlera alors d'ADS-B in.

La législation européenne devrait rendre son installation et son usage obligatoire sur les aéronefs de plus de 5,7T à partir de 2017 pour les anciens aéronefs et 2015 pour les nouveaux aéronefs.

Certaines activités particulières, comme les activités militaires, peuvent être exclues de l'obligation d'emport.

Le signal n'étant pas crypté, il peut être récupéré par n'importe quelle antenne de réception. Il faut donc juste un réseau d'antenne ADS-B permettant de recevoir les émissions des aéronefs. Ce réseau peut être un réseau tiers ouvert. Il est possible de construire son propre réseau. Une antenne de réception ADS-B peut recevoir les émissions des aéronefs dans un rayon de 200Nm.

===Avantages de la transmission ADS-B===
L'avantage de cette solution réside dans son obligation : si l'aéronef doit règlementairement être équipé d'un transpondeur ADS-B alors il n'y pas besoin d'ajouter d'autre équipement pour transmettre la position.

===Inconvénients de la transmission ADS-B===
Les inconvénients sont les suivants :
*S'il n'a pas d'obligation d'installation de dispositif ADS-B, l'exploitant peut, pour des raisons de confidentialité, interdire son usage.
*Il n'existe pas, à notre connaissance, de serveur officiel ouvert permettant de récupérer la position d'un aéronef. Il faut donc :
**soit construire son propre réseau d'antennes.
**soit utiliser des réseaux "libres" privés.

===Coûts de la transmission ADS-B===
*Installation dans l'aéronef : 0 € si on considère que l'installation d'un transpondeur ADS-B répond à une obligation réglementaire. Sinon il faut compter 3000 € pour le transpondeur ADS-B.
*Transmission : 0 €.
*Installation au sol : 1 € par Heure de vol pour l'usage d'un réseau de réception de position ADS-B.

==Transmission GSM==
[[File:Aircraft-position-gsm-transmission-scheme.png|center]]
La position peut être envoyée grâce au réseau GSM utilisé par les téléphones portables. L'équipement qui envoie la position doit être doté d'un modem [[Wikipedia-fr:General Packet Radio Service|GPRS]] incluant une carte SIM. Il nécessite un abonnement data appelé "[[Wikipedia-fr:Machine_to_machine|M2M]]" auprès d'un opérateur de téléphonie. En général l'équipement peut fonctionner avec le réseau GSM partout dans le monde en fonction de l'abonnement (prise en compte ou non du [[Wikipedia-fr:Roaming|roaming]]). Par contre la transmission en temps réel des données est soumise à l'existence d'une couverture GSM au niveau de la région survolée et à la réglementation applicable en matière d'utilisation des appareils GSM (cf. [[#Inconvénients_de_la_transmission_GSM|Inconvénients de la transmission GSM]]). Dans le cadre de l'aéronautique, le GSM est une solution peu onéreuse dans le cas de la transmission des [[Wikipedia-en:OOOI#OOOI_events|OOOI]] ou si la trajectoire n'a besoin d'être transmise qu'à l'issue du vol.

===Avantages de la transmission GSM===
*La transmission GSM passe sans problème à travers le fuselage d'un aéronef. Cela permet d'envisager une installation d'un boitier indépendant de l'aéronef et donc ne nécessitant pas de certification ou encore même l'utilisation d'une tablette dotée d'une carte SIM ou d'un smartphone.

===Inconvénients de la transmission GSM===
*Interdiction d'utilisation du GSM en l'air du fait de la réglementation locale ou de l'exploitant.
*Perte de transmission :
**Ne fonctionne pas au delà de 3000ft à 5000ft sol dans la plupart des pays car les antennes de réception GSM sont dirigées vers le sol. Les pertes de transmission sont systématiques au delà de 5000ft, très fréquentes au delà de 3000ft.
**Les vitesses de déplacement élevées peuvent rendre difficile l'appariement entre une antenne de réception et le module émetteur : l'émetteur saute alors d'antenne en antenne sans avoir le temps d'envoyer les données.
**La région survolée peut ne pas être équipée d'antenne GSM. C'est notamment le cas dans certaines régions boisées et non peuplées ou au-dessus de la mer. Ainsi les pertes de transmission dépassent fréquemment les 5 minutes sur les zones non habitées.

===Coût de la transmission GSM===
*Installation :
**Matériel non certifié :
***Solution smartphone : 0 € si on considère que le smartphone est déjà acheté
***Solution tablette : coût de la tablette (environ 1000 €)
***Solution boitier : l'AeroBox proposée par OpenFlyers est à 990 €. Il existe des boitiers offrant moins de fonctionnalités que l'AeroBox pour 100 à 200 €.
*:Il est possible de connecter une antenne GPS externe à certaines tablettes ou à du matériel non certifié. L'idéal étant que l'antenne soit à l'extérieur de l'aéronef. Dans ce cas, l'antenne doit être certifiée et le coût de l'installation varie entre 1.000 € et 10.000 € selon la nature de l'installation et du boitier auquel elle est reliée.
**Matériel intégralement certifié : 10.000 € à 100.000 €
*Transmission : 0,1 € à 1 €. Le prix dépend de la couverture géographique souhaitée et de la quantité de données à transmettre, c'est à dire de la fréquence d'envoi de la position.

==Transmission Satellite==
[[File:Aircraft-position-satellite-transmission-scheme.png|center]]
Les transmissions satellite depuis des aéronefs repose en général sur la constellation satellite Iridium. La couverture est mondiale.

Il existe 2 types de matériel embarqué :
*le matériel indépendant de l'aéronef : il s'agit de boitiers autonomes qui reçoivent également les signaux GPS et transmettent l'émission par satellite. Cela peut également être une tablette reliée à un modem satellite.
*le matériel monté dans l'aéronef : les antennes sont alors situées à l'extérieur de l'aéronef et qu'il n'y a par conséquent pas de problème réception et de transmission des signaux sauf dans le cas des hélicoptères où la transmission satellite peut poser problème.

===Avantages de la transmission Satellite===
*Couverture mondiale

===Inconvénients de la transmission Satellite===
*Coût

===Coût de la transmission Satellite===
*Installation :
**Matériel non certifié :
***Solution boitier : environ 2.000 €
***Solution tablette : coût de la tablette (environ 1.000 €) + coût du modem satellite (environ 300 €).
**Matériel certifié :
***Module de tracking simplement fixé sur le fuselage de l'aéronef : environ 1.000 €
***Il est possible de connecter une antenne GPS externe à certaines tablettes ou à du matériel non certifié. L'idéal étant que l'antenne soit à l'extérieur de l'aéronef. Dans ce cas, l'antenne doit être certifiée et le coût de l'installation est de l'ordre de 8.000 €.
***Il existe également des solutions conçues pour le montage de tablette utilisée comme EFB classe 2 et permettant une connexion sur le bus ARINC. Nous n'avons pas étudié le chiffrage.
***Matériel intégralement certifié : 15.000 € à 60.000 €
*Transmission : 5 € à 50 € par Heure de vol. Le prix dépend de la fréquence de rafraichissement de la position, du volume d'heures de vol et également du volume des données dans le cas où en plus de la position d'autres données sont échangées. Dans le cadre d'une activité saisonnière l'abonnement peut être réduit sur les seuls mois utiles.

=Interface Homme Machine (IHM)=
Désormais les Interface Homme Machine de type [[Wikipedia-en:Electronic_flight_bag|Electronic Flight Bag (EFB)]] reposent sur un écran tactile.

Elle permet à l'équipage d'obtenir des informations en temps réel durant le vol et également d'envoyer des informations vers un opérateur sol.

Il existe 2 types de solution :
*le matériel non certifié. Désormais seules les tablettes, type iPad, Android ou encore Windows 8RT sont réellement présents sur le marché. Les avantages des tablettes sont indéniables :
**Ils apportent une grande valeur ajoutée en terme de fonctionnalités grâce à une multitude d'applications dédiées à l'aéronautique.
**Leur installation est facilitée par le biais de supports dédiés
**Mises à jour simplifiées des applications embarquées
*le matériel certifié. Il existe notamment les EFB classe 3. Cependant le prix et la lourdeur d'une certification en font des appareils qui paraissent obsolètes par rapport aux tablettes. Ainsi, nombre de compagnies aériennes renoncent à s'équiper en EFB classe 3 onéreux, voir même font démonter leurs EFBs pour rétrofiter leur flotte avec des supports pour iPad certifiés EFB classe 1 ou 2. C'est ainsi que [http://news.delta.com/index.php?s=43&item=2118 Delta a annoncé le 30 septembre 2013] l'équipement en [[Wikipedia-en:Microsoft Surface 2|tablette Surface 2]] pour ses 11.000 pilotes.

=Certification=
Dès qu'un équipement est fixé à l'aéronef, il doit être homologué. (Boitier, antenne, ...) C'est la "fixité" du produit ou des parties du produit qui définit s'il doit bénéficier d'un agrément de matériel autorisé sur un aéronef [http://www.easa.europa.eu/certification/ETSO-authorisations.php ETSO (European Technical Standard Order)]

L'équivalent américain de l'ETSO est le TSO mais il n'est pas valide pour une installation conforme à l'EASA. Une demande doit être faite, le procédé est toutefois allégé

Chaque modification sur un aéronef doit être approuvée par un Supplementary Type Certificat STC
La plupart ne sont pas génériques pour ce type de matériel, à chaque type d'installation il en faut un.

La liste des ETSO et des STC est mise à jour mensuellement sur le site de l'EASA.

==Ensembles autonomes==
Les ensembles autonomes sont posés dans l'aéronef. Dans ce cas les antennes sont soient internes au produit soit externes mais toujours à l'intérieur de l'aéronef. Le produit nécessite alors une alimentation et doit donc disposer d'une batterie pour assurer son autonomie. Le produit n'est pas certifié aéronautique. 2 exemples de produits :
*L'AeroBox que fournit la société OpenFlyers : il s'agit d'un boitier totalement autonome avec une batterie interne et des antennes GPS et GSM internes.
*l'iPad d'Apple : il s'agit d'une tablette qui dispose de sa propre antenne GPS et de sa propre antenne GSM. L'iPad peut également être relié à une antenne GPS externe pour améliorer la réception.
Il existe d'autres produits proposant des récepteurs GPS et des émetteurs Iridium par exemple.

Il est possible de relier le produit au circuit électrique de l'avion via une prise électrique. Une prise allume-cigare peut être utilisée mais une prise dédiée protégée par fusible est recommandée. Dans ce cas il faudra que la câblage soit approuvé par un STC.

==Ensembles partiellement fixés sur l'aéronef==
Dans ce cas, seules les interfaces doivent être approuvées, (câblage, alimentation, antennes, ...). L’équipement est considéré comme dé-connectable sans outillage [http://fsims.faa.gov/PICDetail.aspx?docId=8900.1,Vol.4,Ch15,Sec1 FSIMS 8200-1]

C'est typiquement le cas de la transformation d'un iPad en EFB classe 2 relié à un bus ARINC.
[[File:HMI-non-certified-external-satellite-transmission-scheme.png|center]]

==Ensembles totalement certifiés==
Il existe 2 types de produits correspondant à cette classification :
*les "boites noires" qui ne disposent pas d'IHM. Dans ce cas le produit peut être installé n'importe où dans l'aéronef, notamment dans la soute électronique lorsqu'il y en a une.
*les produits avec une IHM accessible pour le pilote. Le produit peut être alors complètement intégré dans le poste de pilotage ou une partie peut être déportée ailleurs dans l'aéronef.

===Ensembles totalement certifiés sans IHM===
====Ensemble totalement certifié fixé dans l'aéronef====
[[File:Autonomous-external-attached-satellite-transmission-scheme.png|center]]

===Ensembles totalement certifiés avec IHM===
[[File:HMI-all-certified-external-satellite-transmission-scheme.png|center]]

=CS-STAN=
Dans le cadre du CS-STAN (CS-SC106b), un boitier enregistreur ne nécessite pas de certification particulière pour les ELA2 (European Light Aircraft) car :
*Il ne contient pas de batterie (pas de risque de feu de batterie)

Pour plus de précisions, voir le chapitre '''Standard Change CS-SC106b''' pages 119 et120 du document EASA [https://www.easa.europa.eu/en/downloads/136407/en CS-STAN / Issue 4] concernant ''INSTALLATION OF FLIGHT TIME RECORDERS''.

Si le boitier transmet des données pendant le vol, alors il faut un certificat EMI.

Si le boitier contient une batterie, alors il faut qu'il respecte la CS STAN.47.

=Synthèse des coûts des solutions matérielles=
{| class="wikitable centre"
!Schéma de principe!!Type de solution matérielle!!IHM!!Transmission!!Coût d'installation!!Coût mensuel des transmissions<br />par Heure de Vol
|-
|[[File:Aircraft-position-acars-transmission-scheme.png|center|200px]]||certifié||-||ACARS||non chiffré|| 5 € à 50 €
|-
|[[File:Aircraft-position-ads-b-transmission-scheme.png|center|200px]]||certifié||-||ADS-B||0 € si requis<br />Sinon 3.000 € pour le transpondeur|| 1 €
|-
|[[File:Autonomous-internal-gsm-transmission-scheme.png|center|200px]]||autonome
|rowspan="3"|-
|rowspan="6"|GSM||0 à 1.000 €
|rowspan="6"| 0,1 € à 1 €
|-
|[[File:Autonomous-internal-gsm-transmission-linked-to-external-attached-gns-antenna-scheme.png|center|200px]]||branché sur antenne GPS extérieure certifiée, amovible et non certifié||~1.000 €
|-
|X||certifié intégral, fixé extérieurement sur l'aéronef||non étudié
|-
|[[File:HMI-autonomous-internal-gsm-transmission-scheme.png|center|200px]]||autonome
|rowspan="3"|OUI||~1.000 €
|-
|[[File:HMI-non-certified-internal-gsm-transmission-linked-to-external-attached-gns-antenna-scheme.png|center|200px]]||branché sur antenne GPS extérieure certifiée, amovible et non certifié||~8.000 €
|-
|X||certifié intégral||non étudié
|-
|[[File:Autonomous-internal-satellite-transmission-scheme.png|center|200px]]||autonome
|rowspan="2"|-
|rowspan="6"|Satellite||~2.000 €
|rowspan="6"|5 € à 50 €
|-
|[[File:Autonomous-external-attached-satellite-transmission-scheme.png|center|200px]]||certifié intégral, fixé extérieurement sur l'aéronef||non chiffré
|-
|[[File:IHM-autonomous-internal-satellite-transmission-scheme.png|center|200px]]||autonome
|rowspan="4"|OUI||~1.300 €
|-
|[[File:HMI-non-certified-internal-satellite-transmission-linked-to-external-attached-gns-antenna-scheme.png|center|200px]]||branché sur antenne GPS extérieure certifiée, amovible et non certifié||~8.000 €
|-
|[[File:HMI-non-certified-external-satellite-transmission-scheme.png|center|200px]]||branché sur bus ARINC, certifié, tablette amovible et certifiée EFB classe 2||non chiffré
|-
|[[File:HMI-all-certified-external-satellite-transmission-scheme.png|center|200px]]||certifié intégral||15.000 à 60.000 €
|}

Tableurs

2024-10-02T17:28:02Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Introduction=
Les abonnements Business + et supérieur, ou les plateformes disposant de l'option (voir le catalogue [https://openflyers.com/fr/tarifs tarifaire]), peuvent disposer d'un accès à des feuilles de calcul regroupées par classeurs.

Cette page présente le fonctionnement de ces classeurs accessibles depuis la plateforme.

Un exemple de classeur pour le [[suivi de maintenance]] est disponible depuis la plateforme de démonstration [https://openflyers.com/demo-aero-club demo-aero-club].

=Configuration du droit=
Avant d'ouvrir les classeurs, le droit doit être correctement attribué sur la plateforme.

Pour cela, il faut :
*Aller dans le menu '''Amin > Utilisateurs > Profils'''
*Cliquer sur l'onglet '''[[Gestion-des-profils#Généralités-admin|Généralités admin]]'''
*Cocher le droit '''[[Gestion-des-profils#Accès-aux-tableurs|Accès aux tableurs]]''' pour les profils désirés.

[[File:Tableurs_configuration_profils.png|1200px]]

Une fois la configuration effectuée, un nouveau sous-menu [[#Ouvrir-un-classeur|permettant d'accéder aux classeurs]] apparaît dans le menu '''Tableurs''' pour les profils précédemment sélectionnés, pour chaque classeur disponible.

[[File:Bouton_tableur_suivi_nav.png]]

=Ouvrir un classeur=
Les profils [[#Configuration du droit|ayant le droit requis]] peuvent accéder aux classeurs.

Elles sont accessibles depuis le menu '''Tableurs''', où un sous-menu est proposé pour chaque classeur disponible.

Un clique sur l'item du menu ouvre un nouvel onglet dans le navigateur qui contient le classeur dans l'interface ''Google Sheets''.

[[File:Bouton_tableur_suivi_nav.png]]

=Classeurs disponibles=
Voici une liste des différents classeurs proposés par OpenFlyers :
*[[Suivi de maintenance#Classeur de suivi de maintenance|Classeur de suivi de maintenance]] : le classeur, mis à jour en temps réel lors de la saisie et la suppression d'un vol, permet de suivre les potentiels, butées et autres informations des aéronefs paramétrés dans la plateforme.

Il est possible de demander le développement de classeurs personnalisées.

Suivi de maintenance

2024-10-02T17:28:01Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter le module de suivi de [[Maintenance aéronautique|maintenance]].

Ce module est accessible depuis le menu '''Gestion > Ressources > Maintenance''' et dispose de plusieurs interfaces :
*Une page '''[[#Vue-d'ensemble|Vue d'ensemble]]''' récapitulant les informations des aéronefs et les prochaines butées des actions
*Une page '''[[#Programme|Programme]]''' permettant de définir pour chaque ressource les caractéristiques nécessaire pour le suivi : les éléments, visites, potentiels, etc.
*Une page '''[[#Suivi|Suivi]]''' permettant de saisir pour chaque ressource les actions effectuées

Cette page présente également le [[#Module-de-suivi-du-potentiel-restant|module de suivi du potentiel restant]]

Lors de l'initialisation du module, il est recommandé de commencer par renseigner tout le programme de maintenance en commençant par les visites les plus importantes pour terminer par les visites les moins importantes.

=Décalage du programme de maintenance=
Par défaut, le module de suivi de maintenance est prévu pour que '''toutes''' les interventions d'un aéronef soient renseignées dans [[#Suivi|le suivi de la ressource]] et ce, depuis sa mise en circulation.

Si des interventions ont déjà été effectuées sur l'aéronef quand le module est paramétré pour la première fois, ou si les interventions précédentes sont inconnues, il est possible de '''décaler le programme de maintenance'''. De cette manière, on évite de devoir saisir les anciennes actions effectuées.

Pour décaler un programme de maintenance, un paramétrage supplémentaire est nécessaire afin d'optimiser les calculs des butées :
#Aller dans le [[#Programme|paramétrage du programme de la ressource]]
#Renseigner les bonnes valeurs dans la colonne '''Premier travaux de référence (horaire et calendaire)'''

Si le programme de maintenance doit démarrer à un certain instant '''t''', les premiers travaux de référence de chaque action correspondent aux '''heures''' et à la '''date''' auxquels l'action a été effectuée pour la dernière fois quand l'aéronef avait '''t''' heures de vol. Pour les visites, on prend en compte le fait qu'elles [[Maintenance-aéronautique#Remarques|s'incluent]].

Par exemple, un aéronef a déjà 2054h de vol et on veut faire démarrer le programme de maintenance à ce moment :
#La dernière '''Visite 50h''' a été effectuée à 2050h
#La dernière '''Visite 100h''' a été effectuée à 2000h (inclue dans la '''Visite 2000h''')
#La dernière '''Visite 500h''' a été effectuée à 2000h (inclue dans la '''Visite 2000h''')
#La dernière révision du '''Moteur''' était à 2000h
#etc.

Ces valeurs de référence ne prennent pas en compte les marges de tolérance, donc le retard ou l'avance sur l'action. La valeur peut donc être approximative. En reprenant l'exemple précédent :
*Par exemple, la dernière '''Visite 50h''' a été effectuée à 2067h.
*Cette visite aurait dû être effectuée à 2050h, de plus la prochaine est prévue pour 2100h (on additionne les heures lors de la dernière visite plus sa périodicité)
*En mettant 2067h, la prochaine visite serait calculée à 2117h, donc la bonne valeur à renseigner est '''2050h'''.

Attention, pour la saisie de '''toutes''' les visites horaires et calendaires, '''les butées calculées et affichées''' démarrent '''toutes''' de la plus petite visite (habituellement la '''Visite 50h''' et la '''Visite 1 an''') :
*Ainsi, les prochaines butées des visites horaires sont, par exemple, calculées à partir de la '''Visite 50h''' de référence
*Les prochaines butées des visites calendaires sont, par exemple, souvent calculées à partir de la '''Visite 1 an''' de référence

Une fois ces valeurs de référence entrées, [[#Suivi|le suivi de la ressource]] peut être complété en indiquant toutes les interventions '''après''' ces valeurs de référence. Par exemple, si la valeur de référence de la '''Visite 50h''' est 2050h, le suivi ne doit pas contenir de valeur pour la '''Visite 50h''' à 2050h. Seulement les '''Visites 50h''' suivantes seront renseignées. Le principe est le même pour les autres visites et toute autre action.

=Programme=
Pour accéder au programme de chaque ressource :
*'''Gestion > Ressources > Maintenance'''
*Cliquer sur le bouton '''Programme''' de la ressource concernée

Sur cette interface, il est possible d'accéder au programme d'une autre ressource depuis la liste déroulante '''Ressource'''.

Lorsque le programme est vide, en-dessous du tableau, apparait une ligne '''Créer le programme par duplication à partir de''' qui permet de dupliquer le programme de maintenance d'une autre ressource pour la ressource en cours. Dans ce cas, seules les données des colonnes '''Type''', '''Description''', '''Périodicité horaire (heures)''', '''Tolérance horaire''', '''Périodicité calendaire (mois)''', '''Tolérance calendaire''' sont dupliquées.

La page programme d'une ressource contient les caractéristiques nécessaires pour son suivi : éléments, visites, potentiels, etc et sont affichés selon un [[#Ordre-d'affichage-des-composants-du-programme|ordre de priorité]]. Ainsi, chaque ligne du tableau correspond à un élément de la ressource qui est suivi.

Tous les éléments devant être suivis doivent être renseignés et paramétrés. Le paramétrage est nécessaire au bon fonctionnement du [[#Suivi|suivi]].

Une fois le paramétrage effectué, la page affiche les résultats des calculs obtenus d'après les informations contenues dans [[#Suivi|le suivi]].

Lors du paramétrage des composants, [[#Ajouter-ou-modifier-un-composant|plusieurs champs sont à renseigner]].

==Ajouter ou modifier un composant==
Pour ajouter un composant, il faut cliquer sur le bouton '''Ajouter''' présent en-dessous du tableau.

Pour modifier un composant, il faut cliquer sur le pictogramme crayon présent dans la colonne '''Actions''' de la ligne concernée.

Dans le formulaire il faut saisir les champs :
*'''[[#Types-de-composants|Type de composant]]''' : un élément de l'appareil (moteur, hélice, etc), une visite (50H, 100H, etc) ou autre (CEN, Pesée, etc)
*'''Description''' : le nom et les informations détaillées sur le composant. Par exemple la référence du moteur
*'''Périodicité horaire (heures)''' : si le composant a une périodicité horaire il faut remplir cette colonne
*'''Tolérance horaire''' : la tolérance d'un composant permet de calculer [[Maintenance-aéronautique#Schémas-:-calcul-d'échéances|la fenêtre de la butée optimale]]. Pour les composants avec une périodicité horaires, la tolérance doit être en heures.
*'''Périodicité calendaire (mois)''' : si le composant a une périodicité calendaire il faut remplir cette colonne
*'''Tolérance calendaire''' : la tolérance d'un composant permet de calculer [[Maintenance-aéronautique#Schémas-:-calcul-d'échéances|la fenêtre de la butée optimale]]. Pour les composants avec une périodicité calendaire, la tolérance doit être en mois.
*'''Premiers travaux de référence''' : il s'agit de la date ou des heures cellules des travaux de l'action à utiliser comme référence pour le calcul des valeurs dans [[#Suivi|le suivi]]. Cette colonne permet de [[#Décalage-du-programme-de-maintenance|décaler le programme de maintenance de l'aéronef]].
**'''horaire''' : A remplir pour un composant avec périodicité horaire. La valeur doit correspondre aux heures cellules quand l'action a été effectuée pour la dernière fois.
***Si le programme de maintenance n'est pas décalé, ne rien remplir
**'''calendaire''' : Le principe est identique aux premier travaux de référence ayant une périodicité horaire, la date des derniers travaux doit être indiquée.
***<s>Si le programme de maintenance n'est pas décalé, la '''date de mise en circulation''' de l'aéronef doit être renseignée.</s>
*'''Cette visite correspond à la révision générale'''

'''Attention :''' tout composant doit être défini avec soit une périodicité horaire soit une périodicité calendaire. Dans le cas où un composant n'a pas de périodicité, il faut créer une périodicité fictive, par exemple en indiquant une butée calendaire de 120 mois.

==Détail du programme==
Les premières colonnes du programme sont définis lors de l'[[#Ajouter-ou-modifier-un-composant|ajout d'un composant]] :
*'''Type'''
*'''Description'''
*'''Périodicité horaire (heures)'''
*'''Tolérance horaire'''
*'''Périodicité calendaire (mois)'''
*'''Tolérance calendaire'''
*'''Premiers travaux de référence horaire'''
*'''Premiers travaux de référence calendaire'''

Les colonnes suivantes et calculs intermédiaires non visibles sont déterminées à partir des premières colonnes et des informations contenues dans le [[#Suivi|suivi]] :
*'''Heures cellule début travaux''' : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Heures cellule début travaux'''. Si le composant n'a pas d'entrée dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence horaire''' du composant
*'''Date fin travaux''' : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Date fin travaux'''. Si le composant n'a pas d'entrée dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence calendaire''' du composant
*'''Temps réalisé (heures)''' : résultat de la différence entre la colonne '''Heures totales''' de la ressource et la colonne '''Heures cellule début travaux''' du composant
*'''Potentiel restant (heures)''' : résultat de la différence entre la colonne '''Butée horaire sans marge''' du composant et la colonne '''Heures totales''' de la ressource
*'''Butée horaire sans marge''' : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Butée horaire sans marge'''. Résultat de la valeur la plus petite entre celle que l'on vient de récupérer et la colonne '''Heures cellule début travaux''' du composant à laquelle on ajoute la valeur de la colonne '''Périodicité horaire''' du composant
*'''Butée horaire avec marge''' : résultat de la colonne '''Butée horaire sans marge''' du composant à laquelle on ajoute la valeur de la colonne '''Tolérance horaire''' du composant
*'''Temps réalisé (mois)''' : résultat de la différence entre la date du jour et de la colonne '''Date fin travaux''' du composant
*'''Potentiel restant (mois)''' : résultat de la différence entre la colonne '''Butée calendaire sans marge''' du composant et la date du jour
*'''Butée calendaire sans marge''' : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Butée calendaire sans marge'''. Résultat de la valeur la plus petite entre celle que l'on vient de récupérer et la colonne '''Date fin travaux''' du composant à laquelle on ajoute la valeur de la colonne '''Périodicité calendaire''' du composant
*'''Butée calendaire avec marge''' : résultat de la colonne '''Butée calendaire sans marge''' du composant à laquelle on ajoute la valeur de la colonne '''Tolérance calendaire''' du composant
*'''Heures début travaux effective''' (calcul intermédiaire) :
**Si le composant est une visite : récupère sur la dernière visite enregistrée [[Maintenance-aéronautique#Remarques|compatible avec le composant]] dans le suivi la valeur de la colonne '''Heures cellule début travaux'''. Si aucune entrée n'est compatible dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence horaire''' du composant
**Si le composant n'est pas une visite : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Heures cellule début travaux'''. Si le composant n'a pas d'entrée dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence horaire''' du composant
*'''Butée horaire originale théorique''' (calcul intermédiaire) :
**Si le composant est une visite : récupère sur la dernière visite enregistrée [[Maintenance-aéronautique#Remarques|compatible avec le composant]] dans le suivi la valeur de la colonne '''Butée horaire sans marge'''. Si aucune entrée n'est compatible dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence horaire''' du composant
**Si le composant n'est pas une visite : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Heures cellule début travaux'''. Si le composant n'a pas d'entrée dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence horaire''' du composant
*'''Butée horaire originale intelligente''' (calcul intermédiaire) : Si ces valeurs sont présentes, récupère la valeur la plus petite entre la colonne '''Heures début travaux effective''' du composant et la colonne '''Butée horaire originale théorique''' du composant. Sinon récupère la valeur de la colonne '''Heures cellule début travaux''' du composant
*'''Butée horaire intelligente sans marge''' (calcul intermédiaire) : résultat de la valeur de la colonne '''Butée horaire originale intelligente''' du composant à laquelle on ajoute la valeur de la colonne '''Périodicité horaire''' du composant
*'''Butée horaire intelligente avec marge''' (calcul intermédiaire) : résultat de la valeur de la colonne '''Butée horaire intelligente sans marge''' du composant à laquelle on ajoute la valeur de la colonne '''Tolérance horaire''' du composant
*'''Date fin travaux effective''' (calcul intermédiaire) :
**Si le composant est une visite : récupère sur la dernière visite enregistrée [[Maintenance-aéronautique#Remarques|compatible avec le composant]] dans le suivi la valeur de la colonne '''Date fin travaux'''. Si aucune entrée n'est compatible dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence calendaire''' du composant
**Si le composant n'est pas une visite : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Date fin travaux'''. Si le composant n'a pas d'entrée dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence calendaire''' du composant
*'''Butée calendaire originale théorique''' (calcul intermédiaire) :
**Si le composant est une visite : récupère sur la dernière visite enregistrée [[Maintenance-aéronautique#Remarques|compatible avec le composant]] dans le suivi la valeur de la colonne '''Butée calendaire sans marge'''. Si aucune entrée n'est compatible dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence calendaire''' du composant
**Si le composant n'est pas une visite : récupère sur la dernière entrée du composant dans le suivi la valeur de la colonne '''Butée calendaire sans marge'''. Si le composant n'a pas d'entrée dans le suivi, récupère la valeur de la colonne '''Premiers travaux de référence calendaire''' du composant
*'''Butée calendaire originale intelligente''' (calcul intermédiaire) : Si ces valeurs sont présentes, récupère la valeur la plus petite entre la colonne '''Date fin travaux effective''' du composant et la colonne '''Butée calendaire originale théorique''' du composant. Sinon récupère la valeur de la colonne '''Date fin travaux''' du composant
*'''Butée calendaire intelligente sans marge''' (calcul intermédiaire) : résultat de la valeur de la colonne '''Butée calendaire originale intelligente''' du composant à laquelle on ajoute la valeur de la colonne '''Périodicité calendaire''' du composant
*'''Butée calendaire intelligente avec marge''' (calcul intermédiaire) : résultat de la valeur de la colonne '''Butée calendaire intelligente sans marge''' du composant à laquelle on ajoute la valeur de la colonne '''Tolérance calendaire''' du composant
*'''Groupe de chevauchement''' (calcul intermédiaire) : n'est calculé que si le composant est une visite.
*#Récupère dans le programme tous les composants qui sont de type visite et qui chevauche le composant pour lequel on détermine son groupe de chevauchement. Dans le cas d'un composant avec une périodicité horaire, pour déterminer que le composant chevauche un autre composant il doit avoir la valeur de la colonne '''Butée horaire intelligente sans marge''' qui est inférieure ou égale à la valeur de la colonne '''Butée horaire intelligente avec marge''' de l'autre composant et il doit avoir la valeur de la colonne '''Butée horaire intelligente avec marge''' qui est supérieure ou égale à la valeur de la colonne '''Butée horaire intelligente sans marge''' de l'autre composant. Il est également récupéré les visites en retard qui ont la valeur de la colonne '''Butée horaire intelligente avec marge''' qui est inférieure ou égale à la valeur de la colonne '''Butée horaire intelligente sans marge''' de l'autre composant. Dans le cas d'un composant avec une périodicité calendaire le principe est le même mais avec les colonnes '''Butée calendaire intelligente sans et avec marge'''
*#A partir des composant récupérés, le composant reçoit comme identifiant de groupe de chevauchement l'identifiant du composant qui a la plus petite périodicité horaire ou calendaire. Si le composant n'est chevauché par aucun autre composant ou si c'est lui qui a la plus petite périodicité dans le groupe alors c'est son identifiant qui est utilisé comme identifiant de groupe de chevauchement.
*'''Cette visite correspond à la révision générale''' (saisi par l'utilisateur mais non visible sur le programme)

==Forcer le rafraichissement des calculs==
S'il est nécessaire de forcer le recalcule de l'ensemble des butées (calcul intermédiaire), alors il faut saisir une activitéee fictive pour la ressource concernée et ensuite supprimer cette activité.

==Ordre d'affichage des composants du programme==
L'ordre d'affichage des composants du programme est le suivant :
#les visites
#les éléments
#les inspections
#les documents
*Les éléments et les attestations sont triés, dans chaque type, par ordre alphabétique
*Les visites sont triées ainsi :
*#Celles avec une périodicité horaire, de la plus petite à la plus grande
*#Celles avec une périodicité calendaire, par ordre alphabétique

=Suivi=
Le suivi de chaque ressource est accessible depuis le menu '''Gestion > Resource > Maintenance'''. Dans le tableau, cliquer sur le bouton '''Suivi''' de la resource souhaitée. La page suivi d'une ressource contient toutes les actions effectuées sur l'aéronef. Suite à chaque [[#Ajouter-une-action-effectuée|saisie]], les prochaines butées des actions sont estimées et affichées.

Les actions sont triées par ordre chronologique.

==Ajouter une action effectuée==
Pour ajouter une action, il faut cliquer sur le bouton '''Ajouter''' présent en dessous du tableau. Pour modifier une action, il faut cliquer sur le pictogramme crayon présent dans la colonne ''Actions''.

Dans le formulaire il faut saisir les champs :
*'''[[#Types-de-composants|Type de composant]]''' : il s'agit d'une liste déroulante contenant les composant définis dans le [[#Programme|programme]] de la ressource. Il faut sélectionner le composant concerné
*'''Heures cellule début travaux''' : les heures cellule de la ressource au début de l'action effectuée. Le champ est obligatoire si le composant a une périodicité horaire
*'''Date fin travaux''' : la date lorsque l'action a été effectuée. Le champ est obligatoire si le composant a une périodicité calendaire

'''Attention :'''
*Si [[#Décalage-du-programme-de-maintenance|le programme de maintenance est décalé]], le suivi doit contenir les actions '''suivant ce décalage'''. Par exemple si les '''Travaux de référence''' du '''Moteur''' sont de '''2000h''' (le suivi du moteur démarre à 2000h), le suivi ne doit pas contenir l'entrée du '''Moteur''' avec '''2000h''', il contiendra les interventions suivantes du moteur.

==Détail du suivi==
Les premiers champs du suivi sont définis lors de l'[[#Ajouter-une-action-effectuée|ajout d'une action]] :
*'''Action'''
*'''Heures cellule début travaux'''
*'''Date fin travaux'''

Les champs suivants et calculs intermédiaires non visibles sont déterminées à partir des premières colonnes et des informations contenues dans le [[#Programme|programme]] :
*'''Est une visite''' : défini à partir du type du composant
*'''Type d'action''' : horaire (1), calendaire (2), les deux (0). Défini en fonction de si le composant a une périodicité horaire, calendaire ou les deux.
*'''Tolérance horaire''' : défini à partir du champ correspondant dans le composant
*'''Tolérance calendaire''' : défini à partir du champ correspondant dans le composant
*'''Périodicité horaire de l'action''' : si l'action est une visite, la valeur est défini à partir du champ correspondant dans la visite de référence sinon elle est défini à partir du champ correspondant dans le composant
*'''Périodicité calendaire de l'action''' : si l'action est une visite, la valeur est défini à partir du champ correspondant dans la visite de référence sinon elle est défini à partir du champ correspondant dans le composant
*'''Périodicité horaire du composant''' : défini à partir du champ correspondant dans le composant
*'''Périodicité calendaire du composant''' : défini à partir du champ correspondant dans le composant
*'''Butée horaire de référence''' : défini à partir du champ '''Premiers travaux de référence horaire''' dans le composant. Si l'action est une visite il lui est ajouté la valeur du champ '''Périodicité horaire'''
*'''Butée calendaire de référence''' : défini à partir du champ '''Premiers travaux de référence calendaire''' dans le composant. Si l'action est une visite il lui est ajouté la valeur du champ '''Périodicité calendaire'''
*'''Ligne précédente action horaire liée''' / '''Ligne précédente action calendaire liée''' :
**les lignes sont triées par ordre croissant selon le champ '''Heures cellule début travaux''' puis par ordre chronologique selon le champ '''Date fin travaux'''
**si c'est une visite le moteur recherche parmi les visites l'entrée précédente la plus proche, sinon il recherche parmi les entrées qui concernent le même composant
**si une entrée a été trouvée elle est est défini comme ligne précédente sinon c'est la visite de référence qui est utilisée
*'''Ligne prochaine action horaire liée''' / '''Ligne prochaine action calendaire liée''' :
**les lignes sont triées par ordre croissant selon le champ '''Heures cellule début travaux''' puis par ordre chronologique selon le champ '''Date fin travaux'''
**si c'est une visite le moteur recherche parmi les visites l'entrée suivante la plus proche, sinon il recherche parmi les entrées qui concernent le même composant
**si une entrée a été trouvée elle est est défini comme ligne précédente sinon aucune valeur ne lui est défini
*'''Butée horaire sans marge''' :
**s'il s'agit d'une visite ou que la ligne précédente ne correspond pas à la visite de référence
***si la ligne précédente correspond à la visite de référence, le champ '''Butée horaire sans marge''' de la visite de référence est utilisé
***sinon, le champ '''Prochaine butée horaire sans marge''' de la ligne précédente est utilisé
**sinon, le champ '''Butée horaire de référence''' de l'action est utilisé
*'''Butée horaire avec marge''' : résultat du champ '''Butée horaire sans marge''' de l'action à qui on ajoute la valeur du champ '''Tolérance horaire''' de l'action
*'''Prochaine butée horaire sans marge''' : résultat de la valeur la plus petite entre celle du champ '''Heures cellule début travaux''' et du champ '''Butée horaire sans marge''' à qui on ajoute la valeur du champ '''Périodicité horaire''' de l'action
*'''Prochaine butée horaire avec marge''' : résultat du champ '''Prochaine butée horaire sans marge''' de l'action à qui on ajoute une '''Tolérance horaire''' qu'il faut déterminer. Si l'action n'a pas de prochaine ligne alors si c'est une visite on utilise le champ '''Tolérance horaire''' de la visite de référence sinon on utilise le champ '''Tolérance horaire''' de l'action. Si l'action a une prochaine ligne de défini alors c'est le champ '''Tolérance horaire''' de celle-ci qui est utilisé
*'''Butée calendaire sans marge''' :
**s'il s'agit d'une visite ou que la ligne précédente ne correspond pas à la visite de référence
***si la ligne précédente correspond à la visite de référence, le champ '''Butée calendaire sans marge''' de la visite de référence est utilisé
***sinon, le champ '''Prochaine butée calendaire sans marge''' de la ligne précédente est utilisé
**sinon, le champ '''Butée calendaire de référence''' de l'action est utilisé
*'''Butée calendaire avec marge''' : résultat du champ '''Butée calendaire sans marge''' de l'action à qui on ajoute la valeur du champ '''Tolérance calendaire''' de l'action
*'''Prochaine butée calendaire sans marge''' : résultat de la valeur la plus petite entre celle du champ '''Date fin travaux''' et du champ '''Butée calendaire sans marge''' à qui on ajoute la valeur du champ '''Périodicité calendaire''' de l'action
*'''Prochaine butée calendaire avec marge''' : résultat du champ '''Prochaine butée calendaire sans marge''' de l'action à qui on ajoute une '''Tolérance calendaire''' qu'il faut déterminer. Si l'action n'a pas de prochaine ligne alors si c'est une visite on utilise le champ '''Tolérance calendaire''' de la visite de référence sinon on utilise le champ '''Tolérance calendaire''' de l'action. Si l'action a une prochaine ligne de défini alors c'est le champ '''Tolérance calendaire''' de celle-ci qui est utilisé

Une première ligne '''Première visite de référence''' apparait dès lors qu'un composant est ajouté au programme de maintenance. Les cellules suivantes sont initialisées :
*'''Butée horaire sans marge''' : correspond au champ '''Premiers travaux de référence horaire''' du composant ajouté
*'''Butée horaire avec marge''' : correspond à la somme des champs ''''''Premiers travaux de référence horaire''' et '''Tolérance horaire''' du composant ajouté
*'''Butée calendaire sans marge''' : correspond au champ '''Premiers travaux de référence calendaire''' du composant ajouté uniquement si le champ '''Périodicité calendaire''' du composant ajouté est renseigné
*'''Butée calendaire avec marge''' : correspond à la somme des champs '''Premiers travaux de référence calendaire''' et '''Tolérance calendaire''' du composant ajouté. Si le champ '''Périodicité calendaire''' est laissé vide, alors la date indiquée est le 01/01/1970.
Si par la suite d'autres composants sont ajoutés, cette première ligne '''Première visite de référence''' se met à jour dès lors que le composant ajouté est d'une périodicité plus faible que les composants déjà présents. En effet, c'est le composant à la périodicité la plus faible qui donne le rythme des actions de maintenance. C'est donc lui qui donne la référence sur la prochaine action. Cf. le chapitre [[#Décalage-du-programme-de-maintenance|Décalage du programme de maintenance]].

===Calcul des fenêtres d'action de maintenance : 50h bien positionnée ou trop anticipée===
[[File:50h bien positionnée.jpg|800px]]

[[File:50h trop anticipée.jpg|800px]]

===Programme sans/avec butée calendaire===
Programme sans visite calendaire :

[[File:Programme sans VP calendaire.jpg|800px]]

Affichage du suivi sans butée calendaire :

[[File:Suivi sans butée calendaire.jpg|800px]]

Programme avec butée calendaire :

[[File:Programme avec VP calendaire.jpg|800px]]

Affichage du suivi avec butée calendaire :

[[File:Suivi avec butée calendaire.jpg|800px]]

=Vue d'ensemble=
La vue d'ensemble est accessible depuis le menu '''Gestion > Ressources > Maintenance'''. Cette page synthétise les informations les plus importantes pour le suivi de maintenance des différentes ressources:
*'''Heures totales''' : heures totales de la ressource. Cette colonne est automatiquement mise à jour lors de la saisie ou la suppression d'une activité
*'''Heures depuis RG (Cellule)''' : Cette valeur correspond aux heures totales de la ressource depuis sa Révision Générale (RG). La RG est [[#Programme|paramétrée pour correspondre à une visite]] de la ressource, par exemple la visite 2000h.
*'''Heures depuis RG (Moteur)''' : La valeur correspond aux heures totales du moteur depuis sa révision, soit depuis ses [[#Programme|'''Heures début travaux''']].
*'''Heures depuis RG (Hélice)''' : Le principe est le même que pour le moteur, la valeur correspond aux heures totales depuis la révision de l'hélice.
*'''Potentiel''' : Le '''Potentiel''' est divisé en deux sous colonnes. Une contenant le potentiel restant en heures, une contenant le potentiel restant en mois. Les potentiels affichés sont ceux de la colonne '''Prochaine action'''. Si la prochaine action est une visite alors le potentiel restant affichée se base sur le [[Maintenance-aéronautique#Calcul-de-l'échéance-d'une-visite|calcul de l'échéance d'une visite]]. Il est possible que le potentiel restant de la visite visible dans le [[#Programme|programme]] soit inférieur au potentiel calculé. Dans ce cas on vérifie si une [[Maintenance-aéronautique#Remarques|visite compatible]] avec une périodicité supérieure a été réalisé depuis la dernière révision de la prochaine visite affichée. Si c'est le cas alors on affiche le potentiel calculé. Sinon on affiche la potentiel restant de la prochaine visite.
*'''Prochaine action''' : La '''Prochaine action''', divisée en deux colonnes est un complément de la colonne '''Potentiel'''. Elle contient le nom des deux prochaines actions de la ressource arrivant à échéance, une en heures et une en mois. L'affichage de la '''Prochaine action''' est optimisé quand le [[#Suivi|suivi]] de la ressource est complet. La prochaine action est le composant avec la plus petite butée horaire ou calendaire. Lorsque la prochaine action est une visite on regarde si des visites se chevauchent. Si c'est le cas alors c'est la visite avec la plus grande périodicité qui sera affichée.
**Le caractère '''*''' est affiché sur les prochaines actions qui incluent un chevauchement de visite

Le potentiel affiché change de couleur selon sa valeur :
*Au dessus de 10 heures : <span style="color: green;">'''vert'''</span>
*Entre 10 heures (inclus) et 5 heures (non inclus) : <span style="color: orange;">'''orange'''</span>
*En dessous de 5 heures (inclus) : <span style="color: red;">'''rouge'''</span>

==Actualisation journalière de la vue d'ensemble==

Chaque nuit à 06h00 UTC la [[#Vue-d'ensemble|vue d'ensemble]] est actualisée afin de mettre à jour les [[#Détail-de-la-vue-d'ensemble|calculs intermédiaires]] se basant sur la date du jour.

==Détail de la vue d'ensemble==

Les champs suivants et calculs intermédiaires non visibles sont déterminés à partir des informations contenues dans le [[#Programme|programme]] et dans le [[#Suivi|suivi]] :
*'''Cellule - Heures totales''' : heures totales de l'aéronef mises à jour à chaque modification du temps de vol - création, édition ou suppression d'un vol
*'''Cellule - Heures depuis RG''' : résultat de la différence entre le champ '''Cellule - Heures totales''' et le champ '''Heures cellule début travaux''' de la visite qui correspond à la révision générale
*'''Moteur - Heures depuis RG''' : résultat de la différence entre le champ '''Cellule - Heures totales''' et le champ '''Temps réalisé (heures) ''' de l'élément moteur.
Pour que cette case contienne une valeur, il faut qu'un composant de type ''72 - Moteur'' soit renseigné dans le programme de l'aéronef et qu'une entrée soit saisie dans le suivi de l'aéronef lié à ce composant
*'''Hélice - Heures depuis RG''' : résultat de la différence entre le champ '''Cellule - Heures totales''' et le champ '''Temps réalisé (heures) ''' de l'élément hélice.
Pour que cette case contienne une valeur, il faut qu'un composant de type ''61 - Hélice'' soit renseigné dans le programme de l'aéronef et qu'une entrée soit saisie dans le suivi de l'aéronef lié à ce composant

*'''Prochaine visite horaire''' : recherche la visite avec la plus petite périodicité horaire. A partir du champ '''Groupe de chevauchement''', recherche parmi les visites qui sont dans ce groupe la visite avec la plus grande périodicité horaire. Cette visite sera la '''prochaine visite horaire'''.
*'''Butée horaire visite''' : recherche parmi le suivi de la ressource, la visite avec la valeur la plus grande pour le champ '''Prochaine butée horaire sans marge'''. Si une visite est trouvée, récupère la valeur de ce champ. Sinon récupère la valeur de ce champ dans le programme sur la visite défini comme étant la '''prochaine visite horaire'''.
*'''Potentiel prochaine visite horaire''' :
*#Calcule la différence entre le champ '''Butée horaire visite''' et le champ '''Cellule - Heures totales''' et la compare avec le potentiel restant de la prochaine visite horaire
*#Si ce dernier est plus petit, vérifie si une visite compatible avec une périodicité supérieure a été réalisé depuis la dernière révision de la prochaine visite horaire
*#Si c'est le cas alors on affiche le résultat de la différence entre le champ '''Butée horaire visite''' et le champ '''Cellule - Heures totales'''. Sinon on affiche la potentiel restant de la prochaine visite horaire
*'''Prochaine action horaire''' : recherche le composant qui a la '''Butée horaire sans marge''' la plus petite
*'''Butée horaire action''' : récupère sur le composant correspond à la '''Prochaine action horaire''', le champ '''Butée horaire sans marge'''
*'''Potentiel prochaine action horaire''' : résultat de la différence entre le champ '''Butée horaire action''' et le champ '''Cellule - Heures totales'''

*'''Potentiel - Heures''' qui correspond au champ '''Potentiel prochaine action horaire prioritaire''' :
**si les champs '''Potentiel prochaine visite horaire''' et '''Potentiel prochaine action horaire''' sont définis, le champ avec la plus petite valeur sera celui utilisé pour définir le champ '''Potentiel prochaine action horaire prioritaire'''
**si un seul des deux champs est défini ce sera celui utilisé pour définir le champ '''Potentiel prochaine action horaire prioritaire'''
*'''Prochaine action horaire prioritaire''' : si c'est le champ '''Potentiel prochaine visite horaire''' qui a été retenu, la prochaine action sera donc celle correspondant au champ '''Prochaine visite horaire''' sinon ce sera celle du champ '''Prochaine action horaire'''

*'''Prochaine visite calendaire''' : recherche la visite avec la plus petite périodicité calendaire. A partir du champ '''Groupe de chevauchement''', recherche parmi les visites qui sont dans ce groupe la visite avec la plus grande périodicité calendaire. Cette visite sera la '''prochaine visite calendaire'''.
*'''Butée calendaire visite''' : recherche parmi le suivi de la ressource, la visite avec la valeur la plus grande pour le champ '''Prochaine butée calendaire sans marge'''. Si une visite est trouvée, récupère la valeur de ce champ. Sinon récupère la valeur de ce champ dans le programme sur la visite défini comme étant la '''prochaine visite horaire'''.
*'''Potentiel prochaine visite calendaire ''' : résultat en mois de la différence entre le champ '''Butée calendaire visite''' et la date du jour

*'''Prochaine action calendaire''' : recherche le composant qui a la '''Butée calendaire sans marge''' la plus petite
*'''Butée calendaire action''' : récupère sur le composant correspond à la '''Prochaine action calendaire''', le champ '''Butée calendaire sans marge'''
*'''Potentiel prochaine action calendaire ''' : résultat en mois de la différence entre le champ '''Butée calendaire action''' et la date du jour

*'''Potentiel - Mois''' qui correspond au champ '''Potentiel prochaine action calendaire prioritaire''' :
**si les champs '''Potentiel prochaine visite calendaire''' et '''Potentiel prochaine action calendaire''' sont définis, le champ avec la plus petite valeur sera celui utilisé pour définir le champ '''Potentiel prochaine action calendaire prioritaire'''
**si un seul des deux champs est défini ce sera celui utilisé pour définir le champ '''Potentiel prochaine action calendaire prioritaire'''
*'''Prochaine action calendaire prioritaire''' : si c'est le champ '''Potentiel prochaine visite calendaire''' qui a été retenu, la prochaine action sera donc celle correspondant au champ '''Prochaine visite calendaire''' sinon ce sera celle du champ '''Prochaine action calendaire'''

=Module de suivi du potentiel restant=
==Unité de mesure des heures==
L'unité de mesure des compteurs d'un aéronef correspond au [[Gestion des ressources#Ajouter_un_type_de_ressource|paramétrage du type de ressource]] correspondant.

Par contre, l'unité de mesure des totaux d'heures correspond au [[Configuration#Gestion-des-vols|paramétrage de l'unité de temps de la plateforme]]. Cela permet d'avoir la tenue des carnets de route des aéronefs dans une seule unité quelque soit l'aéronef. De même pour les calculs des butées pour le suivi de navigabilité cela permet d'avoir une seule unité.

==Activer le module de gestion des potentiels==
*'''Admin > Structure > Paramétrage > Activités'''
*Activer l'interrupteur '''Gestion des potentiels''' s'il n'est pas déjà activé
*Cliquer sur le bouton '''Enregistrer'''

===Initialisation de la gestion des potentiels===
*Aller dans '''Gestion > Ressources > Actives'''
*Cliquer sur l'icône Édition (le crayon)
**Dans la partie inférieure '''Données pour la gestion des vols''' on initialise les valeurs :
**'''Date de début de comptabilisation des heures'''
**'''Total des heures à la date de début'''
Il faut indiquer dans ces 2 champs le nombre d'heures de la ressource et à quelle date il y avait ce nombre d'heures. Ainsi, OpenFlyers calculera le nombre d'heures de vols effectuées par l'aéronef à compter de cette date de début et en partant du total renseigné pour cette date. Seules les heures de vols dont la date sera postérieure à cette date de début seront prises en compte pour ce calcul.

'''Attention :''' pour un calcul exact du potentiel restant, tous les vols postérieurs à la '''date de début de comptabilisation des heures''' doivent être saisis dans OpenFlyers.

===Affichage du potentiel estimé restant dans les créneaux de réservation===
Cela se fait en activant le champ additionnel spécifique [[Champs-métiers#bookingEstimatedFlightTime|bookingEstimatedFlightTime]].

===Initialisation de la gestion des alertes===
*Aller sur '''Gestion > Ressources > Navigabilité'''
*Cliquer sur l'icône Édition (le crayon) :
**Régler les 3 seuils d'alerte pour les potentiels (exemple 10 h, 0 h et -5 h)
**Régler les 3 seuils d'alerte pour les dates calendaire (exemple 15 jours, 8 jours et 0 jours)

==Butées de maintenance==
*Aller sur '''Gestion > Ressources > Navigabilité'''
<center>[[Image:Maintenance_table_fr.jpg|Tableau de bord maintenance]]</center>
*Cliquer sur l'icône Modifier (le crayon) :
<center>[[Image:Maintenance_detail_fr.jpg|Maintenance]]</center>
:Prochaine butée calendaire : c'est la date qui servira de référence pour les alertes calendaires (ex : renouvèlement CDN). En attendant le module de gestion de la maintenance, le mécanicien gère lui-même la butée en mettant la butée selon son programme d'entretien
:Prochaine butée horaire : c'est le compte horaire de référence. Le programme soustrait de cette valeur le nombre d'heure de référence indiqué dans la page Aéronef et le temps de vols saisi par les pilotes pour définir le potentiel restant
:Seuil des alertes : Il y a 3 niveaux d'alerte horaire et calendaire à mettre selon les souhaits du mécanicien. L'alerte visualisée sur le cahier de réservation sera la première des échéances atteintes
Le programme calcule à chaque vol le total des heures de vol depuis la date d'initialisation (HdV) et affiche le potentiel restant (Pot) à gauche du cahier journalier et affiche sous chaque réservation le potentiel estimé (durée indiquée par l'utilisateur lors de la réservation ou 50% de la durée de la réservation en absence d'information)
<SQL>Potentiel = Prochaine butée horaire - (Total des heures à la date de début + HdV)</SQL>

*Le programme surveille ces 2 butées :
** Alerte visuelle si la date du jour approche les seuils de date calendaire.
** Alerte visuelle si on approche les seuils de fin de potentiel.

Le survol de la souris sur le voyant indique si c'est la date ou le potentiel (ou les deux) qui a déclenché l'alerte

* Il est conseillé de mettre à jour les valeurs d'initialisation une fois par an

==Gestion des points fixes==
On appelle un point fixe le fait de faire tourner le moteur d'un aéronef pour en contrôler les paramètres sans que cela soit suivi d'un vol. Il s'agit d'une action prévue pour certaines opérations de maintenance.

Pour les aéronefs équipés d'horamètres, le point fixe "fait tourner l'horamètre".

OpenFlyers préconise de ne pas saisir les points fixes en tant que vol car il n'y a pas de vol réalisé. Cela évite de d'impacter inutilement le potentiel de l'aéronef qui est normalement déterminé uniquement par les heures de vols.

Aussi, à l'issu d'un point fixe, la seule action à effectuer dans OpenFlyers consiste à mettre à jour le compteur :
*'''Gestion > Ressources > Actives'''
*Cliquer sur l’icône "Crayon" dans la colonne '''Actions''' de la ligne de l'aéronef concerné
*Mettre à jour le champ '''Dernier compteur enregistré'''
*Valider

Ainsi, lors de la prochaine saisie d'heure de vol, le compteur départ correspondra au compteur mis à jour. Cela n'empêchera pas l'utilisateur de voir s'afficher ensuite une alerte mais il pourra vérifier sur le carnet de route ou sur tout autre document mis en place par la structure que cet écart est justifié. De la même façon, lors de la [[#Valider-une-activité|validation des activités]], l'écart de compteur ressortira et sera justifiable.

==Modification des butées suite à un vol validé mal saisi==
Si un vol a été validé et que l'on se rencontre à posteriori qu'il a été mal saisi, il faut alors intervenir pour corriger les erreurs de calcul de potentiel restant qui en résultent. Pour cela, il y a plusieurs possibilités :
*Si le vol saisi initialement a une durée inférieure au vol réellement effectué : il faut saisir un vol complémentaire dont la durée correspond au temps de vol manquant.
*Si le vol saisi initialement a une durée supérieure au vol réellement effectué : il faut reprendre la procédure d'[[#Initialisation-de-la-gestion-des-potentiels|initialisation de la gestion des potentiels]] pour enlever au temps cellule initial le temps de vol décompté en trop de sorte à avoir un potentiel restant qui soit juste.

Du fait de l'[[Comptabilité#Inaltérabilité-des-données|inaltérabilité des données]], il n'est pas possible de modifier une écriture validée.

Il ne faut pas oublier de [[Utilisation-de-la-comptabilité#Annuler-l'effet-d'une-écriture-comptable|corriger comptablement l'effet des écritures]].

=Types de composants=
Les types de composants sont répertoriés dans un catalogue tenu à jour par OpenFlyers. Chaque type de composant est caractérisé par son étiquette et sa catégorie. Il existe 4 catégories définies ci-dessous :

==Documents==
Il s'agit des documents nécessaires pour la gestion et la traçabilité des activités de maintenance. Ils incluent les manuels de maintenance, les bulletins de service, les certificats de conformité, les rapports d'inspection, etc.

'''Exemples''' : Manuels de maintenance de l'aéronef (AMM), Certificat d'Examens de Navigation (CEN), Assurance, Fiche de pesée, etc.

==Éléments==
Il s'agit des composants physiques individuels ou des parties spécifiques de l'aéronef, comme les pièces de rechange, les sous-ensembles, ou les équipements spécifiques.

'''Exemples''' : Un moteur, un hélice, un train d'atterrissage, des instruments de cockpit, etc.

==Inspections==
Il s'agit des activités spécifiques de vérification et de contrôle des composants ou des systèmes de l'aéronef pour s'assurer qu'ils sont en bon état de fonctionnement et conformes aux normes de sécurité.

'''Exemples''' : Inspection de pré-vol, inspection de corrosion, contrôle non destructif (CND), etc.

==Visites==
Il s'agit des visites planifiées pour la maintenance, qui peuvent inclure des vérifications générales, des réparations ou des remplacements de composants.

'''Exemples''' : (50H, 100H, 600 H / 2 ANS, etc)

Rapporter un bug

2024-10-02T17:28:01Z

Lhenry: Text replacement - "Fichier:" to "File:"

[[File:BTS home.jpg|thumb]]

__TOC__

=Introduction=

L'outil de gestion de tickets client d'OpenFlyers utilise le logiciel OpenProject disponible à l'adresse https://project.openflyers.com.

Afin de pouvoir voir et créer un ticket, il est nécessaire de créer un compte. '''Ce compte est indépendant de votre accès à la plateforme OpenFlyers au gestionnaire client d'OpenFlyers'''.

Nous sommes conscients que l'utilisation de cet outil nécessite un peu plus de temps pour rapporter une anomalie que l'envoi d'un email. Mais pour l'équipe de développement OpenFlyers, c'est un véritable gain de temps qui permet ainsi d'être plus efficace et donc de limiter les coûts.

=Créer son compte=
*Se rendre sur le gestionnaire de ticket à l'adresse https://project.openflyers.com.
*En haut à droite, cliquer sur '''Connexion''', puis '''Créer un compte'''.
*Remplir le formulaire d'inscription. Le mot de passe doit contenir au moins 10 caractères.

[[File:Inscription-BTS.jpg|400px]]

Un email de confirmation est envoyé par le BTS.
*Aller sur la messagerie pour retrouver cet e-mail et cliquer sur le lien permettant d'activer le compte.
L'envoi de l'e-mail est instantané mais il est possible de devoir attendre plusieurs minutes avant qu'il n'apparaisse dans la messagerie du fait d'un traitement par le serveur de messagerie recevant l'email. Si l'email n'est pas reçu, vérifier qu'il n'a pas été mis de côté (voir supprimé) par un outil anti-spam attaché à la messagerie. Enfin, si l'e-mail n'est pas retrouvé, il faut envoyer un e-mail au support OpenFlyers de demande d'activation manuelle du compte en nous précisant l'identifiant que choisi pour sa création.
*Cliquer sur le lien contenu dans le message pour activer votre compte.
*Se connecter.

=Comment rapporter un bug=
*[[#Se-connecter|Se connecter]]
*Sur la page d'accueil, dans la case "Projets", cliquer sur '''OpenFlyers'''.
*Dans le menu de gauche, cliquer sur '''Lots de travaux''' (ou '''Work Packages''' en anglais).
*Avant de rapporter un bug, prenez le temps d'effectuer les actions suivantes :
**Vérifier que le bug n'est pas déjà rapporté.
**Renseigner les items dès le début pour éviter l'envoi dans une rubrique non adaptée.
*Cliquer sur le bouton vert '''Créer'''
Un formulaire s'affiche avec comme titre '''New PROBLEME'''
*Remplir les champs '''titre''', '''description''' et '''Order Id'''
:*Dans le champ '''titre''' :
::*Indiquer entre parenthèses sur quelle plateforme OpenFlyers le problème est rencontré suivi d'un titre synthétisant le problème (exemple : ''(ac-nasa) Impossible de se connecter'')
:*Dans le champ '''description''' :
::*Préciser l'identifiant de l'utilisateur concerné
::*La description doit être la plus complète possible pour que les développeurs puissent reproduire le problème.
::*La nature "réelle" (non affichage, alerte, etc.) du problème et sa manifestation.
::*Quelles sont les actions qui conduisent au bug sous la forme de fils d'Ariane (exemple : '''Admin > Utilisateurs > Utilisateurs''' puis icône '''Modifier la fiche utilisateur''')
::*Joindre une copie d'écran est parfois plus explicite que de longs discours. Ne pas en abuser, on ne cherche pas à documenter un bug pour le contourner mais à fournir des explications au développeur pour qu'il puisse le traiter.
:*Dans le champ '''Order Id''' :
::*Mettre la valeur 0
*Cliquer sur le bouton '''Enregistrer'''.

Remarques :
*En cours de traitement, utiliser les notes pour ajouter des informations, éviter les échanges par email parallèles.
*Lorsque le bug est résolu vous recevrez un email d'information :
:*Merci de bien vouloir confirmer que le bug est résolu en '''fermant votre rapport de bug'''.
:*Si vous constatez que la solution ne correspond pas à votre description (totale ou partielle), relancez le sujet en le changeant d'état.
:*Par contre si vous détectez une nouvelle anomalie rédigez un nouveau rapport de bug.
:La fermeture du Bug doit être effectuée par celui qui l'a émis.
:En l'absence d'action de votre part dans un temps raisonnable le développeur ou un administrateur le fermera.

==Faire une copie d'écran==
Il est souvent utile de joindre une copie d'écran montrant le problème. Cela permet de montrer visuellement le problème et peut nous faire gagner un temps précieux à comprendre la description du problème.

Le site de [http://www.commentcamarche.net www.commentcamarche.net] présente une explication sur [http://www.commentcamarche.net/faq/398-capture-d-ecran-copie-d-ecran comment réaliser des captures d'écran].

Sous Windows, la combinaison de touches Alt + PrintScreen donne le meilleur résultat dans la plupart des cas : la fenêtre active est capturée et placée dans le presse papier. Il faut l'enregistrer avec un nom de fichier type jpg. Pour cela il existe une multitude de [http://www.commentcamarche.net/download/graphisme-9 logiciels de traitement d'images]. Ceci dépend des utilisations que vous souhaitez en faire :
*le plus simple est l'utilitaire Paint inclut dans Windows mais il n'est pas très pratique
*[http://www.gimp.org/ Gimp] est très complet mais lourd pour juste faire des copies d'écran

[http://www.faststone.org/ FastStone] est pratique si vous devez capturer une page qui est plus grande que l'écran ou une portion de l'écran et il permet de sauver la capture au format que l'on souhaite.

=Description des états et de l'avancement de la résolution=
==Etats==
{| {{prettytable}}
!Intitulé de l'état!!Description!!Qui devrait mettre cet état
|-
|nouveau||nouveau bug, c'est l'état initial||le rédacteur du bug
|-
|commentaire||le bug nécessite plus d'informations, le rédacteur du bug devrait y préter attention||un gestionnaire ou un développeur
|-
|accepté||le bug a été lu mais n'est ni confirmé ni assigné||un gestionnaire ou le développeur dont dépend le bug
|-
|confirmé||le bug est confirmé et reproductible||un gestionnaire ou un développeur
|-
|assigné||le bug est assigné à un développeur||un gestionnaire ou un développeur qui le prend en charge
|-
|résolu||le bug devrait être résolu, en attente de la confirmation de sa résolution par le rédacteur du bug||le développeur qui a corrigé le bug
|-
|fermé||le bug est fermé||le rédacteur initial du bug ou un gestionnaire ayant confirmé le bug
|}
==Résolutions==
{| {{prettytable}}
!Intitulé de la résolution!!Description
|-
|ouvert||bug ouvert en attente
|-
|résolu||bug résolu d'après le développeur responsable
|-
|réouvert||bug considéré comme toujours existant après correction
|-
|impossible à reproduire||le bug rapporté n'arrive pas à être reproduit
|-
|impossible à corriger||il n'y a pas de possibilité de corriger le bug
|-
|doublon||le bug a déjà fait l'objet d'un rapport dans le BTS
|-
|pas un bug||Ce n'est pas considéré comme un bug
|-
|suspendu||Le bug est mis de côté
|-
|ne sera pas résolu||Le bug est reconnu mais ne sera pas résolu
|}
=Comment fermer un rapport ?=
Une fois qu'un rapport est positionné sur "résolu", voici comment procéder pour le fermer :
*Cliquer sur le bouton "Rouvrir"
*Mettre l'état du bug sur "fermer"

=Se connecter=
*Aller sur https://project.openflyers.com
*Cliquer en haut à droite sur le bouton '''Connexion'''
*Renseigner l'adresse l'email de connexion dans le champ '''Nom d'utilisateur'''
*Renseigner le champ '''Mot de passe'''
*Cliquer sur le bouton '''Connexion'''

=Traitement des bugs dans le BTS (pour les développeurs et gestionnaires)=
*Lorsqu'un bug est résolu il faut faire attention à le marquer comme tel dans la '''version en cours''' de modif (=donc normalement la future version publiée)
*La fermeture du Bug doit être effectuée par celui qui l'a reporté.
*En l'absence d'action de sa part dans un temps raisonnable un gestionnaire le fermera.
'''Suivez vos bugs'''

=Interopérabilité=
==JavaScript==
Les interactions dynamiques d'OpenFlyers nécessitent que JavaScript soit actif. Voici une page du support AdSense de Google qui présente [https://www.google.com/adsense/support/bin/answer.py?hl=fr&answer=12654 les différentes méthodes d'activation de JavaScript] en fonction du navigateur.

Présentation d'OpenFlyers 4

2024-10-02T17:28:00Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Migrer vers OpenFlyers 4=
==Les nouveautés de la version 4==
OpenFlyers repense son interface avec la version 4 afin d'offrir un confort d'utilisation pour les utilisateurs disposant d'écran à forte résolution ou d'écrans tactiles.

Ainsi, la version 4 est prévue être accessible via trois interfaces graphiques différentes :
*L'[[#Appli-OpenFlyers|appli téléchargeable]] (actuellement en développement).
*L'[[#Interface-dynamique|interface dynamique]] (en version alpha)
*L'[[#Interface-légère|interface légère]] qui correspond à l'interface historique d'OpenFlyers qui a fait son succès et qui a été rafraichie pour l'occasion afin de garder un caractère moderne tout en maintenant sa légèreté qui lui permet d'être facilement utilisable dans des lieux où le débit du réseau est limité.

Outre ses nouvelles interfaces, OpenFlyers 4 offre de nombreuses nouvelles fonctionnalités et continue de s'enrichir au fil des semaines en fonction des demandes de ses clients. Notamment le stockage des validités permet aux organismes ATO ou DTO de dématérialiser l'archivage des documents associés à certaines validités des utilisateurs tout en étant conforme à la réglementation.

De nombreuses nouvelles fonctionnalités sont disponibles. Il est possible de retrouver la liste complète dans l'historique des versions :

https://openflyers.com/fr/doc/of4/Historique-des-versions

==Tester la version 4 avant de migrer==
Il est possible pour les clients sous version 3.6 de [[Compte-client-OpenFlyers-et-modèle-commercial#Plateforme-supplémentaire-de-test|créer automatiquement une recopie de leur base de données sur une plateforme OF4]] pour pouvoir la découvrir et la tester avant de passer en production dessus.

Pour les autres clients, il suffit d'aller sur une plateforme de démonstration :
https://openflyers.com/fr/etudes-cas

==Demander à migrer vers la version 4==
Les clients disposant d'une plateforme OpenFlyers sous une ancienne version et souhaitant migrer vers la version 4 peuvent le faire très simplement en effectuant les actions suivantes :
*Uniquement pour les clients First-Price : créer et payer la facture de 100 € HT de demande de migration dans l'espace client https://client.openflyers.com
*Pour tous les clients : envoyer un email à OpenFlyers en tant que responsable OpenFlyers de sa structure et demandant la migration.

Dans l'email, il faut préciser s'il faut activer l'interface dynamique qui est, pour le moment, en version "alpha".

En général, la migration est effectuée la semaine suivant la demande sauf le vendredi et de préférence le lundi.

'''Attention''' : la migration est irréversible et les rapports personnalisés ne sont pas mis à jour. D'ailleurs l'accès à ces derniers est supprimé sauf demande express pour les conserver. Il est recommandé de ne le faire que si la structure dispose d'un informaticien qui s'engage à les maintenir.

=Les interfaces de la version 4=
==Appli OpenFlyers==
Une appli OpenFlyers est en cours de finalisation. Elle sera téléchargeable dans un premier temps sous Android puis ensuite sous iOS.

==Interface légère==
L'interface légère correspond à l'interface historique d'OpenFlyers. Elle contient non seulement l'ensemble des fonctionnalités qui étaient présentes sur l'ancienne version 3 mais également les nouvelles fonctionnalités qui font leur apparition progressivement sur la version 4 en fonction des demandes des clients. Cette interface a le mérite de pouvoir être facilement accessible lorsque la connexion internet souffre d'un débit limité.

=Refonte complète du design et de l'ergonomie=

==Fil d'Ariane==
Le [[Wikipedia-fr:Fil_d'Ariane_(ergonomie)|fil d'Ariane]] est présent uniquement sur l'[[#Interface-légère|interface légère]]. En effet, il est construit d'après l'[[Wikipedia-fr:Arborescence|arborescence]] de la plateforme, celle-ci correspondant aux différents niveaux des menus et sous-menus.

L'[[#Interface-dynamique|interface dynamique]] ne contient pas de fil d'Ariane car le [[Menu-de-l'interface-dynamique|menu]] est potentiellement ré-organisable par l'utilisateur.

==Interface graphique==

===Emails===

====Aspect====
[[File:Mailing.png]]
====Types d'emails====
*[[Envoi-des-emails|E-mails automatiques]]
*[[Mailing|Mailing]]

===Interface multi-supports===
====Adaptation aux différentes résolutions d'écrans====
L'interface graphique d'OpenFlyers4 a été conçue pour '''s'adapter''' à l'écran de l'utilisateur. Que l'écran soit large (PC) ou étroit (tablette en mode portrait et bientôt sur smarphone), les éléments se redisposent de manière à offrir lecture et interactions optimisées.

====Optimisation pour l'utilisation tactile====
Les interactions sont aisément réalisables sur écrans tactiles :
*De nombreuses actions s'effectuent par '''balayage''' ou '''glisser-déposer'''.
*La '''taille''' des éléments est suffisamment grande pour les manipulations tactiles.

===[[Ergonomie#Gestes|Gestes]]===

==[[Menu de navigation]]==

==Planning de réservation==

[[File:OF4-planning-doigt.png]]

====[[Aspect du planning de réservation|Palette d'outils associée au planning]]====
L'interaction entre les lignes du planning et la palette d'outils permet une gestion dynamique des réservations.

====[[Aspect du planning de réservation#Iconographie|Pictogrammes et code-couleurs]]====
De nombreux éléments visuels pour accéder rapidement à l'information et aux interactions.

====Visualisation immédiate des ressources====
Chaque [[Glossaire|ressource]] est identifiée par un pictogramme dédié, quel que soit l'emplacement où elle se trouve : [[Aspect du planning de réservation#Palette_d'outils|palette d'outils]], [[Aspect du planning de réservation#Lignes_du_planning|lignes du planning]], [[Aspect du planning de réservation#Composition_d'une_réservation|réservation]].

====[[Aspect du planning de réservation#Réservations_de_l'utilisateur_connecté|Réservations de l'utilisateur connecté]]====
Pour distinguer immédiatement ses propres réservations.

====[[Utilisation du planning de réservation#Redimensionnement|Redimensionnement de la réservation]]====
Le redimensionnement s'effectue directement sur les lignes du planning, par glisser-déposer.

====[[Utilisation du planning de réservation#Réservation_incomplète|Réservations incomplètes]]====
Les réservations, même incomplètes, sont matérialisées sur le planning et affectées à un utilisateur.

===Publicité===
La publicité permet à OpenFlyers de proposer des [https://openflyers.com/fr/tarifs tarifs d'abonnements] modiques à ses clients.

Elle s'affiche sous forme de bannières sur le [[Aspect du planning de réservation|planning de réservation]], la page de [[connexion]] et les [[#Emails|emails]], selon la formule d'abonnement choisie.

{| class="wikitable"
!Formule d'abonnement!!Publicité sur le planning!!Publicité sur la page de connexion et les emails
|-
|[[#Solo|Solo]]||Oui||Oui
|-
|[[#First Price|First Price]]||Oui||Oui
|-
|[[#Business|Business]]||Non||Oui
|-
|[[#Business+|Business+]]||Non||Non
|-
|[[#Première|Première]]||Non||Non
|}

==[[Tableaux|Tableaux]]==
[[File:Table4-1-generic.png]]

====[[Aspect des tableaux#Adaptation_à_la_taille_de_l'écran|Adaptation à la taille de l'écran]]====
Les dimensions du tableau s'adaptent à celles de l'écran de l'utilisateur. Il est ensuite possible de faire coulisser le contenu dans l'espace disponible. Ainsi, le contenu reste facilement accessible, quel que soit le support.

====[[Utilisation des tableaux#Édition_des_données|Éditions des données]]====
Mise à jour instantanée, sans rechargement de page.

====[[Utilisation des tableaux#Ordonnancement|Ordonnancement]]====
Il est possible de changer l'ordre des lignes du tableau par glisser-déposer.

====[[Utilisation des tableaux#Ajout/suppression-de-ligne|Ajouter et supprimer des lignes]]====
L'utilisateur peut ajouter ou supprimer des lignes rapidement.

====[[Aspect des tableaux#Tableau_à_onglets|Tableaux à onglets]]====
Certains tableaux comportent plusieurs sections. Celles-ci sont accessibles par onglets.

====[[Aspect des tableaux#Tableaux_à_pages|Tableaux à pages]]====
Certains tableau comportent des tableaux imbriqués. Ceux-ci sont accéssibles depuis le premier tableau grâce à un système de pagination.

Utilisation des réservations internes sur l'interface web

2024-10-02T17:27:59Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de présenter le planning et le formulaire de réservation de l'[[Présentation-d'OpenFlyers-4#Interface-légère|interface légère]] de la [[Accueil|version 4 d'OpenFlyers]].

=Aspect du planning de réservation=
==Activité ouverte==
Lorsqu'une activité et en cours :
*Le créneau horaire correspondant est coloré en bleu vif.
*Dans la zone de titre de ligne, un pictogramme animé apparaît, coloré du même bleu. Pour l'aéronautique, ce pictogramme représente un avion qui décolle.

[[File:planning-int-leg-activite-1.png]]

==Affichage des activités sur les réservations==
Cette fonctionnalité permet d'afficher les types d'activités associés à une réservation directement sur l'affichage de la réservation dans le planning sans avoir besoin de la survoler.

Cet affichage est en place lorsque l'utilisateur connecté dispose du droit [[Gestion-des-profils#Voir-les-activités-sur-les-réservations|Voir les activités sur les réservations]].

==Affichage des images des pilotes sur le menu contextuel==
Cette fonctionnalité permet d'afficher les images des personnes associées à une réservation sur le menu contextuel lorsqu'on survole ou effectue un clic droit sur une réservation dans le planning.

Cet affichage est en place lorsque l'utilisateur connecté dispose du droit [[Gestion-des-profils#Voir-les-images-des-pilotes-sur-le-menu-contextuel|Voir les images des pilotes sur le menu contextuel]].

[[File:images-des-pilots-sur-la-réservation.png|400px]]

==Créneaux horaires==
Lorsqu'une réservation ne comporte pas de nom, les intitulés des activités apparaissent sur le créneau de la réservation.

==Places disponibles==
Lorsqu'une ou plusieurs places sont indiquées comme disponibles pour une réservation, alors un pictogramme représentant un siège apparaît dans le créneau correspond à cette réservation.

Le nombre de places disponibles y est précisé : +1, +2, ou +3.

[[File:places-disponibles.png|400px]]

==Planning par type d'activité==
Lorsqu'un type d'activité est sélectionné, seuls les créneaux horaires réservés avec le type d'activité sélectionné sont affichés. En revanche, les autres plages horaires réservées sont affichées sur fond gris hachuré.

[[File:planning_By_Activity_Type.png|1000px]]

==Positionner automatiquement les activités d’un programme de formation==
Si la plateforme dispose du droit [[Gestion-des-profils#Réservation-de-programmes|réservation de programmes]] et des programmes de formation définis, lorsqu'on survole un créneau horaire dans le planning, un menu contextuel s'affiche, proposant les actions suivantes :
*'''Ajouter une réservation...''': Cette option permet de réaliser une réservation simple en affichant le [[#Formulaire-de-réservation|formulaire de réservation]].
*'''Ajouter un programme...''': En choisissant cette option, un pop-up s'affiche, permettant de sélectionner un programme de formation à ajouter au planning pour un utilisateur/client spécifique. En cliquant sur "Ajouter", des créneaux de réservation sont automatiquement générés si des ressources compatibles avec le type d'activité sont disponibles. Dans le cas contraire, ces créneaux sont placés dans une nouvelle ligne appelée "Activité non placée". Cette ligne est positionnée au début du planning, juste après la barre des heures, et reste fixe en haut de la page lorsque l'on fait défiler la page.

En survolant l'un des créneaux créés, tous les créneaux des réservations et des activités non placées du même programme s'affichent avec un effet de mise en surbrillance jaune. Pour supprimer tous les créneaux créés, il suffit de survoler l'un des créneaux de réservation et de cliquer sur l'action '''Annuler la réservation et les réservations liées'''.

Pour positionner une activité non placée, il est possible de soit la [[#Glisser-déposer-des-réservations|glisser-déposer]] à l'emplacement souhaité dans le planning, soit de cliquer sur le créneau pour afficher le [[#Formulaire-de-réservation|formulaire de réservation]].

=Ergonomie sur écran tactile=
==Appui court==
L'appui court au-dessus d'une réservation affiche le menu contextuel.

==Appui suivi d'un déplacement==
L'appui sui d'un déplacement peu de temps après l'appui fait déplacer tout le planning.

==Appui long==
L'appui long au-dessus d'une réservation sans bouger le doigt permet de [[#Glisser-déposer-des-réservations|glisser-déposer]] un créneau de réservation.

==Double-clic==
Double-clic au-dessus d'une réservation permet d'afficher le formulaire de réservation.

=Glisser-déposer des réservations=
La fonction de glisser-déposer est active pour tout utilisateur qui dispose du droit de réservation pour lui-même. Dans ce cas, il ne peut effectuer cette opération que pour les réservations qui le concerne.

;Écran non tactile
*Survoler la réservation qui a besoin d'être déplacée
Le pointeur de la souris se transforme en "4 flèches".
*Appuyer sur le bouton gauche de la souris pour sélectionner la réservation
*Déplacer la souris tout en maintenant le bouton gauche appuyé afin de déplacer le créneau de réservation sur le nouvel horaire et/ou la nouvelle ressource souhaités
*Relâcher le bouton gauche afin que la réservation soit mise à jour
Un pictogramme (roue qui tourne) apparaît en haut à gauche du rectangle de la réservation pour symboliser la mise à jour en base de données.

Lorsque cette mise à jour est effective, le pictogramme est remplacé pendant quelques secondes par une « check » verte.

;Écran tactile
*Maintenir un appui prolongé avec le doigt sur une réservation qui a besoin d'être déplacée
Un pictogramme "4 flèches" s'affiche en haut à gauche du rectangle symbolisant la réservation
*Déplacer son doigt afin de déplacer le créneau de réservation sur le nouvel horaire et/ou la nouvelle ressource souhaités
*Relâcher le doigt afin que la réservation se mette à jour
Un pictogramme (roue qui tourne) apparaît en haut à gauche du rectangle de la réservation pour symboliser la mise à jour en base de données.

Lorsque cette mise à jour est effective, le pictogramme est remplacé pendant quelques secondes par une « check » verte.

Un utilisateur disposant du droit d'effectuer des réservations pour des tiers peut procéder de la même façon pour toutes les réservations.

Lors du déplacement d'une réservation :
*si une alerte bloquante est générée elle est affichée et empêche le déplacement de la réservation
*si une alerte non bloquante est générée, elle n'est affichée que si le paramètre [[Configuration#Afficher-les-alertes-non-bloquantes-lors-des-glisser-déposer|Afficher les alertes non bloquantes lors des glisser-déposer]] est activé.

=Formulaire de réservation=
[[File:Formulaire_reservation_ancienne_interface.png|1000px]]

==Type d'activité par défaut==

Il est possible de cocher automatiquement un type d'activité sur le formulaire de réservation :
* Pour définir le type par défaut lors d'une nouvelle réservation ou lorsqu'on sélectionne une personne en première place, [[Configuration#Type-d'activité-par-défaut|suivre cette procédure de paramétrage]]
* Pour définir le type par défaut lorsqu'on sélectionne une personne en seconde place, [[Configuration#Type-d'activité-par-défaut-pour-la-seconde-place-(ancienne-interface)|suivre cette procédure de paramétrage]]

=Préparer un vol=
OpenFlyers est couplé avec [[Airmate]] pour aider les pilotes à préparer leur vol. Ainsi, depuis OpenFlyers il est possible de :
*coupler une réservation avec une préparation de vol Airmate en survolant la réservation concernée pour faire apparaitre le menu contextuel, puis de sélectionner l'item de menu '''Préparer le vol...'''
*créer un nouveau vol dans Airmate en cliquant sur l'item de menu '''Préparation vol > Préparer un vol'''
Voir la page [[Airmate]] pour les détails concernant l'inscription à Airmate et la synchronisation réservation/vol.

Paramétrage des validités

2024-10-02T17:27:59Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter le paramétrage des [[Validités#Définitions|validités]] sur la [[Accueil|version 4 d'OpenFlyers]].

Il existe également une page qui traite de l'[[Validités|utilisation des validités]].

=Ajouter un type de validités=
*'''Admin > Utilisateurs > Types de validités'''
*Cliquer sur le bouton '''Ajouter un type de validité'''
*Remplir les champs [[#Paramètres_de_configuration|en fonction du comportement attendu]].
*Cliquer sur le bouton '''Valider'''
La validité s'insère dans le tableau qui est trié par ordre alphabétique

==Paramètres de configuration==

===Nom===
Nom choisi pour désigner une validité

===Soumise à échéance===
Indique si la validité doit contenir une date d'échéance ou non

===Gestion du code identifiant===
Indique si un champ "code identifiant" est éditable pour y renseigner un code associé à la validité de l'utilisateur. Exemples : numéro de membre, numéro de licence, numéro de qualification, identifiant, etc.

===Gestion de la date d'obtention===
Indique si un champ "date d'obtention" doit être associé à la validité.
Exemples : date de délivrance d'un permis, date d'obtention d'un brevet, 1ère date d'inscription

===Associer un document===
Indique s'il est possible d'associer un document à une validité. Un document est constitué d'une ou plusieurs pages. Chaque page a un nom et peut être indépendamment obligatoire ou non. Lorsque le paramètre "associer un document" est activé pour un type de validité, les utilisateurs peuvent [[Validités#Téléverser-un-fichier|téléverser un fichier]] pour chaque page afin de l'associer à la validité correspondante dans l'[[Validités#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|interface des validités]].

===Validité bloquante pour la saisie (si requise)===
Indique le comportement pour ce type de validité que doit adopter OpenFlyers lors d'une tentative de saisie d'activité ou de réservation dont une validité requise est périmée ou absente. Si la validité est configurée comme bloquante, alors la saisie sera bloquée et impossible.

C'est utile en mode ouverture/fermeture d'activité où il est alors possible lors de l'ouverture de l'activité d'interdite un utilisateur de saisir son activité s'il manque un certain nombre de validités.

===Validité bloquante pour le contrôle d'accès (lorsque requise par un type de ressource)===
Cette colonne est visible uniquement dans le cas où un contrôle d'accès spécifique est interfacé avec OpenFlyers.

Elle permet de définir si une validité doit bloquer une autorisation d'accès gérée par un système de contrôle d'accès.

Le comportement du blocage est le suivant :
*OpenFlyers liste les validités qui ne sont pas détenues par un utilisateur et qui sont des [[#Paramétrer-pour-chaque-type-de-ressource-les-validités-requises|validités qui sont requises pour un type de ressource]].
*Si dans cette liste, il existe des validités qui sont marquées bloquantes pour le contrôle d'accès alors l'accès n'est pas autorisé.

===Alerte à la connexion===
Définit le comportement souhaité pour [[Connexion#Alertes-à-la-connexion|les contrôles des validités à la connexion]]. 4 types de comportements sont possibles lorsqu'une validité à échéance est périmée ou que l'expérience requise par la validité n'est pas suffisante :
*'''Pas de gestion''' : La validité n'est pas contrôlée à la connexion
*'''Alerte à la connexion''' : Affichage d'une [[Présentation générale des alertes#Description|alerte non bloquante]].
*'''[[Connexion#Restriction_d'accès|Accès restreint au profil X]]''' (où X peut désigner tout profil définit pour la plateforme) : Affichage d'une [[Présentation générale des alertes#Description|alerte non bloquante]] et qui induit des restrictions sur les droits de l'utilisateur.
*'''Pas d'accès''' : Affichage d'une [[Présentation générale des alertes#Description|alerte bloquante]].
'''Attention :''' une validité est considérée comme obsolète si les critères suivants sont remplis :
*Elle est détenue par l'utilisateur
*Sa date d'échéance est renseignée
*Sa date d'échéance est passée
Ainsi, si un utilisateur ne dispose pas de la validité, il ne sera pas alerté ou bloqué à la connexion. De la même façon, un utilisateur qui dispose d'une validité sans que la date d'échéance ne soit renseignée ne sera également pas impacté.

A noter également qu'un utilisateur qui dispose d'un profil ayant le droit de [[Gestion-des-profils#Surpasser-les-restrictions-sur-les-validités-expirées|surpasser les restrictions sur les validités expirées]] ne sera pas bloqué à la connexion si la restriction en place est '''Pas d'accès'''. Il aura une alerte surpassable.

===Formule d'expérience===
Lorsque ce champ est renseigné avec une formule, alors le type de validité devient une [[Validités#Validité-à-expérience|validité à expérience]]. Dans ce cas, la validité ne peut plus être attribuée à un utilisateur. Elle sert à vérifier que l'utilisateur remplit des critères variables au cours du temps. Elle est compatible avec tous les [[Validités#Contrôle-des-validités|cas de contrôle de validité]].

Exemples de validités à formule d'expérience :
*avoir plus de 3 atterrissages dans les 90 derniers jours
*ne pas dépasser plus de 90h dans les 30 derniers jours
cf. [[Formules de calcul#Expérience_récente|les formules de calcul d'expérience récente]].

Note : une validité à expérience ne peut, par conception, être attribuée à un utilisateur puisqu'il s'agit d'un test. Il existe une protection qui empêche de transformer un type de validité, attribué à au moins un utilisateur, en validité à expérience. Cette protection affiche le message d'erreur '''Vous ne pouvez ajouter de formule d'expérience car des utilisateurs sont encore liés à cette validité'''. Il est important de noter que même si le type de validité est supprimé de tous les utilisateurs, cette suppression n'est pas forcément complète en base de données et qu'il reste donc en mémoire le fait que ce type de validité a été associé à des utilisateurs. Dans ce cas, il n'est pas possible de transformer le type de validité en validité à expérience.

===Alerte échéance par email : 1er rappel===
Ce champ ne peut être renseigné que pour les [[#Soumise-à-échéance|validités soumises à échéance]]. Il indique la période d'échéance pour déclencher le [[Envoi-des-emails#Email-de-rappel-d'échéance-de-validité|premier rappel par email]].

Les validités sans date d'échéance ne déclenchent pas l'[[Envoi-des-emails#Email-de-rappel-d'échéance-de-validité|envoi du rappel]].

Les emails de rappels ne sont pas envoyés aux utilisateurs désactivés.

===Fréquence===

Ce champ ne peut être renseigné que pour les [[#Soumise-à-échéance|validités soumises à échéance]] et lorsque le champ [[#Alerte-échéance-par-email-:-1er-rappel|1er rappel]] a été renseigné.

Il détermine la fréquence de rappel, après le [[#Alerte-échéance-par-email-:-1er-rappel|1er rappel]], pour l'[[Envoi-des-emails#Email-de-rappel-d'échéance-de-validité|envoi de l'email d'alerte]].

S'il est sur ''aucun'' et que le champ [[#Alerte-échéance-par-email-:-1er-rappel|1er rappel]] a été renseigné, alors 1 seul envoi d'email est effectué à la date du 1er rappel.

Les validités sans date d'échéance ne déclenchent pas l'[[Envoi-des-emails#Email-de-rappel-d'échéance-de-validité|envoi du rappel]].

===Certification===
La cellule '''Certification''' a 5 choix possibles :
*'''Désactivée''' : la certification n'est pas active sur ce type de validité
*'''Requise''' : la certification est active. La validité ne sera considérée comme valide que si elle est [[Validités#Certification-manuelle|certifiée manuellement]]. Si un document peut être associé, la présence des pages obligatoires est requise.
*'''Par API FFA''' : la certification est active et réalisable exclusivement par le biais du [[Validités#Certification-automatique-à-partir-du-numéro-de-licence-délivré-par-la-Fédération-Française-Aéronautique|robot OpenFlyers en interrogeant l'API FFA]], ce qui signifie que la [[Validités#Certification-manuelle|certification manuelle]] n'est pas possible. De plus, les utilisateurs ne peuvent ni attribuer ni modifier la date d'échéance de la validité.
*'''Possible par robot (FFA)''' : la certification est active, un document est obligatoire qui doit correspondre au fichier PDF original de l'attestation de licence Fédérale délivrée par la FFA. Alors le robot [[Validités#Certification-automatique-de-l'attestation-délivrée-par-la-Fédération-Française-Aéronautique|certifie automatiquement]] le document associé à la validité.
*<s>'''Possible par OCR''' : La certification est active, un document doit être obligatoirement associé à la validité. Ensuite, [[Validités#Licence-de-pilote-privé-(PPL)|une certification automatique par OCR]] peut être effectuée.</s> ''(en développement)''
*'''Requise avec auto-remplissage (SEP)'''
Lorsque la certification est '''requise''', les personnes en charge de ce type de validités sont notifiées par e-mail lorsque une validité doit être certifiée ou re-certifier. Cela arrive dans l'un des cas suivant :
*La validité a été créée et est [[Validités#Validité-complète|complète]].
*La validité a été [[Validités#Validité-complète|complétée]].
*La validité était [[Validités#Validité-complète|complète]] et [[Validités#Certifier-des-validités|certifiée]], mais une page obligatoire a été modifiée.

Lorsque la certification est '''possible par robot''', les personnes en charge de ce type de validités sont notifiées par e-mail uniquement lorsque le robot n'est pas parvenu à certifier automatiquement le fichier téléversé.

Pour l'utilisation des validités avec certification, voir le chapitre [[Validités#Certifier-des-validités|certifier des validités]].

===Contrat===
Permet de définir si la validité est un contrat.

Un gestionnaire ne peut attribuer l'état "contrat" à une validité que si cette dernière n'est pas déjà attribuée à un utilisateur.

L'affectation de l'état de "contrat" à une validité est irréversible, sauf si aucun utilisateur n'a signé cette validité-contrat. Le but est d'empêcher de générer une rupture d'intégrité en base de données ou de perdre des signatures qui seraient dues à une erreur de manipulation.

Voir la procédure [[#Paramétrer-une-validité-comme-contrat|Paramétrer une validité comme contrat]].

===Fichier du contrat===

Permet de mettre en ligne un fichier PDF, ce fichier doit contenir le texte du contrat afin que les utilisateurs puissent le consulter.

Un fichier de contrat ne doit pas dépasser '''500ko'''.

Un contrat n'est proposé à la signature que lorsqu'il contient un fichier.

Cependant lorsqu'un contrat est complet (fichier mis en ligne), tous les utilisateurs qui appartiennent à un profil n'étant pas dispensé de ce contrat devront le signer à leur connexion. La connexion n'est pas possible tant qu'il reste des contrats non signés.

===Profils autorisés à gérer pour eux-mêmes===
Permet de sélectionner les profils autorisés à gérer pour eux-mêmes la validité.
<br/>
Le droit sur la "Gestion des profils" est nécessaire pour modifier les valeurs de cette colonne.

===Profils autorisés à gérer/certifier pour les autres===

Permet de sélectionner les profils autorisés à gérer et certifier la validité pour les autres utilisateurs.
<br/>
Le droit sur la "Gestion des profils" est nécessaire pour modifier les valeurs de cette colonne.
===Profils dispensés de signature===
Dans le cas d'une validité de type contrat, permet de sélectionner les profils dispensés de signature.
<br/>
Le droit sur la "Gestion des profils" est nécessaire pour modifier les valeurs de cette colonne.

=Paramétrer le [[Validités#Contrôle-des-validités|contrôle des validités]]=

==Paramétrer le contrôle des validités pour les activités ou les réservations==
Lors de la saisie d'une activité ou d'une réservation, le contrôle des validités s'effectue en fonction du type de ressource sélectionné et des types d'activités sélectionnés.

===Prendre en compte les validités requises pour un type d'activité donné===
*'''Admin > Structure > Paramétrage'''.
*Dans le formulaire aller sur la section '''[[Configuration#Gestion-des-activités|Gestion des activités]]''' ou sur la section '''[[Configuration#Gestion-du-planning|Gestion du planning]]''' selon si vous souhaitez configurer le contrôles des validités pour les activités ou pour les réservations
*Champ '''Prendre en compte les validités requises pour un type d'activité donné''', il faut choisir le comportement général parmi les choix suivants :
**'''En mode "Restreint"''' : cela fait apparaitre des alertes bloquantes lorsqu'il y a une absence de validités requises pour un type d'activité donné
**'''En mode "Avertissement"''' : cela fait apparaitre des alertes bloquantes ou non-bloquantes lorsqu'il y a une absence de validité requises pour un type d'activité donné. Le choix de l'alerte bloquante ou non est déterminé par OpenFlyers en fonction du [[#Validité-bloquante-pour-la-saisie-(si-requise)|paramétrage du type de validité]].
**'''Désactivé'''
*Puis vous pouvez [[#Paramétrer-pour-chaque-type-d'activité-les-validités-requises|paramétrer pour chaque type d'activité les validités requises]]

====Paramétrer pour chaque type d'activité les validités requises====
Les validités requises lors de la saisie d'une activité dépendent des types d'activités sélectionnés pour cette activité. Le paramétrage des validités requises pour chaque type d'activité s'effectue ainsi :
*'''Admin > Activités > Types d'activités'''
*Dans le tableau '''Types de validités requises (si seul à bord) pour un type d'activité donné''', cocher les validités requises pour chaque type d'activité

===Prendre en compte les validités requises pour un type de ressource donné===
*'''Admin > Structure > Paramétrage'''
*Dans le formulaire aller sur la section '''[[Configuration#Gestion-des-activités|Gestion des activités]]''' ou sur la section '''[[Configuration#Gestion-du-planning|Gestion du planning]]''' selon si vous souhaitez configurer le contrôles des validités pour les activités ou pour les réservations
*Champ '''Prendre en compte les validités requises pour un type de ressource donné''', il faut choisir le comportement général parmi les choix suivants :
**'''En mode "Restreint"''' : cela fait apparaitre des alertes bloquantes lorsqu'il y a une absence de [[#Validités-requises-pour-la-saisie-des-activités|validités requises]] pour une ressource donnée
**'''En mode "Avertissement"''' : cela fait apparaitre des alertes bloquantes ou non-bloquantes lorsqu'il y a une absence de validité requises pour une ressource donnée. Le choix de l'alerte bloquante ou non est déterminé par OpenFlyers en fonction du [[#Validité-bloquante-pour-la-saisie-(si-requise)|paramétrage du type de validité]].
**'''Désactivé'''
*Puis vous pouvez [[#Paramétrer-pour-chaque-type-de-ressource-les-validités-requises|paramétrer pour chaque type de ressource les validités requises]]

====Paramétrer pour chaque type de ressource les validités requises====
Ce paramétrage permet de définir les validités requises en fonction des types de ressources à la fois pour la [[Validités#Contrôle-des-validités-lors-de-la-saisie-d'une-réservation|réservation]] et la [[Validités#Contrôle-des-validités-lors-de-la-saisie-d'un-vol|saisie des activités]].

*'''Admin > Types de ressources > Actifs'''
*Dans le tableau qui liste les types de ressources, cliquer sur l'icône dans la colonne '''Action''' symbolisant une check-list [[File:Checklist.png]] et intitulée '''Validité'''.

On se retrouve avec un tableau qui permet de déterminer les validités requises d'une ressource donnée.

Les validités peuvent se suppléer les unes les autres. C'est la règle "ou" présente entre chaque validité d'une même ligne.

Si on souhaite que les validités s'ajoutent et soient toutes nécessaires, alors il faut les disposer sur des lignes différentes qui sont séparées par la règle "et" présente en début de ligne.

Exemples types :
*Si on souhaite qu'une validité A soit requise, il faut cliquer sur la check verte de cette validité sur la 1ère ligne. Une deuxième ligne apparait alors avec aucune validité de sélectionnée.

*Si on souhaite qu'une validité A et qu'une validité B soient toutes les 2 requises, il faut cliquer sur la check verte de la validité A de la 1ère ligne puis sur la check verte de la validité B de la 2ème ligne qui est apparue. Une 3ème ligne apparait alors également avec aucune validité de sélectionnée.

*Si on souhaite qu’indifféremment les validités A ou B soient requises, il cliquer sur les check vertes de chacune des validités de la 1ère ligne.

Exemple pratique : On souhaite qu'un utilisateur dispose d'un brevet PPL ou d'un brevet BB et qu'il dispose également d'une visite médicale de classe 1 ou de classe 2. Pour cela, on va cliquer :
*sur les validités "PPL" et "BB" de la 1ère ligne.
*sur les validités "Visite médicale classe 1" et "Visite médicale classe 2" de la 2ème ligne.

''Conseil OpenFlyers'' :
*En mode restreint, ne pas oublier d’attribuer les validités aux membres pour qu'ils ne soient pas bloqués. Il est recommandé de rester en mode avertissement durant plusieurs semaines avant d'activer les restrictions.

=Paramétrer des [[Envoi-des-emails#E-mail-de-rappel-d'échéance-de-validité|rappels par e-mail]] des validités à échéance=

Ce paramétrage n'est possible que pour les validités [[#Soumise-à-échéance|soumises à échéance]] :
*'''Admin > Utilisateurs > Types de validités'''
*Pour chaque validité soumise à échéance :
**Cliquer sur le bouton de modification (pictogramme "crayon")
**Champ [[#Alerte-échéance-par-email-:-1er-rappel|Alerte échéance par email : 1er rappel]] : Sélectionner une période d'échéance
**Champ [[#Fréquence|Fréquence]] : Sélectionner une fréquence de rappel ou "Aucun"

'''/!\ Les validités sans date d'échéance ne déclenchent pas l'[[Envoi-des-emails#Email-de-rappel-d'échéance-de-validité|envoi du rappel]].'''

Exemple de paramétrage de rappel qu'au premier mois d'échéance :
* [[#Alerte-échéance-par-email-:-1er-rappel|Alerte échéance par email : 1er rappel]] : 1 mois
* [[#Fréquence|Fréquence]] : Aucun

Exemple de paramétrage de rappel journalier au bout d'un mois d'échéance :
* [[#Alerte-échéance-par-email-:-1er-rappel|Alerte échéance par email : 1er rappel]] : 1 mois
* [[#Fréquence|Fréquence]] : Tous les jours

Exemple de paramétrage de rappel hebdomadaire au bout de deux mois d'échéance :
* [[#Alerte-échéance-par-email-:-1er-rappel|Alerte échéance par email : 1er rappel]] : 2 mois
* [[#Fréquence|Fréquence]] : Tous les 7 jours

=Paramétrer le surpassement des restrictions sur les validités=
''A l'inverse de ce qui est présenté dans ce chapitre, il est également possible de [[Gestion-des-profils#Créer-un-profil-empêchant-tout-surpassement|créer un profil restreint empêchant tout surpassement]].''

Comme indiqué dans le chapitre [[Validités#Contrôle-des-validités|Contrôle des validités]], que se soit à la connexion, lors d'une réservation ou lors d'une saisie d'activité, il est possible de mettre en place des restrictions qui bloqueront les utilisateurs n'ayant pas les validités requises.

Cependant, dans certains cas, il peut être nécessaire de permettre à certaines populations d'utilisateurs de pouvoir surpasser ces restrictions.

Le paramétrage du surpassement dépend de plusieurs choses :
*Est-ce que l'utilisateur peut surpasser lui-même ou est-ce que l'action que ne peut pas effectuer l'utilisateur peut être effectuée par une tierce personne
*Est-ce que la population d'utilisateurs concernés est définie par un profil ou non
*Est-ce que le surpassement est pour toute validité ou est-ce qu'il ne s'applique qu'à certaines validités

Voici quelques exemples de paramétrages possibles :

*Permettre aux instructeurs de pouvoir effectuer une réservation même s'ils n'ont pas l'expérience récente suffisante :
*:Comme les instructeurs disposent d'une validité permettant de connaitre leur statut d'instructeur, la méthode appropriée pour permettre aux instructeurs de surpasser l'absence d'expérience récente est la suivante :
**Aller dans '''Admin > Types de ressources > Actifs'''
**Cliquer sur le bouton symbolisant une liste de validités pour le type de ressource concerné
**Sur la ligne où la validité à expérience concernée est cochée, cocher également le type de validité correspondant aux instructeur (exemple : "Flight Instructor (FI)")

*Permettre à des utilisateurs n'ayant pas l'expérience récente en interne mais disposant de l'expérience récente suffisante grâce à leur activité externe de pouvoir surpasser la restriction, aussi bien en réservation qu'en saisie de vol, pour une validité à expérience récente donnée :
**[[#Ajouter-un-type-de-validités|Ajouter un nouveau type de validité]] à échéance intitulé ''expérience extérieure''
**Modifier la formule de la validité à expérience concernée pour y inclure la prise en compte de la validité ''expérience extérieure''. Cf. la formule de calcul [[Formules-de-calcul#Expérience-récente-en-heures-ou-la-détention-d'une-validité-spécifique|Expérience récente en heures ou la détention d'une validité spécifique]]

=Paramétrer une validité comme [[Validités#Validité-contrat|contrat]]=
*'''Admin > Utilisateurs > Types de validités'''.
*Cliquer sur le bouton '''Ajouter un type de validité'''.
*Choisir un nom pour le contrat.
*Cocher '''Contrat'''.
*Insérer le fichier contenant le corps du contrat dans '''Fichier du contrat'''.
*Si la validité-contrat ne doit pas être requise pour certains profils, cocher [[Gestion-des-profils#Contrats-non-requis|les profils exemptés]].
*Cliquer sur le bouton '''Enregistrer'''

Une fois ceci fait, tous les utilisateurs ou uniquement les utilisateurs n'appartenant aux profils exemptés devront [[Connexion#Signer-des-contrats|signer le contrat]] à leur connexion.

=Supprimer ou désactiver un type de validité=

*'''Admin > Utilisateurs > Types de validités'''
*L'icône symbolisant une poubelle permet de supprimer ou désactiver un type de validité.

Si cette validité a été attribuée à au moins un utilisateur, un message d'avertissement avec la liste des utilisateurs apparaît proposant deux options :

*La suppression : Permet de supprimer complètement le type de validité et les validités correspondantes détenues par les utilisateurs
*La désactivation :
**Permet de rendre obsolète un type de validité, notamment une validité contrat dont la signature ne sera désormais plus requise à la connexion tout en conservant l’historique des personnes ayant détenu cette validité ou ayant signé la « validité contrat ».
**Pour afficher les validités désactivées, cliquer sur le bouton de switch '''Afficher les items désactivés''' disponible au-dessus et en-dessous du tableau.
**Les types de validités désactivés s'affichent et se réactivent selon les [[Tableaux#Entrée-désactivée|caractéristiques des entrées désactivées des tableaux]].

Si une validité du type qu'il faut supprimer est rattachée à un type de ressource ou à un produit alors une alerte bloquante, avec la liste des éléments rattachés, empêche la suppression de cette validité. Il faut d'abord retirer la validité aux éléments concernés.

=Supprimer un type de validité déclaré comme contrat=
*'''Admin > Utilisateurs > Types de validités'''
*L'icône symbolisant une poubelle permet de supprimer un contrat s'il n'a été signé par personne, sinon la page qui permet de consulter les utilisateurs l'ayant signé s'ouvre. Contrairement aux types de validités classiques, l'interface ne propose pas de bouton de suppression forcée

Il est impossible de supprimer un contrat une fois qu'il a été signé par aux moins 2 personnes. Cela permet de conserver la signature des documents par les utilisateurs.

Panier de réservation

2024-10-02T17:27:59Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de présenter le panier de réservation de l'[[Présentation-d'OpenFlyers-4#Interface-dynamique|interface dynamique]] de la [[Accueil|version 4 d'OpenFlyers]]. D'autres pages de la documentation traitent de l'[[aspect du planning de réservation]] et de l'[[utilisation du planning de réservation]].

=Fonctionnement=
Les réservations créées sur le planning et sujettes à une tarification, sont ajoutées au panier. Cela va engendrer la génération [[Écritures-comptables|d'écritures comptables non validées]] pour chacune des réservations.

Le bouton "Payer" permet de valider les réservations présentes dans le panier. Cela a pour effet de :
* Si l'utilisateur connecté dispose du droit de [[Gestion-des-profils#Gestion-des-comptes|gestion des comptes]] ou que le solde de l'utilisateur suffisant, le compte est débité directement en validant les écritures générées
* Sinon une fenêtre pop-up s'ouvre pour alimenter le compte du montant manquant via un [[Paiement en ligne]] par carte bancaire. Après paiement, les écritures générées sont validées.
'''Attention : Certains navigateurs peuvent bloquer les fenêtres pop-up et ainsi empêcher d'effectuer le paiement. Dans ce cas, il faut ajouter une exception pour autoriser votre plateforme OF à ouvrir des fenêtres pop-up.'''

Lorsqu'une réservation validée est modifiée :
* Des [[Écritures-comptables|écritures comptables]] de contre-partie sont générées pour annuler le paiement précédemment effectué
* De nouvelles [[Écritures-comptables|écritures comptables non validées]] sont régénérées
Cela a pour conséquence :
* D'ajouter la réservation modifiée au panier
* De refaire un paiement pour valider à nouveau la réservation

Les réservations qui n'ont pas été payées au bout de 15 minutes sont supprimées automatiquement du panier et du planning.

=Tester le paiement à la réservation=
La plateforme de démonstration http://demo-paiement-reservation.openflyers.fr/ permet de découvrir le paiement à la réservation.

Pour se faire :
*Aller sur la plateforme [http://demo-paiement-reservation.openflyers.fr/ demo-paiement-reservation].
*Se connecter avec :
**identifiant : mbonsaint
**mot de passe : azerty
'''Attention :''' certains navigateurs peuvent bloquer les fenêtres pop-up et ainsi empêcher d'effectuer le paiement. Dans ce cas, il faut ajouter une exception pour [[FAQ-utilisateur#Comment-autoriser-les-fenêtres-pop-up|autoriser la plateforme à ouvrir des fenêtres pop-up]].

Avant de procéder à de quelconques tests de paiement, éditer la [[Fiche personnelle]] pour y mettre une adresse e-mail existante. Une carte bancaire factrice sera utilisée lors des tests.

* [[Utilisation-du-planning-de-réservation#Créer-une-réservation|Créer une réservation]] pour soi-même
* Aller sur le panier situé en haut à droite du planning
[[File:Panier_reservation.png]]
* Cliquer sur le bouton '''Payer'''
* Choisir comme moyen de paiement "CB" ou "Visa" et cliquer sur le bouton '''Effectuer un paiement'''
[[File:Interface_choix_paiement.png]]
* Saisir les informations de la carte bancaire et cliquer sur le bouton '''Valider'''. Pour les tests, utiliser '''1111222233334444''' comme '''numéro de carte''', les valeurs de la '''date de fin''' et le '''cryptogramme''' importent peu
[[File:Interface_saisie_carte_paiement.png]]
* Une fois sur le bon de commande, cliquer sur le bouton '''Retour commerce'''. Ce bon de commande sera aussi envoyé par email
[[File:Bon_commande_reservation.png]]

Normes et réglementations

2024-10-02T17:27:58Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de regrouper les différentes normes et réglementations qu'OpenFlyers respecte ou met en oeuvre.

=Cookies=
La [https://eur-lex.europa.eu/legal-content/FR/TXT/?uri=celex%3A32009L0136 directive 2009/136/CE] impose le consentement de l'utilisateur au stockage de données dans son équipement, c'est à dire le stockage des cookies dans les navigateurs.

Dans le cas d'OpenFlyers, les cookies utilisés sont des "cookies de session". Ils sont indispensables car ils permettent d'assurer la continuité de la connexion de chaque utilisateur après son identification initiale et ainsi lui permettent de naviguer sans avoir à ressaisir le couple identifiant/mot de passe à chaque page.

Depuis le 2 mai 2019, afin d'être conforme à cette réglementation, un article "Cookies" est inclus dans les conditions générales v. 11 et supérieures. Il permet d'informer l'utilisateur sur la nécessité de ce stockage.

Depuis le 18 juin 2019, sur les plateformes OpenFlyers sous version 4, la SARL OpenFlyers impose aux utilisateurs d'accepter les [https://openflyers.com/fr/entreprise/conditions-generales conditions générales d'OpenFlyers] grâce à la fonction [[Validités#Validité-contrat|validité-contrat]].

=Conservation des documents=
'''Documents comptables :'''

Depuis le 4 janvier 2003. Les documents comptables et les pièces justificatives doivent être conservé pendant dix ans.
{| class="wikitable"
!Type de document!!Durée de conservation!!Texte de loi
|-
|Livre et registre comptable||10 ans à partir de la clôture de l'exercice comptable||[https://www.legifrance.gouv.fr/affichCodeArticle.do?idArticle=LEGIARTI000006219327&cidTexte=LEGITEXT000005634379&dateTexte=20030104 article L123-22] du code de commerce
|-
|Pièce justificative (facture client et fournisseur)||10 ans à partir de la clôture de l'exercice comptable||[https://www.legifrance.gouv.fr/affichCodeArticle.do?idArticle=LEGIARTI000006219327&cidTexte=LEGITEXT000005634379&dateTexte=20030104 article L123-22] du code de commerce
|}

'''Documents fiscaux :'''

Depuis le 29 décembre 2016, selon [https://www.legifrance.gouv.fr/affichCodeArticle.do?idArticle=LEGIARTI000033815239&cidTexte=LEGITEXT000006069583&dateTexte=20170331 l'article L102 B] du livre des procédures fiscales, les livres, registres, documents ou pièces sur lesquels peuvent s'exercer les droits de communication, d'enquête et de contrôle de l'administration doivent être conservés pendant un délai de 6 ans à partir de la dernière opération mentionnée sur les livres ou registres ou de la date à laquelle les documents ou pièces ont été établis.

Cette article s'applique pour les documents concernant les différents impôts et les cotisations.

=Factures dématérialisées=
==[https://www.ssi.gouv.fr/entreprise/reglementation/confiance-numerique/le-reglement-eidas/ eIDAS]==
Le règlement eIDAS s'applique à l'identification électronique, aux services de confiance et aux documents électroniques. Il vise à mettre en place un cadre d'interopérabilité des différents systèmes présents au sein des États membres afin de développer un marché numérique de confiance. Des exigences relatives à la reconnaissance mutuelle des moyens d'identification électroniques et des signatures électroniques sont formulées dans le cadre des échanges entre organismes publics et usagers. Les échanges internes aux administrations n'y sont pas inclus.

L'adoption de ce règlement fait suite à un relatif constat d'échec de la directive 1999/93/CE sur la signature électronique. Le règlement eIDAS a pour objectif de mettre en place un socle commun d'interopérabilité afin de développer les échanges transfrontaliers. Contrairement à la directive 1999/93/CE, ce règlement est appliqué directement aux États membres de l'Union Européenne sans transposition dans leur droit national.

Le règlement eIDAS définit le [https://www.ssi.gouv.fr/administration/reglementation/confiance-numerique/le-referentiel-general-de-securite-rgs/ Référentiel Général de Sécurité] (RGS) qui correspond au cadre règlementaire permettant d’instaurer la confiance dans les échanges au sein de l’administration et avec les citoyens. Le RGS, a pour objet le renforcement de la confiance des usagers dans les services électroniques mis à disposition par les autorités administratives et s’impose ainsi à elles comme un cadre contraignant tout en étant adaptable et adapté aux enjeux et besoins de tout type d’autorité administrative.

La version initiale du RGS (v.1.0) a été rendue officielle par arrêté du Premier ministre en date du 6 mai 2010. Une version 2.0 a été publiée par arrêté du Premier ministre du 13 juin 2014. Ses mesures de transitions ont été étendues par arrêté du Premier ministre du 10 juin 2015. Elle est applicable depuis le 1er juillet 2014. La version 2.0 du RGS constitue un référentiel de transition entre une première version liée à la mise en œuvre de l’administration électronique et une troisième version qui se fondera sur la réglementation européenne en cours d’évolution.

Le Référentiel général de sécurité s’impose spécifiquement aux systèmes d’information mis en œuvre par les autorités administratives dans leurs relations entre elles et dans leurs relations avec les usagers.

==Fiscalité française==
La France reconnaît la signature électronique standard comme ayant une valeur juridique limitée et qui a pour vocation de simplifier des processus internes. Seules les signatures électroniques avancées et qualifiées ont une valeur juridique complète. La signature qualifiée, par rapport à la signature avancée, est l'équivalent de la signature manuscrite.

L'[https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000042910281/ article 289 VII du CGI] (Code général des impôts) indique qu'il existe trois solutions pour la transmission de factures électroniques :
* Soit en mettant en place des contrôles établissant une piste d'audit fiable (1°),
* Soit en recourant à la procédure de signature électronique avancée avec un certificat qualifié (2°),
* Soit en utilisant l'échange de données informatisées répondant aux normes prévues par le CGI (3°).

Le [https://bofip.impots.gouv.fr/bofip/8865-PGP.html/identifiant%3DBOI-TVA-DECLA-30-20-30-20-20180207 BOI-TVA-DECLA-30-20-30-20] indique au point '''70''' que dans une très petite entreprise, une comparaison manuelle des factures avec les documents commerciaux (devis, bons de commande, bons de livraison, justificatifs de paiement) peut constituer un contrôle suffisant mis en place par l'assujetti. Ainsi, chacun des éléments suivants doit être conservé et traçé : le devis qui devient le bon de commande, par la suite validé, le bon de livraison (avec l'impact des retours éventuels) et enfin la facturation (également avec l'impact des avoirs éventuels). Les contrôles établissant la piste d'audit doivent permettre de s'assurer que le passage de l'un à l'autre des documents précité est traçable dans les deux sens.

Le point '''80''' indique que, conformément à l'[https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000026892933/2013-01-01 article L. 13 D du livre des procédures fiscales (LPF)] et à l'[https://www.legifrance.gouv.fr/codes/article_lc/LEGIARTI000026949916/2013-01-01 article L. 80 F du LPF], si les contrôles sont effectués sous forme dématérialisée, les contribuables sont tenus de les présenter à l'administration sous cette forme.

Le point '''130''' indique que la piste d'audit doit permettre :

* de reconstituer, dans un ordre chronologique la totalité du processus de facturation, depuis son origine (par exemple, le bon de commande) jusqu'au document facture c'est-à-dire de reconstituer le processus documenté (bons de commande, bons de livraisons, extraits de compte...) d'une opération et de relier les différents documents de ce processus ;
* de garantir que la facture émise ou reçue reflète l'opération qui a eu lieu, en permettant d'établir un lien entre la facture et la livraison de biens ou la prestation de services qui la fonde ;
* de justifier toute opération par une pièce d’origine à partir de laquelle il doit être possible de remonter par un cheminement ininterrompu à la facture et réciproquement.

Concernant [https://www.pwcavocats.com/fr/ealertes/ealertes-france/2017/novembre/signature-electronique-eidas-admise-en-france.html la facture électronique sécurisée au moyen d’une signature électronique], il convient de distinguer deux situations :

* Seule la signature électronique avancée fondée sur un certificat qualifié et créée par un dispositif sécurisé de création de signature, c’est-à-dire la signature électronique qualifiée telle que définie ci-dessus, garantissent de façon autonome l'authenticité de l'origine et l'intégrité du contenu des factures. Ce dispositif prévu par l’article 289 VII 2° du CGI exonère de l’obligation de démonstration et de documentation de la piste d’audit fiable. Les prestataires de services de confiance qualifiés selon le RGS au niveau 2 étoiles (RGS**) ou 3 étoiles (RGS***), pourront bénéficier de modalités de qualification facilitées au titre du règlement eIDAS et ainsi de bénéficier d’une telle qualification au sens du règlement eIDAS.
* A l’inverse, les entreprises émettrices de factures assorties d'autres signatures électroniques (par exemple : signature avancée au sens de l'article 2, point 2, de la Directive 1999/93/CE du 13 décembre 1999 du Parlement européen signature simple ou conforme au RGS 1 étoile (RGS*)) doivent, aux fins de garantir l'authenticité de l'origine et l'intégrité du contenu des factures électroniques, mettre en place des contrôles établissant une piste d’audit fiable.

[[File:Acroba bandeau signature invalide.png]]

Il est donc possible d'utiliser la signature électronique standard, c'est-à-dire que la signature n'a pas pour objectif de certifier que l'auteur de la signature est bien le signataire lui-même. En contre-partie, des pistes d'audit fiables doivent être établies. Cela signifie que dans un lecteur de fichiers PDF comme Adobe Acrobat Reader par exemple, un bandeau indiquant "Validité de la certification du document INCONNUE. Impossible d'en authentifier l'auteur." n'indique pas que la signature est fausse mais que le logiciel n'est pas en capacité d'assurer l'authenticité de la signature.

==Norme PDF/A==
Le PDF/A est une version normalisée [https://fr.wikipedia.org/wiki/ISO ISO] du format [[PDF]] spécialisée pour l'archivage et la conservation à long terme des documents numériques. Le PDF/A diffère du format standard en interdisant les fonctionnalités inadaptées à l'archivage à long terme comme le chiffrement par exemple. Les visionneuses de fichiers PDF/A comprennent des directives de gestion des couleurs, la prise en charge des polices intégrées et une interface utilisateur pour la lecture des annotations intégrées.

Le PDF/A est une version particulière du format propriétaire PDF mis au point par [https://fr.wikipedia.org/wiki/Adobe_Systems Adobe Systems]. Le principal avantage du PDF/A est la fidélité vis à vis des documents originaux : les polices, les images, les objets graphiques et la mise en forme du fichier source sont préservés.

PDF est une norme pour l'encodage de documents sous une forme "telle qu'inprimée" qui est portable entre les systèmes. La pertinence d'un fichier PDF pour la conservation des archives dépend des options choisies lors de la création du PDF comme l'incorporation de polices nécessaires pour produire ou afficher le document, l'utilisation du chiffrement ou la conservation des informations supplémentaires du document original au-delà de ce qui est nécessaire pour l'impression.

La norme PDF/A est à l'origine une activité conjointe entre deux associations américaines : l'Association pour les fournisseurs de technologies d'impression, d'édition et de conversion et l'Association pour la gestion de l'information et de l'image dans le but d'élaborer une norme internationale pour l'archivage de documents au format PDF. L'objectif étant de répondre au besoin croissant d'archiver électroniquement des documents de manière à garantir la conservation de leur contenu.

OpenFlyers utilise la version 2 de la norme publiée en juin 2011 traite de certaines des nouvelles fonctionnalités ajoutées avec les version 1.5, 1.6 et 1.7 de PDF. Les fichiers PDF/A-1 ne sont pas nécessairement conformes à la norme PDF/A-2 et inversement.

La version 2 de la norme PDF/A est basée sur PDF 1.7 plutôt que PDF 1.4 et offre de nouvelles fonctionnalités :
* compression de données pour les images au format [https://fr.wikipedia.org/wiki/JPEG_2000 JPEG 2000]
* prise en charge des effets de transparence et des calques
* incorportation de polices de caractères [https://fr.wikipedia.org/wiki/OpenType OpenType]
* dispositions relatives aux signatures numériques conformément aux signatures électroniques avancées dans PDF (PDF Advanced Electronic Signatures, norme PAdES)
* l'option d'intégration de fichiers à la norme PDF/A pour faciliter l'archivage d'ensembles de documents avec un seul fichier.

La version 2 définit trois niveaux de conformité :
* PDF/A-2a : Conformité de niveau A (niveau avec accessibilité pour mal-voyant ou aveugle). Elle représente la forme complète de la norme ISO.
* PDF/A-2b : Conformité de niveau B (niveau de base). Elle représente une forme allégée de la norme ISO. Cette version préserve la lisibilité du document et sa bonne présentation à l'affichage et à l'impression.
* PDF/A-2u : Conformité de niveau U. Elle représente la conformité de niveau B (PDF/A-2b) avec l'exigence supplémentaire que tout le texte du document ait un mappage [https://fr.wikipedia.org/wiki/Unicode Unicode].

=Inaltérabilité des données et traçabilité des encaissements=
Conformément :
*Au [https://www.legifrance.gouv.fr/affichCodeArticle.do;jsessionid=0CC8197762CAEDE98ECD25A8E19BD9EE.tplgfr36s_2?idArticle=LEGIARTI000034309494&cidTexte=LEGITEXT000006069577&categorieLien=id&dateTexte=20180101 3° bis du I de l'article 286 du Code Général des Impôts de la réglementation française]

OpenFlyers v.4 et supérieur respectent cette réglementation. Ainsi :
*Les [[Comptabilité#Inaltérabilité-des-données|écritures comptables validées ne sont pas modifiables]]
*La traçabilité est garantie par l'[[Envoi-des-emails#E-mail-de-reçu|envoi automatique d'un email de reçu de paiement]] contenant une pièce jointe au format PDF avec un sceau chainé
*Sur les interfaces affichant les extraits de compte, un test est effectué pour chaque écriture comptable validée afin de vérifier que sa chaine n'a pas été falsifiée. Si le test est concluant un pictogramme symbolisant un cadenas apparait à droite de l'écriture comptable concernée. Si une rupture du chainage est identifié, le symbole du cadenas apparaît grisé avec une croix rouge.

Les clients concernés par l'obligation d'utiliser un logiciel conforme à la réglementation peuvent retrouver une attestation à compléter et à produire à l'administration fiscale en cas de contrôle. Cette attestation est disponible dans [[Compte-client-OpenFlyers-et-modèle-commercial#Accéder-à-son-compte-client-OpenFlyers|l'espace client]] menu '''Fiche contact > Attestation art. 286 du CGI'''.

=Protocole TLS 1.2=
Conformément :
*A la recommandation R3 du [https://www.ssi.gouv.fr/uploads/2016/09/guide_tls_v1.1.pdf guide TLS v1.1] du 19 août 2016 de l'[https://www.ssi.gouv.fr/ Agence Nationale de la Sécurité des Systèmes d'Information (ANSSI)] : "Utiliser uniquement TLS 1.2"
*Aux versions 3.1 et 3.2 de la [https://fr.pcisecuritystandards.org/minisite/env2/ norme de sécurité de l’industrie des cartes de paiement PCI-DSS] qui imposent l'abandon de SSL 3.0 et TLS 1.0 à la date du 10 avril 2018
Depuis le 1er mars 2018, sur l'ensemble de ses serveurs, OpenFlyers met uniquement en œuvre le protocole TLS 1.2 pour les échanges sécurisés via le port HTTPS.

Sur OpenFlyers v.4 et supérieur, les accès au logiciel se font exclusivement par le port HTTPS.

L'[[API-OpenFlyers#Script-client-:-Authorization-Code|exemple de script PHP]] concernant le contrôle d'identification par OpenFlyers pour un logiciel tiers est à jour de cette version de protocole.

=Obligation de fournir le fichier des écritures comptables=
Selon [https://www.legifrance.gouv.fr/affichCodeArticle.do?cidTexte=LEGITEXT000006069583&idArticle=LEGIARTI000006315024&dateTexte=&categorieLien=cid l'article L47 A-1] du livre des procédures fiscales, depuis le 1 janvier 2014, il est nécessaire pour les contribuables tenant leur comptabilité au moyen de systèmes informatisés de pouvoir fournir le Fichier des Écritures Comptables (FEC) dématérialisé.

Sont concernées, toutes les entreprises soumises à une obligation de présentation de documents comptables, qui tiennent leur comptabilité de façon informatisée et qui font l'objet d'une vérification de comptabilité. Ceci concerne donc :
*Les entreprises relevant de l’impôt sur les sociétés
*Les entreprises relevant de l’impôt sur le revenu dans la catégorie des BIC, des BNC ou des BA

En cas de contrôle les, un FEC doit être fourni pour chacun des trois derniers exercices clôturés.

=Obligation d'informer les utilisateurs=
Brochure mentionnée au paragraphe 1er de l'article 106 de la directive 2015/2366 du Parlement européen et du Conseil du 25 novembre 2015 :

https://ec.europa.eu/info/sites/default/files/business_economy_euro/banking_and_finance/documents/leaflet-your-rights-payments-eu_fr.pdf

=Prestation de Service d’Information sur les Comptes (PSIC)=
La S.A.R.L. OpenFlyers peut mettre à disposition un service d’import des informations de compte bancaire. Pour ce faire, elle peut faire appel à un sous-traitant dont le nom est indiqué dans ce chapitre.

=[[Règlement Général sur la Protection des Données|Règlement général sur la protection des données (RGPD)]]=
[https://openflyers.com/fr/entreprise/conditions-generales Les conditions générales d'OpenFlyers v. 2] sont conformes au règlement en incluant les [[Règlement-Général-sur-la-Protection-des-Données#Conditions-générales|mentions obligatoires]]. Pour rappel :
*Les données appartiennent aux clients d'OpenFlyers (et non pas aux utilisateurs finaux et encore moins à OpenFlyers)
*Cela ne veut pas dire que l'utilisateur ou le client peuvent demander de rectifier ou supprimer des données. En effet, d'autres règlements imposent la [[#Conservation-des-documents|conservation des données]] et il doit être possible de produire les logs de connexion des utilisateurs ou des actions effectuées sur une durée raisonnable.
*C'est aux structures clientes d'OpenFlyers de mettre en place, au travers du paramétrage, les droits qui permettent de garantir aux utilisateurs les accès de consultation de leurs données personnelles.
*Nous recommandons aux structures clientes de préciser dans leurs propres conditions générales ou dans leur règlement intérieur l'acceptation par l'utilisateur final de la nécessité de stockage, par la structure, des données qui concernent les utilisateurs.

Depuis le 27 mars 2019 (cf. actualité [https://openflyers.com/fr/actualites/certification-des-validites-et-validites-contrats Certification des validités et validités contrats]), OpenFlyers v.4 contient une fonction qui permet aux structures clientes de créer des [[Validités#Validité-contrat|validités-contrats]] que doivent signer les utilisateurs à la connexion. Cette fonction a vocation à permettre l'acceptation, par les utilisateurs finaux, des conditions générales ou du règlement intérieur d'une structure.

Depuis le 18 juin 2019, sur les plateformes OpenFlyers sous version 4, la SARL OpenFlyers impose aux utilisateurs d'accepter les [https://openflyers.com/fr/entreprise/conditions-generales conditions générales d'OpenFlyers] grâce à cette fonction [[Validités#Validité-contrat|validité-contrat]].

Depuis le 12 avril 2021, sur les plateformes OpenFlyers sous version 4, la fonctionnalité liées aux [[Données]] permet :
*de supprimer les données obsolètes
*de générer le registre de traitement des données personnelles prévu par le RGPD

Navigateurs

2024-10-02T17:27:57Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de regrouper les procédures concernant les navigateurs

=Autoriser les cookies=
==Autoriser les cookies sous Firefox==
*'''Outils > Options'''
*Onglet '''vie privée'''
*Cocher '''Accepter les cookies'''
*Bouton '''OK'''

==Autoriser les cookies sous Internet Explorer==
*'''Outils > Options internet'''
*Onglet '''Confidentialité'''
*Positionner le niveau de sécurité au maximum à '''Moyenne'''
*Bouton '''OK'''

==Autoriser les cookies sous iPhone / Safari==
*'''Réglages > Safari'''
*Régler '''Accepter les cookies'''
[[File:Accepter-cookies-iPhone-Safari.png]]

=Autoriser les fenêtres pop-up=
==Autoriser les fenêtres pop-up sur Firefox==
* Lorsque Firefox bloque une fenêtre pop-up, un bandeau apparaît en haut de page
[[File:Message_blocage_popup.png]]
* Pour autoriser la fenêtre, cliquer sur le bouton '''Options''' du bandeau
* Un menu déroulant apparait, cliquer sur '''Autoriser les popups pour "url de la plateforme"'''
[[File:Debloquer_popup.png]]
* La fenêtre pop-up va s'afficher. La fois d'après, la fenêtre pop-up s'affichera directement et vous n'aurez donc pas à suivre cette procédure

==Autoriser les fenêtres pop-up sur Internet Explorer==
* Lorsque Internet Explorer bloque une fenêtre pop-up, une notification apparaît en bas de la page
[[File:Message_blocage_popup_ie.png]]
* Pour autoriser la fenêtre, cliquer sur '''Options de ce site'''
* Un menu déroulant apparait, cliquer sur '''Toujours autoriser'''
[[File:Debloquer_popup_ie.png]]
* La fenêtre pop-up va s'afficher. La fois d'après, la fenêtre pop-up s'affichera directement et vous n'aurez donc pas à suivre cette procédure

==Autoriser les fenêtres pop-up sur Opera==
* Lorsque Opera bloque une fenêtre pop-up, une notification apparaît en haut à droite de la page
[[File:Message_blocage_popup_opera.png]]
* Pour autoriser la fenêtre, cliquer sur la notification
* Un menu déroulant apparait, cliquer sur '''Toujours autoriser les pop-ups de "url de la plateforme"'''
[[File:Debloquer_popup_opera.png]]
* La fenêtre pop-up va s'afficher. La fois d'après, la fenêtre pop-up s'affichera directement et vous n'aurez donc pas à suivre cette procédure

==Autoriser les fenêtres pop-up sur Safari==
* Cliquer sur l'icône de créneau en haut à droite
* Un menu déroulant apparait, cliquer sur '''Bloquer les fenêtres surgissantes''' pour enlever le symbole de coche
[[File:Debloquer_popup_safari.png]]

=Créer un favori=
Un favori, ou signet, permet d'avoir un lien d'enregistré dans le navigateur vers la plateforme OpenFlyers et ainsi d'éviter de devoir chercher la plateforme OpenFlyers dans un moteur de recherche.

==Créer un favori avec Firefox==
*Positionner la souris sur l'onglet de la page à mettre en favori
*Cliquer avec le bouton gauche en laissant appuyer
*Déplacer l'onglet vers la barre personnelle à l'endroit où on souhaite mettre le lien
*Relâcher le bouton gauche de la souris
Il est possible de supprimer l'affichage du nom de la page, pour ne garder que l'icône, en effectuant les actions suivantes :
*Survoler l'icône pour laquelle on souhaite supprimer l'affichage du nom de la page à sa droite
*Cliquer sur le bouton droit de la souris
*Cliquer sur le menu '''Propriétés'''
*Dans la fenêtre contextuelle :
**Supprimer le contenu dans le champ '''Nom'''
**Cliquer sur le bouton '''Enregistrer'''

=Créer une icône sur la page d'accueil d'un smartphone ou d'une tablette=
==Créer une icône sur la page d'accueil d'un smartphone ou d'une tablette Apple==
*Afficher la page d'accueil OpenFlyers dans le navigateur Safari
*Taper sur le bouton '''Partager''' (carré avec une flèche qui sort vers le haut)
*Taper sur le bouton '''Sur l'écran d'accueil'''
*Modifier éventuellement le nom dans la première ligne
*Taper sur le bouton '''Ajouter'''

=Désactiver AdBlock sur Chrome=
AdBlock peut empêcher l'affichage des zones d'informations (flux de la structure, météo, aerobuzz, aerovfr).

Pour empêcher la disparition de ces zones d'informations, il faut désactiver AdBlock pour le site openflyers.com. Voici la procédure :
*Se connecter à sa plateforme OpenFlyers
[[File:AdBlockMenuContextuel.jpg|200px]]
*Cliquer sur le bouton AdBlock symbolisant une main "stop" sur fond rouge en haut à droite du navigateur
*Cliquer sur '''Ne pas activer sur les pages de ce site'''
[[File:AdBlockChoixExclusion.jpg|300px]]
*Cliquer sur le bouton de confirmation '''Exclure'''
[[File:AdBlockRecapitulatif.jpg|300px]]
*Cliquer sur le bouton '''Terminée'''

=Empêcher la mémorisation des saisies dans les formulaires=
Sur Chrome :
*Icône menu > '''Paramètres'''
*'''Afficher les paramètres avancés'''
*Chapitre '''Mots de passe et formulaires''' : décocher '''Activer la saisie automatique pour remplir les formulaires Web en un simple clic'''

Sur Firefox :
*'''Outils > Options'''
*'''Vie privée'''
*Chapitre '''Historique''', décocher '''Conserver l’historique des recherches et des formulaires'''

=Imprimer avec un navigateur=
==Imprimer avec Chrome==
*Cliquer sur le bouton en haut à droite de la barre de navigation symbolisant un menu (trois traits horizontaux)
*'''Imprimer...'''

==Imprimer avec Firefox==
*'''Fichier > Imprimer...'''
Alternative si le menu n'est pas disponible :
*Cliquer sur le bouton en haut à droite de la barre de navigation symbolisant un menu (trois traits horizontaux)
*Cliquer sur le bouton symbolisant une imprimante

=Supprimer une saisie automatique=
Si le navigateur est paramétré pour enregistrer les champs dans un formulaire, il peut être nécessaire de pouvoir supprimer une entrée. C'est par exemple le cas lorsque l'on saisit par erreur son mot de passe dans le champ identifiant et qu'il se retrouve ainsi mémorisé en clair.

Dans le cas d'un ordinateur en accès public, il est déconseillé de paramétrer les navigateurs pour permettre cet enregistrement automatique. Voir [[#Empêcher-la-mémorisation-des-saisies-dans-les-formulaires|Empêcher la mémorisation des saisies dans les formulaires]].

Pour supprimer cette entrée il faut :
*Saisir le début du texte jusqu'à ce que l'entrée à supprimer apparaisse dans la liste des propositions en auto-complétion.
*Positionner le curseur de la souris sur l'entrée à supprimer.
*Appuyer sur la touche ''Suppr'' du clavier.

Kiosque PC

2024-10-02T17:27:56Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
Le but de cette page est de référencer et de proposer des solutions de configuration pour les ordinateurs en accès public.

Les objectifs d'un mode kiosque sont multiples et peuvent recouvrir les besoins suivants :
*Empêcher l'utilisateur de fermer le navigateur
*Empêcher l'utilisateur de changer les pages affichées
*Empêcher l'utilisateur de surfer sur d'autres sites que ceux autorisés
*Empêcher l'utilisateur de basculer sur d'autres programmes que le navigateur souhaité
*Empêcher l'utilisateur de lancer d'autres programmes
*Empêcher l'utilisateur d'accéder au "Bureau".
*Empêcher l'utilisateur de pouvoir éteindre l'ordinateur
*Permettre à l'utilisateur d'allumer l'ordinateur dans le cas où ce dernier a eu par exemple une coupure d'alimentation mais empêcher ce dernier d'accéder au BIOS.

Un prérequis pour la mise en place d'un ordinateur en mode kiosque consiste à ne proposer que les interfaces nécessaires à l'utilisateur :
*Souris
*Clavier
*Écran
Les autres éléments attachés à l'unité centrale ne doivent pas être accessibles (ports, lecteurs)

Pour un PC sous Windows, les opérations suivantes permettent de mettre en place un PC kiosque avec le navigateur souhaité :
*[[#Lancer_un_programme_au_démarrage_de_Windows|Lancer automatiquement un programme au démarrage de Windows]]
*[[#Configurer_un_navigateur_en_mode_kiosque|Modifier l'icône du raccourci pour que le navigateur soit lancé en mode kiosque]] (à effectuer avec l'icône du navigateur placée dans le répertoire de démarrage
*[[#Bloquer-Alt+F4-avec-Deskman|Paramétrer deskman pour qu'il désactive le raccourci [Alt+F4]]]
Il pourra être utile d'utiliser également [[#deskman|Deskman]] pour mettre en place des restrictions d'accès sur certains site internet ou de bloquer l'exécution de programmes ou des fonctionnalités liées à Windows.

=Créer un compte utilisateur Kiosque=
Il est possible de créer un compte utilisateur "kiosque" permettant de ne pas avoir de [[Connexion#Automatique|déconnexion automatique]] et permettant également d'avoir un retour automatique sur la page du planning du jour au bout de 5 minutes d'inactivité. Pour cela il faut effectuer les actions suivantes :
*Créer un profil "kiosque" de type public c'est à dire avec un picto associé noir [[File:Profile-management3.0.x_Userinfo_kiosk.gif]] (voir le chapitre des [[Gestion-des-profils#Icônes-symbolisant-les-droits-des-profils|Icônes symbolisant les droits des profils]]).
*Créer un compte kiosque/kiosque par exemple disposant de ce profil.
*[[#Définir_la_page_par_défaut_à_l'ouverture_du_navigateur|Mettre en place une page par défaut]] sur le navigateur du PC en accès public permettant une connexion automatique avec le compte kiosque.

=Définir la page par défaut à l'ouverture du navigateur=
En l'absence d'un mode kiosque pour un PC, il est toujours possible de mettre OpenFlyers en page par défaut du navigateur.

Pour pousser la personnalisation, il est possible de mettre dans l'adresse l'identifiant et le mot de passe de l'utilisateur sans droit ([[#Créer_un_compte_utilisateur_"visiteur"|type kiosque]]) afin de garder la page de cahier journalier affichée en permanence et dès le lancement du navigateur. Pour cela, il faut mettre en lien par défaut du navigateur le lien suivant :

<nowiki>https://</nowiki>openflyers.com/'''plateforme'''/?login='''identifiant'''&password='''motdepasse'''

En remplaçant :
*'''plateforme''' par le nom de la plateforme de sorte à obtenir l'URL de la plateforme à la place de <nowiki>https://</nowiki>openflyers.com/'''plateforme'''/
*'''identifiant''' par l'identifiant de l'utilisateur ayant un [[#Créer_un_compte_utilisateur_"visiteur"|profil kiosque]] et '''motdepasse''' par son mot de passe

Attention, ceci ne fonctionne que pour les comptes qui n'ont uniquement un profil type "kiosque", c'est à dire sans aucun droit.

==Page par défaut dans Firefox==
*Aller dans '''Outils > Options'''
*Dans l'onglet '''Général''', renseigner le champ '''Page d'accueil''' avec l'URL souhaitée.
*Cliquer sur le bouton '''Fermer'''

==Page par défaut dans Internet Explorer==
*Aller dans '''Outils > Options internet'''
**Dans l'onglet '''Général''', renseigner le champ '''page de démarrage''' avec l'adresse du site.
*Sélectionner le radio-bouton '''Démarrer avec la page d'accueil'''
*Cliquer sur le bouton '''OK'''

=Solutions Mac=
==[http://www.icab.de/ iCab]==
iCab possède un mode kiosque contenant des fonctionnalités "Outils", "Mode public", une protection par mot de passe, et dans lequel ni le Dock de Mac Os X, ni la barre de menu n'apparaissent.

Il faut mettre dans les ouvertures au démarrage un script en applescript, qui démarre automatiquement iCab en ouverture de session, en mode kiosque.

<bash>tell application "iCab"
Activate
enter kiosk mode with password "password"
-- ''le mot de passe qui permettra de sortir du mode kiosque avec le raccourci [Commande-k]''
OpenURL "http://monsite.org/?login=monidentifiant&password=monmotdepasse" toWindow -1
-- ''ouvre la page en question dans iCab et au premier plan, en introduisant identifiant et MdP de l'utilisateur invité''
end tell</bash>

Il faut supprimer toutes les barres d'affichage : Adresse, Barre d'état, Signets, Liens standards, dans les Préférences du mode Kiosque PC, et mettre la page d'OF en page d'accueil du navigateur.

Il est néanmoins nécessaire dans le mode kiosque de garder la barre de navigation, pour relancer le navigateur lors des pertes de connexion.

Comme il est possible de n'autoriser la connexion qu'à un ou plusieurs sites nommément désignés par un système de filtres, il est possible de de bloquer le navigateur sur OpenFlyers.

Le mode kiosque doit être lancé depuis une session d'un utilisateur sans mot de passe (permet les ouvertures et extinctions automatiques la nuit), utilisateur qui n'a aucun droit de gestion sur l'ordinateur et qui travaille sur un Finder restreint.

Une version Free existe, une version Pro sans limitations est disponible pour 15 €.

==wKiosque PC Browser==
Il existe également [http://www.app4mac.com/wkioskbrowser.html wKiosque PC Browser], créé spécifiquement pour cet usage, mais payant ($69 pour un seul poste, la version d'essai quitte après une heure ). Il a des paramétrages très complets et en particulier relance la connexion lors du boot jusqu'à la connexion au site.
=Solutions Windows=
==Configurer un navigateur en mode kiosque==
===Configurer Firefox en mode kiosque===
Il existe des thèmes et extensions permettant de transformer Firefox en kiosque.
Par exemple R-kiosk.

===Configurer Chrome en mode kiosque===
*Créer un raccourci de Chrome
*Survoler avec le pointeur de la souris l'icône du raccourci
*Sélectionner '''Propriétés'''
*Dans l'onglet '''Raccourci''', champ '''Cible''', rajouter à la fin de la ligne : ''--kiosk http://openflyers.com/plateforme/'' en remplaçant ''plateforme'' par le nom de votre plateforme OpenFlyers
<pre>"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" --kiosk http://openflyers.com/plateforme/</pre>
*Cliquer sur le bouton '''OK'''
Une fois Chrome lancé, pour le fermer, il faut utiliser la combinaison de touches [Alt+F4]

===Configurer Internet Explorer en mode kiosque===
*Créer un raccourci d'Internet Explorer
*Survoler avec le pointeur de la souris l'icône du raccourci
*Sélectionner '''Propriétés'''
*Dans l'onglet '''Raccourci''', champ '''Cible''', rajouter à la fin de la ligne : ''-k http://openflyers.com/plateforme/'' en remplaçant ''plateforme'' par le nom de votre plateforme OpenFlyers
<pre>""C:\Program Files (x86)\Internet Explorer\iexplore.exe" -k http://openflyers.com/plateforme/</pre>
*Cliquer sur le bouton '''OK'''
Une fois Internet Explorer lancé, pour le fermer, il faut utiliser la combinaison de touches [Alt+F4]

==Lancer un programme au démarrage de Windows==
===Lancer un programme au démarrage de Windows XP===
Mettre un raccourci vers le navigateur dans le menu '''Démarrer > Programmes > Démarrage'''

===Lancer un programme au démarrage de Windows 8===
*Ouvrir la fenêtre '''Exécuter''' par la combinaison de touches [Win+R]
*Saisir ''shell:startup''
*Dans ce répertoire démarrage, mettre un raccourci vers le navigateur

==Sécuriser Windows==
===[http://www.anfibia-soft.com/products/deskman/index.html deskman]===
Deskman permet de contrôler l'accessibilité des fonctionnalités de Windows. Il est disponible pour Windows XP, Vista 7 et 8 en 32 et 64 bits. Il est disponible pour essai gratuitement et son prix est de 35 € pour un poste.

====Installation de Deskman====
'''Attention''' : ce programme permet de limiter totalement l'accès à un ordinateur notamment en empêchant l'exécution de programmes. S'il est mal configuré, il peut devenir [[#Impossible_de_saisir_le_mot_de_passe_dans_deskman|impossible d'en retrouver le contrôle]].
*[http://www.anfibia-soft.com/products/deskman/index.html#getdeskman Télécharger deskman] en cliquant sur le bouton '''Donwnload Deskman'''.
*Exécuter ''deskmansetup.exe'', accepter les conditions générales et lancer Deskman.
*Cliquer sur l'icône '''Settings'''
*Dans l'onglet '''Basic''', formulaire '''Deskman Authentication'', renseigner dans '''Main password''' et '''Confirm password''', le mot de passe permettant d'accéder à deskman.
*Noter le raccourci par défaut permettant d'afficher affiché dans le formulaire '''Open Deskman''', champ '''Primary Hotkey''' : [CTRL + MAJ + F12]
*Cliquer sur le bouton '''Save'''.

====Activer le contrôle avec Deskman====
Il faut avoir [[#Installation_de_Deskman|installé]] Deskman et mis en place un mot de passe d'accès
*Lancer Deskman
*Cliquer sur l'icône '''Secure'''

====Bloquer Alt+F4 avec Deskman====
Il faut avoir [[#Installation_de_Deskman|installé]] Deskman
*Lancer Deskman
*Dans l'onglet '''Keys''', cocher '''Key Options > Program Closing Disable Alt-F4'''
*[[#Activer_le_contrôle_avec_Deskman|Activer le contrôle avec Deskman]]

====deskman troubleshooting====
=====Impossible de saisir le mot de passe dans deskman=====
Lors de nos essais sur un PC portable avec écran tactile sous Windows 8, il nous a été impossible de saisir le mot de passe permettant de reprendre l'accès car la plupart des touches du clavier étaient reconnues commes des raccourcis pour lancer des programmes au lieu d'afficher le caractère correspondant dans le champ de saisie du mot de passe.

Procédure pour retrouver le contrôle total et les paramètres d'origine :

*Eteindre l'ordinateur
*Déconnecter le disque dur contenant Windows
*Déconnecter le disque dur et le connecter depuis un autre ordinateur
*Renommer les fichiers exécutables correspondants au programme deskman présents dans "Program Files (x86)\anfibia deskman" en rajoutant par exemple un caractère pour en empêcher l'exécution au démarrage.
*Reconnecter le disque dur le PC d'origine
*Lancer Windows : vous retrouver l'accès à l'ordinateur
*Remettre les noms de fichiers initiaux de deskman
*Désinstaller deskman
*Ré-installer deskman
*Activer deskman sans rien restreindre : cela permet de rétablir l'intégralité des accès à Windows notamment au répertoire racine "Ce PC" qui peut ne pas être réapparu.
*Désactiver deskman

Introduction

2024-10-02T17:27:56Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
OpenFlyers est un logiciel de gestion d'activité qui permet de suivre l'ensemble des phases liées aux activités d'une structure qui propose des services à destination de personnes (sociétés de location, organismes de formation, sociétés de services, etc.). Ces personnes sont appelées dans OpenFlyers les "utilisateurs". Il peut s'agir de clients, de membres, d'adhérents, de salariés, etc. Elles ont la possibilité d'interagir avec le logiciel OpenFlyers qui sert d'outil de partage de l'information :
*planning
*suivi de l'activité
*comptes utilisateurs

OpenFlyers a été conçu pour répondre à un [[Bien débuter avec OpenFlyers#Workflow|workflow]] défini et qui correspond aux enchainements généralement constatés des actions au sein des structures proposant des services.

=La gestion des réservations avec OpenFlyers=
OpenFlyers comporte un outil de plannification. Il s'agit d'un planning qui permet de visualiser les réservations de ressources matérielles et humaines. Typiquement, il peut s'agir du triptyque : véhicule, formateur, élève.

[[File:OF-intro-planning.jpg|1000px]]

Selon les droits attribués aux profils des utilisateurs, ces derniers ont la possibilité d'accéder en mode consultation ou en mode édition.

Lorsque les utilisateurs ont le droit d'effectuer des réservations, il leur suffit de cliquer sur une case correspondant à un quart d'heure du planning pour effectuer leur réservation. Un formulaire de réservation s'affiche alors afin de leur permettre de compléter les informations nécessaires à la réservation :

[[File:OF-intro-reserver.jpg|1000px]]

=La gestion d'activité avec OpenFlyers=
==Génération du chiffre d'affaire et gestion des encaissements clients==
L'une des fonctionnalités d'OpenFlyers est de gérer les comptes comptables des utilisateurs.

Le processus chronologique est le suivant :
===saisie de l'activité===
Il s'agit typiquement de la saisie des heures de vols.

Cette saisie peut se faire directement par l'utilisateur final ou être centralisée au sein d'un service dédié (secrétariat par exemple).

Cependant, nous recommandons fortement de déléguer la saisie à l'utilisateur final. Cela présente 2 avantages :
*Renforcement de la qualité de l'action de contrôle effectuée en aval par un service centralisé (secrétariat par exemple). En effet, il a été constaté que lorsque la personne qui saisit l'activité est également la personne qui contrôle la saisie, ce contrôle est effectué avec moins d'assiduité pour des raisons qui relèvent des [[Wikipedia-fr:Facteurs_humains|facteurs humains]] : une personne aura tendance à se faire confiance et à moins remettre en cause sa propre action. De ce fait, elle détectera moins facilement ses propres erreurs de saisie. C'est la raison pour laquelle il est judicieux de faire effectuer ce contrôle par une autre personne.
*Délégation à l'utilisateur (qui peut être le client) et ainsi une diminution des tâches récurrentes pour la structure.

Pour les heures de vols, cette saisie se fait grâce au menu '''Vols > Saisir un vol''' ou grâce à '''Saisir un vol''' qui apparait dans le menu contextuel en survolant une réservation. L'utilisateur remplit ainsi un formulaire de saisie qui peut être personnalisé selon les règles et la politique de la structure :

[[File:FOF-intro-saisie-activite.jpg|1050px]]

Dès qu'un vol est saisi "fermé" une facture pro-format, un devis ou un bon de commande est généré et les écritures comptables qui en découlent sont automatiquement générées. Ces écritures ne sont pas définitives et peuvent être modifiées en modifiant la saisie du vol. C'est l'équivalent du ''Brouillard'' existant dans les logiciels de comptabilité. Elles apparaissent en vert italique sur les relevés de comptes, les carnets de routes, carnets de vols et sur les listes des vols. La personne qui a saisit le vol peut le reprendre et les personnes disposant des droits de gestion peuvent modifier cette saisie.

Si des anomalies sont détectées lors de la saisie, alors des alertes sont affichées à l'utilisateur demandant à l'utilisateur de compléter/corriger sa saisie. Cela peut également être le cas pour des champs dont la saisie est indispensable et qui n'auraient pas été remplis.

'''Conseil OpenFlyers :'''
*Dans le cas où les vols sont saisis directement par les pilotes, nous recommandons de demander aux pilotes de saisir d'abord leur vol dans OpenFlyers et ensuite de recopier ce qui est saisit dans OpenFlyers sur le carnet de route. Ainsi, on est sûr que les 2 informations coïncideront et que les calculs faits par l'application OpenFlyers seront en conformité avec les calculs qui seraient fait au vu du carnet de route qui est le seul document officiel.

====Modes de saisie ouverture+fermeture ou fermeture seule====
Il existe dans OpenFlyers deux modes de gestion de l'activité :
*mode ouverture+fermeture = on ouvre une activité avant de la débuter et on la referme après l'avoir terminée
*mode fermeture seule = on ferme uniquement l'activité une fois qu'elle est terminée

Si on choisit la <i>fermeture des vols seulement</i> le pilote devra remplir à l'issue de son vol un formulaire qui fait office de carnet de route de l'aéronef ; il y renseigne le même type d'informations, entre autres les index de départ et d'arrivée, ce qui permettra à Openflyers de calculer le coût du vol.

Si on choisit <i>ouverture et fermeture des vols</i> on doit lors de la prise de l'aéronef renseigner un formulaire où l'on précise la durée estimée, la destination ainsi que d'autres informations.
L'ouverture du vol présente 3 avantages :
*Alerter le pilote avant son départ en cas de validités expirées, de solde de compte insuffisant
*Permettre d'avoir un "mini-plan de vol" en connaissant où à prévu d'aller le pilote, pour combien de temps et avec combien de personnes
*Permettre aux autres utilisateurs de savoir si une ressource est réellement disponible même lorsqu'elle n'a pas été réservée au préalable
En effet, lorsqu'un vol est ouvert, un créneau bleu apparait sur le planning de réservation et le fond du rectangle de l'aéronef correspondant apparait également sur fond bleu

L'ouverture du vol permet enfin de gérer l'armoire à clef OpenFlyers et ainsi de libérer ou non la clef en fonction des nombreux critères (solde du compte, qualification à jour...)

===Saisie des encaissements===
Les encaissements peuvent être saisis à tout moment et de façon indépendante de l'activité.

Tout comme pour l'activité, la saisie peut être autorisée aux utilisateurs finaux ou restreinte à certaines personnes en charge de la gestion.

Cette saisie s'effectue côté planning, par le biais du menu '''Comptes > Approvisionner'''.

[[File:OF-intro-encaissement.jpg|1000px]]

Toutes les écritures saisies sont modifiables comme pour les vols sauf dans le cas d'un paiement par l'intermédiaire d'un Terminal de Paiement Électronique virtuel (paiement en ligne). En effet, dans ce dernier cas, la validation par la banque du numéro de carte bancaire vaut acceptation par celle-ci et confirmation du montant débité sur le compte attaché à la carte bancaire. Il n'y a donc pas nécessité de valider à posteriori cette écriture comptable. C'est même tout son intérêt : elle permet d'automatiser le processus d'encaissement.

===[[Gestion-des-activités#Valider-une-activité|Validation de la saisie de l'activité]]===

===Validation de la saisie des encaissements===
La validation de la saisie encaissements n'a pas lieu dans le cas d'un paiement par carte bancaire sur un Terminal de Paiement Électronique virtuel (paiement en ligne).

Dans les autres cas, la validation s'effectue dans '''Comptes > Pointer > xxx''' où il faut remplacer xxx par le type de paiement dont on souhaite valider les écritures.

'''Conseils OpenFlyers :'''
*Le pointage des encaissements doit se faire au vu de ces derniers : on pointe les chèques en contrôlant les chèques.
*Une fois le pointage effectué dans OpenFlyers et après appuie sur la touche '''Editer le bordereau de remise''', la personne en charge du pointage voit apparaitre le bordereau de remise. Il est important qu'à ce moment là, le bordereau soit imprimé 2 fois : une fois pour la remise en banque et une fois pour archivage.

==Consultation des écritures==
Un utilisateur peut retrouver l'ensemble des écritures qui concernent son compte depuis le côté Planning en cliquant sur la zone en haut et à droite du planning où apparait le solde de son compte.

Il retrouve alors l'ensemble des écritures qui impactent son compte :
*les factures
*les paiements qu'il a effectué
Ces écritures sont :
*soit en vert italique pour indiquer qu'elles peuvent être modifiées : il a alors la possibilité de les modifier lui-même (sous réserve qu'il dispose des droits) à l'aide de la fonction '''modifier''' qui correspond à l'icône symbolisant un '''crayon''' présente dans la colonne '''action''' à droite de son relevé de comptes.
*soit en noir pour indiquer qu'elles sont définitives

=Le suivi et l'enregistrement de trajectoire avec OpenFlyers et Charterware=
OpenFlyers se couple à la solution Charterware pour l'enregistrement automatique des vols et la récupération des trajectoires.

Voir https://openflyers.com/fr/fonctionnalites/recuperation-automatique-des-vols-avec-charterware

=[[Bien débuter avec OpenFlyers|Bien débuter avec OpenFlyers]]=

Interfaçage OpenFlyers et armoire à clés

2024-10-02T17:27:55Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de décrire le protocole d'interfaçage avec toute solution d'armoire à clés tiers. Pour les armoires à clés commercialisées par OpenFlyers, il faut se référer à la [[Contrôle des accès|documentation sur le contrôle d'accès]].

Le protocole repose sur le principe que l'interfaçage est réalisé par un logiciel de contrôle de l'armoire à clé sur un PC ou une solution embarquée et qui dispose d'un accès à internet lui permettant de communiquer avec OpenFlyers. La communication est synchrone.

=Interface utilisateur OpenFlyers=
L'utilisateur ouvre un vol dans OpenFlyers :

[[File:Menu-contextuel-ouverture-de-vol.png]]

Il se retrouve sur le formulaire de saisie du vol en mode Départ en vol:

[[File:Formulaire-ouverture-de-vol.png]]

Lorsqu'il clique sur le bouton de validation, 3 cas peuvent se présenter :
*Une alerte ou plusieurs alertes rouges (bloquantes), s'affichent : l'utilisateur n'a pas la possibilité de surpasser ses alertes, il ne peut alors récupérer la clé :

[[File:Alertes-bloquantes-en-ouverture-vol.png]]

*Une alerte ou plusieurs alertes oranges (non-bloquantes), s'affichent : l'utilisateur a la possibilité de surpasser ses alertes, et ainsi de récupérer la clé :

[[File:Alertes-non-bloquantes-en-ouverture-vol.png]]

*Aucune alerte ne s'affiche, l'utilisateur se retrouve alors directement sur la page lui indiquant :

[[File:Message_autorisation_libération_clé.png]]

Une fois qu'il a cliqué sur '''LIBÉRER LA CLÉ''', il dispose de X secondes. Cette durée est paramétrable par OpenFlyers.

*Lorsqu'il rentre de vol, l'utilisateur n'a plus qu'a retourner sur le formulaire de saisie de vol et à fermer son vol. La clé doit etre remise en place sur l'armoire pour fermer le vol.

=Interface administrateur OpenFlyers=
==Activation et configuration de la gestion des armoires à clé==
*'''Admin > Structure > Structure > Paramétrage'''
*Dans la section du formulaire '''Contrôle d'accès''', sélectionner '''Activé(e)''' pour les champs '''Contrôle d'accès''' et '''Gestion armoire à clés'''.
[[File:Config_parametres_OF_controle_acces 1.jpg]]
*Cliquer sur le bouton '''Enregistrer'''
*Un nouveau champ s'affich
*Sélectionner le '''Logiciel de contrôle de l'armoire à clés''' selon votre armoire à clés
[[File:Config_parametres_OF_controle_acces 4.jpg]]

Les Logiciels OpenKey et PyOpenKey sont des protocoles propriétaires d'OF, pour les configurer voir [[Interfaçage-OpenFlyers-et-armoire-à-clés#Interface-administrateur-OpenFlyers | Interfaçage armoire à clés OF]]

==Attribution des clés aux ressources/aéronefs==
''Dans le cas où c'est le logiciel OpenFlyers qui gère les clés.''
*'''Admin > Types de ressources > Actives'''
[[File:Liste_des_aéronefs.png]]

Pour chaque aéronef concerné, il suffit d'attribuer un numéro et un nom de clé dans les champs correspondants. La validation de la saisie se fait automatiquement en cliquant hors du champ de saisie.

=Protocole de dialogue XML-RPC entre OpenFlyers et le logiciel de gestion de l'armoire à clé=
Le dialogue avec le serveur XML-RPC d'OpenFlyers doit s'effectuer en '''HTTPS'''. Les commandes accessibles sont listées par un appel à ActionOnDemand.php
https://openflyers.com/yourURL/actionOnDemand.php

==Demande de libération d'une clé==

===Cas avec gestion des clés par OpenFlyers===

*Lorsque qu'une clé doit être libérée, le navigateur envoie un message au logiciel de contrôle de l'armoire à clé par le protocole HTTPS sous la forme suivante :
https://127.0.0.1:4080/?sessid=e5f01p2oqh2vb36arisr8k5j87&timeOut=10000&key=1&resource=2&person=12;action='releaseKey'

:*L'adresse IP (ici 127.0.0.1) et le port (ici 4080) sont fonction de la [[#Activation_et_configuration_de_la_gestion_des_armoires_à_clé|configuration de l'armoire à clé dans OpenFlyers]].
:*sessid contient le numéro de session en cours
:*timeout correspond au temps d'attente pour la prise d'une clé en millisecondes
:*key contient le numéro de la clé concernée
:*resource contient le numéro de la ressource concernée
:*person contient le numéro de l'utilisateur qui fait la demande
:*action est un mot clé désignant l'objet de la commande
:**release_key: ordre de libérer la clé
:**open_door: ordre d'ouvrir la porte
:**init_tags: ordre de lire les tags des clés
*Le logiciel de contrôle de l'armoire à clé doit alors envoyer une demande d'ordre au serveur OpenFlyers à l'adresse suivante https://openflyers.com/structure/ où il faut remplacer openflyers.com/structure par l'adresse de la plateforme OpenFlyers concernée, avec comme commande XML_RPC '''checkCommand ("e5f01p2oqh2vb36arisr8k5j87",int(key))'''.

*Le serveur OpenFlyers vérifie alors l'action demandée :
Pour release_key, il est vérifié :
#Que la clé est au bon format et existe. Lorsque la clé est validée, on passe à l'étape suivante sinon on retourne 0
#Que l'utilisateur faisant la demande est bien celui qui est connecté. Lorsque c'est le cas, on passe à l'étape suivante sinon on retourne 0
#Ensuite si l'utilisateur qui a passé la demande :
#*A le droit '''Gestion des clés''' (administrateur) alors on libère la clé sans condition (cela permet de libérer la clé sans contrôle) et on retourne 1
#*N'a pas le droit '''Gestion des clés''' (pilote) alors on vérifie s'il existe un vol ouvert qui remplit la double condition :
#**Vol attribué à l'utilisateur
#**Aéronef du vol associé à la demande de libération de la clé
#**Lorsque la double condition est remplie, on retourne 1 sinon 0

*Le serveur retourne ensuite la réponse :
**1 dans le cas d'autorisation de libération de clé
**0 dans le cas contraire

====Exemple de script en Python d'utilisation de la commande checkCommand avec gestion des clés====
<python># load library
from twisted.web.xmlrpc import Proxy
from twisted.internet import reactor, ssl

def printValue(value):
print repr(value)
reactor.stop()

def printError(error):
print 'error', error
reactor.stop()

# URL of the XML-RPC server
proxy = Proxy('https://yourURL.xx/actionOnDemand.php')

# init array to send
sessid = ""
key_num = 1

# send to the XML-RPC server
proxy.callRemote('checkCommand', sessid, key_num).addCallbacks(printValue, printError)
reactor.run()</python>

Ce test peut être complété (pour obtenir une réponse "1") en simulant une armoire à clé à l'aide d'un script PHP de la façon suivante :
*Installer un serveur local (par exemple [https://www.wampserver.com/ wampserver] sous Windows) de façon à avoir le port 127.0.0.1 qui lui est attribué
*Configurer la plateforme OpenFlyers de manière à gérer l'armoire à clé avec les éléments suivants :
**'''IP du PC contenant le logiciel de contrôle''' : 127.0.0.1
**'''Port du PC contenant le logiciel de contrôle''' : 80
*Configurer la plateforme OpenFlyers de manière à gérer les clés
*A la racine du répertoire www, mettre le script index.php suivant (on suppose que ce script est appelé par défaut lorsqu'on utilise l'URL https://127.0.0.1 ) :
<php><?php
file_put_contents('test.txt', 'TEST', FILE_APPEND );
file_put_contents('test.txt', print_r($_REQUEST, true), FILE_APPEND );
?></php>
*Toujours à la racine du répertoire www, créer un fichier test.txt
Le script PHP écrira dans le fichier test.txt les variables transmises lors de la demande d'ouverture de l'armoire à clé :
<pre>TESTArray
(
[sessid] => j2eo92215nbef09borb74jftm1
[key] => 1
[resource] => 1
[person] => 1
)</pre>
*Il suffit alors de recopier la valeur de '''sessid''' et de '''key''' dans le script python de ce début de paragraphe et de le tester : il devrait renvoyer 1.

===Cas sans gestion des clés par OpenFlyers===

*Lorsque qu'une demande de vérification doit être réalisée, le navigateur envoie un message au logiciel de contrôle de l'armoire à clé par le protocole HTTPS sous la forme suivante :
https://127.0.0.1:4080/?sessid=e5f01p2oqh2vb36arisr8k5j87&resource=2&person=12

:*L'adresse IP (ici 127.0.0.1) et le port (ici 4080) sont fonction de la [[#Activation_et_configuration_de_la_gestion_des_armoires_à_clé|configuration de l'armoire à clé dans OpenFlyers]].
:*sessid contient le numéro de session en cours
:*resource contient le numéro de la ressource concernée
:*person contient le numéro de l'utilisateur qui fait la demande
*Le logiciel de contrôle de l'armoire à clé doit alors envoyer une demande d'ordre au serveur OpenFlyers à l'adresse suivante https://openflyers.com/structure/actionOnDemand.php où il faut remplacer openflyers.com/structure par l'adresse de la plateforme OpenFlyers concernée, avec comme commande XML_RPC '''checkCommand ("e5f01p2oqh2vb36arisr8k5j87")'''.

*Le serveur OpenFlyers vérifie alors :
#Que l'utilisateur faisant la demande est bien celui qui est connecté. Lorsque c'est le cas, on passe à l'étape suivante sinon on retourne 0
#On vérifie s'il existe un vol ouvert qui remplit la double condition :
#*Vol attribué à l'utilisateur
#*Aéronef du vol associé à la demande de libération de la clé
#*Lorsque la double condition est remplie, on retourne 1 sinon 0

*Le serveur retourne ensuite la réponse :
**1 dans le cas d'autorisation
**0 dans le cas contraire

====Exemple de script en Python d'utilisation de la commande checkCommand sans gestion des clés====

<python># load library
from twisted.web.xmlrpc import Proxy
from twisted.internet import reactor, ssl

def printValue(value):
print repr(value)
reactor.stop()

def printError(error):
print 'error', error
reactor.stop()

# URL of the XML-RPC server
proxy = Proxy('https://yourURL.xx/actionOnDemand.php')

# init array to send
sessid = ""

# send to the XML-RPC server
proxy.callRemote('checkCommand', sessid).addCallbacks(printValue, printError)
reactor.run()</python>

Ce test peut être complété (pour obtenir une réponse "1") en simulant une armoire à clé à l'aide d'un script PHP de la façon suivante :
*Installer un serveur local (par exemple [https://www.wampserver.com/ wampserver] sous Windows) de façon à avoir le port 127.0.0.1 qui lui est attribué
*Configurer la plateforme OpenFlyers de manière à gérer l'armoire à clé avec les éléments suivants :
**'''IP du PC contenant le logiciel de contrôle''' : 127.0.0.1
**'''Port du PC contenant le logiciel de contrôle''' : 80
*Configurer la plateforme OpenFlyers de manière à ne pas gérer les clés
*A la racine du répertoire www, mettre le script index.php suivant (on suppose que ce script est appelé par défaut lorsqu'on utilise l'URL https://127.0.0.1 ) :
<php><?php
file_put_contents('test.txt', 'TEST', FILE_APPEND );
file_put_contents('test.txt', print_r($_REQUEST, true), FILE_APPEND );
?></php>
*Toujours à la racine du répertoire www, créer un fichier test.txt
Le script PHP écrira dans le fichier test.txt les variables transmises lors de la demande d'ouverture de l'armoire à clé :
<pre>TESTArray
(
[sessid] => j2eo92215nbef09borb74jftm1
[resource] => 1
[person] => 1
)</pre>
*Il suffit alors de recopier la valeur de '''sessid''' dans le script python de ce début de paragraphe et de le tester : il devrait renvoyer 1.

==Modification de l'état d'une clé==
''Applicable dans le cas où le protocole PyOpenKeys2 gère les clés.''
*Le logiciel de contrôle de l'armoire à clés doit envoyer un ordre '''notify([1,0,1,1,1,1,0,0], "passphrase")''' avec comme paramètre un tableau chronologique des clés ayant pour valeur leur état
''Applicable dans le cas où le protocole PyOpenKeys3 gère les clés.''
*Le logiciel de contrôle de l'armoire à clés doit envoyer un ordre '''notify2([[1,1],[2,0],[3,1],[4,1],[5,1],[6,1],[7,0],[8,0]], "passphrase")''' avec comme paramètre un tableau de tableau avec le numéro de la clé suivi de son état
**1 = interrupteur de présence de clé fermé = clé absente de l'armoire
**0 = interrupteur de présence de clé ouvert = clé présente dans l'armoire

===Exemple de script en Python pour la commande notify===
Nécessite les librairies Twisted et OpenSSL

<python># load library
from twisted.web.xmlrpc import Proxy
from twisted.internet import reactor, ssl
import random

def printValue(value):
print repr(value)
reactor.stop()

def printError(error):
print 'error', error
reactor.stop()

# URL of the XML-RPC server
proxy = Proxy('https://yourURL.xx/actionOnDemand.php')

# init passphrase
passphrase = 'SDjklsdiuQSIPO23879ZERK2098ZL2908DFZLK'

# Initiate number of key
KEY_NUMBER = 16

# init array to send
state = random.randint(0,1)

if KEY_NUMBER > 8:
# Test notify2
status = [[d+1,0] for d in range(KEY_NUMBER)]
for i in range(KEY_NUMBER):
status[i] = [i+1,state]
# Alternate 0 and 1 for test
state = 0 if state == 1 else 1
else:
# Test notify
for i in range(KEY_NUMBER):
status.append(state)
# Alternate 0 and 1 for test
state = 0 if state == 1 else 1

# send to the XML-RPC server
print "Status sequence : %s" % status
if KEY_NUMBER<9:
proxy.callRemote('notify', status, passphrase).addCallbacks(printValue, printError)
else:
proxy.callRemote('notify2', status, passphrase).addCallbacks(printValue, printError)
reactor.run()
</python>
''Nota : to test change the number of key : up to 8 the software use '''notify()''', beyond it uses '''notify2()'''

Cela retournera 0 en cas d'anomalie ou si la passphase transmise n'est pas correcte, 1 si la table des clés a été correctement mise à jour.

==Fermeture automatique d'un vol==

Le logiciel de contrôle de l'armoire à clé doit envoyer un ordre '''closeFlight("passphrase", "id de ressource")''' avec comme paramètre un passphrase et l'id qui va entraîner la fermeture du vol effectué sur cette ressource si un vol avait été ouvert et que la "Fermeture automatique des
vols au retour de la clé" soit activée. La commande retournera comme réponse une structure JSON pour déterminer si la fermeture du vol s'est bien réalisée ou non et qu'il n'y a pas eu d'erreur.

Réponse quand la vérification du passphrase est incorrecte, ce qui a entraîné la non-fermeture du vol :
<javascript>{[
ack : 0
]}</javascript>

Réponse quand la vérification du passphrase est correcte et que la demande de fermeture du vol s'est bien réalisée :
<javascript>{[
ack : 1
]}</javascript>

Réponse quand la vérification du passphrase est correcte et que la demande de fermeture du vol ne s'est pas bien réalisée suite à une erreur :
<javascript>{[
ack : 1,
error : 'Message d\'erreur ...'
]}</javascript>

===Script d'exemple pour closeFlight===
<python># load library
from twisted.web.xmlrpc import Proxy
from twisted.internet import reactor, ssl
import random

def printValue(value):
print repr(value)
reactor.stop()

def printError(error):
print 'error', error
reactor.stop()

# URL of the XML-RPC server
proxy = Proxy('https://yourURL.xx/actionOnDemand.php')

# Id of resource which needs a flight closing
resource_id = 1

# init passphrase
passphrase = 'SDjklsdiuQSIPO23879ZERK2098ZL2908DFZLK'

# send to the XML-RPC server
proxy.callRemote('closeFlight', resource_id, passphrase).addCallbacks(printValue, printError)
reactor.run()</python>

==Exemple de script en Python de logiciel de contrôle d'une armoire==
<python>#!/usr/bin/python
import xmlrpclib, time, dummy_proto, hashlib
from twisted.internet import reactor, task, threads, ssl
from twisted.application import internet, service
from twisted.internet.protocol import Protocol, ClientCreator, ReconnectingClientFactory
from twisted.web import resource, server

# Port from which the OF client contact OpenKeys service
SERVICE_PORT=4080
# IP address of the OpenKeys service
SERVICE_HOST="192.168.0.200"

# IP address of the key cabinet
KEYS_ADDR='192.168.0.201'
# Port from which OpenKeys service contacts the key cabinet
KEYS_PORT=6002
#Time to release the key
KEY_RELEASE_DURATION=15

# sha224 passwords
PASSWORDS=('847bed9bc354e7e47bc5350a3b3aaf6124f5748224a3c7ad79586c3c')

# init passphrase
passphrase = 'SDjklsdiuQSIPO23879ZERK2098ZL2908DFZLK'

OF_XMLRPC_URL="https://openflyers.com/structure/actionOnDemand.php"

DEBUG=False

class dummyProtocol(Protocol):
def __init__(self, rpc_server):
self.rpc_server=rpc_server
self.lc = None

def connectionMade(self):
if not self.lc:
# update status every 10 minutes
self.lc = task.LoopingCall(self.updateStatus)
self.lc.start(600)

def dataReceived(self, data):
msg=dummy_proto.dummy_message.newFromData(data)
if DEBUG: msg.display()
try:
if type(msg)==dummyproto.dummy_ONOFF_Control_Response:
response = self.rpc_server.notify(msg.getKeysStatus(),passphrase)
except Exception, err:
if DEBUG: print "error: ", err
pass # ignore

def updateStatus(self):
msg = dummy_proto.dummy_State_Request()
self.transport.write(msg.build_message())

def send(self, dummy_data):
self.transport.write(dummy_data.build_message())

class dummyClientFactory(ReconnectingClientFactory):
def __init__(self, rpc_server):
self.rpc_server = rpc_server

def buildProtocol(self, addr):
self.resetDelay()
self.protocol = dummyProtocol(self.rpc_server)
return self.protocol

def clientConnectionLost(self, connector, reason):
ReconnectingClientFactory.clientConnectionLost(self, connector, reason)
connector.connect()

def clientConnectionFailed(self, connector, reason):
if DEBUG: print 'Connection failed. Reason:', reason
ReconnectingClientFactory.clientConnectionFailed(self, connector, reason)

# blocking method ! must be run in a new thread
def release_key(self, key_num, timeOur):
m = dummy_proto.dummy_ONOFF_Control()
m.setON(key_num)
self.protocol.send(m)
time.sleep(timeOut)
m.setOFF(key_num)
self.protocol.send(m)
return key_num

class WebResource(resource.Resource):
def __init__(self, rpc_server, dummy_client_factory):
self.rpc_server = rpc_server
self.dummy_client_factory = dummy_client_factory
resource.Resource.__init__(self)
self.keys_webcontrol_state = [0,0,0,0,0,0,0,0,0,0]

def getChild(self, name, request):
return self

def render(self, request):
reponse = 0 # NOK par defaut
key_num = 0
try:
sessid = request.args.get('sessid', [""])[0]
password = request.args.get('password', [""])[0]
key_num = int(request.args.get('key', ["0"])[0])
response = 0
if password:
if hashlib.sha224(password).hexdigest() in PASSWORDS:
timeOut = KEY_RELEASE_DURATION
response_XMLRPC = 1
else:
timeOut = int(request.args.get('timeout', ["0"])[0])
response = self.rpc_server.checkCommand(sessid, key_num)
except Exception, err:
if DEBUG: print "error: ", err
return "NOK:bad request"

if response == 1:
# Don't try to release a key that is being released
if self.keys_webcontrol_state[key_num-1]: return "OK:already released"
self.keys_webcontrol_state[key_num-1] = 1
d = threads.deferToThread(self.dummy_client_factory.release_key, key_num, timeOut)
d.addCallback(self.unset_webcontrol_state)
return "OK:releasing key..."
else:
return "NOK:permission refused"

def unset_webcontrol_state(self, key_num):
self.keys_webcontrol_state[key_num-1] = 0

class OpenKeysService(service.Service):
def __init__(self):
rpc_server=xmlrpclib.Server(OF_XMLRPC_URL);
self.dummy_client_factory = dummyClientFactory(rpc_server)
self.web_resource = WebResource(rpc_server, self.dummy_client_factory)

def getdummyClientFactory(self):
return self.dummy_client_factory

def getWebResource(self):
return self.web_resource

application = service.Application('openkeys')
f = OpenKeysService()
serviceCollection = service.IServiceCollection(application)
internet.TCPClient(KEYS_ADDR, KEYS_PORT, f.getdummyClientFactory()
).setServiceParent(serviceCollection)
internet.TCPServer(SERVICE_PORT, server.Site(f.getWebResource())
).setServiceParent(serviceCollection)</python>

==Maquette de script actionOnDemand.php côté serveur recevant les appels du logiciel de contrôle de l'armoire==
Ce script nécessite la bibliothèque PEAR [http://pear.php.net/package/XML_RPC2 XML_RPC2].

Pour les tests, il suffit de modifier la valeur de la variable $weDontWant.

<php><?php
include 'XML/RPC2/Server.php';

class OpenKeysGateway {
/**
* Update the status of the keys
*
* @param array $status Status of keys
* @return integer 1 if ok, 0 else
*/
public static function notify($status) {
$logmsg = "";
foreach ($status as $key_num_from_zero => $key_pres) {
if (!is_numeric($key_pres) || intval($key_pres)!=$key_pres || $key_pres < 0 || $key_pres > 1) continue;
if (!is_numeric($key_num_from_zero) || intval($key_num_from_zero)!=$key_num_from_zero
|| $key_num_from_zero < 0 || $key_num_from_zero > 9) continue;
$logmsg .= "".($key_num_from_zero+1).":".$key_pres.",";
}
file_put_contents('test.txt', "key notify :".$logmsg, FILE_APPEND );
return 1;
}

/**
* Check if user is able to release the key 'key_num'
*
* @param string $sessid PHPSESSID of a connected user
* @param integer $key_num number of the key to release
* @return integer 0:NOK, 1:OK
*/
public static function checkCommand($sessid, $key_num) {
/* sanitize input */
if (!is_numeric($key_num) || intval($key_num)!=$key_num || $key_num < 1 || $key_num > 10) {
return 0;
}

$weDontWant = 1;

if ($weDontWant) {
file_put_contents('test.txt', "$key_num has no associated airborne aircraft", FILE_APPEND );
return 0;
}
else {
file_put_contents('test.txt', "granted key: ".$key_num.":permission granted", FILE_APPEND );
return 1;
}
}
}

$options = array(
'autoDocument' => true,
);

// dirty hack to get things work !
$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents('php://input');

$server = XML_RPC2_Server::create('OpenKeysGateway', $options);
$server->handleCall();

?></php>

Interfaçage OpenFlyers et Charterware

2024-10-02T17:27:55Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
[[File:Boitier charterware.png]]

L'objet de cette page est de présenter :
*Le produit Charterware
*La configuration de l'interfaçage OpenFlyers avec Charterware
*Son utilisation dans OpenFlyers

[https://www.charterware.de/index-en.html Charterware] est une société allemande qui commercialise un boitier qui s'installe dans un aéronef en le posant sur le tableau de bord et en le reliant par un câble à l'alimentation électrique de l'avion. Ce boitier enregistre les heures blocs :
*Début du roulage
*Décollage
*Atterrissage
*Fin du roulage
Ainsi que les facteurs de charges excessifs lors de l'atterrissage.

Le boitier transmet ces informations au serveur Charterware après le bloc arrivé et après que les pilotes aient badgé avec leur carte prévue à cet effet après avoir coupé le contact de l'aéronef. Ensuite, OpenFlyers récupère ces données (voir le chapitre ci-dessous [[#Données-récupérés-via-Charterware|données récupérées via Charterware]]).

Il est également possible de récupérer les traces de vols.

Pour la certification, voir le chapitre [[Technologies-de-géolocalisation-aéronautique#CS-STAN|CS-STAN]]. De plus Charterware dispose également d'un Minor Change Approval pour certains types d'aéronefs.

La tarification Charterware est disponible ici : https://www.charterware.de/price.html .

En 2019, les tarifs donnés par Charterware sont :
*Boitier + kit d'installation : 900 + 90 = 990 € HT soit 1178,10 € TTC avec 19% de TVA allemande
*Tag pour permettre à un 1 pilote de badger : 4,90 € HT soit 5,83 € TTC avec 19% de TVA allemande
*Abonnement pour une structure associative sans les traces de vol : 19 € HT/mois soit 22,80 € TTC/mois avec 20% de TVA française
*Abonnement pour une structure associative avec les traces de vol : 28 € HT/mois soit 33,60 € TTC/mois avec 20% de TVA française
*Abonnement pour une structure professionnelle : 49 € HT/mois
C'est la TVA française qui s'applique sur la location car le service est rendu en France.

Pour l'installation, il faut prévoir environ 300 € HT par aéronef selon l'atelier de maintenance. Le prix sera surement plus cher pour un seul appareil et moins cher pour une flotte importante car l'atelier devra passer du temps à lire le guide d'installation une fois et ensuite il pourra amortir ce temps sur les autres appareils.

Côté OpenFlyers, l’interconnexion avec Charterware est facturé 120 € HT/ressource/an pour les abonnements First-Price et Business. L'interconnexion est incluse dans les abonnements Business+ et Première.

OpenFlyers a sélectionné cette solution car elle est fiable et pérenne dans le temps. Nos concurrents nous ont suivi ;-)

==Chronologie de la mise en place==
La mise en place de Charterware et la synchronisation avec OpenFlyers suit la chronologie suivante :
*Achat des boitiers et souscription à l’abonnement de transmission des données chez Charterware.
*Installation des boitiers par l'atelier de maintenance ou l'atelier radio de la structure
*Interfaçage par OpenFlyers de la liaison entre la plateforme OpenFlyers et Charterware. Cela nécessite pour OpenFlyers de disposer des informations de connexion et les numéros d'aéronefs communiqués par Charterware.
Une fois que la configuration est faite par OpenFlyers, il reste à la structure à saisir les numéros de badges des utilisateurs : [[Gestion-des-utilisateurs#Saisir-le-numéro-d'utilisateur-Charterware|Saisir le numéro d'utilisateur Charterware]]

'''Points d'attention''' :
*L'interfaçage n'est pas mis en place sur les dépôts de test OpenFlyers.
*Si les aéronefs disposaient de la saisie des compteurs dans OpenFlyers, ces champs deviennent obsolètes et doivent être désactivés.

=Données récupérées via Charterware=
En récupérant les vols via Charterware les informations suivantes sont récupérées ou calculées.
*Aéronef utilisé (donnée planecode)
*Horodatage du début du vol (donnée offblock)
*Durée du vol (par calcul de la différence entre les données offblock et onblock)
*Temps en l'air (par calcul de la différence entre les données landing et takeoff)
*Personnes à bord (données pilot1 et pilot2)
*Lieu de départ (donnée flightfrom)
*Lieu d'arrivé (donnée flightto)
*Nombre d’atterrissage (donnée nooflandings)
*Rapport d'atterrissage dur

=Paramétrage des arrondis=
Charterware transmet à OpenFlyers des dates à la seconde. OpenFlyers fonctionne avec des dates à la minute. Il est donc nécessaire de définir des formules d'arrondis dans le [[Configuration#Gestion-de-Charterware|paramétrage de Charterware]] de la plateforme.

Les variables suivantes sont utilisables dans les formules :
*CHARTERWARE_ONBLOCK_DATE : Datetime de départ bloc
*CHARTERWARE_TAKEOFF_DATE : Datetime de décollage
*CHARTERWARE_LANDING_DATE : Datetime d’atterrissage
*CHARTERWARE_OFFBLOCK_DATE : Datetime de bloc arrivée
Ces variables sont directement transmises par Charterware.

Les fonctions suivantes peuvent être utilisées dans les formules :
*[[Formules-de-calcul#formatDate('patron',-'date')|formatDate]] : Permet de formater une date
*[[Formules-de-calcul#roundCeil(X,Y)|roundCeil]] : Arrondi à la minute supérieure la date transmise en paramètre
*[[Formules-de-calcul#roundFloor(X,Y)|roundFloor]] : Arrondi à la minute inférieure la date transmise en paramètre
*[[Formules-de-calcul#strtotime(string)|strtotime]] : Transforme une date en timestamp
=Procédure=
==Interfacer OpenFlyers avec Charterware==

*Aller dans '''Admin > Structure > Paramétrage > Activités'''
**Activer l'interrupteur '''Charterware''' situé dans la 4ème colonne
**Renseigner les champs suivants :
*** '''Nom de la plateforme dans Charterware''': Saisir le nom de votre plateforme Charterware.
*** '''Formule date de début du vol Charterware''': Entrer la formule pour calculer la date de début du vol.
*** '''Formule durée du vol Charterware''': Entrer la formule pour calculer la durée du vol.
*** '''Formule temps en l'air Charterware''': Entrer la formule pour calculer le temps en l'air.
*** '''Règle d'arrondi horaire Charterware''': Sélectionner la règle d'arrondi horaire (par exemple, Arrondi au plus proche).
*** '''Type d'activité par défaut avec zéro ou un pilote dans Charterware''': Choisir le type d'activité par défaut pour un pilote unique ou aucun pilote.
*** '''Type d'activité par défaut avec deux pilotes dans Charterware''': Choisir le type d'activité par défaut pour deux pilotes.
*** '''E-mail''': Entrer l'adresse e-mail associée à votre compte Charterware.
*** '''Mot de passe''': Entrer le mot de passe associé à votre compte Charterware.
**Cliquer sur le bouton '''Enregistrer'''
*[[Gestion-des-ressources#Saisir-le-numéro-de-ressource-pour-l'API-de-geolocalisation|Configurer le numéro de l'API de géolocalisation pour les ressources]].

=Récupération des vols Charterware=
Chaque minute le robot OpenFlyers interroge le serveur Charterware pour savoir si de nouveaux vols ont été enregistrés par Charterware. Si c'est le cas, alors il sont sauvegardés dans OpenFlyers et supprimés des vols en attente de récupération côté Charterware.

Charterware utilise un système d'identifiant pour retrouver les pilotes et les aéronefs il est donc nécessaire de créer les champs métiers nécessaires et de les renseigner dans l'interface d'OpenFlyers.

*Si l'identifiant d'un utilisateur Charterware ne peut être retrouvé dans OpenFlyers alors le robot se comporte comme si les pilotes n'avaient pas été transmis par Charterware.
*Si l'identifiant d'un aéronef Charterware ne peut être retrouvé dans OpenFlyers alors le robot n'enregistrera pas le vol.

Afin de retrouver un maximum d'informations le robot tente de retrouver une réservation avec la même ressource correspondant au vol communiqué par charterware :
*Il cherche s'il existe une réservation dont les horaires comprennent l'heure médiane du vol charterware. Si c'est le cas, il se base sur les informations de cette réservation.
*S'il n'y a aucune réservation, il cherche une réservation avec la même ressource dont les horaires sont compris entre le début et la fin du vol remonté par Charterware.
**S'il y a plusieurs réservations, alors il n'en prend aucune.
**S'il y a une seule réservation :
***Si Charterware a transmis les identifiants pilotes alors le robot vérifie si ceux-ci correspondent à ceux de la réservation. Si c'est le cas il prend en compte les informations de la réservation.
***Si Charterware n'a pas transmis les identifiants pilotes, les informations de la réservation sont prises en compte.

Une fois qu'une réservation est identifiée comme correspondre au vol remonté par Charterware, les informations de la réservation sont prises en compte par le robot.

;Exemple :
Pour un vol exemple qui commence à 16h05 et se termine à 17h00, l'heure médiane serait 16h32 et 30 secondes. La réservation correspondante pour ce vol serait celle qui inclut cette heure médiane.

Les données suivantes sont alors récupérées :
==Statut des pilotes==
Pour chaque pilote :
*Si un vol récupéré dans Charterware peut être associé à une réservation => Les statuts des pilotes sont celles définies dans la réservation.
*Si le vol ne peut être associé :
**S'il n'y a qu'un statut autorisé pour la place du pilote et pour l'avion => Le statut du pilote est ce statut.
**Si le pilote est sur la première place => Le statut du pilote est le statut "pilote" si il n'existe pas le premier statut.
**Si le pilote est sur la seconde place => Le statut du pilote est le statut "Instructeur" si il n'existe pas le second statut.

==Place des pilotes==
*Si un vol récupéré dans Charterware peut être associé à une réservation => Les places des pilotes sont celles définies dans la réservation.
*Si le vol ne peut être associé :
**S'il y a un seul pilote => Sa place est celle par défaut (0, Gauche).
**S'il y a deux pilotes et que un seul à l'autorisation pour être sur la place de droite => Le pilote ayant l'autorisation est à la place de droite et l'autre à la place de gauche.
**Si les deux pilotes ont les autorisations pour être sur la place de droite => Le pilote 1 est sur la place de gauche le pilote 2 est sur la place de droite.

==Type d'activité==
*Si un vol récupéré dans Charterware peut être associé à une réservation => Les types d'activités sont celles définies dans la réservation.
*Si le vol ne peut être associé :
**S'il y a deux pilotes et que le type d'activité par défaut pour deux pilotes est défini => Le type d'activité est celle définie par défaut.
**S'il y a zero ou un pilote et que le type d'activité par défaut pour zero ou un pilote est défini => Le type d'activité est celle définie par défaut.
**Si les types d'activité par défaut ne sont pas définies => Le type d'activité est le premier type d'activité trouvé.

=Récupération des traces de vols=
Charterware propose en option à son abonnement d'enregistrer les traces de vols. Cf. la [[#Présentation|présentation]].

Les traces de vols sont constituées de points enregistrés à une fréquence variable qui dépend de la trajectoire ou de la vitesse de l'aéronef :
*1 point tous les 3 secondes pour le roulage
*1 point toutes les 25 secondes en vol en ligne droite
*1 point toutes les secondes en montée et en descente
*1 point tous les 10 degrés d'angle en virage

Les traces de vols sont téléchargeables depuis les interfaces [[Carnet-de-route#Traces-de-vols|Activités > Carnet de route]] et '''Activités > Carnet de vol'''. Pour visualiser les traces de vol il faut soit être sur le vol en tant que pilote ou instructeur ou bien avoir le droit [[Gestion-des-profils#Visualiser-les-traces-de-vol|Visualiser les traces de vol]].

=Troubleshooting=
==Activité vol non créée automatiquement dans OpenFlyers==
Procédure à suivre dans le cas où un vol a été effectué sur un appareil équipé d'un boitier Charterware et que l'activité vol correspondante n'apparait pas dans OpenFlyers.
*Allumer le boitier Charterware de l'aéronef concerné pour lancer une nouvelle tentative de transmission des données. Contrôler l'affichage du boitier pour voir s'il s'éteint de lui-même au bout de 2 minutes. Ce n'est que lorsqu'il s'éteint avec aucun texte d'affiché que la transmission s'est effectuée. Dans le cas contraire, cela veut dire qu'il y a un problème de transmission entre le boitier et le serveur Charterware. Il est probable que ce problème de transmission soit un problème de réseau. Dans ce cas là, il faut retenter le processus lorsque la transmission réseau est meilleure.
Une fois que le boitier s'est éteint de lui-même, dans les 10 minutes qui suivent, la synchronisation entre le serveur Charterware et celui d'OpenFlyers se fait.
*Vérifier à nouveau si le vol apparait dans OpenFlyers
**Si le vol est présent, la procédure est terminée
**Si le vol est toujours manquant effectuer les actions suivantes
*Se connecter à l'interface Charterware et voir si le vol apparait
**Si le vol apparait, faire une copie d'écran de l'interface et la transmettre à OpenFlyers pour qu'il puisse investiguer sur la non création automatique de l'activité vol dans la plateforme OpenFlyers
**Si le vol n'apparait pas, contacter Charterware pour investigation

Interfaçage Aérogligli

2024-10-02T17:27:55Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de présenter les fonctionnalités proposées par [https://openflyers.com/fr/actualites/aerogligli-arrive-sur-openflyers l'interfaçage] avec [https://www.aerogligli.fr/ Aerogligli].

=Questionnaire=
[[File:Aérogligli_qcm.png]][[File:Aérogligli_qcm_correction.png]]

Dans le tableau de bord de la plateforme, le questionnaire du jour d'Aérogligli apparaît.

Après avoir choisi une réponse et avoir cliqué sur le bouton '''Correction''', un pictogramme indiquant une réussite ou une erreur apparaîtra.

Un nouveau bouton '''En savoir plus''' apparaît. Un clic dessus redirige vers une page d'explications d'Aérogligli.

=Statistiques de l'élève=
[[File:Aérogligli_résultats.png]]

Un composant statistiques est aussi disponible dans le tableau de bord.

Ce composant ne fonctionne que si le champ '''Numéro d'utilisateur Aérogligli''' de la fiche personnelle de l'utilisateur est rempli. Si ce n'est pas le cas, le composant affichera un message invitant à renseigner ce numéro.

Une fois le champ renseigné, le bloc statistiques affiche deux éléments selon le profil Aérogligli ''PPL(A) ou BIA'':
*le pourcentage de réussite des QCM
*le pourcentage de cours lus de l'utilisateur

Il est possible de changer de profil Aérogligli en cliquant sur le crayon d'édition à côté de son intitulé. Le changer actualisera les statistiques pour afficher celles correspondantes au profil sélectionné.

Installation armoire à clés

2024-10-02T17:27:54Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de décrire la procédure d'installation d'une [[Contrôle des accès#Armoires_à_clés_Deister_commercialiées_par_OpenFlyers|armoire à clés Deister ProxSafe Smart vendue par OpenFlyers]] et équipée du mini-serveur OpenFlyers.

=Préparation du réseau avant réception de l'armoire=
''La procédure décrite dans ce paragraphe peut être effectuée avant la réception de l'armoire. A défaut, de préparation anticipée, elle doit être effectuée '''avant''' tout branchement de l'armoire à clés sauf dans le cas d'une Livebox d'orange où il est nécessaire d'effectuer d'abord le branchement du matériel pour pouvoir ensuite effectuer la configuration du routeur. Dans ce cas, il faut d'abord suivre la procédure [[#Connexion_de_l'armoire|connexion de l'armoire et ensuite revenir sur ce paragraphe]]''

L'utilisation de l'armoire à clés Deister, nécessite 1 raccordement électrique 220v avec les 3 câbles (phase, neutre et terre) ainsi que 2 connexions RJ45 au réseau local via un routeur, en général une "box" :
*une pour le mini-serveur OpenFlyers
*une pour l'armoire à clés.

Le réseau doit être configuré en DHCP ce qui signifie que toute connexion au réseau est automatiquement reconnue et qu'une adresse IP est automatiquement affectée à cette connexion. Par défaut, les "box" des fournisseurs d'accès sont configurées selon ce mode là.

Cependant pour que le serveur OpenKey et l'armoire à clé puissent communiquer entre-eux et avec le logiciel OpenFlyers, les adresses IP attribuées par le routeur doivent être fixes. Pour forcer le routeur à attribuer toujours la même adresse IP à un équipement il faut le configurer en créant l'association d'une [[Wikipedia-fr:Adresse_IP|adresse IP]] à l'[[Wikipedia-fr:Adresse_MAC|adresse MAC]] du matériel.

Les adresses IP et MAC à configurer vous sont communiquées dans un e-mail qu'OpenFlyers envoie après la commande de l'armoire à clés et qui sont également indiquées le bordereau de livraison.

Ce paramétrage se fait soit directement dans l'interface de gestion du routeur ou par l'intermédiaire de l'interface de gestion de la "box" de votre fournisseur d'accès et dépend du matériel que vous disposez.
==Configuration du routeur==
Le routeur d'un fournisseur d'accès internet correspond à la "box".

===Configuration d'un Routeur NETGEAR Numericable===
''Cette documentation a été rédigée à partir d'un routeur NETGEAR CBVG834G''
*Aller sur la page d'administration du routeur. Elle est par défaut sous la forme http://192.168.0.1
*Saisir l'identifiant et le mot de passe
''Rédiger la redirection des ports''
*Aller '''Paramètres avancés > IP LAN'''
*Dans le 2ème formulaire, saisir dans les lignes '''Adresse MAC''' et '''Adresse IP''' les couples (adresse IP, adresse MAC) communiqués dans le bordereau de livraison et cliquer à après la saisie de chaque couple sur le bouton '''Ajouter''' de sorte à obtenir le tableau suivant :
''Copie d'écran à insérer''
*Débrancher 5 secondes le routeur puis le rebrancher.

===Configuration d'une Box BBox===
Il faut au préalable connecter l'armoire afin que la BBox lui affecte par défaut une adresse IP.
*Connecter vous sur votre BBox en tapant son IP 192.168.1.254 et mettre le mot de passe
* Déployer le menu '''Service de la box''' et sélectionner DHCP

[[File:BBox_acces_DHCP.jpg]]
* Allez dans la rubrique '''Attribution adresse IP Statique'''
* Cliquer sur ajouter un équipement
Sélectionner l'adresse MAC de l'équipement et le nommer pour plus de clarté

[[File:BBox_config_adresse_IP_fixe.jpg]]
* Refaire l'opération pour le Raspberry Pi

[[File:BBox_adresse_IP_fixe.jpg]]

===Configuration d'une Box SFR===
Il faut au préalable connecter l'armoire et le module Raspberry Pi par câbles RJ45 et l'alimenter afin que la Box SFR lui affecte par défaut une adresse IP.
*Connecter vous sur votre Box SFR en tapant son IP 192.168.1.1
*Cliquer sur Réseau V4/Général
*Mettre l'identifiant et mot de passe
*Vous visualiser les Postes connectés, il doit y en avoir deux supplémentaires à votre configuration habituelle
*Notez les adresses MAC des deux équipements (celles ci vous ont été communiquées dans le bon de livraison)
*Aller dans Réseau V4/DHCP
*Dans la section Adresses statiques
**Associez l'adresse 192.168.1.200 à l'adresse MAC du Raspberry Pi et cliquez sur le bouton + à droite
**Associez l'adresse 192.168.1.201 à l'adresse MAC de l'armoire Deister et cliquez sur le bouton + à droite

[[File:Keypanel2012-redirection-de-ports-SFR.PNG|center]]

*Déconnecter l'alimentation de l'armoire et la réalimenter après 10 secondes d'attente pour visualiser les nouvelles affectations d'IP statiques

===Configuration d'une Freebox v4===
*Aller sur [https://subscribe.free.fr/login/ l'espace client]
*Saisir l'identifiant et le mot de passe
*Aller '''Ma Freebox > Configurer mon routeur Freebox'''
*Dans '''Configuration > Configuration du routeur''', vérifier que l''''Adresse IP Freebox''' est 192.168.0.254
*Cliquer sur '''Redirections / Baux DHCP''' pour faire dérouler le contenu
*Dans le paragraphe '''Redirections de ports''', à côté de l’icône symbolisant un "plus" :
**Dans le champ de la colonne '''PORT EXTERNE''' saisir ''8000''
**Dans les champs de la colonne '''IP DE DESTINATION''' saisir ''192.168.0.200''
**Dans le champ de la colonne '''PORT INTERNE''' saisir ''8000''
**Cliquer sur l'icône symbolisant un "plus" de sorte à ce que la ligne vienne s'ajouter en-dessous
*Répéter cette opération de sorte à obtenir le tableau suivant :

[[File:Keypanel2012-redirection-de-ports-freebox.png|center]]

*Dans le paragraphe '''Baux DHCP permanents''', saisir sur la ligne avec l'icône symbolisant un "plus" les couples (adresse IP, adresse MAC) communiqués dans le bordereau de livraison de sorte à obtenir le tableau suivant :

[[File:Keypanel2012-Baux-DHCP-permanents-freebox.png|center]]

*En bas du formulaire, cliquer sur le bouton '''Sauvegarder les paramètres'''
*Débrancher 5 secondes la freebox puis la rebrancher.
*Une fois l'armoire à clés livrée, passer à l'étape de [[Installation armoire à clés#Connexion_de_l'armoire|connexion de l'armoire]].

===Configuration d'une Freebox v6===
A effectuer avec l'armoire connectée au réseau local de la Freebox
*Dans un navigateur d'un appareil connecté au réseau local de la Freebox concernée : http://mafreebox.freebox.fr
*Saisir le mot de passe de connexion à la Freebox
*Double-cliquer sur le bouton '''Paramètres de la Freebox'''
*Cliquer sur l'onglet en haut '''Mode avancé'''
*Double-cliquer le bouton '''DHCP'''
*Cliquer sur l'onglet '''Baux actifs'''
*Identifier dans la liste l'armoire à clés
*Faire un clic droit et cliquer sur le bouton contextuel '''Ajouter un bail statique'''
*Compléter l'adresse IP statique avec l'adresse IP communiqué dans le bordereau de livraison
*Indiquer éventuellement un commentaire pour permettre de repérer plus facilement l'élément dans la liste
*Cliquer le bouton '''Valider'''
*Vérifier dans '''Baux statiques''' qu'apparait bien le nouvel élément

===Configuration d'une Livebox Orange===
Pour se connecter à l'interface d'une Livebox Orange, il faut :
*[[Trucs-et-astuces#Trouver-l'adresse-IP-du-routeur|Trouver l'adresse IP du routeur]].
*Taper cette adresse dans la barre d'adresse du navigateur.
*Saisir le couple identifiant mot de passe du routeur. C'est par défaut (admin, admin). ''Il est recommandé de modifier ce mot passe.''
Ensuite, la procédure dépend du [http://assistance.orange.fr/livebox-tous-les-modeles-524.php modèle de Livebox]. Nous mettons ci-dessous les procédures en fonction des demandes et des difficultés rencontrées par les administrateurs.

''Attention, pour configurer correctement le routeur, il faut mettre les couples (adresses IP, adresses MAC) au niveau de la configuration des adresses IP statiques et non pas au niveau du filtrage du réseau Wifi (WAN).''

====Livebox 2 de Sagem====
La procédure ci-dessous permet d'associer les couples (adresse IP, adresse MAC) uniquement lorsque l'armoire à clé est connectée.
* '''Configuration'''
* Menu de gauche '''Réseaux & Services > Équipements > Visualiser'''
* Deux nouvelles icônes doivent apparaitre
* Cliquer dessus chaque icône, vérifier à quel matériel l'adresse MAC correspond (inscrit sur le bordereau de livraison de l'armoire à clés) et renommer chaque icône en "Armoire à clés" et "Daemon RPi" pour une identification plus aisée.
Attention : orange rajoute ses propres noms qui ne simplifient pas la reconnaissance du matériel.
*Retourner dans l'onglet '''Configuration'''
*Menu de gauche '''Réseaux & Services > Livebox > Paramètres avancés'''
*Onglet '''DHCP'''
*Section '''Adresse IP statique'''
*Cliquer sur '''Ajouter'''
[[File:LiveBox.JPG]]
*Sélectionner dans le menu déroulant '''Armoire à clés'''
*Saisir l'adresse "192.168.1.201"
*Cliquer sur '''Ajouter'''
*Sélectionner dans le menu déroulant '''Daemon RPi'''
*Saisir l'adresse "192.168.1.200"
*Cliquer sur le bouton '''Sauver'''
*Réinitialiser la Livebox
Il ne faut pas se fier à l'interface livebox pour la reconnaissance de l'armoire à clés car il semblerait qu'il existe un défaut d'affichage de l'état de connexion de l'armoire à clés dans cette interface. A la place il faut [[Gestion armoire à clés#Vérifier_les_connexions_réseaux_de_l'armoire_et_du_mini-serveur|vérifier la bonne attribution des couples (adresse IP, adresse MAC) en ligne de commande]].

=Fixation de l'armoire DEISTER ProxSafe Smart II=
L'armoire a un encombrement murale de 630 mm x 300 mm et une profondeur de 200 mm

L'arrière du coffret comporte un capteur de détection d'arrachement, veillez à ce que la zone d'appui soit affleurante aux fixations du coffret

La face arrière du coffret est espacé de 20 mm des fixations murales. Ceci permet le cheminement des câbles (alimentation + 2 Ethernet)

Pour accéder aux fixations de l'armoire il faut ouvrir la porte de service. Prendre la clé dans la pochette rouge fournie avec l'armoire, ouvrir la porte de façade en tournant la clé dans le sens horaire. Ouvrir la porte de service en tournant la clé dans le sens anti-horaire

Sa fixation murale dépend du type de mur sur lequel vous l'installez

==Fixation de l'armoire sur un mur robuste==
Elle peut dans ce cas être fixée que par les 2 orifices traversants avec 2 vis

[[File:DEISTER_ _Support_fixation_ _dos_armoire.jpg]]

[[Media:DEISTER_fixation_SMART U II.pdf]]

*Entraxe 406 mm,
*Diamètre 10 mm,
*Profondeur 20 mm
Les fixations dépendent de la nature du support, nous conseillons :
* Dans du bois : 2 tire-fonds de 8 x 70
* Dans du béton : 2 chevilles à expansion M8 x 55 + 2 vis M8 x 60
* Dans de la brique alvéolaire : 2 chevilles à scellement chimique M8 + rondelles et écrous (ou bien voir ci dessous)

Ces fixations sont aussi suffisantes si l'armoire est supportée sur un meuble ou une étagère

==Fixation de l'armoire sur un mur de résistance modérée==
Le support de fixation fournit permet de répartir les efforts. Il est vivement recommandé pour une pose similaire à celle d'une fixation d'une télévision à écran plat murale

[[File:DEISTER_ _Support_fixation.jpg]]

Il présente les avantages suivants :
*Il permet de faire l'installation seul (pas besoin d'être à deux)
*Il permet un réglage de horizontalité pour une mise niveaux plus aisée
*Il réduit le risque de chute (l'armoire pèse 20kg) et de l'endommager en la faisant tomber lors de son installation.
Ce support ne reprend que les efforts verticaux, il ne dispense pas des 2 fixations centrales qui pourront alors être de résistance moindre. Le support comporte 8 orifices de fixations de diamètre 8 mm, le nombre de fixations sera adaptée au type de support
*Placo, chevilles à grande expansion (type "Molly") M6 x 65 ou DuoPower de Fisher + vis 7 x 60
*Brique plâtrière, carreau de plâtre, parpaing, béton cellulaire : cheville plastique de 10 x 50 + vis 6 ou 8 de longueur 60 mm

Ne pas négliger les fixations, les sollicitations dans un club peuvent être sévères

=Connexions de l'armoire DEISTER ProxSafe Smart II=

Ne brancher la batterie qu'au moment de la [[#Finalisation|finalisation]], c'est à dire une fois que l'armoire est correctement installée et configurée à la plateforme OpenFlyers. En effet, il peut être nécessaire de faire plusieurs reboots de l'armoire en débranchant/rebranchant l'armoire du secteur. De ce fait, si la batterie est branchée, le reboot ne pourrait se faire en débranchant l'alimentation.

Les câbles suivants doivent être passés avant la fixation définitive au mur :
*Câble d'alimentation 220v
*Câble Ethernet entre le routeur et l'armoire
*Câble Ethernet entre le routeur et le mini-serveur OpenFlyers
Fixer l'armoire au mur par 4 chevilles et vis en ayant au préalable retiré l’adhésif de maintien de l’interrupteur qui sert à détecter une tentative de vandalisme
*Identifier le serveur OpenKey situé derrière le verrou de porte
*Vérifier que la carte microSDHC est correctement enfichée dans le logement du serveur OpenKey situé derrière la carte électronique.
*Brancher un câble Ethernet sur le serveur OpenKey
*Identifier la prise RJ45 de l'armoire et y brancher un câble Ethernet :
*Brancher le câble d'alimentation 220V en y joignant le câble de l'armoire correspondant à la "terre" (câble jaune et vert) :
*Bien vérifier que la terre soit raccorder sur le connecteur et que votre installation dispose d'un disjoncteur différentielle approprié
[[File:Connexion_Alim_SmartII.jpg]]
*Brancher l'alimentation sur le secteur.
**1 voyant vert, sur l'alimentation signal que l'alimentation est correctement connectée
**1 voyant rouge, sur le module serveur Openkey signal que la carte est fonctionnelle, un voyant vert cligne lorsque des signaux sont échangé sur le réseaux
**5 voyants leds, situés sur la carte mère de l'armoire doivent s'éclairer
**2 leds sur chaque connecteur RJ45, indique que la connexion au réseau est fonctionnelle : orange fixe et clignement vert
*Refermer la porte de service puis la porte de façade
*A l'initialisation de l'armoire les voyants en haut de la face avant signale les phases de démarrage
** Jaune clignotant durant l'initialisation de la carte mère de l'armoire
** Jaune fixe en fin d'initialisation
** Si la configuration du programme est faite le voyant Jaune s'eteint, le voyant rouge s'allumera pour test puis le voyant vert fixe signale la fin de l'initialisation du serveur OpenKey

=Configuration OpenFlyers=

==Navigateur==

*Dialogue avec l'armoire en HTTPS : seul le navigateur Chrome de Google permet la connexion avec l'armoire à clés. Ce navigateur est compatible avec le certificat de sécurité autosigné installé sur le(s) PC permettant l'accès à l'armoire.
*Le ou les PC de la structure doivent être paramétrés pour que ce soit ce navigateur qui soit utilisé.

=== Installation du certificat de sécurité sur PC Windows ===
En cas de changement de PC le certificat de sécurité doit être installé

Avant le changement du PC récupérer la clé public sur une clé USB. Par défaut elle est situé dans le répertoire :
'''C:\Users\OpenFlyers\PyOpenKey\SSL\opkServer.crt'''

Ce certificat est au format texte codé en base 64

En tant qu'administrateur créer les répertoires devant recevoir le certificat
*Ouvrir l'explorateur et le répertoire Utilisateur
*Clic droit puis dans le menu popup sélectionné '''Nouveau > Dossier'''
*Nommer le '''OpenFlyers'''
*Ce déplacer dans ce nouveau répertoire
*Clic droit puis dans le menu popup sélectionné '''Nouveau > Dossier'''
*Nommer le '''PyOpenKey'''
*Ce déplacer dans ce nouveau répertoire
*Clic droit puis dans le menu popup sélectionné '''Nouveau > Dossier'''
*Nommer le '''SSL'''
*Copier le certificat '''opkServer.crt''' situé sur votre clé USB dans ce répertoire

L'activation du certificat doit être faite dans chaque environnement utilisant OpenFlyers

L'installation sur le nouveau PC s'effectue en ligne de commande

Ouvrir l'interface de ligne de commande de Windows
* Exécuté la commande '''cmd''' dans la zone de recherche de la barre de tache de Windows
* Cliquer sur '''Invite de commande''', ceci affiche la fenêtre noir Windows de ligne de commande
* Exécuter la commande '''certutil -addstore -f -user root "C:\Users\OpenFlyers\PyOpenKey\SSL\opkServer.crt"'''

==Paramétrage OpenFlyers==

*Aller dans '''Admin > Structure > Structure > Paramétrage'''
*Dans la section '''Contrôle d'accès''', cliquer sur l'option '''Activé(e)''' des rubriques '''Contrôle d'accès''' et '''Gestion armoire à clés'''.
[[File:Config_parametres_OF_controle_acces 1.jpg]]
*Cliquer sur le bouton '''Enregistrer'''
*De nouveaux champs sont alors visibles :
**cliquer sur l'option '''Activé(e)''' de la rubrique '''Gestion des clés'
** sélectionner le Logiciel de contrôle de l'armoire à clés. Pour OpenFlyers version 4.2 en https : PyOpenKey4
[[File:Config_parametres_OF_controle_acces 2.jpg]]
*Cliquer sur le bouton '''Enregistrer'''
*De nouveaux champs sont alors visibles :
**Champ '''Nombre de clés''' : indiquer le nombre de clés que l'armoire peut accueillir (8, 16 ou 32)
*Dans la rubrique '''IP du PC contenant le logiciel de contrôle''' indiquer l'adresse IP du mini-serveur OpenFlyers, par défaut '''192.168.0.200''' ou '''192.168.1.200'''
*Dans la rubrique '''Port du PC contenant le logiciel de contrôle''' indiquer le port '''4080''' (ou autre si spécifié sur le bordereau de livraison)
**Champ '''Vérifier la présence de la clé lors de la fermeture du vol''', valeur conseillée : '''Activé(e)'''
**Choisissez la durée de '''Temporisation''' pour prendre la clé. Cette durée est uniquement valide pour la prise de clé en mode locale, elle dépend de la distance entre votre PC et l'armoire. 10 à 20 secondes sont des valeurs usuelles. Pour la durée de déclenchement par le logiciel celle ci est paramétrable dans le programme du mini serveur. Demander au support OF pour modification
**Champ '''Fermeture automatique des vols au retour de la clé''', valeur conseillée : '''Désactivé(e)'''
**Champ '''Phrase mot de passe''', saisissez la même phrase que celle paramétrée lors de la configuration de l'armoire
[[File:Config_parametres_OF_controle_acces 3.jpg]]
*Cliquer sur le bouton '''Enregistrer'''
*Aller dans '''Admin > Utilisateurs > Profils''' et vérifier que le profil sous lequel vous êtes connecté possède le droit '''Gestion des clés''' dans l'onglet '''Généralité admin'''

=Première connexion=
==Brancher l'alimentation de l'armoire à clés==
*Le voyant vert de l'armoire doit s'allumer après quelques minutes
*Le voyant orange reste allumé durant la phase de connexion au serveur OpenFlyers et la vérification de la concordande de la position des clés dans l'armoire
*A la fin de l'initialisation, si toutes les clés sont bien positionnées, le voyant orange s’éteint

Si le voyant orange ne s'éteint pas, [[Gestion armoire à clés#Remettre_les_clés_à_leur_bonne_position|vérifier si le problème ne vient pas de la position d'une ou plusieurs clés]].

== Vérifier la communication avec le serveur PyOpenKey ==
Ce chapitre concerne les utilisateurs d'OpenFlyers 4.2 et au delà qui demande une connexion au serveur PyOpenKey en https

Vérifier si le certificat est correctement reconnu sur votre PC

*Ouvrer le Navigateur Google Chrome
*Dans le champ url indiquer l'adresse du WevServer de PyOpenKey, port 8000 '''https;//192.168.1.200:8000''' (cette adresse est a adapter en fonction de votre configuration réseau)
*Si c'est une première connexion, une fenêtre Windows s'ouvre vous demandant la confirmation de l'utilisation du certificat
*Si la fenêtre Windows indique que la connexion n'est pas sécurisé c'est que le certificat n'est pas correctement installé. Ne pas valider une exception de sécurité
*Si le certificat est reconnu alors la page du [[Gestion-armoire-à-clés#Connexion-à-l'interface-Web-de-secours|Webserver]] doit s'ouvrir

=Appariement des clés aux ressources=
*Pour attribuer les clés aux ressources dans OpenFlyers il faut aller dans la page '''Gestion > Ressources > Actives'''
*Sélectionner un numéro de clé pour chaque ressource.
[[File:Page_Ressource.jpg|center]]

Sur les versions au-delà d'OpenFlyers 4.2, si aucune action ne s'exécute ceci être dû à la non reconnaissance du certificat

Voir [[Installation-armoire-à-clés#Vérifier-la-communication-avec-le-serveur-PyOpenKey |Vérifier la communication avec le serveur PyOpenKey]].

Sur les versions antérieures d'OpenFlyers 4.2, si l'action ne s'exécute pas ceci peut être dû au blocage par le navigateur des scripts javascript car l'appel est en http sur une page https.

Sous Google Chrome apparait un icône en haut à droite
[[File:Page_Allow_mixed_content_Chrome.png|center]]
Avec le message
<bash>This page is trying to load scripts from unauthenticated sources</bash>
Avec un lien pour autoriser la page
<bash>Load unsafe script</bash>

=Enregistrer la position souhaitée des clés=
*Aller dans '''Gestion > Ressources > Actives'''
*Cliquer sur l'un des icônes symbolisant une clé dans la colonne '''Armoire à clé > Statut''' afin de pouvoir déverrouiller la porte.
*Mettre '''toutes les clés''' au tableau dans l'ordre souhaité y compris les clés qui avaient été retirées lors de la [[#Première_connexion|première connexion]]. Il ne faut pas tenir compte des lumières rouges autour des clés.
*Cliquer sur l'icône '''Activer les tags des clés'''
Les identifiants de chaque clé doivent apparaître après rafraîchissement de la page :

[[File:Ressources_activees.jpg|center]]

Si ce n'est pas le cas, rafraichir manuellement la page en allant dans '''Gestion > Ressources > Actives'''.

Débranchez de nouveau l'armoire pour refaire l'initialisation

=Prise de clé à l'ouverture d'un vol=
Pour un contrôle de la prise de clé par un utilisateur il faut que le logiciel soit paramétré avec l'option '''Ouverture et fermeture des activités.''' Aller dans '''Admin > Structure > Structure > Paramétrage''' et dans la rubrique '''Gestion des activités''' activer l'option '''Ouverture et fermeture des activités'''
.
[[File:Gestion_des_vols.JPG]]

Pour une prise de clé il faut cliquer droit sur une réservation et choisir l'option Saisir un vol
La page de saisie d'un vol s'ouvre avec l'option Départ en vol
Renseigner les champs et cliquer sur Valider
Une page de prise de clé s'ouvrira

[[File:Prise_de_cle.JPG]]

Cliquer sur le bouton Libérer la clé pour l'aéronef F-XXXX
La porte doit se déverrouiller (voyant orange) et la clé être libérer durant la temporisation prévue (clé entourée d'un halo lumineux rouge)
Refermer la porte sinon un buzzer intermittent retenti

Déconnectez-vous de OpenFlyers pour l'utilisateur suivant

=Retour de vol=

Pour remettre la clé, se connecter sur OpenFlyers
Cliquer sur l'icône Ouvrir la porte en haut à gauche de la page du cahier de réservation

[[File:Ouvrir_porte.JPG]]

La porte sera déverrouillé durant la durée de la temporisation
*Remettre la clé à son emplacement
*Si la clé est incorrectement placée, l'armoire déverrouille la clé (halo rouge de la clé reposée) et signale l'emplacement correct en allumant le halo rouge de l'emplacement prévu.
*Sur le planning l'avion en vol est indiquer par une couleur bleu. Survoler ce vol avec la souris
*Un menu apparait avec l'option '''Fermer le vol'''
*Cliquer et enregistré le vol

'''Note:''' Ne pas aller directement sur le menu '''Planning > Activités > Saisir une activité''' pour fermer le vol. Dans ce cas il ne pourra être établi de corrélation entre l'affichage du planning et le vol que vous fermez. Le vol restera ouvert (en bleu sur le planning) et l'avion sera bloqué pour repartir en vol. Néanmoins si un pilote faire l'erreur alors il faut, dans le menu surgissant, cliquer sur '''Annuler'''

=Finalisation=
*Ouvrir la porte de service
*Brancher le connecteur de la batterie de sauvegarde (Déconnecté pour le transport)

[[File:Connexion_Batterie_SmartII.jpg]]
*Refermer la porte de service

L'ouverture de la porte de service enclenche une alarme qui est mise en mémoire dans OpenFlyers. Pour supprimer l'alarme il faut aller sur l'interface [[Gestion armoire à clés#Connexion_interface_Web_de_secours|Web admin]] et cliquer sur '''RESET'''

Gestion des types d'activités

2024-10-02T17:27:54Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de présenter la '''gestion des types d'activités''' sur la [[Accueil|version 4 d'OpenFlyers]].

Le droit [[Gestion-des-profils#Gestion-du-paramétrage|Gestion du paramétrage]] est nécessaire pour accéder à cette fonctionnalité.

=Affecter une couleur à un type d'activité=
Préambule : pour voir ces couleurs, il faut que dans la configuration soit paramétré le code couleur par type d'activité pour voir ces couleurs.

*Aller sur la page '''Admin > Types d'activités > Types d'activités > Actifs'''
*Aller sur la ligne concernée et cliquer dans la colonne '''Couleur''' où apparait l'icône modifier.
*Sélectionner une couleur.
*La validation se fait automatiquement.

=Ajouter un type d'activité=
*Aller sur la page '''Admin > Types d'activités > Types d'activités > Actifs'''
*Cliquer sur chaque cellule contenant le symbole '''+''' pour
**Saisir le nom du type d'activité
**[[#Affecter-une-couleur-à-un-type-d'activité|Affecter une couleur]]
**La colonne '''Formation''' permet de définir le type d'activité comme étant un type d'activité formation ce qui permet de [[Gestion-des-activités#Saisir-un-suivi-de-formation|saisir un suivi de formation]] pour chaque activité ayant ce type.
*Cliquer sur l'icône [[File:MRO302-addButton.png]]

=Modifier un type d'activité=
*Aller sur la page '''Admin > Types d'activités > Types d'activités > Actifs'''
*Cliquer sur le champ dont le contenu est à modifier de l'activité concernée et qui correspond à l'une des colonnes suivantes :
**'''Nom''' : nom de l'activité
**'''[[#Affecter-une-couleur-à-un-type-d'activité|Couleur]]'''
**'''Formation''' : permet de définir le type d'activité comme étant un type d'activité formation ce qui permet de [[Gestion-des-activités#Saisir-un-suivi-de-formation|saisir un suivi de formation]] pour chaque activité ayant ce type.
Une fois la modification effectuée, il faut cliquer en dehors du tableau pour que la modification soit enregistrée en base de données.

=Typer formation un type d'activité=
Permet de définir un type d'activité comme étant un type d'activité formation ce qui permet de [[Gestion-des-activités#Saisir-un-suivi-de-formation|saisir un suivi de formation]] pour chaque activité ayant ce type.

*Aller sur la page '''Admin > Types d'activités > Types d'activités > Actifs'''
*Cliquer sur la cellule de la colonne '''Formation''' de la ligne du type d'activité concerné
*Cocher la case à cocher
Une fois la modification effectuée, il faut cliquer en dehors du tableau pour que la modification soit enregistrée en base de données.
Attendre que la page se rafraichisse et qu'un 1 apparaisse

Gestion des profils

2024-10-02T17:27:53Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter la '''gestion des profils''' sur la [[Accueil|version 4 d'OpenFlyers]].

[[File:Profile-management4.png]]

Les profils attribués par défaut à un utilisateur créé automatiquement sont définis dans '''Admin > Utilisateurs > Paramètres par défaut'''.

=Définition=
*Un '''profil''' correspond à un ensemble de '''droits''' qui définissent les actions que peut effectuer un [[Glossaire|utilisateur]] dans l'application OpenFlyers.
*Un utilisateur peut disposer de '''plusieurs profils'''. L'attribution des profils aux utilisateurs se fait par l'intermédiaire du [[Gestion des utilisateurs|tableau de gestion des utilisateurs]].

''Exemple de profils : administrateur, pilote, formateur, technicien, mécanicien, trésorier, secrétaire.''

=Icônes symbolisant les droits des profils=
Dans la page '''Admin > Utilisateurs > Profils''', il faut distinguer deux éléments pour comprendre le principe des icônes. Il y a les droits d'un côté et les profils de l'autre.

Les droits constituent les entêtes du tableau. Chaque entête de colonne correspond à un droit.
L’icône [[File:Profile-management3.0.x_Userinfo_connected.gif]] a été attribuée à l'ensemble de ces droits sauf deux :
*[[#Profil-non-sélectionnable-par-l'utilisateur|Profil non sélectionnable par l'utilisateur]] de l'onglet '''Généralités''' à laquelle l'icône [[File:Profile-management3.0.x_ConnectedNoFilling.png]] à été attribuée
*[[#Voir-les-noms-sur-les-réservations|Voir les noms sur les réservations]] de l'onglet '''Réservations''' à laquelle l'icône [[File:Profile-management3.0.x_Userinfo_kiosk.gif]] à été attribuée

Les profils correspondent à chaque ligne du tableau. L'icône d'un profil est variable et dépend des droits qui lui sont attribués.
#L'icône d'un profil sera [[File:Profile-management3.0.x_ConnectedNoFilling.png]] si le droit [[#Profil-non-sélectionnable-par-l'utilisateur|Profil non sélectionnable par l'utilisateur]] ci-dessus est coché
#L'icône d'un profil sera [[File:Profile-management3.0.x_Userinfo_kiosk.gif]] si aucun droit n'est attribué au profil à l'exception du droit [[#Voir-les-noms-sur-les-réservations|Voir les noms sur les réservations]] ci-dessus qui peut être coché ou non
#Dans tous les autres cas, l'icône d'un profil sera [[File:Profile-management3.0.x_Userinfo_connected.gif]]

==Définition des icônes représentant des droits==
:[[File:Profile-management3.0.x_Userinfo_connected.gif]] : Droit qui définit un profil de base.
:[[File:Profile-management3.0.x_ConnectedNoFilling.png]] : Droit qui rend un profil non sélectionnable par un utilisateur lors de sa connexion.
:[[File:Profile-management3.0.x_Userinfo_kiosk.gif]] : Droit qui rend un profil de type "kiosque" (voir [[Kiosque PC]]) permettant de consulter le planning uniquement. Si au moins un droit de base est activé, le profil devient un profil de base.

==Définition des icônes attribuées aux profils==
:[[File:Profile-management3.0.x_Userinfo_connected.gif]] : Profil de base
:[[File:Profile-management3.0.x_ConnectedNoFilling.png]] : Profil non sélectionnable par un utilisateur lors de sa connexion.
:[[File:Profile-management3.0.x_Userinfo_kiosk.gif]] : Profil de type "kiosque" (voir [[Kiosque PC]]) permettant de consulter le planning uniquement. Toute modification ou saisie par un utilisateur nécessitera une identification par le biais d'une fenêtre "pop-up" demandant à l'utilisateur son propre identifiant et mot de passe.

=Niveau d'accréditation des droits et des profils=
Les niveaux d'accréditation vont de 0 à 6 :
*0 représente le niveau le plus bas
*6 représente le niveau le plus élevé

Chaque droit dispose d'un niveau d'accréditation qui lui est propre : plus le droit permet de faire des actions pouvant avoir des conséquences sur les données, plus le niveau d'accréditation est élevé.

Chaque profil dispose également d'un niveau d'accréditation. Le niveau d'accréditation d'un profil correspond au niveau d'accréditation le plus élevé des droits détenus par le profil.

La page '''Admin > Utilisateurs > Profils''' indique les niveaux d'accréditation à la fois des droits et des profils :
*Les droits sont indiqués dans les entêtes de chaque colonne. Le niveau d'accréditation du droit est indiqué en dessous du nom du droit dans un cercle.
*Les profils sont indiqués à chaque ligne du tableau. le niveau d'accréditation du profil est indiqué en dessous du nom du profil dans un cercle.
Le niveau d'accréditation 6 est affiché en inverse vidéo par rapport aux autres niveaux pour le distinguer.

Un gestionnaire disposant le droit de gérer des utilisateurs ne peut attribuer un profil à un utilisateur qui soit plus élevé que le profil le plus élevé qu'il détient lui-même.

Lorsqu'une plateforme dispose de plus de 3 utilisateurs avec le niveau 6, [[Alertes-de-configuration#La-plateforme-a-plus-de-3-utilisateurs-actifs-avec-un-profil-de-niveau-6.-Les-utilisateurs-concernés-sont-:-XXX|une alerte de configuration est affichée]].

Lorsqu'un droit de niveau 6 est accordé à un profil, une alerte est générée si cela entraîne plus de 3 utilisateurs de niveau 6.

=Profils=
La gestion des profils s'effectue depuis le menu '''Admin > Utilisateurs > Profils'''.

Le nombre d'onglets disponible dépend du paramétrage de la plateforme OpenFlyers. Par exemple, si la gestion des activités est activée, alors l'onglet ''Activités'' est disponible.

==Généralités==

===Profil non sélectionnable par l'utilisateur===

Lors de la connexion et lorsqu'un utilisateur doit faire le choix entre un profil pour se connecter, les [[Bien-débuter-avec-OpenFlyers#Attribuer-les-profils-aux-utilisateurs|profils non sélectionnables]] ne seront pas proposés parmi la liste. Ce droit ne peut pas être attribué à un profil ayant des droits de gestion.

===Pas de déconnexion automatique===
Ce droit permet d'éviter la [[Connexion#Automatique|déconnexion automatique de la session]] au bout de 10 minutes et étend la connexion à 2 heures.

===Accès visiteur===
L'accès visiteur permet de [[Kiosque-PC#Créer-un-compte-utilisateur-Visiteur|créer un compte visiteur]] donnant un accès limité destiné à pouvoir être utilisé par n'importe quelle personne.

Cet accès permet également de créer un lien vers OpenFlyers avec une connexion automatique en passant les identifiants via l'URL.

Si un visiteur [[#Réservation|peut réserver]] - dépend du paramétrage - alors, lors de la création d'une réservation, [[Utilisation-du-planning-de-réservation#Créer-automatiquement-un-utilisateur-en-créant-une-réservation|le système va générer automatiquement un compte utilisateur]] à partir des informations que le visiteur aura saisi. Le visiteur sera connecté automatiquement sur ce nouveau compte.

===Mise à jour de sa date de naissance, de son sexe et de sa nationalité===

Permet à un utilisateur de modifier [[Fiche-personnelle#Mettre-à-jour-sa-date-de-naissance,-sa-nationalité-ou-son-sexe|sa date de naissance, sa nationalité et/ou son sexe dans sa fiche personnelle]].

===Voir ses validités===

Permet d'[[Validités#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|accéder à ses validités depuis le planning]].

===Ajout et gestion de ses validités===

Permet à un [[Validités#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|utilisateur de rajouter/supprimer/mettre à jour ses validités]] qui sont dans la liste [[#Type-de-validité-que-l'utilisateur-peut-gérer|Type de validité que l'utilisateur peut gérer]] et pour la mise à jour, sous réserve que le type de validité dispose d'informations qui peuvent être mises à jour.

===Gestion de ses validités détenues===

Permet à un [[Validités#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|utilisateur de mettre à jour/supprimer uniquement les validités]] qui lui sont déjà attribuées et qui sont dans la liste [[#Type-de-validité-que-l'utilisateur-peut-gérer|Type de validité que l'utilisateur peut gérer]] et pour la mise à jour, sous réserve que le type de validité dispose d'informations qui peuvent être mises à jour.

===Surpasser les restrictions sur les validités===
Permet à un utilisateur de surpasser les [[Connexion#Restriction_d'accès|restrictions d'accès]] dues à des validités expirées, incomplétes ou non certifiées qui sont [[Validités#Contrôle-des-validités-à-la-connexion|appliquées à la connexion]].

Voir le chapitre [[Paramétrage-des-validités#Alerte-à-la-connexion|Alerte à la connexion]] pour le paramétrage des restrictions sur les validités.

===Editer sa photo===

Permet à un utilisateur [[Fiche-personnelle#Editer-sa-photo|d'importer ou de supprimer sa photo dans sa fiche personnelle]].

==Réservation==

===Planning personnel===

Permet de visualiser son propre planning.

===Planning individuel visible pour les autres===

Permet de rendre disponible son planning aux autres utilisateurs.

===Personnaliser ses ressources visibles===

Permet de personnaliser la [[Fiche-personnelle#Paramétrer-les-ressources-et-les-utilisateurs-visibles-sur-le-planning|liste des ressources et utilisateurs visibles dans le planning depuis sa fiche utilisateur]].

===Gérer ses disponibilités===

Permet la gestion de [[Gestion-des-disponibilités#Gérer-la-disponibilité-des-intervenants|ses propres disponibilités]].

===Gestion des disponibilités des tiers===

Permet de gérer la [[Gestion-des-disponibilités#Gérer-la-disponibilité-des-intervenants|disponibilité des utilisateurs]].

===Etre sur une nouvelle réservation===
Permet lors d'une nouvelle réservation, que l'utilisateur disposant du profil concerné soit autorisée à être sur une des places.

Permet entre autre à un utilisateur tiers, de pouvoir effectuer de nouvelles réservations pour un utilisateur disposant du profil concerné et n'ayant pas de droit [[#Réservation-solo|Réservation solo]], [[#Réservation-pour-des-tiers|Réservation pour des tiers]] ou [[#Réservation-avec-un-instructeur|Réservation avec un instructeur]].

===Réservation solo===

Autorise un utilisateur de réserver une ressource avec lui-même en première place.

===Réservation pour des tiers===

Autorise la réservation d'une ressource pour un autre utilisateur (en solo et/ou double selon les droits du profil de cet utilisateur tiers).

===Réservation avec un instructeur===

Autorise la réservation d'une ressource avec une personne en seconde place.

===Réservation de programmes===
Autorise [[Planning-(interface-légère)#Positionner-automatiquement-les-activités-d’un-programme-de-formation|le positionnement automatique des activités d’un programme de formation dans le planning]].

===Gestion des disponibilités des ressources===

Sur l'ancienne interface, permet de gérer la disponibilité des ressources et de les immobiliser (pour entretien, maintenance, réparation, arrêt d'activité, ...).

Cela se fait comme pour une réservation, une case "immobiliser la ressource" est alors disponible. Sur la frise de réservation, il sera indiqué "Mise en maintenance" pour la période demandée.

===Surpasser l'indisponibilité des instructeurs===

Autorise la réservation d'une ressource avec un instructeur même si celui-ci n'est pas enregistré comme disponible durant la plage horaire de la réservation (Un message d'alerte prévient quand même. Fonction utile pour les instructeurs et le secrétariat).

===Surpasser l'indisponibilité des ressources===

Autorise la réservation d'une ressource même si celle-ci n'est pas enregistrée comme disponible durant la plage horaire de la réservation (Un message d'alerte prévient quand même).

===Surpasser l'interdiction d'effectuer une réservation dans moins de X temps===

Autorise la réservation en annulant l'interdiction "d'effectuer une réservation débutant dans moins de" .

===Surpasser la limite de durée minimum===

Autorise la réservation en annulant la restriction sur la durée minimum d'une réservation.

===Surpasser la limite de durée maximum===

Autorise la réservation en annulant la restriction sur la durée maximum d'une réservation.

===Surpasser la limite de temps===

Autorise la réservation en annulant la restriction sur la limitation dans le temps des réservations.

===Surpasser la limite de nombre===

Autorise la réservation en annulant la restriction sur le nombre maximum de réservation.

===Surpasser la réservation par type===

En cas de chevauchement, cela permet de déplacer la réservation sur une autre ressource de type différent.

===Alertable par e-mail pour toute réservation===

Permet la [[Fiche-personnelle#Recevoir-un-e-mail-pour-les-réservations-ayant-pour-activité|notification par e-mail pour toute réservation]].

===Créer ou modifier une réservation avec une date de début dépassée===

Autorise à créer ou modifier une réservation dont la date de début est dépassée.

===Supprimer une réservation avec une date de début dépassée===

Autorise à supprimer une réservation dont la date de début est dépassée.

===Voir les noms sur les réservations===
Permet de visualiser les noms des utilisateurs associés à la réservation.

===Voir les activités sur les réservations===
Permet de [[Planning-(interface-légère)#Affichage-des-activités-sur-les-réservations|visualiser les types d'activités associés à chaque réservation]].

===Voir les images des pilotes sur le menu contextuel===
Permet de [[Planning-(interface-légère)#Affichage-des-images-des-pilotes-sur-le-menu-contextuel|visualiser images des pilotes associés à chaque réservation sur le menu contextuel]] lorsqu'on survole ou effectue un clic droit sur la réservation.

===Surpasser les formules de saisie===
Permet de surpasser les règles de saisie sur les réservations.

===Champs additionnels visualisables dans les pop-ups de réservation===

Permet de visualiser le contenu des champs additionnels dans la pop-up de réservation.

==Activités==

===Etre sur une nouvelle ouverture d'activité===
Permet lors d'une nouvelle ouverture d'activité, que la personne disposant du profil concerné soit autorisée à être sur une des places.

Permet entre autre à une personne tierce, de pouvoir effectuer de nouvelles ouvertures d'activité pour une personne disposant du profil concerné et n'ayant pas le droit [[#Saisie-d'activité-pour-soi-même|Saisie d'activité pour soi-même]] ou [[#Saisie-d'activité-pour-un-tiers|Saisie d'activité pour un tiers]].

===Etre sur une nouvelle fermeture d'activité===
Permet lors d'une nouvelle fermeture d'activité, que la personne disposant du profil concerné soit autorisée à être sur une des places.

Permet entre autre à une personne tierce, de pouvoir effectuer de nouvelles fermetures d'activité pour une personne disposant du profil concerné et n'ayant pas le droit [[#Saisie-d'activité-pour-soi-même|Saisie d'activité pour soi-même]] ou [[#Saisie-d'activité-pour-un-tiers|Saisie d'activité pour un tiers]].

===Saisie d'activité pour soi-même===
Autorise la saisie des vols et permet aussi à l'utilisateur de voir son carnet de vols.

Permet également de supprimer ses propres vols depuis son carnet de vol et depuis le [[Carnet-de-route#Modifier-et-supprimer|carnet de route]].

===Saisie d'activité pour un tiers===
Autorise la saisie des vols pour des tiers et permet de voir les carnets de vols des utilisateurs.

Permet également de supprimer les vols des tiers depuis le carnet de vol d'un utilisateur et depuis le [[Carnet-de-route#Modifier-et-supprimer|carnet de route]].

===Vérifier la saisie des activités et les modifier===

Permet de voir les carnets de vols des utilisateurs et de pointer les vols (vérification qui entérine un vol et qui rend ainsi sa modification ou suppression impossible), permet ainsi de voir les "vols oubliés" aussi (trous dans les horamètres).

===Visualisation du carnet de route===

Accorde (ou pas) le droit de visualiser le carnet de route de chaque ressource aéronef.

===Visualisation de son carnet de vol===

Autorise l'utilisateur à voir son carnet de vol.

===Visualiser les traces de vol===

Permet de [[Interfaçage-OpenFlyers-et-Charterware#Récupération-des-traces-de-vols|visualiser les traces d'un vol]].

===Attribution de place===

Permet d'attribuer les places auxquelles sont autorisées les utilisateurs de ce profil. Cela impacte sur les listes des utilisateurs qui se nttrouve à la saisie d'une réservation ou d'une activité.

Ces listes sont accessibles depuis '''Planning > Planning > Réserver''' et '''Planning > Activités > Saisir une activité'''.

La page '''Admin > Type de ressource > Places''' permet de gérer les places d'un type de ressource. Elle permet également de définir qui a le droit d'être sur telle place en cas de restriction de profil.

===Alerté par e-mail pour le renouvellement des validités de tous les utilisateurs===

Ce droit permet de suivre le renouvellement des validités par les utilisateurs en étant alerté par un [[Envoi-des-emails#E-mail-d'information-des-actions-des-utilisateurs-sur-des-validités|e-maild'information des actions des utilisateurs sur des validités]] à chaque fois qu'un utilisateur renouvelle une validité sélectionnée dans la liste de la cellule '''Alerté par e-mail pour le renouvellement des types de validités'''. Attention : la mise en place de ce droit peut provoquer la réception de nombreux e-mails.

==Formations==
===Voir les suivis de formations===
Autorise l'utilisateur à [[Gestion-des-activités#Consulter-le-suivi-de-formation|voir les suivis de formations]] de tous les utilisateurs.

===Gestion des formations===
Ce droit permet la [[Gestion-des-formations|gestion des formations]].

==Comptes==

===Gestion des comptes===
Couplé à d'autres droits, permet de créer et modifier les intitulés des comptes (boutiques, espèces, etc.) ainsi que d'accéder à la comptabilité.

Permet lors de la [[Gestion-de-la-comptabilité-côté-utilisateur#Extrait-de-compte|visualisation des écritures]] d'un compte :
*de pouvoir consulter les écritures des comptes affectés
*[[Gestion-de-la-comptabilité-côté-utilisateur#Consulter-une-facture-client-ou-un-reçu-d'encaissement|de pouvoir consulter une facture client ou un reçu]]
*de pouvoir [[Utilisation-de-la-comptabilité#Contrepasser-une-écriture|contrepasser les écritures]]
*de pouvoir [[Utilisation-de-la-comptabilité#Lettrer-des-écritures-comptables|lettrer les écritures]]

Permet [[Utilisation-de-la-comptabilité#Importer-un-relevé-bancaire|d'importer des relevés bancaires]]

Ce droit inclut les droits '''Gestion des types d'encaissements''' et '''Voir les comptes'''.

===Voir les comptes===
[[Gestion-de-la-comptabilité-côté-utilisateur#Consulter-son-compte-ou-celui-d'un-tiers|Permet de voir tous les comptes]], de [[Gestion-de-la-comptabilité-côté-utilisateur#Extrait-de-compte|visualiser la liste des mouvements]] et de [[Gestion-de-la-comptabilité-côté-utilisateur#Consulter-une-facture-client-ou-un-reçu-d'encaissement|consulter les factures clients et les reçus]].

Couplé au droit [[#Saisir-les-encaissements-pour-les-tiers|Saisir les encaissements pour les tiers]], il permet de saisir un encaissement sur tous comptes. Ce droit inclut les privilèges du droit [[#Voir-les-comptes-utilisateurs|Voir les comptes utilisateurs]].

===Voir les comptes utilisateurs===
[[Gestion-de-la-comptabilité-côté-utilisateur#Consulter-son-compte-ou-celui-d'un-tiers|Permet de voir tous les comptes utilisateurs]] et de [[Gestion-de-la-comptabilité-côté-utilisateur#Consulter-une-facture-client-ou-un-reçu-d'encaissement|consulter les factures clients et les reçus]].

Couplé au droit [[#Saisir-les-encaissements-pour-les-tiers|Saisir les encaissements pour les tiers]], il permet de saisir un encaissement sur les comptes utilisateurs.

===Gestion des comptabilités===

permet la gestion des comptabilités

===Gestion des types d'encaissements===

permet la gestion des types d'encaissements.

===Encaisser ses paiements===

Permet à l'utilisateur de [[FAQ-comptabilité#Comment-autoriser-un-profil-utilisateur-à-saisir-des-encaissements-pour-lui-même-?|saisir ses propres paiements]], de les modifier ou de les supprimer tant qu'ils n'ont pas été validés. L'utilisateur ne peut pas saisir les types d'encaissements qui sont ''Accessible uniquement aux personnes autorisées à saisir pour les tiers''.

===Saisir les encaissements pour les tiers===

Permet à l'utilisateur de saisir, modifier ou supprimer, tant qu'ils n'ont pas été validés, les encaissements d'autres utilisateurs ainsi que les encaissements devant être affectés sur des [[Configuration de la comptabilité#Créer_un_compte_comptable|comptes comptables clients autorisés à recevoir de l'argent]].

===Modifier la date d'un encaissement, d'un flux ou d'un transfert===

autorise la modification de la date d'un encaissement, d'un flux ou d'un transfert s'il peut être modifié

===Valider les encaissements===

pointage des paiements saisis par les pilotes par exemple (Modification ultérieure de cette saisie impossible, en cas de problème il faudra alors faire l'opération inverse). Permet également la suppression d'encaissement.

===Recevoir de l'argent===

Permet à un utilisateur d'être sur la liste des paiements remis. Voir la [[Configuration-de-la-comptabilité#Types-d'encaissements|configuration de la ventilation des types d'encaissements]].

===Transfert de son compte===
Permet le transfert de compte à compte depuis la page '''Planning > Comptes > Actions > Transférer'''.

Les transferts effectués avec ce seul droit (sans le droit [[#Transfert-de-son-compte-sans-validation|Transfert de son compte sans validation]]) depuis cette page sont validés automatiquement.

===Transfert de son compte sans validation===
Permet lors d'un transfert de compte à compte, que les flux générés ne soient pas automatiquement validés. Ce droit n'a d'effet que si le droit [[#Transfert-de-son-compte|Transfert de son compte]] est affecté au profil.

'''Conseil OpenFlyers :''' Ce droit a été créé à la demande de clients OpenFlyers. Néanmoins, nous en déconseillons son usage. En effet, avec ce droit, un utilisateur qui "donne" de l'argent à un autre utilisateur peut ensuite reprendre sa donation. Or comme le dit l'expression : "[https://fr.wiktionary.org/wiki/donner_c%E2%80%99est_donner,_reprendre_c%E2%80%99est_voler Donner c'est donner, reprendre c'est voler]". L'attribution du seul droit [[#Transfert-de-son-compte|Transfert de son compte]] permet un comportement conforme aux fonctionnalités présentes sur les applications bancaires, à savoir que lorsqu'on effectue un virement ce virement est définitif. Si un utilisateur se trompe dans son virement, alors il faut qu'il demande soit à la personne à qui il a donné de lui rendre le trop-perçu, soit à un gestionnaire de la structure pour qu'elle saisisse une écriture corrective. L'intérêt de procéder ainsi est qu'on conserve visuellement et directement sur les comptes la trace des opérations effectuées.

===Saisir tout flux===
Permet de :
*[[Utilisation-de-la-comptabilité#Saisir-un-flux|saisir des flux]] depuis '''Gestion > Comptes > Flux > Saisir'''
*de modifier/supprimer des flux non validés
*de consulter la liste des flux depuis '''Gestion > Comptes > Flux > Valider'''
*de [[Gestion-de-la-comptabilité-côté-utilisateur#Extrait-de-compte|visualiser la liste des mouvements]]
*d'[[Utilisation-de-la-comptabilité#Importer-un-relevé-bancaire|importer des relevés bancaires]]

===Valider tout flux===
Permet de valider les flux de la page '''Gestion > Comptes > Flux > Valider'''.

Ce droit n'a effet que si le droit [[#Saisir-tout-flux|Saisir tout flux]] est affecté au profil.

===Paramétrage de la facturation===
Permet de gérer les règles de [[Facturation-des-clients#Facturation-des-activités|facturation des activités]] et de [[Facturation-des-clients#Facturation-périodique|facturation périodique]].

===Saisie des valeurs de facturation===

Permet de gérer les variables et leurs valeurs destinés aux règles de facturation

===Compte sur lequel un utilisateur peut agir===

Permet de définir sur quel compte utilisateur un encaissement ou un transfert peut être réalisé par la personne connectée. Attention : ce droit est pour l'utilisateur connecté et non pas pour l'utilisateur concerné par l'encaissement ou le transfert.

===Surpasser la limitation du solde du compte===

Permet à un utilisateur disposant de ce droit dans l'un de ses profils de ne pas avoir de [[Connexion#Restriction_d'accès|restriction d'accès]], de saisie de réservation ou de saisie de vol lorsque [[Configuration de la comptabilité#Restriction_d'accès_en_cas_de_solde_insuffisant|une restriction sur les soldes]] est en place. Il aura juste une alerte à la connexion. Ce droit ne permet pas à l'utilisateur concerné X de pouvoir surpasser les restrictions d'un autre utilisateur Y en effectuant par exemple une réservation en son nom alors que Y n'a ni le droit de surpasser ni le solde suffisant.

===Surpasser le seuil de [[Gestion-de-la-comptabilité-côté-utilisateur#Transférer-de-l'argent|transfert de compte]]===

Permet à un utilisateur disposant de ce droit dans l'un de ses profils de ne pas être bloqué lorsque une [[Configuration-de-la-comptabilité#Paramétrage-général-des-comptabilités|restriction sur les soldes]] est en place et qu'il ne dispose pas d'un solde suffisant.

==Ventes==

===Gestion globale des ventes===

Permet de gérer les produits, la facturation des produits, les stocks et [[Paramétrage-des-validités#Validité-à-vendre|validités à vendre]]. Permet également de modifier/supprimer des achats de produit.

===Achat ventes libres===

Autorise à acheter tous les produits qui sont en vente libre. Permet également de modifier/supprimer des achats de produit.

===Acheter pour les tiers===
Autorise à effectuer/modifier/supprimer des achats de produit pour un tiers.
*Couplé au droit [[#Gestion-des-utilisateurs|Gestion des utilisateurs]], il permet de gérer les [[Paramétrage-des-validités#Validité-à-vendre|validités à vendre]] d'un tiers.
*Couplé au droit [[Gestion-des-profils#Vente-de-produit-sans-tarif|Vente de produit sans tarif]], il permet de vendre des [[Gestion-des-produits-et-des-ventes#Configuration-d'un-produit-non-stocké-sans-tarif-défini|produits sans tarif]].

===Vente de produit sans tarif===
Autorise à rendre disponible et à acheter des produits sans tarif. Nécessite le droit [[#Acheter-pour-les-tiers|Acheter pour les tiers]].

===Débrayage des ventes de validités===

Autorise à ajouter et modifier la date d'expiration d'une [[Validités#Validité-à-vendre|validité à vendre]] sans débiter le compte.

==Achats==

===Gestion des achats===
Permet la gestion des factures fournisseurs, à en créer, modifier et supprimer.

==Admin==
===Gestion du paramétrage===
Ce droit est nécessaire pour accéder aux pages permettant de [[Paramétrage|paramétrer la plateforme]] et fait apparaitre le menu '''Structure''' avec les items :
*[[Données#Accéder-au-tableau-de-conservation-des-données|'''Admin > Structure > Données > Conservation des données''']]
*'''Admin > Structure > Structure > Canaux de communications'''
*[[Configuration#Admin > Structure > Structure > Paramétrage|'''Admin > Structure > Structure > Paramétrage''']]
*[[Configuration#Admin->-Structure->-Structure->-Coordonnées|'''Admin > Structure > Structure > Coordonnées''']]
*'''Admin > Structure > Variables > Définition'''
*'''Admin > Structure > Variables > Actualisation'''
*[[Configuration#Structure->-Champs-métiers|'''Admin > Structure > Variables > Champs métiers''']]
*[[Configuration#Structure->-Export-SQL|'''Admin > Structure > Export SQL > Complet''']]
*[[Utilisation-de-la-comptabilité#Importer-son-modèle-de-facture|'''Admin > Structure > Imports > Templates ODT''']]

Ce droit fait également apparaitre des items utiles au paramétrage mais présents dans d'autres menus :
*Couplé au droit [[#Gestion-des-utilisateurs|Gestion des utilisateurs]], dans le menu '''Admin > Utilisateurs''' :
**[[Champs-métiers|'''Admin > Utilisateurs > Champs métiers''']]
**'''Admin > Utilisateurs > Statuts'''
*[[Gestion-des-types-d'activités|'''Admin > Types d'activités > Actifs''']]
*[[Champs-métiers|'''Admin > Types d'activités > Champs métiers''']]
*[[Champs-métiers|'''Ventes > Champs métiers > Champs métiers''']]

===Gestion des valeurs===

===Gestion des profils===
permet de créer et modifier les profils. Attention, laisser cette autorisation à au moins un profil !

===Gestion des utilisateurs===

Permet de modifier les caractéristiques, infos et photos des utilisateurs, les désactiver et gérer leurs validités qui ne correspondent pas à des [[Paramétrage-des-validités#Validité-à-vendre|validités à vendre]]. Couplé au droit [[#Acheter-pour-les-tiers|Acheter pour les tiers]], il permet de gérer les [[Paramétrage-des-validités#Validité-à-vendre|validités qui sont à vendre]].

===Gestion des ressources===
Permet la gestion complète des types de ressources et des ressources (créer/supprimer/modifier/associer des validités). Autorise également la gestion de navigabilité des ressources aéronefs et la gestion des statuts.

Permet d'accéder à [[Gestion-des-documents|la liste des documents]] qui sont associés aux ressources et leur gestion (Ajouter, modifier, supprimer). Permet aussi de gérer la liste des catégories de ces documents.

===Gestion des rapports===
Fait apparaître le menu '''[[Gestion-des-rapports|Gestion > Rapports]]''' avec les items :
* '''Gestion > Rapports > Rapports personnalisés > Champs métiers'''
* '''[[Gestion-des-rapports#Configurer-les-rapports-visibles-pour-les-utilisateurs|Gestion > Rapports > Rapports personnalisés > Créer/Modifier]]'''
* '''[[Gestion-des-rapports#Configurer-les-rapports-visibles-pour-les-utilisateurs|Gestion > Rapports > Rapports personnalisés > Visualiser]]'''
* '''Gestion > Rapports > Rapports spécifiques > Activités et coûts'''
* '''[[Gestion-des-rapports#Configurer-les-rapports-visibles-pour-les-utilisateurs|Gestion > Rapports > Bibliothèque]]'''

Fait apparaître la [[Gestion-des-rapports#Case-à-cocher-Mémoriser-ce-choix|case à cocher '''Mémoriser ce choix''']].

===Voir tous les rapports===
Fait apparaître le menu '''Rapports''' avec les items :
* '''[[Gestion-des-rapports#Configurer-les-rapports-visibles-pour-les-utilisateurs|Rapports personnalisés > Visualiser]]'''
* '''Rapports spécifiques > Vols et coûts'''

Cela permet de consulter l'intégralité des rapports, y compris les favoris.

Fait apparaître la [[Gestion-des-rapports#Case-à-cocher-Mémoriser-ce-choix|case à cocher '''Mémoriser ce choix''']].

===Gestion des logs===
Fait apparaître le menu '''Admin > Logs''' avec les items :
*'''Admin > Logs > Actions effectuées'''
*'''Admin > Logs > Adresses IP bloquées'''
*'''Admin > Logs > Historique d'une réservation'''
*'''Admin > Logs > Identifiants bloqués'''
*'''Admin > Logs > Requête utilisateur en attente'''

===Envoyer et suivre les e-mails===
Permet d'accéder à la page [[Mailing|Mailing]] et de [[Suivi-des-emails|suivre les emails]].

===Accès aux tableurs===
Permet d'accéder aux fichiers [[Tableurs|tableurs]] depuis le menu.

===Gestion des communications===
Permet de gérer les flux d'informations et leurs canaux.

=Profils Plus=
*'''Admin > Utilisateurs > Profils plus'''

==Ajouter un profil depuis Profils plus==
*Cliquer sur une cellule contenant le caractère '''+'''
*remplissez la cellule puis appuyer sur la touche "Entrée"
*pour valider cliquer sur la disquette à gauche dans la colonne "Actions"
*le nouveau profil est placé à la fin du tableau

==Modifier un profil depuis Profils plus==
*Cliquer sur une cellule du profil à modifier
*remplissez la cellule puis appuyer sur la touche "Entrée"

==Colonnes du tableau Profils Plus==
===Nom (du profil)===
Nom du profil

===Type de compte requis===
Permet de définir les comptes utilisateurs appartenant aux types sélectionnés qui seront créés pour les nouveaux utilisateurs ou ajoutés aux utilisateurs existants à qui on attribuera ce profil

===Champ métier visible par le profil sur le formulaire utilisateur ou sur le planning===
Permet d'afficher ou de cacher les [[Champs-métiers|champs métiers]] des formulaires présents dans :
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*'''Gestion > Utilisateurs > Utilisateurs > Actifs'''
*'''Planning > Planning > Réserver'''

===Type de validité que l'utilisateur peut gérer pour lui-même===
Permet de sélectionner les types de validités qu'un utilisateur de ce profil peut [[Validités#Consulter-et-gérer-ses-validités-ou-celles-d'un-tiers|ajouter/acheter/mettre/supprimer]] (ex: Licence fédérale, Visite Médicale, Autres licences) pour lui-même. Les validités d'un utilisateur sont accessibles depuis '''Planning > Données > Personnelles > Validités'''.

[[Paramétrage-des-validités#Ajouter-un-type-de-validités|Lors de l'ajout d'un type de validité, celui-ci est automatiquement affecté aux profils]].

===Types de validités que l'utilisateur peut gérer et certifier===
Permet de sélectionner les types de validités qu'un utilisateur de ce profil peut gérer et certifier.

Tous les utilisateurs détenant un profil pouvant certifier un type de validité coché recevront un [[Envoi-des-emails#E-mail-de-demande-de-certification-de-validité|e-mail]] lorsqu'une validité d'un des types choisis sera ajoutée par un utilisateur et [[Validités#Validités-en-attente-de-certification|en attente de certification]].

===Contrats non requis===
Voir la définition de [[Paramétrage-des-validités#Validité-contrat|validité-contrat]].

Permet de [[Gestion-des-profils#Modifier-un-profil-depuis-Profils-plus|définir]] les [[Paramétrage-des-validités#Validité-contrat|validités-contrats]] qui ne sont pas requises pour certains profils.

Les utilisateurs ne disposant que de profils exemptés, ne se verront pas demandés la signature des validités-contrats à la connexion. Tous les autres utilisateurs doivent signer chacun des contrats s'ils disposent d'au moins un profil non-exempté ou si la validité-contrat est requise pour tous les profils.

La signature des validités-contrats, se fait juste après l'identification à la connexion. Le formulaire apparait tant qu'il reste au moins un contrat non-signé. L'utilisateur ne peut passer outre ce processus.

===Attribution de place===
Permet d'attribuer les places auxquelles sont autorisées les utilisateurs de ce profil. Cela impacte sur les listes des utilisateurs que l'on trouve à la saisie d'une réservation ou d'un vol.

Ces listes sont accessibles depuis '''Planning > Planning > Réserver''' et '''Planning > Activités > Saisir une activités'''.

La page '''Admin > Type de ressource > Places''' permet de gérer les places d'un type de ressource. Elle permet également de définir qui a le droit d'être sur telle place en cas de restriction de profil.

===Profils visibles===
Dans les pages '''Planning > Données > Personnelles > Affichage et fiche personnelle''', '''Gestion > Utilisateurs > Actifs''' et '''Admin > Utilisateurs > Paramètres par défaut''', on peut sélectionner les utilisateurs auxquels on souhaite voir leur planning.

La liste des utilisateurs affichés sont ceux possédant un profil ayant les droits [[#Planning-personnel|Planning personnel]] et [[#Planning-individuel-visible-pour-les-autres|Planning individuel visible pour les autres]]. La colonne '''Profils visibles''' permet de restreindre la liste de ces utilisateurs pour ne la limiter qu'aux utilisateurs possédant les profils sélectionnés.

'''Attention :''' Il faut attribuer à un profil au moins une place de 1ère rang (numéro de place 0).

===Types de ressources visibles===
Dans les pages '''Planning > Données > Personnelles > Affichage et fiche personnelle''', '''Gestion > Utilisateurs > Actifs''' et '''Admin > Utilisateurs > Paramètres par défaut''', on peut sélectionner les ressources dont on souhaite voir le [[Utilisation-du-planning-de-réservation|planning]] ou les rendre disponibles dans les formulaires de saisie de réservation et d'activité.

La colonne '''Types de ressources visibles''' permet de restreindre la liste de ces ressources pour ne la limiter qu'aux ressources appartenant aux types de ressources sélectionnés.

===Comptabilités visibles===
Permet de sélectionner les comptabilités qui sont visibles pour un profil. De plus, les types de compte et les comptes n'étant pas d'une comptabilité sélectionnée ne seront pas visibles.

===Alerté par e-mail pour le renouvellement des validités de tous les utilisateurs===
Ce droit permet de suivre le renouvellement des validités par les utilisateurs en étant alerté par e-mail à chaque fois qu'un utilisateur renouvelle une validité sélectionnée dans la liste de la cellule '''Alerté par e-mail pour le renouvellement des validités de tous les utilisateurs'''. Attention : la mise en place de ce droit peut provoquer la réception de nombreux e-mails.

=Utilisation=
==[[Connexion#Choix_du_profil|Choix du profil à la connexion]]==

==Ajouter un profil==

Depuis l'interface dynamique :
*Cliquer sur l'icône de menu correspondant à la gestion des profils
*[[Tableaux#Ajout-de-ligne|Ajouter une ligne]]
*[[Tableaux#Édition-des-données|Compléter les cellules]]
*L'ajout est [[Tableaux#Enregistrement-d'une-ligne|enregistré]] si les cellules suivantes sont correctement remplies :
**'''Nom du profil''' : la cellule doit être remplie et le nom ne pas avoir déjà été utilisé comme nom de profil.

Depuis l'interface légère :
*Aller sur '''Admin > Utilisateurs > Profils'''
*En-dessous du tableau listant les profils, cliquer sur le bouton '''AJOUTER UN PROFIL'''
*Renseigner les droits pour chaque onglet
*Aller sur '''Admin > Utilisateurs > Profils plus'''
*Renseigner les colonnes pour la ligne du profil nouvellement créé

===Ajouter un profil qui surpasse la restriction en cas de solde insuffisant===
*Procéder à l'[[Tableaux#Ajout_de_ligne|ajout de ligne dans un tableau]].
*Saisir par exemple comme nom '''Non restreignable'''.
*Toujours dans '''Admin > Utilisateurs > Profils''', onglet '''Généralités''', cocher pour ce profil le droit [[Gestion des profils#Généralités|Profil non sélectionnable par l'utilisateur]].
*Dans l'onglet '''Gestion des comptes''', sélectionner le droit [[#Surpasser-la-limitation-du-solde-du-compte|Surpasser la limitation du solde du compte]] pour le profil concerné
Il suffit ensuite de rajouter ce profil aux utilisateurs concernés.

=Créer un profil empêchant tout surpassement=
Il peut être nécessaire d'empêcher un utilisateur de pouvoir réserver ou saisir une activité même en recourant à l'aide d'un tiers qui disposerait de droits permettant de surpasser des restrictions, que cela soit sur des comptes ou sur des validités.

Cela peut être le cas, par exemple, pour la détention d'une validité ''Cotisation'' périmée ou lorsque le solde du compte utilisateur est insuffisant (cf. [[Configuration-de-la-comptabilité#Restriction-d'accès-en-cas-de-solde-insuffisant|Restriction d'accès en cas de solde insuffisant]]).

Pour mettre en place une telle restriction, il faut :
*[[Gestion-des-profils#Ajouter-un-profil|Ajouter un profil]] en lui attribuant l'ensemble des droits (ne pas oublier la page '''Admin > Utilisateurs > Profils plus'''
*[[Gestion-des-profils#Modifier-un-profil|Modifier le profil]] nouvellement créé
**Si l'utilisateur ne doit pas pouvoir ouvrir un vol : dans l'onglet [[Gestion-des-profils#Activités|Activités]], décocher le droit [[Gestion-des-profils#Etre-sur-une-nouvelle-ouverture-d'activité|Etre sur une nouvelle ouverture d'activité]]
**Si l'utilisateur ne doit pas pouvoir être sur une réservation : dans l'onglet [[Gestion-des-profils#Réservation|Réservation]], décocher les droits [[Gestion-des-profils#Etre-sur-une-nouvelle-réservation|Etre sur une nouvelle réservation]], [[Gestion-des-profils#Réservation-solo|Réservation solo]] et [[Gestion-des-profils#Réservation-avec-un-instructeur|Réservation avec un instructeur]]

==Droits particuliers==
*'''GÉNÉRALITÉS / Profil non sélectionnable par l'utilisateur :''' ce droit n'est applicable que si les [[Gestion des utilisateurs|utilisateurs disposant du profil concerné]] possèdent au moins un autre [[Connexion#Sélection_du_profil|profil sélectionnable à la connexion]].
*'''GÉNÉRALITÉS ADMIN / Gestion des profils :''' au moins un profil doit posséder ce droit.

==Modifier un profil==
La modification des profils s'effectue selon les règles d'[[Utilisation des tableaux#Édition_des_données#|édition des données d'un tableau]].

==Supprimer un profil==
*La suppression d'un profil est possible uniquement si les [[Gestion des utilisateurs|utilisateurs disposant de ce profil]] possèdent aussi au moins un autre profil.
*Procéder à la[[Tableaux#Suppression_de_ligne|suppression de ligne dans un tableau]].

==Valeurs par défaut lors de la création d'un profil==
Lors de la création d'un profil, on affecte automatiquement par défaut :
* Tous les '''Profils visibles'''
* Tous les '''Types de ressources visibles'''
* Toutes les '''Comptabilités visibles'''
* Les '''Attribution de place''' correspondants à la première place de chaque type de ressource

Gestion des produits et des ventes

2024-10-02T17:27:53Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
Cette page décrit la '''gestion des produits et des ventes'''.

Pour facturer des produits, il faut que [[Configuration-de-la-comptabilité#Paramétrage-général-de-la-gestion-des-comptes|la gestion des comptes soit activée]].

Les écritures comptables générées par le moteur de facturation dépendent de la [[Gestion-des-écritures-comptables#Fusion-des-écritures-comptables|fusion des écritures]].

Pour accéder à la gestion des produits (menu '''Admin > Ventes > Produits > Produits'''), il faut de l'un des droits suivants : [[Gestion-des-profils#Gestion-globale-des-ventes|gestion globale des ventes]], [[Gestion-des-profils#Gestion-des-comptes|gestion des comptes]].

==[[Facturation-des-clients#Fonctionnement-et-nommage-des-variables-associées-aux-formules-de-facturation|Fonctionnement et nommage des variables associées aux formules de facturation]]==

=Configuration=
* Les produits non stockés sans tarif ne sont disponibles à l'achat qu'avec le droit [[Gestion-des-profils#Vente-de-produit-sans-tarif|Vente de produit sans tarif]].
*Les produits en vente libre peuvent être achetés par les utilisateurs disposant du droit [[Gestion-des-profils#Achat-ventes-libres|Achat ventes libres]] ou être vendus par les utilisateurs avec le droit [[Gestion-des-profils#Acheter-pour-les-tiers|Acheter pour les tiers]].
*Les produits qui ne sont pas en vente libre ne peuvent être vendues qu'avec le droit [[Gestion-des-profils#Acheter-pour-les-tiers|Acheter pour les tiers]].

Pour définir un produit comme étant en '''Vente libre''', il faut aller dans '''Admin > Ventes > Produits > Produits''' et cocher la marque correspondante dans la colonne '''Vente libre''' de la ligne du produit concerné.

Voir les [[Formules de calcul#Tarification|formules de tarification]].

Les paragraphes ci-dessous présentes plusieurs exemples de configuration de produit.

==Mettre en place une règle de facturation générale pour les produits==
Nous recommandons fortement de mettre en place cette règle qui simplifie grandement par la suite l'ajout de nouveaux produits à vendre. Cette règle à vocation à s'appliquer tout le temps. Ensuite, on peut rajouter des [[Facturation des clients#Cascade_d'écritures_comptables|règles en cascade]] qui viendront modifier le comportement de cette première règle de tarification en modifiant par exemple le compte produit concerné.

*'''Admin > Ventes > Facturation > Produits'''
*Cliquer sur le bouton '''AJOUTER UNE LIGNE DE FACTURATION'''
*Dans le champ '''Nom''', insérer ''Facturation générale des produits''
*Dans le champ '''Formule''', insérer ''%UNIT_PRICE_VALUE * %PRODUCT_QUANTITY''. Cette formule multiplie le tarif unitaire du produit défini dans '''Admin > Ventes > Produits > Produits''' avec la quantité commandée.
*Dans le champ '''Nom de variable associé à la formule''', insérer ''tarifGeneral''.
*Dans le champ '''Type de compte à débiter''' sélectionner ''Compte utilisateur''.
*Modifier le cas échéant, le champ '''Compte utilisateur à débiter'''.
*Dans le champ '''Type de compte à créditer''', sélectionner ''Compte Produit''.
*Dans le champ '''Compte Produit à créditer''', sélectionner ''Boutique''.
*Dans les champs '''produits internes''' et '''produits externes''', sélectionner '''tous'''.
*Cliquer sur le bouton '''Valider'''.

==Rediriger vers un autre compte produit le produit d'une vente==
Avec la [[#Mettre-en-place-une-règle-de-facturation-générale-pour-les-produits|règle de facturation générale]] déjà en place, le produit de toute vente va dans le compte de produit ''boutique''. Si on souhaite une ventilation différente, il faut rediriger le produit de la vente ainsi :

*Aller dans '''Admin > Ventes > Facturation > Produits'''.
* Cliquer sur '''AJOUTER UNE LIGNE DE FACTURATION'''
* Remplir le formulaire :
** '''Nom''' : ''produit X''
** '''Formule''' : ''@tarifGeneral''
** '''Produits internes/Produits externes''' : Cocher le ou les noms du ou des produits concernés par cette redirection.
** '''Type de compte à créditer''' : Au choix. Normalement cela doit être un compte produit.
** '''Type de compte à débiter''' : ''Compte produit''
** '''Compte à produit à débiter''' : ''Boutique''
** Valider le formulaire
Ainsi la 1ère règle générale créditera le compte produit "Boutique" et la règle ci-dessus débitera du même montant ce compte produit "Boutique" pour créditer à la place un autre compte produit au choix.

==Configuration d'un produit non-stocké avec tarif==
*Aller sur '''Admin > Ventes > Produits > Produits'''
Tout en bas du tableau, sur la dernière ligne vide, créer un produit :
*'''Nom''' : Carte
*'''Unité''' : ''Sans unité''
*Cocher '''Vente libre''' si vous souhaitez que les utilisateurs ayant le droit '''[[Gestion-des-profils#Achat-ventes-libres|Achat ventes libres]]''' puissent acheter ce produit là.
*'''Type de vente''' : ''Produit non stocké''
*'''Tarif associé''' : ''Nouveau tarif...''
*'''Historique des montants''' : laisser ''Nouveau couple...''
*'''Date d'entrée en vigueur du tarif''' : laisser la date proposée par défaut qui correspond à la date du début d'exercice comptable. En effet, chaque nouveau tarif doit avoir un prix qui couvre depuis le début de l'exercice en cours afin de ne pas avoir d'absence de tarif applicable.
*'''Montant du tarif''' : renseigner le montant applicable
*Cliquer sur le bouton '''Ajouter'''

Avec la [[#Mettre-en-place-une-règle-de-facturation-générale-pour-les-produits|règle de facturation générale]] déjà en place, le produit de la vente d'une carte ira dans le compte de produit ''boutique''. Si on souhaite une ventilation différente, il faut [[#Rediriger-vers-un-autre-compte-produit-le-produit-d'une-vente|rediriger le produit de la vente]].

==Configuration d'un produit non-stocké sans tarif défini==
Tout en bas du tableau, sur la dernière ligne vide, créer un produit :
*'''Nom''' : Carte
*'''Unité''' : ''Sans unité''
*Cocher '''Vente libre''' si vous souhaitez que les utilisateurs ayant le droit '''[[Gestion-des-profils#Achat-ventes-libres|Achat ventes libres]]''' puissent acheter ce produit là.
*'''Type de vente''' : ''Produit non stocké''
*'''Tarif associé''' : ''Aucun''
*Cliquer sur le bouton '''Ajouter'''

Avec la [[#Mettre-en-place-une-règle-de-facturation-générale-pour-les-produits|règle de facturation générale]] déjà en place, le produit de la vente d'une carte ira dans le compte de produit ''boutique''. Si on souhaite une ventilation différente, il faut [[#Rediriger-vers-un-autre-compte-produit-le-produit-d'une-vente|rediriger le produit de la vente]].

==[[Validités#Débrayer-la-vente-d'une-validité|Mettre à jour la date d'échéance d'une validité à vendre]]==

==Mise en place de la TVA dans la facturation des produits==
Si vous gérez la TVA, alors il faut rajouter une ligne pour créer les mouvements liés à la TVA. On suppose qu'il existe déjà une [[#Mettre-en-place-une-règle-de-facturation-générale-pour-les-produits|ligne de facturation générale]].
*Aller dans '''Admin > Ventes > Facturation > Produits'''.
*Cliquer sur le bouton '''AJOUTER UNE LIGNE DE FACTURATION'''
*Dans le champ '''Nom''', renseigner ''Taux TVA standard''
*Dans le champ formule, renseigner ''@standardPrice * $tvaFranceNormale / 100'' en supposant que la variable associée à la TVA se nomme ''$tvaFranceNormale''.
*Laisser le champ '''Produit''' sélectionné pour '''Tous'''.
*Dans le champ '''Type de compte à débiter''', sélectionner ''Compte utilisateur''.
*Modifier le cas échéant, le champ '''Compte utilisateur à débiter'''.
*Dans le champ '''Type de compte à créditer''', sélectionner ''Compte TVA''.
*Dans le champ '''Compte TVA à créditer''', sélectionner ''TVA collectée''.
*Cliquer sur le bouton '''Valider'''.
Remarque : dans le cas où l'on part d'un prix TTC, alors pour retrouver la TVA il faut appliquer la formule suivante :
''@standardPriceTTC * $tvaFranceNormale / (100 + $tvaFranceNormale)''

=[[Utilisation-de-la-comptabilité#Mettre-à-jour-les-tarifs|Gestion des tarifs]]=

=Utilisation=

==Achat de produit non stocké==
Depuis la page du planning, se rendre sur la page '''Planning > Comptes > Actions > Acheter'''. Pour avoir une vue des produits sans tarif, s'assurer de posséder le droit [[Gestion-des-profils#Vente-de-produit-sans-tarif|Vente de produit sans tarif]].

Pour l'achat d'un seul produit, se placer la ligne de celui-ci :
* '''Compte utilisateur''' : Champ vide par défaut et affiché si l'utilisateur à le droit [[Gestion-des-profils#Acheter-pour-les-tiers|Acheter pour les tiers]]. Entrer le début du nom, prénom ou identifiant d'un utilisateur pour voir apparaitre une liste proposant les choix possibles correspondants.
* '''Quantité''' : Saisir la valeur désirée
* '''Prix unitaire''' : Dans le cas d'un produit sans tarif, saisir la valeur désirée
* Cliquer sur l'icône qui représente un caddy avec un plus intitulée '''Ajouter au panier'''

Pour l'achat de plusieurs produits :
* '''Compte utilisateur''' : Champ vide par défaut et affiché si l'utilisateur à le droit [[Gestion-des-profils#Acheter-pour-les-tiers|Acheter pour les tiers]]. Entrer le début du nom, prénom ou identifiant d'un utilisateur pour voir apparaitre une liste proposant les choix possibles correspondants.
* Pour chacun des produits :
** '''Quantité''' : Saisir la valeur désirée
** '''Prix unitaire''' : Dans le cas d'un produit sans tarif, saisir la valeur désirée
* Cliquer sur le bouton '''Tout ajouter au panier'''

Après un achat, on est redirigé vers le panier. On peut retirer des produits du panier. On peut également en rajouter d'autres en cliquant sur le bouton '''Voir les produits en vente'''.

Avec un utilisateur gestionnaire possédant le droit [[Gestion-des-profils#Acheter-pour-les-tiers|Acheter pour les tiers]] il est possible de vendre des produits depuis la page '''Gestion > Ventes > Vendre'''.

Le droit [[Gestion-des-profils#Acheter-pour-les-tiers|Acheter pour les tiers]] n'inclut pas le droit de vendre des produits sans tarif, le droit [[Gestion-des-profils#Vente-de-produit-sans-tarif|Vente de produit sans tarif]] doit être activé activé, l'inverse est aussi vrai.

==Achat de validité==
Les utilisateurs auront le droit d'"Acheter" leur cotisation si leur profil a le droit de '''Mises à jour des dates de péremption de ses validités'''. Sinon seul les profils avec '''Mise à jour de ses validités''' pourront le faire.

[[File:Users_Profil_fr.jpg]]

Dans '''Planning > Données > Personnelles > Validités''', au premier accès, il faut acheter la validité "Cotisation" :
* En bas du tableau, sélectionner dans la liste déroulante "Cotisation". le bouton sur la gauche doit indiquer '''Acheter'''. Si le bouton est désactivé (grisé), c'est que le produit lié à la validité n'a pas l'option '''Ventes libre''' de coché.
* Cliquer sur '''Acheter'''. La validité doit apparaitre dans le tableau et la date limite de validité doit être au 31/12/2012

[[File:Donnés_validité_fr.jpg]]

Si la validité "Cotisation" existe déjà dans le tableau, il faut la renouveler (par exemple, la date actuelle est le 31/12/2011). Dans ce cas, dans la colonne Limite de validité, cliquer sur l'icône "Flèche circulaire" et la date de la validité doit passer au 31/12/2012

L'action de renouvellement/achat de validité est irréversible. Par contre, on peut [[#Annuler_l'achat_d'une_validité|annuler comptablement l'achat d'une validité et modifier la validité pour l'utilisateur concerné]].

==Annuler l'achat d'une validité==
L'achat d'une validité est irréversible pour un utilisateur : dès qu'il a choisi d'acheter une validité, cette opération est comptablement validée et l'utilisateur n'a pas la possibiltié de revenir en arrière. Cela permet de garantir que l'utilisateur ne va pas s'attribuer des privilèges liés à son achat de validité, effectuer ce qu'il souhaite et ensuite annuler cet achat.

Si un gestionnaire souhaite annuler un tel achat, il faut alors effectuer 2 opérations :
*[[Utilisation-de-la-comptabilité#Annuler-l'effet-d'une-écriture-comptable|Annuler l'effet comptable]] de la vente de la validité en saisissant un flux opposé.
*[[Validités#Débrayer-la-vente-d'une-validité|Débrayer la vente de la validité]] afin de modifier la date d'échéance pour l'utilisateur concerné.

==Annuler la vente d'un produit==
Si la vente du produit n'a pas été validée, alors il faut cliquer sur l'icône crayon correspondant à une ligne comptable de la vente du produit pour se retrouver dans le panier correspondant à cette vente. Ensuite, il faut éditer le panier soit en supprimant la ligne correspondant au produit soit vider complètement le panier.

Si la vente du produit a été validée, alors il n'est plus possible de supprimer les écritures comptables correspondantes et il faut [[#Annuler-l'effet-d'une-écriture-comptable|annuler l'effet comptable]].

==Validation d'un panier par un utilisateur==
*Pour finaliser les achats et les valider, cliquer sur le bouton '''Valider tous les achats'''.
Lors de la validation de plusieurs produits, ceux-ci sont [[Facturation-des-clients#Regrouper-les-ventes-par-client|regroupés en une seule facture]].

Cette opération peut être effectuée plus tard en modifiant une entrée comptable générée par la vente du produit concerné. Dans ce cas, les produits restent dans le panier. On doit considérer qu'ils ne sont pas réellement vendus tant qu'ils ne sont pas validés.

Cependant un gestionnaire a la possibilité de [[#Validation_des_produits_en_attente_dans_les_paniers_par_un_gestionnaire|valider massivement les produits présents dans les paniers]] et ainsi de valider à posteriori les achats. Ce mode de fonctionnement peut être utile dans un [[Bien débuter avec OpenFlyers#Workflow|workflow]] où seul un gestionnaire/responsable dispose du droit d'effectuer les achats et ne souhaitent pas valider à chaque achat pour ne pas perdre de temps mais reporter cette opération en fin de journée ou en fin de semaine par exemple.

==Validation des produits en attente dans les paniers par un gestionnaire==
*Un gestionnaire peut valider tout ou partie des produits mis dans les paniers de chaque utilisateur :
*'''Gestion > Ventes > Valider les ventes'''
*Choisir la période de ventes souhaitée dans les champs '''A partir du''' et '''Jusqu'au'''
*Choisir l'utilisateur concerné dans le champ '''Compte utilisateur''' ou laisser ''Tous'' pour faire apparaitre les ventes de tous les utilisateurs
*Cliquer sur le bouton '''Valider'''
Un tableau liste les produits mis dans des paniers et en attente de validation
*Pointer les produits à valider
*Cliquer sur le bouton '''Pointer les entrées sélectionnées (cette action est irréversible)'''

Lors de la validation, les ventes sont [[Facturation-des-clients#Regrouper-les-ventes-par-client|regroupées en une seule facture par client]].

Gestion de la comptabilité côté utilisateur

2024-10-02T17:27:53Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de présenter la '''gestion de la comptabilité côté utilisateur''' dans la [[Accueil|version 4 d'OpenFlyers]].

=Alertes générées lors de [[Utilisation de la comptabilité#Saisie_d'écritures_comptables|saisie d'écritures comptables]]=

==Les comptes n'ont pas la même comptabilité==

Cette alerte apparait lors d'une [[Comptabilité#Comptabilités_multiples|comptabilité multiple]] : Le compte débité et le compte crédité doivent être issues de la même comptabilité.

=Consulter son compte ou celui d'un tiers=
Pour consulter son propre compte :
*'''Planning > Comptes > Extrait de compte... > "le nom de son compte"''' ou depuis le raccourci présent en en-tête de chaque page (juste en dessous du menu).

Pour consulter le compte d'un tiers, il faut disposer de [[Gestion des profils#Comptes|l'un de ces droits]] : [[Gestion-des-profils#Gestion-des-comptes|'''Gestion des comptes''']], [[Gestion-des-profils#Voir-les-comptes|'''Voir les comptes''']] ou [[Gestion-des-profils#Voir-les-comptes-utilisateurs|'''Voir les comptes utilisateurs''']].
*'''Gestion > Comptes > Comptes > Utilisateurs''' et cliquer sur la loupe du compte que l'on souhaite consulter.

=Consulter une [[Écritures comptables#Facture-client|facture client]] ou un reçu d'encaissement=

Pour consulter une facture client ou un reçu d'encaissement, il faut :
*Aller sur [[#Consulter-son-compte-ou-celui-d'un-tiers|le compte concerné]]
*Cibler l'écriture recherchée
*Colonne [[#Colonne-Numéro-de-pointage,-facture-ou-reçu|'''Numéro de pointage, facture ou reçu''']], cliquer sur l'icône correspondante de la facture ou du reçu

=Créditer son compte utilisateur=
Un utilisateur, qui dispose du droit [[Gestion-des-profils#Encaisser-ses-paiements|Encaisser ses paiements]] ou du droit [[Gestion-des-profils#Saisir-les-encaissements-pour-les-tiers|Saisir les encaissements pour les tiers]], peut le créditer :
*Soit par '''Planning > Comptes > Actions > Approvisionner'''
*Soit par '''Gestion > Comptes > Encaissements > Saisir''' s'il dispose de droits de gestion
*Soit en affichant un extrait de son compte utilisateur et cliquer sur le bouton '''Approvisionner''' situé en bas à droite de l'affichage de son compte à droite de la ligne du solde de compte.
Si l'utilisateur arrive sur le formulaire de saisie d'encaissement depuis un extrait de compte utilisateur, alors le compte à créditer par défaut porte le nom de l'utilisateur du compte depuis où la personne a cliqué.
*Si l'utilisateur dispose du droit [[Gestion-des-profils#Saisir-les-encaissements-pour-les-tiers|Saisir les encaissements pour les tiers]], choisir dans le champ '''Encaissement de l'utilisateur''' le nom de l'utilisateur concerné
*Si l'utilisateur dispose de plusieurs comptes sur lesquels il peut effectuer son encaissement (défini par le droit [[Gestion-des-profils#Compte-sur-lequel-un-utilisateur-peut-agir|Compte sur lequel un utilisateur peut agir]]), choisir dans le champ '''Compte à créditer''' le nom du compte concerné
*Dans le champ '''Type de règlement''', sélectionner le type de règlement
*Si vous effectuez un paiement avec une remise à une personne physique, vous devez préciser le nom de cette personne dans le champ '''Personne qui reçoit'''
*Dans le champ, montant indiquer le montant de votre paiement.
*Cliquer sur le bouton '''Valider'''
Dans le cas où le type de paiement est un paiement par carte bancaire en ligne mis en place par votre structure, alors êtes redirigé sur le terminal de paiement électronique de la banque de votre structure. Il vous faut alors saisir les informations de votre carte bancaire. Il est possible que le terminal de paiement électronique supporte le "[[Wikipedia-fr:3-D_Secure|3-D Secure]]" qui implique un contrôle renforcé. Dans ce cas, c'est votre propre banque qui vous demandera des informations complémentaires pour confirmer que c'est bien vous qui êtes à l'origine de la demande de paiement par carte bancaire.

Une fois le paiement validé, [[Envoi-des-emails#E-mail-de-reçu|un email vous sera automatiquement envoyé par OpenFlyers avec en pièce-jointe votre reçu au format PDF]].

=Extrait de compte=
'''OpenFlyers''' offre la possibilité à un utilisateur de consulter des extraits de compte : C'est un rapport permettant de visualiser le détail des écritures comptables effectuées sur une période (une année complète ou un mois d'une année) d'un compte ou de tous les comptes d'une comptabilité donnée. Si la gestion des budgets est activée, il est possible de filtrer l'affichage des écritures selon les budgets.

L'extrait de compte est accessible :
*Depuis l'interface légère :
**Le bandeau des soldes de chaque compte sous le menu
** '''Planning > Comptes > Extrait de compte...''' puis sélectionner un compte
** '''Gestion > Comptes > Comptes > Utilisateurs''' puis cliquer sur l'icône '''Extrait de compte''' du compte
** '''Gestion > Comptes > Comptes > Ressources''' puis cliquer sur l'icône '''Extrait de compte''' du compte
** '''Gestion > Comptes > Comptes > ... ''', sélectionner une catégorie de compte puis cliquer sur l'icône '''Extrait de compte''' du compte
** '''Gestion > Comptes > Flux > Mouvements''', pour visualiser cette page il faut posséder le droit [[Gestion-des-profils#Gestion-des-comptes|Gestion des comptes]], [[Gestion-des-profils#Voir-les-comptes|Voir les comptes]] ou [[Gestion-des-profils#Saisir-tout-flux|Saisir tout flux]]
* Depuis la nouvelle interface :
** Le bandeau des soldes de chaque compte sous la barre supérieure

Dès qu'il y a plus de 50 écritures à afficher pour un extrait de compte, la liste des écritures est paginée pour afficher 50 écritures par page.

Lorsqu'une écriture est validée, les montants au débit et au crédit sont affichés en noir gras.

Lorsqu'une écriture est non validée, les montants au débit et au crédit sont affichés en vert gras. En fonction du [[Gestion des profils|profil et de ses droits]], dans la colonne '''Actions''', des icônes peuvent apparaitre pour modifier ou supprimer une écriture non validée selon [[Gestion des écritures comptables#Types_d'écritures_comptable_générées_par_OpenFlyers|le type d'écriture comptable qui est générée]].

En bas du tableau, en fonction du [[Gestion des profils|profil et des droits]] de l'utilisateur, les boutons suivants peuvent être présents :
*'''Saisir un encaissement''' : accès au formulaire de [[#Créditer-son-compte-utilisateur|saisie d'encaissement]]. Ce lien apparaît uniquement dans les extraits de comptes-utilisateurs.
*'''Saisir un flux''' : accès au formulaire de [[Utilisation-de-la-comptabilité#Saisir-un-flux|saisie d'un flux]].

==Colonne Numéro de pointage, facture ou reçu==
*Lorsque l'écriture est liée à une [[Écritures comptables#Facture-fournisseur|facture fournisseur]], la colonne affiche le numéro de pointage.
*Lorsque l'écriture est liée à une [[Écritures comptables#Facture-client|facture client]] :
**Si l'utilisateur dispose de [[Gestion des profils#Comptes|l'un de ces droits]] : [[Gestion-des-profils#Gestion-des-comptes|'''Gestion des comptes''']], [[Gestion-des-profils#Voir-les-comptes|'''Voir les comptes''']] ou [[Gestion-des-profils#Voir-les-comptes-utilisateurs|'''Voir les comptes utilisateurs''']] ou que la facture à afficher '''lui est destinée''' :
***Pour une écriture non-validée, la colonne affiche les icônes [[File:IconHTML.png]] qui amènent aux factures pro-format associées.
***Pour une écriture validée, la colonne affiche les icônes [[File:IconPDF.png]] qui amène aux factures PDF associées.
**Dans le cas contraire, ce sont les numéros des factures qui sont affichés à la place des icônes.

La colonne affiche "--" lorsqu'il s'agit d'une écriture :
* D'[[Écritures comptables#Encaissement-(d'un-client)|encaissement client]].
* De [[Écritures comptables#Les-4-grands-types-d'écritures|flux]].
* De [[Écritures comptables#Facture-client|facture client]] n'ayant pas de facture associée.

=Imprimer un extrait de compte=
*Afficher l'extrait de compte souhaité
*[[Navigateurs#Imprimer-avec-un-navigateur|Imprimer avec la commande du navigateur]]

=Transférer de l'argent=
Selon les droits accordés aux utilisateurs par la structure, il peut être possible d'effectuer un transfert d'argent depuis son compte vers le compte d'un autre utilisateur en suivant la procédure suivante :
*'''Planning > Comptes > Actions > Transférer'''
*Dans le champ '''Compte à créditer''' choisir le nom de la personne concernée
*Dans le champ '''Montant''', saisir le montant que l'on souhaite transférer
*Remplir éventuellement le champ '''Commentaires'''
*Cliquer sur le bouton '''Valider''' : '''Attention''' cette opération est irrévocable et une fois que vous aurez validé, il ne sera pas possible de supprimer le virement. Si vous souhaitez faire annuler l'opération il faudra contacter la personne recevant l'argent pour qu'elle fasse à son tour un transfert sur votre compte.

Si le message d'alerte '''Le solde du compte après opération serait inférieur au minimum autorisé (X) pour un transfert''' apparait alors cela signifie qu'une [[Configuration-de-la-comptabilité#Paramétrage-général-des-comptabilités|restriction sur les soldes]] est en place et que vous ne disposez pas d'un solde suffisant.

Gestion armoire à clés

2024-10-02T17:27:52Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de décrire le logiciel de gestion d'armoire à clés POK.

=Alertes=
==Alertes de paramétrage==
===[[Alertes-de-configuration#Une-armoire-à-clés-est-paramétrée-cependant-la-dernière-synchronisation-remonte-à-X|Une armoire à clés est paramétrée cependant la dernière synchronisation remonte à X]]===
==Alertes lors de la saisie d'une activité==
Les [[Gestion-des-activités#Alertes|alertes suivantes sont générées lors de la saisie d'une activité]].
===Alerte générée lors du contrôle sur la présence de la clé===
Un contrôle sur la présence de la clé associée à un aéronef est effectué lorsque l'utilisateur :
*Saisit une nouvelle activité, en ouverture ou fermeture
ou
*Ferme une activité qui est saisie ouverte
et que l'[[Installation-armoire-à-clés#Paramétrage-OpenFlyers|armoire à clés est paramétrée]] avec '''Vérifier la présence de la clé lors de la fermeture du vol'''

Alors, si la clé n'est pas à sa position sur l'armoire, une alerte rouge apparait indiquant : '''La clé de l'aéronef n'est pas au tableau'''.

NB : Le contrôle n'est pas effectué si on essaie de modifier un vol déjà saisi et clôturé.

=Débloquer une clé en secours manuellement=
*Couper l'alimentation électrique et débrancher la batterie de secours
*[[#Ouvrir-la-porte-avant-vitrée-en-secours|Ouvrir la porte avant vitrée en secours]]
*Agir sur le crochet verrouillant la clé à récupérer

=Interface web de secours=
L'armoire à clés fournie par OpenFlyers dispose d'une interface web accessible en intranet gérée par le mini-serveur OpenFlyers embarqué dans l'armoire à clés. Cette interface permet de contrôler l'armoire en cas de problème d'accès internet.
==Connexion à l'interface Web de secours==
*Dans le navigateur mettre l'URL du mini-serveur OpenFlyers. Cette adresse peut changer selon les configurations. Voici les 2 cas les plus courants :
**http://192.168.0.200:8000
**http://192.168.1.200:8000
*Une page permettant de libérer les clés indépendamment d'une connexion avec le serveur s'affiche :

[[File:Interface_administrateur_POK4.png|600px]]

*Saisir le mot de passe administrateur indiqué sur le bordereau de livraison

==Libérer une clé via l'interface intranet de secours==
Pour libérer une clé lors d'une coupure internet, il y a 2 solutions :
*Soit en tant qu'administrateur :
**[[#Connexion_à_l'interface_Web_de_secours|Se connecter à l'interface web de secours]]
**Sélectionner le numéro et cliquer sur le bouton '''Libérer la clé'''
*Soit en tant qu'utilisateur final :
**S'identifier sur l'interface utilisateur hors ligne
**Demander la clé à libérer
Le système vérifie alors que l'utilisateur dispose bien des droits

[[File:Interface_utilisateur_hors_ligne_POK4.png|600px]]

==Réinitialiser une alarme de défaut==
*[[#Connexion_à_l'interface_Web_de_secours|Se connecter à l'interface web de secours]]
*Cliquer sur le bouton '''RESET''' pour supprimer l'alarme de défaut

=Libérer une clé sans ouvrir une activité=
Il est possible de libérer une clé d'une ressource depuis OpenFlyers sans avoir à ouvrir une activité. Cette possibilité n'est normalement accessible qu'à des utilisateurs disposant de droits de gestion.
*Aller au menu '''Gestion > Ressources > Actives'''
*Dans la colonne '''statut''' cliquer sur le pictogramme symbolisant une clé pour la ressource concernée.

=Ouvrir la porte avant vitrée en secours=
*Ouvrir la porte arrière avec la clé
*Glisser sa main contre le panneau latéral jusqu'à toucher le crochet qui sert à verrouiller mécaniquement la porte.
*Manipuler le crochet pour ouvrir la porte

=Remettre les clés à leur bonne position=
Le paramétrage des clés dans OpenFlyers permet de choisir la position que doit avoir chaque clé. Lorsqu'une clé est mal positionnée dans l'armoire elle est entourée d'un cercle rouge et elle est déverrouillée :

[[File:Clé_rouge.JPG|center]]

De plus, la porte de l'armoire est également déverrouillée. Dans ce cas, il faut effectuer la procédure suivante :
*Ouvrir la porte
*Enlever toutes les clés qui sont détectées comme mal positionnées
*Effectuer une réinitialisation de l'armoire en débranchant l'alimentation puis en la reconnectant après 5 secondes
Si à la fin de cette nouvelle réinitialisation, il y a d'autres clés qui sont détectées comme mal positionnées, il faut répéter cette opération d'enlèvement/réinitialisation jusqu'à ce qu'il n'y ait ne plus de clé détectée comme mal positionnée. Au pire, toutes les clés seront enlevées de l'armoire.

Une fois qu'il n'y a plus de clé détectée comme mal positionnée, on doit se retrouver avec une ou plusieurs clés hors de l'armoire : ces clés seront remises à leur emplacement ultérieurement dans la procédure [[#Enregistrer_la_position_souhaitée_des_clés|d'enregistrement de la position souhaitée des clés]] après avoir effectué la procédure [[#Appariement_des_clés_aux_ressources|d’appariement des clés aux ressources]].

=Séquence d'initialisation des leds=
''La séquence d'initialisation suivante correspond au logiciel de gestion de l'armoire POK v.4.''

Lors de l'initialisation de l'armoire par le programme, une séquence de fonctionnement des leds de l'armoire est mise en place :
# La led jaune clignote : l'armoire démarre.
# La led jaune reste allumée : L'armoire a démarré et attend la connexion du programme.
# La led jaune s’éteint et la led rouge s'allume : Le programme vient de se connecter à l'armoire et se met à jour auprès d'elle.
# La led rouge reste allumée et la led jaune se rallume : Le programme fini l'initialisation
# Les leds rouge et jaune s'éteignent et la led verte s'allume : Le programme a fini l'initialisation et attend les ordres.

=Trouver l'adresse MAC du deamon=
==Trouver l'adresse MAC du deamon avec une freebox==
Prérequis :
*Il ne faut pas que le deamon soit connecté à la freebox par câble RJ45
*Il ne faut pas qu'un baud permanent soit déjà attribué à cette adresse MAC sur la freebox. En effet, si un baud est déjà attribué, la procédure suivante fera apparaitre l'adresse MAC du deamon même s'il n'est pas connecté.

Procédure :
*Afficher la [[Trucs-et-astuces#Monitoring-d'une-freebox|page de monitoring d'une freebox]]
*Repérer le paragraphe '''Réseau''' et le sous-paragraphe '''Attributions dhcp'''
*Brancher le deamon par câble RJ45 à la freebox en veillant à ce qu'il soit sous tension
*Rafraichir la [[Trucs-et-astuces#Monitoring-d'une-freebox|page de monitoring d'une freebox]]
*Comparer le paragraphe '''Réseau''' et le sous-paragraphe '''Attributions dhcp''' avec l'onglet précédent : la nouvelle ligne qui apparait correspond à l'adresse IP et à l'adresse MAC du deamon

=Vérifier les connexions réseaux de l'armoire et du mini-serveur=
*[[Trucs-et-astuces#Ouvrir-une-console|Ouvrir une console]]
*Taper la commande suivante en remplaçant :
**x par 0 ou 1 selon la configuration du réseau
**y par :
***200 pour vérifier le branchement du mini-serveur
***201 pour vérifier la branchement de l'armoire à clés
<bash>ping 192.168.x.y</bash>
Le résultat doit être sous la forme suivante :
<bash>ping 192.168.x.y (192.168.x.y) 56(84) bytes of data.
64 bytes from 192.168.x.y: icmp_req=1 ttl=64 time=0.241 ms
64 bytes from 192.168.x.y: icmp_req=2 ttl=64 time=0.143 ms
64 bytes from 192.168.x.y: icmp_req=3 ttl=64 time=0.144 ms
64 bytes from 192.168.x.y: icmp_req=4 ttl=64 time=0.145 ms</bash>
Si la réponse est "Unreachable" ou "Impossible de joindre l'hôte de destination" :
<bash>ping 192.168.x.y (192.168.x.y) 56(84) bytes of data.
From 192.168.x.y icmp_seq=1 Destination Host Unreachable</bash>
<bash>Envoi d'une requête 'Ping' 192.168.x.y avec 32 octets de données :
Réponse de 192.168.x.y : Impossible de joindre l'hôte de destination.</bash>
alors les adresses ne sont pas correctement affectées ou un câble est défectueux.

Fiche personnelle

2024-10-02T17:27:52Z

Lhenry: Text replacement - "Fichier:" to "File:"

[[File:Fiche_personnelle.png|right|thumb|200px|Fiche personnelle]]

__TOC__

=Présentation=
L'objet de cette page est de présenter la '''fiche personnelle''' dans la [[Accueil|version 4 d'OpenFlyers]].

=Accès=
Depuis le [[Planning-(interface-légère)|planning de l'interface légère]] :
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''

=Affichage du menu contextuel=
Le menu contextuel et un menu déroulant qui apparait lors du survol d'une réservation ou d'un vol ouvert. Ce menu contextuel peut apparaitre :
*soit automatiquement
*soit par un clic droit de la souris
Ce paramétrage est personnalisable pour chaque utilisateur :
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*Cocher ou décocher '''N'afficher la description des réservations qu'avec le bouton droit de la souris''' selon le comportement souhaité
*Cliquer sur le bouton '''Sauver''' tout en bas du formulaire

=Afficher les éphémérides=
Permet sur le [[Planning-(interface-légère)|planning de l'interface légère]] :
* D'afficher la boîte des éphémérides
* Faire une distinction de couleur sur les créneaux horaires liés aux éphémérides

[[File:Ephemeride_ancienne_interface.png|800px]]

Ce paramétrage est personnalisable pour chaque utilisateur :
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*Cocher ou décocher '''Afficher les éphémérides''' selon le comportement souhaité
*Cliquer sur le bouton '''Sauver''' tout en bas du formulaire

=Choisir l'unité de temps=
Chaque utilisateur peut choisir l'unité de temps qui sert à afficher les heures.
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*Choisir dans le champ '''Unité de temps''' parmi :
**heures minutes
**heures centièmes
**heures dixièmes
*Appuyer sur le bouton '''Sauver'''.

==[[Champs métiers]]==
En plus des champs habituels, des [[Champs-métiers|champs métiers]] spécifiques à la structure peuvent apparaître dans la fiche personnelle.

Ils sont affichés [[Gestion-des-profils#Généralités|si les droits sont attribués par l'administrateur]] et permettent d'activer des fonctionnalités supplémentaires, par exemple, [[Interfaçage-Aérogligli|l'interfaçage avec Aérogligli]].

=Changer sa langue=
*Aller dans '''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*Dans la colonne '''Accès et interface''', changer la '''langue'''
*Cliquer sur '''Enregistrer'''

=Changer son mot de passe=

==Alertes en changeant son mot de passe==

===Vous devez saisir l'ancien mot de passe et deux fois le nouveau===

Lors du changement du mot de passe, cette alerte s'affiche si :
*L'un des champs du formulaire n'a pas été saisi.

===Vous devez saisir deux fois le même nouveau mot de passe===

Lors du changement du mot de passe, cette alerte s'affiche si :
*L'un des champs du formulaire n'a pas été saisi et que l'ancien mot de passe n'est pas demandé.
*Le nouveau mot de passe et sa confirmation ne sont pas identiques.

==Niveau de sécurité du mot de passe==

Lors du changement du mot de passe, une barre montre le niveau de sécurité du mot de passe. Cette barre a 4 niveaux : '''faible''', '''moyen''', '''fort''' et '''excellent'''. Pour évaluer le niveau de sécurité du mot de passe nous regardons son nombre de caractères, s'il y a des lettres minuscules et majuscules, s'il y a des chiffres et s'il y a des caractères de ponctuation.

Plus précisément voici ce que requiert chaque niveau :
*Faible : le mot de passe doit avoir au moins 1 caractère
*Moyen : le mot de passe doit avoir au moins 8 caractères et doit être composé de 2 types de caractères (par exemple des lettres minuscules et des lettres majuscules)
*Fort : le mot de passe doit avoir au moins 8 caractères et doit être composé de 3 types de caractères (par exemple des lettres minuscules, des lettres majuscules et des chiffres)
*Excellent : le mot de passe doit avoir au moins 14 caractères et doit être composé de 3 types de caractères (par exemple des lettres minuscules, des lettres majuscules et des chiffres)

=Communication=
==E-mail==
Il est possible de renseigner plusieurs adresses e-mails dans ce champ en séparant chaque adresse e-mail d'une virgule.
'''Attention : il ne faut jamais mettre d'espace : ni dans l'adresse e-mail elle même, ni avant ou après les virgules de séparation des adresses e-mails'''

Exemple valide :
<pre>jesuisuntest@test.fr,jesuisuntest@test.com</pre>

Exemples non valides :
<pre>jesuisuntest@test.fr , jesuisuntest@test.com
jesuisuntest@test.fr ,jesuisuntest@test.com
jesuisuntest@test.fr, jesuisuntest@test.com</pre>

==Gérer l'abonnement à la liste de diffusion==
Lorsque une liste de diffusion mailman gérée par OpenFlyers est activée pour la plateforme OpenFlyers, l'utilisateur peut de lui-même gérer son abonnement à la liste de diffusion :
*'''Données > Affichage et fiche personnelle'''
Formulaire '''Liste de diffusion : nomdelastructure-ml@openflyers.info'''
*Cocher/décocher le bouton '''Abonné(e)'''
*Cliquer sur le bouton '''Sauver'''

=Editer sa photo=
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*L'import ou la suppression d'une photo requiert le droit [[Gestion-des-profils#Editer-sa-photo|Editer sa photo]]. Ce droit n'est pas nécessaire pour rendre sa photo visible pour tous.
*Lors de l'import, si la photo de profil a une taille supérieure à 600 pixels (de largeur ou de hauteur), elle est automatiquement redimensionner à cette taille. Son poids ne doit pas être supérieur à 100Ko.

=Mettre à jour sa date de naissance, sa nationalité ou son sexe=
Le droit [[Gestion-des-profils#Mise-à-jour-de-sa-date-de-naissance,-de-son-sexe-et-de-sa-nationalité|Mise à jour de sa date de naissance, de son sexe et de sa nationalité]] est requis pour mettre à jour sa date de naissance, sa nationalité ou son sexe.

=Notifications=
==Etre informé des actualités OpenFlyers par e-mail==
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*L'utilisateur peut cocher ou décocher cette case afin d'être prévenu ou non par e-mail des nouveautés OpenFlyers.

==Notification des réservations par e-mail==
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*L'utilisateur peut cocher ou décocher cette case afin d'être prévenu ou non par [[#E-mail_de_notification_de_réservation|e-mail des réservations créées ou modifiées]] le concernant.

==Rappel des réservations de 2 jours d'avance par e-mail==
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*L'utilisateur peut cocher ou décocher cette case afin de recevoir ou non par e-mail un rappel de réservation.

Les rappels sont envoyés entre 0h et 6h au fuseau Europe/Paris pour les réservations débutant entre 2 et 3 jours après.

Les [[Envoi-des-emails#Présentation|rappels ne sont effectifs que sur les plateformes en production]].

==Rappel des réservations de la veille ou de la journée par e-mail==
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*L'utilisateur peut cocher ou décocher cette case afin de recevoir ou non l'e-mail de rappel de la structure concernant une réservation passée (réservation de la veille ou de la journée). L'e-mail contient un message paramétré par la structure.

Les rappels sont envoyés entre 0h et 6h au fuseau Europe/Paris pour les réservations de la veille.

Les [[Envoi-des-emails#Présentation|rappels ne sont effectifs que sur les plateformes en production]].

==Notification des réservations annulées==
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*L'utilisateur peut cocher ou décocher cette case afin d'être prévenu ou non par [[#E-mail_d'annulation_de_réservation|e-mail des réservations annulées]] le concernant.

==Recevoir un e-mail pour les réservations ayant pour activité==
*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
Lorsque l'utilisateur dispose d'un profil avec le droit [[Gestion-des-profils#Alertable-par-e-mail-pour-toute-réservation|Alertable par e-mail pour toute réservation]], apparait une liste de case à cocher avec pour label '''Recevoir un e-mail pour les réservations ayant pour activité'''.
*L'utilisateur peut cocher ou décocher ces cases afin d'être prévenu ou non [[Envoi-des-emails|par e-mail]] lorsqu'une réservation avec l'une de ces [[Gestion-des-activités|activités]] est créée ou modifiée par n'importe quel utilisateur.

==Recevoir un e-mail pour chaque facture==
Cette option permet d'activer ou de désactiver l'[[Envoi-des-emails#E-mail-de-facture|envoi automatique de chaque facture]] appartenant à l'utilisateur.

L'apparition de cette option dépend de la [[Configuration#Envoyer-un-email-pour-chaque-facture|configuration de la plateforme]] dont [[Facturation-des-clients#Envoi-automatique-de-chaque-facture-client|le comportement est décrit ici]].

=Paramétrer les ressources et les utilisateurs visibles sur le planning=
Depuis la fiche personnelle, il est possible de choisir [[Aspect-du-planning-de-réservation#Généralités|quelles ressources matérielles et humaines sont visibles sur le planning]] avec le droit [[Gestion-des-profils#Personnaliser-ses-ressources-visibles|Personnaliser ses ressources visibles]].

*'''Planning > Données > Personnelles > Affichage et fiche personnelle'''
*Dans la catégorie '''Options d'affichage''' :
*Cocher ou décocher les '''Ressources visibles''' ou '''Utilisateurs visibles''' à afficher.

=Synchronisation des réservations=
==Mettre en place un planning partagé avec Google agenda==
;Présentation
L'objectif de cette procédure est de permettre la création d'un planning partagé contenant l'ensemble des réservations d'une plateforme OpenFlyers afin qu'elles soient visibles depuis un agenda Google lui-même partagé entre plusieurs personnes

;Procédure
*Créer un compte utilisateur ayant un profil disposant du droit [[Gestion-des-profils#Alertable-par-e-mail-pour-toute-réservation|Alertable par e-mail pour toute réservation]]
Depuis la fiche personnelle de l'utilisateur créé :
*Suivre la procédure [[#Synchroniser-les-réservations-dans-OpenFlyers-avec-un-agenda-Google|Synchroniser les réservations dans OpenFlyers avec un agenda Google]]
*Dans '''Recevoir un e-mail pour les réservations ayant pour activité''', cocher les activités pour lesquelles la synchronisation avec le planning partagé Google agenda doit s'effectuer
*Cliquer sur le bouton '''Enregistrer'''

==Synchroniser les réservations dans OpenFlyers avec un agenda Google==
;Présentation
L'objectif est de synchroniser ses réservations personnelles présentes sur une plateforme OpenFlyers avec un compte Google agenda

;Procédure
*'''Données > Personnelles > Affichage et fiche personnelle'''
Sous le titre '''Synchronisation des réservations''' et le sous titre '''avec Google agenda'''
*Cliquer sur le bouton '''Se connecter avec Google'''
*Si plusieurs comptes Google sont enregistrés dans le navigateur, une page s'affiche demandant avec quel compte Google il faut se synchroniser. Sélectionner le compte concerné
*Une fois le compte Google sélectionné, le nom du compte en question s'affiche en dessous du sous titre '''avec Google agenda'''
Lorsque l'utilisateur a lié son compte Google agenda, une liste d'agendas apparaît lui permettant de choisir dans quel agenda les événements doivent être créés.
*'''Données > Personnelles > Affichage et fiche personnelle'''
Sous le titre '''Synchronisation des réservations''' et le sous titre '''Calendrier'''
*Choisir un des agendas de la liste
*Cliquer sur '''Enregistrer'''

FAQ armoire à clés

2024-10-02T17:27:52Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__
=Changement de fournisseur d'accès impliquant un changement de routeur=
Dans le cas d'un changement de routeur entrainant un changement de la structure du réseau (par exemple réseau en 192.168.0.x devenant 192.168.1.x), afin d'éviter d'avoir à reconfigurer tout le réseau et en particulier l'armoire à clés, le plus simple est de modifier la structure par défaut du réseau mis en place par le nouveau routeur afin de conserver l'ancienne structuration (par exemple 192.168.0.x).

Dans le cas où il n'est pas possible de modifier la structuration du réseau dans le paramétrage du routeur et qu'il est nécessaire de modifier les adresses IP internes à l'armoire à clés, il faut contacter OpenFlyers pour une prise de rendez-vous afin de permettre une intervention à distance pour effectuer ces modifications.

=Check-list Armoire à clé INOP=
En cas de dysfonctionnement de l'armoire effectuer les vérification suivantes:
#Vérifier les branchements des câbles RJ45 coté routeur
#Couper son alimentation (retrait de la prise ou disjoncteur).
#Ouvrir la porte de service
#Vérifier les branchements des câbles RJ45 coté armoire
#Déconnecter la batterie de sauvegarde. Troisième connecteur vert en bas de la carte électronique Deister en partant de la gauche (2 pins) [[File:Connecteur_Batterie.JPG]]
#Après 15 secondes d'attente reconnecter l'alimentation électrique (pas la batterie de secours)
#Observer la présence de la diode orange clignotante sur la façade avant du tableau de clés
#Observer les diodes sur la carte électronique du daemon Openflyers, porte arrière ouverte
#Une diode rouge doit immédiatement s'allumer suivi du clignotement des diodes oranges. Voir signification des [http://www.framboise314.fr/les-leds-du-raspberry-pi/ diodes du Raspberry Pi]
#La diode Orange de façade doit devenir fixe
#Après 2 à 3 minutes la diode de façade orange doit s’éteindre et la diode vertes doit s'allumer fixe
#Vérifier vos [[Installation armoire à clés#Paramétrage OpenFlyers|paramètres dans OpenFlyers]]
#:Si la séquence d'allumage des diodes décrite ci-dessus n'est pas conforme, contacter OpenFlyers en décrivant les points défaillants
#:Si la séquence d'allumage des diodes est opérationnelle poursuivre les investigations ci-après
#Vérifier s'il est possible de contrôler l'armoire à clés avec l'interface web de secours qui ne nécessite pas de connexion internet mais juste que le réseau local fonctionne. Voir le chapitre [[Gestion-armoire-à-clés#Interface-web-de-secours|Interface-web-de-secours]].

=Access denied=
Ce message peut apparaitre lorsque le contrôle d'accès est partiellement désactivé :
*Aller dans '''Admin > Structure > Contrôle d'accès'''
Vérifier que :
*'''Contrôle d'accès''' est activé
*'''Gestion armoire à clés''' est activé
Si ce n'est pas le cas, activer les 2 paramètres

=Connection is denied=
Lors de la demande d'ouverture d'une porte ou de libération d'une clé depuis l'interface OpenFlyers, un popup apparait au bout de quelques secondes avec le message '''Connection is denied'''.

Ce message indique que le mini-serveur OpenFlyers présent dans l'armoire n'arrive pas à établir la connexion avec le serveur OpenFlyers hébergeant la plateforme de la structure.

Vérifier que la connexion internet est valide (ce qui est normalement le cas, si on arrive à afficher le contenu de la plateforme OpenFlyers sur un ordinateur du même réseau.

Si l'armoire et le mini-serveur sont en IP statique, vérifier que l'adresse IP du routeur est identique à celle communiquée à OpenFlyers lors de la mise en place du paramétrage.

A défaut, contacter l'équipe OpenFlyers pour vérification de la configuration du mini-serveur et de la plateforme OpenFlyers de la structure.

=Connection Issue with Raspberry Server=

Lors de la demande d'ouverture d'une porte ou de libération d'une clé depuis l'interface OpenFlyers, un popup apparaît au bout de quelques secondes avec le message '''Connection issue with Raspberry server'''.

Ce message indique qu'une erreur retournée par le mini-serveur ou à une réponse inattendue.

=Impossible de dialoguer avec l'armoire depuis un nouveau PC=
Le problème doit venir du fait que le nouveau PC utilise le protocole HTTPS au lieu du protocole HTTP qui est le seul supporté pour se connecter à l'armoire à clés pour les armoires dont le firmware n'a pas été mis à jour.

Il faut [[Installation-armoire-à-clés#Navigateur|configurer les navigateurs pour qu'ils acceptent le mix HTTP/HTTPS]].

=Latence entre la demande d'ouverture de la porte et l'ouverture effective=
S'il y a un délai de plusieurs secondes (5, 10, ou 20 secondes) entre le moment où un utilisateur demande à récupérer une clé le le moment où la porte de l'armoire s'ouvre effectivement, alors il faut fortement soupçonner un problème de configuration des DNS.

=Le voyant jaune reste allumé=
* Débrancher/rebrancher l'armoire
Le voyant devrait ensuite clignoter pendant moins d'une minute, puis rester fixe et s'éteindre pour que le voyant rouge s'allume.

Si le problème persiste :
* Pinger le programme
** Si le programme ne répond pas au ping, alors le problème est du côté du daemon
** Si le programme répond, poursuivre
* Pinger l'armoire
** Si l'armoire ne répond pas au ping, alors le problème est du côté de l'armoire
** Si l'armoire répond, poursuivre
A ce niveau là, on peut suspecter un problème de liaison entre le daemon et l'armoire.
* Contacter OpenFlyers pour lancer une investigation.

=Le voyant rouge reste allumé=
* Débrancher/rebrancher l'armoire
Le voyant devrait ensuite clignoter pendant moins d'une minute, puis rester fixe et s'éteindre pour que le voyant rouge s'allume.

Après une courte période le voyant jaune devrait s'allumer lui aussi.

Si le problème persiste :
* Pinger le programme
** Si le programme ne répond pas au ping, alors le problème est du côté du daemon
** Si le programme répond, poursuivre
* Pinger l'armoire
** Si l'armoire ne répond pas au ping, alors le problème est du côté de l'armoire
** Si l'armoire répond, poursuivre
A ce niveau là, on peut suspecter un problème de liaison entre le daemon et l'armoire.
* Contacter OpenFlyers pour lancer une investigation.

=Les voyants jaune et rouge restent allumés=
* Débrancher/rebrancher l'armoire
Le voyant devrait ensuite clignoter pendant moins d'une minute, puis rester fixe et s'éteindre pour que le voyant rouge s'allume.

Après une courte période le voyant jaune devrait s'allumer lui aussi.

Après cela les deux voyants devraient s'éteindre pour que le voyant vert s'allume.

Si le problème persiste :
* Pinger le programme
** Si le programme ne répond pas au ping, alors le problème est du côté du daemon
** Si le programme répond, poursuivre
* Pinger l'armoire
** Si l'armoire ne répond pas au ping, alors le problème est du côté de l'armoire
** Si l'armoire répond, poursuivre
A ce niveau là, on peut suspecter un problème de liaison entre le daemon et l'armoire.
* Contacter OpenFlyers pour lancer une investigation.

=Modifier le mot de passe de communication interne à OpenFlyers=
OpenFlyers utilise une pass-phrase pour contrôler l'origine des commandes de type "push" de l'armoire à clés. Ce mot de passe ne doit pas être modifié dans l'interface OpenFlyers sinon le dialogue entre l'armoire à clés et la plateforme OpenFlyers ne sera plus possible.

Ergonomie

2024-10-02T17:27:51Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter l''''ergonomie''' de la [[Accueil|version 4 d'OpenFlyers]].

=Éléments communs aux deux interfaces=

==Comptes==
Les '''comptes''' sont situées à droite sous le menu principal.

Un compte s'affiche :
*Sur fond '''rouge''' lorsqu'il est déficitaire.
*Sur fond '''vert''' lorsqu'il est bénéficiaire.

[[File:comptes-utilisateurs.png]]

==Fuseau horaire==
Il s'affiche au survol de l'[[#Utilisateur-connecté|utilisateur connecté]].

[[File:fuseau-horaire.png]]

==Utilisateur connecté==
Située sous le menu de navigation à droite, la zone de l'utilisateur connecté comprend :
*Un pictogramme par défaut ou la photo de l'utilisateur si celui-ci l'a [[Fiche-personnelle#Editer-sa-photo|importée dans sa fiche personnelle]].
*Le nom de famille, le prénom ainsi que l'identifiant.

[[File:utilisateur-connecte-default.png]]
[[File:utilisateur-connecte-photo.png]]

==Pied de page==
Il affiche :
*l'email de la structure lorsque celui-ci est saisi dans les [[Configuration#Adresse-de-la-structure|paramètres de la structure]].

[[File:footer-structure-email.png]]

=Interface dynamique=
Ce paragraphe présente les interactions de l'utilisateurs spécifiques à la '''interface dynamique'''.

==Gestes==
Ce paragraphe présente les '''gestes''' permettant de manipuler OpenFlyers 4.

===Balayage===
Le '''balayage''' existe uniquement sur écran tactile. Il consiste à effleurer rapidement l'écran selon l'axe horizontal ou l'axe vertical.

Utilisation :
*Sur le menu de navigation ouvert : affiche la page à la gauche ou à la droite de la page actuelle selon le sens du balayage.

Vidéo : https://www.youtube.com/watch?v=qNACMM6vv7s#t=0m32s

===Clic court===
Le '''clic court''' consiste à presser brièvement le bouton gauche de la souris ou à appuyer avec un doigt brièvement sur l'écran tactile.

Utilisation :
Le clic court étant le clic standard, seules sont détaillées ici les utilisations notables dans d'OpenFlyers 4.
*Sur une réservation existante : édition de la réservation

Vidéo : https://www.youtube.com/watch?v=tzM6hyOIpnc&t=1m06s

===Clic long===
Le '''clic long''' consiste à presser le bouton gauche de la souris ou à appuyer avec un doigt 0,3 secondes sur l'écran tactile.

Utilisation :
*Sur un créneau des lignes du planning : crée une réservation.

Vidéo : https://www.youtube.com/watch?v=tzM6hyOIpnc&t=2m18s

===Glisser-déposer===
Le '''glisser-déposer''' consiste avec une souris à presser le bouton gauche de la souris sur un élément déplaçable, effectuer un déplacement avec la souris, et enfin relâcher le bouton gauche lorsque le déplacement est terminé.

Le '''glisser-déposer''' consiste avec un écran tactile à maintenir le doigt appuyé sur un élément déplaçable, effectuer un déplacement, et enfin enlever son doigt de l'écran lorsque le déplacement est terminé.

Utilisation :
*Sur un pictogramme du menu : déplace le pictogramme.
*Au milieu d'une réservation auparavant éditée avec un [[#Clic_court|clic court]] : déplace la réservation.
*Sur une zone de redimensionnement d'une réservation auparavant éditée avec un [[#Clic_court|clic court]] : redimensionne la réservation.
*Sur le bouton de déplacement d'une ligne de tableau : modifie la position de la ligne.

Vidéo : https://www.youtube.com/watch?v=YylSewaTm4c&t=3m45s

=Interface légère=
Ce paragraphe présente les interactions de l'utilisateurs spécifiques à l'''interface légère'''.

==Navigation par onglet==
Afin d'avoir à disposition les différentes pages dont vous avez besoin pour effectuer une action, il est possible d'afficher chacune d'entre elles dans un [[Wikipedia-fr:Onglet_%28informatique%29|onglet]] du navigateur.
Lorsque vous effectuez un clic gauche sur un lien situé dans une page donnée pour accéder à une autre page, la page initiale est remplacée par la page de destination. Ce qui rend fastidieux la réalisation des tâches nécessitant un accès répétitif à certaines pages.

==Clic droit et clic molette==
[https://www.youtube.com/watch?v=kUvWhUXyC5Q&ab_channel=OpenFlyers Vidéo tutorielle présentant l'ouverture dans un nouvel onglet]

Afin de gagner en efficacité et en confort d'utilisation, pensez à utiliser les autres boutons de la souris qui vous permettent d'ouvrir une page dans un '''nouvel onglet'''. Pour cela il existe deux méthodes lorsqu'on survole un lien dans un navigateur Internet pour ouvrir la page de destination dans un nouvel onglet :
*'''Le clic droit :''' il permet d'afficher un menu contextuel qui contient une action nommée « Ouvrir le lien dans un nouveau onglet ».
*'''Le clic molette :''' il est encore plus efficace que le clic droit, car il correspond directement à l'action « Ouvrir le lien dans un nouveau onglet ».

Normalement le clic molette est configuré pour cette action. Dans le cas contraire, il faut [[Trucs et astuces#Modifier_le_comportement_la_souris|en modifier le comportement]].

[[File:OF3.5-clics-1.png]]

L'exemple suivant explique comment modifier successivement les validités de plusieurs utilisateurs :
*Dans un premier onglet, ouvrir le tableau présentant la liste des utilisateurs.
[[File:OF3.5-clics-2.png]]
*Effectuer un '''clic droit''' ou '''clic molette''' sur le pictogramme des validités pour déplier un second onglet.
[[File:OF3.5-clics-3.png]]
*Effectuer et enregistrer les modifications dans le second onglet, présentant les validités d'un utilisateur.
[[File:OF3.5-clics-4.jpg]]
*Replier le second onglet en cliquant sur la croix ou en pressant '''CTRL + W'''.
[[File:OF3.5-clics-5.png]]
*Retour au premier onglet, présentant la liste des utilisateurs. Répéter les opérations du 2 au 4 pour les autres utilisateurs concernés.

Il est possible de naviguer rapidement d'un onglet à l'autre sans utiliser la souris en utilisant simplement les raccourcis clavier : '''CTRL + TAB''' pour avancer d'un onglet ou '''CTRL + SHIFT + TAB''' pour reculer d'un onglet.

[[File:OF3.5-clics-6.png]]

Documents

2024-10-02T17:27:51Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter les fonctionnalités utilisateurs permettant d'accéder aux documents stockés sur une plateforme OpenFlyers.

Les gestionnaires peuvent consulter la page de [[gestion des documents]].

=Utilisation=
L'utilisateur peut accéder aux documents rattachés à chaque ressource depuis le planning (interface légère). Il faut survoler la ressource avec la souris et choisir parmi les documents disponibles en cliquant sur le document souhaité.
[[File:doc-planning.png|400px|center]]

Créer une plateforme OpenFlyers pour sa structure

2024-10-02T17:27:50Z

Lhenry: Text replacement - "Fichier:" to "File:"

Le processus de création de plateforme est complètement automatisé.

Il en est de même pour la prise d'abonnement, sauf dans le cas d'un paiement pas chèque ou par virement qui nécessitent un traitement manuel. Aussi, il est nécessaire d'informer la SARL OpenFlyers par email lors d'un virement afin qu'il soit pris en compte.

__TOC__

=Création de [[Compte-client-OpenFlyers-et-modèle-commercial|compte client]] et de plateforme=
Cette procédure est gratuite et vous pouvez rester en [[Compte-client-OpenFlyers-et-modèle-commercial#Plateforme-en-test|test]] aussi longtemps que vous le souhaitez.

La création d'une plateforme OpenFlyers se fait depuis le site vitrine [https://openflyers.com/ openflyers.com].

Il faut ensuite cliquer en haut à droite sur le bouton '''s'inscrire'''.

La page de création de compte doit alors apparaitre :

[[File:création_de_compte_français.png|center|thumb|Formulaire de création de compte et de plateforme|upright=3]]

Si certains champs sont invalides, différents messages d'alertes sont affichées (voir plus bas).

Lors de la création de votre plateforme, une recopie de la plateforme de démonstration est effectuée vers la nouvelle plateforme créée et également, vers une [[#Plateforme-supplémentaire-de-test|seconde plateforme de test]]. Si dans le champ '''Activité principale''', a été sélectionné '''Propriétaire(s) privé(s) d'aéronef''' alors une recopie de la plateforme de démonstration pour abonnement '''SOLO''' est effectuée.

Une fois que le formulaire est renseigné, la page suivante s'affiche :

[[File:e-mail_confirmation_flouté.png|center|thumb|message d'envoi d'e-mail|upright=3]]

Elle invite à consulter la boite de messagerie associée à l'adresse e-mail qui a été communiquée pour confirmer la création de votre compte.

''Messages d'alertes possibles au dessus du formulaire si des champs sont manquants ou invalides :''
*Lorsqu'un des champs est vide le message '''Champ vide : ''[champ]'' ''' apparaît
*Lorsque le champ '''Nom de la structure''' est invalide : '''Ce nom de structure contient un ou plusieurs mots interdits'''
*Lorsque le champ '''Nom de domaine de la plateforme''' contient des caractères interdits : '''Le nom de domaine doit seulement comporter des lettres en minuscule et/ou des chiffres/tirets et ne commencer que par une lettre'''
*Lorsque le champ '''Nom de domaine de la plateforme''' est déjà utilisé : '''Ce domaine est déjà utilisé ou plusieurs mots-clés interdits'''
*Lorsque le champ '''Email''' ne contient pas une bonne adresse : '''Email invalide'''

=E-mail de demande de confirmation de création de plateforme=
Le message envoyé a pour objet "plateforme de test OpenFlyers", et se présente comme suit :

<pre>Bonjour,

Ceci est un e-mail généré automatiquement par nos serveurs.

Nous avons le plaisir de vous confirmer la création de compte client sur http://client.openflyers.com/.

Veuillez trouver ci-dessous les identifiants vous permettant de vous y connecter :
Identifiant : demo-fr
Mot de passe : XXXXXX

Merci de confirmer la création de votre plateforme openflyers.com/demo-fr, en cliquant sur ce lien :
https://client.openflyers.com/confirmSubscription.php?ofName=demo-fr&ofRelease=3&key=15a151bf1561e

Pour tout question, n'hésitez pas à contacter notre service commercial qui est à votre disposition du lundi au vendredi de 9h à 12h et de 13h à 17h : 05.35.54.58.18 ou bien selon l'un des moyens proposés ici :
https://openflyers.com/support</pre>

Cliquer sur le lien contenu dans cet e-mail pour activer la création.

L'écran suivant s'ouvre et confirme que la plateforme est en cours de création :

[[File:Création_de_compte_en_cours_français.png|center|thumb|Ecran de confirmation de plateforme|upright=3]]

Un second e-mail est envoyé avec pour objet "plateforme de test OpenFlyers" qui confirme la création de la plateforme :

<pre>Votre plateforme a été créée et est accessible à cette adresse :
http://openflyers.com/demo-fr/

Veuillez attendre 5 minutes avant d'accéder à votre plateforme, le temps que l'installation soit totalement terminée.

Votre plateforme est la recopie d'une plateforme de démonstration. Par défaut les identifiants sont :
Identifiant : admini
Mot de passe : azerty

Vous trouverez de plus amples explications sur cette plateforme de démonstration à cette adresse :
https://openflyers.com/fr/doc/of4/Découvrir-OpenFlyers

Attention : votre plateforme est en phase de test et par conséquent les réservations et les factures sont susceptibles d'être effacées à tout moment.

N'hésitez pas à contacter notre service commercial qui se fera un plaisir de vous assister et de répondre à vos questions du lundi au vendredi de 9h à 12h et de 13h à 17h : 05.35.54.58.18

Si vous souhaitez passer en production et ainsi utiliser notre solution avec des réservations et des factures réelles, souscrivez à l'un des abonnements proposés en vous connectant sur notre espace client :
https://client.openflyers.com

Vous trouverez de plus amples explications à cette adresse :
https://openflyers.com/fr/doc/of4/Créer-une-plateforme-OpenFlyers-pour-sa-structure#Prise-d'abonnement

Vous pouvez aussi nous contacter selon l'un des moyens proposés à cette adresse :
https://openflyers.com/support

L'équipe OpenFlyers</pre>

=Prise d'abonnement=
Pour passer en production et ainsi lancer le paramétrage (hors abonnement Solo) de la plateforme par l'équipe OpenFlyers, il faut [[Compte-client-OpenFlyers-et-modèle-commercial#Renouveler-l'abonnement-OpenFlyers|lancer la facturation]] depuis l'espace client OpenFlyers : https://client.openflyers.com

Cf. [[Compte-client-OpenFlyers-et-modèle-commercial#Accéder-à-l'espace-client-OpenFlyers|Accéder à l'espace client OpenFlyers]].

'''Attention :''' le [[Bien-débuter-avec-OpenFlyers#Forfait-paramétrage|forfait paramétrage]] est obligatoire dans la 1ère prise d'abonnement. Il est d'ailleurs inclus dans les abonnements Business et Business+.

A noter également que le passage en production impacte la base de données lors de la mise en œuvre du paramétrage par OpenFlyers : toutes les données déjà saisies sont susceptibles d'être écrasées pour repartir sur une base de données vierge.

Si les données de la plateforme de test doivent être conservées, alors il faut créer une nouvelle plateforme et passer en production sur cette dernière.

=[[Formations OpenFlyers|Formations OpenFlyers]]=

=[[Compte-client-OpenFlyers-et-modèle-commercial#Plateforme-supplémentaire-de-test-(bac-à-sable)|Plateforme supplémentaire de test (bac à sable)]]=

Conseils spécifiques pour la comptabilité

2024-10-02T17:27:50Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de présenter nos conseils sur la [[Comptabilité|comptabilité]]

Les associations à but non lucratif sont tenues de tenir une comptabilité conformément au [https://www.anc.gouv.fr/files/live/sites/anc/files/contributed/ANC/1_Normes_fran%c3%a7aises/Reglements/2018/Reglt_2018_06/Reglt_2018_06_Asso_version_commentaires-fev-2021.pdf RÈGLEMENT N° 2018-06 du 5 décembre 2018 Relatif aux comptes annuels des personnes morales de droit privé à but non lucratif Version intégrant l’article 1er du règlement ANC n° 2019-04 et le règlement ANC n° 2020-08].

=Baptêmes dans un aéro-club=
Dans un aéro-club, les baptêmes ne doivent pas dépasser pas 8% de l'activité (cf. [http://www.legifrance.gouv.fr/affichCodeArticle.do;?cidTexte=LEGITEXT000006074234&idArticle=LEGIARTI000006844019&dateTexte=20140707&categorieLien=id#LEGIARTI000006844019 Article D510-7 du code de l'aviation civile]). Aussi, nous déconseillons de mettre en place les tarifs des baptêmes qui engendrent plus d'erreurs de saisies qu'autre chose. Par contre, dans le cas d'une société commerciale et notamment si la saisie des vols est entre les mains d'un nombre réduit de personnes, alors la facturation des baptêmes peut être mise en place. Voici donc comment nous conseillons de gérer les baptêmes dans OpenFlyers pour un aéro-club.

==[[Configuration de la comptabilité#Gestion_des_baptêmes|Paramétrage préconisé pour gérer les baptêmes de l'air d'un aéro-club]]==

==[[Utilisation de la comptabilité#Gestion_des_baptêmes|Utilisation pratique du paramétrage préconisé des baptêmes de l'air d'un aéro-club]]==

==Bons baptêmes payés et non effectués==
Quelque soit le statut commercial de la structure aéronautique (association ou société), voici comment nous conseillons de gérer les bons baptêmes :
*Enregistrer dans OpenFlyers uniquement l'encaissement du bon sans saisir de vente (et donc ne pas créer de produit pour cela)
*Lorsque le baptême est effectué, saisir le vol : cela génère la facture selon le paramétrage
Lors de la clôture de l'exercice, il suffit de contrôler le compte "client baptême" et de le comparer avec les dates de remise des bons baptêmes. C'est alors que doit être décidé si un bon ne sera jamais utilisé. Auquel cas, une écriture spécifique est à prévoir comptablement.

==Contrôle du quota d'heures baptêmes==
Pour vérifier que l'activité baptême de l'aéro-club ne dépasse pas les 8% des heures de vols, il faut utiliser les rapports pour contrôler le pourcentage d'heures de vols baptêmes par rapport au total des heures de vols.

=Cautions=
Le principe de la caution est de demander, lors de l'inscription en général, un montant de X € à l'utilisateur qui est mis en réserve et remboursé lorsqu'il quitte la structure.

Cette somme doit être encaissée normalement sur son compte utilisateur.

Par contre, elle doit également générer une "facture" qui va débiter son compte utilisateur du montant de la caution et créditer un [[Comptabilité#Comptes_d'emprunts_et_de_dettes_assimilées|compte d'emprunts de dettes assimilées]] pour "stocker" la caution. Ce compte de caution est en général en 165000.

Il est possible de mettre en place la vente d'un produit "Caution" qui génère automatiquement l'écriture entre le compte utilisateur et le compte de caution.

=Comptes à terme, Livret A=
Il faut créer autant de compte comptable qu'il y a de comptes bancaires. L'extrait de chaque compte en comptabilité doit être le reflet exact du relevé de compte fourni par la banque.

Les intérêts générés par chaque compte doivent faire l'objet d'une écriture comptable séparée.

Les comptes bancaires doivent avoir pour racine 512 dans le plan comptable à la française.

=Cotisation des adhérents dans une association=
Le produit de la cotisation des adhérents à l'association doivent aller au crédit du compte de produit 756100 ''Cotisation sans contrepartie'' ou 756200 ''Cotisation avec contrepartie''.

Est considérée comme une cotisation sans contrepartie si la cotisation donne juste le droit de participer à l'assemblée générale de l'association.

Cf. Art. 142-1 du [https://www.anc.gouv.fr/files/live/sites/anc/files/contributed/ANC/1_Normes_fran%c3%a7aises/Reglements/2018/Reglt_2018_06/Reglt_2018_06_Asso_version_commentaires-fev-2021.pdf RÈGLEMENT N° 2018-06 du 5 décembre 2018 Relatif aux comptes annuels des personnes morales de droit privé à but non lucratif]

=Cotisations fédérales des adhérents dans une association=
La gestion des cotisations fédérales des adhérents dans OpenFlyers dépend de plusieurs facteurs.
*Si les cotisations fédérales sont souscrites par les adhérents directement auprès des fédérations concernées et qu'il n'y a pas de mouvement financier au travers de l'association, alors il n'y a pas à mettre en place comptablement de gestion. Par contre, il peut être nécessaire de [[Paramétrage des validités|gérer les types de validités]] correspondantes dans OpenFlyers notamment lorsque les cotisations fédérales inclues des assurances pour la pratique de l'activité. Dans ce cas là, il faut également voir avec l'équipe OpenFlyers s'il n'existe pas un système automatique de mise à jour dans OpenFlyers depuis le système de gestion des fédérations concernées.
*Si les cotisations fédérales sont souscrites par les adhérents auprès de l'association et que par conséquent l'association leur facture comptablement ces cotisations, alors il faut mettre en place dans OpenFlyers la [[Gestion des produits et des ventes#Configuration_du_produit_Validité|vente de produits validités]] correspondante.
*:Dans ce cas là, il y a également la question de la gestion des "factures fournisseurs" des fédérations. 2 cas possibles :
*#Si OpenFlyers n'est utilisé que pour gérer la "facturation client", c'est à dire le chiffre d'affaire, alors la saisie des factures fédérales doit se faire dans le logiciel de gestion comptable.
*#Si OpenFlyers est utilisé pour gérer l'intégralité de la comptabilité courante de la structure, alors il faudra [[Gestion des achats#Saisie_d'une_facture_fournisseur|saisir les factures des fédérations en tant que facture fournisseur]]. Comptablement les choses sont hermétiques entre :
*#*d'un côté, la vente d'une cotisation d'une fédération à un adhérent qui va impacter son [[Comptabilité#Comptes_clients|compte client]] et un [[Comptabilité#Comptes_de_produits|compte produit]].
*#*de l'autre côté, l'achat de la même cotisation auprès de la fédération pour cet adhérent qui va impacter le [[Comptabilité#Comptes_fournisseurs|compte fournisseur]] de la fédération et un [[Comptabilité#Comptes_de_charges|compte de charge]].
*:A noter que pour ce qui concerne la saisie de la facture fournisseur de la fédération, il y a 2 méthodes expliquées dans le chapitre [[Écritures-comptables#Achat-direct|achat direct]].
Dans certaines structures, la prise de cotisation après une certaine date dans l'année, permet de bénéficier de la cotisation jusqu'au 31 décembre de l'année suivante. Cela se gère au travers de la formule de calcul de la date d'expiration dans '''Ventes > Validités à vendre'''. Cf. [[Formules-de-calcul#Exemples-de-formules-de-calcul-de-la-date-d'expiration|les exemples de formules de calcul de la date d'expiration]].

=Cotisations/abonnements année N+1=
Certaines cotisations ou abonnements peuvent être facturées sur l'année précédente de leur date d'effet. Comptablement, ces factures clients doivent apparaitre sur l'exercice où elles ont été établies. Cependant, il est souvent nécessaire de séparer leur produit des cotisations ou abonnements de l'année N afin de pouvoir les sortir du chiffre d'affaire de l'année N.

Voici comment gérer cela dans OpenFlyers :
*Nous supposons qu'il existe déjà un compte produit ''Cotisation'' dont le compte d'export est par exemple ''706100''.
*Il faut créer un 2ème compte produit intitulé ''Cotisation N+1'' dont le compte d'export sera par exemple ''706110''.
*Dans '''Ventes > Facturation des produits''', il faut créer une nouvelle ligne de facturation qui va transférer le crédit au profit du compte produit "Cotisation" vers le comptes produit "Cotisation N+1". De plus, ce transfert ne devra s'applique que lorsqu'on est dans la période de renouvellement anticipé. Voici un exemple de règle de facturation lorsque la cotisation peut être pris de façon anticipée à partir du mois d'octobre :
{| class="wikitable"
!Champ!!Ligne Cotisation N+1
|-
|'''Nom'''||Cotisation N+1
|-
|'''Quantité/Taux'''||
|-
|'''Prix unitaire hors-taxe / TVA'''||
|-
|'''Formule'''||(formatDate('MM',%NOW_DATE)>9)?@tarifGeneral:0
|-
|'''Nom de variable associé à la formule'''||tarifGeneral
|-
|'''Produit'''||''Cocher uniquement les produits concernés. Normalement, il s'agit de la même liste de produit que pour la règle "parente" Cotisation.
|-
|'''Type de compte à débiter'''||Compte produit
|-
|'''Compte à débiter'''||Cotisation
|-
|'''Type de compte à créditer'''||Compte produit
|-
|'''Compte produit à créditer'''||Cotisation N+1
|}

Si la structure applique une remise sur cotisation sur certains critères, comme par exemple l'âge, il faut que la règle appliquant la remise s'applique avant la règle ci-dessus de ventilation. De plus, il faut que la règle de remise stocke son calcul dans une [[Facturation des clients#Facturation-des-clients#Fonctionnement-des-variables-associées-aux-formules-de-facturation|variable associée à la formule]] comme par exemple @remise pour que la remise soit prise en compte pour la ventilation N+1. Voici un exemple de construction de ces règles en cascade :
[[File:Tarification_cotisation_N+1.png]]

*En fin d'année, avant la clôture de la comptabilité, il faudra effectuer une [[Écritures comptables#Écritures_de_transfert_des_produits_et_charges_constatées_d'avance|opération comptable pour transférer le solde du compte produit N+1 dans un compte de ''produit constaté d’avance'']]
*Puis, après l'ouverture de la comptabilité, il faudra [[Écritures comptables#Écritures_de_réaffectation_des_produits/charges_constatées_d'avances|transférer le même montant du compte ''produit constaté d’avance'' vers le compte produit de l'année N]].

=Dons=
Ce chapitre décrit les opérations comptables pour un don de la structure en faveur d'un tiers. Pour les dons reçus par la structure, il faut voir le chapitre [[#Subventions|Subventions]].

Enregistrement d'un don effectué par la structure en faveur d'un tiers :
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Tiers percevant le don (401...)||||1000 €
|-
|Divers (pourboires, dons courants...) (6238)||1000 €||
|}

Le compte de charge ''Divers (pourboires, dons courants...) (6238)'' peut être remplacé par le compte de charge exceptionnelle ''Dons, libéralités (6713)''.

Lorsque le don est décaissé par la structure :
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Banque (512)||||1000 €
|-
|Tiers percevant le don (401...)||1000 €||
|}

=Droit d'entrée=
Le droit d’entrée versé par un membre d'une association doit poursuivre un des trois objectifs suivants et cela doit être défini dans les statuts :
*financer l’entité, il est alors assimilé à un dépôt restituable. Le produit est affecté sur le compte de bilan 1032 ''Fonds statutaires''
*renforcer les fonds propres de l’entité. Le produit est affecté sur le compte de bilan 1022 ''Fonds statutaires''
*être constitutif d’un produit. Le produit est affecté sur un compte de produit.

Cf. Art. 142-2 du [https://www.anc.gouv.fr/files/live/sites/anc/files/contributed/ANC/1_Normes_fran%c3%a7aises/Reglements/2018/Reglt_2018_06/Reglt_2018_06_Asso_version_commentaires-fev-2021.pdf RÈGLEMENT N° 2018-06 du 5 décembre 2018 Relatif aux comptes annuels des personnes morales de droit privé à but non lucratif]

=Encaissements "test" (type PayPal)=
Certains organismes, pour vérifier la véracité des informations déclarées, effectuent un virement test de quelques centimes sur le compte bancaire qu'on leur communique. C'est le cas, par exemple, de PayPal lors de l'ouverture d'un compte chez eux.

Le virement peut être enregistré comptablement de la façon suivante :

{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Banque (512)||0,15 €||
|-
|Produits divers de gestion courante (758...)||||0,15 €
|}

=Facturation automatique à des organismes avec ou sans quotas=
Certains utilisateurs finaux peuvent appartenir à des organismes (Entreprises, Comités d'entreprises, établissements publics etc.) qui prennent en charge soit une partie soit la totalité du coût d'une activité avec ou sans des limitations (quotas en heures d'activité ou en montant).

Il est possible de mettre en place sur une plateforme OpenFlyers un paramétrage comptable spécifique qui déclenchera la facturation automatiquement auprès de l'organisme devant être réellement facturé. Cela présente comme avantages :
*De ne pas avoir à passer systématiquement et manuellement des écritures de transfert de facturation entre comptes clients.
*D'avoir directement sur le compte client de l'organisme concerné l'ensemble des débits à sa charge et ainsi de pouvoir déterminer le montant du paiement global qu'il doit effectuer.

La mise en place du paramétrage comptable repose sur 2 éléments :
*un suivi (le cas échéant) des quotas d'heures d'activités/montants au travers de la mise en place d'une comptabilité en heures/euros séparée de la comptabilité générale. Ce mécanisme est identique dans son principe à celui mis en place pour la [[#Packs_d'heures_d'activités|gestion des packs d'heures]]. Simplement, le "rechargement" du compte "quota" de l'utilisateur concerné ne se fait pas lors de la vente d'un pack mais lors du renouvellement d'une cotisation.
*une cascade d'écritures comptables permettant de débiter l'organisme en lieu et place de l'utilisateur

Les utilisateurs dépendant d'un organisme X doivent être identifiés dans OpenFlyers grâce à un profil spécifique et [[Gestion-des-profils#Profil-non-sélectionnable-par-l'utilisateur|non sélectionnable par l'utilisateur]].

A l'usage, les choses se déroulent concrètement dans l'ordre suivant :
#L'utilisateur saisit son activité dans OpenFlyers => automatiquement la ventilation des écritures se fait. Si l'utilisateur dispose d'un quota positif d'heures/d'argent, voir même d'un quota illimité, alors c'est le compte de son organisme de rattachement qui est débité au lieu de son compte. Il est également possible de "mixer". C'est à dire que si l'organisme de rattachement ne prend en charge qu'une partie du coût, OpenFlyers calculera automatiquement qui paie quoi et débitera chaque compte en conséquence.
#Le gestionnaire de la structure envoie la liasse de factures ou un relevé d'activités général mensuellement/trimestriellement à l'organisme considéré. Ces éléments sont disponibles dans OpenFlyers.
#Le gestionnaire de la structure reçoit le paiement de l'organisme qu'il saisit directement dans OpenFlyers comme un encaissement normal qui va créditer le compte client de l'organisme considéré.

Ainsi, le gestionnaire n'a que 2 actions à faire :
#Générer le relevé d'activités ou la liasse de factures et l'envoyer par e-mail
#Saisir l'encaissement de l'organisme payeur

=Forfaits découverte=
Les forfaits découverte consistent à vendre à un prix réduit plusieurs produits lors d'une première inscription ou pré-inscription dans une structure. Typiquement, dans le cas d'une structure aéronautique, les forfaits découvertes regroupent en général :
*La cotisation
*L'assurance/Licence Fédérale
*Un certain nombre d'heures d'instruction

''Pour les associations à but non lucratifs qui bénéficient d'exemption fiscale, OpenFlyers recommande, avant leur mise en place, de se rapprocher du fisc afin de vérifier la comptabilité de cette offre qui pourrait être considérée comme une remise commerciale et entrainer la requalification fiscale de l'association.''

Pour la gestion comptable du forfait découverte dans OpenFlyers, le plus simple consiste à vendre normalement chaque produit "physique" :
*Cotisation
*Assurance/Licence Fédérale
A enregistrer l'encaissement (par exemple Forfait découverte vendu 500 €) et ensuite à calculer la remise auquel à droit l'utilisateur en regardant son solde de compte et en le comparant avec le nombre d'heures auquel il a droit. En effet, bien souvent, la remise va être différente en fonction du montant payé pour la cotisation qui lui-même peut varier en fonction de l'âge ou de la date de prise de cotisation.

Exemple de calcul pour un forfait découverte à 500 € qui donne droit à :
*1 cotisation normalement facturée 120 €
*1 licence fédérale normalement facturée 80 €
*3 heures de vols normalement facturés 120 €/h
Après l'enregistrement de la cotisation, de la licence et l'encaissement des 500 €, le solde du compte pilote est de 500-120-80 = 300 €.

La personne en charge de la saisie, calcule :
*le montant normalement facturé pour les 3 heures de vols : 3 x 120 € = 360 €
*Détermine la remise à enregistrer en comptabilité au vu du solde du compte : 360 € - 300 € = 60 €

Elle doit enregistrer ensuite un flux comptable qui va créditer le compte pilote de 60 € et débiter un compte de charge "remise inscription" de 60 €.

Ainsi le solde du compte pilote est de 360 € à l'issue de ces saisies. Lorsque les 3 heures de vols seront effectuées, il sera bien à 0 €.

L'intérêt de cette méthode est :
*d'enregistrer une fois pour toute la remise et ensuite de ne plus avoir à s'en soucier
*de permettre que les heures de vols réellement effectuées ne correspondent pas exactement au nombre attribué par le Forfait découverte et permette ainsi un dépassement qui rentrera le montant normalement facturé des heures de vols.

=Packs d'heures d'activités=
OpenFlyers propose un système de comptabilités multiples dans son [[Configuration de la comptabilité#Paramétrage_général_des_comptabilités|paramétrage général des comptabilités]]. Ce système permet de mettre en place plusieurs comptabilités à la fois. Ainsi, on peut avoir une comptabilité en euros et une comptabilités en heures. La comptabilité en heures, permet de gérer des crédits d'heures d'activités qui sont mis en ventes sous la forme de packs d'heures d'activités.

'''Attention''' : ce système de packs d'heures d'activités n'est pas adapté aux produits de type [[#Forfaits-découverte|Forfaits découverte]]. En effet, le paramétrage de packs d'heures d'activités induisent la création de comptabilités supplémentaires, en heures de vols, pour générer les crédits d'heures des utilisateurs. De ce fait cela rajoute des comptes, en heures, pour tous les utilisateurs et cela alourdit donc visuellement l'interface. Or, les forfaits découverte sont destinés à 1 seule utilisation maximum par utilisateur. Il n'est donc pas souhaitable de polluer visuellement l'interface pour un usage non récurrent. Alors qu'à l'inverse, dans le cas des packs d'heures, la vue de ces comptes agit comme un moyen de communication et d'appropriation du concept de packs d'heures auprès des utilisateurs.

==Fonctionnement d'un exemple de configuration de vente de packs d'heures==
L'exemple est basé sur une structure qui propose 2 packs d'heures d'activités :
*un pack de 5 heures à 450 €
*un pack de 10 heures à 850 €
Le tarif d'une heure d'activité hors pack est à 100 €.

===Achat d'un pack d'heures par un utilisateur===
un utilisateur achète un pack de 10 heures 850 euros :
*Son compte utilisateur en euro est débité de 850 euros : le solde de son compte est débiteur de 850 €.
*Son compte en heures est crédité de 10 heures.
Ensuite l'utilisateur paie son pack 850 € ce qui a pour effet de ramener le solde de son compte en euros à 0 €.

===Saisie d'une activité pour un utilisateur bénéficiant d'heures créditées===
Lors de la saisie d'une activité de 1 heure, le compte en heures de l'utilisateur est débité de 1 heure. Le compte en euros de l'utilisateur n'est pas impacté : les heures ont été payées en amont lors de l'achat du pack.

===Remboursement d'heures===
A titre commercial, une structure peut accepter de rembourser un utilisateur n'ayant pas épuisé ses heures. Dans ce cas, plusieurs méthodes commerciales sont possibles dont :
#Considérer le crédit d'heures restant au tarif de l'heure du pack (par exemple 85 €/h pour un pack de 10 heures à 850 €) : cela revient à faire un prorata du prix du pack
#Considérer que dans ce cas précis, les heures utilisées sont refacturables à leur tarif hors pack. Dans ce cas, il faut consulter l'histoire du compte pour trouver le dernier pack acheté (pack de 5h ou de 10h), en déduire le nombre d'heures utilisées sur ce pack en faisant la différence avec le crédit d'heures restant, calculer le coût des heures utilisées hors pack et rembourser de la différence du prix du pack.
Dans les 2 cas, il faut saisir 2 flux :
*Un flux qui va débiter le compte en heures de l'utilisateur et créditer le compte de bilan correspondant "Encours ..." du nombre d'heures choisi
*Un flux qui va créditer le compte en euros de l'utilisateur et débiter le compte de produit comptabilisant normalement la vente des packs d'heures correspondant. Le montant est le montant calculé comme indiqué ci-dessus en 1 ou en 2.

===Solder un compte en heure présentant un très faible reliquat===
Il peut arriver qu'un compte en heures présente un reliquat très faible et qui apparait avec un solde à 0 mais sans l'icône poubelle permettant de désactiver ce compte. De plus, si on tente de saisir un flux pour solder ce reliquat, le flux n'est pas enregistré. De ce fait, on peut penser qu'il est impossible de supprimer ce compte.

Pour sortir de l'impasse, voici la procédure :
*Saisir un flux entre le compte à supprimer et son compte de contre-partie naturel. En général, le compte de contre-partie naturel est un compte de bilan qui s'intitule "Encours...". Pour en être sûr, il suffit de remonter dans l'historique des opérations du compte pour noter le compte de contre-partie qui était impacté.
*Sur la ligne du compte à supprimer cliquer sur l'icône représentant une balance pour que le montant du reliquat apparaisse en débit ou en crédit. Il doit être de la forme ''0,0123''.
*Rajouter une unité au montant du reliquat. Ainsi, ''0,0123'' devient ''1,0123''.
*Sur la 2ème ligne contrant le compte de contre-partie, cliquer sur l'icône balance avec une flèche pour équilibrer le flux.
*Indiquer la bonne date comptable
*Valider
Le flux est bien saisi et le compte à supprimer présente désormais un solde exact de 1 ou -1.
*Saisir un nouveau flux entre le compte à supprimer et son compte de contre-partie naturel en ramenant tout simplement le solde de son compte à 0.
La 2ème écriture s'enregistre correctement et le solde du compte est exactement de 0. Il est donc possible de supprimer le compte après avoir validé les flux.

==Initialisation du solde d'heures lors de la mise en place des packs==
Lors de la mise en place du système des packs sur une structure aéronautique déjà en activités, des packs peuvent avoir déjà été vendues et des heures effectuées. Dans ce cas, il faut juste saisir un flux entre le compte d'heures de l'utilisateur et le compte de bilan représentant l'encours des heures. Ce flux va créditer le compte d'heures de l'utilisateur de la valeur du nombre d'heures auxquelles il a encore droit.

Exemple de saisie d'un flux :

[[Image:Exemple-saisie-flux-pour-initialisation-solde-heures.png]]

==Transférer des crédits d'heures d'un utilisateur sur un autre de ses comptes==
Généralement, chaque compte utilisateur dispose de sa propre comptabilité. Ainsi, le compte principal, en euros, est rattaché à la comptabilité en euros. De la même façon, si l'utilisateur dispose d'un compte "Crédit heures A" et d'un autre compte "Crédit heures B" alors le premier compte va être rattaché à une comptabilité A et le deuxième compte à une comptabilité B. Pour dire les choses autrement : on ne mélange pas les torchons avec les serviettes.

Néanmoins, si commercialement, il est nécessaire de transférer le solde du compte "Crédit heures A" vers le compte "Crédit heures B", alors il faut saisir 2 flux comptables :
*Un premier flux qui va [[Utilisation-de-la-comptabilité#Solder-un-compte|solder le compte]] "Crédit heures A" en débit le compte correspondant et en créditant le compte permettant de mesurer l'encourt total des heures en crédit et que l'on intitule généralement "Encours Heures A". Pour trouver son intitulé exact, il suffit d'aller dans les comptes de bilan où ce compte doit être référencé.
*Un deuxième flux qui va effectuer l'opération en sens inverse : créditer le compte "Crédit heures B" et débiter le compte "Encours Heures B".
Il est possible lors de la saisie de ce 2ème flux, d'appliquer un coefficient correctif au montant à créditer si les valeurs des heures entre A et B ne correspondent pas.

Nous recommandons de mettre un intitulé qui permet d'expliquer la raison d'être de chaque flux.

S'il y a beaucoup de comptes utilisateurs concernés, la multiplication des saisies de flux, peut s'avérer rapidement fastidieuse. Afin de limiter le temps consacré à cette saisie, nous recommandons alors d'effectuer 1 seule saisie de flux qui solde l'ensemble des comptes utilisateurs, en soldant tous les comptes utilisateurs concernés dans un seul flux qui contiendra en dernière ligne la contre-partie totale.

[[Image:Saisir_un_flux_solde_multiple_de_comptes_heures.png]]

Pour trouver facilement les comptes utilisateurs concernés, nous recommandons d'afficher dans un onglet du navigateur la liste des comptes de tous les utilisateurs et dans un autre onglet d'afficher l'interface de saisie de flux.

De la même façon, pour le deuxième flux, nous recommandons de garder un onglet ouvert qui affiche le détail des montants soldés, en éditant l'écriture comptable précédente, et dans un autre onglet de saisir le deuxième flux.

=Participation des adhérents à une auto-assurance=
Le versement par un membre d'une association à une caisse d'auto-assurance doit aller au crédit du compte de bilan 151 ''Provisions pour risques''.

=Prêt des adhérents à l'association avec remboursement en numéraire=
Il s'agit d'argent prêté des membres à l'association, par exemple pour participer au financement de l'achat d'un nouvel aéronef.

Il est considéré dans l'exemple ci-après que l'argent est prêté sans intérêt. Il s'agit d'un prêt de 5 000 € remboursé en 5 mensualités de 1 000 €.

;Enregistrement comptable du prêt
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Compte de l'adhérent X (411xxx)||5 000 €||
|-
|Emprunt X (164xxx - compte de bilan)||||5 000 €
|}

;Enregistrement comptable du remboursement d'une échéance
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Compte de l'adhérent X (411xxx)||||1 000 €
|-
|Emprunt X (164xxx - compte de bilan)||1000 €||
|}

=Prêt des adhérents à l'association avec remboursement en remise sur le tarif des heures de vols=
Il s'agit d'argent prêté des membres à l'association, par exemple pour participer au financement de l'achat d'un nouvel aéronef.

Dans l'exemple ci-après, le membre prête 1 000 € se sera remboursé par une remise de 20 € sur l'heure de vol à concurrence de 50 heures.

;Enregistrement comptable du prêt
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Compte de l'adhérent X (411xxx)||5 000 €||
|-
|Emprunt X (164xxx - compte de bilan)||||5 000 €
|}

;Enregistrement comptable du remboursement d'une échéance
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Compte de l'adhérent X (411xxx)||||20 € * temps de vol en heure
|-
|Emprunt X (164xxx - compte de bilan)||20 € * temps de vol en heure||
|}

Il est possible d'automatiser dans OpenFlyers le remboursement des 20 € par heure de vol en mettant en place un mécanisme similaire aux [[#Packs-d'heures-d'activités|packs d'heures d'activités]].

=Rapprochement des encaissements=
Lors de la saisie d'un [[Écritures-comptables#Encaissement-(d'un-client)|encaissement client]], un flux comptable est généré. Il crédite le compte du client et débite un [[Comptabilité#Comptes-de-trésorerie|compte de trésorerie]].

Dans le paramétrage type d'OpenFlyers, le compte de trésorerie débité est un compte d'attente intitulé ''Compte remise X'' où X correspond au type d'encaissement (carte bancaire, virement, chèques).

Cela permet ensuite lors de l'import d'un relevé bancaire, de rapprocher automatiquement les écritures en générant des flux qui crédite le compte de banque et crédite le ''Compte remise X''.

Si après import du relevé bancaire, tout est juste alors le ''Compte remise X'' a un solde à 0.

S'il n'est pas à 0, alors grâce au lettrage, il est possible en regardant le détail du compte de lister les écritures non lettrées qui sont à l'origine de l'écart et ainsi de trouver plus rapidement la justification de l'écart.

Exemple basé sur le paramétrage ci-dessous avec un chèque de 250 € remis par le pilote M. Romain GARY.

La saisie du chèque de 250 € par M. Romain GARY génère le flux suivant :
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Compte remise chèque (512102)||2500 €||
|-
|Compte M. GARY (411rgary)||||250 €
|}

L'import du relevé bancaire génère le flux suivant :
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Compte courant (512100)||2500 €||
|-
|Compte remise chèque (512102)||||250 €
|}

Les extraits de compte résultants sont les suivants :

Compte M. GARY :
{| class="wikitable"
!Intitulé écriture!!Débit!!Crédit
|-
|Chèque X||||250 €
|-
|'''TOTAUX'''||'''0 €'''||'''250 €'''
|-
|'''SOLDE'''||||'''250 €'''
|}

Compte remise chèque :
{| class="wikitable"
!Intitulé écriture!!Débit!!Crédit
|-
|Chèque X||250 €||
|-
|Remise en banque chèque||||250 €
|-
|'''TOTAUX'''||'''250 €'''||'''250 €'''
|-
|'''SOLDE'''||||
|}

Compte courant :
{| class="wikitable"
!Intitulé écriture!!Débit!!Crédit
|-
|Remise en banque chèque||250 €||
|-
|'''TOTAUX'''||'''250 €'''||'''0 €'''
|-
|'''SOLDE'''||'''250 €'''||
|}

----
'''Paramétrage'''

Pour que ce mécanisme fonctionne, il faut :

*Avoir des comptes de trésorerie "Compte remise X" définis ainsi dans '''Gestion > Comptes > Comptes > Trésorerie''' :
[[File:Comptes_remise_trésorerie.jpg]]

*Avoir une [[Configuration-de-la-comptabilité#Ventilation-des-types-d'encaissements|ventilation des types d'encaissements]] définie ainsi dans '''Admin > Comptes > Encaissements > Ventilation''' :
[[File:Paramétrage_ventilation_encaissements.jpg]]

*Avoir des [[Configuration-de-la-comptabilité#Règles-d'imputations-automatiques|règles d'imputation]] définies ainsi dans '''Gestion > Comptes > Relevé bancaire > Règles d'imputation''' :
[[File:Règles_imputation_ventilation_encaissements.jpg]]

Attention : les mots clés définis dans les règles d'imputation varient en fonction de la banque de la structure.

=Refacturation=
Il peut arriver qu'une structure soit facturée à la place de l'utilisateur final. Dans ce cas, la structure peut décider de refacturer à la personne concernée. C'est souvent le cas, par exemple, pour les factures de taxes d'atterrissages qui sont envoyée à la structure en tant que propriétaire de l'aéronef et qu'ensuite la structure refacture l'utilisateur concerné.

Comptablement, il faut saisir les 2 écritures séparément :
*Saisir la facture fournisseur de la taxe d'atterrissage soit [[Gestion des achats#Saisie_d'une_facture_fournisseur|dans OpenFlyers]], soit dans le logiciel comptable utilisé pour les charges.
*[[Gestion des produits et des ventes#Achat_de_produit_non_stocké|Saisir l'achat d'une taxe d'atterrissages pour l'utilisateur concerné]].

=Rembourser une facture avancée par un utilisateur=
Pour rembourser une facture payée par un utilisateur (exemple : un pilote qui paie une facture d'essence alors que la location de l'aéronef inclut déjà l'essence), il suffit de [[Utilisation-de-la-comptabilité#Saisir-un-flux|saisir un flux]] qui va créditer le compte de l'utilisateur et débiter le compte du fournisseur correspondant à la facture.

Dans le cas où les [[Gestion-des-achats|factures fournisseurs]] sont saisies dans OpenFlyers, il suffit alors de saisir cette facture normalement et le compte du fournisseur se retrouvera à 0.

Dans le cas où les factures fournisseurs ne sont pas saisies dans OpenFlyers, il faut laisser le compte fournisseur débiteur. La facture correspondante sera saisie dans le logiciel de comptabilité en créditeur le même compte fournisseur qui se retrouvera donc à 0.

=Salaires=
Les salaires doivent être [[Gestion-des-achats#Saisie-d'une-facture-fournisseur|saisis comme des factures fournisseurs]] :
*Pour le salaire net versé au salarié : mettre comme fournisseur le salarié et comme compte de charge ''Rémunérations brutes'' (compte d'export 641100)
*Pour l'URSSAF : mettre comme fournisseur l'URSSAF (compte d'export 431000) et comme compte de charge ''Cotisations à l'URSSAF'' (compte d'export 645100)

=Subventions=
Une structure peut recevoir 2 types de subventions :
*[[#Enregistrement_des_subventions_destinées_à_la_structure|Des subventions destinées directement à la structure]]
*[[#Ventilation_des_subventions_destinées_aux_utilisateurs|Des subventions destinées à des utilisateurs de la structure et qui doivent donc être ventilées]]

==Enregistrement des subventions destinées à la structure==
Il existe plusieurs situations :
*Subventions d'exploitation accordées sans condition
*Subventions d'exploitation accordées avec condition résolutoire
*Subventions d'exploitation accordées avec condition suspensives
*Subventions d’investissement

Nous ne documentons ici que le cas de la subvention d'exploitation accordée sans condition. Pour ces autres cas, nous recommandons d'effectuer une recherche sur internet pour trouver les éléments décrivant l'enregistrement comptable correspondant.

*Enregistrement de la subvention à percevoir :
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Tiers qui subventionne (411...)||1000 €||
|-
|Subventions d'exploitation (74....)||||1000 €
|}

Si le tiers est une collectivité, alors la racine est 441...

Si la subvention est destinée à financer un investissement, alors il faut passer par des écritures qui impactent les comptes de bilan.

*Lorsque la subvention est encaissée par la structure :
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Banque (512...)||1000 €||
|-
|Tiers qui subventionne (411...)||||1000 €
|}

Si on souhaite simplifier la saisie, on peut enregistrer directement et uniquement l'encaissement de la subvention :
{| class="wikitable"
!Compte!!Débit!!Crédit
|-
|Banque (512...)||1000 €||
|-
|Subventions d’exploitation (74....)||||1000 €
|}

==Ventilation des subventions destinées aux utilisateurs==
Il peut arriver que la structure reçoive de l'argent d'un organisme et que cet argent doive ensuite être ventilé entre plusieurs clients. C'est le cas notamment pour les bourses attribuées par les fédérations qui doivent être redistribuées sur les comptes des utilisateurs concernés.

Les opérations comptables à effectuer pour cela sont les suivantes :
*[[Utilisation-de-la-comptabilité#Saisir-un-flux|Saisir un flux]] correspondant à un [[Écritures comptables#Transfert_de_charge|transfert de charges]].
*[[Utilisation-de-la-comptabilité#Saisir-un-flux|Saisir un autre flux]] débitant le "compte de Transfert de charge (791)" et créditant les comptes des utilisateurs concernés.
Si on sait au moment de l'encaissement du paiement quels sont les utilisateurs concernés, alors on peut saisir directement un flux qui débite le compte de trésorerie et crédite les comptes des utilisateurs concernés.

===Anticiper l'attribution des subventions pour ne pas bloquer les utilisateurs===
Dans le cas où il existe des restrictions sur les droits pour les utilisateurs n'ayant pas le solde suffisant sur leur compte, il peut être pénalisant pour les utilisateurs attendant des subventions de se retrouver restreints dans leur droit à cause d'un solde insuffisant alors que la subvention est certaine.

Afin, de ne pas restreindre les pilotes concernés, il faut :
*Créer un [[Comptabilité#Comptes_de_tiers|compte de tiers]], par exemple "Subvention à recevoir (441)".
*Saisir un flux créditant le compte de l'utilisateur et débitant le compte "Subvention à recevoir".
Ainsi :
*Le compte du pilote est crédité de la future subvention et il n'est donc pas restreint du fait d'un solde insuffisant dans l'attente d'une subvention.
*Il est possible de contrôler les sommes distribuées et non perçues au travers du compte "Subvention à recevoir".
*Lorsque la subvention sera réellement perçue, il suffira de saisir un flux de transfert entre ce compte et le compte recevant la subvention afin de le ramener à 0.

=Les taxes=
==Gérer les taxes d'atterrissage==
Les taxes d'atterrissages sont facturées à la structure aéronautique qui souvent les débitent sur le compte de ses clients. Voici plusieurs méthodes pour gérer ces opérations dans OpenFlyers.

#Pour les aérodromes dont la facturation est très récurrente et systématiquement effectuée à la structure (par exemple s'il s'agit de la base ou d'un aérodrome voisin), il peut être intéressant de rendre la facturation systématique en la couplant avec la saisie du vol. Pour ce faire, il faut créer la variable tarif correspondante, lui associer une valeur et ensuite créer une règle de facturation d'activité avec une formule qui contiendra un test sur l'aérodrome de départ ou d'arrivée :
#:''(%AIRFIELD_DEPARTURE=='LFBD')? $tarifTaxeLFBD : 0''
#Pour les aérodromes dont les taxes sont récurrentes mais pour lesquelles le pilote est susceptible de les payer directement et qui ne sont donc pas systématiquement facturées à la structure, il est recommander de créer un type de vente et de "revendre" la taxe à l'utilisateur concerné.
#Sinon, pour le cas plus fréquent (taxes différentes et peu fréquentes), il est recommandé de revendre la taxe en tant que produit "Taxe" dont le tarif est libre.

=Ventilation des factures essences=
Afin de déterminer le coût de revient d'une ressource, il est nécessaire de pouvoir ventiler les différents postes de charge par ressource. C'est notamment le cas pour le poste "essence" qui dans le cas de l'aéronautique représente une part importante des charges.

Dans le cas d'une structure aéronautique, en général, l'approvisionnement se fait principalement auprès d'une seul fournisseur d'essence localisé sur son aérodrome ou sur un aérodrome voisin.

Il existe alors 2 types de situations :
#la structure dispose de "clés" ou de badges par aéronef et ainsi le fournisseur d'essence est capable de générer des factures avec le détail des montants facturés par aéronef
#le fournisseur d'essence ne fournit qu'une facture globale

Dans la 1ère situation, il est judicieux de saisir les factures fournisseurs en éclatant la facture globale en autant de sous-factures qu'il y a de ressources concernées. Cela permet d'avoir directement une ventilation des charges par ressource. C'est également le cas qu'on retrouve dans le cas où les factures sont individualisées à chaque avitaillement : on est capable d'associer telle facture à telle ressource.

Dans la 2ème situation, il n'est pas possible à priori de ventiler la facture d'essence par ressource. Dans ce cas là, on recommande de regrouper toutes les factures d'essence dans un même compte de charge. Ensuite, grâce à la consultation du total des volumes d'essences saisis dans les rapports, on est capable d'en déduire la part du coût global qui revient à chaque ressource. On recommande de ne pas faire de post-ventilation comptable mais de gérer cela directement dans une feuille de calcul qui est normalement utilisée pour déterminer le coût de revient des ressources.

Configuration de la comptabilité

2024-10-02T17:27:49Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de décrire la configuration de la [[Comptabilité|comptabilité]] dans la [[Accueil|version 4 d'OpenFlyers]].

=[[Bien débuter avec OpenFlyers#Mettre_en_place_la_gestion_d'activité_sur_OpenFlyers|Mise en place de la comptabilité dans OpenFlyers]]=

=Paramétrage général de la gestion des comptes=
*Aller dans '''[[Configuration#Gestion-des-comptes-(Admin->-Structure->-Paramétrage->-Comptes)|Admin > Structure > Paramétrage > Comptes]]'''.

*Activer le toggle switch '''Comptes''' et cliquer sur '''Enregistrer''' pour activer la gestion des comptes.
*Champ '''Gestion TVA''' : activer le toggle switch si la structure est soumise à la TVA, sinon le laisser désactivé. Lorsque le toggle switch est désactivé, le champ '''Mention spécifique pour l'absence de TVA''' est saisissable.
*Champ '''Mention spécifique pour l'absence de TVA''' :
*:Exemple de valeurs possibles pour le champ :
**"TVA non applicable : article 293B du CGI" pour une association loi 1901, exonérée de TVA car ne dépassant pas un certain chiffre d'affaire
**"Association loi 1901, exonérées de TVA : B.O.I. N° 208 du 18/12/2006 [BOI 4H-5-06]" pour une association exonérée de TVA du fait de son caractère non lucratif
**"TVA non applicable : article 202B du CGI" pour un organisme de formation professionnelle continue déclaré ayant opté pour l'exonération de TVA
**"Organisme de formation professionnelle continue déclaré ayant opté pour l'exonération de TVA : article 202B du CGI" pour les organismes de formation ayant opté pour l'exonération de TVA
**"TVA provisoirement non applicable en Guyane, Article 294-1 du CGI" pour une structure commerciale en Guyane.
**"TVA non applicable sur vols internationaux : Article 262-II-8° du CGI" pour une structure commerciale effectuant des vols internationaux
*Champ '''Titre spécifique pour les factures validées''' :
*:Exemple de valeurs possibles pour le champ :
**"Facture"
**"Note de participation aux frais"
*Champ '''Titre spécifique pour les factures non validées''' :
*:Exemple de valeurs possibles pour le champ :
**"Facture PROFORMA"
**"Note de participation aux frais PROFORMA"
**"Devis"
**"Bon de commande"
*Champ '''Titre spécifique pour les reçus validées''' :
*:Exemple de valeurs possibles pour le champ :
**"Reçu"
*Champ '''Titre spécifique pour les reçus non validés''' :
*:Exemple de valeurs possibles pour le champ :
**"Reçu PROFORMA"
*Champ '''Nombre maximal de jours antérieur pour lettrer''' : définit le nombre de jours avant la date d'une écriture pour lequel le lettrage automatique peut s'appliquer avec une autre écriture d'un même compte lors de l'[[Utilisation-de-la-comptabilité#Importer-un-relevé-bancaire|import d'un relevé bancaire]]
*Champ '''Nombre maximal de jours postérieur pour lettrer''' : définit le nombre de jours après la date d'une écriture pour lequel le lettrage automatique peut s'appliquer avec une autre écriture d'un même compte lors de l'[[Utilisation-de-la-comptabilité#Importer-un-relevé-bancaire|import d'un relevé bancaire]]
*Champ '''Mentions sur les conditions de paiement''' : remplace le champ [[Modèle de facture ODT#Variables|[payment_notice_tag]]] dans le template de la facture PDF.
*:Exemple de texte possible :
<pre>Règlement à réception

En cas de retard de paiement, il sera appliqué des pénalités correspondant au taux légal en vigueur par mois de retard.

En outre, une indemnité forfaitaire pour frais de recouvrement de 40 € sera due.

Pas d'escompte en cas de paiement anticipé.</pre>
*'''Mentions pieds de page''' : remplace le champ [[Modèle de facture ODT#Variables|[footer_tag]]] dans le template de la facture PDF. Exemple de texte possible :
<pre>SARL DUPONT au capital de 22 000 €, SIREN 123 456 789 RCS Paris, FR01234567890</pre>

=Paramétrage général des comptabilités=
*Aller dans '''Admin > Comptes > Comptabilités > Comptabilités'''.

Les différentes colonnes permettent de paramétrer une comptabilité :
*'''Nom''' : Nom de la comptabilité
*'''Unité''' : L'unité employé
*'''Symbole''' : Le symbole de l'unité
*'''Format''' : Le format d'affichage à utiliser pour les montants
*'''Nombre de chiffre après la virgule''' : Détermine à combien de chiffre après la virgule vont être arrondi les montants calculés au sein de la comptabilité. L'arrondissement s'effectue aussi sur les variable-formules.
*'''Comptes pour apurement d'un compte utilisateur'''
**'''Solde de compte positif''' : compte de produit défini pour recevoir le crédit lors de l'apurement d'un compte utilisateur ayant un solde positif lors de sa désactivation. Le compte défini par défaut est le compte [[Wikipedia-fr::Plan_comptable_général_(France)#75._Autres_produits_de_gestion_courante|758-Produits divers de gestion courante]].
**'''Solde de compte négatif''' : compte de charge défini pour recevoir le débit lors de l'apurement d'un compte utilisateur ayant un solde négatif lors de sa désactivation. Le compte défini par défaut est le compte [[Wikipedia-fr::Plan_comptable_général_(France)#65._Autres_charges_de_gestion_courante|654-Perte sur créances irrécouvrable]].
:Si le compte utilisateur à mettre à 0 est un compte en heure alors le compte de contre-partie est en général un compte de bilan intitulé "Encours xxx" appartement à la même comptabilité que le compte utilisateur concerné.
* '''Solde minimum requis''' et '''Si solde utilisateur inférieur au minimum''' : Permettent d'alerter et de restreindre l'accès à un profil déterminé ou de bloquer l'accès lorsque l'un des soldes des comptes d'un utilisateur est inférieur au minimum requis.
*'''Seuil minimum requis après transfert''' : Permet de bloquer [[Gestion-de-la-comptabilité-côté-utilisateur#Transférer-de-l'argent|un transfert]] si après opération, le solde du compte de l'utilisateur serait inférieur au seuil minimum requis. Si le seuil n'est pas défini alors il n'y a pas de vérification sur le solde. Le droit [[Gestion-des-profils#Surpasser-le-seuil-de-transfert-de-compte|Surpasser le seuil de transfert de compte]] permet de outrepasser cette limitation.
* '''Seuil de compte pour l'envoi d'e-mail d'alerte''' : Permet l'envoi d'un [[Envoi-des-emails#E-mail-de-rappel-de-solde|email d'alerte]], [[Envoi-des-emails#Présentation|uniquement sur les plateformes en production]], lorsque l'utilisateur a un solde de compte inférieur au seuil. L'email est envoyé à tous les utilisateurs concernés dès lors qu'une adresse email est enregistrée dans leur fiche utilisateur. Il est possible de suivre la bonne réception des alertes par email dans le module [[Suivi-des-emails|Suivi des emails]] (catégorie ''Alerte de solde'').
* '''Fréquence de rappel pour l'envoi d'e-mail d'alerte''' : Détermine la fréquence de rappel pour l'envoi de l'[[Envoi-des-emails#E-mail-de-rappel-de-solde|email d'alerte]] (Jamais, tous les jours, tous les 3 jours).
* '''Contenu de l'e-mail d'alerte''' : Le contenu à insérer dans le message d'[[Envoi-des-emails#E-mail-de-rappel-de-solde|email d'alerte]].
* '''Ajouté en copie d'e-mail''' : Permet d'ajouter les utilisateurs des profils cochés en copie de l'[[Envoi-des-emails#E-mail-de-rappel-de-solde|email d'alerte]] envoyé à chaque utilisateur concerné

Voir le chapitre [[Formules-de-calcul#Exemples-de-patrons-d'emails-de-rappel-de-solde|Exemples de patrons d'emails de rappel de solde]].

Nous recommandons fortement de mettre le paramètre %ACCOUNT_BALANCE € dans le patron d'emails. Cela permet d'avoir une traçabilité du montant calculé par OpenFlyers au moment de l'envoi de l'e-mail et ainsi d'éviter tout problème de discussion ultérieur.

==Restriction d'accès en cas de solde insuffisant==
Il est possible de définir des règles de restriction et/ou alerte pour chaque comptabilité. Pour cela, il faut :
*[[Gestion des profils|Créer un profil]] spécifique qui peut s'intituler ''Accès restreint''. Lors de la restriction, seuls les droits présents à la fois sur ce profil et sur celui de l'utilisateur restreint, resteront valides. Il faut donc bien définir les droits qui doivent rester présent pour le profil restreint.
*Dans le [[#Paramétrage_général_des_comptabilités|paramétrage général des comptabilités]], paramétrer les colonnes '''Si solde utilisateur inférieur au minimum''' et '''Solde minimum requis''' pour permettent d'alerter et de [[Connexion#Restriction-d'accès|restreindre l'accès à un profil déterminé]] ou de bloquer l'accès lorsque l'un des soldes des comptes d'un utilisateur est inférieur au minimum requis.

Le fait de [[Connexion#Restriction_d'accès|restreindre le profil d'un utilisateur]], permet de l'empêcher de pouvoir effectuer certaines actions comme réserver ou débuter une activité si l'un de ses soldes est insuffisant.

Ce contrôle sur le solde du compte et les droits qui en résultent s'effectue :
*A la connexion de l'utilisateur pour en déduire le type d'accès auquel il a droit
*Lors d'une action de réservation ou de saisie de vol effectuée par n'importe quel utilisateur. Dans ce cas, OpenFlyers contrôle le solde non pas de la personne effectuant l'action mais celui pour qui l'action est effectuée. Cela permet d'empêcher à un utilisateur de contourner une restriction en demandant à un autre utilisateur disposant de droits étendus de faire par exemple une réservation à son nom.

Il est possible d'attribuer à des profils le droit "[[Gestion-des-profils#Surpasser-la-limitation-du-solde-du-compte|Surpasser la limitation du solde du compte]]" qui seraient ainsi mise en place.

'''Attention :''' lorsqu'un utilisateur dispose d'un profil avec le droit "[[Gestion-des-profils#Surpasser-la-limitation-du-solde-du-compte|Surpasser la limitation du solde du compte]]", alors même s'il se connecte avec un autre profil, il n'aura pas de restriction en cas de solde insuffisant.

Il est possible d'empêcher les utilisateurs standards d'effectuer des réservations en cas de solde insuffisant en enlevant les droits [[Gestion-des-profils#Réservation-solo|"Réservation solo"]] et [[Gestion-des-profils#Réservation-pour-des-tiers|"Réservation pour des tiers"]] au profil ''Accès restreint'' tout en permettant à des tiers de pouvoir effectuer des réservations pour eux en laissant le droit [[Gestion-des-profils#Etre-sur-une-nouvelle-réservation|"Etre sur une nouvelle réservation"]] au profil ''Accès restreint''.

Conseil OpenFlyers : il est possible d'utiliser l'alerte sur une comptabilité pour mettre en place l'envoi automatique d'un e-mail lorsque le crédit d'heures de vol devient inférieur à une certaine valeur. Exemple : "Votre crédit d'heures de vol est inférieur à 1h, n'hésitez-pas à le recharger en achetant un pack de 10 heures".

=Compte comptable=
==Créer un compte comptable==
*Aller dans '''Gestion > Comptes > Comptes > X''' où X dépend de la [[Comptabilité#Présentation-des-comptes-dans-OpenFlyers|catégorie de comptes]] à créer.
*En bas du tableau :
**Remplir le champ de la colonne '''Nom''' avec le nom souhaité pour désigner le compte à créer. Certains caractères ne sont pas recommandés dans le nom [[OF-doc-en::Accounting-export-template-CsvWithPointDecimal#Introduction|car ils sont supprimées dans les fichiers d'exports]]
***'''Attention''' : Certains caractères ne sont pas recommandés dans le nom [[OF-doc-en::Accounting-export-template-CsvWithPointDecimal#Introduction|car ils sont supprimées dans les fichiers d'exports au format CSV]]
**Remplir le champ de la colonne '''Compte d'export''' avec le numéro de compte d'export comptable souhaité. Cette information peut être saisie ou mise à jour à tout moment jusqu'à avant l'export vers un logiciel de comptabilité.
**Dans le cas où il s'agit d'un compte client, il faut sélectionner la case à cocher de la colonne '''Reçoit les paiements des clients extérieurs''' si l'on souhaite pouvoir saisir des encaissements directement sur ce compte
**Cliquer sur le bouton '''Ajouter'''

==Créer un compte pour les ressources==
*Aller dans '''Gestion > Comptes > Comptes > Ressources'''
*Cliquer sur l'icône [[File:Icone_creation_compte.png]]

Les ressources affichées sont :
* celles utilisables pour la '''Saisie d'activité'''
* celles non utilisables pour la '''Saisie d'activité''' mais ayant au moins un compte actif : cela permet de continuer à pouvoir consulter l'historique du compte de la ressource alors que la ressource n'est plus utilisée.

==Comptes d'export==
A chaque [[#Compte_comptable|compte comptable]] est associé un compte d'export qui lui est propre.
*Ce numéro de compte d'export est utilisé exclusivement pour les [[Utilisation de la comptabilité#Les_exports_comptables|exports comptables]] et les rapports comptables
*Tous les comptes d'export doivent être définis avant de pouvoir réaliser un export comptable.
*Cette attribution de compte d'export peut être effectuée et modifiée à n'importe quel moment.
*Ce compte d'export est éditable directement au niveau du compte.
*De plus, pour les comptes utilisateurs et les comptes ressources, il est possible et fortement recommandé de définir des règles de numérotation automatique qui permettent de créer automatiquement les numéros de compte d'export lors de la création de nouveaux utilisateurs ou de nouvelles ressources.
*'''Attention''' : Certains caractères ne sont pas recommandés dans le nom [[OF-doc-en::Accounting-export-template-CsvWithPointDecimal#Introduction|car ils sont supprimées dans les fichiers d'exports au format CSV]]
''Dans le cadre du paramétrage effectué par OpenFlyers, nous livrons la plateforme avec les comptes d'export attribués selon le modèle couramment utilisé pour tous les comptes créés par nos soins.''
===Attribuer les comptes d'export utilisateurs ou ressources===
Pour attribuer les comptes d'export aux comptes utilisateurs ou aux comptes ressources, il existe 2 possibilités :
*soit par [[#Attribuer_manuellement_les_comptes_d'export_utilisateurs_ou_ressources|édition du compte d'export de chaque compte individuellement]]
*soit par [[#Mettre_en_place_un_patron_de_génération_automatique_de_compte_d'export_utilisateurs_ou_ressources|mise en place d'une formule permettant de générer automatiquement les valeurs]]
Il est recommandé de mettre en place une formule pour chaque type de compte utilisateur/ressource. Cela permet, lors de l'ajout de nouveaux utilisateurs/ressources, d'être sûr d'avoir une règle qui va être respectée et de permettre une génération automatique du compte d'export.

====Attribuer manuellement les comptes d'export utilisateurs ou ressources====
*Aller dans '''Gestion > Comptes > Comptes > Utilisateurs''' ou '''Gestion > Comptes > Comptes > Ressources'''
*Retrouver le compte souhaité
*Cliquer sur l'icône "crayon" pour modifier : un formulaire apparait permettant de modifier/saisir le Code comptable pour l'exportation

====Mettre en place un patron de génération automatique de compte d'export utilisateurs ou ressources====
*Aller dans '''Admin > Comptes > Utilisateurs > Types actifs''' ou '''Admin > Comptes > Ressources > Types actifs''' selon le cas.
*Cliquer sur l'icône symbolisant un crayon de la ligne du type de compte pour lequel vous souhaitez mettre en place/éditer le patron de code comptable.
*Renseigner le champ '''Patron de code comptable pour l'exportation''' (cf. [[Formules de calcul#Compte_d'export|les exemples]]).
*Cliquer sur le bouton '''Valider'''.
Il faut ensuite appliquer le patron :
*Aller dans '''Admin > Comptes > Utilisateurs > Gérer les comptes d'export''' ou dans '''Admin > Comptes > Ressources > Gérer les comptes d'export''' selon le cas.
*Dans le champ '''Appliquer la mise à jour sur les types de comptes''' sélectionner le type de compte concerné. Le champ '''Formule à appliquer''' doit automatiquement se remplir avec le patron précédemment créé
*Si vous souhaitez que le patron s'applique à tous les comptes, sélectionner '''Tous les comptes'''. Sinon, sélectionner '''Uniquement les comptes sans numéro d'export'''.
*Cliquer sur le bouton '''Appliquer'''.

===Attribuer les comptes d'export pour un compte ni utilisateur ni ressource===
*Aller dans '''Gestion > Comptes > Comptes > Tous'''
*Modifier le champ Compte d'export, la validation est automatique lors de la sortie du champ

=Agréger des comptes bancaires=
;Présentation
Cette action préliminaire est nécessaire pour permettre soit d'activer l'import quotidien automatique des relevés bancaires soit pour [[Utilisation-de-la-comptabilité#Importer-par-API|importer par API]] les relevés bancaires.

;Prérequis
*Disposer du droit [[Gestion-des-profils#Gestion-des-comptabilités|Gestion des comptabilités]] ou du droit [[Gestion-des-profils#Gestion-des-comptes|Gestion des comptes]]

;Chapitres liés
*[[Envoi-des-emails#E-mail-de-rappel-de-renouvellement-d'agrégation-bancaire|E-mail de rappel de renouvellement d'agrégation bancaire]]
*[[Utilisation-de-la-comptabilité#Importer-par-API|Importer par API un relevé bancaire]]

;Procédure
Aller dans '''Admin > Comptes > Banque > Agréger''', Un tableau s'affiche avec les informations suivantes :
*Colonne '''Actions sur la banque''' :
**Bouton '''supprimer''' à gauche du tableau permet de supprimer l'agrégation d'une banque et tous les comptes associés.
**Bouton '''Renouveler''' permet d'effectuer le renouvellement de l'authentification forte. Il est à faire tous les 90 jours pour que l'agrégation soit maintenue.
*'''Banque''' : banque du compte contenant les transactions à importer.
*'''Compte Bancaire''' : compte bancaire contenant les extraits de compte à importer.
*'''Date de la dernière authentification''': dernière authentification forte réalisée auprès de la banque à laquelle appartient le compte en question.
*'''Date limite d'agrégation''': date d'échéance d'aggrégation (Date de la dernière authentification + 90 jours), s'affiche en rouge à partir d'un mois avant l'échéance.
*'''[[Comptabilité#Comptes-de-trésorerie|Compte de trésorerie]]''' : compte de trésorerie couplé au compte bancaire. C'est sur ce compte que s'enregistre les écritures comptables correspondantes aux extraits de comptes importés du compte bancaire.
*'''Date de début d'import''' : seuls les extraits de compte ayant une date postérieure ou égale à la date de début d'import indiquée sont pris en compte pour l'import dans OpenFlyers.
*'''Synchroniser 1 fois par jour ''': Lorsque la case est cochée, alors le robot OpenFlyers importe automatiquement une fois par jour l'extrait de compte du compte bancaire concerné dans le compte de trésorerie couplé.

Pour créer une nouvelle agrégation il faut cliquer sur le bouton '''Ajouter''' situé à droite en bas et en haut du tableau. Il faut ensuite remplir le formulaire et appuyer sur le bouton '''Ajouter'''.

Pour modifier un couplage entre un compte bancaire et un compte de trésorerie, il faut cliquer sur le bouton '''Modifier''' situé dans la colonne Actions de l'agrégation que l'on souhaite éditer. Il faut ensuite remplir le formulaire et appuyer sur le bouton '''Modifier'''.

Pour supprimer un couplage entre un compte bancaire et un compte de trésorerie, il faut cliquer sur le bouton '''Supprimer''' situé dans la colonne Actions de l'agrégation que l'on souhaite supprimer. Il faut ensuite confirmer la suppression en appuyant sur le bouton '''OK'''.

Pour supprimer l'agrégation d'une banque, il faut cliquer sur le bouton '''Supprimer''' situé dans la colonne de gauche à la ligne de la concernée. Il faut ensuite confirmer la suppression en appuyant sur le bouton '''OK'''.

Le formulaire d'ajout/modification d'une agrégation/d'un couplage contient les champs suivants :
*'''Compte de trésorerie''' : menu déroulant permettant de choisir le compte de trésorerie. Seuls les comptes qui ne sont pas déjà couplés ainsi que le compte qu'on édite, dans le cas d'une modification peuvent être sélectionnés.
*'''Date de début d'import''': calendrier permettant de choisir la date de début d'import à associer au compte de trésorerie sélectionné dans le champ précèdent.
*'''Synchroniser 1 fois par jour''': un interrupteur permet d'activer la synchronisation automatique afin d'importer le relevé bancaire tous les jours.
*'''Banque''' : menu déroulant permettant de sélectionner la banque à agréger. Une fois la banque sélectionnée, la page défile et il y a deux situations :
**Si la banque sélectionnée n'est pas déjà agrégée, le processus d'agrégation est le suivant :
***'''Agréger la banque''' : permet de lancer le processus d'agrégation.
***En cliquant sur le bouton l'utilisateur est redirigé vers une page d'authentification de la banque sélectionnée.
***Une fois l'utilisateur authentifié, tous les comptes disponibles de la banque sont agrégées, l'utilisateur se redirige vers la même interface avec :
****Les champs '''Compte de trésorerie''' et '''Banque''' seront en lecture seule.
****Une liste déroulante permet de choisir le compte à coupler. Cette liste contient les comptes agrégés de la banque. Seuls les comptes qui ne sont pas couplés à un compte de trésorerie peuvent être sélectionnés.
**Si la banque est déjà agrégée, le nom de la banque apparait dans la liste suivi de l'information '''(agrégation existante)''', le processus de l'agrégation est le suivant :
***'''Compte bancaire''': une liste déroulante permet de choisir l'un des comptes. Seuls les comptes qui ne sont pas déjà couplés à un compte de trésorerie et le compte couplé que l'on édite en cas de modification peuvent être sélectionnés.
*le bouton '''Ajouter''' ou '''Modifier''' pour enregistrer l'agrégation.

Un email de rappel de renouvellement de l'agrégation est envoyé à intervalle régulier pour avertir les gestionnaires de la nécessité de renouveler l'agrégation. Voir les chapitres [[Envoi-des-emails#E-mail-de-rappel-de-renouvellement-d'agrégation-bancaire|E-mail de rappel de renouvellement d'agrégation bancaire]] et [[#Renouveler-l'agrégation-des-comptes-bancaires|Renouveler l'agrégation des comptes bancaires]].

=Renouveler l'agrégation des comptes bancaires=
;Présentation
Le renouvellement de l'agrégation des comptes bancaires doit être effectués tous les 3 mois. Il s'agit d'une obligation légale européenne. Si le renouvellement de l'agrégation n'est pas effectué au bout de 3 mois, alors il n'est plus possible de synchroniser manuellement ou automatiquement les comptes bancaires avec l'API de la banque.

Il est important de noter qu'il ne faut pas supprimer une agrégation existante pour la renouveler. En effet, si un utilisateur effectue cette action, alors les références de la nouvelle agrégation ne correspondront plus avec celles de l'ancienne et l'import des écritures bancaires va créer des doublons avec les anciens imports.

;Prérequis
*Disposer du droit [[Gestion-des-profils#Gestion-des-comptabilités|Gestion des comptabilités]] ou du droit [[Gestion-des-profils#Gestion-des-comptes|Gestion des comptes]]
*Avoir un ou plusieurs [[#Agréger-des-comptes-bancaires|comptes bancaires agrégés]]

;Chapitres liés
*[[#Agréger-des-comptes-bancaires|Agréger des comptes bancaires]]
*[[Envoi-des-emails#E-mail-de-rappel-de-renouvellement-d'agrégation-bancaire|E-mail de rappel de renouvellement d'agrégation bancaire]]
*[[Utilisation-de-la-comptabilité#Importer-par-API|Importer par API un relevé bancaire]]
*[[Alertes-de-configuration#Utiliser-correctement-la-fonctionnalité-'Importer-les-relevés-bancaires-par-API'-en-prolongant-l'agrégation-des-banques-au-delà-de-90-jours-après-la-dernière-date-d'authentification|Alerte de configuration pour renouveler l'aggrégation bancaire]]

;Procédure
Aller dans '''Admin > Comptes > Banque > Agréger'''
Un tableau s'affiche. Il doit contenir la liste des banques agrégées. Pour renouveler l'agrégation de l'une d'elle, il faut :
*Cliquer sur le pictogramme '''Renouveler''', symbolisant un triangle avec une flèche qui tourne autour, à gauche de la ligne de la banque concernée
L'interface de la banque apparait pour effectuer l'action de renouvellement de l'agrégation. Suivre les consignes et renseigner les informations demandées par la banque. Une fois le renouvellement de l'agrégation achevé, apparait à nouveau la page OpenFlyers du tableau des agrégations.
*Vérifier que la date d'agrégation correspond à la date du jour

=Règles d'imputations automatiques=
Pour accéder à cette fonctionnalité il faut disposer des droits de [[Gestion-des-profils#Gestion-des-comptes|Gestion des comptes]] ou [[Gestion-des-profils#Saisir-tout-flux|Saisir tout flux]].

Prérequis :
*L'accès à cette fonctionnalité nécessite [[Utilisation-de-la-comptabilité#Créer-un-compte|la création d'au moins un compte]] client ou fournisseur.

Cela permet de créer ou modifier les règles d'imputation automatique utilisés lors de l'[[Utilisation-de-la-comptabilité#Importer-un-relevé-bancaire|importation de relevés bancaires]].

Depuis l'[[Présentation-d'OpenFlyers-4#Interface-légère|interface légère]] :
*'''Gestion > Comptes > relevé bancaire > Règles d'imputation'''
Un tableau est alors affiché :

{| class="wikitable"
!Ordonner!!Titre!!Montant sur le relevé bancaire!!Mot clé à rechercher!!Nom du compte imputé dans la comptabilité
|-
|0||Compte d'attente fournisseur||Débit (montant négatif)||--||Fournisseur - compte d'attente
|-
|1||Compte d'attente client||Crédit (montant positif)||--||Client - compte d'attente
|-
|}

Pour créer une nouvelle règle il faut cliquer sur le bouton '''Ajouter une règle d'imputation''' situé en bas du tableau. Il faut ensuite remplir le formulaire et appuyer sur le bouton '''Enregistrer'''. Le champ "Titre" doit être obligatoirement rempli.

Pour modifier une nouvelle règle il faut cliquer sur le bouton '''Modifier''' situé dans la colonne '''Actions''' de la règle d'imputation que l'on souhaite éditer. Il faut ensuite remplir le formulaire et appuyer sur le bouton '''Enregistrer'''. Le champ "Titre" doit être obligatoirement rempli.

Pour les règles d'imputation "Compte d'attente fournisseur" et "Compte d'attente client" seul les champs "Placer avant" et "Nom de compte" sont modifiable.

Présentation des colonnes :
*La colonne 'Ordonner' : Ordre dans lequel s'applique les règles d'imputation;
*La colonne 'Titre' : Titre des règles d'imputation;
*La colonne 'Montant sur le relevé bancaire' : L'utilisateur à le choix entre "Crédit" ou "Débit",
*La colonne 'Mot clé à rechercher' : Champs texte;
*La colonne 'Nom du compte imputé dans la comptabilité' : L'utilisateur à le choix entre les comptes déjà existant,

Fonctionnement :
*Lors de l'[[Utilisation-de-la-comptabilité#Importer-un-relevé-bancaire|import d'un relevé bancaire]], le robot OpenFlyers va pour chaque ligne du relevé bancaire, parcourir les règles d'imputation dans l'ordre dans lequel elles sont définies.
*Si le montant de la ligne du relevé est du même signe que celui défini dans la règle (champ '''Montant sur le relevé bancaire''') et si l'intitulé contient le mot clé ou l'[[Wikipedia-fr:Expression_régulière|expression régulière]] définie dans le champ '''Mot clé à rechercher''', alors la règle s'applique. Dans ce cas, le robot, génère un flux qui va débiter/créditer le compte de trésorerie définie dans l'interface d'import des relevés bancaires et va mettre la contre-partie dans le compte défini dans la règle (champ '''Nom du compte imputé dans la comptabilité''').
*Si la règle ne correspond pas, le robot passe à la règle suivante jusqu'à trouver une règle qui s'applique.

Deux règles (''Compte d'attente fournisseur'' et ''Compte d'attente client'') sont créées par défaut. Elles ne peuvent être supprimées et leur ordre ne peut être modifiées. Elles sont positionnées en dernier. Ainsi, elles permettent de garantir que pour toute ligne du relevé bancaire, une règle va correspondre et que la ligne va donc bien être enregistrée dans OpenFlyers. Ces règles sont prévues pour s'appliquer sur des comptes par défaut (comptes d'attentes) afin de permettre un traitement manuel ultérieur par le gestionnaire. Seul le paramètre '''Nom du compte imputé dans la comptabilité''' est modifiable.

[[File:Exemple_regle_imputation.PNG|center|800px]]

=Types d'encaissements=
OpenFlyers permet de définir librement autant de types d'encaissements que l'on souhaite. Cela permet de créer, outre les types d'encaissements courants tels que les paiements par espèce, carte bancaire, chèque ou virement de définir des types de paiements plus spécifiques comme les chèques vacances, les bons de comités d'entreprises, etc.

Aller dans le menu '''Admin > Comptes > Encaissements > Types''' afin d'afficher l'interface tableau de bord (vue synthétique), cette interface permet de visualiser les types d'encaissement créés précédemment. Il est possible d'y effectuer des modifications, notamment pour les actions suivants:

*Supprimer un type d'encaissement existant en cliquant sur le pictogramme symbolisant une poubelle à droite de la ligne du type d'encaissement à supprimer.
*Modifier un type d'encaissement existant en cliquant sur le pictogramme symbolisant un crayon sur la ligne correspondante au type d'encaissement à modifier.
*Créer un nouveau type d'encaissement en cliquant sur le bouton '''Ajouter'''.

L'ajout ou la modification d'un type d'encaissement redirige vers un formulaire contenant les champs suivants:
*'''Type d'encaissement''':
**'''Nom''' : Champ de saisie de texte permet de définir le nom du type d'encaissement (il est interdit de créer deux types d'encaissement avec le même nom).
**'''Intitulé du champ de saisie (vide si pas de champ)''' : champ de saisie de texte permet de définir l'intitulé
**'''Accessible uniquement aux personnes autorisées à saisir pour les tiers'''
*'''Ventilation''':
**'''Compte de trésorerie affecté''' : champ de sélection permet de définir sur quel compte de trésorerie les paiements doivent être affectés au débit en contre partie du crédit sur le compte de l'utilisateur concerné.
**'''Remise à une personne''' : toggle switch permet de rendra actif le champ '''Personne qui reçoit''' lors de [[Utilisation-de-la-comptabilité#Saisir-un-encaissement|la saisie d'un encaissement]] (La liste des utilisateurs apparaissant dans le menu déroulant de ce champ contient les utilisateurs disposant d'un profil ayant le droit [[Gestion-des-profils#Recevoir-de-l'argent|Recevoir de l'argent]]).
*'''Montant minimum''' :
**'''Aucune limite''' : si le toggle switch est activé donc il n'y a aucune limite minimum pour le montant lors de [[Utilisation-de-la-comptabilité#Saisir-un-encaissement|la saisie d'un encaissement]].
**Sinon, Champ de saisie de texte s'affiche pour définir le montant minimum autorisée pour le type d'encaissement lors de [[Utilisation-de-la-comptabilité#Saisir-un-encaissement|la saisie d'un encaissement]].
*'''Montant maximum''' :
**'''Aucune limite''' : si le toggle switch est activé donc il n'y a aucune limite maximum pour le montant lors de [[Utilisation-de-la-comptabilité#Saisir-un-encaissement|la saisie d'un encaissement]].
**Sinon, Champ de saisie de texte s'affiche pour définir le montant maximum autorisée pour le type d'encaissement lors de [[Utilisation-de-la-comptabilité#Saisir-un-encaissement|la saisie d'un encaissement]].

=Spécificités métiers=
==[[Conseils spécifiques pour la comptabilité#Baptêmes_dans_un_aéro-club|Gestion des baptêmes]]==
#Créer un type d'activité "baptême"
#Créer un compte client "Clients extérieurs"
#Créer une règle de tarification concernant le type de vol "baptême" qui va débiter le compte "Clients extérieurs" et créditer le compte du pilote qui effectue le baptême à hauteur du montant du prix du vol en solo
Ainsi :
*le pilote qui effectue le baptême ne sera pas facturé
*le compte client "Clients extérieurs" sera débité du montant du prix du vol "solo"
*le compte produit "heures de vol" sera crédité normalement

Classeur de suivi de maintenance

2024-10-02T17:27:49Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Classeur de suivi de maintenance=
Voir la vidéo [https://www.youtube.com/watch?v=iJJitD7j8Ro Classeur de suivi de maintenance].

Parmi les [[Tableurs|classeurs]] existants, OpenFlyers propose un classeur de suivi de maintenance.

Ce document, contenant les caractéristiques des aéronefs comme les potentiels restants et les butées des actions, est mis à jour en temps réel lors de la saisie ou de la suppression d'un vol sur OpenFlyers.

==Présentation du classeur==
Le classeur est constitué de plusieurs onglets :
*Un onglet appelé [[#Onglet "Vue d'ensemble"|'''Vue d'ensemble''']], récapitulant les informations des aéronefs et les prochaines butées des actions.
*Un onglet [[#Onglets des ressources|'''par ressource''']], contenant les informations détaillées telles que les heures cellules de chaque action, les potentiels et butées associées.
*Un onglet [[#Onglets de l'historique d'une ressource|'''d'historique et de saisie des actions par ressource''']] permettant de suivre les échéances pour chaque action.

[[File:Tableur_suivi_navigabilité_onglets.png]]

Les modifications apportées [[#Règles de modification du document|doivent respecter des règles]], notamment sur les formats de durées et dates, puis sur les droits de modifications de certaines cellules bien précises.

==Onglet "Vue d'ensemble"==
===Présentation de l'onglet général===
[[File:tableur_suivi_navigabilité_vue_d_ensemble.png]]

La vue d'ensemble est automatiquement mise à jour. Les heures cellules totales des aéronefs sont modifiées dès qu'un vol est saisi ou supprimé sur OpenFlyers, ce qui provoque la mise à jour en cascade de toutes les valeurs calculées et affichées.

Sur cet onglet, les cellules correspondant aux '''Heures cellules depuis RG''', '''Heures moteur depuis RG''', '''Heures hélice depuis RG''', '''Potentiel''' (en heures et mois) et à la '''Prochaine action''' (en heures et mois) sont mises à jour automatiquement.

La colonne '''Heures totales''' est mise à jour automatiquement dès qu'un vol est saisi ou supprimé sur la plateforme.

===Lire l'onglet général===
[[File:tableur_suivi_navigabilité_vue_d_ensemble_ex.png]]

Étant donné que cet onglet est géré de manière automatique, il n'y a aucune modification à effectuer.

L'onglet synthétise les informations les plus importantes pour le suivi de maintenance des différentes ressources:
*'''Heures totales''' : C'est cette cellule qui est mise à jour automatiquement par le logiciel OpenFlyers, lors de la saisie ou suppression d'un vol.
*'''Heures depuis RG (Cellule)''' : Cette valeur correspond aux heures totales de la ressource depuis sa Révision Générale (RG). La RG est paramétrée pour [[#Onglets des ressources|correspondre à une visite]] de la ressource, par exemple la visite 2000h.
*'''Heures depuis RG (Moteur)''' : La valeur correspond aux heures totales du moteur depuis sa révision, soit depuis ses [[#Onglets des ressources|'''Heures début travaux''']].
*'''Heures depuis RG (Hélice)''' : Le principe est le même que pour le moteur, la valeur correspond aux heures totales depuis la révision de l'hélice.
*'''Potentiel''' : Le '''Potentiel''' est divisé en deux sous colonnes. Une contenant le potentiel restant en heures, une contenant le potentiel restant en mois. Les potentiels affichés sont ceux de la colonne '''Prochaine action'''.
*'''Prochaine action''' : La '''Prochaine action''', divisée en deux colonnes est un complément de la colonne '''Potentiel'''. Elle contient le nom des deux prochaines actions de la ressource arrivant à échéance, une en heures et une en mois. L'affichage de la '''Prochaine action''' est optimisé quand [[#Onglets de l'historique d'une ressource|l'onglet d'historique est complet]].

Le potentiel affiché change de couleur selon sa valeur :
*Au dessus de 10 heures : <span style="color: green;">'''vert'''</span>
*Entre 10 heures (inclus) et 5 heures (non inclus) : <span style="color: orange;">'''orange'''</span>
*En dessous de 5 heures (inclus) : <span style="color: red;">'''rouge'''</span>

==Onglets des ressources==
[[File:tableur_suivi_navigabilité_ressource.png|800px]]

Chaque ressource suivie dans le classeur est accessible dans son propre onglet qui est paramétrable. Ainsi, pour chaque aéronef dans la vue d'ensemble, un onglet est présent avec le même nom.

La page d'un aéronef contient ses caractéristiques nécessaires pour le suivi : les éléments, visites, potentiels, etc. Ainsi, chaque ligne du tableau correspond à un élément de la ressource qui est suivi.

Tous les éléments devant être suivis doivent être renseignés et correctement paramétrés dans cet onglet. Le paramétrage est nécessaire au bon fonctionnement de [[#Onglets de l'historique d'une ressource|l'onglet d'historique]].

Une fois le paramétrage correctement effectué, l'onglet complètera automatiquement les informations des actions, en allant chercher les bonnes informations [[#Onglets de l'historique d'une ressource|dans l'onglet de l'historique]].

Lors du paramétrage des actions, [[#Ajouter ou supprimer une action|plusieurs champs sont à renseigner]].
===Ajouter ou supprimer une action===
[[File:tableur_suivi_navigabilité_ressource_ex_paramétrage.png]]

Pour gérer les différentes actions, il est nécessaire d'éditer ces colonnes:
*Le '''Type'''
**Pour les visites, la valeur doit être '''Visite'''
**Pour un élément (moteur, hélice, etc), entrer '''Elément'''
**Pour les autres actions, entrer la valeur de votre choix.
*'''Description''' : Le nom et les informations détaillées sur l'action. Par exemple '''Visite 50 heures''', '''Moteur [ref]''', etc
*'''Durée potentielle''' : Si l'élément a une durée potentielle en heure, il faut remplir cette colonne.
*'''Potentiel calendaire en mois''' : Si l'élément a un potentiel calculé en mois, c'est cette colonne qu'il faut renseigner.
*'''Premiers travaux de référence''' : Il s'agit de la date ou des heures cellules des travaux de l'action à utiliser comme référence pour le calcul des valeurs dans [[#Onglets de l'historique d'une ressource|dans l'onglet de l'historique]]. Cette colonne permet de [[#Décalage du programme de maintenance|décaler le programme de maintenance de l'aéronef ('''explications sur l'utilisation du décalage''')]].
**'''Horaire''' : A remplir pour une action avec périodicité horaire. La valeur doit correspondre aux heures cellules quand l'action a été effectuée pour la dernière fois.
***Si le programme de maintenance n'est pas décalé ('''toutes''' les interventions de l'aéronef seront saisies), ne rien remplir
**'''Calendaire''' : Le principe est identique aux premier travaux de référence ayant une périodicité horaire, la '''date''' des derniers travaux doit être indiquée.
***Si le programme de maintenance n'est pas décalé ('''toutes''' les interventions de l'aéronef seront saisies), la '''date de mise en circulation''' de l'aéronef doit être renseignée.
*'''Marge''' : La '''marge''' d'une action permet de calculer [[Maintenance-aéronautique#Schémas-:-calcul-d'échéances|la fenêtre de la butée optimale]]. Pour les actions horaires, la marge doit être en heures. Pour les actions calendaires, elle doit être en mois.

Lors de l'ajout d'un nouvel élément donc d'une nouvelle ligne, il suffit de prendre une ligne vide disponible en bas du tableau et remplir les différentes colonnes citées.

Pour la suppression d'un élément, il suffit simplement de vider les colonnes de paramétrage de l'élément.

'''Attention''' : Après chaque modification d'une action, il faut [[#Modifications des actions d'une ressource et impact sur l'historique|vérifier la cohérence de l'historique]].

===Lire les données d'une action===
[[File:tableur_suivi_navigabilité_ressource_ex_lecture.png]]

Une fois les actions paramétrées, les données se mettent à jour automatiquement en fonction des informations contenues dans [[#Onglets de l'historique d'une ressource|l'historique]].
Par exemple, la ligne d'une '''Visite 50h''' affichera les données de la dernière '''Visite 50h''' effectuée dans [[#Onglets de l'historique d'une ressource|l'historique]], '''sans prendre en compte le fait que [[#Maintenance-aéronautique#Remarques|les visites s'incluent]]'''.

*'''Heures cellules début travaux''' : Le nombre d'heures de la ressource lorsque que l'action a été effectuée.
*'''Date fin travaux''' : Le principe est identique à '''Heures cellules début travaux'''. Cette colonne a pour but de contenir la date lorsque la dernière opération est terminée.
*'''Temps réalisé''' : Il s'agit du temps écoulé depuis les '''Heures cellules début travaux''' d'un élément. Si les potentiels de l'élément sont en durées, le '''Temps réalisé''' est en heures. Si ils sont en mois, la valeur est aussi en mois.
*'''Potentiel restant''' : Le potentiel restant est calculé selon les données précédentes, en heures ou en mois. Il s'agit d'une soustraction entre '''Durée potentielle''' et '''Temps réalisé''' pour les données en heures. Pour les données en mois une soustraction entre la date actuelle et la '''Butée en temps''' est effectuée.
*'''Butée horaire''' : Cette colonne est affichée uniquement si la '''Durée potentielle''' en heures d'un élément est renseignée. Le temps affiché est la quantité totale d'heures cellules de la ressource avant l'échéance de l'élément en prenant en compte la '''Marge horaire''' de l'action afin de construire un intervalle optimal.
*'''Butée en temps''' : Le principe est identique à la '''Butée horaire'''. La colonne est calculée uniquement si le '''Potentiel calendaire en mois''' est renseigné. La valeur affichée est la date d'échéance de l'élément en prenant en compte la '''Marge calendaire''' de l'action.

==Onglets de l'historique d'une ressource==
[[File:Tableur_suivi_navigabilité_historique.png]]

En plus d'un tableau de suivi détaillé, chaque ressource dispose d'un onglet d'historique des actions, nommé '''RESSOURCE - Historique des actions'''.

Dans cet onglet, toutes les actions effectuées sur l'aéronef doivent être saisies. Dès qu'une visite, révision ou autre action est faite, elle doit être ajoutée dans l'onglet afin de mettre à jour [[#Onglets des ressources|l'onglet de suivi détaillé de la ressource]].

Une fois les valeurs saisies [[#Lire les informations de l'action ajoutée|les prochaines butées des actions]] sont estimées et affichées.

===Ajouter une action effectuée===
[[File:Tableur_suivi_navigabilité_historique_ex_paramétrage.png]]

Pour ajouter une nouvelle action qui vient d'être effectuée (par exemple, on vient de faire la '''Visite 100h'''), il faut renseigner ces trois champs dans une nouvelle ligne :
*'''Action''' : il s'agit d'une liste déroulante contenant les '''descriptions''' des actions définies dans [[#Onglets des ressources|l'onglet de suivi détaillé de la ressource]]. Il faut sélectionner l'action à ajouter.
*'''Heures cellules début travaux''' : Les heures cellules lors de la ressource lorsque l'action a été effectuée, le champ est obligatoire si l'action est horaire.
*'''Date fin travaux''' : La date lorsque l'action a été effectuée, le champ est obligatoire si l'action est calendaire

'''Attention :'''
*Les actions doivent être saisies [[#Chronologie de l'historique des actions|dans l'ordre chronologique dans lequel est ont été effectuée]].
*Si [[#Décalage-du-programme-de-maintenance|le programme de maintenance est décalé]], l'historique doit contenir les actions '''suivant ce décalage'''. Par exemple si les '''Travaux de référence''' du '''Moteur''' sont de '''2000h''' (le suivi du moteur démarre à 2000h), l'historique ne doit pas contenir l'entrée du '''Moteur''' avec '''2000h''', il contiendra les intervetion sur le moteur suivantes.

===Lire les informations de l'action ajoutée===
[[File:Tableur_suivi_navigabilité_historique_ex_lecture.png]]

Une fois [[#Ajouter une action effectuée|l'action ajoutée]], les données de l'action sont automatiquement calculées :
*'''Butée horaire théorique''' : Cette colonne, vide si l'action est calendaire, contiendra la '''fourchette de la butée de l'action saisie'''. Autrement dit, pour optimiser le programme de maintenance de l'aéronef, il est préférable que l'action (ses '''Heures cellules début travaux''') soit dans cet intervalle.
*'''Butée calendaire théorique''' : Le principe est le même que la '''Butée horaire théorique''' mais pour les actions calendaires. Il s'agit d'un intervalle de date optimal pour effectuer l'action : il est préférable que la '''Date fin travaux''' appartienne à cet intervalle.
*'''Prochaine butée horaire''' : Il s'agit de la fenêtre optimale de la butée pour la '''prochaine action'''
**Dans le cas d'une visite horaire, une visite se fait toutes les 50 heures. Donc la '''Prochaine butée horaire''' est calculée 50 heures en avance.
*'''Prochaine butée calendaire''' : Le principe est le même que la '''Butée horaire théorique''' mais pour les actions calendaires. Il s'agit d'un intervalle de date optimal pour effectuer l'action.
**Pour les visites calendaires (1 an, 2 ans, etc), la fenêtre est calculée avec un an d'avance, puisqu'une visite calendaire est effectuée tous les ans.

==Règles de modification du document==

===Chronologie de l'historique des actions===
Dans [[#Onglets-de-l'historique-d'une-ressource|l'onglet d'historique des actions]] d'une ressource, il est conseillé de saisir les actions dans leur ordre chronologique afin d'avoir un affichage et un enchaînement des valeurs calculées plus clair.

===Format des dates===
Le classeur est au format Royaume-Unis, ainsi :
*Les durée utilisent le format '''Heures:Minutes:Secondes.Millisecondes'''

===Modifications des actions d'une ressource et impact sur l'historique===
Pour une ressource, son [[#Onglets-de-l'historique-d'une-ressource|onglet d'historique des actions]] est lié au [[#Ajouter-ou-supprimer-une-action|paramétrage des actions dans l'onglet de la ressource]].

Si le paramétrage d'une action est modifié, toutes les entrées correspondant à cette même action dans l'historique seront modifiées. Par exempe si on modifie le paramétrage de la '''Visite 50H''', toutes les '''Visites 50H''' rentrées dans l'historique seront mises à jour.

Lorsque la '''[[#Ajouter-ou-supprimer-une-action|description]]''' d'une action est modifiée, il faut vérifier celles affichées dans [[#Onglets-de-l'historique-d'une-ressource|l'historique d'historique des actions]]. Si la description d'une action ne correspond plus entre ces deux onglets, le lien et les calculs ne peuvent pas être faits correctement.

===Modifications des cellules===
Une partie des cellules sont calculées automatiquement, il n'est pas nécessaire de les modifier.

Les colonnes comportant des cellules modifiables ont une annotation :
*'''"À renseigner"''' lorsque les informations peuvent être modifiées autant de fois que désiré
*'''"À paramétrer"''' lorsqu'une valeur '''définitive''' est attendue

Ainsi, dans la [[#Onglet "Vue d'ensemble"|vue d'ensemble]], aucune colonne n'est à modifier.

Dans [[#Onglets des ressources|les onglets des ressource]], les colonnes '''Description''', '''Durée potentielle''', '''Potentiel calendaire en mois''', '''Premier travaux de référence''' et '''Marge''' doivent être paramétrées de manière définitive pour chaque élément.

Dans l'onglet [[#Onglets de l'historique d'une ressource|'''d'historique et de saisie des actions''']], les colonnes '''Heures cellules début travaux''' et/ou '''Date fin travaux''' doivent être renseignées et peuvent être modifiées par la suite.

==Décalage du programme de maintenance==
Par défaut, le classeur de suivi de maintenance est prévu pour que '''toutes''' les interventions d'un aéronef soient renseignées dans [[#Onglets-de-l'historique-d'une-ressource|l'onglet d'historique de la ressource]] et ce, depuis sa mise en circulation.

Si des interventions ont déjà été effectuées sur l'aéronef quand le classeur est paramétré pour la première fois, ou si les interventions précédentes sont inconnues, il est possible de '''décaler le programme de maintenance'''. De cette manière, on évite de devoir saisir les anciennes actions effectuées.

Pour décaler un programme de maintenance, un paramétrage supplémentaire est nécessaire afin d'optimiser les calculs des butées :
#[[Tableurs#Ouvrir-un-classeur|Se rendre sur le classeur]]
#Aller dans l'onglet de [[#Onglets des ressources|paramétrage du programme de maintenance de la ressource]]
#Renseigner les bonnes valeurs dans la colonne '''Premier travaux de référence (horaire et calendaire)'''

Si le programme de maintenance doit démarrer à un certain instant '''t''', les premiers travaux de référence de chaque action correspondent aux '''heures''' et à la '''date''' auxquels l'action a été effectuée pour la dernière fois quand l'aéronef avait '''t''' heures de vol. Pour les visites, on prend en compte le fait qu'elles [[Maintenance-aéronautique#Remarques|s'incluent]].

Par exemple, un aéronef a déjà 2054h de vol et on veut faire démarrer le programme de maintenance à ce moment :
#La dernière '''Visite 50h''' a été effectuée à 2050h
#La dernière '''Visite 100h''' a été effectuée à 2000h (inclue dans la '''Visite 2000h''')
#La dernière '''Visite 500h''' a été effectuée à 2000h (inclue dans la '''Visite 2000h''')
#La dernière révision du '''Moteur''' était à 2000h
#etc.

Ces valeurs de référence ne prennent pas en compte les marges de tolérance, donc le retard ou l'avance sur l'action. La valeur peut donc être approximative. En reprenant l'exemple précédent :
*Par exemple, la dernière '''Visite 50h''' a été effectuée à 2067h.
*Cette visite aurait dû être effectuée à 2050h, de plus la prochaine est prévue pour 2100h (on additionne les heures lors de la dernière visite plus sa périodicité)
*En mettant 2067h, la prochaine visite serait calculée à 2117h, donc la bonne valeur à renseigner est '''2050h'''.

Attention, pour la saisie de '''toutes''' les visites horaires et calendaires, '''les butées calculées et affichées''' démarrent '''toutes''' de la plus petite visite (habituellement la '''Visite 50h''' et la '''Visite 1 an''') :
*Ainsi, les prochaines butées des visites horaires sont, par exemple, calculées à partir de la '''Visite 50h''' de référence
*Les prochaines butées des visites calendaires sont, par exemple, souvent calculées à partir de la '''Visite 1 an''' de référence

Une fois ces valeurs de référence entrées, [[#Onglets-de-l'historique-d'une-ressource|l'onglet d'historique de la ressource]] peut être complété en indiquant toutes les interventions '''après''' ces valeurs de référence. Par exemple, si la valeur de référence de la '''Visite 50h''' est 2050h, l'historique ne doit pas contenir de valeur pour la '''Visite 50h''' à 2050h. Seulement les '''Visites 50h''' suivantes seront renseignées. Le principe est le même pour les autres visites et toute autre action.

==Utilisation du classeur==
===Paramétrer une action dans le programme de maintenance===
Pour rajouter une action dans le programme de maintenance d'un aéronef, il faut :

#Se rendre sur [[#Onglets-des-ressources|l'onglet du programme de maintenance]]
#Saisir l'action dans une ligne vide
#*'''Type''' :
#**'''Élément''', à choisir pour un moteur ou une hélice
#**'''Visite''', à choisir pour une visite horaire ou calendaire (Visite 50h, Visite 5 ans, etc)
#**Si l'action ne correspond pas aux types au-dessus, il est possible de mettre un type personnalisé complètement arbitraire
#*'''Description''' : l'intitulé de l'action ou une très courte description
#Selon le type de périodicité de l'action
#*Saisir la '''Durée potentielle''' en heure, ou
#*saisir le '''Potentiel calendaire en mois'''
#Si le suivi de l'action doit-être décalé, [[#Décaler le programme de maintenance|saisir des travaux de référence]]
#Selon le type de périodicité de l'action
#*Saisir la '''Marge horaire''' , ou
#*saisir la '''Marge calendaire'''

[[File:tableur_suivi_maintenance_creation_action.png|800px]]

Une fois ces colonnes remplies, l'action est désormais ajoutée au programme de maintenance. Elle sera suivi et prise en compte dans l'historique.

===Saisir une action venant d'être effectuée===
[[#Onglets-des-ressources|L'onglet du programme de maintenance]] d'un aéronef contient ses actions suivies.

Si une action vient d'être effectuée sur l'aéronef, il faut la saisir dans [[#Onglets de l'historique d'une ressource|l'onglet d'historique de la ressource]].

Par exemple, si une '''Visite 100h''' a été effectuée, elle doit être renseignée :
#Se rendre sur [[#Onglets-des-ressources|l'onglet d'historique de la ressource]]
#Saisir l'action dans une ligne vide, '''à la suite des actions précédentes, dans l'ordre chronologique'''
#*Colonne '''Action''' : Un clic affiche toutes les actions paramétrées dans [[#Onglets-des-ressources|l'onglet du programme de maintenance]]. Sélectionner la bonne action.
#Selon le type de périodicité de l'action
#*Saisir les '''Heures cellules début travaux''' au début de l'intervention , ou
#*saisir la '''Data fin travaux''' à la fin de l'intervention

[[File:tableur_suivi_maintenance_saisie_action.png]]

Une fois ces colonnes remplies, l'intervention est prise en compte dans les calculs du suivi de maintenance.

===Décaler le programme de maintenance===
Habituellement, '''toutes les actions effectuées sur un avion depuis sa mise en circulation '''doivent être saisies dans [[#Onglets de l'historique d'une ressource|l'onglet d'historique]]'''.
Si on ne connaît pas l'historique de l'entretien entier d'une ressource, il est nécessaire de décaler le programme de maintenance pour ne pas prendre en compte les actions précédentes qui sont inconnues.

Dans ce cas, il est nécessaire de choisir, pour chaque action (moteur, hélice, visite 50h et autres), des '''travaux de référence''' qui ont deux rôles :
*Décaler l'enchaînement et la saisie des futures actions saisies, en ignorant les visites précédentes inconnues
*Calculer la toute première prochaine butée

Pour ce faire, il faut :
#Se rendre sur [[#Onglets-des-ressources|l'onglet du programme de maintenance]]
#Renseigner les '''Premiers travaux de référence''' :
#*'''Horaire''', à saisir s'il s'agit d'une action horaire, mettre le nombre d'heures de vol qu'avait l'aéronef lors de l'action
#*'''Horaire''', à saisir s'il s'agit d'une action calendaire, mettre la date lorsque l'action a été effectuée

Remarques :
*Les premiers travaux de référence prennent en compte le fait que les [[Maintenance-aéronautique#Remarques|visites s'incluent]] : si on a fait une 100 heures, on considère qu'on a aussi fait une 50 heures
*L'[[#Onglets de l'historique d'une ressource|historique]] ne contient pas les actions correspondant aux travaux de référence, mais contient uniquement les actions '''suivantes''', donc l'action de référence est exclue
*Cependant dans l'[[#Onglets de l'historique d'une ressource|historique]], les calculs des '''visites''' sont continus et se suivent. Toutes les visites '''suivant''' la première occurence de la plus petite doivent être saisies. La première occurrence de la petite visite est exclue.

Désormais, les calculs dans le programme de maintenance prennent en compte les décalages paramétrés.

====Exemple de décalage====
[[File:tableur_suivi_maintenance_décalage_programme_maintenance.png|800px]]

Par exemple, on vient d'acquérir un aéronef qui a 12250 heures de vol. On ne connaît pas l'historique entier des interventions.

Cependant :
*La révision du moteur la plus ancienne qu'on connaît a été effectuée à 12000 heures
*La visite 50 heures la plus ancienne qu'on connaît a été effectuée à 12250 heures
*La visite 100 heures la plus ancienne qu'on connaît a été effectuée à 12200 heures
*etc...

On a donc comme '''travaux de référence''' à renseigner dans le classeur :
*12000 heures pour le moteur
*12250 heures pour la visite 50 heures
*12200 heures pour la visite 100 heures
*etc...

Les toutes premières butées calculées seront donc :
*14000 heures pour le moteur, en supposant que son potentiel est de 2000 heures
*12300 heures pour la visite 50 heures
*12300 heures pour la visite 100 heures
*etc...

[[File:tableur_suivi_maintenance_décalage_historique.png|500px]]

On suppose que l'avion a maintenant 12400 heures de vol. Il y a eu des interventions depuis et on aurait un historique des actions proche de celui-ci :
#Les travaux de référence du moteur correspondent à 12000 heures. L'historique ne doit pas contenir l'entrée '''Moteur à 12000 heures'''. Depuis, il n'y a pas eu de révision, donc il n'y a aucune ligne sur le moteur.
#La première visite 50 heures connue a été effectuée à 12250 heures. Tout comme le moteur, dans l'historique, il ne faut pas la saisir. La valeur de référence est détectée et utilisée en point de départ.
#Cependant, '''toutes les visites suivantes''', y compris les autres visites de référence (ici la 100 heures de référence à 12200 heures qui est surlignée), '''doivent être saisies'''

Champs métiers

2024-10-02T17:27:48Z

Lhenry: Text replacement - "Fichier:" to "File:"

__TOC__

=Présentation=
L'objet de cette page est de présenter les '''champs métiers''' de la [[Accueil|version 4 d'OpenFlyers]].

Le droit [[Gestion-des-profils#Gestion-du-paramétrage|Gestion du paramétrage]] est nécessaire pour accéder à cette page.

=Introduction=
Les champs métiers ont pour vocation de remplacer les champs définis en dur dans les différents modules du logiciel OpenFlyers :
*Imports et synchronisations
*Gestion des ressources
*Gestion des utilisateurs
*Saisie des réservations
*Saisie des activités (saisie des vols par exemple)
*Edition des rapports
*Rapport des mouvements comptables (ou flux) d'un compte et factures

On retrouve ces modules dans la colonne '''Catégorie''' :
*Comptabilité : Cela rajoute une colonne dans les rapports et les factures
*Import : Cela rajoute un champ dans le module d'import
*Rapport : Cela rajoute un champ dans le formulaire d'édition des rapports
*Ressource : Cela rajoute un champ dans le formulaire de gestion de ressource
*Réservation : Cela rajoute un champ dans le formulaire de réservation
*Utilisateur : Cela rajoute une champ dans les fiches utilisateurs
*Activité : Cela rajoute un champ dans le formulaire de saisie des réservations ectèrnes
*Réservation extérieure: Cela rajoutera un champ dans le formulaire de saisie des vols

Ils permettent ainsi une plus grande flexibilité dans la configuration d'OpenFlyers en permettant de créer librement des champs et en permettant de définir qui peut y avoir accès, qui peut en voir le contenu et quelles règles de saisies peuvent être imposées pour chaque champ.

[[#Champs-spécifiques|Certains champs additionnels restent néanmoins liés à des comportements spécifiques du logiciel.]] Leur absence entraine alors une régression des fonctionnalités propres à OpenFlyers.

L'accès à la gestion des champs additionnels se fait depuis '''Admin > Configuration > Champ(s) additionnel(s)''' :
[[File:Extrafield4.png]]

Pour chaque champ, il est possible de définir le [[#Type-de-valeur|type de valeur]]. En fonction du type sélectionné, le champ prendra une forme différente (zone de saisie libre, "combo", etc.)

=Champs spécifiques=

==activityComment==

Le champ métier '''activityComment''' remplace le champ en dur qui permettait de laisser un commentaire sur l'activité.

==airborneTime==

Le champ métier '''airborneTime''' permet de spécifier pour chaque vol le temps passé en l'air cela est utilisé pour [[Interfaçage-OpenFlyers-et-Charterware|l'interfaçage Charterware]].

==aerogligliPilotId==
Le champ métier '''aerogligliPilotId''' permet de coupler les utilisateurs avec [[Interfaçage-Aérogligli|Aérogligli]]. Ce champ est de type '''Chaîne textuelle''' et appartient à la catégorie '''Utilisateur'''.

Ainsi, lorsqu'il est activé, chaque utilisateur verra apparaître dans sa [[Fiche personnelle]] un champ '''Numéro d'utilisateur Aérogligli'''.
Une fois le numéro d'utilisateur aérogligli renseigné, l'utilisateur verra ses [[Interfaçage-Aérogligli|statistiques Aérogligli]] apparaître dans le tableau de bord.

==billingAddress==

Le champ métier '''billingAddress''' est utilisé dans la facturation pour modifier l'adresse de l'utilisateur facturé par l'adresse d'un autre utilisateur.

Pour autoriser cette fonctionnalité, [[Champs-métiers#Introduction|créer le champ métier]] avec :
* '''Nom''' : billingAddress
* '''Intitulé''' : Adresse de facturation
* '''Type de valeur''' : dbObject::Person
* '''Catégorie''' : Utilisateur

Ensuite, procéder à la liaison des utilisateurs :
* Aller '''Gestion > Utilisateurs > Utilisateurs > Actifs'''
* Aller sur la ligne d'un utilisateur et cliquer sur l'icône "Crayon"
* Dans le champ '''Adresse de facturation''', sélectionner un utilisateur dont son adresse sera utilisée pour la facturation
* Cliquer sur le bouton '''Enregistrer'''

==bookingArrivalLocation==

Le champ métier '''bookingArrivalLocation''' de catégorie '''Réservation''' remplace le champ en dur qui permettait de choisir le lieu d'arrivée.

==bookingComment==

Le champ métier '''bookingComment''' remplace le champ en dur qui permettait de laisser un commentaire sur la réservation.

==bookingDepartureLocation==

Le champ métier '''bookingDepartureLocation''' de catégorie '''Réservation''' remplace le champ en dur qui permettait de choisir le lieu de départ.

==bookingEstimatedFlightTime==
Le champ métier '''bookingEstimatedFlightTime''' remplace le champ en dur qui permettait de connaitre la durée du temps de vol prévu. S'il est présent, alors OpenFlyers le renseigne automatiquement lorsqu'il est laissé vide en prenant la moitié de la durée de la réservation.

Ce champ métier permet aussi le calcul du temps prévisionnel qui va s'afficher au niveau du planning, en dessous de chaque réservation.

Il est également possible d'obliger les utilisateurs à renseigner la valeur du champ en cochant la check-box de la colonne '''Remplissage obligatoire'''.

Pour que la valeur contenue dans ce champ soit utilisée pour remplir par défaut le champ '''Durée du vol''' lors de la saisie d'un vol associé à une réservation, il faut :
*Dans la cellule de la colonne '''Catégorie liée''', sélectionner '''Vol'''
*Dans la cellule de la colonne '''Champ à lier''', sélectionner '''Temps de vol'''

==bookingFreeSeats==

Le champ métier '''bookingFreeSeats''' remplace le champ en dur '''Places à disposition''' qui permettait de saisir le nombre de places à disposition.

Valeur par défaut : '''0'''

==charterwareUserId==

Le champ métier '''charterwareUserId''' permet de spécifier pour chaque utilisateur son identifiant Charterware cela est utilisé pour [[Interfaçage-OpenFlyers-et-Charterware|l'interfaçage Charterware]]

==charterwareResourceId==

Le champ métier '''charterwareResourceId''' permet de spécifier pour chaque ressource son identifiant Charterware cela est utilisé pour [[Interfaçage-OpenFlyers-et-Charterware|l'interfaçage Charterware]]

==city==

Le champ métier '''city''' de catégorie '''Ayant comme activité''' permet de définir la ville de [[Utilisation-du-planning-de-réservation#Créer-automatiquement-un-utilisateur-en-créant-une-réservation|de l'utilisateur lors de la création automatique à la réservation]].

==email==

Le champ métier '''email''' de catégorie '''Ayant comme activité''' permet de définir l'email [[Utilisation-du-planning-de-réservation#Créer-automatiquement-un-utilisateur-en-créant-une-réservation|de l'utilisateur lors de la création automatique à la réservation]].

==endDate==

Le champ métier '''endDate''' de catégorie '''Réservation''' permet de définir la date de fin des [[Utilisation-du-planning-de-réservation|réservations sur la nouvelle interface]].

==firstName==

Le champ métier '''firstName''' de catégorie '''Ayant comme activité''' permet de définir le nom de [[Utilisation-du-planning-de-réservation#Créer-automatiquement-un-utilisateur-en-créant-une-réservation|de l'utilisateur lors de la création automatique à la réservation]].

==hardLandingReport==
Le champ métier '''hardLandingReport''' (Rapport d'atterrissage dur) de catégorie '''Vol''' permet de stocker le rapport d'atterrissage dur récupéré de l'[[Interfaçage-OpenFlyers-et-Charterware|interfaçage avec Charterware]].

==keyAuthorization==
Le champ métier '''keyAuthorization''' de catégorie '''Utilisateur''' est utilisé notamment pour certains [[Contrôle-des-accès|contrôles d'accès]] afin de mettre à jour la clé d'accès de chaque utilisateur.

===Mettre à jour les clés d'autorisations des utilisateurs===
Les actions suivantes permettent de mettre à jour les clés de tous les utilisateurs :
*Créer, modifier, supprimer un type de validité
*Modifier les types de validités requises d'un type de ressource

Les actions suivantes permettent de mettre à jour la clé d'un seul utilisateur :
*Ajouter, modifier, supprimer une validité d'un utilisateur
*Créer, modifier, supprimer un vol

==keyPanelUserId==
Le champ métier '''keyPanelUserId''' de catégorie '''Utilisateur''' est utilisé notamment pour certains [[Contrôle-des-accès|contrôles d'accès]] afin d'indiquer le numéro de badge attribué à chaque utilisateur.

Ce champ doit être renseigné pour chaque utilisateur qui dispose d'un badge.

==landingDate==
Le champ métier '''landingDate''' de catégorie '''Vol''' permet de stocker la date d'atterissage récupérée de l'[[Interfaçage-OpenFlyers-et-Charterware|interfaçage avec Charterware]].

==lastName==

Le champ métier '''lastName''' de catégorie '''Ayant comme activité''' permet de définir le nom de [[Utilisation-du-planning-de-réservation#Créer-automatiquement-un-utilisateur-en-créant-une-réservation|de l'utilisateur lors de la création automatique à la réservation]].

==offBlockDate==
Le champ métier '''offBlockDate''' permet de spécifier pour chaque vol une heure off block cela est utilisé pour [[Interfaçage-OpenFlyers-et-Charterware|l'interfaçage Charterware]]

==onBlockDate==
Le champ métier '''onBlockDate''' permet de spécifier pour chaque vol une heure on block cela est utilisé pour [[Interfaçage-OpenFlyers-et-Charterware|l'interfaçage Charterware]]

==phone==

Le champ métier '''phone''' de catégorie '''Ayant comme activité''' permet de définir le téléphone de [[Utilisation-du-planning-de-réservation#Créer-automatiquement-un-utilisateur-en-créant-une-réservation|de l'utilisateur lors de la création automatique à la réservation]].

==spreadsheetResourceCell==
Le champ métier '''spreadsheetResourceCell''' remplace le champ en dur qui permettait de définir, [[Tableurs|pour une feuille de calcul]], la cellule liée à la ressource.

==startDate==

Le champ métier '''startDate''' de catégorie '''Réservation''' permet de définir la date de début des [[Utilisation-du-planning-de-réservation|réservations sur la nouvelle interface]].

==takeoffDate==
Le champ métier '''takeoffDate''' de catégorie '''Vol''' permet de stocker la date de décollage récupérée de l'[[Interfaçage-OpenFlyers-et-Charterware|interfaçage avec Charterware]].

=Type de valeur=

Les types de valeurs proposées sont :
*'''currency''' pour les nombres décimaux positifs (utilisé principalement pour du monétaire)
*'''date''' pour les dates
*'''datetime''' pour les dates avec les heures
*'''decimal''' pour les nombres décimaux
*'''integer''' pour les entiers
*'''formula''' pour les formules
*'''mois''' pour les mois. Seul le module [[Gestion-des-rapports|Edition des rapports]] peut exploiter ce type de valeur.
*'''multiline_string''' pour les chaînes textuelles multi-ligne
*'''sexacentimal''' pour les [[Formules-de-calcul#Définition-Unité-sexacentimal|Sexacentimal]]
*'''time''' pour les heures
*'''unique_integer''' pour les entiers dont les valeurs doivent être uniques
*'''unique_string''' pour les chaînes textuelles dont les valeurs doivent être uniques
*'''string''' pour les chaînes textuelles
*'''year''' pour les années
*[[#dbObject::XXX|'''dbObject::XXX''']] pour un élément de la base de données
*[[#dbObjectMulti::XXX|'''dbObjectMulti::XXX''']] pour plusieurs éléments de la base de données. Seul le module [[Gestion-des-rapports|Edition des rapports]] peut exploiter ce type de valeur.

==dbObject::[[#Liste-des-valeurs-possibles-pour-dbObject-et-dbObjectMulti|XXX]]==

Chaque type '''dbOject''' représentent [[#Liste-des-valeurs-possibles-pour-dbObject-et-dbObjectMulti|une table de la base de donnée]] et retournent les entrées de la table sous forme d'une liste déroulante. Exemple : '''dbObject::Account''' retourne la liste des comptes. Chaque liste déroulante a pour première entrée la valeur ''Pas de filtre''. Il n'est possible de ne sélectionner qu'un élément.

Cas particulier pour le type '''dbObject::Person''', il est possible de filtrer la liste des personnes avec l'identifiant d'un profil. Le logiciel va proposer pour chaque profil un type '''dbObject::Person''', par exemple : '''dbObject::Person::1024''' et qui sera affiché dans le logiciel sous cette forme : '''dbObject::Person (Instructeur)'''.

==dbObjectMulti::[[#Liste-des-valeurs-possibles-pour-dbObject-et-dbObjectMulti|XXX]]==

Chaque type '''dbObjectMulti''' représentent [[#Liste-des-valeurs-possibles-pour-dbObject-et-dbObjectMulti|une table de la base de donnée]] et retournent les entrées de la table sous forme d'une liste de cases à cocher. Exemple : '''dbObjectMulti::Profile''' retourne la liste des profils. Il est possible de sélectionner plusieurs éléments.

==Liste des valeurs possibles pour [[#dbObject::XXX|dbObject]] et [[#dbObjectMulti::XXX|dbObjectMulti]]==
*Account
*AccountEntry
*Accounting
*AccountType
*ActivityType
*BalanceDate
*Booking
*Budget
*BudgetGroup
*BusinessField
*Structure
*Criteria
*ExceptionnalInstDate
*Flight
*FlightHoursPricing
*Location
*Logger
*Nationality
*Parameter
*PaymentDistribution
*PaymentType
*Person
*Profile
*Product
*RegularPresenceInstDate
*Resource
*ResourceType
*SalePricing
*Status
*Stock
*StockLevel
*StockType
*StockVariation
*SupplierBill
*SupplierBillType
*ValidityType
*Variable
*WebFeed
*WebFeedChannel

=Utilisations=
==Ajouter un champ métier==
* Aller Dans '''Structure › Variables › Champs métiers'''
* Renseigner les champs suivants :
** '''Nom du champ''' : un identifiant unique pour le champ.
** '''Intitulé''' : le nom qui apparaîtra dans l'interface utilisateur.
** '''Catégorie''' : représente le module auquel le champ métier peut être amputé.
** '''Type de valeur''' : [[#Type-de-valeur|le type de données]] autorisé.
** '''Formule''' : Si le champ nécessite une valeur calculée, saisir la formule correspondante.
** '''Remplissage obligatoire''' : Cocher cette case si le champ doit être complété par l'utilisateur.
** '''Catégorie liée''' : la catégorie à lier au champ métier.
** '''Champ à lier''' : Ce champ s'affiche automatiquement lorsqu'une catégorie est sélectionnée. Il correspond au champ métier ou original de la catégorie associée, où la valeur saisie par le client externe est enregistrée.
** '''Valeur par défaut''' : Définir une valeur par défaut si applicable.
* Cliquer sur le bouton '''Ajouter'''

==Créer une colonne supplémentaire dans les factures des heures de vols==
Il est possible de créer des colonnes supplémentaires dans les factures des heures de vols grâce aux champs métiers.
*Dans '''Admin > Structure > Variables > Champs métiers''' :
**Créer un nouveau champ métier de catégorie '''Entrée comptable'''
*Dans '''Admin > Ventes > Facturation > Activités''' :
**Modifier une règle de tarification ou en créer une nouvelle (s'il faut créer une règle de tarification spécifique pour obtenir l'information à insérer dans le champ additionnel) et renseigner le champ '''Champ additionnel à lier''' avec le nom du champ métier précédemment créé.
**'''Valider'''.
Ainsi, une nouvelle colonne du nom du champ métier créé sera systématiquement rajoutée dans la facture et contiendra la valeur issue de la règle de tarification qui lui est liée.

==Ordonner les champs métiers==

Pour ordonner les champs métiers il faut utiliser les flèches haut/bas dans la colonne '''Ordonner'''.

A cause de [[Champs-métiers#Champs-spécifiques|champs cachés]], il se peut que vous ne voyez pas de changement lorsque vous cliquez sur une flèche car le changement s'est fait avec l'un de ces champs. Il faut donc recommencer l'opération.

==Récupérer la valeur d'un champ métier dans les règles de tarification des activités==
Il est possible de récupérer la valeur d'un champ métier dans les règles de tarification des activités. Cela permet de modifier par exemple un tarif en fonction de la valeur indiquée dans le champ métier ou d'indiquer une quantité qui influe sur le prix.

Pour cela il faut utiliser la variable [[Formules-de-calcul#.EXTRAFIELDxx|%EXTRAFIELDxx]].

Airmate

2024-10-02T17:27:48Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de regrouper les informations concernant l'outil de préparation des vols [https://airmate.aero Airmate] couplé à OpenFlyers via les items de menu/boutons de préparation de vol. Voir :
*Pour l'interface légère : [[Planning-(interface-légère)#Préparer-un-vol|Planning (interface légère)]]
*Pour l'interface dynamique : [[Utilisation-du-planning-de-réservation#Préparer-un-vol|Utilisation du planning de réservation]]

=Se connecter=
Lorsque l'utilisateur est redirigé sur Airmate sans être précédemment logué, une page de connexion s'affiche. Il faut renseigner l'identifiant Airmate qui a été créé la première fois :
[[File:Identification airmate.png]]

=S'inscrire=
Après avoir cliquer, pour la première fois, sur l'un des liens '''Préparer un vol''' depuis OpenFlyers, l'utilisateur est redirigé sur le site d'airmate où s'affiche un formulaire lui permettant de s'inscrire à partir des informations pré-complétées communiquées par OpenFlyers, à savoir :
*l'adresse email de l'utilisateur enregistré dans OpenFlyers
*Le code OACI de la structure aéronautique de l'utilisateur

L'utilisateur doit renseigner un identifiant, un mot de passe, accepter les conditions d'utilisation et valider le formulaire :

[[File:Interface airmate creation de compte.png]]

Il reçoit un email qui lui permet d'avoir un rappel de son identifiant Airmate.

Ensuite, il doit [[#Se-connecter|se connecter]].

=Synchronisation réservations OpenFlyers / préparation de vols Airmate=
Lorsque l'utilisateur clique sur l'item de menu '''Préparer un vol...''' depuis le menu contextuel qui apparait au survol d'une réservation, il est redirigé sur le site d'Airmate avec une transmission des éléments suivants de la réservation :
*Aérodrome de départ
*Aérodrome d'arrivée
*Date et heure de départ

Ensuite, les éléments du vol sont mémorisés chez Airmate et l'utilisateur peut donc facilement les retrouver pour les compléter ou les modifier juste en survolant la réservation associée dans OpenFlyers et en cliquant sur l'item de menu '''Préparer un vol...'''.

API OpenFlyers

2024-10-02T17:27:47Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de décrire l'API OpenFlyers.

;Description de l'API
OpenFlyers possède une API basée sur [[Wikipedia-en:OAuth#OAuth_2.0|OAuth2]] qui permet à des serveurs extérieurs, dûment [[#Enregistrer-un-client|enregistrés]], de mettre en œuvre un processus d'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]] et/ou de récupération des résultats des requêtes SQL de la [[Bibliothèque-des-rapports|bibliothèque des rapports]] ou des rapports personnalisés sous la forme de fichiers CSV.

OAuth2 propose plusieurs mécanismes pour permettre l'authentification. Un mécanisme d'authentification détermine la séquence exacte des étapes impliquées dans le processus d'authentification d'OAuth2. OpenFlyers met à disposition deux mécanismes d'authentification :
*[[#Authorization Code|Authorization Code]] basé sur la méthode d'authentification par code d'autorisation et qui correspond au mécanisme associé à l'[[Wikipedia-fr:Authentification_unique|authentification unique (SSO)]],
*[[#Client Credentials|Client Credentials]] basé sur la méthode d'authentification avec les identifiants clients et qui est utilisé dans un contexte d'automatisme sans autorisation de l'utilisateur au préalable.

Dans les chapitres qui suivent, le terme ''ressource'' fait référence à la définition OAuth2. Une ressource dans OAuth2 est un élément qui peut être :
*une ou des données comme des photos, des documents, des contacts ou des informations personnelles,
*un ou plusieurs services comme des transferts de fonds, la récupération de rapports ou l'ajout d'articles sur un blog,
*toute ressource nécessitant un accès restreint.

OpenFlyers définit plusieurs [[#Utiliser-l'API|types de ressources]] :
*les [[#Récupérer-les-informations-de-l'utilisateur-connecté|informations de l'utilisateur connecté]],
*les [[#Récupérer les rapports génériques|rapports génériques]] ou [[#Récupérer les rapports personnalisés|personnalisés]] au format CSV.

OAuth2 dispose de ''scopes''. Un scope est un privilège définit de manière explicite permettant l'accès à une ressource protégée. OpenFlyers met à disposition une [[#Liste des scopes disponibles|liste de scopes]] utilisables à travers l'API.

Deux protocoles de sécurité sont présents dans l'API OpenFlyers :
*[[#Authentification-TLS-Mutuelle-(mTLS)|mTLS]] : il permet d'authentifier le client avec un certificat TLS, en plus d'authentifier le serveur avec un certificat. Ce protocole permet d'éviter les usurpations d'identité.
*[[#HTTP-Signature|HTTP-Signature]] : il permet de signer les en-têtes et le corps (lorsqu'il y en a un) des messages échangés afin d'en garantir leur intégrité.

;Premiers pas - Client de démonstration
Un client de démonstration est disponible pour comprendre les mécanismes décrits ci-dessous.

L'utilisation de ce client de démonstration est décrite dans la procédure [[#Utiliser-le-client|Utiliser le client]] de cette page.

Le client de démonstration est lui-même accessible à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le code source du client de démonstration est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

L'utilisation du code source est décrite dans la procédure [[#Créer-un-client-à-partir-du-code-source|Créer un client à partir du code source]].

=Définitions=
==Authentification TLS Mutuelle (mTLS)==
En général dans une communication TLS, seul le serveur a l'obligation de fournir un certificat. Il est également possible pour le client de fournir un certificat. Ce principe s'appelle l'authentification mutuelle et est mise en place avec Mutual TLS (ou [[Wikipedia-en:Mutual_authentication#mTLS|mTLS]]).

OpenFlyers associe un certificat pour l'authentification mutuelle unique à chaque client OAuth2.

;Envoyer un certificat client
Côté client, le code suivant peut être utilisé pour fournir à cURL le certificat et la clé correspondante ainsi que le certificat du CA d'OpenFlyers à utiliser pour la connexion :
<php>curl_setopt_array($request, [
CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
CURLOPT_CAINFO => $caCertificatePath,
CURLOPT_SSLCERT => $certificatePath,
CURLOPT_SSLKEY => $keyPath
]);</php>

'''À noter''' : le certificat du CA d'OpenFlyers est nécessaire pour assurer la validité des certificats utilisés.

==HTTP Signature==
HTTP Signature utilise le principe de la signature numérique pour garantir l'authenticité et l'intégrité du message HTTP.

La signature est générée à l'aide d'une clé privée et vérifiée à l'aide de la clé publique correspondante ou d'un certificat contenant cette clé publique.

HTTP Signature utilise deux en-têtes HTTP :
*Signature : contient la signature et ses métadonnées.
*Digest : contient le corps du message haché.

===Digest===
Le ''digest'' est calculé comme ceci : <code>digest = base64encode(sha256(corps du message))</code>

Et l'en-tête est structuré de la manière suivante : <code>Digest: SHA-256=<digest></code>

Un autre algorithme de hachage peut être utilisé, SHA-256 reste cependant le plus répendu.

;Exemple en php
<php>$digestHeader = 'Digest: SHA-256=' . base64_encode(hash('sha256', $postData, true));</php>

===Signature===
L'en-tête HTTP de signature est structuré de la manière suivante : <code>Signature: keyId="<keyId>",algorithm="<algo>",headers="<signed_headers>",signature="<signature>"</code>

Le champ ''keyId'' correspond à un identifiant permettant l'identification de la clé utilisée pour vérifier la signature. Pour l'API d'OpenFlyers, sa valeur correspond à l'empreinte SHA-1 du certificat au format PEM à utiliser pour vérifier la signature.

L'algorithme ''algo'' correspond à celui utilisé pour générer la signature, exemple : <code>rsa-sha256</code>.

La valeur de ''signed_headers'' correspond à la liste des en-têtes inclus dans la signature séparés d'un espace. Exemple : <code>date digest (request-target)</code>

Pour générer la signature, une chaîne de caractères appelée <code>signing string</code> contenant les en-têtes au format <code>lowercase_header_name: value</code> séparés par une nouvelle ligne au format LF (<code>\n</code>) est d'abord générée. Exemple avec les en-têtes "date" et "(request-target)" :

<pre>(request-target): post /some/uri\ndate: Tue, 07 Jun 2014 20:51:35 GMT</pre>

La signature est ensuite générée comme ceci : <code>base64encode(algo(signing string))</code>

;Exemple en php
<php>function generateSignatureHeader(array $headersToSign, string $certificateFingerprint, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}

// trim extra whitespace
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, $privateKey, 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "Signature: keyId=\"$certificateFingerprint\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}</php>
Les variables ''$certificateFingerprint'' et ''$privateKey'' correspondent respectivement à une empreinte SHA-1 de certificat et à une clé privée, tous deux au format PEM.

La variable ''$headersToSign'' est un tableau formaté de la manière suivante :
<php>[
$headerName => $headerValue,
...
]</php>

'''À noter''' : les en-têtes sont à signer côté client avec le certificat de signature signé par le CA d'OpenFlyers et dédié au client ainsi que la clé privée associée. Le certificat de signature dédié au client est téléchargeable depuis l'interface de gestion des clients OAuth2. Les en-têtes de la réponse du serveur quant à elles doivent être vérifiées avec le certificat de signature HTTP du serveur, téléchargeable aussi depuis l'interface de configuration des clients OAuth2.

=Client OAuth2=
Une fois le client OAuth2 configuré sur OpenFlyers, il faut l'utiliser avec un client créé au préalable pour communiquer avec le serveur d'autorisation et l'API.

Plusieurs [https://oauth.net/code/ bibliothèques] simplifiant la création d'un client sont disponibles.

Des scripts client basiques écrits en php sont aussi fournis pour les mécanismes [[#Script-client-:-authorization-code|''authorization_code'']] et [[#Script-client-:-client-credentials|''client_credentials'']]

==Authorization Code==
Ce flux OAuth2 se déroule en plusieurs étapes :
*Le client redirige le navigateur de l'utilisateur vers l'URL d'autorisation.
*Le navigateur de l'utilisateur est redirigé vers l'URL fourni durant la demande ou durant l'enregistrement du client.
*Le client récupère un code d'autorisation grâce à la redirection précédente, et échange ce code contre un jeton d'accès auprès du serveur d'autorisation.
*Le client peut utiliser ce code d'accès :
**Comme preuve d'authentification pour une solution SSO (Single Sign-On).
**Pour accéder à des données sur le serveur distant en utilisant l'API.

+-----------+ +------+ +-----------+ +-------------+ +-----------+
|Utilisateur| |Client| |Navigateur | | Serveur | | Serveur |
+-----+-----+ +--+---+ +-----+-----+ |Autorisation | | Ressources|
| | | +------+------+ +-----+-----+
| | | | |
| | Demande|d'autorisation | |
| +------------------------->+------------------------------>| |
| | | | |
| |Authentification + Formulaire d'autorisation | |
|<---------------------------+--------------------------+<------------------------------+ |
| | | | |
| | Autorisation | | |
+----------------------------+------------------------->+------------------------------>| |
| | | | |
| | Code|d'autorisation | |
| |<-------------------------+<------------------------------+ |
| | | | |
| | Demande de|token | |
| +--------------------------+------------------------------>| |
| | | | |
| | Access (+|Refresh) token | |
| |<-------------------------+-------------------------------+ |
| | | | |
| | | Requête vers API | |
| +--------------------------+-------------------------------+------------------------------>|
| | | | |
| | | | |
| | | |<------------------------------+
| | | | Vérification d'autorisation |
| | | +------------------------------>|
| | | | |
| | | Données/Réponse | |
| |<-------------------------+-------------------------------+-------------------------------+
| | | | |

===Générer les codes pour PKCE===
Pour faire fonctionner le client OAuth2, il faut générer deux codes pour l'extension PKCE :
*Un ''code_verifier'' échangé pendant la demande de jeton d'accès.
*Un ''code_challenge'' dérivé du ''code_verifier'' et échangé pendant la demande d'autorisation.

;Générer le ''code_verifier''
<php>function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}</php>

Cette fonction permet de générer un ''code_verifier'' avec une longueur donnée. Le ''code_verifier'' doit avoir une longueur entre 43 et 128 caractères.

;Générer le ''code_challenge''
<php>function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}</php>

Cette fonction génère le ''code_challenge'' à partir du ''code_verifier'' fourni.

===Demande d'autorisation===
Pour initier la demande d'autorisation, rediriger le navigateur de l'utilisateur vers l'URL : <code>GET https://openflyers.com/nom-de-plateforme/oauth/authorize.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également les paramètres suivants :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|response_type||string||Le type de réponse envoyée par le serveur. Doit utiliser la valeur "code" (sans guillements) pour ce mécanisme.
|-
|redirect_uri||string||L'URI (ou l'URL) fourni pendant l'enregistrement du client et vers lequel l'utilisateur est redirigé après la demande d'autorisation.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparés par des espaces.
|-
|state||string||Chaîne de caractère aléatoire utilisée pour éviter les [https://fr.wikipedia.org/wiki/Cross-site_request_forgery attaques CSRF]. '''Fortement recommandé'''.
|-
|code_challenge||string||Code nécessaire pour le fonctionnement de l'extension [[#Générer-les-codes-pour-PKCE|PKCE]].
|-
|code_challenge_method||string||Méthode utilisée pour générer le ''code_challenge''. Ici, la valeur est "S256".
|}

===Demande de jeton d'accès===
Après avoir répondu à la demande, l'utilisateur est redirigé vers l'URI fourni pendant l'enregistrement du client. Si la demande est acceptée, un code temporaire : ''code'' est fourni, ainsi que le paramètre ''state'' fourni pendant la demande avec la même valeur. Si la demande est refusée, un code d'erreur est renvoyé.
;Si le paramètre ''state'' a une valeur différente de celle envoyée avec la demande, c'est peut-être une tentative d'attaque et il faut refuser la réponse.

Echanger ce ''code'' contre un jeton d'accès via l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont également nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|code||string||Le code temporaire reçu dans la réponse à la demande d'autorisation.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, sa valeur doit être ''authorization_code''
|-
|redirect_uri||string||L'URI (ou l'URL) de redirection fourni pendant l'enregistrement du client.
|-
|code_verifier||string||Le ''code_verifier'' utilisé pour générer le ''code_challenge'' de la demande d'autorisation.
|}

Si la requête est correcte, un jeton d'accès (Access Token) ainsi qu'un jeton de rafraîchissement (Refresh Token) sont fournis en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

===Script client : Authorization Code===
Voici un exemple simple de client OAuth2 pour le mécanisme d'authentification par code d'autorisation (Authorization Code).

Fichier de configuration ''config.authcode.json'' :
<javascript>{
"client_id": "",
"client_secret": "",
"authorize_uri": "https://openflyers.com/nom-de-plateforme/oauth/authorize.php",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/AuthCodeDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/AuthCodeDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script PHP :
<php><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.authcode.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the Authorization Server and the Resource Server
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $refresh = false, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
// required when a refresh token request is issued
// because there is only one header in the response
// while there are two for regular auth requests
if (!$refresh) {
list($firstResponseHeaders, $secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 3);
if (!$responseBody) {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}
} else {
list($secondResponseHeaders, $responseBody) = explode("\r\n\r\n", $response, 2);
}

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $secondResponseHeaders);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function takes a code_verifier and outputs the corresponding code_challenge
*
* @param string $codeVerifier the generated code_verifier
*
* @return string the computed code_challenge
*/
function computeCodeChallenge(string $codeVerifier): string
{
return strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_');
}

/**
* This function takes an optional string length and outputs a random code_verifier string
*
* @param int $length the length of the output code_verifier. Default = 128
*
* @return string the code_verifier
* @throws Exception
*/
function generateCodeVerifier($length = 128): string
{
$characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~';
$outputCode = '';

for ($i = 0; $i < $length; $i++) {
$index = random_int(0, strlen($characters) - 1);
$outputCode .= $characters[$index];
}

return $outputCode;
}

/**
* This function calculates the entropy of a given string
*
* @param string $string the string for which to calculate the entropy
* @param string $charset a string with all the usable characters. Default = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~
*
* @return float|int
*/
function computeEntropy(string $string, string $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~')
{
$chars = str_split($charset);
$probs = [];

foreach ($chars as $char) {
$probs[$char] = floatval(substr_count($string, $char)) / strlen($string);
}

$sum = 0.0;
foreach ($probs as $prob) {
$sum += $prob != 0 ? $prob * log($prob, 2) : 0.0;
}

return -$sum;
}

/**
* This function calculates the ideal (maximum) entropy for a string of a given length
*
* @param int $length length of the string. Default = 128
*
* @return float|int
*/
function idealEntropy(int $length = 128)
{
$prob = 1.0 / $length;

return -1.0 * $length * $prob * log($prob, 2);
}

/**
* This function is used to initiate the authentication code flow.
*
* @param string $clientID the client's ID
* @param string $redirectURL the URL where to redirect after auth
* @param string $authorizeURL the target URL to request authorization
*
* @throws Exception
*/
function login(string $clientID, string $redirectURL, string $authorizeURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

// This unguessable string is used to prevent csrf attacks
$_SESSION['state'] = bin2hex(random_bytes(16));

// Generate code_verifier and code_challenge for PKCE
$_SESSION['code_verifier'] = generateCodeVerifier();
$_SESSION['code_challenge'] = computeCodeChallenge($_SESSION['code_verifier']);

// required parameters for the redirection, redirect_uri is where the browser should be redirected
// when the user grants (or denies) access, scope are the authorizations (rights) requested
$params = [
'response_type' => 'code',
'client_id' => $clientID,
'redirect_uri' => $redirectURL,
'scope' => 'default.login',
'state' => $_SESSION['state'],
'code_challenge' => $_SESSION['code_challenge'],
'code_challenge_method' => 'S256'
];

// redirecting the browser to the AS authorization endpoint to obtain the authorization code
header('Location: ' . $authorizeURL . '?' . http_build_query($params));
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
// Building query array for resource dumping
$repoQueryParameters = [
'resource_type' => 'user_information',
'client_id' => $config['client_id']
];
switch ($_POST['action']) {
case 'login':
login($config['client_id'], $baseURL, $config['authorize_uri']);
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server to retreive user information
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Displaying user information
echo '<pre>';
echo $resourceBody;
echo '</pre>';

// Automatic refreshing token once access token is expired
if (strpos($firstHeaderLine, "401")) {
$errorBody = json_decode($resourceBody, true);
if ($errorBody['error'] == 'access_denied' && isset($errorBody['hint'])) {
if ($errorBody['hint'] == 'Access token could not be verified') {
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'refresh_token',
'refresh_token' => $localToken['refresh_token'],
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret']
],
false,
true,
true
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
}
}
}
}
break;
}
}

// Once the browser has been redirected to the AS to ask for the user's authorization, assuming it has been granted,
// the browser will get back here with a "code" parameter in the query string
if (isset($_GET['code'])) {
// The AS MUST redirect the browser here with the exact same state parameter we sent it before, so we check if it is indeed the same
// to detect if the oauth flow has been tampered with
if (!isset($_GET['state']) || $_SESSION['state'] != $_GET['state']) {
header('Location: ' . $baseURL . '?error=invalid_state');
die();
}

// We communicate directly with the AS to exchange the code received against an access token.
// The id/secret pair is send to authenticate the client, the redirect_uri is sent to verify the code's validity
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'authorization_code',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'redirect_uri' => $baseURL,
'code' => $_GET['code'],
'code_verifier' => $_SESSION['code_verifier']
]
);

// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
die();
}</php>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme afin de tester l'implémentation d'un serveur et n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Client Credentials==
Ce mécanisme d'autorisation est adapté pour l'automatisation. Il fonctionne de la manière suivante :
*Le client effectue la demande de jeton d'accès au serveur d'autorisation en fournissant ses identifiants.
*Le serveur authentifie le client avec les identifiants fournis et renvoie un jeton d'accès.
*Le client utilise ce jeton d'accès pour accéder à des données via l'API.

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Demande token | |
+--------------------------------->| |
| | |
| Access token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de jeton d'accès===
Pour obtenir un jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être ''client_credentials''.
|-
|scope||string||[[#Liste-des-scopes-disponibles|Liste des droits demandés par le client]], séparé par des espaces.
|}

;Ce mécanisme a la particularité de ne pas nécessiter d'URI de redirection, il n'est donc pas utile d'en renseigner un lors de l'enregistrement d'un client.

Si la requête est correcte, un jeton d'accès (Access Token) est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw"
}</javascript>

===Script client : Client Credentials===
Voici un exemple simple d'un client OAuth2 pour le mécanisme d'authentification par les identifiants client (Client Credentials).

Fichier de configuration ''config.clientcred.json'' :
<javascript>{
"client_id": "",
"client_secret": "",
"token_uri": "https://openflyers.com/nom-de-plateforme/oauth/access_token.php",
"resource_uri": "https://openflyers.com/nom-de-plateforme/oauth/resources.php",
"revoke_uri": "https://openflyers.com/nom-de-plateforme/oauth/revoke.php",
"auth_cert": "/path/to/client/auth_cert.crt",
"auth_key": "/path/to/client/auth.key",
"sign_cert": "/path/to/client/sign_cert.crt",
"sign_key": "/path/to/client/sign.key",
"auth_cacert": "/path/to/ca.crt",
"sign_cert_server": "/path/to/server/sign_cert_server.crt"
}</javascript>
Où <code>/path/to/client/</code> est le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
*Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/ssl/ClientCredDemo/</code>.
*Exemple sur un serveur Linux '''debian''': <code>./ssl/ClientCredDemo/</code>.

Ce fichier de configuration doit se situer au même niveau que le script PHP dans le système de fichiers.

Script php :
<php><?php
$localTokenFile = 'token.json';
// create token file if it does not exist
if (!file_exists($localTokenFile))
file_put_contents($localTokenFile, '');

$config = json_decode(file_get_contents('config.clientcred.json'), true);
$localToken = json_decode(file_get_contents($localTokenFile), true);
$GLOBALS['config'] = $config;

// Build the baseURL, accounting for protocol, port, name and endpoint. Used for redirection
$protocol = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
$port = ($protocol == 'https://' && $_SERVER['SERVER_PORT'] == 443)
|| ($protocol == 'http://' && $_SERVER['SERVER_PORT'] == 80) ? '' : ':' . $_SERVER['SERVER_PORT'];

$baseURL = $protocol . $_SERVER['SERVER_NAME'] . $port . $_SERVER['PHP_SELF'];
$errorLog = 'error_log.log';
$responseLog = 'response_log.log';
$GLOBALS['baseURL'] = $baseURL;

$replacementListItems = [
1 => "year",
2 => "validityTypeId",
3 => "icao",
4 => "profileId",
7 => "accountingId",
8 => "paymentType",
9 => "startDate",
10 => "endDate",
11 => "occupiedSeat",
12 => "date",
13 => "activityTypeId",
14 => "age",
15 => "resourceId",
16 => "personId",
17 => "accountId",
20 => "rightPlacePersonId",
21 => "month",
22 => "numberMonth",
23 => "oneValidityTypeId",
];

//Session cookies are used to store information necessary for the authorization code flow
session_start();

/**
* This function is used to make api calls to the RS
*
* @param $url
* @param $post
* @param array $headers
*
* @return mixed
*/
function apiRequest($url, $post = null, $token = false, $auth = true, $headers = array())
{
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HEADER, true);

$method = 'get';

if ($post) {
$method = 'post';
$postData = http_build_query($post);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);

$headersToSign['Content-Type'] = 'application/x-www-form-urlencoded';
$headersToSign['digest'] = 'SHA-256=' . base64_encode(hash('sha256', $postData, true));
}

$urlComponents = parse_url($url);

$headersToSign['(request-target)'] = $method . ' ' . $urlComponents['path'];
$headersToSign['Host'] = $urlComponents['host'];
$headersToSign['Date'] = gmdate('D, j M Y H:i:s T');

// generating the signature header
$keyId = openssl_x509_fingerprint(file_get_contents($GLOBALS['config']['sign_cert']));
$privateKey = file_get_contents($GLOBALS['config']['sign_key']);
$headers['Signature'] = generateSignatureHeader($headersToSign, $keyId, $privateKey);

$headers['Accept'] = 'application/json';
$headers['User-Agent'] = $GLOBALS['baseURL'];
unset($headersToSign['(request-target)']);
$headers += $headersToSign;

if ($token) {
$headers['Authorization'] = $token['token_type'] . ' ' . $token['access_token'];
}

// formatting the headers
$httpFormattedHeaders = [];
foreach ($headers as $key => $value) {
$httpFormattedHeaders[] = trim($key) . ': ' . trim($value);
}

curl_setopt($ch, CURLOPT_HTTPHEADER, $httpFormattedHeaders);
curl_setopt($ch, CURLINFO_HEADER_OUT, true);

// for development environment only
//curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
//curl_setopt($ch, CURLOPT_VERBOSE, true);

// defining TLS client certificates for Mutual TLS
curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
curl_setopt($ch, CURLOPT_CAINFO, $GLOBALS['config']['auth_cacert']);
curl_setopt($ch, CURLOPT_SSLCERT, $GLOBALS['config']['auth_cert']);
curl_setopt($ch, CURLOPT_SSLKEY, $GLOBALS['config']['auth_key']);

$response = curl_exec($ch);

// logging errors and responses
errorLog(true, $response, $ch);

curl_close($ch);

// in case an authentication request is executed
if ($auth) {
list($responseHeader, $responseBody) = explode("\r\n\r\n", $response, 2);

$responseHeadersDigest = '';
$responseHeadersSignature = '';
// extracting digest and signature from headers
$responseHeadersArray = explode("\r\n", $responseHeader);
$responseProtocol = array_shift($responseHeadersArray);

foreach ($responseHeadersArray as $value) {
list($responseHeadersKeys, $responseHeadersValue) = explode(": ", $value, 2);
$responseHeaders[strtolower($responseHeadersKeys)] = $responseHeadersValue;
}

$responseDigestAlgo = '';
$responseDigestKey = '';
foreach ($responseHeaders as $key => $value) {
if ($key === "digest") {
$responseHeadersDigest = $value;
// stripping SHA algorithm for later comparison
list($responseDigestAlgo, $responseDigestKey) = explode("=", $responseHeadersDigest, 2);
} else if ($key === "signature")
$responseHeadersSignature = $value;
}

// calculating response digest
$responseDigest = base64_encode(hash(strtolower(str_replace("-", "", $responseDigestAlgo)), $responseBody, true));

// checking digest validity
if ($responseDigest !== $responseDigestKey) {
errorLog(false, false, "Digests are not the same");
die();
}

// extracting variables from signature header
$signatureArray = explode(",", $responseHeadersSignature);
foreach ($signatureArray as $value) {
list($signatureKey, $signatureValue) = explode("=", $value, 2);
$signature[$signatureKey] = trim($signatureValue, '"');
}

// generating siging string
$signingStringArray = explode(" ", $signature['headers']);
$signingString = '';
foreach ($signingStringArray as $value) {
$signingString = $signingString . trim($value) . ": " . trim($responseHeaders[$value]) . "\n";
}

// trimming last '\n' character
$signingString = trim($signingString);

// decoding signature
$decodedSignature = base64_decode($signature['signature']);

// verifying signature
$signatureVerify = openssl_verify($signingString, $decodedSignature, openssl_get_publickey(file_get_contents($GLOBALS['config']['sign_cert_server'])), 'RSA-SHA256');

if (!$signatureVerify) {
errorLog(false, false, "Signature is not correct");
while (($err = openssl_error_string()))
errorLog(false, false, $err);
die();
}

return json_decode($responseBody, true);
}

return $response;
}

/**
* This function logs curl responses and errors in text files
*
* @param mixed $response the response
* @param mixed $request the request handle, used to get errors
*/
function errorLog($curl, $response, $request = false)
{
$timestamp = '[' . date('Y-m-d H:i:s') . ']:';
global $errorLog;
global $responseLog;

if ($response === false) {
if ($curl)
file_put_contents($errorLog, $timestamp . curl_error($request) . "\n", FILE_APPEND);
else
file_put_contents($errorLog, $timestamp . $request . "\n", FILE_APPEND);
} else {
file_put_contents($responseLog, $timestamp . "\n" . $response . "\n", FILE_APPEND);
}
}

/**
* This function generates the full signature header line from a set of headers, a certificate and the linked private key
*
* @param array $headersToSign the headers to sign, in the $key => $value format
* @param string $certificate the certificate linked to the used private key
* @param string $privateKey the private key used to sign the headers
*
* @return string the full signature header line
*/
function generateSignatureHeader(array $headersToSign, string $certificate, string $privateKey): string
{
// generating the signing string and header list
$headers = '';
$signatureString = '';
foreach ($headersToSign as $key => $value) {
$normalizedHeaderKey = trim(strtolower($key));
$headers .= $normalizedHeaderKey . ' ';
$signatureString .= $normalizedHeaderKey . ': ' . trim($value) . "\n";
}
$headers = trim($headers);
$signatureString = trim($signatureString);

// signing the signing string
$signature = '';
openssl_sign($signatureString, $signature, openssl_get_privatekey($privateKey), 'RSA-SHA256');
$signature = base64_encode($signature);

// compiling the header line
return "keyId=\"$certificate\",algorithm=\"rsa-sha256\",headers=\"$headers\",signature=\"$signature\"";
}

/**
* This function deletes the access token from the session
*
* @param string $baseURL
*/
function logout(string $baseURL): void
{
global $localTokenFile;
file_put_contents($localTokenFile, '');

header('Location: ' . $baseURL);
}

function displayMenuLoggedIn(): void
{
global $replacementListItems;
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Logged In</h3>';

echo '<form id="view_repos" method="post">';
echo '<label for="report_id">Report ID: </label>';
echo '<input type="number" id="report_id" name="report_id"><br><br>';
foreach ($replacementListItems as $value) {
echo '<label for="' . $value . '">' . $value . ': </label>';
echo '<input type="text" id="' . $value . '" name="' . $value . '"><br><br>';
}
echo '<input type="hidden" id="action" name="action" value="view">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'view_repos\').submit(); return false;">View Repos</a></p>';
echo '</form>';

echo '<form id="logout" method="post">';
echo '<input type="hidden" id="action" name="action" value="logout">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'logout\').submit(); return false;">Log Out</a></p>';
echo '</form>';
}

function displayMenuLoggedOut(): void
{
echo '<h2><a href="/">Home</a></h2>';
echo '<h3>Not logged in</h3>';
echo '<form id="login" method="post">';
echo '<input type="hidden" id="action" name="action" value="login">';
echo '<p><a href="javascript:{}" onclick="document.getElementById(\'login\').submit(); return false;">Log In</a></p>';
echo '</form>';
}

// display client "home" page
if (!isset($_POST['action'])) {
if (!empty($localToken['access_token'])) {
displayMenuLoggedIn();
} else {
displayMenuLoggedOut();
}
}

if (isset($_POST['action'])) {
$replacementList = [];
// Building replacement list
foreach ($replacementListItems as $key => $value) {
$replacementList[$value] = (isset($_POST[$value]) && strlen($_POST[$value]) > 0) ? $_POST[$value] : null;
}
// Building query array
$repoQueryParameters = [
'resource_type' => 'generic_report',
'client_id' => $config['client_id'],
'report_id' => (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0) ? $_POST['report_id'] : null,
'replacementList' => $replacementList
];
switch ($_POST['action']) {
case 'login':
$token = apiRequest(
$config['token_uri'],
[
'grant_type' => 'client_credentials',
'client_id' => $config['client_id'],
'client_secret' => empty($config['client_secret']) ? null : $config['client_secret'],
'scope' => 'genericreports.readonly reports.readonly'
]
);
// We store the access token in the session so the user is "connected"
// Only if the request has been successfully executed
if (isset($token['access_token'])) {
file_put_contents($localTokenFile, json_encode($token, true));

// Redirecting the user's browser to the "home" page
header('Location: ' . $baseURL);
} else {
echo $token;
}
break;
case 'logout':
logout($baseURL);
break;
case 'view':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);

$resourceHeaders = explode("\r\n", $resourceHeader);
$firstHeaderLine = array_shift($resourceHeaders);

// Building form for download CSV button
echo '<form method="post">';
foreach ($_POST as $key => $value) {
if ($key == "action") {
$value = "download";
}
echo '<input type="hidden" id="' . $key . '" name="' . $key . '" value="' . $value . '">';
}
if (isset($_POST['report_id']) && strlen($_POST['report_id']) > 0 && !isset(json_decode($resourceBody, true)['error'])) {
echo '<button>Download as CSV</button>';
}
echo '</form>';

// Displaying requested content
echo '<pre>';
echo (strpos($firstHeaderLine, "200")) ? json_decode($resourceBody) : $resourceBody;
echo '</pre>';
break;
case 'download':
// call to the resource server
$resources = apiRequest(
$config['resource_uri'],
$repoQueryParameters,
$localToken,
false
);

// Separating headers from body
list($resourceHeader, $resourceBody) = explode("\r\n\r\n", $resources, 2);
$resourceHeaders = explode("\r\n", $resourceHeader);
array_shift($resourceHeaders);

// Dumping headers to insert them in current page
foreach ($resourceHeaders as $key => $value) {
header($value);
}
echo json_decode($resourceBody);
break;
}
}</php>

;Ce script a été conçu pour montrer le fonctionnement du mécanisme et tester l'implémentation d'un serveur, il n'a pas été testé extensivement. Il est conseillé d'utiliser une solution adaptée à un environnement de production.

==Refresh Token==
Refresh Token (ou jeton de rafraîchissement en français) est un mécanisme d'autorisation particulier. Il ne peut fonctionner en tant que tel, il fonctionne de pair avec [[#Authorization-Code|Authorization Code]]. Lorsqu'un jeton d'accès arrive est arrivé en fin de vie, si le client y est autorisé, il peut faire une demande de renouvellement de son jeton d'accès auprès du serveur d'autorisation en présentant son jeton de rafraîchissement. Le serveur d'autorisation vérifie la validité et génère un autre jeton d'accès qu'il transmet au client, sans que l'utilisateur final n'aît à se connecter de nouveau.

Le principe de fonctionnement du rafraîchissement d'un jeton est le suivant :
* Le jeton d'accès du client est arrivé à péremption. Le client effectue une demande de renouvellement en transmettant son Refresh Token au serveur d'autorisation.
* Le serveur d'autorisation vérifie la validité des informations, "consomme" le jeton de rafraîchissement et génère une nouvelle paire de jetons
* Le client reçoit sa nouvelle paire et utilise le nouveau jeton d'accès pour accéder aux ressources

+------+ +-------------+ +-----------+
|Client| | Serveur | | Serveur |
+--+---+ |Autorisation | | Ressources|
| +------+------+ +-----+-----+
| Authentification | |
| + Refresh Token | |
+--------------------------------->| |
| | |
| Access (+ Refresh) token | |
|<---------------------------------+ |
| | |
| Requête vers|API |
+----------------------------------+------------------------------>|
| | |
| | |
| |<------------------------------+
| | Vérification d'autorisation |
| +------------------------------>|
| | |
| Données /|Réponse |
|<---------------------------------+-------------------------------+
| | |

===Demande de renouvellement d'un jeton===
Pour obtenir un renouvellement de jeton d'accès, il faut effectuer la requête suivante : <code>POST https://openflyers.com/nom-de-plateforme/oauth/access_token.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Les paramètres suivants sont nécessaires :
{| class="wikitable"
!Nom!!Type!!Description
|-
|client_id||string||L'identifiant ''client_id'' reçu pendant l'enregistrement du client.
|-
|client_secret||string||La passphrase ''client_secret'' reçue pendant l'enregistrement du client.
|-
|grant_type||string||Le mécanisme d'autorisation utilisé. Ici, la valeur doit être "refresh_token" (sans guillements).
|-
|scope||string||('''OPTIONNEL''') Liste des droits demandés par le client, séparés par des espaces.
|}

Si la requête est correcte, un jeton d'accès ''access_token'' est fourni en réponse dans un objet au format JSON.
<javascript>{
"token_type": "Bearer",
"expires_in": 3600,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSU-G7fOBOYzOgioSGNIQKI2A2OxjsNBbOOoaHsqNpsQxWZse3rofExAaGKh2tXbeuz1YAVhdLUGYgq-oKRK4ONFhw2NvcRf3QPxQXZImLWw",
"refresh_token": "a59ef39fa9bab9b95cd554f921e7f3080a34c90f23d2b8031d692b5ff2d0993dcc392d9c7f9a43242337ef144c1a5fe1d0174413ade973e1b628ac0bbfc39b23973534"
}</javascript>

==Liste des scopes disponibles==
Un scope sur OAuth2 correspond à un droit d'accès sur une ressource particulière. Chaque scope est unique et indique de manière explicite le privilège qu'il donne. Il n'y a aucune restriction d'utilisation des scopes par rapport aux mécanismes. Chaque scope peut être utilisé avec n'importe quel mécanisme. Il n'y a que des recommandations vis à vis de leur utilisation. OpenFlyers définit une liste de scopes dédiée aux ressources accessibles par les clients. Ces scopes sont les suivants :
{| class="wikitable"
!Nom!!Description
|-
|default.login||Comportement par défaut lorsqu'aucun scope n'est précisé ou qu'un scope est invalide. Ce scope est recommandé pour '''Authorization Code'''.
|-
|genericreports.readonly||Accéder aux rapports génériques autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|-
|reports.readonly||Accéder aux rapports personnalisés autorisés pour le client en lecture seule. Ce scope est recommandé pour '''Client Credentials'''.
|}
==Prolonger la durée de vie de la session du client de démonstration==
La session du client de démonstration est initiée avec la méthode PHP [https://www.php.net/manual/en/function.session-start.php session_start]. Cette session peut être interrompue soit en cliquant sur le bouton de déconnexion, soit en fermant le navigateur (car les cookies associés à cette session se détruisent par défaut lorsque le navigateur est fermé).

Pour permettre à la session de rester active même après la fermeture du navigateur, il faut utiliser la méthode PHP [https://www.php.net/manual/en/function.session-set-cookie-params.php session_set_cookie_params]. Cette méthode donne la possibilité de définir une durée de vie pour les différents cookies associés à la session.
<php>// Set the parameters for the session cookie in a PHP session in order to configure its lifetime in 30 days
$oauth2DemoSessionLifeTime = time() + (86400 * 30);
session_set_cookie_params($oauth2DemoSessionLifeTime);</php>

NB: Cette approche n'est pas particulièrement sécurisée et peut présenter des risques de sécurité pour OpenFlyers. Par conséquent, elle doit être utilisée avec précaution.

==Révocation de token==
Pour initier la demande de révocation, rediriger le navigateur de l'utilisateur vers l'URL : <code>POST https://openflyers.com/nom-de-plateforme/oauth/revoke.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée.

Envoyer également le paramètre suivant:
{| class="wikitable"
!Nom!!Type!!Description
|-
|access_token||string||Le jeton d'accès (Chaîne de caractère unique permettant de prouver qu'un client OAuth a le droit d'accéder à une ressource.)
|}
<php> apiRequest(
$config['revoke_uri'],
['access_token' => $_SESSION['auth_token']['access_token']],
null,
false
);</php>

La demande de révocation se fait quand l'utilisateur clique sur le bouton '''Se déconnecter''' pour l'un des deux Clients '''Authorization Code''' et '''Client Credentials'''.

Si les jetons sont révoqués, l'utilisateur ne peut pas accéder à la plateforme OpenFlyers, il doit se reconnecter.

==Utiliser l'API==
Une fois un jeton d'accès obtenu, les données sont accessibles par une requête POST exécutée vers l'URL : <code>https://openflyers.com/nom-de-plateforme/oauth/resources.php</code>. Remplacer <code>nom-de-plateforme</code> par le nom de la plateforme utilisée. La requête POST doit respecter une structure particulière. Cette structure diffère en fonction du type de ressource souhaité et chaque ressource ne peut être accédée qu'[[#Liste-des-scopes-disponibles|avec le scope qui lui est associé]]. Le jeton d'accès doit être renseigné dans l'en-tête HTTP ''Authorization'' en y indiquant la valeur complète du jeton d'accès reçu précédé du type de jeton reçu : <code>Authorization: <token_type> <access_token></code>.

===Récupérer les informations de l'utilisateur connecté===
Ce type de ressource est nommé '''user_information'''. Cette ressource n'est accessible qu'avec le scope '''default.login'''. Cette ressource permet la récupération des informations de l'utilisateur connecté, en d'autre termes, l'utilisateur connecté lors de l'étape d'autorisation et correspondant à celui ayant émis la demande de jeton d'accès. À l'heure actuelle, seul l'identifiant de l'utilisateur connecté est retourné. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''user_information'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"user_information",
"client_id":"d2615fe2020ec476"
}</javascript>

La réponse est retournée dans un conteneur JSON.

===Récupérer les rapports génériques===
Ce type de ressource est nommé '''generic_report'''. Cette ressource n'est accessible qu'avec le scope '''genericreports.readonly'''. Cette ressource permet la récupération des rapports génériques au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''generic_report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"generic_report",
"client_id":"d2615fe2020ec476",
"report_id":135,
"replacementList":{
"year":2018
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

===Récupérer les rapports personnalisés===
Ce type de ressource est nommé '''report'''. Cette ressource n'est accessible qu'avec le scope '''reports.readonly'''. Cette ressource permet la récupération des rapports personnalisés au format CSV autorisés pour le profil de l'utilisateur associé au client OAuth2 enregistré. La requête POST est construite de la manière suivante :

{| class="wikitable"
!Nom!!Type!!Description
|-
|resource_type||string||Le type de ressource demandé, ici, ce champ correspond à '''report'''.
|-
|client_id||string||L'identifiant unique reçu pendant l'enregistrement du client.
|-
|report_id||int||Identifiant du rapport souhaité.
|-
|replacementList||array||Tableau correspondant aux différents paramètres modifiables pour générer le rapport souhaité.
|}

Un exemple de requête complète au format JSON :
<javascript>POST /nom-de-plateforme/oauth/resources.php HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: openflyers.com
Date: Wed, 04 Aug 2021 13:57:51 GMT
Accept: application/json
User-Agent: curl/7.64.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSU
Signature: keyId="58c450d937953829c8cca3613001f865a918da07",
algorithm="rsa-sha256",
headers="host content-type digest",
signature="UsTjCPLsXzmo1b8FrA18SdLgaPamCpqR7tDHBhaiBnro6RbOkoD7="
Digest: SHA-256=Bi6/9qfJXEWme2/9o7VQMyvf+MED523bWdtdi91opwk=

{
"resource_type":"report",
"client_id":"d2615fe2020ec476",
"report_id":1,
"replacementList":{
"year":2020
}
}</javascript>

La réponse est un fichier CSV retourné dans un conteneur JSON.

=Procédures=
==Créer un client à partir du code source==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

;Télécharger Le code source du client de démonstration :

Le code source est mis à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

Le code source est structuré de la manière suivante :

[[File:Oauth2 src demo folder.png|800px]]

* Le dossier '''css''' contient tout le matériel nécessaire à la stylisation de la page web.
* Le dossier '''img''' contient les images affichées sur la page web.
* Le dossier '''ssl''' est le dossier contenant tous les certificats et les clé privées associées à chaque client. Il doit respecter une structure particulière décrite ci-dessous.
* Le fichier '''ClientDemo.php''' contient la classe '''ClientDemo'''. Cette classe contient toutes les méthodes nécessaires au fonctionnement du client de démonstration OAuth2.
* Le fichier '''index.php''' est le fichier à appeler depuis le navigateur. Ce fichier correspond au fichier qui gère les appels à la classe '''ClientDemo''' et exécute les méthodes dans l'ordre.

Le dossier '''ssl''' doit respecter la structure suivante :

[[File:Oauth2 demo tree.png]]

;[[#Générer des certificats|Générer les certificats]] :
Après la génération des certificats, les clés privées 'auth.key' et 'sign.key' remplacent celles présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo'.

;[[#Enregistrer un client|Enregistrer les clients]] :

*Deux clients doivent être créés :
**Le premier pour le mécanisme d'autorisation '''Authorization Code''',
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion. Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion. Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/AuthCodeDemo/auth.key",
"sign_cert": "path_to_client/ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/AuthCodeDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "path_to_client/ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "path_to_client/ssl/ClientCredDemo/auth.key",
"sign_cert": "path_to_client/ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "path_to_client/ssl/ClientCredDemo/sign.key",
"auth_cacert": "path_to_client/ssl/ca.crt",
"sign_cert_server": "path_to_client/ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.
*Remplacer <code>path_to_client/</code> par le chemin d'accès vers le dossier qui contient le code source du client de démonstration.
**Exemple sur '''windows''': <code>C:/wamp64/www/4.0/oauth-demo/</code>.
**Exemple sur un serveur Linux '''debian''': <code>./</code>.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Enregistrer un client==
Pour utiliser l'API OAuth2, il faut enregistrer un client OAuth2 auprès d'OpenFlyers. Pour ceci, suivre les étapes suivantes :

;Pour le mécanisme d'authentification Client Credentials
*Créer un [[Gestion-des-profils#Ajouter-un-profil|nouveau profil]]. Ce profil doit permettre de gérer les droits du client OAuth2. Choisir un nom explicite, par exemple "Client OAuth rapports".

*Sélectionner les droits à assigner à ce profil. Ces droits limitent les données auxquelles le client OAuth2 a accès.
**Sélectionner les droits relatifs à l'enregistrement de clients OAuth2 dans l'onglet '''Admin''' (colonne '''Associé aux clients OAuth2''').
**Sélectionner les rapports accessibles par le profil précédemment créé.

*Créer un nouvel utilisateur à partir du panneau de gestion. Cet utilisateur est virtuel et représente le serveur sur lequel fonctionne le client OAuth2.
**''Des identifiant et nom explicites sont recommandés (exemple : "serv1_oauth_client")''
**'''Attention''' : tout utilisateur désactivé et associé à un client OAuth2 rend le client inactif, il faut donc changer l'utilisateur associé au client pour réactiver le client.

;Pour le mécanisme d'authentification Authorization Code
*Aller dans '''Admin > Utilisateurs > Profils'''
*Dans l'onglet '''Généralités''', cocher la case relative à la colonne '''Connexion depuis l'extérieur (OAuth2)''' pour le profil souhaité.

;Créer un nouveau client OAuth2
*Aller dans '''Admin > Transferts > Exports > API OAuth2'''
[[File:Oauth2 manage.png|800px]]
*Cliquer sur le bouton Ajouter '''+''' ou '''Ajouter un client'''
[[File:Oauth2 client creation.png|800px]]
*Choisir un nom pour le client.
*Sélectionner le mécanisme d'autorisation utilisé par le client :
**'''Authorization Code''': permet d'utiliser OAuth2 comme solution SSO ou accéder à des données utilisateurs. Cette méthode peut être couplée avec le mécanisme de mémorisation de connexion (''Refresh Token'').
**'''Client Credentials''': permet d'utiliser OAuth2 dans un contexte d'automatisme.
*Saisir l'URI de redirection vers le client pour le mécanisme ''Authorization Code''.
*Sélectionner l'utilisateur virtuel créé précédemment pour le mécanisme ''Client Credentials''.
*[[#Générer-des-certificats|Générer deux CSR]] afin d'obtenir deux certificats signés et les saisir :
**'''Certificate Signing Request pour le certificat d'authentification''' est utilisé pour l'authentification mutuelle avec mTLS (auth_cert.csr.pem).
**'''Certificate Signing Request pour le certificat de signature''' est utilisé pour la signature des en-têtes HTTP (sign_cert.csr.pem).

[[File:PublicKeysCopyScreen.png|900px]]

*Cliquer sur '''Enregistrer'''.

NB: La validité des certificats générés s'étend sur une période de '''3 années'''.

;Sauvegarder le couple ID/passphrase
Un couple ID/passphrase (client_id/client_secret) est généré. Ces deux clées ne sont communiquées qu'une seule fois. Elle doivent être stockées en toute sécurité et gardées confidentielles,
et Mettre ces identifiants dans le fichier '''config.clientcred.json'''.
[[File:Oauth2 client created.png]]

[[File:ConfigCredJsonScreen.png|600px]]

;Télécharger les certificats crt
Les certificats signés sont téléchargeables depuis l'interface de gestion des clients OAuth2, les certificats sont disponibles dans les onglets '''Certificat d'authentification''' et '''Certificat de signature''' et les mettre dans le dossier '''/ssl''' du client OAuth2.
[[File:Oauth2 client certificates.png]]

;Téléchargez les certificats du serveur.
*Les certificats du CA d'OpenFlyers et de signature HTTP du serveur sont nécessaires. Ils sont téléchargeables depuis l'interface de configuration des clients OAuth2.
[[File:DownloadServerCertifScreen.png|900px]]
*Dans certains cas d'utilisation, il peut être nécessaire d'ajouter le certificat du CA d'OpenFlyers au Trust Store du système. Si cette étape n'est pas réalisée, les certificats peuvent être considérés comme invalides et peuvent ne pas être utilisables.
*Pour ajouter le certificat CA au Trust Store du système, suivre les étapes suivantes:
**Sous Linux, copier le certificat CA d'OpenFlyers dans le dossier <code>/usr/local/share/ca-certificates</code> et exécuter la commande <code>sudo update-ca-certificates</code>
**Sous Windows,
***Double-cliquer sur le certificat CA d'OpenFlyers téléchargé depuis l'interface d'enregistrement des clients OAuth2
***Cliquer sur '''Installer un certificat...'''
***Choisir l'emplacement de stockage (utilisateur ou ordinateur) et cliquer sur '''Suivant''' puis '''Suivant''' et enfin '''Terminer'''

==Générer des certificats==
L'API OAuth2 implémente [https://tools.ietf.org/html/draft-cavage-http-signatures-10 HTTP Signature] et l'[[Wikipedia-en:Mutual_authentication#mTLS|authentification TLS mutuelle]]. Ces mécanismes utilisent chacun une paire certificat/clé privée différente.

Pour obtenir ces certificats, il faut d'abord générer des Certificate Signing Request (CSR).

La procédure est la suivante :
*[[OpenSSL#Installer-OpenSSL-dans-un-environnement-Windows|Télécharger OpenSSL pour Windows]] ou [[OpenSSL#Utiliser-Openssl-d'Apache-sous-WAMP|utiliser Openssl d'Apache sous WAMP]].
*Utiliser les deux fichiers de configuration ''sign_cert.conf'' et ''auth_cert.conf'' ci-dessous et les remplir.

;Fichier de configuration OpenSSL - sign_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
keyUsage = digitalSignature # pour quelles opérations la clé peut-elle être utilisée</pre>

;Fichier de configuration OpenSSL - auth_cert.conf
<pre>[req]
default_bits = 4096 # taille par défaut des nouvelles clés, peut être surchargé dans la commande
encrypt_key = no # chiffrer la clé générée
distinguished_name = req_distinguished_name # pointe vers la catégorie spécifiée pour le Distinguished Name
x509_extensions = v3_req # pointe vers la catégorie spécifiée pour les extensions x509
prompt = no

[req_distinguished_name]
C = # code à deux chiffres du pays (ex: FR)
ST = # région/état (ex: Gironde)
L = # ville (ex: Bordeaux)
O = # organisation (ex: OpenFlyers)
OU = # unité organisationelle (ex: IT)
CN = # nom de domaine (ex: openflyers.com)

[v3_req]
extendedKeyUsage = clientAuth # pour quelles opérations la clé peut-elle être utilisée</pre>

Exécuter les commandes suivantes :
*<bash>openssl req -sha256 -newkey rsa -keyout sign.key -out sign_cert.csr.pem -outform PEM -config sign_cert.conf</bash>
*<bash>openssl req -sha256 -newkey rsa -keyout auth.key -out auth_cert.csr.pem -outform PEM -config auth_cert.conf</bash>

Ces commandes prennent chacune en entrée le fichier de configuration et génèrent une clé privée et un Certificate Signing Request.

Une fois ces CSR obtenus :
*Les renseigner dans les champs prévus à cet effet lors de la [[#Enregistrer-un-client|création d'un client]] et télécharger les certificats signés depuis l'interface une fois le client créé.
*Garder la clé privée confidentielle. Une fuite poserait un risque de sécurité. Elle va de paire avec le certificat distribué par l'autorité de certification OpenFlyers.

==Mettre en place une connexion à l'API OpenFlyers sur un serveur mutualisé==
;Note
La procédure ci-après est destinée à une mise en place lorsqu'il n'y a pas d'accès SSH en ligne de commande mais uniquement un accès FTP. Dans ce cas, la création des clés privées et publics est effectuée "en local". Dans la procédure suivante elle est effectuée depuis un PC sous '''Windows'''.

;Prérequis
*Posséder les accès FTP :
**Hôte : XXXXXXXXXXXXXXXXXX
**Login : XXXXXXXX
**Mot de passe : XXXXXXXX
**Port : XX (par exemple 21)
*Télécharger Le code source du client de démonstration à disposition par OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/oauth2-demo-src.zip

;Procédure
*[[#Générer des certificats|Générer les certificats]] en local.
*Remplacer les clés privées 'auth.key' et 'sign.key' présentes dans les dossiers 'ssl/AuthCodeDemo' et 'ssl/ClientCredDemo' par les clés générées.
*[[#Enregistrer un client|Enregistrer les deux clients]] :
**Le premier pour le mécanisme d'autorisation '''Authorization Code'''.
**Le second pour le mécanisme d'autorisation '''Client Credentials'''.

[[File:Oauth2 demo manage.png|800px]]

*Télécharger le certificat du CA OpenFlyers en cliquant sur le bouton '''Télécharger le certificat CA''' de la page de gestion.
*Télécharger aussi le certificat de signature du serveur en cliquant sur le bouton '''Télécharger le certificat de signature du serveur''' de la page de gestion.
*Placer les deux certificats téléchargés à la racine du dossier '''ssl'''.

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Authorization Code''' et les placer dans le répertoire '''ssl/AuthCodeDemo'''.
*Modifier le fichier '''ssl/AuthCodeDemo/config.authcode.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"authorize_uri": "https://openflyers.com/mastructure/oauth/authorize.php",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/AuthCodeDemo/auth_cert.crt",
"auth_key": "./ssl/AuthCodeDemo/auth.key",
"sign_cert": "./ssl/AuthCodeDemo/sign_cert.crt",
"sign_key": "./ssl/AuthCodeDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Télécharger les deux certificats ''Certificat d'authentification'' et ''Certificat de signature'' du client '''Client Credentials''' et les placer dans le répertoire '''ssl/ClientCredDemo'''.
*Modifier le fichier '''ssl/ClientCredDemo/config.clientcred.json''' en le remplissant de la manière suivante.
<php>{
"client_id": "XXXXXXXXXXXXXXXX",
"client_secret": "XXXXXXXXXXXXXXXX",
"token_uri": "https://openflyers.com/mastructure/oauth/access_token.php",
"resource_uri": "https://openflyers.com/mastructure/oauth/resources.php",
"revoke_uri": "https://openflyers.com/mastructure/oauth/revoke.php",
"auth_cert": "./ssl/ClientCredDemo/auth_cert.crt",
"auth_key": "./ssl/ClientCredDemo/auth.key",
"sign_cert": "./ssl/ClientCredDemo/sign_cert.crt",
"sign_key": "./ssl/ClientCredDemo/sign.key",
"auth_cacert": "./ssl/ca.crt",
"sign_cert_server": "./ssl/sign_cert_server.crt"
}</php>

*Remplacer les <code>XXXXXXXXXXXXXXXX</code> des champs <code>client_id</code> et <code>client_secret</code> par les valeurs obtenues lors de [[#Enregistrer-un-client|l'enregistrement du client]].
*Remplacer <code>mastructure</code> par le nom de la structure sur laquelle la démo est testée.

*Transférer le fichier "oauth-demo" vers le serveur mutualisé :
**Télécharger [http://filezilla-project.org/download.php?type=client FileZilla].
**Lancer FileZilla.
**Entrer l'URl du serveur mutualisé dans le champ '''Hôte'''.
**Entrer le login dans le champ '''Nom d'utilisateur'''.
**Entrer le mot de passe dans le champ '''Mot de passe'''.
**Entrer le port dans le champ '''Port'''.
**Cliquer sur le bouton Connexion.
**Accéder à l'emplacement du répertoire "oauth-demo" en local à gauche dans l'onglet "Site local".
**Choisir l'emplacement où placer le répértoire oauth-demo dans l'anglet '''Site distant''' à droite.
**Glisser et déposer le oauth-demo à l'emplacement choisi.
[[File:Transfer OauthDemo To Shared Server.png|800px]]
*Accéder au client OAuth-demo depuis le serveur mutualisé en utilisant l'URL du domaine du serveur : url_de_domaine_de_serveur/oauth-demo/index.php
*Modifier la valeur '''URI de redirection vers le client''' du client '''AuthCodeDemo''' précédemment créé en remplaçant l'ancienne URL par la nouvelle.

*Suivre la [[#Utiliser le client|procédure d'utilisation du client de démonstration]] pour faire fonctionner le client.

'''NB''': Le certificat de signature du serveur est unique à chaque plateforme et serveur. Ainsi, si le serveur ou la plateforme est modifié, le certificat doit être renouvelé.

==Récupérer les données d'un utilisateur==
*Cliquer sur le bouton '''Récupérer les informations utilisateur''', l'identifiant de l'utilisateur s'affiche.
*Utiliser l'identifiant récupérer afin de récupérer toute information associée à cet utilisateur en [[Gestion-des-rapports#Ajouter-un-rapport|créant de nouveaux rapports personnalisés]]

==Utiliser le client==
;Prérequis
Un client de démonstration est disponible pour le logiciel OpenFlyers à cette adresse : https://openflyers.com/oauth2-demo/index.php

Le client de démonstration se présente de la manière suivante.

[[File:Oauth2-client-demo.png]]

La démonstration est composée de deux colonnes. La première, nommée '''Authorization Code''' correspond [[#Authorization Code|au mécanisme d'autorisation du même nom]]. Elle dispose d'un bouton permettant de se connecter ainsi que d'une section indiquant les informations relatives à l'état de la connexion. La seconde colonne, nommée '''Client Credentials''' correspond elle aussi [[#Client Credentials|au mécanisme d'autorisation du même nom]]. Comme pour la première colonne, les éléments qui y sont présentés sont identiques. La différence étant que le bouton de connexion n'a pas le même effet étant donné que ces deux mécanismes sont différents. Chaque mécanisme est indépendant et il est possible de se connecter à un des deux mécanismes sans se connecter à l'autre ou se connecter aux deux en même temps.

;Le mécanisme '''Authorization Code'''
*Cliquer sur le bouton '''Se connecter''' (ce qui redirige le navigateur vers la page de connexion du logiciel OpenFlyers).
*Renseigner les identifiants de l'administrateur pour s'y connecter.
*Nom d'utilisateur : '''admini'''.
*Mot de passe : '''azerty'''.

Une fois les informations saisies, la page suivante est affichée.

[[File:Oauth authorize demo.png]]

*Cliquer sur le bouton '''Autoriser l'application''' pour autoriser la connexion (ce qui se redirige le navigateur vers la page du client de démonstration OAuth2).

La première colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un nouveau bouton '''Récupèrer les informations utilisateurs''' qui permet de récupérer les informations de l'utilisateur connecté.

;Le mécanisme '''Client Credentials'''
*Cliquer sur le bouton de connexion '''Se connecter''': contrairement à celui du mécanisme '''Authorization Code''', ne redirige pas le navigateur vers la page de connexion du logiciel OpenFlyers. Le bouton de connexion utilise les identifiants du client, ici le couple clé privée/clé publique, pour initier la connexion avec le serveur d'autorisation et obtenir un jeton d'accès.

Une fois la connexion établie, la seconde colonne doit afficher l'état de connexion '''Connecté''' ainsi qu'un menu déroulant '''Rapport à récupèrer''' et un nouveau bouton '''Récupèrer le rapport''' qui permet de récupérer les rapports génériques et personnalisés.

Le client, une fois connecté sur les deux mécanismes, se présente de la manière suivante.

[[File:Oauth2 connected demo.png]]

=Troubleshooting=
==500 Internal Server Error en récupérant le rapport==
La démo utilise les valeurs par défaut pour extraire les rapports. Une erreur 500 indique une "Erreur de syntaxe ou violation d'accès" lors de l'exécution de la requête du rapport. Cela se produit parce que le rapport n'a pas de valeurs par défaut associées, étant donné qu'il n'a jamais été visualisé dans l'interface web. Pour résoudre ce problème, il vous suffit de visualiser le rapport et de cocher la case "Mémoriser ce choix".

==Erreur "File not found."==
Cette erreur se produit lorsque l'URI utilisé n'existe pas sur le serveur OpenFlyers. Vérifier les URIs mis en place dans les fichiers de configuration et essayer de nouveau.

==int_rsa_verify : longueur de signature incorrecte==
Ce problème pourrait survenir si les fichiers ca.cert et sign_cert_server.cert ne proviennent pas du même serveur que celui du client oauth2.
La solution est :

*D'essayer depuis le début l'étape de [[#Générer-des-certificats|génération]] et de [[#Enregistrer-un-client|configuration des certificats]] avec jsut la modification du client existant.

;Si cela ne fonctionne pas:

*Essayez de créer [[#Enregistrer-un-client|un nouveau client]] et refaites la configuration des certificats.

AERAL

2024-10-02T17:27:46Z

Lhenry: Text replacement - "Fichier:" to "File:"

=Présentation=
L'objet de cette page est de décrire le module OpenFlyers permettant de paramétrer et générer les statistiques Aeral (Acquisition et Exploitation des Rapports d'activités de l'Aviation Légère) requises par la DGAC pour les associations aéronautiques et qui se concrétise au travers du remplissage d'un formulaire dont la version PDF est disponible à cette adresse : https://www.formulaires.service-public.fr/gf/cerfa_12806.do .

La DGAC préconise de ne pas remplir le formulaire PDF mais à la place le formulaire en ligne accessible à cette adresse : https://aeral.dg.aviation-civile.gouv.fr/WD220AWP/WD220Awp.exe/CONNECT/AERAL

De son côté, la Fédération Française Aéronautique (FFA) propose un module qui permet de faciliter le remplissage des statistiques Aeral au travers de son outil SMILE. Une documentation concernant l'utilisation de ce module est disponible à cette adresse : https://faq.ffa-aero.fr/smile/docs/aeral/saisir-son-rapport-aeral-dans-smile/

OpenFlyers s'interface avec le module SMILE de la FFA au travers d'un module de génération et d'envoi des statistiques Aeral. Ce module permet également d'automatiser l'envoi des données mensuelles vers SMILE FFA.

==Chronologie des actions à effectuer sur OpenFlyers==
Lorsque la structure utilise la fonction de génération du rapport Aeral pour la première fois :
*Tenter de générer un premier rapport Aeral en allant dans '''Gestion > Rapports > Rapports spécifiques > Export Aeral'''
Si le robot OpenFlyers n'est pas en mesure de prédire l'ensemble des paramètres par défaut nécessaires à la génération du rapport, il renvoie vers le paramétrage. Sinon, il affiche les tableaux de statistiques.

Dans tous les cas, '''ne pas tenir des données publiées lors de la première tentative et vérifier les paramètres''' :
*Aller dans '''Admin > Structure > Paramétrage > Export Aeral'''
*Vérifier que les paramètres renseignés sont conformes à la configuration de la plateforme OpenFlyers en s'aidant des consignes et copies d'écrans publiées dans le chapitre [[#Admin->-Structure->-Paramétrage->-Export-Aeral|Admin > Structure > Paramétrage > Export Aeral]] de cette page

Si les paramètres ne sont pas définis ou sauvegardés, [[Alertes-de-configuration#Le-formulaire-de-configuration-de-l'export-aeral-n'a-pas-été-rempli-ou-sauvegardé|une alerte de configuration est affichée]].

Une fois les paramètres définis :
*Retourner dans '''Gestion > Rapports > Rapports spécifiques > Export Aeral'''
*Vérifier l'année sélectionnée
*Cliquer sur le bouton '''Visualiser'''
*Vérifier la cohérence des statistiques générées
Une fois que les données sont considérées comme correctes, il faut recopier les données sur l'[https://aeral.dg.aviation-civile.gouv.fr/AERAL outil Aeral] '''sauf pour les aéro-clubs affiliés à la Fédération Française Aéronautique''' où cette dernière souhaite que les données remontent via son outil SMILE. Voir le chapitre suivant [[#Chronologie-des-actions-à-effectuer-sur-SMILE-FFA|Chronologie des actions à effectuer sur SMILE FFA]]

==Chronologie des actions à effectuer sur SMILE FFA==
;Prérequis
*Avoir renseigné le '''Code FFA''' dans le formulaire [[#Coordonnées|Coordonnées]] présent dans '''Admin > Structure > Paramétrage > Export Aeral'''
*Avoir testé le code FFA de sorte à avoir le cadenas vert de verrouillé

;Procédure
*Depuis '''Gestion > Rapports > Rapports spécifiques > Export Aeral''', une fois que la cohérence des statistiques générées a été vérifié, il faut :
*Cliquer sur le bouton '''Envoyer à SMILE'''
*[https://projet.ff-aero.fr/SMILE_II Aller sur SMILE AEROCLUB] et suivre la procédure suivante : https://faq.ffa-aero.fr/smile/docs/aeral/saisir-son-rapport-aeral-dans-smile/
*Il faut parcourir les onglets un par un de la gauche vers la droite en cliquant à chaque fois sur le bouton '''Nous avons reçu des données de votre logiciel de gestion d'Aeroclub OpenFlyers. Dates des données : fin 12/2022. CLIQUER ICI POUR CHARGER CES DONNEES AUTOMATIQUEMENT.''' puis cliquer sur le bouton '''Oui''' de la boite de dialogue demandant confirmation
*Une fois que tous les onglets ont été parcourus, les données importées et les vérifications effectuées, il faut cliquer sur le dernier onglet '''VALIDATION'''
Si les vérifications d'intégrité sont correctes sur SMILE, un pavé sur fond vert apparait avec 2 cases à cocher pour permettre l'envoi des données vers Aeral

[[File:VALIDATION_SMILE.png|600px]]

'''ATTENTION : il n'est possible d'envoyer les données qu'une seule fois depuis SMILE vers Aeral'''

;Points d'attention
*les données ne remontent dans chaque formulaire SMILE qu'après avoir cliqué sur le bouton '''Nous avons reçu des données de votre logiciel de gestion d'Aeroclub OpenFlyers. Dates des données : fin 12/2022. CLIQUER ICI POUR CHARGER CES DONNEES AUTOMATIQUEMENT.'''
Il faut effectuer cette action pour CHAQUE onglet. Il est donc recommandé de parcourir les onglets de la gauche vers la droite.
*Il est possible d'exporter (pousser) les données depuis OpenFlyers vers SMILE FFA autant de fois qu'on le souhaite. Chaque nouvel envoi de données écrase l'envoi précédent effectué pour le même mois. Par contre, à chaque nouvel envoi, il faut cliquer sur le bouton d'import dans SMILE FFA pour chaque onglet du formulaire.
*A l'heure actuelle, SMILE récupère bien toutes les données OpenFlyers mais ne permet pas de les incorporer toutes. Ainsi il manque le bouton de synchronisation pour les onglets suivants :
**GENERAL : non souhaité par la FFA
**TERRAINS : prévu pour 2024
**BUREAU : à fiabiliser
**MATERIEL : prévu pour 2024
*Autant il est possible de pousser les données depuis OpenFlyers vers SMILE FFA autant de fois qu'on le souhaite, autant il n'est possible d'exporter de SMILE FFA vers Aeral qu'une seule fois. En cas d'erreur, il faut contacter la [https://www.ffa-aero.fr Fédération Française Aéronautique] pour déverrouiller le système et permettre d'effectuer un nouvel envoi.

=Admin > Structure > Paramétrage > Export Aeral=
Pour accéder au paramétrage '''Export Aeral''', il faut disposer du droit [[Gestion-des-profils#Gestion-des-rapports|Gestion des rapports]].

Afin de pouvoir générer les statistiques Aeral, il faut que toutes les questions du formulaire soient complétées. Ce dernier est pré-rempli automatiquement avec les données de la structure grâce à l'utilisation de [[#Prédictions|prédictions]] lors de la première tentative de génération des statistiques Aeral depuis [[#Gestion->-Rapports->-Rapports-spécifiques->-Export-Aeral|Gestion > Rapports > Rapports spécifiques > Export Aeral]].

Il est donc fortement recommandé de générer une première fois les statistiques '''AVANT''' d'éditer le contenu du paramétrage. En effet, une fois que les données de paramétrage des statistiques Aeral sont stockées, la prédiction est désactivée pour ne pas réinitialiser les valeurs enregistrées.

Après une première génération des statistiques, le gestionnaire est invité à vérifier les paramètres pré-remplis du formulaire, à les corriger le cas échéant, et à renseigner manuellement les éléments restants.

les données récupérées de ce formulaire affectent directement la manière dont le robot OpenFlyers traite les rapports. Si une donnée n'est pas présente dans le paramétrage de la structure, le gestionnaire doit sélectionner le choix '''Non applicable'''.

==Coordonnées==
[[File:Aeral coordonnées.png|800px]]

Pour les structures affiliées à la [https://www.ffa-aero.fr Fédération Française Aéronautique] :
*Renseigner '''Code FFA (10 chiffres sans espace et sans tiret)'''
*Cliquer sur le bouton '''Enregistrer''' en haut à droite
*Cliquer sur le bouton '''Valider le code FFA'''. Cela permet de tester le code FFA en envoyant les données des statistique AERAL à l'API SMILE FFA en mode de test.
Une fois que le code FFA est validé, le pictogramme du cadenas à droite passe vert/verrouillé
*Cliquer sur l'interrupteur '''Synchronisation Automatique SMILE FFA''' pour activer la synchronisation automatique les données AERAL vers le serveur SMILE de la FFA. L'interrupteur n'est activable que si le '''Code FFA''' est préalablement validé. Lorsque l'interrupteur est activé et [[#Admin->-Structure->-Paramétrage->-Export-Aeral|le paramétrage Aeral]] est rempli et sauvegardé, les statistiques sont envoyées tous les 1er du mois à l'API SMILE FFA. Elles concernent la période du 1er janvier de l'année en cours au jour précédent la date d'envoi, sauf pour le 1er janvier où la période correspond à l'année précédente.

'''NB''': Pour valider le code FFA, on click sur le bouton '''Valider le code FFA''':
*Si le code FFA est valide:
**Le champ de la saisie du code FFA sera verrouillé avec un cadenas qui passe en vert.
**L'interrupteur de la synchronisation automatique peut être activé.
**Le bouton '''Valider le code FFA''' disparaît ( le déverrouillage du Code FFA ne sera fait que par un admin interne d'OpenFlyers).
*Si le code FFA n'est pas valide:
**L'interrupteur de la synchronisation automatique devient désactivé.
**le champ de la saisie du code FFA sera déverrouillé avec un cadenas en rouge.

*'''Département'''
*'''Région aéronautique'''
*'''Délégation régionale'''
*'''Date agrément DGAC'''
*'''Préfecture Agrément DGAC'''
*'''Numéro ATO'''
*'''Date d'obtention de l'ATO'''
*'''Numéro DTO'''
*'''Date d'obtention du DTO'''
*'''APE'''

==Tarifs==
[[File:Aeral_ _Tarifs.png|800px]]

*Droit d'entrée
*Cotisation
*Remise cotisation jeunes
*Tarif supplément instruction

Les informations renseignées sont utilisées par le robot OpenFlyers pour générer le tableau [[#Tarifs|Tarifs]] du rapport Aeral.

==Validité définissant la pratique d'une activité==
[[File:Aeral_ _Validité_définissant_la_pratique_d'une_activité.png|800px]]

*Type de validité définissant un utilisateur "Avion"
*Type de validité définissant un utilisateur "Hélicoptère"
*Type de validité définissant un utilisateur "Planeur"
*Type de validité définissant un utilisateur "ULM classe 3 - 3 axes"
*Type de validité définissant un utilisateur "ULM classe 4 - autogire"

Ces champs permettent à l'utilisateur de choisir le type de validité correspondant à chaque type d'activité.

Les informations renseignées sont utilisées par le robot OpenFlyers pour générer le tableau ADHERENTS du rapport Aeral.

==Correspondance validités / Brevets, licences ou qualifications==
[[File:Aeral_ _Correspondance_validités_Brevets_licences_ou_qualifications.png|800px]]

*Activité Avion
**LAPL
**PPL
**CPL
**ATPL
**Qualif_Voltige
**Qualif_Montagne
**Qualif_Hydravion
**Qualif_IFR
**Qualif_VFR_Nuit
*Activité ULM
**Paramoteur
**Pendulaire
**Multiaxes
**Autogire
**Dirigeable
**Hélicoptère
*Activité Hélicoptère
**LAPL(H)
**PPL(H)
**CPL(H)
**ATPL(H)
*Activité Planeur
**VV/SPL/LAPL(S)

Ces champs permettant l'utilisateur de choisir le type de validité correspondant à Brevets, licences ou qualifications pour chaque type d'activité.

Les informations renseignées sont utilisées par le robot OpenFlyers pour générer le tableau FORMATIONS du rapport Aeral.

==Validités correspondant à la cotisation de la structure==
[[File:Aeral_ _Validités_correspondant_à_la_cotisation_de_la_structure.png|500px]]

Les validités cochées dans cette partie sont utilisées par le robot OpenFlyers dans les tableaux [[#Adhérents-par-activité-X|Adhérents par activité X]] du rapport Aeral afin de déterminer les utilisateurs inscrits dans la structure durant l'année considérée.

==Validité correspondant à la licence FFA==
Une liste déroulante comprenant tous les types de validités configurés pour obtenir la certification par l'API FFA.

[[File:Aeral_ _Validité_correspondant_à_la_licence_FFA.png|400px]]

Si aucun type de validité n'est défini pour l'obtention de la certification via l'API FFA, le message d'erreur suivant sera affiché.

[[File:Aeral_Validité_correspondant_à_la_licence_FFA_Warning.jpg|400px]]

La validité cochée dans cette partie est utilisée par le robot OpenFlyers dans les tableaux [[#Adhérents-par-activité-X|Adhérents par activité X]] du rapport Aeral afin de déterminer les utilisateurs brevetés inscrits dans la structure durant l'année considérée.

Voir le chapitre de non conformité [[#Ce-numéro-de-licence-FFA-n'a-pas-été-certifié-par-SMILE-et-ne-sera-donc-pas-pris-en-compte-lors-de-l'export|Ce numéro de licence FFA n'a pas été certifié par SMILE et ne sera donc pas pris en compte lors de l'export]] pour les explications sur ce message d'alerte.

==Validités désignant les brevetés==
[[File:Aeral_ _Validités_désignant_les_brevetés.png|400px]]

Les validités sélectionnées dans ce champ permettent de définir les validités qui permettent de savoir une personne dispose d'un brevet ou non et donc par différence les personnes qui ne disposent d'aucun brevet sont considérées comme des élèves. Cette catégorisation des personnes est utilisée dans les rapports [[#Adhérents-par-activité-X|Adhérents par activité X]].

==Activités pratiquées==
[[File:Aeral_ _Activités_pratiquées.png|200px]]

Cocher les activités pratiquées par la structure.

Les paramètres de cette partie sont utilisées par le robot OpenFlyers pour générer les tableaux [[#Activité-en-instruction-et-Activité-hors-instruction|Activité en instruction et Activité hors instruction]] ainsi que pour le tableau [[#Instructeurs|Instructeurs]] (pour la partie '''solo supervisé''') du rapport Aeral.

==Correspondance activités / typologie des vols Aeral==
[[File:Aeral_ _Correspondance_activités_typologie_des_vols_Aeral.png|1200px]]

*IFR
*VFR Nuit
*Nuit
*VFR jour navigation
*Navigation
*Montagne
*Voltige
*BIA
*Baptême de l'air
*Instruction
*Remorquage
*Treuillage

Les informations renseignées sont utilisées par le robot OpenFlyers pour générer les tableau 'En_Instruction_Par_Activite pour la catégorie X' et 'Hors_Instruction_Par_Activite' du rapport Aeral.

==Activité correspondant à Solo supervisé==
OpenFlyers recommande de ne pas saisir les vols solos supervisés avec l'instructeur en place droite mais de créer un champ spécifique pour renseigner le nom du superviseur. Le paramétrage correspondant est décrit dans le chapitre [[Gestion-des-activités#Paramétrage-des-vols-solos-supervisés|Paramétrage des vols solos supervisés]].

*L'activité sélectionnée dans le champ autocomplète '''Solo Supervisé''' est utilisée par le robot OpenFlyers dans les tableaux 'En_Instruction_Par_Population pour la catégorie X' et 'En_Instruction_Par_Activite pour la catégorie X' du rapport Aeral afin de déterminer les heures de vol en Solo Supervisé durant l'année considérée.

[[File:Aeral_Instructeur_En_Place_Droite.png|1200px]]
*Si l'interrupteur '''instructeur en place droite''' est activé, les heures de vol en solo supervisé durant l'année considérée sont déterminées en fonction du fait qu'il y a un instructeur occupant la place droite et qui effectue un vol avec l'activité sélectionnée dans le champ '''Solo Supervisé'''.

[[File:Aeral_Champ_Métier_Correspondant_Au_Superviseur.png|1200px]]
*Si l'interrupteur '''instructeur en place droite''' est désactivé, les heures de vol en solo supervisé durant l'année considérée sont déterminées en fonction du fait qu'il y a un superviseur qui effectue un vol avec l'activité sélectionnée dans le champ '''Solo Supervisé'''. Pour cela il faut renseigner le '''Champ métier correspondant au superviseur'''.

==Matériels==
[[File:Aeral_ _Matériels.png|400px]]

Cocher le matériel dont dispose la structure.

==Terrain==
[[File:Aeral_ _Terrain.png|800px]]

Renseigner les informations concernant l'aérodrome utilisé.

==Bureau==
[[File:Aeral_ _Bureau.png|800px]]

Définir les personnelles exerçant les fonctions définies.

==Personnel==
[[File:Aeral_ _Personnel.png|1600px]]

Renseigner les informatiques statistiques concernant le personnel.

==Profil des adhérents non pilotes==
[[File:Aeral_ _Profil_des_adhérents_non_pilotes.png|300px]]

Le profil sélectionné dans cette partie est utilisé par le robot OpenFlyers dans les tableaux [[#Adhérents-par-activité-X|Adhérents par activité X]] du rapport Aeral afin de déterminer les utilisateurs inscrits dans la structure qui rentrent la catégorie '''non pilotes'''.

==Profil(s) désignant les instructeurs==
[[File:Aeral_ _Profil(s)_désignant_les_instructeurs.png|400px]]

Définir le profil permettant de désigner les utilisateurs instructeurs.

Ce profil est utilisé par le robot OpenFlyers pour lister les utilisateurs dans le tableau [[#Instructeurs|Instructeurs]] du rapport Aeral.

=Gestion > Rapports > Rapports spécifiques > Export Aeral=
Pour accéder au rapport '''Export Aeral''', il faut disposer du droit [[Gestion-des-profils#Voir-tous-les-rapports|Voir tous les rapports]] ou [[Gestion-des-profils#Gestion-des-rapports|Gestion des rapports]].

Lors de la première tentative de génération d'un export Aeral, le robot OpenFlyers tente de devenir le paramétrage qui doit être mis en place. S'il arrive à renseigner l'ensemble des paramètres indispensables à la génération du rapport, alors il affiche les tableaux pour les statistiques Aeral. S'il n'est pas en mesure de prédire l'ensemble des paramètres par défaut nécessaires à la génération du rapport, il renvoie vers le [[#Admin->-Structure->-Paramétrage->-Export-Aeral|paramétrage Aeral]].

Avant de générer le bilan annuel, il faut s'assurer que toutes les informations sont renseignées, si ce n'est pas le cas alors le gestionnaire est redirigé vers le formulaire précédent.

L'année affichée par défaut est :
*l'année précédente lorsque le mois actuel est compris entre le mois de janvier et le mois de mars inclus
*l'année actuelle dans le cas contraire

La distinction entre '''jeunes''' et '''adultes''' dans les rapports se situe à :
*21 ans pour '''AVION'''.
*25 ans pour les autres catégories ('''ULM''', '''HELECOPTERE''' et '''PLANEUR''')

Une personne est décomptée comme adulte dès lors que son année de naissance est supérieure ou égale à 21 ou 25 ans suivant la catégorie considérée.

==Rapports issus de données de formulaire==
:* rapport Aeral ''' TERRAINS'''
:* rapport Aeral '''BUREAU'''
:* rapport Aeral '''PERSONNEL'''
:* rapport Aeral '''MATERIEL'''

==Adhérents par activité X==
Ce rapport regroupe 4 tableaux qui correspondent chacun à un type d'activité :
*Avion
*Hélicoptère
*ULM
*Planeur

Pour qu'un pratiquant soit pris en compte dans le recensement, il faut :
*Qu'il détienne au moins l'une des validités [[#Validités-correspondant-à-la-cotisation-de-la-structure|Validités correspondant à la cotisation de la structure]] et dont la date d'échéance doit être supérieure ou égale au 31/12 de l'année des statistiques.
*Qu'il dispose d'une date de naissance (cela permet d'exclure les utilisateurs qui ne correspondent pas à des utilisateurs réels en leur mettant une date de naissance vide)

Pour chaque type d'activité, le robot OpenFlyers détermine les pratiquants en prenant en compte au moins l'un des éléments suivants :
*La pratique effective durant l'année sur un type d'aéronef correspondant au type d'activité
*La détention par un utilisateur d'une validité le définissant comme pratiquant de l'activité

Le robot OpenFlyers prend en compte les utilisateurs désactivés.

Une fois calculé le nombre de pratiquants, le robot OpenFlyers détermine le nombre de brevetés parmi ces pratiquants. Est considéré comme breveté un utilisateur qui dispose de l'une des validités sélectionnées dans le paramétrage [[#Validités-désignant-les-brevetés|Validités désignant les brevetés]], peu importe que la validité soit à jour ou non. Cela permet de déterminer, par soustraction, les personnes qui sont élèves. Dis autrement : est élève une personne qui ne possède pas une validité répertoriée comme étant une validité de type "brevet".

La figure suivante résume l'approche adoptée pour générer les statistiques liées à ce rapport :

[[File:Aeral_statistic_members_by_activity_schema_algorithm.png|800px]]

==Instructeurs==
Pour calculer les heures de vol de chaque instructeur, il y a 2 façons possibles :
*Première méthode : Lorsqu'il n'y a pas de type d'activité de sélectionné dans le champ '''Activité correspondant à Solo supervisé''', le robot OpenFlyers détermine le total des heures de vol de l'instructeur en place droite, puis le total des heures de vols en place droite de l'instructeur pour lesquelles il y a le type d'activité sélectionné pour le paramètre '''Instruction'''
:'''Heures totales = total des heures en place droite '''
:'''Heures doubles = total des heures en place droite avec le type d'activité correspondant à instruction'''
:'''Heures solo supervisé = Heures totales - Heures doubles'''
*Deuxième méthode : si le type d'activité solo supervisé est coché pour l'instructeur, dans ce cas on détermine le total des heures en solo supervisé comme étant la somme des heures de vols de l'instructeur pour lesquelles il y a comme type d'activité celle correspondant au paramètre '''Activité correspondant à Solo supervisé'''.
:'''Heures totales = total des heures en place droite avec le type d'activité correspondant à instruction'''
:'''Heures solo supervisé = total des heures en place droite avec le type d'activité correspondant à solo supervisé'''
:'''Heures doubles = Heures totales - Heures solo supervisé'''

Voir le chapitre de non conformité [[#Ce-numéro-de-licence-FFA-n'a-pas-été-certifié-par-SMILE-et-ne-sera-donc-pas-pris-en-compte-lors-de-l'export|Ce numéro de licence FFA n'a pas été certifié par SMILE et ne sera donc pas pris en compte lors de l'export]] pour les explications sur ce message d'alerte.

==Activité en instruction et Activité hors instruction==

pour ces deux rapport aeral nous utilisons la même stratégie qui est définie ci-dessous, pour différencier entre ces deux types d'activité on se base sur la place du pilote :

-En instruction place de pilote = 1.

-Hors instruction place de pilote = 0.

===Activité en instruction / Activité hors instruction pour les catégories AVION et HELECOPTERE===

La stratégie retenue pour générer ces rapports Aeral a été de commencer par identifier les variables fiables qui sont présentes chez toutes les structures
(navigation, IFR, Nuit),qui sont récupérées soit à partir du [[#Admin > Structure > Paramétrage > Export Aeral| formulaire]], soit grâce à l'utilisation de [[#Types d'activités|prédictions sur les types d'activités]], et à partir desquelles on calcule le nombre d'heures de vol pour les autres types d'activité.

[[File:Aeral_activity_types_partition_schema.png|650px]]

Les données les plus fiables sont celles qui sont les plus spécifiques, par exemple, pour obtenir la valeur de VFR nuit si ce type d’activité n'est pas présente dans la structure alors on considère que le type d’activité nuit est le plus spécifique et donc il correspond à la donnée la plus fiable pour calculer ce type d’activité.

Le calcul des heures de vol pour les différents types d'activité se fait en suivant les étapes suivantes:
:* On commence par l’obtention des heures de vol total de toutes les activités confondues par une requête sql.
:* Ensuite, les heures de vol de chaque type d'activité sont calculées en fonction des données fournies par le gestionnaire dans le [[#Admin > Structure > Paramétrage > Export Aeral| formulaire]].

La figure suivante représente le schéma de l'algorithme utilisé par le robot OpenFlyers pour calculer les heures de vol en fonction des données présente dans la structure :

[[File:Aeral_statistic_activity_schema_algorithm.png|650px]]

:*'''Exemple''':
on prend l'exemple suivant dans lequel la structure ne possède que les types d'activités suivants: IFR, NUIT et Navigation

on commence par l'obtention le '''total des heures de vol''' : 2430

ensuite on obtient le total '''IFR''' : 1000

puisque le type d'activité VFR nuit n'est pas présent dans la structure:

on commence par exécuter deux requête la première sur le type d'activité nuit et l'autre sur les deux types d'activité ifr et nuit on obtient par exemple:

'''Nuit''' = 1200

'''IFR nuit''' = 400

ce que nous aide à calculer la valeur de VFR Nuit(voir la relation dans la figure ci-dessus)

'''VFR Nuit''': 1200 - 400 = 800.

pour calculer VFR jour navigation:

on commence par calculer navigation jour, pour cela on obtient la valeur de navigation = 700 et la valeur de navigation nuit = 300 à partir de la base de données, et donc
'''Navigation jour''' = 700 - 300 = 400,

ensuite de la même manière on obtient IFR Navigation = 330 et IFR navigation nuit = 200, pour calculer '''IFR navigation jour''' = 330 - 200 = 130.

et en utilisant la relation défini dans figure ci-dessus, on calcule '''VFR jour navigation''' = 400 - 130 = 270.

à la fin on déduit la valeur de VFR jour local en suivant les étapes suivants :

*:On calcule tout d'abord les heures de vol de '''VFR jour''' = VFR - VFR nuit = 1430 - 800.

avec '''VFR''' = Total - IFR = 2430 - 1000 = 1430.

*:ensuite on déduit la valeur de '''VFR Jour local''' = VFR jour - VFR jour navigation = 630 - 270 = 360

===Activité en instruction / Activité hors instruction pour la catégorie ULM===
Pour générer les statistiques liée à ces rapports il faut prendre en compte que chaque vol de la catégorie ULM peut être classée selon la catégorie de la ressource, mais pour le moment les clients d'OpenFlyers utilisent deux catégories ULM qui sont: '''ULM classe 3 - 3 axes''' et '''ULM classe 4 - autogire'''.

Pour résoudre ce problème on a calculé que les heures totales des vols, les heures de vols pour la catégorie de ressource '''ULM 3 axes''' (Heures_Multiaxes) et les heures de vols pour la catégorie de ressource '''ULM classe 4 - autogire''' (Heures_Autogire). Cependant on a transmis des zéros pour les autres catégories des ressources (Heures_Paramoteur, Heures_Pendulaire, Heures_Dirigeable, Heures_Helicoptere et Heures_Dont_Vol_BIA).

NB. Si l'un des clients a des catégories de ressources autres que ULM 3 axes et ULM classe 4 - autogire, il faudra ajouter les requêtes de génération des heures de vol pour chacune de ces catégories de ressource.

===Activité en instruction / Activité hors instruction pour la catégorie PLANEUR===
[[File:Gliding_Activity_Categorization_Diagram.png|650px]]

La stratégie adoptée pour générer ces rapports Aeral repose sur la prise en compte de divers aspects :

*Extraire les heures totales de vol pour l'activité planeur, quelle que soit sa catégorie (en instruction, hors instruction, autres).
*Extraire les heures de vol étrangères spécifiquement pour l'activité planeur (Nationalité non française).
*Extraire les heures de vol des remorqueurs dans le cadre de l'activité planeur.
*Extraire les heures de vol en fonction du sexe pour la catégorie en instruction planeur.
*Extraire les heures de vol en fonction du sexe pour la catégorie hors instruction planeur.
*Extraire les heures de vol hors instruction destiné aux personnes françaises (Jeunes/Adultes) (total des heures, heures avec BIA, heures de vol de découverte).
*Extraire le nombre de vols hors instruction destiné aux personnes françaises (Jeunes/Adultes) selon le type d'activité (Remorqués, Treuillés, Lâchers solo, BPP Théorique, BPP Homologués).

==Mouvements==
Pour calculer les mouvements sur la plateforme en comptant simplement les atterrissages des vols locaux.

Sachant que 1 décollage ou 1 atterrissage ou 1 touch and go= 1 mouvement.

mouvements locaux = total atterrissages vol locaux * 2

==Tarifs==
ce rapport aeral consiste à renseigner les droits d'entrée, cotisation non pilote et cotisation Club pour les deux tranches d'age (Jeunes et Adultes).

pour cela, les valeurs du droit d'entrée et de la cotisation non pilote sont directement attribuées pour les deux tranches d'age, en se basant sur les variables renseignées dans la [[#Admin > Structure > Paramétrage > Export Aeral| formulaire]] ou trouvées grâce à l'utilisation de [[#Prédictions|prédictions]].

pour Cotisation Club on récupère la valeur ADULTES_Cotisation_Club directement à partir de la variable Cotisation.

et on déduit '''Jeunes_Cotisation_Club = ADULTES_Cotisation_Club - remise Cotisation jeunes'''

==Terrains==

==Bureau==
Voir le chapitre de non conformité [[#Ce-numéro-de-licence-FFA-n'a-pas-été-certifié-par-SMILE-et-ne-sera-donc-pas-pris-en-compte-lors-de-l'export|Ce numéro de licence FFA n'a pas été certifié par SMILE et ne sera donc pas pris en compte lors de l'export]] pour les explications sur ce message d'alerte.

==Aéronefs==
Ce tableau liste toutes les ressources de catégorie aéronefs (Avion, ULM, Hélicoptère, Planeur) :
*actives pour lesquelles l'option '''Saisie d'activité''' est cochée dans le paramétrage
*qui ont effectué au moins un vol dans l'année considérée
Le tableau contient les colonnes suivantes :
*Immatriculation qui correspond au nom de l'aéronef
*Modèle qui correspond au nom du type de ressource correspond
*Heures_Cette_Annee correspond au total des heures de vols effectuées par l'aéronef
*Heures_dont_en_Double correspond aux heures de vols pour lesquelles il y a 2 utilisateurs : 1 en place gauche et 1 en place droite.
*Heures_dont_en_Solo correspond à la différence de Heures_Cette_Annee et Heures_dont_en_Double.
*Tarif_Solo dont la valeur provient de la variable ayant pour nom "$tarifSolo + le nom du type d'aéronef".
*Tarif_Double dont la valeur provient de la variable ayant pour nom "$tarifSolo + le nom du type d'aéronef".

==Liste détaillée des personnes liée pour chaque nombre d'adhérents==

Dans l'affichage des statistiques AERAL, pour les tableaux ADHERENTS PAR ACTIVITE X (avec X est une des catégories: AVION, HELICOPTERE, PLANEUR et ULM) et FORMATIONS, on associe pour chaque nombre de personnes différent de 0 un lien vers un nouvel onglet qui contient la table détaillée des personnes , cette dernière contient les informations suivantes :
*Nom
*Prénom
*Sexe
*Date de naissance
*Année de naissance
*Génération
*Colonne dynamique pour chaque type de validité cochées en cas des '''Brevetes''': cette colonne contient une icône checked verte + la date d'obtention si la personne a la validité, sinon elle est vide

=Prédictions=
Le principe de prédictions consiste à essayer de retrouver les paramètres nécessaires au remplissage du formulaire de statistiques AERAL en recherchant dans la base de données des mots clés spécifiques pour chaque référence.

Liste des prédictions utilisées par le robot OpenFlyers.

==Tarifs==
===Tarif cotisation===
Le robot OpenFlyers cherche dans la liste des variables '''Admin > Ventes > Variables > Définition''' les occurrences :
#'''cotisation'''
#'''cotisation club'''
#'''cotisation <nom de la structure>'''

===Tarif droit d'entrée===
Le robot OpenFlyers cherche dans la liste des variables '''Admin > Ventes > Variables > Définition''' les occurrences :
#'''Droit d'entrée'''
#'''Tarif entrée'''

===Tarif instruction===
Le robot OpenFlyers cherche dans la liste des variables '''Admin > Ventes > Variables > Définition''' les occurrences :
#'''Tarif instruction'''

===Remise cotisation jeune===
Le robot OpenFlyers cherche dans la liste des variables '''Admin > Ventes > Variables > Définition''' les occurrences :
#'''Remise cotisation jeune'''

==Qualifications==
Le robot OpenFlyers cherche dans la liste des variables '''Admin > Ventes > Variables > Définition''' les occurrences :
#'''PPL'''
#'''Brevet de base'''
#'''CPL'''
#'''ATPL'''
#'''Brevet ULM'''

==Profils==
===Non Pilotes===
Le robot OpenFlyers cherche dans la liste des profils '''Admin > Utilisateur > Profils''' les occurrences :
#'''Honoraire'''
#'''Non pilote'''

===Instructeurs===
Le robot OpenFlyers cherche dans la liste des profils '''Admin > Utilisateur > Profils > Réservations''' les profils qui ont les deux droits suivants:
#'''Planning personnel'''
#'''Planning individuel visible pour les autres'''

==Types d'activités==
Le robot OpenFlyers cherche dans la liste des variables '''Admin > Ventes > Variables > Définition''' des occurrences spécifiques pour chaque type d'activité :

IFR :
#'''IFR'''
#'''IFR-FR'''

Instruction :
#'''Instruction'''
#'''Double commande'''

Navigation :
#'''Navigation'''

Nuit :
#'''Nuit'''
#'''Vol de nuit'''

VFR jour navigation :
#'''VFR jour navigation'''

VFR nuit :
#'''VFR nuit'''

Solo supervisé :
# '''Solo supervisé'''

=Non-conformités=
==Ce numéro de licence FFA n'a pas été certifié par SMILE et ne sera donc pas pris en compte lors de l'export==
Si la validité correspondant à la licence FFA n'est pas spécifiée ou si les numéros de licence FFA dans les tableaux [[#Bureau_2|BUREAU]] et [[#Instructeurs|INSTRUCTEURS]] n'ont pas été validés par l'API FFA, ces licences seront signalées en rouge avec le message d'erreur '''Ce numéro de licence FFA n'a pas été certifié par SMILE et ne sera donc pas pris en compte lors de l'export''' en bas du tableau, et le JSON envoyé à SMILE ne les inclura pas.

Pour corriger cette non-conformité, il est nécessaire que la validité associée à la licence FFA soit configurée pour être certifiée via l'API FFA dès que toute la colonne 'Numero_Licence_FFA' est signalée en rouge. Pour les numéros de licence FFA affichés en rouge, la certification par l'API FFA est impérative. En guise de solution, il est envisageable de forcer la certification par l'API FFA en naviguant vers Gestion > Utilisateurs > Validités.

==Heures de vol pour les utilisateurs ayant le sexe '''Indéfini'''==
Dans les blocs Activité en instruction ET Activité hors instruction, s'il y a des heures de vol liées au sexe indéfini, nous ajoutons des lignes supplémentaires où nous stockons les heures sans celles du sexe indéfini.

Pour corriger cette non-conformité, le bon sexe (M/F) doit être renseigné pour les utilisateurs ayant des vols enregistrés.

==Numéro de licence FFA non renseigné==
Dans les blocs INSTRUCTEURS et BUREAU, si l'utilisateur n'a pas le Numéro de licence FFA la case s'affiche en rouge pour indiqué la nécessité de renseigner les numéros de licence FFA pour faire la correspondance côté SMILE FFA.

Pour corriger cette non-conformité, le bon Numéro de licence FFA doit être renseigné pour le personnel de BUREAU et les instructeurs.

Interfaçage OpenFlyers et Teltonika

2024-10-02T17:27:08Z

Lhenry:

=Présentation=
L'objet de cette page est de présenter l'interfaçage d'OpenFlyers avec les boitiers [https://teltonika-networks.com/ Teltonika].

;Trackers testés par OpenFlyers
*[https://wiki.teltonika-gps.com/view/FMC125 Teltonika FMC 125]
*[https://wiki.teltonika-gps.com/view/FMC130 Teltonika FMC 130] comporte des entrées supplémentaires

Ce sont des modèles 4G multi-systèmes satellitaires (GPS, GLONASS et Galileo).

;Certificats
*https://wiki.teltonika-gps.com/view/FMC125_Certification_%26_Approvals
*https://wiki.teltonika-gps.com/view/FMC130_Certification_%26_Approvals

;Compatibilité avec l'aéronautique
*Pour les ULMs, il n'y a pas de réglementation particulière
*Pour les aéronefs certifiés ELA2 (aéronef léger européen dont la masse maximale au décollage ne dépasse pas 2 tonnes), la réglementation EASA [https://www.easa.europa.eu/en/document-library/certification-specifications/cs-stan-issue-4 CS-STAN version 4], chapitre "Standard Change CS-SC106b" (installation of flight-time recorders), impose que les appareils installés à demeure sur l'aéronef ne dépassent pas une puissance d'émission de 100mW dès lors que l'aéronef est en mouvement. La documentation de certification Teltonika indique une puissance d'émission de 26,05dBm soit 402mW.

Il existe à l'heure actuelle 2 solutions :
*Rajouter au boitier Teltonika un boitier d'alimentation autonome disposant de sa propre batterie (solution testée par OpenFlyers)
*Rajouter au boitier Teltonika un boitier d'interfaçage à une alimentation standardisée et installer sur l'aéronef ce type d'alimentation permettant au boitier de ne pas être considéré comme fixé sur l'appareil (solution non testée par OpenFlyers)

OpenFlyers est ouvert à toute solution alternative qui n'émettrait pas durant le déplacement de l'aéronef et a sollicité Teltonika dans ce sens.

;Paramétrage et installation
*Paramétrer le boitier pour qu'il envoie les données sur le serveur de réception des données OpenFlyers prévu à cet effet
*Équiper le boitier avec une carte SIM pour l'envoi des données
*Brancher le boitier sur la batterie via une connectique amovible de l'aéronef ou de façon autonome

Pour la carte SIM, il existe une multitude de solutions. Ces prestataires fournissent une carte SIM avec un abonnement de type "Internet des Objets" (IoT "Internet of Things") en anglais) permettant de ne faire que du transfert de données et qui est multi-opérateurs. A noter, que le tracker prend le meilleur des réseaux disponibles.

;Exemples de fournisseurs de cartes SIM
*[https://www.korewireless.com/super-sim-card Kore Super SIM] a un cout de $2 par mois et le coût des data est de $0,10 par Mo
*[https://www.thingsmobile.com/fr/private/solutions/carte-sim-gps-tracker Things Mobile "Carte SIM pour GPS Tracker"] a un coût de 0,12 €/Mo

=Variables pour les formules de calcul=
Les variables suivantes sont utilisables dans les formules :

*TELTONIKA_ENGINE_START : Datetime de décollage
*TELTONIKA_OFFBLOCK_DATE : Datetime de départ bloc
*TELTONIKA_ONBLOCK_DATE : Datetime de bloc arrivée
*TELTONIKA_ENGINE_STOP : Datetime d'atterrissage
Ces variables sont directement transmises par Teltonika.

Les fonctions suivantes peuvent être utilisées dans les formules pour le [[Configuration#Gestion-de-Teltonika|paramétrage de Teltonika]] :
*[[Formules-de-calcul#formatDate('patron',-'date')|formatDate]] : Permet de formater une date
*[[Formules-de-calcul#roundCeil(X,Y)|roundCeil]] : Arrondi à la minute supérieure la date transmise en paramètre
*[[Formules-de-calcul#roundFloor(X,Y)|roundFloor]] : Arrondi à la minute inférieure la date transmise en paramètre
*[[Formules-de-calcul#strtotime(string)|strtotime]] : Transforme une date en timestamp

=Procédure=
==Configurer le tracker==
;Prérequis
*Avoir [[#Initialiser-le-tracker|initialisé le tracker]]

;Procédure
Pour paramétrer le tracker il faut le connecter avec un PC.
*Il faut ouvrir le boitier du tracker et connecter un câble micro USB

[[File:Connexion_pour_configuration.jpg|File:Connexion_pour_configuration.jpg]]

*Aller sur le site de Teltonika pour télécharger la dernière version du [https://wiki.teltonika-gps.com/view/Teltonika_Configurator_versions programme de configuration]
*Reconnecter le tracker sur son bloc d’alimentation et le mettre sous tension
*Lancer le programme Teltonika Configurator, la page d’accueil doit détecter automatiquement le tracker connecté.
*Double-cliquer sur le device détecté

[[File:Menu_Teltonika.JPG|File:Menu_Teltonika.JPG]]

*Cliquer sur '''Load from file''' et charger le fichier de configuration fourni par OpenFlyers
*Beaucoup de paramètres sont disponibles, ne pas les modifier sans avertir OpenFlyers
*Cliquer sur '''Save to device'''
*Débrancher le câble et refermer le tracker

Voir la documentation Teltonika pour la description des [https://wiki.teltonika-gps.com/view/FMC125_Configuration paramètres]

==Initialiser le tracker==
;Références
*[https://wiki.teltonika-gps.com/images/0/05/QM-FMC125.pdf documentation officielle]
*[https://wiki.teltonika-gps.com/view/FMC125_First_Start Premier démarrage]

;Procédure
*Ouvrir le tracker en écartant les clips latéraux
*Insérer une carte SIM au format mini (2FF : 25mm x 15mm) dans le slot inférieur. Coin coupé vers l’avant et contact vers le bas
*Ne pas connecter la batterie de secours située sous le circuit imprimé
*Refermer le tracker
*Brocher le tracker sur le bloc d’alimentation

L'alimentation du tracker Teltonika FMC 125 peut être faite par une alimentation autonome sur batterie.
Voici par exemple la description de mise en œuvre d'un boitier (Conception hors OpenFlyers)

[[File:Alimentation.JPG|File:Alimentation.JPG]]

*Basculer l’interrupteur de mise sous tension vers la gauche : la diode d’état doit s’allumer en rouge. L’alimentation est sous tension mais pas le tracker
*Appuyé sur le bouton blanc : la diode d’état doit passer au vert. Le tracker est sous tension
*Sur la face arrière du tracker les diodes d’état doivent s’allumer. La diode de droite indique la connexion au réseau cellulaire, celle de gauche la connexion au système satellitaire. Diode fixe pas de connexion, clignotant connexion établie
*En cas de chute de tension sous le seuil de décharge, le boitier se met en sécurité, la diode d'état repasse au rouge. Il faut recharger le boitier sinon il y a risque de destruction des batteries

==Interfacer OpenFlyers avec Teltonika==
*Aller dans '''Admin > Structure > Paramétrage > Activités'''
**Activer l'interrupteur '''Teltonika''' situé dans la 4ème colonne
**Renseigner les champs '''Nom d'utilisateur''' et '''Mot de passe'''.
**Cliquer sur le bouton '''Enregistrer'''
*[[Gestion-des-ressources#Saisir-le-numéro-de-ressource-pour-l'API-de-geolocalisation|Configurer le numéro de l'API de géolocalisation pour les ressources]].

=Récupération des vols Teltonika=
Chaque minute, le robot OpenFlyers interroge le serveur Teltonika pour vérifier s'il y a de nouveaux vols enregistrés. S'il y en a, ces vols sont sauvegardés dans OpenFlyers et les vols récupérés du côté de Teltonika sont marqués comme '''collected''' via la demande '''/confirmTrack'''.

Teltonika utilise un système d'identifiant pour retrouver les pilotes et les aéronefs il est donc nécessaire de créer les champs métiers nécessaires et de les renseigner dans l'interface d'OpenFlyers.

*Si l'identifiant d'un aéronef chez Teltonika ne peut être retrouvé dans OpenFlyers alors le robot n'enregistrera pas le vol.

Afin de retrouver un maximum d'informations le robot tente de retrouver une réservation avec la même ressource correspondant au vol communiqué par Teltonika:
*Il vérifie l'existence d'une réservation avec des horaires incluant l'heure médiane du vol Teltonika. En cas de présence, il se réfère aux informations de cette réservation.
*En l'absence de toute réservation, il recherche une réservation avec la même ressource dont les horaires se situent entre le début et la fin du vol remonté par Teltonika.
**S'il y a plusieurs réservations, alors il n'en prend aucune.
**Dès qu'une réservation correspondant au vol remonté par Teltonika est identifiée, les informations de cette réservation sont prises en compte par le robot.

;Exemple
Pour un vol qui commence à 16h05 et se termine à 17h00, l'heure médiane est 16h32. La réservation correspondante pour ce vol sera celle qui inclut cette heure médiane.

==Statut des pilotes==
Pour chaque pilote :
*Si un vol récupéré dans Teltonika peut être associé à une réservation => Les statuts des pilotes sont celles définies dans la réservation.
*Si le vol ne peut être associé :
**S'il n'y a qu'un statut autorisé pour la place du pilote et pour l'avion => Le statut du pilote est ce statut.
**Si le pilote est sur la première place => Le statut du pilote est le statut "pilote" si il n'existe pas le premier statut.
**Si le pilote est sur la seconde place => Le statut du pilote est le statut "Instructeur" si il n'existe pas le second statut.

==Place des pilotes==
*Si un vol récupéré dans Teltonika peut être associé à une réservation => Les places des pilotes sont celles définies dans la réservation.
*Si le vol ne peut être associé :
**S'il y a un seul pilote => Sa place est celle par défaut (0, Gauche).
**S'il y a deux pilotes et que un seul à l'autorisation pour être sur la place de droite => Le pilote ayant l'autorisation est à la place de droite et l'autre à la place de gauche.
**Si les deux pilotes ont les autorisations pour être sur la place de droite => Le pilote 1 est sur la place de gauche le pilote 2 est sur la place de droite.

=FAQ=
==Le boitier se connecte au serveur OpenFlyers Teltonika mais n'envoie pas de données==
Vérifier la configuration de la box Teltonika dans cette documentation : [[#Configurer-le-tracker|Configurer le tracker]].
==Page ressource: le numéro de ressource à renseigner est-il bien l'IMEI du boîtier ?==
Oui, il faut saisir l'IMEI dans le champ "numéro de ressource"

==Page Structure > Activités: il y a un "nom utilisateur" et "Mot de passe" à renseigner. Que doit mettre à ce niveau ?==
Après avoir demandé à l'équipe d'Openflyers de créer un compte pour la plateforme sur le serveur Teltonika, insérer les identifiants fournis par Openflyers dans les champs nom d'utilisateur et mot de passe.

Interfaçage OpenFlyers et Teltonika

2024-10-02T17:26:12Z

Lhenry:

=Présentation=
L'objet de cette page est de présenter l'interfaçage d'OpenFlyers avec les boitiers [https://teltonika-networks.com/ Teltonika].

;Trackers testés par OpenFlyers
*[https://wiki.teltonika-gps.com/view/FMC125 Teltonika FMC 125]
*[https://wiki.teltonika-gps.com/view/FMC130 Teltonika FMC 130] comporte des entrées supplémentaires

Ce sont des modèles 4G multi-systèmes satellitaires (GPS, GLONASS et Galileo).

;Certificats
*https://wiki.teltonika-gps.com/view/FMC125_Certification_%26_Approvals
*https://wiki.teltonika-gps.com/view/FMC130_Certification_%26_Approvals

;Compatibilité avec l'aéronautique
*Pour les ULMs, il n'y a pas de réglementation particulière
*Pour les aéronefs certifiés ELA2 (aéronef léger européen dont la masse maximale au décollage ne dépasse pas 2 tonnes), la réglementation EASA [https://www.easa.europa.eu/en/document-library/certification-specifications/cs-stan-issue-4 CS-STAN version 4], chapitre "Standard Change CS-SC106b" (installation of flight-time recorders), impose que les appareils installés à demeure sur l'aéronef ne dépassent pas une puissance d'émission de 100mW dès lors que l'aéronef est en mouvement. La documentation de certification Teltonika indique une puissance d'émission de 26,05dBm soit 402mW.

Il existe à l'heure actuelle 2 solutions :
*Rajouter au boitier Teltonika un boitier d'alimentation autonome disposant de sa propre batterie (solution testée par OpenFlyers)
*Rajouter au boitier Teltonika un boitier d'interfaçage à une alimentation standardisée et installer sur l'aéronef ce type d'alimentation permettant au boitier de ne pas être considéré comme fixé sur l'appareil (solution non testée par OpenFlyers)

OpenFlyers est ouvert à toute solution alternative qui n'émettrait pas durant le déplacement de l'aéronef et a sollicité Teltonika dans ce sens.

;Paramétrage et installation
*Paramétrer le boitier pour qu'il envoie les données sur le serveur de réception des données OpenFlyers prévu à cet effet
*Équiper le boitier avec une carte SIM pour l'envoi des données
*Brancher le boitier sur la batterie via une connectique amovible de l'aéronef ou de façon autonome

Pour la carte SIM, il existe une multitude de solutions. Ces prestataires fournissent une carte SIM avec un abonnement de type "Internet des Objets" (IoT "Internet of Things") en anglais) permettant de ne faire que du transfert de données et qui est multi-opérateurs. A noter, que le tracker prend le meilleur des réseaux disponibles.

;Exemples de fournisseurs de cartes SIM
*[https://www.korewireless.com/super-sim-card Kore Super SIM] a un cout de $2 par mois et le coût des data est de $0,10 par Mo
*[https://www.thingsmobile.com/fr/private/solutions/carte-sim-gps-tracker Things Mobile "Carte SIM pour GPS Tracker"] a un coût de 0,12 €/Mo

=Variables pour les formules de calcul=
Les variables suivantes sont utilisables dans les formules :

*TELTONIKA_ENGINE_START : Datetime de décollage
*TELTONIKA_OFFBLOCK_DATE : Datetime de départ bloc
*TELTONIKA_ONBLOCK_DATE : Datetime de bloc arrivée
*TELTONIKA_ENGINE_STOP : Datetime d'atterrissage
Ces variables sont directement transmises par Teltonika.

Les fonctions suivantes peuvent être utilisées dans les formules pour le [[Configuration#Gestion-de-Teltonika|paramétrage de Teltonika]] :
*[[Formules-de-calcul#formatDate('patron',-'date')|formatDate]] : Permet de formater une date
*[[Formules-de-calcul#roundCeil(X,Y)|roundCeil]] : Arrondi à la minute supérieure la date transmise en paramètre
*[[Formules-de-calcul#roundFloor(X,Y)|roundFloor]] : Arrondi à la minute inférieure la date transmise en paramètre
*[[Formules-de-calcul#strtotime(string)|strtotime]] : Transforme une date en timestamp

=Procédure=
==Configurer le tracker==
;Prérequis
*Avoir [[#Initialiser-le-tracker|initialisé le tracker]]

;Procédure
Pour paramétrer le tracker il faut le connecter avec un PC.
*Il faut ouvrir le boitier du tracker et connecter un câble micro USB

[[Fichier:Connexion_pour_configuration.jpg|File:Connexion_pour_configuration.jpg]]

*Aller sur le site de Teltonika pour télécharger la dernière version du [https://wiki.teltonika-gps.com/view/Teltonika_Configurator_versions programme de configuration]
*Reconnecter le tracker sur son bloc d’alimentation et le mettre sous tension
*Lancer le programme Teltonika Configurator, la page d’accueil doit détecter automatiquement le tracker connecté.
*Double-cliquer sur le device détecté

[[Fichier:Menu_Teltonika.JPG|File:Menu_Teltonika.JPG]]

*Cliquer sur '''Load from file''' et charger le fichier de configuration fourni par OpenFlyers
*Beaucoup de paramètres sont disponibles, ne pas les modifier sans avertir OpenFlyers
*Cliquer sur '''Save to device'''
*Débrancher le câble et refermer le tracker

Voir la documentation Teltonika pour la description des [https://wiki.teltonika-gps.com/view/FMC125_Configuration paramètres]

==Initialiser le tracker==
;Références
*[https://wiki.teltonika-gps.com/images/0/05/QM-FMC125.pdf documentation officielle]
*[https://wiki.teltonika-gps.com/view/FMC125_First_Start Premier démarrage]

;Procédure
*Ouvrir le tracker en écartant les clips latéraux
*Insérer une carte SIM au format mini (2FF : 25mm x 15mm) dans le slot inférieur. Coin coupé vers l’avant et contact vers le bas
*Ne pas connecter la batterie de secours située sous le circuit imprimé
*Refermer le tracker
*Brocher le tracker sur le bloc d’alimentation

L'alimentation du tracker Teltonika FMC 125 peut être faite par une alimentation autonome sur batterie.
Voici par exemple la description de mise en œuvre d'un boitier (Conception hors OpenFlyers)

[[Fichier:Alimentation.JPG|File:Alimentation.JPG]]

*Basculer l’interrupteur de mise sous tension vers la gauche : la diode d’état doit s’allumer en rouge. L’alimentation est sous tension mais pas le tracker
*Appuyé sur le bouton blanc : la diode d’état doit passer au vert. Le tracker est sous tension
*Sur la face arrière du tracker les diodes d’état doivent s’allumer. La diode de droite indique la connexion au réseau cellulaire, celle de gauche la connexion au système satellitaire. Diode fixe pas de connexion, clignotant connexion établie
*En cas de chute de tension sous le seuil de décharge, le boitier se met en sécurité, la diode d'état repasse au rouge. Il faut recharger le boitier sinon il y a risque de destruction des batteries

==Interfacer OpenFlyers avec Teltonika==
*Aller dans '''Admin > Structure > Paramétrage > Activités'''
**Activer l'interrupteur '''Teltonika''' situé dans la 4ème colonne
**Renseigner les champs '''Nom d'utilisateur''' et '''Mot de passe'''.
**Cliquer sur le bouton '''Enregistrer'''
*[[Gestion-des-ressources#Saisir-le-numéro-de-ressource-pour-l'API-de-geolocalisation|Configurer le numéro de l'API de géolocalisation pour les ressources]].

=Récupération des vols Teltonika=
Chaque minute, le robot OpenFlyers interroge le serveur Teltonika pour vérifier s'il y a de nouveaux vols enregistrés. S'il y en a, ces vols sont sauvegardés dans OpenFlyers et les vols récupérés du côté de Teltonika sont marqués comme '''collected''' via la demande '''/confirmTrack'''.

Teltonika utilise un système d'identifiant pour retrouver les pilotes et les aéronefs il est donc nécessaire de créer les champs métiers nécessaires et de les renseigner dans l'interface d'OpenFlyers.

*Si l'identifiant d'un aéronef chez Teltonika ne peut être retrouvé dans OpenFlyers alors le robot n'enregistrera pas le vol.

Afin de retrouver un maximum d'informations le robot tente de retrouver une réservation avec la même ressource correspondant au vol communiqué par Teltonika:
*Il vérifie l'existence d'une réservation avec des horaires incluant l'heure médiane du vol Teltonika. En cas de présence, il se réfère aux informations de cette réservation.
*En l'absence de toute réservation, il recherche une réservation avec la même ressource dont les horaires se situent entre le début et la fin du vol remonté par Teltonika.
**S'il y a plusieurs réservations, alors il n'en prend aucune.
**Dès qu'une réservation correspondant au vol remonté par Teltonika est identifiée, les informations de cette réservation sont prises en compte par le robot.

;Exemple
Pour un vol qui commence à 16h05 et se termine à 17h00, l'heure médiane est 16h32. La réservation correspondante pour ce vol sera celle qui inclut cette heure médiane.

==Statut des pilotes==
Pour chaque pilote :
*Si un vol récupéré dans Teltonika peut être associé à une réservation => Les statuts des pilotes sont celles définies dans la réservation.
*Si le vol ne peut être associé :
**S'il n'y a qu'un statut autorisé pour la place du pilote et pour l'avion => Le statut du pilote est ce statut.
**Si le pilote est sur la première place => Le statut du pilote est le statut "pilote" si il n'existe pas le premier statut.
**Si le pilote est sur la seconde place => Le statut du pilote est le statut "Instructeur" si il n'existe pas le second statut.

==Place des pilotes==
*Si un vol récupéré dans Teltonika peut être associé à une réservation => Les places des pilotes sont celles définies dans la réservation.
*Si le vol ne peut être associé :
**S'il y a un seul pilote => Sa place est celle par défaut (0, Gauche).
**S'il y a deux pilotes et que un seul à l'autorisation pour être sur la place de droite => Le pilote ayant l'autorisation est à la place de droite et l'autre à la place de gauche.
**Si les deux pilotes ont les autorisations pour être sur la place de droite => Le pilote 1 est sur la place de gauche le pilote 2 est sur la place de droite.

=FAQ=
==Le boitier se connecte au serveur OpenFlyers Teltonika mais n'envoie pas de données==
Vérifier la configuration de la box Teltonika dans cette documentation : [[#Configurer-le-tracker|Configurer le tracker]].
==Page ressource: le numéro de ressource à renseigner est-il bien l'IMEI du boîtier ?==
Oui, il faut saisir l'IMEI dans le champ "numéro de ressource"

==Page Structure > Activités: il y a un "nom utilisateur" et "Mot de passe" à renseigner. Que doit mettre à ce niveau ?==
Après avoir demandé à l'équipe d'Openflyers de créer un compte pour la plateforme sur le serveur Teltonika, insérer les identifiants fournis par Openflyers dans les champs nom d'utilisateur et mot de passe.

Accueil

2024-09-06T17:51:20Z

Lhenry:

Bienvenue sur la [[Toutes les documentations|documentation]] d''''OpenFlyers version 4'''.

You can also access to our [[OF-doc-en:Main-Page|english documentation]].

__TOC__

=Présentation=
[https://www.youtube.com/watch?v=-lqPyrtf1i4 Présentation vidéo OpenFlyers]

OpenFlyers :
*[[Introduction]]
*[[Présentation d'OpenFlyers 4]]
*[[Compte client OpenFlyers et modèle commercial]]
**[[Compte-client-OpenFlyers-et-modèle-commercial#Plateforme-supplémentaire-de-test-(bac-à-sable)|Plateforme supplémentaire de test (bac à sable)]]
*[[Plateforme de démonstration]]
*[[Bien communiquer avec OpenFlyers]]
*[[Formations OpenFlyers]]
*[[Historique des versions]]
*[[Normes et réglementations]]
*[[Technologies de géolocalisation aéronautique]]

Installation :
*[[Créer une plateforme OpenFlyers pour sa structure]]
*[[Bien débuter avec OpenFlyers]]
*[[Compatibilité des navigateurs]]
*[[Paiement en ligne|Paiement en ligne (TPE virtuel)]]

[[Rapporter un bug]]

[[Trucs et astuces]] :
*[[Kiosque PC|Mettre en place un PC kiosque]]
*[[Réseau Internet hybride|Mettre en place un réseau internet hybride]]

=Tutoriels vidéos=
Vidéos tutorielles disponibles sur la [https://www.youtube.com/user/OpenFlyersFr chaîne YouTube OpenFlyers] :
*[https://www.youtube.com/watch?v=Mx8xxsWdaC8&t=31s Analyse automatisée des factures fournisseurs]
*[https://www.youtube.com/watch?v=_hjOHHXP_ig Clôturer la comptabilité]
*[https://www.youtube.com/watch?v=X9bIEzxXIDw&ab_channel=OpenFlyers Créer une plateforme bac à sable]
*[https://www.youtube.com/watch?v=VVCdPWlwglM&ab_channel=OpenFlyers Importer un relevé bancaire]
*[https://www.youtube.com/watch?v=Bgb32Ay6TVU Lettrer des écritures comptables]
*[https://www.youtube.com/watch?v=kUvWhUXyC5Q&ab_channel=OpenFlyers Ouvrir dans un nouvel onglet]
*[https://www.youtube.com/watch?v=8J-AEtHrPqg Paiement à la réservation]
*[https://www.youtube.com/watch?v=pjuE6h0yXJA&ab_channel=OpenFlyers Saisir un flux]
*[https://www.youtube.com/watch?v=QVUgYEfqDk0&t=1s&ab_channel=OpenFlyers Saisir une facture fournisseur]
*[https://www.youtube.com/watch?v=qNACMM6vv7sI Utilisation du menu]
*[https://www.youtube.com/watch?v=tzM6hyOIpnc Utilisation du planning de réservation]
*[https://www.youtube.com/watch?v=YylSewaTm4c Utilisation des tableaux]

=Documentation Administrateurs=
[[Compte-client-OpenFlyers-et-modèle-commercial#Plateforme-supplémentaire-de-test|Créer une plateforme supplémentaire de test (bac à sable)]]

[[Configuration]]

[[Paramétrage]]

[[Champs métiers]]

[[Formules de calcul]]

Alertes :
*[[Alertes administrateur|Alertes administrateur]]
*[[Alertes de configuration]]
*[[Alertes utilisateur]]

Activité :
*[[Gestion des activités]]
*[[Gestion des types d'activités]]
*[[Règles de saisie]]

[[Communications]]

Comptabilité :
*Documentation générale :
**[[Comptabilité|Généralités sur la comptabilité]]
**[[Conseils spécifiques pour la comptabilité]]
**[[Écritures comptables]]
**[[Gestion des écritures comptables]]
*Configuration et utilisation :
**[[Configuration de la comptabilité]]
**[[Exporter un relevé bancaire depuis un site internet de banque]]
**[[Gestion des budgets]]
**[[Import dans un logiciel comptable tiers]]
**[[Utilisation de la comptabilité]]
*Documentation de référence :
**[[OF-doc-en::Accounting-export-template-list|Modèle de format d'export comptable]]
**[[Modèles de format d'import de relevé bancaire]]
**[[Modèle de facture ODT|Template ODT pour les factures]]

[[Contrôle des accès]] :
*[[Installation armoire à clés]]
*[[Gestion armoire à clés]]
*[[FAQ armoire à clés]]

[[Données]] et [[Règlement Général sur la Protection des Données|Règlement Général sur la Protection des Données (RGPD)]]

Documents :
*[[Gestion des documents]]

[[Facturation des clients]] :
*[[Gestion de la facturation des activités]]
*[[Gestion des produits et des ventes]]

Facturation fournisseur :
*[[Exporter les factures bancaires depuis un site internet de banque]]
*[[Gestion des achats]]

Formation :
*[[Gestion des formations]]
*[[Utilisation des formations]]

Géolocalisation :
*[[Interfaçage OpenFlyers et Charterware]]
*[[Interfaçage OpenFlyers et ClickAndTakeoff]]
*[[Interfaçage OpenFlyers et Gesasso]]
*[[Interfaçage OpenFlyers et Teltonika]]

[[Logs]]

Maintenance :
*[[Maintenance aéronautique]]
*[[Suivi-de-maintenance|Suivi de maintenance]]
*[[Suivi des remarques de maintenance]]

Rapports :
*[[AERAL]]
*[[Bibliothèque des rapports]]
*[[Fonctionnement du moteur des rapports]]
*[[Gestion des rapports]]

Réservations externes :
*[[Configuration des réservations externes]]
*[[Utilisation des réservations externes]]

[[Gestion des ressources|Ressources]]

[[Gestion des stocks|Stocks]]

[[Tableurs]]

Utilisateurs :
*[[Gestion des utilisateurs]]
*[[Gestion des profils]]
*[[Liste de diffusion]]
*[[Mailing]]
*[[Suivi des emails]]

[[Validités]] :
*[[Paramétrage des validités]]

Documentation Webmasters et Développeurs :
*[[API OpenFlyers]]
*[[Interfaçage OpenFlyers et armoire à clés]]
*[[OpenSSL]]
*[[Récupération des vols par un logiciel tiers]]
*[[Structure de la base de données]]

=Documentation Utilisateurs=
[[Actions]]

[[Gestion des activités|Activités]] :
*[[Carnet de route]]
*[[Carnet de vol]]

Alertes et messages :
*[[Présentation générale des alertes|Aspect]]
*[[Alertes de configuration]]
*[[Alertes utilisateur]]

[[Airmate]]

[[Connexion]]

[[Documents]]

[[Ergonomie]] :
*[[Barre supérieure]]
*[[Boîtes de dialogue]]
*[[Calendrier]]
*[[Formulaires]]
*Menu de navigation :
**[[Menu de navigation|Menu de l'interface légère]]
**[[Menu de l'interface dynamique]]

[[Envoi des emails]]

[[Éphémérides]]

[[Fiche personnelle]]

[[Gestion de la comptabilité côté utilisateur]]

[[Navigateurs]]

Rapports :
*[[Bibliothèque des rapports]]

Réservations :
*[[Aspect du planning de réservation]]
*[[Gestion des disponibilités|Disponibilités]]
*[[Panier de réservation]]
*[[Planning (interface légère)]]
*[[Utilisation du planning de réservation]]

[[Utilisation des réservations externes|Réservations externes]]

Tableaux :
*[[Tableaux|Tableaux de l'interface légère]]
*[[Tableaux de l'interface dynamique|Tableaux de l'interface dynamique]]

[[Validités]]

[[Gestion des ventes côté utilisateur]]

=[[Appli OpenFlyers]]=

=[[Glossaire]]=

=FAQ=
*[[FAQ administrateur]]
*[[FAQ AeroBox]]
*[[FAQ armoire à clés]]
*[[FAQ client]]
*[[FAQ comptabilité]]
*[[FAQ export]]
*[[Liste-de-diffusion#Questions-fréquentes|FAQ liste de diffusion]]
*[[FAQ utilisateur]]
*[[Interfaçage-OpenFlyers-et-Teltonika#FAQ|FAQ Teltonika]]

MediaWiki:Sidebar

2024-09-06T17:38:47Z

Lhenry:

Test

2024-09-06T17:36:46Z

Lhenry:

[[OF-doc4-fr:Accueil]]

Test

2024-09-06T17:36:18Z

Lhenry:

[[OF-doc-en:Main-Page4]]

Test

2024-09-06T17:36:05Z

Lhenry: Created page with "[OF-doc-en:Main-Page4]"

[OF-doc-en:Main-Page4]

MediaWiki:Mainpage

2024-09-06T17:16:56Z

Lhenry: Created page with "Accueil"

Accueil

Utilisation de la comptabilité

2024-09-06T16:38:17Z

Lhenry: Text replacement - "OF_doc-en" to "OF-doc-en"

__TOC__
=Présentation=
L'objet de cette page est de décrire la saisie des opérations de [[Comptabilité|comptabilité]] dans la [[Accueil|version 4 d'OpenFlyers]].

==Date par défaut dans les formulaires==
La date proposée par défaut dans les formulaires de saisie (saisie des factures fournisseurs, saisie des transferts de compte à compte, etc.) est la date de la dernière écriture enregistrée.

==Définitions==
===Compte d'export===
Pour chaque compte, il faut [[Configuration de la comptabilité#Définir_les_comptes_d'export|préciser un compte d'export]] qui sert dans le cas où on exporte la comptabilité vers un autre logiciel de comptabilité.

Cela sert également si on souhaite éditer une comptabilité depuis OpenFlyers et son module de gestion des rapports tout en respectant un plan comptable codifié.

=Clôturer l'exercice comptable=
[https://www.youtube.com/watch?v=_hjOHHXP_ig Vidéo tutorielle pour clôturer une comptabilité]

''Attention : la clôture de la comptabilité ne doit être effectuée qu'une fois qu'on est sûr et certain de ne plus avoir à intervenir sur l'exercice à clôturer. Cette opération doit donc être temporisée dans le temps sachant qu'il est tout à fait possible de poursuivre son activité sur l'exercice suivant sans que l'exercice précédent ne soit clôturé.''

OpenFlyers affiche une [[Alertes de configuration#L'exercice_comptable_courant_a_plus_d'un_an|alerte lorsque l'exercice en cours est ouvert depuis 400 jours]].

Avant de clôturer, il faut :
*Si le bilan est effectué dans OpenFlyers, [[Écritures comptables#Écritures_de_fin_d'exercice_avant_la_clôture_de_la_comptabilité|saisir les écritures de fin d'exercice]]
*[[#Solder-les-comptes|Solder les comptes d'exploitation]].
*[[Utilisation-de-la-comptabilité#Valider-toutes-les-écritures|Valider toutes les écritures antérieures à la date de clôture]].
En effet, on ne peut clôturer qu'une période pour laquelle toutes les écritures comptables ont été validées sinon cela engendre [[Alertes-administrateur#Alertes-lors-de-la-clôture-de-la-comptabilité|des alertes]]. Si des comptes n'ont pas été [[#Solder-les-comptes|soldés]] alors un [[Alertes-administrateur#Alertes-lors-de-la-clôture-de-la-comptabilité|message d'alerte]] apparaitra. Il n'est également pas possible de clôturer sur une date future.

Ensuite, pour clôturer :
*Aller dans '''Gestion > Comptes > Exercice > Clôturer'''.
*Dans la première colonne, la date de début de l'exercice comptable est renseignée ainsi qu'un tableau intitulé '''Statistiques''' fournit des informations sur les écritures. Sa lecture est indispensable pour vérifier qu'il ne subsiste pas d'écriture non validée antérieures à la fin de la période de clôture souhaitée. Si tel est le cas, la date sera affichée en rouge. Dans ce scénario, il est nécessaire de localiser les écritures non validées et de les valider en utilisant le bouton "Aller vers la première écriture comptable non validée" pour les écritures comptables non validées, ou le bouton "Aller vers la première activité non validée" pour les activités non validées.
*Dans la deuxième colonne intitulée '''Gestion de l'exercice comptable''', renseigner le champ '''Date de clôture'''.
La date de début de nouvel exercice est automatiquement actualisée.

Pour une structure qui a un exercice annuel correspondant à l'année civile les dates devraient être 31/12/XXXX et 01/01/XXXX+1
*Cliquer sur le bouton '''Clôturer l'exercice puis ouvrir un nouvel exercice'''.

En cas d'erreur de clôture, il est possible de [[#Déclôturer-l'exercice-comptable|Déclôturer le dernier exercice clôturé]].

=Créer un tarif pour la facturation des activités=
*'''Admin > Ventes > Variables > Définition'''
*Cliquer sur le bouton '''Ajouter'''
*Champ '''Nom de variable''', renseigner un nom de variable sous la forme ''tarifSoloXXXX'' en remplaçant XXXX par le nom du type de ressource pour lequel le tarif doit s'appliquer. Exemple : ''tarifSoloDR42''. Il est primordial de respecter la casse (c'est à dire les majuscules et minuscules).
*Champ '''Intitulé''', renseigner le nom en clair de la variable sous la forme ''Tarif Solo XXXX'' en remplaçant XXXX par le nom du type de ressource pour lequel le tarif doit s'appliquer.
*Champ '''Type de valeur''', laisser ''Nombre à virgule''
*Cliquer sur le bouton '''Enregistrer'''

Il faut ensuite associer une valeur au tarif :
*'''Admin > Ventes > Variables > Actualisation'''
*Cliquer sur le bouton '''Ajouter une nouvelle valeur à une variable existante''' en bas du tableau
*Champ '''Nom de variable''', sélectionner le nom de la variable précédemment créé
*Champ '''Valeur''', renseigner le tarif à associer à la variable
*Champ '''Date de début''', laisser la date renseignée par défaut : elle correspond à la date de début d'exercice comptable et permet de ne pas avoir de "trou tarifaire"
*Cliquer sur le bouton '''Enregistrer'''

=Déclôturer l'exercice comptable=
;Prérequis
*Disposer du droit [[Gestion-des-profils#Gestion-des-comptabilités|Gestion des comptabilités]]

;Procédure
*Aller dans '''Gestion > Comptes > Exercice > Déclôturer'''.
*Activer l'interrupteur '''Autoriser la déclôture de l'exercice''', le bouton '''Supprimer''' devient opérationnel sur la première ligne du tableau, qui correspond à la dernière clôture (la date la plus récente).
*Cliquer sur le button '''Supprimer'''.

'''NB''': Il n'est pas permis de déclôturer l'exercice comptable en cas d'une seule clôture comptable.

=Éditions=
==Compte de résultat==
;Description

;Utilisation
*Aller dans '''Gestion > Comptes > Gestion > Compte de résultat'''
*Sélectionner l'année souhaitée
*Cliquer sur le bouton '''Visualiser'''

'''/!\ Si les écritures de mise à 0 des comptes d'exploitation ont été passées, l'affichage indiquera que des valeurs à 0 pour les exercices précédents'''

==Grand livre==
;Description
Le [https://fr.wikipedia.org/wiki/Grand_livre grand livre] sert à lister l'ensemble des écritures comptables sur une période donnée dans l'ordre chronologique où ils ont lieu et l'ordre des numéros des flux. Il présente pour chaque compte :
* Le solde initial
* La liste des écritures
* Le solde final

;Utilisation
*Aller dans '''Gestion > Comptes > Gestion > Grand livre'''
*Choisir la date de début '''du'''
*Choisir la date de fin '''au'''
*Sélectionner le '''Compte d'export de début'''
*Sélectionner le '''Compte d'export de fin'''
*Cliquer sur le bouton '''Sauver dans un fichier CSV'''

'''/!\ Le grand livre n'affiche que les comptes ayant eu au moins une écriture comptable sur la période donnée.'''

=Exporter la comptabilité=
''Conseil OpenFlyers : l'export de la comptabilité nécessite au préalable des actions irréversibles comme la validation de l'ensemble des écritures. Pour les personnes débutantes avec cette fonction et qui souhaite pouvoir exporter sans effectuer ces actions irréversibles, il est recommandé de [[Compte-client-OpenFlyers-et-modèle-commercial#Plateforme-supplémentaire-de-test|s'entrainer avec le bac à sable]] en effectuant une recopie de sa plateforme de production.''

Pour les exports comptable, la date de début d'export proposée par défaut correspond à la date du mouvement le plus vieux qui n'ait pas été encore exporté.
==Actions à effectuer par ordre chronologique==
OpenFlyers permet d'exporter uniquement les [[Bien débuter avec OpenFlyers#Validation_des_écritures|écritures validées]] et ainsi ne propose par défaut comme période d'export que la période maximum exportable ne contenant que des écritures validées.

Les exports se font généralement à intervalle régulier : tous les mois, tous les trimestres ou tous les ans.

Si vous n'avez pas de logiciel de comptabilité, il est recommandé d'effectuer quand même l'export et de l'archiver sur un support de stockage (disque dur par exemple) pour conservation.

Dans le cas du dernier export d'un exercice comptable donné, il est important de décider avant l'export si tout ou partie des écritures de fin d'exercice doivent être réalisées avant ou après. En général, si l'export sert ensuite à être retravaillé dans un logiciel de comptabilité, alors les écritures de fin d'exercice seront réalisées dans le logiciel de comptabilité et il ne faudra faire le "nettoyage" côté OpenFlyers qu'à l'issue de l'export comptable officiel. Ainsi les points 2 et 3 des "Opérations à effectuer avant tout export" ci-dessous doit être, dans certains cas, réalisé en partie ou en totalité après le point 2 des "Opérations supplémentaires pour l'export de fin d'exercice" ci-dessous.

De plus, si vous utilisez un logiciel de comptabilité uniquement pour le bilan, c'est à dire que les charges sont gérées dans OpenFlyers, alors la clôture dans OpenFlyers doit être faite après la clôture dans ce logiciel de comptabilité. Il est ainsi possible de vérifier que les "A nouveaux" sont identiques dans les 2 logiciels et de corriger dans OpenFlyers si nécessaire. Il existe un [[OF-doc-en:Accounting_exports_3#Carry_forwards|rapport qui permet d'avoir les à nouveaux]].

Prérequis à tout export comptable :
*[[Configuration de la comptabilité#Comptes_d'export|Attribuer les comptes d'export]] pour ne pas avoir l'alerte "[[#Vous_ne_pouvez_exporter_car_il_y_a_des_comptes_sans_valeur_d'export|Vous ne pouvez exporter car il y a des comptes sans valeur d'export]]".

Opérations à effectuer pour tout export :
#[[#Retrouver-les-écritures-non-validées|Retrouver les écritures non validées]] pour [[Bien débuter avec OpenFlyers#Validation_des_écritures|les valider]]
#[[#Export_de_la_comptabilité|Export de la comptabilité]]
#[[Import dans un logiciel comptable tiers|import dans un logiciel de comptabilité]]

Opérations supplémentaires pour l'export de fin d'exercice :
#[[Écritures comptables#Écritures_de_fin_d'exercice_avant_la_clôture_de_la_comptabilité|Écritures de fin d'exercice avant la clôture de l'exercice]] dont le [[#Solder-les-comptes|solde des comptes d'exploitation]]
#Validation des écritures de fin d'exercice par la [[Utilisation de la comptabilité#Validation_d'un_flux|validation des flux]] correspondant.
#Ultime export pour stockage [[#Marquer_les_écritures_lors_de_l'export|en marquant les écritures]].
#[[#Clôturer-l'exercice-comptable|Clôture / ouverture du nouvel exercice comptable]].
#[[Écritures comptables#Écritures_de_début_d'exercice_après_l'ouverture_de_la_comptabilité|Écritures de début d'exercice après l'ouverture de la comptabilité]].

==Alertes générées lors d'une tentative d'[[Utilisation de la comptabilité#Export-de-la-comptabilité|export comptable]]==
===Vous ne pouvez exporter car il y a des comptes sans valeur d'export===
Cette alerte bloquante apparait dans '''Comptes > Exporter''' avec les éléments suivants :
<pre>Vous ne pouvez exporter car il y a des comptes sans valeur d'export
intitulé de compte X (type de compte Y)</pre>
Pour supprimer cette alerte, il faut [[Configuration de la comptabilité#Comptes_d'export|attribuer les comptes d'export manquants]].

==Export de la comptabilité==
Pré-requis : vérifier que le format d'export pour votre logiciel est présent dans le tableau '''Format de l'export'''. S'il n'est pas présent, [[Configuration#Formats-d'export-à-afficher|le rendre visible depuis la page Configuration]].

Pour exporter la comptabilité, il faut :
*Aller dans '''Gestion > Comptes > Gestion > Exporter'''

Dans la première colonne, le tableau '''Statistiques''' donne des informations sur les écritures. Sa lecture est indispensable pour vérifier qu'il ne subsiste pas d'écriture non validée antérieures à la fin de la période d'export souhaitée. Si c'est le cas, il faut alors [[#Retrouver-les-écritures-non-validées|trouver les écritures non validées]] et les valider.

Dans la deuxième colonne:
*Choisir la '''Comptabilité''' à exporter.
*Indiquer la période que l'on souhaite exporter.

Attention: la période proposée par défaut correspond à la plus grande période possible et ne correspond donc pas à la période souhaitée. Il faut donc modifier la date de fin.

Exemples :
*Si on souhaite exporter '''une année civile complète''', alors il faut sélectionner comme date de fin le 31 décembre.
*Si on souhaite exporter '''un mois''', il faut sélectionner comme date de fin le dernier jour du mois concerné.

Il est également possible de marquer les écritures exportées afin qu'elles ne soient plus ré-exportées. Cependant, à la place de cette zone de saisie, il peut apparaitre la liste des comptes sans [[#Compte_d'export|valeur d'export]] c'est à dire sans le numéro de compte du plan comptable. Dans ce cas, il faut d'abord rechercher le compte concerné dans '''Comptes > Lister les comptes''' puis attribuer au compte concerné une valeur d'export.
*Cocher ou non '''[[#Marquer_les_écritures_lors_de_l'export|Marquer les écritures]]'''.
*Dans la troisième colonne, sélectionner le format d'export souhaité.
*L'export s'effectue en cliquant sur le bouton '''Exporter'''.
*Il faut ensuite [[Import dans un logiciel comptable tiers|importer dans un logiciel comptable tiers]].

'''Remarques :'''
*Sauf à avoir cocher la case '''Ecritures non validées''', il n'est possible d'exporter que des écritures validées. Par conséquent, s'il subsiste des écritures non validées sur la période d'export souhaitée, alors une alerte apparait signalant qu'il n'est pas possible d'exporter la période souhaitée.
*Dans le fichier d'export, les écritures sont triées par numéro de flux.

===Exporter les écritures marquées comme exportées===
Il est possible de ré-exporter les écritures marquées comme ayant été déjà exportées (et [[#Marquer-les-écritures-lors-de-l'export|marquées comme tel]]) en cochant '''Ecritures marquées comme exportées''' dans la colonne '''Écriture'''. En cochant cette case, un message d'alerte apparait indiquant ''Attention : vous allez exporter des écritures marquées, elles ont sans doute déjà étaient importées dans la comptabilité réelle.''.

===Exporter les écritures non validées===
Il est possible d'exporter les écritures non validées en cochant '''Ecritures non validées''' dans la colonne '''Écriture'''. En cochant cette case, un message d'alerte apparait indiquant ''Attention : vous allez exporter des écritures non validées, elles ne devraient pas être importées dans la comptabilité réelle.''.

===Marquer les écritures lors de l'export===
Lors d'un export comptable, OpenFlyers donne la possibilité de marquer ou non les écritures qui vont être exportées. Cela permet :
*Soit de pouvoir ré-exporter des écritures déjà exportées (mais non marquées)
*Soit au contraire de ne plus exporter des écritures dont OpenFlyers sait qu'elles ont déjà été exportées car marquées.

Ce choix se fait dans le formulaire d'export en cochant '''Marquer les écritures (elles ne pourront plus être exportées de nouveau)'''.

Il est conseillé de toujours procéder à un 1er export sans marquer les écritures. Ainsi, si l'export se passe mal, on aura la garantie de pouvoir le refaire.

=Lettrer des écritures comptables=
Tutoriel OpenFlyers : [https://www.youtube.com/watch?v=Bgb32Ay6TVU Lettrer des écritures comptables]

Le [https://fr.wikipedia.org/wiki/Lettrage_comptable lettrage] est une opération comptable qui consiste à affecter un seul repère à 2 ou plusieurs entrées comptables dans ce compte. la somme des entrées au crédit devant être égale à la somme des entrées au débit.

Pour pouvoir effectuer le lettrage il faut disposer du droit [[Gestion-des-profils#Gestion-des-comptes|Gestion des comptes]].

==Annulation automatique du lettrage==
Dans le cas où un flux comptable est modifié ou annulé, les écritures comptables lettrées avec les écritures du flux concerné sont automatiquement délettrées.

==Lettrage automatique==
Le lettrage automatique se fait lors de l'[[#Importer-un-relevé-bancaire|import de relevés bancaires]] en cochant la case à cocher '''Lettrer automatiquement les écritures comptables''' de l'interface correspondante. Un robot va alors essayer de trouver des écritures à lettrer. Son fonctionnement est le suivant :
*Génération de l'écriture comptable
*Recherche d'une écriture comptable ayant le montant inverse (somme des crédits et débits égal à 0) et appartenant au même compte
*Création d'un lettrage pour les deux écritures correspondantes ainsi qu'une date de lettrage
*Enregistrement de l'écriture dans la base de données.
Pour la recherche de l'écriture inverse, le robot se limite à X jours avant et Y jours après la date de l'écriture d'origine. X et Y sont définis dans le [[Configuration-de-la-comptabilité#Paramétrage-général-de-la-gestion-des-comptes|Paramétrage général de la gestion des comptes]].

Si plusieurs écritures ont été trouvées dans la base de données comme correspondante alors le lettrage n'est pas fait. Si plusieurs écritures générées ont la même écriture correspondante seule, la première est lettrée.

==Lettrer manuellement==
Le lettrage manuel est fait par l'utilisateur via l'interface '''Gestion > Comptes › Comptes > X'''. Pour ajouter un lettrage à une écriture il faut :
*Cliquer sur le bouton d'édition du lettrage en haut de la colonne lettrage
*Cliquer sur les écritures que l'on souhaite associer
*Chaque entrée sélectionnée est ajoutée au panier des écritures en attente de lettrage affiché en haut de l'extrait de compte. Le contenu de ce panier est préservé en affichant d'autres pages d'extraits de compte du compte concerné. Cela permet d'associer des écritures comptables réparties sur des dates éloignées.
*Re-cliquer sur le bouton d'édition.
OpenFlyers va alors s'assurer que la somme des entrées au crédit est égale à la somme des entrées au débit. Si c'est le cas alors le lettrage est effectué.

Seules les écritures n'ayant pas encore de lettrage peuvent être sélectionnées par l'utilisateur.

Pour supprimer un lettrage, il faut :
*Cliquer sur le bouton de dissociation en haut de la colonne lettrage
*Cliquer sur les écritures que l'on souhaite dissocier.
*Re-cliquer sur le bouton d'édition.

L'ensemble des écritures sélectionnées n'auront alors plus de lettrage ainsi que leurs écritures correspondantes. Si l'utilisateur a sélectionné deux écritures correspondantes, leur lettrage sera supprimé comme si une seul avait été sélectionnée.

Ainsi si l'on souhaite modifier le lettrage d'une écriture il faut dans un premier temps supprimer son lettrage puis en ajouter un nouveau.

=Mettre à jour les tarifs=
==Mettre à jour les tarifs associés à des produits==
*'''Gestion > Ventes > Produits'''

*Les tarifs sont définis dans la partie droite du tableau à partir de la colonne '''Tarif associé'''.
[[Image:Tableau_produits_actualisation_tarifs.png|800px]]
*Dans '''Historique des montants''', sélectionner '''Nouveau couple...''' pour créer un nouveau tarif.
*Saisir un nouveau '''Montant du tarif''' et la nouvelle '''Date d'entrée en vigueur du tarif''' à partir de laquelle le tarif s'appliquera. Vous pouvez anticiper un changement de tarif. Le tarif s'appliquera à la date du mouvement.

'''Attention''': si vous sélectionnez un couple existant dans '''Historique des montants''' et que vous modifiez le montant ou la date d'entrée en vigueur, alors vous changez le prix de cette période mais vous ne créez pas un nouveau tarif. Vous perdrez toute possibilité de corriger par exemple un vol à une date donnée.

* S'il y a un message d'erreur "chaque variable doit disposer d'une valeur antérieure à la date de début de l'exercice comptable" cela signifie que la variable ne possède pas de valeur entre la date de début d'exercice (date définie dans '''Admin > Comptes > Gestion & Export''') et la date indiquée. Le programme refuse qu'il y ait une absence de tarif applicable.
*Chaque variable utilisée dans les formules de tarification doit avoir une valeur initialisée depuis une date antérieure à la date de début de l'exercice comptable

==Mettre à jour les tarifs associés à des activités==
*'''Admin > Ventes > Variables > Actualisation'''
[[Image:Menu-vente-prix-actualisation-des-prix.jpg|250px]]

Si vous souhaitez mettre à jour un tarif, c'est à dire définir un prix qui doit s'appliquer à partir d'une certaine date, alors il faut :
*Cliquer sur le bouton '''Ajouter une nouvelle valeur à une variable existante''' en bas du tableau et '''non pas sur l'icône crayon à droite de la ligne de tarif'''.
[[Image:Tableau-vente-prix-actualisation-de-prix.jpg|500px]]

*Saisir une nouvelle valeur et la date à partir de laquelle le tarif s'appliquera. Vous pouvez anticiper un changement de tarif. Le tarif s'appliquera à la date du mouvement.
[[Image:Ajout-nouvelle-valeur-variable-tarif.png|400px]]

'''Attention''': si vous cliquez sur l'icône "Édition" (Crayon dans la colonne action) et que vous modifiez la valeur, alors vous changez le prix de cette période mais vous ne créez pas un nouveau tarif. Vous perdrez toute possibilité de corriger par exemple un vol à une date donnée.

*Si vous avez le message d'erreur "chaque variable doit disposer d'une valeur antérieure à la date de début de l'exercice comptable" cela signifie que la variable ne possède pas de valeur entre la date de début d'exercice (date définie dans '''Gestion > Comptes > Gestion > Gestion & Export''') et la date indiquée. Le programme refuse qu'il y ait un "trou tarifaire" (vols non facturés).
*Chaque variable utilisée dans les formules de tarification doit avoir une valeur initialisée depuis une date antérieure à la date de début de l'exercice comptable

Après mise à jour des tarifs, s'il est nécessaire de mettre à jour les activités déjà saisies, alors il faut suivre la procédure [[Gestion-des-activités#Mettre-à-jour-les-entrées-comptables-associées-à-des-activités-non-validées|Mettre à jour les entrées comptables associées à des activités non validées]].

==Supprimer les tarifs associés à des activités==
;Supprimer une valeur de tarif
*Accéder à '''Admin > Ventes > Variables > Actualisation'''
*Cliquer sur l'icone ''Supprimer'' (représentée par une poubelle dans la colonne Actions)
*Si deux valeurs ou plus de la même variable que celle que nous souhaitons supprimer ont une date de début antérieure ou égale à celle de l'exercice, alors la suppression est autorisée.
*Si une seule valeur de la même variable que celle que nous souhaitons supprimer a une date de début antérieure ou égale à la date de début de l'exercice, nous devons alors vérifier si la valeur que nous voulons supprimer a une date de début ultérieure à celle de l'exercice. Si tel est le cas, nous pouvons la supprimer.
*Dans tous les autres cas, la suppression n'est pas autorisée. Cela signifie soit qu'il n'y aura aucune valeur applicable à la date de début de l'exercice comptable, soit que la situation est déjà compromise, c'est-à-dire qu'aucune valeur applicable n'existe à la date de début de l'exercice comptable.

;Supprimer une variable tarif
*Accéder à '''Admin > Ventes > Variables > Définition'''
*Cliquer sur l'icone ''Supprimer'' (représentée par une poubelle dans la colonne Actions)
*Si la valeur est utilisée dans une règle de facturation des '''Activités''' ou des '''Produits''', la suppression n'est pas autorisée et un message d'alerte s'affiche.
*Si aucune règle de facturation n'utilise cette variable tarif, la suppression sera autorisée, entraînant la suppression de toutes les valeurs associées à cette variable tarif.

=Opérations sur les comptes=
==Afficher la liste des opérations d'un compte==
*S'il s'agit d'un compte ressource, aller sur '''Gestion > Comptes > Comptes > Ressources'''.
*S'il s'agit d'un compte utilisateur, aller sur '''Gestion > Comptes > Comptes > Utilisateurs'''.
*Sinon, aller sur '''Gestion > Comptes > Comptes > Tous'''.
*Le cas échéant, cliquer la lettre correspond à la première lettre du nom du compte.
*Cliquer sur le pictogramme symbolisant une liste d'écritures dans la colonne '''Action''' de la ligne du compte concerné

==Créer un compte==
===Créer un compte ressource===
Pour créer un compte ressource, il faut :
*Aller sur '''Gestion > Comptes > Comptes > Ressources'''.
*Dans la ligne de la ressource concernée, cliquer sur l'icône check du compte souhaité.

===Créer un compte utilisateur===
Pour créer un compte utilisateur, il faut :
*Aller sur '''Gestion > Comptes > Comptes > Utilisateurs'''.
*Dans la ligne de l'utilisateur concerné, cliquer sur l'icône check du compte souhaité.

===Créer un compte non-ressource non-utilisateur===
Pour créer un compte, il faut :
*Aller sur '''Gestion > Comptes > Comptes > Tous'''.
*En bas du tableau, remplir la ligne et choisir la catégorie du compte
*Cliquer sur le bouton '''Ajouter'''

==Créer un type de compte==
===Créer un type de compte ressource===
Pour créer un type de compte ressource, il faut :
*Aller sur '''Admin > Comptes > Ressources > Types actifs''' puis cliquer sur le bouton '''Ajouter un compte'''.
*Saisir les champs du formulaire et valider .

==Désactiver un compte==
Pour désactiver un compte qui ne doit plus être utilisé, il faut que :
* le compte ne doit pas être utilisé dans une règle de tarification. Cela concerne directement les comptes et non pas les types de comptes. Ainsi, il est possible de désactiver un compte utilisateur ou un compte ressource alors qu'il existe des règles de tarification qui utilisent le même type de compte que le compte à désactiver.
* dans le cas d'un compte de type utilisateur, l'utilisateur possédant ce compte ne doit pas être lié à un profil qui requiert le type de compte
* le compte ne doit pas être utilisé par un type de facture fournisseur
* le compte ne doit pas créer de trou dans la comptabilité. C'est à dire que :
** le [[#Solder_un_compte|solde du compte doit être à 0]]
** les écritures associées à ce compte doivent être toutes validées
Ensuite, on peut procéder à sa désactivation en cliquant sur l'icône symbolisant une poubelle sur la ligne de ce compte. Un compte n'ayant jamais eu d'écriture est supprimé au lieu de passer à l'état désactivé.

==Lister les comptes==
*Aller sur '''Gestion > Comptes > Comptes > Ressources''' pour obtenir les comptes ressource
*Aller sur '''Gestion > Comptes > Comptes > Utilisateurs''' pour obtenir les comptes utilisateur
*Aller sur '''Gestion > Comptes > Comptes > Tous''' pour obtenir les autres comptes.

Dans ces pages, le solde de chaque compte est calculé en prenant les écritures datant du début d'exercice comptable jusqu'à la fin de la journée courante dans le [[Configuration#Fuseau-horaire-de-la-structure|fuseau horaire de la structure]]. Ainsi, les écritures comptables avec une date comptable future ne sont pas prises en compte pour le calcul du solde.

Le symbole '''*''' peut apparaître à gauche d'un solde : Cela signifie que le compte possède des écritures comptables dans le futur.

==Renommer un compte==
*Aller sur '''Gestion > Comptes > Comptes > Tous'''
*Cliquer éventuellement sur la lettre correspond à la 1ère lettre du nom du compte concerné.
*Cliquer sur le champ de la colonne '''Nom''' du compte concerné.
*Changer le nom du compte.
*Cliquer en dehors de la zone de saisie afin de permettre l'enregistrement de la saisie et le rafraichissement du tableau.

==Supprimer un compte créé en double==
Il peut arriver que deux comptes identiques soient créés par inadvertance. Dans ce cas, il est nécessaire de supprimer le compte en trop. Pour cela il faut :
*[[#Renommer-un-compte|Renommer le compte]] en trop pour qu'il ne porte pas le même nom que le compte initial. Cela peut se faire en lui rajoutant un numéro. Exemple : ''Compte en trop'' deviendra ''Compte en trop 1''.
*Si le compte comporte des écritures non validées, il est recommandé de modifier les écritures pour les affecter au bon compte. Pour cela, il faut :
*[[#Afficher-la-liste-des-opérations-d'un-compte|Afficher la liste des opérations du compte]].
*Cliquer sur le pictogramme symbolisant un crayon pour chaque ligne concernée afin d'éditer la saisie. Il est recommandé d'utiliser le [[Ergonomie#Clic-droit-et-clic-molette|clic droit ou le clic molette]] de la souris. Cela permet d'effectuer l'édition dans un nouvel onglet et ainsi de ne pas perdre la page contenant le détail du compte.
*S'il s'agit d'un flux, il suffit de modifier la saisie du flux, puis de cliquer sur le bouton '''Enregistrer'''.
*S'il s'agit d'une facture fournisseur, il faut d'abord modifier le type de facture fournisseur correspondant. Pour cela il faut :
**Aller dans '''Gestion > Achats > Types de facture fournisseur'''
**Retrouver le type de facture correspondant
**Cliquer sur le pictogramme symbolisant un crayon dans la colonne '''Actions''' de la ligne du type de facture fournisseur concerné.
**Modifier la sélection du champ '''Compte fournisseur ou trésorerie''' ou du champ '''Compte de charge, de bilan ou ressource''' pour y mettre le ''compte qui n'est pas en trop''.
**Cliquer sur le bouton '''Enregistrer'''.
:Ensuite, il est possible d'éditer la facture fournisseur et de la réenregistrer. Cela permet l'imputation sur le bon compte.
*Répéter l'opération d'édition de chaque ligne afin de faire disparaitre toutes les lignes non validées.
*Une fois qu'il ne reste plus de ligne non validée, alors il faut retourner sur l'affichage des comptes de même catégorie afin de pouvoir cliquer sur le pictogramme symbolisant une poubelle à l'intersection de la colonne '''Actions''' et de la ligne concernée.

=Relever bancaire=
'''Attention :''' avant d'effectuer un import de relevé bancaire en production, il est vivement recommandé de le faire sur la [[Compte-client-OpenFlyers-et-modèle-commercial#Plateforme-supplémentaire-de-test-(bac-à-sable)|plateforme bac à sable]]. En effet, un import de relevé bancaire génère de nombreuses écritures qu'il peut être ensuite fastidieux de supprimer à la main en cas de mauvais import.

De la même façon, lors des tests, il est recommandé d'importer qu'une petite période comptable (quelques jours) afin de ne pas générer de trop nombreuses écritures qui peuvent rendre totalement illisibles la consultation des comptes.

Pour accéder à cette fonctionnalité il faut disposer des droits de [[Gestion-des-profils#Gestion-des-comptes|Gestion des comptes]] ou [[Gestion-des-profils#Saisir-tout-flux|Saisir tout flux]].

Il est recommandé de saisir les [[Gestion-des-achats#Saisie-d'une-facture-fournisseur|factures fournisseurs]] avant d'effectuer l'import du relevé bancaire conformément au [[Comptabilité#Règles-de-saisies-de-la-comptabilité-courante|règles de saisies de la comptabilité courante]].

Voir également le chapitre [[Conseils-spécifiques-pour-la-comptabilité#Rapprochement-des-encaissements|Rapprochement des encaissements]] concernant la ventilation des écritures comptables liées à des encaissements.

==Importer par API==
Prérequis :
*Avoir [[Configuration-de-la-comptabilité#Agréger-des-comptes-bancaires|agrégé un ou plusieurs compte(s) bancaire(s)avec des comptes de trésorerie]].

Aller dans '''Gestion > Comptes > Relevé bancaire > Importer par API''':
*'''Compte de trésorerie''' : Sélectionner le compte de trésorerie qui va être mis à jour par import du relevé du compte bancaire agrégé avec ce compte.
*'''Lettrer automatiquement les écritures importées''' : en cochant cette case, le [[#Lettrage-automatique|lettrage automatique]] des écritures générées par l'import s'effectue
*Cliquer sur le bouton '''Importer'''

Remarques :
* Si lors de l'import des lignes ne sont pas importées car déjà présentes en base de données, un avertissement du type suivant s'affiche :
<pre>20 lignes comprises entre 01-03-2023 et 30-03-2023 n'ont pas été importées</pre>
* Les écritures générés via l'importation par API sont identifiés dans la liste des mouvements par l'icône "B-Bancaire".

==Importer par fichier==
[https://youtu.be/VVCdPWlwglM Vidéo tutorielle pour importer un relevé bancaire]

Prérequis :
*L'export du relevé doit avoir été réalisé (voir les procédures pour chaque dans la page [[Exporter un relevé bancaire depuis un site internet de banque]])
*Les [[Configuration-de-la-comptabilité#Règles-d'imputations-automatiques|règles d'imputation]] doivent être paramétrées

Utilisation depuis l'[[Présentation-d'OpenFlyers-4#Interface-légère|interface légère]] :
*'''Gestion > Comptes > Relevé bancaire > Importer par fichier'''
*'''Fichier''' : Sélectionner le fichier à importer
*'''Format d'import''' : Sélectionner le [[Modèles-de-format-d'import-de-relevé-bancaire#Format-d'import|format]] correspondant au fichier à importer. La sélection est mémorisée pour les imports suivants.
*'''Compte trésorerie''' : Sélectionner le compte de trésorerie qui va être débité. Lorsque le montant est négatif, ce compte est crédité.
:Le compte affiché par défaut est déterminé dans l'ordre suivant :
:#Compte utilisé lors du précédent import
:#Compte ayant le plus petit numéro d'export comptable
*'''Lettrer automatiquement les écritures importées''' : en cochant cette case, le [[#Lettrage-automatique|lettrage automatique]] des écritures générées par l'import s'effectue
*Cliquer sur le bouton '''Importer'''

* S'il y a un message d'erreur ''[[#Ligne-:-xxx-déjà-présente-en-base-de-données|Ligne : xxx déjà présente en base de données]]'', l'import n'est pas réalisé afin de ne pas générer de doublons.

Lors de l'import, des [[Comptabilité#Flux|flux]] sont générés. Ils sont définis en fonction des [[Configuration-de-la-comptabilité#Règles-d'imputations-automatiques|règles d'imputation]]. Il est ensuite possible de modifier ces écritures en [[Utilisation-de-la-comptabilité#Modifier-un-flux|modifiant les flux]] depuis la [[Gestion-de-la-comptabilité-côté-utilisateur#Extrait-de-compte|liste des mouvements]] ou le détail des comptes imputés.

Le compte de banque sélectionné lors de l'import contient une ligne de débit ou de crédit pour chaque flux généré par l'import.

==Ligne : xxx déjà présente en base de données==
Ce message d'erreur peut être généré lors de l'utilisation de la fonctionnalité d'import de relevé bancaire.<br/>
Il indique que la ligne affichée est déjà présente en base de données.<br/>
Dans ce cas, aucune ligne du fichier n'est chargée en base de données.<br/>
En cas de présence de cette erreur, vérifier que la période d'export de votre relevé bancaire ne chevauche pas la période de l'export précédant.

=Retrouver les écritures non validées=
S'il y a beaucoup d'écritures à valider, il faut procéder de façon systématique en parcourant chaque interface de validation :
*Pour les activités, aller dans '''Gestion > Activités > Activités > Liste''' puis '''Valider les activités sélectionnés''' pour chaque ressource.
*Pour les encaissements, aller dans '''Gestion > Comptes > Pointer > X''' où X correspond au type de paiement à pointer.
*Pour les transferts, aller dans '''Gestion > Comptes > Flux > Valider''' puis '''valider les transferts'''.
*Pour les factures, aller dans '''Gestion > Achats > Liste des factures fournisseurs'''.
*Pour les ventes, aller dans '''Gestion > Ventes > Valider les ventes'''. Choisir ses critères de recherche et valider le formulaire. Ensuite cocher les différentes ventes listées puis '''Pointer les entrées sélectionnées'''.
En procédant ainsi, il ne doit normalement ne pas subsister d'écriture à valider. Cependant, si l'essentiel des écritures a été validé, alors il est plus rapide de rechercher les écritures à valider que de parcourir chaque interface de validation.

Pour rechercher les écritures restantes à valider, il faut :
*Aller dans '''Gestion > Comptes > Gestion > Gestion / Export'''
En-dessous du titre '''Statistiques''' figure un tableau :

[[Image:Tableau_statistiques_gestion-export.png]]

Dans l'exemple ci-dessus, on peut voir à la ligne ''Ecritures non validées'', colonne ''Date de première écriture'' l'horodatage "19/08/2013 14:45".

Cela veut dire qu'il y a au moins une écriture qui date du 19 août 2013 et qui n'a pas été validée.

Pour retrouver cette écriture non validée, il faut :
*Aller dans '''Gestion > Comptes > Flux > Mouvements'''
*Rechercher l'écriture d'après la date indiquée.
Son contenu permettra de savoir s'il s'agit d'un vol, d'un encaissement, d'un flux, etc. Si un doute subsiste sur le type d'écriture, il faut cliquer sur l'icône "modifier" de l'écriture considérée afin de se retrouver dans son formulaire d'édition.

Si les vols non validés correspondent à une ressource qui a été désactivée, alors pour valider les vols concernés, il faut :
*Aller dans '''Gestion > Ressources > Actives''' désactiver temporairement '''Réservable''' et '''Saisie d'activité''' pour une ressource existante afin de pouvoir avoir la possibilité de réactiver l'autre ressource
*Aller dans '''Gestion > Ressources > Désactivées'''
*Réactiver la ressource concernée
*Aller dans '''Gestion > Ressources > Actives''' et activer temporairement '''Saisie d'activité''' pour la ressource concernée
*Aller dans '''Gestion > Activités > Liste d'activités''' puis cliquer le bouton de la colonne '''Valider les activités sélectionnées''' correspondant à la ressource concernée
*Pointer les activités de la ressource
*Retourner dans '''Gestion > Ressources > Actives''' et désactiver la ressource concernée en cliquant sur l'icône symbolisant une poubelle
*Toujours dans cette interface, remettre '''Réservable''' et '''Saisie d'activité''' pour la ressource temporairement désactivée

Remarques :
*Le nombre d'écritures non validées indiqué dans le tableau '''Statistiques''' correspond au nombre TOTAL d'écritures non validées. En effet, OpenFlyers sait quand est-ce que vous commencez un exercice mais il ne sait pas quand est-ce que vous voulez qu'il s'arrête. Donc il prend toutes les écritures non validées.
*OpenFlyers ne permet d'exporter ou de clôturer que la période qui inclut des écritures validées. Dès qu'il rencontre une écriture non validée, il bloque toute action d'export ou de clôture.

=Saisir des écritures comptables=
==Annuler une écriture comptable==
Dans le cas où une écriture comptable saisie n'a pas été encore validée, pour l'annuler, il faut cliquer sur le bouton symbolisant une poubelle. Cela supprimera complètement l'écriture.

Dans le cas où une écriture comptable a été validée, il n'est plus possible de la supprimer du fait de l'[[Comptabilité#Inaltérabilité-des-données|inaltérabilité des données]]. Le seul moyen d'en annuler son effet consiste à saisir une écriture opposée. Pour cela, il faut [[#Contrepasser-une-écriture|contrepasser l'écriture]].

Cette solution permet de garantir l'inaltérabilité des écritures qui peuvent avoir été saisies par d'autres personnes et surtout qui peuvent affecter des comptes d'utilisateurs.

C'est comme pour un compte bancaire : un banquier ne supprime jamais une écriture sur un compte client. Il passe simplement une nouvelle écriture qui annule l'effet de la précédente.

==Contrepasser une écriture==
Cette fonction nécessite le droit [[Gestion-des-profils#Gestion-des-comptes|gestion des comptes]].

La fonction de contrepassation d'une écriture permet d'annuler l'effet d'une vente (produit stocké ou non stocké), d'un encaissement ou d'un flux. Cette fonction n'existe pas pour contrepasser la vente de validité ou la vente d'activité. Pour la vente d'activité, il faut [[Gestion-des-activités#Annuler-une-activité-validée|annuler l'activité validée]].

;Procédure
*Aller sur la page d'un extrait de compte ou sur la liste des mouvements : '''Gestion > Comptes > Flux > Mouvements'''
*Dans la colonne '''Actions''', cliquer sur le pictogramme '''Contrepasser le flux'''
*Une alerte demande de confirmer le souhait de créer une écriture de contrepassation
*Cela crée une écriture opposée, à la date de l'écriture initiale, qui a pour commentaire le texte "Contrepassation flux X du XX/XX/XXXX". L'écriture générée est directement validée.

==Modifier un flux==
* Aller dans '''Gestion > Comptes > Flux > Valider''' ou dans l'[[Gestion-de-la-comptabilité-côté-utilisateur#Extrait-de-compte|extrait de compte]]
* Cliquer sur l'icône "Crayon" correspond au flux à éditer
* [[#Saisir-un-flux|Procéder à éditer le flux]]

==[[Écritures comptables#Avoir_clients|Saisie d'un avoir client]]==
Il faut [[#Saisir-un-flux|saisir un flux]] qui va créditer un compte utilisateur/client d'un certain montant et débiter un compte produit "Remise X" du même montant.

==Saisir un flux==
Pour saisir un flux, il faut :
*Soit aller dans '''Gestion > Comptes > Flux > Saisir'''
*Soit afficher un extrait de compte et cliquer sur le bouton '''Saisir un flux''' situé en bas à droite de l'affichage du compte à droite de la ligne du solde.
Si le gestionnaire arrive sur le formulaire de saisie d'un flux depuis un extrait de compte, alors la première ligne est pré-remplie avec le compte depuis lequel le formulaire a été affiché.

Sinon, Il faut sélectionner sur la première ligne de compte, le compte souhaité. Pour cela, il est possible de cliquer sur le champ afin de faire apparaitre la liste de tous les comptes. Ils sont regroupés par catégorie et dans chaque catégorie triés par ordre alphabétique. A droite de chaque nom de compte apparait entre parenthèses le compte d'export associé.

Il est possible de renseigner dans le champ de saisie quelques lettres correspondantes à une partie du nom du compte afin de faire apparaitre la liste des comptes qui correspondent. Il est également possible de saisir quelques chiffres du compte d'export.
*Remplir le champ débit ou crédit selon le cas
S'il n'y a que 2 lignes comptables pour le flux :
*Sélectionner sur la 2ème ligne un compte de contre-partie
*Sur cette 2ème ligne, cliquer sur l'icône qui symbolise une balance avec une flèche bleue et intitulé "Equilibrer la dernière ligne"
S'il y a plus 2 lignes comptables pour le flux :
*Cliquer sur le pictogramme symbolisant un "plus" dans la colonne '''Action''' de la dernière ligne du flux afin de faire apparaitre une ligne supplémentaire
*Répéter cette opération autant de fois que nécessaire
Une fois que l'ensemble des lignes du flux sont remplies :
*Compléter éventuellement le champ '''commentaires'''
*Choisir une date comptable dans le champ '''Date comptable''' en cliquant sur l'icône associée. Si la date est à la date du jour l'heure courante est utilisée. Sinon la date est définie à 12:00 heure locale.
*Cliquer sur le bouton '''Valider'''
Remarque : La date comptable proposée par défaut correspond à la date comptable du dernier flux saisi. Cela permet de faciliter les [[Comptabilité#Règles_de_saisies_de_la_comptabilité_courante|saisies au vu du relevé de banque]].

==Solder les comptes charges, produits et ressources==
Pour solder des comptes charges, produits et ressources en un seul flux vers un compte de contrepartie à partir de la date de début d'exercice comptable jusqu'à une date désirée, aller dans '''Gestion > Comptes > Gestion > Gestion / Export'''. Seulement les comptes actifs seront soldés.

Dans cette interface :
* Décocher les comptes ressources à ne pas solder
* Sélectionner la date
* Sélectionner la comptabilité
* Choisir un compte de contrepartie
* Cliquer sur '''Générer les écritures'''

==Solder un compte==
Pour solder un compte, il faut [[#Saisir-un-flux|saisir un flux]] avec la particularité que l'on souhaite "ramener le solde à zéro" d'un compte donné. Pour cela, il faut en plus des [[#Saisir-un-flux|opérations]] indiquées pour la saisie d'un flux, il faut :
*dans la première ligne de compte, sélectionner le compte concerné
*Cliquer sur l'icône qui symbolise une balance intitulé "Ramener le solde à zéro"

==Validation d'un flux==
Pour pouvoir valider les flux, il faut disposer des droits [[Gestion-des-profils#Valider-tout-flux|Valider tout flux]] et [[Gestion-des-profils#Saisir-tout-flux|Saisir tout flux]].
*Aller dans '''Gestion > Comptes > Flux > Valider'''
*Cocher dans la 1ère colonne '''Pointer''' les lignes à valider
*Cliquer sur le bouton '''Valider les flux sélectionnés (cette action est irréversible)'''

=Solder les comptes=
*Aller dans '''Gestion > Comptes > Gestion > Solder les comptes'''
*Dans la première colonne, laisser tous les comptes "Ressources" cochés sauf si certains ne sont pas des comptes d'exploitation
*Dans la deuxième colonne, la date proposée dans le champ '''A la date du''' doit correspondre au 31 décembre de l'année de l'exercice comptable en cours
*Si plusieurs comptabilités sont paramétrées, un le champ '''Comptabilité''' est visible, sélectionner la comptabilité souhaitée : il faudra effectuer cette opération pour chacune des comptabilités de la plateforme
*Dans le champ '''Compte de contrepartie''', sélectionner le compte de bilan souhaité
**Par défaut, est sélectionné, soit le compte '''Report à nouveau (Bilan)''' pour la comptabilité générale, soit le compte utilisé lors du précédent import
*Cliquer sur le bouton '''Générer les écritures'''

Ce module génère alors un unique flux qui solde les comptes de charges, de produits et ceux liés aux ressources vers un compte de contrepartie de sorte que ces comptes soient ramenés à 0 à la date sélectionnée.

Seuls les comptes actifs sont pris en compte.

Le flux généré est modifiable.

Après avoir cliqué sur le bouton '''Générer les écritures''', le gestionnaire est redirigé vers '''Admin > Comptes > Valider les flux''' avec par défaut l'affichage du mois et de l'année correspondant aux flux générés afin de lui permettre de valider ces flux. Cette opération est nécessaire avant de pouvoir [[#Clôturer-l'exercice-comptable|Clôturer l'exercice comptable]].

=Valider toutes les écritures=
OpenFlyers permet de valider toutes les écritures comprises avant une date choisie.
*Aller dans '''Gestion > Comptes > Gestion > Valider'''
*Dans la 1ère colonne intitulée '''Statistiques''', la date de début de l'exercice comptable est renseignée ainsi qu'un tableau indiquant le nombre d'écritures non validés avec la date de la première écriture non validée.
*Dans la 2ème colonne intitulée '''Valider''', renseigner la date '''Valider les écritures jusqu'au :''' en cliquant sur le calendrier.
** Cette date ne doit pas être inférieure à la date de début de l'exercice comptable.
** Et, ne doit pas être supérieure au 31 décembre de l'année précédente.
* Activer l'interrupteur '''Autoriser''' et cliquer sur le button '''Valider toutes les écritures'''

=Factures fournisseurs=
==Saisir des factures fournisseurs==
[https://www.youtube.com/watch?v=QVUgYEfqDk0 Vidéo tutorielle pour saisir une facture fournisseur]

*Aller dans '''Gestion > Achats > Saisie Factures fournisseurs'''.
*Vous vous retrouvez alors avec le formulaire de saisie suivant :

2 cas peuvent se présenter :
*Soit [[#Saisir-une-facture-fournisseur-dont-le-type-de-facture-est-déjà-enregistré|le type de facture fournisseur correspondant à la facture à saisir est déjà existant]]
*Soit la facture fournisseur à saisir nécessite la création d'un nouveau type de facture fournisseur. Dans ce cas, il existe plusieurs façons de créer un nouveau type de facture fournisseur dont la possibilité de [[#Saisir-une-facture-fournisseur-dont-le-type-est-nouveau|le faire directement en saisissant la facture]].

Vous pouvez importer un fichier en plus si nécessaire. Seulement [[Gestion-des-documents#Type-de-fichier-autorisé|certains types de fichiers sont autorisés]].

===Saisir une facture fournisseur dont le type de facture est déjà enregistré===
*Sélectionner le '''type de facture fournisseur''' correspondant à la facture à saisie. Le nombre de champs à renseigner se réduit alors automatiquement :
*Reporter sur la facture originale le '''numéro de pointage''' qui apparaît dans le formulaire. Ce numéro de pointage est unique et permet de rapprocher les factures fournisseurs saisies dans OpenFlyers avec leurs originaux.
*Cocher "'''J'ai bien pris en compte cette valeur et je l'ai reporté sur ma facture'''". A défaut, si vous validez, le système refusera votre saisie et une alerte apparaitra.
*Le champ '''Description''' permet d'indiquer toute information utile concernant la facture et d'en faciliter la recherche ultérieure.
*Indiquer la date de facturation en cliquant sur le calendrier. Il est possible de paramétrer le format d'affichage de la date en allant dans le menu '''Données/Affichage''' puis de modifier le contenu du champ '''fiche personnelle/Patron de format de date'''.
*Renseigner le '''montant hors taxe'''
*Renseigner la '''TVA''' (champ visible uniquement si la comptabilité est paramétrée pour la prise en compte de la TVA). Si la TVA est nulle, il faut indiquer 0.
*Cliquer sur '''Valider''' ou '''Valider et Saisir le suivant''' si vous avez plusieurs factures à saisir à la volée. Dans ce dernier cas, le formulaire de saisie de facture fournisseur s'affiche à nouveau et il faut reprendre les opérations de saisie depuis le début de ce paragraphe.

===Saisir une facture fournisseur dont le type est nouveau===
Lors de la saisie d'un nouveau compte fournisseur, aucun élément n'est renseigné par défaut.

Plusieurs parties du formulaire peuvent se réduire à partir du moment où dans le champ précédant la partie réductible, l'utilisateur remplace '''Autre...''' par un choix proposé. A contrario, en laissant '''Autre...''' ou '''Associer un nouveau compte''' (dans le cas du premier champ), c'est l'information saisie dans le champ suivant qui sera prise en compte.

La saisie va consister à définir les ventilations comptables associée à ce type de facture fournisseur. A savoir :
*le fournisseur et son compte fournisseur qui sera crédité du montant des factures associées à ce type de facture fournisseur
*le compte de charge qui sera débité du montant des factures associées à ce type de facture fournisseur
*Si la gestion de la TVA est activée, le compte de TVA qui sera débité du montant de la TVA associée à ce type de facture fournisseur
*De plus, si la gestion des budgets est activée, il est demandé, pour chaque compte (fournisseur, charge et TVA), le budget à associer

*Ainsi, si on doit saisir une facture fournisseur associée à un nouveau type de facture fournisseur, alors il faut laisser '''associer un nouveau compte''' au champ '''Type de facture fournisseur''' et renseigner l'intitulé souhaité pour le type de facture fournisseur dans le champ suivant '''Nom de type de facture'''
*Ensuite, dans le champ '''Fournisseur''', là aussi, 2 cas peuvent se présenter :
**Soit le fournisseur à mentionner est déjà dans la liste proposée dans le champ '''Fournisseur''' et auquel cas il faut le sélectionner (et le champ suivant '''Nom du fournisseur''' disparaitra)
**Soit le fournisseur à mentionner n'est pas déjà dans la liste proposée dans le champ '''Fournisseur''' et il faut dans ce cas :
***Si la gestion des budgets est active : choisir dans le champ suivant un '''Budget à attribuer'''' au fournisseur ou laisser '''Aucun budget'''. On peut, par exemple, sélectionner pour tous les fournisseurs un budget ''Fournisseurs''.
***Renseigner le champ '''Nom du fournisseur''' qui doit correspondre au fournisseur souhaité
***Choisir un compte d'export associé au nouveau fournisseur créé :
****Soit il existe déjà un compte d'export dans le champ '''Compte du fournisseur'''
****Soit il n'existe pas de compte d'export associable à ce nouveau fournisseur (en général on associe un compte d'export différent pour chaque compte défini dans OpenFlyers) et auquel cas, il faut renseigner le champ '''Compte fournisseur d'export'''. On peut, par exemple, saisir ''401NOMDUFOURNISSEUR'' dans le cas du plan comptable français.
***Si la gestion des budgets est active, le champ suivant est '''Budget à attribuer''' et OpenFlyers a dû le remplir par défaut avec la même valeur que pour le champ du même nom rattaché au '''Nom du fournisseur'''. Il ne doit pas y avoir besoin de modifier le contenu de ce champ.
*Dans le champ '''Compte de charge''', 2 cas peuvent se présenter :
**Soit le compte de charge à associer est déjà dans la liste proposée et auquel cas il faut le sélectionner
**Soit le compte de charge à associer n'est pas déjà dans la liste proposée et il faut dans ce cas :
***Si la gestion des budgets est active : choisir dans le champ suivant un '''Budget à attribuer''' au compte de charge que l'on crée ou laisser '''Aucun budget'''. On peut, par exemple, sélectionner un budget représentatif du type de facture et ainsi avoir la ventilation de toutes les factures fournisseurs par poste budgétaire
***Renseigner le champ '''Nom du compte''' avec l'intitulé correspondant au compte de charge à créer
***Renseigner le champ '''Compte d'export''' avec la valeur du plan comptable correspondante. Pour le plan comptable français, ce sera un compte en 6xx.
*Si la gestion de la TVA est activée, le champ '''Compte TVA du type de facture''' est présent et 2 cas peuvent se présenter :
**Soit le compte de TVA à associer à ce type de facture est dans la liste proposée et auquel cas il faut le sélectionner
**Soit le compte de TVA n'existe pas et il faut dans ce cas :
***Si la gestion des budgets est active : choisir dans le champ suivant un '''Budget à attribuer''' au compte de TVA que l'on crée ou laisser '''Aucun budget'''. On peut, par exemple, sélectionner un budget ''TVA Fournisseur''
***Renseigner le champ '''Nom de compte TVA'''. Par exemple, dans le cas des factures fournisseurs provenant de France : ''TVA déductible sur autres biens et services''
***Renseigner le champ '''Compte TVA d'export'''. Par exemple, dans le cas des factures fournisseurs provenant de France : ''445660''.
*Le reste de la saisie s'effectue comme pour la [[#Saisie_d'une_facture_fournisseur_dont_le_type_de_facture_est_déjà_enregistré|saisie d'une facture fournisseur dont le type de facture est déjà enregistré]].

===Supprimer une facture fournisseur===
Pour supprimer une facture fournisseur qui aurait été saisie par erreur, il faut :
*Aller dans '''Gestion > Achats > Liste des factures fournisseurs''' ;

*Rechercher le '''numéro de pointage''' de la facture concernée en ayant pris soin au préalable de sélectionner le mois de la facture (ou l'année complète pour lister l'ensemble des factures).
*Cliquer sur l'icône poubelle associée à la facture concernée.

Le numéro de la facture supprimée n'existera plus dans la comptabilité. Il ne sera pas proposé à nouveau lors de la saisie d'une nouvelle facture. Par ailleurs, la numérotation des factures saisies a posteriori de la facture supprimée demeurera inchangée.

===Supprimer un type de facture fournisseur===
Pour supprimer un type de facture fournisseur qui aurait été saisi par erreur, il faut :

*Aller dans '''Gestion > Achats > Types de factures fournisseurs''' ;

*Sélectionner le type de fournisseur concerné dans la colonne '''Nom''' ;

*Cliquer sur l'icône poubelle associée à la facture concernée.

==Saisir un [[Écritures comptables#Paiement_(à_un_fournisseur)|paiement à un fournisseur]]==
*Aller dans '''Gestion > Comptes > Flux > Saisir'''
*Sur la première ligne :
**dans la colonne '''Compte''' sélectionner le compte du fournisseur
**dans la colonne '''Débit''' saisir le montant du paiement que vous effectuez. Si vous souhaiter solder le compte du fournisseur, il vous suffit de cliquer sur l'icône représentant une balance et intitulée "Ramener le solde à zéro"
*Sur la deuxième ligne :
**dans la colonne '''Compte''' sélectionner le compte bancaire depuis lequel l'argent est débité
**cliquer sur l'icône représentant une balance avec une flèche bleue et intitulée "Equilibrer la dernière ligne"
*Dans le champ '''Commentaires''' saisir un texte libre
*Ne pas oublier de renseigner le champ '''Date comptable'''
*Cliquer sur le bouton '''Valider'''

=Bon de commande et facture clients=

==Visualiser des factures au format PDF==
Nous conseillons de se connecter en https à votre espace http://openflyers.com/demo-fr/index.php

OpenFlyers propose par défaut un [[Modèle de facture ODT|modèle de facture]] qui permet d'éditer des factures PDF pour les prestations suivantes :
*les achats réalisés depuis le gestionnaire des ventes
**depuis la page du planning de réservation, cliquer sur le menu '''Comptes/Acheter'''.
*les validités qui ont été achetées/renouvelées
*les vols.
**Aller dans le menu '''Comptes/Etat/Pilote''' et se rendre dans la [[Gestion de la comptabilité côté utilisateur#Colonne-Numéro-de-pointage-ou-de-facture|colonne numéro de pointage ou de facture]]

==Importer son [[Modèle de facture ODT|modèle de facture]]==

'''/!\ En important un [[Modèle de facture ODT|modèle de facture]], ce sera celui-ci qui va être utilisé pour générer les nouvelles factures au format PDF. Les factures qui ont déjà créées avant la mise en place du nouveau modèle continuera d'appliquer les anciens versions du modèle ou ceux fournis par défaut par OF'''

Le droit [[Gestion-des-profils#Gestion-du-paramétrage|Gestion du paramétrage]] est nécessaire pour cette fonctionnalité.

*Aller dans '''Admin > Structure > Imports > Templates ODT'''.
* Préparer le fichier ODT contenant tous les modèles utilisés qui doivent être organisés comme suit :
**'''page 1''' : Facture client
**'''page 2''' : Duplicata de la facture client
*Importer le fichier
*Cocher '''Facturation client'''
*Valider

==Calcul du montant HT, de la TVA et du montant TTC==

Les différents montants sont calculés de la sorte :
* Pour la TVA, on effectue la somme des écritures de débit et de crédit liés aux
** comptes de catégorie TVA
** produits de type de vente TVA
* Pour le montant TTC, on effectue la somme des écritures de débit et de crédit liées aux
** comptes qui ne sont pas de catégorie TVA
** produits qui ne sont pas de type de vente TVA
* Pour le montant HT, on effectue la différence entre la TVA et le montant TTC

==Relevés de factures clients==
Une facture client est un document unique. Les PDF d'une facture déjà exportée seront générés avec la mention "Duplicata".

===Formulaire de sélection===
Ce formulaire permet d'établir une sélection générale de factures clients.
*Aller dans '''Gestion > Rapports > Rapports spécifiques > Relevés de factures clients'''
*Les champs "A partir du" et "Jusqu'au" permettent d'établir une sélection en fonction des dates de facturation. Pour éviter un temps de chargement trop long, il est conseillé de définir une plage d'un mois maximum.
*Le champ "Compte client" permet de sélectionner les relevés de factures d'un client particulier
*Le champ "Types de vols" permet de sélectionner des factures en fonction du type de vol
*Le champ "Produits non stockés" permet de sélectionner des factures en fonction de la nature du produit
*Le champ "Validités" permet de sélectionner des factures en fonction des produits de type "validité"
*Valider pour accéder aux factures à exporter

===Tableau de factures à exporter===
Ce tableau est le résultat du formulaire. Il liste des factures clients.
*Sélectionner au cas par cas les factures à exporter
*Cliquer sur le bouton '''Générer PDF''' en bas du tableau pour générer le PDF des factures sélectionnées
*Cliquer sur le bouton '''Sauver dans un fichier CSV''' en bas du tableau pour exporter les factures sélectionnées au format CSV

=Gestion des règlements clients=
==Saisir un encaissement==

Préambule : Se référer aux [[Écritures comptables#Encaissement-(d'un-client)|mouvements associés à un encaissement client]] pour connaitre les mouvements créés lors de la saisie comptable.

* Aller dans '''Planning > Comptes > Approvisionner''' ou '''Gestion > Comptes > Encaissements > Saisir'''
*'''Comptes clients''' :
**Si le payeur est un utilisateur de la plateforme, laisser sélectionné '''Utilisateur'''
**Sinon, sélectionner '''Non-utilisateur'''
*(facultatif) '''Email client''' : si '''Non-utilisateur''' est sélectionné, saisir l'adresse email du client où sera [[Envoi-des-emails#E-mail-de-reçu|envoyé le reçu pour le paiement]]
*'''Encaissement de l'utilisateur''' : sélectionner le nom de l'utilisateur effectuant le paiement
ou
*'''Compte à créditer''' : sélectionner le nom du client "connu" ou à défaut "Clients extérieurs"
** Seuls les [[Comptabilité#Comptes_clients|comptes clients]] et les [[Comptabilité#Comptes_utilisateurs|comptes utilisateurs]] peuvent recevoir des encaissements. En effet, comptablement, cela n'a pas de sens de faire un encaissement sur d'autres types de comptes.
** Il faut sélectionner le compte correspondant à celui qui a été facturé et donc débité.
*'''Type de règlement''' : sélectionner le type de règlement.
** Les types de règlement disponibles dépendent du compte à créditer pour s'assurer que [[Gestion-de-la-comptabilité-côté-utilisateur#Les-comptes-n'ont-pas-la-même-comptabilité|les comptes ont la même comptabilité]].
*'''Montant''' : indiquer le montant du paiement qui doit être dans l'intervalle '''[Montant minimum, Montant maximum]''' autorisé pour chaque [[Configuration-de-la-comptabilité#Types-d'encaissements|type d'encaissement]].
*'''Date du paiement''' :
**pour les paiements par chèque on laisse en général la date du jour qui correspond "au mieux" à la date à laquelle l'encaissement sera fait.
**pour les paiements en espèce on met la date à laquelle les sommes ont été reçus.
**pour les paiements par virement on met la date du virement.
*'''Heure du paiement''' : l'heure est saisie automatiquement et ne peut pas être saisie manuellement
**Si la date du paiement correspond à la date du jour alors c'est l'heure courante qui est saisi
**Autrement, l'heure est fixée à 12h00.
*Cliquer sur le bouton '''Valider''' ou le bouton '''VALIDER ET SAISIR LE SUIVANT'''

==Saisir l'encaissement d'un comité d'entreprise ou d'un groupement d'utilisateurs==
Dans le cas où un comité d'entreprise ou un groupement d'utilisateurs (comme la DGAC dans le cas des contrôleurs aériens) prend en charge tout ou partie du coût d'une activité générée par OpenFlyers, la plateforme est normalement configurée pour que ce soit le compte du CE ou du groupement qui soit automatiquement débité lors de la saisie de l'activité.

De ce fait, saisir dans OpenFlyers un règlement provenant d'une telle entité revient à [[#Saisir_un_encaissement|saisir un encaissement d'un "non-utilisateur" sur son propre compte client]].

==Validation des règlements clients==
La personne en charge de la gestion des encaissements doit valider les règlements avant de remettre l'argent en banque, que la saisie soit faite pas un utilisateur final ou par un gestionnaire de la structure.

Tant qu'une écriture n'est pas validée, elle apparaît différemment dans les extraits de compte afin de bien signifier que le mouvement n'est pas validé et que le solde du compte est donc susceptible d'être modifié. Une écriture non validée peut être modifiée mais '''Une fois la validation effectuée''' il n'est plus possible de '''revenir en arrière'''.

En cas d'erreur, la personne en charge de la tenue des comptes doit saisir une écriture d'annulation et ressaisir le règlement correct.

Pour valider les règlements la personne en charge de la gestion des encaissements dispose d'une page accessible uniquement avec le droit "'''Valider les encaissements'''".

Voici la description de la tâche de validation des règlements de type "Chèques" :
*Récupérer les chèques et espèces à valider
*Classer les chèques par ordre de date.
*Aller dans la page '''Gestion > Comptes > Pointer > Chèques'''
*Cette pages affiche les règlements saisis et qui sont en attente de validation
*Cocher les règlements correspondants à aux chèques physiquement présents.
*Si des règlements ne sont pas dans la liste en attente, la personne en charge de la gestion des encaissements les ajoute à l'aide d'un bouton prévu à cet effet puis les coche.
*Si des saisies sont erronées, il faut les corriger puis les cocher.
*Supprimer les saisies inopportunes.
*Une fois que tout les chèques sont pointés, cliquer sur '''Éditer le bordereau de remise'''.
*On passe sur la page de la liste des règlements validés : faire une vérification
*Imprimer le bordereau de remise en banque avec la [[Navigateurs#Imprimer-avec-un-navigateur|fonction prévue à cet effet du navigateur]]
*Valider le bordereau. '''Attention, cette action est irréversible'''
A l'issue de cette procédure, il faut porter la remise en banque.

Une fois le paiement validé, [[Envoi-des-emails#E-mail-de-reçu|un email sera automatiquement envoyé à l'utilisateur avec en pièce-jointe le reçu au format PDF]].

Le processus est le même pour les autres types de règlements à l'exception des [[Paiement en ligne|paiements en ligne]] qui sont automatiquement validées et qui par conséquent ne nécessitent pas de pointage.

Il est possible de retrouver la liste des encaissements par type et pour la période souhaitée dans le [[Gestion-des-rapports|rapport]] '''Gestion > Comptes > Rapports > Paiements par type'''.

Le [[Gestion-des-rapports|rapport]] '''Gestion > Comptes > Rapports > Ventilation des encaissements''' permet d'avoir le tableau du total des encaissements par mois et par type.

'''La validation régulière des règlements permet de bloquer les modifications par les utilisateurs et facilite la tenue de la comptabilité'''.

=Cas particuliers=
==Ecritures manuelles dans le cadre [[Conseils spécifiques pour la comptabilité#Facturation_automatique_à_des_organismes_avec_ou_sans_quotas|d'une facturation automatique à un organisme tiers]]==
Normalement, le paramétrage d'une plateforme OpenFlyers est effectué pour que les écritures soient automatiquement réalisées lors de la saisie d'une activité.

Cependant, si les écritures ne se sont pas effectuées automatiquement, ne serait-ce que dans le cas où le paramétrage a été mis en place ultérieurement à la saisie d'activité et que ces saisies ont été validées, il est nécessaire d'effectuer la saisie manuelle des flux permettant d'obtenir la [[Facturation des clients#Cascade_d'écritures_comptables|situation comptable souhaitée]].

Ainsi, si l'utilisateur a été intégralement débité du montant de l'activité et qu'il faut simplement saisir une écriture permettant de créditer son compte du montant devant être débité à l'organisme tiers, il suffit de [[#Saisir-un-flux|saisir un flux]] qui va créditer son compte du montant concerné et débiter le compte de l'organisme tiers du même montant.

De plus, si une gestion de quota est en place, il faut également corriger le compte de quota de l'utilisateur concerné sur le même modèle d'écriture que pour l'[[Conseils spécifiques pour la comptabilité#Initialisation_du_solde_d'heures_lors_de_la_mise_en_place_des_packs|initialisation d'un quota]] mais en sens opposé (le compte quota de l'utilisateur doit être débité au lieu d'être crédité et inversement pour le compte de bilan correspondant).

==Gestion des baptêmes==
Certaines structures utilisent le terme "Vol découverte" pour parler des baptêmes de l'air. Il est important d'avoir en tête que le grand public ne connait que le terme "Baptême de l'air" et que par conséquent ce terme est sans commune mesure plus utilisé dans les moteurs de recherche en comparaison au terme "Vol découverte".

===Utiliser le [[Configuration de la comptabilité#Gestion_des_baptêmes|paramétrage préconisé des baptêmes]]===
On appelle dans l'exemple "Clients extérieurs" le compte client qui est utilisé pour les clients baptêmes. La dénomination peut changer d'une configuration à l'autre.
Lorsqu'un baptême est effectué :
#Saisir le vol avec comme type de vol "baptême" : le coût du vol au tarif solo est alors débité sur le compte client "Clients extérieurs".
#Encaisser le paiement du baptême sur le compte client "Clients extérieurs" (qui est accessible dans le formulaire de saisie des encaissements en sélectionnant comme type d'utilisateur "non utilisateur").
Ainsi, le compte client "Clients extérieurs" se retrouvera avec un solde correspondant à la différence entre le prix du baptême payé par le client et le prix du vol solo facturé par OpenFlyers.

Il suffit alors de passer une écriture, par exemple tous les mois, tous les trimestres ou tous les ans, entre le compte "Clients extérieurs" et un compte produit (par exemple compte produit "gain baptêmes") qui va recevoir le solde du compte client "Clients extérieurs" afin de le ramener à 0.

Cas pratique :
*Tarif solo : 100 €/h
*Tarif baptême : 60 €
*Vol effectué de 30 minutes

Alors :
*En saisissant le vol de 30 minutes en tant que "baptême", le compte "clients extérieurs" sera débité du montant du tarif solo soit 50 €.
*En saisissant l'encaissement du paiement de 60 € effectué par le baptisé, le compte "clients extérieurs" sera crédité de 60 €.
*Il est résulte sur le compte "clients extérieur" un solde positif de 10 €.
A la fin de l'année, le compte "clients extérieur" aura vu son solde augmenter au fur et à mesure que les baptêmes auront été effectuée. Admettons qu'il se retrouve avec un solde positif de 1210 €. Il faut alors passer un mouvement (via la saisie d'un flux) pour débiter le compte "clients extérieurs" de 1210 € et créditer un compte produit "delta baptêmes" de 1210 €. Ce faisant le solde du compte client "clients extérieurs" est ramené à 0 ce qui est important pour montrer comptablement que personne ne doit de l'argent à l'aéro-club et le gain spécifique aux baptêmes est enregistré dans le compte produit "delta baptêmes".

==Mettre à jour un plafond d'heures ou d'argent sur une comptabilité parallèle==
Certaines plateformes sont paramétrées avec une comptabilité parallèle permettant de [[Conseils-spécifiques-pour-la-comptabilité#Facturation-automatique-à-des-organismes-avec-ou-sans-quotas|gérer des quotas d'heures ou d'argent]] pour des utilisateurs du fait de leur appartenance à une entreprise, un comité d'entreprise ou un comité d'établissement public, etc.

Les utilisateurs disposent alors d'un 2ème compte qui permet de suivre l'évolution de leur utilisation du quota qui leur est attribué, par exemple annuellement. Si le montant crédité automatiquement ne correspond pas au quota auquel ils ont droit, il faut alors, pour chaque compte utilisateur concerné, saisir un flux qui permet de mettre à jour ce quota.

Pour cela, il faut d'abord identifier le compte de contre-partie qui est utilisé pour les écritures comptables qui impactent ce compte. Généralement ce compte est un compte de bilan dont le nom est du type "Encours...". Pour le trouver 2 méthodes :
#Aller sur '''Gestion > Comptes > Lister les comptes > Comptes bilan''' puis rechercher le compte concerné
#Aller sur le compte de suivi de quota d'un utilisateur concerné et identifier dans la cellule de la colonne '''Compte affecté''' et de la ligne d'une écriture comptable d'initialisation, le nom du compte de contre-partie.

Une fois ce travail d'identification effectué, il faut, pour chaque compte utilisateur concerné, saisir un flux dans '''Gestion > Comptes > Flux > Saisir''', en mettant au crédit ou au débit le compte quota de l'utilisateur concerné et en contre-partie le compte d'encours identifié précédemment. Le montant doit correspondre à la différence entre ce qu'aurait du être le plafond initial et le plafond attribué. Si le plafond final est supérieur, alors c'est un crédit sur le compte utilisateur. Sinon, c'est un débit.

Toutes les documentations

2024-09-06T16:38:17Z

Lhenry: Text replacement - "OF_doc-en" to "OF-doc-en"

__NOTOC__
Bienvenue sur la documentation d'OpenFlyers.

You can also access to our [[OF-doc-en:Main_Page|english documentation]].

Si vous n'êtes pas encore client OpenFlyers, vous trouverez tous les renseignements dans cette [[OF_doc4-fr:Accueil|documentation]].

=[[OF_doc1-fr:Accueil|Documentation OpenFlyers version 1]]=
=[[OF_doc2-fr:Accueil|Documentation OpenFlyers version 2]]=
=[[OF_doc3-fr:Accueil|Documentation OpenFlyers version 3]]=
=[[OF_doc4-fr:Accueil|Documentation OpenFlyers version 4]]=

Suivi des remarques de maintenance

2024-09-06T16:38:16Z

Lhenry: Text replacement - "OF_doc-en" to "OF-doc-en"

=Présentation=
L'objet de cette page est de décrire la mise en place d'un outil de '''suivi des remarques maintenance''' lors de la saisie d'une activité. Cet outil est basé sur les éléments suivants :
*Présence dans le formulaire de saisie des vols de 2 champs supplémentaires intitulés :
**"Remarques maintenance"
**"Réponse mécanicien"
*Présence d'un rapport accessible depuis '''Planning > Données > Rapports utilisateurs > Rapport personnalisés''' qui liste pour une ressource donnée les activités ayant une entrée dans le champ "Remarques maintenance" ou dans le champ "Réponse mécanicien".

=Paramétrage=
==Création des champs de saisie==
*Aller dans '''Admin > Structure > Variables > Champs métiers''' :
*En bas du tableau remplir la dernière ligne vide avec les éléments suivants :
**Colonne '''Nom de variable''' : ''maintenanceUserComment''
**Colonne '''Intitulé''' : ''Remarques maintenance''
**Colonne '''Catégorie''' : ''Vol''
**Colonne '''Type de valeur''' : ''Chaîne textuelle multi-ligne''
*Cliquer sur le bouton '''Ajouter''' à la fin de la ligne
*Répéter l'opration en bas du tableau remplir la dernière ligne vide avec les éléments suivants :
**Colonne '''Nom de variable''' : ''mechanicAnswer''
**Colonne '''Intitulé''' : ''Réponse mécanicien''
**Colonne '''Catégorie''' : ''Vol''
**Colonne '''Type de valeur''' : ''Chaîne textuelle multi-ligne''
*Cliquer sur le bouton '''Ajouter''' à la fin de la ligne

==Mise en place du rapport==
*Rendre visible le rapport [[OF-doc-en:Export-generator-4#Flights-with-mechanic-remark|Vols avec une remarque maintenance]]

Import dans un logiciel comptable tiers

2024-09-06T16:38:16Z

Lhenry: Text replacement - "OF_doc-en" to "OF-doc-en"

=Présentation=
L'objet de cette page est de présenter les bonnes pratiques pour permettre l'import des écritures comptables générées par OpenFlyers dans les logiciels de comptabilités tiers et d'indiquer les procédures à suivre selon les logiciels connus.

=Bonnes pratiques=
*La plupart des logiciels de comptabilités exigent que les comptes soient numérotés uniquement avec des chiffres (exemple : 706000) sauf pour les comptes fournisseurs et les comptes clients où les caractères alphanumériques sont acceptés (exemples : 411pdupont ou 401extal). Il est donc nécessaire dans OpenFlyers de [[Configuration de la comptabilité#Comptes_d'export|renseigner les comptes d'export selon ces règles]].

=Exports/Imports=
Pour importer les écritures comptables générées par OpenFlyers dans un logiciel de comptabilité, il faut d'abord déterminer le format d'export comptable à utiliser dans OpenFlyers.

[[OF-doc-en:Accounting-export-template-list|Différents formats d'exports comptables]] sont disponibles dans OpenFlyers version 4.

Le contenu de la colonne du libellé dépend de la catégorie du compte :
*Catégorie divers, charge, trésorerie, produit et taxe : c'est le nom du compte
*Catégorie utilisateur : c'est le type de compte utilisateur suivi du nom de l'utilisateur
*Catégorie ressource : c'est le type de compte ressource suivi du nom de la ressource
*Catégorie fournisseur : c'est le nom du fournisseur

Le code du journal est défini en fonction des comptes d'exports impliqués dans le flux comptable. Voici les règles programmées par défaut :
#Les comptes d'export de racine "7" génèrent l'utilisation d'un code journal "VT"
#Les comptes d'export de racine "53" génèrent l'utilisation d'un code journal "CA"
#Les comptes d'export de racine "512" génèrent l'utilisation d'un code journal "BQ"

Ces règles s'appliquent par ordre croissant de racine d'export. Ainsi, la racine "7" est inférieure à la racine "53". La règle de racine "7" s'applique donc en 1er et peut-être surpassée par la règle de racine "53".

Nous intégrons sur demande tout type de format d'export. Nous pouvons également personnaliser les formats d'export pour y modifier les règles de génération des codes journaux en sachant que les règles s'appliquent toujours par ordre croissant de racine.

Une fois les écritures exportées dans un fichier, il faut les importer dans le logiciel de comptabilité. Vous trouverez dans les sous-chapitres ci-dessous les procédures pour certains logiciels. N'hésitez-pas à nous contacter pour compléter ces procédures afin d'y faire figurer la procédure pour votre logiciel de comptabilité.

En cas de problème lors d'un import, une liste de messages d'erreurs est générée. Il est recommandé de copier/coller le détail des erreurs dans un [[Trucs-et-astuces#Editer-un-fichier-texte|éditeur de texte]] pour en facilité la lecture. En général, la lecture des messages d'erreur permet d'en comprendre l'origine et de trouver une solution.

Si le problème d'import persiste, il faut [[#Rapporter_un_problème_d'import|rapporter le problème d'import]] à l'équipe OpenFlyers.

Il faut être vigilant sur le fait les logiciels de comptabilité peuvent faire évoluer leur format d'import. Il faut donc faire des tests pour valider le format avant toute utilisation en production.

==Import dans [http://www.ciel.com/logiciel-ciel-compta-evolution.aspx Ciel Compta Evolution]==
Depuis OpenFlyers, utiliser le format [[OF-doc-en:Accounting_export_template_CielXimport|Ciel Ximport]] pour exporter les écritures comptables.

Pour la version 8.1 de Ciel Compta Evolution :
*Aller dans '''Divers > Relation Expert > Import...'''

Pour la version 14.0 de Ciel Compta Evolution :
*Aller dans '''Echange > Importer les écritures'''
*Choisir '''Ciel'''

==Import dans EBP==
''Documentation rédigée d'après la version 2012 du logiciel [http://www.ebp.com/ EBP Compta].''

Dans OpenFlyers, il faut utiliser le format [[OF-doc-en:Accounting_export_template_Ebp2012|EBP 2012]] pour exporter les écritures comptables.

Depuis le logiciel EBP :
*Aller dans '''Outils > Imports/Exports > Import texte au format EBP'''
*Une fenêtre s'ouvre intitulée '''Import texte au format EBP'''
*Dans le cas où il existe déjà des écritures comptables dans la comptabilité d'EBP, il est recommandé d'effectuer une sauvegarde du dossier comptable actuel en cliquant sur le bouton '''Sauver mon dossier maintenant'''. Cela permettra de restaurer la comptabilité en cas de mauvaise injection.
*Ensuite, cliquer sur le bouton '''Suivant >'''
*Dans '''Fichier à importer''', indiquer le nom du fichier généré par OpenFlyers à importer
*Laisser cochés '''Création automatique des comptes''' et '''Création automatique des journaux'''
*Laisser décochés les autres lignes sauf '''Changer les comptes racines en détail'''
*Cliquer sur '''Suivant >'''
*Cliquer sur '''Lancer'''

==Caractères accentués dans les formats d'export==
Les formats d'export pour Ciel et EBP sont anciens (compatibilité avec d'anciennes versions), ils utilisent le format d'encodage CP850. Nos exports pour ces logiciels sont convertis à ce format donc si vous les ouvrez avec un programme qui n'accepte pas cet encodage (tel que Word ou Excel) alors les caractères ne s'afficheront pas correctement. Nous conseillons le logiciel [http://fr.openoffice.org/ OpenOffice] pour les lire. Lors de l'import dans votre logiciel de comptabilité les écritures doivent apparaitre correctement.

La tendance des programmes plus récents est de gérer l'encodage, si ces caractères n'apparaissent pas correctement nous contacter
*'''Conseils''': pour OpenOffice choisir dans l'import de texte : Europe occidentale (DOS/OS2-850 international). Voir [[FAQ-export#Import_de_fichiers_CSV_dans_OpenOffice/LibreOffice|FAQ csv reading with Oo]] pour ne pas avoir de conversion des colonnes avec des chiffres
* Pour le format d'export '''csv''' vous pouvez choisir directement l'encodage de sortie : pour Windows => CP1252, pour Mac => Mac Roman, pour Linux => ISO-8859-15. Dans '''Admin > Configuration > Paramètres''' vous pouvez mettre une valeur par défaut qui sera utilisée dans tous les exports au format csv

=Rapporter un problème d'import=
En cas de problème d'import d'un fichier dans un logiciel de comptabilité, il est nécessaire de faire un copier/coller de l'intégralité du détail des erreurs générées par le logiciel de comptabilité. Si ces erreurs contiennent des informations confidentielles, il est possible de nous envoyer par e-mail le détail des erreurs en indiquant le numéro de bug généré lors de la saisie du [[Rapporter un bug|rapport de bug]].