The SystemDocument API provides methods for setting fields of a record in the Documents [ds_document] table.

This API requires the Document Management plugin (com.snc.platform_document_management) and is provided within the sn_doc_services namespace. For information, see Document Services.

To create a document, use the DocumentService API.

SystemDocument - SystemDocument(String docName)

Instantiates a SystemDocument object.

Table 1. Parameters
Name Type Description
docName String Name of the document.
Table 2. Returns
Type Description
None

Example

The following example shows how to instantiate a SystemDocument object and set several fields for a document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
  "request_id": "1040420224503410f877a6fed1c2b031",
  "status": "success"
}

SystemDocument - audience(String audience)

Sets the Audience field of a document record to specify external or internal availability. Represents the Audience field in a Document Management form.

Table 3. Parameters
Name Type Description
audience String String representing the intended audience of the document.
Possible values:
  • external
  • internal
Default: internal
Table 4. Returns
Type Description
None

Example

The following example shows how to set the Audience field in a new document record. See also DocumentService - Scoped, 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));
Output:
{
  "message": "Create document sysId : 1193fd4624103410f877a6fed1c2b016 is successful.",
  "request_id": "1193fd4624103410f877a6fed1c2b016",
  "status": "success"
}

SystemDocument - classification(String classification)

Sets the Classification field of a document record to identify the level of information sensitivity. Represents the Classification field in a Document Management form.

Table 5. Parameters
Name Type Description
classification String Classification of the document.
Possible values:
  • confidential
  • public
  • restricted
Default: public
Table 6. Returns
Type Description
String The value of the classification property of a SystemDocument object.

Example

The following example shows how to set the classification field in a new document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : d80435c624103410f877a6fed1c2b0d0 is successful.",
  "request_id": "d80435c624103410f877a6fed1c2b0d0",
  "status": "success"
}

SystemDocument - createdFromTemplate(String docTemplate)

Sets the template from which to generate a document. When the document is generated, the specified template is listed in the Created From Template field in the Documents [ds_document_list] table.

Table 7. Parameters
Name Type Description
docTemplate String Sys_id of a document listed in the Documents [ds_document_list] table. The document must have the Template checkbox selected (true). See also DocumentVersionService API.
Table 8. Returns
Type Description
None

Example

The following example shows how to create a new document record from an existing template. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : deaef1ce24103410f877a6fed1c2b085 is successful.",
  "request_id": "deaef1ce24103410f877a6fed1c2b085",
  "status": "success"
}

SystemDocument - department(String docDept)

Sets the Department field of a document record.

Table 9. Parameters
Name Type Description
docDept String Sys_id of a department listed in the Departments [cmn_department] table.
Table 10. Returns
Type Description
None

Example

The following example shows how to set the department field in a new document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : 491efbee24187410f877a6fed1c2b0a9 is successful.",
  "request_id": "491efbee24187410f877a6fed1c2b0a9",
  "status": "success"
}

SystemDocument - description(String description)

Sets the Description field of a document record.

Table 11. Parameters
Name Type Description
description String Description of the document.
Table 12. Returns
Type Description
None

Example

The following example shows how to set the description field in a document record. See also: DocumentService API.

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));
Output:
{
  "message": "Create document sysId : 9acd7fea24587410f877a6fed1c2b060 is successful.",
  "request_id": "9acd7fea24587410f877a6fed1c2b060",
  "status": "success"
}

SystemDocument - name(String docName)

Sets the Name field of a document record.

Note: You can also set the name as a parameter in the SystemDocument() constructor.
Table 13. Parameters
Name Type Description
docName String Name of the document.
Table 14. Returns
Type Description
None

Example

The following example shows how to set the Name field in a new document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : c19d7f2624587410f877a6fed1c2b0eb is successful.",
  "request_id": "c19d7f2624587410f877a6fed1c2b0eb",
  "status": "success"
}

SystemDocument - owner(String owner)

Sets the Owner field of a document record.

Table 15. Parameters
Name Type Description
owner String Sys_id of a user listed in the Users [sys_user] table.

Role required: admin

Default: Current user
Table 16. Returns
Type Description
None

Example

The following example shows how to set the owner field in a new document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : 4235318a24103410f877a6fed1c2b0ff is successful.",
  "request_id": "4235318a24103410f877a6fed1c2b0ff",
  "status": "success"
}

SystemDocument - reviewers(String reviewers)

Sets the Reviewers field of a document record.

Table 17. Parameters
Name Type Description
reviewers String List of one or more document reviewers by sys_id. The reviewer must be a user listed in the Users [sys_user] table.
Table 18. Returns
Type Description
None

Example

The following example shows how to set the reviewers field in a new document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : 8d19f9ca24103410f877a6fed1c2b0aa is successful.",
  "request_id": "8d19f9ca24103410f877a6fed1c2b0aa",
  "status": "success"
}

SystemDocument - state(String state)

Sets the State field of a document record.

Table 19. Parameters
Name Type Description
state String State of the document representing where the document is in the workflow.
Valid values:
  • draft
  • submit
  • review
  • complete
Default: draft
Table 20. Returns
Type Description
None

Example

The following example shows how to set the state field in a new document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
  "request_id": "19aab54e24103410f877a6fed1c2b03d",
  "status": "success"
}

SystemDocument - template(Boolean template)

Specifies whether a document record is a template.

Table 21. Parameters
Name Type Description
template Boolean

Flag that specifies whether a document record is a template.

Valid values:
  • true: The default version of this document is a template.
  • false: This document is not a template.

Default: false
Table 22. Returns
Type Description
None

Example

The following example shows how to indicate that a document record is a template. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : f7f006ce24103410f877a6fed1c2b053 is successful.",
  "request_id": "f7f006ce24103410f877a6fed1c2b053",
  "status": "success"
}

SystemDocument - type(String docType)

Sets the Type field of a document record.

Table 23. Parameters
Name Type Description
docType String Type of document.
Valid values:
  • contract
  • guideline
  • policy
  • procedure
Default: None
Table 24. Returns
Type Description
None

Example

The following example shows how to set the type field in a new document record. See also DocumentService API.

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));
Output:
{
  "message": "Create document sysId : 8adfb10224503410f877a6fed1c2b0e4 is successful.",
  "request_id": "8adfb10224503410f877a6fed1c2b0e4",
  "status": "success"
}