SAP Work Manager For Maximo Installation Guide

CUSTOMER

SAP Work Manager for MaximoDocument Version: 8.1.0 – 2017-09-12

SAP Work Manager For Maximo Installation Guide

Content

1 Work Manager for Maximo Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.1 SAP Work Manager for Maximo Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.2 SAP Work Manager for Maximo on the SAP Mobile Platform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.3 What’s Different with Agentry in the SAP Mobile Platform?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.4 Additional Documentation on the SAP Mobile Platform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2 System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

3 Deployment and Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113.1 Creating System Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Establishing Connectivity: Oracle Net Service Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Establishing Connectivity: SQL Server ODBC Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Establishing Connectivity: IBM DB2 ODBC Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Establishing Connectivity: HTTP-XML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

3.2 Installing the Maximo Java Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Modifying the PATH Environment Variable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Making the Maximo Java Classes Available. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

3.3 JavaBE.ini Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323.4 Installing the Work Manager Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343.5 Administration Scripts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Running the Installation Scripts for the SAP Work Manager for Maximo Application. . . . . . . . . . . . . 37Applying the Configuration Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

4 Importing the SAP Work Manager for Maximo Project into the Eclipse Workspace. . . . . . . . . . . . 39

5 Installing the SAP Work Manager for Maximo server Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415.1 Attached Documents Client-Side Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415.2 Installing the SAP Work Manager for Maximo client for Windows CE. . . . . . . . . . . . . . . . . . . . . . . . . . . 415.3 Installing the SAP Work Manager for Maximo client on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435.4 Installing the SAP Work Manager for Maximo Client on Apple iOS and Android Devices. . . . . . . . . . . . . 44

6 Installation Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466.1 Verifying Version Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466.2 SAP Work Manager for Maximo Server to Maximo Connection Issues. . . . . . . . . . . . . . . . . . . . . . . . . 466.3 SAP Work Manager for Maximo Server to SAP Work Manager for Maximo Client Connection Issues

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476.4 Message Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

7 Security for SAP Work Manager for Maximo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

2 C U S T O M E RSAP Work Manager For Maximo Installation Guide

Content

8 Global Definitions and Default Values in SAP Work Manager for Maximo. . . . . . . . . . . . . . . . . . . 538.1 Global Default Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

9 Data Protection and Privacy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 749.1 Data Protection Aspects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .769.2 Deletion of Person-Related Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

SAP Work Manager For Maximo Installation GuideContent C U S T O M E R 3

1 Work Manager for Maximo Overview

1.1 SAP Work Manager for Maximo Overview

SAP Work Manager for Maximo is designed to automate workflow and improve service with mobile work orders, notifications and time management.

SAP Work Manager for Maximo connects mobile employees with the data stored in the Maximo system so they can better manage work and service requests.

Creating a Paperless Workflow

SAP Work Manager for Maximo enables specific details such as asset, customer, or transaction histories and other critical information to be delivered to employees using mobile devices such as PDAs, tablets or laptop computers. In turn, data is uploaded to the Maximo system to generate follow-up work orders, status reports, customer invoices, charge backs and more.

Figure 1: SAP Work Manager for Maximo Paperless Workflow

The paperless workflow process is as follows:

1. Workers log on to their mobile devices and download new work orders through a docking cradle or a real-time wireless connection.

2. Workers can then follow step-by-step job plans, verify work completed and work status, as well as access additional details of a work order or notification to improve decision-making.

3. Workers update customer accounts, place orders, transfer or reassign work to another team member, or complete all required information and update to the Maximo back end system. This added data is accurate and usable, as SAP Work Manager for Maximo enforces business rules on the mobile device (i.e., not allowing modifications or edits of objects if not allowed by the back end).


Work Manager for Maximo Overview

4. Workers transmit their updated or added data to the backend for any additional processing.

1.2 SAP Work Manager for Maximo on the SAP Mobile Platform

SAP Work Manager for Maximo is deployed on the SAP Mobile Platform as an Agentry application. The application is built with the Agentry toolkit within the SAP EAM and service mobile SDK. There are numerous components to the SAP Mobile Platform, including the following:

● Runtime environment● Agentry Editor● Agentry client● Agentry test environment (ATE)● Development server (optional installation)

General overview information on each of these components is provided in this topic. For information the components, including usage, configuration, and other technical details, see the documentation provided with the SAP Mobile Platform and SDK.

Runtime Environment

The runtime environment is a production server system. Within this component, you can define one or more applications of different “archetypes.” An archetype refers to the different types of mobile applications, including the development paradigms, under which mobile applications are developed and deployed. The SAP Work Manager for Maximo application is developed and deployed under the Agentry archetype. Therefore, it requires the definition of an Agentry application within the runtime environment into which it is deployed. You can modify the application by configuring options within the administration interface, the SAP Cockpit.

Additionally, you can develop changes to out-of-the-box behavior of the application by using components of the Agentry toolkit within the SAP EAM and service mobile SDK.

SAP Mobile Platform Server

The server is provided within the SAP EAM and service mobile app SDK. It provides the same runtime functionality as the Agentry server component within the SAP mobile runtime environment. It is provided in the Agentry toolkit to allow you to install the server without the need to install the entire runtime environment for development work. The development server is not intended for production use.

SAP Work Manager For Maximo Installation GuideWork Manager for Maximo Overview C U S T O M E R 5

Agentry Editor Plug-in to Eclipse

The Agentry Editor plug-in to Eclipse provides a 4GL, point-and-click interface that allows developers to modify the SAP Work Manager for Maximo application. The Agentry Editor is provided in the SAP EAM and service mobile app SDK as a part of the Agentry toolkit. Agentry applications are stored within the Agentry Editor in the Eclipse workspace as Agentry application projects.

Both the Agentry application project and the Java packages and projects are all managed within a single Eclipse workspace. The developer is presented with a single IDE in which the mobile application as a whole can be maintained and modified. See the document Agentry App Development in the SAP Mobile Platform documentation for details on working within this toolset.

SAP Work Manager for Maximo Client

The SAP Work Manager for Maximo client is provided for each of the client device types supported by the SAP Work Manager for Maximo application. An installer for the SAP Work Manager for Maximo client build is provided for Windows operating systems. For devices running iOS, the application is installed from the App store, or from your Apple Enterprise Server site. For Android devices, the .apk file is provided. You can install the .apk file from a Web server by navigating to its location within the local network of your environment.

The SAP Work Manager for Maximo client is an executable run on the client device by the end user. The overall architecture of the Agentry toolkit allows for the development of a single application project, which can be deployed on multiple device types. The client processes the business logic developed in the Agentry Editor and is deployed to the runtime environment. The client displays the user interface according to the native operating system of the device on which the SAP Work Manager for Maximo is running.

The Agentry Test Environment

The Agentry Test Environment (ATE) is among the development tools provided in the Agentry Toolkit within the SAP EAM and service mobile app SDK. It is a highly useful tool for developers during the development cycle used for testing the client-side behavior and functionality of your mobile application. It includes numerous debugging and inspection tools to provide insight into the data, action execution, rule evaluation, and other aspects of the behavior of the client at runtime.

The ATE is not an emulator. However, it does posses the capability to mimic the behavior of all the supported client device types. Within the ATE is a full Agentry client. Part of the features of the ATE is the ability to select from a list of supported client platforms from within the Agentry archetype development paradigm. Once you select a platform, the Agentry client tells the SAP Work Manager for Maximo server that it is a client of that type. The client then receives the user interface components for that platform.



http://help.sap.com/saphelp_smp3012sdk/helpdata/en/7c/1c8bd1700610148278be00e002816b/content.htm?frameset=/en/7c/055a4370061014af4ab9a522acd7c7/frameset.htm&current_toc=/en/7c/01cda6700610149b10c2f2a86d335b/plain.htm&node_id=4201&show_children=false

1.3 What’s Different with Agentry in the SAP Mobile Platform?

The SAP Work Manager for Maximo application is an Agentry application deployed within the SAP Mobile Platform runtime environment. For those familiar with older releases of this application, which were deployed on the Agentry Mobile Platform, this section provides some transitional information on what has changed and what is the same in the SAP Mobile Platform 3.

In addition to the general information provided here, it is strongly recommended that you review the information available with the SMP runtime environment, as well as the SAP EAM and service mobile app SDK. Many procedures employed in the configuration and deployment of the SAP Work Manager for Maximo application are documented in those guides and manuals.

Agentry Production Server Within the SMP Runtime Environment

The Agentry server within the Agentry mobile platform is now an application type within the SAP Mobile Platform runtime environment. For those familiar with terminology from the Agentry mobile platform, this is the equivalent of the Agentry production server. From a functional standpoint there are no significant changes to the behavior of the Agentry server functionality. Data and business logic are served up to clients just as they were in the Agentry mobile platform. Data synchronization is handled in the same manner.

Differences involve how the settings for the Agentry server are configured. Within SMP it is no longer possible to modify configuration files directly for applications deployed to this environment. Rather, one of two options exist for making these modifications. First, the SAP Cockpit, which is the administration console for SMP, is used to make any changes that would have otherwise been made to the Agentry.ini configuration file. All settings are available within the SAP Cockpit.

Second, copies of the configuration files can be modified directly outside of the SAP Mobile Platform runtime environment, and then deployed to the Agentry application within the environment. This is the required procedure for all configuration files in need of modification other than the Agentry.ini file, as these are not configurable within the SAP Cockpit.

Agentry Development Components in the SAP EAM and service mobile app SDK

The various development components of the former Agentry mobile platform are now provided as a part of the SAP EAM and service mobile app SDK. This includes:

● The Agentry development server● The Agentry editor plug-in● The Agentry test environment● The Agentry client installers

Each of these components is installed and used in the same manner as they were within the Agentry mobile platform.


SAP Cockpit Replaces Agentry Administration Client

Almost all functions of the Agentry administration client are now handled by the SAP Cockpit. In addition to configuration settings for runtime behaviors of the application itself, this also includes the following functional areas:

● Server logging and log file management● Creating and managing clustered server environments● Backup and restore of former server-side resources

As mentioned previously, it is important for you to review the information provided with the SAP Mobile Platform , including guides and manuals, as well as any other publications, for information on these procedures and functional areas.

1.4 Additional Documentation on the SAP Mobile Platform

Note that there are many features and functions supported by the SAP Mobile Platform. The guides and other technical information provided with the SAP Mobile Platform have fully documented all of the functional areas. You can access this information on the SAP help portal (help.sap.com) by selecting the Mobile option, and then viewing information provided on the SAP Mobile Platform.

Following are some of the key areas of functionality, presented with the sections of the SAP Mobile Platform documentation that describes it.

Security

Security features, including SSL authentication certificates for user authentication, client-side data encryption, and other security features are available for configuration. Some are set by default and can be adjusted. Others, however, you will enable and configure others for your implementation environment. The following are sections where detailed information on security features can be found within the SAP Mobile Platform documentation.

● Guide: Security Administration Agentry Security● Agentry App Development: Security Related Development Overview

Application Administration

Administration of all mobile applications deployed within the runtime environment, including SAP Work Manager for Maximo, is accomplished using the SAP Cockpit. Administration includes cluster administration, security configuration, application administration, deployment, and several other tasks. The following lists some of the key sections on the SAP Cockpit. Read and become familiar with these topics, as and all of the topics available in this guide, as they may become pertinent later in your implementation.

● Guide: Administration Overview, sections of note:



http://help.sap.com

http://help.sap.com/saphelp_smp3011svr/helpdata/en/7c/2e19b670061014bab381e4c49a5380/content.htm?frameset=/en/7c/291afe700610148260f49a25a22839/frameset.htm&current_toc=/en/7c/1feb92700610148db1c136782f3f1f/plain.htm&node_id=323&show_children=true

