DocumentListService : champ d’application, global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture

    • L’API DocumentListService fournit des méthodes pour créer, supprimer et mettre à jour une liste de documents.

    Cette API nécessite le module d’extension Document Management (com.snc.platform_document_management) et est fournie dans l’espace de noms sn_doc_services . Pour plus d’informations, consultez Services documentaires.

    Le Document Management module d’extension prend également en charge la création de listes de modèles de documents à associer à votre document. Par exemple, une demande d’emploi nécessitant plusieurs documents tels qu’un diplôme, une carte d’identité ou un passeport. Après avoir ajouté votre liste de documents, vous pouvez ajouter des modèles de documents :
    Pour définir un document en tant que modèle :
    • Définissez l’objet document en définissant la méthode SystemDocument – template() sur true. Créez ou mettez à jour l’enregistrement de document avec les méthodes de l’API DocumentService .
    • Cochez la case Modèle d’un document dans la table Documents [ds_document].
    Les API suivantes vous permettent de définir et de gérer des documents :
    Pour définir un document en tant que modèle :
    • Définissez l’objet document en définissant la méthode SystemDocument – template() sur true. Créez ou mettez à jour l’enregistrement de document avec les méthodes de l’API DocumentService .
    • Cochez la case Modèle d’un document dans la table Documents [ds_document].

    Voir aussi SystemDocumentList.

    DocumentListService : DocumentListService()

    Instancie un objet DocumentListService .

    Tableau 1. Paramètres
    Nom Type Description
    Aucun

    L’exemple suivant montre comment instancier un objet DocumentListService . Voir aussi SystemDocumentList.

    var s = new sn_doc_services.DocumentListService();

    DocumentListService : createDocumentList(document SystemDocumentList)

    Crée une liste de documents dans la table Listes de documents [ds_document_lists].

    Le Document Management module d’extension prend également en charge la création de listes de modèles de documents à associer à votre document. Par exemple, une demande d’emploi nécessitant plusieurs documents tels qu’un diplôme, une carte d’identité ou un passeport. Après avoir ajouté votre liste de documents, vous pouvez ajouter des modèles de documents :

    Utilisez la méthode createDocumentsFromList() pour créer des documents à partir de la liste des modèles de documents.

    Tableau 2. Paramètres
    Nom Type Description
    document Liste des documents système Une ou plusieurs propriétés représentant les champs d’un nouvel enregistrement. La propriété name est requise et peut être définie à l’aide du constructeur SystemDocumentList ou de la méthode name().
    Tableau 3. Renvoie
    Type Description
    Objet Sys_id du nouvel enregistrement dans la table Listes de documents [ds_document_lists] avec un message de réussite. Message d’erreur sinon.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur.

    Type de données : chaîne
    <Object>.request_id Sys_id de l’enregistrement dans la table Listes de documents [ds_document_lists].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération s’est déroulée correctement.
    • échec : l’opération n’a pas réussi. Fournit message des détails.

    Type de données : chaîne

    L’exemple suivant montre comment créer une liste de documents. Voir aussi SystemDocumentList.

    var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));
    Sortie :
    {
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService : createDocumentsFromList(String listSysId, String tableName, String tableSysId)

    Crée des documents à partir d’une liste de modèles de documents.

    Remarque :
    Avant d’utiliser cette méthode, créez une liste de modèles de documents à l’aide de la méthode createDocumentList().
    Tableau 4. Paramètres
    Nom Type Description
    listSysId (en anglais seulement) Chaîne Sys_id d’un enregistrement de liste de documents dans la table Listes de documents [ds_document_lists].
    tableName Chaîne Nom de la table contenant l’enregistrement sur lequel ajouter une liste de références de modèle de document.
    tableSysId Chaîne Sys_id de l’enregistrement contenant le contenu à partir duquel ajouter une liste de références de modèle de document.
    Tableau 5. Renvoie
    Type Description
    Objet Message de réussite ou d’erreur. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Message

    Message contenant le nombre de modèles de documents dans la liste de documents.

    Type de données : chaîne
    <Object>.request_id Sys_id de l’enregistrement dans la table Listes de documents [ds_document_lists].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération s’est déroulée correctement.
    • échec : l’opération n’a pas réussi. Fournit message des détails.

    Type de données : chaîne

    L’exemple suivant montre comment ajouter une liste de références de modèle de document à un enregistrement. La documentation est ajoutée à un enregistrement dans la table Incidents [incident].

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
gs.info(JSON.stringify(result, null, 2));
    Sortie :
    {
  "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
  "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
  "status": "success"
}

    DocumentListService : deleteDocumentList(String listSysId)

    Supprime un enregistrement de document de la table Listes de documents [ds_document_lists].

    Tableau 6. Paramètres
    Nom Type Description
    listSysId (en anglais seulement) Chaîne Sys_id d’un enregistrement de liste de documents dans la table Listes de documents [ds_document_lists].
    Tableau 7. Renvoie
    Type Description
    Objet Message de réussite ou d’erreur. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur.

    Type de données : chaîne
    <Object>.request_id Sys_id de l’enregistrement dans la table Listes de documents [ds_document_lists].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération s’est déroulée correctement.
    • échec : l’opération n’a pas réussi. Fournit message des détails.

    Type de données : chaîne

    L’exemple suivant montre comment supprimer un enregistrement de liste de documents. Voir aussi SystemDocumentList.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));
    Sortie :
    {
  "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService : updateDocumentList(String docSysId, SystemDocumentList doc)

    Met à jour les valeurs de champ d’une liste de documents existante.

    Tableau 8. Paramètres
    Nom Type Description
    listSysId (en anglais seulement) Chaîne Sys_id d’un enregistrement de liste de documents dans la table Listes de documents [ds_document_lists].
    document Document système Une ou plusieurs propriétés représentant les champs de liste de documents à mettre à jour.
    Tableau 9. Renvoie
    Type Description
    Objet Message de réussite ou d’erreur. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Message Message confirmant la réussite ou l’erreur.

    Type de données : chaîne
    <Object>.request_id Sys_id de l’enregistrement dans la table Listes de documents [ds_document_lists].

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération s’est déroulée correctement.
    • échec : l’opération n’a pas réussi. Fournit message des détails.

    Type de données : chaîne

    L’exemple suivant montre comment mettre à jour le nom et la description d’une liste de documents. Voir aussi SystemDocumentList.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListUpdate = new sn_doc_services.SystemDocumentList();
docListUpdate.name('name change');
docListUpdate.description('description update');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));
    Sortie :
    {
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}