Family Field Descriptions

This topic provides a listing of all the families in the ASI module with links to the family fields information.

Note: Some of the data used to populate various drop-down list boxes comes from SAP via a static data interface used in SAP Adapters. For more information, refer to SAP ASI Static Data Mappings.

SAP-Specific Work Item Records

About These Descriptions

Throughout most of the APM documentation, family field descriptions are provided in a table format, where the table describes the purpose and behavior of all fields that are defined for a specific family.

In ASI, however, most of the fields that are defined for families representing SAP items (e.g., Maintenance Plan) correspond directly to an SAP field. We assume that you are familiar with your SAP data structure and fields, so we do not provide descriptions of the values that these fields are meant to store. In other words, because they store the same values that their corresponding SAP counterpart fields store, we assume that you understand what to enter or select in the fields in APM.

We do, however, provide information about the behavior of some fields on the datasheet if that behavior cannot be inferred based upon prior knowledge of SAP functionality. For example, if a field is required in APM to save a record, we note the requirement. Likewise, if a field is populated automatically in APM as a result of selecting a value in another field, this is also noted.

Note: For all families, all fields are disabled after the Implementation Package is implemented.

Cycle

Counter ID: This field contains the ID for the counter that is being applied to the Maintenance Plan. If there is no Counter ID, the Cycle will be time-based.
Cycle: The numeric component of the Counter interval applied to the Maintenance Plan.
Cycle Description: A description of the Cycle being applied to the Maintenance Plan.
Cycle Set Sequence: This field contains a number which corresponds to the Cycle Set Sequence value that you assigned to the Maintenance Plan.
Cycle UOM: The unit component of the Counter interval applied to the Maintenance Plan.
Offset: This field contains a numeric value corresponding to an interval at which some maintenance may have been carried out in the middle of a scheduled Cycle.
Plan Key: The ID for the associated Maintenance Plan.
Start Counter: This field contains a numeric value corresponding to an interval at which the maintenance plan will begin. This field is only applicable to single-cycle plans.

Maintenance Item

Cycle Set Sequence: This field contains a number which corresponds to the Cycle Set Sequence value that you assigned to a Maintenance Item.
Equipment: The Equipment field is disabled if the Maintenance Item record is linked to a Task List record and the associated Task List has been implemented in SAP, or if the Task List record contains a value in the Equipment field.
If a Maintenance Item record contains a value in either the Functional Location or Equipment field, after you create a Task List record that is linked to that Maintenance Item record, you can use the Synchronize button in that Maintenance Item record to copy that value to the Task List record.
Functional Location: The Functional Location field is disabled if the Maintenance Item record is linked to a Task List record and the associated Task List has been implemented in SAP or if the Task List record contains a value in the Functional Location field.

If a Maintenance Item record contains a value in either the Functional Location or Equipment field, then after you create a Task List record that is linked to that Maintenance Item record, you can use the Synchronize button in that Maintenance Item record to copy that value to the Task List record.
Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.
Item Description: This field is required.
Maintenance Item: After the Implementation Package is implemented, this field is populated automatically with a link that you can select to open the ITS System Information screen in Internet Explorer, where you can log in to the SAP system to view the Maintenance Item.

Maintenance Package

Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.

Maintenance Plan

Description: This field is required.
Factory Calendar: This field is disabled if the value in the Scheduling Indicator field is empty. If the Scheduling Indicator field is cleared after a value already exists in the Factory Calendar field, the Factory Calendar field will be cleared automatically.
Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.
ID: After the Implementation Package is implemented, this field is populated automatically with a link that you can select to open the ITS System Information screen in Internet Explorer, where you can log in to the SAP system to view the Maintenance Plan.
Interval: This field is required.
Interval Unit: This field is required.
Maintenance Strategy: If you modify the value stored in the Maintenance Strategy field in a predecessor Maintenance Plan record, that value will be copied automatically to the Maintenance Strategy field in the successor records, with one exception: if you modify the value stored in the Maintenance Strategy field in a Maintenance Plan record that is linked to predecessor Maintenance Package records, the Maintenance Package records will be deleted automatically.
Multiple Counter: If this box is checked when creating a Maintenance Plan, it will enable multiple cycles to be applied. Otherwise, only a single-cycle plan can be created. This check box is unselected by default. If the check box is selected, then the Scheduling Indicator field will automatically be populated as Multiple Counter (4) and disabled.
Scheduling Indicator: Within a maintenance strategy, you can use different scheduling indicators to specify the type of scheduling you require:
- Time - Key Date (1)
- Time - Factor Calendar (2)
- Performance Based (3)
- Multiple Counter (4).
Note: The Multiple Counter (4) value will only be populated if the Multiple Counter check box is selected.

