...

Dans "Admin" puis "Circuit", vous avez accès à l'outil permet de consulter et de modifier les circuits de signatures. Il est possible de filtrer les circuits présents dans esup-signature :

• Workflows globaux (définis pas les administrateurs)
• Classes workflow (définies par les développeurs)
  
• Workflows Utilisateurs (définis pas les utilisateurs)
  

Création d'un circuit classique

...

Dans cette vue il est possible d'activer la notion d'étape "infinie" en activant "L'utilisateur peut ajouter une étape avant la suivante". Si cette option est activée, vous donnerez la possibilité aux participants de cette étape, d'ajouter des étapes intermédiaires (non prévues à l'origine).

Chaque étape créée à la suite d'une étape "infinie" sera elle aussi une étape "infini". Cela se traduit, au niveau de l'interface utilisateur, par une question qui lui est posée lorsque qu'il s’apprête à signer : "Signer et passer à l'étape suivante" ou "signer et ajouter une étape"

Paramètres généraux d'un circuit

...

[TextField]^(SIG_SIGNATURE|SIG_CACHET)$ : pour détecter les champs de type TextField avec les attributs "nom" ("name") SIG_SIGNATURE ou SIG_CACHET

...

...

• smb, cmis, file, sftp / ftp, pour ces types, il faut suive les explications du tableau ci-dessus
• http:// https:// (fera une requete, type REST, vers l'url avec en paramètre l'ID de la demande de signature, son statut signé ou refusé et le numéro d'étape concerné
• mailto (envoi du document en pièce jointe au destinataire)

Transmission vers REST

(maj depuis pour la version 1.30.x)

Lorsque vous configurez une adresse type "rest", donc vers un websevice en écoute, esup-signature va tenté de transmettre les données via GET et via POST.

Voici la liste (et le format) des données transmisent :

{
    "signRequestId": ["XXXX"],
    "status": ["deleted"],
    "step": [
        "2"
    ],
    "userEppn": [
        "esupdem@univ-rouen.fr"
    ],
    "comment": [
        ""
    ]
}

En GET les informations sont transmisent via les paramètres de la requête.

Voici un exemple de code à mettre coté application métier pour permettre à esup-signature de transmettre les informations du circuit via REST. Ici il s'agir d'un controleur Spring. La requête est envoyée en GET, esup-signature doit avoir un accès direct à cette API. 

    @GetMapping(value = "/return-test")
    @ResponseBody
    public ResponseEntity<Void> returnTest(@RequestParam("signRequestId") String signRequestId, @RequestParam("status") String status, @RequestParam("step") String step) {
        logger.info(signRequestId + ", " + status + ", " + step);
        //ici, le code à executer coté application métier en fonction du statut
        return ResponseEntity.ok().build();
    }

En POST, les informations sont transmisent sous forme de map json:

Voici un script python permettant de simuler un mini server web et affichant les données reçues:

Verification du bon fonctionnement de la copie coté serveur avec smbclient :

apt install smbclient
echo "Contenu de test" > /tmp/test_fichier.txt
smbclient //stockage.univ-ville.fr/nom_du_partage -W MON_WORKGROUP -U mon_uid -c "put /tmp/test_fichier.txt mon_du_dossier/test_fichier.txt"

La copie doit fonctionner pour qu'esup-signature puisse en faire autant.

Transmission vers REST

(maj depuis pour la version 1.30.x)

Lorsque vous configurez une adresse type "rest", donc vers un websevice en écoute, esup-signature va tenté de transmettre les données via GET et via POST.

Voici à quels moments les requettes sont transmisent :

• À chaque signature / refus (avec le motif)
• À la suppression / suppression définitive
• À la restautation
• À la fin du circuit

Les statuts transmis sont les suivants : pending, refused, deleted, restored, cleaned, completed

Voici la liste (et le format) des données transmisent :

{
    "signRequestId": "XXXX",
    "status": "pending",
    "step": "1",
    "userEppn": "toto@univ-ville.fr",
    "comment": ""
}

En GET les informations sont transmisent via les paramètres de la requête.

