Method Configuration - SDK (Magic xpi 3.x)
The Method Configuration dialog box is used to define or change methods and method parameters for a component.
The dialog box includes the fields described below.
|
|
|
|
Methods
|
|
Name
|
The name of the method used by the server at runtime. This is a public name for uniPaaS components and a method name for Java components. Names with special characters, such as a period (.), question mark (?), or slash (/) cannot be loaded.
|
|
Display Name
|
The general name of the method. The name should start with an Alpha value.
|
|
Description
|
A brief description of the method.
|
|
Method Arguments
|
|
Display Name
|
The name of argument sent to the component by an external call to Magic xpi. The name should start with an Alpha value.
|
|
Type
|
The data type of the argument. You can select: Alpha, Numeric, Logical, Date, Time or BLOB.
|
|
Picture
|
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 output parameter or both.
|
|
Argument Properties
|
|
Display Name
|
The name of the argument.
|
|
Tooltip
|
The tooltip that will appear when the cursor hovers over the argument.
|
|
Value Type
|
Decides how the parameter value is entered by the user.
If you select Combo, you can then click the  button to open the Combo Box Values dialog box.
|
|
Visibility
|
Determines whether the argument is displayed in the Direct Access Method Configuration dialog box. Select one of the following from the drop-down list:
-
Yes (default)
-
No – The argument will not be displayed in the Direct Access Method Configuration dialog box. However, a record of this parameter will be created internally in the Direct Access Method table, and in Runtime it will have a value as specified in the Fixed Value property.
-
Condition – You can select Condition only if the Value Type is Combo linked to another combo box. The condition defines whether the field will be visible, depending on the value of the linked combo. Click the button to open the Selection Type dialog box.
In the Selection Type dialog box, you should then click the button to open the Parameter List dialog box. Select the required parameter for the condition.
|
|
Mandatory
|
Indicates whether the argument must have a value (or default value) when sent to the trigger.
You cannot define a field as mandatory if it is invisible and does not have a default value.
|
|
Default Value
|
You can specify a value or an expression (depending on the Type property) that will be set automatically by Magic xpi if the received argument does not have a value.
If the Default Value is not blank, then in the Direct Access Method Configuration dialog box, the argument will be updated with the Default Value and will be read-only.
|
This dialog box contains the following buttons:
|
|
|
|
Load
|
Opens the Load Program Definitions – SDK dialog box. This button is disabled in Trigger mode.
|
|
In the Methods section of the dialog box.
|
|
New
|
This button is only available in uniPaaS class type components. The defined method will be generated when generating the component skeleton.
|
|
Delete
|
Deletes the selected method.
|
|
Delete All
|
Deletes all methods.
|
|
In the Method Arguments section of the dialog box.
|
|
New
|
Adds a new argument to the method.
|
|
Delete
|
Deletes the selected argument.
|
|
Delete All
|
Deletes all arguments.
|