http://help.sap.com/saphelp_smp3011sdk/helpdata/en/7c/1ae77d70061014bcd5db4714a2d5d4/frameset.htm

○ Getting Started with Management Cockpit○ Application Administration○ Security Administration○ Basic Deployment Model○ Managing and Monitoring Applications

Development and Customization

Included with the SAP Work Manager for Maximo application are the business logic and Java resources to modify the out of the box behavior of the application. These changes are made to the Agentry application project or by extending the Java logic provided for synchronization.


http://help.sap.com/saphelp_smp3011svr/helpdata/en/7c/30fb4670061014830e8bd7911bbef7/content.htm?frameset=/en/7c/1feb92700610148db1c136782f3f1f/frameset.htm&current_toc=/en/7c/1feb92700610148db1c136782f3f1f/plain.htm&node_id=70&show_children=false

http://help.sap.com/saphelp_smp3011svr/helpdata/en/7c/2fead2700610149a6cb250096017f9/content.htm?frameset=/en/7c/30fb4670061014830e8bd7911bbef7/frameset.htm&current_toc=/en/7c/1feb92700610148db1c136782f3f1f/plain.htm&node_id=72&show_children=false

http://help.sap.com/saphelp_smp3011svr/helpdata/en/7c/291afe700610148260f49a25a22839/content.htm

http://help.sap.com/saphelp_smp3011svr/helpdata/en/7c/2ce6f9700610148178cc350c7120eb/frameset.htm

http://help.sap.com/saphelp_smp3011svr/helpdata/en/7c/2a1dff70061014920aa1338fa67797/content.htm?frameset=/en/7c/2a3c6070061014bc14ea56b0ab4883/frameset.htm&current_toc=/en/7c/1feb92700610148db1c136782f3f1f/plain.htm&node_id=137&show_children=false

2 System Requirements

The system requirements for the SAP Work Manager for Maximo application are primarily driven by the requirements of the SAP Mobile Platform upon which it is deployed. The SAP Mobile Platform must be installed prior to installing the SAP Work Manager for Maximo application and all requirements of the platform must be met.


System Requirements

3 Deployment and Configuration

To implement and install the SAP Work Manager for Maximo system:

1. Verify that all system requirements have been met for each software component.2. Establish connectivity on the intended host system(s) for the SAP Work Manager for Maximo server

application(s) to allow the server to connect with the Maximo system. This includes connections for all system components within the application.

3. Install the Agentry Editor and configure the host system of the editor if needed. This can include installing necessary Java components or other development tools specific to the application. This also includes installation of the Agentry test environment.

4. Configure the SAP Work Manager for Maximo server application(s) for your environment and implementation needs.

5. Install the SAP Work Manager for Maximo application(s) to the SMP Cockpit. This can include both production and development servers, as well as multiple production servers in load balancing and failover environments.

6. Perform any post-installation tasks that may be necessary for the host system of the Agentry Editor.7. Install SAP Work Manager for Maximo client as needed to the various client devices.

3.1 Creating System Connections

Agentry SAP framework supports three different system connection types:

● SQL server● Oracle● DB2● Maximo Java interface

The Oracle, SQL server, or DB2 connection is used where the connection is dependant on the type of database implemented at the site.

A system connection encompasses the method in which the SAP Work Manager for Maximo server communicates with the Maximo database. The connection is either through the SQL server or Oracle client software, and through the Java interface provided with Maximo. Since each of these connections contain their own methodologies for updating and retrieving data, it is important to ensure the proper configuration of the host system on which the SAP Work Manager for Maximo server is installed.

3.1.1 Establishing Connectivity: Oracle Net Service Names

Prerequisites

Address the following items prior to performing this procedure:

SAP Work Manager For Maximo Installation GuideDeployment and Configuration C U S T O M E R 11

● Verify the proper version of the Oracle client software is installed to the intended host system for the SAP Work Manager for Maximo server.

● Gather the following information:○ Database Service Name: The service name or global database name of the database to which the SAP

Work Manager for Maximo server is to connect.○ Communications Protocol: The communications protocol to use in communications between the SAP

Work Manager for Maximo server and the Oracle database. May be one of TCP, TCPS, ICP, or NMP.○ Database Host Network Name: The network name of the host system for the Oracle database server.

This is needed only if the communications protocol used is TCP, TCPS, or NMP.○ Database Port Number: The port number used to communicate with the Oracle database server. This

value is only needed if the TCP or TCPS communications protocol is used.○ Pipe Name: The name of the pipe for the database service. This value is only needed if the NMP

communications protocol is used.○ SAP Work Manager for Maximo server Login and Password: The login and password to the database

that is used by the SAP Work Manager for Maximo server to connect with the database server.○ Desired Net Service Name: The net service name by which the connection created is identified by on the

SAP Work Manager for Maximo server’s host system.

Context

This procedure documents the creation of a net service name for use by an SAP Work Manager for Maximo server. When the SAP Work Manager for Maximo server connects with an Oracle database, the host system must have the Oracle client software installed. Using this software, an Oracle net service name is created for the target Oracle database with which the SAP Work Manager for Maximo server synchronizes data. This is accomplished using the Net configuration assistant within the Oracle client software package.

The following procedure uses the net configuration assistant as provided by version 9i of the Oracle client software. Those not familiar with this tool should review the Oracle documentation for the net configuration assistant and for creating net service names before proceeding.

Procedure

1. Start the Oracle net configuration assistant and select Local Net Service Name configuration.


Deployment and Configuration

Click Next to continue.2. Select Add to create the net service name.


Click Next to continue.3. Select the Oracle database version used in your environment.

Click Next to continue.4. Enter the database service name to which the SAP Work Manager for Maximo server will connect.



Click Next to continue.5. Select the appropriate communications protocol for your environment from those available in Oracle. Click

Help for further information on these protocols.


Click Next to continue.6. Enter the communications protocol-specific configuration information.

○ TCP or TCPS: Enter the Database Host Computer Name for the database to connect to. You must also enter the Database Port Number by entering its value or choosing to use the default value provided.

○ IPC: Enter the IPC Key value for the local Oracle database service.○ NMP: Provide the Database Host Computer Name. You must also enter the database pipe name or

choose the default pipe name provided.

Click Next to continue.7. Test the new net service name to verify all configuration options are correct and to validate the login and

password used by the SAP Work Manager for Maximo server.



Click Next to continue.8. Perform a test by following the instructions on the next screen. As an added test, change the login information

to use the login and password intended for use by the SAP Work Manager for Maximo server. Once the testing is complete, click Next to continue.

9. Enter the Net Service Name through which this connection is identified on the system. Be sure to note this name as it is needed to configure the SAP Work Manager for Maximo server to connect to the target database.


Click Next to continue.10. Complete the creation of the new net service name and close the wizard, or add another Net Service Name.



Select Yes to repeat this procedure. Select No to advance the wizard to the final screen, where the net service name creation process is completed.

11. Click Next on the final screen to complete the net service name wizard.

At this point the main options for the net configuration assistant utility are presented again. To close this utility, click Finish.

Results

When this procedure is complete, an Oracle net service name is created on the host system to which the SAP Work Manager for Maximo server will be installed. The server will use this net service name to connect to the database with which it will synchronize data for the mobile application.

Next Steps

Note the net service name created, as well as the login and password used by the SAP Work Manager for Maximo server to connect to the database instance. These values are needed when configuring the SAP Work Manager for Maximo server after it is installed.


3.1.2 Establishing Connectivity: SQL Server ODBC Connections

Prerequisites


● Install or verify the presence of the proper version of the MS SQL server ODBC drivers matching the version of the SQL server database to which the SAP Work Manager for Maximo server will connect.

● Gather the following information:○ DSN name: Determine and record the name for the DSN before the DSN is created. This is the name by

which the ODBC connection for the SQL server database is identified on the host system. It is needed when the SAP Work Manager for Maximo server is configured.

○ Server network name: The network name of the host system for the SQL server database.○ Login authentication method: When creating the DSN, the option is provided to validate a database

client’s login and password using either Windows NT authentication, or by using SQL server authentication. Determine the proper method before creating the DSN.

○ Login and password: If the login authentication method will be SQL server authentication, obtain the login and password of a valid database user. If the chosen login and password are not valid, it is not possible to create the DSN.

○ Default database: A DSN connection is made to a SQL server database server. It is likely this server has multiple database instances. Therefore, determine the proper database instance as it will be the default instance to which a database client connects when using the DSN created in this procedure.

○ Additional options: There are several options available within the Add System DSN wizard that do not usually need to be modified for SAP Work Manager for Maximo. However, if special circumstances in an implementation require changes to these options, make such determinations prior to creating the new DSN for the SAP Work Manager for Maximo server.

Context

This procedure describes the steps necessary to create an ODBC Data Source Name (DSN), used for connections to an MS SQL server database system. A DSN is created using the Add System DSN wizard provided in the data sources (ODBC) utility in Windows. This information is provided for reference purposes only. Those who are not familiar with this procedure or the concepts of ODBC should review documentation provided by Microsoft before proceeding.

Procedure

1. Open the data sources (ODBC) utility in Windows by navigating to Start Settings Control PanelAdministrative Tools Data Sources (ODBC) . Select the System DSN tab.



2. Click Add to start the Add System DSN Wizard.

Select the appropriate SQL server driver from the list and click Finish.3. Enter the desired DSN name and note this value for use during the SAP Work Manager for Maximo server

installation. Also enter a Description and Network Name in the fields provided.


Enter the server name or select one from those available on the network using the drop-down list for this field. Click Next to continue.

4. Select the authentication method for database clients using this DSN and, if SQL authentication is selected, the login and password for the SQL server database.

Remember that the login and password are only needed if the SQL server authentication method was selected. Click Next to continue.



5. Set the default database to the database with which the SAP Work Manager for Maximo server will synchronize data. In most cases the remaining options are left set to their defaults. It is recommended that these settings are changed only by an expert user that understands the purpose and resulting behavior of each setting and the overall needs of the implementation environment.

Click Next to continue.6. Set the final options as needed, based on the environment and administrative needs. These settings pertain

primarily to locality and logging. They should only be changed by someone familiar with their purposes. The SAP Work Manager for Maximo server does not impose any requirements on the settings for these items.


Click Finish to complete creating the new DSN and to test it.7. Click Test Data Resource to review the summary of the DSN configuration and perform a test.



Once the test has completed successfully, click OK to close this wizard and return to the Data Sources (ODBC) utility. The new system DSN is listed and available to database clients needing to connect to this database, including the SAP Work Manager for Maximo server.

Results

A new ODBC data source name is created. This DSN will be used by the SAP Work Manager for Maximo server to connect with the MS SQL server database.

Next Steps

Make note of the DSN value entered when creating the DSN. This value is needed when configuring the SAP Work Manager for Maximo server after it is installed. Also note the login and password information for SQL authentication (if selected) as this is needed by the SAP Work Manager for Maximo server.

3.1.3 Establishing Connectivity: IBM DB2 ODBC Connections

Prerequisites

The following items must be addressed prior to performing this procedure:

● Verify the proper ODBC driver for the IBM DB2 database with the Maximo schema is installed to the intended host system of the SAP Work Manager for Maximo server.

● Determine if a database alias already exists for the system to which the ODBC DSN will create a connection. If so, it may be reused here.

● If an alias does not exist, the following information should be gathered prior to beginning:○ User ID and password for the database○ The database name, host name, and port number for the Maximo database instance and the DB2 system

