API Inspector Settings
AlchemyJ provides API Inspector for you to check the intermediate result during runtime for troubleshooting. The API Inspector settings can be defined and enabled in the ##InspectorSettings worksheet. To show the Inspector Settings worksheet, to AlchemyJ ribbon and click Inspector Settings in the Troubleshoot menu group.
API Inspector Settings contain the following sections.
- Basic Settings
- Generate API Inspector Excel File
- Set Cell Formula
- Set Cell Value
- View Cell
- View Cookie
- View Environment Properties
- View Exception
- View Library Function Parameter
- View Function Point Parameter
- View Request Body
- View Request Header
- View Request Parameter
- View Session
Basic Settings
| Item | Description |
|---|---|
| API Inspector listening port | This specifies the port API Inspector shall be monitoring, the default is 9898. There is no need to modify this unless 9898 is currently occupied in your machine. |
Generate API Inspector Excel File
Description
Generates an Excel file that represents the workbook in memory. It is like a snapshot of the model after a method is run. By being able to check the formulas and values in the file, it can help you to find out what has went wrong.
Supporting Parameters
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered. Value “*” means the action would be triggered by all function points. |
| Folder Path | Yes | None | The folder location where the file should be saved. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
Set Cell Formula
Description
Sets a formula to a specified cell.
Supporting Parameters
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Cell Address | Yes | None | Defines the address to set the formula. For example, sheetA!B1. |
| Formula | Yes | None | Defines the formula to be set. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
Set Cell Value
Description
Sets a value to a specified cell.
Supporting Parameters
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Cell Address | Yes | None | Defines the address to set the value. For example, sheetA!B1. |
| Value | Yes | None | Defines the value to be set. |
| Data Type | Yes | None | Defines the data type for the value to be set. String/Number/Date. If the data type is date, the default date format is yyyy-MM-dd HH:mm:ss |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Cell
Description
Prints out the value of the specified cell from API Inspector.
Supporting Parameters
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered. Value “*” means the action would be triggered by all function points. |
| Show Formula | No | False | Defines whether the formula text would be printed to API Inspector. |
| Cell Address | Yes | None | Defines the address of the cells to be printed. For example, sheetA!B1. It supports range addresses. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Cookies
Description
Prints out the cookies information to API Inspector. This action only supports REST APIs.
Supporting Parameter
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Environment Properties
Description
Prints out the environment properties to API Inspector. This action is only supported in REST APIs.
Supporting Parameters
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Key Name | Yes | None | Define which keys should be printed. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Exception
Description
Prints out the exception information to API Inspector.
Supporting Parameter
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Library Function Parameter
Description
Prints out the value of input parameters and output parameters of a specified AlchemyJ Extended Function to API Inspector.
Supporting Parameters
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Function Name | Yes | None | The AlchemyJ Extended Functions that would be included. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Request Body
Description
Prints out the request body to API Inspector. This action only supports REST APIs.
Supporting Parameter
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Request Header
Description
Prints out the request header to API Inspector. This action only supports REST APIs.
Supporting Parameter
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Request Parameter
Description
Prints out the request parameters to API Inspector. This action only supports REST APIs.
Supporting Parameter
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Disable | No | No | To enable or disable the inspector settings of this row. |
View Session
Description
Prints out the session information from API Inspector. This action only supports REST APIs.
Supporting Parameter
| Parameter Name | Mandatory | Default Value | Description |
|---|---|---|---|
| Function Point | Yes | None | Defines which function point this action would be triggered, value “*” means the action would be triggered by all function points. |
| Disable | No | No | To enable or disable the inspector settings of this row. |