The dialog box includes the fields described below.
|
|
|
|
Name
|
The name of the method used by the server at runtime. This is a public name for Magic xpa components and a method name for Java components. Names with special characters,such as a period (.), question mark (?), or slash (/) cannot be loaded.
|
|
Public Name
|
The general name of the method. The name should start with an Alpha value.
|
|
Description
|
A brief description of the method.
|
|
|
|
|
Advanced SDK
|
When this option (toggle button) is enabled, the PseudoRef configuration will be implicitly handled by Magic xpi. In the Connector Builder, the PseudoRef arguments will not be displayed in the Method Arguments given below and in the Studio, you will not need to map those in the DAM Methods dialog for this connector.
(Since version: 4.13.4)
|
|
Load Method
|
Opens the Load Methods dialog box.
|
|
Method Arguments
|
|
Name
|
The name of the argument . This is the variable name which will be internally used to assign and pass the field values from the project created in Studio to runtime execution. This field is not editable.
|
|
There is a special type of name called PseudoRef. A PseudoRef in xpi refers to a variable that will contain the reference to the Java Object that you would instantiate using the constructor from the class.
At runtime, the variable will be initialized with the instance/object of the class by executing the constructor. This will be thereon used as an input variable when calling the instance methods of the class.
|
|
|
Display Name
|
The name of the argument which will be displayed in the DAM Configuration section when the step is added in the Studio. This is an editable field. The changes done to this field will be reflected in the corresponding property name in the Studio step configuration.
|
|
Tooltip
|
The tooltip that will appear when the cursor hovers over the argument.
|
|
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.
|
|
Runtime Order
|
Indicates the actual order of the arguments during runtime.
|
|
Value Type
|
Determines how the parameter value is entered by the user. Select one of the following from the drop-down list:
-
Expression (default)
-
Variable
-
Fixed 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 this value is not blank, the argument in the Direct Access Method Configuration dialog box will be updated with the default value and will be read-only.
|
|
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. Select the check box to define a field as mandatory.
|
|
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:
|
|
Depends On
|
Define whether you want the new method to depend on the existing methods.
|
|
Depends On Values
|
Define whether you want the new method to depend on values of the existing properties.
|
