Usando modelos de documento: caso de uso genérico

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 1 min. de leitura
  • Entenda como usar modelos de documento fora do HR Service Delivery.

    Antes de Iniciar

    Função necessária: administrador

    Procedimento

    1. Defina um modelo de documento para uma determinada tabela, por exemplo, Tabela de incidentes.
    2. Se os participantes estiverem configurados para o modelo de documento, use a seguinte API para iniciar tarefas de documento para os participantes:
      /**
      * Description: Method to prefill document with mapped values and attach it to record table.
      * @param {GlideRecord} taskGr (GlideRecord of task table)
      * @param {String} htmlBody html body of document (Optional, if not passed then it will be generated from template for html template)
      * @param {SysId} docTemplateId (sysId of document template)
      * @param {String} generatedPdfName name of generated pdf (Optional, if not passed then it will be taken from template name)
      * @param {String} documentId (word template attachment sysId) (Only for word templates)
      * @return {boolean} true/false
      */
      new sn_doc.GenerateDocumentAPI().initiateDocumentTasks(taskGr, htmlBody, docTemplateId, generatedPdfName, documentId)
      
    3. Para gerar um documento PDF a partir de um modelo de documento, use a seguinte API:
      /**
      * Description: Method to generate a PDF from a document template.
      * @param {GlideRecord} recordId (GlideRecord of task table)
      * @param {documentTemplateId} docTemplateId (sysId of document template)
      * @param {String} pdfName name of generated pdf (Optional, if not passed then it will be taken from template name)
      * @return {sysId} (sysId of the attachment)
      */
      new sn_doc.GenerateDocumentAPI().generateDocumentForTask(recordId, documentTemplateId, pdfName)
    4. Para exibir as tarefas de documento associadas a um registro:
      1. Abra o registro, por exemplo, um registro de incidente.
      2. Configure as listas relacionadas.Configurar listas relacionadas em um registro

        Uma caixa de listagem dupla é aberta. Adicionar Tarefa de Documento -> Primário e Salvar.Adicionar lista relacionada de tarefas de documento a um registro de incidente

        As tarefas de documento associadas ao registro são exibidas na lista relacionada de tarefas de documento.

        A lista relacionada de tarefas do documento aparece no formulário de registro