hosting it○ Where applicable, information specific to the OS/400 system hosting the DB2 system, possibly including

gateway information○ Any specific security settings for connections to the DB2 system or the Maximo database instance. Note

that there are no specific requirements for the SAP Work Manager for Maximo server’s default implementation, but there may be specific requirements based on the network environment where the system is installed.

○ Any CLI parameters and values that may need to be configured. Note that there are no specific requirements for the SAP Work Manager for Maximo server’s default implementation.


Procedure

1. Open the Windows ODBC Data Source Name (DSN) utility by selecting Start Settings Control PanelAdministrative Tools Data Sources (ODBC) .

This displays the main screen of the ODBC DSN Utility where new data source names can be configured and

created:2. Click Add to start the Create Data Source Wizard.



The driver selection screen is displayed:

3. Select the IBM DB2 ODBC DRIVER item in this list and click Finish.

The settings page for the DB2 driver displays:4. Enter a Data source name in the field provided. This value is used to name this data source on this system. It

will be provided to the SAP Work Manager for Maximo server after it has been installed as a part of configuring the connection to the DB2 database containing the Maximo schema. Next, if an alias exists that is suitable for this connection, select it from the drop down list for the Database alias field. If a suitable alias is available, click OK and skip the remaining steps of this procedure. Other wise create a new alias by clicking Add to the right of the Database alias field.


This displays the CLI/ODBC Settings screen, which contains multiple tabs:

5. Enter the following values in the Data Source tab:

○ Description: An optional description of the data source for future reference.○ User ID and Password: A valid user ID and password to the DB2 database with the proper permissions

for accessing the Maximo database instance.



Once these values are entered, select the TCP/IP tab:

6. Enter the following values in the TCP/IP tab:

○ Database name: The name of the Maximo database instance to which the SAP Work Manager for Maximo server will connect.

○ Database alias: The alias for the database instance.○ Host name: The name of the host system on which the DB2 system is running.○ Port number: The port number for the DB2 system open to the host system for the SAP Work Manager

for Maximo server.7. The remaining tabs for Security Settings and Advanced Settings may or may not require modification. The

SAP Work Manager for Maximo server has no specific requirements for these settings. These options should be set by or under the direction of the database administrator and/or network administrator for the implementation environment. Once all settings are entered, click OK to continue.


The new DSN is created and listed in the System DSN tab of the ODBC DSN utility:

Results

With the completion of this procedure, a new DSN is created on the local system. This DSN can be referenced by systems needing to connect to the DB2 system containing the Maximo database instance. It is referenced by the name entered for the Data Source Name, in this example “Maximo.”

Next Steps

When installation of the SAP Work Manager for Maximo server is complete, it will be necessary to configure its communications settings. The DSN just created is required information for those settings and will be referenced by the name given to it in this procedure. Note this name value for the procedure for configuring the SAP Work Manager for Maximo server’s database communications.

3.1.4 Establishing Connectivity: HTTP-XML

When the SAP Work Manager for Maximo server is to synchronize data with an HTTP server that returns XML data, little configuration is required prior to installing the SAP Work Manager for Maximo server. The configuration required involves access to the HTTP server. The specific tasks for this vary with each implementation and/or application.



Most of the tasks involved in connecting the SAP Work Manager for Maximo server to the HTTP server occur after the SAP Work Manager for Maximo server software is installed, during the configuration phase. Review the information provided for the SAP Work Manager for Maximo server installation and configuration for details on these post-installation tasks.

3.2 Installing the Maximo Java Interface

Prerequisites

SAP Work Manager for Maximo server uses Java to perform data synchronization between itself and the Maximo server.

The following is required for different machines:

● SAP Work Manager for Maximo server: Java 2 Software Development Kit (Java SDK) version 1.5 or higher● Windows 32-bit Machine: 32-bit JDK● Windows 64-bit Machine: 64-bit JDK

Procedure

1. Download the installer for the J2SE 1.5 or later and the JRE from the following address: http://www.oracle.com/technetwork/java/javase/downloads/index.html .

2. Download the correct JDK for your system.3. Run the Java SDK installer and the Java JRE installer. SAP Work Manager for Maximo recommends that you

accept all default values. If you install these components to a different location, be sure to note these locations.

3.2.1 Modifying the PATH Environment Variable

Context

Once the Java SDK and JRE are installed, two new paths for the JDK need to be added. The first path is for the bin directory of the JDK. The second path is for the bin directory of the JRE.

Procedure

1. Add the paths for the JDK and Java SDK to the Windows environment variables. For example: C:\Java\jdkl.5.0_06\bin;C:\Java\jdkl.5.0_06\jre\bin\server


http://help.sap.com/disclaimer?site=http://www.oracle.com/technetwork/java/javase/downloads/index.html

http://help.sap.com/disclaimer?site=http://www.oracle.com/technetwork/java/javase/downloads/index.html

When adding these values to the Path variable, be sure they are separated by a semicolon. SAP Work Manager for Maximo recommends that they are the first two paths in the string for this system variable.

2. If you selected different installation locations for these components, modify the paths accordingly.

3.2.2 Making the Maximo Java Classes Available

Context

This task must be performed whether or not the SAP Work Manager for Maximo server and Agentry Editor are installed to the same host system as the Maximo application. Perform these tasks in order to allow the SAP Work Manager for Maximo server and the Agentry Editor to use the Maximo Java interface.

Procedure

1. Extract the businessobjects.jar file from the Maximo Java interface maximo.ear file. You can open both *.ear and *.jar files using the WinZip application.

2. Place the extracted maximo.ear file, which is found on the host system for the Maximo web server in the following directory: C:\Maximo\deployment\default.

NoteThe maximo.ear file path is <Websphere Directory>\AppServer\profiles\<Maximo Profile Name>\installedApps\<Maximo Cellname>\MAXIMO.ear.

3. Extract the businessobjects.jar file and place it in the same file location as shown in the previous step.

NoteIf the businessobjects.jar file was installed to a different location, the maximo.ear file will be located in the deployment\default subdirectory of that location.

4. Copy the businessobjects.jar file to the host machines for both the SAP Work Manager for Maximo server and the Agentry Editor. If this is the same system, you only need to copy the file once. Note the location where the file is placed on both systems, as this information is needed for the SAP Work Manager for Maximo server installation procedure.

3.3 JavaBE.ini Properties

For Application Server Authentication on BEA Weblogic, use the Weblogic Value.

For Application Server Authentication on IBM WebSphere, use the WebSphere Value.

If not using Application Server Authentication, use the Native Auth Value.



NA indicates that the property should be deleted or commented out of the JavaBE.ini file.

The server property is not a new property but is included here for completeness.

● Property: maximoAuthenticationMethod○ Weblogic value: appserver○ WebSphere value: appserver○ Native auth value: native

● Property: server○ Weblogic value: NA○ WebSphere value: NA○ Native auth value: As defined previously in this guide

● Property: appServerType○ Weblogic value: weblogic○ WebSphere value: websphere○ Native auth value: NA

● Property: security.auth.login.config○ Weblogic value: ./jaas_client.conf○ WebSphere value: ./jaas_client.conf○ Native auth value: NA

● Property: naming.factory.initial○ Weblogic value: weblogic.jndi.WLInitialContextFactory○ WebSphere value: com.ibm.websphere.naming.WsnInitialContextFactory○ Native auth value:NA

● Property: maximo.jndi.rootContext○ Weblogic value: NA○ WebSphere value: Of the form cell/nodes/<node-name>/servers/<maximo-servername> where

<maximo-servername> is the name of the application server on which the Maximo application is running and <node-name> is the name of the node on which the <maximo-servername> is running. Both the Maximo application server name and node name can be found in the WebSphere administrative console by viewing Servers Application Servers .

○ Native auth value: x● Property: maximo.jndi.ejb.accesstoken

○ Weblogic value: NA○ WebSphere value: ejb/maximo/remote/accesstokenprovider○ Native auth value: NA

● Property: com.ibm.CORBA.ConfigURL○ Weblogic value: NA○ WebSphere value: Of the form file:<AppClientDir>/properties/sas.client.props where

<AppClientDir> is the full path to the local directory where the WebSphere pluggable application client is installed. This path is specified as an absolute path using drive letters, forward slashes, and no quotation marks as in the following example:file:C:/Program Files/IBM/WebSphere/AppClient/properties/sas.client.props

○ Native auth value: x● Property: naming.provider.url


○ Weblogic value: Of the form iiop://<hostname>:<port-number> or t3://<hostname>:<port-number> where <hostname> is the Maximo server fully qualified hostname or IP address and <port-number> is the TCP port through which web browsers connect to Maximo. Note that this port is not the same as the RMI registry port used for native authentication.

○ WebSphere value: Of the form iiop://<hostname>:<port-number> where <hostname> is the Maximo server fully qualified hostname or IP address and <port-number> is the TCP port configured as the bootstrap address for the node agent controlling the node under which the Maximo application server is running. The port number should match the BOOTSTRAP_ADDRESS property of the node agent that controls the Maximo application server. Open the Websphere administrative console and navigate to

System administration Node agents , find the name of the node that runs the Maximo application and click its link. On the Node agents detail screen, open Ports and find the BOOTSTRAP_ADDRESS host and port. By default the port for the deployment manager is 9809.

○ Native auth value: NA● Property: java.text.AppServerAuthenticationError

○ Weblogic value: Error authenticating to application server %for user %s. Can be modified if required.○ WebSphere value: NA○ Native auth value: NA

3.4 Installing the Work Manager Application

Prerequisites

Address the following items prior to installing the SAP Work Manager for Maximo:

● The SAP Mobile Platform 3 must have been installed and an Agentry application defined within it. To define an Agentry application within this environment, see the documentation for the SAP Mobile Platform 3 on help.sap.com, specifically the topic Creating Agentry Application Definitions.

Context

This procedure describes the steps to install the SAP Work Manager for Maximo application to the SAP Mobile Platform runtime environment, as well as making it available for import into the Eclipse workspace as an Agentry application project.

When this procedure is complete, it will be necessary to perform initial configuration of the SAP Work Manager for Maximo. Specifically, configuration options related to communications between the SAP Work Manager for Maximo clients and the Agentry application must be set within the SAP Mobile Platform runtime environment.

Overall within this procedure you will run the applicable executable file for the application and run the configuration tool provided with the application to set the implementation-specific configuration options.

The following files are used in the implementation of this application. However, not all files are used for a given installation. Read the descriptions in the list to determine which is needed for your environment:

● SAPWorkMgrMx810Deployment.exe: The Maximo Work Manager application for Windows deployments of the SAP Mobile Platform Runtime environment.



http://help.sap.com

http://help.sap.com/saphelp_smp235/helpdata/en/6c/cadb45845f1014aa5bd30b1cdeeb95/frameset.htm

NoteIf you are running SAP Mobile Platform 3 on Linux, run the installation in Windows, produce the .zip file and then use the SAP Mobile Platform Server Admin UI to publish to the Linux-based SMP3 (see Step 8).

Procedure

1. Double-click the appropriate .exe file for the SAP Mobile Platform runtime environment with the options related to the add-on component.

2. Launch the appropriate deployment executable for the SAP Work Manager for Maximo.

The Welcome screen is displayed.3. Click Next to continue the installation.

The SAP Connectivity Information screen displays.4. Enter the name of the IBM Server. Enter the Client Number and System Number the SAP Work Manager for

Maximo will use to communicate with the IBM Application server. Click Next to continue.

The User Information screen displays.5. Enter the Service User Name and Service User Password. This is an administrative user established as a proxy

for all users.6. If you are using push notifications, you must check the Enable Push check box and then enter the Push User