Material

Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.

Notification

Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.
Notification Number: After the Implementation Package is implemented, this field is populated automatically with a link that you can select to open the ITS System Information screen in Internet Explorer, where you can log in to the SAP system to view the Notification.
Notification Type: This field is required.
Short Text: This field is required.

Object List Item

Equipment Description: This field is populated automatically after the Equipment Number field is populated.
Equipment Number: If the Functional Location ID field is empty, this field is required.
Functional Location ID: If the Equipment Number field is empty, this field is required.
Functional Location Label: This field is populated automatically after the Functional Location ID field is populated.
Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.

Operation

Calc: Depending upon what you select in the Calc list, other fields will be enabled or disabled. This behaviors are described in the following list:
- If you select Calculate Duration, the Normal Duration and Normal Duration Unit fields will be disabled.
- If you select Calculate Work, the Work and Work Unit fields will be disabled.
- If you select Calculate Number of Capacities, the Number of Resources field will be disabled.
- If you select Calculate Manually or leave this field blank, all the fields are enabled.
Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.
Plant: This field is populated automatically after the Work Center field is populated.
StdTxt: The value in this field is automatically populated via SAP records. Next to the StdTxt field, when you select , a drop-down list box appears. The value that you select in this drop-down list box then populates the Long Text field of the Operation record with the SAP-specific description.

Task List

Description: This field is required.
Equipment: If the Equipment field contains a value, an Equipment Task List will be created in SAP. If the Functional Location field contains a value, a Functional Location Task List will be created in SAP. If neither field contains a value, a General Task List will be created in SAP.
Equipment Description: This field is populated automatically after the Equipment field is populated.
Functional Location: If the Equipment field contains a value, an Equipment Task List will be created in SAP. If the Functional Location field contains a value, a Functional Location Task List will be created in SAP. If neither field contains a value, a General Task List will be created in SAP.
Functional Location Label: This field is populated automatically after the Functional Location field is populated.
Group: After the Implementation Package is implemented, this field is populated automatically with a link, which displays the ITS System Information window in Internet Explorer, where you can log in to the SAP System to view the SAP Task List.
Implementation Status: This field can contain any of the following values:
- Added: The record is new and has not yet been sent to SAP. In this case, when the Implementation Package is implemented, the corresponding SAP item will be created.
- Modified: One or more values in the record have changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be updated accordingly.
- Deleted: The record has been flagged for deletion since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will be deleted.
- Unchanged: The record has not changed since it was last sent to SAP. In this case, when the Implementation Package is reimplemented, the corresponding SAP item will not be modified.
The Implementation Status field is not available on any baseline datasheets. Instead, the value is used to determine the image that is displayed next to the node name in the tree on the Packaging page.
Key Date: By default, the value in this field is set to the current date and time.
Maintenance Strategy: This field is disabled if the associated Task List has been implemented in SAP.
Status: By default, the value in this field is set to 4.

Work Management Item Definition Configuration Records

The following table provides an alphabetical list and descriptions of the fields that exist for the Work Management Item Definition Configuration family. The information in the table reflects the baseline state and behavior of the fields.

This family is not enabled for site filtering, which means that records in this family can be accessed by any user with the appropriate license and family privileges. For more information, refer to the Sites section of the documentation.


Field Caption	Data Type	Description	Behavior and Usage
Class Name	Character	The rule class that will be invoked when you select a work item node in the tree on the Packaging page.	You will need to enter the name of the class.
Description	Text	A description of the configuration.	You can enter any description.
Name	Character	The name of the configuration.	The value in this field is displayed in the Definition Configuration column on the Work Management Item Definitions page.
Project Path	Character	The path to the rule that will be invoked when you select a work item node in the tree on the Packaging page.	You will need to enter the path to the rule project.

Work Management Item Definition Records

The following table provides an alphabetical list and descriptions of the fields that exist for the Work Management Item Definition family. The information in the table reflects the baseline state and behavior of the fields.


