SystemDocument - com escopo, global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 6 min. de leitura

    • A API SystemDocument fornece métodos para definir campos de um registro na tabela Documentos [ds_document].

    Esta API requer o plug-in Gestão de documentos (com.snc.platform_document_management) e é fornecida no namespace sn_doc_services. Para obter informações, consulte Serviços de documentos.

    Para criar um documento, use a API DocumentService.

    SystemDocument - SystemDocument(cadeia de caracteres docName)

    Instancia um objeto SystemDocument.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    docName Cadeia de caracteres Nome do Documento.
    Tabela 2. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como instanciar um objeto SystemDocument e definir vários campos para um registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('My document');

// Define the document fields
var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
d.description('description');
d.classification('restricted');
d.state('review');
d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
d.template(false);
d.type('policy');
d.reviewers(reviewers);
d.audience('external');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
  "request_id": "1040420224503410f877a6fed1c2b031",
  "status": "success"
}

    SystemDocument - Audience(cadeia de caracteres "público-alvo")

    Define o campo Público de um registro de documento para especificar a disponibilidade externa ou interna. Representa o campo Público em um formulário Gestão de documentos.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    público(a) Cadeia de caracteres Cadeia de caracteres que representa o público-alvo do documento.
    Valores possíveis:
    • externo
    • interno(a)
    Padrão: interno
    Tabela 4. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo Público em um novo registro de documento. Consulte também DocumentService - com escopo, global.

    var d = new sn_doc_services.SystemDocument('My document');
var s = new sn_doc_services.DocumentService();

d.audience('external');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 1193fd4624103410f877a6fed1c2b016 is successful.",
  "request_id": "1193fd4624103410f877a6fed1c2b016",
  "status": "success"
}

    SystemDocument - classificação (classificação de cadeia de caracteres)

    Define o campo Classificação de um registro de documento para identificar o nível de confidencialidade das informações. Representa o campo Classificação em um formulário Gestão de documentos.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    classificação Cadeia de caracteres Classificação do documento.
    Valores possíveis:
    • confidencial
    • público
    • restrito
    Padrão: público
    Tabela 6. Retorna
    Tipo Descrição
    Cadeia de caracteres O valor da propriedade de classificação de um objeto SystemDocument.

    O exemplo a seguir mostra como definir o campo de classificação em um novo registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('My restricted document');
var s = new sn_doc_services.DocumentService();

d.classification('restricted');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : d80435c624103410f877a6fed1c2b0d0 is successful.",
  "request_id": "d80435c624103410f877a6fed1c2b0d0",
  "status": "success"
}

    SystemDocument - createdFromTemplate(cadeia de caracteres docTemplate)

    Define o modelo a partir do qual gerar um documento. Quando o documento é gerado, o modelo especificado é listado no campo Criado a partir do modelo na tabela Documentos [ds_document_list].

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    docTemplate Cadeia de caracteres Sys_id de um documento listado na tabela Documentos [ds_document_list]. O documento deve ter a caixa de seleção Modelo marcada (verdadeiro). Consulte também API DocumentVersionService.
    Tabela 8. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como criar um novo registro de documento a partir de um modelo existente. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('New doc from template');
var s = new sn_doc_services.DocumentService();

d.createdFromTemplate('<doc_template_sys_id>');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : deaef1ce24103410f877a6fed1c2b085 is successful.",
  "request_id": "deaef1ce24103410f877a6fed1c2b085",
  "status": "success"
}

    SystemDocument - departamento(cadeia de caracteres docDept)

    Define o campo Departamento de um registro de documento.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    docDept Cadeia de caracteres Sys_id de um departamento listado na tabela Departamentos [cmn_department].
    Tabela 10. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo de departamento em um novo registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('My document');

// Assign the doc to the human resources department
d.department('<dept_sys_id>');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 491efbee24187410f877a6fed1c2b0a9 is successful.",
  "request_id": "491efbee24187410f877a6fed1c2b0a9",
  "status": "success"
}

    SystemDocument - description(cadeia de caracteres description)

    Define o campo Descrição de um registro de documento.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    description Cadeia de caracteres Descrição do documento.
    Tabela 12. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo de descrição em um registro de documento. Consulte também: API DocumentService.

    var d = new sn_doc_services.SystemDocument('My document');