Name and Push User Password. Again, this is an administrative user established as a proxy for all users. In most cases, this can be the same user name and password as the service user. Click Next to continue.

TipThe Service User Password and Push User Password values entered in the previous steps are stored by the installer in the JavaBE.ini configuration file as plain text values, making them human readable. It is highly recommended that these values are secured using the Encrypt Password utility provided with the SAP Work Manager for Maximo. Instructions on this task are provided later in this procedure.

The Java Backend Information screen displays.7. Change the default values for the Java back end class paths only if you want to point the server to a different

SAPjco3.jar file or a different runtime environment. Click Next to continue.

The Choose Install Location screen displays.8. To specify the destination directory for the deployment .zip file, either enter the path manually or click Browse

and select the location in the File Explorer dialog. Click Install to proceed with the installation. You should be able to see the deployment .zip file (i.e., SAPWorkMgrMx810Deployment....zip) in the directory specified above. Click Finish to close the configuration application when the final screen is displayed.

NoteIf you are running SAP Mobile Platform 3 on Linux, run the installation steps 1-8 on Windows, then use the SAP Mobile Platform 3 Administrator user interface (Cockpit) to publish to the Lunux-based SAP Mobile Platform 3 server.


9. Open the SAP Mobile Platform 3 administrator user interface (Cockpit) and publish the deployment .zip file. For more information on the Cockpit, see SAP Mobile Platform 3 documentation.

The SAP Work Manager for Maximo is now published and can be immediately accessed by clients.10. Install the SAP Mobile Platform 3 certificate on the clients and perform an initial sync to the SAP Mobile

Platform 3 server using the appropriate server url.

Results

The SAP Work Manager for Maximo application is now ready to be deployed to the SAP Mobile Platform runtime environment. It includes the application as delivered by SAP and the configuration settings in support of the communications between the mobile application and the SAP system. The contents of the folder from which this archive was created can also be used as an import source to create an Agentry application project within the Eclipse workspace containing the Agentry Editor plug-in.

Next Steps

Deploy the application to the SAP Mobile Platform runtime environment, specifically to the defined Agentry application within the runtime. For details on this procedure see the information provided with the SAP Mobile Platform, including the sections Deploy and Deploying Agentry Application Files to an Existing Application.

3.5 Administration Scripts

As part of the SAP Work Manager for Maximo server installation, there are several administration scripts, located in sql\admin, which is a sub-folder of the SAP Work Manager for Maximo server installation folder. These scripts drop, create, and modify the various database objects needed for SAP Work Manager for Maximo within the Maximo database. There are numerous scripts contained in this folder, not all of which may need to be run. This determination is based on the current environment, including any current versions of SAP Work Manager for Maximo as well as the existence of any other Agentry SAP framework products.

Within the SAP Work Manager for Maximo, there are two levels of database objects:

The first level is the base level. These objects are those that are common to all SAP mobile suite products. If any one of the products within this suite are installed, the base objects must exist. Subsequent installation of other products within the suite will also use these objects.

The second level contains the application-specific objects. These are database objects that are created and used only by one specific product. These objects will only exist within the database if the application to which they pertain has been installed.

The following is a list of all of the scripts contained within the admin folder of the SAP Work Manager for Maximo server.



http://help.sap.com/saphelp_smp235/helpdata/en/ee/0cfde735594455933c6f8a45ef7c86/frameset.htm

http://help.sap.com/saphelp_smp235/helpdata/en/6c/cbbaca845f1014b8e9acb5fa6d6c93/content.htm

NoteIn all of the script names, substitute DB with either Oracle or SQL Server, depending on the platform for a specific implementation.

● dropSycloBaseDB.sql: Drops the base database objects for the SAP Work Manager for Maximo. This includes any and all objects that are common to all of the products within this suite.

● createSycloBaseDB.sql: Creates the base database objects. These objects should only be created once, even if multiple SAP Work Manager for Maximo applications are being implemented.

● modifySycloDefaultValues01DBType.sql: Sets the correct default values for Syclo objects in the Maximo configuration tables. The integrity check will fail if this script is not run.

● modifySycloDefaultValues01DBType.sql: Sets the correct default values for Syclo objects in the Maximo configuration tables. The integrity check will fail if this script is not run.

3.5.1 Running the Installation Scripts for the SAP Work Manager for Maximo Application

Context

When installing a new SAP Work Manager for Maximo server, there is a series of administration scripts that need to be run against the Maximo database. These scripts are located in the installation directory of the SAP Work Manager for Maximo server. For a default installation location, this path is:

C:\<SAP Product>\ServerProd\sql\admin\

All scripts are named to match the database type. The SAP Work Manager for Maximo server installer only installs the scripts written for the database type for which the installer was created. In the following steps, the portion of the script file names listed as DbType is replaced in the actual scripts with one of Oracle, SqlServer, or DB2.

NoteIf you are localizing the application using the multi-language method as found in the section Multi-Language Localization Method in this guide, running the populate script will lose, or orphan, any multi-language translations set up in Maximo against the domain.

Procedure

1. Log into a SQL query tool matching the database system type for the implementation. Be sure to log in as a user with administrative privileges capable of creating and modifying database objects within the system. The safest login is as the database owner for the Maximo database. All scripts executed in this procedure should be executed against the Maximo database instance.

2. Open and execute the script createSycloBaseDbType.sql.

This script creates database objects common to all mobile applications.


3. Open and execute the scripts modifySycloDefaultValues01DbType.sql and modifySycloDefaultValues02DbType.sql.

These scripts set the correct default values for objects in the Maximo configuration tables.

Next Steps

If it is necessary to remove the items created by the administration scripts described in this procedure, run the scripts beginning with drop in the file name, found in the same location. Do not run the script dropSycloBaseDbType.sql in implementation environments where multiple Work Manager applications have been implemented and where you are only removing the database objects for one of those applications.

3.5.2 Applying the Configuration Changes

Context

In order to keep Maximo table attributes in sync with SAP Work Manager for Maximo attributes, the SAP Work Manager for Maximo administration scripts will populate three Maximo data dictionary configuration tables:

● MAXOBJECTCFG● MAXTABLECFG● MAXATTRIBUTECFG

Use the following steps to complete the configuration change process.

Procedure

1. Refresh the index by running Refresh Index Tables.2. For Maximo 8.x:

a. Navigate to the Database Configuration page.b. Run Apply Configuration Changes.

3. Restart the Maximo application server.



4 Importing the SAP Work Manager for Maximo Project into the Eclipse Workspace

Prerequisites


● The components of the Agentry Toolkit form the SAP Mobile SDK must be installed prior to performing this procedure. This includes both the Agentry Editor plug-in to Eclipse as well as the SAP Mobile Platform development server.

● The SAP Work Manager for Maximo application must have been installed to a location accessible to the host system of Eclipse.

● Verify the workspace in which you are importing the project is the currently opened workspace in Eclipse.● Determine a name for the project as it will be listed in the Eclipse workspace, as this is required information

entered in the import process.

Context

This procedure describes the steps needed to import the SAP Mobile Platform development server application into the Eclipse workspace as an Agentry application project. If you are unfamiliar with the import process for Agentry applications, see the Developing Agentry Apps manual in the SAP Mobile Platform documentation, specifically the section on Agentry Application Projects: Creating, Managing, and Publishing, which includes sections on import functionality as well as detailed steps on the procedure.

Note that this process excludes any related projects for the source application that may reside in that source project’s workspace, such as Java development projects and related packages. Import these related projects and components according to the process that matches that project type, using tools found in Eclipse.

This procedure will result in the creation of an Agentry application project within the Eclipse workspace for the SAP Work Manager for Maximo application. This project is imported form the installation location of the application.

Procedure

1. Open one of the Agentry Editor perspectives in Eclipse. Then right-click an empty area in the Project Explorer View and select the menu item Import. Alternately, select the menu item File Import in the Eclipse main menu.

The Select Import Source screen displays.

SAP Work Manager For Maximo Installation GuideImporting the SAP Work Manager for Maximo Project into the Eclipse Workspace C U S T O M E R 39

http://help.sap.com/saphelp_smp306sdk/helpdata/en/7c/055a4370061014af4ab9a522acd7c7/content.htm?frameset=/en/7c/1a0090700610148ca483de28cd24e6/frameset.htm&current_toc=/en/7c/01cda6700610149b10c2f2a86d335b/plain.htm&node_id=4268&show_children=false

http://help.sap.com/saphelp_smp306sdk/helpdata/en/7c/1a0090700610148ca483de28cd24e6/content.htm?frameset=/en/7c/1a0932700610149866af68760b3cd5/frameset.htm&current_toc=/en/7c/01cda6700610149b10c2f2a86d335b/plain.htm&node_id=4283&show_children=false

2. On this screen are the different import sources for Eclipse. Select the item Agentry Project From Agentry Server . Click Next to continue.

The Select Source screen displays.3. On this screen, the information entered is dependent on the source type selected in the previous step. Enter

the information according to the following:a. For the Agentry Server field, click Browse and navigate to the location where the SAP Work Manager for

Maximo executable resides.b. The Source Application box will display a single item and be left as-is.c. The Application Name is the value of the Application definitions name attribute. Set this to the desired

value, preferably to SAP Work Manager for Maximo.d. The Project Name is the name for the project within the Eclipse workspace. This must be a unique project

name for the workspace and white space is allowed.e. The Development Server (optional) is the SAP Mobile Platform development server. Select the installation

location of this component.4. Verify the information entered is accurate and complete. Click Finish to initiate the project import.

A new project is created by importing the definitions from the selected import source. The project is listed in the Project Explorer View and is automatically opened.

Results

After this process is complete, the new project for the SAP Work Manager for Maximo application is added to the Eclipse workspace. The project is opened and displayed in the Agentry Perspective within Eclipse. The application name and project name match those values entered in the Import wizard.

Next Steps

The Java resources of the application can be included in a Java project in the same workspace of Eclipse.


Importing the SAP Work Manager for Maximo Project into the Eclipse Workspace

5 Installing the SAP Work Manager for Maximo server Client

You can install the SAP Work Manager for Maximo server client on Windows, Android, and iOS devices.

5.1 Attached Documents Client-Side Security

Any documents that are uploaded using the SAP Work Manager for Maximo application are stored in the Maximo back end. These documents can either be found as an object or as a link in the SAP Document Management System.

While doing an upload of documents from the local device or downloading documents to your local device, the application does not perform a virus scan of the documents. It is therefore important to ensure that you use a third party virus scanner to upload and download virus free attachments. Another alternate is to implement the SAP Virus Scan Interface (VSI). The VSI allows customers to easily embed an external certified virus scanner of their choice. See Note 599541 for which languages and platforms are supported and where to get further guidance on implementing the SAP VSI.

5.2 Installing the SAP Work Manager for Maximo client for Windows CE

Prerequisites

The SAP Work Manager for Maximo client for Windows CE requires that the Windows CE device is connected to the PC using ActiveSync or My Mobiler. Make this connection using the device’s docking station or through a network connection.

Context

The SAP Work Manager for Maximo client Installer for mobile versions of Windows will install the appropriate build of the Client for the target client device. Certain options are selected as a part of this installation procedure related to the type of device. These options all pertain to scanner-enabled devices. All other information concerning the specific version of Windows and the processor type of the client device is determined automatically by the installer.

SAP Work Manager For Maximo Installation GuideInstalling the SAP Work Manager for Maximo server Client C U S T O M E R 41

Procedure

1. Launch the installer executable file from the installation CD.

The Welcome screen displays.2. From the Welcome screen, click Next to begin installing the SAP Work Manager for Maximo client.

