본 문서에서는 API Portal Admin에서 진행하는 결재 요청과 승인 과정을 설명합니다.
Index
Deploy 기능은 솔루션 공급 방식에 따라 제한적으로 제공됩니다.
결재 요청
1) API Portal Admin Account 결재 권한 부여
•
API Portal Admin에서는 Deploy Request 소스의 결재 요청과 승인 과정이 이루어집니다.
•
API Portal Admin의 Account는 API Portal Admin > Management > Account 메뉴 에서 각 계정의 Deploy Permission을 조정하여 결재와 관련된 권한을 부여할 수 있습니다.
•
각 권한은 다음과 같으며, API Portal 사이드 메뉴의 구성이 달라집니다.
No. | Deploy Permission | 설명 | API Portal Admin 사이드 메뉴 구성 |
1 | Request | 결재 요청 가능 | Deploy 전체 메뉴 노출 |
2 | Approval | 결재 승인 가능 | Deploy 메뉴 중 결재 목록(Approvals List)만 노출 |
3 | Approval/Request | 결재 요청과 승인 모두 가능 | Deploy 전체 메뉴 노출 |
4 | Not Available | 결재에 관한 권한 없음 | Deploy 메뉴 비노출 |
2) Approval Request - 배포 요청 항목 선택
•
API Portal Admin의 Deploy > Approval Request 페이지에서 SyncTree Studio에서 Deploy Request를 통해 배포 요청이 생성된 Revision과 리소스 정보를 확인할 수 있습니다.
•
결재를 상신하기 위해 Revision 체크 박스를 선택하면 우측 상단의 Request 버튼이 활성화됩니다. 이 버튼을 클릭하면 Approval Request Registration 페이지로 연결됩니다.
•
결재 요청 전에는 Cancel 버튼이 활성화되어 있어, 배포 요청의 취소가 가능합니다.
•
Status는 결재의 진행 상태를 표시하며, 진행 단계에 따라 자동으로 바뀝니다.
Status(KR) | Status(EN) | 상세 | Deploy 취소 |
- | - | API Portal에서 아직 결재 요청 하지 않음 | 가능 |
1차 승인 대기 | Wait for 1st approval | 결재 생성 즉시 | 불가 |
2차 승인 대기 | Wait for 2nd approval | 1차 결재권자가 승인 | 불가 |
3차 승인 대기 | Wait for 3rd approval | 2차 결재권자가 승인 | 불가 |
배포 대기 | Wait for deploment | 3차 결재권자가 승인 && 배포 시각 이전 | 불가 |
•
리스트에서 확인할 수 있는 Revision의 리소스 정보는 아래와 같습니다.
Type(리소스) | Type Name에 표시되는 Studio 항목 | 설명 | SyncTree Studio 경로 |
bizunit (pk) | Bizunit Name | Studio에서 배포 요청하는 기본 단위 | Apps > BizUnit |
app | App Name | BizUnit이 속한 App의 이름 | Apps |
revision | Revision Name | BizUnit의 환경(Production), 상태(Active) | Apps > BizUnit > Revision List |
bizunit_proxy | Proxy Name | proxy method, base_path 등 상세 정보 | Apps |
operator | Bizunit Name과 동일 | block code meta 정보 | - |
storage | Storage Group Name | App에 연결된 Storage 그룹 | Storage > Storage Group |
storage_detail | Storage Name | BizUnit에 연결된 Storage 이름 | Storage > Storage |
dictionary | Dictionary Group Name | App에 연결된 Dictionary 그룹 | Dictionary > Dictionary Group > Edit |
dictionary_detail | Dictionary Key Name | BizUnit에 연결된 Dictionary Key 이름 | Dictionary > Edit |
scheduler | Scheduler Name | 세팅된 Scheduler 정보 | Scheduler |
query | Storage Query Name | BizUnit에 연결된 Query 이름 | Query Manager > Query |
3) Approval Request Registration - 결재 정보 작성하여 결재 상신
•
결재에 대한 정보와 결재권자를 지정하여 최종적으로 결재를 상신합니다.
No. | 설명 |
1 | Project Number 는 최대 9자 이하의 숫자로 입력하며, 이 값은 다른 요청과 중복될 수 없습니다. |
2 | 프로젝트 이름을 기입합니다. |
3 | Deploy Date에서 배포 일자, Deploy Time에서 배포 시각을 지정합니다.
결재가 승인되면 지정한 시각에 배포됩니다. |
4 | 긴급 배포를 의미하며, 해당 항목을 체크하면 승인 완료 시 즉시 배포됩니다. |
5 | 결재 상신을 선택한 Revision과 그에 종속된 리소스 항목들을 확인할 수 있습니다. |
6 | Deploy Permission에 Approval이 포함된 결재권자(결재라인)을 최소 1명에서 최대 3명 까지 지정할 수 있습니다. |
7 | [Cancel] 버튼 클릭 시 Approval Request 화면으로 이동하고, [Done] 버튼으로 결재 승인 요청이 등록됩니다. |
결재 확인 및 승인
1) Approvals List - 결재 요청 목록 확인
•
Approval Request를 통해 결재 승인 요청한 항목들이 노출되며, 상태의 최종 단계(승인, 반려, 취소)에 도달해도 목록에서는 사라지지 않습니다.
•
로그인한 API Portal 계정이 결재권자일 때 My Approvals 체크박스를 선택하면, 나에게 할당된 결재 리스트만 필터링하여 볼 수 있습니다.
•
Project Number를 클릭하면 해당 결재 요청에 대한 상세 정보 페이지로 연결됩니다.
•
결재 진행 Status는 아래와 같습니다.
Status(KR) | Status(EN) | 상세 | 결재 요청 취소 |
1차 승인 대기 | Wait for 1st approval | 결재 생성 즉시 | 가능 |
2차 승인 대기 | Wait for 2nd approval | 1차 결재권자가 승인 | 불가 |
3차 승인 대기 | Wait for 3rd approval | 2차 결재권자가 승인 | 불가 |
반려 | Rejected | 승인 차수 상관없이 반려 처리 | 불가 |
배포 대기 | Wait for deploment | 3차 결재권자가 승인 && 배포 시각 이전 | 불가 |
배포 (진행)중 | Deployment in progress | 배포 시작 직후 ~ 배포 완료 직전까지 | 불가 |
배포 완료 | Deployment Completion | 3차 결재권자가 승인 && 배포 시각 이후
(or 배포 상태 ‘완료’ 검증 이후) | 불가 |
승인 기한 만료 | Wait time expired | 설정된 배포 시각까지 최종 승인되지 않음 | - |
배포 실패 | Deployment operation failed | 배포가 진행되었으나 정상적으로 완료되지 않음 (논리적으로는 retry 가능) | - |
배포 불가 | Unable to deploy | 기능적으로 배포 불가 (시작이 불가) | - |
2) Approvals Request Details - 결재 요청 상세 확인 / 승인 / 반려
•
결재 항목에 대해 열람과 최종 승인, 반려 처리를 하는 페이지입니다.
No. | 설명 |
1 | 승인 요청된 배포건에 대한 정보 영역으로 열람만 가능합니다. |
2 | 결재 요청 등록 시 설정한 결재권자의 목록이 노출됩니다. |
3 | 결재에 대한 최종 처리를 하는 버튼으로, 결재권자가 아닐 경우 [List] 버튼만 노출됩니다.
[List] : Approvals List로 이동합니다.
[Approve] : 클릭 시 결재가 승인됩니다.
- 다음 결재권자가 지정되었을 경우 해당 결재권자가 결재를 검토할 수 있게 됩니다.
- 최종 결재권자인 경우, 지정된 시간에 배포가 진행됩니다.
[Reject] : 클릭 시 배포 승인이 거절됩니다. |
결재가 승인되면 운영 서버의 SyncTree 스튜디오에 배포 요청 시점과 동일한 Production, Active 상태의 Revision과 리소스가 배포됩니다.
운영 서버의 API Portal 등록 및 Public 공개는 Portal API 생성 매뉴얼을 참고하시기 바랍니다.