Field

Description

General Details

Name

A mandatory unique name in the project for the component. The name entered is displayed in the Component Repository for this project. Names with special characters, such as a period (.), question mark (?), or slash (/) cannot be loaded.

Description

The component description text.

Icon File Name

Browse to select an icon for the component or enter its name with the correct extension (for example, icon.bmp).

Class Type

Select one of the following from the drop-down list, depending on how the component was developed:

• uniPaaS Component

• Java Framework Component

Execution Mode

Defines whether the component is in Trigger mode or Step mode.

Resource Type

The name of the resource type that will be attached to the new component.

Select a resource from the drop-down list.

You can also click the New hyperlink to add a new resource in the New Resource Type dialog box.

Advanced Details

<class type> Module Name

A mandatory unique name in the project for the module.

The name of this field depends on the selected class type. For example, if you select Java from the Class Type field, this field will be called Java Class Name.

This field is read-only.

Field

Description

General Details

Name

A mandatory unique name in the project for the component. The name entered is displayed in the Component Repository for this project.

Description

The component description text.

Icon File Name

Browse to select an icon for the component or enter its name with the correct extension, such as icon.bmp.

Class Type

Select one of the following from the drop-down list, depending on how the component was developed:

• uniPaaS

• Java

Execution Mode

Defines whether the component is in Trigger mode or Step mode.

The trigger exposes a uniPaaS program with an external name (the component name), so that other uniPaaS applications can call it (through remote calling, the mgrqcmdl command, or by using the Java requester). The trigger works "as is" without needing to make modifications to the uniPaaS code inside. It invokes the Magic xpi flow synchronously, passes the arguments to the variables defined in the trigger, and sends back the value in the return parameter.

Trigger Type

If you selected Trigger as the Execution Mode, this field will appear. Select one of the following:

• External – This option lets you set a non-polling trigger. External triggers can call these triggers from the outside world. These triggers are sync triggers, meaning that for each request it will wait until it completes the flow execution and then return the result to the caller.

• Polling – The trigger will continuously poll other programs or devices to see what their status is.

Since version: V3.1 SP1

Service Type

Select a service from the drop-down list.

You can also click the New hyperlink to add a new service in the New Service Type dialog box.

The Service Type is not available for External triggers.

Argument Configuration – Fox External (non-polling) triggers, these arguments receive the data from the external world. For polling triggers, the data is the data entered in the Component Configuration dialog box.

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. You can select: Alpha, Numeric, Logical, Date, Time or 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

The direction of the argument. Use the drop-down list to select whether the argument is an input or an output parameter.

The trigger can have several In parameters and one Return parameter.

Tooltip

The tooltip that will appear when the cursor hovers over the argument.

You can click the button and enter the tooltip in the Tooltip Description box.

Value Type

Select whether the value of the type will be displayed as an Expression, Variable, or Combo.

If you select Combo, you can then click the button to access the Combo Box Values dialog box.

Button

Description

New

Adds an argument to your new component. This button is only available for Trigger mode.

Delete

Deletes the selected argument from your new component. This button is only available for Trigger mode.

Delete All

Deletes all arguments from your new component. This button is only available for Trigger mode.

Errors

Opens the Error Details dialog box. The user can define a set of errors for the new component. The user can give any error code for the component. The new errors will be added to the Global Error repository and to the Component XML file.

Methods

Opens the Method Configuration dialog box for uniPaaS class types and the Load Program Definitions dialog box for Java class types.

Edit Source

This is available when you select uniPaaS Component in the Class Type field.

• For uniPaaS components, it opens the uniPaaS development environment and allows for the defining or changing of the component source code.
  Note: Before clicking this button to edit the source, make sure to place the component in the original structure under the following path: <Magic xpi Installation Folder>\User resources\Components. The edp, ecf, and idd files need to be in the component's main folder and the xsd file needs to be in the xsd folder.

Generate

Generates the component. The component must have at least one method defined before you can generate it. As of V3.1, to generate the methods, you must click the Generate button. When you click OK, Magic xpi only saves the new definitions.

Resource Types

Opens the Resource Types dialog box. This is available only when you select Step in the Execution Mode field (above).

Service Types

Opens the Service Details dialog box. This is available only when you select Trigger in the Execution Mode field and Polling in the Trigger Type field.

Since version:

V3