The License Agreement screen displays.3. Review the License Agreement and click I Agree to continue.

The Choose Components window displays.4. Select the option that matches your device. If your device is not equipped with a built in scanner, check No

scanner. If not equipped with a camera, select No camera. Click Install to continue.

The Installation window displays, showing the progress of the installation to the mobile device.5. The application downloading is complete. Click OK to continue.

The application windows close. Check your client device for further instructions6. Check the target device for any additional steps. Click OK to complete the installation.

Some devices require confirmation for the installation. Actions vary depending on device.

The Installation wizard finishes the installation of the SAP Work Manager for Maximo client. When the installation is complete, the InstallShield Wizard Complete screen displays.

7. Click Finish to complete the installation.

Results

The SAP Work Manager for Maximo client is installed on your mobile device.

Next Steps

You must synchronize the newly-installed SAP Work Manager for Maximo client with the SAP Work Manager for Maximo server containing the published application that will be deployed to users. You can do this, or the intended user of the application can perform this action. The user ID and password information entered during this initial transmit are stored as the user’s credentials for the device going forward. If a different user ID and password is entered, a user change takes place, along with the resulting behavior of that change.


Installing the SAP Work Manager for Maximo server Client

5.3 Installing the SAP Work Manager for Maximo client on Windows

Procedure

1. Launch the WPF installer executable.

The Welcome screen displays.2. Click Next to begin installing the SAP Work Manager for Maximo client.

The License Agreement displays.3. Click Yes on the License Agreement screen to accept the terms and to continue the installation.

The Scanning Option screen displays.4. Select whether or not the target device for the Client contains barcode scanning hardware. This is currently

only supported on Panasonic Toughbook systems. Click Next to continue.

The Client Destination Location Window displays.5. Specify a folder to install the SAP Work Manager for Maximo client. To change the default folder, click Browse

and navigate to the desired folder. Click Next to continue.

The Shortcuts window displays.6. Select the desired shortcuts and click Install to begin installation.7. When the installation is complete the Wizard Complete screen displays. Click Finish to complete the

installation.

Results

The SAP Work Manager for Maximo client is installed on the system.

Next Steps

You must synchronize a newly installed SAP Work Manager for Maximo client with the SAP Work Manager for Maximo server containing the published application that is deployed to users. You can synchronize now or the intended user of the application can perform what is called the initial transmit. The user ID and password information entered during the initial transmit is stored as the user’s credentials for the device going forward. If a different user ID and password is entered, a user change takes place along with the resulting behavior of that change.


5.4 Installing the SAP Work Manager for Maximo Client on Apple iOS and Android Devices

Prerequisites

NoteOnly iOS 9.x and 10.x devices are supported by the SAP Work Manager for Maximo client.

The SAP Work Manager for Maximo client for Apple products requires that the device is connected to a computer with iTunes installed. The mobile device must be able to connect to the iTunes library to download the client application. Android devices must be able to connect to Google Play to download the client application.

Context

Apple iOS: To install the SAP Work Manager for Maximo client, perform a search in the Apple App Store through the device itself.

If you are not installing through the device using the Internet, plug your device into a desktop or laptop computer with a connection to iTunes. Make sure the computer with iTunes has downloaded a copy of the SAP Work Manager for Maximo client. When the device is synced with iTunes on the desktop or laptop computer, the SAP Work Manager for Maximo client is installed on the target client device. All information concerning the specific version and processor type of the client device is determined automatically by the installer.

Android: To install the SAP Work Manager for Maximo client, perform a search in Google Play through the device itself.

Procedure

1. Apple iOS: Open the App Store and search on “SAP Work Manager for Maximo client” to pull up the most current application and tap Install.

2. Android: Open Google Play and search on “SAP Work Manager for Maximo client” to pull up the most current application and tap Install.

Results

The SAP Work Manager for Maximo client is installed on your mobile device.


Installing the SAP Work Manager for Maximo server Client

Next Steps

Synchronize the newly installed SAP Work Manager for Maximo client with the SAP Work Manager for Maximo server containing the published application that is deployed to users. You can synchronize the application, or the intended user of the application can perform this action. The user ID and password information entered during this initial transmit are stored as the credentials of the user for the device going forward. If a different user ID and password is entered, a user change takes place, along with the resulting behavior of that change.


6 Installation Troubleshooting

Use the topics in this section to assist you in troubleshooting your application.

6.1 Verifying Version Information

Client Version

Version information for the Windows build of the SAP Work Manager for Maximo client is found in the about.txt file. The about.txt file is located in the directory where the client is installed.

For iOS and Android clients, the version can be obtained by viewing the About screen, displayed by the client.

6.2 SAP Work Manager for Maximo Server to Maximo Connection Issues

If you used the connectivity test after installing and configuring the SAP Work Manager for Maximo server, connectivity problems can manifest as error messages when you start the server, or as connect test failures.

If errors occur, first check the events log. The event log is the primary troubleshooting tool for connectivity issues. The events log lists either the Maximo-specific error code or SAP Work Manager for Maximo-specific error message.

After installing the SAP Work Manager for Maximo server and configuring the connection with your back-end system, if the connection test fails, or you received an error when starting the SAP Work Manager for Maximo server, perform the following checks:

1. Verify that the Java classpath in Agentry.ini is correct.2. Verify that the Windows environment PATH variable is correct.3. Try to connect to the back-end system from the SAP Work Manager for Maximo server using the SAP GUI.

Verify the user name and password used to connect are correct.4. Ensure that the client version and the back-end system version numbers are correct.


Installation Troubleshooting

6.3 SAP Work Manager for Maximo Server to SAP Work Manager for Maximo Client Connection Issues

A client connectivity problem will manifest as a not all data transmitted, logging request failed message on the client.

If this occurs, check the events log. The events log is the primary troubleshooting tool for connectivity issues. The events log lists all Maximo-specific and SAP Work Manager for Maximo-specific error messages.

Login Request Failed

This error message results when the client device is not communicating with the SAP Work Manager for Maximo server. To troubleshoot the above error message:

1. Make sure that the SAP Work Manager for Maximo server is running.2. If the server is not started, you will see the logging in message for a minute and eventually get this error.3. Check the events log to make sure that the SAP Work Manager for Maximo server has not lost its Maximo

connection. Check for the following network issues:

● Time-outs and TCP/IP issues: Troubleshoot network● Wireless network issues: Troubleshoot wide area network● Firewalls: Ensure that configured ports are open for the IP addresses of the clients

Incorrect User ID or Password

This error is seen on the mobile device when an incorrect user ID or password is used. View the error in the events.log file located in the install directory of the SAP Work Manager for Maximo server.

To fix the problem, have the technician use the correct password.

Failure to Connect to the Server (3)

This error is received when the SAP Work Manager for Maximo client fails to connect to the SAP Work Manager for Maximo server or an established connection is lost. Because a connection to the server was not made or was lost, there will not be an entry in the events.log file.

A common cause of this error is that a client’s network connection is not established or is severed. If this error is received during transmit, note that some data may have already been updated to the back end system.

To fix the problem, re-establish the client device’s network connection and perform another transmit. Any data not sent during the previous transmit will be sent during the next successful transmit, and will be listed in the transmit dialog of the SAP Work Manager for Maximo client.

SAP Work Manager For Maximo Installation GuideInstallation Troubleshooting C U S T O M E R 47

Communication Error (14)

This error is received when the SAP Work Manager for Maximo client cannot communicate with the SAP Work Manager for Maximo server. Because there is a problem communicating with the server, there is not an entry in the events.log file. Common causes of this error are:

● The SAP Work Manager for Maximo server service is not started● The network connection is not working properly● The device has production logic on it and is now trying to connect to the SAP Mobile Platform development

server. This is shown in the events.log file.

To fix the problem:

● Start the SAP Work Manager for Maximo server service.● Disconnect, then re-establish a network connection.

6.4 Message Codes

All communication between the SAP Work Manager for Maximo server and the SAP Work Manager for Maximo client are logged to a log file on the server named messages.log. A transmission from the SAP Work Manager for Maximo client to the SAP Work Manager for Maximo server is made up of many individual messages. Each message goes through several states as it is processed by the SAP Work Manager for Maximo server. A single line is written to the messages.log for each state of each message per user.

The log file is located in the directory where the SAP Work Manager for Maximo server was installed. If the server was installed in the default directory, it can be found here for the SAP Work Manager for Maximo production server:

C:\SAP Work Manager ForMaximo\ServerProd\Logs

The messages log is stored in the following location for the SAP Mobile Platform development server:

C:\SAP Work Manager ForMaximo\ServerDev\Logs

Message Codes

Table 1:

Code Number Code Message / Description

1 SystemInfoRequestRC

2 LogoutRequestRC: Client logout from server




3 Login Request: Client login from server

5 LogoutNoticeRC: The server decided to log the user out (the user timed out, the server or the app is shutting down, an administrator disconnected the user, etc.)

6 ResetRequestRC

7 ChangePasswordRequestRC: Client attempt to change password

8 PublicKeyRequestRC

11 DecryptKeyRequestRC

12 UploadE2ETraceRequestRC

13 PasswordValidationAuditRecordNoticeRC

200 Object Transaction: Client send of a single transaction to the server

201 Object Fetch: Client request for a fetch to be run by the server and the result objects to be sent to the client

202 Client System Info Notice: Client-specific information sent to server such as client hardware, OS, screen size, etc.

203 Object Refresh: Client request for server to send updated copy of an object

204 Object Definition Request: Client request for an Agentry object definition

205 Fetch Definition Request: Client request for an Agentry fetch definition

206 Transaction Definition Request: Client request for an Agentry transaction definition

207 Screen Set Definition Request: Client request for an Agentry screen set definition

208 Action Definition Request: Client request for an Agentry action definition

209 Rule Definition Request: Client request for an Agentry rule definition

210 Report Definition Request: Client request for an Agentry report definition

211 Object Push: Server send of objects and/or messages sent to the client

212 Enable Push: Sent by client to enable push for this user on the server

213 Style Definition Request: Client request for an Agentry style definition

622 Complex Table Request: Client request for all Agentry complex table updates

623 Data Table Update Request: Client request for all Agentry data table updates. The formatting of <TEXT> following a is not supported. Wrap the <TEXT> that follows in a .


Error Codes

Table 2:


0 NoFailure: No failure, not worth mentioning

1 UnknownFailure: A catch-all failure error code

2 NotLoggedIn: Client thought it was logged in, but the server did not think it was logged in

3 GrapevineCreateFailed: An attempt to create a grapevine failed

4 ChangingMediums

5 MediumConnectFailed

6 MediumNotAvailable

7 AttemptCancelled

8 MessageCancelled

9 TimedOut

10 NoEscalateGroupName

11 GrapevineDisconnectedUnexpectedly

12 ReceiverCoudNotDecode: The message receiver could not understand the message

13 ReceiverException

14 CommunicationError

<no code number> AuthenticationError

<no code number> PasswordChangeFailed

<no code number> PasswordChangeFailedAccountBlocked

Push Message States

Table 3:

State Name Description

O Outgoing Message in process of being sent to client




T Trying Attempting to connect to client

L Linked Successfully connected to client

W Waiting Failed attempt to connect to client, will retry

R Received Response Client response received by server

S Sent response Server sent information and/or acknowledgement to the client

C Complete Message complete

X Cancelled Message cancelled by server

F Failed Message failed, will not retry. The formatting of <TEXT> following a is not supported. Wrap the <TEXT> that follows in a .

Message States

Table 4:


I Incoming Message in process of being received from client

Q Queued Message has been decoded, user has been identified, and the message is placed in one of the server’s work queues

