This edition applies to version 7, release 5, modification 0 of IBM Maximo Adapter
for Microsoft Project and to all subsequent releases and modifications until ...
IBM Maximo Adapter for Microsoft Project Version 7 Release 5
User Guide
Note Before using this information and the product it supports, read the information in “Notices” on page 31.
This edition applies to version 7, release 5, modification 0 of IBM Maximo Adapter for Microsoft Project and to all subsequent releases and modifications until otherwise indicated in new editions. © Copyright IBM Corporation 2011. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents Chapter 1. IBM Maximo Adapter for Microsoft Project overview . . . . . . 1
Saving work order data from Microsoft Project to Maximo Asset Management . . . . . . . .
Chapter 2. Configuring Maximo Adapter for Microsoft Project . . . . . . . . . 3
Chapter 5. Scheduling projects using Maximo Asset Management data . . . 19
Configuring automatic login settings Configuring language settings . . Configuring help settings . . . . Custom data mapping . . . . . Defining custom mappings . . . MaximoProject.ini file . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
3 3 4 5 8 8
Chapter 3. Integrating Maximo Asset Management and Microsoft Project data . . . . . . . . . . . . . . . . 13 Creating a project in Microsoft Project that uses Maximo Asset Management data . . . . . Transferring work orders to Microsoft Project scheduling. . . . . . . . . . . . Selecting preventive maintenance records for scheduling. . . . . . . . . . . . Loading resources into Microsoft Project. .
Chapter 4. Synchronizing data
. . 13 for . . 13 . .
. 14 . 15
. . . . 17
Work order refresh . . . . . . . . . . . . 17 Refreshing Maximo Asset Management work orders in Microsoft Project . . . . . . . . . . . . 17
© Copyright IBM Corp. 2011
Creating a preventive maintenance workload forecast . . . . . . . . . . . . . Planning work for a shutdown period . . Scheduling a work order backlog . . . . Consolidating projects . . . . . . . . Constraining previously scheduled dates . Comparing the scheduled dates of a project
. . . . . .
. . . . . .
. 18
. . . . . .
19 19 19 20 20 21
Chapter 6. Data mapping . . . . . . . 23 Crafts, labor, and tools data mapping. . . . . . Work order and preventive maintenance data mapping . . . . . . . . . . . . . . . Schedule constraints data mapping . . . . . . Duration data mapping . . . . . . . . . . Progress data transfer logic . . . . . . . . . Resource calculations . . . . . . . . . . . Transferring data from Microsoft Project to Maximo Asset Management . . . . . . . . . . . .
23 25 26 28 28 29 29
Notices . . . . . . . . . . . . . . 31 Trademarks .
.
.
.
.
.
.
.
.
.
.
.
.
. 32
iii
iv
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Chapter 1. IBM Maximo Adapter for Microsoft Project overview You use IBM® Maximo® Adapter for Microsoft Project to view, schedule, and work with IBM Maximo Asset Management data in Microsoft Project. You can create projects that use the data from Maximo Asset Management work orders and preventive maintenance records. By selecting options from the Maximo menu in Microsoft Project, you can create projects that use work orders and preventive maintenance data from Maximo Asset Management. You can also transfer crafts, tools, and people records from Maximo Asset Management into Microsoft Project. You can schedule project work using the Maximo Asset Management data and resources. After you work with your project, you can return schedule data to the Maximo database.
© Copyright IBM Corp. 2011
1
2
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Chapter 2. Configuring Maximo Adapter for Microsoft Project You can configure your login settings and your language settings. You can create data mappings to transfer custom work order and preventive maintenance data between Maximo Asset Management and Microsoft Project. You can configure a connection to the locally installed version of the information center.
Configuring automatic login settings By default, you must enter your Maximo Asset Management credentials every time you open Microsoft Project when Maximo Adapter for Microsoft Project is installed. However, you can configure the adapter to automatically connect to Maximo Asset Management.
Procedure 1. Open the MaximoProject.ini file in a text editor. 2. In the system section of the MaximoProject.ini file, uncomment the LOGINMODE=Auto line to enable automatic login to Maximo Asset Management. 3. In the system section of the MaximoProject.ini file, enter a valid Maximo Asset Management user name and password. 4. Save the MaximoProject.ini file.
Results You are automatically connected to Maximo Asset Management with the specified user name and password when you open Microsoft Project. Related reference “MaximoProject.ini file” on page 8 The MaximoProject.ini file contains settings for user options, including login, logging, and data mapping settings. You can customize your installation of Maximo Adapter for Microsoft Project by changing the settings in the MaximoProject.ini file.
Configuring language settings You can deploy Maximo Adapter for Microsoft Project in the languages that are available on the Maximo Asset Management application server. You run the TDToolkit.bat utility to deploy translated versions of Maximo Adapter for Microsoft Project.
Before you begin The server component of the Maximo Adapter for Microsoft Project installation program must be installed on your Maximo Asset Management application server.
Procedure 1. Open a command prompt on the application server. 2. Enter cd Product_Home\tools\maximo.
© Copyright IBM Corp. 2011
3
3. Enter TDToolkit.bat -pmpupdate -version"version_number" to import the translated content. V7100-000 is the default version number for all Maximo Asset Management 7.X versions. 4. Check the error log file for any errors that occurred. a. Enter cd Product_Home\tools\maximo\log b. Open the TDToolkittimestamp.log file.
Results All the available languages on your Maximo Asset Management application server are available in Maximo Adapter for Microsoft Project.
Configuring help settings Maximo Adapter for Microsoft Project connects to the product information center at ibm.com by default. You can configure Maximo Adapter for Microsoft Project to connect to a locally installed information center.
About this task To configure Maximo Adapter for Microsoft Project to connect to the locally installed information center, you edit the INFOHOST, INFOPORT, and INFOPATH parameters in the MaximoProject.ini file with the help settings from the Maximo Asset Management System Properties as follows: v set INFOHOST to be a concatenation of mxe.help.protocol and mxe.help.host. v set INFOPORT to the same value as mxe.help.port. v set INFOPATH to be a concatenation of mxe.help.path and the plug-in ID. The plug-in ID Maximo Adapter for Microsoft Project is com.ibm.prj.doc. For example, if the help settings in the Maximo Asset Management System Properties are as follows: v mxe.help.protocol= http v mxe.help.host=exampleserver.example.com v mxe.help.port=9080 v mxe.help.path=/help/ To configure the connection to the locally installed information center, you edit the MaximoProject.ini file to read, INFOHOST=http://exampleserver.example.com INFOPORT=9080 INFOPATH=help/index.jsp?topic=/com.ibm.prj.doc.
Procedure 1. In the System Properties tab of the Maximo Asset Management System application, select System Configuration > Platform Configuration > System Properties. Filter on mxe.help. Note the following values, mxe.help.protocol, mxe.help.port, mxe.help.host, mxe.help.path. 2. Open the MaximoProject.ini file in a text editor. 3. In the system section of the MaximoProject.ini file, edit the following parameters, INFOHOST, INFOPORT, and INFOPATH as follows:
4
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Option
Description
INFOHOST
mxe.help.protocol ://mxe.help.host
INFOPORT
mxe.help.port
INFOPATH
mxe.help.path/index.jsp?topic=/ com.ibm.prj.doc
Results You are connected to the locally installed information center when you click the Maximo Adapter for Microsoft Project help links. Related reference “MaximoProject.ini file” on page 8 The MaximoProject.ini file contains settings for user options, including login, logging, and data mapping settings. You can customize your installation of Maximo Adapter for Microsoft Project by changing the settings in the MaximoProject.ini file.
Custom data mapping You can define custom mapping of work order and preventive maintenance fields by defining the mappings in the MaximoProject.ini file. There are some limitations on how the data can be mapped. The data type selected for the Microsoft Project field must be compatible with the data type of the Maximo Asset Management field. For example, if the Maximo Asset Management field is alphanumeric (ALN), the Microsoft Project field must be configured as Text. If the Maximo Asset Management field is Yes or No (YORN), the Microsoft Project field must be configured as FLAG fields. Each field can be used for one data mapping definition.
Available fields in Microsoft Project The following Microsoft Project fields are available for mapping to Maximo Asset Management. v Date1 - Date10 v Text1 - Text27 v Cost1 - Cost10 v Flag1 - Flag20
Mapping work order data For work order data, the all fields in the Maximo Asset Management WorkOrder table and any custom fields defined in the MaximoProject.ini file are available to map to Microsoft Project fields.
Example custom mapping of work order data To map the work order data, add the following code to the wofieldmap section of the MaximoProject.ini file.
Chapter 2. Configuring Maximo Adapter for Microsoft Project
5
Table 1. Work order data mapping example Parameter
Value
Key name
WOMAPROW1
Maximo column name
location
Microsoft Project task field
text1
Lookup status
TRUE
[wofieldmap] WOMAPROW1=location text1 TRUE
Mapping preventive maintenance data For preventive maintenance records, fields from the WogenForecast table in Maximo Asset Management are available to map to Microsoft Project fields. Table 2. Maximo Asset Management fields available for mapping preventive maintenance data to Microsoft Project fields
6
ATTRIBUTENO
ATTRIBUTENAME
1
PARENT
2
STATUS
3
WORKTYPE
4
DESCRIPTION
5
ASSETNUM
6
LOCATION
7
JPNUM
8
ESTDUR
9
ESTLABHRS
10
PMNUM
11
HASCHILDREN
12
WOPRIORITY
13
TARGCOMPDATE
14
TARGSTARTDATE
15
CALENDAR
16
DOWNTIME
17
CREWID
18
SUPERVISOR
19
CALCPRIORITY
20
WOSEQUENCE
21
PMDUEDATE
22
PMEXTDATE
23
PMNEXTDUEDATE
24
ORGID
25
SITEID
26
TASKID
27
GLACCOUNT
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Table 2. Maximo Asset Management fields available for mapping preventive maintenance data to Microsoft Project fields (continued) ATTRIBUTENO
ATTRIBUTENAME
28
WOPM1
29
WOPM2
30
WOPM3
31
WOPM4
32
WOPM5
33
WOPM6
34
WOPM7
35
STORELOC
36
ISTASK
37
WONUM
38
ASSETLOCPRIORITY
39
PARENTJP
40
PARENTCHGSSTATUS
41
INTERRUPTIBLE
42
LONGDESCRIPTION
43
STORELOCSITE
Example custom mapping of preventive maintenance data To map the preventive maintenance data, add the code to the pmfieldmap section of the MaximoProject.ini file. Table 3. Preventive Maintenance data mapping example Parameter
Value
Key name
PMMAPROW2
Maximo column name
assetnum
Microsoft Project task field
text2
Lookup status
TRUE
[pmfieldmap] PMMAPROW2=assetnum text2 TRUE
Chapter 2. Configuring Maximo Adapter for Microsoft Project
7
Related tasks “Defining custom mappings” Custom mapped fields are user-defined fields that transfer extra information between Maximo Asset Management and Microsoft Project. You create custom mappings of work order and preventive maintenance data by adding the mapping definitions to the MaximoProject.ini file. Related reference “MaximoProject.ini file” The MaximoProject.ini file contains settings for user options, including login, logging, and data mapping settings. You can customize your installation of Maximo Adapter for Microsoft Project by changing the settings in the MaximoProject.ini file.
Defining custom mappings Custom mapped fields are user-defined fields that transfer extra information between Maximo Asset Management and Microsoft Project. You create custom mappings of work order and preventive maintenance data by adding the mapping definitions to the MaximoProject.ini file.
Procedure 1. Open the MaximoProject.ini file in a text editor. 2. Define work order data mapping in the wofieldmap section by adding a line with the format key name=Maximo column name Microsoft Project task field name Lookup status 3. Define preventive maintenance data mapping in the pmfieldmap section by adding a line with the format key name=Maximo column name Microsoft Project task field name Lookup status 4. Save the MaximoProject.ini file. Related concepts “Custom data mapping” on page 5 You can define custom mapping of work order and preventive maintenance fields by defining the mappings in the MaximoProject.ini file. There are some limitations on how the data can be mapped. Related reference “MaximoProject.ini file” The MaximoProject.ini file contains settings for user options, including login, logging, and data mapping settings. You can customize your installation of Maximo Adapter for Microsoft Project by changing the settings in the MaximoProject.ini file.
MaximoProject.ini file The MaximoProject.ini file contains settings for user options, including login, logging, and data mapping settings. You can customize your installation of Maximo Adapter for Microsoft Project by changing the settings in the MaximoProject.ini file. You can customize the following sections of the MaximoProject.ini file: v system v options v field
8
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
v wofieldmap v pmfieldmap
The system section The system section of the MaximoProject.ini file contains information about the Maximo Asset Management server that this client connects to. SERVERIP The IP address of the Maximo Asset Management application server. The SERVERIP parameter must contain a valid value and it must not be commented out. SERVERRMI The SERVERRMI parameter value must be commented out unless the max.registry.port setting of the Maximo Asset Management application server has a value other than the default value of 1099. SERVERPORT The SERVERPORT parameter must contain a valid value and it must not be commented out. SERVERNAME The server name of the Maximo Asset Management application server. The SERVERNAME parameter must contain a valid value and it must not be commented out. The system section of the MaximoProject.ini file also contains the login settings for connecting Maximo Adapter for Microsoft Project to Maximo Asset Management. By default, the login settings are commented out, and users must manually log in to Maximo Asset Management every time they open Microsoft Project. You can uncomment the lines in the system section to allow automatic login to Maximo Asset Management. The system section has the following format. [system] LOGINMODE=Auto USERNAME=username PASSWORD=password
The system section of the MaximoProject.ini file also contains the parameters INFOHOST, INFOPORT, and INFOHOST. TheINFOHOST, INFOPORT, and INFOHOST parameters point to the Maximo Adapter for Microsoft Project information center. The parameter values are set during installation to point to the information center hosted at ibm.com. The parameters can be configured to link to the information center installed on your local application server. The Maximo Asset Management help settings, mxe.help.protocol , mxe.help.port, mxe.help.host, and mxe.help.path can be viewed in the system properties application. When the link to the locally installed information center is configured the INFOHOST, INFOPORT, and INFOHOST parameters are configured as follows: INFOHOST INFOHOST is a concatenation of mxe.help.protocol and mxe.help.host. INFOPORT INFOPORT= mxe.help.port Chapter 2. Configuring Maximo Adapter for Microsoft Project
9
INFOPATH INFOPATH is a concatenation of mxe.help.path and the plug-in ID (for Maximo Adapter for Microsoft Project the plug-in ID is com.ibm.prj.doc)
The options section The options section of the MaximoProject.ini file contains options for error logs, messages, and data transfer. Logtype The Logtype parameter indicates what messages are logged. Its format is LOGTYPE=Logtype value. Table 4. Logtype values Logtype value
Description
NONE
No messages are logged.
SQL
SQL statements are logged.
ERRORS
Error messages, and certain program instructions are logged.
SQLERRORS
SQL statements, error messages, and certain program instructions are logged.
FULL
SQL statements, error messages, certain program instructions, and performance information are logged.
Logfile The Logfile parameter specifies the file name of the message log file. The Logfile parameter can include a full Windows path to the message log file. If the path is omitted, the log file is saved in the Maximo Adapter for Microsoft Project installation directory. The format of theLogfile parameter is LOGFILE=logfile_path/logfilename.log IGNORETASKS If the line IGNORETASKS=TRUE is uncommented, the work order tasks are not loaded into Maximo Adapter for Microsoft Project when a work order query is selected. SHOWCLASSSELECTOR If SHOWCLASSSELECTOR=TRUE, the WOCLASS (WORKORDER/TASK/ CHANGE/RELEASE) column is transferred to Microsoft Project. If you enable the SHOWCLASSSELECTOR setting, tasks that you transfer from Maximo Asset Management are identified in the Class column in Microsoft Project. UPDATEFINISHANNOUNCE If UPDATEFINISHANNOUNCE=TRUE, a message is shown when an update from Maximo Asset Management is complete. SAVEPREDECESSORS If SAVEPREDECESSORS=TRUE, predecessors are saved back to Maximo Asset Management as actual predecessor data. Tasks that are loaded from Maximo Asset Management with sequence numbers and then saved with this option on are saved as Maximo Asset Management predecessors. USESSL The parameter USESSL=TRUE if your server is configured to use SSL. DONTRETAINPARENT If the line DONTRETAINPARENT=TRUE is uncommented, then child work
10
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
orders that do not have a parent work order in Microsoft Project are transferred to Maximo Asset Management from Microsoft Project without the link to the parent work order.
The field section The field section of the MaximoProject.ini file contains SSL settings, lookup table settings, and value list lookup settings. To transfer work order data to Maximo Asset Management from Microsoft Project, the wofieldmap section must have a corresponding field section setting of editable=true. The format of the field section is: [field-INSPECTOR] lookuptype=false editable=true
To configure a field for a table lookup in Maximo Project, the following settings are required: lookuptype= table (Valid settings are table or valuelist) lookuptable= the Maximo database table keyfield= primary key field description= field value to be displayed
The following is an example of how to configure a field for a table lookup. [field-SUPERVISOR] lookuptype=table lookuptable=PERSON keyfield=PERSONID description=DISPLAYNAME editable=true
To configure a field for value list lookup in Maximo Project, the following settings are required: lookuptype= valuelist (Valid settings are table or valuelist) lookuptable= valid settings are: SYNONYMDOMAIN, ALNDOMAIN or NUMERICDOMAIN
The following is an example of how to configure a field for a value list lookup. [field-STATUS] lookuptype=valuelist lookuptable=SYNONYMDOMAIN keyfield=VALUE description=description editable=true
The wofieldmap section The wofieldmap section contains custom data mappings between fields in the work order table of Maximo Asset Management and the task fields of Microsoft Project. The values in the wofieldmap section define the work order data that transferred from Maximo Asset Management to Microsoft Project. The format of the wofieldmap section is: [wofieldmap] key name=Maximo column name Microsoft Project task field name Lookup status
Chapter 2. Configuring Maximo Adapter for Microsoft Project
11
Key name The key name has the format WOMAPROWx, where x is 1-99. You can map up to 99 rows of work order information. Maximo Asset Management column name The name of the Maximo Asset Management database column from which work order data is transferred to Microsoft Project. Microsoft Project task field The name of the Microsoft Project task field that holds the transferred Maximo Asset Management data. This field name is language-dependent and it must match the field name in Microsoft Project. Lookup status The Lookup Status has the value TRUE or FALSE. TRUE, indicates the Value list is enabled for the Maximo Adapter for Microsoft Project field. FALSE indicates the Value list is disabled for the Maximo Adapter for Microsoft Project field. Enabling the Lookup Status affects performance, as populating the Value list increases the amount of data transferred.
The pmfieldmap section The pmfieldmap section contains custom data mappings fields between the preventive maintenance table of Maximo Asset Management and the task fields of Microsoft Project. The format of the pmfieldmap section is: [pmfieldmap] key name=Maximo column name Microsoft Project task field name Lookup status
Key name The key name has the format PMMAPROWx, where x is 1-99. You can map up to 99 rows of preventive maintenance information. Maximo Asset Management column name The Maximo Asset Management database column from which preventive maintenance data is transferred to Microsoft Project. Microsoft Project task field The Microsoft Project task field that holds the transferred Maximo Asset Management data. This field name is language-dependent and it must match the field name in Microsoft Project. Lookup status The Lookup Status has the value TRUE or FALSE. TRUE indicates the 'Select Value list' is enabled for the Maximo Adapter for Microsoft Project field. FALSE indicates the 'Select Value list' is disabled for the Maximo Adapter for Microsoft Project field. Enabling the Lookup Status affects performance as populating the Value list increases the amount of data transferred.
12
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Chapter 3. Integrating Maximo Asset Management and Microsoft Project data You can transfer work order and preventive maintenance data from Maximo Asset Management into Microsoft Project. After working with the data in Microsoft Project, you can save the data back to Maximo Asset Management.
Creating a project in Microsoft Project that uses Maximo Asset Management data You can create projects in Microsoft Project using work order and preventive maintenance (PM) information from Maximo Asset Management. You can use the information from Maximo Asset Management to schedule and forecast work.
Procedure 1. In the Work Order Tracking application or Preventive Maintenance application of Maximo Asset Management, create and save a query. 2. In the Maximo Project Manager startup window, click New Maximo Project. 3. Select the type of data you want to transfer from Maximo Asset Management into Microsoft Project. v To transfer work order data, select Maximo > Select Work Orders. v To forecast PM data in Microsoft Project, select Maximo > Select PMs. 4. Select the query you want to use and click OK to transfer the work order or PM data from Maximo Asset Management to Microsoft Project. 5. Save the project.
Transferring work orders to Microsoft Project for scheduling You can transfer work orders to Microsoft Project from Maximo Asset Management for planning and scheduling.
Procedure 1. In Microsoft Project, select Maximo > Select Work Orders. 2. On the Queries tab, select the query that you require. You can select a public query, or a query that you created in Maximo Asset Management. 3. Click Advanced and use the tabs Constraints, Calendars, Site, Task Priority, and Filter to refine the results.
© Copyright IBM Corp. 2011
Option
Description
Constraints
Defines the dates for which you want to transfer data.
Calendars
Transfer asset and labor calendars from Maximo Asset Management to Microsoft Project. Specify the dates for which you want to transfer the calendars.
Site
Filter to include child work orders for the specified sites in your results set. Select each site to include. To select all sites, click All. To clear all sites, click None
13
Option
Description
Task Priority
Filter the query results by work order, calculated, location, or asset priority.
Filter
The Filter option returns child work orders that have their status specified in their parent work order. Parent work orders are not restricted by filtering the child status. To select all statuses, click All. To clear all statuses, click None.
4. To preview the results, click Preview. 5. After you select the query you require, click OK to transfer the work order data from Maximo Asset Management to Microsoft Project. The work order data that is transferred includes assignments, craft and tool resources, and resource availability. Any custom data specified in the MaximoProject.ini is transferred. For example, if SHOWCLASSSELECTOR is enabled, tasks that you transferred from Maximo Asset Management are listed in the Class column in Microsoft Project. Related reference “Schedule constraints data mapping” on page 26 When you transfer date constraints from to Microsoft Project to schedule work, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields. “Work order and preventive maintenance data mapping” on page 25 When you transfer work orders and preventive maintenance records from Maximo Asset Management to Microsoft Project, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields.
Selecting preventive maintenance records for scheduling You can transfer preventive maintenance (PM) records from Maximo Asset Management to Microsoft Project in order to forecast them.
Procedure 1. Select Maximo > Select PMs. 2. In the Queries tab, select the query that you require. 3. To refine the results, click Advanced, and use the Forecast tab, the Calendars tab, and the Site tab to filter your query. Option
Description
Forecast
Enter the time period for which you want Maximo Adapter for Microsoft Project to forecast preventive maintenance activities and transfer PM work orders to Microsoft Project. v Choose the Generate once without frequency criteria option to start the forecast from today. v Choose the Forecast repeatedly until option to start the forecast from today until the date you specify.
14
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Option
Description
Calendars
Enter the dates for which you want to transfer the Maximo Asset Management asset and labor calendars to Microsoft Project.
Site
Select the sites for which you want to include child PM records.
4. Select the query you require, click OK to transfer the PM data from Maximo Asset Management to Microsoft Project. Related reference “Schedule constraints data mapping” on page 26 When you transfer date constraints from to Microsoft Project to schedule work, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields.
Loading resources into Microsoft Project You can transfer crafts, tools, and labor information from Maximo Asset Management to Microsoft Project. Then you can schedule work using the resources in Microsoft Project. If you are a Maximo for Utilities user, you can also transfer crew and crew type data to Microsoft Project.
Procedure 1. In Microsoft Project, select Maximo > Load Resources. 2. Select the resources you want to transfer. You can transfer any combination of resources. 3. Click OK. The Load Resources window closes and the selected resources are transferred. You can view the transferred data in the Resource Information window of Microsoft Project.
Chapter 3. Integrating Maximo Asset Management and Microsoft Project data
15
16
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Chapter 4. Synchronizing data You can keep the project data in Maximo Asset Management and Microsoft Project consistent. You can refresh the project data with new and updated work orders from Maximo Asset Management.
Work order refresh Work orders can be updated in Maximo Asset Management even if they are already included in a project in Microsoft Project. Then you can refresh the project with the updated work orders. The following rules apply when work orders are refreshed in Microsoft Project. v If the work order exists as a task in Microsoft Project, then the task data in Microsoft Project is updated with the changed work order data. v If a Maximo Asset Management child work order is not a task in the current project, a new child work order is added to Microsoft Project as a subtask, placed after the existing child work orders. No links are established for new child work orders. v New top-level work orders in Maximo Asset Management are not transferred to Microsoft Project. Tip: If you need to make extensive changes to the structure of a project or to transfer a new hierarchy from Maximo Asset Management, create a new project. Related tasks “Refreshing Maximo Asset Management work orders in Microsoft Project” If work order data in Maximo Asset Management is updated since the work order data was last transferred to Microsoft Project, you can refresh the information in Microsoft Project.
Refreshing Maximo Asset Management work orders in Microsoft Project If work order data in Maximo Asset Management is updated since the work order data was last transferred to Microsoft Project, you can refresh the information in Microsoft Project.
Before you begin Tip: If you need to make extensive changes to the structure of a project or to transfer a new hierarchy from Maximo Asset Management, create a new project.
Procedure 1. In the Maximo Asset Management Work Order Tracking application or the Preventive Maintenance application, create and save a query. 2. In Microsoft Project, display the project that you want to update. 3. Select Maximo > Update Work Orders. The updated work order data and task data is displayed in the project.
© Copyright IBM Corp. 2011
17
Related concepts “Work order refresh” on page 17 Work orders can be updated in Maximo Asset Management even if they are already included in a project in Microsoft Project. Then you can refresh the project with the updated work orders.
Saving work order data from Microsoft Project to Maximo Asset Management You can create tasks in Microsoft Project. You can then add these tasks to work orders in your Maximo Asset Management database.
Procedure 1. In Microsoft Project, open the project containing the data you want to save to Maximo Asset Management. 2. Select Maximo > Save work orders to Maximo. 3. Click OK.
Results The work order data is updated in Maximo Asset Management and tasks that you added in Microsoft Project become new work orders. Related reference “Transferring data from Microsoft Project to Maximo Asset Management” on page 29 You can keep your Maximo Asset Management data and your Microsoft Project data consistent. Task information from Microsoft Project can be transferred to Maximo Asset Management as updated work orders.
18
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Chapter 5. Scheduling projects using Maximo Asset Management data You can forecast and schedule projects in Microsoft Project using Maximo Asset Management data.
Creating a preventive maintenance workload forecast You can use Maximo Adapter for Microsoft Project to plan the human resources requirements for planned maintenance and for future preventive maintenance projects.
Procedure 1. In the Preventive Maintenance application of Maximo Asset Management, create a PM query. 2. Log in to Microsoft Project. 3. Select Maximo > Select PMs. 4. On the Queries tab of the Select PMs window, select the query that you want to use. 5. On the Forecast section of the Advanced tab, click Forecast Repeatedly Until. Select the date that you want to forecast to.
Planning work for a shutdown period Some maintenance activities must be carried out when production on a site is stopped. You can gather all the work orders that require a shutdown and include them as part of a shutdown project. Scheduling as part of a shutdown project minimizes the length of time a site is closed.
Procedure 1. In the Work Order Tracking application of Maximo Asset Management, create a work order hierarchy containing all shutdown details. Assign the top-level work orders a work order type of CP, for a capital project. 2. In the Work Order Tracking application, create and save a query to select the work orders required for the shutdown project. 3. In Microsoft Project, select Maximo > Select Work Orders. 4. On the Queries tab of the Select Work Orders window, select the query you require. You can preview the selected work orders and modify your query if necessary. 5. Use Microsoft Project to create a schedule for the work that must be done during a defined shutdown period. 6. Select Maximo > Save work order to Maximo. The work orders in Maximo Asset Management are updated with the new schedule dates.
Scheduling a work order backlog You can create a project schedule that includes only work orders that are approved, waiting for approval, or waiting to be scheduled for a specific location.
© Copyright IBM Corp. 2011
19
Procedure 1. In the Work Order Tracking application, create a work order query to filter for work orders that meet the criteria you require. For example if you want to manage corrective maintenance work orders for the Shipping location, enter the following criteria. v Work Order Type = CM v Status = APPR, WAPPR, and WSCHED v Location = Shipping 2. In Microsoft Project, select Maximo > Select Work Orders. 3. In the Select Work Orders window, select the query you require. Click OK. The work order data is transferred from Maximo Asset Management to Microsoft Project. 4. Use Microsoft Project to work with the project schedule and resources. 5. Select Maximo > Save WO to Maximo. 6. Click OK to save the schedule dates to the work orders in the Maximo Asset Management database.
Consolidating projects You can use Maximo Adapter for Microsoft Project and Microsoft Project to combine multiple .mpp files that contain work order data and preventive maintenance (pm) data from Maximo Asset Management. You can save the resulting project file as reference data.
About this task To establish permanent relationships between projects, you can consolidate them.
Procedure 1. Select a project to be the master project, and open it. 2. On the Gantt chart, click the row in which to insert the project. 3. Select Project > Insert and select the project or projects to insert. Related reference “Schedule constraints data mapping” on page 26 When you transfer date constraints from to Microsoft Project to schedule work, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields.
Constraining previously scheduled dates You can constrain the schedule dates for a set of work orders you have previously scheduled in Microsoft Project.
Before you begin You need a set of scheduled work orders in Microsoft Project.
About this task Only the lowest-level tasks in any hierarchy of the project receive constraints, which roll up the hierarchy. To constrain a branch of a hierarchy, constrain its first detailed subtask.
20
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Procedure 1. Select Maximo > Select work orders. 2. Click Advanced. 3. Click the Constraints tab. Select the Work order date and Task constraint type you require. 4. Click OK.
Results Microsoft Project assigns the date constraints according to your specifications.
Comparing the scheduled dates of a project You can use Maximo Adapter for Microsoft Project to compare the current schedule dates to the dates from the last scheduling session or to the original target dates.
Procedure 1. In the MaximoProject.ini file, map the TARGSTARTDATE and SCHEDSTART fields in the Maximo Asset Management WORKORDER table to date fields in Microsoft Project, for example: Date1 and Date2. 2. In Microsoft Project, create a filter to compare dates. 3. In Microsoft Project, view the latest update from Maximo Asset Management and the latest schedule calculation, select the new filter and click Highlight. All tasks that are overdue or delayed are highlighted.
Chapter 5. Scheduling projects using Maximo Asset Management data
21
22
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Chapter 6. Data mapping When you transfer data between Maximo Asset Management and Microsoft Project, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields.
Crafts, labor, and tools data mapping When you transfer forecasting, scheduling, resource, or progress data between Maximo Asset Management and Microsoft Project, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields.
Crafts Craft fields from the LABOR table in Maximo Asset Management are mapped to MSP Resources in Microsoft Project. Table 5. Data mapping of craft data from the LABOR table in Maximo Asset Management and MSP Resources fields in Microsoft Project Maximo Asset Management data
Microsoft Project field
LABORCODE
Resource Name
NAME
Resource Notes
Resource Quantity (RESQTY)
Availability
PAYRATE
Standard Rate
Payrate x OTscale (the product of these values is transferred) CRAFT
Resource Code
Craft fields from the WORKPLAN table in Maximo Asset Management are mapped to Assignments in Microsoft Project. Table 6. Data mapping of craft data from the WORKPLAN table in Maximo Asset Management and Assignments fields in Microsoft Project Maximo Asset Management data
Microsoft Project field
Assignment Work Plan row
Assignment
Work Plan quantity (CRAFTQTY)
Assignment Units
Work Plan Hours (LABORHRS) x Work Plan Assignment Work Hours Quantity (CRAFTQTY) (the product of these values is transferred)
Labor Labor fields from the LABOR table in Maximo Asset Management are mapped to MSP Resources in Microsoft Project.
© Copyright IBM Corp. 2011
23
Table 7. Data mapping of Labor data from the LABOR table in Maximo Asset Management and MSP Resources fields in Microsoft Project Maximo Asset Management data
Microsoft Project field
PERSONID
Resource Name
DISPLAYNAME
Resource Notes
Calendar/Shift (optional)
Working Time Resource Type= "Labor" Labor Type= "Person"
Labor fields from the WORKPLAN table in Maximo Asset Management are mapped to Assignments in Microsoft Project Table 8. Data mapping of Labor data from the WORKPLAN table in Maximo Asset Management and Assignments fields in Microsoft Project Maximo Asset Management data
Microsoft Project field
Assignment Work Plan row
Assignment
Work Plan quantity
Assignment Units
Work Plan Hours
Assignment Work Hours
Tools Tools fields from the TOOL table in Maximo Asset Management are mapped to MSP Resources in Microsoft Project. Table 9. Data mapping of tools data from the TOOL table in Maximo Asset Management and MSP Resources fields in Microsoft Project Maximo Asset Management data
Microsoft Project field
TOOLNUM
Resource Name
Description
Resource notes
Resource Quantity (RESQTY)
Availability
Tool Rate
Standard Rate
TOOL
Resource Code
Tools fields from the WORKPLAN table in Maximo Asset Management are mapped to Assignments in Microsoft Project. Table 10. Data mapping of tools data from the WORKPLAN table in Maximo Asset Management and Assignments fields in Microsoft Project Maximo Asset Management data
Microsoft Project field
Assignment Work Plan row
Assignment
Work Plan Quantity (TOOLQTY)
Assignment Units
Work Plan Hours (TOOLHRS) x Work Plan Quantity (TOOLQTY)
Assignment Work Hours
(the product of these values is transferred)
24
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Related concepts “Resource calculations” on page 29 You can transfer work plans containing multiple resources from Maximo Asset Management to Microsoft Project. If a resource is assigned to a work plan multiple times Maximo Adapter for Microsoft Project combines the resource units. The total amount of resources assigned is available for scheduling purposes in Microsoft Project.
Work order and preventive maintenance data mapping When you transfer work orders and preventive maintenance records from Maximo Asset Management to Microsoft Project, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields.
Work orders Work orders are transferred from Maximo Asset Management to Microsoft Project as tasks. A transferred work order is assigned a priority in Microsoft Project based on its priority in Maximo Asset Management. Table 11. Work Order Priority in Maximo Asset Management Maximo Asset Management Priority Field
Description
Work Order (WOPRIORITY)
This is the default work order priority. This is the priority level of the work order assigned in the work order or by a job plan.
Calculated Priority (CALCPRIORITY)
This value is calculated in Maximo Asset Management using a formula that combines the Work Order Priority and Location/Asset Priority values to produce the Work Priority value.
Location/Asset Priority (ASSETLOCPRIORITY)
This is the priority level of the asset or location specified on a work order.
Table 12. Data mapping of work order data between Maximo Asset Management and Microsoft Project Maximo field
Microsoft Project field
Work Order Number (WONUM)
Task Notes
Description
Task Name
Child work orders Child work orders at the same level of any given work order hierarchy are linked together according to their Maximo Asset Management work order sequence (WOSEQUENCE) numbers. Table 13. Data mapping of child work order data between Maximo Asset Management and Microsoft Project Maximo field
Microsoft Project field
Child WOs
Microsoft Project sub tasks
Task Number Sequencing
Links Chapter 6. Data mapping
25
Table 13. Data mapping of child work order data between Maximo Asset Management and Microsoft Project (continued) Maximo field
Microsoft Project field
Work Order Sequencing (WOSEQUENCE)
Smaller sequence numbers become predecessors to larger sequence numbers. Maximo Adapter for Microsoft Project creates finish-to-start links between numbered work orders.
Preventive maintenance Preventive maintenance (pm) data is transferred from Maximo Asset Management to Microsoft Project as tasks. The number of sets of work orders forecasted depends on the controlling frequency of the hierarchy. Any PM in the hierarchy can trigger all PMs to be forecasted as a set. Maximo Adapter for Microsoft Project only forecasts PMs with ACTIVE status in Maximo. Table 14. Data mapping of preventive maintenance data between Maximo Asset Management and Microsoft Project Maximo Asset Management field
Microsoft Project field
PM Number (PMNUM)
Task Notes
Description
Task Name
You can transfer asset and labor calendars when you transfer preventive maintenance data from Maximo Asset Management to Microsoft Project When you transfer asset calendars to Microsoft Project, the data that is shown changes. The asset calendar in Maximo Asset Management shows when the asset is operating. The asset calendar in Microsoft Project shows when the asset is available for preventive maintenance. Upon receiving the asset calendar from Maximo Asset Management, Maximo Adapter for Microsoft Project names the calendar with the asset number, and makes the asset calendar an attribute of the work order being scheduled. Transferring calendar data can impact performance, make the date range as small as possible. Related tasks “Transferring work orders to Microsoft Project for scheduling” on page 13 You can transfer work orders to Microsoft Project from Maximo Asset Management for planning and scheduling.
Schedule constraints data mapping When you transfer date constraints from to Microsoft Project to schedule work, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields. You can define date constraints for work orders and preventive maintenance data to limit the data you transfer from Maximo Asset Management to Microsoft
26
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Project. You can select only one constraint type. When you constrain work orders, Maximo Adapter for Microsoft Project uses that constraint on all tasks at the lowest hierarchical level. You can constrain only tasks that are not summaries of other tasks. Mixing child and parent constraints can violate the business rules of Microsoft Project and cause problems when work orders are transferred to Microsoft Project. To manipulate groups of tasks, transfer the parent tasks and work orders from Maximo Asset Management, then set the constraints in Microsoft Project. Maximo Asset Management start date constraints
Microsoft Project task data
Scheduled start (SCHEDSTART)
ConstraintDate
Target start (TARGSTARTDATE)
ConstraintDate
Maximo Asset Management finish date constraints
Microsoft Project task data
Scheduled finish (SCHEDFINISH)
ConstraintDate
Target finish (TARGCOMPDATE)
ConstraintDate
Maximo Asset Management start date constraint types
Microsoft Project task data
Must start On
ConstraintDate
Start no earlier than
ConstraintDate
Start no later than
ConstraintDate
Maximo Asset Management date constraint types
Microsoft Project task data
End no earlier than
ConstraintDate
End no later than
ConstraintDate
Chapter 6. Data mapping
27
Related tasks “Transferring work orders to Microsoft Project for scheduling” on page 13 You can transfer work orders to Microsoft Project from Maximo Asset Management for planning and scheduling. “Selecting preventive maintenance records for scheduling” on page 14 You can transfer preventive maintenance (PM) records from Maximo Asset Management to Microsoft Project in order to forecast them. “Consolidating projects” on page 20 You can use Maximo Adapter for Microsoft Project and Microsoft Project to combine multiple .mpp files that contain work order data and preventive maintenance (pm) data from Maximo Asset Management. You can save the resulting project file as reference data.
Duration data mapping Progress data is transferred from Maximo Asset Management to Microsoft Project, if the Actual start field contains a value. If there is no Actual start data, the value in the Estimated duration field is transferred. Maximo Asset Management field
Microsoft Project field
Estimated duration (ESTDUR)
Duration
Remaining duration (REMDUR)
RemainingDuration
Actual hours (ACTLABHRS)
ActualDuration
Actual start (ACTSTART)
ActualStart
Actual finish (ACTFINISH)
ActualFinish
When labor exists for work plan data that is transferred to Microsoft Project, the work is scheduled by resource assignments at the lowest level of the work hierarchy. Durations get passed up to tasks and work orders through the hierarchy, often resulting in the recalculation of work order duration.
Progress data transfer logic You can transfer data from Maximo Asset Management to Maximo Adapter for Microsoft Project to track the progress of scheduled work. The data recorded in Maximo Asset Management for a specific task determines how the information is transferred. The following logic is used to transfer progress data. Condition
The logic used to transfer progress data
If there is ACTSTART data
The ACTSTART data is transferred to Actual Start.
If there is no ACTSTART data
The ESTDUR data is transferred to Duration.
If there is ACTFINISH data
The ACTFINISH data is transferred to Actual Finish.
If there is no ACTFINISH data and if there is The REMDUR data is transferred to REMDUR data Remaining Duration If there is no ACTFINISH and no REMDUR data
28
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
The ESTDUR data is transferred to Duration
Condition
The logic used to transfer progress data
If there is no ACTFINISH data and if there is The ACTLABHRS data is transferred to ACTLABHRS data Actual Duration
Resource calculations You can transfer work plans containing multiple resources from Maximo Asset Management to Microsoft Project. If a resource is assigned to a work plan multiple times Maximo Adapter for Microsoft Project combines the resource units. The total amount of resources assigned is available for scheduling purposes in Microsoft Project.
Example A work plan can contain multiple resources. If a resource is assigned multiple times to the same operation or work plan, Maximo Adapter for Microsoft Project combines the entries for the resource by adding the units. Then the total resource allocation is transferred to Microsoft Project. A work plan contains the assignments: Labor code
Description
Quantity
Hours
ME1
Mechanic First Class
2
8:00
ME1
Mechanic First Class
1
6:00
Maximo Adapter for Microsoft Project assigns three mechanics for 8 hours to complete the task. Related reference “Crafts, labor, and tools data mapping” on page 23 When you transfer forecasting, scheduling, resource, or progress data between Maximo Asset Management and Microsoft Project, Maximo Asset Management fields are mapped to corresponding Microsoft Project fields.
Transferring data from Microsoft Project to Maximo Asset Management You can keep your Maximo Asset Management data and your Microsoft Project data consistent. Task information from Microsoft Project can be transferred to Maximo Asset Management as updated work orders.
Data that is transferred from Microsoft Project to Maximo Asset Management The following data is transferred to Maximo Asset Management from Microsoft Project: v The start and finish dates of the task are transferred as the scheduled start date, SCHEDSTART, and scheduled finish, SCHEDFINISH, data of the work order. v The duration of the task is transferred as the estimated duration the work order, ESTDUR. v The custom data specified in the [wofieldmap] section of the MaximoProject.ini file is transferred to the work order.
Chapter 6. Data mapping
29
Data that is not transferred from Microsoft Project to Maximo Asset Management The following data is not transferred to Maximo Asset Management: v Preventive maintenance data. If the active project includes both preventive maintenance subprojects and work order subprojects, only the work order data is transferred. The preventive maintenance data is not transferred to Maximo Asset Management. v Work order status. Work order status is not transferred to Maximo Asset Management. Related tasks “Saving work order data from Microsoft Project to Maximo Asset Management” on page 18 You can create tasks in Microsoft Project. You can then add these tasks to work orders in your Maximo Asset Management database.
30
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan Ltd. 1623-14, Shimotsuruma, Yamato-shi Kanagawa 242-8502 Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
© Copyright IBM Corp. 2011
31
IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be liable for any damages arising out of your use of the sample programs. © Copyright IBM Corp. 2007, 2011. All rights reserved.
Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at “Copyright and trademark information” at www.ibm.com/legal/copytrade.shtml.
32
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Other product and service names might be trademarks of IBM or other companies.
Notices
33
34
IBM Maximo Adapter for Microsoft Project 7.5: User Guide
Printed in USA