Voici un exemple de code à mettre coté application métier pour permettre à esup-signature de transmettre les informations du circuit via REST. Ici il s'agir d'un controleur Spring. La requête est envoyée en GET, esup-signature doit avoir un accès direct à cette API. 

    @GetMapping(value = "/return-test")
    @ResponseBody
    public ResponseEntity<Void> returnTest(@RequestParam("signRequestId") String signRequestId, @RequestParam("status") String status, @RequestParam("step") String step) {

from http.server import BaseHTTPRequestHandler, HTTPServer
from urllib.parse import urlparse, parse_qs
import json

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
    
    def do_GET(self):
        # Parse l'URL et ses paramètres
        parsed_path = urlparse(self.path)
        query_components = parse_qs(parsed_path.query)logger.info(signRequestId + ", " + status + ", " + step);
        
//ici, le code à executer coté application métier #en Affichefonction lesdu informationsstatut
 dans la console
     return ResponseEntity.ok().build();
    }

En POST, les informations sont transmisent sous forme de map json:

Voici un script python permettant de simuler un mini server web et affichant les données reçues ici en http://localhost:8000 :

from http.server import BaseHTTPRequestHandler, HTTPServer
from urllib.parse import urlparse, parse_qs
import json

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):   print("Received GET request:")
        print(f"Path: {self.path}")
        print("Query parameters:")
    
    for key, values in query_components.items(def do_GET(self):
        # Parse l'URL et forses valueparamètres
 in values:
      parsed_path = urlparse(self.path)
        print(f"  {key}: {value}"query_components = parse_qs(parsed_path.query)
        
        # Prépare Affiche les informations dans la réponse (simple pour le clientconsole
        print("Received GET request:")
        self.send_response(200print(f"Path: {self.path}")
        self.send_header('Content-type', 'text/html'print("Query parameters:")
        for key, values in self.end_headersquery_components.items():
        self.wfile.write(b"<html><body><h1>GET request received</h1></body></html>")

  for value def do_POST(self)in values:
        # Récupère    la longueur des données envoyées
  print(f"  {key}: {value}")
      content_length = int(self.headers['Content-Length'])
        # RécupèrePrépare la leréponse corps(simple depour lale requêteclient)
        post_data = self.rfile.read(content_length)send_response(200)
        self.send_header('Content-type', 'text/html')
        # Tente de décoder les données comme JSON
   self.end_headers()
        self.wfile.write(b"<html><body><h1>GET request received</h1></body></html>")

     trydef do_POST(self):
        # Récupère la longueur json_datades = json.loads(post_data)
données envoyées
        content_length = int(self.headers['Content-Length'])
   print("Received POST request with JSON data:")
# Récupère le corps de la requête
      print(json.dumps(json  post_data, indent=4)= self.rfile.read(content_length)
        except json.JSONDecodeError:

        # Tente de décoder les données comme JSON
   print("Received POST request with invalid JSON")try:
            json_data = {"error": "Invalid JSON"}json.loads(post_data)
        
    print("Received POST request with # Prépare la réponse (simple pour le client)
JSON data:")
            self.send_response(200print(json.dumps(json_data, indent=4))
        self.send_header('Content-type', 'text/html')except json.JSONDecodeError:
        self.end_headers()
        self.wfile.write(b"<html><body><h1>POST request received</h1></body></html>")

def run(server_class=HTTPServer, handler_class=SimpleHTTPRequestHandler, port=8000):
    server_address = ('', port)
    httpd = server_class(server_address, handler_class)
    print(f"Starting server on port {port}...")
    httpd.serve_forever()

if __name__ == '__main__':
    run()

Définir les participants à un circuit à posteriori

Dans certains cas, les participants à une étape ne peuvent pas être prédéfinis dans esup-signature.

Dans le cas concret du circuit des bons de commande à l'université de Rouen, les signataires sont détermines en fonction de l'unité budgétaire (donc par l'application métier, SIFAC).

Le cas d'usage à Rouen est que les utilisateurs génèrent des bons de commande "à signer" au format PDF et les déposent dans leur dossier de travail.

Trois possibilités :

• Mettre en place un script qui va calculer le workflow, utiliser les web-services pour configurer les participants du circuit des bons de commandes et injecter le document. (pour plus de détails sur les web services voir : Web services REST)

• Mettre en place un script qui calcule le workflow, inscrit ce workflow dans les métas-données du document (PDF) et le copie dans un dossier défini comme "source" au niveau d'Esup-signature.
  Pour cette dernière solution il faut donc créer un circuit comme vu précédemment, cocher la case "Scanner les métadonnées des PDF" et définir une source pour la récupération des documents au niveau des paramètres généraux

• Implémenter une classe worflow (voir le chapitre suivant)

Les métas-données qui doivent être inscrite dans les document PDF sont les suivantes:

• sign_type_default_val : contenant le type de signature (visa, pdfImageStamp, certSign ou nexuSign)
• sign_step#<n> : contenant la liste des participants de l'étape n
• sign_target : contenant le chemin de dépôt des documents après signature

Lorsque le scheduler passera pour importer les documents, ceux-ci seront analysés, le circuit sera généré en fonction des informations trouvées dans les métas-données.

Exemple de code java permettant d'ajouter les métas-données à un fichier pdf :

PDDocument document = PDDocument.load(in);
PDDocumentInformation info = document.getDocumentInformation();
info.setCustomMetadataValue("sign_type_default_val", "pdfImageStamp");
info.setCustomMetadataValue("sign_step#1", "[machin@univ-ville.fr, truc@univ-ville.fr]");
info.setCustomMetadataValue("sign_target_key","smb://serveur_de_fichiers/la_destination/signed");

Utiliser les classes workflow

Pour les cas les plus spécifiques, il est possible d'ajouter, au code source original d'esup-signature, une classe qui décrira précisément un circuit.

Une nouvelle classe workflow devra implémenter la classe "DefaultWorkflow". Des exemples sont déjà présents dans le code source original d'Esup-signature dans le dossier src/main/java/org/esupportail/esupsignature/service/workflow/impl/

print("Received POST request with invalid JSON")
            json_data = {"error": "Invalid JSON"}
        
        # Prépare la réponse (simple pour le client)
        self.send_response(200)
        self.send_header('Content-type', 'text/html')
        self.end_headers()
        self.wfile.write(b"<html><body><h1>POST request received</h1></body></html>")

def run(server_class=HTTPServer, handler_class=SimpleHTTPRequestHandler, port=8000):
    server_address = ('', port)
    httpd = server_class(server_address, handler_class)
    print(f"Starting server on port {port}...")
    httpd.serve_forever()

if __name__ == '__main__':
    run()

...

Définir les participants à un circuit à posteriori

Dans certains cas, les participants à une étape ne peuvent pas être prédéfinis dans esup-signature.

Dans le cas concret du circuit des bons de commande à l'université de Rouen, les signataires sont détermines en fonction de l'unité budgétaire (donc par l'application métier, SIFAC).

Le cas d'usage à Rouen est que les utilisateurs génèrent des bons de commande "à signer" au format PDF et les déposent dans leur dossier de travail.

Trois possibilités :

• Mettre en place un script qui va calculer le workflow, utiliser les web-services pour configurer les participants du circuit des bons de commandes et injecter le document. (pour plus de détails sur les web services voir : Web services REST)

• Mettre en place un script qui calcule le workflow, inscrit ce workflow dans les métas-données du document (PDF) et le copie dans un dossier défini comme "source" au niveau d'Esup-signature.
  Pour cette dernière solution il faut donc créer un circuit comme vu précédemment, cocher la case "Scanner les métadonnées des PDF" et définir une source pour la récupération des documents au niveau des paramètres généraux

• Implémenter une classe worflow (voir le chapitre suivant)

Les métas-données qui doivent être inscrite dans les document PDF sont les suivantes:

• sign_type_default_val : contenant le type de signature (visa, pdfImageStamp, certSign ou nexuSign)
• sign_step#<n> : contenant la liste des participants de l'étape n
• sign_target : contenant le chemin de dépôt des documents après signature

Lorsque le scheduler passera pour importer les documents, ceux-ci seront analysés, le circuit sera généré en fonction des informations trouvées dans les métas-données.

Exemple de code java permettant d'ajouter les métas-données à un fichier pdf Votre classe doit être construite comme suit :

package org.esupportail.esupsignature.service.workflow.impl;

import org.esupportail.esupsignature.entity.Data;
import org.esupportail.esupsignature.entity.User;
import org.esupportail.esupsignature.entity.WorkflowStep;
import org.esupportail.esupsignature.entity.enums.SignType;
import org.esupportail.esupsignature.exception.EsupSignatureUserException;
import org.esupportail.esupsignature.service.workflow.DefaultWorkflow;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

@Component
public class BasicWorkflow extends DefaultWorkflow {

   private String name = "BasicWorkflow";
   private String description = "Une signature";
   private List<WorkflowStep> workflowSteps;

   @Override
   public String getName() {
      return name;
   }

   @Override
   public String getDescription() {
      return description;
   }

   @Override
   public List<WorkflowStep> getWorkflowSteps() {
      if(this.workflowSteps == null) {
         try {
            this.workflowSteps = generateWorkflowSteps(userService.getCurrentUser(), null, null);
         } catch (EsupSignatureUserException e) {
            return null;
         }
      }
      return this.workflowSteps;
   }

   public void initWorkflowSteps() {
      this.workflowSteps = new ArrayList<>();
   }

   @Override
   public List<WorkflowStep> generateWorkflowSteps(User user, Data data, List<String> recipentEmailsStep) throws EsupSignatureUserException {
      List<WorkflowStep> workflowSteps = new ArrayList<>();
/* ici on construit la liste des étapes du circuit */
      WorkflowStep workflowStep = new WorkflowStep();
      workflowStep.setStepNumber(1);
      workflowStep.setSignType(SignType.pdfImageStamp);
      workflowStep.setDescription("Choix du signataire");
      workflowStep.setChangeable(true);
      if(data != null) {
         workflowStep.setRecipients(workflowService.getFavoriteRecipientEmail(1, data.getForm(), recipentEmailsStep, user));
      } else {
         workflowStep.getRecipients().add(recipientService.createRecipient(null, userService.getGenericUser("Utilisateur issue des favoris", "")));
      }
      workflowSteps.add(workflowStep);
      return workflowSteps;
   }
}

Il faut donc a minima :

...

PDDocument document = PDDocument.load(in);
PDDocumentInformation info = document.getDocumentInformation();
info.setCustomMetadataValue("sign_type_default_val", "pdfImageStamp");
info.setCustomMetadataValue("sign_step#1", "[machin@univ-ville.fr, truc@univ-ville.fr]");
info.setCustomMetadataValue("sign_target_key","smb://serveur_de_fichiers/la_destination/signed");

...

Utiliser les classes workflow

Pour les cas les plus spécifiques, il est possible d'ajouter, au code source original d'esup-signature, une classe qui construira un circuit de manière dynamique via du code java.

L’intérêt de cette solution est de permettre la mise en place de mécanismes complexes de calcul des participants et des paramètres des étapes. On peut par exemple imaginer de calculer le n+1 de l'utilisateur courant. Cela nécessite d'avoir des compétences en développement et connaitre notamment le langage Java et le framework Spring

Une nouvelle classe workflow devra étendre "ClassWorkflow" et implémenter la classe "ModelClassWorkflow". Des exemples sont déjà présents dans le code source original d'Esup-signature dans le dossier src/main/java/org/esupportail/esupsignature/service/workflow/impl/

Votre classe doit être construite comme suit :

package org.esupportail.esupsignature.service.interfaces.workflow.impl;

import org.esupportail.esupsignature.dto.json.WorkflowStepDto;
import org.esupportail.esupsignature.entity.WorkflowStep;
import org.esupportail.esupsignature.entity.enums.SignType;
import org.esupportail.esupsignature.exception.EsupSignatureUserException;
import org.esupportail.esupsignature.service.UserService;
import org.esupportail.esupsignature.service.interfaces.workflow.ClassWorkflow;
import org.esupportail.esupsignature.service.interfaces.workflow.ModelClassWorkflow;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.List;

@Component
public class CreatorAndManagerClassWorkflow extends ClassWorkflow implements ModelClassWorkflow {

    transient final UserService userService;

    public CreatorAndManagerClassWorkflow(UserService userService) {
        this.userService = userService;
    }

    @Override
    public String getName() {
        return "CreatorAndManagerClassWorkflow";
    }

    @Override
    public String getDescription() {
        return "Signature du créateur puis du responsable";
    }

    @Override
    public List<WorkflowStep> getWorkflowSteps() {
        return generateWorkflowSteps("creator", null);
    }

    @Override
    public List<WorkflowStep> generateWorkflowSteps(String userEppn, List<WorkflowStepDto> workflowStepDto) throws EsupSignatureUserException {
        List<WorkflowStep> workflowSteps = new ArrayList<>();
        //STEP 1
        WorkflowStep workflowStep1 = new WorkflowStep();
        workflowStep1.getUsers().add(userService.getCreatorUser());
        workflowStep1.setDescription("Votre signature");
        workflowStep1.setSignType(SignType.signature);
        workflowSteps.add(workflowStep1);
        //STEP 2
        WorkflowStep workflowStep2 = new WorkflowStep();
        workflowStep2.setSignType(SignType.signature);
        workflowStep2.setDescription("Signature de votre supérieur hiérarchique (présélectionné en fonction de vos précédentes saisies)");
        workflowStep2.getUsers().add(userService.getGenericUser());
        //à remplacer par l'utilisateur n + 1 de l'utilisateur courant par ex
        //User userManager = calculManager(userEppn)
        //workflowStep2.getUsers().add(userManager);
        workflowStep2.setChangeable(false);
        workflowSteps.add(workflowStep2);
        return workflowSteps;
    }

}

Il faut donc a minima implémenter:

• getName() : en inscrivant un nom unique qui est le même que le nom de la classe
• getDescription() : qui sera visible au niveau de l'interface graphique.
• generateWorkflowSteps() : qui retournera une liste de WorkFlowStep (les étapes calculées en fonction de l'utilisateur courant "userEppn"). Le deuxième paramètre "workflowStepDto" représente les éléments transmis par l'utilisateur au moment ou il démarre le workflow

Vous pourrez, par exemple, utiliser RestTemplate restTemplate = new RestTemplate(); pour lancer des requetes API (ajouter "import org.springframework.web.client.RestTemplate;").

Votre configuration LDAP sera accessible en ajoutant

@Ressource
private final LdapTemplate ldapTemplate;

aux attributs de la classe et ensuite lancer une requete : List<PersonLightLdap> personLightLdaps = ldapTemplate.search("eduPersonPrincipalName=" + userEppn, new PersonLightLdapAttributesMapper())

WorflowStep est defini comme suit : https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/entity/WorkflowStep.java

WorkflowStepDto : https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/dto/json/WorkflowStepDto.java

User : https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/entity/User.java

PersonLightLdap : https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/service/ldap/entry/PersonLightLdap.java

...

Récupérer les données via Power Query

Tout d'abord il faut se générer une clé API depuis les paramètres utilisateurs. Si le champ est vide il suffit de cliquer sur actualiser.

Via Excel, Ouvrir Power Query ("Obtebir des données → Power Query)

Dans Power Query, "Nouvelle source" → "Autres sources" → "Requête vide"

Clique droit sur la requête (Requête1 par ex) → "Éditeur avancé" et copier un script du type :

let
    Source = Csv.Document(Web.Contents("https://esup-signature.univ-ville.fr/ws/workflows/XXXXXXX/datas/csv", [ApiKeyName="XApiKey"]), [Delimiter=",", Columns=24, Encoding=65001, QuoteStyle=QuoteStyle.None]),
    Table_table = Table.PromoteHeaders(Source, [PromoteAllScalars=true])
in
    Table_table

Il faut, ensuite, cliquer sur "Modifier les informations d'identification", choisir API Web et coller votre clé.

...