This document describes the structure of BizUnit and the block coding method using NBlock.
Index
Plan Control
•
Some features of NBlock are controlled by your subscribe Plan.
BizUnit Structure
•
When you create a BizUnit, a basic template is provided for API communication.
•
The structure of BizUnit is divided into 4 main parts.
Division | Function |
Request | The area that defines the request data for API calls. |
Statement | The area where the API creates the business logic that works. |
Response | The area that defines the response to be returned after executing the called API. |
Exceptions | An area that defines and handles exception situations that occur during API operation. |
NBlock creation page
•
The NBlock creation page has the following information.
No. | Function |
1 | Check the current BizUnit information and path
App : [The name of the Apps to which BizUnit belongs] > BizUnit : [BizUnit name_version] > Revision : [BizUnti revision [revision name]] |
2 | A drop-down list to select a different revision of the BizUnit you are currently working on.
If no other Revision is available, the list does not appear when the button is selected. |
3 | Revision status change button. (Active ⇆ Standby) |
4 | The number of accounts that have shared the revision. |
5 | Category of NBlock.
When you select a category, NBlock belonging to each category appears, and you select NBlock to use it |
6 | NBlock Save button to save the worked block, and it can also be operated with Ctrl+S. |
7 | Button for Revision Build
To proceed with Build, Save must come first. |
8 | Button for Revision Push. (Same function as Push in Revision List)
Appears when the revision status is Active, and when a button is selected, a Push Guidance Popup is exposed. |
Add-on to NBlock
•
Various add-ons provided by the NBlock creation page.
1) Provide API Document
•
After completing Save and Build, NBlock checks the separate API Document page through the Document button at the top right.
•
Use this information to test your API with external testing tools.
2) Using API Tester
•
After saving and building, the Test button is activated for NBlock, and you can quickly test the API directly without using a separate external test tool.
•
The request data defined through the request area of NBlock is displayed in the Header area, and additional data is input with the + button.
•
Type the request body in Json, Text, and Form (Key/Value) types
•
If you press Run at the bottom, the API works and you can check the Response and Console Log.
3) Exception Block Shortcut
•
When an Exception occurs during the test, an [!] icon is displayed on the Console tab.
•
A link to the block where the error occurred is created, and you can move directly to that block by clicking it.
4) Making JSON data into blocks
•
Create a block by directly composing data in Json format.
•
5) Utilization for Comment Blocks, Zoom, and Trash Bin
•
Using Helper's Comment, Comment Statement block, a flag icon appears in the upper right corner. When you click the flag icon, you can see the Comment List and leave a note.
•
If you click Comment, you can go directly to the location of the block and use it like a check point.
•
The blocks placed within the import-code of the Comment Statement block are annotated.
•
Adjust NBlock screen size with Zoom-in/out button
•
You can drag a block to put it in the Recycle Bin, and the block in the Recycle Bin remains for a certain period of time, so you can take it out again.
6) BizUnit Connect
•
View your blocks or blocks shared by others through Extension.
◦
My : Call the active Revision among my revisions.
◦
Other : Call the shared Revision.
7) Code Split
•
Code Split is a feature that automatically splits the block screen according to certain criteria when registering a large number of blocks.
•
Code Split Settings
◦
The toggle button on the NBlock screen can be used to select whether to apply Code Split.
◦
Save must be done before the button is activated.
◦
Code Split explanation can be found in the '?' Icon.
Moves to a page where you can check the flow in Code Section units.
At least one block must exist in the statement. After saving, the button becomes active. If there are any changes, please save them and use the function.
•
If there is no block in the statement, the button will not be active after saving.
•
Blocks that are not grouped as Code Sections are grouped by 500 units.
•
Flow: Refers to the screen split by Code Split.
No. | Function |
1 | Check the entire flow of the BizUnit split by Code Split. |
2 | The selected Code Section Flow is displayed in a different background color. |
3 | The default name of Code Section is 'Code Section {n}', which can be changed by using a Comment Block. The names of Request/Response/Exception {n} cannot be changed. If there are multiple Exception blocks, they will be created as 'Exception {n}' when split. |
4 | After accessing the Flow screen, you need to Save to reactivate the Flow. |
5 | Debug feature is disabled on the Flow screen. |
6 | Block search is only enabled within the corresponding Code Section Flow. |
•
Code Split criteria are as follows:
◦
◦
When a single block contains more than 500 blocks.
◦
When blocks are divided based on the standard of 500 blocks, and there are leftover blocks.
◦
When adding n+1 blocks exceeds 500.
Code Split is provided in a limited way, depending on how the solution is supplied.
8) Debugger (Beta)
•
Debugger allows you to easily and reliably locate the block where the error occurs.
•
The Debug button is activated after Save and Build in BizUnit.
•
Button Description
◦
Start Debug button: Runs the entire block in turn, one step at a time.
◦
Next Step button: Proceeds to execute the next step of the block. When it reaches a block with an error, it highlights it and displays the error details.
Debug error details
◦
Stop Debug button: Click to end the running debug.
•
‘?’ icon for a description of Debug.
We release the debug feature as a beta version. You can easily and reliably find the location of the error in the block coding where the error occurs.
•
When the Start Debug button is clicked, it starts executing the entire block step by step.
•
Continue to the next step by clicking the Next Step button! When a block with an error is reached, it will be highlight and the error details will be shown.
•
Request and Response are included in the basic inspection, and if a 'Log/Debug message' block is included in the Statement, the inspection starts from that block.
* The debug function is currently in beta, and you can debug block coding consisting of up to 2,000 blocks.
* If you use the split function, the debug function is deiabled.
* Debug function is diasbled if the proxy path contains a dynamic url.
Debugger is provided in a limited way, depending on how the solution is supplied.