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:

Table 1‒7: Items described in the property list (plug-in)
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. --: No value is assigned.
I/O type	The input/output type of the property, as one of the following: Input: Indicates an input property. Output: Indicates an output property
Required	Whether the property is required or optional. R (Required): The property must be specified O (Optional): The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.

Related topics

To Page Top