Wiki1000 - Contributions de l'utilisateur [fr]

CreateDocumentFromDesc (TdbfDocument)

2026-04-24T12:46:34Z

Syfre : Page créée avec « <source lang='delphi'>class function CreateDocumentEx(desc:TJsonStruct; var aReason:string):TabsCustomDocument;</source> Cette fonction crée un document à partir d'un d... »

<source lang='delphi'>class function CreateDocumentEx(desc:TJsonStruct; var aReason:string):TabsCustomDocument;</source>

Cette fonction crée un document à partir d'un descripteur json.

{|class="wikitable"
|-
|desc
|Descripteur structure json
|-
|aReason
|Raison de l'erreur en cas d'échec
|-
|Reesult
|L'objet document créé ou nil
|}

Descripteur

{|class="wikitable"
|-
|name
|Chaine
|Nom du document
|-
|title
|Chaine
|Libellé associé au document
|-
|contentType
|Chaine
|Type de contenu du document
|-
|nature
|Entier
|Nature du document
|-
|oidObject
|Chaine
|Oid de l'objet auquel est associé le document
|-
|lastModified
|Datetime
|Date heure de modification du document
|}

Le nom du document peut être :

En Webtop
# Un chemin vers un fichier accessible à partir de la sandbox du service
# Le nom d'un document téléchargé dans la session de l'utilisateur.

En Destop
# Un chemin vers un fichier accessible à partir de l'application
# Le nom d'un document téléchargé dans le répertoire cache des documents (cache\documents\uploaded).

La nature du document peut être une valeur de l'énuméré Nature de document:

{|class="wikitable"
|-
|Autre
|DOCUMENTNATURE_OTHER
|-
|Archive
|DOCUMENTNATURE_ARCHIVE
|-
|Elément d'archive
|DOCUMENTNATURE_ARCHIVE_ITEM
|-
|Facture
|DOCUMENTNATURE_INVOICE
|-
|Visuel PDF de facture
|DOCUMENTNATURE_INVOICE_PDF
|-
|Facture UBL
|DOCUMENTNATURE_INVOICE_UBL
|-
|Validation UBL
|DOCUMENTNATURE_INVOICE_UBL_SCH
|-
|Facture CII
|DOCUMENTNATURE_INVOICE_CII
|-
|Validation CII
|DOCUMENTNATURE_INVOICE_CII_SCH
|}

'''Exemple :'''

<source lang='delphi'>
//function ExecuteAction(req:TJson; resp:TJson):boolean;
var fileData:TJsonStruct; aReason:string;
begin
// Executed if beforeExecute returns True
//
Result := False;
aReason := '';
//
fileData := GetFileData(req);
if not Assigned(fileData) then Exit; // no expected
//
if (fileData.name<>'') then
begin
fileData.title := titleDocument;
fileData.comment := commentaire.value;
//....
//showMessage('fileData'#13'%s',[fileData]);
//
withP transaction do
begin
TdbfDocument.CreateDocumentFromDesc(fileData,aReason);
end;
end;
//
Result := (aReason='');
end;
</source>

Voir aussi:

{{Footer|TdbfDocument}}
[[category:TdbfDocument]]
[[Category:Version800]]

TdbfDocument (class)

2026-04-24T12:22:56Z

Syfre : /* Méthodes de classe */

__NOTOC__
==Introduction==
La classe TdbfDocument est la classe des documents

===Attributs===
{|class="wikitable"
|-
|[[DateCreate (TdbfDocument)|DateCreate]]
|Date de création de cet objet
|-
|[[oidObject (TdbfDocument)|oidObject]]
|Identifiant de l'objet associé au document
|-
|[[KeyWords (TdbfDocument)|KeyWords]]
|Mots clés associés au document
|-
|[[Document (TdbfDocument)|Document]]
|Nom ou chemin du document
|-
|[[DateDocument (TdbfDocument)|DateDocument]]
|Date du document
|-
|[[ObjectBinary (TdbfDocument)|ObjectBinary]]
|Contenu binaire document
|-
|[[DocumentType (TdbfDocument)|DocumentType]]
|Type du document
|}

===Méthodes d'instance===
{|class="wikitable"
|-
|[[ViewDocument (TdbfDocument)|ViewDocument]]
|Visualiser le document
|-
|[[GetAsBase64Binary (TdbfDocument)|GetAsBase64Binary]]
|Obtenir le contenu document sous forme d'un flux encodé en base 64
|-
|[[SetAsBase64Binary (TdbfDocument)|SetAsBase64Binary]]
|défini le contenu du document par un flux encodé en base 64
|-
|[[GetAsDataURL (TdbfDocument)|GetAsDataURL]]
|Obtenir le contenu du document sous forme d'un flux de type toDataURL()
|-
|[[SetAsDataURL (TdbfDocument)|SetAsDataURL]]
|Défini le contenu du document par un flux de type toDataURL()
|-
|[[GetAsXMLDocument (TdbfDocument)|GetAsXMLDocument]]
|Obtenir le contenu du document sous forme d'un document XML
|-
|[[Print (TdbfDocument)|Print]]
|Impression directe du contenu du document si son type est pdf
|}

===Méthodes de classe===
{|class="wikitable"
|-
|[[CreateDocument (TdbfDocument)|CreateDocument]]
|Créer un document rattaché à un objet
|-
|[[CreateDocumentEx (TdbfDocument)|CreateDocumentEx]]
|Créer un document rattaché à un objet
|-
|[[CreateDocumentFromDesc (TdbfDocument)|CreateDocumentFromDesc]]
|Créer un document à partir d'un descripteur json
|-
|[[ExportToCompressedFile (TdbfDocument)|ExportToCompressedFile]]
|Exporter une liste de documents dans un fichier compressé
|-
|[[GetPdfAttachements (TdbfDocument)|GetPdfAttachements]]
|Extraire tous les attachements d'un flux PDF
|}

Voir aussi :

* [[TdbfDocumentType (class)|TdbfDocumentType]]

{{Footer|Code métier}}
[[category:Classes frameworks]]
[[category:Documents]]
[[category:TdbfDocument]]

TdbfDocument (class)

2026-04-24T12:22:39Z

Syfre : /* Méthodes de classe */

__NOTOC__
==Introduction==
La classe TdbfDocument est la classe des documents

===Attributs===
{|class="wikitable"
|-
|[[DateCreate (TdbfDocument)|DateCreate]]
|Date de création de cet objet
|-
|[[oidObject (TdbfDocument)|oidObject]]
|Identifiant de l'objet associé au document
|-
|[[KeyWords (TdbfDocument)|KeyWords]]
|Mots clés associés au document
|-
|[[Document (TdbfDocument)|Document]]
|Nom ou chemin du document
|-
|[[DateDocument (TdbfDocument)|DateDocument]]
|Date du document
|-
|[[ObjectBinary (TdbfDocument)|ObjectBinary]]
|Contenu binaire document
|-
|[[DocumentType (TdbfDocument)|DocumentType]]
|Type du document
|}

===Méthodes d'instance===
{|class="wikitable"
|-
|[[ViewDocument (TdbfDocument)|ViewDocument]]
|Visualiser le document
|-
|[[GetAsBase64Binary (TdbfDocument)|GetAsBase64Binary]]
|Obtenir le contenu document sous forme d'un flux encodé en base 64
|-
|[[SetAsBase64Binary (TdbfDocument)|SetAsBase64Binary]]
|défini le contenu du document par un flux encodé en base 64
|-
|[[GetAsDataURL (TdbfDocument)|GetAsDataURL]]
|Obtenir le contenu du document sous forme d'un flux de type toDataURL()
|-
|[[SetAsDataURL (TdbfDocument)|SetAsDataURL]]
|Défini le contenu du document par un flux de type toDataURL()
|-
|[[GetAsXMLDocument (TdbfDocument)|GetAsXMLDocument]]
|Obtenir le contenu du document sous forme d'un document XML
|-
|[[Print (TdbfDocument)|Print]]
|Impression directe du contenu du document si son type est pdf
|}

===Méthodes de classe===
{|class="wikitable"
|-
|[[CreateDocument (TdbfDocument)|CreateDocument]]
|Créer un document rattaché à un objet
|-
|[[CreateDocumentEx (TdbfDocument)|CreateDocumentEx]]
|Créer un document rattaché à un objet
|-
|[[CreateDoucmentFromDesc (TdbfDocument)|CreateDoucmentFromDesc]]
|Créer un document à partir d'un descripteur json
|-
|[[ExportToCompressedFile (TdbfDocument)|ExportToCompressedFile]]
|Exporter une liste de documents dans un fichier compressé
|-
|[[GetPdfAttachements (TdbfDocument)|GetPdfAttachements]]
|Extraire tous les attachements d'un flux PDF
|}

Voir aussi :

* [[TdbfDocumentType (class)|TdbfDocumentType]]

{{Footer|Code métier}}
[[category:Classes frameworks]]
[[category:Documents]]
[[category:TdbfDocument]]

Fichier de configuration (server)

2026-03-16T14:34:38Z

Syfre : /* Service */

===Introduction===
Le Serveur d'application Sage 1000 utilise un fichier de configuration situé dans le répertoire du serveur.

{{info|Le nom du fichier est serverl1000.ini}}

Ce fichier peut être soit modifié à l'aide de la console d'administration des services, soit manuellement par un éditeur de texte.

{{tip|Le fichier est chargé au démarrage du service.}}

===Structure===
Le fichier peut configurer plusieurs services exécutés sur le même serveur, chaque service comporte au moins deux sections :

* [\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SERVICE_NAME]
: Cette entrée détermine la configuration réseau du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE]
: Cette entrée détermine la configuration logicielle du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE\Export]
: Cette entrée configure la fonction d'exportation du service.

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\MYSERVICE]
ipcMode=ipcSHM
tcpPort=8090
shmAddress=SYFRE

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\MYSERVICE]
Master base=orasql://myhost/DBMASTER_ORA?prefix="DBMASTERT_ORA."
Master driver=orasql
Master OS Authentication=0
Master user=DBMASTER_ORA
Master password=DBMASTER_ORA
Server Societies=Société de démonstration GCF 1000
Server Application=Sage 1000 Suite Financière
...
</pre>

Chaque section est composée d'une liste de variables (NomVariable=ValeurVariable), les types de données des variables sont :

{|class="wikitable"
|-
!Variable
!Type
|-
|String
|Chaîne de caractère
|-
|Boolean
|Valeur logique 0:Non 1:Oui
|-
|Integer
|Valeur entière
|-
|Liste de chaîne
|Liste de chaîne de caractère séparée par des virgules.
|}

===Section IPC===

{|class="wikitable"
|-
!Variable
!Type
!Contexte
!Usage
|-
|ipcMode
|enumération
|Client/Serveur
|
*ipcTCP
:Mode de communication par TCP/IP
*ipcSHM
:Mode de communication par mémoire partagée (dépréciée)
|-
|tcpPort
|Integer
|Client/Serveur
|Port de communication TCP
|-
|tcpAddress
|string
|Client/Serveur
|Adresse de communication TCP
|-
|shmAddress
|string
|Client/Serveur
|Nom du segment de mémoire partagé
|-
|serverList
|Serveur
|String list
|Configuration de Cluster 
Liste des services associés à cet identifiant de service.
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\TRESO]
ipcMode=ipcTCP
tcpPort=8090
tcpAddress=localhost
</pre>

Exemple de configuration Cluster :

'''fichier du configuration des services :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

'''fichier du configuration du client HTTP :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

===Section Servers===
====IPC====
Ces variables configurent la gestion des services IPC.

La configuration des services IPC peut être renseignée dans une section IPC

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\nom_de_profil]

puis référencée par la variable "IPC Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|IPC Profil
|String
|Référence un nom de section IPC contenant la configuration
|-
|IPC Started
|boolean
|Démarre les services IPC (défaut true)
|}

Les services IPC sont les services permettant de communiquer via RPC.

Vous avez besoins des services IPC si :
* Vous utilisez un serveur HTTP externe (IIS ou Apache).
* Vous utilisez la Console des Processus Métiers pour dialoguer avec ce Service.
* Vous utilisez le Contrôleur des services.
* Ce Service exécute des tâches de traitement déléguées par un autre Service.

Si vous n'utilisez pas les services IPC il est conseillé de ne pas les démarrer.

{{tip|Ce paramètre n'est pas modifiable depuis la console des services car si vous désactivez les services IPC le contrôleur n'est plus opérationnel}}

====Sessions====
Ces variables configurent la gestion des sessions.

La configuration des sessions peut être renseignée dans une section SESSIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\SESSIONS\nom_de_profil]

puis référencée par la variable "SESSIONS Profil"

{|class="wikitable"
|-
!Variable
!Type
!Défaut
!Min
!Usage
|-
|SESSIONS Profil
|String
|
|
|Référence un nom de section SESSIONS contenant la configuration
|-
|CheckInterval
|Entier
|1 minute
|1 minute
|Délai entre chaque test d'expiration en seconde.
|-
|ExpireInterval
|Entier
|15 minutes
|
|Délai d'expiration des sessions en seconde.
|}

====Base master====
Ces variables configurent la base Master utilisée par le service.

La configuration de la base master peut être renseignée dans une section MASTER

[\SOFTWARE\Sage\Ligne 1000\Administration\MASTER\nom_de_profil]

puis référencée par la variable "Master Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Master Profil
|String
|Référence un nom de section MASTER contenant la configuration
|-
|Master base
|String
|Nom de la base de données Master
|-
|Master driver
|String
|Nom du driver de la base de données Master
|-
|Master OS Authentication
|Boolean
|Utiliser l'authentification du système d'exploitation.
|-
|Master user
|String
|Nom d'utilisateur utilisé pour la connexion à la base Master
|-
|Master password
|String
|Mot de passe utilisé pour la connexion à la base Master
|}

====Application et Sociétés====
Ces variables configurent l'application et les sociétés servies par le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Societies
|String
|
|Liste des sociétés/dossiers servies par le service.
|-
|Server Application
|String
|
|Nom de l'application servie par le service.
|-
|Server User
|String
|
|Nom de l'utilisateur du service.
|-
|Server Password
|String
|
|Mot de passe de l'utilisateur du service.
|-
|Server User Group
|String
|
|Nom du groupe de l'utilisateur du service.
|-
|Server Authentication
|String
|
|Annuaire utilisé pour l'authentification.
|-
|Authentication Directories
|liste de chaîne
|8.00
|Annuaires disponibles pour ce service.(code des annuaires séparés par ";")
|}

====Service====
Ces variables configurent le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Name
|String
|
|Nom du service.
|-
|Cache Folder
|String
|
|Répertoire où stocker les fichiers temporaires et les fichiers en cache.
|-
|[[Zone publique (server)|Public Folder]]
|String
|
|[[Zone_publique_(server)|Racine des répertoires partagés du service]].
|-
|[[Public links (server)|Public Links]]
|Liste de chaîne
|
|Liste de répertoires réseaux (séparés par un ;) pour lesquels des [[Stockage_des_documents|documents peuvent être associés]].
|-
|Send Alert To
|String
|
|Liste d'adresses emails (séparées par un ;) auxquelles seront envoyés les messages d'alertes.
|-
|Scripts
|Liste de chaîne
|
|Liste de références CSS ajouté aux pages HTML
|-
|MaxDatagridRowCount
|Integer
|
|Limite le nombre de lignes affichées dans les grilles (par défaut à 10 000).
|-
|[[Security mode (server)|Security Mode]]
|String
|7.00
|Valeurs possibles : Intranet (valeur par défaut) / Internet [[Service_exposé_sur_internet|Voir Service exposé sur internet]]
|-
|Enable Remember User
|boolean
|7.10
|Permet à l'utilisateur d'avoir son nom pré-renseigné dans la page d'authentification (par défaut à vrai)
|-
|MaxPreviewPageCount
|Integer
|
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview max page
|Integer
|10.00
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview blocking
|Boolean
|10.00
|1:Les aperçus sont affichés directement en onglet 0:les aperçus sont envoyés dans la bam.
|-
|Preview timeout
|Integer
|10.00
|Délai d'attente de fin d'aperçu si Preview blocking=1.
|-
|Printer Filter
|chaine
|
|Noms des imprimantes à ne pas proposer, séparées par des points virgules (9.20)
|-
|Portal tab limits
|Integer
|10
|Limite du nombre de TAB ouverts dans le portail
|-
|Portal redirect legacy
|Boolean
|false
|Utilise la redirection vers l'ancien portail
|}

====Automates====
Ces variables configurent le serveur d'automate inclus dans le serveur.

Ces variables peuvent être renseignées dans une section AUTOMATE

[\SOFTWARE\Sage\Ligne 1000\Administration\AUTOMATE\nom_de_profil]

puis référencées par la variable "Automate Profil"

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Automate Profil
|String
|
|Référence une section AUTOMATE.
|-
|Automate Started 
Process Server Started
|Boolean
|
|Démarre le serveur d'automate. (défaut) (*) 
|-
|Automate Name 
Process Server Name
|String
|
|Nom du serveur d'automate à démarrer. (*)
|-
|Automate Message Box 
Process Server Message Box
|String
|
|Boite à messages utilisé par le serveur d'automate.
|-
|Automate Task Service 
Process Task Service
|String
|
|Nom du Service 1000 exécutant les tâches du serveur d'automate.(hostname.servicename)
|-
|Automate Task Count 
|Integer
|6.50
|Nombre maximal de tâches automates simultanées (défaut 1).
|-
|Automate Debug 
|Boolean
|7.00 Patch
|Active le mode debug verbose (**).
|}

{{Version700}} (*) Ces valeurs peuvent être modifiées sur la ligne de commande

{{Version700}} (**) A utiliser conjointement avec la console de trap snmp

====Processus métiers====
Ces variables configurent le service de Processus Métiers inclus dans le serveur.

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|BP Started
|Boolean
|Démarre le service de Processus Métiers (défault).
|}

{{Version700}} Cette valeur peut être modifiée sur la ligne de commande

====Système====
Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PROCESS

[\SOFTWARE\Sage\Ligne 1000\Administration\PROCESS\nom_de_profil]

puis référencée par la variable "Process Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Process Profil
|string
|Référence une section PROCESS
|-
|ProcessAffinity
|String
|Détermine les coeurs utilisés par le processus sur une machine multi-coeurs 
ex : 1,3 pour utiliser les coeurs 1 et 3 d'une machine multi-coeurs.
|-
|ThreadPoolSize
|Integer
|Taille du pool de thread (20)
|-
|FormCacheSize
|Integer
|Taille du cache pour un écran (défaut:20, 0:désactive l'utilisation du cache)
|-
|FormCacheLimit
|Integer
|Taille du cache pour l'ensemble des écrans (256)
|-
|FormCacheReuse
|Integer
|Nombre de fois qu'un écran peut être réutilisé (-1 : pas de limite)
|}

*ProcessAffinity
:Le Processus du serveur est un processus multi-threadé, sur une machine multi-coeurs il utilise tous les coeurs disponibles sur le système d'exploitation. Dans certain cas il est souhaitable de restreindre l'exécution à certains coeurs.

*ThreadPoolsize
:Chaque requête sur le service est exécutée par une thread allouée d'un pool ; lorsque le pool est plein la requête est suspendue jusqu'à ce qu'une thread se libère dans le pool. Cette variable limite la taille du pool de thread et par conséquence limite les contentions et les "context switches" provoqués par le processus.

*FormCacheSize
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre d'instance d'un écran dans le cache.

*FormCacheLimit
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre maximal d'écran dans le cache et par conséquent la mémoire utilisée par le cache d'écran.

*FormCacheReuse
:Indique le nombre de fois qu'un écran en cache peut être réutilisé.

{{info|Pour pouvoir utiliser WMI la dll serviceL1000perf.dll doit être présente dans le répertoire du serveur.}}
{{info|Pour désactiver le cache, définir la valeur de FormCacheSize à 0}}

====Files d'attente====
Ces variables configurent le service de consommation de file d'attente.

Ces variables peuvent être renseignées dans une section PERF.

[\SOFTWARE\Sage\Ligne 1000\Administration\QUEUELISTENER\nom_de_profil]

puis référencée par la variable "Queue listener Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Queue listener Started
|Boolean
|Démarre le service de consommation de file d'attente.
|-
|Queue listener queues
|Liste de chaînes séparées par des ,
|Liste des files d'attente à consommer.
|-
|Queue listener Task count
|Entier
|Nombre maximal de tâches simultanées par service.
|}

Les paramètres de scrutation d'une file d'attente peuvent être configurés à la suite du nom de la file d'attente en séparant les paramètres par un caractère ":"

{|class="wikitable"
|-
!Paramètre
!Valeur par défaut (ms)
!Usage
|-
|Initial
|1000
|Délai initial de scrutation (ms)
|-
|Max
|10000
|Délai maximal de scrutation (ms)
|-
|Increment
|1000
|Incrément du délai jusqu'au délai maximal si aucun message n'est disponible (ms)
|}

Exemple :
<pre>
Queue listener queues=MyQueue1:2000:10:20000,MyQueue2,MyQueue3:100:10:1000
</pre>

Avec les valeurs par défaut, une file d'attente est lue initialement toutes les secondes, puis si aucun message n'est reçu, ce délai monte jusqu'à 10 secondes. Lorsque un message est reçu le délai est réinitialisé à 1 seconde et ainsi de suite.

====Compteurs de performance====

Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PERF

[\SOFTWARE\Sage\Ligne 1000\Administration\PERF\nom_de_profil]

puis référencée par la variable "Performance Counters Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Start Performance Counters
|Boolean
|Démarre les compteurs de performance
|-
|Start Performance Clock
|Boolean
|Démarre l'horloge de performance
|-
|Performance Clock Delay
|Cardinal
|Période de l'horloge de performance (ms)
|-
|HTTP PerfServer Start
|Boolean
|Démarre le serveur HTTP de performance
|-
|HTTP PerfServer Port
|Integer
|Port du serveur HTTP de performance
|-
|HTTP PerfServer Protocol
|String
|Protocole du serveur HTTP de performance
|}

*Start Performance Counters
:Le serveur inclus un certain nombre de [[Compteurs de performance (monitoring)|compteurs de performance]] interrogeables par le [[Serveur de performance (monitoring)|serveur de performance]].

*Start Performance Clock
: Démarre une horloge permettant de générer un évènement de monitoring.

*Performance Clock Delay
: Période de l'horloge de performance. (défaut 1000)

*HTTP PerfServer Start
: Démarre le server HTTP de performance.

*HTTP PerfServer Port
: Port du serveur HTTP de performance. (défaut 9999)

*HTTP PerfServer Protocol
:Protocole du serveur HTTP de performance (défaut http)

Voir la catégorie [[:Category:Monitoring]]

====HTTP====
Ces variables peuvent être renseignées dans une section HTTP

[\SOFTWARE\Sage\Ligne 1000\Administration\HTTP\nom_de_profil]

puis référencée par la variable "HTTP Profil"

Les variables suivantes configurent le protocole HTTP utilisé par le service, elles sont utilisées pour construire des URL pointant sur le service.

{|class="wikitable"
|-
!Nom de variable
!Type
!Version
!Par défaut
!Usage
|-
|HTTP Protocol
|String
|Toute
|http:
|Protocole HTTP publique du Service (http: ou https:)
|-
|HTTP Port
|Integer
|Toute
|80
|Port HTTP publique du Service
|-
|HTTP HostName
|String
|Toute
|Nom local de la machine
|Domaine publique du serveur HTTP frontal
|-
|HTTP ServiceName
|String
|6.51
|Nom du service
|
Nom du service load-balancé utilisé par le service 
Ce nom peut différer du nom du service dans une configuration load balancée. 
C'est ce nom qui est enregistrée dans les URLs de la registry SDATA 
Implémenté pour SOAP à partir de la version 7 
|}

Les variables suivantes configurent [[Serveur HTTP (server)|le service HTTP interne]] inclus dans le serveur.

{{Version700}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP Started
|boolean
|Démarre le serveur HTTP
|-
|HTTP Listen Protocol
|String
|Protocole HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le protocole est défini par HTTP Protocol
|-
|HTTP Listen Port
|Integer
|Port HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le port est défini par HTTP Port
|-
|HTTP Site
|String
|Répertoire du site utilisé par le serveur HTTP
|-
|HTTP Alias
|String
|Nom de section des alias de répertoire du serveur HTTP
|-
|HTTP CertFile
|String
|Si le protocole est https, représente le fichier certificat (.pem)
|-
|HTTP RootCertFile
|String
|Si le protocole est https, représente le fichier certificat de l'autorité intermédiaire qui a signé le certificat "CertFile" (.pem). 
Ce paramètre est optionnel, il est utile si l'autorité intermédiaire n'est pas directement reconnue par le navigateur.
|-
|HTTP KeyFile
|String
|Si le protocole est https, représente le fichier clef privée (.pem ou .key) qui est liée au certificat
|-
|HTTP KeyPassword
|String
|Si le protocole est https, représente le mot de passe qui permet de décoder la clef privée
|-
|HTTP CertIssuer
|String
|Si le protocole est https, représente l'émetteur du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP CertSerial
|String
|Si le protocole est https, représente le numéro de série du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP SSLVersion
|String
|Version du protocole SSL à utiliser: sslvTLSv1_1, sslvTLSv1_2, sslvTLSv1_3 (par défaut :sslvTLSv1_2)
|-
|HTTP SSLCipherList
|String
|Sceaux proposés par le serveur (par défaut "HIGH:!aNULL:!MD5:!RC4") [https://www.openssl.org/docs/manmaster/apps/ciphers.html en savoir plus] Version 7.10
|-
|HTTP KeepAlive
|Boolean
|Détermine la valeur du paramètre KeepAlive des réponses du serveur HTTP. 
La valeur est True (1) par défaut et le serveur renvoi KeepAlive dans ses réponses. 
Cette valeur doit être false (0) pour une configuration load balancée.
|-
|HTTP Private Started
|Boolean
|Permet de démarrer un service http "privé", utile dans le cadre d'une configuration load balancée. 
Ce service n'est adressé que par les autres services, et permet d'économiser la partie SSL des échanges. 
Le port de ce service ne doit pas être exposé au clients web.
|-
|HTTP Private Port
|Integer
|Détermine la valeur du port http privé.
|-
|HTTP Log
|Booléen
|Active la journalisation des flux http (Version 10)
|}

{{tip|TLS 1.3 supporté à partir de la version 10 en utilisant OpenSSL 3.0}}

{{tip|Le protocole/port publique peuvent être différent du protocole/port d'écoute si un load balancer est utilisé.}}

Voir aussi :
* [[Serveur HTTP (server)|Serveur HTTP interne]]
* [[Configuration_du_Serveur_HTTPS|Configuration du serveur en HTTPs]]
* [[Configuration_du_Serveur_HTTP_derrière_un_répartiteur_de_charge|Configuration derrière un répartiteur de charge]]

Certains de ces paramètres peuvent être remplacés par [[Service_1000_(server)|les paramètres de la ligne de commande]] :

{|class="wikitable"
|-
!Paramètre
!Paramètre de la ligne de commande
|-
|HTTP Listen Port
|HTTPPORT
|-
|HTTP KeepAlive
|HTTPKEEPALIVE
|}

====HTTP ACLs====
{{version710}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP ACL
|string
|Liste de règles séparées par une virgule, par ordre de priorité
|}

La syntaxe d'une règle ACL :
<pre>
action-IP/Nob
</pre>

*action
: Type de règle, doit être accept ou deny
*IP
: Addresse IP en notation pointé
*Nob (facultatif)
:Nombre de bits du masque de sous réseau, par exemple 29 correspond au masque 255.255.255.248 et défini un sous réseau de 8 adresses.

[http://jodies.de/ipcalc Calculateur de masque]

Exemple 1 :

Autorise les adresses 192.168.1.0 ... 192.168.1.7 à l’exception de 192.168.1.5

<pre>
deny-192.168.1.5
accept-192.168.1.0/29
</pre>

Exemple 2 :

Autorise seulement l'adresse 192.168.1.1

<pre>
accept-192.168.1.1
deny-0.0.0.0/0
</pre>

====HTTP Web Worker====
{{version800}}

Le Web Worker est un mécanisme de notification asynchrone permettant au client Web d'être notifié des événements survenant coté serveur.

Il permet de gérer les notifications de boîte à message ainsi que les notifications de traitement.

L'utilisation du web worker améliore l'expérience utilisateur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web worker started
|Integer
|Active (1) ou désactive (0) l'utilisation du web worker
|}

{{Tip|Lorsque le web worker est activé, le client génère des requêtes msg.pending périodiques.}}

====HTTP Web Socket====
{{version800}}

Les WebSockets utilisent un protocole permettant de créé des canaux de communication full-duplex à l'intérieur d'une connexion TCP.

L'utilisation des WebSockets améliore l'expérience utilisateur par une meilleur fluidité des échanges.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web socket started
|Integer
|Active (1) ou désactive (0) l'utilisation de WebSocket
|}

{{Tip|

#Les WebSocket ne sont prises en charge que par le serveur HTTP embarqué et en mode '''HTTPs uniquement'''.
#Les WebSockets sont activées par défaut.
#Les WebSocket peuvent ne pas fonctionner ou provoquer des problèmes dans le cas d'utilisation du serveur Sage 1000 derrière un load balancer qui ne supporterait pas le protocole WebSocket.
#L'url utilisée doit correspondre au domaine du certificat SSL. Par exemple, en entreprise, si votre serveur est myhost sur le domaine interne xxx.yyy.zzz le nom de domaine du certificat auto-généré sera myhost.xxx.yyy.zzz. Vous devez utiliser https://myhost.xxx.yyy.zzz comme url d'accès même si https://myhost est valide sur votre réseau. A défaut l'établissement des connexions websockets échoueront.}}

{{Tip|Lorsque les websockets sont actives, le dialogue d'attente n'est pas affiché.}}

====HTTP CSP====
La [https://developer.mozilla.org/fr/docs/Web/HTTP/CSP stratégie de sécurité du contenu] permet d'améliorer la sécurité des sites web.

{{version1000}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CSP
|Liste de chaines
|Liste des règles séparées par ";"
|}

Exemple

HTTP CSP = default-src 'self'; script-src https://example.com

La valeur par défaut est ''default-src 'self'''

====HTTP CORS====
Le [https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS CORS] permet d'autoriser des requêtes provenant d'autre domaine.

{{version800}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CORS Allow origin
|Liste de chaines
|Liste des domaines autorisés
|}

La liste des domaines doit être séparée par des virgules, utilisez * pour autoriser tous les domaines.

Les domaines doivent être qualifié par le protocole, par exemple http://origin.com

Les domaines indiqués ici seront comparés à la valeur du champ d'entête Origin

Lorsque le domain est autorisé, le service retourne dans la réponse :

{| class="wikitable"
|-
!Champ
!Valeur
|-
|Access-Control-Allow-Origin
|Valeur du chanmp Origin de la requête
|-
|Vary
|Origin
|-
|Access-Control-Allow-Credentials
|true
|-
|Access-Control-Allow-Methods
|POST,PUT,DELETE,GET,OPTION
|-
|Access-Control-Allow-Headers
|Valeur de Access-Control-Request-Headers de la requête
|-
|Access-Control-Max-Age
|86400
|}

====FTPs====
Ces variables configurent le serveur FTPs inclu dans le servcice.
Le serveur FTP peut être utilisé sur les containeurs.

[\SOFTWARE\Sage\Ligne 1000\Administration\FTP\nom_de_profil]

puis référencée par la variable "FTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP Profil
|string
|Référence une section FTP
|-
|FTP Start
|1 ou 0
|Démarre le service FTP
|-
|FTP ACL
|Chaîne
|Définit une liste d'ACL optionnelle
|}

====WEB====
Ces variables configurent le service WEB inclu dans le service.

Ces variables peuvent être renseignées dans une section WEB

[\SOFTWARE\Sage\Ligne 1000\Administration\WEB\nom_de_profil]

puis référencée par la variable "WEB Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|WEB Profil
|string
|Référence une section WEB
|-
|MaxDatagridRowCount
|Entier
|Détermine le nombre maximal de lignes chargées dans une grille (défaut 5000)
|-
|GridWindowSize
|Entier
|Détermine le nombre maximal de lignes affichées dans une page de grille. (Défaut 25)
|-
|MDIForms
|1 ou 0
|Défaut 0
|-
|MDIAssistants
|1 ou 0
|Défaut 1
|-
|UseTreeBookClassic
|1 ou 0
|Défaut 0
|-
|SavePortalTabForms
|1 ou 0
|Défaut 1
|-
|DebugJS
|1 ou 0
|Utilise les javascript en mode debug (Défaut 0)
|-
|RecordMode
|1 ou 0
|Active le mode enregistrement pour JMeter (Défaut 0)
|-
|FormRedirect
|1 ou 0
|Active la redirection des urls d'écran, pour IIS cette redirection doit être désactivée. (défaut 1, ativé)
|}

====Export de grille ====

{{Version2025r2}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Grid exporters
|liste de nom d'extension de fichier séparés par une virgule
|Défini les formats d'export autorisés
|-
|Grid export limits
|Entier
|Limite le nombre de lignes exportées
|}

====Mise au point, debugger {{Version700}}====
Ces variables configurent le remote debugger inclus dans le service.

Le remote debugger permet à un poste client desktop de visualiser, modifier et poser des points d'arrêt dans le code métier exécuté par le service.

Ces variables peuvent être renseignées dans une section DEBUGGER

[\SOFTWARE\Sage\Ligne 1000\Administration\DEBUGGER\nom_de_profil]

puis référencée par la variable "DEBUGGER Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|DEBUGGER Profil
|string
|Référence une section DEBUGGER
|-
|DEBUGGER Started
|Boolean
|Démarre le service de Remote debugging
|-
|DEBUGGER Users
|Strings
|Liste des utilisateurs autorisés à utiliser le service de remote debugging
|-
|DEBUGGER Handlers
|Strings
|Liste des handlers des évènements de trace qui seront interceptés et redirigés vers le journal d'évènement, ceci vous permet de visualiser en temps réel ces traces dans la console SNMP. Les handlers possibles sont:
* script
: Evènements générés par la fonction dbgMsg() du code métier
* queries
: Evènements de trace des requêtes SQL
|}

{{warning|L'utilisation de DEBUGGER Handlers peut provoquer une forte consommation de mémoire}}
{{warning|Ces fonctionnalités ne doivent pas être activés sur un serveur de production}}

====LDAP====
Ces variables configurent le serveur LDAP inclus dans le service.

Ces variables peuvent être renseignées dans une section LDAP

[\SOFTWARE\Sage\Ligne 1000\Administration\LDAP\nom_de_profil]

puis référencée par la variable "LDAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|LDAP Profil
|string
|Référence une section LDAP
|-
|LDAP Started
|Boolean
|Démarre le service LDAP (défaut false).
|-
|LDAP Port
|Integer
|Port d'écoute du service LDAP
|-
|LDAP Password
|String
|Mot de passe administrateur du compte system du serveur LDAP ('uid=admin,ou=system')
|}

====SAML====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SAMLv2 Log=1
|Boolean
|Active la trace SAML (à retirer une fois la mise au point effectuée)
|}

====SOAP====
Ces variables configurent le service SOAP inclus dans le serveur.

Ces variables peuvent être renseignées dans une section SOAP

[\SOFTWARE\Sage\Ligne 1000\Administration\SOAP\nom_de_profil]

puis référencées par la variable "SOAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SOAP Profil
|string
|Référence une section SOAP
|-
|SOAP Log Documents
|Boolean
|Active la journalisation des documents SOAP
|-
|SOAP Log Messages
|Boolean
|Active la journalisation des messages SOAP
|-
|SOAP 5.5x
|Boolean
|Utilise l'implémentation SOAP des versions 5.5x
|}

*SOAP 5.5x
:L'implémentation de SOAP a été récrite en version 5.6x, en cas de problème de compatibilité avec des développements existant il est possible d'utiliser l'ancienne implémentation.

====SMTP====
Ces variables configurent le client SMTP utilisé par le service pour envoyer des EMails.

Ces variables peuvent être renseignées dans une section SMTP

[\SOFTWARE\Sage\Ligne 1000\Administration\SMTP\nom_de_profil]

puis référencés par la variable "SMTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SMTP Profil
|string
|Référence une section SMTP
|-
|SMTP Host
|String
|Adresse du serveur SMTP.
|-
|SMTP Port
|Integer
|Port du serveur SMTP.
|-
|SMTP Login
|String
|Utilisateur de connexion du serveur SMTP.
|-
|SMTP Password
|String
|Mot de passe de connexion du serveur SMTP.
|-
|SMTP From
|String
|Adresse EMail de l'expéditeur.
|-
|SMTP UseTLS
|Boolean
|Utilise une sécurisation TLS
|}

====SNMP====
Ces variables peuvent être renseignées dans une section SNMP

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\nom_de_profil]

puis référencés par la variable "SNMP Profil"

Ces variables configurent l'agent SNMP inclus dans le serveur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Profil
|string
|Référence une section SNMP
|-
|SNMP Started
|Boolean
|Démarre l'agent SNMP
|-
|SNMP Port
|Integer
|Port UDP de l'agent SNMP (161)
|-
|SNMP sysName
|String
|Valeur de la variable sysName pour la MIB2
|-
|SNMP sysContact
|String
|Valeur de la variable sysContact pour la MIB2
|-
|SNMP sysLocation
|String
|Valeur de la variable sysLocation pour la MIB2
|-
|SNMP Traps
|liste de chaîne
|Référence des sections SNMPTRAP
|}

Les sections SNMPTRAP permettent de définir des points d'écoute SNMP auquels seront envoyés les messages de traps.

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\nom_de_profil]

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Trap Host
|string
|Nom réseau du point d'écoute
|-
|SNMP Trap Port
|Integer
|Numéro du port du point d'écoute
|-
|SNMP Trap Categories
|Liste de chaîne
|Catégories des traps à envoyer à ce point d'écoute 
|}

La liste des catégories de trap est la suivante :

{|class="wikitable"
|-
!Nom de catégorie
!Type de message
|-
|Service
|Messages relatifs au processus du service.
|-
|Automate
|Messages relatifs aux exécutions de l'automate.
|-
|BP
|Messages relatifs aux exécutions des Processus métiers.
|-
|Authenticate
|Messages relatifs aux erreurs d'authentification.
|}

Exemple de configuration SNMP :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\CONFIG_SNMP_1]
SNMP Started=1
SNMP Start=1
SNMP Port=161
SNMP sysContact = toto@sage.com
SNMP sysName = toto
SNMP sysLocation = Paris,France
SNMP Traps=Service,Automate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Service]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Service,Authenticate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Automate]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Automate,BP
</pre>

====PROXY====

{{tip|Déprécié, utiliser le paramétrage dans la console d'administration.}}

Ces variables configurent le PROXY utilisé par le client HTTP.

Ces variables peuvent être renseignées dans une section PROXY

[\SOFTWARE\Sage\Ligne 1000\Administration\PROXY\nom_de_profil]

puis référencée par la variable "PROXY Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|PROXY Profil
|string
|Référence une section PROXY
|-
|PROXY Host
|String
|Adresse du serveur PROXY.
|-
|PROXY Port
|Integer
|Port du serveur PROXY (défaut 8080).
|-
|PROXY Login
|String
|Utilisateur de connexion du serveur PROXY.
|-
|PROXY Password
|String
|Mot de passe de connexion du serveur PROXY.
|-
|PROXY Timeout
|Integer
|Délai d'expiration du PROXY. (défaut 60 secondes)
|}

====Exceptions====
Ces variables configurent l'enregistrement des exceptions du service.

Ces variables peuvent être renseignées dans une section EXCEPTIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\EXCEPTIONS\nom_de_profil]

puis référencées par la variable "Exceptions logs Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Exceptions logs Profil
|string
|Référence une section EXCEPTIONS
|-
|Exceptions logs Started
|boolean
|Enregistrer les exceptions. Vrai par défaut.
|-
|Exceptions logs path
|String
|Répertoire dans lequel seront créés les fichiers d'exception.
|-
|Exceptions logs ignore
|Liste de chaîne
|Liste d'exception à ignorer.
|-
|Exceptions logs write file
|booléen
|Un fichier d'exception est écrit. Vrai par défaut. Il peut être inutile d'écrire un fichier d'exception si les exceptions sont transmises à un gestionnaire de log (voir LOG MANAGER) et permet dans ce cas ne ne pas encombrer le disque.(V8)
|}

====Captcha====

Dans le cadre d'un service public, les utilisateurs souhaitant s'enregistrer peuvent être soumis à un captcha.

Si l'utilisateur commet trois erreurs lors de l'authentification, il devra saisir un captcha.

voir http://www.google.com/recaptcha

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Recaptcha Public Key
|string
|Clef publique Recaptcha
|-
|Recaptcha Private Key
|String
|Clef privée Recaptcha
|}

====Quotas====

Dans le cadre d'un service public, les utilisateurs téléversent des fichiers dans un répertoire propres à la session.

Ces fichiers doivent avoir une extension prévue pour des questions de sécurité.

La taille totale du répertoire est définie pour éviter un manque de place sur le disque.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Upload Document Size
|integer
|Taille maximale en Mb d'un fichier uploadé; valeur par défaut : 0 (non limité)
|-
|Upload User Quota
|integer
|Taille maximale en Mb du répertoire upload de l'utilisateur par session; valeur par défaut : 50
|-
|Upload Ext Allowed
|String
|Extensions autorisées; valeur par défaut : vide (tout est autorisé)
|-
|Auto delete messages
|Entier
|Durée de conservation en jours des messages
|}

{{tip|La liste des extensions suivantes n'est jamais filtrée car le service est susceptible de créer des fichiers de ce type (xlsx,ods,xml,pdf,,csv,sxc,xls,,jpg,jpeg,png,asice)}}

====Clefs====

Le stockage de certaines clefs peut être externalié

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Key Cookie
|chaine
|[[keyvault_url|url d'un stockage sécurisé externe]], si la clef est non trouvée, elle y sera créée
|}

====Logs====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Log keep days
|entier
|durée en jour de rétention des fichiers dans le répertoire de log, par défaut 10
|-
|SDATA Log Messages
|Boolean
|Enregistre les messages SDATA dans le répertoire de log
|}

===Sections SDATA===
Ces sections permettent de configurer les points d'accès SDATA qui seront exposés par le service.

Les noms de ces sections sont

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\<<nom du service>>\SData\<<incrément 1...>>]

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|DataSetName
|string
|Nom du dataset dans l'URL SDATA
|-
|Title
|string
|Libellé informatif sur l'usage du point d'accès
|-
|Contract
|string
|Nom du paquet de service SDATA
|-
|Version
|string
|Numéro de version, peut être utilisé pour supporté plusieurs version du même contrat
|-
|Folder
|string
|Nom du dossier utilisé par ce point d'accès
|-
|Database
|string
|Nom de la base de donnée utilisé pour ce point d'accès (multi-bases)
|-
|Society
|string
|Nom de la société pour ce point d'accès (multi-société)
|-
|Restitution
|string
|Nom de la famille de restitution pour ce point d'accès (multi-société)
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\SData\1]
DataSetName=iphone
Title=syfre iphone
Contract=ndfContract
Version=1
Folder=Test Syfre iPhone
Database=dbTestIPhone
Society=
Restitution=
</pre>

===Section Export===
Cette section permet de configurer la fonction d'exportation des vignettes de portail des Services.

Deux mode d'exportation sont possibles :

*ftp
: Dans ce mode les vignettes sont générées et copiées dans un répertoire public accessible par ftp.

*file
: Dans ce mode les vignettes sont générées et copiées dans un répertoire local du serveur. Ce mode n'est utile que si le répertoire est un répertoire du Site et que celui-ci est public.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Protocol
|String
|ftp ou file
|-
|Export URL
|String
|Cette URL référence le répertoire où la vignette a été générée.
|}

Si le protocole est 'ftp' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP host
|String
|Addresse du serveur FTP
|-
|FTP Port
|Integer
|Numéro du port du serveur FTP
|-
|FTP Login
|String
|Utilisateur de connexion du serveur FTP
|-
|FTP Password
|String
|Mot de passe de connexion du serveur FTP
|-
|FTP Directory
|String
|Répertoire d'exportation sur le serveur FTP
|}

Si le protocole est 'file' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Directory
|String
|Répertoire d'exportation sur le serveur.
|}

Exemple de configuration ftp utilisant une zone publique Free :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\Export]
Protocol=ftp
Export URL=http://syfre.free.fr/sage/
FTP Host=ftpperso.free.fr
FTP Port=21
FTP Login=syfre
FTP Password=XXXXXXXXXX
FTP Directory=sage
</pre>

===Section ConfigServer===

Cette section permet d'utiliser un fichier de configuration disponible sur une url.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|url
|String
|Cette URL permet de récupérer le fichier de configuration.
|}

Un POST HTTP est effectué sur cette url avec les données suivantes :

<source lang="javascript">
{"deploymentId":"nom_système_de_la_machine"}
</source>

Le résultat attendu est

<source lang="javascript">
{"config":"contenu_du_fichier_de_configuration"},
{"certificate":"certificat_au_format_pfx"}
</source>

*[[Exemple de configuration (server)|Exemple de configuration]]
*[[Service_1000_(server)|Ligne de commande]]

{{Footer|Serveur}}
[[category:Serveur]]

Main Page

2026-03-16T14:28:48Z

Syfre : /* Versions */

__NOTOC__
=Sage FRP 1000 =

===Architectures===
* [[Vue d'ensemble 1000 (arch)|Vue d'ensemble]]
* [[Architecture 2 Tiers (arch)|Architecture 2 Tiers]]
* [[Architecture 3 Tiers (arch)|Architecture 3 Tiers]]
* [[Architecture cluster (arch)|Architecture cluster]]

===Guides des administrateurs===

* [[Administration (admin)|Administration]]
* [[Console d'administration (admin)|Référence de la console d'administration]]
* [[Flux d'administration|Flux d'administration]]

===Guides des intégrateurs===

* [[Automates|Automates]]
* [[Processus Métiers (bp)|Processus Métiers et Workflow]]
* [[Imports|Imports]]
* [[Exports|Exports]]
* [[Guide de la traduction|Traduction]]
* [[Pilotage|Pilotage]]
* [[Publication|Publication]]
* [[Portail|Portail]]
* [[Serveur|Serveur]]
* [[Complément Outlook (Outlook)|Complément Outlook]]
* [[Complément Excel (Excel)|Complément Excel]]

===Guides des développeurs===

* [[Développement ESM|Guide de développement ESM]]
* [[Développement DSM|Guide de développement DSM]]
{{IfLatest|
* [[Développement Mobile|Guide de développement d'applications Mobiles]]
}}
* [[Processus Métiers (bp)|Guide des processus métiers et Workflow]]
* [[Web Services (ws)|Guide de développement de Web Services]]
* [[SData|Guide de développement de l'API Rest SData]]
* [[Tableaux de bord (dev)|Guide de développement des Tableaux de bord]]

* [[Concepteur de modèle|Concepteur de modèle]]
* [[Concepteur d'écran|Concepteur d'écran]]
* [[Concepteur de requêtes (Concepteur de requêtes)|Concepteur de requête]]
* [[Guide des formats |Guide des formats de génération/intégration de fichier]]
* [[Référence_pour_les_formats_de_fichier|Référence pour les formats de fichier]]

===Références===

* [[:Category:RTL|Référence du langage et de l'API]]
* [[Référence des styles|Référence des styles desktop]]
* [[Référence des styles web|Référence des styles webtop]]

===Vidéos===
* [[:Category:Video|Didactitiels vidéo (nécessite flash version 9.02 ou plus)]]

===Versions===

* [[Version 6.00 (release note)|Version 6.00]]
* [[Version 6.50 (release note)|Version 6.50]]
* [[Version 7.00 (release note)|Version 7.00]]
* [[Version 7.10 (release_note)|Version 7.10]]
* [[Version 8.00 (release_note)|Version 8.00]]
* [[Version 9.00 (release_note)|Version 9.00]]
* [[Version 9.10 (release_note)|Version 9.10]]
* [[Version 9.20 (release_note)|Version 9.20]]
* [[Version 10.00 (release_note)|Version 10.00]]
* [[Version 11.00 (release_note)|Version 11.00]]
* [[Version 2024 r1 (release_note)|Version 2024 r1]]
* [[Version 2024 r2 (release_note)|Version 2024 r2]]
* [[Version 2025 r1 (release_note)|Version 2025 r1]]
* [[Version 2025 r2 (release_note)|Version 2025 r2]]
* [[Version 2026 r1 (release_note)|Version 2026 r1]]

===Documents===
* [[Documents|Documents]]

Version 2026 r1 (release note)

2026-03-16T14:28:22Z

Syfre : /* Portail */

{{version2026r1}}
__TOC__

''' PREVIEW '''

==Redirection Portail==

Le portail supporte la redirection à partir de l'écran de connexion vers un écran ou un tableau de bord de l'application.

Exemples :

Redirection vers un écran:
<pre>
https://..../service_name/htmls/htmlhomepage/index.html?redirectUrl=frm%3A%2F%2Fegescom_tiersform.dfm%2FDAC19ACF0B210002079000000E690002
</pre>

Redirection vers un dashboard:
<pre>
https://..../service_name/htmls/htmlhomepage/index.html?redirectUrl=tab%3A%2F%2Fdashboard%2FTDashboardAdminDatabase
</pre>

Redirection vers un écran à partir de l'url de callback d'un workflow :
<pre>
https://.../service_name/server/rpc.l1000/rest/forms.url?value=frm%3A%2F%2Fegescom_tiersform.dfm%2FDAC19ACF0B210002079000000E690002%2F%3Fparams%3D%22ArgOidSiteCommercial%3DmptString%28%27%27%29%26SiteOid%3DmptString%28%27%27%29%22%26options%3D%22%7B%22showCaption%22%3Atrue%2C%22screenCenter%22%3Atrue%2C%22close%22%3Atrue%2C%22formType%22%3A0%2C%22formTitle%22%3A%22ACARIS%20-%20Fiche%20Tiers%22%2C%22helpUrl%22%3A%22https%3A%5C%2F%5C%2Fsagefrp1000.online-help.sage.fr%5C%2F%22%2C%22width%22%3A1827%2C%22height%22%3A912%7D%22%0A
</pre>

[[Category:Version2026r1]]
[[Category:Release note]]

Version 2025 r2 (release note)

2026-03-16T14:28:05Z

Syfre :

{{version2025r2}}
__TOC__

==Langage==

* Valeur par défaut de paramètre
: Il est possible de définir des valeurs par défaut aux paramètres des méthodes

<source lang="delphi">
MyClass = Class(TitObject)
Procedure TestDeffParams;
Procedure TestDefParamBool(p1:string; p2:boolean=true);
Procedure TestDefParamJson(p1:string; p2:TJson=nil);
Procedure TestDefParamJson2(p1:string; p2:TJson='{a:false}');
Procedure TestDefParamEnum(p1:string; p2:Integer=WFCAState_Etat2);
Procedure TestDefParamMulti(p1:string; p2:string='a'; p3:string='b');
Function TestDefParamOne(p1:string='a'):string;
Function TestDefParamFunc(p1:string='a'):string;
end;

Procedure MyClass.TestDefParamJson(p1:string; p2:TJson=nil);
var json:TJson;
begin
json := TJsonStruct.Create('{}');
//
// use Assigned insted of p2<>nil
//
if assigned(p2) then json.addStruct('p2',p2);
end;

Procedure MyClass.TestDeffParams;
var V:string;
begin
V := TestDefParamFunc('c');
ShowMessage(V);

TestDefParamOne;
TestDefParamOne();
TestDefParamOne('x');

TestDefParamMulti('a');
TestDefParamMulti('a','1');
TestDefParamMulti('a','1','2');

TestDefParamBool('a');
TestDefParamBool('a',false);
TestDefParamBool('a',true);

TestDefParamJson2('b');
TestDefParamJson2('b','{a:true}');

TestDefParamEnum('c');
TestDefParamEnum('c',WFCAState_Final);
end;
</source>

* Paramètre de type classe
: Les paramètres de type classe peuvent être passé directement

<source lang="delphi">
Type
MyClass1 = class
class procedure foo(rg:TRegClass);
end;

MyClass2 = class
....
end;

MyClass3 = class
procedure oldbar();
procedure newbar();
end;

class procedure MyClass1.foo(rg:TRegClass);
begin
// => MyClass2
showMessage(rg.aClassName);
end;

procedure MyClass3.oldbar();
var rg:TRegClass;
begin
ModelManager.FindClass('MyClass2');
myClass1.foo(rg);
end;

procedure MyClass3.newbar();
begin
myClass1.foo(MyClass2);
end;
</source>

==Json==
* Opérateur In
: Un json de type structure supporte l'opérateur In

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):boolean;
begin
Result := false;
if 'a' in p then
begin
Result := True;
end;
end;

var js:TJson;
begin
js := TJson.Create('{a:true}');
if _foo(js) then showMessage('ok') else showMessage('nok');
end;
</source>

* Getter et Setter
: Un json de type structure supporte l'accès direct aux valeur des membres

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):boolean;
begin
Result := false;
if 'a' in p then
begin
Result := p['a'];
end;
end;

var js:TJson;
begin
js := TJson.Create('{a:true}');
js['b'] := False;
js['a'] := not js['b'];
if _foo(js) then showMessage('ok') else showMessage('nok');
end;
</source>

* Constructeur implicite
: Un paramètre TJson peut être instancié à partir d'une chaine de caractère

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):boolean;
begin
Result := false;
if 'a' in p then
begin
Result := p['a'];
end;
end;

begin
if _foo('{a:true}') then showMessage('ok') else showMessage('nok');
end;
</source>

{{tip|La chaine doit être une constante, l'instanciation à partir d'une chaîne construite dynamiquement ne marche pas :

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):string;
begin
Result := false;
if 'a' in p then
begin
Result := p['a'];
end;
end;

var v:string;
begin
v := 'une chaine';
if _foo('{a:"'+uneChaine+'"}')<>'' then showMessage('ok') else showMessage('nok'); // don't work !
end;
</source>

}}

* Enumérateurs
: Un json de type strutucture supporte l'énumérateur sur les clés
: Un json de type tableau supporte l'énumérateur sur les éléments

<source lang="delphi">
//Procedure TestJson;

procedure _enumValues(p:TJson);
var i:Integer; V:Variant;
begin
forEach V in p index i do
begin
showMessageFmt('%d:%s',[i,V]);
end;
end;

procedure _enumKeys(p:TJson);
var i:Integer; Key,Keys,stag:string;
begin
Keys := ''; stag := '';
forEach key in p index i do
begin
Keys := Keys+stag+inttostr(i)+':'+key;
stag := ',';
end;
showMessage(Keys);
end;

begin
_enumKeys('{a:true, b:false}');
_enumValues('[{a:true, b:false},{a:false, b:true}]');
end;
</source>

==Modèle==

===Classes===

* Méthode AllocOID

<source lang="delphi">class function AllocOID:TOID;</source>
* Alloue un oid de la classe
: Peut être utile dans les tests unitaires

* Méthode ToJson()

<source lang="delphi">procedure ToJson(SA:variant);</source>

* Sérialize l'objet en json
: SA peut être un TJsonArray ou un TJsonStruct

===Classes SQL===

* Options de rôle : NoRefIndex

* Options de rôle : NoForeignKey

==Script==

===Trace===

<source lang="delphi">procedure dbgClear();</source>
: Vide la trace

<source lang="delphi">procedure dbgEnable(value:boolean);</source>
: Active / désactive la trace

===Vue locale===

* Une vue locale peut contenir des attributs "oidXXX" sans définir le rôle

'''Exemple:'''

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:TEnum(enumName) = ...;
oidRef:TOID = oidrefB;
..
idRefB:TOID = oidrefB notInSelect;
[ (idRefB=%ArgRefB) and ....]
end;
</source>

* Une vue locale peut contenir des attributs non mappés dans la définition, ces attributs peuvent ensuite être mappés dynamiquement par le selecteur en utilisant addColumn()

'''Exemple:'''

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
ACount:Integer = count(oid)
oidRef:TOID;
codeRef:string;
libelleRef:string;
..
[ ...]
end;

var sel:TSelector;
begin
sel := vue1.createSelector();
case iGroupBy of
'refB':
begin
sel.AddColumn('oidrefB','oidRef');
sel.AddColumn('refB.code','codeRef');
sel.AddColumn('refB.Caption','libelleRef');
end;
'refC':
begin
sel.AddColumn('oidrefC','oidRef');
sel.AddColumn('refC.code','codeRef');
sel.AddColumn('refC.Caption','libelleRef');
end;
end;
end;
</source>

* Paramètre de type de donnée

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:TEnum(enumName) = ...;
end;
</source>

* Qualifier d'attribut NotInGroupBy

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:string = expression('...') notInGroupBy;
end;
</source>

* Héritage de vue locale

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:string = ...;
[...]
end;

vue2 = viewOf(vue1)
p2:string = ...;
[inherited and (...)]
end;
</source>

'''Exemple:'''

<source lang="delphi">
//function GetSelector(iGroupBy:string; iFilter:TJsonArray):TSelector;
Type
// défini une classe de base avec tous les filtres
//
vueEcritureLettrage = viewOf(TEcriture)
lettrable:boolean = compteGeneral.lettrable notInSelect;
idEtablissement:TOID = piece.oidEtablissement notInSelect;
idCompteGeneral:TOID = oidCompteGeneral notInSelect;
idRoleTiers:TOID = oidroleTiers notInSelect;
[(lettrable=true)
and ((oidLettrageEcriture='') or (dateLettrage=0))
and (typeEcriture<>0)
and (piece.lot.origineLot<>0)
and (eDate>=%ArgDateInf)
and (eDate<=%ArgDateSup)
and (idEtablissement=%ArgEtablissement)
and (idCompteGeneral=%ArgCompteGeneral)
and (idRoleTiers=%ArgRoleTiers)
]
end;

// Hérite de tous les filtres
//
vueEcritureLettrageGroupBy = viewOf(vueEcritureLettrage)
dateMin:TDatetime = min(eDate);
dateMax:TDatetime = max(eDate);
ACount:Integer = count(oid);
credit:Currency = sum('credit:TCValue');
debit:Currency = sum('debit:TCValue');
solde:Currency = sumDiff(debit,credit);
[inherited]
end;

begin
Result := vueLettrageGroupBy.CreateSelector('','',True,[]);
end;
</source>

* Scope de vue locale

Une vue locale peut être référencée en dehors de la méthode où elle est définie.

<source lang="delphi">
procedure Class1.foo;
Type
vue1 = viewOf(ClassA)
p1:string = ...;
end;
begin
...
end;

procedure Class2.bar;
Type
vue2 = viewOf(class1.foo.vue1)
p2:string = ...;
end;
begin
...
end;
</source>

* Expression Exists()

Une expression existe peut être utilisée dans les filtres comme une valeur logique

{{tip|Une expression Exists() est beaucoup plus rapide qu'un "Count<>0"}

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
id:string = ...;
end;

vue2 = viewOf(ClassB)
id:string = ...;
bb:boolean = vue1.Exists('(id=self.id)',True,[]) notInSelect;
[(bb=true) and (....)]
end;
</source>

* Expression de Sous requête

Une expression peut être définie par une sous requête

<source lang="delphi">
Type
VueTauxADate = ViewOf(TTauxADate)
idTVA : TOid = oidTVA;
tDate : Date = tDate;
taux : float = taux;
end;

vueMontantTVA = viewOf(TEcriture)
dateEcriture:TDatetime=eDate notInSelect;
oidTVA:TOID = ProfilTVA.oidTVA notInSelect;
oidPiece:TOID = oidPiece;
montantTVAReel:Currency = vueTauxADate.select('taux * self.montant_TCValue /100','(tDate<=self.dateEcriture)and(idTVA=self.oidTVA)','',True,[]);
montantTVAReel_CodeDevise:string = montantTVAReel:CodeDevise;
end;
</source>

==ToJson==

Permet de sérialiser l'objet ou l'ensemble d'objets au format json compatible avec les tables du client React

<pre> procedure TObject.ToJson(SA:TJsonArray);</pre>
<pre> procedure TObject.ToJsonEx(SA:TJsonArray; iOptions:TSerializeJsonOptions);</pre>
<pre> procedure TSelector.ToJson(SA:TJsonArray);</pre>
<pre> procedure TSelector.ToJsonEx(SA:TJsonArray; iOptions:TSerializeJsonOptions);</pre>
<pre> procedure TRole.ToJson(SA:TJsonArray);</pre>

TSerializeJsonOptions :

* sjoIdAsGuid
: Le membre id de la sérialisation sera un GUID

* sjoIdAsOid
: Le membre id de la sérialisation sera l'OID de l'objet

<source lang="delphi">

//procedure GetData(SRows:TJsonArray);
Type
myView = viewOf(...)
...
end;

var sel:TSelector;
begin
// Selector to retreive the data
//
sel := myView.CreateSelector('','',True,[]);
sel.ToJson(SRows);
end;
</source>

===Formats===

Le formattage de la sérialisation des propriétés peut être controllé par les propriétés du type

<pre>
Type
vue = viewOf(...)
p:string(typeParam1,typeParam2,typeParam3) = x;
end;
</pre>

{|class="wikitable"
|-
!Type de l'attribut
!TypeParam1
!TypeParam2
!TypeParam3
!Usage
|-
|Currency
|fmtTC
| -
| -
|Le montant est considéré en valeur de tenue de compte
|-
|Currency
|fmtRP
| -
| -
|Le montant est considéré en valeur de reporting
|-
|String contenant un TfwParameters
|fmtParameters
| -
| -
|Valeur des paramètres
|-
|String contenant un TfwParameters
|fmtParameter
|Nom du paramètre
|Valeur par défaut si le paramètre n'existe pas
|Valeur du paramètre
|-
|String
|fmtTaskCategory
| -
| -
|Catégorie de tâche
|-
|oid de TdbfDocument
|fmtDocumentUrl
|Paramètre optionnel contenant le nom du document
|Paramètre optionnel contenant une url externe
|Lien sur le document
|-
|Datetime
|fmtUTC
| -
| -
|La date en considérée UTC et convertie en date locale
|-
|Integer (idOTP)
|fmtClassLabel
| -
| -
|Le libellé de la classe
|-
|Integer (idOTP)
|fmtClassName
| -
| -
|Le nom de la classe
|}

==Sélecteur==

* lastOpeStamp, lastOpeAffected, lastOpeFirstOID
: Attributs mis à jour par la dernière opération assembliste.

* operationId, operation
: Permet d'enregistrer les opérations dans la table TsqlOperation
: S'applique à CopyTo()

* RmvParameter()
: Permet de retirer un paramètre qui a été ajouté par AddParameter()

* Amélioration de CopyTo
: Permet de créer des objets à partir d'un sélecteur

* CopyTo, Update, UpdateFrom
: Fonctionne sur les classes de stéréotype SQL

* InsertInto
: Permet de créer une table temporaire à partir d'un sélecteur
: Réalise un select ... into TEMPTABLE from ...

* SourceTableName
: Permet de sélectionner une table SQL comme source de l'opération
: Utiliser dans les opérations ensemblistes sur des tables temporaires

===TsqlOperation===

Classe SQL définie par le framework et permettant d'enregistrer les opérations du sélecteur

<source lang="delphi">
TsqlOperation = Class(TsqlObject)
public
class procedure CleanOpe(iOpeId:string);
//
property action: StringS[128];
property id: SQLIdentity;
property oidSourceObject: TOID;
property oidTargetObject: TOID;
property opeId: StringS[128];
property operation: StringS[128];
property SourceObject: Ref(roGeneric,roNotExternal,roNoForeignKey,roNoRoleIndex) of TitObject;
property TargetObject: Ref(roGeneric,roNotExternal,roNoForeignKey,roNoRoleIndex) of TitObject;
end;
</source>

* opeId, operationId
: Un identifiant unique (guid) identifiant l'ensemble des opérations

* opération
: Nom de l'opération dans l'ensemble des opérations

* action
: Action de l'opération
: Par exemple INSERT pour un CopyTo

* oidSourceObject
: identifiant de l'objet source dans l'opération
: Par exemple l'objet source de la copie pour un CopyTo

* oidTargetObject
: identifiant de l'objet cible dans l'opération
: Par exemple l'objet copié par un CopyTo

'''Exemple d'utilisation:'''

<source lang="delphi">

// Créer des écritures a partir des réglements
//
procedure _doCreateEcritureReglements(iOidPiece:string; iOpeId:string);
var sel:TSelector;
begin
sel := vueEcritureReglement.CreateSelector('(oidBordereau=%1)','',True,[oidBordereauReglement]);
sel.AddParameter('ArgBordereau',oidBordereauReglement);
sel.Operation := 'EcrReg';
sel.OpeId := iOpeId;
//
sel.CopyTo('TEcriture',['oidpiece','eDate','sens','sensProrata','regimeTVA','typeEcriture'],[
iOidPiece,
BordereauReglement.dateReglement,
sens_credit,
sens_credit,
regimeTVA_Encaissements,
typeEcriture_Brouillard
]);
end;

Type
vueUpdateReglement = viewOf(TReglement)
vl:TsqlOperation = join('(opeId=%ArgOpeId) and (operation=%ArgOperation) and (oidSourceObject=self.oid)');
oidEcriture:TOID = oidEcriture;
oidTargetEcriture:TOID = vl.oidTargetObject;
oidBordereau:TOID = oidBordereauReglement;
end;

// Met à jour l'oidEcriture créée sur les réglements correspondants
..
procedure _doUpdateReglementsEcriture(iOidPiece:string; iOpeId:string);
var sel:TSelector;
begin
sel := vueUpdateReglement.CreateSelector('(oidBordereau=%1)','',True,[oidBordereauReglement]);
sel.AddParameter('ArgOpeId',iOpeId);
sel.AddParameter('ArgOperation','EcrReg');
//
sel.Update(['oidEcriture'],['oidTargetEcriture']);
end;

begin
aOpeId := CreateGuid;
withP long transaction do
begin
aOidPiece := _doCreatePiece();
_doCreateEcritureReglements(aOidPiece,aOpeId);
_doUpdateReglementsEcriture(aOidPice,aOpeId);
...
TsqlOperation.CleanOpe(aOpeId);
end;
end;
</source>

===UpdateFrom()===

<source lang="delphi">
function updateFrom(sel:TSelector; iMatchedProps:Array of string; iUpdatedProps:Array of string; iUpdatedValue:Array of variant):Integer;
</source>

Permet de mettre à jour une classe à partir d'un sélecteur et d'une colonne de correspondance.

'''Exemple :'''

<source lang="delphi">
Type
// Update the temp table
vueTemp = viewOf(TempLettrage)
reference1:string = reference1;
reference2:string = reference2;
modeLettrage:Integer = modeLettrage;
end;

vueRef1 = viewOf(TempLettrage)
//ACount:Integer = count(id);
ATotal:Currency = sumSign(montant:TCValue,sens,'1');
reference1:string = reference1;
[(modeLettrage=0) and (reference1<>'')]
end;

var selT,selG:TSelector;
begin
withP long transaction do
begin
// for updating the temp table on "match"
selT := vueTemp.CreateSelector('','',True,[]);

// Lettrage sur reference 1
selG := vueRef1.CreateSelector('(ATotal=0)','',True,[]);
selG.useCTE := True;
selT.UpdateFrom(selG,['reference1'],['modeLettrage'],[1]);
end;
end;
</source>

<pre>
with CTE as (
select sum(case when t0.sens=1 then ISNULL(t0.montant_TCValue, 0) else -ISNULL(t0.montant_TCValue, 0) end) as "ATotal",t0.reference1 as "reference1"
from dbo.TEMPLETTRAGE t0 WITH (NOLOCK)
where ((t0.modeLettrage = 0) and (t0.reference1 IS NOT NULL))
group by t0.reference1
)
merge into dbo.TEMPLETTRAGE tm0 using (
SELECT *
FROM CTE
Where (ATotal = 0.0000)
) tm1 on (tm1.reference1=tm0.reference1)
when matched then update set
tm0.modeLettrage = 1
;
</pre>

==Opérations ensemblistes SQL==

Des opérations ensemblistes utilisant des tables SQL temporaires peuvent être réalisées en utilisant l'opération InserInto du selecteur.

===Table temporaire===

* TDatabase.AllocTempTable(JobId:string)
: Génère un nom de table temporaire

* TDatabase.DropTempTables(JobId:string)
: Supprime (drop) les tables temporaires

===Vue SQL locale===

Une vue SQL locale permet d'utiliser une table SQL comme source d'opération d'un sélecteur

<source lang="delphi">
Type
// define an interface
intf = interface
...
end;

// create a view which support the interface
// will be used to create the temp table
//
vue = viewOf(MyClass,intf)
end;

// define a sql class based on the interface
//
sql = sqlClass(intf)
end;

// view on the sql class
//
vue2 = viewOf(sql)
...
end;

var sel:Tselector; aJob,aTempTable:string; keepTables:boolean;
begin
// Alloc a temp table name
//
aJob := CreateGuid;
aTempTable := ClassManager.DefDatabase.AllocTempTable(aJob);
KeepTables := false; // for debuging
try
// Create a temp table from MyClass view
//
sel := vue.CreateSelector(...);
sel.insertInto(aTempTable,[...],[...]); // we create a tempTable

// Query the temp table throught the vue2
//
sel := vue2.CreateSelector(...);
sel.SourceTableName := aTempTable; // because we select the tempTable

...
finally
if not KeepTables then ClassManager.DefDatabase.DropTempTables(aJob);
end;
end;
</source>

==Updater==

Classe technique permettant de mettre à jour un attribut sur un ensemble d'objet.

'''Exemple : Mise à jour des compteurs qui ne peuvent pas être déterminés en SQL'''

<source lang="delphi">
Type
// Should returns all attributes part of the counter
//
vueNumeroPiece = viewOf(TPiece)
pDate:TDatetime = pDate;
numero:TCounter = numero;
end;

procedure _doUpdateNumeroPiece(iOidPiece:string);
var sel:TSelector; vueNP:vueNumeroPiece; upd:TUpdater;
begin
upd := TPiece.CreateUpdater('numero');
//
sel := vueNumeroPiece.CreateSelector('(oid=%1)','',True,[iOidPiece]);
forEach vueNP in sel.AsCursor do
begin
vueNP.numero.AllocValue;
upd.AddValue(vueNP.OID,vueNP.numero.value);
end;
//
upd.Execute;
end;

begin

end;

</source>

==Interface==

* [[Améliorations des contrôles d'interface (Version 11.00 2025 r2)]]

[[Category:Version2025r2]]
[[Category:Release note]]

Version 2026 r1 (release note)

2026-03-16T14:27:54Z

Syfre : Page créée avec « {{version2026r1}} __TOC__ ''' PREVIEW ''' ==Portail== Le portail supporte la redirection à partir de l'écran de connexion vers un écran ou un tableau de bord de l'ap... »

{{version2026r1}}
__TOC__

''' PREVIEW '''

==Portail==

Le portail supporte la redirection à partir de l'écran de connexion vers un écran ou un tableau de bord de l'application.

Exemples :

Redirection vers un écran:
<pre>
https://..../service_name/htmls/htmlhomepage/index.html?redirectUrl=frm%3A%2F%2Fegescom_tiersform.dfm%2FDAC19ACF0B210002079000000E690002
</pre>

Redirection vers un dashboard:
<pre>
https://..../service_name/htmls/htmlhomepage/index.html?redirectUrl=tab%3A%2F%2Fdashboard%2FTDashboardAdminDatabase
</pre>

Redirection vers un écran à partir de l'url de callback d'un workflow :
<pre>
https://.../service_name/server/rpc.l1000/rest/forms.url?value=frm%3A%2F%2Fegescom_tiersform.dfm%2FDAC19ACF0B210002079000000E690002%2F%3Fparams%3D%22ArgOidSiteCommercial%3DmptString%28%27%27%29%26SiteOid%3DmptString%28%27%27%29%22%26options%3D%22%7B%22showCaption%22%3Atrue%2C%22screenCenter%22%3Atrue%2C%22close%22%3Atrue%2C%22formType%22%3A0%2C%22formTitle%22%3A%22ACARIS%20-%20Fiche%20Tiers%22%2C%22helpUrl%22%3A%22https%3A%5C%2F%5C%2Fsagefrp1000.online-help.sage.fr%5C%2F%22%2C%22width%22%3A1827%2C%22height%22%3A912%7D%22%0A
</pre>

[[Category:Version2026r1]]
[[Category:Release note]]

Ressource (sdata)

2026-03-11T12:57:44Z

Syfre : /* Mise au point */

__TOC__

{{tip|Voir aussi l'[[API Json (SData)|API en mode JSON]], qui permet d'encapsuler d'avantage les appels de service.}}

==Prérequis==
Les requêtes SData sont exécutées sur [[SData|le point d'accès SData du service]].

La forme simplifiée des urls est

<pre>http://hostname/sdata/ressource?paramètres</pre>

ou

<pre>http://hostname/sdata/societe/ressource?paramètres</pre>

Les requêtes sont authentifiées par un jeton d'authentification placé dans l'entête Authorization de la requêtes.

[[Gestion des jetons d'authentification (Administration)|Le jeton d'authentification peut être géré par le client dans l'administration.]]

Les requêtes doivent comporter les entêtes suivantes :

{|class="wikitable"
|-
|accept
|application/json
|-
|Authorization
|Bearer token
|}

Les url des requêtes doivent être encodées, par exemple :

<pre>https://.../sdata/Société 1/ttiers...</pre>

doit être transmis encodé en

<pre>https://.../sdata.Soci%C3%A9t%C3%A9%201/ttiers....</pre>

==Sélection de version==
Il es possible d'indiquer un numéro de version dans l'url de la requête.

Placez le numéro de version derrière le préfix sdata :

<pre>
https://.../sdata/1/....
</pre>

En absence de numéro de version la dernière version sera utilisée.

==Informations de version==
Utilisez la fonction $version pour retrouver les informations de version

<pre>
GET http://localhost:8080/sdata/$version
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 0,
"debug": true,
"shareEnable": true
}
</pre>

<pre>
GET https://localhost/sdata/$version?select=details
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 1,
"debug": true,
"minors": [
{
"minor": 1,
"details": [
"Fix $batch : Error in commit don't return message and continue execution",
"Fix time measure decimal format use . instead of local",
"Add extension information to $schema",
"Add operations to $schema",
"Add select options to $schema"
]
},
{
"minor": 0,
"details": [
"Add version information"
]
}
]
}
</pre>

Le paramètre select accepte les options suivantes :

{|class="wikitable"
|-
!option
!usage
|-
|details
|Détails des modifications des versions mineurs
|-
|patches
|Liste des patches installés
|}

==Mise au point==
Vous pouvez activer l'enregistrement des messages SDATA dans le répertoire de log du service, en [[[[Fichier_de_configuration_(server)#Logs|configurant le fichier de service]] ou bien en utilisant l'interface de configuration du service.

[[image:Sdata-conf-log.png|600px]]

==Ressource (GET)==
Dans l'interface SData les ressources sont les objets de l'application.

Une ressource est identifié par son uri qui représente le chemin de la ressource.

L'uri est composé du chemin de la classe et d'un sélecteur qui est l'oid de l'objet.

'''Exemple :'''

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')
Response: 200 OK
{
"$baseUrl":"http://localhost:8080/sdata/l1000/gentiers/-/",
"$title":"TTiers - -",
"$updated":"2020-12-22T08:10:09.740Z",
"$resources":[
{
"$url":"TTiers('9D33A23CFA6A005500F6000000285DAE')",
"$title":"ABI Jardin",
"$updated":"2010-03-23T15:37:46.000Z",
"$etag":"9D33A23CFA6A005500F6000000285DAE-000002C60000421C",
"$key":"9D33A23CFA6A005500F6000000285DAE",
"$baseUrl":"http://localhost:8080/sdata/l1000/GenTiers/-/",
"stamp":"000002C60000421C",
.... Attribute list ...
}
]
}
</pre>

===Sélecteur de ressource===

Un sélecteur permet de retrouver une ressource spécifique, il est possible de rechercher une ressource par clé ou clause

{|class="wikitable"
|-
!Sélecteur
!Exemple
|-
|Clé
|TTiers('9D33A23CFA6A005500F6000000285DAE')
|-
|clause
|TTiers(code eq 'ABI 007')
|}

===Code de retour HTTP===

{|class="wikitable"
|-
!Code
!Résultat
|-
|200
|La ressource existe
|-
|404
|La ressource n'existe pas
|}

===Gestion des rôles dans les ressources===
La gestion des rôles de la ressource dépend du type et de la nature du rôle :

{|class="wikitable"
|-
!Type de rôle
!Nature
!Retour
|-
|Référence,Liste
|Composition
|Les ressources composants sont retournées dans le corps de la ressource composée
|-
|Référence
| -
|La ressource référencée est retournée par référence dans le corps de la ressource
|-
|Liste
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe référencée filtrée sur la référence réciproque.
|-
|Association
|Avec suppression en cascade
|Les ressources associées sont considérées comme des composants et retournées dans le corps de la ressource composée.
|-
|Association
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe associée filtrée sur la classe d'association
|}

{{tip|Utilisez une vue pour retourner directement les attributs liés par des références, voir le paramètre select}}

===Gestion du périmètre société===
Par défaut, les requêtes s'exécutent dans le contexte société défini dans le jeton d'authentification.

Vous pouvez définir le contexte société dans le l'url de la requête :

<pre>
METHOD https://host/sdata/society/package/class ...
</pre>

{{tip|Définir le contexte société dans l'url n'est utilisable que sur une base supportant le multi-société. Pour connaitre le statut multi-société, utilisez la requête $version ou bien interrogez [[Utilisation_du_contrôleur_de_partage_(API)|le contrôleur de partage]]}}

==Requête sur les ressources (GET)==
Une requête sur les ressources est une requête sur une classe du modèle.

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?parameters
</pre>

===Paramètres de la requête===

{|class="wikitable"
|-
!Paramètre
!valeur
!Usage
|-
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|-
|where
|Expression objet
|Filtre de la requête
|-
|orderBy
|Attribut de tri
|Ordre de tri de la requête
|-
|count
|Taille de page (*)
|Pagination : Taille de page
|-
|startIndex
|Index de page
|Pagination par page : Numéro de page (0 première)
|-
|startKey
|Valeur de clé ou de tri
|Pagination par clé : Clé de position
|-
|keyDirection
|lt,le,gt,ge
|Pagination par clé : direction par rapport à startKey
|-
|dateFormat
|noTime, locale, utc
|Indique le format de date retourné pour les types de données date comptable
|}

(*) Il existe une limite par défaut si la valeur de count n'est pas précisée.

Les valeurs passées en paramètre doivent être encodées en HTML

Exemple :

where=code eq 'ABI 007'

doit être encodée en :

where=code%20eq%20%27ABI%20007%27

====Select====
Select permet de définir les attributs à retourner, par défaut tous les attributs non vide sont retournés

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
</pre>

La présence du paramètre select conditionne la façon d'exécuter la requête.

Les formats possibles sont :

{|class="wikitable"
|-
!format
!Usage
!Génère l'utilisation d'une vue
|-
|x
|Attribut x de la ressource
|non
|-
|x.y
|Attribut y de la ressource lié par de référence x (jointure exacte)
|oui
|-
|x.+y
|Attribut y de la ressource lié par de référence x (jointure externe)
|oui
|-
|x as y
|Attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y)
|Opération sur l'attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y;z)
|Opération sur les attributs y et z de la ressource retourné sous l'alias x
|oui
|}

Une vue sera utilisée si au moins un des membres de select nécessite l'utilisation d'une vue.

Pour les opérateurs utilisables consultez [[Vue_locale_(langage)|la page sur les vues locales]]

Notes :

* La sélection d'attribut référencé non défini peut générer l'absence de ressources dans le résultat, pour éviter ceci utilisez un spécificateur de jointure externe.
* La sélection d'attribut référencé par un rôle liste peut générer plusieurs ressources dans le résultat correspondant à chaque ressource liée par la relation.
* La séparation des paramètres pour les opérateurs ayant plusieurs paramètres utilise le séparateur ; et pas ,
* Lorsqu'une vue est utilisée, les filtres et ordre de tri sont exprimés par rapport à la vue.

Par exemple :
* TCompteGeneral?select=codeCompte&where=codeCompte ge '4'&orderBy=codeCompte
mais
* TCompteGeneral?select=code as codeCompte&where=code ge '4'&orderBy=code

====Dates comptables====
Le paramètre dateFormat permet de définir le format des dates comptables retournées par l'API

{|class="wikitable"
|-
!Version API
!dateFormat
!Exemple
!Format
!Représente
!Temps UTC
|-
|1.6
|
|2021-05-31T22:00:00Z
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|
|2021-06-01T00:00:00+02
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|locale
|2021-06-01T00:00:00
|Format heure locale
|Un instant heure locale
|
|-
|1.7
|noTime
|2021-06-01
|Format date locale
|Une date locale
|
|-
|1.7
|UTC
|2021-05-31T22:00:00Z
|Format heure UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

====Filtre====

'''Opérateurs:'''

{|class="wikitable"
|-
!opérateur
!équivalence
!exemple
!encoded
|-
|eq
|=
|where=code eq 'ABI 007'
|where=code%20eq%20%27ABI%20007%27
|-
|ne
|<>
|
|
|-
|lt
|<
|
|
|-
|le
|<=
|
|
|-
|gt
|>
|
|
|-
|ge
|>=
|
|
|-
|like
|like
|where=code like 'ABI %'
|where=code%20like%20%27ABI %25%27
|-
|in
|in
|
|
|}

'''Valeurs des paramètres:'''

Les valeurs des paramètres sont passées en littérale

{|class="wikitable"
|-
!Type de donnée
!exemple
|-
|Chaîne
|code eq 'xxx'
|-
|boolean
|flag eq true
|-
|numérique
|value eq 1
|-
|flottant
|value eq 1.0
|-
|date (voir format)
|$updated > '2019-12-31T23:00:00Z'
|-
|enum (par index)
|value eq 1
|-
|enum (par constant)
|value eq sens_credit
|}

Format des paramètres date :

{|class="wikitable"
|-
!format
!décodage
!Exemple (1 jan. 2020 France)
|-
|AAAA-MM-DDTHH:MM:SS.MMMZ
|ISO-8601 UTC
|2019-12-31T23:00:00Z
|-
|AAAA-MM-DDTHH:MM:SS.MMM+OFFSET
|ISO-8601 avec timezone
|2019-12-31T23:00:00+1
|-
|AAAA-MM-DDTHH:MM:SS.MMM
|ISO-8601 sans timezone
|2020-01-01T00:00:00
|-
|AAA-MM-DD
|Date au format ISO-8601
|2020-01-01
|-
|DD/MM/AAAA
|Date au format local
|01/01/2020
|}

====Ordre de tri====

Tri ascendant :

orderby=code

Tri descendant :

orderby=code%20desc

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc
</pre>

====Pagination par page====

Utiliser orderBy, count et startIndex

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=0
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=10
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=20
...
</pre>

{{tip|Incrémentez startIndex du nombre de ressource retourné par la requête}}

====Pagination par clé====

Utiliser orderBy, startKey et keyDirection

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
</pre>

==Création de ressource (POST)==
<pre>
POST http://localhost:8080/sdata/gentiers/ttiers
Request:
{
"code":"SYFRE1",
"caption":"syfre 1",
"sitesList":[
{
"code":"SITE1",
"caption":"site1 de syfre1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E20022",
"$url": "http://localhost:8080/sdata/l1000/gentiers/-/TTiers('9D33A23CFA6A005500F6000001E20022')",
... attribute list ...
}
]
}
</pre>

===Gestion du périmètre de partage===

Le niveau de partage d'une ressource de niveau activité peut être contrôlé par des propriétés de contrôle au niveau de la définition de la ressource :

{|class="wikitable"
|-
!Contrôle
!Usage
|-
|$shareId
|Valeur du périmètre sur lequel créer l'objet
|-
|$shareLevel
|Niveau de partage sur lequel créer l'objet (0:dossier,1:activité ou 2:société)
|}

<pre>
POST https://localhost/sdata/S3/gentiers/ttiers
Request:
{
"$shareLevel":2,
"code":"SYFRES3-2",
"caption":"syfre S3-2",
"sitesList":[
{
"code":"SITE1",
"caption":"site 1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response : 201 OK
</pre>

{{Tip|Par défaut la ressource sera créée au niveau activité}}

===Gestion des rôles===

La création de ressource dans les rôles dépend de la nature du rôle.

* Pour les rôles de type composition les ressources liées sont créés simultanément.
* Pour les rôles qui ne sont pas des compositions les ressources liées sont rattachés.

'''Identification des références'''

'''Par clé:'''
<pre>
{
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
</pre>

'''Par uri:'''
<pre>
{
"pays":{
"$url":TPays("9D33A23CFA6A005500150000001700FD")
}
}
</pre>

'''Par expression:'''
<pre>
{
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
</pre>

Lorsqu'une expression est utilisée la première ressource retournée par l'expression est utilisée.

===Gestion des dates comptables===
Pour les dates comptables, le serveur convertit la date reçu en heure locale puis conserve la partie date.

{|class="wikitable"
|-
!Format
!Représente
!Exemple
!Interprète
|-
|locale
|Une heure locale
|2021-06-01T00:00:00
|Conserve l’heure reçue en heure locale et conserve la date, la date sera toujours celle transmise.
|-
|noTime
|Une date sans heure
|2021-06-01
|Conserve la date reçue sans conversion, la date sera toujours celle transmise.
|-
|UTC
|Un instant universel UTC
|2021-05-31T22:00:00Z
2021-05-31T22:00:00+02
|Convertit l’heure UTC en heure locale du service et conserve la date reçue, la date peut être différente de la date transmise si le client et le service ne sont pas dans le même fuseau horaire.
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

==Modification de ressource (PUT)==
<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request:
{
"codeSIRET":"12345678"
}
Response: 200 OK
[
{
.... resource modified ...
}
]
</pre>

===Modification de rôle liste composition===
Par défaut les rôles composition sont gérés en remplacement, pour contrôler le mode de gestion des rôles utilisez un élément de contrôle "$" pour le rôle :

'''Exemple : Modification du rôle par remplacement des composants :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites has been removed.
... There is one site left in the list
]
]
}
</pre>

'''Exemple : Modification du rôle par ajout de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["create"]
},
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites are not affected
... There is one site more in the list
}
]
]
}
</pre>

'''Exemple : Modification du rôle par mise à jour de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["update"]
},
"sitesList":[
{
"$key":"9D33A23CFA6A005500F6000001E30019",
"caption":"Site maj",
}
]
}
</pre>

{|class="wikitable"
|-
!contrôle
!action
|-
|create
|Les nouvelles ressources sont ajoutées au rôle
|-
|update
|Les ressources existantes dans le rôle sont mise à jour
|-
|delete
|Les ressources existantes et non présentes dans la requête sont supprimées
|}

La valeur par défaut est "create","update","delete"

===Modification des attributs privés===
Par défaut les attributs privés sont modifiés sur le niveau de partage correspondant au périmètre société, pour contrôler le niveau de partage des attributs privés utilisez un élément de contrôle $sharePrivateLevel.

{|class="wikitable"
|-
!sharePrivateLevel
!Périmètre de définition
|-
|absent
|Périmètre courant de l'objet
|-
|0
|Dossier
|-
|1
|Activité
|-
|2
|Société
|}

{{tip|Le périmètre courant de l'objet dépend de l'état de l'objet. Par exemple, si l'objet est de niveau activité et n'a pas de propriété défini pour la société courante, le périmètre courant sera l'activité, mais si l'objet a des propriétés définies pour la société courante alors le périmètre courant sera la société. Ne pas définir explicitement le niveau de partage peut amener à des ambiguïtés.}}

'''Modification de la valeur de l'attribut privé pour les sociétés de l'activité du Tiers (le tiers n'a pas de propriété défini pour la société S3):'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"modeReglementDecaissement":{"$where":"code eq 'CHQ'"},
}
</pre>

'''Modification de la valeur de l'attribut privé pour la société S3 :'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"$sharePrivateLevel":2,
"modeReglementDecaissement":{"$where":"code eq 'CBB'"},
}
</pre>

==Suppression de ressource (DELETE)==
<pre>
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Response: 200 OK
</pre>

==Opération sur une ressource (POST)==

Les opérations des ressources correspondent aux méthodes publiques de cette ressource.

===Méthode d'instance de ressource===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/wfclassea('B5A28A92EB0C00020010000000DB0006')/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Méthode de classe de ressource, ou méthode de classe non persistante===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Passage des paramètres===
Les paramètres sont passés par nom et valeur.

Les types de paramètres et de retour supportés sont :

{|class="wikitable"
|-
!Type
!Exemple
|-
|Chaîne
|"p":"xxx"
|-
|Entier
|"p":1
|-
|Boolean
|"p":true
|-
|Flottant
|"p":1.1
|-
|Datetime
|"p":"2020-12-25T01:01:01"
|-
|Enuméré (par valeur)
|"p":1
|-
|Liste d'objets
|"p":[ {$key:"key", $uuid:"uuid", $where:"expression"}, ...],
|}

{{tip|Les références des objets passés dans des listes peuvent être définies par clé ($key), identifiant appelant ($uuid) ou expression ($where)
Exemple :
<pre>
{
"paramList":[
{"$key":"B5A28A92EB0C00020010000001F500A1"},
{"$where":"uneChaine like 'cN%'"}
]
}
</pre>
}}

===Résultat de type ressource===
Lorsque l'opération retourne un objet ou une liste d'objets ceux-ci sont retournés sous forme de ressource.

Par exemple :

<source lang="delphi">
//class Function GetWFClasseA(const iCode:string):WFClasseA;
begin
Result := WFClasseA.Find('(unCode = %1)','unCode',True,[iCode]);
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassea
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:41:41.015Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
}
]
}
}
</pre>

<source lang="delphi">
//Class Function GetWFClasseA(const iCodeLike:string):WFClasseAList;
begin
Result := WFClasseA.CreateListWhere('(unCode like %1)','','unCode',True,-1,[iCodeLike]);
end;
</source>

<pre>

POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassealist
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:49:14.061Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
},
{
"$key": "B5A28A92EB0C00020010000001B4000E",
"$etag": "B5A28A92EB0C00020010000001B4000E-0000025000000025",
"stamp": "0000025000000025",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaalb",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 2,
"title": "Etat 2"
},
"unStatus": 0
},
{
"$key": "B5A28A92EB0C00020010000001B4001A",
"$etag": "B5A28A92EB0C00020010000001B4001A-0000018B0000001A",
"stamp": "0000018B0000001A",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaale",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 0,
"title": "Initial"
},
"unStatus": 0
},
......
]
}
}
</pre>

===Initialisation de la ressource===
Il est possible d'initialiser la ressource avant d'exécuter la méthode, par exemple pour un processus :

<source lang="delphi">
Type
TmyProcessus = class
public
procedure Execute(p:string);
property attString:string;
property attInt:Integer;
property attRef:TRefClass;
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/execute
Request:
{
"$resource":{
"attString":"value 1",
"attInt":100,
"attRef":{"$url":"TRefClass('xxx')"},
},
"p":"value",
}
Response: 200 OK
{
"result":""
}
</pre>

==Requête Batch (POST $batch)==
Une requête Batch permet de réaliser plusieurs opérations de type GET,POST/PUT/DELETE/EXEC en une seule fois.

Une requête Batch contient un tableau de ressources, pour chaque ressource l'action et l'uri doivent être précisées :

<pre>
POST http://.../sdata/$batch
{
"$resources":[
{
"$httpMethod":"POST",
"$url":"gentiers/ttiers",
"code":"SYFRE2",
"caption":"syfre 2",
"sitesList":[
{
"code":"SITE1",
"caption":"site2 de syfre2",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
]
}
</pre>

{{tip|Le format d'url complet de $Batch est https://hostname/service/server/sdata/l1000/-/-/$batch}}

===Gestion de la transaction dans un batch===
Par défaut les opérations réalisées sont unitaires (une transaction par ressource).

Pour réaliser une opération Batch atomique (une seule transaction longue) utilisez un élément de contrôle transaction :

Lorsque l'opération est atomique la réponse contient un élément $batch indiquant le statut de l'opération.

Le code de retour http est le code de retour de la dernière opération réalisée.

<pre>
POST http://localhost:8080/sdata/$batch
{
"$": {"$transaction":["atomic"]},
"$resources":[
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')",
"$uuid":"1",
"capital":{"value":7200,"CodeDevise":"USD"}
},
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$uuid":"2",
"capital":{"value":1000,"CodeDevise":"EUR"}
}
]
}
Response : 401
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "PUT",
"$httpMessage": "OK",
"$etag": "9D33A23CFA6A005500F6000000285DAE-0000018C00000001"
},
{
"$httpStatus": 410,
"$httpMessage": "Already Deleted",
"$uuid": "2",
"$url": "gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis"
}
]
}
}
],
"$batch": {
"$httpStatus": 400,
"$httpMessage": "ROLLBACK",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis",
"entry": {
"number": 2,
"uuid": "2"
}
}
]
}
}
}
</pre>

'''$transaction :'''

{|class="wikitable"
|-
!Commande
!Action
|-
|atomic
|Démarre une transaction longue
|-
|flush
|Force un batch de la transaction longue
|-
|commit
|Valide la transaction longue
|}
{{Tip|L'élément de contrôle de transaction peut être placé au niveau d'un ordre du lot.}}

===Execution de méthode dans un batch===
Utiliser le verbe EXEC pour exécuter une méthode

<pre>
POST http://localhost:8080/sdata/$batch
{
"$resources":[
{
"$httpMethod":"EXEC",
"$url":"testsyfrewf/wfprocessus/testmethod",
"$resource":{
"uneChaine":"value 1"
},
"p":"value 2"
}
]
}
Response : 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "POST",
"$httpMessage": "Executed",
"$url": "testsyfrewf/wfprocessus/testmethod",
"$uuid": "",
"result": "value 1 value 2"
}
]
}
</pre>

==Schéma d'une ressource (GET $schema)==
Le schéma d'une ressource retourne la structure de la classe.

<pre>
GET http://localhost:8080/sdata/testsyfrewf/wfclassea/$schema
Response : 200 OK
{
"title": "Libellé de la Classe A",
"stereotype": "persistent",
"properties": {
"unBool": {
"type": "boolean",
"title": "Un Bool"
},
"unCode": {
"type": "string",
"title": "Un code"
},
"unCompteur": {
"type": "string"
},
"unDerive": {
"type": "string",
"title": "Un dérivé"
},
"unDouble": {
"type": "double",
"title": "Un double"
},
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEmail": {
"type": "string",
"title": "Un email"
},
"unEntier": {
"type": "int",
"title": "Un Entier"
},
"unEtat": {
"type": "integer",
"title": "Un Etat"
},
"unStatus": {
"type": "int",
"title": "Statut de l'objet (Panel)"
},
"WFClasseBRef": {
"type": {
"$ref": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseB/$schema",
"$relationship": "reference"
},
"title": "Référence B"
},
"WFClasseCList": {
"type": "array",
"item": {
"title": "Classe C",
"properties": {
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEntier": {
"type": "int",
"title": "un entier"
}
}
}
}
},
"$url": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseA/$schema"
}
</pre>

Le contenu de la réponse peut être configurée avec le paramètre "select", à défaut toutes les informations sont retournées.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|extensions
|Retourne uniquement les attributs issus d'extension
|-
|properties
|Retourne la liste de tous les attributs
|-
|selfProperties
|Retourne uniquement les attributs de la classe elle même
|-
|operations
|Retourne les opérations de la classe
|-
|compositions
|Retourne le schéma des classes composants
|}

Exemple : Retrouver uniquement les attributs d'extension d'une classe :

<pre>
GET http://localhost:8080/sdata/ttiers/$schema?select=extensions
{
"title": "Tiers",
"stereotype": "persistent",
"extensions": [
{
"class": "TTiers_esmPackage",
"title": "Extension de TTiers",
"package": "esmPackage"
}
],
"properties": {
"esmCode": {
"type": "string",
"extension": "TTiers_esmPackage",
"title": "un code esm"
}
},
"$url": "http://localhost:8080/sdata/gentiers/TTiers/$schema"
}
</pre>

==Modèle de ressource (GET $template)==
Le modèle de ressource retourne une ressource initialisée

<pre>
GET http://localhost:8080/sdata/gcimport/TImportContratCommercial/$template
Response : 200 OK

{
"$url": "http://localhost:8080/sdata/l1000/gcimport/-/TImportContratCommercial",
"stamp": "000001D900000001",
"acompte": 0,
"affaire": "",
"budget": "",
"Caption": "",
"commandeEngagement": false,
"commercial": "",
"coursDevise": {
"value": 1,
"CodeDevise": "",
"Date": "1899-12-30T00:00:00.000Z",
"TCConv": "",
"TCValue": 0,
"RPConv": "",
"RPValue": 0
},
"coursNegocie": false,
"dateCommande": "1899-12-30T00:00:00.000Z",
"dateLivraison": "1899-12-30T00:00:00.000Z",
"devise": "",
"donneeEDI1": "",
"donneeEDI2": "",
"donneeEDI3": "",
"donneeEDI4": "",
"donneeEDI5": "",
"echeancement": "",
"etablissement": "",
"exonereTaxe": "",
"exonereTVA": "",
"gestionTransport": {
"value": 0,
"title": "Automatique"
},
"immobilisation": {
"value": 0,
"title": "B&S"
},
"ImportCCDetailList": [],
"importeGMAO": false,
"importerRemisePied": false,
"ImportSiteAdresse": {},
"incoterm": "",
"MentionExonerationTVA": "",
"posteBudgetaire": "",
"pourcentAcompte": {
"value": 0,
"Decimales": 2
},
"pourcentRemisePied": {
"value": 0,
"Decimales": 2
},
"reference": "",
"referenceMandat": "",
"regimeTVA": "",
"roleTiers": "",
"roleTiersLivre": "",
"SessionImportation": {},
"typeFacturation": {
"value": 0,
"title": "HT"
}
}
</pre>

Voir aussi :

* [[SData|Point d'accès et url SData]]
* [[Gestion des jetons d'authentification (Administration)|Gestion des jetons d'authentification]]
* [[API Json (SData)|API SData en mode json]]
* [[Fichier_de_configuration_(server)#Logs|Enregistrement des messages SDATA]]

Voir aussi les exemples suivants :

* [[Utilisation du contrôleur de partage (API)|Utilisation du contrôleur de partage]]
* [[Interrogation des écritures (API)|Interrogation des écritures avec l'API SData]]
* [[Interrogation des fournisseurs (API)|Interrogation des fournisseurs avec l'API SData]]
* [[Creation d'un fournisseur (API)|Création d'un fournisseur avec l'API SData]]
* [[Import_de commandes_(API)|Import de commandes avec l'API SData]]
* [[Import_d%27écritures_(API)|Import d'écritures avec l'API SData]]
* [[Gestion des réceptions fournisseurs (API)|Gestion des réceptions fournisseurs avec l'API SData]]
* [[Facturation d'un bon de livraison (API)|Facturation d'un bon de livraison avec l'API SData]]
* [[Creation_d%27un_Tiers_et_son_compte_bancaire_(API)|Creation_d'un Tiers et son compte bancaire (API)]]
[[Category:SData]]

Fichier:Sdata-conf-log.png

2026-03-11T12:53:30Z

Syfre :

API Json (SData)

2026-03-11T09:43:43Z

Syfre : /* Méthode JSON */

==Prérequis==

L'API Json est une variante de [[Ressource (sdata)|l'API SData en mode ressource]]

Les informations de connexion et les schémas d'URL sont identiques.

A la différence de l'API en mode ressource, elle nécessite le déploiement de paquet DSM pour gérer les appels de service.

==Méthode JSON==

Dans ce mode, au lieu de manipuler des ressources retournées en xml ou json, le client appele des méthodes en passant en paramètre un payload json et en recevant en retour une responde json.

La signature de ces méthodes doit être :

<source lang="delphi">
procedure foo(req:TJson; out resp:TJson);
var json:TJson;
begin
json := TJson.Create('{}');
....
resp := json;
end;
</source>

Ces méthodes peuvent être membre de n'importe quelle classe non persistante, ou d'une classe support d'un paquet de service local.

==Paquet de service local==

L'utilisation d'un paquet de service local permet d'appeler directement les méthodes de la classe support du paquet.

Par exemple :

[[image:api-json-1.png|800px]]

Vous pouvez appeler directement la méthode myMethodJson() sans explicitement indiquer la classe support :

<pre>
http://localhost:8080/sdata/dsmPaquetDeService/myMethodJson
</pre>

[[image:api-json-2.png|800px]]

==Paquet de classes non persistantes ==

Les méthodes Json membres de classes non persistantes peuvent aussi être appelées.

Par exemple :

[[image:api-json-3.png|800px]]

Dans ce cas vous devez spécifier le nom de la classe dans l'URL d'appel de la méthode.

<pre>
http://localhost:8080/sdata/dsmPaquetAPI/myMethodJson
</pre>

[[image:api-json-4.png|800px]]

Voir aussi:

* [[Ressource (sdata)|API SData en mode ressource]]

[[Category:SData]]

API Json (SData)

2026-03-11T09:43:18Z

Syfre : /* Méthode JSON */

==Prérequis==

L'API Json est une variante de [[Ressource (sdata)|l'API SData en mode ressource]]

Les informations de connexion et les schémas d'URL sont identiques.

A la différence de l'API en mode ressource, elle nécessite le déploiement de paquet DSM pour gérer les appels de service.

==Méthode JSON==

Dans ce mode, au lieu de manipuler des ressources retournées en xml ou json, le client appele des méthodes en passant en paramètre un payload json et en recevant en retour une responde json.

La signature de ces méthodes doit être :

<source lang="delphi">
procedure foo(req:TJson; out resp:TJson);
var json:TJson;
begin
json := TJson.Create('');
....
resp := json;
end;
</source>

Ces méthodes peuvent être membre de n'importe quelle classe non persistante, ou d'une classe support d'un paquet de service local.

==Paquet de service local==

L'utilisation d'un paquet de service local permet d'appeler directement les méthodes de la classe support du paquet.

Par exemple :

[[image:api-json-1.png|800px]]

Vous pouvez appeler directement la méthode myMethodJson() sans explicitement indiquer la classe support :

<pre>
http://localhost:8080/sdata/dsmPaquetDeService/myMethodJson
</pre>

[[image:api-json-2.png|800px]]

==Paquet de classes non persistantes ==

Les méthodes Json membres de classes non persistantes peuvent aussi être appelées.

Par exemple :

[[image:api-json-3.png|800px]]

Dans ce cas vous devez spécifier le nom de la classe dans l'URL d'appel de la méthode.

<pre>
http://localhost:8080/sdata/dsmPaquetAPI/myMethodJson
</pre>

[[image:api-json-4.png|800px]]

Voir aussi:

* [[Ressource (sdata)|API SData en mode ressource]]

[[Category:SData]]

Ressource (sdata)

2026-03-11T09:22:18Z

Syfre : /* Modèle de ressource (GET $template) */

__TOC__

{{tip|Voir aussi l'[[API Json (SData)|API en mode JSON]], qui permet d'encapsuler d'avantage les appels de service.}}

==Prérequis==
Les requêtes SData sont exécutées sur [[SData|le point d'accès SData du service]].

La forme simplifiée des urls est

<pre>http://hostname/sdata/ressource?paramètres</pre>

ou

<pre>http://hostname/sdata/societe/ressource?paramètres</pre>

Les requêtes sont authentifiées par un jeton d'authentification placé dans l'entête Authorization de la requêtes.

[[Gestion des jetons d'authentification (Administration)|Le jeton d'authentification peut être géré par le client dans l'administration.]]

Les requêtes doivent comporter les entêtes suivantes :

{|class="wikitable"
|-
|accept
|application/json
|-
|Authorization
|Bearer token
|}

Les url des requêtes doivent être encodées, par exemple :

<pre>https://.../sdata/Société 1/ttiers...</pre>

doit être transmis encodé en

<pre>https://.../sdata.Soci%C3%A9t%C3%A9%201/ttiers....</pre>

==Sélection de version==
Il es possible d'indiquer un numéro de version dans l'url de la requête.

Placez le numéro de version derrière le préfix sdata :

<pre>
https://.../sdata/1/....
</pre>

En absence de numéro de version la dernière version sera utilisée.

==Informations de version==
Utilisez la fonction $version pour retrouver les informations de version

<pre>
GET http://localhost:8080/sdata/$version
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 0,
"debug": true,
"shareEnable": true
}
</pre>

<pre>
GET https://localhost/sdata/$version?select=details
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 1,
"debug": true,
"minors": [
{
"minor": 1,
"details": [
"Fix $batch : Error in commit don't return message and continue execution",
"Fix time measure decimal format use . instead of local",
"Add extension information to $schema",
"Add operations to $schema",
"Add select options to $schema"
]
},
{
"minor": 0,
"details": [
"Add version information"
]
}
]
}
</pre>

Le paramètre select accepte les options suivantes :

{|class="wikitable"
|-
!option
!usage
|-
|details
|Détails des modifications des versions mineurs
|-
|patches
|Liste des patches installés
|}

==Mise au point==
Vous pouvez activer [[Fichier_de_configuration_(server)#Logs|l'enregistrement des messages SDATA]] dans le répertoire de log du service.

==Ressource (GET)==
Dans l'interface SData les ressources sont les objets de l'application.

Une ressource est identifié par son uri qui représente le chemin de la ressource.

L'uri est composé du chemin de la classe et d'un sélecteur qui est l'oid de l'objet.

'''Exemple :'''

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')
Response: 200 OK
{
"$baseUrl":"http://localhost:8080/sdata/l1000/gentiers/-/",
"$title":"TTiers - -",
"$updated":"2020-12-22T08:10:09.740Z",
"$resources":[
{
"$url":"TTiers('9D33A23CFA6A005500F6000000285DAE')",
"$title":"ABI Jardin",
"$updated":"2010-03-23T15:37:46.000Z",
"$etag":"9D33A23CFA6A005500F6000000285DAE-000002C60000421C",
"$key":"9D33A23CFA6A005500F6000000285DAE",
"$baseUrl":"http://localhost:8080/sdata/l1000/GenTiers/-/",
"stamp":"000002C60000421C",
.... Attribute list ...
}
]
}
</pre>

===Sélecteur de ressource===

Un sélecteur permet de retrouver une ressource spécifique, il est possible de rechercher une ressource par clé ou clause

{|class="wikitable"
|-
!Sélecteur
!Exemple
|-
|Clé
|TTiers('9D33A23CFA6A005500F6000000285DAE')
|-
|clause
|TTiers(code eq 'ABI 007')
|}

===Code de retour HTTP===

{|class="wikitable"
|-
!Code
!Résultat
|-
|200
|La ressource existe
|-
|404
|La ressource n'existe pas
|}

===Gestion des rôles dans les ressources===
La gestion des rôles de la ressource dépend du type et de la nature du rôle :

{|class="wikitable"
|-
!Type de rôle
!Nature
!Retour
|-
|Référence,Liste
|Composition
|Les ressources composants sont retournées dans le corps de la ressource composée
|-
|Référence
| -
|La ressource référencée est retournée par référence dans le corps de la ressource
|-
|Liste
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe référencée filtrée sur la référence réciproque.
|-
|Association
|Avec suppression en cascade
|Les ressources associées sont considérées comme des composants et retournées dans le corps de la ressource composée.
|-
|Association
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe associée filtrée sur la classe d'association
|}

{{tip|Utilisez une vue pour retourner directement les attributs liés par des références, voir le paramètre select}}

===Gestion du périmètre société===
Par défaut, les requêtes s'exécutent dans le contexte société défini dans le jeton d'authentification.

Vous pouvez définir le contexte société dans le l'url de la requête :

<pre>
METHOD https://host/sdata/society/package/class ...
</pre>

{{tip|Définir le contexte société dans l'url n'est utilisable que sur une base supportant le multi-société. Pour connaitre le statut multi-société, utilisez la requête $version ou bien interrogez [[Utilisation_du_contrôleur_de_partage_(API)|le contrôleur de partage]]}}

==Requête sur les ressources (GET)==
Une requête sur les ressources est une requête sur une classe du modèle.

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?parameters
</pre>

===Paramètres de la requête===

{|class="wikitable"
|-
!Paramètre
!valeur
!Usage
|-
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|-
|where
|Expression objet
|Filtre de la requête
|-
|orderBy
|Attribut de tri
|Ordre de tri de la requête
|-
|count
|Taille de page (*)
|Pagination : Taille de page
|-
|startIndex
|Index de page
|Pagination par page : Numéro de page (0 première)
|-
|startKey
|Valeur de clé ou de tri
|Pagination par clé : Clé de position
|-
|keyDirection
|lt,le,gt,ge
|Pagination par clé : direction par rapport à startKey
|-
|dateFormat
|noTime, locale, utc
|Indique le format de date retourné pour les types de données date comptable
|}

(*) Il existe une limite par défaut si la valeur de count n'est pas précisée.

Les valeurs passées en paramètre doivent être encodées en HTML

Exemple :

where=code eq 'ABI 007'

doit être encodée en :

where=code%20eq%20%27ABI%20007%27

====Select====
Select permet de définir les attributs à retourner, par défaut tous les attributs non vide sont retournés

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
</pre>

La présence du paramètre select conditionne la façon d'exécuter la requête.

Les formats possibles sont :

{|class="wikitable"
|-
!format
!Usage
!Génère l'utilisation d'une vue
|-
|x
|Attribut x de la ressource
|non
|-
|x.y
|Attribut y de la ressource lié par de référence x (jointure exacte)
|oui
|-
|x.+y
|Attribut y de la ressource lié par de référence x (jointure externe)
|oui
|-
|x as y
|Attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y)
|Opération sur l'attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y;z)
|Opération sur les attributs y et z de la ressource retourné sous l'alias x
|oui
|}

Une vue sera utilisée si au moins un des membres de select nécessite l'utilisation d'une vue.

Pour les opérateurs utilisables consultez [[Vue_locale_(langage)|la page sur les vues locales]]

Notes :

* La sélection d'attribut référencé non défini peut générer l'absence de ressources dans le résultat, pour éviter ceci utilisez un spécificateur de jointure externe.
* La sélection d'attribut référencé par un rôle liste peut générer plusieurs ressources dans le résultat correspondant à chaque ressource liée par la relation.
* La séparation des paramètres pour les opérateurs ayant plusieurs paramètres utilise le séparateur ; et pas ,
* Lorsqu'une vue est utilisée, les filtres et ordre de tri sont exprimés par rapport à la vue.

Par exemple :
* TCompteGeneral?select=codeCompte&where=codeCompte ge '4'&orderBy=codeCompte
mais
* TCompteGeneral?select=code as codeCompte&where=code ge '4'&orderBy=code

====Dates comptables====
Le paramètre dateFormat permet de définir le format des dates comptables retournées par l'API

{|class="wikitable"
|-
!Version API
!dateFormat
!Exemple
!Format
!Représente
!Temps UTC
|-
|1.6
|
|2021-05-31T22:00:00Z
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|
|2021-06-01T00:00:00+02
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|locale
|2021-06-01T00:00:00
|Format heure locale
|Un instant heure locale
|
|-
|1.7
|noTime
|2021-06-01
|Format date locale
|Une date locale
|
|-
|1.7
|UTC
|2021-05-31T22:00:00Z
|Format heure UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

====Filtre====

'''Opérateurs:'''

{|class="wikitable"
|-
!opérateur
!équivalence
!exemple
!encoded
|-
|eq
|=
|where=code eq 'ABI 007'
|where=code%20eq%20%27ABI%20007%27
|-
|ne
|<>
|
|
|-
|lt
|<
|
|
|-
|le
|<=
|
|
|-
|gt
|>
|
|
|-
|ge
|>=
|
|
|-
|like
|like
|where=code like 'ABI %'
|where=code%20like%20%27ABI %25%27
|-
|in
|in
|
|
|}

'''Valeurs des paramètres:'''

Les valeurs des paramètres sont passées en littérale

{|class="wikitable"
|-
!Type de donnée
!exemple
|-
|Chaîne
|code eq 'xxx'
|-
|boolean
|flag eq true
|-
|numérique
|value eq 1
|-
|flottant
|value eq 1.0
|-
|date (voir format)
|$updated > '2019-12-31T23:00:00Z'
|-
|enum (par index)
|value eq 1
|-
|enum (par constant)
|value eq sens_credit
|}

Format des paramètres date :

{|class="wikitable"
|-
!format
!décodage
!Exemple (1 jan. 2020 France)
|-
|AAAA-MM-DDTHH:MM:SS.MMMZ
|ISO-8601 UTC
|2019-12-31T23:00:00Z
|-
|AAAA-MM-DDTHH:MM:SS.MMM+OFFSET
|ISO-8601 avec timezone
|2019-12-31T23:00:00+1
|-
|AAAA-MM-DDTHH:MM:SS.MMM
|ISO-8601 sans timezone
|2020-01-01T00:00:00
|-
|AAA-MM-DD
|Date au format ISO-8601
|2020-01-01
|-
|DD/MM/AAAA
|Date au format local
|01/01/2020
|}

====Ordre de tri====

Tri ascendant :

orderby=code

Tri descendant :

orderby=code%20desc

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc
</pre>

====Pagination par page====

Utiliser orderBy, count et startIndex

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=0
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=10
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=20
...
</pre>

{{tip|Incrémentez startIndex du nombre de ressource retourné par la requête}}

====Pagination par clé====

Utiliser orderBy, startKey et keyDirection

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
</pre>

==Création de ressource (POST)==
<pre>
POST http://localhost:8080/sdata/gentiers/ttiers
Request:
{
"code":"SYFRE1",
"caption":"syfre 1",
"sitesList":[
{
"code":"SITE1",
"caption":"site1 de syfre1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E20022",
"$url": "http://localhost:8080/sdata/l1000/gentiers/-/TTiers('9D33A23CFA6A005500F6000001E20022')",
... attribute list ...
}
]
}
</pre>

===Gestion du périmètre de partage===

Le niveau de partage d'une ressource de niveau activité peut être contrôlé par des propriétés de contrôle au niveau de la définition de la ressource :

{|class="wikitable"
|-
!Contrôle
!Usage
|-
|$shareId
|Valeur du périmètre sur lequel créer l'objet
|-
|$shareLevel
|Niveau de partage sur lequel créer l'objet (0:dossier,1:activité ou 2:société)
|}

<pre>
POST https://localhost/sdata/S3/gentiers/ttiers
Request:
{
"$shareLevel":2,
"code":"SYFRES3-2",
"caption":"syfre S3-2",
"sitesList":[
{
"code":"SITE1",
"caption":"site 1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response : 201 OK
</pre>

{{Tip|Par défaut la ressource sera créée au niveau activité}}

===Gestion des rôles===

La création de ressource dans les rôles dépend de la nature du rôle.

* Pour les rôles de type composition les ressources liées sont créés simultanément.
* Pour les rôles qui ne sont pas des compositions les ressources liées sont rattachés.

'''Identification des références'''

'''Par clé:'''
<pre>
{
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
</pre>

'''Par uri:'''
<pre>
{
"pays":{
"$url":TPays("9D33A23CFA6A005500150000001700FD")
}
}
</pre>

'''Par expression:'''
<pre>
{
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
</pre>

Lorsqu'une expression est utilisée la première ressource retournée par l'expression est utilisée.

===Gestion des dates comptables===
Pour les dates comptables, le serveur convertit la date reçu en heure locale puis conserve la partie date.

{|class="wikitable"
|-
!Format
!Représente
!Exemple
!Interprète
|-
|locale
|Une heure locale
|2021-06-01T00:00:00
|Conserve l’heure reçue en heure locale et conserve la date, la date sera toujours celle transmise.
|-
|noTime
|Une date sans heure
|2021-06-01
|Conserve la date reçue sans conversion, la date sera toujours celle transmise.
|-
|UTC
|Un instant universel UTC
|2021-05-31T22:00:00Z
2021-05-31T22:00:00+02
|Convertit l’heure UTC en heure locale du service et conserve la date reçue, la date peut être différente de la date transmise si le client et le service ne sont pas dans le même fuseau horaire.
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

==Modification de ressource (PUT)==
<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request:
{
"codeSIRET":"12345678"
}
Response: 200 OK
[
{
.... resource modified ...
}
]
</pre>

===Modification de rôle liste composition===
Par défaut les rôles composition sont gérés en remplacement, pour contrôler le mode de gestion des rôles utilisez un élément de contrôle "$" pour le rôle :

'''Exemple : Modification du rôle par remplacement des composants :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites has been removed.
... There is one site left in the list
]
]
}
</pre>

'''Exemple : Modification du rôle par ajout de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["create"]
},
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites are not affected
... There is one site more in the list
}
]
]
}
</pre>

'''Exemple : Modification du rôle par mise à jour de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["update"]
},
"sitesList":[
{
"$key":"9D33A23CFA6A005500F6000001E30019",
"caption":"Site maj",
}
]
}
</pre>

{|class="wikitable"
|-
!contrôle
!action
|-
|create
|Les nouvelles ressources sont ajoutées au rôle
|-
|update
|Les ressources existantes dans le rôle sont mise à jour
|-
|delete
|Les ressources existantes et non présentes dans la requête sont supprimées
|}

La valeur par défaut est "create","update","delete"

===Modification des attributs privés===
Par défaut les attributs privés sont modifiés sur le niveau de partage correspondant au périmètre société, pour contrôler le niveau de partage des attributs privés utilisez un élément de contrôle $sharePrivateLevel.

{|class="wikitable"
|-
!sharePrivateLevel
!Périmètre de définition
|-
|absent
|Périmètre courant de l'objet
|-
|0
|Dossier
|-
|1
|Activité
|-
|2
|Société
|}

{{tip|Le périmètre courant de l'objet dépend de l'état de l'objet. Par exemple, si l'objet est de niveau activité et n'a pas de propriété défini pour la société courante, le périmètre courant sera l'activité, mais si l'objet a des propriétés définies pour la société courante alors le périmètre courant sera la société. Ne pas définir explicitement le niveau de partage peut amener à des ambiguïtés.}}

'''Modification de la valeur de l'attribut privé pour les sociétés de l'activité du Tiers (le tiers n'a pas de propriété défini pour la société S3):'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"modeReglementDecaissement":{"$where":"code eq 'CHQ'"},
}
</pre>

'''Modification de la valeur de l'attribut privé pour la société S3 :'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"$sharePrivateLevel":2,
"modeReglementDecaissement":{"$where":"code eq 'CBB'"},
}
</pre>

==Suppression de ressource (DELETE)==
<pre>
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Response: 200 OK
</pre>

==Opération sur une ressource (POST)==

Les opérations des ressources correspondent aux méthodes publiques de cette ressource.

===Méthode d'instance de ressource===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/wfclassea('B5A28A92EB0C00020010000000DB0006')/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Méthode de classe de ressource, ou méthode de classe non persistante===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Passage des paramètres===
Les paramètres sont passés par nom et valeur.

Les types de paramètres et de retour supportés sont :

{|class="wikitable"
|-
!Type
!Exemple
|-
|Chaîne
|"p":"xxx"
|-
|Entier
|"p":1
|-
|Boolean
|"p":true
|-
|Flottant
|"p":1.1
|-
|Datetime
|"p":"2020-12-25T01:01:01"
|-
|Enuméré (par valeur)
|"p":1
|-
|Liste d'objets
|"p":[ {$key:"key", $uuid:"uuid", $where:"expression"}, ...],
|}

{{tip|Les références des objets passés dans des listes peuvent être définies par clé ($key), identifiant appelant ($uuid) ou expression ($where)
Exemple :
<pre>
{
"paramList":[
{"$key":"B5A28A92EB0C00020010000001F500A1"},
{"$where":"uneChaine like 'cN%'"}
]
}
</pre>
}}

===Résultat de type ressource===
Lorsque l'opération retourne un objet ou une liste d'objets ceux-ci sont retournés sous forme de ressource.

Par exemple :

<source lang="delphi">
//class Function GetWFClasseA(const iCode:string):WFClasseA;
begin
Result := WFClasseA.Find('(unCode = %1)','unCode',True,[iCode]);
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassea
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:41:41.015Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
}
]
}
}
</pre>

<source lang="delphi">
//Class Function GetWFClasseA(const iCodeLike:string):WFClasseAList;
begin
Result := WFClasseA.CreateListWhere('(unCode like %1)','','unCode',True,-1,[iCodeLike]);
end;
</source>

<pre>

POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassealist
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:49:14.061Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
},
{
"$key": "B5A28A92EB0C00020010000001B4000E",
"$etag": "B5A28A92EB0C00020010000001B4000E-0000025000000025",
"stamp": "0000025000000025",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaalb",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 2,
"title": "Etat 2"
},
"unStatus": 0
},
{
"$key": "B5A28A92EB0C00020010000001B4001A",
"$etag": "B5A28A92EB0C00020010000001B4001A-0000018B0000001A",
"stamp": "0000018B0000001A",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaale",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 0,
"title": "Initial"
},
"unStatus": 0
},
......
]
}
}
</pre>

===Initialisation de la ressource===
Il est possible d'initialiser la ressource avant d'exécuter la méthode, par exemple pour un processus :

<source lang="delphi">
Type
TmyProcessus = class
public
procedure Execute(p:string);
property attString:string;
property attInt:Integer;
property attRef:TRefClass;
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/execute
Request:
{
"$resource":{
"attString":"value 1",
"attInt":100,
"attRef":{"$url":"TRefClass('xxx')"},
},
"p":"value",
}
Response: 200 OK
{
"result":""
}
</pre>

==Requête Batch (POST $batch)==
Une requête Batch permet de réaliser plusieurs opérations de type GET,POST/PUT/DELETE/EXEC en une seule fois.

Une requête Batch contient un tableau de ressources, pour chaque ressource l'action et l'uri doivent être précisées :

<pre>
POST http://.../sdata/$batch
{
"$resources":[
{
"$httpMethod":"POST",
"$url":"gentiers/ttiers",
"code":"SYFRE2",
"caption":"syfre 2",
"sitesList":[
{
"code":"SITE1",
"caption":"site2 de syfre2",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
]
}
</pre>

{{tip|Le format d'url complet de $Batch est https://hostname/service/server/sdata/l1000/-/-/$batch}}

===Gestion de la transaction dans un batch===
Par défaut les opérations réalisées sont unitaires (une transaction par ressource).

Pour réaliser une opération Batch atomique (une seule transaction longue) utilisez un élément de contrôle transaction :

Lorsque l'opération est atomique la réponse contient un élément $batch indiquant le statut de l'opération.

Le code de retour http est le code de retour de la dernière opération réalisée.

<pre>
POST http://localhost:8080/sdata/$batch
{
"$": {"$transaction":["atomic"]},
"$resources":[
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')",
"$uuid":"1",
"capital":{"value":7200,"CodeDevise":"USD"}
},
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$uuid":"2",
"capital":{"value":1000,"CodeDevise":"EUR"}
}
]
}
Response : 401
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "PUT",
"$httpMessage": "OK",
"$etag": "9D33A23CFA6A005500F6000000285DAE-0000018C00000001"
},
{
"$httpStatus": 410,
"$httpMessage": "Already Deleted",
"$uuid": "2",
"$url": "gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis"
}
]
}
}
],
"$batch": {
"$httpStatus": 400,
"$httpMessage": "ROLLBACK",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis",
"entry": {
"number": 2,
"uuid": "2"
}
}
]
}
}
}
</pre>

'''$transaction :'''

{|class="wikitable"
|-
!Commande
!Action
|-
|atomic
|Démarre une transaction longue
|-
|flush
|Force un batch de la transaction longue
|-
|commit
|Valide la transaction longue
|}
{{Tip|L'élément de contrôle de transaction peut être placé au niveau d'un ordre du lot.}}

===Execution de méthode dans un batch===
Utiliser le verbe EXEC pour exécuter une méthode

<pre>
POST http://localhost:8080/sdata/$batch
{
"$resources":[
{
"$httpMethod":"EXEC",
"$url":"testsyfrewf/wfprocessus/testmethod",
"$resource":{
"uneChaine":"value 1"
},
"p":"value 2"
}
]
}
Response : 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "POST",
"$httpMessage": "Executed",
"$url": "testsyfrewf/wfprocessus/testmethod",
"$uuid": "",
"result": "value 1 value 2"
}
]
}
</pre>

==Schéma d'une ressource (GET $schema)==
Le schéma d'une ressource retourne la structure de la classe.

<pre>
GET http://localhost:8080/sdata/testsyfrewf/wfclassea/$schema
Response : 200 OK
{
"title": "Libellé de la Classe A",
"stereotype": "persistent",
"properties": {
"unBool": {
"type": "boolean",
"title": "Un Bool"
},
"unCode": {
"type": "string",
"title": "Un code"
},
"unCompteur": {
"type": "string"
},
"unDerive": {
"type": "string",
"title": "Un dérivé"
},
"unDouble": {
"type": "double",
"title": "Un double"
},
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEmail": {
"type": "string",
"title": "Un email"
},
"unEntier": {
"type": "int",
"title": "Un Entier"
},
"unEtat": {
"type": "integer",
"title": "Un Etat"
},
"unStatus": {
"type": "int",
"title": "Statut de l'objet (Panel)"
},
"WFClasseBRef": {
"type": {
"$ref": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseB/$schema",
"$relationship": "reference"
},
"title": "Référence B"
},
"WFClasseCList": {
"type": "array",
"item": {
"title": "Classe C",
"properties": {
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEntier": {
"type": "int",
"title": "un entier"
}
}
}
}
},
"$url": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseA/$schema"
}
</pre>

Le contenu de la réponse peut être configurée avec le paramètre "select", à défaut toutes les informations sont retournées.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|extensions
|Retourne uniquement les attributs issus d'extension
|-
|properties
|Retourne la liste de tous les attributs
|-
|selfProperties
|Retourne uniquement les attributs de la classe elle même
|-
|operations
|Retourne les opérations de la classe
|-
|compositions
|Retourne le schéma des classes composants
|}

Exemple : Retrouver uniquement les attributs d'extension d'une classe :

<pre>
GET http://localhost:8080/sdata/ttiers/$schema?select=extensions
{
"title": "Tiers",
"stereotype": "persistent",
"extensions": [
{
"class": "TTiers_esmPackage",
"title": "Extension de TTiers",
"package": "esmPackage"
}
],
"properties": {
"esmCode": {
"type": "string",
"extension": "TTiers_esmPackage",
"title": "un code esm"
}
},
"$url": "http://localhost:8080/sdata/gentiers/TTiers/$schema"
}
</pre>

==Modèle de ressource (GET $template)==
Le modèle de ressource retourne une ressource initialisée

<pre>
GET http://localhost:8080/sdata/gcimport/TImportContratCommercial/$template
Response : 200 OK

{
"$url": "http://localhost:8080/sdata/l1000/gcimport/-/TImportContratCommercial",
"stamp": "000001D900000001",
"acompte": 0,
"affaire": "",
"budget": "",
"Caption": "",
"commandeEngagement": false,
"commercial": "",
"coursDevise": {
"value": 1,
"CodeDevise": "",
"Date": "1899-12-30T00:00:00.000Z",
"TCConv": "",
"TCValue": 0,
"RPConv": "",
"RPValue": 0
},
"coursNegocie": false,
"dateCommande": "1899-12-30T00:00:00.000Z",
"dateLivraison": "1899-12-30T00:00:00.000Z",
"devise": "",
"donneeEDI1": "",
"donneeEDI2": "",
"donneeEDI3": "",
"donneeEDI4": "",
"donneeEDI5": "",
"echeancement": "",
"etablissement": "",
"exonereTaxe": "",
"exonereTVA": "",
"gestionTransport": {
"value": 0,
"title": "Automatique"
},
"immobilisation": {
"value": 0,
"title": "B&S"
},
"ImportCCDetailList": [],
"importeGMAO": false,
"importerRemisePied": false,
"ImportSiteAdresse": {},
"incoterm": "",
"MentionExonerationTVA": "",
"posteBudgetaire": "",
"pourcentAcompte": {
"value": 0,
"Decimales": 2
},
"pourcentRemisePied": {
"value": 0,
"Decimales": 2
},
"reference": "",
"referenceMandat": "",
"regimeTVA": "",
"roleTiers": "",
"roleTiersLivre": "",
"SessionImportation": {},
"typeFacturation": {
"value": 0,
"title": "HT"
}
}
</pre>

Voir aussi :

* [[SData|Point d'accès et url SData]]
* [[Gestion des jetons d'authentification (Administration)|Gestion des jetons d'authentification]]
* [[API Json (SData)|API SData en mode json]]
* [[Fichier_de_configuration_(server)#Logs|Enregistrement des messages SDATA]]

Voir aussi les exemples suivants :

* [[Utilisation du contrôleur de partage (API)|Utilisation du contrôleur de partage]]
* [[Interrogation des écritures (API)|Interrogation des écritures avec l'API SData]]
* [[Interrogation des fournisseurs (API)|Interrogation des fournisseurs avec l'API SData]]
* [[Creation d'un fournisseur (API)|Création d'un fournisseur avec l'API SData]]
* [[Import_de commandes_(API)|Import de commandes avec l'API SData]]
* [[Import_d%27écritures_(API)|Import d'écritures avec l'API SData]]
* [[Gestion des réceptions fournisseurs (API)|Gestion des réceptions fournisseurs avec l'API SData]]
* [[Facturation d'un bon de livraison (API)|Facturation d'un bon de livraison avec l'API SData]]
* [[Creation_d%27un_Tiers_et_son_compte_bancaire_(API)|Creation_d'un Tiers et son compte bancaire (API)]]
[[Category:SData]]

Ressource (sdata)

2026-03-11T09:21:29Z

Syfre : /* Ressource (GET) */

__TOC__

{{tip|Voir aussi l'[[API Json (SData)|API en mode JSON]], qui permet d'encapsuler d'avantage les appels de service.}}

==Prérequis==
Les requêtes SData sont exécutées sur [[SData|le point d'accès SData du service]].

La forme simplifiée des urls est

<pre>http://hostname/sdata/ressource?paramètres</pre>

ou

<pre>http://hostname/sdata/societe/ressource?paramètres</pre>

Les requêtes sont authentifiées par un jeton d'authentification placé dans l'entête Authorization de la requêtes.

[[Gestion des jetons d'authentification (Administration)|Le jeton d'authentification peut être géré par le client dans l'administration.]]

Les requêtes doivent comporter les entêtes suivantes :

{|class="wikitable"
|-
|accept
|application/json
|-
|Authorization
|Bearer token
|}

Les url des requêtes doivent être encodées, par exemple :

<pre>https://.../sdata/Société 1/ttiers...</pre>

doit être transmis encodé en

<pre>https://.../sdata.Soci%C3%A9t%C3%A9%201/ttiers....</pre>

==Sélection de version==
Il es possible d'indiquer un numéro de version dans l'url de la requête.

Placez le numéro de version derrière le préfix sdata :

<pre>
https://.../sdata/1/....
</pre>

En absence de numéro de version la dernière version sera utilisée.

==Informations de version==
Utilisez la fonction $version pour retrouver les informations de version

<pre>
GET http://localhost:8080/sdata/$version
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 0,
"debug": true,
"shareEnable": true
}
</pre>

<pre>
GET https://localhost/sdata/$version?select=details
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 1,
"debug": true,
"minors": [
{
"minor": 1,
"details": [
"Fix $batch : Error in commit don't return message and continue execution",
"Fix time measure decimal format use . instead of local",
"Add extension information to $schema",
"Add operations to $schema",
"Add select options to $schema"
]
},
{
"minor": 0,
"details": [
"Add version information"
]
}
]
}
</pre>

Le paramètre select accepte les options suivantes :

{|class="wikitable"
|-
!option
!usage
|-
|details
|Détails des modifications des versions mineurs
|-
|patches
|Liste des patches installés
|}

==Mise au point==
Vous pouvez activer [[Fichier_de_configuration_(server)#Logs|l'enregistrement des messages SDATA]] dans le répertoire de log du service.

==Ressource (GET)==
Dans l'interface SData les ressources sont les objets de l'application.

Une ressource est identifié par son uri qui représente le chemin de la ressource.

L'uri est composé du chemin de la classe et d'un sélecteur qui est l'oid de l'objet.

'''Exemple :'''

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')
Response: 200 OK
{
"$baseUrl":"http://localhost:8080/sdata/l1000/gentiers/-/",
"$title":"TTiers - -",
"$updated":"2020-12-22T08:10:09.740Z",
"$resources":[
{
"$url":"TTiers('9D33A23CFA6A005500F6000000285DAE')",
"$title":"ABI Jardin",
"$updated":"2010-03-23T15:37:46.000Z",
"$etag":"9D33A23CFA6A005500F6000000285DAE-000002C60000421C",
"$key":"9D33A23CFA6A005500F6000000285DAE",
"$baseUrl":"http://localhost:8080/sdata/l1000/GenTiers/-/",
"stamp":"000002C60000421C",
.... Attribute list ...
}
]
}
</pre>

===Sélecteur de ressource===

Un sélecteur permet de retrouver une ressource spécifique, il est possible de rechercher une ressource par clé ou clause

{|class="wikitable"
|-
!Sélecteur
!Exemple
|-
|Clé
|TTiers('9D33A23CFA6A005500F6000000285DAE')
|-
|clause
|TTiers(code eq 'ABI 007')
|}

===Code de retour HTTP===

{|class="wikitable"
|-
!Code
!Résultat
|-
|200
|La ressource existe
|-
|404
|La ressource n'existe pas
|}

===Gestion des rôles dans les ressources===
La gestion des rôles de la ressource dépend du type et de la nature du rôle :

{|class="wikitable"
|-
!Type de rôle
!Nature
!Retour
|-
|Référence,Liste
|Composition
|Les ressources composants sont retournées dans le corps de la ressource composée
|-
|Référence
| -
|La ressource référencée est retournée par référence dans le corps de la ressource
|-
|Liste
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe référencée filtrée sur la référence réciproque.
|-
|Association
|Avec suppression en cascade
|Les ressources associées sont considérées comme des composants et retournées dans le corps de la ressource composée.
|-
|Association
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe associée filtrée sur la classe d'association
|}

{{tip|Utilisez une vue pour retourner directement les attributs liés par des références, voir le paramètre select}}

===Gestion du périmètre société===
Par défaut, les requêtes s'exécutent dans le contexte société défini dans le jeton d'authentification.

Vous pouvez définir le contexte société dans le l'url de la requête :

<pre>
METHOD https://host/sdata/society/package/class ...
</pre>

{{tip|Définir le contexte société dans l'url n'est utilisable que sur une base supportant le multi-société. Pour connaitre le statut multi-société, utilisez la requête $version ou bien interrogez [[Utilisation_du_contrôleur_de_partage_(API)|le contrôleur de partage]]}}

==Requête sur les ressources (GET)==
Une requête sur les ressources est une requête sur une classe du modèle.

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?parameters
</pre>

===Paramètres de la requête===

{|class="wikitable"
|-
!Paramètre
!valeur
!Usage
|-
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|-
|where
|Expression objet
|Filtre de la requête
|-
|orderBy
|Attribut de tri
|Ordre de tri de la requête
|-
|count
|Taille de page (*)
|Pagination : Taille de page
|-
|startIndex
|Index de page
|Pagination par page : Numéro de page (0 première)
|-
|startKey
|Valeur de clé ou de tri
|Pagination par clé : Clé de position
|-
|keyDirection
|lt,le,gt,ge
|Pagination par clé : direction par rapport à startKey
|-
|dateFormat
|noTime, locale, utc
|Indique le format de date retourné pour les types de données date comptable
|}

(*) Il existe une limite par défaut si la valeur de count n'est pas précisée.

Les valeurs passées en paramètre doivent être encodées en HTML

Exemple :

where=code eq 'ABI 007'

doit être encodée en :

where=code%20eq%20%27ABI%20007%27

====Select====
Select permet de définir les attributs à retourner, par défaut tous les attributs non vide sont retournés

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
</pre>

La présence du paramètre select conditionne la façon d'exécuter la requête.

Les formats possibles sont :

{|class="wikitable"
|-
!format
!Usage
!Génère l'utilisation d'une vue
|-
|x
|Attribut x de la ressource
|non
|-
|x.y
|Attribut y de la ressource lié par de référence x (jointure exacte)
|oui
|-
|x.+y
|Attribut y de la ressource lié par de référence x (jointure externe)
|oui
|-
|x as y
|Attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y)
|Opération sur l'attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y;z)
|Opération sur les attributs y et z de la ressource retourné sous l'alias x
|oui
|}

Une vue sera utilisée si au moins un des membres de select nécessite l'utilisation d'une vue.

Pour les opérateurs utilisables consultez [[Vue_locale_(langage)|la page sur les vues locales]]

Notes :

* La sélection d'attribut référencé non défini peut générer l'absence de ressources dans le résultat, pour éviter ceci utilisez un spécificateur de jointure externe.
* La sélection d'attribut référencé par un rôle liste peut générer plusieurs ressources dans le résultat correspondant à chaque ressource liée par la relation.
* La séparation des paramètres pour les opérateurs ayant plusieurs paramètres utilise le séparateur ; et pas ,
* Lorsqu'une vue est utilisée, les filtres et ordre de tri sont exprimés par rapport à la vue.

Par exemple :
* TCompteGeneral?select=codeCompte&where=codeCompte ge '4'&orderBy=codeCompte
mais
* TCompteGeneral?select=code as codeCompte&where=code ge '4'&orderBy=code

====Dates comptables====
Le paramètre dateFormat permet de définir le format des dates comptables retournées par l'API

{|class="wikitable"
|-
!Version API
!dateFormat
!Exemple
!Format
!Représente
!Temps UTC
|-
|1.6
|
|2021-05-31T22:00:00Z
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|
|2021-06-01T00:00:00+02
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|locale
|2021-06-01T00:00:00
|Format heure locale
|Un instant heure locale
|
|-
|1.7
|noTime
|2021-06-01
|Format date locale
|Une date locale
|
|-
|1.7
|UTC
|2021-05-31T22:00:00Z
|Format heure UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

====Filtre====

'''Opérateurs:'''

{|class="wikitable"
|-
!opérateur
!équivalence
!exemple
!encoded
|-
|eq
|=
|where=code eq 'ABI 007'
|where=code%20eq%20%27ABI%20007%27
|-
|ne
|<>
|
|
|-
|lt
|<
|
|
|-
|le
|<=
|
|
|-
|gt
|>
|
|
|-
|ge
|>=
|
|
|-
|like
|like
|where=code like 'ABI %'
|where=code%20like%20%27ABI %25%27
|-
|in
|in
|
|
|}

'''Valeurs des paramètres:'''

Les valeurs des paramètres sont passées en littérale

{|class="wikitable"
|-
!Type de donnée
!exemple
|-
|Chaîne
|code eq 'xxx'
|-
|boolean
|flag eq true
|-
|numérique
|value eq 1
|-
|flottant
|value eq 1.0
|-
|date (voir format)
|$updated > '2019-12-31T23:00:00Z'
|-
|enum (par index)
|value eq 1
|-
|enum (par constant)
|value eq sens_credit
|}

Format des paramètres date :

{|class="wikitable"
|-
!format
!décodage
!Exemple (1 jan. 2020 France)
|-
|AAAA-MM-DDTHH:MM:SS.MMMZ
|ISO-8601 UTC
|2019-12-31T23:00:00Z
|-
|AAAA-MM-DDTHH:MM:SS.MMM+OFFSET
|ISO-8601 avec timezone
|2019-12-31T23:00:00+1
|-
|AAAA-MM-DDTHH:MM:SS.MMM
|ISO-8601 sans timezone
|2020-01-01T00:00:00
|-
|AAA-MM-DD
|Date au format ISO-8601
|2020-01-01
|-
|DD/MM/AAAA
|Date au format local
|01/01/2020
|}

====Ordre de tri====

Tri ascendant :

orderby=code

Tri descendant :

orderby=code%20desc

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc
</pre>

====Pagination par page====

Utiliser orderBy, count et startIndex

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=0
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=10
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=20
...
</pre>

{{tip|Incrémentez startIndex du nombre de ressource retourné par la requête}}

====Pagination par clé====

Utiliser orderBy, startKey et keyDirection

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
</pre>

==Création de ressource (POST)==
<pre>
POST http://localhost:8080/sdata/gentiers/ttiers
Request:
{
"code":"SYFRE1",
"caption":"syfre 1",
"sitesList":[
{
"code":"SITE1",
"caption":"site1 de syfre1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E20022",
"$url": "http://localhost:8080/sdata/l1000/gentiers/-/TTiers('9D33A23CFA6A005500F6000001E20022')",
... attribute list ...
}
]
}
</pre>

===Gestion du périmètre de partage===

Le niveau de partage d'une ressource de niveau activité peut être contrôlé par des propriétés de contrôle au niveau de la définition de la ressource :

{|class="wikitable"
|-
!Contrôle
!Usage
|-
|$shareId
|Valeur du périmètre sur lequel créer l'objet
|-
|$shareLevel
|Niveau de partage sur lequel créer l'objet (0:dossier,1:activité ou 2:société)
|}

<pre>
POST https://localhost/sdata/S3/gentiers/ttiers
Request:
{
"$shareLevel":2,
"code":"SYFRES3-2",
"caption":"syfre S3-2",
"sitesList":[
{
"code":"SITE1",
"caption":"site 1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response : 201 OK
</pre>

{{Tip|Par défaut la ressource sera créée au niveau activité}}

===Gestion des rôles===

La création de ressource dans les rôles dépend de la nature du rôle.

* Pour les rôles de type composition les ressources liées sont créés simultanément.
* Pour les rôles qui ne sont pas des compositions les ressources liées sont rattachés.

'''Identification des références'''

'''Par clé:'''
<pre>
{
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
</pre>

'''Par uri:'''
<pre>
{
"pays":{
"$url":TPays("9D33A23CFA6A005500150000001700FD")
}
}
</pre>

'''Par expression:'''
<pre>
{
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
</pre>

Lorsqu'une expression est utilisée la première ressource retournée par l'expression est utilisée.

===Gestion des dates comptables===
Pour les dates comptables, le serveur convertit la date reçu en heure locale puis conserve la partie date.

{|class="wikitable"
|-
!Format
!Représente
!Exemple
!Interprète
|-
|locale
|Une heure locale
|2021-06-01T00:00:00
|Conserve l’heure reçue en heure locale et conserve la date, la date sera toujours celle transmise.
|-
|noTime
|Une date sans heure
|2021-06-01
|Conserve la date reçue sans conversion, la date sera toujours celle transmise.
|-
|UTC
|Un instant universel UTC
|2021-05-31T22:00:00Z
2021-05-31T22:00:00+02
|Convertit l’heure UTC en heure locale du service et conserve la date reçue, la date peut être différente de la date transmise si le client et le service ne sont pas dans le même fuseau horaire.
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

==Modification de ressource (PUT)==
<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request:
{
"codeSIRET":"12345678"
}
Response: 200 OK
[
{
.... resource modified ...
}
]
</pre>

===Modification de rôle liste composition===
Par défaut les rôles composition sont gérés en remplacement, pour contrôler le mode de gestion des rôles utilisez un élément de contrôle "$" pour le rôle :

'''Exemple : Modification du rôle par remplacement des composants :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites has been removed.
... There is one site left in the list
]
]
}
</pre>

'''Exemple : Modification du rôle par ajout de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["create"]
},
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites are not affected
... There is one site more in the list
}
]
]
}
</pre>

'''Exemple : Modification du rôle par mise à jour de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["update"]
},
"sitesList":[
{
"$key":"9D33A23CFA6A005500F6000001E30019",
"caption":"Site maj",
}
]
}
</pre>

{|class="wikitable"
|-
!contrôle
!action
|-
|create
|Les nouvelles ressources sont ajoutées au rôle
|-
|update
|Les ressources existantes dans le rôle sont mise à jour
|-
|delete
|Les ressources existantes et non présentes dans la requête sont supprimées
|}

La valeur par défaut est "create","update","delete"

===Modification des attributs privés===
Par défaut les attributs privés sont modifiés sur le niveau de partage correspondant au périmètre société, pour contrôler le niveau de partage des attributs privés utilisez un élément de contrôle $sharePrivateLevel.

{|class="wikitable"
|-
!sharePrivateLevel
!Périmètre de définition
|-
|absent
|Périmètre courant de l'objet
|-
|0
|Dossier
|-
|1
|Activité
|-
|2
|Société
|}

{{tip|Le périmètre courant de l'objet dépend de l'état de l'objet. Par exemple, si l'objet est de niveau activité et n'a pas de propriété défini pour la société courante, le périmètre courant sera l'activité, mais si l'objet a des propriétés définies pour la société courante alors le périmètre courant sera la société. Ne pas définir explicitement le niveau de partage peut amener à des ambiguïtés.}}

'''Modification de la valeur de l'attribut privé pour les sociétés de l'activité du Tiers (le tiers n'a pas de propriété défini pour la société S3):'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"modeReglementDecaissement":{"$where":"code eq 'CHQ'"},
}
</pre>

'''Modification de la valeur de l'attribut privé pour la société S3 :'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"$sharePrivateLevel":2,
"modeReglementDecaissement":{"$where":"code eq 'CBB'"},
}
</pre>

==Suppression de ressource (DELETE)==
<pre>
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Response: 200 OK
</pre>

==Opération sur une ressource (POST)==

Les opérations des ressources correspondent aux méthodes publiques de cette ressource.

===Méthode d'instance de ressource===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/wfclassea('B5A28A92EB0C00020010000000DB0006')/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Méthode de classe de ressource, ou méthode de classe non persistante===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Passage des paramètres===
Les paramètres sont passés par nom et valeur.

Les types de paramètres et de retour supportés sont :

{|class="wikitable"
|-
!Type
!Exemple
|-
|Chaîne
|"p":"xxx"
|-
|Entier
|"p":1
|-
|Boolean
|"p":true
|-
|Flottant
|"p":1.1
|-
|Datetime
|"p":"2020-12-25T01:01:01"
|-
|Enuméré (par valeur)
|"p":1
|-
|Liste d'objets
|"p":[ {$key:"key", $uuid:"uuid", $where:"expression"}, ...],
|}

{{tip|Les références des objets passés dans des listes peuvent être définies par clé ($key), identifiant appelant ($uuid) ou expression ($where)
Exemple :
<pre>
{
"paramList":[
{"$key":"B5A28A92EB0C00020010000001F500A1"},
{"$where":"uneChaine like 'cN%'"}
]
}
</pre>
}}

===Résultat de type ressource===
Lorsque l'opération retourne un objet ou une liste d'objets ceux-ci sont retournés sous forme de ressource.

Par exemple :

<source lang="delphi">
//class Function GetWFClasseA(const iCode:string):WFClasseA;
begin
Result := WFClasseA.Find('(unCode = %1)','unCode',True,[iCode]);
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassea
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:41:41.015Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
}
]
}
}
</pre>

<source lang="delphi">
//Class Function GetWFClasseA(const iCodeLike:string):WFClasseAList;
begin
Result := WFClasseA.CreateListWhere('(unCode like %1)','','unCode',True,-1,[iCodeLike]);
end;
</source>

<pre>

POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassealist
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:49:14.061Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
},
{
"$key": "B5A28A92EB0C00020010000001B4000E",
"$etag": "B5A28A92EB0C00020010000001B4000E-0000025000000025",
"stamp": "0000025000000025",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaalb",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 2,
"title": "Etat 2"
},
"unStatus": 0
},
{
"$key": "B5A28A92EB0C00020010000001B4001A",
"$etag": "B5A28A92EB0C00020010000001B4001A-0000018B0000001A",
"stamp": "0000018B0000001A",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaale",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 0,
"title": "Initial"
},
"unStatus": 0
},
......
]
}
}
</pre>

===Initialisation de la ressource===
Il est possible d'initialiser la ressource avant d'exécuter la méthode, par exemple pour un processus :

<source lang="delphi">
Type
TmyProcessus = class
public
procedure Execute(p:string);
property attString:string;
property attInt:Integer;
property attRef:TRefClass;
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/execute
Request:
{
"$resource":{
"attString":"value 1",
"attInt":100,
"attRef":{"$url":"TRefClass('xxx')"},
},
"p":"value",
}
Response: 200 OK
{
"result":""
}
</pre>

==Requête Batch (POST $batch)==
Une requête Batch permet de réaliser plusieurs opérations de type GET,POST/PUT/DELETE/EXEC en une seule fois.

Une requête Batch contient un tableau de ressources, pour chaque ressource l'action et l'uri doivent être précisées :

<pre>
POST http://.../sdata/$batch
{
"$resources":[
{
"$httpMethod":"POST",
"$url":"gentiers/ttiers",
"code":"SYFRE2",
"caption":"syfre 2",
"sitesList":[
{
"code":"SITE1",
"caption":"site2 de syfre2",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
]
}
</pre>

{{tip|Le format d'url complet de $Batch est https://hostname/service/server/sdata/l1000/-/-/$batch}}

===Gestion de la transaction dans un batch===
Par défaut les opérations réalisées sont unitaires (une transaction par ressource).

Pour réaliser une opération Batch atomique (une seule transaction longue) utilisez un élément de contrôle transaction :

Lorsque l'opération est atomique la réponse contient un élément $batch indiquant le statut de l'opération.

Le code de retour http est le code de retour de la dernière opération réalisée.

<pre>
POST http://localhost:8080/sdata/$batch
{
"$": {"$transaction":["atomic"]},
"$resources":[
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')",
"$uuid":"1",
"capital":{"value":7200,"CodeDevise":"USD"}
},
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$uuid":"2",
"capital":{"value":1000,"CodeDevise":"EUR"}
}
]
}
Response : 401
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "PUT",
"$httpMessage": "OK",
"$etag": "9D33A23CFA6A005500F6000000285DAE-0000018C00000001"
},
{
"$httpStatus": 410,
"$httpMessage": "Already Deleted",
"$uuid": "2",
"$url": "gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis"
}
]
}
}
],
"$batch": {
"$httpStatus": 400,
"$httpMessage": "ROLLBACK",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis",
"entry": {
"number": 2,
"uuid": "2"
}
}
]
}
}
}
</pre>

'''$transaction :'''

{|class="wikitable"
|-
!Commande
!Action
|-
|atomic
|Démarre une transaction longue
|-
|flush
|Force un batch de la transaction longue
|-
|commit
|Valide la transaction longue
|}
{{Tip|L'élément de contrôle de transaction peut être placé au niveau d'un ordre du lot.}}

===Execution de méthode dans un batch===
Utiliser le verbe EXEC pour exécuter une méthode

<pre>
POST http://localhost:8080/sdata/$batch
{
"$resources":[
{
"$httpMethod":"EXEC",
"$url":"testsyfrewf/wfprocessus/testmethod",
"$resource":{
"uneChaine":"value 1"
},
"p":"value 2"
}
]
}
Response : 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "POST",
"$httpMessage": "Executed",
"$url": "testsyfrewf/wfprocessus/testmethod",
"$uuid": "",
"result": "value 1 value 2"
}
]
}
</pre>

==Schéma d'une ressource (GET $schema)==
Le schéma d'une ressource retourne la structure de la classe.

<pre>
GET http://localhost:8080/sdata/testsyfrewf/wfclassea/$schema
Response : 200 OK
{
"title": "Libellé de la Classe A",
"stereotype": "persistent",
"properties": {
"unBool": {
"type": "boolean",
"title": "Un Bool"
},
"unCode": {
"type": "string",
"title": "Un code"
},
"unCompteur": {
"type": "string"
},
"unDerive": {
"type": "string",
"title": "Un dérivé"
},
"unDouble": {
"type": "double",
"title": "Un double"
},
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEmail": {
"type": "string",
"title": "Un email"
},
"unEntier": {
"type": "int",
"title": "Un Entier"
},
"unEtat": {
"type": "integer",
"title": "Un Etat"
},
"unStatus": {
"type": "int",
"title": "Statut de l'objet (Panel)"
},
"WFClasseBRef": {
"type": {
"$ref": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseB/$schema",
"$relationship": "reference"
},
"title": "Référence B"
},
"WFClasseCList": {
"type": "array",
"item": {
"title": "Classe C",
"properties": {
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEntier": {
"type": "int",
"title": "un entier"
}
}
}
}
},
"$url": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseA/$schema"
}
</pre>

Le contenu de la réponse peut être configurée avec le paramètre "select", à défaut toutes les informations sont retournées.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|extensions
|Retourne uniquement les attributs issus d'extension
|-
|properties
|Retourne la liste de tous les attributs
|-
|selfProperties
|Retourne uniquement les attributs de la classe elle même
|-
|operations
|Retourne les opérations de la classe
|-
|compositions
|Retourne le schéma des classes composants
|}

Exemple : Retrouver uniquement les attributs d'extension d'une classe :

<pre>
GET http://localhost:8080/sdata/ttiers/$schema?select=extensions
{
"title": "Tiers",
"stereotype": "persistent",
"extensions": [
{
"class": "TTiers_esmPackage",
"title": "Extension de TTiers",
"package": "esmPackage"
}
],
"properties": {
"esmCode": {
"type": "string",
"extension": "TTiers_esmPackage",
"title": "un code esm"
}
},
"$url": "http://localhost:8080/sdata/gentiers/TTiers/$schema"
}
</pre>

==Modèle de ressource (GET $template)==
Le modèle de ressource retourne une ressource initialisée

<pre>
GET http://localhost:8080/sdata/gcimport/TImportContratCommercial/$template
Response : 200 OK

{
"$url": "http://localhost:8080/sdata/l1000/gcimport/-/TImportContratCommercial",
"stamp": "000001D900000001",
"acompte": 0,
"affaire": "",
"budget": "",
"Caption": "",
"commandeEngagement": false,
"commercial": "",
"coursDevise": {
"value": 1,
"CodeDevise": "",
"Date": "1899-12-30T00:00:00.000Z",
"TCConv": "",
"TCValue": 0,
"RPConv": "",
"RPValue": 0
},
"coursNegocie": false,
"dateCommande": "1899-12-30T00:00:00.000Z",
"dateLivraison": "1899-12-30T00:00:00.000Z",
"devise": "",
"donneeEDI1": "",
"donneeEDI2": "",
"donneeEDI3": "",
"donneeEDI4": "",
"donneeEDI5": "",
"echeancement": "",
"etablissement": "",
"exonereTaxe": "",
"exonereTVA": "",
"gestionTransport": {
"value": 0,
"title": "Automatique"
},
"immobilisation": {
"value": 0,
"title": "B&S"
},
"ImportCCDetailList": [],
"importeGMAO": false,
"importerRemisePied": false,
"ImportSiteAdresse": {},
"incoterm": "",
"MentionExonerationTVA": "",
"posteBudgetaire": "",
"pourcentAcompte": {
"value": 0,
"Decimales": 2
},
"pourcentRemisePied": {
"value": 0,
"Decimales": 2
},
"reference": "",
"referenceMandat": "",
"regimeTVA": "",
"roleTiers": "",
"roleTiersLivre": "",
"SessionImportation": {},
"typeFacturation": {
"value": 0,
"title": "HT"
}
}
</pre>

Voir aussi :

* [[SData|Point d'accès et url SData]]
* [[Gestion des jetons d'authentification (Administration)|Gestion des jetons d'authentification]]
* [[API Json (SData)|API SData en mode json]]

Voir aussi les exemples suivants :

* [[Utilisation du contrôleur de partage (API)|Utilisation du contrôleur de partage]]
* [[Interrogation des écritures (API)|Interrogation des écritures avec l'API SData]]
* [[Interrogation des fournisseurs (API)|Interrogation des fournisseurs avec l'API SData]]
* [[Creation d'un fournisseur (API)|Création d'un fournisseur avec l'API SData]]
* [[Import_de commandes_(API)|Import de commandes avec l'API SData]]
* [[Import_d%27écritures_(API)|Import d'écritures avec l'API SData]]
* [[Gestion des réceptions fournisseurs (API)|Gestion des réceptions fournisseurs avec l'API SData]]
* [[Facturation d'un bon de livraison (API)|Facturation d'un bon de livraison avec l'API SData]]
* [[Creation_d%27un_Tiers_et_son_compte_bancaire_(API)|Creation_d'un Tiers et son compte bancaire (API)]]
[[Category:SData]]

Fichier de configuration (server)

2026-03-11T09:16:45Z

Syfre : /* Logs */

===Introduction===
Le Serveur d'application Sage 1000 utilise un fichier de configuration situé dans le répertoire du serveur.

{{info|Le nom du fichier est serverl1000.ini}}

Ce fichier peut être soit modifié à l'aide de la console d'administration des services, soit manuellement par un éditeur de texte.

{{tip|Le fichier est chargé au démarrage du service.}}

===Structure===
Le fichier peut configurer plusieurs services exécutés sur le même serveur, chaque service comporte au moins deux sections :

* [\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SERVICE_NAME]
: Cette entrée détermine la configuration réseau du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE]
: Cette entrée détermine la configuration logicielle du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE\Export]
: Cette entrée configure la fonction d'exportation du service.

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\MYSERVICE]
ipcMode=ipcSHM
tcpPort=8090
shmAddress=SYFRE

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\MYSERVICE]
Master base=orasql://myhost/DBMASTER_ORA?prefix="DBMASTERT_ORA."
Master driver=orasql
Master OS Authentication=0
Master user=DBMASTER_ORA
Master password=DBMASTER_ORA
Server Societies=Société de démonstration GCF 1000
Server Application=Sage 1000 Suite Financière
...
</pre>

Chaque section est composée d'une liste de variables (NomVariable=ValeurVariable), les types de données des variables sont :

{|class="wikitable"
|-
!Variable
!Type
|-
|String
|Chaîne de caractère
|-
|Boolean
|Valeur logique 0:Non 1:Oui
|-
|Integer
|Valeur entière
|-
|Liste de chaîne
|Liste de chaîne de caractère séparée par des virgules.
|}

===Section IPC===

{|class="wikitable"
|-
!Variable
!Type
!Contexte
!Usage
|-
|ipcMode
|enumération
|Client/Serveur
|
*ipcTCP
:Mode de communication par TCP/IP
*ipcSHM
:Mode de communication par mémoire partagée (dépréciée)
|-
|tcpPort
|Integer
|Client/Serveur
|Port de communication TCP
|-
|tcpAddress
|string
|Client/Serveur
|Adresse de communication TCP
|-
|shmAddress
|string
|Client/Serveur
|Nom du segment de mémoire partagé
|-
|serverList
|Serveur
|String list
|Configuration de Cluster 
Liste des services associés à cet identifiant de service.
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\TRESO]
ipcMode=ipcTCP
tcpPort=8090
tcpAddress=localhost
</pre>

Exemple de configuration Cluster :

'''fichier du configuration des services :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

'''fichier du configuration du client HTTP :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

===Section Servers===
====IPC====
Ces variables configurent la gestion des services IPC.

La configuration des services IPC peut être renseignée dans une section IPC

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\nom_de_profil]

puis référencée par la variable "IPC Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|IPC Profil
|String
|Référence un nom de section IPC contenant la configuration
|-
|IPC Started
|boolean
|Démarre les services IPC (défaut true)
|}

Les services IPC sont les services permettant de communiquer via RPC.

Vous avez besoins des services IPC si :
* Vous utilisez un serveur HTTP externe (IIS ou Apache).
* Vous utilisez la Console des Processus Métiers pour dialoguer avec ce Service.
* Vous utilisez le Contrôleur des services.
* Ce Service exécute des tâches de traitement déléguées par un autre Service.

Si vous n'utilisez pas les services IPC il est conseillé de ne pas les démarrer.

{{tip|Ce paramètre n'est pas modifiable depuis la console des services car si vous désactivez les services IPC le contrôleur n'est plus opérationnel}}

====Sessions====
Ces variables configurent la gestion des sessions.

La configuration des sessions peut être renseignée dans une section SESSIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\SESSIONS\nom_de_profil]

puis référencée par la variable "SESSIONS Profil"

{|class="wikitable"
|-
!Variable
!Type
!Défaut
!Min
!Usage
|-
|SESSIONS Profil
|String
|
|
|Référence un nom de section SESSIONS contenant la configuration
|-
|CheckInterval
|Entier
|1 minute
|1 minute
|Délai entre chaque test d'expiration en seconde.
|-
|ExpireInterval
|Entier
|15 minutes
|
|Délai d'expiration des sessions en seconde.
|}

====Base master====
Ces variables configurent la base Master utilisée par le service.

La configuration de la base master peut être renseignée dans une section MASTER

[\SOFTWARE\Sage\Ligne 1000\Administration\MASTER\nom_de_profil]

puis référencée par la variable "Master Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Master Profil
|String
|Référence un nom de section MASTER contenant la configuration
|-
|Master base
|String
|Nom de la base de données Master
|-
|Master driver
|String
|Nom du driver de la base de données Master
|-
|Master OS Authentication
|Boolean
|Utiliser l'authentification du système d'exploitation.
|-
|Master user
|String
|Nom d'utilisateur utilisé pour la connexion à la base Master
|-
|Master password
|String
|Mot de passe utilisé pour la connexion à la base Master
|}

====Application et Sociétés====
Ces variables configurent l'application et les sociétés servies par le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Societies
|String
|
|Liste des sociétés/dossiers servies par le service.
|-
|Server Application
|String
|
|Nom de l'application servie par le service.
|-
|Server User
|String
|
|Nom de l'utilisateur du service.
|-
|Server Password
|String
|
|Mot de passe de l'utilisateur du service.
|-
|Server User Group
|String
|
|Nom du groupe de l'utilisateur du service.
|-
|Server Authentication
|String
|
|Annuaire utilisé pour l'authentification.
|-
|Authentication Directories
|liste de chaîne
|8.00
|Annuaires disponibles pour ce service.(code des annuaires séparés par ";")
|}

====Service====
Ces variables configurent le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Name
|String
|
|Nom du service.
|-
|Cache Folder
|String
|
|Répertoire où stocker les fichiers temporaires et les fichiers en cache.
|-
|[[Zone publique (server)|Public Folder]]
|String
|
|[[Zone_publique_(server)|Racine des répertoires partagés du service]].
|-
|[[Public links (server)|Public Links]]
|Liste de chaîne
|
|Liste de répertoires réseaux (séparés par un ;) pour lesquels des [[Stockage_des_documents|documents peuvent être associés]].
|-
|Send Alert To
|String
|
|Liste d'adresses emails (séparées par un ;) auxquelles seront envoyés les messages d'alertes.
|-
|Scripts
|Liste de chaîne
|
|Liste de références CSS ajouté aux pages HTML
|-
|MaxDatagridRowCount
|Integer
|
|Limite le nombre de lignes affichées dans les grilles (par défaut à 10 000).
|-
|[[Security mode (server)|Security Mode]]
|String
|7.00
|Valeurs possibles : Intranet (valeur par défaut) / Internet [[Service_exposé_sur_internet|Voir Service exposé sur internet]]
|-
|Enable Remember User
|boolean
|7.10
|Permet à l'utilisateur d'avoir son nom pré-renseigné dans la page d'authentification (par défaut à vrai)
|-
|MaxPreviewPageCount
|Integer
|
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview max page
|Integer
|10.00
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview blocking
|Boolean
|10.00
|1:Les aperçus sont affichés directement en onglet 0:les aperçus sont envoyés dans la bam.
|-
|Preview timeout
|Integer
|10.00
|Délai d'attente de fin d'aperçu si Preview blocking=1.
|-
|Printer Filter
|chaine
|
|Noms des imprimantes à ne pas proposer, séparées par des points virgules (9.20)

|}

====Automates====
Ces variables configurent le serveur d'automate inclus dans le serveur.

Ces variables peuvent être renseignées dans une section AUTOMATE

[\SOFTWARE\Sage\Ligne 1000\Administration\AUTOMATE\nom_de_profil]

puis référencées par la variable "Automate Profil"

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Automate Profil
|String
|
|Référence une section AUTOMATE.
|-
|Automate Started 
Process Server Started
|Boolean
|
|Démarre le serveur d'automate. (défaut) (*) 
|-
|Automate Name 
Process Server Name
|String
|
|Nom du serveur d'automate à démarrer. (*)
|-
|Automate Message Box 
Process Server Message Box
|String
|
|Boite à messages utilisé par le serveur d'automate.
|-
|Automate Task Service 
Process Task Service
|String
|
|Nom du Service 1000 exécutant les tâches du serveur d'automate.(hostname.servicename)
|-
|Automate Task Count 
|Integer
|6.50
|Nombre maximal de tâches automates simultanées (défaut 1).
|-
|Automate Debug 
|Boolean
|7.00 Patch
|Active le mode debug verbose (**).
|}

{{Version700}} (*) Ces valeurs peuvent être modifiées sur la ligne de commande

{{Version700}} (**) A utiliser conjointement avec la console de trap snmp

====Processus métiers====
Ces variables configurent le service de Processus Métiers inclus dans le serveur.

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|BP Started
|Boolean
|Démarre le service de Processus Métiers (défault).
|}

{{Version700}} Cette valeur peut être modifiée sur la ligne de commande

====Système====
Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PROCESS

[\SOFTWARE\Sage\Ligne 1000\Administration\PROCESS\nom_de_profil]

puis référencée par la variable "Process Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Process Profil
|string
|Référence une section PROCESS
|-
|ProcessAffinity
|String
|Détermine les coeurs utilisés par le processus sur une machine multi-coeurs 
ex : 1,3 pour utiliser les coeurs 1 et 3 d'une machine multi-coeurs.
|-
|ThreadPoolSize
|Integer
|Taille du pool de thread (20)
|-
|FormCacheSize
|Integer
|Taille du cache pour un écran (défaut:20, 0:désactive l'utilisation du cache)
|-
|FormCacheLimit
|Integer
|Taille du cache pour l'ensemble des écrans (256)
|-
|FormCacheReuse
|Integer
|Nombre de fois qu'un écran peut être réutilisé (-1 : pas de limite)
|}

*ProcessAffinity
:Le Processus du serveur est un processus multi-threadé, sur une machine multi-coeurs il utilise tous les coeurs disponibles sur le système d'exploitation. Dans certain cas il est souhaitable de restreindre l'exécution à certains coeurs.

*ThreadPoolsize
:Chaque requête sur le service est exécutée par une thread allouée d'un pool ; lorsque le pool est plein la requête est suspendue jusqu'à ce qu'une thread se libère dans le pool. Cette variable limite la taille du pool de thread et par conséquence limite les contentions et les "context switches" provoqués par le processus.

*FormCacheSize
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre d'instance d'un écran dans le cache.

*FormCacheLimit
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre maximal d'écran dans le cache et par conséquent la mémoire utilisée par le cache d'écran.

*FormCacheReuse
:Indique le nombre de fois qu'un écran en cache peut être réutilisé.

{{info|Pour pouvoir utiliser WMI la dll serviceL1000perf.dll doit être présente dans le répertoire du serveur.}}
{{info|Pour désactiver le cache, définir la valeur de FormCacheSize à 0}}

====Files d'attente====
Ces variables configurent le service de consommation de file d'attente.

Ces variables peuvent être renseignées dans une section PERF.

[\SOFTWARE\Sage\Ligne 1000\Administration\QUEUELISTENER\nom_de_profil]

puis référencée par la variable "Queue listener Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Queue listener Started
|Boolean
|Démarre le service de consommation de file d'attente.
|-
|Queue listener queues
|Liste de chaînes séparées par des ,
|Liste des files d'attente à consommer.
|-
|Queue listener Task count
|Entier
|Nombre maximal de tâches simultanées par service.
|}

Les paramètres de scrutation d'une file d'attente peuvent être configurés à la suite du nom de la file d'attente en séparant les paramètres par un caractère ":"

{|class="wikitable"
|-
!Paramètre
!Valeur par défaut (ms)
!Usage
|-
|Initial
|1000
|Délai initial de scrutation (ms)
|-
|Max
|10000
|Délai maximal de scrutation (ms)
|-
|Increment
|1000
|Incrément du délai jusqu'au délai maximal si aucun message n'est disponible (ms)
|}

Exemple :
<pre>
Queue listener queues=MyQueue1:2000:10:20000,MyQueue2,MyQueue3:100:10:1000
</pre>

Avec les valeurs par défaut, une file d'attente est lue initialement toutes les secondes, puis si aucun message n'est reçu, ce délai monte jusqu'à 10 secondes. Lorsque un message est reçu le délai est réinitialisé à 1 seconde et ainsi de suite.

====Compteurs de performance====

Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PERF

[\SOFTWARE\Sage\Ligne 1000\Administration\PERF\nom_de_profil]

puis référencée par la variable "Performance Counters Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Start Performance Counters
|Boolean
|Démarre les compteurs de performance
|-
|Start Performance Clock
|Boolean
|Démarre l'horloge de performance
|-
|Performance Clock Delay
|Cardinal
|Période de l'horloge de performance (ms)
|-
|HTTP PerfServer Start
|Boolean
|Démarre le serveur HTTP de performance
|-
|HTTP PerfServer Port
|Integer
|Port du serveur HTTP de performance
|-
|HTTP PerfServer Protocol
|String
|Protocole du serveur HTTP de performance
|}

*Start Performance Counters
:Le serveur inclus un certain nombre de [[Compteurs de performance (monitoring)|compteurs de performance]] interrogeables par le [[Serveur de performance (monitoring)|serveur de performance]].

*Start Performance Clock
: Démarre une horloge permettant de générer un évènement de monitoring.

*Performance Clock Delay
: Période de l'horloge de performance. (défaut 1000)

*HTTP PerfServer Start
: Démarre le server HTTP de performance.

*HTTP PerfServer Port
: Port du serveur HTTP de performance. (défaut 9999)

*HTTP PerfServer Protocol
:Protocole du serveur HTTP de performance (défaut http)

Voir la catégorie [[:Category:Monitoring]]

====HTTP====
Ces variables peuvent être renseignées dans une section HTTP

[\SOFTWARE\Sage\Ligne 1000\Administration\HTTP\nom_de_profil]

puis référencée par la variable "HTTP Profil"

Les variables suivantes configurent le protocole HTTP utilisé par le service, elles sont utilisées pour construire des URL pointant sur le service.

{|class="wikitable"
|-
!Nom de variable
!Type
!Version
!Par défaut
!Usage
|-
|HTTP Protocol
|String
|Toute
|http:
|Protocole HTTP publique du Service (http: ou https:)
|-
|HTTP Port
|Integer
|Toute
|80
|Port HTTP publique du Service
|-
|HTTP HostName
|String
|Toute
|Nom local de la machine
|Domaine publique du serveur HTTP frontal
|-
|HTTP ServiceName
|String
|6.51
|Nom du service
|
Nom du service load-balancé utilisé par le service 
Ce nom peut différer du nom du service dans une configuration load balancée. 
C'est ce nom qui est enregistrée dans les URLs de la registry SDATA 
Implémenté pour SOAP à partir de la version 7 
|}

Les variables suivantes configurent [[Serveur HTTP (server)|le service HTTP interne]] inclus dans le serveur.

{{Version700}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP Started
|boolean
|Démarre le serveur HTTP
|-
|HTTP Listen Protocol
|String
|Protocole HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le protocole est défini par HTTP Protocol
|-
|HTTP Listen Port
|Integer
|Port HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le port est défini par HTTP Port
|-
|HTTP Site
|String
|Répertoire du site utilisé par le serveur HTTP
|-
|HTTP Alias
|String
|Nom de section des alias de répertoire du serveur HTTP
|-
|HTTP CertFile
|String
|Si le protocole est https, représente le fichier certificat (.pem)
|-
|HTTP RootCertFile
|String
|Si le protocole est https, représente le fichier certificat de l'autorité intermédiaire qui a signé le certificat "CertFile" (.pem). 
Ce paramètre est optionnel, il est utile si l'autorité intermédiaire n'est pas directement reconnue par le navigateur.
|-
|HTTP KeyFile
|String
|Si le protocole est https, représente le fichier clef privée (.pem ou .key) qui est liée au certificat
|-
|HTTP KeyPassword
|String
|Si le protocole est https, représente le mot de passe qui permet de décoder la clef privée
|-
|HTTP CertIssuer
|String
|Si le protocole est https, représente l'émetteur du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP CertSerial
|String
|Si le protocole est https, représente le numéro de série du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP SSLVersion
|String
|Version du protocole SSL à utiliser: sslvTLSv1_1, sslvTLSv1_2, sslvTLSv1_3 (par défaut :sslvTLSv1_2)
|-
|HTTP SSLCipherList
|String
|Sceaux proposés par le serveur (par défaut "HIGH:!aNULL:!MD5:!RC4") [https://www.openssl.org/docs/manmaster/apps/ciphers.html en savoir plus] Version 7.10
|-
|HTTP KeepAlive
|Boolean
|Détermine la valeur du paramètre KeepAlive des réponses du serveur HTTP. 
La valeur est True (1) par défaut et le serveur renvoi KeepAlive dans ses réponses. 
Cette valeur doit être false (0) pour une configuration load balancée.
|-
|HTTP Private Started
|Boolean
|Permet de démarrer un service http "privé", utile dans le cadre d'une configuration load balancée. 
Ce service n'est adressé que par les autres services, et permet d'économiser la partie SSL des échanges. 
Le port de ce service ne doit pas être exposé au clients web.
|-
|HTTP Private Port
|Integer
|Détermine la valeur du port http privé.
|-
|HTTP Log
|Booléen
|Active la journalisation des flux http (Version 10)
|}

{{tip|TLS 1.3 supporté à partir de la version 10 en utilisant OpenSSL 3.0}}

{{tip|Le protocole/port publique peuvent être différent du protocole/port d'écoute si un load balancer est utilisé.}}

Voir aussi :
* [[Serveur HTTP (server)|Serveur HTTP interne]]
* [[Configuration_du_Serveur_HTTPS|Configuration du serveur en HTTPs]]
* [[Configuration_du_Serveur_HTTP_derrière_un_répartiteur_de_charge|Configuration derrière un répartiteur de charge]]

Certains de ces paramètres peuvent être remplacés par [[Service_1000_(server)|les paramètres de la ligne de commande]] :

{|class="wikitable"
|-
!Paramètre
!Paramètre de la ligne de commande
|-
|HTTP Listen Port
|HTTPPORT
|-
|HTTP KeepAlive
|HTTPKEEPALIVE
|}

====HTTP ACLs====
{{version710}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP ACL
|string
|Liste de règles séparées par une virgule, par ordre de priorité
|}

La syntaxe d'une règle ACL :
<pre>
action-IP/Nob
</pre>

*action
: Type de règle, doit être accept ou deny
*IP
: Addresse IP en notation pointé
*Nob (facultatif)
:Nombre de bits du masque de sous réseau, par exemple 29 correspond au masque 255.255.255.248 et défini un sous réseau de 8 adresses.

[http://jodies.de/ipcalc Calculateur de masque]

Exemple 1 :

Autorise les adresses 192.168.1.0 ... 192.168.1.7 à l’exception de 192.168.1.5

<pre>
deny-192.168.1.5
accept-192.168.1.0/29
</pre>

Exemple 2 :

Autorise seulement l'adresse 192.168.1.1

<pre>
accept-192.168.1.1
deny-0.0.0.0/0
</pre>

====HTTP Web Worker====
{{version800}}

Le Web Worker est un mécanisme de notification asynchrone permettant au client Web d'être notifié des événements survenant coté serveur.

Il permet de gérer les notifications de boîte à message ainsi que les notifications de traitement.

L'utilisation du web worker améliore l'expérience utilisateur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web worker started
|Integer
|Active (1) ou désactive (0) l'utilisation du web worker
|}

{{Tip|Lorsque le web worker est activé, le client génère des requêtes msg.pending périodiques.}}

====HTTP Web Socket====
{{version800}}

Les WebSockets utilisent un protocole permettant de créé des canaux de communication full-duplex à l'intérieur d'une connexion TCP.

L'utilisation des WebSockets améliore l'expérience utilisateur par une meilleur fluidité des échanges.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web socket started
|Integer
|Active (1) ou désactive (0) l'utilisation de WebSocket
|}

{{Tip|

#Les WebSocket ne sont prises en charge que par le serveur HTTP embarqué et en mode '''HTTPs uniquement'''.
#Les WebSockets sont activées par défaut.
#Les WebSocket peuvent ne pas fonctionner ou provoquer des problèmes dans le cas d'utilisation du serveur Sage 1000 derrière un load balancer qui ne supporterait pas le protocole WebSocket.
#L'url utilisée doit correspondre au domaine du certificat SSL. Par exemple, en entreprise, si votre serveur est myhost sur le domaine interne xxx.yyy.zzz le nom de domaine du certificat auto-généré sera myhost.xxx.yyy.zzz. Vous devez utiliser https://myhost.xxx.yyy.zzz comme url d'accès même si https://myhost est valide sur votre réseau. A défaut l'établissement des connexions websockets échoueront.}}

{{Tip|Lorsque les websockets sont actives, le dialogue d'attente n'est pas affiché.}}

====HTTP CSP====
La [https://developer.mozilla.org/fr/docs/Web/HTTP/CSP stratégie de sécurité du contenu] permet d'améliorer la sécurité des sites web.

{{version1000}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CSP
|Liste de chaines
|Liste des règles séparées par ";"
|}

Exemple

HTTP CSP = default-src 'self'; script-src https://example.com

La valeur par défaut est ''default-src 'self'''

====HTTP CORS====
Le [https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS CORS] permet d'autoriser des requêtes provenant d'autre domaine.

{{version800}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CORS Allow origin
|Liste de chaines
|Liste des domaines autorisés
|}

La liste des domaines doit être séparée par des virgules, utilisez * pour autoriser tous les domaines.

Les domaines doivent être qualifié par le protocole, par exemple http://origin.com

Les domaines indiqués ici seront comparés à la valeur du champ d'entête Origin

Lorsque le domain est autorisé, le service retourne dans la réponse :

{| class="wikitable"
|-
!Champ
!Valeur
|-
|Access-Control-Allow-Origin
|Valeur du chanmp Origin de la requête
|-
|Vary
|Origin
|-
|Access-Control-Allow-Credentials
|true
|-
|Access-Control-Allow-Methods
|POST,PUT,DELETE,GET,OPTION
|-
|Access-Control-Allow-Headers
|Valeur de Access-Control-Request-Headers de la requête
|-
|Access-Control-Max-Age
|86400
|}

====FTPs====
Ces variables configurent le serveur FTPs inclu dans le servcice.
Le serveur FTP peut être utilisé sur les containeurs.

[\SOFTWARE\Sage\Ligne 1000\Administration\FTP\nom_de_profil]

puis référencée par la variable "FTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP Profil
|string
|Référence une section FTP
|-
|FTP Start
|1 ou 0
|Démarre le service FTP
|-
|FTP ACL
|Chaîne
|Définit une liste d'ACL optionnelle
|}

====WEB====
Ces variables configurent le service WEB inclu dans le service.

Ces variables peuvent être renseignées dans une section WEB

[\SOFTWARE\Sage\Ligne 1000\Administration\WEB\nom_de_profil]

puis référencée par la variable "WEB Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|WEB Profil
|string
|Référence une section WEB
|-
|MaxDatagridRowCount
|Entier
|Détermine le nombre maximal de lignes chargées dans une grille (défaut 5000)
|-
|GridWindowSize
|Entier
|Détermine le nombre maximal de lignes affichées dans une page de grille. (Défaut 25)
|-
|MDIForms
|1 ou 0
|Défaut 0
|-
|MDIAssistants
|1 ou 0
|Défaut 1
|-
|UseTreeBookClassic
|1 ou 0
|Défaut 0
|-
|SavePortalTabForms
|1 ou 0
|Défaut 1
|-
|DebugJS
|1 ou 0
|Utilise les javascript en mode debug (Défaut 0)
|-
|RecordMode
|1 ou 0
|Active le mode enregistrement pour JMeter (Défaut 0)
|-
|FormRedirect
|1 ou 0
|Active la redirection des urls d'écran, pour IIS cette redirection doit être désactivée. (défaut 1, ativé)
|}

====Export de grille ====

{{Version2025r2}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Grid exporters
|liste de nom d'extension de fichier séparés par une virgule
|Défini les formats d'export autorisés
|-
|Grid export limits
|Entier
|Limite le nombre de lignes exportées
|}

====Mise au point, debugger {{Version700}}====
Ces variables configurent le remote debugger inclus dans le service.

Le remote debugger permet à un poste client desktop de visualiser, modifier et poser des points d'arrêt dans le code métier exécuté par le service.

Ces variables peuvent être renseignées dans une section DEBUGGER

[\SOFTWARE\Sage\Ligne 1000\Administration\DEBUGGER\nom_de_profil]

puis référencée par la variable "DEBUGGER Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|DEBUGGER Profil
|string
|Référence une section DEBUGGER
|-
|DEBUGGER Started
|Boolean
|Démarre le service de Remote debugging
|-
|DEBUGGER Users
|Strings
|Liste des utilisateurs autorisés à utiliser le service de remote debugging
|-
|DEBUGGER Handlers
|Strings
|Liste des handlers des évènements de trace qui seront interceptés et redirigés vers le journal d'évènement, ceci vous permet de visualiser en temps réel ces traces dans la console SNMP. Les handlers possibles sont:
* script
: Evènements générés par la fonction dbgMsg() du code métier
* queries
: Evènements de trace des requêtes SQL
|}

{{warning|L'utilisation de DEBUGGER Handlers peut provoquer une forte consommation de mémoire}}
{{warning|Ces fonctionnalités ne doivent pas être activés sur un serveur de production}}

====LDAP====
Ces variables configurent le serveur LDAP inclus dans le service.

Ces variables peuvent être renseignées dans une section LDAP

[\SOFTWARE\Sage\Ligne 1000\Administration\LDAP\nom_de_profil]

puis référencée par la variable "LDAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|LDAP Profil
|string
|Référence une section LDAP
|-
|LDAP Started
|Boolean
|Démarre le service LDAP (défaut false).
|-
|LDAP Port
|Integer
|Port d'écoute du service LDAP
|-
|LDAP Password
|String
|Mot de passe administrateur du compte system du serveur LDAP ('uid=admin,ou=system')
|}

====SAML====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SAMLv2 Log=1
|Boolean
|Active la trace SAML (à retirer une fois la mise au point effectuée)
|}

====SOAP====
Ces variables configurent le service SOAP inclus dans le serveur.

Ces variables peuvent être renseignées dans une section SOAP

[\SOFTWARE\Sage\Ligne 1000\Administration\SOAP\nom_de_profil]

puis référencées par la variable "SOAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SOAP Profil
|string
|Référence une section SOAP
|-
|SOAP Log Documents
|Boolean
|Active la journalisation des documents SOAP
|-
|SOAP Log Messages
|Boolean
|Active la journalisation des messages SOAP
|-
|SOAP 5.5x
|Boolean
|Utilise l'implémentation SOAP des versions 5.5x
|}

*SOAP 5.5x
:L'implémentation de SOAP a été récrite en version 5.6x, en cas de problème de compatibilité avec des développements existant il est possible d'utiliser l'ancienne implémentation.

====SMTP====
Ces variables configurent le client SMTP utilisé par le service pour envoyer des EMails.

Ces variables peuvent être renseignées dans une section SMTP

[\SOFTWARE\Sage\Ligne 1000\Administration\SMTP\nom_de_profil]

puis référencés par la variable "SMTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SMTP Profil
|string
|Référence une section SMTP
|-
|SMTP Host
|String
|Adresse du serveur SMTP.
|-
|SMTP Port
|Integer
|Port du serveur SMTP.
|-
|SMTP Login
|String
|Utilisateur de connexion du serveur SMTP.
|-
|SMTP Password
|String
|Mot de passe de connexion du serveur SMTP.
|-
|SMTP From
|String
|Adresse EMail de l'expéditeur.
|-
|SMTP UseTLS
|Boolean
|Utilise une sécurisation TLS
|}

====SNMP====
Ces variables peuvent être renseignées dans une section SNMP

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\nom_de_profil]

puis référencés par la variable "SNMP Profil"

Ces variables configurent l'agent SNMP inclus dans le serveur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Profil
|string
|Référence une section SNMP
|-
|SNMP Started
|Boolean
|Démarre l'agent SNMP
|-
|SNMP Port
|Integer
|Port UDP de l'agent SNMP (161)
|-
|SNMP sysName
|String
|Valeur de la variable sysName pour la MIB2
|-
|SNMP sysContact
|String
|Valeur de la variable sysContact pour la MIB2
|-
|SNMP sysLocation
|String
|Valeur de la variable sysLocation pour la MIB2
|-
|SNMP Traps
|liste de chaîne
|Référence des sections SNMPTRAP
|}

Les sections SNMPTRAP permettent de définir des points d'écoute SNMP auquels seront envoyés les messages de traps.

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\nom_de_profil]

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Trap Host
|string
|Nom réseau du point d'écoute
|-
|SNMP Trap Port
|Integer
|Numéro du port du point d'écoute
|-
|SNMP Trap Categories
|Liste de chaîne
|Catégories des traps à envoyer à ce point d'écoute 
|}

La liste des catégories de trap est la suivante :

{|class="wikitable"
|-
!Nom de catégorie
!Type de message
|-
|Service
|Messages relatifs au processus du service.
|-
|Automate
|Messages relatifs aux exécutions de l'automate.
|-
|BP
|Messages relatifs aux exécutions des Processus métiers.
|-
|Authenticate
|Messages relatifs aux erreurs d'authentification.
|}

Exemple de configuration SNMP :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\CONFIG_SNMP_1]
SNMP Started=1
SNMP Start=1
SNMP Port=161
SNMP sysContact = toto@sage.com
SNMP sysName = toto
SNMP sysLocation = Paris,France
SNMP Traps=Service,Automate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Service]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Service,Authenticate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Automate]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Automate,BP
</pre>

====PROXY====

{{tip|Déprécié, utiliser le paramétrage dans la console d'administration.}}

Ces variables configurent le PROXY utilisé par le client HTTP.

Ces variables peuvent être renseignées dans une section PROXY

[\SOFTWARE\Sage\Ligne 1000\Administration\PROXY\nom_de_profil]

puis référencée par la variable "PROXY Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|PROXY Profil
|string
|Référence une section PROXY
|-
|PROXY Host
|String
|Adresse du serveur PROXY.
|-
|PROXY Port
|Integer
|Port du serveur PROXY (défaut 8080).
|-
|PROXY Login
|String
|Utilisateur de connexion du serveur PROXY.
|-
|PROXY Password
|String
|Mot de passe de connexion du serveur PROXY.
|-
|PROXY Timeout
|Integer
|Délai d'expiration du PROXY. (défaut 60 secondes)
|}

====Exceptions====
Ces variables configurent l'enregistrement des exceptions du service.

Ces variables peuvent être renseignées dans une section EXCEPTIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\EXCEPTIONS\nom_de_profil]

puis référencées par la variable "Exceptions logs Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Exceptions logs Profil
|string
|Référence une section EXCEPTIONS
|-
|Exceptions logs Started
|boolean
|Enregistrer les exceptions. Vrai par défaut.
|-
|Exceptions logs path
|String
|Répertoire dans lequel seront créés les fichiers d'exception.
|-
|Exceptions logs ignore
|Liste de chaîne
|Liste d'exception à ignorer.
|-
|Exceptions logs write file
|booléen
|Un fichier d'exception est écrit. Vrai par défaut. Il peut être inutile d'écrire un fichier d'exception si les exceptions sont transmises à un gestionnaire de log (voir LOG MANAGER) et permet dans ce cas ne ne pas encombrer le disque.(V8)
|}

====Captcha====

Dans le cadre d'un service public, les utilisateurs souhaitant s'enregistrer peuvent être soumis à un captcha.

Si l'utilisateur commet trois erreurs lors de l'authentification, il devra saisir un captcha.

voir http://www.google.com/recaptcha

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Recaptcha Public Key
|string
|Clef publique Recaptcha
|-
|Recaptcha Private Key
|String
|Clef privée Recaptcha
|}

====Quotas====

Dans le cadre d'un service public, les utilisateurs téléversent des fichiers dans un répertoire propres à la session.

Ces fichiers doivent avoir une extension prévue pour des questions de sécurité.

La taille totale du répertoire est définie pour éviter un manque de place sur le disque.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Upload Document Size
|integer
|Taille maximale en Mb d'un fichier uploadé; valeur par défaut : 0 (non limité)
|-
|Upload User Quota
|integer
|Taille maximale en Mb du répertoire upload de l'utilisateur par session; valeur par défaut : 50
|-
|Upload Ext Allowed
|String
|Extensions autorisées; valeur par défaut : vide (tout est autorisé)
|-
|Auto delete messages
|Entier
|Durée de conservation en jours des messages
|}

{{tip|La liste des extensions suivantes n'est jamais filtrée car le service est susceptible de créer des fichiers de ce type (xlsx,ods,xml,pdf,,csv,sxc,xls,,jpg,jpeg,png,asice)}}

====Clefs====

Le stockage de certaines clefs peut être externalié

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Key Cookie
|chaine
|[[keyvault_url|url d'un stockage sécurisé externe]], si la clef est non trouvée, elle y sera créée
|}

====Logs====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Log keep days
|entier
|durée en jour de rétention des fichiers dans le répertoire de log, par défaut 10
|-
|SDATA Log Messages
|Boolean
|Enregistre les messages SDATA dans le répertoire de log
|}

===Sections SDATA===
Ces sections permettent de configurer les points d'accès SDATA qui seront exposés par le service.

Les noms de ces sections sont

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\<<nom du service>>\SData\<<incrément 1...>>]

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|DataSetName
|string
|Nom du dataset dans l'URL SDATA
|-
|Title
|string
|Libellé informatif sur l'usage du point d'accès
|-
|Contract
|string
|Nom du paquet de service SDATA
|-
|Version
|string
|Numéro de version, peut être utilisé pour supporté plusieurs version du même contrat
|-
|Folder
|string
|Nom du dossier utilisé par ce point d'accès
|-
|Database
|string
|Nom de la base de donnée utilisé pour ce point d'accès (multi-bases)
|-
|Society
|string
|Nom de la société pour ce point d'accès (multi-société)
|-
|Restitution
|string
|Nom de la famille de restitution pour ce point d'accès (multi-société)
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\SData\1]
DataSetName=iphone
Title=syfre iphone
Contract=ndfContract
Version=1
Folder=Test Syfre iPhone
Database=dbTestIPhone
Society=
Restitution=
</pre>

===Section Export===
Cette section permet de configurer la fonction d'exportation des vignettes de portail des Services.

Deux mode d'exportation sont possibles :

*ftp
: Dans ce mode les vignettes sont générées et copiées dans un répertoire public accessible par ftp.

*file
: Dans ce mode les vignettes sont générées et copiées dans un répertoire local du serveur. Ce mode n'est utile que si le répertoire est un répertoire du Site et que celui-ci est public.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Protocol
|String
|ftp ou file
|-
|Export URL
|String
|Cette URL référence le répertoire où la vignette a été générée.
|}

Si le protocole est 'ftp' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP host
|String
|Addresse du serveur FTP
|-
|FTP Port
|Integer
|Numéro du port du serveur FTP
|-
|FTP Login
|String
|Utilisateur de connexion du serveur FTP
|-
|FTP Password
|String
|Mot de passe de connexion du serveur FTP
|-
|FTP Directory
|String
|Répertoire d'exportation sur le serveur FTP
|}

Si le protocole est 'file' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Directory
|String
|Répertoire d'exportation sur le serveur.
|}

Exemple de configuration ftp utilisant une zone publique Free :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\Export]
Protocol=ftp
Export URL=http://syfre.free.fr/sage/
FTP Host=ftpperso.free.fr
FTP Port=21
FTP Login=syfre
FTP Password=XXXXXXXXXX
FTP Directory=sage
</pre>

===Section ConfigServer===

Cette section permet d'utiliser un fichier de configuration disponible sur une url.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|url
|String
|Cette URL permet de récupérer le fichier de configuration.
|}

Un POST HTTP est effectué sur cette url avec les données suivantes :

<source lang="javascript">
{"deploymentId":"nom_système_de_la_machine"}
</source>

Le résultat attendu est

<source lang="javascript">
{"config":"contenu_du_fichier_de_configuration"},
{"certificate":"certificat_au_format_pfx"}
</source>

*[[Exemple de configuration (server)|Exemple de configuration]]
*[[Service_1000_(server)|Ligne de commande]]

{{Footer|Serveur}}
[[category:Serveur]]

Fichier de configuration (server)

2026-03-11T09:16:24Z

Syfre : /* Logs */

===Introduction===
Le Serveur d'application Sage 1000 utilise un fichier de configuration situé dans le répertoire du serveur.

{{info|Le nom du fichier est serverl1000.ini}}

Ce fichier peut être soit modifié à l'aide de la console d'administration des services, soit manuellement par un éditeur de texte.

{{tip|Le fichier est chargé au démarrage du service.}}

===Structure===
Le fichier peut configurer plusieurs services exécutés sur le même serveur, chaque service comporte au moins deux sections :

* [\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SERVICE_NAME]
: Cette entrée détermine la configuration réseau du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE]
: Cette entrée détermine la configuration logicielle du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE\Export]
: Cette entrée configure la fonction d'exportation du service.

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\MYSERVICE]
ipcMode=ipcSHM
tcpPort=8090
shmAddress=SYFRE

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\MYSERVICE]
Master base=orasql://myhost/DBMASTER_ORA?prefix="DBMASTERT_ORA."
Master driver=orasql
Master OS Authentication=0
Master user=DBMASTER_ORA
Master password=DBMASTER_ORA
Server Societies=Société de démonstration GCF 1000
Server Application=Sage 1000 Suite Financière
...
</pre>

Chaque section est composée d'une liste de variables (NomVariable=ValeurVariable), les types de données des variables sont :

{|class="wikitable"
|-
!Variable
!Type
|-
|String
|Chaîne de caractère
|-
|Boolean
|Valeur logique 0:Non 1:Oui
|-
|Integer
|Valeur entière
|-
|Liste de chaîne
|Liste de chaîne de caractère séparée par des virgules.
|}

===Section IPC===

{|class="wikitable"
|-
!Variable
!Type
!Contexte
!Usage
|-
|ipcMode
|enumération
|Client/Serveur
|
*ipcTCP
:Mode de communication par TCP/IP
*ipcSHM
:Mode de communication par mémoire partagée (dépréciée)
|-
|tcpPort
|Integer
|Client/Serveur
|Port de communication TCP
|-
|tcpAddress
|string
|Client/Serveur
|Adresse de communication TCP
|-
|shmAddress
|string
|Client/Serveur
|Nom du segment de mémoire partagé
|-
|serverList
|Serveur
|String list
|Configuration de Cluster 
Liste des services associés à cet identifiant de service.
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\TRESO]
ipcMode=ipcTCP
tcpPort=8090
tcpAddress=localhost
</pre>

Exemple de configuration Cluster :

'''fichier du configuration des services :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

'''fichier du configuration du client HTTP :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

===Section Servers===
====IPC====
Ces variables configurent la gestion des services IPC.

La configuration des services IPC peut être renseignée dans une section IPC

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\nom_de_profil]

puis référencée par la variable "IPC Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|IPC Profil
|String
|Référence un nom de section IPC contenant la configuration
|-
|IPC Started
|boolean
|Démarre les services IPC (défaut true)
|}

Les services IPC sont les services permettant de communiquer via RPC.

Vous avez besoins des services IPC si :
* Vous utilisez un serveur HTTP externe (IIS ou Apache).
* Vous utilisez la Console des Processus Métiers pour dialoguer avec ce Service.
* Vous utilisez le Contrôleur des services.
* Ce Service exécute des tâches de traitement déléguées par un autre Service.

Si vous n'utilisez pas les services IPC il est conseillé de ne pas les démarrer.

{{tip|Ce paramètre n'est pas modifiable depuis la console des services car si vous désactivez les services IPC le contrôleur n'est plus opérationnel}}

====Sessions====
Ces variables configurent la gestion des sessions.

La configuration des sessions peut être renseignée dans une section SESSIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\SESSIONS\nom_de_profil]

puis référencée par la variable "SESSIONS Profil"

{|class="wikitable"
|-
!Variable
!Type
!Défaut
!Min
!Usage
|-
|SESSIONS Profil
|String
|
|
|Référence un nom de section SESSIONS contenant la configuration
|-
|CheckInterval
|Entier
|1 minute
|1 minute
|Délai entre chaque test d'expiration en seconde.
|-
|ExpireInterval
|Entier
|15 minutes
|
|Délai d'expiration des sessions en seconde.
|}

====Base master====
Ces variables configurent la base Master utilisée par le service.

La configuration de la base master peut être renseignée dans une section MASTER

[\SOFTWARE\Sage\Ligne 1000\Administration\MASTER\nom_de_profil]

puis référencée par la variable "Master Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Master Profil
|String
|Référence un nom de section MASTER contenant la configuration
|-
|Master base
|String
|Nom de la base de données Master
|-
|Master driver
|String
|Nom du driver de la base de données Master
|-
|Master OS Authentication
|Boolean
|Utiliser l'authentification du système d'exploitation.
|-
|Master user
|String
|Nom d'utilisateur utilisé pour la connexion à la base Master
|-
|Master password
|String
|Mot de passe utilisé pour la connexion à la base Master
|}

====Application et Sociétés====
Ces variables configurent l'application et les sociétés servies par le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Societies
|String
|
|Liste des sociétés/dossiers servies par le service.
|-
|Server Application
|String
|
|Nom de l'application servie par le service.
|-
|Server User
|String
|
|Nom de l'utilisateur du service.
|-
|Server Password
|String
|
|Mot de passe de l'utilisateur du service.
|-
|Server User Group
|String
|
|Nom du groupe de l'utilisateur du service.
|-
|Server Authentication
|String
|
|Annuaire utilisé pour l'authentification.
|-
|Authentication Directories
|liste de chaîne
|8.00
|Annuaires disponibles pour ce service.(code des annuaires séparés par ";")
|}

====Service====
Ces variables configurent le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Name
|String
|
|Nom du service.
|-
|Cache Folder
|String
|
|Répertoire où stocker les fichiers temporaires et les fichiers en cache.
|-
|[[Zone publique (server)|Public Folder]]
|String
|
|[[Zone_publique_(server)|Racine des répertoires partagés du service]].
|-
|[[Public links (server)|Public Links]]
|Liste de chaîne
|
|Liste de répertoires réseaux (séparés par un ;) pour lesquels des [[Stockage_des_documents|documents peuvent être associés]].
|-
|Send Alert To
|String
|
|Liste d'adresses emails (séparées par un ;) auxquelles seront envoyés les messages d'alertes.
|-
|Scripts
|Liste de chaîne
|
|Liste de références CSS ajouté aux pages HTML
|-
|MaxDatagridRowCount
|Integer
|
|Limite le nombre de lignes affichées dans les grilles (par défaut à 10 000).
|-
|[[Security mode (server)|Security Mode]]
|String
|7.00
|Valeurs possibles : Intranet (valeur par défaut) / Internet [[Service_exposé_sur_internet|Voir Service exposé sur internet]]
|-
|Enable Remember User
|boolean
|7.10
|Permet à l'utilisateur d'avoir son nom pré-renseigné dans la page d'authentification (par défaut à vrai)
|-
|MaxPreviewPageCount
|Integer
|
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview max page
|Integer
|10.00
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview blocking
|Boolean
|10.00
|1:Les aperçus sont affichés directement en onglet 0:les aperçus sont envoyés dans la bam.
|-
|Preview timeout
|Integer
|10.00
|Délai d'attente de fin d'aperçu si Preview blocking=1.
|-
|Printer Filter
|chaine
|
|Noms des imprimantes à ne pas proposer, séparées par des points virgules (9.20)

|}

====Automates====
Ces variables configurent le serveur d'automate inclus dans le serveur.

Ces variables peuvent être renseignées dans une section AUTOMATE

[\SOFTWARE\Sage\Ligne 1000\Administration\AUTOMATE\nom_de_profil]

puis référencées par la variable "Automate Profil"

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Automate Profil
|String
|
|Référence une section AUTOMATE.
|-
|Automate Started 
Process Server Started
|Boolean
|
|Démarre le serveur d'automate. (défaut) (*) 
|-
|Automate Name 
Process Server Name
|String
|
|Nom du serveur d'automate à démarrer. (*)
|-
|Automate Message Box 
Process Server Message Box
|String
|
|Boite à messages utilisé par le serveur d'automate.
|-
|Automate Task Service 
Process Task Service
|String
|
|Nom du Service 1000 exécutant les tâches du serveur d'automate.(hostname.servicename)
|-
|Automate Task Count 
|Integer
|6.50
|Nombre maximal de tâches automates simultanées (défaut 1).
|-
|Automate Debug 
|Boolean
|7.00 Patch
|Active le mode debug verbose (**).
|}

{{Version700}} (*) Ces valeurs peuvent être modifiées sur la ligne de commande

{{Version700}} (**) A utiliser conjointement avec la console de trap snmp

====Processus métiers====
Ces variables configurent le service de Processus Métiers inclus dans le serveur.

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|BP Started
|Boolean
|Démarre le service de Processus Métiers (défault).
|}

{{Version700}} Cette valeur peut être modifiée sur la ligne de commande

====Système====
Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PROCESS

[\SOFTWARE\Sage\Ligne 1000\Administration\PROCESS\nom_de_profil]

puis référencée par la variable "Process Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Process Profil
|string
|Référence une section PROCESS
|-
|ProcessAffinity
|String
|Détermine les coeurs utilisés par le processus sur une machine multi-coeurs 
ex : 1,3 pour utiliser les coeurs 1 et 3 d'une machine multi-coeurs.
|-
|ThreadPoolSize
|Integer
|Taille du pool de thread (20)
|-
|FormCacheSize
|Integer
|Taille du cache pour un écran (défaut:20, 0:désactive l'utilisation du cache)
|-
|FormCacheLimit
|Integer
|Taille du cache pour l'ensemble des écrans (256)
|-
|FormCacheReuse
|Integer
|Nombre de fois qu'un écran peut être réutilisé (-1 : pas de limite)
|}

*ProcessAffinity
:Le Processus du serveur est un processus multi-threadé, sur une machine multi-coeurs il utilise tous les coeurs disponibles sur le système d'exploitation. Dans certain cas il est souhaitable de restreindre l'exécution à certains coeurs.

*ThreadPoolsize
:Chaque requête sur le service est exécutée par une thread allouée d'un pool ; lorsque le pool est plein la requête est suspendue jusqu'à ce qu'une thread se libère dans le pool. Cette variable limite la taille du pool de thread et par conséquence limite les contentions et les "context switches" provoqués par le processus.

*FormCacheSize
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre d'instance d'un écran dans le cache.

*FormCacheLimit
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre maximal d'écran dans le cache et par conséquent la mémoire utilisée par le cache d'écran.

*FormCacheReuse
:Indique le nombre de fois qu'un écran en cache peut être réutilisé.

{{info|Pour pouvoir utiliser WMI la dll serviceL1000perf.dll doit être présente dans le répertoire du serveur.}}
{{info|Pour désactiver le cache, définir la valeur de FormCacheSize à 0}}

====Files d'attente====
Ces variables configurent le service de consommation de file d'attente.

Ces variables peuvent être renseignées dans une section PERF.

[\SOFTWARE\Sage\Ligne 1000\Administration\QUEUELISTENER\nom_de_profil]

puis référencée par la variable "Queue listener Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Queue listener Started
|Boolean
|Démarre le service de consommation de file d'attente.
|-
|Queue listener queues
|Liste de chaînes séparées par des ,
|Liste des files d'attente à consommer.
|-
|Queue listener Task count
|Entier
|Nombre maximal de tâches simultanées par service.
|}

Les paramètres de scrutation d'une file d'attente peuvent être configurés à la suite du nom de la file d'attente en séparant les paramètres par un caractère ":"

{|class="wikitable"
|-
!Paramètre
!Valeur par défaut (ms)
!Usage
|-
|Initial
|1000
|Délai initial de scrutation (ms)
|-
|Max
|10000
|Délai maximal de scrutation (ms)
|-
|Increment
|1000
|Incrément du délai jusqu'au délai maximal si aucun message n'est disponible (ms)
|}

Exemple :
<pre>
Queue listener queues=MyQueue1:2000:10:20000,MyQueue2,MyQueue3:100:10:1000
</pre>

Avec les valeurs par défaut, une file d'attente est lue initialement toutes les secondes, puis si aucun message n'est reçu, ce délai monte jusqu'à 10 secondes. Lorsque un message est reçu le délai est réinitialisé à 1 seconde et ainsi de suite.

====Compteurs de performance====

Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PERF

[\SOFTWARE\Sage\Ligne 1000\Administration\PERF\nom_de_profil]

puis référencée par la variable "Performance Counters Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Start Performance Counters
|Boolean
|Démarre les compteurs de performance
|-
|Start Performance Clock
|Boolean
|Démarre l'horloge de performance
|-
|Performance Clock Delay
|Cardinal
|Période de l'horloge de performance (ms)
|-
|HTTP PerfServer Start
|Boolean
|Démarre le serveur HTTP de performance
|-
|HTTP PerfServer Port
|Integer
|Port du serveur HTTP de performance
|-
|HTTP PerfServer Protocol
|String
|Protocole du serveur HTTP de performance
|}

*Start Performance Counters
:Le serveur inclus un certain nombre de [[Compteurs de performance (monitoring)|compteurs de performance]] interrogeables par le [[Serveur de performance (monitoring)|serveur de performance]].

*Start Performance Clock
: Démarre une horloge permettant de générer un évènement de monitoring.

*Performance Clock Delay
: Période de l'horloge de performance. (défaut 1000)

*HTTP PerfServer Start
: Démarre le server HTTP de performance.

*HTTP PerfServer Port
: Port du serveur HTTP de performance. (défaut 9999)

*HTTP PerfServer Protocol
:Protocole du serveur HTTP de performance (défaut http)

Voir la catégorie [[:Category:Monitoring]]

====HTTP====
Ces variables peuvent être renseignées dans une section HTTP

[\SOFTWARE\Sage\Ligne 1000\Administration\HTTP\nom_de_profil]

puis référencée par la variable "HTTP Profil"

Les variables suivantes configurent le protocole HTTP utilisé par le service, elles sont utilisées pour construire des URL pointant sur le service.

{|class="wikitable"
|-
!Nom de variable
!Type
!Version
!Par défaut
!Usage
|-
|HTTP Protocol
|String
|Toute
|http:
|Protocole HTTP publique du Service (http: ou https:)
|-
|HTTP Port
|Integer
|Toute
|80
|Port HTTP publique du Service
|-
|HTTP HostName
|String
|Toute
|Nom local de la machine
|Domaine publique du serveur HTTP frontal
|-
|HTTP ServiceName
|String
|6.51
|Nom du service
|
Nom du service load-balancé utilisé par le service 
Ce nom peut différer du nom du service dans une configuration load balancée. 
C'est ce nom qui est enregistrée dans les URLs de la registry SDATA 
Implémenté pour SOAP à partir de la version 7 
|}

Les variables suivantes configurent [[Serveur HTTP (server)|le service HTTP interne]] inclus dans le serveur.

{{Version700}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP Started
|boolean
|Démarre le serveur HTTP
|-
|HTTP Listen Protocol
|String
|Protocole HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le protocole est défini par HTTP Protocol
|-
|HTTP Listen Port
|Integer
|Port HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le port est défini par HTTP Port
|-
|HTTP Site
|String
|Répertoire du site utilisé par le serveur HTTP
|-
|HTTP Alias
|String
|Nom de section des alias de répertoire du serveur HTTP
|-
|HTTP CertFile
|String
|Si le protocole est https, représente le fichier certificat (.pem)
|-
|HTTP RootCertFile
|String
|Si le protocole est https, représente le fichier certificat de l'autorité intermédiaire qui a signé le certificat "CertFile" (.pem). 
Ce paramètre est optionnel, il est utile si l'autorité intermédiaire n'est pas directement reconnue par le navigateur.
|-
|HTTP KeyFile
|String
|Si le protocole est https, représente le fichier clef privée (.pem ou .key) qui est liée au certificat
|-
|HTTP KeyPassword
|String
|Si le protocole est https, représente le mot de passe qui permet de décoder la clef privée
|-
|HTTP CertIssuer
|String
|Si le protocole est https, représente l'émetteur du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP CertSerial
|String
|Si le protocole est https, représente le numéro de série du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP SSLVersion
|String
|Version du protocole SSL à utiliser: sslvTLSv1_1, sslvTLSv1_2, sslvTLSv1_3 (par défaut :sslvTLSv1_2)
|-
|HTTP SSLCipherList
|String
|Sceaux proposés par le serveur (par défaut "HIGH:!aNULL:!MD5:!RC4") [https://www.openssl.org/docs/manmaster/apps/ciphers.html en savoir plus] Version 7.10
|-
|HTTP KeepAlive
|Boolean
|Détermine la valeur du paramètre KeepAlive des réponses du serveur HTTP. 
La valeur est True (1) par défaut et le serveur renvoi KeepAlive dans ses réponses. 
Cette valeur doit être false (0) pour une configuration load balancée.
|-
|HTTP Private Started
|Boolean
|Permet de démarrer un service http "privé", utile dans le cadre d'une configuration load balancée. 
Ce service n'est adressé que par les autres services, et permet d'économiser la partie SSL des échanges. 
Le port de ce service ne doit pas être exposé au clients web.
|-
|HTTP Private Port
|Integer
|Détermine la valeur du port http privé.
|-
|HTTP Log
|Booléen
|Active la journalisation des flux http (Version 10)
|}

{{tip|TLS 1.3 supporté à partir de la version 10 en utilisant OpenSSL 3.0}}

{{tip|Le protocole/port publique peuvent être différent du protocole/port d'écoute si un load balancer est utilisé.}}

Voir aussi :
* [[Serveur HTTP (server)|Serveur HTTP interne]]
* [[Configuration_du_Serveur_HTTPS|Configuration du serveur en HTTPs]]
* [[Configuration_du_Serveur_HTTP_derrière_un_répartiteur_de_charge|Configuration derrière un répartiteur de charge]]

Certains de ces paramètres peuvent être remplacés par [[Service_1000_(server)|les paramètres de la ligne de commande]] :

{|class="wikitable"
|-
!Paramètre
!Paramètre de la ligne de commande
|-
|HTTP Listen Port
|HTTPPORT
|-
|HTTP KeepAlive
|HTTPKEEPALIVE
|}

====HTTP ACLs====
{{version710}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP ACL
|string
|Liste de règles séparées par une virgule, par ordre de priorité
|}

La syntaxe d'une règle ACL :
<pre>
action-IP/Nob
</pre>

*action
: Type de règle, doit être accept ou deny
*IP
: Addresse IP en notation pointé
*Nob (facultatif)
:Nombre de bits du masque de sous réseau, par exemple 29 correspond au masque 255.255.255.248 et défini un sous réseau de 8 adresses.

[http://jodies.de/ipcalc Calculateur de masque]

Exemple 1 :

Autorise les adresses 192.168.1.0 ... 192.168.1.7 à l’exception de 192.168.1.5

<pre>
deny-192.168.1.5
accept-192.168.1.0/29
</pre>

Exemple 2 :

Autorise seulement l'adresse 192.168.1.1

<pre>
accept-192.168.1.1
deny-0.0.0.0/0
</pre>

====HTTP Web Worker====
{{version800}}

Le Web Worker est un mécanisme de notification asynchrone permettant au client Web d'être notifié des événements survenant coté serveur.

Il permet de gérer les notifications de boîte à message ainsi que les notifications de traitement.

L'utilisation du web worker améliore l'expérience utilisateur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web worker started
|Integer
|Active (1) ou désactive (0) l'utilisation du web worker
|}

{{Tip|Lorsque le web worker est activé, le client génère des requêtes msg.pending périodiques.}}

====HTTP Web Socket====
{{version800}}

Les WebSockets utilisent un protocole permettant de créé des canaux de communication full-duplex à l'intérieur d'une connexion TCP.

L'utilisation des WebSockets améliore l'expérience utilisateur par une meilleur fluidité des échanges.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web socket started
|Integer
|Active (1) ou désactive (0) l'utilisation de WebSocket
|}

{{Tip|

#Les WebSocket ne sont prises en charge que par le serveur HTTP embarqué et en mode '''HTTPs uniquement'''.
#Les WebSockets sont activées par défaut.
#Les WebSocket peuvent ne pas fonctionner ou provoquer des problèmes dans le cas d'utilisation du serveur Sage 1000 derrière un load balancer qui ne supporterait pas le protocole WebSocket.
#L'url utilisée doit correspondre au domaine du certificat SSL. Par exemple, en entreprise, si votre serveur est myhost sur le domaine interne xxx.yyy.zzz le nom de domaine du certificat auto-généré sera myhost.xxx.yyy.zzz. Vous devez utiliser https://myhost.xxx.yyy.zzz comme url d'accès même si https://myhost est valide sur votre réseau. A défaut l'établissement des connexions websockets échoueront.}}

{{Tip|Lorsque les websockets sont actives, le dialogue d'attente n'est pas affiché.}}

====HTTP CSP====
La [https://developer.mozilla.org/fr/docs/Web/HTTP/CSP stratégie de sécurité du contenu] permet d'améliorer la sécurité des sites web.

{{version1000}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CSP
|Liste de chaines
|Liste des règles séparées par ";"
|}

Exemple

HTTP CSP = default-src 'self'; script-src https://example.com

La valeur par défaut est ''default-src 'self'''

====HTTP CORS====
Le [https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS CORS] permet d'autoriser des requêtes provenant d'autre domaine.

{{version800}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CORS Allow origin
|Liste de chaines
|Liste des domaines autorisés
|}

La liste des domaines doit être séparée par des virgules, utilisez * pour autoriser tous les domaines.

Les domaines doivent être qualifié par le protocole, par exemple http://origin.com

Les domaines indiqués ici seront comparés à la valeur du champ d'entête Origin

Lorsque le domain est autorisé, le service retourne dans la réponse :

{| class="wikitable"
|-
!Champ
!Valeur
|-
|Access-Control-Allow-Origin
|Valeur du chanmp Origin de la requête
|-
|Vary
|Origin
|-
|Access-Control-Allow-Credentials
|true
|-
|Access-Control-Allow-Methods
|POST,PUT,DELETE,GET,OPTION
|-
|Access-Control-Allow-Headers
|Valeur de Access-Control-Request-Headers de la requête
|-
|Access-Control-Max-Age
|86400
|}

====FTPs====
Ces variables configurent le serveur FTPs inclu dans le servcice.
Le serveur FTP peut être utilisé sur les containeurs.

[\SOFTWARE\Sage\Ligne 1000\Administration\FTP\nom_de_profil]

puis référencée par la variable "FTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP Profil
|string
|Référence une section FTP
|-
|FTP Start
|1 ou 0
|Démarre le service FTP
|-
|FTP ACL
|Chaîne
|Définit une liste d'ACL optionnelle
|}

====WEB====
Ces variables configurent le service WEB inclu dans le service.

Ces variables peuvent être renseignées dans une section WEB

[\SOFTWARE\Sage\Ligne 1000\Administration\WEB\nom_de_profil]

puis référencée par la variable "WEB Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|WEB Profil
|string
|Référence une section WEB
|-
|MaxDatagridRowCount
|Entier
|Détermine le nombre maximal de lignes chargées dans une grille (défaut 5000)
|-
|GridWindowSize
|Entier
|Détermine le nombre maximal de lignes affichées dans une page de grille. (Défaut 25)
|-
|MDIForms
|1 ou 0
|Défaut 0
|-
|MDIAssistants
|1 ou 0
|Défaut 1
|-
|UseTreeBookClassic
|1 ou 0
|Défaut 0
|-
|SavePortalTabForms
|1 ou 0
|Défaut 1
|-
|DebugJS
|1 ou 0
|Utilise les javascript en mode debug (Défaut 0)
|-
|RecordMode
|1 ou 0
|Active le mode enregistrement pour JMeter (Défaut 0)
|-
|FormRedirect
|1 ou 0
|Active la redirection des urls d'écran, pour IIS cette redirection doit être désactivée. (défaut 1, ativé)
|}

====Export de grille ====

{{Version2025r2}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Grid exporters
|liste de nom d'extension de fichier séparés par une virgule
|Défini les formats d'export autorisés
|-
|Grid export limits
|Entier
|Limite le nombre de lignes exportées
|}

====Mise au point, debugger {{Version700}}====
Ces variables configurent le remote debugger inclus dans le service.

Le remote debugger permet à un poste client desktop de visualiser, modifier et poser des points d'arrêt dans le code métier exécuté par le service.

Ces variables peuvent être renseignées dans une section DEBUGGER

[\SOFTWARE\Sage\Ligne 1000\Administration\DEBUGGER\nom_de_profil]

puis référencée par la variable "DEBUGGER Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|DEBUGGER Profil
|string
|Référence une section DEBUGGER
|-
|DEBUGGER Started
|Boolean
|Démarre le service de Remote debugging
|-
|DEBUGGER Users
|Strings
|Liste des utilisateurs autorisés à utiliser le service de remote debugging
|-
|DEBUGGER Handlers
|Strings
|Liste des handlers des évènements de trace qui seront interceptés et redirigés vers le journal d'évènement, ceci vous permet de visualiser en temps réel ces traces dans la console SNMP. Les handlers possibles sont:
* script
: Evènements générés par la fonction dbgMsg() du code métier
* queries
: Evènements de trace des requêtes SQL
|}

{{warning|L'utilisation de DEBUGGER Handlers peut provoquer une forte consommation de mémoire}}
{{warning|Ces fonctionnalités ne doivent pas être activés sur un serveur de production}}

====LDAP====
Ces variables configurent le serveur LDAP inclus dans le service.

Ces variables peuvent être renseignées dans une section LDAP

[\SOFTWARE\Sage\Ligne 1000\Administration\LDAP\nom_de_profil]

puis référencée par la variable "LDAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|LDAP Profil
|string
|Référence une section LDAP
|-
|LDAP Started
|Boolean
|Démarre le service LDAP (défaut false).
|-
|LDAP Port
|Integer
|Port d'écoute du service LDAP
|-
|LDAP Password
|String
|Mot de passe administrateur du compte system du serveur LDAP ('uid=admin,ou=system')
|}

====SAML====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SAMLv2 Log=1
|Boolean
|Active la trace SAML (à retirer une fois la mise au point effectuée)
|}

====SOAP====
Ces variables configurent le service SOAP inclus dans le serveur.

Ces variables peuvent être renseignées dans une section SOAP

[\SOFTWARE\Sage\Ligne 1000\Administration\SOAP\nom_de_profil]

puis référencées par la variable "SOAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SOAP Profil
|string
|Référence une section SOAP
|-
|SOAP Log Documents
|Boolean
|Active la journalisation des documents SOAP
|-
|SOAP Log Messages
|Boolean
|Active la journalisation des messages SOAP
|-
|SOAP 5.5x
|Boolean
|Utilise l'implémentation SOAP des versions 5.5x
|}

*SOAP 5.5x
:L'implémentation de SOAP a été récrite en version 5.6x, en cas de problème de compatibilité avec des développements existant il est possible d'utiliser l'ancienne implémentation.

====SMTP====
Ces variables configurent le client SMTP utilisé par le service pour envoyer des EMails.

Ces variables peuvent être renseignées dans une section SMTP

[\SOFTWARE\Sage\Ligne 1000\Administration\SMTP\nom_de_profil]

puis référencés par la variable "SMTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SMTP Profil
|string
|Référence une section SMTP
|-
|SMTP Host
|String
|Adresse du serveur SMTP.
|-
|SMTP Port
|Integer
|Port du serveur SMTP.
|-
|SMTP Login
|String
|Utilisateur de connexion du serveur SMTP.
|-
|SMTP Password
|String
|Mot de passe de connexion du serveur SMTP.
|-
|SMTP From
|String
|Adresse EMail de l'expéditeur.
|-
|SMTP UseTLS
|Boolean
|Utilise une sécurisation TLS
|}

====SNMP====
Ces variables peuvent être renseignées dans une section SNMP

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\nom_de_profil]

puis référencés par la variable "SNMP Profil"

Ces variables configurent l'agent SNMP inclus dans le serveur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Profil
|string
|Référence une section SNMP
|-
|SNMP Started
|Boolean
|Démarre l'agent SNMP
|-
|SNMP Port
|Integer
|Port UDP de l'agent SNMP (161)
|-
|SNMP sysName
|String
|Valeur de la variable sysName pour la MIB2
|-
|SNMP sysContact
|String
|Valeur de la variable sysContact pour la MIB2
|-
|SNMP sysLocation
|String
|Valeur de la variable sysLocation pour la MIB2
|-
|SNMP Traps
|liste de chaîne
|Référence des sections SNMPTRAP
|}

Les sections SNMPTRAP permettent de définir des points d'écoute SNMP auquels seront envoyés les messages de traps.

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\nom_de_profil]

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Trap Host
|string
|Nom réseau du point d'écoute
|-
|SNMP Trap Port
|Integer
|Numéro du port du point d'écoute
|-
|SNMP Trap Categories
|Liste de chaîne
|Catégories des traps à envoyer à ce point d'écoute 
|}

La liste des catégories de trap est la suivante :

{|class="wikitable"
|-
!Nom de catégorie
!Type de message
|-
|Service
|Messages relatifs au processus du service.
|-
|Automate
|Messages relatifs aux exécutions de l'automate.
|-
|BP
|Messages relatifs aux exécutions des Processus métiers.
|-
|Authenticate
|Messages relatifs aux erreurs d'authentification.
|}

Exemple de configuration SNMP :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\CONFIG_SNMP_1]
SNMP Started=1
SNMP Start=1
SNMP Port=161
SNMP sysContact = toto@sage.com
SNMP sysName = toto
SNMP sysLocation = Paris,France
SNMP Traps=Service,Automate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Service]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Service,Authenticate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Automate]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Automate,BP
</pre>

====PROXY====

{{tip|Déprécié, utiliser le paramétrage dans la console d'administration.}}

Ces variables configurent le PROXY utilisé par le client HTTP.

Ces variables peuvent être renseignées dans une section PROXY

[\SOFTWARE\Sage\Ligne 1000\Administration\PROXY\nom_de_profil]

puis référencée par la variable "PROXY Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|PROXY Profil
|string
|Référence une section PROXY
|-
|PROXY Host
|String
|Adresse du serveur PROXY.
|-
|PROXY Port
|Integer
|Port du serveur PROXY (défaut 8080).
|-
|PROXY Login
|String
|Utilisateur de connexion du serveur PROXY.
|-
|PROXY Password
|String
|Mot de passe de connexion du serveur PROXY.
|-
|PROXY Timeout
|Integer
|Délai d'expiration du PROXY. (défaut 60 secondes)
|}

====Exceptions====
Ces variables configurent l'enregistrement des exceptions du service.

Ces variables peuvent être renseignées dans une section EXCEPTIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\EXCEPTIONS\nom_de_profil]

puis référencées par la variable "Exceptions logs Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Exceptions logs Profil
|string
|Référence une section EXCEPTIONS
|-
|Exceptions logs Started
|boolean
|Enregistrer les exceptions. Vrai par défaut.
|-
|Exceptions logs path
|String
|Répertoire dans lequel seront créés les fichiers d'exception.
|-
|Exceptions logs ignore
|Liste de chaîne
|Liste d'exception à ignorer.
|-
|Exceptions logs write file
|booléen
|Un fichier d'exception est écrit. Vrai par défaut. Il peut être inutile d'écrire un fichier d'exception si les exceptions sont transmises à un gestionnaire de log (voir LOG MANAGER) et permet dans ce cas ne ne pas encombrer le disque.(V8)
|}

====Captcha====

Dans le cadre d'un service public, les utilisateurs souhaitant s'enregistrer peuvent être soumis à un captcha.

Si l'utilisateur commet trois erreurs lors de l'authentification, il devra saisir un captcha.

voir http://www.google.com/recaptcha

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Recaptcha Public Key
|string
|Clef publique Recaptcha
|-
|Recaptcha Private Key
|String
|Clef privée Recaptcha
|}

====Quotas====

Dans le cadre d'un service public, les utilisateurs téléversent des fichiers dans un répertoire propres à la session.

Ces fichiers doivent avoir une extension prévue pour des questions de sécurité.

La taille totale du répertoire est définie pour éviter un manque de place sur le disque.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Upload Document Size
|integer
|Taille maximale en Mb d'un fichier uploadé; valeur par défaut : 0 (non limité)
|-
|Upload User Quota
|integer
|Taille maximale en Mb du répertoire upload de l'utilisateur par session; valeur par défaut : 50
|-
|Upload Ext Allowed
|String
|Extensions autorisées; valeur par défaut : vide (tout est autorisé)
|-
|Auto delete messages
|Entier
|Durée de conservation en jours des messages
|}

{{tip|La liste des extensions suivantes n'est jamais filtrée car le service est susceptible de créer des fichiers de ce type (xlsx,ods,xml,pdf,,csv,sxc,xls,,jpg,jpeg,png,asice)}}

====Clefs====

Le stockage de certaines clefs peut être externalié

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Key Cookie
|chaine
|[[keyvault_url|url d'un stockage sécurisé externe]], si la clef est non trouvée, elle y sera créée
|}

====Logs====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Log keep days
|entier
|durée en jour de rétention des fichiers dans le répertoire de log, par défaut 10
|-
|SDATA Log Messages
|Logique
|Enregistre les messages SDATA dans le répertoire de log
|}

===Sections SDATA===
Ces sections permettent de configurer les points d'accès SDATA qui seront exposés par le service.

Les noms de ces sections sont

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\<<nom du service>>\SData\<<incrément 1...>>]

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|DataSetName
|string
|Nom du dataset dans l'URL SDATA
|-
|Title
|string
|Libellé informatif sur l'usage du point d'accès
|-
|Contract
|string
|Nom du paquet de service SDATA
|-
|Version
|string
|Numéro de version, peut être utilisé pour supporté plusieurs version du même contrat
|-
|Folder
|string
|Nom du dossier utilisé par ce point d'accès
|-
|Database
|string
|Nom de la base de donnée utilisé pour ce point d'accès (multi-bases)
|-
|Society
|string
|Nom de la société pour ce point d'accès (multi-société)
|-
|Restitution
|string
|Nom de la famille de restitution pour ce point d'accès (multi-société)
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\SData\1]
DataSetName=iphone
Title=syfre iphone
Contract=ndfContract
Version=1
Folder=Test Syfre iPhone
Database=dbTestIPhone
Society=
Restitution=
</pre>

===Section Export===
Cette section permet de configurer la fonction d'exportation des vignettes de portail des Services.

Deux mode d'exportation sont possibles :

*ftp
: Dans ce mode les vignettes sont générées et copiées dans un répertoire public accessible par ftp.

*file
: Dans ce mode les vignettes sont générées et copiées dans un répertoire local du serveur. Ce mode n'est utile que si le répertoire est un répertoire du Site et que celui-ci est public.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Protocol
|String
|ftp ou file
|-
|Export URL
|String
|Cette URL référence le répertoire où la vignette a été générée.
|}

Si le protocole est 'ftp' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP host
|String
|Addresse du serveur FTP
|-
|FTP Port
|Integer
|Numéro du port du serveur FTP
|-
|FTP Login
|String
|Utilisateur de connexion du serveur FTP
|-
|FTP Password
|String
|Mot de passe de connexion du serveur FTP
|-
|FTP Directory
|String
|Répertoire d'exportation sur le serveur FTP
|}

Si le protocole est 'file' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Directory
|String
|Répertoire d'exportation sur le serveur.
|}

Exemple de configuration ftp utilisant une zone publique Free :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\Export]
Protocol=ftp
Export URL=http://syfre.free.fr/sage/
FTP Host=ftpperso.free.fr
FTP Port=21
FTP Login=syfre
FTP Password=XXXXXXXXXX
FTP Directory=sage
</pre>

===Section ConfigServer===

Cette section permet d'utiliser un fichier de configuration disponible sur une url.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|url
|String
|Cette URL permet de récupérer le fichier de configuration.
|}

Un POST HTTP est effectué sur cette url avec les données suivantes :

<source lang="javascript">
{"deploymentId":"nom_système_de_la_machine"}
</source>

Le résultat attendu est

<source lang="javascript">
{"config":"contenu_du_fichier_de_configuration"},
{"certificate":"certificat_au_format_pfx"}
</source>

*[[Exemple de configuration (server)|Exemple de configuration]]
*[[Service_1000_(server)|Ligne de commande]]

{{Footer|Serveur}}
[[category:Serveur]]

Fichier de configuration (server)

2026-03-02T07:29:10Z

Syfre : /* Mise au point, debugger {{Version700}} */

===Introduction===
Le Serveur d'application Sage 1000 utilise un fichier de configuration situé dans le répertoire du serveur.

{{info|Le nom du fichier est serverl1000.ini}}

Ce fichier peut être soit modifié à l'aide de la console d'administration des services, soit manuellement par un éditeur de texte.

{{tip|Le fichier est chargé au démarrage du service.}}

===Structure===
Le fichier peut configurer plusieurs services exécutés sur le même serveur, chaque service comporte au moins deux sections :

* [\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SERVICE_NAME]
: Cette entrée détermine la configuration réseau du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE]
: Cette entrée détermine la configuration logicielle du service.

* [\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SERVICE\Export]
: Cette entrée configure la fonction d'exportation du service.

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\MYSERVICE]
ipcMode=ipcSHM
tcpPort=8090
shmAddress=SYFRE

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\MYSERVICE]
Master base=orasql://myhost/DBMASTER_ORA?prefix="DBMASTERT_ORA."
Master driver=orasql
Master OS Authentication=0
Master user=DBMASTER_ORA
Master password=DBMASTER_ORA
Server Societies=Société de démonstration GCF 1000
Server Application=Sage 1000 Suite Financière
...
</pre>

Chaque section est composée d'une liste de variables (NomVariable=ValeurVariable), les types de données des variables sont :

{|class="wikitable"
|-
!Variable
!Type
|-
|String
|Chaîne de caractère
|-
|Boolean
|Valeur logique 0:Non 1:Oui
|-
|Integer
|Valeur entière
|-
|Liste de chaîne
|Liste de chaîne de caractère séparée par des virgules.
|}

===Section IPC===

{|class="wikitable"
|-
!Variable
!Type
!Contexte
!Usage
|-
|ipcMode
|enumération
|Client/Serveur
|
*ipcTCP
:Mode de communication par TCP/IP
*ipcSHM
:Mode de communication par mémoire partagée (dépréciée)
|-
|tcpPort
|Integer
|Client/Serveur
|Port de communication TCP
|-
|tcpAddress
|string
|Client/Serveur
|Adresse de communication TCP
|-
|shmAddress
|string
|Client/Serveur
|Nom du segment de mémoire partagé
|-
|serverList
|Serveur
|String list
|Configuration de Cluster 
Liste des services associés à cet identifiant de service.
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\TRESO]
ipcMode=ipcTCP
tcpPort=8090
tcpAddress=localhost
</pre>

Exemple de configuration Cluster :

'''fichier du configuration des services :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

'''fichier du configuration du client HTTP :'''

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE]
serverList=SYFRE1,SYFRE2

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE1]
ipcMode=ipcTCP
tcpPort=8091
tcpAddress=syfre

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\SYFRE2]
ipcMode=ipcTCP
tcpPort=8092
tcpAddress=syfre
</pre>

===Section Servers===
====IPC====
Ces variables configurent la gestion des services IPC.

La configuration des services IPC peut être renseignée dans une section IPC

[\SOFTWARE\Sage\Ligne 1000\Administration\IPC\nom_de_profil]

puis référencée par la variable "IPC Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|IPC Profil
|String
|Référence un nom de section IPC contenant la configuration
|-
|IPC Started
|boolean
|Démarre les services IPC (défaut true)
|}

Les services IPC sont les services permettant de communiquer via RPC.

Vous avez besoins des services IPC si :
* Vous utilisez un serveur HTTP externe (IIS ou Apache).
* Vous utilisez la Console des Processus Métiers pour dialoguer avec ce Service.
* Vous utilisez le Contrôleur des services.
* Ce Service exécute des tâches de traitement déléguées par un autre Service.

Si vous n'utilisez pas les services IPC il est conseillé de ne pas les démarrer.

{{tip|Ce paramètre n'est pas modifiable depuis la console des services car si vous désactivez les services IPC le contrôleur n'est plus opérationnel}}

====Sessions====
Ces variables configurent la gestion des sessions.

La configuration des sessions peut être renseignée dans une section SESSIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\SESSIONS\nom_de_profil]

puis référencée par la variable "SESSIONS Profil"

{|class="wikitable"
|-
!Variable
!Type
!Défaut
!Min
!Usage
|-
|SESSIONS Profil
|String
|
|
|Référence un nom de section SESSIONS contenant la configuration
|-
|CheckInterval
|Entier
|1 minute
|1 minute
|Délai entre chaque test d'expiration en seconde.
|-
|ExpireInterval
|Entier
|15 minutes
|
|Délai d'expiration des sessions en seconde.
|}

====Base master====
Ces variables configurent la base Master utilisée par le service.

La configuration de la base master peut être renseignée dans une section MASTER

[\SOFTWARE\Sage\Ligne 1000\Administration\MASTER\nom_de_profil]

puis référencée par la variable "Master Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Master Profil
|String
|Référence un nom de section MASTER contenant la configuration
|-
|Master base
|String
|Nom de la base de données Master
|-
|Master driver
|String
|Nom du driver de la base de données Master
|-
|Master OS Authentication
|Boolean
|Utiliser l'authentification du système d'exploitation.
|-
|Master user
|String
|Nom d'utilisateur utilisé pour la connexion à la base Master
|-
|Master password
|String
|Mot de passe utilisé pour la connexion à la base Master
|}

====Application et Sociétés====
Ces variables configurent l'application et les sociétés servies par le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Societies
|String
|
|Liste des sociétés/dossiers servies par le service.
|-
|Server Application
|String
|
|Nom de l'application servie par le service.
|-
|Server User
|String
|
|Nom de l'utilisateur du service.
|-
|Server Password
|String
|
|Mot de passe de l'utilisateur du service.
|-
|Server User Group
|String
|
|Nom du groupe de l'utilisateur du service.
|-
|Server Authentication
|String
|
|Annuaire utilisé pour l'authentification.
|-
|Authentication Directories
|liste de chaîne
|8.00
|Annuaires disponibles pour ce service.(code des annuaires séparés par ";")
|}

====Service====
Ces variables configurent le service.

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Server Name
|String
|
|Nom du service.
|-
|Cache Folder
|String
|
|Répertoire où stocker les fichiers temporaires et les fichiers en cache.
|-
|[[Zone publique (server)|Public Folder]]
|String
|
|[[Zone_publique_(server)|Racine des répertoires partagés du service]].
|-
|[[Public links (server)|Public Links]]
|Liste de chaîne
|
|Liste de répertoires réseaux (séparés par un ;) pour lesquels des [[Stockage_des_documents|documents peuvent être associés]].
|-
|Send Alert To
|String
|
|Liste d'adresses emails (séparées par un ;) auxquelles seront envoyés les messages d'alertes.
|-
|Scripts
|Liste de chaîne
|
|Liste de références CSS ajouté aux pages HTML
|-
|MaxDatagridRowCount
|Integer
|
|Limite le nombre de lignes affichées dans les grilles (par défaut à 10 000).
|-
|[[Security mode (server)|Security Mode]]
|String
|7.00
|Valeurs possibles : Intranet (valeur par défaut) / Internet [[Service_exposé_sur_internet|Voir Service exposé sur internet]]
|-
|Enable Remember User
|boolean
|7.10
|Permet à l'utilisateur d'avoir son nom pré-renseigné dans la page d'authentification (par défaut à vrai)
|-
|MaxPreviewPageCount
|Integer
|
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview max page
|Integer
|10.00
|Limite le nombre de pages affichées dans les aperçus des éditions (par défaut à 50).
|-
|Preview blocking
|Boolean
|10.00
|1:Les aperçus sont affichés directement en onglet 0:les aperçus sont envoyés dans la bam.
|-
|Preview timeout
|Integer
|10.00
|Délai d'attente de fin d'aperçu si Preview blocking=1.
|-
|Printer Filter
|chaine
|
|Noms des imprimantes à ne pas proposer, séparées par des points virgules (9.20)

|}

====Automates====
Ces variables configurent le serveur d'automate inclus dans le serveur.

Ces variables peuvent être renseignées dans une section AUTOMATE

[\SOFTWARE\Sage\Ligne 1000\Administration\AUTOMATE\nom_de_profil]

puis référencées par la variable "Automate Profil"

{|class="wikitable"
|-
!Variable
!Type
!Version
!Usage
|-
|Automate Profil
|String
|
|Référence une section AUTOMATE.
|-
|Automate Started 
Process Server Started
|Boolean
|
|Démarre le serveur d'automate. (défaut) (*) 
|-
|Automate Name 
Process Server Name
|String
|
|Nom du serveur d'automate à démarrer. (*)
|-
|Automate Message Box 
Process Server Message Box
|String
|
|Boite à messages utilisé par le serveur d'automate.
|-
|Automate Task Service 
Process Task Service
|String
|
|Nom du Service 1000 exécutant les tâches du serveur d'automate.(hostname.servicename)
|-
|Automate Task Count 
|Integer
|6.50
|Nombre maximal de tâches automates simultanées (défaut 1).
|-
|Automate Debug 
|Boolean
|7.00 Patch
|Active le mode debug verbose (**).
|}

{{Version700}} (*) Ces valeurs peuvent être modifiées sur la ligne de commande

{{Version700}} (**) A utiliser conjointement avec la console de trap snmp

====Processus métiers====
Ces variables configurent le service de Processus Métiers inclus dans le serveur.

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|BP Started
|Boolean
|Démarre le service de Processus Métiers (défault).
|}

{{Version700}} Cette valeur peut être modifiée sur la ligne de commande

====Système====
Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PROCESS

[\SOFTWARE\Sage\Ligne 1000\Administration\PROCESS\nom_de_profil]

puis référencée par la variable "Process Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Process Profil
|string
|Référence une section PROCESS
|-
|ProcessAffinity
|String
|Détermine les coeurs utilisés par le processus sur une machine multi-coeurs 
ex : 1,3 pour utiliser les coeurs 1 et 3 d'une machine multi-coeurs.
|-
|ThreadPoolSize
|Integer
|Taille du pool de thread (20)
|-
|FormCacheSize
|Integer
|Taille du cache pour un écran (défaut:20, 0:désactive l'utilisation du cache)
|-
|FormCacheLimit
|Integer
|Taille du cache pour l'ensemble des écrans (256)
|-
|FormCacheReuse
|Integer
|Nombre de fois qu'un écran peut être réutilisé (-1 : pas de limite)
|}

*ProcessAffinity
:Le Processus du serveur est un processus multi-threadé, sur une machine multi-coeurs il utilise tous les coeurs disponibles sur le système d'exploitation. Dans certain cas il est souhaitable de restreindre l'exécution à certains coeurs.

*ThreadPoolsize
:Chaque requête sur le service est exécutée par une thread allouée d'un pool ; lorsque le pool est plein la requête est suspendue jusqu'à ce qu'une thread se libère dans le pool. Cette variable limite la taille du pool de thread et par conséquence limite les contentions et les "context switches" provoqués par le processus.

*FormCacheSize
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre d'instance d'un écran dans le cache.

*FormCacheLimit
:L'opération d'ouverture d'un écran est une opération coûteuse, pour cette raison les écrans fermés sont placés dans un cache pour être réutilisés. Cette variable limite le nombre maximal d'écran dans le cache et par conséquent la mémoire utilisée par le cache d'écran.

*FormCacheReuse
:Indique le nombre de fois qu'un écran en cache peut être réutilisé.

{{info|Pour pouvoir utiliser WMI la dll serviceL1000perf.dll doit être présente dans le répertoire du serveur.}}
{{info|Pour désactiver le cache, définir la valeur de FormCacheSize à 0}}

====Files d'attente====
Ces variables configurent le service de consommation de file d'attente.

Ces variables peuvent être renseignées dans une section PERF.

[\SOFTWARE\Sage\Ligne 1000\Administration\QUEUELISTENER\nom_de_profil]

puis référencée par la variable "Queue listener Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Queue listener Started
|Boolean
|Démarre le service de consommation de file d'attente.
|-
|Queue listener queues
|Liste de chaînes séparées par des ,
|Liste des files d'attente à consommer.
|-
|Queue listener Task count
|Entier
|Nombre maximal de tâches simultanées par service.
|}

Les paramètres de scrutation d'une file d'attente peuvent être configurés à la suite du nom de la file d'attente en séparant les paramètres par un caractère ":"

{|class="wikitable"
|-
!Paramètre
!Valeur par défaut (ms)
!Usage
|-
|Initial
|1000
|Délai initial de scrutation (ms)
|-
|Max
|10000
|Délai maximal de scrutation (ms)
|-
|Increment
|1000
|Incrément du délai jusqu'au délai maximal si aucun message n'est disponible (ms)
|}

Exemple :
<pre>
Queue listener queues=MyQueue1:2000:10:20000,MyQueue2,MyQueue3:100:10:1000
</pre>

Avec les valeurs par défaut, une file d'attente est lue initialement toutes les secondes, puis si aucun message n'est reçu, ce délai monte jusqu'à 10 secondes. Lorsque un message est reçu le délai est réinitialisé à 1 seconde et ainsi de suite.

====Compteurs de performance====

Ces variables configurent le Processus du serveur.

Ces variables peuvent être renseignées dans une section PERF

[\SOFTWARE\Sage\Ligne 1000\Administration\PERF\nom_de_profil]

puis référencée par la variable "Performance Counters Profil"

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|Start Performance Counters
|Boolean
|Démarre les compteurs de performance
|-
|Start Performance Clock
|Boolean
|Démarre l'horloge de performance
|-
|Performance Clock Delay
|Cardinal
|Période de l'horloge de performance (ms)
|-
|HTTP PerfServer Start
|Boolean
|Démarre le serveur HTTP de performance
|-
|HTTP PerfServer Port
|Integer
|Port du serveur HTTP de performance
|-
|HTTP PerfServer Protocol
|String
|Protocole du serveur HTTP de performance
|}

*Start Performance Counters
:Le serveur inclus un certain nombre de [[Compteurs de performance (monitoring)|compteurs de performance]] interrogeables par le [[Serveur de performance (monitoring)|serveur de performance]].

*Start Performance Clock
: Démarre une horloge permettant de générer un évènement de monitoring.

*Performance Clock Delay
: Période de l'horloge de performance. (défaut 1000)

*HTTP PerfServer Start
: Démarre le server HTTP de performance.

*HTTP PerfServer Port
: Port du serveur HTTP de performance. (défaut 9999)

*HTTP PerfServer Protocol
:Protocole du serveur HTTP de performance (défaut http)

Voir la catégorie [[:Category:Monitoring]]

====HTTP====
Ces variables peuvent être renseignées dans une section HTTP

[\SOFTWARE\Sage\Ligne 1000\Administration\HTTP\nom_de_profil]

puis référencée par la variable "HTTP Profil"

Les variables suivantes configurent le protocole HTTP utilisé par le service, elles sont utilisées pour construire des URL pointant sur le service.

{|class="wikitable"
|-
!Nom de variable
!Type
!Version
!Par défaut
!Usage
|-
|HTTP Protocol
|String
|Toute
|http:
|Protocole HTTP publique du Service (http: ou https:)
|-
|HTTP Port
|Integer
|Toute
|80
|Port HTTP publique du Service
|-
|HTTP HostName
|String
|Toute
|Nom local de la machine
|Domaine publique du serveur HTTP frontal
|-
|HTTP ServiceName
|String
|6.51
|Nom du service
|
Nom du service load-balancé utilisé par le service 
Ce nom peut différer du nom du service dans une configuration load balancée. 
C'est ce nom qui est enregistrée dans les URLs de la registry SDATA 
Implémenté pour SOAP à partir de la version 7 
|}

Les variables suivantes configurent [[Serveur HTTP (server)|le service HTTP interne]] inclus dans le serveur.

{{Version700}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP Started
|boolean
|Démarre le serveur HTTP
|-
|HTTP Listen Protocol
|String
|Protocole HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le protocole est défini par HTTP Protocol
|-
|HTTP Listen Port
|Integer
|Port HTTP écouté par le serveur HTTP embarqué 
Si cette variable n'est pas défini le port est défini par HTTP Port
|-
|HTTP Site
|String
|Répertoire du site utilisé par le serveur HTTP
|-
|HTTP Alias
|String
|Nom de section des alias de répertoire du serveur HTTP
|-
|HTTP CertFile
|String
|Si le protocole est https, représente le fichier certificat (.pem)
|-
|HTTP RootCertFile
|String
|Si le protocole est https, représente le fichier certificat de l'autorité intermédiaire qui a signé le certificat "CertFile" (.pem). 
Ce paramètre est optionnel, il est utile si l'autorité intermédiaire n'est pas directement reconnue par le navigateur.
|-
|HTTP KeyFile
|String
|Si le protocole est https, représente le fichier clef privée (.pem ou .key) qui est liée au certificat
|-
|HTTP KeyPassword
|String
|Si le protocole est https, représente le mot de passe qui permet de décoder la clef privée
|-
|HTTP CertIssuer
|String
|Si le protocole est https, représente l'émetteur du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP CertSerial
|String
|Si le protocole est https, représente le numéro de série du certificat du site permettant de l'identifier dans le magasin Windows
|-
|HTTP SSLVersion
|String
|Version du protocole SSL à utiliser: sslvTLSv1_1, sslvTLSv1_2, sslvTLSv1_3 (par défaut :sslvTLSv1_2)
|-
|HTTP SSLCipherList
|String
|Sceaux proposés par le serveur (par défaut "HIGH:!aNULL:!MD5:!RC4") [https://www.openssl.org/docs/manmaster/apps/ciphers.html en savoir plus] Version 7.10
|-
|HTTP KeepAlive
|Boolean
|Détermine la valeur du paramètre KeepAlive des réponses du serveur HTTP. 
La valeur est True (1) par défaut et le serveur renvoi KeepAlive dans ses réponses. 
Cette valeur doit être false (0) pour une configuration load balancée.
|-
|HTTP Private Started
|Boolean
|Permet de démarrer un service http "privé", utile dans le cadre d'une configuration load balancée. 
Ce service n'est adressé que par les autres services, et permet d'économiser la partie SSL des échanges. 
Le port de ce service ne doit pas être exposé au clients web.
|-
|HTTP Private Port
|Integer
|Détermine la valeur du port http privé.
|-
|HTTP Log
|Booléen
|Active la journalisation des flux http (Version 10)
|}

{{tip|TLS 1.3 supporté à partir de la version 10 en utilisant OpenSSL 3.0}}

{{tip|Le protocole/port publique peuvent être différent du protocole/port d'écoute si un load balancer est utilisé.}}

Voir aussi :
* [[Serveur HTTP (server)|Serveur HTTP interne]]
* [[Configuration_du_Serveur_HTTPS|Configuration du serveur en HTTPs]]
* [[Configuration_du_Serveur_HTTP_derrière_un_répartiteur_de_charge|Configuration derrière un répartiteur de charge]]

Certains de ces paramètres peuvent être remplacés par [[Service_1000_(server)|les paramètres de la ligne de commande]] :

{|class="wikitable"
|-
!Paramètre
!Paramètre de la ligne de commande
|-
|HTTP Listen Port
|HTTPPORT
|-
|HTTP KeepAlive
|HTTPKEEPALIVE
|}

====HTTP ACLs====
{{version710}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP ACL
|string
|Liste de règles séparées par une virgule, par ordre de priorité
|}

La syntaxe d'une règle ACL :
<pre>
action-IP/Nob
</pre>

*action
: Type de règle, doit être accept ou deny
*IP
: Addresse IP en notation pointé
*Nob (facultatif)
:Nombre de bits du masque de sous réseau, par exemple 29 correspond au masque 255.255.255.248 et défini un sous réseau de 8 adresses.

[http://jodies.de/ipcalc Calculateur de masque]

Exemple 1 :

Autorise les adresses 192.168.1.0 ... 192.168.1.7 à l’exception de 192.168.1.5

<pre>
deny-192.168.1.5
accept-192.168.1.0/29
</pre>

Exemple 2 :

Autorise seulement l'adresse 192.168.1.1

<pre>
accept-192.168.1.1
deny-0.0.0.0/0
</pre>

====HTTP Web Worker====
{{version800}}

Le Web Worker est un mécanisme de notification asynchrone permettant au client Web d'être notifié des événements survenant coté serveur.

Il permet de gérer les notifications de boîte à message ainsi que les notifications de traitement.

L'utilisation du web worker améliore l'expérience utilisateur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web worker started
|Integer
|Active (1) ou désactive (0) l'utilisation du web worker
|}

{{Tip|Lorsque le web worker est activé, le client génère des requêtes msg.pending périodiques.}}

====HTTP Web Socket====
{{version800}}

Les WebSockets utilisent un protocole permettant de créé des canaux de communication full-duplex à l'intérieur d'une connexion TCP.

L'utilisation des WebSockets améliore l'expérience utilisateur par une meilleur fluidité des échanges.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Web socket started
|Integer
|Active (1) ou désactive (0) l'utilisation de WebSocket
|}

{{Tip|

#Les WebSocket ne sont prises en charge que par le serveur HTTP embarqué et en mode '''HTTPs uniquement'''.
#Les WebSockets sont activées par défaut.
#Les WebSocket peuvent ne pas fonctionner ou provoquer des problèmes dans le cas d'utilisation du serveur Sage 1000 derrière un load balancer qui ne supporterait pas le protocole WebSocket.
#L'url utilisée doit correspondre au domaine du certificat SSL. Par exemple, en entreprise, si votre serveur est myhost sur le domaine interne xxx.yyy.zzz le nom de domaine du certificat auto-généré sera myhost.xxx.yyy.zzz. Vous devez utiliser https://myhost.xxx.yyy.zzz comme url d'accès même si https://myhost est valide sur votre réseau. A défaut l'établissement des connexions websockets échoueront.}}

{{Tip|Lorsque les websockets sont actives, le dialogue d'attente n'est pas affiché.}}

====HTTP CSP====
La [https://developer.mozilla.org/fr/docs/Web/HTTP/CSP stratégie de sécurité du contenu] permet d'améliorer la sécurité des sites web.

{{version1000}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CSP
|Liste de chaines
|Liste des règles séparées par ";"
|}

Exemple

HTTP CSP = default-src 'self'; script-src https://example.com

La valeur par défaut est ''default-src 'self'''

====HTTP CORS====
Le [https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS CORS] permet d'autoriser des requêtes provenant d'autre domaine.

{{version800}}
{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|HTTP CORS Allow origin
|Liste de chaines
|Liste des domaines autorisés
|}

La liste des domaines doit être séparée par des virgules, utilisez * pour autoriser tous les domaines.

Les domaines doivent être qualifié par le protocole, par exemple http://origin.com

Les domaines indiqués ici seront comparés à la valeur du champ d'entête Origin

Lorsque le domain est autorisé, le service retourne dans la réponse :

{| class="wikitable"
|-
!Champ
!Valeur
|-
|Access-Control-Allow-Origin
|Valeur du chanmp Origin de la requête
|-
|Vary
|Origin
|-
|Access-Control-Allow-Credentials
|true
|-
|Access-Control-Allow-Methods
|POST,PUT,DELETE,GET,OPTION
|-
|Access-Control-Allow-Headers
|Valeur de Access-Control-Request-Headers de la requête
|-
|Access-Control-Max-Age
|86400
|}

====FTPs====
Ces variables configurent le serveur FTPs inclu dans le servcice.
Le serveur FTP peut être utilisé sur les containeurs.

[\SOFTWARE\Sage\Ligne 1000\Administration\FTP\nom_de_profil]

puis référencée par la variable "FTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP Profil
|string
|Référence une section FTP
|-
|FTP Start
|1 ou 0
|Démarre le service FTP
|-
|FTP ACL
|Chaîne
|Définit une liste d'ACL optionnelle
|}

====WEB====
Ces variables configurent le service WEB inclu dans le service.

Ces variables peuvent être renseignées dans une section WEB

[\SOFTWARE\Sage\Ligne 1000\Administration\WEB\nom_de_profil]

puis référencée par la variable "WEB Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|WEB Profil
|string
|Référence une section WEB
|-
|MaxDatagridRowCount
|Entier
|Détermine le nombre maximal de lignes chargées dans une grille (défaut 5000)
|-
|GridWindowSize
|Entier
|Détermine le nombre maximal de lignes affichées dans une page de grille. (Défaut 25)
|-
|MDIForms
|1 ou 0
|Défaut 0
|-
|MDIAssistants
|1 ou 0
|Défaut 1
|-
|UseTreeBookClassic
|1 ou 0
|Défaut 0
|-
|SavePortalTabForms
|1 ou 0
|Défaut 1
|-
|DebugJS
|1 ou 0
|Utilise les javascript en mode debug (Défaut 0)
|-
|RecordMode
|1 ou 0
|Active le mode enregistrement pour JMeter (Défaut 0)
|-
|FormRedirect
|1 ou 0
|Active la redirection des urls d'écran, pour IIS cette redirection doit être désactivée. (défaut 1, ativé)
|}

====Export de grille ====

{{Version2025r2}}

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Grid exporters
|liste de nom d'extension de fichier séparés par une virgule
|Défini les formats d'export autorisés
|-
|Grid export limits
|Entier
|Limite le nombre de lignes exportées
|}

====Mise au point, debugger {{Version700}}====
Ces variables configurent le remote debugger inclus dans le service.

Le remote debugger permet à un poste client desktop de visualiser, modifier et poser des points d'arrêt dans le code métier exécuté par le service.

Ces variables peuvent être renseignées dans une section DEBUGGER

[\SOFTWARE\Sage\Ligne 1000\Administration\DEBUGGER\nom_de_profil]

puis référencée par la variable "DEBUGGER Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|DEBUGGER Profil
|string
|Référence une section DEBUGGER
|-
|DEBUGGER Started
|Boolean
|Démarre le service de Remote debugging
|-
|DEBUGGER Users
|Strings
|Liste des utilisateurs autorisés à utiliser le service de remote debugging
|-
|DEBUGGER Handlers
|Strings
|Liste des handlers des évènements de trace qui seront interceptés et redirigés vers le journal d'évènement, ceci vous permet de visualiser en temps réel ces traces dans la console SNMP. Les handlers possibles sont:
* script
: Evènements générés par la fonction dbgMsg() du code métier
* queries
: Evènements de trace des requêtes SQL
|}

{{warning|L'utilisation de DEBUGGER Handlers peut provoquer une forte consommation de mémoire}}
{{warning|Ces fonctionnalités ne doivent pas être activés sur un serveur de production}}

====LDAP====
Ces variables configurent le serveur LDAP inclus dans le service.

Ces variables peuvent être renseignées dans une section LDAP

[\SOFTWARE\Sage\Ligne 1000\Administration\LDAP\nom_de_profil]

puis référencée par la variable "LDAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|LDAP Profil
|string
|Référence une section LDAP
|-
|LDAP Started
|Boolean
|Démarre le service LDAP (défaut false).
|-
|LDAP Port
|Integer
|Port d'écoute du service LDAP
|-
|LDAP Password
|String
|Mot de passe administrateur du compte system du serveur LDAP ('uid=admin,ou=system')
|}

====SAML====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SAMLv2 Log=1
|Boolean
|Active la trace SAML (à retirer une fois la mise au point effectuée)
|}

====SOAP====
Ces variables configurent le service SOAP inclus dans le serveur.

Ces variables peuvent être renseignées dans une section SOAP

[\SOFTWARE\Sage\Ligne 1000\Administration\SOAP\nom_de_profil]

puis référencées par la variable "SOAP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SOAP Profil
|string
|Référence une section SOAP
|-
|SOAP Log Documents
|Boolean
|Active la journalisation des documents SOAP
|-
|SOAP Log Messages
|Boolean
|Active la journalisation des messages SOAP
|-
|SOAP 5.5x
|Boolean
|Utilise l'implémentation SOAP des versions 5.5x
|}

*SOAP 5.5x
:L'implémentation de SOAP a été récrite en version 5.6x, en cas de problème de compatibilité avec des développements existant il est possible d'utiliser l'ancienne implémentation.

====SMTP====
Ces variables configurent le client SMTP utilisé par le service pour envoyer des EMails.

Ces variables peuvent être renseignées dans une section SMTP

[\SOFTWARE\Sage\Ligne 1000\Administration\SMTP\nom_de_profil]

puis référencés par la variable "SMTP Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SMTP Profil
|string
|Référence une section SMTP
|-
|SMTP Host
|String
|Adresse du serveur SMTP.
|-
|SMTP Port
|Integer
|Port du serveur SMTP.
|-
|SMTP Login
|String
|Utilisateur de connexion du serveur SMTP.
|-
|SMTP Password
|String
|Mot de passe de connexion du serveur SMTP.
|-
|SMTP From
|String
|Adresse EMail de l'expéditeur.
|-
|SMTP UseTLS
|Boolean
|Utilise une sécurisation TLS
|}

====SNMP====
Ces variables peuvent être renseignées dans une section SNMP

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\nom_de_profil]

puis référencés par la variable "SNMP Profil"

Ces variables configurent l'agent SNMP inclus dans le serveur.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Profil
|string
|Référence une section SNMP
|-
|SNMP Started
|Boolean
|Démarre l'agent SNMP
|-
|SNMP Port
|Integer
|Port UDP de l'agent SNMP (161)
|-
|SNMP sysName
|String
|Valeur de la variable sysName pour la MIB2
|-
|SNMP sysContact
|String
|Valeur de la variable sysContact pour la MIB2
|-
|SNMP sysLocation
|String
|Valeur de la variable sysLocation pour la MIB2
|-
|SNMP Traps
|liste de chaîne
|Référence des sections SNMPTRAP
|}

Les sections SNMPTRAP permettent de définir des points d'écoute SNMP auquels seront envoyés les messages de traps.

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\nom_de_profil]

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|SNMP Trap Host
|string
|Nom réseau du point d'écoute
|-
|SNMP Trap Port
|Integer
|Numéro du port du point d'écoute
|-
|SNMP Trap Categories
|Liste de chaîne
|Catégories des traps à envoyer à ce point d'écoute 
|}

La liste des catégories de trap est la suivante :

{|class="wikitable"
|-
!Nom de catégorie
!Type de message
|-
|Service
|Messages relatifs au processus du service.
|-
|Automate
|Messages relatifs aux exécutions de l'automate.
|-
|BP
|Messages relatifs aux exécutions des Processus métiers.
|-
|Authenticate
|Messages relatifs aux erreurs d'authentification.
|}

Exemple de configuration SNMP :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\SNMP\CONFIG_SNMP_1]
SNMP Started=1
SNMP Start=1
SNMP Port=161
SNMP sysContact = toto@sage.com
SNMP sysName = toto
SNMP sysLocation = Paris,France
SNMP Traps=Service,Automate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Service]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Service,Authenticate

[\SOFTWARE\Sage\Ligne 1000\Administration\SNMPTRAP\Automate]
SNMP Trap Host=localhost
SNMP Trap Port=162
SNMP Trap Categories=Automate,BP
</pre>

====PROXY====

{{tip|Déprécié, utiliser le paramétrage dans la console d'administration.}}

Ces variables configurent le PROXY utilisé par le client HTTP.

Ces variables peuvent être renseignées dans une section PROXY

[\SOFTWARE\Sage\Ligne 1000\Administration\PROXY\nom_de_profil]

puis référencée par la variable "PROXY Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|PROXY Profil
|string
|Référence une section PROXY
|-
|PROXY Host
|String
|Adresse du serveur PROXY.
|-
|PROXY Port
|Integer
|Port du serveur PROXY (défaut 8080).
|-
|PROXY Login
|String
|Utilisateur de connexion du serveur PROXY.
|-
|PROXY Password
|String
|Mot de passe de connexion du serveur PROXY.
|-
|PROXY Timeout
|Integer
|Délai d'expiration du PROXY. (défaut 60 secondes)
|}

====Exceptions====
Ces variables configurent l'enregistrement des exceptions du service.

Ces variables peuvent être renseignées dans une section EXCEPTIONS

[\SOFTWARE\Sage\Ligne 1000\Administration\EXCEPTIONS\nom_de_profil]

puis référencées par la variable "Exceptions logs Profil"

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Exceptions logs Profil
|string
|Référence une section EXCEPTIONS
|-
|Exceptions logs Started
|boolean
|Enregistrer les exceptions. Vrai par défaut.
|-
|Exceptions logs path
|String
|Répertoire dans lequel seront créés les fichiers d'exception.
|-
|Exceptions logs ignore
|Liste de chaîne
|Liste d'exception à ignorer.
|-
|Exceptions logs write file
|booléen
|Un fichier d'exception est écrit. Vrai par défaut. Il peut être inutile d'écrire un fichier d'exception si les exceptions sont transmises à un gestionnaire de log (voir LOG MANAGER) et permet dans ce cas ne ne pas encombrer le disque.(V8)
|}

====Captcha====

Dans le cadre d'un service public, les utilisateurs souhaitant s'enregistrer peuvent être soumis à un captcha.

Si l'utilisateur commet trois erreurs lors de l'authentification, il devra saisir un captcha.

voir http://www.google.com/recaptcha

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Recaptcha Public Key
|string
|Clef publique Recaptcha
|-
|Recaptcha Private Key
|String
|Clef privée Recaptcha
|}

====Quotas====

Dans le cadre d'un service public, les utilisateurs téléversent des fichiers dans un répertoire propres à la session.

Ces fichiers doivent avoir une extension prévue pour des questions de sécurité.

La taille totale du répertoire est définie pour éviter un manque de place sur le disque.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Upload Document Size
|integer
|Taille maximale en Mb d'un fichier uploadé; valeur par défaut : 0 (non limité)
|-
|Upload User Quota
|integer
|Taille maximale en Mb du répertoire upload de l'utilisateur par session; valeur par défaut : 50
|-
|Upload Ext Allowed
|String
|Extensions autorisées; valeur par défaut : vide (tout est autorisé)
|-
|Auto delete messages
|Entier
|Durée de conservation en jours des messages
|}

{{tip|La liste des extensions suivantes n'est jamais filtrée car le service est susceptible de créer des fichiers de ce type (xlsx,ods,xml,pdf,,csv,sxc,xls,,jpg,jpeg,png,asice)}}

====Clefs====

Le stockage de certaines clefs peut être externalié

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Key Cookie
|chaine
|[[keyvault_url|url d'un stockage sécurisé externe]], si la clef est non trouvée, elle y sera créée
|}

====Logs====

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Log keep days
|entier
|durée en jour de rétention des fichiers dans le répertoire de log, par défaut 10
|}

===Sections SDATA===
Ces sections permettent de configurer les points d'accès SDATA qui seront exposés par le service.

Les noms de ces sections sont

[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\<<nom du service>>\SData\<<incrément 1...>>]

{|class="wikitable"
|-
!Variable
!Type
!Usage
|-
|DataSetName
|string
|Nom du dataset dans l'URL SDATA
|-
|Title
|string
|Libellé informatif sur l'usage du point d'accès
|-
|Contract
|string
|Nom du paquet de service SDATA
|-
|Version
|string
|Numéro de version, peut être utilisé pour supporté plusieurs version du même contrat
|-
|Folder
|string
|Nom du dossier utilisé par ce point d'accès
|-
|Database
|string
|Nom de la base de donnée utilisé pour ce point d'accès (multi-bases)
|-
|Society
|string
|Nom de la société pour ce point d'accès (multi-société)
|-
|Restitution
|string
|Nom de la famille de restitution pour ce point d'accès (multi-société)
|}

Exemple :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\SData\1]
DataSetName=iphone
Title=syfre iphone
Contract=ndfContract
Version=1
Folder=Test Syfre iPhone
Database=dbTestIPhone
Society=
Restitution=
</pre>

===Section Export===
Cette section permet de configurer la fonction d'exportation des vignettes de portail des Services.

Deux mode d'exportation sont possibles :

*ftp
: Dans ce mode les vignettes sont générées et copiées dans un répertoire public accessible par ftp.

*file
: Dans ce mode les vignettes sont générées et copiées dans un répertoire local du serveur. Ce mode n'est utile que si le répertoire est un répertoire du Site et que celui-ci est public.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Protocol
|String
|ftp ou file
|-
|Export URL
|String
|Cette URL référence le répertoire où la vignette a été générée.
|}

Si le protocole est 'ftp' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|FTP host
|String
|Addresse du serveur FTP
|-
|FTP Port
|Integer
|Numéro du port du serveur FTP
|-
|FTP Login
|String
|Utilisateur de connexion du serveur FTP
|-
|FTP Password
|String
|Mot de passe de connexion du serveur FTP
|-
|FTP Directory
|String
|Répertoire d'exportation sur le serveur FTP
|}

Si le protocole est 'file' les variables suivantes sont utilisées :

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|Directory
|String
|Répertoire d'exportation sur le serveur.
|}

Exemple de configuration ftp utilisant une zone publique Free :

<pre>
[\SOFTWARE\Sage\Ligne 1000\Administration\Servers\SYFRE\Export]
Protocol=ftp
Export URL=http://syfre.free.fr/sage/
FTP Host=ftpperso.free.fr
FTP Port=21
FTP Login=syfre
FTP Password=XXXXXXXXXX
FTP Directory=sage
</pre>

===Section ConfigServer===

Cette section permet d'utiliser un fichier de configuration disponible sur une url.

{|class="wikitable"
|-
!Nom de variable
!Type
!Usage
|-
|url
|String
|Cette URL permet de récupérer le fichier de configuration.
|}

Un POST HTTP est effectué sur cette url avec les données suivantes :

<source lang="javascript">
{"deploymentId":"nom_système_de_la_machine"}
</source>

Le résultat attendu est

<source lang="javascript">
{"config":"contenu_du_fichier_de_configuration"},
{"certificate":"certificat_au_format_pfx"}
</source>

*[[Exemple de configuration (server)|Exemple de configuration]]
*[[Service_1000_(server)|Ligne de commande]]

{{Footer|Serveur}}
[[category:Serveur]]

API Json (SData)

2026-02-26T15:44:36Z

Syfre : /* Prérequis */

==Prérequis==

L'API Json est une variante de [[Ressource (sdata)|l'API SData en mode ressource]]

Les informations de connexion et les schémas d'URL sont identiques.

A la différence de l'API en mode ressource, elle nécessite le déploiement de paquet DSM pour gérer les appels de service.

==Méthode JSON==

Dans ce mode, au lieu de manipuler des ressources retournées en xml ou json, le client appele des méthodes en passant en paramètre un payload json et en recevant en retour une responde json.

La signature de ces méthodes doit être :

<pre>
procedure foo(req:TJson; out resp:TJson);
</pre>

Ces méthodes peuvent être membre de n'importe quelle classe non persistante, ou d'une classe support d'un paquet de service local.

==Paquet de service local==

L'utilisation d'un paquet de service local permet d'appeler directement les méthodes de la classe support du paquet.

Par exemple :

[[image:api-json-1.png|800px]]

Vous pouvez appeler directement la méthode myMethodJson() sans explicitement indiquer la classe support :

<pre>
http://localhost:8080/sdata/dsmPaquetDeService/myMethodJson
</pre>

[[image:api-json-2.png|800px]]

==Paquet de classes non persistantes ==

Les méthodes Json membres de classes non persistantes peuvent aussi être appelées.

Par exemple :

[[image:api-json-3.png|800px]]

Dans ce cas vous devez spécifier le nom de la classe dans l'URL d'appel de la méthode.

<pre>
http://localhost:8080/sdata/dsmPaquetAPI/myMethodJson
</pre>

[[image:api-json-4.png|800px]]

Voir aussi:

* [[Ressource (sdata)|API SData en mode ressource]]

[[Category:SData]]

Ressource (sdata)

2026-02-26T15:43:27Z

Syfre :

__TOC__

{{tip|Voir aussi l'[[API Json (SData)|API en mode JSON]], qui permet d'encapsuler d'avantage les appels de service.}}

==Prérequis==
Les requêtes SData sont exécutées sur [[SData|le point d'accès SData du service]].

La forme simplifiée des urls est

<pre>http://hostname/sdata/ressource?paramètres</pre>

ou

<pre>http://hostname/sdata/societe/ressource?paramètres</pre>

Les requêtes sont authentifiées par un jeton d'authentification placé dans l'entête Authorization de la requêtes.

[[Gestion des jetons d'authentification (Administration)|Le jeton d'authentification peut être géré par le client dans l'administration.]]

Les requêtes doivent comporter les entêtes suivantes :

{|class="wikitable"
|-
|accept
|application/json
|-
|Authorization
|Bearer token
|}

Les url des requêtes doivent être encodées, par exemple :

<pre>https://.../sdata/Société 1/ttiers...</pre>

doit être transmis encodé en

<pre>https://.../sdata.Soci%C3%A9t%C3%A9%201/ttiers....</pre>

==Sélection de version==
Il es possible d'indiquer un numéro de version dans l'url de la requête.

Placez le numéro de version derrière le préfix sdata :

<pre>
https://.../sdata/1/....
</pre>

En absence de numéro de version la dernière version sera utilisée.

==Informations de version==
Utilisez la fonction $version pour retrouver les informations de version

<pre>
GET http://localhost:8080/sdata/$version
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 0,
"debug": true,
"shareEnable": true
}
</pre>

<pre>
GET https://localhost/sdata/$version?select=details
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 1,
"debug": true,
"minors": [
{
"minor": 1,
"details": [
"Fix $batch : Error in commit don't return message and continue execution",
"Fix time measure decimal format use . instead of local",
"Add extension information to $schema",
"Add operations to $schema",
"Add select options to $schema"
]
},
{
"minor": 0,
"details": [
"Add version information"
]
}
]
}
</pre>

Le paramètre select accepte les options suivantes :

{|class="wikitable"
|-
!option
!usage
|-
|details
|Détails des modifications des versions mineurs
|-
|patches
|Liste des patches installés
|}

==Ressource (GET)==
Dans l'interface SData les ressources sont les objets de l'application.

Une ressource est identifié par son uri qui représente le chemin de la ressource.

L'uri est composé du chemin de la classe et d'un sélecteur qui est l'oid de l'objet.

'''Exemple :'''

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')
Response: 200 OK
{
"$baseUrl":"http://localhost:8080/sdata/l1000/gentiers/-/",
"$title":"TTiers - -",
"$updated":"2020-12-22T08:10:09.740Z",
"$resources":[
{
"$url":"TTiers('9D33A23CFA6A005500F6000000285DAE')",
"$title":"ABI Jardin",
"$updated":"2010-03-23T15:37:46.000Z",
"$etag":"9D33A23CFA6A005500F6000000285DAE-000002C60000421C",
"$key":"9D33A23CFA6A005500F6000000285DAE",
"$baseUrl":"http://localhost:8080/sdata/l1000/GenTiers/-/",
"stamp":"000002C60000421C",
.... Attribute list ...
}
]
}
</pre>

===Sélecteur de ressource===

Un sélecteur permet de retrouver une ressource spécifique, il est possible de rechercher une ressource par clé ou clause

{|class="wikitable"
|-
!Sélecteur
!Exemple
|-
|Clé
|TTiers('9D33A23CFA6A005500F6000000285DAE')
|-
|clause
|TTiers(code eq 'ABI 007')
|}

===Code de retour HTTP===

{|class="wikitable"
|-
!Code
!Résultat
|-
|200
|La ressource existe
|-
|404
|La ressource n'existe pas
|}

===Gestion des rôles dans les ressources===
La gestion des rôles de la ressource dépend du type et de la nature du rôle :

{|class="wikitable"
|-
!Type de rôle
!Nature
!Retour
|-
|Référence,Liste
|Composition
|Les ressources composants sont retournées dans le corps de la ressource composée
|-
|Référence
| -
|La ressource référencée est retournée par référence dans le corps de la ressource
|-
|Liste
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe référencée filtrée sur la référence réciproque.
|-
|Association
|Avec suppression en cascade
|Les ressources associées sont considérées comme des composants et retournées dans le corps de la ressource composée.
|-
|Association
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe associée filtrée sur la classe d'association
|}

{{tip|Utilisez une vue pour retourner directement les attributs liés par des références, voir le paramètre select}}

===Gestion du périmètre société===
Par défaut, les requêtes s'exécutent dans le contexte société défini dans le jeton d'authentification.

Vous pouvez définir le contexte société dans le l'url de la requête :

<pre>
METHOD https://host/sdata/society/package/class ...
</pre>

{{tip|Définir le contexte société dans l'url n'est utilisable que sur une base supportant le multi-société. Pour connaitre le statut multi-société, utilisez la requête $version ou bien interrogez [[Utilisation_du_contrôleur_de_partage_(API)|le contrôleur de partage]]}}

==Requête sur les ressources (GET)==
Une requête sur les ressources est une requête sur une classe du modèle.

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?parameters
</pre>

===Paramètres de la requête===

{|class="wikitable"
|-
!Paramètre
!valeur
!Usage
|-
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|-
|where
|Expression objet
|Filtre de la requête
|-
|orderBy
|Attribut de tri
|Ordre de tri de la requête
|-
|count
|Taille de page (*)
|Pagination : Taille de page
|-
|startIndex
|Index de page
|Pagination par page : Numéro de page (0 première)
|-
|startKey
|Valeur de clé ou de tri
|Pagination par clé : Clé de position
|-
|keyDirection
|lt,le,gt,ge
|Pagination par clé : direction par rapport à startKey
|-
|dateFormat
|noTime, locale, utc
|Indique le format de date retourné pour les types de données date comptable
|}

(*) Il existe une limite par défaut si la valeur de count n'est pas précisée.

Les valeurs passées en paramètre doivent être encodées en HTML

Exemple :

where=code eq 'ABI 007'

doit être encodée en :

where=code%20eq%20%27ABI%20007%27

====Select====
Select permet de définir les attributs à retourner, par défaut tous les attributs non vide sont retournés

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
</pre>

La présence du paramètre select conditionne la façon d'exécuter la requête.

Les formats possibles sont :

{|class="wikitable"
|-
!format
!Usage
!Génère l'utilisation d'une vue
|-
|x
|Attribut x de la ressource
|non
|-
|x.y
|Attribut y de la ressource lié par de référence x (jointure exacte)
|oui
|-
|x.+y
|Attribut y de la ressource lié par de référence x (jointure externe)
|oui
|-
|x as y
|Attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y)
|Opération sur l'attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y;z)
|Opération sur les attributs y et z de la ressource retourné sous l'alias x
|oui
|}

Une vue sera utilisée si au moins un des membres de select nécessite l'utilisation d'une vue.

Pour les opérateurs utilisables consultez [[Vue_locale_(langage)|la page sur les vues locales]]

Notes :

* La sélection d'attribut référencé non défini peut générer l'absence de ressources dans le résultat, pour éviter ceci utilisez un spécificateur de jointure externe.
* La sélection d'attribut référencé par un rôle liste peut générer plusieurs ressources dans le résultat correspondant à chaque ressource liée par la relation.
* La séparation des paramètres pour les opérateurs ayant plusieurs paramètres utilise le séparateur ; et pas ,
* Lorsqu'une vue est utilisée, les filtres et ordre de tri sont exprimés par rapport à la vue.

Par exemple :
* TCompteGeneral?select=codeCompte&where=codeCompte ge '4'&orderBy=codeCompte
mais
* TCompteGeneral?select=code as codeCompte&where=code ge '4'&orderBy=code

====Dates comptables====
Le paramètre dateFormat permet de définir le format des dates comptables retournées par l'API

{|class="wikitable"
|-
!Version API
!dateFormat
!Exemple
!Format
!Représente
!Temps UTC
|-
|1.6
|
|2021-05-31T22:00:00Z
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|
|2021-06-01T00:00:00+02
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|locale
|2021-06-01T00:00:00
|Format heure locale
|Un instant heure locale
|
|-
|1.7
|noTime
|2021-06-01
|Format date locale
|Une date locale
|
|-
|1.7
|UTC
|2021-05-31T22:00:00Z
|Format heure UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

====Filtre====

'''Opérateurs:'''

{|class="wikitable"
|-
!opérateur
!équivalence
!exemple
!encoded
|-
|eq
|=
|where=code eq 'ABI 007'
|where=code%20eq%20%27ABI%20007%27
|-
|ne
|<>
|
|
|-
|lt
|<
|
|
|-
|le
|<=
|
|
|-
|gt
|>
|
|
|-
|ge
|>=
|
|
|-
|like
|like
|where=code like 'ABI %'
|where=code%20like%20%27ABI %25%27
|-
|in
|in
|
|
|}

'''Valeurs des paramètres:'''

Les valeurs des paramètres sont passées en littérale

{|class="wikitable"
|-
!Type de donnée
!exemple
|-
|Chaîne
|code eq 'xxx'
|-
|boolean
|flag eq true
|-
|numérique
|value eq 1
|-
|flottant
|value eq 1.0
|-
|date (voir format)
|$updated > '2019-12-31T23:00:00Z'
|-
|enum (par index)
|value eq 1
|-
|enum (par constant)
|value eq sens_credit
|}

Format des paramètres date :

{|class="wikitable"
|-
!format
!décodage
!Exemple (1 jan. 2020 France)
|-
|AAAA-MM-DDTHH:MM:SS.MMMZ
|ISO-8601 UTC
|2019-12-31T23:00:00Z
|-
|AAAA-MM-DDTHH:MM:SS.MMM+OFFSET
|ISO-8601 avec timezone
|2019-12-31T23:00:00+1
|-
|AAAA-MM-DDTHH:MM:SS.MMM
|ISO-8601 sans timezone
|2020-01-01T00:00:00
|-
|AAA-MM-DD
|Date au format ISO-8601
|2020-01-01
|-
|DD/MM/AAAA
|Date au format local
|01/01/2020
|}

====Ordre de tri====

Tri ascendant :

orderby=code

Tri descendant :

orderby=code%20desc

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc
</pre>

====Pagination par page====

Utiliser orderBy, count et startIndex

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=0
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=10
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=20
...
</pre>

{{tip|Incrémentez startIndex du nombre de ressource retourné par la requête}}

====Pagination par clé====

Utiliser orderBy, startKey et keyDirection

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
</pre>

==Création de ressource (POST)==
<pre>
POST http://localhost:8080/sdata/gentiers/ttiers
Request:
{
"code":"SYFRE1",
"caption":"syfre 1",
"sitesList":[
{
"code":"SITE1",
"caption":"site1 de syfre1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E20022",
"$url": "http://localhost:8080/sdata/l1000/gentiers/-/TTiers('9D33A23CFA6A005500F6000001E20022')",
... attribute list ...
}
]
}
</pre>

===Gestion du périmètre de partage===

Le niveau de partage d'une ressource de niveau activité peut être contrôlé par des propriétés de contrôle au niveau de la définition de la ressource :

{|class="wikitable"
|-
!Contrôle
!Usage
|-
|$shareId
|Valeur du périmètre sur lequel créer l'objet
|-
|$shareLevel
|Niveau de partage sur lequel créer l'objet (0:dossier,1:activité ou 2:société)
|}

<pre>
POST https://localhost/sdata/S3/gentiers/ttiers
Request:
{
"$shareLevel":2,
"code":"SYFRES3-2",
"caption":"syfre S3-2",
"sitesList":[
{
"code":"SITE1",
"caption":"site 1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response : 201 OK
</pre>

{{Tip|Par défaut la ressource sera créée au niveau activité}}

===Gestion des rôles===

La création de ressource dans les rôles dépend de la nature du rôle.

* Pour les rôles de type composition les ressources liées sont créés simultanément.
* Pour les rôles qui ne sont pas des compositions les ressources liées sont rattachés.

'''Identification des références'''

'''Par clé:'''
<pre>
{
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
</pre>

'''Par uri:'''
<pre>
{
"pays":{
"$url":TPays("9D33A23CFA6A005500150000001700FD")
}
}
</pre>

'''Par expression:'''
<pre>
{
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
</pre>

Lorsqu'une expression est utilisée la première ressource retournée par l'expression est utilisée.

===Gestion des dates comptables===
Pour les dates comptables, le serveur convertit la date reçu en heure locale puis conserve la partie date.

{|class="wikitable"
|-
!Format
!Représente
!Exemple
!Interprète
|-
|locale
|Une heure locale
|2021-06-01T00:00:00
|Conserve l’heure reçue en heure locale et conserve la date, la date sera toujours celle transmise.
|-
|noTime
|Une date sans heure
|2021-06-01
|Conserve la date reçue sans conversion, la date sera toujours celle transmise.
|-
|UTC
|Un instant universel UTC
|2021-05-31T22:00:00Z
2021-05-31T22:00:00+02
|Convertit l’heure UTC en heure locale du service et conserve la date reçue, la date peut être différente de la date transmise si le client et le service ne sont pas dans le même fuseau horaire.
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

==Modification de ressource (PUT)==
<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request:
{
"codeSIRET":"12345678"
}
Response: 200 OK
[
{
.... resource modified ...
}
]
</pre>

===Modification de rôle liste composition===
Par défaut les rôles composition sont gérés en remplacement, pour contrôler le mode de gestion des rôles utilisez un élément de contrôle "$" pour le rôle :

'''Exemple : Modification du rôle par remplacement des composants :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites has been removed.
... There is one site left in the list
]
]
}
</pre>

'''Exemple : Modification du rôle par ajout de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["create"]
},
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites are not affected
... There is one site more in the list
}
]
]
}
</pre>

'''Exemple : Modification du rôle par mise à jour de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["update"]
},
"sitesList":[
{
"$key":"9D33A23CFA6A005500F6000001E30019",
"caption":"Site maj",
}
]
}
</pre>

{|class="wikitable"
|-
!contrôle
!action
|-
|create
|Les nouvelles ressources sont ajoutées au rôle
|-
|update
|Les ressources existantes dans le rôle sont mise à jour
|-
|delete
|Les ressources existantes et non présentes dans la requête sont supprimées
|}

La valeur par défaut est "create","update","delete"

===Modification des attributs privés===
Par défaut les attributs privés sont modifiés sur le niveau de partage correspondant au périmètre société, pour contrôler le niveau de partage des attributs privés utilisez un élément de contrôle $sharePrivateLevel.

{|class="wikitable"
|-
!sharePrivateLevel
!Périmètre de définition
|-
|absent
|Périmètre courant de l'objet
|-
|0
|Dossier
|-
|1
|Activité
|-
|2
|Société
|}

{{tip|Le périmètre courant de l'objet dépend de l'état de l'objet. Par exemple, si l'objet est de niveau activité et n'a pas de propriété défini pour la société courante, le périmètre courant sera l'activité, mais si l'objet a des propriétés définies pour la société courante alors le périmètre courant sera la société. Ne pas définir explicitement le niveau de partage peut amener à des ambiguïtés.}}

'''Modification de la valeur de l'attribut privé pour les sociétés de l'activité du Tiers (le tiers n'a pas de propriété défini pour la société S3):'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"modeReglementDecaissement":{"$where":"code eq 'CHQ'"},
}
</pre>

'''Modification de la valeur de l'attribut privé pour la société S3 :'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"$sharePrivateLevel":2,
"modeReglementDecaissement":{"$where":"code eq 'CBB'"},
}
</pre>

==Suppression de ressource (DELETE)==
<pre>
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Response: 200 OK
</pre>

==Opération sur une ressource (POST)==

Les opérations des ressources correspondent aux méthodes publiques de cette ressource.

===Méthode d'instance de ressource===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/wfclassea('B5A28A92EB0C00020010000000DB0006')/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Méthode de classe de ressource, ou méthode de classe non persistante===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Passage des paramètres===
Les paramètres sont passés par nom et valeur.

Les types de paramètres et de retour supportés sont :

{|class="wikitable"
|-
!Type
!Exemple
|-
|Chaîne
|"p":"xxx"
|-
|Entier
|"p":1
|-
|Boolean
|"p":true
|-
|Flottant
|"p":1.1
|-
|Datetime
|"p":"2020-12-25T01:01:01"
|-
|Enuméré (par valeur)
|"p":1
|-
|Liste d'objets
|"p":[ {$key:"key", $uuid:"uuid", $where:"expression"}, ...],
|}

{{tip|Les références des objets passés dans des listes peuvent être définies par clé ($key), identifiant appelant ($uuid) ou expression ($where)
Exemple :
<pre>
{
"paramList":[
{"$key":"B5A28A92EB0C00020010000001F500A1"},
{"$where":"uneChaine like 'cN%'"}
]
}
</pre>
}}

===Résultat de type ressource===
Lorsque l'opération retourne un objet ou une liste d'objets ceux-ci sont retournés sous forme de ressource.

Par exemple :

<source lang="delphi">
//class Function GetWFClasseA(const iCode:string):WFClasseA;
begin
Result := WFClasseA.Find('(unCode = %1)','unCode',True,[iCode]);
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassea
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:41:41.015Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
}
]
}
}
</pre>

<source lang="delphi">
//Class Function GetWFClasseA(const iCodeLike:string):WFClasseAList;
begin
Result := WFClasseA.CreateListWhere('(unCode like %1)','','unCode',True,-1,[iCodeLike]);
end;
</source>

<pre>

POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassealist
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:49:14.061Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
},
{
"$key": "B5A28A92EB0C00020010000001B4000E",
"$etag": "B5A28A92EB0C00020010000001B4000E-0000025000000025",
"stamp": "0000025000000025",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaalb",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 2,
"title": "Etat 2"
},
"unStatus": 0
},
{
"$key": "B5A28A92EB0C00020010000001B4001A",
"$etag": "B5A28A92EB0C00020010000001B4001A-0000018B0000001A",
"stamp": "0000018B0000001A",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaale",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 0,
"title": "Initial"
},
"unStatus": 0
},
......
]
}
}
</pre>

===Initialisation de la ressource===
Il est possible d'initialiser la ressource avant d'exécuter la méthode, par exemple pour un processus :

<source lang="delphi">
Type
TmyProcessus = class
public
procedure Execute(p:string);
property attString:string;
property attInt:Integer;
property attRef:TRefClass;
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/execute
Request:
{
"$resource":{
"attString":"value 1",
"attInt":100,
"attRef":{"$url":"TRefClass('xxx')"},
},
"p":"value",
}
Response: 200 OK
{
"result":""
}
</pre>

==Requête Batch (POST $batch)==
Une requête Batch permet de réaliser plusieurs opérations de type GET,POST/PUT/DELETE/EXEC en une seule fois.

Une requête Batch contient un tableau de ressources, pour chaque ressource l'action et l'uri doivent être précisées :

<pre>
POST http://.../sdata/$batch
{
"$resources":[
{
"$httpMethod":"POST",
"$url":"gentiers/ttiers",
"code":"SYFRE2",
"caption":"syfre 2",
"sitesList":[
{
"code":"SITE1",
"caption":"site2 de syfre2",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
]
}
</pre>

{{tip|Le format d'url complet de $Batch est https://hostname/service/server/sdata/l1000/-/-/$batch}}

===Gestion de la transaction dans un batch===
Par défaut les opérations réalisées sont unitaires (une transaction par ressource).

Pour réaliser une opération Batch atomique (une seule transaction longue) utilisez un élément de contrôle transaction :

Lorsque l'opération est atomique la réponse contient un élément $batch indiquant le statut de l'opération.

Le code de retour http est le code de retour de la dernière opération réalisée.

<pre>
POST http://localhost:8080/sdata/$batch
{
"$": {"$transaction":["atomic"]},
"$resources":[
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')",
"$uuid":"1",
"capital":{"value":7200,"CodeDevise":"USD"}
},
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$uuid":"2",
"capital":{"value":1000,"CodeDevise":"EUR"}
}
]
}
Response : 401
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "PUT",
"$httpMessage": "OK",
"$etag": "9D33A23CFA6A005500F6000000285DAE-0000018C00000001"
},
{
"$httpStatus": 410,
"$httpMessage": "Already Deleted",
"$uuid": "2",
"$url": "gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis"
}
]
}
}
],
"$batch": {
"$httpStatus": 400,
"$httpMessage": "ROLLBACK",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis",
"entry": {
"number": 2,
"uuid": "2"
}
}
]
}
}
}
</pre>

'''$transaction :'''

{|class="wikitable"
|-
!Commande
!Action
|-
|atomic
|Démarre une transaction longue
|-
|flush
|Force un batch de la transaction longue
|-
|commit
|Valide la transaction longue
|}
{{Tip|L'élément de contrôle de transaction peut être placé au niveau d'un ordre du lot.}}

===Execution de méthode dans un batch===
Utiliser le verbe EXEC pour exécuter une méthode

<pre>
POST http://localhost:8080/sdata/$batch
{
"$resources":[
{
"$httpMethod":"EXEC",
"$url":"testsyfrewf/wfprocessus/testmethod",
"$resource":{
"uneChaine":"value 1"
},
"p":"value 2"
}
]
}
Response : 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "POST",
"$httpMessage": "Executed",
"$url": "testsyfrewf/wfprocessus/testmethod",
"$uuid": "",
"result": "value 1 value 2"
}
]
}
</pre>

==Schéma d'une ressource (GET $schema)==
Le schéma d'une ressource retourne la structure de la classe.

<pre>
GET http://localhost:8080/sdata/testsyfrewf/wfclassea/$schema
Response : 200 OK
{
"title": "Libellé de la Classe A",
"stereotype": "persistent",
"properties": {
"unBool": {
"type": "boolean",
"title": "Un Bool"
},
"unCode": {
"type": "string",
"title": "Un code"
},
"unCompteur": {
"type": "string"
},
"unDerive": {
"type": "string",
"title": "Un dérivé"
},
"unDouble": {
"type": "double",
"title": "Un double"
},
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEmail": {
"type": "string",
"title": "Un email"
},
"unEntier": {
"type": "int",
"title": "Un Entier"
},
"unEtat": {
"type": "integer",
"title": "Un Etat"
},
"unStatus": {
"type": "int",
"title": "Statut de l'objet (Panel)"
},
"WFClasseBRef": {
"type": {
"$ref": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseB/$schema",
"$relationship": "reference"
},
"title": "Référence B"
},
"WFClasseCList": {
"type": "array",
"item": {
"title": "Classe C",
"properties": {
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEntier": {
"type": "int",
"title": "un entier"
}
}
}
}
},
"$url": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseA/$schema"
}
</pre>

Le contenu de la réponse peut être configurée avec le paramètre "select", à défaut toutes les informations sont retournées.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|extensions
|Retourne uniquement les attributs issus d'extension
|-
|properties
|Retourne la liste de tous les attributs
|-
|selfProperties
|Retourne uniquement les attributs de la classe elle même
|-
|operations
|Retourne les opérations de la classe
|-
|compositions
|Retourne le schéma des classes composants
|}

Exemple : Retrouver uniquement les attributs d'extension d'une classe :

<pre>
GET http://localhost:8080/sdata/ttiers/$schema?select=extensions
{
"title": "Tiers",
"stereotype": "persistent",
"extensions": [
{
"class": "TTiers_esmPackage",
"title": "Extension de TTiers",
"package": "esmPackage"
}
],
"properties": {
"esmCode": {
"type": "string",
"extension": "TTiers_esmPackage",
"title": "un code esm"
}
},
"$url": "http://localhost:8080/sdata/gentiers/TTiers/$schema"
}
</pre>

==Modèle de ressource (GET $template)==
Le modèle de ressource retourne une ressource initialisée

<pre>
GET http://localhost:8080/sdata/gcimport/TImportContratCommercial/$template
Response : 200 OK

{
"$url": "http://localhost:8080/sdata/l1000/gcimport/-/TImportContratCommercial",
"stamp": "000001D900000001",
"acompte": 0,
"affaire": "",
"budget": "",
"Caption": "",
"commandeEngagement": false,
"commercial": "",
"coursDevise": {
"value": 1,
"CodeDevise": "",
"Date": "1899-12-30T00:00:00.000Z",
"TCConv": "",
"TCValue": 0,
"RPConv": "",
"RPValue": 0
},
"coursNegocie": false,
"dateCommande": "1899-12-30T00:00:00.000Z",
"dateLivraison": "1899-12-30T00:00:00.000Z",
"devise": "",
"donneeEDI1": "",
"donneeEDI2": "",
"donneeEDI3": "",
"donneeEDI4": "",
"donneeEDI5": "",
"echeancement": "",
"etablissement": "",
"exonereTaxe": "",
"exonereTVA": "",
"gestionTransport": {
"value": 0,
"title": "Automatique"
},
"immobilisation": {
"value": 0,
"title": "B&S"
},
"ImportCCDetailList": [],
"importeGMAO": false,
"importerRemisePied": false,
"ImportSiteAdresse": {},
"incoterm": "",
"MentionExonerationTVA": "",
"posteBudgetaire": "",
"pourcentAcompte": {
"value": 0,
"Decimales": 2
},
"pourcentRemisePied": {
"value": 0,
"Decimales": 2
},
"reference": "",
"referenceMandat": "",
"regimeTVA": "",
"roleTiers": "",
"roleTiersLivre": "",
"SessionImportation": {},
"typeFacturation": {
"value": 0,
"title": "HT"
}
}
</pre>

Voir aussi :

* [[SData|Point d'accès et url SData]]
* [[Gestion des jetons d'authentification (Administration)|Gestion des jetons d'authentification]]
* [[API Json (SData)|API SData en mode json]]

Voir aussi les exemples suivants :

* [[Utilisation du contrôleur de partage (API)|Utilisation du contrôleur de partage]]
* [[Interrogation des écritures (API)|Interrogation des écritures avec l'API SData]]
* [[Interrogation des fournisseurs (API)|Interrogation des fournisseurs avec l'API SData]]
* [[Creation d'un fournisseur (API)|Création d'un fournisseur avec l'API SData]]
* [[Import_de commandes_(API)|Import de commandes avec l'API SData]]
* [[Import_d%27écritures_(API)|Import d'écritures avec l'API SData]]
* [[Gestion des réceptions fournisseurs (API)|Gestion des réceptions fournisseurs avec l'API SData]]
* [[Facturation d'un bon de livraison (API)|Facturation d'un bon de livraison avec l'API SData]]
* [[Creation_d%27un_Tiers_et_son_compte_bancaire_(API)|Creation_d'un Tiers et son compte bancaire (API)]]
[[Category:SData]]

Ressource (sdata)

2026-02-26T15:39:58Z

Syfre :

__TOC__

==Prérequis==
Les requêtes SData sont exécutées sur [[SData|le point d'accès SData du service]].

La forme simplifiée des urls est

<pre>http://hostname/sdata/ressource?paramètres</pre>

ou

<pre>http://hostname/sdata/societe/ressource?paramètres</pre>

Les requêtes sont authentifiées par un jeton d'authentification placé dans l'entête Authorization de la requêtes.

[[Gestion des jetons d'authentification (Administration)|Le jeton d'authentification peut être géré par le client dans l'administration.]]

Les requêtes doivent comporter les entêtes suivantes :

{|class="wikitable"
|-
|accept
|application/json
|-
|Authorization
|Bearer token
|}

Les url des requêtes doivent être encodées, par exemple :

<pre>https://.../sdata/Société 1/ttiers...</pre>

doit être transmis encodé en

<pre>https://.../sdata.Soci%C3%A9t%C3%A9%201/ttiers....</pre>

==Sélection de version==
Il es possible d'indiquer un numéro de version dans l'url de la requête.

Placez le numéro de version derrière le préfix sdata :

<pre>
https://.../sdata/1/....
</pre>

En absence de numéro de version la dernière version sera utilisée.

==Informations de version==
Utilisez la fonction $version pour retrouver les informations de version

<pre>
GET http://localhost:8080/sdata/$version
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 0,
"debug": true,
"shareEnable": true
}
</pre>

<pre>
GET https://localhost/sdata/$version?select=details
{
"product": "Sage FRP 1000",
"version": "9.1.0.0",
"master": "1.22",
"apiMajor": 1,
"apiMinor": 1,
"debug": true,
"minors": [
{
"minor": 1,
"details": [
"Fix $batch : Error in commit don't return message and continue execution",
"Fix time measure decimal format use . instead of local",
"Add extension information to $schema",
"Add operations to $schema",
"Add select options to $schema"
]
},
{
"minor": 0,
"details": [
"Add version information"
]
}
]
}
</pre>

Le paramètre select accepte les options suivantes :

{|class="wikitable"
|-
!option
!usage
|-
|details
|Détails des modifications des versions mineurs
|-
|patches
|Liste des patches installés
|}

==Ressource (GET)==
Dans l'interface SData les ressources sont les objets de l'application.

Une ressource est identifié par son uri qui représente le chemin de la ressource.

L'uri est composé du chemin de la classe et d'un sélecteur qui est l'oid de l'objet.

'''Exemple :'''

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')
Response: 200 OK
{
"$baseUrl":"http://localhost:8080/sdata/l1000/gentiers/-/",
"$title":"TTiers - -",
"$updated":"2020-12-22T08:10:09.740Z",
"$resources":[
{
"$url":"TTiers('9D33A23CFA6A005500F6000000285DAE')",
"$title":"ABI Jardin",
"$updated":"2010-03-23T15:37:46.000Z",
"$etag":"9D33A23CFA6A005500F6000000285DAE-000002C60000421C",
"$key":"9D33A23CFA6A005500F6000000285DAE",
"$baseUrl":"http://localhost:8080/sdata/l1000/GenTiers/-/",
"stamp":"000002C60000421C",
.... Attribute list ...
}
]
}
</pre>

===Sélecteur de ressource===

Un sélecteur permet de retrouver une ressource spécifique, il est possible de rechercher une ressource par clé ou clause

{|class="wikitable"
|-
!Sélecteur
!Exemple
|-
|Clé
|TTiers('9D33A23CFA6A005500F6000000285DAE')
|-
|clause
|TTiers(code eq 'ABI 007')
|}

===Code de retour HTTP===

{|class="wikitable"
|-
!Code
!Résultat
|-
|200
|La ressource existe
|-
|404
|La ressource n'existe pas
|}

===Gestion des rôles dans les ressources===
La gestion des rôles de la ressource dépend du type et de la nature du rôle :

{|class="wikitable"
|-
!Type de rôle
!Nature
!Retour
|-
|Référence,Liste
|Composition
|Les ressources composants sont retournées dans le corps de la ressource composée
|-
|Référence
| -
|La ressource référencée est retournée par référence dans le corps de la ressource
|-
|Liste
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe référencée filtrée sur la référence réciproque.
|-
|Association
|Avec suppression en cascade
|Les ressources associées sont considérées comme des composants et retournées dans le corps de la ressource composée.
|-
|Association
| -
|Les ressources ne sont pas retournées. Pour obtenir ces ressources, il faut faire une requête sur la classe associée filtrée sur la classe d'association
|}

{{tip|Utilisez une vue pour retourner directement les attributs liés par des références, voir le paramètre select}}

===Gestion du périmètre société===
Par défaut, les requêtes s'exécutent dans le contexte société défini dans le jeton d'authentification.

Vous pouvez définir le contexte société dans le l'url de la requête :

<pre>
METHOD https://host/sdata/society/package/class ...
</pre>

{{tip|Définir le contexte société dans l'url n'est utilisable que sur une base supportant le multi-société. Pour connaitre le statut multi-société, utilisez la requête $version ou bien interrogez [[Utilisation_du_contrôleur_de_partage_(API)|le contrôleur de partage]]}}

==Requête sur les ressources (GET)==
Une requête sur les ressources est une requête sur une classe du modèle.

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?parameters
</pre>

===Paramètres de la requête===

{|class="wikitable"
|-
!Paramètre
!valeur
!Usage
|-
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|-
|where
|Expression objet
|Filtre de la requête
|-
|orderBy
|Attribut de tri
|Ordre de tri de la requête
|-
|count
|Taille de page (*)
|Pagination : Taille de page
|-
|startIndex
|Index de page
|Pagination par page : Numéro de page (0 première)
|-
|startKey
|Valeur de clé ou de tri
|Pagination par clé : Clé de position
|-
|keyDirection
|lt,le,gt,ge
|Pagination par clé : direction par rapport à startKey
|-
|dateFormat
|noTime, locale, utc
|Indique le format de date retourné pour les types de données date comptable
|}

(*) Il existe une limite par défaut si la valeur de count n'est pas précisée.

Les valeurs passées en paramètre doivent être encodées en HTML

Exemple :

where=code eq 'ABI 007'

doit être encodée en :

where=code%20eq%20%27ABI%20007%27

====Select====
Select permet de définir les attributs à retourner, par défaut tous les attributs non vide sont retournés

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
</pre>

La présence du paramètre select conditionne la façon d'exécuter la requête.

Les formats possibles sont :

{|class="wikitable"
|-
!format
!Usage
!Génère l'utilisation d'une vue
|-
|x
|Attribut x de la ressource
|non
|-
|x.y
|Attribut y de la ressource lié par de référence x (jointure exacte)
|oui
|-
|x.+y
|Attribut y de la ressource lié par de référence x (jointure externe)
|oui
|-
|x as y
|Attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y)
|Opération sur l'attribut y de la ressource retourné sous l'alias x
|oui
|-
|x as ope(y;z)
|Opération sur les attributs y et z de la ressource retourné sous l'alias x
|oui
|}

Une vue sera utilisée si au moins un des membres de select nécessite l'utilisation d'une vue.

Pour les opérateurs utilisables consultez [[Vue_locale_(langage)|la page sur les vues locales]]

Notes :

* La sélection d'attribut référencé non défini peut générer l'absence de ressources dans le résultat, pour éviter ceci utilisez un spécificateur de jointure externe.
* La sélection d'attribut référencé par un rôle liste peut générer plusieurs ressources dans le résultat correspondant à chaque ressource liée par la relation.
* La séparation des paramètres pour les opérateurs ayant plusieurs paramètres utilise le séparateur ; et pas ,
* Lorsqu'une vue est utilisée, les filtres et ordre de tri sont exprimés par rapport à la vue.

Par exemple :
* TCompteGeneral?select=codeCompte&where=codeCompte ge '4'&orderBy=codeCompte
mais
* TCompteGeneral?select=code as codeCompte&where=code ge '4'&orderBy=code

====Dates comptables====
Le paramètre dateFormat permet de définir le format des dates comptables retournées par l'API

{|class="wikitable"
|-
!Version API
!dateFormat
!Exemple
!Format
!Représente
!Temps UTC
|-
|1.6
|
|2021-05-31T22:00:00Z
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|
|2021-06-01T00:00:00+02
|Format UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|-
|1.7
|locale
|2021-06-01T00:00:00
|Format heure locale
|Un instant heure locale
|
|-
|1.7
|noTime
|2021-06-01
|Format date locale
|Une date locale
|
|-
|1.7
|UTC
|2021-05-31T22:00:00Z
|Format heure UTC
|Un instant heure universelle
|Le 31 Mai 2021 à 22 heure
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

====Filtre====

'''Opérateurs:'''

{|class="wikitable"
|-
!opérateur
!équivalence
!exemple
!encoded
|-
|eq
|=
|where=code eq 'ABI 007'
|where=code%20eq%20%27ABI%20007%27
|-
|ne
|<>
|
|
|-
|lt
|<
|
|
|-
|le
|<=
|
|
|-
|gt
|>
|
|
|-
|ge
|>=
|
|
|-
|like
|like
|where=code like 'ABI %'
|where=code%20like%20%27ABI %25%27
|-
|in
|in
|
|
|}

'''Valeurs des paramètres:'''

Les valeurs des paramètres sont passées en littérale

{|class="wikitable"
|-
!Type de donnée
!exemple
|-
|Chaîne
|code eq 'xxx'
|-
|boolean
|flag eq true
|-
|numérique
|value eq 1
|-
|flottant
|value eq 1.0
|-
|date (voir format)
|$updated > '2019-12-31T23:00:00Z'
|-
|enum (par index)
|value eq 1
|-
|enum (par constant)
|value eq sens_credit
|}

Format des paramètres date :

{|class="wikitable"
|-
!format
!décodage
!Exemple (1 jan. 2020 France)
|-
|AAAA-MM-DDTHH:MM:SS.MMMZ
|ISO-8601 UTC
|2019-12-31T23:00:00Z
|-
|AAAA-MM-DDTHH:MM:SS.MMM+OFFSET
|ISO-8601 avec timezone
|2019-12-31T23:00:00+1
|-
|AAAA-MM-DDTHH:MM:SS.MMM
|ISO-8601 sans timezone
|2020-01-01T00:00:00
|-
|AAA-MM-DD
|Date au format ISO-8601
|2020-01-01
|-
|DD/MM/AAAA
|Date au format local
|01/01/2020
|}

====Ordre de tri====

Tri ascendant :

orderby=code

Tri descendant :

orderby=code%20desc

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc
</pre>

====Pagination par page====

Utiliser orderBy, count et startIndex

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=0
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=10
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startIndex=20
...
</pre>

{{tip|Incrémentez startIndex du nombre de ressource retourné par la requête}}

====Pagination par clé====

Utiliser orderBy, startKey et keyDirection

<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
</pre>

==Création de ressource (POST)==
<pre>
POST http://localhost:8080/sdata/gentiers/ttiers
Request:
{
"code":"SYFRE1",
"caption":"syfre 1",
"sitesList":[
{
"code":"SITE1",
"caption":"site1 de syfre1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E20022",
"$url": "http://localhost:8080/sdata/l1000/gentiers/-/TTiers('9D33A23CFA6A005500F6000001E20022')",
... attribute list ...
}
]
}
</pre>

===Gestion du périmètre de partage===

Le niveau de partage d'une ressource de niveau activité peut être contrôlé par des propriétés de contrôle au niveau de la définition de la ressource :

{|class="wikitable"
|-
!Contrôle
!Usage
|-
|$shareId
|Valeur du périmètre sur lequel créer l'objet
|-
|$shareLevel
|Niveau de partage sur lequel créer l'objet (0:dossier,1:activité ou 2:société)
|}

<pre>
POST https://localhost/sdata/S3/gentiers/ttiers
Request:
{
"$shareLevel":2,
"code":"SYFRES3-2",
"caption":"syfre S3-2",
"sitesList":[
{
"code":"SITE1",
"caption":"site 1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response : 201 OK
</pre>

{{Tip|Par défaut la ressource sera créée au niveau activité}}

===Gestion des rôles===

La création de ressource dans les rôles dépend de la nature du rôle.

* Pour les rôles de type composition les ressources liées sont créés simultanément.
* Pour les rôles qui ne sont pas des compositions les ressources liées sont rattachés.

'''Identification des références'''

'''Par clé:'''
<pre>
{
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
</pre>

'''Par uri:'''
<pre>
{
"pays":{
"$url":TPays("9D33A23CFA6A005500150000001700FD")
}
}
</pre>

'''Par expression:'''
<pre>
{
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
</pre>

Lorsqu'une expression est utilisée la première ressource retournée par l'expression est utilisée.

===Gestion des dates comptables===
Pour les dates comptables, le serveur convertit la date reçu en heure locale puis conserve la partie date.

{|class="wikitable"
|-
!Format
!Représente
!Exemple
!Interprète
|-
|locale
|Une heure locale
|2021-06-01T00:00:00
|Conserve l’heure reçue en heure locale et conserve la date, la date sera toujours celle transmise.
|-
|noTime
|Une date sans heure
|2021-06-01
|Conserve la date reçue sans conversion, la date sera toujours celle transmise.
|-
|UTC
|Un instant universel UTC
|2021-05-31T22:00:00Z
2021-05-31T22:00:00+02
|Convertit l’heure UTC en heure locale du service et conserve la date reçue, la date peut être différente de la date transmise si le client et le service ne sont pas dans le même fuseau horaire.
|}

{{warning|Pour les dates comptables, les formats UTC sont ambigus et peuvent générer des erreurs de conversion si les fuseaux horaire du serveur et du client sont différents}}

==Modification de ressource (PUT)==
<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request:
{
"codeSIRET":"12345678"
}
Response: 200 OK
[
{
.... resource modified ...
}
]
</pre>

===Modification de rôle liste composition===
Par défaut les rôles composition sont gérés en remplacement, pour contrôler le mode de gestion des rôles utilisez un élément de contrôle "$" pour le rôle :

'''Exemple : Modification du rôle par remplacement des composants :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites has been removed.
... There is one site left in the list
]
]
}
</pre>

'''Exemple : Modification du rôle par ajout de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["create"]
},
"sitesList":[
{
"code":"SITE3",
"caption":"site3 de syfre1",
"adresse":{
"nomRueVoie":"rue Mogador",
"ville":"Paris",
"codePostal":"75008",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E30019",
"$url": "/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E30019')",
"stamp": "000001710000002A",
....
"sitesList": [
... Site3 has been added, other sites are not affected
... There is one site more in the list
}
]
]
}
</pre>

'''Exemple : Modification du rôle par mise à jour de composant :'''

<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request :
{
"$":{
"sitesList:["update"]
},
"sitesList":[
{
"$key":"9D33A23CFA6A005500F6000001E30019",
"caption":"Site maj",
}
]
}
</pre>

{|class="wikitable"
|-
!contrôle
!action
|-
|create
|Les nouvelles ressources sont ajoutées au rôle
|-
|update
|Les ressources existantes dans le rôle sont mise à jour
|-
|delete
|Les ressources existantes et non présentes dans la requête sont supprimées
|}

La valeur par défaut est "create","update","delete"

===Modification des attributs privés===
Par défaut les attributs privés sont modifiés sur le niveau de partage correspondant au périmètre société, pour contrôler le niveau de partage des attributs privés utilisez un élément de contrôle $sharePrivateLevel.

{|class="wikitable"
|-
!sharePrivateLevel
!Périmètre de définition
|-
|absent
|Périmètre courant de l'objet
|-
|0
|Dossier
|-
|1
|Activité
|-
|2
|Société
|}

{{tip|Le périmètre courant de l'objet dépend de l'état de l'objet. Par exemple, si l'objet est de niveau activité et n'a pas de propriété défini pour la société courante, le périmètre courant sera l'activité, mais si l'objet a des propriétés définies pour la société courante alors le périmètre courant sera la société. Ne pas définir explicitement le niveau de partage peut amener à des ambiguïtés.}}

'''Modification de la valeur de l'attribut privé pour les sociétés de l'activité du Tiers (le tiers n'a pas de propriété défini pour la société S3):'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"modeReglementDecaissement":{"$where":"code eq 'CHQ'"},
}
</pre>

'''Modification de la valeur de l'attribut privé pour la société S3 :'''
<pre>
PUT http://localhost:8080/sdata/S3/gentiers/ttiers(code eq 'ABI 00007')
{
"$sharePrivateLevel":2,
"modeReglementDecaissement":{"$where":"code eq 'CBB'"},
}
</pre>

==Suppression de ressource (DELETE)==
<pre>
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Response: 200 OK
</pre>

==Opération sur une ressource (POST)==

Les opérations des ressources correspondent aux méthodes publiques de cette ressource.

===Méthode d'instance de ressource===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/wfclassea('B5A28A92EB0C00020010000000DB0006')/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Méthode de classe de ressource, ou méthode de classe non persistante===

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/testmethode
Request:
{
"pString":"value1",
"pInteger":1,
"pFloat":1.2,
"pEnum":1,
"pBoolean":false
}

Response: 200 OK
{
"result": "pString:value1 pInteger:1 pBoolean:false pFloat:1,2 pEnum:1"
}
</pre>

===Passage des paramètres===
Les paramètres sont passés par nom et valeur.

Les types de paramètres et de retour supportés sont :

{|class="wikitable"
|-
!Type
!Exemple
|-
|Chaîne
|"p":"xxx"
|-
|Entier
|"p":1
|-
|Boolean
|"p":true
|-
|Flottant
|"p":1.1
|-
|Datetime
|"p":"2020-12-25T01:01:01"
|-
|Enuméré (par valeur)
|"p":1
|-
|Liste d'objets
|"p":[ {$key:"key", $uuid:"uuid", $where:"expression"}, ...],
|}

{{tip|Les références des objets passés dans des listes peuvent être définies par clé ($key), identifiant appelant ($uuid) ou expression ($where)
Exemple :
<pre>
{
"paramList":[
{"$key":"B5A28A92EB0C00020010000001F500A1"},
{"$where":"uneChaine like 'cN%'"}
]
}
</pre>
}}

===Résultat de type ressource===
Lorsque l'opération retourne un objet ou une liste d'objets ceux-ci sont retournés sous forme de ressource.

Par exemple :

<source lang="delphi">
//class Function GetWFClasseA(const iCode:string):WFClasseA;
begin
Result := WFClasseA.Find('(unCode = %1)','unCode',True,[iCode]);
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassea
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:41:41.015Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
}
]
}
}
</pre>

<source lang="delphi">
//Class Function GetWFClasseA(const iCodeLike:string):WFClasseAList;
begin
Result := WFClasseA.CreateListWhere('(unCode like %1)','','unCode',True,-1,[iCodeLike]);
end;
</source>

<pre>

POST http://localhost:8080/sdata/testsyfrewf/testapi/getwfclassealist
{
"result": {
"$baseUrl": "http://localhost:8080/sdata/testsyfrewf/",
"$title": "WFClasseA - -",
"$updated": "2021-01-29T12:49:14.061Z",
"$resources": [
{
"$key": "B5A28A92EB0C00020010000001B40002",
"$etag": "B5A28A92EB0C00020010000001B40002-0000028E00000001",
"stamp": "0000028E00000001",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaaky",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "une chaine 1",
"unEntier": 10,
"unEtat": {
"value": 1,
"title": "Etat 1"
},
"unStatus": 0,
"WFClasseCList": [
{
"$key": "B5A28A92EB0C000200140000020E000A",
"uneChaine": "Title 1-1",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C000200140000020E000B",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C00020014000002100079",
"uneChaine": "Title 1-0",
"unEntier": 0
},
{
"$key": "B5A28A92EB0C0002001400000210007A",
"uneChaine": "Title 1-1",
"unEntier": 0
}
]
},
{
"$key": "B5A28A92EB0C00020010000001B4000E",
"$etag": "B5A28A92EB0C00020010000001B4000E-0000025000000025",
"stamp": "0000025000000025",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaalb",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 2,
"title": "Etat 2"
},
"unStatus": 0
},
{
"$key": "B5A28A92EB0C00020010000001B4001A",
"$etag": "B5A28A92EB0C00020010000001B4001A-0000018B0000001A",
"stamp": "0000018B0000001A",
"Caption": "Title 1",
"unBool": false,
"unCode": "A1",
"unCompteur": {
"value": "aaaaaaaaaale",
"CounterName": "MonCompteur"
},
"unDouble": 0,
"uneChaine": "U1",
"unEntier": 10,
"unEtat": {
"value": 0,
"title": "Initial"
},
"unStatus": 0
},
......
]
}
}
</pre>

===Initialisation de la ressource===
Il est possible d'initialiser la ressource avant d'exécuter la méthode, par exemple pour un processus :

<source lang="delphi">
Type
TmyProcessus = class
public
procedure Execute(p:string);
property attString:string;
property attInt:Integer;
property attRef:TRefClass;
end;
</source>

<pre>
POST http://localhost:8080/sdata/testsyfrewf/myProcessus/execute
Request:
{
"$resource":{
"attString":"value 1",
"attInt":100,
"attRef":{"$url":"TRefClass('xxx')"},
},
"p":"value",
}
Response: 200 OK
{
"result":""
}
</pre>

==Requête Batch (POST $batch)==
Une requête Batch permet de réaliser plusieurs opérations de type GET,POST/PUT/DELETE/EXEC en une seule fois.

Une requête Batch contient un tableau de ressources, pour chaque ressource l'action et l'uri doivent être précisées :

<pre>
POST http://.../sdata/$batch
{
"$resources":[
{
"$httpMethod":"POST",
"$url":"gentiers/ttiers",
"code":"SYFRE2",
"caption":"syfre 2",
"sitesList":[
{
"code":"SITE1",
"caption":"site2 de syfre2",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$where":"codeISO = 'FRA'",
"$orderby":"codeISO"
}
}
}
]
}
]
}
</pre>

{{tip|Le format d'url complet de $Batch est https://hostname/service/server/sdata/l1000/-/-/$batch}}

===Gestion de la transaction dans un batch===
Par défaut les opérations réalisées sont unitaires (une transaction par ressource).

Pour réaliser une opération Batch atomique (une seule transaction longue) utilisez un élément de contrôle transaction :

Lorsque l'opération est atomique la réponse contient un élément $batch indiquant le statut de l'opération.

Le code de retour http est le code de retour de la dernière opération réalisée.

<pre>
POST http://localhost:8080/sdata/$batch
{
"$": {"$transaction":["atomic"]},
"$resources":[
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')",
"$uuid":"1",
"capital":{"value":7200,"CodeDevise":"USD"}
},
{
"$httpMethod":"PUT",
"$url":"gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$uuid":"2",
"capital":{"value":1000,"CodeDevise":"EUR"}
}
]
}
Response : 401
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "PUT",
"$httpMessage": "OK",
"$etag": "9D33A23CFA6A005500F6000000285DAE-0000018C00000001"
},
{
"$httpStatus": 410,
"$httpMessage": "Already Deleted",
"$uuid": "2",
"$url": "gentiers/ttiers('9D33A23CFA6A005500F600000023048C')",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis"
}
]
}
}
],
"$batch": {
"$httpStatus": 400,
"$httpMessage": "ROLLBACK",
"$": {
"$diagnoses": [
{
"severity": "error",
"message": "Already Deleted",
"sdataCode": "ApplicationDiagnosis",
"entry": {
"number": 2,
"uuid": "2"
}
}
]
}
}
}
</pre>

'''$transaction :'''

{|class="wikitable"
|-
!Commande
!Action
|-
|atomic
|Démarre une transaction longue
|-
|flush
|Force un batch de la transaction longue
|-
|commit
|Valide la transaction longue
|}
{{Tip|L'élément de contrôle de transaction peut être placé au niveau d'un ordre du lot.}}

===Execution de méthode dans un batch===
Utiliser le verbe EXEC pour exécuter une méthode

<pre>
POST http://localhost:8080/sdata/$batch
{
"$resources":[
{
"$httpMethod":"EXEC",
"$url":"testsyfrewf/wfprocessus/testmethod",
"$resource":{
"uneChaine":"value 1"
},
"p":"value 2"
}
]
}
Response : 200 OK
{
"$baseUrl": "http://localhost:8080/sdata/l1000/-/-/",
"$title": "$batch - -",
"$resources": [
{
"$httpStatus": 200,
"$httpMethod": "POST",
"$httpMessage": "Executed",
"$url": "testsyfrewf/wfprocessus/testmethod",
"$uuid": "",
"result": "value 1 value 2"
}
]
}
</pre>

==Schéma d'une ressource (GET $schema)==
Le schéma d'une ressource retourne la structure de la classe.

<pre>
GET http://localhost:8080/sdata/testsyfrewf/wfclassea/$schema
Response : 200 OK
{
"title": "Libellé de la Classe A",
"stereotype": "persistent",
"properties": {
"unBool": {
"type": "boolean",
"title": "Un Bool"
},
"unCode": {
"type": "string",
"title": "Un code"
},
"unCompteur": {
"type": "string"
},
"unDerive": {
"type": "string",
"title": "Un dérivé"
},
"unDouble": {
"type": "double",
"title": "Un double"
},
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEmail": {
"type": "string",
"title": "Un email"
},
"unEntier": {
"type": "int",
"title": "Un Entier"
},
"unEtat": {
"type": "integer",
"title": "Un Etat"
},
"unStatus": {
"type": "int",
"title": "Statut de l'objet (Panel)"
},
"WFClasseBRef": {
"type": {
"$ref": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseB/$schema",
"$relationship": "reference"
},
"title": "Référence B"
},
"WFClasseCList": {
"type": "array",
"item": {
"title": "Classe C",
"properties": {
"uneChaine": {
"type": "string",
"title": "une chaine"
},
"unEntier": {
"type": "int",
"title": "un entier"
}
}
}
}
},
"$url": "http://localhost:8080/sdata/l1000/testsyfrewf/-/WFClasseA/$schema"
}
</pre>

Le contenu de la réponse peut être configurée avec le paramètre "select", à défaut toutes les informations sont retournées.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|extensions
|Retourne uniquement les attributs issus d'extension
|-
|properties
|Retourne la liste de tous les attributs
|-
|selfProperties
|Retourne uniquement les attributs de la classe elle même
|-
|operations
|Retourne les opérations de la classe
|-
|compositions
|Retourne le schéma des classes composants
|}

Exemple : Retrouver uniquement les attributs d'extension d'une classe :

<pre>
GET http://localhost:8080/sdata/ttiers/$schema?select=extensions
{
"title": "Tiers",
"stereotype": "persistent",
"extensions": [
{
"class": "TTiers_esmPackage",
"title": "Extension de TTiers",
"package": "esmPackage"
}
],
"properties": {
"esmCode": {
"type": "string",
"extension": "TTiers_esmPackage",
"title": "un code esm"
}
},
"$url": "http://localhost:8080/sdata/gentiers/TTiers/$schema"
}
</pre>

==Modèle de ressource (GET $template)==
Le modèle de ressource retourne une ressource initialisée

<pre>
GET http://localhost:8080/sdata/gcimport/TImportContratCommercial/$template
Response : 200 OK

{
"$url": "http://localhost:8080/sdata/l1000/gcimport/-/TImportContratCommercial",
"stamp": "000001D900000001",
"acompte": 0,
"affaire": "",
"budget": "",
"Caption": "",
"commandeEngagement": false,
"commercial": "",
"coursDevise": {
"value": 1,
"CodeDevise": "",
"Date": "1899-12-30T00:00:00.000Z",
"TCConv": "",
"TCValue": 0,
"RPConv": "",
"RPValue": 0
},
"coursNegocie": false,
"dateCommande": "1899-12-30T00:00:00.000Z",
"dateLivraison": "1899-12-30T00:00:00.000Z",
"devise": "",
"donneeEDI1": "",
"donneeEDI2": "",
"donneeEDI3": "",
"donneeEDI4": "",
"donneeEDI5": "",
"echeancement": "",
"etablissement": "",
"exonereTaxe": "",
"exonereTVA": "",
"gestionTransport": {
"value": 0,
"title": "Automatique"
},
"immobilisation": {
"value": 0,
"title": "B&S"
},
"ImportCCDetailList": [],
"importeGMAO": false,
"importerRemisePied": false,
"ImportSiteAdresse": {},
"incoterm": "",
"MentionExonerationTVA": "",
"posteBudgetaire": "",
"pourcentAcompte": {
"value": 0,
"Decimales": 2
},
"pourcentRemisePied": {
"value": 0,
"Decimales": 2
},
"reference": "",
"referenceMandat": "",
"regimeTVA": "",
"roleTiers": "",
"roleTiersLivre": "",
"SessionImportation": {},
"typeFacturation": {
"value": 0,
"title": "HT"
}
}
</pre>

Voir aussi :

* [[SData|Point d'accès et url SData]]
* [[Gestion des jetons d'authentification (Administration)|Gestion des jetons d'authentification]]
* [[API Json (SData)|API SData en mode json]]

Voir aussi les exemples suivants :

* [[Utilisation du contrôleur de partage (API)|Utilisation du contrôleur de partage]]
* [[Interrogation des écritures (API)|Interrogation des écritures avec l'API SData]]
* [[Interrogation des fournisseurs (API)|Interrogation des fournisseurs avec l'API SData]]
* [[Creation d'un fournisseur (API)|Création d'un fournisseur avec l'API SData]]
* [[Import_de commandes_(API)|Import de commandes avec l'API SData]]
* [[Import_d%27écritures_(API)|Import d'écritures avec l'API SData]]
* [[Gestion des réceptions fournisseurs (API)|Gestion des réceptions fournisseurs avec l'API SData]]
* [[Facturation d'un bon de livraison (API)|Facturation d'un bon de livraison avec l'API SData]]
* [[Creation_d%27un_Tiers_et_son_compte_bancaire_(API)|Creation_d'un Tiers et son compte bancaire (API)]]
[[Category:SData]]

API Json (SData)

2026-02-26T15:39:09Z

Syfre :

==Prérequis==

L'API Json est une variante de [[Ressource (sdata)|l'API SData en mode ressource]]

Les informations de connexion et les schémas d'URL sont identiques.

==Méthode JSON==

Dans ce mode, au lieu de manipuler des ressources retournées en xml ou json, le client appele des méthodes en passant en paramètre un payload json et en recevant en retour une responde json.

La signature de ces méthodes doit être :

<pre>
procedure foo(req:TJson; out resp:TJson);
</pre>

Ces méthodes peuvent être membre de n'importe quelle classe non persistante, ou d'une classe support d'un paquet de service local.

==Paquet de service local==

L'utilisation d'un paquet de service local permet d'appeler directement les méthodes de la classe support du paquet.

Par exemple :

[[image:api-json-1.png|800px]]

Vous pouvez appeler directement la méthode myMethodJson() sans explicitement indiquer la classe support :

<pre>
http://localhost:8080/sdata/dsmPaquetDeService/myMethodJson
</pre>

[[image:api-json-2.png|800px]]

==Paquet de classes non persistantes ==

Les méthodes Json membres de classes non persistantes peuvent aussi être appelées.

Par exemple :

[[image:api-json-3.png|800px]]

Dans ce cas vous devez spécifier le nom de la classe dans l'URL d'appel de la méthode.

<pre>
http://localhost:8080/sdata/dsmPaquetAPI/myMethodJson
</pre>

[[image:api-json-4.png|800px]]

Voir aussi:

* [[Ressource (sdata)|API SData en mode ressource]]

[[Category:SData]]

API Json (SData)

2026-02-26T15:38:22Z

Syfre :

Fichier:Api-json-4.png

2026-02-26T15:37:57Z

Syfre :

Fichier:Api-json-3.png

2026-02-26T15:35:17Z

Syfre :

API Json (SData)

2026-02-26T15:27:21Z

Syfre : Page créée avec « ==Prérequis== L'API Json est une variante de l'API SData en mode ressource Les informations de connexion et les schémas d'URL sont identiques. =... »

Fichier:Api-json-2.png

2026-02-26T15:23:26Z

Syfre :

Fichier:Api-json-1.png

2026-02-26T15:19:21Z

Syfre :

Gestionnaire de Service 1000

2026-02-18T18:43:29Z

Syfre : /* Contexte */

==Contexte==
Dans le cadre de l'utilisation du service dans le cloud, le contrôleur de service n'est plus utilisé.

Afin de mettre à jour le service, un nouvel exécutable est utilisé, le gestionnaire de service.

Ses deux uniques fonctions sont
* De redémarrer le service si celui s'arrête de façon inopinée.
* De mettre à jour le service si une nouvelle version est présente dans le répertoire "install"

Ainsi, le service FRP 1000 peut se mettre à jour en téléchargeant la mise à jour et en s'arrêtant. Le gestionnaire se charge de remplacer la version courante et de redémarrer.

{{tip|Dans un cluster chaque noeud se met à jour independemment}}

{{tip|Le gestionnaire de service ne permet de gèrer l'exécution que d'un seul service par répertoire, si vous démarrez plusieurs services sur la même machine vous devez déployer un répertoire containeur par service.}}

===Installation avec le gestionnaire de service===

Arborescence des fichiers :

<pre>
<répertoire du gestionnaire>
serviceL1000Loader.exe
<server>
serviceL1000.exe
... Tous les fichiers du container ...
<install>
fichiers temporaires des fichiers à installer
</pre>

===Nouvelle installation===

Le gestionnaire de service s'installe via l'admin manager.

==Installation avec migration==

* Sauvegardez le fichier serveur .ini
* Désinstallez le service par Windows
* Installez le loader via le l'admin en ligne de commande
* Recopiez le fichier .ini dans le répertoire server.

{{tip|En mode cluster il est nécessaire de réenregistrer le gestionnaire de service manuellement en passant les paramètres adéquats sur la ligne de commande}}

==Installation manuelle==
'''Désenregistrement des services Windows :'''

* Désenregistrez le service controlleur
* Désenregistrez les services 1000 en notant les paramètres passés sur leur ligne de commande

'''Création de la structure de répertoire :'''

* Créez un répertoire au même niveau que le répertoire du service existant.
* Copiez l'exécutable serviceL1000Loader.exe
* Créez un répertoire "server"
* Copiez l'ancien répertoire du service dans ce répertoire "server"
* Créez un répertoire "install"

'''Enregistrement des gestionnaires en service Windows :'''

* Enregistrer le serviceL1000Loader autant fois que de serviceL1000 démarrés avec même les paramètres que les serviceL1000.

{{warning|L'utilisation du gestionnaire est incompatible avec celle du contrôleur, vous devez désinstaller le contrôleur et configurer les services manuellement dans le fichier de configuration.}}

[[Category:Version1000]]
[[Category:Serveur]]

SQL Server 2025 (rdbms)

2026-02-07T08:33:46Z

Syfre : /* Mode Optimized locking */

===Mode Optimized locking===

SQL Serveur 2025 supporte une nouvelle option de gestion des verrous qui peut permettre dans certain cas de réduire le nombre de verrous posés durant une transaction et de limiter l'escalation de verrous vers le niveau Table .

Ce mode est disponible sur toutes les éditions sauf Express.

Ce mode n'est pas actif par défaut sur la version On Premise.

'''Pour activer l'optimisation de verrous'''

Activer le mode snapshot avec READ_COMMITTED_SNAPSHOT :
* Déconnecter tous les utilisateurs
* Exécuter l’ordre suivant :

* ALTER DATABASE ... SET READ_COMMITTED_SNAPSHOT ON

Activer le mode Accelerated Database Recovery :

* ALTER DATABASE ... SET ACCELERATED_DATABASE_RECOVERY = ON;

Activer le mode optimisation des verrous :

* ALTER DATABASE ... SET OPTIMIZED_LOCKING = ON

Pour vérifier que le mode est actif :

<pre>
SELECT database_id,
name,
is_accelerated_database_recovery_on,
is_read_committed_snapshot_on,
is_optimized_locking_on
FROM sys.databases
WHERE name = ....;
</pre>

Voir aussi :

* [[SQL_Server_2005_(rdbms)|SQL Server 2005, mode snapshot]]

[[Category:Base de données]]

SQL Server 2025 (rdbms)

2026-02-07T08:33:31Z

Syfre : /* Mode Optimized locking */

===Mode Optimized locking===

SQL Serveur 2025 supporte une nouvelle option de gestion des verrous qui peut permettre dans certain cas de réduire le nombre de verrous posés durant une transaction et de limiter l'escalation de verrous vers le niveau Table .

Ce mode est disponible sur toutes les éditions sauf Express.

Ce mode n'est pas actif par défaut sur la version On Premise.

'''Pour activer l'optimisation de verrous'''

Activer le mode snapshot READ_COMMITTED_SNAPSHOT :
* Déconnecter tous les utilisateurs
* Exécuter l’ordre suivant :

* ALTER DATABASE ... SET READ_COMMITTED_SNAPSHOT ON

Activer le mode Accelerated Database Recovery :

* ALTER DATABASE ... SET ACCELERATED_DATABASE_RECOVERY = ON;

Activer le mode optimisation des verrous :

* ALTER DATABASE ... SET OPTIMIZED_LOCKING = ON

Pour vérifier que le mode est actif :

<pre>
SELECT database_id,
name,
is_accelerated_database_recovery_on,
is_read_committed_snapshot_on,
is_optimized_locking_on
FROM sys.databases
WHERE name = ....;
</pre>

Voir aussi :

* [[SQL_Server_2005_(rdbms)|SQL Server 2005, mode snapshot]]

[[Category:Base de données]]

SQL Server 2005 (rdbms)

2026-02-07T08:32:39Z

Syfre :

===Nouveau mode d’isolation transactionnelle===
SQL Serveur supporte depuis la version 2005 un nouveau mode d’isolation transactionnel appelé « Snapshot ».

Ce mode, identique au mode de fonctionnement d’Oracle, apporte plusieurs avantages :
* Les lectures ne sont pas verrouillées par les mises à jour. Ce point permet d’améliorer grandement la disponibilité de l’application lorsque des traitements effectuant de nombreuse mise à jour sont en cours d’exécution.
* Les éditions qui ont besoins d’une cohérence des lectures ne sont pas bloquantes pour les autres utilisateurs.
Les inconvénients du mode Snapshot sont :
* Les mises à jour peuvent être ralenties du fait de la gestion du suivi de version des enregistrements.
* Chaque enregistrement de la base nécessite 16 caractères supplémentaires, ce qui peut augmenter légèrement la taille des bases de données
* Les lectures utilisant le suivi de version nécessite de réaliser des « photos » de la base de données qui sont stockées dans la base de données temporaire du serveur. Celle-ci doit être correctement et largement dimensionnée.
* Certaine tournure de code peuvent ne plus fonctionner du fait que les lectures ne peuvent pas voir les données non validées.

===Pilote SQL Serveur===

Le pilote SQL Serveur supporte le nouveau mode SnapShot sans toutefois l’imposer :

* Si le mode SnapShot est activé dans la base de données il est utilisé, sinon il n’est pas utilisé.
* Lors de la création d’une nouvelle base de données le mode SnapShot est activé.

===Activer le mode SnapShot sur une base existante.===
Pour activer le mode SnapShot sur une base existante :
# Déconnecter tous les utilisateurs
# Exécuter l’ordre suivant :
# ALTER DATABASE MaBasedeDonnee SET READ_COMMITTED_SNAPSHOT ON

Pour vérifier que la base est en mode SnapShot :

SELECT is_read_committed_snapshot_on FROM sys.databases WHERE name= 'YourDatabase'

Voir aussi :

* [[SQL_Server_2025_(rdbms)|SQL Server 2025, optimized locking]]

[[Category:Base de données]]

SQL Server 2025 (rdbms)

2026-02-07T08:31:48Z

Syfre :

===Mode Optimized locking===

SQL Serveur 2025 supporte une nouvelle option de gestion des verrous qui peut permettre dans certain cas de réduire le nombre de verrous posés durant une transaction et de limiter l'escalation de verrous vers le niveau Table .

Ce mode est disponible sur toutes les éditions sauf Express.

Ce mode n'est pas actif par défaut sur la version On Premise.

'''Pour activer l'optimisation de verrous'''

Activer le mode READ_COMMITTED_SNAPSHOT :
* Déconnecter tous les utilisateurs
* Exécuter l’ordre suivant :

* ALTER DATABASE ... SET READ_COMMITTED_SNAPSHOT ON

Activer le mode Accelerated Database Recovery :

* ALTER DATABASE ... SET ACCELERATED_DATABASE_RECOVERY = ON;

Activer le mode optimisation des verrous :

* ALTER DATABASE ... SET OPTIMIZED_LOCKING = ON

Pour vérifier que le mode est actif :

<pre>
SELECT database_id,
name,
is_accelerated_database_recovery_on,
is_read_committed_snapshot_on,
is_optimized_locking_on
FROM sys.databases
WHERE name = ....;
</pre>

Voir aussi :

* [[SQL_Server_2005_(rdbms)|SQL Server 2005, mode snapshot]]

[[Category:Base de données]]

SQL Server 2025 (rdbms)

2026-02-07T08:29:24Z

Syfre : Page créée avec « ===Mode Optimized locking=== SQL Serveur 2025 supporte une nouvelle option de gestion des verrous qui peut permettre dans certain cas de réduire le nombre de verrous pos... »

===Mode Optimized locking===

SQL Serveur 2025 supporte une nouvelle option de gestion des verrous qui peut permettre dans certain cas de réduire le nombre de verrous posés durant une transaction et de limiter l'escalation de verrous vers le niveau Table .

Ce mode est disponible sur toutes les éditions sauf Express.

Ce mode n'est pas actif par défaut sur la version On Premise.

'''Pour activer l'optimisation de verrous'''

Activer le mode READ_COMMITTED_SNAPSHOT :
* Déconnecter tous les utilisateurs
* Exécuter l’ordre suivant :

* ALTER DATABASE ... SET READ_COMMITTED_SNAPSHOT ON

Activer le mode Accelerated Database Recovery :

* ALTER DATABASE ... SET ACCELERATED_DATABASE_RECOVERY = ON;

Activer le mode optimisation des verrous :

* ALTER DATABASE ... SET OPTIMIZED_LOCKING = ON

Pour vérifier que le mode est actif :

<pre>
SELECT database_id,
name,
is_accelerated_database_recovery_on,
is_read_committed_snapshot_on,
is_optimized_locking_on
FROM sys.databases
WHERE name = ....;
</pre>

[[Category:Base de données]]

OnCreateEventId (class)

2026-01-09T13:48:28Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function OnCreateEventID():string;</source>

Retourne l'identifiant de l'évènement de création d'un objet de cette classe.

{|class="wikitable"
|-
|Return
|L'identifiant de l'évènement
|}

Exemple

<source lang='delphi'>
Type
MyClass = class(TdbObject)
//...
property CanStart:boolean;
end;

MyTask = class(TitTask)
Function Execute():boolean;
Function doExecute(obj:TitObject):boolean;
end;

Function MyTask.doExecute(obj:TitObject):boolean;
begin
if obj is MyClass then
begin
if (obj as MyClass).CanStart then
begin
AddMessage(Format('object %s ...',[(obj as MyClass).Caption]));
// do something ...
end
else
begin
AddMessage(Format('objet %s ne peut pas ...'),[(obj as MyClass).Caption]));
end;
Result := True;
end
else Result := False;
end;

Function MyTask.Execute():boolean;
var aMsg:TdbmQueueMessage;
begin
Result := False;
aMsg := ReceivedMsg as TdbmQueueMessage;
if Assigned(aMsg) then
begin
if Assigned(SourceObject) then
begin
Result := doExecute(SourceObject);
end;
end;
end;

//procedure RegisterTasks;
begin
MyClass.RegisterOnCreateEvent();

MyTask.Subscribe(
MyClass.OnCreateEventId(),
[],[]
);
end;
</source>

Voir aussi :

* [[RegisterOnCreateEvent_(class)|RegisterOnCreateEvent]]
* [[OnChangeEventId_(class)|OnChangeEventId]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

OnDeleteEventId (class)

2026-01-09T13:43:06Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function OnDeleteEventID():string;</source>

Retourne l'identifiant de l'évènement de suppression d'un objet de cette classe.

{|class="wikitable"
|-
|Return
|L'identifiant de l'évènement
|}

Exemple

<source lang='delphi'>
</source>

Voir aussi :

* [[RegisterOnDeleteEvent_(class)|RegisterOnDeleteEvent]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

RegisterOnDeleteEvent (class)

2026-01-09T13:42:55Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function RegisterOnDeleteEvent():string;</source>

Enregistre la classe d'évènement de suppression de cette classe.

{|class="wikitable"
|-
|Return
|L'identifiant de l'évènement
|}

Exemple

<source lang='delphi'>
</source>

Voir aussi :

* [[OnDeleteEventId_(class)|OnDeleteEventId]]
* [[RegisterOnCreateEvent_(class)|RegisterOnCreateEvent]]
* [[RegisterOnChangeEvent_(class)|RegisterOnChangeEvent]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

RegisterOnDeleteEvent (class)

2026-01-09T13:42:36Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function RegisterOnDeleteEvent():string;</source>

Enregistre la classe d'évènement de suppression de cette classe.

{|class="wikitable"
|-
|Return
|L'identifiant de l'évènement
|}

Exemple

<source lang='delphi'>
</source>

Voir aussi :

* [[OnDeleteEventId_(class)|OnDeleteEventId]]
* [[RegisterOnCreateEvent_(class)|RegisterOnCreateEvent]]
* [[RegisterOnDeleteEvent_(class)|RegisterOnDeleteEvent]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

RegisterOnChangeEvent (class)

2026-01-09T13:42:15Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function RegisterOnChangeEvent(const iProperty:string):string;</source>

Enregistre la classe d'évènement de modification d'un attribut de cette classe.

{|class="wikitable"
|-
|iProperty
|L'attribut modifié
|-
|Return
|L'identifiant de l'évènement
|}

Exemple

<source lang='delphi'>
// see onChangeEventId
</source>

Voir aussi :

* [[OnChangeEventId_(class)|OnChangeEventId]]
* [[RegisterOnCreateEvent_(class)|RegisterOnCreateEvent]]
* [[RegisterOnDeleteEvent_(class)|RegisterOnDeleteEvent]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

OnChangeEventId (class)

2026-01-09T13:41:16Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function OnChangeEventID(const iProperty:string; const iOldValue:variant; const iNewValue:variant):string;</source>

Retourne l'identifiant de l'évènement de modification d'un attribut d'un objet de cette classe.

{|class="wikitable"
|-
|iProperty
|Nom de l'attribut
|-
|oldValue
|Ancienne valeur de l'attribut
|-
|newValue
|Nouvelle valeur de l'attribut
|-
|Return
|L'identifiant de l'évènement
|}

{{tip|La valeur NULL peut être utilisée pour indiquer "toute valeur"}}

Exemple :

<source lang='delphi'>

//function TTestTask.doExecute(obj:TitObject):boolean;
begin
if obj is WFClasseA then
begin
//.... do something
Result := True;
end
else Result := False;
end;

//function TTestTask.Execute:boolean;
var aMsg:TdbmQueueMessage;
begin
Result := False;
aMsg := ReceivedMsg as TdbmQueueMessage;
if Assigned(aMsg) then
begin
if Assigned(SourceObject) then
begin
Result := doExecute(SourceObject);
end;
end;
end;

//Procedure TestRegisterTasks;
begin
WFClasseA.RegisterOnChangeEvent('unEtat');
TTestTask.Subscribe(WFClasseA.OnChangeEventId('unEtat',NULL {NULL means any value} ,WFCAState_Etat2),['unCode','unEntier'],['X',2]);
end;
</source>

Voir aussi :

* [[RegisterOnChangeEvent (class)|RegisterOnChangeEvent]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

RegisterOnCreateEvent (class)

2026-01-09T13:40:57Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function RegisterOnCreateEvent():string;</source>

Enregistre la classe d'évènement de création de cette classe.

{|class="wikitable"
|-
|Return
|L'identifiant de l'évènement
|}

Exemple

<source lang='delphi'>
// see OnCreateEventId
</source>

Voir aussi :

* [[OnCreateEventId_(class)|OnCreateEventId]]
* [[RegisterOnChangeEvent_(class)|RegisterOnChangeEvent]]
* [[RegisterOnDeleteEvent_(class)|RegisterOnDeleteEvent]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

OnCreateEventId (class)

2026-01-09T13:39:37Z

Syfre :

{{Version1100}}
<source lang='delphi'>class function OnCreateEventID():string;</source>

Retourne l'identifiant de l'évènement de création d'un objet de cette classe.

{|class="wikitable"
|-
|Return
|L'identifiant de l'évènement
|}

Exemple

<source lang='delphi'>
Type
MyClass = class(TdbObject)
//...
property CanStart:boolean;
end;

MyTask = class(TitTask)
Function Execute():boolean;
Function doExecute(obj:TitObject):boolean;
end;

Function MyTask.Execute():boolean;
var aMsg:TdbmQueueMessage;
begin
Result := False;
aMsg := ReceivedMsg as TdbmQueueMessage;
if Assigned(aMsg) then
begin
if Assigned(SourceObject) then
begin
Result := doExecute(SourceObject);
end;
end;
end;

Function MyTask.doExecute(obj:TitObject):boolean;
begin
if obj is MyClass then
begin
if (obj as MyClass).CanStart then
begin
AddMessage(Format('object %s ...',[(obj as MyClass).Caption]));
// do something ...
end
else
begin
AddMessage(Format('objet %s ne peut pas ...'),[(obj as MyClass).Caption]));
end;
Result := True;
end
else Result := False;
end;

//procedure RegisterTasks;
begin
MyClass.RegisterOnCreateEvent();

MyTask.Subscribe(
MyClass.OnCreateEventId(),
[],[]
);
end;
</source>

Voir aussi :

* [[RegisterOnCreateEvent_(class)|RegisterOnCreateEvent]]
* [[OnChangeEventId_(class)|OnChangeEventId]]

{{Footer|Classes métiers (tech)}}
[[category:Classes métiers]]
[[Category:Version1100]]

IsoEndOfWeek (rtl)

2025-12-26T13:58:55Z

Syfre :

<source lang='delphi'>Function IsoEndOfWeek(dt:DateTime):DateTime;</source>

Cette fonction retourne la date de la fin de la semaine (Dimanche) d'une date suivant la norme ISO-8601.

{|class="wikitable"
|-
|Result
|Une date représentant la fin de la semaine.
|-
|dt
|Date à convertir.
|}

La partie représentant l'heure de la date est conservée.

Semaine ISO:
: Premier jour : Lundi
: Dernier jour : Dimanche

Exemple

<source lang='delphi'>
begin
end;
</source>

Voir aussi:

{{Footer|Développement DSM}}
[[category:RTL Date et heure]]

EndOfWeek (rtl)

2025-12-26T13:55:09Z

Syfre :

<source lang='delphi'>Function EndOfWeek(const DT:DateTime):DateTime;</source>

Cette fonction retourne la date du dernier jour de la semaine d'une date.

{|class="wikitable"
|-
|Result
|Le jour de fin de semaine (Samedi) de la date.
|-
|DT
|Date.
|}

{{info|Cette fonction n'est pas compatible avec la norme ISO-8601. Voir les fonctions Isoxxx}}

Exemple

<source lang='delphi'>
begin
end;
</source>

Voir aussi:

*[[IsoEndOfWeek (rtl)|IsoEndOfWeek]]

{{Footer|Développement DSM}}
[[category:RTL Date et heure]]

Version 2025 r2 (release note)

2025-12-23T11:03:31Z

Syfre : /* Interface */

{{version2025r2}}
__TOC__

''' PREVIEW '''

==Langage==

* Valeur par défaut de paramètre
: Il est possible de définir des valeurs par défaut aux paramètres des méthodes

<source lang="delphi">
MyClass = Class(TitObject)
Procedure TestDeffParams;
Procedure TestDefParamBool(p1:string; p2:boolean=true);
Procedure TestDefParamJson(p1:string; p2:TJson=nil);
Procedure TestDefParamJson2(p1:string; p2:TJson='{a:false}');
Procedure TestDefParamEnum(p1:string; p2:Integer=WFCAState_Etat2);
Procedure TestDefParamMulti(p1:string; p2:string='a'; p3:string='b');
Function TestDefParamOne(p1:string='a'):string;
Function TestDefParamFunc(p1:string='a'):string;
end;

Procedure MyClass.TestDefParamJson(p1:string; p2:TJson=nil);
var json:TJson;
begin
json := TJsonStruct.Create('{}');
//
// use Assigned insted of p2<>nil
//
if assigned(p2) then json.addStruct('p2',p2);
end;

Procedure MyClass.TestDeffParams;
var V:string;
begin
V := TestDefParamFunc('c');
ShowMessage(V);

TestDefParamOne;
TestDefParamOne();
TestDefParamOne('x');

TestDefParamMulti('a');
TestDefParamMulti('a','1');
TestDefParamMulti('a','1','2');

TestDefParamBool('a');
TestDefParamBool('a',false);
TestDefParamBool('a',true);

TestDefParamJson2('b');
TestDefParamJson2('b','{a:true}');

TestDefParamEnum('c');
TestDefParamEnum('c',WFCAState_Final);
end;
</source>

* Paramètre de type classe
: Les paramètres de type classe peuvent être passé directement

<source lang="delphi">
Type
MyClass1 = class
class procedure foo(rg:TRegClass);
end;

MyClass2 = class
....
end;

MyClass3 = class
procedure oldbar();
procedure newbar();
end;

class procedure MyClass1.foo(rg:TRegClass);
begin
// => MyClass2
showMessage(rg.aClassName);
end;

procedure MyClass3.oldbar();
var rg:TRegClass;
begin
ModelManager.FindClass('MyClass2');
myClass1.foo(rg);
end;

procedure MyClass3.newbar();
begin
myClass1.foo(MyClass2);
end;
</source>

==Json==
* Opérateur In
: Un json de type structure supporte l'opérateur In

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):boolean;
begin
Result := false;
if 'a' in p then
begin
Result := True;
end;
end;

var js:TJson;
begin
js := TJson.Create('{a:true}');
if _foo(js) then showMessage('ok') else showMessage('nok');
end;
</source>

* Getter et Setter
: Un json de type structure supporte l'accès direct aux valeur des membres

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):boolean;
begin
Result := false;
if 'a' in p then
begin
Result := p['a'];
end;
end;

var js:TJson;
begin
js := TJson.Create('{a:true}');
js['b'] := False;
js['a'] := not js['b'];
if _foo(js) then showMessage('ok') else showMessage('nok');
end;
</source>

* Constructeur implicite
: Un paramètre TJson peut être instancié à partir d'une chaine de caractère

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):boolean;
begin
Result := false;
if 'a' in p then
begin
Result := p['a'];
end;
end;

begin
if _foo('{a:true}') then showMessage('ok') else showMessage('nok');
end;
</source>

{{tip|La chaine doit être une constante, l'instanciation à partir d'une chaîne construite dynamiquement ne marche pas :

<source lang="delphi">
Procedure TestJson;

function _foo(p:TJson):string;
begin
Result := false;
if 'a' in p then
begin
Result := p['a'];
end;
end;

var v:string;
begin
v := 'une chaine';
if _foo('{a:"'+uneChaine+'"}')<>'' then showMessage('ok') else showMessage('nok'); // don't work !
end;
</source>

}}

* Enumérateurs
: Un json de type strutucture supporte l'énumérateur sur les clés
: Un json de type tableau supporte l'énumérateur sur les éléments

<source lang="delphi">
//Procedure TestJson;

procedure _enumValues(p:TJson);
var i:Integer; V:Variant;
begin
forEach V in p index i do
begin
showMessageFmt('%d:%s',[i,V]);
end;
end;

procedure _enumKeys(p:TJson);
var i:Integer; Key,Keys,stag:string;
begin
Keys := ''; stag := '';
forEach key in p index i do
begin
Keys := Keys+stag+inttostr(i)+':'+key;
stag := ',';
end;
showMessage(Keys);
end;

begin
_enumKeys('{a:true, b:false}');
_enumValues('[{a:true, b:false},{a:false, b:true}]');
end;
</source>

==Modèle==

===Classes===

* Méthode AllocOID

<source lang="delphi">class function AllocOID:TOID;</source>
* Alloue un oid de la classe
: Peut être utile dans les tests unitaires

* Méthode ToJson()

<source lang="delphi">procedure ToJson(SA:variant);</source>

* Sérialize l'objet en json
: SA peut être un TJsonArray ou un TJsonStruct

===Classes SQL===

* Options de rôle : NoRefIndex

* Options de rôle : NoForeignKey

==Script==

===Trace===

<source lang="delphi">procedure dbgClear();</source>
: Vide la trace

<source lang="delphi">procedure dbgEnable(value:boolean);</source>
: Active / désactive la trace

===Vue locale===

* Une vue locale peut contenir des attributs "oidXXX" sans définir le rôle

'''Exemple:'''

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:TEnum(enumName) = ...;
oidRef:TOID = oidrefB;
..
idRefB:TOID = oidrefB notInSelect;
[ (idRefB=%ArgRefB) and ....]
end;
</source>

* Une vue locale peut contenir des attributs non mappés dans la définition, ces attributs peuvent ensuite être mappés dynamiquement par le selecteur en utilisant addColumn()

'''Exemple:'''

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
ACount:Integer = count(oid)
oidRef:TOID;
codeRef:string;
libelleRef:string;
..
[ ...]
end;

var sel:TSelector;
begin
sel := vue1.createSelector();
case iGroupBy of
'refB':
begin
sel.AddColumn('oidrefB','oidRef');
sel.AddColumn('refB.code','codeRef');
sel.AddColumn('refB.Caption','libelleRef');
end;
'refC':
begin
sel.AddColumn('oidrefC','oidRef');
sel.AddColumn('refC.code','codeRef');
sel.AddColumn('refC.Caption','libelleRef');
end;
end;
end;
</source>

* Paramètre de type de donnée

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:TEnum(enumName) = ...;
end;
</source>

* Qualifier d'attribut NotInGroupBy

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:string = expression('...') notInGroupBy;
end;
</source>

* Héritage de vue locale

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
p1:string = ...;
[...]
end;

vue2 = viewOf(vue1)
p2:string = ...;
[inherited and (...)]
end;
</source>

'''Exemple:'''

<source lang="delphi">
//function GetSelector(iGroupBy:string; iFilter:TJsonArray):TSelector;
Type
// défini une classe de base avec tous les filtres
//
vueEcritureLettrage = viewOf(TEcriture)
lettrable:boolean = compteGeneral.lettrable notInSelect;
idEtablissement:TOID = piece.oidEtablissement notInSelect;
idCompteGeneral:TOID = oidCompteGeneral notInSelect;
idRoleTiers:TOID = oidroleTiers notInSelect;
[(lettrable=true)
and ((oidLettrageEcriture='') or (dateLettrage=0))
and (typeEcriture<>0)
and (piece.lot.origineLot<>0)
and (eDate>=%ArgDateInf)
and (eDate<=%ArgDateSup)
and (idEtablissement=%ArgEtablissement)
and (idCompteGeneral=%ArgCompteGeneral)
and (idRoleTiers=%ArgRoleTiers)
]
end;

// Hérite de tous les filtres
//
vueEcritureLettrageGroupBy = viewOf(vueEcritureLettrage)
dateMin:TDatetime = min(eDate);
dateMax:TDatetime = max(eDate);
ACount:Integer = count(oid);
credit:Currency = sum('credit:TCValue');
debit:Currency = sum('debit:TCValue');
solde:Currency = sumDiff(debit,credit);
[inherited]
end;

begin
Result := vueLettrageGroupBy.CreateSelector('','',True,[]);
end;
</source>

* Scope de vue locale

Une vue locale peut être référencée en dehors de la méthode où elle est définie.

<source lang="delphi">
procedure Class1.foo;
Type
vue1 = viewOf(ClassA)
p1:string = ...;
end;
begin
...
end;

procedure Class2.bar;
Type
vue2 = viewOf(class1.foo.vue1)
p2:string = ...;
end;
begin
...
end;
</source>

* Expression Exists()

Une expression existe peut être utilisée dans les filtres comme une valeur logique

{{tip|Une expression Exists() est beaucoup plus rapide qu'un "Count<>0"}

<source lang="delphi">
Type
vue1 = viewOf(ClassA)
id:string = ...;
end;

vue2 = viewOf(ClassB)
id:string = ...;
bb:boolean = vue1.Exists('(id=self.id)',True,[]) notInSelect;
[(bb=true) and (....)]
end;
</source>

* Expression de Sous requête

Une expression peut être définie par une sous requête

<source lang="delphi">
Type
VueTauxADate = ViewOf(TTauxADate)
idTVA : TOid = oidTVA;
tDate : Date = tDate;
taux : float = taux;
end;

vueMontantTVA = viewOf(TEcriture)
dateEcriture:TDatetime=eDate notInSelect;
oidTVA:TOID = ProfilTVA.oidTVA notInSelect;
oidPiece:TOID = oidPiece;
montantTVAReel:Currency = vueTauxADate.select('taux * self.montant_TCValue /100','(tDate<=self.dateEcriture)and(idTVA=self.oidTVA)','',True,[]);
montantTVAReel_CodeDevise:string = montantTVAReel:CodeDevise;
end;
</source>

==ToJson==

Permet de sérialiser l'objet ou l'ensemble d'objets au format json compatible avec les tables du client React

<pre> procedure TObject.ToJson(SA:TJsonArray);</pre>
<pre> procedure TObject.ToJsonEx(SA:TJsonArray; iOptions:TSerializeJsonOptions);</pre>
<pre> procedure TSelector.ToJson(SA:TJsonArray);</pre>
<pre> procedure TSelector.ToJsonEx(SA:TJsonArray; iOptions:TSerializeJsonOptions);</pre>
<pre> procedure TRole.ToJson(SA:TJsonArray);</pre>

TSerializeJsonOptions :

* sjoIdAsGuid
: Le membre id de la sérialisation sera un GUID

* sjoIdAsOid
: Le membre id de la sérialisation sera l'OID de l'objet

<source lang="delphi">

//procedure GetData(SRows:TJsonArray);
Type
myView = viewOf(...)
...
end;

var sel:TSelector;
begin
// Selector to retreive the data
//
sel := myView.CreateSelector('','',True,[]);
sel.ToJson(SRows);
end;
</source>

===Formats===

Le formattage de la sérialisation des propriétés peut être controllé par les propriétés du type

<pre>
Type
vue = viewOf(...)
p:string(typeParam1,typeParam2,typeParam3) = x;
end;
</pre>

{|class="wikitable"
|-
!Type de l'attribut
!TypeParam1
!TypeParam2
!TypeParam3
!Usage
|-
|Currency
|fmtTC
| -
| -
|Le montant est considéré en valeur de tenue de compte
|-
|Currency
|fmtRP
| -
| -
|Le montant est considéré en valeur de reporting
|-
|String contenant un TfwParameters
|fmtParameters
| -
| -
|Valeur des paramètres
|-
|String contenant un TfwParameters
|fmtParameter
|Nom du paramètre
|Valeur par défaut si le paramètre n'existe pas
|Valeur du paramètre
|-
|String
|fmtTaskCategory
| -
| -
|Catégorie de tâche
|-
|oid de TdbfDocument
|fmtDocumentUrl
|Paramètre optionnel contenant le nom du document
|Paramètre optionnel contenant une url externe
|Lien sur le document
|-
|Datetime
|fmtUTC
| -
| -
|La date en considérée UTC et convertie en date locale
|-
|Integer (idOTP)
|fmtClassLabel
| -
| -
|Le libellé de la classe
|-
|Integer (idOTP)
|fmtClassName
| -
| -
|Le nom de la classe
|}

==Sélecteur==

* lastOpeStamp, lastOpeAffected, lastOpeFirstOID
: Attributs mis à jour par la dernière opération assembliste.

* operationId, operation
: Permet d'enregistrer les opérations dans la table TsqlOperation
: S'applique à CopyTo()

* RmvParameter()
: Permet de retirer un paramètre qui a été ajouté par AddParameter()

* Amélioration de CopyTo
: Permet de créer des objets à partir d'un sélecteur

* CopyTo, Update, UpdateFrom
: Fonctionne sur les classes de stéréotype SQL

* InsertInto
: Permet de créer une table temporaire à partir d'un sélecteur
: Réalise un select ... into TEMPTABLE from ...

* SourceTableName
: Permet de sélectionner une table SQL comme source de l'opération
: Utiliser dans les opérations ensemblistes sur des tables temporaires

===TsqlOperation===

Classe SQL définie par le framework et permettant d'enregistrer les opérations du sélecteur

<source lang="delphi">
TsqlOperation = Class(TsqlObject)
public
class procedure CleanOpe(iOpeId:string);
//
property action: StringS[128];
property id: SQLIdentity;
property oidSourceObject: TOID;
property oidTargetObject: TOID;
property opeId: StringS[128];
property operation: StringS[128];
property SourceObject: Ref(roGeneric,roNotExternal,roNoForeignKey,roNoRoleIndex) of TitObject;
property TargetObject: Ref(roGeneric,roNotExternal,roNoForeignKey,roNoRoleIndex) of TitObject;
end;
</source>

* opeId, operationId
: Un identifiant unique (guid) identifiant l'ensemble des opérations

* opération
: Nom de l'opération dans l'ensemble des opérations

* action
: Action de l'opération
: Par exemple INSERT pour un CopyTo

* oidSourceObject
: identifiant de l'objet source dans l'opération
: Par exemple l'objet source de la copie pour un CopyTo

* oidTargetObject
: identifiant de l'objet cible dans l'opération
: Par exemple l'objet copié par un CopyTo

'''Exemple d'utilisation:'''

<source lang="delphi">

// Créer des écritures a partir des réglements
//
procedure _doCreateEcritureReglements(iOidPiece:string; iOpeId:string);
var sel:TSelector;
begin
sel := vueEcritureReglement.CreateSelector('(oidBordereau=%1)','',True,[oidBordereauReglement]);
sel.AddParameter('ArgBordereau',oidBordereauReglement);
sel.Operation := 'EcrReg';
sel.OpeId := iOpeId;
//
sel.CopyTo('TEcriture',['oidpiece','eDate','sens','sensProrata','regimeTVA','typeEcriture'],[
iOidPiece,
BordereauReglement.dateReglement,
sens_credit,
sens_credit,
regimeTVA_Encaissements,
typeEcriture_Brouillard
]);
end;

Type
vueUpdateReglement = viewOf(TReglement)
vl:TsqlOperation = join('(opeId=%ArgOpeId) and (operation=%ArgOperation) and (oidSourceObject=self.oid)');
oidEcriture:TOID = oidEcriture;
oidTargetEcriture:TOID = vl.oidTargetObject;
oidBordereau:TOID = oidBordereauReglement;
end;

// Met à jour l'oidEcriture créée sur les réglements correspondants
..
procedure _doUpdateReglementsEcriture(iOidPiece:string; iOpeId:string);
var sel:TSelector;
begin
sel := vueUpdateReglement.CreateSelector('(oidBordereau=%1)','',True,[oidBordereauReglement]);
sel.AddParameter('ArgOpeId',iOpeId);
sel.AddParameter('ArgOperation','EcrReg');
//
sel.Update(['oidEcriture'],['oidTargetEcriture']);
end;

begin
aOpeId := CreateGuid;
withP long transaction do
begin
aOidPiece := _doCreatePiece();
_doCreateEcritureReglements(aOidPiece,aOpeId);
_doUpdateReglementsEcriture(aOidPice,aOpeId);
...
TsqlOperation.CleanOpe(aOpeId);
end;
end;
</source>

===UpdateFrom()===

<source lang="delphi">
function updateFrom(sel:TSelector; iMatchedProps:Array of string; iUpdatedProps:Array of string; iUpdatedValue:Array of variant):Integer;
</source>

Permet de mettre à jour une classe à partir d'un sélecteur et d'une colonne de correspondance.

'''Exemple :'''

<source lang="delphi">
Type
// Update the temp table
vueTemp = viewOf(TempLettrage)
reference1:string = reference1;
reference2:string = reference2;
modeLettrage:Integer = modeLettrage;
end;

vueRef1 = viewOf(TempLettrage)
//ACount:Integer = count(id);
ATotal:Currency = sumSign(montant:TCValue,sens,'1');
reference1:string = reference1;
[(modeLettrage=0) and (reference1<>'')]
end;

var selT,selG:TSelector;
begin
withP long transaction do
begin
// for updating the temp table on "match"
selT := vueTemp.CreateSelector('','',True,[]);

// Lettrage sur reference 1
selG := vueRef1.CreateSelector('(ATotal=0)','',True,[]);
selG.useCTE := True;
selT.UpdateFrom(selG,['reference1'],['modeLettrage'],[1]);
end;
end;
</source>

<pre>
with CTE as (
select sum(case when t0.sens=1 then ISNULL(t0.montant_TCValue, 0) else -ISNULL(t0.montant_TCValue, 0) end) as "ATotal",t0.reference1 as "reference1"
from dbo.TEMPLETTRAGE t0 WITH (NOLOCK)
where ((t0.modeLettrage = 0) and (t0.reference1 IS NOT NULL))
group by t0.reference1
)
merge into dbo.TEMPLETTRAGE tm0 using (
SELECT *
FROM CTE
Where (ATotal = 0.0000)
) tm1 on (tm1.reference1=tm0.reference1)
when matched then update set
tm0.modeLettrage = 1
;
</pre>

==Opérations ensemblistes SQL==

Des opérations ensemblistes utilisant des tables SQL temporaires peuvent être réalisées en utilisant l'opération InserInto du selecteur.

===Table temporaire===

* TDatabase.AllocTempTable(JobId:string)
: Génère un nom de table temporaire

* TDatabase.DropTempTables(JobId:string)
: Supprime (drop) les tables temporaires

===Vue SQL locale===

Une vue SQL locale permet d'utiliser une table SQL comme source d'opération d'un sélecteur

<source lang="delphi">
Type
// define an interface
intf = interface
...
end;

// create a view which support the interface
// will be used to create the temp table
//
vue = viewOf(MyClass,intf)
end;

// define a sql class based on the interface
//
sql = sqlClass(intf)
end;

// view on the sql class
//
vue2 = viewOf(sql)
...
end;

var sel:Tselector; aJob,aTempTable:string; keepTables:boolean;
begin
// Alloc a temp table name
//
aJob := CreateGuid;
aTempTable := ClassManager.DefDatabase.AllocTempTable(aJob);
KeepTables := false; // for debuging
try
// Create a temp table from MyClass view
//
sel := vue.CreateSelector(...);
sel.insertInto(aTempTable,[...],[...]); // we create a tempTable

// Query the temp table throught the vue2
//
sel := vue2.CreateSelector(...);
sel.SourceTableName := aTempTable; // because we select the tempTable

...
finally
if not KeepTables then ClassManager.DefDatabase.DropTempTables(aJob);
end;
end;
</source>

==Updater==

Classe technique permettant de mettre à jour un attribut sur un ensemble d'objet.

'''Exemple : Mise à jour des compteurs qui ne peuvent pas être déterminés en SQL'''

<source lang="delphi">
Type
// Should returns all attributes part of the counter
//
vueNumeroPiece = viewOf(TPiece)
pDate:TDatetime = pDate;
numero:TCounter = numero;
end;

procedure _doUpdateNumeroPiece(iOidPiece:string);
var sel:TSelector; vueNP:vueNumeroPiece; upd:TUpdater;
begin
upd := TPiece.CreateUpdater('numero');
//
sel := vueNumeroPiece.CreateSelector('(oid=%1)','',True,[iOidPiece]);
forEach vueNP in sel.AsCursor do
begin
vueNP.numero.AllocValue;
upd.AddValue(vueNP.OID,vueNP.numero.value);
end;
//
upd.Execute;
end;

begin

end;

</source>

==Interface==

* [[Améliorations des contrôles d'interface (Version 11.00 2025 r2)]]

[[Category:Version2025r2]]
[[Category:Release note]]

Version 2025 r2 (release note)

2025-12-23T11:01:24Z

Syfre :

TsqlOperation (class)

2025-12-23T11:00:52Z

Syfre : Page créée avec « {{version2025r2}} ==Introduction== La classe TsqlOperation est une classe SQL utilisée dans les opérations SQL exécutées par des sélecteurs. {|class="wikitable" |-... »

{{version2025r2}}

==Introduction==

La classe TsqlOperation est une classe SQL utilisée dans les opérations SQL exécutées par des sélecteurs.

{|class="wikitable"
|-
!Colonne
!Type
!Usage
|-
|id
|Identity
|Identifiant unique
|-
|opeId
|string
|Identifiant d'opération
|-
|action
|string
|Action SQL
|-
|operation
|string
|Operation SQL
|-
|oidTargeObject
|TOID
|Identifiant de l'objet créé / modifié
|-
|oidSourceObject
|TOID
|Identifiant de l'objet source
|}

Voir aussi :

* [[Selecteur (tech)|Sélecteur]]
* [[CopyTo (selector)|Sélecteur CopyTo]]

{{Footer|Code métier}}
[[category:Classes frameworks]]
[[category:version2025r2]]

Catégorie:Version2025r2

2025-12-23T10:45:09Z

Syfre : Page créée avec « __NOTOC__ »

__NOTOC__

Selecteur (tech)

2025-12-23T10:44:57Z

Syfre :

__TOC__
Les sélecteurs sont des objets techniques permettant d'encapsuler une sélection sur une classe.

A partir d'un sélecteur il est possible de réaliser des opérations sur l'ensemble des objets représentés par la sélection.

===Création d'un sélecteur===

A partir d'une classe métier

* [[CreateSelector (class)|CreateSelector]]

A partir du [[ClassManager_(code)|class manager]]

* [[CreateSelector (CM)|CreateSelector]]
* [[CreateSelectorWhere (CM)|CreateSelectorWhere]]

===Attributs===

{|class="wikitable"
|-
!Attribut
!Usage
|-
|[[ClassName (selector)|ClassName]]
|Nom de la classe sur laquelle porte la sélection
|-
|[[OrderBy (selector)|OrderBy]]
|Ordre de tri de la sélection
|-
|[[Where (selector)|Where]]
|Clause de recherche de la sélection.
|-
|[[Descendants (selector)|Descendants]]
|Inclure les objets descendants
|-
|[[ArgCount (selector)|ArgCount]]
|Nombre d'arguments de la clause where
|-
|[[Args (selector)|Args[]]]
|Argument de la clause where
|-
|[[AgregateCount (selector)|AgregateCount]]
|Nombre d'agrégats
|-
|[[Agregates (selector)|Agregates[]]]
|Agrégats
|-
|[[AgregatesOpes (selector)|AgregateOpes[]]]
|Opérateurs des agrégats
|-
|[[GroupByCount (selector)|GroupByCount]]
|Nombre de regroupements
|-
|[[GroupBys (selector)|GroupBys[]]]
|Regroupements
|-
|[[MaxInstances (selector)|MaxInstances]]
|Nombre maximum d'instance retournées
|-
|[[ClassFilter (selector)|ClassFilter]]
|Filtre de classe
|-
|[[AnyWhere (selector)|AnyWhere]]
|Appliquer à tous les périmètres
|-
|[[DebugString (selector)|DebugString]]
|Chaîne de debug
|-
|[[ApplyRights (selector)|ApplyRights]]
|Applique les droits {{version11}}
|-
|[[UseCTE (selector)|UseCTE]]
|Utilise une requête "Common Table Expression" {{version11}}
|}

'''Mise à jour'''

{|class="wikitable"
|-
!Attribut
!Usage
|-
|[[UpdateStamp (selector)|UpdateStamp]]
|Met à jour les champs UpdStamp et UpdDate dans les update {{version11}}
|-
|[[UpdateCumuls (selector)|UpdateCumuls]]
|Met à jour les cumuls si la classe en possède {{version2025r2}}
|}

'''Pagination'''

{|class="wikitable"
|-
!Attribut
!Usage
|-
|[[PageMode (selector)|PageMode]]
|Utilise une requête paginée
|-
|[[PageOffset (selector)|PageOffset]]
|Offset dans la pagination
|-
|[[PageSize (selector)|PageSize]]
|Taille de page
|}

'''Résultat d'opération SQL {{version2025r2}}'''

{|class="wikitable"
|-
!Attribut
!Usage
|-
|[[LastOpeStamp (selector)|LastOpeStamp]]
|Dernier UpdStamp affecté par l'opération
|-
|[[LastOpeFirstOID (selector)|LastOpeFirstOID]]
|Dernier premier OID affecté par l'opération
|-
|[[LastOpeAffected (selector)|LastOpeAffected]]
|Dernier nombre d'objets affectés par l'opération
|}

'''Identifiants d'opération SQL {{version2025r2}}'''

{|class="wikitable"
|-
!Attribut
!Usage
|-
|[[OpeClass (selector)|OpeClass]]
|Classe affectée par l'opération SQL
|-
|[[Operation (selector)|Operation]]
|Identfiant d'opérations SQL
|-
|[[OperationId (selector)|OperationID]]
|Identfiant d'ensemble d'opérations SQL
|-
|[[OperationId (selector)|OpeID]]
|Identfiant d'ensemble d'opérations SQL (OperationId)
|-
|[[OpeSource (selector)|OpeSource]]
|Source de l'opération SQL
|-
|[[SourceTableName (selector)|SourceTableName]]
|Nom de table temporaire pour opération sur une table temporaire
|-
|[[MergeTableName (selector)|MergeTableName]]
|Nom de table temporaire pour opération de mise à jour sur une table temporaire
|}

===Méthodes d'instance===

{|class="wikitable"
|-
!Méthode
!Usage
|-
|[[AsList (selector)|AsList]]
|Retourne une liste basée sur la sélection
|-
|[[AsCursor (selector)|AsCursor]]
|Retourne un curseur basé sur la sélection
|-
|[[Count (selector)|Count]]
|Retourne le nombre d'objets inclus dans la sélection.
|-
|[[Concat (selector)|Concat]]
|Retourne la valeur concaténée d'un attribut de la sélection.
|-
|[[Invoke (selector)|Invoke]]
|Exécute une méthode pour chaque objet de la sélection.
|-
|[[InQueue (selector)|InQueue]]
|Insère les objets de la sélection dans une file d'attente
|-
|[[Renumber (selector)|Renumber]]
|Renumérote un attribut des objets sélectionnés par le sélecteur
|-
|[[Update (selector)|Update]]
|Met à jour les objets sélectionnés par le sélecteur
|-
|[[UpdateFrom (selector)|UpdateFrom]]
|Met à jour les objets sélectionnés par le sélecteur à partir d'un sélecteur source {{version2025r2}}
|-
|[[CopyTo (selector)|CopyTo]]
|Copie les objets de la sélection
|-
|[[InsertInto (selector)|InsertInto]]
|Insère les objets SQL de la sélection dans une table temporaire {{version2025r2}}
|-
|[[AddConstraint (selector)|AddConstraint]]
|Ajouter une contrainte
|-
|[[AddColumn (selector)|AddColumn]]
|Ajouter une colonne
|-
|[[Export (selector)|Export]]
|Export les objets {{version11}}
|-
|[[ToJson (selector)|ToJson]]
|Sérialise les objets de la sélection en format json {{version2025r2}}
|-
|[[ToJsonEx (selector)|ToJsonEx]]
|Sérialise les objets de la sélection en format json avec options {{version2025r2}}
|}

'''Paramètres des requêts'''

{|class="wikitable"
|-
!Méthode
!Usage
|-
|[[AddParameter (selector)|AddParameter]]
|Ajoute un paramètre {{version11}}
|-
|[[RmvParameter (selector)|RmvParameter]]
|Supprime un paramètre {{version11}}
|-
|[[GetParameter (selector)|GetParameter]]
|Retourne un paramètre du sélecteur {{version2024r1}}
|-
|[[HasParameter (selector)|HasParameter]]
|Test si le sélecteur à un paramètre {{version2024r1}}
|}

===Méthodes de classe===

{|class="wikitable"
|-
|
|
|}

[[Category:Objets techniques]]
[[Category:Sélecteur]]
[[Category:Version700]]
[[Category:version11]]
[[Category:version2025r2]]

Selecteur (tech)

2025-12-23T10:44:23Z

Syfre : /* Méthodes d'instance */

ToJson (selector)

2025-12-23T10:43:23Z

Syfre :

{{version2025r2}}

<source lang='delphi'>function ToJson(SA:TJson):Integer;</source>

Cette méthode sérialise les objets de la sélection en json.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|Result
|Nombre d'objets
|-
|SA
|Tableau json
|}

Cette fonction retourne le nombre d'objets affectés par l'opération.

Exemple :

<source lang="delphi">

//procedure TableRows(ST:TJsonStruct)
Type
vue = viewOf(...)
jsonName:Type(fmtOptions) = propPath;
....
end;

begin
sel := vue.CreateSelector('','',True,[]);
sel.ToJson(ST.rows);
end;

</source>

Voir aussi :

* [[ToJsonEx (selector)|ToJsonEx]]

{{Footer|Selecteur (tech)}}
[[category:Sélecteur]]
[[Category:version11]]

ToJsonEx (selector)

2025-12-23T10:43:08Z

Syfre :

{{version2025r2}}

<source lang='delphi'>function ToJsonEx(SA:TJson; iOptions:Integer):Integer;</source>

Cette méthode sérialise les objets de la sélection en json.

{|class="wikitable"
|-
!Paramètre
!Usage
|-
|Result
|Nombre d'objets
|-
|SA
|Tableau json
|-
|iOptions
|Options de sérialisation
|}

Cette fonction retourne le nombre d'objets affectés par l'opération en utilisant un jeu d'options.

Exemple :

<source lang="delphi">

//procedure TableRows(ST:TJsonStruct)
Type
vue = viewOf(...)
jsonName:Type(fmtOptions) = propPath;
....
end;

begin
sel := vue.CreateSelector('','',True,[]);
sel.ToJsonEx(ST.rows, sjoIdAsGuid);
end;

</source>

Voir aussi :

* [[ToJson (selector)|ToJson]]

{{Footer|Selecteur (tech)}}
[[category:Sélecteur]]
[[Category:version11]]