S Sent response Server sent information and/or acknowledgement to the client

R Received Response Client response received by server

C Complete Message complete. The formatting of <TEXT> following a is not supported. Wrap the <TEXT> that follows in a .


7 Security for SAP Work Manager for Maximo

For general information regarding security settings for SAP Work Manager for Maximo, see the SAP Mobile Platform Security Administration guide, particularily:

● Security Related Development Overview


Security for SAP Work Manager for Maximo

http://help.sap.com/saphelp_smp306svr/helpdata/en/7c/291afe700610148260f49a25a22839/frameset.htm

http://help.sap.com/saphelp_smp306svr/helpdata/en/7c/291afe700610148260f49a25a22839/frameset.htm

http://help.sap.com/saphelp_smp307sdk/helpdata/en/7c/1ae77d70061014bcd5db4714a2d5d4/content.htm

8 Global Definitions and Default Values in SAP Work Manager for Maximo

Contained in this chapter is a listing of the global definitions and their default values within the SAP Work Manager for Maximo Agentry application project. A global definition defines a constant value, including the data type, for the application. This value can be referenced throughout the application, both by the attributes of other definition types and for use in synchronization components. A global value cannot be changed on the Client at run-time but can be overridden during synchronization.

You can change the value of a global within the application project and then publish it to the SAP Work Manager for Maximo server. This is a more permanent change than overriding the value through synchronization.

Overriding or modifying a global’s value is done to make a change to the application’s behavior. This can include a change to a display value, enabling or disabling entire functionality sets, or other changes in different degrees of significance.

The list provided here is intended to serve multiple purposes. First, it provides a brief description of each global’s purpose and area of use. Second, it provides a documented listing of the default values of the global definitions as provided by SAP Work Manager for Maximo, so that it is possible to revert a modified global back to its original value, if necessary.

8.1 Global Default Values

The following table provides the default global definitions and default values for the SAP Work Manager for Maximo application, as provided by SAP.

Group Name Default Value Description

Application AgentryDecimalSeparator . Decimal separator used by Agentry to store client data. Used for international display and rule math.

Application LocalDecimalSeparator . Local decimal separator. Used for display and rule math.

Assets Status DECOMMISSIONED Statuses not allowed to be brought down to handheld. Values need to be comma-separated.

Calibration enabled [checkbox] If true, then calibration screens and scripts are available.

SAP Work Manager For Maximo Installation GuideGlobal Definitions and Default Values in SAP Work Manager for Maximo C U S T O M E R 53


DatabaseField assignmentField supervisor Database field used for workorder assignment. Used in the following SQL queries: evalWorkorderIsInterrupted, findInterruptedWorkorders, findNewWorkorders and getWorkorderDetails.

DatabaseField otRateField otRate Database field used for OT rate used in updateActLabCost.sql.

DatabaseField Owner dbo. Prefix. Required for SQL server user-defined functions.

DatabaseField payrateField payrate Database field used for the normal payrate. Used in insertAddLabor.sql.

DatabaseField storeRoomField storeroom Database field value for locationS.type for storerooms.

Jobplan canAddJPFollowupWorkorder

[checkbox] Allows the user to add a follow-up work order, including a job plan from the current work order’s job plan.

Jobplan JobPlanActualPartListHeader Actual Parts [no description available]

Jobplan JobPlanActualToolListHeader

Actual Tools [no description available]

Jobplan JobPlanLaborListHeader Labors Used in the header of the job plan labor list screen.

Jobplan jobPlanNoMeasStopWOType [none] List of work order types that require all job plan readings to be taken. The user cannot complete a work order where all job plan readings have not been entered. This is a semicolon-separated list (i.e., ‘PM;CM;EM’).

Jobplan JobPlanPlannedPartListHeader

Planned Parts [no description available]

Jobplan JobPlanPlannedToolListHeader

Planned Tools [no description available]

Jobplan JobPlanRequestListHeader Requests [no description available]

Jobplan stepComplete Completed String to display on detail screen when a step has been marked as complete.

Jobplan FilterByStep [checkbox] [no description available]


Global Definitions and Default Values in SAP Work Manager for Maximo


Jobplan followupWoDesc * The default description of a follow-up work order. If *, the existing work order description is used.

Jobplan followupWoType CM The default work type of a follow-up work order.

Labor canAddAddlTechs [checkbox] When recording time against a work order, the technician with the device can choose additional technicians and charge their time against the current work order.

Labor trackWorkorderLaborHrs Value [checkbox] If true, will keep track of the duration in which the work is in a STARTed state.

LaborDflt otScale [none] The default overtime scale to use in labor reporting screens.

LaborDflt workType WORK The default value of work type used when creating time entries.

Lngth assetDescription 100 Length of ASSET.DESCRIPTION.

Lngth Assetnum 15 Length of ASSET.ASSETNUM.

Lngth assignmentDescription 100 [no description available]

Lngth Attribute 50 Length of an AssetAttrid for Classifications.

Lngth AttributeDefaultValue 100 Used by Classifications.

Lngth AttributeDescription 100 Description of the Asset Attribute used by Classifications.

Lngth AttributeType 1 Asset attribute type abbreviation length used for Classifications.

Lngth binnum 8 Length of INVBALANCES.BINNUM

Lngth ClassHierarchy 100 Syclo-defined limit for Classification hierarchy string.

Lngth ClassificationID 50 Used for Classification component enhancements.

Lngth classStructureID 20 [no description available]



Lngth company 12 Length of COMPANIES.COMPANY

Lngth companyName 50 Length of COMPANIES.NAME

Lngth companyType 1 Length of COMPANIES.TYPE

Lngth contractNum 8 [no description available]

Lngth Decimals 2 Number of decimal places to display.

Lngth failurecode 8 Length of FAILURELIST.FAILURECODE

Lngth failurecodeDescription 100 Length of FAILURECODE.DESCRIPTION

Lngth failureType 12 Length of FAILURELIST.TYPE

Lngth itemDescription 100 Length of ITEM.DESCRIPTION

Lngth itemnum 30 Length of ITEM.ITEMNUM

Lngth JobLaborId 30 Sum of lengths of WPLABOR.SITEID, WPLABOR.WONUM, JOBLABOR.JPTASK, WPLABOR.LABORCODE

Lngth JobOperationID 22 Sum of lengths of WORKORDER.SITEID, WORKORDER.WONUM, WORKORDER.JPTASK

Lngth jobplanDescription 100 Length of JOBPLAN.DESCRIPTION

Lngth jobTaskDescription 100 Length of JOBTASK.DESCRIPTION

Lngth JPAssetsplinkID 32 Sum of lengths of JPASSETSPLINK.JPNUM, JPASSETSPLINK.LOCATION, JPASSETSPLINK.ASSETNUM, JPASSETSPLINK.SITEID

Lngth jpnum 10 Length of JOBPLAN.JPNUM

Lngth laborcode 8 Length of LABOR.LABORCODE

Lngth laborName 62 Length of PERSON.DISPLAYNAME

Lngth laborType 16 Length of LABOR.TYPE

Lngth location 12 Length of LOCATIONS.LOCATION




Lngth locationDescription 100 Length of LOCATIONS.DESCRIPTION

Lngth locationID 16 To get unique records displayed in the location tree, we need to concatenate a location code and its parent. This constant should be the length of LOCATIONS.LOCATION X 2.

Lngth longDescription 1000 The number of characters to download from the longdescription Idtext field. This was set to 256.

Lngth lotnum 8 Length of INVBALANCES.LOTNUM

Lngth mailSubject 50 Length of subject for mail messages.

Lngth MaximoIntegerIdentifier 20 String representation of a Maximo Integer Unique ID.

Lngth maxValue 25 Length of SYNONYMDOMAIN.MAXVALUE

Lngth measurementType 10 [no description available]

Lngth MeterDescription 100 Length of a meter description

Lngth MeterDomainid 18 Length of a meter domain ID. Used in rounds, WM meters, and classifications.

Lngth metername 10 MeterName field from the meter table.

Lngth MeterUOM 8 Length of a meter UOM. Used in WM meters and classifications.

Lngth MultiAssetLocComments 250 Maximum comments length allowed.

Lngth notes 200 Length of notes allowed to be entered on the client.

Lngth NumDomainValue 16 String used to hold a decimal value from Maximo.

Lngth origid 8 Length of ORIGID in all MAXIMO tables.

Lngth PartsID 72 Sum of lengths of INVBALANCES.ITEMNUM, INVBALANCES.LOCATION, INVBALANCES.BINNUM,



INVBALANCES.LOTNUM, INVBALANCES.SITEID

Lngth PhoneNum 20 Max length

Lngth pointname 15 Length of MEASUREPOINT.METERNAME

Lngth pointnum 8 Rounds pointnum field from measurepoint table.

Lngth premiumPayCode 8 Length of premiumpay.premiumpaycode.

Lngth premiumpayDescription 100 Length of premiumpay.description

Lngth ReadingDecimals 3 The number of decimals allowed for job plan measurements.

Lngth Route 8 Length of a route.

Lngth RouteDescription 100 Length of a route description

Lngth serialnum 15 Length of ASSET.SERIALNUM

Lngth SiteClass 30 Calculated column (ClassStructureID + SiteID + 1) used for classifications.

Lngth siteid 8 Length of SITEID in all MAXIMO tables.

Lngth skillLevel 15 [no description available]

Lngth status 16 Length of WORKORDER.STATUS

Lngth stockType 16 Length of INVENTORY.CATEGORY

Lngth StructureDescription 100 Length of a ClassStructure description. Used in Classifications.

Lngth StructureID 20 length of ASSET.CLASSSTRUCTUREID. Used in CT-Asset-Data.sql

Lngth syclonotes 100 [no description available]

Lngth toolDescription 100 Length of ITEM.DESCRIPTION

Lngth toolID 16 Length of ASSETNUM + SITEID

Lngth toolnum 30 Length of ITEM.ITEMNUM




Lngth valuelistDescription 30 Length of SYNONYMDOMAIN.VALUE

Lngth vendor 12 [no description available]

Lngth WindowsCaptionWidth 15 The caption width of a Win32 screen field.

Lngth wonum 10 The length of WORKORDER.WONUM

Lngth WorkLogSummary 100 Max Length

Lngth workorderDescription 100 Length of WORKORDER.DESCRIPTION

Lngth workType 5 Length of WORKORDER.WORKTYPE

Lngth workTypeDescription 58 Length of WorkType, WTypeDesc + 3

Locations Status DECOMMISIONED [no description available]

Log automaticType WORK Value to be written for automatically generated work log entries. This value should match a value from the LOGTYPE Maximo synonym domain.

Log automaticViewable [checkbox] Flag determining if automatically generated work log entries are created in Maximo with their viewable property set to True.

Log defaultType CLIENTNOTE Value that appears in the Add Work Log screens for the Type field when those screens are first entered. This value should match a value from the LOGTYPE Maximo synonym domain.

Log defaultViewable [checkbox] Setting determines if the Viewable field in the Add Work Log screens is checked or not when those screens are first entered.

Log enable [checkbox] Enable/disable work log functionality. Setting to False causes application to revert to legacy work order notes support.

Mail delivered Delivered Status for a mail record that has been delivered to a



recipient. Used in MarkMailRecieved.sql.

Mail expirationDays 30 The number of days an old mail message will remain on the server. Used in DeleteOldMail.sql.

Mail Messages Messages [no description available]

Mail replyPrefix re: The prepended string to add to the subject on a reply.

Mail sent Sent Status for local mail messages that have been sent to the server.

Mail undelivered Undelivered Status for a mail record that has yet to be delivered to the recipient.

