1. Introduction
The app exposes dedicated pages for Setup, Dashboard, Actors, Operations, and API Gateway to manage integrations and operational logs.
1.1 Recipients
The manual is intended for application consultants, key users, and functional developers who work on Business Central and need to configure or monitor integrations (actors, operations, queues, and workflows).
1.2 Scope of the document
The document covers: initial setup, dashboard consultation, actor and parameter management, task creation/execution, sending via API Gateway, automatic background execution, workflow configuration, and maintenance tasks.
1.3 Conventions and terms
The following terms are used in the document:
| Term | Meaning |
| Setup Integration Broker | General app configuration page (number series, options, graphs and settings). |
| Dashboard | Tracking page showing graphs and quick links to key areas. |
| Actor | Configurable element representing a connector/integration scenario and its parameters. |
| Operation | Execution (manual or automatic) of an integration scenario, with inputs/outputs and status. |
| API Gateway | Endpoint/page that allows you to send operations and parameters via API calls. |
| Queue / Job Queue | Background execution mechanism via scheduled jobs. |
| Workflow | Rules and responses that, when conditions occur, generate or initiate operations. |
| Error Codes | Code/description mapping to classify and normalize integration errors. |
2. Basic concepts
2.1 Setup
The Setup centralizes numbering series, dashboard parameters and serialization options.
2.2 Dashboard
The Dashboard displays charts configured by Setup and links to the main areas.
2.3 Actors
Actors define the scenario, encoding, and integration parameters.
2.4 Operations
Operations record input/output, state, and integration results.
2.5 API Gateway
APIs allow you to create and execute operations via OData API endpoints.
2.6 Autorun
The queue can create or execute operations through Job Queue and background tasks.
2.7 Workflow
Workflow events and responses are available for operations.
2.8 Errors and maintenance
Tools are available to code errors and clean up orphaned parameters.
3. Pages and functions
The app pages allow you to configure setups and actors, monitor executions, and interact with operations via the UI and API. Names may vary depending on locale; this manual uses the draft names.
3.1 Overview and Access
The app exposes dedicated pages for Setup, Dashboard, Actors, Operations, and API Gateway to manage integrations and operational logs.
Pages involved:
Actor Card with the part "Actor Permissions".
User Setup (extended from Pageextension 72913963 User Setup).
Main fields:
"Integrator Admin".
"User ID" (actor permission).
Actions:
action "Actors" (opens the filtered Actors list).
management via permission list.
no dedicated action
3.2 Setup
The Setup centralizes numbering series, dashboard parameters and serialization options.
Pages involved:
Setup .
Main fields:
"Actor No. Series"
"Auto Incremental Operation Key"
"Default Operation No. Series"
"License Expiration Date"
"License Status"
"Missing Transformation Error".
Chart fields 1..6
part "Current License" (Additional Info Part).
Actions:
AddRetentionPolicy
Check License
Check invalid parameter.
Error Codes
NuBeTech
Transformation
action "Check License".
AddWorkflow debug actions
3.3 Dashboard
The Dashboard displays charts configured by Setup and links to the main areas.
Pages involved:
Dashboard .
Main fields:
Chart1..Chart6 charts (visible based on "Chart x Visible").
Actions:
Actors
Areas
Entities
Operations.
Setup
3.4 Actors
Actors define the scenario, encoding, and integration parameters.
Pages involved:
Actor Card .
Actor Card with the part "Actor Permissions".
Actor Card with parts "Input Params", "Output Params", "Protected Params".
Actor List and Actor Card.
Main fields:
"Classification" in the parameter lists.
"Code"
"Description"
"Encoding"
"Name"
"Operation No. Series".
"Scenario"
"User ID" (actor permission).
"Value"
operation counters by state.
Actions:
counter drilldown (open filtered Operation List).
drilldown on Queued/Processing/Processed/Error/To be deleted counters.
management via permission list.
lookup on the Name field to choose parameters from the scenario.
no dedicated action
3.5 Operations
Operations record input/output, state, and integration results.
Pages involved:
API Gateway .
Actor Card .
Operation Card or Operation List.
Operation List .
Operation List and Operation Card.
Workflow Response Options (extended from Pageextension 72913964 Workflow Response Opt).
Main fields:
"Action Code"
"Actor Code"
"Execution By"
"Execution Count".
"Execution Status"
"Action Code"
"Actor Code"
"Execute on Creation"
"Input Message Source"
"scenario"
"Processed Datetime"
"Queued Datetime".
"Scenario"
action
actorCode
additionalInfo.
operation counters by state.
input
operationno (read-only)
output
copy/new parameters.
task id and task execution status.
Actions:
AssistEdit on Copy Input/Output Params and New Input Params.
Execute
Execute.
ExecuteInBackgroundSession (BackgroundSession).
Refresh
Set Error Code (list)
Set Error Code (card).
Set Status Queue
drilldown on Queued/Processing/Processed/Error/To be deleted counters.
no action on page.
3.6 API Gateway
APIs allow you to create and execute operations via OData API endpoints.
Pages involved:
API Gateway .
API Parameters .
Main fields:
action
actorCode
additionalInfo.
input
name
operationno (read-only)
output
value.
Actions:
no action on page.
3.7 Autorun
The queue can create or execute operations through Job Queue and background tasks.
Pages involved:
Job Queue Entry Card
Operation List .
Main fields:
"Action Code"
"Actor Code"
"Enable Loop"
"Execution Type"
"InputParams"
"Loop Wait".
"Scenario"
task id and task execution status.
Actions:
"Get XML Parameters".
ExecuteInBackgroundSession (BackgroundSession).
3.8 Workflow
Workflow events and responses are available for operations.
Pages involved:
Workflow Condition .
Workflow Response Options
Main fields:
"Action Code"
"Actor Code"
"Execute on Creation"
"Input Message Source"
"scenario"
inputparameterfilters
outputparameterfilters.
copy/new parameters.
Actions:
AssistEdit on "Input Parameter Filters" and "Output Parameter Filters".
AssistEdit on Copy Input/Output Params and New Input Params.
3.9 Errors and maintenance
Tools are available to code errors and clean up orphaned parameters.
Pages involved:
Error Codes .
Invalid Parameters .
Operation Card .
Main fields:
"Code"
"Execution Call Stack".
"Execution Error Message"
"Operation Count".
"Regular Expression"
DeleteOrphanParams.
Input/Output sections
Actions:
Download Input
Download Output
Linked Operations.
Set Error Code
Update Error Code.
Upload Input
Running report with DeleteOrphanParams option.
4. Operating procedures
The procedures provide a recommended sequence of steps for the most common tasks. Where indicated, insert screenshots in the appropriate areas of the document.
4.1 Enable the Integrator Admin role for a user
allow full access to protected actors and parameters.
This procedure is performed from the page: User
Before you begin: The user must have a record in User Setup, otherwise the Actors pages return an error.
Fields involved:
"Integrator Admin".
Helpful actions:
action "Actors" (opens the filtered Actors list).
Operational notes: No specific validation in the extended field.
Operational steps:
Open the User Setup page.
Select the user and enable "Integrator Admin".
(Optional) Use the "Actors" action to control the visibility of actors.
Expected result: The user sees all protected actors and sections in the tabs.
Common problems:
"Missing user setup" when the User Setup record is missing.
|
INSERT SCREENSHOT: User Setup [Reserved space] |
4.2 Authorize a user on specific actors
limit actor visibility to non-admin users.
This procedure is performed from the Actor Card page with the "Actor Permissions" part.
Before you begin: The user does not need to be an Integrator Admin; the actor must exist.
Fields involved:
"User ID" (actor permission).
Helpful actions:
no dedicated action
management via permission list.
Operational notes: The "User ID" field validates that the user exists.
Operational steps:
Open an actor's profile.
In the "Actor Permissions" section, add a user in "User ID".
Repeat for each permitted actor.
Expected result: The user sees only the actors in the allowed list.
Common problems:
"Unauthorized" if the user does not have any permissions on actors.
|
INSERT SCREENSHOT: Actor Permissions [Reserved space] |
4.3 Configure the general setup
Set number series and basic app options.
This procedure is performed from the page: Setup ..
Fields involved:
"Actor No. Series"
"Default Operation No. Series"
"Auto Incremental Operation Key"
Chart fields 1..6
"Missing Transformation Error".
Helpful actions:
Error Codes
NuBeTech
Transformation
Check License
AddWorkflow debug actions
AddRetentionPolicy
Check invalid parameter.
Operational notes: The selection of a Chart Name is valid only if it is present in the scenario's graphs; changing the scenario Chart resets the name.
Operational steps:
Open "Setup".
Set the "Actor No. Series" and "Default Operation No. Series".
(Optional) Configure charts by choosing Scenario, Name and Visible for Chart 1..6.
Save changes.
Expected result: The series and options are saved and used on new actors/operations.
Common problems:
"Invalid chart name" if the chart name does not exist in the selected scenario.
|
INSERT SCREENSHOT: Setup [Reserved space] |
4.5 Consult the Dashboard
monitor trading charts and navigate to key areas.
This procedure is performed from the page: Dashboard ..
Before you start: Charts configured in Setup (Chart 1..6)..
Fields involved:
Chart1..Chart6 charts (visible based on "Chart x Visible").
Helpful actions:
Setup
Actors
Entities
Areas
Operations.
Operational notes: no specific validation on the page.
Operational steps:
Open "Dashboard".
Check the visible graphs.
Use actions to open Setups, Actors, or Operations.
Expected result: Charts display data and actions open linked pages.
|
INSERT SCREENSHOT: Dashboard [Reserved space] |
4.6 Create or edit an actor
configure an actor with scenario and numbering series.
This procedure is performed from the Actor List and Actor Card page.
Before you begin: Setup with "Default Operation No. Series" set to "Default Operation No."
Fields involved:
"Code"
"Description"
"Scenario"
"Encoding"
"Operation No. Series".
Helpful actions:
counter drilldown (open filtered Operation List).
Operation Notes: "Operation No. Series" uses the relationship with No. Series; the default series from Setup is applied upon creation.
Operational steps:
Open "Actor List" and create a new actor.
Fill in "Code", "Description", "Scenario" and "Encoding".
Check or change "Operation No. Series".
Save the tab.
Expected result: the actor is created with the series of operations consistent with the Setup.
Common problems:
"Missing user setup" or "Unauthorized" if the user does not have access to the actors.
|
INSERT SCREENSHOT: Actor Card [Reserved space] |
4.7 Setting input/output/protected parameters of an actor
define reusable parameters for operations of the same actor.
This procedure is performed from the page: Actor Card with parts "Input Params", "Output Params", "Protected Params".
Before you begin: Existing actor; "Protected" parameters require Integrator Admin.
Fields involved:
"Name"
"Value"
"Classification" in the parameter lists.
Helpful actions:
lookup on the Name field to choose parameters from the scenario.
Operation notes: If parameters are set via app functions, max name 50 and max value 2048.
Operational steps:
Open the actor tab.
In "Input Params" or "Output Params", add Name/Value.
In "Protected Params" add the reserved parameters (admin only).
Save changes.
Expected result: The parameters become defaults for the actor's operations.
|
INSERT SCREENSHOT: Actor Params [Reserved space] |
4.8 Consult an actor's operation counters
Check how many operations are queued, in progress, processed, or in error.
This procedure is performed from the page: Actor Card ..
Before you begin: Actor with associated operations..
Fields involved:
operation counters by state.
Helpful actions:
drilldown on Queued/Processing/Processed/Error/To be deleted counters.
Operational notes: no specific validation on the page.
Operational steps:
Open the actor tab.
Click on the desired counter to open the filtered operation list.
Expected result: the list of operations filtered by actor and status opens.
|
INSERT SCREENSHOT: Actor Counters [Reserved space] |
4.9 Create a manual operation
insert a new operation for an actor.
This procedure is performed from the page: Operation List and Operation Card.
Before you begin: Existing and configured actor.
Fields involved:
"Actor Code"
"Action Code"
"Scenario"
"Execution Status"
"Queued Datetime".
Helpful actions:
Execute
Refresh
Set Status Queue
Set Error Code (list)
Execute
Refresh
Set Error Code (card).
Operation Notes: "Actor Code" automatically sets the Scenario; the operation number is automatically generated with No. Series or auto-increment.
Operational steps:
Open "Operation List" and create a new row.
Select "Actor Code" and "Action Code".
Save the line to generate the operation number.
Open the tab to complete input/parameters.
Expected result: a new operation is created with assigned number.
|
INSERT SCREENSHOT: Operation List [Reserved space] |
4.10 perform an operation
execute scenario logic and update state.
This procedure is performed from the page: Operation Card or Operation List.
Before you begin: Operation with required parameters set.
Fields involved:
"Execution Status"
"Execution By"
"Processed Datetime"
"Execution Count".
Helpful actions:
Execute.
Operational notes: Execution checks for mandatory parameters required by the action.
Operational steps:
Open the operation.
Click "Execute".
Please wait for the status update.
Expected result: The status changes to Processed (or Error) and the execution fields are updated.
|
INSERT SCREENSHOT: Operation Card [Reserved space] |
4.11 Load/unload input/output and read errors
manage input/output BLOB contents and consult errors.
This procedure is performed from the page: Operation Card ..
Before you begin: Existing operation..
Fields involved:
Input/Output sections
"Execution Error Message"
"Execution Call Stack".
Helpful actions:
Download Input
Download Output
Upload Input
Set Error Code
Linked Operations.
Operational notes: Upload Input uses the encoding defined on the actor.
Operational steps:
Open the operation.
Use "Download Input" or "Download Output" to download blobs.
Use "Upload Input" to reload the input.
Read error messages in the dedicated sections.
Expected result: Input/output is downloaded or updated, errors visible on the page.
|
INSERT SCREENSHOT: Operation Input Output [Reserved space] |
4.12 Send a transaction via API Gateway
create an operation via API and get output.
This procedure is performed from the page: API Gateway ..
Before you start: actor configured and.
Fields involved:
operationno (read-only)
actorCode
action
input
output
additionalInfo.
Helpful actions:
no action on page.
Operational Notes: "Actor Code" must exist to determine scenario.
Operational steps:
Perform a POST to the "gateway" entity set with actorCode, action, input.
(Optional) Add parameters to the "parameters" collection.
Read the response with output and additionalInfo.
Expected result: The operation is created and, if not ASYNC, executed during the call.
|
INSERT SCREENSHOT: API Gateway [Reserved space] |
4.13 Send parameters via API
bind input parameters to an operation via API.
This procedure is performed from the page: API Parameters ..
Before you begin: Operation created via API Gateway.
Fields involved:
name
value.
Helpful actions:
no action on page.
Operation Notes: Upon creation, Table No. and Type are automatically set to Operation/Input.
Operational steps:
In the Gateway POST, add the "parameters" collection.
Fill in the name and value fields for each parameter.
Expected result: The parameters are saved as input to the operation.
|
INSERT SCREENSHOT: API Parameters [Reserved space] |
4.14 Configure a Job Queue Entry for the queue
schedule the creation or execution of operations.
This procedure is performed from the page: Job Queue Entry Card (extended by Pageextension 72913962 Job Queue Entry Card).
Before you begin: Job Queue is active and the "Queue" codeunit is available.
Fields involved:
"Execution Type"
"Actor Code"
"Scenario"
"Action Code"
"InputParams"
"Enable Loop"
"Loop Wait".
Helpful actions:
"Get XML Parameters".
Operational Notes: "Actor Code" sets the Scenario; if Input Params are missing in QUEUE mode, the queue generates an "Invalid setup" error.
Operational steps:
Create a Job Queue Entry with Object Type = Codeunit and Object ID = Queue.
Select "Execution Type" (EXECUTE to execute the queue, QUEUE to create new operations).
In QUEUE mode, set Actor, Scenario, Action and input parameters via AssistEdit.
(Optional) Enable "Enable Loop" and set "Loop Wait".
Expected result: The Job Queue executes or generates operations according to the selected type.
|
INSERT SCREENSHOT: Job Queue Entry Card [Reserved space] |
4.15 Run in background from task list
start the queue running in a background session.
This procedure is performed from the page: Operation List ..
Before you begin: Queued state operations.
Fields involved:
task id and task execution status.
Helpful actions:
ExecuteInBackgroundSession (BackgroundSession).
Operational notes: If there is a running Job Queue, the background task generates an error.
Operational steps:
Open "Operation List".
Use the "Execute" action in the BackgroundSession section.
Please wait for the background session to end.
Expected result: Queued operations are processed.
|
INSERT SCREENSHOT: Operation List Background [Reserved space] |
4.16 Configure workflow conditions on parameters
filter workflow events based on input/output parameters.
This procedure is performed from the page: Workflow Condition ..
Before you begin: Workflow active on "Operation".
Fields involved:
inputparameterfilters
outputparameterfilters.
Helpful actions:
AssistEdit on "Input Parameter Filters" and "Output Parameter Filters".
Operational notes: No specific validation on the request page.
Operational steps:
Open the workflow condition request page.
Use AssistEdit to choose input/output parameters.
Save the condition.
Expected result: The condition evaluates whether the parameters match when the workflow executes.
|
INSERT SCREENSHOT: Workflow Condition [Reserved space] |
4.17 Configure workflow response that creates operations
create a new operation in response to workflow events.
This procedure is performed from the page: Workflow Response Options (
Before you begin: Workflow with response "NuBeTechINT-CREATEOPERATION".
Fields involved:
"Actor Code"
"scenario"
"Action Code"
"Execute on Creation"
"Input Message Source"
copy/new parameters.
Helpful actions:
AssistEdit on Copy Input/Output Params and New Input Params.
Operational Notes: This section is only visible for the "NuBeTechINT-CREATEOPERATION" response.
Operational steps:
Open the workflow response options.
Select Actor, Scenario and Action.
Sets the input message source and the parameters to copy or add.
Save the answer.
Expected result: The response creates a new operation with the given parameters.
|
INSERT SCREENSHOT: Workflow Response Options [Reserved space] |
4.18 Map errors with codes
associate an error code with operations using regex.
This procedure is performed from the page: Error Codes ..
Before you begin: Operations with errors in the log.
Fields involved:
"Code"
"Regular Expression"
"Operation Count".
Helpful actions:
Update Error Code.
Operational notes: no specific validation on the fields.
Operational steps:
Open "Error Codes".
Enter the codes and regexes.
Use the "Update Error Code" action on selected operations.
Expected result: The operations update the "Execution Error Code" field according to the regexes.
|
INSERT SCREENSHOT: Error Codes [Reserved space] |
4.19 clean up orphaned parameters
locate or delete parameters without parent records.
This procedure is performed from the page: Invalid Parameters ..
Before you begin: Access administrative reports.
Fields involved:
DeleteOrphanParams.
Helpful actions:
Running report with DeleteOrphanParams option.
Operational notes: no specific validation.
Operational steps:
Run the "Invalid Parameters" report.
Enable "DeleteOrphanParams" if you want to delete orphaned parameters.
Run the report.
Expected result: Orphaned parameters are reported or deleted.
|
INSERT SCREENSHOT: Invalid Parameters Report [Reserved space] |