Service Types (Magic xpi 4.13)
The Service dialog box lets you view the available service types and modify the user-defined service types. It also allows you to add a new service type with all its properties.
When you click the New button, the New Service Entry dialog box appears. Here you can define a new servcie that can be accessed from the Settings dialog box's Services section. Once you have entered a name and a description for your new service type, you should enter its arguments as follows:
|
|
|
|
Service Details
|
|
Name
|
A unique service name. This field is mandatory.
|
|
Description
|
A description of the new service.
|
|
Properties
|
|
Name
|
The argument name.
|
|
Type
|
The argument type. Select one of the following from the drop-down list:
-
Resource
-
Alpha
-
Numeric
-
Date
-
Time
-
Logical
|
|
When the Local agent compatibility toogle button in the Resource tab of the Connector Builder is checked at the time of resource configuration, the first argument should always be added of type Resource. This parameter will contain the reference to the resource that was defined on the Resource tab.
If the type of the first argument is not set to Resource, an error will be thrown on clicking the OK button and the configuration will not be saved.
|
|
|
Length
|
The maximum character length for the type selected above. This field is mandatory.
|
|
Tooltip Description
|
Click  to open the Tooltip Description dialog box. Enter a tooltip to describe the new argument.
|
|
Value Selection Type
|
Select whether you want to set an Expression (default) or a Combo. If you select Combo, click to open the Combo Box Values dialog box. Enter the relevant combo box details.
|
|
Default Value
|
This assigns a default value to the argument. For example, if you define a service whose first argument is Host Name, the default value can be Localhost. The default value selected must match the field type. If the Password check box is selected, this column is disabled.
|
|
Password
|
Define whether you want passwords to be visible or to be encrypted and marked with asterisks (*).
If you select this check box, the value is also encrypted in the service settings XML file.
|
|
Env Variables
|
Define whether you want the new service to support environment variables.
|
|
Mandatory
|
Define whether you want the new service property to be a mandatory property.
|
|
Read-only
|
Define whether you want the new service property to be read-only.
|
|
Visibility
|
Define whether you want the new service property to have visibility dependencies.
Select one of the following from the drop-down list:
-
Yes (default)
-
No
-
Condition
If you select Condition, click to open the Visibility dialog box.
|
|
Depends On
|
Define whether you want the new service property to depend on the existing properties. Select the properties from the drop-down list.
|
|
Depends On Values
|
Define whether you want the new service property to depend on values of the existing properties. Select one of the following from the drop-down list:
|
|
Buttons: Click the  button to add up to three new action buttons. Click the  button to delete existing action buttons.
|
|
Validation Button
|
Click this toogle button, if you want to add a Validation button to the new service. If you select this, you can then click the button to add and define the Validation button.
|
