This document describes process of the approval request and approval in API Portal.
Index
Deploy function is provided in a limited way, depending on how the solution is supplied.
Approval Request
1) Grant permission for API Portal User approval
•
API Portal provides approval requests and approvals for the Deploy Request source.
•
Users in the API Portal can grant payment-related permission through Studio > Portal > Manage User > Deploy Permission.
•
Below is each permission, and the configuration of the API Portal side menu is different.
No. | Deploy Permission | Explanation | API Portal side menu configuration |
1 | Request | Approval request available | The Deploy menu exposed |
2 | Approval | Approved 가능 | Tthe Approval List on the Deploy menu exposed |
2 | Approval /Request | Both approval request and approval are available | The Deploy menu exposed |
4 | Not Available | No permission to approval | The Deploy menu unexposed |
2) Approval Request - Select requested deployment item
•
On the Deploy > Approval Request page of the API Portal, in SyncTree Studio, chedck the Revision and resource information for which the deployment request was created through Deploy Request
•
If the Revision check box is selected to request approval, the Request button at the top right is activated. Click this button to go the Approval Request Registration page.
•
The Cancel button is activated before the approval request, the deployment request can be canceled .
•
Status displays the progress of the approval, and changes automatically according to the progress.
Status(EN) | Status(KR) | Details | Cancel Deploy |
- | - | No approval request in API Portal yet | Available |
Wait for 1st approval | 1차 승인 대기 | Immediately upon approval creation | Not available |
Wait for 2nd approval | 2차 승인 대기 | Approved by the 1st approver | Not available |
Wait for 3rd approval | 3차 승인 대기 | Approved by the 2nd approver | Not available |
Wait for deploment | 배포 대기 | Approved by 3rd approver && before deployment time | Not available |
•
Below is the resource information of Revision that can be found in the list.
Type(Resource) | Studio item displayed in Type Name | Explanation | SyncTree Studio Path |
bizunit (pk) | Bizunit Name | Base unit requested by Studio for deployment | Orchestra > Apps > BizUnit |
app | App Name | The name of the app the BizUnit belongs to | Orchestra > Apps |
revision | Revision Name | Environment (Production), Status (Active) of BizUnit | Orchestra > Apps > BizUnit > Revision List |
bizunit_proxy | Proxy Name | The details such as proxy method, base_path | Orchestra > Apps |
operator | Same as Bizunit Name | block code meta information | - |
storage | Storage Group Name | Storage Group App | Storage > DB Storage > Storage Group |
storage_detail | Storage Name | Storage Name connected to BizUnit | Storage > DB Storage |
dictionary | Dictionary Group Name | Dictionary Group connected to App | Dictionary > Dictionary Group > Edit |
dictionary_detail | Dictionary Key Name | Dictionary Key name connected to BizUnit | Dictionary > Edit |
scheduler | Scheduler Name | Set Scheduler information | Scheduler |
query | Storage Query Name | Query Name connected to BizUnit | Studio > Storage > Query Manager > Query |
3) Approval Request Registration - Approval request by filling out approval information
•
Finally request approval with designating approval information and approver.
No. | Explanation |
1 | The Project Number is entered with a maximum of 9 characters or less, which cannot be duplicated with other requests. |
2 | Enter the project name. |
3 | Specify the deployment date in Deploy Date, and the deployment time in Deploy Time.
Once the approval is approved, it is deployed at the specified time. |
4 | It means urgent deployment , and if checked it will be deployed immediately upon approval made. |
5 | Check Revision and its dependent resource items that have selected the approval request. |
6 | A minimum of 1 and a maximum of 3 approvers (approver party) including Approval in Deploy Permission are designated |
7 | Click the [Cancel] button to go to the Approval Request screen and register the approval request with the [Done] button. |
Checking approval and making it approved
1) Approvals List - Checking Approvals List
•
Items requested for approval through Approval Request are exposed and do not disappear from the list even when reaching the final stage of status (approved, rejected, or canceled).
•
If the My Approvals check box is selected when the logged-in API Portal account is the approver, only the payment list assigned to me is filtered and displayed
•
Click Project Number to connect to the Details page for that approval request.
•
Below is the Approval process Status.
Status(KR) | Status(EN) | Status(KR) | Details | Cancel Approval Request |
1차 승인 대기 | Wait for 1st approval | 1차 승인 대기 | Immediately upon approval creation | Available |
2차 승인 대기 | Wait for 2nd approval | 2차 승인 대기 | Approved by the 1st approver | Not available |
3차 승인 대기 | Wait for 3rd approval | 3차 승인 대기 | Approved by the 2nd approver | Not available |
반려 | Rejected | 반려 | Rejection regardless of the degree of approvals | Not available |
배포 대기 | Wait for deploment | 배포 대기 | Approved by 3rd approver && before deployment time | Not available |
배포 (진행)중 | Deployment in progress | 배포 (진행)중 | Immediately after the start of deployment ~ Just before the completion of deployment | Not available |
배포 완료 | Deployment Completion | 배포 완료 | After the 3rd approval authority approves && after deployment time
(or after verifying the deployment status 'Completion') | Not available |
승인 기한 만료 | Wait time expired | 승인 기한 만료 | Not finalized until set deployment time | |
배포 실패 | Deployment operation failed | 배포 실패 | Deployment has progressed but not completed normally (logically, retry is possible) | |
배포 불가 | Unable to deploy | 배포 불가 | Functionally Deployment Not Available (Unable to start) |
2) Approvals Request Details - Approval Request Details Check / Approved / Rejected
•
Below is the page to check, final approve and reject to Approval items.
No. | Explanation |
1 | Only access to the information area for the deployment requested for approval. |
2 | The list of approvers set when registering an Approval request is exposed. |
3 | The button that makes the final processing of the approval, only the [List] button is exposed if it is not the approver
[List] : Go to Approvals List
[Approve] : lt is approved when clicking
- If the next approver is designated, the approver will be able to check the approval.
- If you are the final approver the deployment will proceed at the designated time.
[Reject] : lt is rejected when clicking |
Once the payment is approved, the production server's SyncTree studio will be deployed with Revision and resources in the same Production, Activer state as the deployment request time.
For API Portal registration and public disclosure on the production server, please refer to the Portal API creation manual.
•