SystemDocumentListEntry - Scoped, Global
-
- UpdatedFeb 1, 2024
- 3 minutes to read
- Washington DC
- API reference
The SystemDocumentListEntry API provides methods for setting the record fields in the Document List Entries [ds_document_list_entry] 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.
Before using the methods in this API, add a document with its version and create a document list. Use the DocumentListEntryService API to add or remove documents from a document list.
- SystemDocument – Define a document object.
- DocumentService – Add, update, or delete a document.
- SystemDocumentVersion – Define a document version.
- DocumentVersionService – Add, update, or delete a document version.
- SystemDocumentList – Define a document list.
- DocumentListService – Add, update, or delete a document list.
SystemDocumentListEntry - SystemDocumentListEntry(String listID)
Instantiates a SystemDocumentListEntry object.
Name | Type | Description |
---|---|---|
listSysId | String | Sys_id of a document list record in the Document Lists [ds_document_lists] table. |
Type | Description |
---|---|
None |
Example
The following example shows how to instantiate a SystemDocumentListEntry object.
SystemDocumentListEntry - description(String description)
Sets the Description field of a document list entry record.
Name | Type | Description |
---|---|---|
description | String | Description of the document list entry. |
Type | Description |
---|---|
None |
Example
The following example shows how to add a description to the document list entry provided using the constructor. See also DocumentListEntryService API.
SystemDocumentListEntry - document(String docSysId)
Specifies the document template to add to a document list.
- Define the document object setting the SystemDocument – template() method to true. Create or update the document record with the methods in the DocumentService API.
- Select the Template check box of a document in the Documents [ds_document] table.
- SystemDocumentVersion – Define a document version.
- DocumentVersionService – Add, update, or delete a document version.
Name | Type | Description |
---|---|---|
docSysId | String | Sys_id of a document record in the Documents [ds_document] table. The document specified must be a template and have a version. |
Type | Description |
---|---|
None |
Example
The following example shows how to add a document template as a document list entry. See also DocumentListEntryService API.
SystemDocumentListEntry - documentList(String listSysId)
Specifies the document list in which to add a document.
- SystemDocumentList – Define a document list.
- DocumentListService – Add, update, or delete a document list.
Name | Type | Description |
---|---|---|
listSysId | String | Sys_id of a document list record in the Document Lists [ds_document_lists] table. |
Type | Description |
---|---|
None |
Example
The following example shows how to set the document list in which to add a document. See also DocumentListEntryService API.