Mail unread Unread Status for new, unread mail messages.

Mail unsent Unsent Status for locally created, unsent mail messages.

Mail viewMail View Mail Label for mail action when there is no mail pending.

Maximo AdjustTimeZone From System Connection Local Time

[no description available]

Maximo ALNAttributeClient A Value representing an ALN attribute in the type property of the CT.

Maximo ALNString ALN Maximo indicator that the attribute is ALN.

Maximo approved APPR Status code for an approved work order. Used in workorderReceivedAll.sql

Maximo ClassificationSpecsUse [checkbox] Whether specifications are shown on the client. Also controls whether certain related CTs are even populated: ALNAttributeDomain, NumAttributeDomain, AssetAttribute.

Maximo ClassificationUse [checkbox] Whether classifications should be shown on the mobile client.

Maximo Close CLOSE Status code for a closed work order. Used in




evalWorkorderIsComplete.sql, getWoHistDetailsAll.sql.

Maximo Complete COMP Status code for a completed work order. Used in WorkordersStepHandler.java, evalWorkorderIsComplete.sql, getWoHistDetailsAll.sql.

Maximo DownloadAllAssignments [checkbox] [no description available]

Maximo FalseString N [no description available]

Maximo Frozen FROZEN Status code for a frozen work order. Used in Workorder.java, getWorkorderDetails.sql.

Maximo Hold HOLD Status code for a work order on hold.

Maximo inprg INPRG Status code for an in progress work order. Used in workorderReceivedAll.sql, woStatusReceivedAll.sql, WorkordersStepHandler.java.

Maximo jobPlanStepComplete X String to be displayed indicating a job step plan has been completed.

Maximo jobPlanStepInComplete [none] String to be displayed indicating that a job plan step has not yet been completed.

Maximo labtransTypeWork WORK Database value for maxvalue field for the record where listname = ‘LTTYPE’ and value = ‘WORK’. Used in CT-LTType-Data.sql, CT-LTType-Deleted.sql.

Maximo MeterReadingHistoryLimitDays

30 The maximum number of days from which to receive historical readings for meters. A value of 0 indicates there should be no limit and to retrieve historical meter readings for all time.

Maximo NUMERICAttributeClient N Value representing a NUMERIC attribute in the Type property of the CT.

Maximo NUMERICString NUMERIC Used in Maximo to indicate a NUMERIC attribute type.

Maximo OneValue 1 Used by classifications.



Maximo problem PROBLEM String for failure type PROBLEM. Used in CT-Failure-Data.sql.

Maximo received RECEIVED Status string of a work order that has been received on a Client. Used in getWorkorderDetails.sql, worderReceivedAll.sql, WorkordersStepHandler.java.

Maximo remedy REMEDY Used for failure type REMEDY. Used in CT-Failure-Data.sql, getWoHsitDetailsAll.sql.

Maximo start STARTED Status code of a work order that has been started on the client.

Maximo transfer TRANSFER Status code for a transferred work order.

Maximo useAssignmentManager [checkbox] If true, look for assigned work orders in the ASSIGNMENT table, rather than in the WORKORDER table. Otherwise, look in the WORKORDER table using the field defined in <<databaseField.assignmentField>>. Used in WorkordersStepHandler.java, evalWorkorderIsInterrupted.sql, findInterruptedWorkorders.sql, findNewWorkorders.sql, getWorkorderDetsils.sql, workorderReceifedAll.sql.

Maximo UseStatusIcons True [no description available]

Maximo version 7 The backend Maximo version to which this application is connecting.

Maximo WAPPR WAPPR Waiting for approval status. Used in workorderReceivedAll.sql, woStatusReceivedAll.sql.

Maximo WMATL WMATL Waiting for material status. Used in workorderReceivedAll.sql, woStatusReceivedAll.sql.

Maximo woApprovedStat 'APPR', 'INPRG', 'STARTED', 'RECEIVED', 'HOLD'

Comma separated list of work order statuses that will




be considered for downloading to the Client. Used in evalWorkorderIsInterrupted.sql, findInterruptedWorkorders.sql, findNewWorkorders.sql, unfreezeWorkorders.sql.

Maximo woHistDetailsWorkType 'EM', 'CM' Comma separated list of work order work types for which work order history will be retrieved during download. Used in getWoHistDetailsAll.sql.

Maximo WSCH WSCH Waiting to be scheduled status. Used in workorderReceivedAll.sql, woStatusReceivedAll.sql.

Nuclear enabled [checkbox] If true, enables support for MAXIMO Nuclear.

Parts allowUnknownParts [checkbox] Enables the option for the user to select ‘Nonstock Parts’ when adding parts to a work order.

Parts defaultNonStockItem NONSTK The default value of the name used for the part number when adding a nonstock part.

Parts nonstock NONSTOCK Value for item type of items not under inventory control.

Parts useParts [checkbox] Allows the user to add parts to a work order.

Rounds Enabled [checkbox] Set to false by default. When imported into SAP Work Manager for Maximo, it gets set to true.

Rounds NoteEnabled [checkbox] Set to false by default. When imported into SAP Work Manager for Maximo, it gets set to true.

Rounds SequenceEnabled [checkbox] Set to false by default. When imported into SAP Work Manager for Maximo, it gets set to true.

ScreenLayout ColumnSizeHeaderButton 10 [no description available]

ScreenLayout ColumnSizeHeaderOneButton

90 [no description available]



ScreenLayout ColumnSizeHeaderThreeButtons


ScreenLayout ColumnSizeHeaderTwoButtons


ScreenLayout ColumnStartHeaderButtonOne


ScreenLayout ColumnStartHeaderButtonThree


ScreenLayout ColumnStartHeaderButtonTwo


ScreenLayout ColumnStartHeaderLogo 1 [no description available]

Text AdjustTimeZone To System Connection Local Time

[no description available]

Text AssetLabel Asset: Short prefix for Assetnum fields displayed in rules.

Text Assignments Assignments [no description available]

Text BlankSpace [none] [no description available]

Text completeConflictA There was a conflict when tech

Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text completeConflictB tried to COMPLETE wo# Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text completeConflictC The following information was not posted to Maximo:

Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text completeConflictD Start Date: Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text completeConflictE Finish Date: Partial text string used in constructing a notification message about a work order transaction that has a




problem to be resolved. Used in msg.Complete.sql.

Text completeConflictF Duration: Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text completeConflictG Cause: Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text completeConflictH Remedy: Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text completeConflictI Note: Partial text string used in constructing a notification message about a work order transaction that has a problem to be resolved. Used in msg.Complete.sql.

Text DescLabel Desc: Label for description fields used in update rules.

Text DetailsCaptionPrefix Details for Prefix for an item that has sub-screens under it (ex: Safety plan hazards and precautions).

Text EmptyString [blank] [no description available]

Text FalseValue False [no description available]

Text Hazards Hazards Used in the header for safety plan hazards screens.

Text Histories Histories Used in the header for work order histories.

Text holdConflictA There was a conflict when tech #

Partial text string used in constructed a notification message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text holdConflictB tried to HOLD wo# Partial text string used in constructed a notification



message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text holdConflictC The following information was not posted to Maximo:

Partial text string used in constructed a notification message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text holdConflictD Start Date: Partial text string used in constructed a notification message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text holdConflictE Finish Date: Partial text string used in constructed a notification message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text holdConflictF Duration: Partial text string used in constructed a notification message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text holdConflictG Reason: Partial text string used in constructed a notification message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text holdConflictH Note: Partial text string used in constructed a notification message about a work order transaction that has a problem to be resolved. Used in msgHold.sql.

Text InvalidLogin Invalid Login Test to show the user when the log in provided is not valid.

Text JobPlanHeaderPrefix WO # The tring prepended to the work order number.

Text JobPlanStepDetailsCaptionPrefix

, Step # Text prepended to the job plan step number in the caption on an HPC screen.




Text jobReceived job received String used as a comment in the WOSTATUS table when a work order is received on the Client. Used in woStatusReceivedAll.sql.

Text Location LOCATION String used to display value ‘Location’. Used in ct-MeasSearchValues-Data.sql.

Text LocLabel Loc: Short prefix for location labels.

Text Mandatory MANDATORY String to preface mandatory specifications.

Text maxConflictCallSubject Maximo Conflict! Call Dispatch.

Partial text string used in constructing a notification message about a work order transaction that has a problem to resolve. Used in msgPleaseCall.sql.

Text maxConflictSubject Maximo Conflict! Partial text string used in constructing a notification message about a work order transaction that has a problem to resolve. Used in msgComplete.sql, msgHold.sql, mxgXfer.sql.

Text maxJobConflictSubject Maximo Conflict on job Partial text string used in constructing a notification message about a work order transaction that has a problem to resolve. Used in msgConflict.sql.

Text MeterReadings Meter Readings [no description available]

Text Meters Meters [no description available]

Text needsXmitIndicator * Shows a character after the string to indicate that there are pending transactions.

Text no N Simple abbreviation for ‘no’.

Text None -NONE- String used for displaying NULL or unselected values.

Text NoneDescriptionForClass No Classification [no description available]

Text NotApplicable N/A [no description available]

Text reason Reason Used to indicate why a work order was transferred. Used in WorkordersStepHandler.java.



Text separator - Visual separator between displayed key and value pairs.

Text SiteDescription Site Used in Classification CTs

Text Specifications Specifications [no description available]

Text StepPrefix - Step String to display in job plan headers

Text Steps Steps Used in the header for job plan step lists.

Text TimeSummaryCaptionPrefix Labor for WO# The header caption for work order time summaries.

Text transferConflictA There was a conflict when tech #

Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgXfer.sql.

Text transferConflictB tried to TRANSFER wo# Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgXfer.sql.

Text transferConflictC The following information was not posted to Maximo:

Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgXfer.sql.

Text transferConflictD Reason: Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgXfer.sql.

Text transferConflictE Note: Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgXfer.sql.

Text TransferTo Transfer To String to prepend in front of a labor code that goes in the long description to indicate that a workorder has been transferred to that person. See appendLongDescriptionXfer.




sql to see this constant in context. Used in WorkorderStephandler.java.

Text TrueValue True [no description available]

Text updateConflictA There was a conflict Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgConflict.sql, MsgPleaseCall.sql.

Text updateConflictB when tech # Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgConflict.sql, MsgPleaseCall.sql.

Text updateConflictC tried to update wo# Partial text string used in constructed a notification message about a workorder transaction that conflicts with some server side data. Used in MsgConflict.sql, MsgPleaseCall.sql.

Text WorkLogs Work Logs Used in the work order log list screens.

Text WorkorderDetailsCaptionPrefix

Details for WO # Text that is prepended on HPC work order detail screens.

Text workOrders Work Orders The name of the main objects in the work orders modules.

Text woTransferredSubjectA WO# Partial text string used in constructed a notification message about a workorder that has been transferred. Used in msgXferMotice.sql.

Text woTransferredSubjectB Transferred by dispatch Partial text string used in constructed a notification message about a workorder that has been transferred. Used in msgXferMotice.sql.

Text woTransferredTextA WO# Partial text string used in constructed a notification message about a workorder that has been transferred. Used in woTransferredTextA.sql.



Text woTransferredTextB has been transferred off your schedule. if this is a problem, please call Dispatch.

Partial text string used in constructed a notification message about a workorder that has been transferred. Used in woTransferredTextA.sql.

Text yes Y Simple abbreviation for ‘Yes’.

TileList FieldColumns 50 Number of columns for a generic field.

TileList HeightPPC 7 Height of PPC screen tile list.

TileList ListTileRowAdjustment -8 [no description available]

