1. Field Service Guide
  2. Parameters for the Preventive Maintenance Engine

Parameters for the Preventive Maintenance Engine

The Workflow Manager or the client can call all engines. These engines require certain passed parameters. Changing the values of these parameters changes the default behavior of the engine. To implement changes to parameters, restart the Field Service server. The following table describes the parameters for the Preventive Maintenance Engine.

Parameter Values Description

Mode

SQL, Id, TempTbl

Specifies how the engine locates the entities to process. In a user request, specify only SQL or ID. Client applications use TempTbl for submitting requests. This parameter is required.

Note: Do not run component jobs in TempTbl mode to call the Preventive Maintenance Engine. This mode is reserved for interactive engine jobs sent directly from a client application.

Sub-mode

Assets, Plans, Assets&Plans, Agreements

Identifies the specified entities. A Sub-mode of Assets implies all PM plans, and a Sub-mode of Plans implies all assets. This parameter is required.

End Date

Date in YYYY-MM-DD format

Specifies the last date that the engine generates PM actions. Currently, only time-based triggers can occur for a future date. This parameter is required.

Asset ID

Row ID of an asset

Specifies an asset. This parameter is required when the Mode is ID and the Sub-mode is Assets or Assets&Plans.

Plan ID

Row ID of a PM plan

Specifies a PM plan. This parameter is required when the Mode is ID and the Sub-mode is Plans or Assets&Plans.

Agreement ID

Row ID of an agreement

Specifies an agreement. This parameter is required when the Mode is ID and the Sub-mode is Agreements.

DefOrgID

Row ID of an organization

Specifies an organization. This parameter applies to a generated service request when the asset for the service request does not have a specified account. If the asset has a specified owner account, then the BU_ID for the account is used.

DefActOwnerID

Row ID of an employee

Specifies an employee. This parameter applies when you create activities from a template that does not define the activity owner (employee).

Asset SQL

Where clause for the GET_SQL_ASSETS template. The where clause uses the following form:

[BusComp Field Name] = ‘Value’

Specifies a search specification for assets. This parameter is required when the Mode is SQL and the Sub-mode is Assets or Assets&Plans.

The SQL template for retrieving assets follows:

GET_SQL_ASSETS =
  SELECT asset.ROW_ID
  FROM &Table_Owner.S_ASSET asset
  WHERE $SEARCH_SPEC$

The value for the Asset SQL parameter is substituted for '$SEARCH_SPEC$.' Any specification that completes this template with valid values is allowed for the parameter.

Plan SQL

Where clause for the GET_SQL_PM_PLANS template. The where clause uses the following form:

[BusComp Field Name] = ‘Value’

Specifies a search specification for PM plans. This parameter is required when the Mode is SQL and the Sub-mode is Plans or Assets&Plans.

The SQL template for retrieving PM plans follows:

GET_SQL_PM_PLANS =
  SELECT pln.ROW_ID
  FROM&Table_Owner.S_PM_PLNITM pln
  WHERE pln.ACTIVE_FLG = 'Y'
    AND $SEARCH_SPEC$

The value for the Plan SQL parameter is substituted for '$SEARCH_SPEC$.' Any specification that completes this template with valid values is allowed for the parameter.

Agreement SQL

Where clause for the GET_SQL_AGREEMENT_IDS template. The where clause uses the following form:

[BusComp Field Name] = ‘Value’

Specifies a search specification for agreements. This parameter is required when the Mode is SQL and the Sub-mode is Agreements.

The SQL template for retrieving PM agreements follows:

GET_SQL_AGREEMENT_IDS =
  SELECT agrmnt.ROW_ID
  FROM &Table_Owner.S_DOC_AGREE agrmt
  WHERE agrmnt.VALID_FLG = 'Y'
    AND $SEARCH_SPEC$

The value for the Agreement SQL parameter is substituted for '$SEARCH_SPEC$.' Any specification that completes this template with valid values is allowed for the parameter.