1.3 Interpreting the plug-in reference
This section describes how to interpret the plug-in reference provided in chapters 4 and 5.
Function
Describes the functionality provided by the plug-in.
Usage scenario
Describes an example of a scenario in which the plug-in is used.
Prerequisites
Describes the prerequisites, if any, for executing a service that includes the plug-in.
Cautionary notes
Describes cautionary notes the operator needs to be aware of when executing a service that includes the plug-in.
Permissions
Shows the permissions required to execute a service that includes the plug-in.
Version
Shows the version of the plug-in.
Category
Shows the category of the plug-in.
Plug-in name displayed in the task log
Shows the plug-in name displayed in the task log.
Return code
Shows the return code of the plug-in.
Property list
Shows the properties of the plug-in. The following information is provided:
Item |
Description |
---|---|
Property key |
The property key displayed in the Edit Plug-in dialog box. |
Property name |
The property name displayed in the Edit Plug-in dialog box. |
Description |
The description of the property. |
Default value |
The default value of the property.
|
I/O type |
The input/output type of the property, as one of the following:
|
Required |
Whether the property is required or optional.
|
Related topics