1.2 Interpreting the service template reference

This section describes how to interpret the service template reference provided in chapters 2 and 3.

Function

Describes the functionality provided by the service template.

Prerequisites

Describes the prerequisites, if any, for executing the service.

Cautionary notes

Describes cautionary notes the operator needs to be aware of when executing the service.

Permissions

Shows the permissions required to execute the service.

Version

Shows the version of the service template.

Category

Shows the category of the service template.

Property list

Shows the properties of the service template. The following information is provided:

• Property group

  The group in which the property is classified. This information is only provided if a property group is assigned to the service template.

  Table 1‒3: Items described in the property list (property group)

  Item	Description
  Property group	The name of the property group.
  Description	The description of the property group.
  Initial display	Shows whether properties that belong to the property group are listed as the initial display.

• Property overview

  This table shows the information displayed for the property in the JP1/AO user interface, the property type, and other information.

  Table 1‒4: Items described in property list (property overview) (for service templates)

  Item	Description
  Property key	The property key displayed in the Service Definition dialog box and the Submit Service dialog box.
  Property name	The property name displayed in the Service Definition dialog box and the Submit Service dialog box.
  Description	The description displayed in the Service Definition dialog box and the Submit Service dialog box.
  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. Variable: Indicates a variable.
  Shared	The scope of the property. Enabled: The Service Share Property check box is selected for the property in the Scope area in the Create Input Property for Service or Edit Input Property for Service dialog box. Disabled: The Service Share Property check box is cleared for the 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.
  Property group	The property group into which each property is classified.

• Values that can be specified in the property

  For input properties, this section shows the characters that can be specified in the property, or the values that can be selected from the list.

  Table 1‒5: Items described in the property list (values that can be specified in the property) (for service templates)

  Item	Description
  Property key	The property key displayed in the Service Definition dialog box and the Submit Service dialog box.
  Characters that can be input	The characters that can be input into the property, or the values that can be selected from the list.

Flow specification details

This section shows the detailed specification of the flow of the service template.

The following details are described:

Table 1‒6: Items described in Flow specification details

Item		Description
Hierarchy		The position of the step in the hierarchy of the flow.
Display Name#		The name displayed for the step in the Task Details dialog box.
Plug-in	Plug-in name	The plug-in name used in the service template.
	Version	The version of the plug-in.
	Description	The description of the plug-in.
	Error recovery method	A description of how to recover from errors that occur in the plug-in.

#:

Because repeated flows are not displayed in the Editor window, Processing is displayed instead of Display Name for repeated flows.

Related topics

• 2. JP1/AO Standard-package Service Templates

• 3. JP1/AO Content Set Service Templates

• 1.4 Notes common to service templates

• Properties defined in services (service properties) in the Job Management Partner 1/Automatic Operation Service Template Developer's Guide

To Page Top