Integrating Approval

Available in Classic/VPC.

Set Approval

Linking Approval is a task to link the approval information of WORKPLACE to the company's corporate information system. When the Approval linkage is set, the approval status of each WORKPLACE form is automatically sent to the company's corporate information system. You can utilize it in different ways on the company's corporate information system.

Flow of Approval linkage settings and processing:

The following describes the settings method for receiving events that occur in the document processing process.

1. From the NAVER Cloud Platform console, click the Services > Business Applications > WORKPLACE menus, in that order.
2. Click the Developers menu.
   • If the notification pop-up window appears, check the details in the pop-up window, and then click the [Close] button.
3. Click Link Approval > Set Approval, in that order.
4. Click the [Browse] button in Add Forms.
5. Select the form to be linked, and then click the [Apply] button.
6. Set the information to be received for each form.

• Select Approval Status: Select the status for which the delivery is made. The name can be displayed differently, depending on the Approval admin’s approval type and processing type settings. (Example > Approval/Consent)
• Enter Callback URL: Enter the callback URL of the form. For the entry method, see Callback URL.
  • Refer to Event Processing for the processing of registered callback URL.

7. Click the [Save] button to complete the setup.

Enter Callback URL

Enter the callback URL to receive events that occur for each form.

• To receive events for each form, set each URL to receive callback. To use the same URL, you can set dfmId as the get parameter, as shown in the example below.

The object structure delivered during event callback is as follows.

• Please refer to the following table for events available for delivery (sendTpCd).

Event Processing

It processes events that occur from Approval documents in real time by calling registered callback URL using the PUT method. The processing method is as follows.

• Method: PUT
• Media Type: application/json

It is processed as follows according to the response code of the PUT method call result.

• When the response code is returned in the 200 range: Recorded as successful delivery
• When the response code is returned in the 400 or 500 range: Recorded as failed delivery

The processing results are recorded in Developers of the WORKPLACE console. Refer to Delivery History for delivery details.

View Delivery History

You can view the success and failure history of the approval information delivered to the client's corporate information system, as well as resend failed history.

The View Delivery History page is laid out as follows.

Resend Failed History

The following describes how to resend failed delivery history.

1. From the NAVER Cloud Platform console, click the Services > Business Applications > WORKPLACE menus, in that order.
2. Click the Developers menu.
3. Click Link Approval > View Delivery History, in that order.
4. Select Succeeded and Failed Delivery History.
5. Click the [Resend] button.

View Document Details Using API

You can view the details of received documents by calling provided API.

2 types of APIs are provided, and you can search using aprvId.

• V1 API: This API can be used to view document details of basic WORKPLACE forms. For more details, see V1 API.
  • Example of API call: https://workplace.apigw.ntruss.com/workflow/apigw/v1/company/52e6e775-6993-424d-bc58-62e17268ed29/doc/25025
• V2 API: You can view documents of forms created by Create Form. For more details, see V2 API.
  • Example of API call: https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/52e6e775-6993-424d-bc58-62e17268ed29/doc/25025

Set Component Keys

It can be linked to set company-specific component keys for specific components of created forms. The configured component keys can be utilized as parameters when searching document details using an open API.

Flow of component key settings and utilization:

The following describes how to add a form to set the component key for.

1. From the NAVER Cloud Platform console, click the Services > Business Applications > WORKPLACE menus, in that order.
2. Click the Developers menu.
3. Click Link Approval > Set Component Key, in that order.
4. Click the [Browse] button.
5. Select a form.

• You can only select forms set to Use, among forms created with Create Form.

6. Click the [Apply] button.

• Integrated forms can be utilized by setting the company's unique ID in the component. Refer to Set User-defined ID.

Set User-defined ID

For integrated forms, the Component Linkage Settings option is displayed in the options area of the form details.

The following describes how to set the user-defined component ID for the integrated form.

1. In the WORKPLACE PC webpage, click the [Service Menu] > [Manage Approval] button.
2. Click the Form > Manage Form menu.
3. Click of the integrated form.
4. Enter the User-defined ID in the component linkage settings area.
5. Click the [Save Form] button to save.

• The entered user-defined ID can be utilized as a parameter (componentCustomId) when calling search form information API. For more details, see View Form Details API Guide.