TileList ListTileRowAdjustmentWinThirtyTwo

-5 [no description available]

TileListLayout ColumnSizeExpandArrow 7 [no description available]

TileListLayout ColumnSizeFourColumns 23 [no description available]

TileListLayout ColumnSizeFourColumnsThreeFields


TileListLayout ColumnSizeImageTileFourColumns


TileListLayout ColumnSizeImageTileImage 9 [no description available]

TileListLayout ColumnSizeImageTileOneColumn


TileListLayout ColumnSizeImageTileThreeColumns


TileListLayout ColumnSizeImageTileThreeColumnsTwoFields


TileListLayout ColumnSizeImageTileTwoColumns


TileListLayout ColumnSizeOneColumn 93 [no description available]

TileListLayout ColumnSizeThreeColumns 31 [no description available]

TileListLayout ColumnSizeThreeColumnsTwoFields


TileListLayout ColumnSizeTwoColumns 46 [no description available]

TileListLayout ColumnStartExpandArrow 94 [no description available]

TileListLayout ColumnStartFieldOne 1 [no description available]

TileListLayout ColumnStartFourOfFour 71 [no description available]

TileListLayout ColumnStartImageTileFieldOne


TileListLayout ColumnStartImageTileFourOfFour





TileListLayout ColumnStartImageTileThreeOfFour


TileListLayout ColumnStartImageTileThreeOfThree


TileListLayout ColumnStartImageTileTwoOfFour


TileListLayout ColumnStartImageTileTwoOfThree


TileListLayout ColumnStartImageTileTwoOfTwo


TileListLayout ColumnStartThreeOfFour 48 [no description available]

TileListLayout ColumnStartThreeOfThree 63 [no description available]

TileListLayout ColumnStartTwoOfFour 25 [no description available]

TileListLayout ColumnStartTwoOfThree 32 [no description available]

TileListLayout ColumnStartTwoOfTwo 48 [no description available]

TileListLayoutIphone ColumnSizeImageTile 12 Image was getting cut off on iPhone.

TileListLayoutIphone DetailFieldWidthOneFieldIphone


TileListLayoutIphone LabelColumnStartAfterStatusImage

12 Starting point after making space for status icon.

TileListLayoutIphone LabelWidthFour 4 Label width of 4

TileListLayoutIphone TileHeaderSmartColumnRowHeightIphone


TileListLayoutIphone TileHeaderWidthIphone 100 [no description available]

TileListLayoutIphone TileSelectedColumnWidthAfterLabels

82 Width of field after label.

TileListLayoutIphone TileSelectedLabelWidth 6 [no description available]

TileListLayoutIphone ValueIsOne 1 A lot of size and row values are set to 1. This is a generic global.

Timesheet expirationDays 30 The number of days past to pull labor reporting information. Used in findUserTimeEntries.sql, findUserTimeEntriesToRemove.sql.

Timesheet PayPeriods Pay Periods [no description available]

Timesheet TimeEntries Time Entries [no description available]



WO canChangeFailure [checkbox] Allows the user to change the failure when completing a work order.

WO canEditFailure [checkbox] Allows the user to change the failure when editing a work order.

WO canEditWorkOrders [checkbox] Allows the user to edit selected fields in a received work order.

WO canTransfer [checkbox] Allows the user to transfer a work order.

WO downloadActions 'A', 'X', 'R', 'F' A comma separated list of action codes that will be considered for downloading to the Client. Used in gets...sql.

WO DowntimeCodes DOWNCODE List of possible downtime codes for an asset.

WO enableMultiAssetLocCi [checkbox] Turn on or off Multiple Asset Location CI functioanlity.dsds

WO useFailure [checkbox] Allows the user to input failure information when creating or completing a work order.

WO useHistory [checkbox] Allows the user to view history on the work order.

WO useSafetyPlan [checkbox] Allows the user to view a safety plan attached to a work order.

WoDflt holdReason [none] The default reason to put a work order on hold. Any value here should match valid keys in the HoldReasons data table.

WoDflt xferCraft [none] The default value to use for craft when transferring a workorder. If no value is provided, the craft group of the current user will be used.

WoDflt xferReason [none] The default reason to transfer a work order. Any value here should match valid keys in the TransferReasons data table.

WoLocal canCreate [checkbox] Allows the user to create a field work order on the Client.




WoLocal canStart [checkbox] Allows the user to start a work order created on the Client.

WoLocal localWoPrefix LOCAL_ Internal prefix used when creating Client-side work orders.

WoLocal newProblemRequired [checkbox] A problem must be entered on a new field-generated work order.

WoLocalDflt Craft [none] The default craft group to use when creating a field work order. If no value is entered, the default will be the craft group of the current user.

WoLocalDflt Priority 3 The default priority to use when creating a field work order.

WoLocalDflt Type [none] The default work type to use when creating a field work order.


9 Data Protection and Privacy

Describes the specific features and functions that SAP provides to support compliance with data protection legal requirements and data privacy.

Data protection is associated with numerous legal requirements and privacy concerns. In addition to compliance with general data privacy acts, it is necessary to consider compliance with industry-specific legislation in different countries.

This section and any other sections in this Security Guide do not give any advice on whether these features and functions are the best method to support company-, industry-, regional-, or country-specific requirements. Furthermore, this guide does not give any advice or recommendations with regard to additional features that would be required in a particular environment; decisions related to data protection must be made on a case-by-case basis and under consideration of the given system landscape and the applicable legal requirements.

NoteIn the majority of cases, compliance with data privacy laws is not a product feature. SAP software supports data privacy by providing security features and specific data protection-relevant functions such as functions for the simplified blocking and deletion of personal data. SAP does not provide legal advice in any form. The definitions and other terms used in this guide are not taken from any given legal source.

Glossary

Table 5:

Term Definition

Personal data Information about an identified or identifiable natural person.

Business purpose A legal, contractual, or in other form justified reason for the processing of personal data. The assumption is that any purpose has an end that is usually already defined when the purpose starts.

Blocking A method of restricting access to data for which the primary business purpose has ended.

Deletion Deletion of personal data so that the data is no longer usable.

Retention period The time period during which data must be available.


Data Protection and Privacy

Term Definition

End of purpose (EoP) A method of identifying the point in time for a data set when the processing of personal data is no longer required for the primary business purpose. After the EoP has been reached, the data is blocked and can only be accessed by users with special authorization.

CautionThe extent to which data protection is ensured depends on secure system operation. Network security, security note implementation, adequate logging of system changes, and appropriate usage of the system are the basic technical requirements for compliance with data privacy legislation and other legislation.

User Consent

SAP Work Manager for Maximo does not provide separate consent management, as only work-related data, such as work orders, notifications and readings are created by the app users. This data collection is covered by the employment contract as it is directly related to the daily work of the employees. Before using any device capabilities, such as the camera or photo library, the user is asked for consent by using the mobile capabilities.

Sensitive Person-Related Data

SAP Work Manager for Maximo is not designed to store sensitive person-related data. Therefore, there is no logging of sensitive person-related data.

Displaying Person-Related Data

All person-related data for SAP Work Manager for Maximo is retrieved to the mobile device based on the user ID of the user. Personal data includes user ID, name, phone number, and e-mail address of the technician or technicians assigned to the work orders and operations.

Change Log for Person-Related Data

User IDs that are stored for transactions cannot be changed once they are transmitted to the Maximo back end system. You can view all transactions on the Maximo back end system.

SAP Work Manager For Maximo Installation GuideData Protection and Privacy C U S T O M E R 75

GeoLocation Data

If configured, when the user starts SAP Work Manager for Maximo for the first time, and begins work on a maintenance order for an asset, they are asked interactively if they want to allow the application to use geolocation. The geolocation functionality does not collect, store, or use the geolocation data for any reason other than to show the route to the respective assets on the map.

9.1 Data Protection Aspects

Provides an overview of data protection aspects involved within the SAP Work Manager for Maximo application.

NoteFor a complete guide to Agentry security, see the SAP Mobile Platform Sever Guide, section " "Security Administration | Application Security | Agentry Security".

SAP Work Manager for Maximo is a business application for business-owned devices. A unique device ID, or GUID, is generated for each client device logging into the destination server through the URL of the server. The user ID can only connect to one device at a time.

Personal Data

Technicians log into the application through a client device with their user ID and password. While their user ID is stored in plain text on server logs and on the client, their password is encrypted and is not stored on the client. The client stores a one way hash of the password. The server validates the password of the user against the back end, where it is stored.

Data is then retrieved from the server based on their user ID and associated profile and sent to the client application so they can perform their tasks. The user ID is written to transactional data.

The Push User and the Service User, when configured upon application installation, have passwords that are viewable in the JavaBE.ini file. Administrators should encrypt these passwords.

History Data of User Input

Dates recorded are transaction times. The user ID is written for transactional data and is available for viewing in plain text in the server logs.



Application Logs

Active and saved user IDs are written in plain text to the xxx-smp-server.log. The push and service user IDs are written in plain text to the JavaBE.ini file. Because these IDs are written in plain text, limit dissemination and viewing of these files to administrators of the application.

9.2 Deletion of Person-Related Data

A user cannot delete individual, replicated, person-related, protected data that originates from Maximo in SAP Work Manager for Maximo.

If the user deletes the SAP Work Manager for Maximo application from the mobile device, or performs a reset of the application, performing those actions delete all person-related protected data in their local data store.

End of Purpose (EoP) Check

An end of purpose check determines whether data is still relevant for business activities based on the retention period defined for the data. The retention period of data consists of the following phases:

● Phase one: The relevant data is actively used.● Phase two: The relevant data is actively available in the system.● Phase three: The relevant data must be retained for other reasons.

If an object is deleted by a user or by the synchronization job, it is blocked but still available in the database.Blocking of data prevents the SAP Work Manager for Maximo users from displaying and using data that may include person-related data and is no longer relevant for business activities.

Blocking of data can impact system behavior in the following ways:

● Display: The system does not display blocked data.● Change: It is not possible to change blocked data.● Create: It is not possible to create objects connected to a blocked project or work package.● Search: It is not possible to search for blocked data.

Deletion

Time sheet data is deleted from Maximo by authorized processes. Timesheet data is displayed for 30 days by default in SAP Work Manager for Maximo. Timesheet records older than 30 days are removed from the device upon synchronization. The retention period for timesheets is configurable by the system administrator.

Users can request the removal of their person-related data from SAP Work Manager for Maximo any time through their system administrators.

Uninstalling the app follows the standard process for your type of mobile device, and requires no special handling. When the app is uninstalled, all locally stored data is deleted as well.

SAP Work Manager For Maximo Installation GuideData Protection and Privacy C U S T O M E R 77

You must manually delete the agentryDB for WPF (Windows Presentation Foundation) and Windows Mobile applications, which both use Agentry clients.



Important Disclaimers and Legal Information

Coding SamplesAny software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence.

AccessibilityThe information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does not apply in cases of willful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.

Gender-Neutral LanguageAs far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.

Internet HyperlinksThe SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see: http://help.sap.com/disclaimer).

SAP Work Manager For Maximo Installation GuideImportant Disclaimers and Legal Information C U S T O M E R 79

http://help.sap.com/disclaimer/

go.sap.com/registration/contact.html

© 2017 SAP SE or an SAP affiliate company. All rights reserved.No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice.Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.Please see http://www.sap.com/corporate-en/legal/copyright/index.epx for additional trademark information and notices.

https://go.sap.com/registration/contact.html

https://go.sap.com/registration/contact.html

http://www.sap.com/corporate-en/legal/copyright/index.epx

http://www.sap.com/corporate-en/legal/copyright/index.epx