uniPaaS-Based Components (Magic xpi 3.x)
Magic xpi is fully compatible with flow components developed in uniPaaS. Magic xpi provides the out-of-the-box uniPaaS service, which allows a developer to easily enter the uniPaaS Studio to edit and create user-defined components.
User-defined components must provide a specific component interface, which is used by the Flow Editor and the Magic xpi Server. The standard interface is supported in uniPaaS with the following programs:
|
Main Program
|
The component’s main program. The main program has some global variables. These are used by the component, and should not be modified. All new user-defined global variables should be created subsequently in the list.
|
|
SetResource
|
Sets the new component model’s resource type (if defined). This program is called before the step begins. It sends all resource arguments to the main program. You need to write the code to check the resource.
|
|
MethodName
|
A program created for every method defined. In addition to the user-defined arguments, the ErrorCode and ErrorDescription variables are created. You must update these variables to enable an error to be raised during processing.
|
|
VersionOK
|
The global function allows you to define logic for checking the component version.
|
Trigger components include the following programs:
|
Main Program
|
The component’s main program. The main program has some global variables. These are used by the component, and should not be modified. All new user-defined global variables should be created after these.
|
|
SetService
|
Sets the new component model service type (if defined). This program is called before the trigger starts and sends all service arguments to the main program. You need to write the code to check the service.
|
|
Start Trigger
|
Called when the Server starts and calls the Trigger Logic program.
|
|
Trigger Logic
|
User-defined trigger code.
|
|
Enable
|
Called when flow is switched to enable mode. This method must continue the flow in the Trigger Logic program.
|
|
Disable
|
Called when the flow is switched to Disable mode.
|
|
VersionOK
|
The global function allows you to define logic for checking the component version.
|
You can use an existing uniPaaS application as a flow component to quickly enter an application into the Magic xpi framework.
For more information on user-defined components, click here.
