SystemDocument - 범위 지정, 전역

  • 릴리스 버전: Yokohama
  • 업데이트 날짜 2025년 01월 30일
  • 읽기13분

    • SystemDocument API는 문서 [ds_document] 테이블에서 레코드의 필드를 설정하는 메서드를 제공합니다.

    이 API에는 플러그인(com.snc.platform_document_management)이 문서 관리 필요하며 sn_doc_services 네임스페이스 내에서 제공됩니다. 자세한 내용은 문서 서비스를 참조하십시오.

    문서를 만들려면 DocumentService API를 사용하십시오.

    시스템 문서 - SystemDocument(String docName)

    SystemDocument 개체를 인스턴스화합니다.

    표 1. 매개변수
    이름 유형 설명
    문서 이름 문자열 문서의 이름입니다.
    표 2. 반환
    유형 설명
    안 함

    다음 예제에서는 SystemDocument 개체를 인스턴스화하고 문서 레코드에 대한 여러 필드를 설정하는 방법을 보여 줍니다. 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));
    출력:
    {
  "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
  "request_id": "1040420224503410f877a6fed1c2b031",
  "status": "success"
}

    SystemDocument - audience(문자열 대상)

    문서 기록의 대상 필드를 설정하여 외부 또는 내부 가용성을 지정합니다. 양식의 대상 필드를 문서 관리 나타냅니다.

    표 3. 매개변수
    이름 유형 설명
    대상 그룹 문자열 문서의 의도된 대상을 나타내는 문자열입니다.
    가능한 값:
    • 외부
    • 내부
    기본값: internal
    표 4. 반환
    유형 설명
    안 함

    다음 예제에서는 새 문서 레코드에서 대상 필드를 설정하는 방법을 보여 줍니다. DocumentService - 범위 지정, 전역 또한 참조하십시오.

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

    SystemDocument - 분류(문자열 분류)

    문서 기록의 분류 필드를 설정하여 정보 민감도 수준을 식별합니다. 양식의 분류 필드를 문서 관리 나타냅니다.

    표 5. 매개변수
    이름 유형 설명
    분류 문자열 문서의 분류입니다.
    가능한 값:
    • 기밀
    • 공개
    • 제한
    기본값: public
    표 6. 반환
    유형 설명
    문자열 SystemDocument 개체의 classification 속성 값입니다.

    다음 예에서는 새 문서 기록에서 분류 필드를 설정하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : d80435c624103410f877a6fed1c2b0d0 is successful.",
  "request_id": "d80435c624103410f877a6fed1c2b0d0",
  "status": "success"
}

    SystemDocument - createdFromTemplate(String docTemplate)

    문서를 생성할 템플릿을 설정합니다. 문서가 생성되면 지정된 템플릿이 문서 [ds_document_list] 테이블의 템플릿에서 작성 필드에 나열됩니다.

    표 7. 매개변수
    이름 유형 설명
    문서 템플릿 문자열 문서 [ds_document_list] 테이블에 나열된 문서의 Sys_id입니다. 문서에 템플릿 확인란이 선택되어 있어야 합니다(true). 다른 살펴볼 내용 DocumentVersionService API.
    표 8. 반환
    유형 설명
    안 함

    다음 예시에서는 기존 템플릿에서 새 문서 기록을 생성하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : deaef1ce24103410f877a6fed1c2b085 is successful.",
  "request_id": "deaef1ce24103410f877a6fed1c2b085",
  "status": "success"
}

    SystemDocument - 부서(String docDept)

    문서 기록의 부서 필드를 설정합니다.

    표 9. 매개변수
    이름 유형 설명
    문서 부서 문자열 부서 [cmn_department] 테이블에 나열된 부서의 Sys_id입니다.
    표 10. 반환
    유형 설명
    안 함

    다음 예는 새 문서 기록에서 부서 필드를 설정하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : 491efbee24187410f877a6fed1c2b0a9 is successful.",
  "request_id": "491efbee24187410f877a6fed1c2b0a9",
  "status": "success"
}

    SystemDocument - description(문자열 설명)

    문서 기록의 설명 필드를 설정합니다.

    표 11. 매개변수
    이름 유형 설명
    설명 문자열 문서에 대한 설명입니다.
    표 12. 반환
    유형 설명
    안 함

    다음 예는 문서 기록에서 설명 필드를 설정하는 방법을 보여줍니다. 참고 항목: 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));
    출력:
    {
  "message": "Create document sysId : 9acd7fea24587410f877a6fed1c2b060 is successful.",
  "request_id": "9acd7fea24587410f877a6fed1c2b060",
  "status": "success"
}

    시스템 문서 - name(String docName)

    문서 기록의 이름 필드를 설정합니다.

    주:
    SystemDocument() 생성자에서 이름을 매개 변수로 설정할 수도 있습니다.
    표 13. 매개변수
    이름 유형 설명
    문서 이름 문자열 문서의 이름입니다.
    표 14. 반환
    유형 설명
    안 함

    다음 예는 새 문서 기록에서 이름 필드를 설정하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : c19d7f2624587410f877a6fed1c2b0eb is successful.",
  "request_id": "c19d7f2624587410f877a6fed1c2b0eb",
  "status": "success"
}

    SystemDocument - 소유자(문자열 소유자)

    문서 기록의 소유자 필드를 설정합니다.

    표 15. 매개변수
    이름 유형 설명
    소유자 문자열 사용자 [sys_user] 테이블에 나열된 사용자의 Sys_id입니다.

    필요한 역할: 관리자

    기본값: 현재 사용자
    표 16. 반환
    유형 설명
    안 함

    다음 예시에서는 새 문서 기록에서 소유자 필드를 설정하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : 4235318a24103410f877a6fed1c2b0ff is successful.",
  "request_id": "4235318a24103410f877a6fed1c2b0ff",
  "status": "success"
}

    SystemDocument - reviewers(문자열 검토자)

    문서 기록의 검토자 필드를 설정합니다.

    표 17. 매개변수
    이름 유형 설명
    검토자 문자열 sys_id별 한 명 이상의 문서 검토자 목록입니다. 검토자는 사용자 [sys_user] 테이블에 나열된 사용자여야 합니다.
    표 18. 반환
    유형 설명
    안 함

    다음 예는 새 문서 기록에서 검토자 필드를 설정하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : 8d19f9ca24103410f877a6fed1c2b0aa is successful.",
  "request_id": "8d19f9ca24103410f877a6fed1c2b0aa",
  "status": "success"
}

    SystemDocument - 상태(문자열 상태)

    문서 기록의 상태 필드를 설정합니다.

    표 19. 매개변수
    이름 유형 설명
    state 문자열 워크플로우에서 문서가 있는 위치를 나타내는 문서의 상태입니다.
    유효한 값은 다음과 같습니다.
    • 초안
    • 제출
    • 복습
    • 완료
    기본값: 초안
    표 20. 반환
    유형 설명
    안 함

    다음 예는 새 문서 기록에서 상태 필드를 설정하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
  "request_id": "19aab54e24103410f877a6fed1c2b03d",
  "status": "success"
}

    SystemDocument - 템플릿(부울 템플릿)

    문서 기록이 템플릿인지 여부를 지정합니다.

    표 21. 매개변수
    이름 유형 설명
    템플릿 부울

    문서 기록이 템플릿인지 여부를 지정하는 플래그입니다.

    유효한 값은 다음과 같습니다.
    • true: 이 문서의 기본 버전은 템플릿입니다.
    • false: 이 문서는 템플릿이 아닙니다.

    기본값: false
    표 22. 반환
    유형 설명
    안 함

    다음 예는 문서 기록이 템플릿임을 나타내는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : f7f006ce24103410f877a6fed1c2b053 is successful.",
  "request_id": "f7f006ce24103410f877a6fed1c2b053",
  "status": "success"
}

    SystemDocument - 유형(문자열, 문서 유형)

    문서 기록의 유형 필드를 설정합니다.

    표 23. 매개변수
    이름 유형 설명
    docType 문자열 문서의 유형입니다.
    유효한 값은 다음과 같습니다.
    • 계약
    • 가이드라인
    • 정책
    • 절차
    기본값: 없음
    표 24. 반환
    유형 설명
    안 함

    다음 예는 새 문서 기록에서 유형 필드를 설정하는 방법을 보여줍니다. 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));
    출력:
    {
  "message": "Create document sysId : 8adfb10224503410f877a6fed1c2b0e4 is successful.",
  "request_id": "8adfb10224503410f877a6fed1c2b0e4",
  "status": "success"
}