d.description('Information describing the doc.');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 9acd7fea24587410f877a6fed1c2b060 is successful.",
  "request_id": "9acd7fea24587410f877a6fed1c2b060",
  "status": "success"
}

    SystemDocument - name(cadeia de caracteres docName)

    Define o campo Nome de um registro de documento.

    Nota:
    Você também pode definir o nome como um parâmetro no construtor SystemDocument().
    Tabela 13. Parâmetros
    Nome Tipo Descrição
    docName Cadeia de caracteres Nome do Documento.
    Tabela 14. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo Nome em um novo registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument();

d.name('Document named using method instead of constructor');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : c19d7f2624587410f877a6fed1c2b0eb is successful.",
  "request_id": "c19d7f2624587410f877a6fed1c2b0eb",
  "status": "success"
}

    SystemDocument - owner(cadeia de caracteres "proprietário")

    Define o campo Proprietário de um registro de documento.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    responsável Cadeia de caracteres Sys_id de um usuário listado na tabela Usuários [sys_user].

    Função necessária: administrador

    Padrão: usuário atual
    Tabela 16. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo do proprietário em um novo registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('My document');
var s = new sn_doc_services.DocumentService();

d.owner('aa826bf03710200044e0bfc8bcbe5dd6');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 4235318a24103410f877a6fed1c2b0ff is successful.",
  "request_id": "4235318a24103410f877a6fed1c2b0ff",
  "status": "success"
}

    SystemDocument - revisores(cadeia de caracteres revisores)

    Define o campo Revisores de um registro de documento.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    revisores Cadeia de caracteres Lista de um ou mais revisores de documentos por sys_id. O revisor deve ser um usuário listado na tabela Usuários [sys_user].
    Tabela 18. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo de revisores em um novo registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('My document');

var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
d.reviewers(reviewers);

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 8d19f9ca24103410f877a6fed1c2b0aa is successful.",
  "request_id": "8d19f9ca24103410f877a6fed1c2b0aa",
  "status": "success"
}

    SystemDocument - state(cadeia de caracteres state)

    Define o campo Estado de um registro de documento.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Estado Cadeia de caracteres Estado do documento que representa onde o documento está no fluxo de trabalho.
    Valores válidos:
    • rascunho
    • enviar
    • revisão
    • concluir
    Padrão: rascunho
    Tabela 20. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo de estado em um novo registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('My document');
var s = new sn_doc_services.DocumentService();

d.state('submit');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
  "request_id": "19aab54e24103410f877a6fed1c2b03d",
  "status": "success"
}

    SystemDocument - modelo (modelo booliano)

    Especifica se um registro de documento é um modelo.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    modelo Booliano

    Sinalizador que especifica se um registro de documento é um modelo.

    Valores válidos:
    • verdadeiro: a versão padrão deste documento é um modelo.
    • false: este documento não é um modelo.

    Padrão: falso
    Tabela 22. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como indicar que um registro de documento é um modelo. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('My document');

d.template(true);

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : f7f006ce24103410f877a6fed1c2b053 is successful.",
  "request_id": "f7f006ce24103410f877a6fed1c2b053",
  "status": "success"
}

    SystemDocument - type(cadeia de caracteres docType)

    Define o campo Tipo de um registro de documento.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    docType Cadeia de caracteres Tipo de documento.
    Valores válidos:
    • contrato
    • diretriz
    • política
    • procedimento
    Padrão: Nenhum
    Tabela 24. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o campo de tipo em um novo registro de documento. Consulte também API DocumentService.

    var d = new sn_doc_services.SystemDocument('How to use the document mgmt API');
var s = new sn_doc_services.DocumentService();

d.type('guideline');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Saída:
    {
  "message": "Create document sysId : 8adfb10224503410f877a6fed1c2b0e4 is successful.",
  "request_id": "8adfb10224503410f877a6fed1c2b0e4",
  "status": "success"
}