|
|
|
|
General Details
|
|
Name
|
A mandatory unique name in the project for the component. The name entered is displayed in the Toolbox pane for this project. Names with special characters, such as a period (.), question mark (?), or slash (/) cannot be loaded.
|
|
Description
|
The component description text.
|
|
Connector version
|
The version number for the connector with a maximum length of 30. The default is 1.0.
|
|
Icon file name
|
Browse to select an icon for the component or enter its name with the correct extension (for example, icon.bmp).
|
|
Icon preview
|
A preview of the selected icon.
|
|
Toolbox group
|
Select the category you want the new component to be saved under in the Toolbox pane:
-
Utilities
-
Converters
-
File Management
-
Connectors (default)
-
Communication
-
Mail
-
Messaging
-
Triggers
-
User Components
If the connector is also defined as a trigger, it will be added to the Toolbox pane's Triggers group as well.
|
|
Step default interface
|
Determines the default interface of the step. Select one of the following from the drop-down list:
-
Data Mapper (default)
-
Methods
|
|
Encryption key
|
Define your own encryption key of between 8 to 56 characters. This key will be used to encrypt and decrypt the resource and service passwords and the license serial number.
|
|
License feature
|
Define a license feature of up to 10 characters (letters only) to use in the license of the generated component.
Click the Generate License Key button to open the License Key utility. This tool helps you create a unique value in the VENDOR_STRING that Magic xpi can check at runtime and inform you whether the license is valid.
|
|
Step tab: Select the Include step check box if you want to define the connector as a step.
|
|
UI Type
|
Determines the user interface type. Select one of the following from the drop-down list:
|
|
UI implementing class
|
The .NET class name. This is required if the UI type property (above) is set to Dynamic.
Click the Generate UI Project button to open a utility that creates a preconfigured project template. This project is the starting point for the development of the UI part of your connector.
|
|
Resource
|
When selected, this indicates that this connector will use a resource. This check box is only enabled when the UI type property (above) is set to Dynamic. When this check box is not selected, the resource configuration is not deleted since the check box only indicates that no resource is available for this connector in the Studio.
Click the Configure Resource button to open the New Resource Type dialog box.
|
|
Configuration dialog requires a resource
|
If you select this check box, you cannot enter the component's configuration details when there is no resource configured. This is unchecked by default. This check box is disabled and unchecked when the UI type property (above) is set to Static.
|
|
Runtime technology
|
Select one of the following technologies from the drop-down list:
This is disabled when the UI type property (above) is set to Static.
|
|
Runtime implementing class
|
The name of the Java, .NET class or Magic xpa .ecf file. This is disabled when the UI type property (above) is set to Static.
Click the Generate Runtime Project button to open a utility that creates a preconfigured project template. This project is the starting point for the development of the runtime part of your connector.
|
|
Runtime requires a resource
|
Determines whether a resource is mandatory when using the component during runtime. This check box is selected by default, and is disabled and unchecked when the UI type property (above) is set to Static.
|
|
Methods (DAM) interface
|
When the UI type property (above) is set to Dynamic, the default is unchecked. When the UI type property is set to Static, the default is checked and read-only.
Click the Configure Methods button to open the Load Methods dialog box. If you have already defined and loaded methods, the Method Configuration dialog box will open.
|
|
Mirror methods to static XML interface
(Only available for static UI)
|
This parameter is only available if the UI type property (above) is set to Static and the Methods (DAM) interface property (above) is checked.
When selected, the connector will have an XML interface for the methods.
|
|
Trigger tab: Select the Include Trigger check box if you want to define the connector as a trigger.
|
|
UI Type
|
Determines the user interface type. Select one of the following from the drop-down list:
|
|
UI implementing class
|
The .NET class name. This is required if the UI type property (above) is set to Dynamic, but is disabled if the UI type property is set to Static.
Click the Generate UI Project button to open a utility that creates a preconfigured project template. This project is the starting point for the development of the UI part of your connector.
|
|
Service
|
When selected, this indicates that this connector will use a service. This check box is only enabled when the UI type property (above) is set to Dynamic. When this check box is not selected, the service configuration is not deleted since the check box only indicates that no service is available for this connector in the Studio.
Click the Configure Service button to open the New Service Type dialog box.
|
|
Service implementing class
|
The .NET class name that implements the service interface for the Validate button and any other action buttons that you create.
This is only available if the Service check box is selected and the UI Type parameter (above) is Static.
|
|
Configuration dialog requires a service
|
If you select this check box, you cannot enter the component's configuration details when there is no service configured. This is unchecked by default. This check box is disabled and unchecked when the UI type property (above) is set to Static.
|
|
Trigger invocation type
|
Determines the trigger invocation type for the component. Select one of the following from the drop-down list:
|
|
If you select Endpoint when the UI type property (above) is set to Static, the generated trigger UI in the Magic xpi Studio will contain a mandatory Endpoint field.
The Endpoint trigger represents a trigger that is not running under the Magic xpi engines. The Endpoint trigger is unique across all the projects (it is unique in a single space). An example of such a trigger is an HTTP trigger running under the IIS/Apache
The Endpoint name for the SDK trigger in the studio is case-sensitive. Defining two triggers with the same name but different case types in different flows will be considered as two separate endpoints.
The Standalone Invoker.zip file located in the <Magic xpi installation>/Runtime/Support folder, holds all the files required for invoking Magic xpi from an external application.
Since version: 4.6
|
|
|
Flow Invocation Behavior
|
Determines the component's flow invocation behavior. Select one of the following from the drop-down list:
-
Sync-Wait: The flow invocation is synchronous. If the flow is within its defined Max Instances value, the message will wait.
-
Sync-No Wait (default): The flow invocation is synchronous. However, if the flow is within its defined Max Instances value, the message will not wait and an error will be returned immediately.
-
Async: The flow invocation is asynchronous. The invoke method will return once the message is in the Space and will not wait for the flow to return a result.
|
|
Asynchronous invocation is suitable for triggers with no return value, such as messaging triggers with callback methods.
Synchronous invocation is suitable for triggers with a return value, such as TCP triggers.
|
|
|
Runtime technology
|
Select one of the following from the drop-down list:
This parameter is disabled when:
|
|
Runtime implementing class
|
The name of the Java class, .NET class, or Magic xpa .ecf file. This is disabled when the UI type property (above) is set to Static.
Click the Generate Runtime Project button to open a utility that creates a preconfigured project template. This project is the starting point for the development of the runtime part of your connector.
This parameter is disabled when the UI type property is set to Dynamic and the Trigger invocation type is set to Endpoint. (Since version: 4.6)
|
|
Runtime requires a service
|
Determines whether a service is mandatory when using the component during runtime. This check box is selected by default, and is disabled and unchecked when the UI type property (above) is set to Static.
|
|
Argument Configuration: This section is enabled only when the UI type property (above) is set to Static. You add and delete arguments using the New, Delete, and Delete All buttons.
|
|
Name
|
The name of argument sent to the component by an external call to Magic xpi. A valid name cannot start with special characters.
|
|
Type
|
The data type of the argument. Select one of the following from the drop-down list:
-
Alpha
-
Numeric
-
Logical
-
Date
-
Time
-
BLOB
|
|
Length
|
A string of characters that tells Magic xpi how to define the format of the argument.
For example, a 15-character alphanumeric parameter has a picture definition of 15. A picture that defines a date is DD/MM/YYYY.
|
|
Direction
|
Determines whether the argument's direction is an input or an output parameter. Select one of the following from the drop-down list:
|
|
-
A trigger can have several In parameters but only one Out parameter.
-
Polling trigger can have only In parameter.
-
External trigger can have In as well as Out parameter.
|
|
|
Tooltip
|
The tooltip that will appear when the cursor hovers over the argument.
Click the  button and enter the required tooltip in the Tooltip Description box.
|
|
Value Type
|
The way the argument's value type will be displayed. Select one of the following from the drop-down list:
-
Expression
-
Variable
-
Combo
If you select Combo, click the button to access the Combo Box Values dialog box.
|