Field Caption	Data Type	Description	Behavior and Usage
Allow Link Existing	Logical	A value that indicates whether or not you are allowed to add existing records in the family that is stored in the Family ID field to records in its predecessor family using the shortcut menu in the tree on the Packaging page.	On the datasheet, you can select or clear the check box. For example, if you selected Preventative Maintenance Task in the Family ID list, its successor family is the Implementation Package family, and the Allow Link Existing check box is selected, and when you select the Implementation Package node in the tree, the Find an existing Preventative Maintenance Task to link to <Root Implementation Package Name> Implementation Package option will appear.
Family ID	Character	The family ID of the family representing the type of work item record that you want to add to an Implementation Package.	On the datasheet, the list displays all families that are related to the Implementation Package family through the Has Work Management Item relationship. This field is required. For example, if you want to be able to add Preventative Maintenance Task records to an Implementation Package, you would select Preventative Maintenance Task in the Family ID list. This would allow you to add Preventative Maintenance Task records to an Implementation Package when you select the Implementation Package node in the tree on the Packaging page.
Parent Family ID	Character	The family ID of the family whose records will be predecessors to records that belong to the family that is stored in the Family ID field.	On the datasheet, the list displays all families that are related to the Implementation Package family through the Has Work Management Item relationship.
Parent Family Relationship ID	Character	The relationship family that relates the family that is stored in the Family ID field to the family that is stored in the Parent Family ID field.	On the datasheet, the list displays all relationship families that exist in the database. For example, suppose you selected Preventative Maintenance Task in the Family ID list and Task Grouping in the Parent Family ID list. If the Task Grouping family is related to the Preventative Maintenance Task family through the Has Tasks relationship, you would select Has Tasks in the Parent Family Relationship ID list.
Sequence	Number	A number that determines the order in which the family identified by the value in the Family ID field will appear on the Packaging Tasks submenu, the menu in the tree, and the Work Management Item Definitions grid on the Implementation Administration page.	You can enter any number beginning with 0.

Work Management Item Child Definition Records

The following table provides an alphabetical list and descriptions of the fields that exist for the Work Management Item Child Definition family. The information in the table reflects the baseline state and behavior of the fields.


Field Caption	Data Type	Description	Behavior and Usage
Child Family ID	Character	The successor family whose records you want to link to records belonging to the family that appears in the Family ID cell in the Work Management Item Definition record to which this Work Management Item Child Definition record is linked.	On the datasheet, you can select a family from a list containing all families that are related to the Implementation Package family through the Has Work Management Item relationship. For example, suppose you want to be able to link Preventative Maintenance Task records to Task Grouping records. If the Family ID field in the predecessor Work Management Item Definition record contains the value Task Grouping, then in the Child Family ID list, you would select Preventative Maintenance Task.
Child Family Relationship ID	Character	The relationship family that relates the family that appears in the Family ID cell in the predecessor Work Management Item Definition record to the family that is stored in the Child Family ID field in this Work Management Item Child Definition record.	On the datasheet, you can select the appropriate relationship family from the list.

Implementation Package Records

The following table provides an alphabetical list and descriptions of the fields that exist for the Implementation Package family. The information in the table reflects the baseline state and behavior of the fields.


Field Caption	Data Type	Description	Behavior and Usage
Description	Text	A description of the Implementation Package.	You can enter any description. This field is disabled if the Implementation Package record is set to the Packaged or Implemented state.
ID	Character	The ID of the Implementation Package.	You can enter any ID. This is a required field.
SAP System	Character	The name of the SAP system to which you will transfer the items in the Implementation Package.	Select the SAP System record representing the SAP system to which you want to transfer items in the Implementation Package. This is a required field.

Execution Mapping Records

The following table provides an alphabetical list and descriptions of the fields that exist for the Execution Mapping family. The information in the table reflects the baseline state and behavior of the fields.


Field Caption	Data Type	Description	Behavior and Usage
Description	Text	A description of the mapping.	You can enter any description.
Name	Character	The name of the mapping.	The value in this field is displayed in the Execution Mapping column on the Work Management Item Definitions page. A value is required.
WMI to SAP Object Mapping Policy	Character	The policies that are used to configure the field mappings for the export of WMI records of SAP.	This field contains a list of policies that you can modify to change the baseline field mappings.

Action Mapping Records

The following table provides an alphabetical list and descriptions of the fields that exist for the Action Mapping family. The information in the table reflects the baseline state and behavior of the fields.


Field Caption	Data Type	Description	Behavior and Usage
Description	Text	A description of the mapping.	You can enter any description.
Name	Character	The name of the mapping.	The value in this field is displayed in the Action Mapping column on the Work Management Item Definitions page. A value is required.
Map to Action	Character	The policies that are used to configure the field mappings when linking a WMI to an Action in ASM.	This field contains a list of policies that you can modify to change the baseline field mappings.
Map to Work Management Item	Character	The policies that are used to configure the field mappings when linking an ASM Action to WMI.	This field contains a list of policies that you can modify to change the baseline field mappings.