GE Digital APM Connect - Asset Performance Management

GE Digital APM Connect
GE Digital APM Connect
Data Loaders UDLP V2.2.0, Maximo UDLP V2.2.0, SAP UDLP V2.2.0, EAM SAP PI V2.0.0
Copyright © 2017 General Electric Company. All rights reserved. • Page 1 of 495
Copyright and Legal
GE Digital APM Connect
Data Loaders UDLP V2.2.0, Maximo UDLP V2.2.0, SAP UDLP V2.2.0, EAM SAP PI V2.0.0
© 2017 General Electric Company.
GE, the GE Monogram, and Predix are either registered trademarks or trademarks of
General Electric Company. All other trademarks are the property of their respective
owners.
This document may contain Confidential/Proprietary information of General Electric
Company and/or its suppliers or vendors. Distribution or reproduction is prohibited
without permission.
THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO
REPRESENTATION OR WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO WARRANTIES OF DESIGN, MERCHANTABILITY, OR
FITNESS FOR A PARTICULAR PURPOSE. ALL OTHER LIABILITY ARISING FROM RELIANCE
UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLY DISCLAIMED.
Access to and use of the software described in this document is conditioned on acceptance of the End User License Agreement and compliance with its terms.
Copyright © 2017 General Electric Company. All rights reserved. • Page 2 of 495
About This Document
About This Document
This file is provided so that you can easily print this section of the GE Digital APM Help
system.
You should, however, use the Help system instead of a printed document. This is
because the Help system provides hyperlinks that will assist you in easily locating the
related instructions that you need. Such links are not available in a print document
format.
The GE Digital APM Help system can be accessed within GE Digital APM itself or via the
GE Digital APM Documentation Website (https://www.meridium.com/secure/documentation/WebHelp/Home.htm).
Note: If you do not have access to the GE Digital APM Documentation Website, contact GE Global Support (https://www.ge.com/digital/asset-performance-management).
Copyright © 2017 General Electric Company. All rights reserved. • Page 3 of 495
Table of Contents
Table of Contents
GE Digital APM Connect
1
Copyright and Legal
2
About This Document
3
Table of Contents
4
APM Connect System Requirements
11
Deploy APM Connect
16
Deploy the APM Connect Base
17
Deploy the APM Connect Base for the First Time
18
Upgrade the APM Connect Base to V2.0.0
21
About the APM Connect Installation Package
22
Run the Third-Party Software Batch File
23
Run the APM Connect Installer
25
Change and Encrypt the APM Connect Service User Names and Passwords
42
Import the Karaf File into the APM Connect Administration Center
44
Install and Start the APM Runtime Container
45
Install the Meridium Integration Services
48
Enable Internet Explorer for APM Connect
50
Update PostgreSQL Networking Configuration
51
Change the PostgreSQL Passwords
52
Access the APM Connect Administration Center
53
Change the APM Connect Administration Center User Password
57
Validate the APM Connect Administration Center License
58
Configure the APM Connect Administration Center
61
Set User Permissions
64
Authorize Users for Projects
67
Create a Service Account User
69
Configure Logging
73
Configure the APM Connect Administration Center for the Studio
75
Copyright © 2017 General Electric Company. All rights reserved. • Page 4 of 495
Table of Contents
Install the Studio
78
Uninstall APM Connect
81
Set Java Environment Variables
82
Import Adapter Jobs
84
Delete a Job
90
Deploy the Data Loaders
91
Deploy the Data Loaders for the First Time
92
Upgrade APM Connect Data Loaders to UDLP V2.2.0
93
Configure SSL
94
Set Permissions for APM Connect Directory
97
Deploy and Configure Data Loader Files
104
Deploy and Configure the APM_UPDATE_LOGIC Webservice
107
Create the Intermediate Repository Database
108
Enable Test Connection
110
Change H2 Console Password
111
Create APM Service User
113
Deploy the Maximo Adapters
114
Deploy Maximo Adapters for the First Time
115
Upgrade Maximo to UDLP V2.2.0
116
Maximo Interfaces Security Groups
117
Configure SSL
119
Configure the Maximo Context File
120
Maximo Context File Parameters
121
About Site Reference Configuration via the autojoin_control Table
136
The autojoin_control Table
137
Encrypt Passwords
139
Import Notification Management File
140
Configure Context Parameters
141
Create the Intermediate Repository Database
143
Configure Site Reference Values
145
Copyright © 2017 General Electric Company. All rights reserved. • Page 5 of 495
Table of Contents
Create Object Structures in Maximo
147
Create Web Services in Maximo
153
Configure the Default Password
154
Set System Properties Settings for Web Service Response
155
Create EAM System Records
156
Deploy the SAP Adapters
157
Deploy the SAP Adapters for the First Time
158
Upgrade SAP Adapters to SAP UDLP V2.2.0
161
Configure the Context File Directory
162
Configure the Context File Directory for Multiple SAP Systems
163
Install SAP Java Connector
164
Configure SSL
165
Configure the Context File
166
Encrypt Passwords
199
Configure Context Parameters
200
Configure the Context Parameters for APM Now
203
Configure Site Reference Values
205
About Site Filtering Configuration via the autojoin_control Table
209
Mount a File Share
211
About File Shares and APM Connect
220
Establish SFTP Transfer in SAP
222
Create File Share Folder Structure
223
Install the ABAP Base Service Pack Add-on
224
Verify ABAP Installation
228
Uninstall the ABAP Base Service Pack Add-on
230
Create APM Connect User Profile in SAP
232
SAP Interfaces Security Groups
234
Identify Trigger Values for Creating Task Records
236
Configure GE Digital APM to Create Notifications from Recommendation
Records
237
Copyright © 2017 General Electric Company. All rights reserved. • Page 6 of 495
Table of Contents
Deploy and Configure the RFC Connector Files
238
Deploy and Configure the RFC Connector Configuration File
241
Configure Notification Priority
242
Create an EAM System Record
243
Test the Connection Defined in an EAM System Record
246
Create the Intermediate Repository Database
247
Run the Static Data Job
249
Configure SAP Task and Confirmation Creation
250
Configure the Query Get Tasks for Work Order Generation
252
Schedule Work Orders
253
Identify Classifications to Extract
255
About Classification Hierarchies
256
Identify Characteristics to Extract
260
About Extracting Characteristics
261
Import Notification Management File
262
Deploy the SAP PI Adapters
263
Deploy the SAP PI Adapters for the First Time
264
Upgrade the SAP PI Adapters to EAM SAP PI V2.0.0
265
About Site Filtering Configuration in the Context File
266
Import Notification Management File
268
Import the Design Objects
269
Import the Configuration Object
271
Modify the Baseline Communication Channels
273
Activate the RFCReceiver_SAP Object
275
Add Entries to the /MIAPM/TASK_CNF Table
277
Define the Command Name in SAP
281
Install the SAPCAR File on the APM Connect Server
282
Create SAP PI Directory Structure
283
Deploy the Automatic Data Loader Job
284
Set up the Automatic Data Loader Job
Copyright © 2017 General Electric Company. All rights reserved. • Page 7 of 495
285
Table of Contents
Configure the Context File
286
About the Automatic Data Loader Job
288
The Automatic Data Loader Directories
289
Overview of APM Connect
291
Overview of the EAM Adapters
292
About Time Zone Data
293
EAM Adapter Workflow
295
Overview of the SAP Adapters
296
Employ the Notification Management Adapter
297
Create an SAP Notification from a Recommendation Record
298
Update an SAP Notification from a Recommendation Record
300
Employ the Work Management Adapter
301
Work Management Workflow
302
Create a Task Record
304
Create an Event Record or Inspection Record
306
Close a Work Order
307
Update an SAP Confirmation by Updating the Actual Work Time in a Confirmation Record
309
Validate SAP Confirmations Against GE Digital APM Confirmation Records
310
Manage Filter Parameters in the Context File
312
Apply Common Filter Parameters
313
Apply Equipment Filter Parameters
317
Apply Functional Location Filter Parameters
320
Apply Work History Filter Parameters
323
Apply Technical Characteristics Filters
327
Apply Work Management Filters
331
About the SAP Adapters
335
About the Equipment and Functional Location Adapters
336
About the Work History Adapter
338
About the Technical Characteristics Adapter
349
Copyright © 2017 General Electric Company. All rights reserved. • Page 8 of 495
Table of Contents
About the Work Management Adapter
356
About Filter Parameters
362
Reference Information: SAP Adapters
365
SAP Adapter Data Model
366
Family Field Descriptions
368
CMMS Characteristic
369
CMMS Classification
371
CMMS Classification Type Records
373
EAM System
374
Technical Characteristic
377
SAP Transactions-Quick Reference
378
SAP Adapter Mappings
379
SAP Equipment Mappings
380
SAP Functional Location Mappings
389
SAP Work History Mappings
394
SAP Work History Detail Mappings
423
SAP Technical Characteristics Mappings
427
SAP Work Management Mappings
429
SAP Recommendation Mappings
433
SAP Task Value Mappings
437
Overview of the Maximo Adapters
441
Create Maximo Work Orders or Service Requests
442
About Extracting Data From Maximo
443
Reference Information: Maximo Adapters
446
Maximo Data Model
447
Maximo Values Mapped to GE Digital APM Records
449
Maximo Equipment Mappings
450
Maximo Functional Location Mappings
453
Maximo Work History Mappings
455
Maximo Work History Detail Mappings
466
Copyright © 2017 General Electric Company. All rights reserved. • Page 9 of 495
Table of Contents
Maximo Recommendation Mappings
Manage Jobs in the Administration Center
470
472
Schedule a Job
473
Execute a Run-Now Job
475
View the Execution Log
476
Update Existing Jobs
477
APM Connect Administrative Help
APM Connect EAM Jobs
479
480
Access APM Connect EAM Jobs
481
Access the Details of an EAM Job
482
APM Connect
484
Access the APM Connect Page
485
Establish Connection from GE Digital APM
486
Determine Logging Level
487
Schedule Work Orders
488
APM Connect Connection Records
490
Copyright © 2017 General Electric Company. All rights reserved. • Page 10 of 495
APM Connect System Requirements
APM Connect System Requirements
License Requirements
APM Connect has a three-tier license system that enables the APM Connect Framework.
One of the following license types is required to take advantage of the APM Connect
functionality:
l
APM Connect Basic
l
APM Connect Plus
l
APM Connect Studio
Note: APM Connect Studio contains numerous libraries that integrate with
third-party products, such as GeoRaster. Questions regarding linking these libraries with GE Digital APM should be directed to a member of the GE Digital Professional Services department on an individual basis. Specific requirements of
third-party products, such as additional licensing, is outside the scope of APM
Connect Studio support.
Additional Licensing
The following additional licenses are required to take advantage of the SAP Adapters:
l
SAP Integration Interfaces: Enables the SAP Equipment, Functional Location, Work
History, and Notification Creation Adapters.
l
SAP Technical Characteristics: Enables the SAP Technical Characteristics Adapter.
l
SAP Work Management: Enables the SAP Work Management Adapter.
The following additional license is required to take advantage of the SAP PI Adapters:
l
SAP Process Integration: Enables the SAP PI Adapters.
The following additional license is required to take advantage of the Maximo Adapters:
l
Maximo Interfaces: Enables the Maximo Equipment, Functional Location, Work
History, Service Request, and Work Order Generation Adapters.
Note: There is no additional license required to take advantage of the APM Connect
Data Loader functionality.
Additional Components Required
In addition to the basic GE Digital APM system architecture, your system must also contain the following components:
Minimum Software Requirements
Copyright © 2017 General Electric Company. All rights reserved. • Page 11 of 495
APM Connect System Requirements
l
Windows Server 2008 R2
l
Windows Server 2012
l
Java SE 8 Update 131 or higher
l
The third-party components listed in the following table
Third-Party File
Name
Version
Where You Can Obtain It
edtftpj.jar
Version: 2.0.5
http://enterprisedt.com/products/edtftpj/
ftp4j-1.5.1.jar
Version: 1.5.1
http://www.sauronsoftware.it/projects/ftp4j/
jboss-serialization.jar
Version:
1.0.3.GA
http://serialization.jboss.org/downloads
trove.jar
Version: 1.0.2
http://trove4j.sourceforge.net/
xom-1.2.7.jar
Version: 1.2.7
http://www.xom.nu/
Recommended Software
l
Windows Server 2012 R2
l
Windows 7 64-bit OS
Browser Requirements
Web Browser
Recommended or Supported
Microsoft Internet Explorer 11
Recommended
Mozilla Firefox 13 to 28
Recommended
Microsoft Internet Explorer 10
Supported
Apple Safari 5 to 7
Supported
Google Chrome 22 to 34
Supported
Minimum Hardware Requirements
l
Four Processor Core, 2.0GHz
l
8 GB RAM
l
100 GB Free Disk
l
100 MB Network Interface
Recommended Hardware
Copyright © 2017 General Electric Company. All rights reserved. • Page 12 of 495
APM Connect System Requirements
l
I5 Processor, 2.0 + GHz
l
32 GB RAM
l
300 GB Free Disk
l
1 GB Network Interface
ŒTip: APM Connect is input and output intensive, and requires a lot of storage space.
Faster storage is the best way to improve performance.
Depending on how your system is configured, these requirements may not be sufficient.
Parameters that affect the hardware requirements include the number of users, modules purchased, database size, and other factors that can vary from one customer to
another. For help refining your specific system requirements, contact GE Digital.
SAP System Requirements
l
SAP Backend System: An SAP server machine with an ECC system. The following
versions are supported:
n
SAP ECC 6.0 (Enhancement Packs [EhP] 1 and above)
n
S/4 Hana (1511 and 1610) for the following APM Connect SAP Adapters:
l
Equipment Extraction
l
Functional Location Extraction
l
Notification Management
l
Technical Characteristics
l
Work History Extraction
l
Work Management
l
SAP Database: A database that contains the SAP data model and data.
l
SAP Internet Transaction Server (ITS): Version 6.20 or higher.
l
SAP Java Connector Files (SAP JCO) downloaded from the SAP marketplace, which
contains the following files:
l sapjco.dll
l
sapjco3.dll
l
sapjco3.jar
SAP PI System Requirements
l
SAP Backend System: An SAP server machine with an ECC system. The following
versions are supported:
n
l
SAP ECC 6.0 (Enhancement Packs [EhP] 1 and above)
SAP PI: An SAP PI system 7.00 and above, up to SAP PI 7.40.
Note: The SAP PI Adapters do not support S/4 Hana.
Copyright © 2017 General Electric Company. All rights reserved. • Page 13 of 495
APM Connect System Requirements
Maximo System Requirements
APM Connect supports Maximo versions above 7.1.1.6.
l
l
l
l
Maximo Application Server: A Maximo Application Server machine that houses
the Maximo Web Services and is running version 7.1, 7.5, or 7.6.
Maximo Database Server: A database that houses the Maximo data model and
data and is running a version that is supported by the Maximo Application Server.
For details on requirements of the Maximo Database Server, see the Maximo documentation.
Maximo Client Workstation: A computer that is used to access the Maximo application. For details on the requirements of the Maximo Client workstation, see the
Maximo documentation.
Maximo Administrative Workstation: A computer that contains the Maximo application. For details on the requirements of the Maximo Administrative workstation,
see the Maximo documentation.
System Architecture for EAM Adapters
Single Server Configuration (Recommended)
The single server configuration is the simplest way to configure APM Connect. However,
it does include an embedded database. The following image depicts this configuration.
External Database Configuration
Copyright © 2017 General Electric Company. All rights reserved. • Page 14 of 495
APM Connect System Requirements
Many organizations choose to separate their databases. It is possible to install the intermediate repository database on an external server, and to keep the APM Connect Systems database on a different server. The following image depicts this configuration.
Note: The external configuration will affect performance. The single server configuration results in faster performance.
Deploying APM Connect
After you have installed and configured the basic GE Digital APM system architecture,
you will need to perform some configuration steps specifically for APM Connect.
Supported Features in APM Now
In the APM Now environment, the following features are unavailable: l
ACA for SAP
l
ASI for SAP
l
SAP PI
l
Maximo Integration
All other APM Connect features are available.
Copyright © 2017 General Electric Company. All rights reserved. • Page 15 of 495
Deploy APM Connect
Deploy APM Connect
The checklists in this section of the documentation contain all the steps necessary for
deploying and configuring this module whether you are deploying the module for the
first time or upgrading from a previous module.
Copyright © 2017 General Electric Company. All rights reserved. • Page 16 of 495
Deploy APM Connect
Deploy the APM Connect Base
The checklists in this section of the documentation contain all the steps necessary for
deploying and configuring this module whether you are deploying the module for the
first time or upgrading from a previous module.
Copyright © 2017 General Electric Company. All rights reserved. • Page 17 of 495
Deploy APM Connect
Deploy the APM Connect Base for the First Time
The following table outlines the steps that you must complete to deploy and configure
this module for the first time. These instructions assume that you have completed the
steps for deploying the basic GE Digital APM system architecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Note: If you are deploying this module in APM Now, before you begin completing
these tasks, review the system requirements for this module to identify the supported
features for this module in APM Now. Unless noted, all deployment tasks in the following table are applicable for the deployment of this module in APM Now.
Step
Task
Notes
1
Ensure that you meet the software and
hardware system requirements for APM
Connect.
This step is required.
2
On the APM Connect server, run the
third-party software batch file.
This step is required. The
APM Connect server is the system
on which you will run the
APM Connect installer.
3
On the APM Connect server, run the APM
Connect installer.
This step is required.
4
On the APM Connect server, change and
encrypt passwords.
This step is required.
5
On the APM Connect server, import the
karaf file into the Administration Center.
This step is required.
6
On the APM Connect server, start the
APM Runtime Container.
This step is required.
7
On the APM Connect server or the
GE Digital APM server, install the
Meridium Integration Services.
This step is required only if you
are completing an on-premises
deployment.
8
This step is required only if you
On the APM Connect server, enable Inter- are using Internet Explorer to
net Explorer for APM Connect.
access the APM Connect Administration Center.
9
On the APM Connect server, update PostThis step is required.
greSQL networking configuration.
10
On the APM Connect server, change the
PostgreSQL passwords.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 18 of 495
Deploy APM Connect
Step
Task
Notes
11
On the APM Connect server, access the
APM Connect Administration Center.
This step is required.
12
On the APM Connect server, change the
APM Connect Administration Center user
password.
This step is required.
13
On the APM Connect Server, validate the
APM Connect Administration Center
license.
This step is required only if your
APM Connect Administration
Center license was not validated
automatically when you accessed
the APM Connect Administration
Center.
14
Configure the APM Connect Administration Center.
This step is required.
15
In the APM Connect Administration
Center, set user permissions.
This step is required.
16
In the APM Connect Administration
Center, authorize users for projects.
This step is required.
17
In GE Digital APM, establish the conThis step is required only if you
nection from GE Digital APM to APM Con- are completing an on-premises
nect.
deployment.
18
On the APM Connect server, create a service user.
This step is required.
19
On the APM Connect server, configure
logging.
This step is required only if you
want to change how APM Connect
logs events.
ŗIMPORTANT: Each of the following tasks may be required depending on the
license that you have purchased and the APM Connect component that you are
deploying.
20
Configure the APM Connect Administration Center for the Studio.
This step is required only if you
have the APM Connect Studio
license.
21
On the APM Connect server, install the
Studio.
This step is required only if you
have the APM Connect Studio
license.
Copyright © 2017 General Electric Company. All rights reserved. • Page 19 of 495
Deploy APM Connect
Step
Task
Notes
22
Deploy the Data Loaders.
This step is required only if you
are deploying the Data Loaders in
an on-premises deployment.
23
On the APM Connect server, deploy the
automatic data loader job.
This step is required only if you
are using the automatic data
loader job.
24
Deploy the Maximo Adapters.
This step is required only if you
are deploying the Maximo
Adapters.
25
Deploy the SAP Adapters.
This step is required only if you
are deploying the SAP Adapters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 20 of 495
Deploy APM Connect
Upgrade the APM Connect Base to V2.0.0
The following table outlines the steps that you must complete to upgrade this module
to V2.0.0.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Upgrade from any version V1.0.0 through V1.0.3
Step
Task
Notes
1
Uninstall APM Connect.
This step
is
required.
2
Complete the steps to deploy the APM Connect Base for the first
time.
This step
is
required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 21 of 495
Deploy APM Connect
About the APM Connect Installation Package
GE Digital APM creates and delivers an installation package that provides the files and
folders needed for a successful implementation of APM Connect. This topic describes
what may be contained in your installation package based on your requirements.
Contents of the Installation Package
The installation package contains the following folders:
l
l
APM Connect Base: This folder contains the APM Connect installer.
DL: The APM Connect data loaders. This folder contains a configuration folder, a
jobs package folder, a third-party software folder, and a compressed file to help
you install the third-party software.
Depending on the licenses that you have activated, it also contains these folders:
l
APM Connect Studio: This folder contains the APM Connect Studio installer.
The following folders contain a configuration folder, a jobs package folder, a thirdparty software folder, and a compressed file to help you install the third-party software. The SAP folders also contain the ABAP package and installation documentation for that package.
l
EAM MAX: This folder contains Maximo data loaders.
l
EAM SAP: This folder contains SAP data loaders.
l
EAM SAP PI: This folder contains SAP PI data loaders.
Copyright © 2017 General Electric Company. All rights reserved. • Page 22 of 495
Deploy APM Connect
Run the Third-Party Software Batch File
APM Connect requires third-party software files for FTP capabilities and improved Java
performance. This topic describes how to incorporate these components into the jobs.
Steps
1. On your APM Connect server, access your APM Connect installation package, and
then navigate to the Jobs folder.
2. Right-click on the folder ApplyThirdPartySoftware_0.1.zip, and then select Extract
All.
The Extract Compressed (Zipped) Folders window appears.
3. Select Extract.
The files are extracted, and the folder ApplyThirdPartySoftware_0.1 appears in
the same directory.
4. Download the third party software files, and then create a directory on the APM
Connect server containing those files.
5. Open a command prompt, and navigate to <root>ApplyThirdPartySoftware_0.1\ApplyThirdPartySoftware.
6. Enter the following command: ApplyThirdPartySoftware_run.bat --context_param
JOBS_DIR=<JOB PACKAGE DIR> --context_param THIRD_PARTY_SOFTWARE_DIRR=<YOUR THIRD_PARTY_SOFTWARE_DIR>.
l
l
<JOB PACKAGE DIR>: Replace with the filepath to the directory that contains
the job zip files (e.g., C:/APMConnect/Jobs).
<YOUR THIRD_PARTY_SOFTWARE_DIR>: Replace with the filepath for the directory that you created in step 4 (e.g., C:/APMConnect/ThirdPartySoftware).
ŒHint: When entering a directory in a command prompt window, the file path
must use the forward slashes.
7. Execute the command by pressing Enter.
The adapter jobs are updated with the third-party software component, and a message appears on the command prompt window, indicating that the update is complete. Additionally, a new folder is created: updated_jobs.
Note: The jobs contained in the updated_jobs folder are the jobs that will be
used to facilitate the data transfer from the source to GE Digital APM.
Copyright © 2017 General Electric Company. All rights reserved. • Page 23 of 495
Deploy APM Connect
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 24 of 495
Deploy APM Connect
Run the APM Connect Installer
The APM Connect installer completes many tasks, including installing Java, installing
APM Connect Windows services, and installing the intermediate repository (PostgreSQL).
ŗIMPORTANT: Each of the following steps may be required depending on the license
that you have purchased and the APM Connect component that you are deploying.
Before You Begin
Before you can run the APM Connect Installer, you must:
l
Access the APM Connect installation package.
l
Ensure that your system meets the APM Connect system requirements.
l
For SAP integrations, download the SAP Java Connector Files (SAP JCO) from the
SAP marketplace.
Steps
1. On your APM Connect server, access the APM Connect installation package, navigate the Installer folder, and then open it.
2. Double-click the file APMConnect-Base.exe.
A message appears, asking if you want to allow the installer to make changes to
your machine.
3. Select Yes.
The Setup - APM Connect window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 25 of 495
Deploy APM Connect
4. Select Next.
The Select Destination Location screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 26 of 495
Deploy APM Connect
5. By default, the APM Connect software will be saved to the following folder:
C:\APMConnect. If you are satisfied with the default location where the software
will be installed, select Next.
-orIf you want to change the location where the software will be installed, select
Browse..., and then navigate to the location where you want to install the APM
Connect software. The folder path that you select will be displayed in place of the
default folder path. When you are satisfied with the installation location, select
OK, and then select Next.
The Select Components screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 27 of 495
Deploy APM Connect
6. If you want to install all components, select Next.
-orAs needed, clear the check boxes based on your APM Connect license and the
APM Connect component(s) you are deploying:
l
l
l
Install Oracle Java JDK 1.8 (uncheck if java already installed): If Java JDK 1.8
is already installed on your machine, clear the check box.
Install PostgreSQL (required unless using external database): If you are
using an external database configuration, clear the check box.
Install APM Connect Container (required unless already installed): If you
have previously installed the APM Connect Container, clear the check box.
7. Select Next.
The Select Start Menu Folder screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 28 of 495
Deploy APM Connect
8. By default, the Start Menu folder will be saved to the following folder: APMConnect. If you are satisfied with the default location where the software will be
installed, select Next.
-orIf you want to change the location where the folder will be saved, select Browse...,
and then navigate to the location where you want to install the APM Connect software. The folder path that you select will be displayed in place of the default folder
path. When you are satisfied with the installation location, select OK, and then
select Next.
The Select Additional Tasks screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 29 of 495
Deploy APM Connect
9. If you want to perform all additional tasks, select Next.
-orAs needed, clear the check boxes based on your APM Connect license and the
APM Connect component(s) you are deploying:
l
l
l
l
l
l
l
Create a desktop shortcut: If you do not want to create a shortcut on your
desktop, clear the box.
Set JAVA_HOME environment variable: If Java is already installed, and an
environment variable does not need to be created, clear the check box.
APMConnect Services: If the APM Connect Services do not need to be
installed, clear the check box.
Tomcat Windows service: If the Tomcat Windows service does not need to
be created, clear the check box.
APMConnect Container service: If you don't want to install the APM Connect
Container service, clear the check box.
Configure APMConnect Container service: If you don't want to configure
the APM Connect Container service, clear the check box.
Install APM Connect Container service SAP JCO driver software: If your
source system is SAP, select this check box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 30 of 495
Deploy APM Connect
10. Select Next.
The Ready to Install screen appears.
11. Review the items to be installed, and then select Install.
If you selected Install APM Connect Container service SAP JCO driver software on
the previous screen, the Select the SAP JCO Driver Location screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 31 of 495
Deploy APM Connect
Note: If you did not select Install APM Connect Container service SAP JCO
driver software, the Select the Job Location screen appears, and you can proceed to Step 13.
12. In the SAP Bundle box, specify the location of the file sapjco3.jar, which is part of
the SAP Java Connector Files (SAP JCO) that you downloaded from the SAP marketplace, and then select Next.
The Select the Job Location screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 32 of 495
Deploy APM Connect
13. By default, the folder containing the job files is specified as C:\APMConnect\Downloaded Jobs Package. If this location is correct, select Next.
-orIf this location is incorrect, select Browse..., navigate to the location where the
jobs package is located, select OK, and then select Next.
Note: The jobs package is not part of the APM Connect Installation package.
Instead, you will receive it as a separate artifact (e.g., download from a designated ftp site).
The Select the APMConnect License file screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 33 of 495
Deploy APM Connect
14. By default, the folder specified is C:\APMConnect\license. If this location is correct, select Next.
-orIf this location is incorrect, select Browse..., navigate to the location where the
license file is located, select OK, and then select Next.
The APMConnect Server Information screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 34 of 495
Deploy APM Connect
15. In the Hostname box, enter the name of you APM Connect server, and then select
Next.
The Installing screen appears, displaying an installation progress bar.
Copyright © 2017 General Electric Company. All rights reserved. • Page 35 of 495
Deploy APM Connect
Once the progress bar indicates that the APM Connect installer is Finishing installation..., Java SE Development Kit <JAVA_VERSION_NUMBER> - Setup window
appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 36 of 495
Deploy APM Connect
16. Select Next.
The Select optional features to install screen appears.
17. Select Next.
The Java installation progress bar appears. Once the progress bar indicates that
the process is complete, the Destination Folder screen appears.
18. Select Next to install Java in the default location.
ŗIMPORTANT: These instructions assume that Java is installed in the default location.
The progress bar reappears. After the progress bar indicates that the installation is
complete, the Successfully Installed Java SE Development Kit <JAVA_VERSION_
NUMBER> screen appears.
19. Select Close.
Java is installed.
A command prompt appears, prompting you to press any key to continue.
ŒHint: If an error appears on the command prompt window, refer to creating
Copyright © 2017 General Electric Company. All rights reserved. • Page 37 of 495
Deploy APM Connect
Java environment variables.
20. Press any key.
The command prompt window closes, then the Installing screen reappears briefly,
and then the Setup dialog box appears, displaying the JavaHome path.
21. Select OK.
The Setup - PostgreSQL screen appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 38 of 495
Deploy APM Connect
22. Select Next.
The Installation Directory screen appears, prompting you to select the location
where PostgreSQL for APM Connect will be installed.
23. By default, PostgreSQL will be saved to the following folder: C:\Program Files\PostgreSQL\9.6. If you are satisfied with the default location, select Next.
-orIf you want to change the location where the software will be installed, select the
button, then navigate to the location where you want to install PostgreSQL for
APM Connect, and then select Next.
The Data Directory screen appears.
24. Select Next.
The Password screen appears.
25. In the Password box, and in the Retype password box, enter a password.
ŒHint: This password will be used as a service account for PostgreSQL, and is
needed in later configuration. Be sure to record it. Additionally, this documentation assumes admin as the password, and uses it in subsequent default
configurations.
26. Select Next.
The Port screen appears.
27. If you are satisfied with the default port, select Next.
ŒHint: The port number is needed in later configuration. Be sure to record it.
Additionally, these instructions and all subsequent instructions assume that the
default port 5432 is used.
-orIn the Port box, enter the port on which you prefer the server to listen, and then
select Next.
The Advanced Options screen appears.
28. Select Next.
The Ready to Install screen appears.
29. Select Next.
Copyright © 2017 General Electric Company. All rights reserved. • Page 39 of 495
Deploy APM Connect
The Installing screen appears, displaying an installation progress bar. After the
installation bar indicates that the installation is complete, the Completing the PostgreSQL Setup Wizard screen appears.
30. Clear the Stack Builder may be used to download and install additional tools,
drivers and applications to complement your PostgreSQL installation check box.
31. Select Finish.
PostgreSQL server is installed, then the Installing screen reappears briefly, and
then Completing the APM Connect Setup Wizard appears.
Note: If you have selected the installation of APM Connect Container service
or the SAPJCO driver software , the Administrator: Windows Power Shell and
Administrator: Karaf windows appear. Installation progress may not be visible
on the screen for 2-3 minutes. During this time, do not press any key or close
the windows.
The Yes, restart the computer now check box should be selected.
Copyright © 2017 General Electric Company. All rights reserved. • Page 40 of 495
Deploy APM Connect
32. Select Finish.
The APM Connect installer has completed its operations, and the machine should
restart automatically.
33. If it does not do so automatically, restart your machine.
What's Next?
l
Refer back to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 41 of 495
Deploy APM Connect
Change and Encrypt the APM Connect Service User
Names and Passwords
ŗIMPORTANT: During installation, the system defines default users and passwords in
a configuration file. Complete these steps on the APM Connect server to correctly
secure the server.
Steps
1. On the APM Connect server, if the service is running, stop the APM Connect service.
2. Navigate to C:\APMConnect\Utilities\runtime\etc.
3. Open the file users.properties in an application that you can use to modify a text
file (e.g., Notepad).
4. Change the passwords for the default user names.
5. Specify your own user names using the following format:
user=password[,role] [,role] [,role]...
- or user=password[,group] [,group] [,group]...
Note: For information about groups and defining roles, refer to the Talend
documentation.
6. Save and close the file.
7. To specify authorizations for the jobserver, open the file users.csv.
8. Add the authorized user names and passwords in the following format:
username,password
Note: For information about jobserver requirements, refer to the Talend documentation.
9. Save and close the file.
10. To enable password encryption, open the file system.properties.
11. Add the following statements at the end of the file:
# edit config
config:edit org.apache.karaf.jaas
config:property-set encryption.enabled true
config:update
Copyright © 2017 General Electric Company. All rights reserved. • Page 42 of 495
Deploy APM Connect
# force a restart
bundle:restart
12. Save and close the file.
13. Start the APM Connect service.
What's Next? l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 43 of 495
Deploy APM Connect
Import the Karaf File into the APM Connect Administration Center
In order to complete the connection between GE Digital APM, Karaf, and the APM Connect Administration Center, you must import the runActioninMAC.kar file into the APM
Runtime folder. This topic guides you through that process.
Steps
1. On your local machine, access and then copy the runActionInMAC-0.1.kar file.
2. Navigate to the following path: <root:>\APMConnect\Utilities\runtime\deploy.
3. Right-click inside the folder, and then select Paste to copy the .kar file into the
Runtime folder.
The new service is deployed to the APM Connect host.
What's Next?
l
Refer back to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 44 of 495
Deploy APM Connect
Install and Start the APM Runtime Container
Steps
1. On the APM Connect server, locate Command Prompt
2. Right-click on Command Prompt, and then select Run as administrator.
The Administrator: Command Prompt window appears.
3. Change the directory to: C:\APMConnect\Utilities\runtime\bin.
4. In the Command Prompt, after the new directory path, enter: trun.
A message appears in the Command Prompt, and another karaf@trun> prefix
appears.
Note: When you first start Karaf, it takes a few minutes to load all of the commands. So, if you attempt to enter the features:install command in Step 5 and
Copyright © 2017 General Electric Company. All rights reserved. • Page 45 of 495
Deploy APM Connect
receive an error message in the Command Prompt, try the command again in a
few minutes.
5. In the Command Prompt, after karaf@trun>, enter features:install wrapper.
Another karaf@trun> prefix appears.
6. After karaf@trun>, enter wrapper:install -s AUTO_START -n APM-CONTAINER -d
APM-Container -D "APM Container Service".
A service wrapper feature is now installed into the Runtime Container, and a batch
file is created in your local APM folder.
ŒHint: On your local computer, navigate to your APM Connect folder:
C:\APMConnect\Utilities\runtime\bin. Notice that your local APM Connect folder
now contains two new items: APM-CONTAINER-service.bat and APM-CONTAINERwrapper.exe.
Another karaf@trun> prefix appears.
7. After karaf@trun>, enter shutdown, and then enter yes to confirm you want to
shut down karaf.
Karaf is shut down, and another karaf@trun> prefix appears and the directory is
changed toc:\APMConnect\Utilities\runtime\bin
8. After c:\APMConnect\Utilities\runtime\bin> , enter APM-CONTAINER-service.bat
install.
Copyright © 2017 General Electric Company. All rights reserved. • Page 46 of 495
Deploy APM Connect
The APM Container is installed, and a message appears indicating as such.
9. To start the APM Container, restart your machine.
What's Next?
l
Refer back to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 47 of 495
Deploy APM Connect
Install the Meridium Integration Services
ŗIMPORTANT: This step is required only if you are deploying APM Connect onpremises. If you are deploying in APM Now, you can skip this procedure, and proceed
to the next step in the APM Connect Base First-Time Deployment Workflow.
Depending on your system architecture, you can perform this procedure on the
APM Connect server or the GE Digital APM server.
Steps
1. On the server, access the GE Digital APM distribution package, and then navigate
to the folder \\Setup\Meridium APM Server and Add-ons.
2. Double-click the file Setup.exe.
The Welcome screen appears.
3. Select Next.
The License Agreement screen appears.
4. Read the License Agreement and, if you agree, select the I accept the terms of the
license agreement check box. Then, select Next.
The Select Installation Location screen appears.
5. Select Next to accept the default location.
The Select the features you want to install screen appears.
6. Select the Meridium Integration Services option.
Note: While additional options are available for selection, these options are
not meant to be installed on this server. These instructions assume that you
want to install only Meridium Integration Services.
Copyright © 2017 General Electric Company. All rights reserved. • Page 48 of 495
Deploy APM Connect
7. Select Next.
The Websites screen appears.
8. Select Next.
The Complete the Installation screen appears.
9. Select Install.
The Setup Status screen appears, displaying a progress bar. Once the installation
is complete, the Installation is complete screen appears.
10. Select Finish.
The Meridium Integration Services installation is complete
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 49 of 495
Deploy APM Connect
Enable Internet Explorer for APM Connect
ŗIMPORTANT: This step is required only if you are using Internet Explorer to access
the APM Connect Administration Center. If you are not using Internet Explorer, you
can skip this procedure, and proceed to the next step, in the APM Connect Base FirstTime Deployment Workflow.
Steps
1. On the APM Connect server, access Control Panel\Network and Internet, and then
select Internet Options.
The Internet Properties screen appears
2. Select the Security tab, then, in the Select a zone to view or change security settings section, select Local intranet, and then select Custom level....
The Security Settings -Intranet Zone screen appears.
3. In the Settings section, access the Include local directory path when uploading
files to a server, and select Disable.
4. Select OK.
The Security Settings -Intranet Zone screen closes.
5. On the Internet Properties screen, select Apply.
Internet Explorer is configured accommodate APM Connect.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 50 of 495
Deploy APM Connect
Update PostgreSQL Networking Configuration
To allow connections from the APM server to APM Connect, you must update the PostgreSQL networking configuration. This topic describes how to perform the configuration
update.
Steps
1. On the machine on which you installed APM Connect, navigate to your PostgreSQL
installation files. The default location is <root:>\Program Files\PostgreSQL\9.3\data.
2. Locate the configuration file pg_hba.conf, right-click the file, and then open it with
a text editor.
The file pg_hba.conf opens in the text editing application.
3. Scroll down to the end of the document and locate the following line of text: host
all all 127.0.0.1/32 md5
4. Save the file, and then close the text editor.
PostgreSQL is now configured to open the connection from the GE Digital APM
Server.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 51 of 495
Deploy APM Connect
Change the PostgreSQL Passwords
These steps describe how to change the PostgreSQL passwords using pgAdmin,
although you can use any SQL query tool to perform this task.
Steps
1. Start pgAdmin.
2. Right-click on a database, and then select Query Tool.
The workspace for the selected database appears.
3. In the workspace, enter ALTER statements for each role to be changed using the
following format:
ALTER ROLE username SET PASSWORD TO 'newpassword'
4. At the top of the workspace, select
.
The query runs and the password is changed.
Note: For more information about the PostgreSQL roles, see the PostgreSQL
documentation.
What's Next? l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 52 of 495
Deploy APM Connect
Access the APM Connect Administration Center
Using the APM Connect Administration Center, you can run extraction and load jobs.
Before you can begin running jobs, you must set up the APM Connect Administration
Center. This topic explains how to access and deploy the APM Connect Administration
Center for the first time.
Steps
1. Open a web browser, and then enter the following URL into your web browser:
http://localhost:8080/apmconnect/.
The Login window appears.
2. In the Password box, enter admin.
3. Select OK.
The Login window disappears, the Database parameter section is visible, and a
check is performed by the APM Connect Administration Center.
ŗIMPORTANT: If your license does not validate, you can validate your license
manually.
Copyright © 2017 General Electric Company. All rights reserved. • Page 53 of 495
Deploy APM Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 54 of 495
Deploy APM Connect
Select Go to login page.
4. The Login page appears.
5. In the Login box, enter the default username: admin@company.com.
6. In the Password box, enter the default password: admin.
7. Select Login.
The APM Connect Administration Center is successfully deployed, and the APM
Connect Administration Center Welcome page appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 55 of 495
Deploy APM Connect
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 56 of 495
Deploy APM Connect
Change the APM Connect Administration Center
User Password
Steps
1. Access the APM Connect Administration Center.
2. In the Menu pane, in the Settings section, select the Users tab.
The Users workspace appears.
3. In the Users workspace, select the user whose password you want to change.
4. In the Data pane, select change password.
The User Password window appears.
5. Enter the new password, and enter it again to confirm.
6. Select Validate.
The password has been changed.
Copyright © 2017 General Electric Company. All rights reserved. • Page 57 of 495
Deploy APM Connect
Validate the APM Connect Administration Center
License
ŗIMPORTANT: This step is required only if your license was not validated automatically when you accessed the APM Connect Administration Center. If you did not
receive the No token set error when accessing the APM Connect Administration
Center, you can skip this procedure, and proceed to the next step, Configure the APM
Connect Administration Center, in the APM Connect Base deployment workflow.
To use the APM Connect Administration Center, you must validate your Administration
Center license. Typically, validation is done automatically. However, user specific environment configuration, such as firewalls, may require manual validation. This topic
describes how to manually validate your APM Connect Administration Center license.
Steps
1. If you receive the No token set error when accessing the APM Connect Administration Center, as shown in the following image, select Validate your license
manually.
Copyright © 2017 General Electric Company. All rights reserved. • Page 58 of 495
Deploy APM Connect
The Validation request screen appears.
2. In the Validation message (put this message on the form of the next Link) box,
copy the text.
3. In the Validation link (put the generated validation token to the next text Area)
section, select link.
If a browser opens, displaying the Enter your validation request page, skip to step
6.
-orIf a browser does not open, proceed to the next step.
4. Right-click link, and then select copy link text.
5. Via email or chat, send the link to a machine with internet access that is not
behind the firewall, and then, on that machine, paste the link into a browser.
The Enter your validation request page appears in your browser.
6. Paste or enter the text from the Validation message (put this message on the
form of the next Link) box into the box in the browser.
Copyright © 2017 General Electric Company. All rights reserved. • Page 59 of 495
Deploy APM Connect
7. Select Get your validation token.
The Copy your validation token screen appears.
8. Copy the text in the box.
9. Return to the APM Connect Administration Center.
10. Paste the token text into the Validate box.
11. Select Validate.
The license is validated manually.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 60 of 495
Deploy APM Connect
Configure the APM Connect Administration Center
Depending on whether you are using the EAM Adapters (SAP Adapters and Maximo
Adapters) or the Data Loaders, configuring the APM Connect Administration Center
requires defining parameters for some or all of the following components: SVN, Commandline, Job conductor, Monitoring, and Log4j. This topic describes how to configure
these parameters in the APM Connect Administration Center.
Steps
1. If you are not already in the APM Connect Administration Center, access it via
http://localhost:8080/apmconnect/.
2. If prompted, log in to the APM Connect Administration Center.
3. In the Menu pane, in the Settings section, select the Configuration tab.
The Configuration pane appears.
4. Select the Job conductor (7 Parameters) group to expand the workspace.
5. Using the following table as a guide, enter the recommended parameters.
Note: You can accept the default values of parameters not listed in the table.
Parameter
Description
Recommended or Default Value
Generated
jobs folder
The path to the folder
with the Job execution
archives.
C:\APMConnect\Logs\generated_jobs
Tasks logs
folder
The path to the folder
with the Job execution
logs.
C:\APMConnect\Logs\execution_logs
The default parameters are configured as shown in the following image.
Copyright © 2017 General Electric Company. All rights reserved. • Page 61 of 495
Deploy APM Connect
6. Select the Monitoring (2 Parameters) group to expand the workspace.
Note: Configuring this parameter is optional.
7. Select the Log4j (4 Parameters) group to expand the workspace.
8. Using the following table as a guide, enter the necessary parameters.
Parameter
Description
Recommended or Default Value
Technical
file
appender
The path to
the technical
log file of the
C:/APMConnect/Utilities/Tomcat/logs/technical.log
APM Connect
Administration
Center.
Technical
log
threshold
The level of
logs you want
to append.
Business
log file
path
The path to
the business
log file of the
C:/APMConnect/Utilities/Tomcat/logs/business.log
APM Connect
Administration
Center.
WARN
Copyright © 2017 General Electric Company. All rights reserved. • Page 62 of 495
Deploy APM Connect
Technical
logstash
appender
The host and
port corresponding to
the Logstash
instance.
localhost:8050
The default parameters are configured as shown in the following image.
The APM Connect Administration Center parameters are configured.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 63 of 495
Deploy APM Connect
Set User Permissions
To begin using the APM Connect Administration Center to run data extractions, or Jobs,
you must first give the admin user all of the user roles.
Steps
1. In the Menu pane, in the Settings section, select the Users tab.
2. Select the user that you want to be the administrator.
The Data pane is activated.
3. On the Data pane, next to the Role: box, select
.
The Role Selection window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 64 of 495
Deploy APM Connect
4. Select each check box to assign the user all roles, or select the box of the role(s)
you want to assign the user, according to the following table:
ŗIMPORTANT: You must designate at least one user the role of Operation Manager to access the Job Conductor.
Note: A user must be authorized for a project before they can view or change
sections associated with a project.
Role
Read Permissions by Module
Administrator None.
Write Permissions by Module
License, Configuration, Users,
Projects, Rights Management,
Backup, Notifications, Software
Updates
Operations
Manager
Projects, EBS Publisher, Service Activity Monitoring,
Authorization, Service
Registry, Studio, Repository
Browser
Configuration, Lock, Notifications, Servers, Job Conductor ,
ESB Conductor, Execution Plan,
Monitoring Audit BRMS (Drools),
Service Locator
Designer
Configuration, Projects, Servers, Job Conductor, EBS ConExecution Plan, Audit, BRMS
ductor, EBS Conductor, EBS
(Drools), Service Locator
Publisher, Execution Plan,
Monitoring
Viewer
Servers, Job Conductor, Execution Plan, Audit, Studio,
Repository
None.
Copyright © 2017 General Electric Company. All rights reserved. • Page 65 of 495
Deploy APM Connect
5. Select Validate.
6. Select Save.
The user permissions are set.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 66 of 495
Deploy APM Connect
Authorize Users for Projects
Before a user can begin work on a specific project, that user must be authorized to work
on that project. Each project can have multiple users with differing roles. Users can also
be authorized for multiple projects. This topic explains how to authorize a user for a project.
Steps
1. In the Menu pane, in the Settings section, select Project authorizations.
The Project Authorizations workspace appears displaying the Project section
which lists all the projects to which you can add users and the User Authorizations
for the Project: <name> section which lists all users that can be added to the project.
2. From the Project list, select the project to which you want to add a user.
3. To give a user read permissions only, in the Right column in the row for that user,
select the
button.
4. To give a user read and write permissions, in the Right column in the row for that
user, select the
button.
Copyright © 2017 General Electric Company. All rights reserved. • Page 67 of 495
Deploy APM Connect
ŒHint: The icons in the Right column will be appear in a lighter color if the user
is not authorized for a specific action, and be colored if the user has the
required permissions.
The user is now authorized for the project.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 68 of 495
Deploy APM Connect
Create a Service Account User
For security reasons, it is important to limit the number of users that can access the file
shares between the SAP server and the APM Connect server. The best way to do this is to
create one service account user to run the Jobserver and to access the SAP file shares on
the SAP server. This topic describes how to create a service account user that has access
to the SAP server and runs the Jobserver.
Steps
1. In the same domain as the SAP server, create an active directory user.
2. On the SAP server, create a new folder that will be shared with the new user you
just created.
3. Right-click the new folder.
4. Select Properties.
The <Folder Name> Properties window appears.
5. Select the Sharing tab.
Copyright © 2017 General Electric Company. All rights reserved. • Page 69 of 495
Deploy APM Connect
6. Select Share...
The File Sharing window appears.
7. In the text box, enter the user name of the service account.
8. Select Add.
The new user appears in the list of users.
9. In the Permission Level column, select
, and then select Read/Write.
10. Select Share.
11. Close the windows.
12. On the APM Connect server, select the Windows Start button to open the Windows
Start menu.
13. In the Search programs and files box, enter services.
Copyright © 2017 General Electric Company. All rights reserved. • Page 70 of 495
Deploy APM Connect
Services appears in the Programs list.
14. Open Services.
The Services window appears.
15. Right-click the APM-CONTAINER service.
16. Select Properties.
The APM-CONTAINER Properties (Local Computer) window appears.
17. Select the Log On tab.
18. Select This account:.
19. Enter the service account user.
20. Select OK.
The service account user has been created, authorized to run the Jobserver, and
given access to the file shares on the SAP server.
What's Next?
Copyright © 2017 General Electric Company. All rights reserved. • Page 71 of 495
Deploy APM Connect
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 72 of 495
Deploy APM Connect
Configure Logging
APM Connect uses log4j version 1.2 to log events and provides a default configuration
for logging events. These steps describe how to modify this default configuration.
Steps
1. On the APM Connect Server, navigate to the folder C:\APMConnect\Config.
2. Open the file log4j.properties in an application that you can use to modify a text
file (e.g., Notepad).
3. Modify the log4j.rootLogger statement to select the correct severity level and
appender. Consider the following example of a modified statement:
log4j.rootLogger=ERROR, fileout
...where the first value is the severity level and the second value is the appender to
use. You can enter any of the following values as the severity level:
l
TRACE
l
DEBUG
l
INFO
l
WARN
l
ERROR
l
FATAL
l
OFF
The severity level that you configure controls the messages written to the log. Each
severity causes the system to filter messages above that type in the preceding list.
Note: The appender value must be either fileout or consoleout.
ŗIMPORTANT: To collect the most complete information, do not change the
conversion pattern on any appender you use.
4. Modify the log4j.logger.org.apache.cd statement to log the Web Service request
and response messages. The format is similar to log4j.rootlogger.
5. Modify the log4j.logger.org.apache.activemq statement to enable the logging
levels for ActiveMQ messages. The format is similar to log4j.rootlogger.
6. If you use the console appender, uncomment all statements containing consoleout and comment the statements containing fileout. Consider the following
example:
Copyright © 2017 General Electric Company. All rights reserved. • Page 73 of 495
Deploy APM Connect
# consoleout is set to be a ConsoleAppender.
log4j.appender.consoleout=org.apache.log4j.ConsoleAppender
log4j.appender.consoleout.Threshold=DEBUG
log4j.appender.consoleout.layout=org.apache.log4j.PatternLayout
log4j.appender.consoleout.layout.ConversionPattern=[%-5p][%d{dd MMM yyyy HH:mm:ss}][%t][%c][%M] %x - %m%n
#fileout uses fileAppender
#log4j.appender.fileout=org.apache.log4j.RollingFileAppender
#log4j.appender.fileout.Threshold=debug
#log4j.appender.fileout.MaxFileSize=1MB
#log4j.appender.fileout.MaxBackupIndex=2
#log4j.appender.fileout.File=${LOG}/${LOG_FILE}
#log4j.appender.fileout.Append=true
#log4j.appender.fileout.layout=org.apache.log4j.PatternLayout
#log4j.appender.fileout.layout.ConversionPattern=[%-5p][%d{dd MMM yyyy HH:mm:ss}][%t][%c][%M] %x - %m%n
Note: When configuring logging for SAP or SAP PI, you must specify the actual
path to the log file as the value of log4j.appender.fileout.file.
7. If you use the file rolling appender:
a. Modify the log4j.appender.fileout.MaxFileSize value to the appropriate size
for your installation.
b. Modify the log4j.appender.fileout.MaxBackupIndex value to the number of
log files you want to keep.
8. Save the file.
Event logging has been configured.
Copyright © 2017 General Electric Company. All rights reserved. • Page 74 of 495
Deploy APM Connect
Configure the APM Connect Administration Center
for the Studio
ŗIMPORTANT: This step is required only if you have the APM Connect Studio license.
If you are deploying APM Connect Base with a Basic or Plus License, skip this procedure and proceed to the next step in the APM Connect Base deployment workflow.
Steps
1. Open a web browser.
ŒHint: APM Connect is most compatible with Google Chrome or Mozilla Firefox
web browsers. It is not recommend using Internet Explorer to access the APM
Connect Administration Center.
2. Enter the following URL into your web browser: http://localhost:8080/apmconnect/.
3. If prompted, log in to the APM Connect Administration Center.
4. In the Menu pane, in the Settings section, select the Configuration tab.
The Configuration pane appears.
5. Select the Svn (7 Parameters) group to expand the workspace.
6. According to the following table, enter the necessary parameters.
Parameter
Description
Recommended or Default Value
Server location URL
URL location of the SVN
server.
http://localhost/svn/MIAPMINT
Username
SVN user name created to
use in the APM Connect
Administration Center
when installing the SVN
server.
APM
Password
SVN password created to
use in the APM Connect
Administration Center
when installing the SVN
server.
Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 75 of 495
Deploy APM Connect
Commit Log
Pattern
SVN commit log according
to your log format convention.
{0}
Library location URL
URL location of the SVN
external libraries directory
downloaded with the Studio.
Not Required
Library username
User name of the SVN user
that has access to the libraries directory.
Not Required
Library password
Password of the SVN user
that has access to the libraries directory.
Not Required
The default parameters are configured as shown in the following image.
7. Select the CommandLine/primary (5 Parameters) group to expand the workspace.
8. According to the information in the following table, enter the necessary parameters.
Parameter
Host
Description
The IP
address of
the CommandLine.
Recommend or Default Value
localhost
Copyright © 2017 General Electric Company. All rights reserved. • Page 76 of 495
Deploy APM Connect
Port
The port number on which
the Com8002
mandLine is
queried.
Job generation
folder
The path to
the folder
where Jobs
are generated.
<root:>\APMConnect\Utilities\cmdline\generationCache
User component
path
The path to
the folder
where user
components
are stored.
<root:>\APMConnect\Utilities\cmdline\custom_components
The default parameters are configured as shown in the following image.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 77 of 495
Deploy APM Connect
Install the Studio
ŗIMPORTANT: This step is required only if you have the APM Connect Studio license.
If you are deploying APM Connect Base with a Basic or Plus License, skip this procedure and proceed to the next step in the APM Connect Base deployment workflow.
Steps
1. On the machine on which you installed APM Connect, access the Talend Studio
installation package.
2. Open the file TalendStudioInstall.exe.
The Setup-Talend Studio window opens.
3. Select Next.
The License Agreement screen appears.
4. Read the entire license agreement, and then select one of the following options:
l
I accept the agreement: If you agree to the terms of the license agreement
and want to continue. These instructions assume that you want to continue.
Copyright © 2017 General Electric Company. All rights reserved. • Page 78 of 495
Deploy APM Connect
l
I do not accept the agreement: This option is selected by default. If you do
not agree to the terms of the license agreement and do not want to continue, select Cancel to exit the installer.
Next is enabled.
5. Select Next.
The Select Destination Location screen appears.
6. Select Next.
The Select Components screen appears.
7. Select the Add Start Menu Entry box, and then select the Add Desktop Icon box.
8. Select Next.
The Select Start Menu Folder screen appears.
9. Select Next.
The Ready to Install screen appears.
10. Select Install.
Copyright © 2017 General Electric Company. All rights reserved. • Page 79 of 495
Deploy APM Connect
The Installing screen appears, displaying an installation progress bar. Once the
installation is complete, the Completing the Talend Studio Setup Wizard screen
appears.
11. Select Finish.
The installation is complete, and Talend Studio desktop icon is available.
What's Next?
l
Refer to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 80 of 495
Deploy APM Connect
Uninstall APM Connect
Before you can upgrade the APM Connect Base, you must uninstall your current version
of APM Connect.
Steps
1. On the APM Connect server, access the Uninstall or Change a Program section of
the Control Panel.
2. Select APMConnect 1.0.3, right-click, and then select Uninstall.
3. Access the Services section of the Control Panel (in the Administrative Tools section of System and Security) and stop the following services:
l
APM-CONTAINER
l
7.0.57 APMConnect_Tomcat
4. Access the Uninstall or Change a Program section of the Control Panel again,
select the Java programs (e.g., Java 1.7.71 and Java SE Development Kit 1.7.71),
right-click, and then select Uninstall.
5. On the APM Connect server, locate the folder C:\APMConnect, and then delete it.
ŒTip: If files are locked and prevent you from deleting this folder, you may
need to restart the APM Connect server machine.
6. Access the DOS Command Prompt window, and run the following commands:
l
SC DELETE APM-CONTAINER
l
SC DELETE APMConnect_Tomcat
7. Restart the APM Connect server machine.
APM Connect is uninstalled.
Copyright © 2017 General Electric Company. All rights reserved. • Page 81 of 495
Deploy APM Connect
Set Java Environment Variables
The Java Environment variables are set automatically when you run the APM Connect
installer. However, if you need to update or reinstall Java without reinstalling
APM Connect, complete these steps to configure Java on your APM Connect server.
Steps
1. On the APM Connect server, navigate to Control Panel\System and Security\System to open system properties for the Windows machine.
The View basic information about your computer screen appears.
2. In the Control Panel Home pane, select Advanced systems settings.
The System Properties window appears, displaying the Advanced tab.
3. Select Environment Variables....
The Environment Variables window appears.
4. In the System variables section, select New....
The New System Variable window appears.
5. In the Variable name box, enter JAVA_HOME.
6. In the Variable value box, enter the path to the root jdk installation directory. If
you installed Java in the default location, the path you should enter is C:\Program Files\Java\jdk<JAVA_VERSION_NUMBER>. For example, the default
path for Java 8 is C:\Program Files\Java\jdk1.8.0_131
7. Select OK.
8. In the System variables section, select New....
The New System Variable window appears.
9. In the Variable name box, enter JRE_HOME.
10. In the Variable value box, enter the path to the root jre installation directory. If
Copyright © 2017 General Electric Company. All rights reserved. • Page 82 of 495
Deploy APM Connect
you installed Java in the default location, the path you should enter is C:\Program Files\Java\jdk<JAVA_VERSION_NUMBER>\jre. For example, the
default path for Java 8 is C:\Program Files\Java\jdk1.8.0_131\jre
11. Select OK, and then close the properties window.
The Java environment variables are created.
Copyright © 2017 General Electric Company. All rights reserved. • Page 83 of 495
Deploy APM Connect
Import Adapter Jobs
Note: This step is needed only if the adapter jobs were not imported when you ran
the APM Connect installer.
A job is used to extract information from the source and push it into GE Digital APM.
Before you can initiate a job using the APM Connect Administration Center, you must
first load the jobs into the APM Connect Administration Center. This is accomplished by
importing the jobs from a .zip file. This topic describes how to import jobs into the APM
Connect Administration Center.
Steps
1. In the Menu pane, in the Conductor section, select the Job Conductor tab.
2. On the Job Conductor toolbar, select Add.
The Execution task pane is activated.
3. In the Execution task pane, in the Label box, enter a label for the job.
4. In the Description box, enter a description for the Job.
5. Select the Active check box.
6. In the Job section, select
.
The Import generated code window appears.
7. Select Browse, and then navigate to the folder containing the updated jobs package.
8. Depending on the type of deployment, select the files that contains the job based
on the following table.
Note: You must import every job, or run the respective wrapper job, in the
table for the respective deployment.
Data Loader Jobs
Copyright © 2017 General Electric Company. All rights reserved. • Page 84 of 495
Deploy APM Connect
Job Name
CleanStagingDatabase.zip
Description
This is a utility job that is optional
and it does not load data. When
the job is run, it clears temporary
tables not removed from your IR
database during the loading process. This can help reduce the
amount of disk space used by the
IR database.
Creates Intermediate Repository
database for DinoLoader.
create_dinoloader_db.zip
Note: This job must be
executed before you can initiate
any data imports using the data
loaders.
Maximo Adapter Jobs
Job Name
Description
CreateIntermediateRepository.zip
Creates the IR database.
Maximo_Assets.zip
Loads Asset records to GE Digital APM
as Equipment records.
Maximo_Location.zip
Loads Location records to GE Digital
APM as Functional Location records.
Maximo_Master_Interface.zip
Wrapper job for all Maximo Adapters
allowing easy configuration of multiple
Maximo Adapters jobs.
Maximo_WorkHistory.zip
Loads Maximo Service Request and
Work Order records to GE Digital APM
as Work History records.
SAP Adapter Jobs
Copyright © 2017 General Electric Company. All rights reserved. • Page 85 of 495
Deploy APM Connect
Job Name
Description
CreateIntermediateRepository.zip
Creates IR database.
CreateStaticData.zip
Loads lookup tables.
EncryptString.zip
Used to encrypt passwords.
IR_Equipment_APM_load.zip
Restarts failed Equipment load from
the point of failure.
IR_Equipment_TC_APM_load.zip
Restarts failed Technical Characteristics
load from the point of failure.
IR_FLOC_APM_Load.zip
Restarts failed Functional Location load
from the point of failure.
IR_FLOC_TC_APM_Load.zip
Restarts failed Technical Characteristics
load from the point of failure.
IR_Task_APM_load.zip
Restarts failed Notification Management load from the point of failure.
IR_WorkHistory_To_APM_load.zip
Restarts failed Work History load from
the point of failure.
Load_ID_List.zip
Allows large amounts of Asset IDs to be
loaded into GE Digital APM.
SAP_Equipment.zip
Loads Equipment records to GE Digital
APM.
SAP_Equipment_TechCharacters.zip
Loads Equipment Technical Characteristics records to GE Digital APM.
SAP_FunctionalLocation.zip
Loads Functional Location records to
GE Digital APM.
SAP_FunctionalLocation_TechCharacters.zip
Loads Functional Location Technical
Characteristics records to GE Digital
APM.
Copyright © 2017 General Electric Company. All rights reserved. • Page 86 of 495
Deploy APM Connect
Wrapper job for all SAP Adapters allowing easy configuration of multiple SAP
jobs.
SAP_Master_Interface.zip
Note: This job can be used to run
all of the Adapter jobs. It is recommended to use this job solely. Additionally, if you are using Multiple
SAP systems you must use this job.
SAP_WorkHistory.zip
Loads Work History records to
GE Digital APM.
SAP_WorkManagement.zip
Loads Work Management records to
GE Digital APM.
SAP Cloud Adapter Jobs
Job Name
Description
Client_Queue_Listener.zip
Enables the connection to the queue.
CreateIntermediateRepository_Client.zip
Creates Intermediate Repository database.
Email_notifcation.zip
Allows for an email notification to be
sent when a job or extraction fails. This
report, the Failure Details report,
provides the reason for why a record
did not load.
EncryptString.zip
Used to encrypt passwords.
Copyright © 2017 General Electric Company. All rights reserved. • Page 87 of 495
Deploy APM Connect
Wrapper job for all SAP Adapters allowing easy configuration of multiple SAP
jobs.
Extraction_Wrapper.zip
Note: This job can be used to run
all of the Adapter jobs. It is recommended to use this job solely. Additionally, if you are using multiple
SAP systems you must use this job.
SAP_NotificationManagement.zip
Create SAP Notification from General
Recommendations.
SAP PI Adapter Jobs
SAP PI Jobs
Description
CreateIntermediateRepository.zip
Creates IR database.
EncryptString.zip
Used to encrypt passwords.
IR_Equipment_APM_load.zip
Restarts failed Equipment load from
the point of failure.
IR_FLOC_APM_Load.zip
Restarts failed Functional Location load
from the point of failure.
IR_WorkHistory_To_APM_load.zip
Restarts failed Work History load from
the point of failure.
Load_ID_List.zip
Allows large amounts of Asset IDs to be
loaded into GE Digital APM.
SAP_PI_CreateStaticData.zip
Loads look up tables.
SAP_PI_Equipment.zip
Loads Equipment records to GE Digital
APM.
SAP_PI_Equipment_TechCharacters.zip
Loads Equipment Technical Characteristics records to GE Digital APM.
SAP_PI_FuncationalLocation.zip
Loads Functional Location records to
GE Digital APM.
Copyright © 2017 General Electric Company. All rights reserved. • Page 88 of 495
Deploy APM Connect
SAP_PI_FunctionalLocation_TechCharacters.zip
Loads Functional Location Technical
Characteristics records to GE Digital
APM.
SAP_PI_Maseter_Interface.zip
Wrapper job for all SAP PI Adapters
interfaces allowing easy configuration
of multiple SAP.
SAP_PI_NotificationManagement.zip
Load Notification Management data
into GE Digital APM.
SAP_PI_WorkHistory
Loads Work History records to
GE Digital APM.
SAP_PI_WorkManagement.zip
Loads Work Management records to
GE Digital APM.
9. On the Import generated code window, select Launch upload.
The Project, Branch, Name, Version, and Context boxes are automatically populated with appropriate values.
10. In the Execution Server list, select the server on which the task should be
executed.
11. Select Save.
The Adapter Job is imported into the APM Connect Administration Center.
12. Repeat steps 2-12 for every job.
Each Job is automatically categorized into the correct project.
What's Next?
l
Return to the APM Connect base first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 89 of 495
Deploy APM Connect
Delete a Job
When upgrading in a cloud environment or an adapter, you have to delete the old
adapter job before installing the new job.
Steps
1. Access the APM Connect Administration Center.
2. In the Menu pane, in the Conductor section, select Job Conductor.
The Job Conductor workspace appears.
3. In the Job Conductor workspace, select the job you want to delete, and then, at the
top of the workspace, select
.
Results
The job is deleted.
Copyright © 2017 General Electric Company. All rights reserved. • Page 90 of 495
Deploy APM Connect
Deploy the Data Loaders
The checklists in this section of the documentation contain all the steps necessary for
deploying and configuring this module whether you are deploying the module for the
first time or upgrading from a previous module.
Copyright © 2017 General Electric Company. All rights reserved. • Page 91 of 495
Deploy APM Connect
Deploy the Data Loaders for the First Time
The following table outlines the steps that you must complete to deploy and configure
this module for the first time. These instructions assume that you have completed the
steps for deploying the basic GE Digital APM system architecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Step
1
Task
Notes
Deploy the APM Connect Base.
This step is required.
2
In the GE Digital APM web browser, configure
SSL.
This step is required only if
you are completing an onpremises deployment and if
your GE Digital APM system
is configured to use SSL.
3
On your APM Connect server and on your
GE Digital APM Application Sever, set permissions for the APM Connect Directory.
This step is required.
4
On your APM Connect server, deploy and configure data loaders files.
This step is required.
5
On your APM Connect server, deploy and configure the APM_UPDATE_LOGIC Webservice.
This step is required.
6
In the APM Connect Administration Center, create the Intermediate Repository database.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 92 of 495
Deploy APM Connect
Upgrade APM Connect Data Loaders to UDLP
V2.2.0
The following table outlines the steps that you must complete to upgrade this module
to UDLP V2.2.0.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Upgrade from any Version DL V1.0.0 through UDLP V2.1.0
Step
Task
Notes
1
Upgrade the APM Connect Base.
This step is required.
2
Complete the steps to deploy the data loaders
for the first time.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 93 of 495
Deploy APM Connect
Configure SSL
If your GE Digital APM Web Server is configured to use SSL, this step is required to use
the Data Loader functionality.
Steps
1. Log in to your GE Digital APM web application, and then access your browsers certificate information.
Note: Typically you can access certificate information by selecting the lock
icon in the address bar.
The Certificate window appears.
2. Select Details, and select Copy to File....
The Certificate Export Wizard window appears.
3. Select Next.
Copyright © 2017 General Electric Company. All rights reserved. • Page 94 of 495
Deploy APM Connect
4. In the Export File Format window, select the DER encoded binary X.509 (.cer) button, and then select Next.
5. On the File to Export window, select Browse….
The Save As window appears.
6. Save the file to your Desktop under the name certificate.cer.
7. Select Next.
8. Select Finish.
The Certificate Export Wizard window appears.
9. Select OK.
10. Copy the certificate.cer file, and then paste it into the location of your machine’s
Java files.
For example, if your Java files are located at C:\Program Files\Java\jre7\bin, you
will want to copy the certificate.cer file to that bin folder.
Copyright © 2017 General Electric Company. All rights reserved. • Page 95 of 495
Deploy APM Connect
11. On the APM Connect server, run the Command Prompt as an Administrator, and
navigate to the location of your machine’s Java files.
12. Enter keytool.
Commands for the Key and Certificate Management Tool appear in the Command Prompt.
13. In the last line line, C:\Program Files\Java\jre7\bin>, enter keytool –importcert –
alias test –file certificate.cer –keystore publickey.store.
14. Enter a password, and confirm the password by re-entering it.
In the Command Prompt, you are asked if you want to trust the certificate.
15. For yes, enter y.
The keystore file is created.
16. Log into an instance of the APM Connect Administration Center.
17. In the Job Conductor workspace, select the Job for which you would like to set
parameters.
18. At the bottom of the Job Conductor workspace, select Context parameters.
The Context parameters section appears.
19. Enter the following values for the corresponding parameters:
l
l
l
TRUSTSTORE_FILE: The location of the certificate file
TRUSTSTORE_PASSWORD: The password you entered into the Command
Prompt when you installed the certificate.
USE_SSL: true.
SSL is now enabled.
What's Next?
l
Refer back to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 96 of 495
Deploy APM Connect
Set Permissions for APM Connect Directory
Before you begin importing data into GE Digital APM using the Excel source files, you
must set up a network folder share. The data is passed from the APM Server to the APM
Connect server through a file share, a situation in which a folder on the network is
shared and accessible to both servers. This topic describes the steps for setting up the
permissions required to enable the file share.
Steps: To create a domain user for the APM Container:
1. On the machine on which you installed APM Connect, from your desktop, select
the Windows Start button to open the Windows Start Menu.
2. In the Search programs and files box, search for Run.
Run appears in the Programs list.
3. Open Run.
The Run window appears.
4. In the Open box, enter: services.msc.
5. Select OK.
The Services window appears.
6. Right-click APM-CONTAINER, and then select Properties.
The APM-CONTAINER Properties window appears.
7. Select the Log On tab, and then select This account.
8. Enter the credentials for a user within your network, designated to run APM Connect services.
Copyright © 2017 General Electric Company. All rights reserved. • Page 97 of 495
Deploy APM Connect
Example: user1@meridium.com
9. Select Apply, and then select OK.
10. Repeat Steps 6-8 for the service Apache Tomcat 7.0 APMConnect_Tomcat.
A domain user has been assigned to run the APM Container service and the Tomcat service.
To create a Data Loaders file share:
ŗIMPORTANT: If you are employing a load-balancing setup using multiple servers,
before you proceed, you must first configure the APM Server file share. If you are
employing a standalone server, you may proceed with the following steps.
1. On your APM Connect Server, navigate to the APM Connect directory at the following file path: <root:>\APMConnect\.
2. In the directory window, select New folder, and then name the folder with the
Copyright © 2017 General Electric Company. All rights reserved. • Page 98 of 495
Deploy APM Connect
recommended name: DataLoaderFiles.
The Data Loader files folder is created.
3. Right-click the folder DataLoaderFiles.
4. Point to Share with, and then select Specific people....
The File Sharing window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 99 of 495
Deploy APM Connect
5. Select the domain user that you indicated in Step 8 of the To create a domain
user for the APM Container section of this topic.
6. In the Permission Level column for that user, select the drop-down arrow, and
then select Read/Write.
Copyright © 2017 General Electric Company. All rights reserved. • Page 100 of 495
Deploy APM Connect
Note: Users running the APM-CONTAINER service and the APM Server must
have Read/Write access to this folder.
7. Select Share.
Permission for the folder is granted to the user that you selected.
Grant Read/Write Access to the APMConnect folder:
1. Navigate to the APMConnect folder.
If you installed APM Connect in the default location the folder is C:/APMConnect.
2. Right-click on the folder APMConnect, and then select Properties.
The APMConnet Properties window appears.
3. Select the Security tab, and then select Edit.
The Permissions for APMConnect window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 101 of 495
Deploy APM Connect
4. Select Add....
The Select Users, Computers, Service Accounts, or Groups window appears.
5. In the Enter the object names to select(examples): box, enter the name of the
APM Connect user that you indicated in Step 8 of the To create a domain user for
the APM Container section of this topic.
6. Select Check Names.
The APMConnect user's name is validated.
7. Select OK.
The Select Users, Computers, Service Accounts, or Groups window closes, and
the APM Connect user is populated in the Group or user names box.
8. Select the APM Connect user.
Copyright © 2017 General Electric Company. All rights reserved. • Page 102 of 495
Deploy APM Connect
9. In the Permissions for <Username> box, on the Full Control row, select Allow.
10. Select OK.
The Permissions for APM Connect window closes.
11. On the APMConnect Properties window, select OK.
The APM Connect service user has access to the APM Connect folder.
What's Next?
l
Refer back to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 103 of 495
Deploy APM Connect
Deploy and Configure Data Loader Files
Note: The APM Connect installer automatically deletes the file RunDataLoaderRoute.cfg from the following location C:\APMConnect\Utilities\runtime\deploy, if it exists there. You must complete the remaining steps
in this topic manually.
Steps
1. Access the APM Connect installation package, and then copy the file RunDataLoaderRoute.cfg.
2. Navigate to <root>\APMConnect\Utilities\runtime\etc, and then paste the copied
file in that location.
3. Open the file to edit, and then configure the following parameters:
Parameter
Description
Default or Recommended Value
context
Defines what
Talend context
environment is
used.
TRUSTSTORE_FILE
The directory
path to the dinoValue is unique to the user.
loader SSL configuration file.
TRUSTSTORE_PASSWORD
The password
for the keystore
files.
USE_SSL
Determines if
SSL is used.
Default.
Value is unique to the user.
l
true: will use SSL.
l
false: will not use SSL.
IR_HOST
Intermediary
Repository host
name.
Value is unique to the user.
IR_DATABASE
Database for
the dinoloader
job.
Value is unique to the user.
Copyright © 2017 General Electric Company. All rights reserved. • Page 104 of 495
Deploy APM Connect
IR_USERID
Intermediary
Repository user- Value is unique to the user.
name.
IR_PASSWORD
Intermediary
Repository pass- Value is unique to the user.
word.
IR_SCHEMA
The schema in
which the IR
The default value is public.
database will be
created.
IR_PORT
Intermediate
Default value is 5432.
Repository port.
LOG4J_CONFIG_FILE
Log4j directory
path.
IS_LINUX
Indicates if the
machine on
which the Data
Loaders are
deployed is a
POSIX-compliant operating
system (e.g.,
Linux, UNIX,
AIX, HPUX etc.)
or another operating system.
LINUX_BASE_PATH
The directory
path where the
data loader file
share is mounted.
ROW_LEVEL_LOGGING
Used for debugging, specifies
whether or not
data rows are
written to the
log.
C:/APMConnect/Config/log4j.properties
l
l
true: Enter true if you are
deploying the Data Loaders
on a POSIX-compliant operating system.
false: Enter false if you are
not deploying the Data
Loaders on a POSIX-compliant operating system.
This parameter is required only if
you are deploying the Data Loaders on a Linux machine.
This path is defined by system
administrator for the Linux
machine, and the value is unique
to the user.
The default is false.
true: Writes data rows to the log.
false: Suppresses data rows from
the log.
Copyright © 2017 General Electric Company. All rights reserved. • Page 105 of 495
Deploy APM Connect
org.apache.karaf.features.configKey
Karaf web console configuration tie-in
is used to associate this configuration file
with the RunDataLoaderRoute class.
RunDataLoaderRoute.talendcontext.Default
ŗIMPORTANT: Do not modify
this parameter.
4. Save the file.
5. In the installation package, copy the file RunDataloaderRoute.kar.
6. On your APM Connect server, navigate to <root>\APMConnect\Utilities\runtime\deploy, and then paste the copied file in that location.
Note: If new configuration is not automatically applied, restart the APM_
CONTAINER service. This will force the changes to be applied.
What's Next?
l
Refer back to the first-time deployment workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 106 of 495
Deploy APM Connect
Deploy and Configure the APM_UPDATE_LOGIC
Webservice
The APM_UPDATE_LOGIC webservice manages the temporary tables GE Digital APM
uses to load the database. Correct configuration is required for the system to operate
correctly.
1. Access the APM Connect installation package, and then copy the file APM_
UPDATE_LOGIC.cfg.
2. Navigate to <root>\APMConnect\Utilities\runtime\etc, and then paste the copied
file in that location.
3. Open the file to edit, and then configure the following parameters:
Parameter
Description
Default or Recommended Value
context
Defines what Talend context environment is used.
Default. Do not change.
CONFIG_
FILE_PATH
The directory path to the
context file used for
extractions.
C:/APMConnect/Config/ContextFile.xml
LOG4J_
CONFIG_
FILE
The directory path to the
log4j.properties file used
for extractions.
C:/APMConnect/Config/log4j.properties
SAP_
CLOUD_
ENABLED
Specifies whether the
installation is in the cloud
or on premises.
l
l
true: the installation is in the
cloud.
false: the installation is on
premises.
Note: All file paths must use / in this configuration as a directory separator or
errors will occur.
4. Save the file.
5. In the installation package, copy the file APM_UPDATE_LOGIC.jar.
6. On your APM Connect server, navigate to <root>\APMConnect\Utilities\runtime\deploy, and then paste the copied file in that location.
Note: If new configuration is not automatically applied, restart the APM_
CONTAINER service. This will force the changes to be applied.
Copyright © 2017 General Electric Company. All rights reserved. • Page 107 of 495
Deploy APM Connect
Create the Intermediate Repository Database
Before you can run an extraction job, you must prepare the intermediate repository.
This topic describes how to set up a repository in preparation to run your first job.
Note: For SAP adapters, you must first run the Static Data job.
ŗIMPORTANT: If you are using the Data Loaders and the SAP Adapters, you must
deploy and run the CreateIntermediateRepository job for each set of adapters.
Before You Begin
l
Before you can prepare and deploy the repository, you must import the Create
Intermediate Repository Job.
Steps
1. Open and log in to the APM Connect Administration Center web application.
Note: The user logging in must have access to the Job Conductor by being designated the Operations Manager role. By default, users designated as administrators do not have Job Conductor permissions.
2. In the Job Conductor workspace, in the appropriate project, select the CreateIntermediateRepository Job.
3. At the bottom of the Job Conductor workspace, select Context parameters.
The Context parameters section appears.
4. Configure the following parameters:
Context Parameter
Description
The file path to context files
for the jobs.
CONFIG_FILE_PATH
ŗIMPORTANT: You must
change the default value to
reflect the actual path to
your configuration file.
Copyright © 2017 General Electric Company. All rights reserved. • Page 108 of 495
Deploy APM Connect
IR_DATABASE
Enter your APM Connect
database name.
The default value is DINODB.
IR_HOST
Enter your APM Connect
server name. The default
value is localhost.
IR_PORT
Enter your APM Connect
server port. The default
value is 5432.
IR_SCHEMA
The schema for your APM
Connect database. The
default value is public.
IR_USERID
Enter your APM Connect
database username.
IR_PASSWORD
Enter your APM Connect
database password.
LOG4J_CONFIG_FILE
The file path to the log4j configuration file.
PG_ADMIN_PASSWORD
The password for the PostgreSQL IR.
PG_ADMIN_USER
The user name for the PostgreSQL IR.
5. Select Run.
The intermediate repository is created for the project.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
-or-
l
Return to the Maximo Adapter workflow for the next steps in the deployment process.
-or-
l
Return to the Data Loader workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 109 of 495
Deploy APM Connect
Enable Test Connection
Note: This step is completed automatically when you run the APM Connect installer.
These steps are included here for your reference if necessary.
Steps
1. Access your APM Connect Installation package, navigate to the Jobs folder, and
then copy the file CheckConnections.jar.
2. On your APM Connect server, navigate to C:\APMConnect\Utilities\runtime\deploy.
3. In the deploy directory, paste the file CheckConnections.jar.
Results
l
You can now test the connections required to complete a data load.
Copyright © 2017 General Electric Company. All rights reserved. • Page 110 of 495
Deploy APM Connect
Change H2 Console Password
Note: This step is completed automatically when you run the APM Connect installer.
These steps are included here for your reference if necessary.
This topic describes how to change the H2 Console password associated with the APM
Connect Administration Center.
Steps
1. Access the APM Connect Administration Center.
2. In the Menu pane, in the Settings section, select the Configuration tab.
The Configuration section appears.
3. Select the Database (4 Parameters) group to expand the workspace.
4. Highlight and copy the URL in the URL row.
5. Select the link in the Web Console row.
In a new browser tab, the H2 Console Login screen appears.
6. In the H2 Console, in the JDBC URL field, paste the copied URL.
7. In the User Name field, enter the user name. The default user name is tisadmin.
8. In the Password field, enter the password. The default password is tisadmin.
Copyright © 2017 General Electric Company. All rights reserved. • Page 111 of 495
Deploy APM Connect
9. Select Connect.
10. In the H2 Console, in the SQL statement pane, enter the following command: SET
PASSWORD '<password>'.
Note: The password must be in single quotes. Example: SET PASSWORD 'abcstrng!5'.
11. Select Run (Ctrl+Enter).
The H2 Console password is changed.
Copyright © 2017 General Electric Company. All rights reserved. • Page 112 of 495
Deploy APM Connect
Create APM Service User
Note: This step is completed automatically when you run the APM Connect installer.
These steps are included here for your reference if necessary.
Running jobs in the APM Connect Administration Center is perpetrated by users. The
apmService user is required in order to facilitate communication between APM Connect
and GE Digital APM.
Steps
1. In the APM Connect Administration Center, from the Menu pane, in the Settings
section, select the Users tab.
2. Select Add.
The Users pane appears.
3. Enter the user information into the empty fields as necessary according to the following table:
Field
Description
Value
Login
Email login for user
apmService@meridium.com
First name
User first name
apm
Last name
User last name
service
Password
User password
apmConnect (default password)
Type
Type of data migration
Data Integration/ESB
Role
User role
Operation manager
Active
Select check box to signify active
user
Must select check box
4. Select Save.
The apmService user is created, and it appears in the list of users.
Copyright © 2017 General Electric Company. All rights reserved. • Page 113 of 495
Deploy APM Connect
Deploy the Maximo Adapters
The checklists in this section of the documentation contain all the steps necessary for
deploying and configuring this module whether you are deploying the module for the
first time or upgrading from a previous module.
Copyright © 2017 General Electric Company. All rights reserved. • Page 114 of 495
Deploy APM Connect
Deploy Maximo Adapters for the First Time
The following table outlines the steps that you must complete to deploy and configure
this module for the first time. These instructions assume that you have completed the
steps for deploying the basic GE Digital APM system architecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Note: This GE Digital APM module is not available in the APM Now environment.
Step
Task
Notes
1
Deploy the APM Connect Base.
This step is required.
2
In GE Digital APM, assign security users to one or
This step is required.
more of the APM Connect Security Groups.
3
On the APM Connect sever, configure the context
This step is required.
file.
4
On the APM Connect server, encrypt passwords
in the context file.
None
5
On the APM Connect sever, import notification
management file.
This step is required.
6
In the APM Connect Administration Center, configure the context parameters.
This step is required.
7
In the APM Connect Administration Center, create the intermediate repository database.
None
8
Configure Site Reference Values.
This step is required only
if you want to modify the
default configuration for
Site References.
9
In Maximo, create object structures.
This step is required.
10
In Maximo, create web services.
This step is required only
if you are not using the
REST web services.
11
In Maximo, configure the default password.
This step is required.
12
In GE Digital APM, create EAM System records to
identify your Maximo systems.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 115 of 495
Deploy APM Connect
Upgrade Maximo to UDLP V2.2.0
The following table outlines the steps that you must complete to upgrade this module
to UDLP V2.2.0. These instructions assume that you have completed the steps for
upgrading the basic GE Digital APM system architecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Upgrade from any version EAM MAX V1.0.0 through EAM MAX
V2.0.0
Step
Task
Notes
1
Upgrade the APM Connect Base.
This step is required.
2
Complete the steps to deploy the Maximo
adapters for the first time.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 116 of 495
Deploy APM Connect
Maximo Interfaces Security Groups
The following table lists the baseline Security Groups available for users within this module, as well as the baseline Roles to which those Security Groups are assigned.
ŗIMPORTANT: Assigning a Security User to a Role grants that user the privileges associated with all of the Security Groups that are assigned to that Role. To avoid granting
a Security User unintended privileges, before assigning a Security User to a Role, be
sure to review all of the privileges associated with the Security Groups assigned to that
Role. Also be aware that additional Roles, as well as Security Groups assigned to existing Roles, can be added via Security Manager.
Security Group
Roles
MI CMMS Interface Administrator
MI Data Loader Admin
MI CMMS Interface User
MI Data Loader User
The baseline family-level privileges that exist for these Security Groups are summarized
in the following table.
Family
MI CMMS Interface
Administrator
MI CMMS Interface User
Entity Families
CMMS Interface
View, Update, Insert,
Delete
View
CMMS Mapping
View, Update, Insert,
Delete
View
CMMS System
View, Update, Insert,
Delete
View
Equipment
View, Update, Insert,
Delete
View
Functional Location
View, Update, Insert,
Delete
View
Interface Log
View, Update, Insert,
Delete
View
SAP System1
View, Update, Insert,
Delete
View
Site Reference
View
View
Copyright © 2017 General Electric Company. All rights reserved. • Page 117 of 495
Deploy APM Connect
Work History
View, Update, Insert,
Delete
View, Update,
Insert
Work History Detail
View, Update, Insert,
Delete
View, Update,
Insert
Equipment Has Equipment
View, Update, Insert,
Delete
View, Update,
Insert
Functional Location Has Equipment
View, Update, Insert,
Delete
View, Update,
Insert
Functional Location Has Functional
Location(s)
View, Update, Insert,
Delete
View, Update,
Insert
Has CMMS Interface
View, Update, Insert,
Delete
View
Has CMMS Mapping
View, Update, Insert,
Delete
View
Has CMMS System
View, Update, Insert,
Delete
View
Has Event Detail
View, Update, Insert,
Delete
View, Update,
Insert
Has SAP System
View, Update, Insert,
Delete
View
Relationship Families
Copyright © 2017 General Electric Company. All rights reserved. • Page 118 of 495
Deploy APM Connect
Configure SSL
Adapters in APM Now require an SSL certificate to transfer files. GE Digital will supply
you with an SSL certificate during installation.
Steps
1. Access the SSL truststore file that is provided during installation.
2. Copy the truststore file.
3. On your APM Connect Server, paste the truststore file in a secure file system location that is accessible by the APM Container service user.
4. In the context file, ensure that you have configured the following SSL Connection
parameters:
l
USE_SSL
l
TRUSTSTORE_FILE
l
TRUSTSTORE_PASSWORD
The Maximo Adapters are configured to use SSL.
Copyright © 2017 General Electric Company. All rights reserved. • Page 119 of 495
Deploy APM Connect
Configure the Maximo Context File
Steps
1. On the APM Connect server, navigate to the following folder: <root>:/APMConnect/Config.
2. Rename the folder RENAME_TO_SYSTEM_NAME to the name of the Maximo system that you are using.
3. Open the folder that you renamed, and then, using an XML editor or a text editor,
open the following file: ContextFile.xml.
The content in the context file appears in the editor, displaying the parameters
that you can configure for data extraction.
4. As needed, modify the values for the parameters in the context file, and then save
the file.
Your changes to the context file are saved.
What's Next?
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 120 of 495
Deploy APM Connect
Maximo Context File Parameters
The following table contains a list of parameters that you can configure in the Maximo
context file.
ŗIMPORTANT: Modifying the context file will override the configurations in the Context Parameters section of the APM Connect Administration Center.
Note: For parameters in the Functional Location Specific Filters, Equipment Specific
Filters, and Work History Specific Filters sections, you can enter multiple values by separating the values using commas.
Parameters
Description
Default or Recommended Value
Interface Mode Selection
MAXIMO_CLOUD_
ENABLED
LOAD_MERIDIUM_
APM
LOAD_DIGITAL_
APM
Determines if
the Adapter will
be used in a
cloud environment.
Determines if
data will be
loaded into the
Meridium database.
Determines if
data will be
loaded into the
Predix database.
You must enter one of the following values:
l
true: Adapter will run in the cloud.
l
false: Adapter will run on premises.
You must enter one of the following values:
l
l
true: Data will be loaded into the
Meridium database.
false: Data will not be loaded into the
Meridium database.
You must enter one of the following values:
l
l
true: Data will be loaded into the Predix
database.
false: Data will not be loaded into the
Predix database.
Intermediate Repository (IR) Connection
IR_HOST
The IP address
of the IR.
This value is unique for each user.
IR_PORT
The port number of the IR.
The default value is 5432.
IR_DATABASE
The database in
which the IR
data is stored.
This value is unique for each user.
Copyright © 2017 General Electric Company. All rights reserved. • Page 121 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
IR_SCHEMA
The schema
associated with
the IR.
The default value is Public.
IR_USER_ID
The IR user
name.
This value is unique for each user.
IR_PASSWORD
The IR system
password.
This value is unique for each user.
IR_TALEND_
OUTPUT
The shared
folder to which
the Maximo
Adapter will
write files.
This value is unique for each user.
APM Connect Connection
This value is unique for each user.
PG_ADMIN_USER
The administrator user
name for the
PostgreSQL IR.
This value is unique for each user.
PG_ADMIN_
PASSWORD
The administrator password for the
PostgreSQL IR.
CUSTOMER_NAME
The coded customer name.
Enter your unique value, which was provided
during installation.
This value is used when creating the IR database. You can remove the value in this field
after the database is created.
This value is used when creating the IR database. You can remove the value in this field
after the database is created.
APM Connection
Note: The APM Connection Parameters are not required for a cloud deployment.
APM_API_APP_
SERVER
The name of the
GE Digital APM
This value is unique for each user.
server.
APM_APP_SERVER
The name of the
GE Digital APM
This value is unique for each user.
server.
Copyright © 2017 General Electric Company. All rights reserved. • Page 122 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
APM_DATASOURCE
The name of the
GE Digital APM
data source to
This value is unique for each user.
which the data
will be exported.
APM_USERID
Your GE Digital
APM user ID.
This value is unique for each user.
APM_PASSWORD
Your GE Digital
APM password.
This value is unique for each user.
Maximo Connection for Extraction Interfaces
MAXIMO_USERID
The Maximo sysThis value is unique for each user.
tem user ID.
MAXIMO_
PASSWORD
The Maximo sysThis value is unique for each user.
tem password.
LANGUAGE
The alphabetical
code that represents the language used for
This value is unique for each user.
values in the
records that are
transferred to
GE Digital APM.
MAXIMO_REST_URL
The REST URL
for the Maximo
Interface. This
value is used if
you want to use
the REST web
services to communicate with
the Maximo system.
You must enter a value in the following
format: http://<maximohost>:<port>/maxrest/rest/os
This value is not required if the value for the
MAXIMO_WEBSERVICE_URL parameter is
false.
Note: REST services are not fully supported in Maximo versions 7.1 and 7.5.
Copyright © 2017 General Electric Company. All rights reserved. • Page 123 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
MAXIMO_
WEBSERVICE_URL
The web service
URL for the Maximo Interface.
This value is
used if you want
to use the SOAP
web services to
communicate
with the Maximo system.
MAXIMO_
WEBSERVICE
Determines the
type of web service to use.
MAXIMO_SYSTEM
The EAM System
name defined in This value is unique for each user, and must
the EAM System match the value in the Name field in the EAM
record in
System family in GE Digital APM.
GE Digital APM.
MAXIMO_
CONNECTION_
TIMEOUT
The duration,
measured in
seconds, until
which the Maximo Adapters
will wait for the
connection to
be established
with the Maximo system
before timing
out.
You must enter a value in the following
format: http://<maximohost>:<port>/meaweb/services
This value is not required if the value for the
MAXIMO_WEBSERVICE_URL parameter is true.
You must enter one of the following values:
l
l
true: Uses the SOAP web services.
false: Uses the REST web services. This
is the default value for this parameter.
The recommended value is 30.
Copyright © 2017 General Electric Company. All rights reserved. • Page 124 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
MAXIMO_RECEIVE_
TIMEOUT
The duration,
measured in
seconds, until
which the Maximo Adapters
The recommended value is 60.
will wait for the
response from
the Maximo system before timing out.
MAXIMO_REST_
ASSETNAME
This value is
based on the
Equipment
object structure The default value fis MIASSET.
that you created
in the Maximo
system.
MAXIMO_REST_
FLOCNAME
This value is
based on the
Functional Location object struc- The default value is MIOPERLOC.
ture that you
created in the
Maximo system.
MAXIMO_REST_
SRNAME
This value is
based on the
Service Request
object structure The default value is MISR.
that you created
in the Maximo
system.
MAXIMO_REST_
WONAME
This value is
based on the
Work Order
object structure The default value is MIWO.
that you created
in the Maximo
system.
Copyright © 2017 General Electric Company. All rights reserved. • Page 125 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
EXTRACT_NUM_
PARALLEL_JOBS
Determines the
maximum number of Maximo
background
The recommended value is 10.
jobs allowed
during extraction.
IR_LOAD_NUM_
PARALLEL_JOBS
Determines the
maximum number of Maximo
The recommended value is 10.
background
jobs allowed
during loading.
Common Filter
CHANGE_DATE_
START
The data extracted is restricted
to records
changed on or
after the date
specified for
this parameter.
CHANGE_DATE_
END
The data extracted is restricted
to records
changed on or
before the date
specified for
this parameter.
CHANGE_TIME_
START
The data extracted is restricted
to records
changed on or
after the time
specified for
this parameter.
A value is optional for this parameter.
You must enter a date in the following format:
YYYYMMDD
A value is optional for this parameter.
You must enter a date in the following format:
YYYYMMDD
A value is optional for this parameter.
You must enter time in the following format:
HHMMSS
Copyright © 2017 General Electric Company. All rights reserved. • Page 126 of 495
Deploy APM Connect
Parameters
Description
The data extracted is restricted
to records
CHANGE_TIME_END changed on or
before the time
specified for
this parameter.
SITE_ID
The site ID as
defined in
GE Digital APM.
Default or Recommended Value
A value is optional for this parameter.
You must enter time in the following format:
HHMMSS
A value is optional for this parameter. This
value is unique for each user.
Functional Location Specific Filter
LOCATION
A number that
identifies the
Functional Loca- A value is optional for this parameter. This
tion whose data value is unique for each user.
you want to
extract.
LOCATION_TYPE
The ID of the
Functional LocaA value is optional for this parameter. This
tion type whose
value is unique for each user.
data you want
to extract.
LOCATION_STATUS
The status of
the Functional
Location whose
data you want
to extract.
A value is optional for this parameter. This
value is unique for each user.
Equipment Specific Filter
ASSETNUM
The asset number of the asset A value is optional for this parameter. This
(s) that you want value is unique for each user.
to extract.
ASSET_TYPE
The ID of the
Asset type that
will limit the
assets extracted.
A value is optional for this parameter. This
value is unique for each user.
Copyright © 2017 General Electric Company. All rights reserved. • Page 127 of 495
Deploy APM Connect
Parameters
ASSET_STATUS
Description
Default or Recommended Value
The asset status
that will limit
A value is optional for this parameter. This
the Functional
value is unique for each user.
Locations extracted.
Work History Specific Filter
SERVICE_REQUEST_
NO
The Service
Request number that will
A value is optional for this parameter. This
limit the Service value is unique for each user.
Requests extracted.
SERVICE_REQUEST_
STATUS
The Service
Request status
that will limit
the data extracted.
A value is optional for this parameter. This
value is unique for each user.
WORK_ORDER_NO
The Work Order
number that
will limit the
Work Orders
extracted.
A value is optional for this parameter. This
value is unique for each user.
WORK_ORDER_
TYPE
The type of
Work Order that
A value is optional for this parameter. This
will limit the
value is unique for each user.
Work Orders
extracted.
WORK_ORDER_
SYSTEM_STATUS
The Work Order
system status
that will limit
the Work
Orders extracted.
A value is optional for this parameter. This
value is unique for each user.
Copyright © 2017 General Electric Company. All rights reserved. • Page 128 of 495
Deploy APM Connect
Parameters
WORKORDER_OR_
SERVICEREQUEST_
FILTER
Description
Determines if
the Maximo Service Requests or
Work Orders
will be transferred to and
from GE Digital
APM.
Default or Recommended Value
For Work Order and Service Request extraction jobs, a value is required for this parameter. You can enter one of the following
values:
l
l
SERVICEREQUEST: Loads only Service
Requests.
WORKORDER: Loads only Work Orders.
This is the default value.
Note: If no value is entered for this parameter, then both Service Requests and
Work Orders will be extracted.
Miscellaneous
You must enter one of the following values:
l
MANUAL_RUN
Determines
how the date
parameters will
be treated.
LOG_REQUEST
Determines if
the GE Digital
APM web service requests
must be logged.
LOG_RESPONSE
Determines if
the GE Digital
APM web service responses
must be logged.
l
true: The dates specified in the context
file will be used. Additionally, the dates
of the last successful run stored in the
database will not be updated.
false: The date range used during the
extraction will be the date of the last successful record, as stored in the database. Each time a job is run
successfully, the database is updated
with those dates, and all subsequent
runs will use the dates from the last successful record.
You must enter one of the following values:
l
l
true: Enables log creation for requests.
false: Disables log creation for requests.
This is the recommended value.
You must enter one of the following values:
l
l
true: Enables log creation for responses.
false: Disables log creation for
responses. This is the recommended
value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 129 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
REST_FILTER_LIMIT
A numeric value
that indicates
the number of
records that are The default value is 100.
extracted in one
load in the failure table.
MAXIMO_RS_
COUNT
Limits the
amount of Maximo records
The default value is 1,000.
extracted in one
load.
Maximo Notification Management
ŗIMPORTANT: You must configure the Maximo parameters for the parameters that
correspond to your version of Maximo. For example, if you are using Maximo 76,
configure the parameters in the MAXIMO76 section.
MAXIMO_USERID
The Maximo sysThis value is unique for each user.
tem user ID.
MAXIMO_
PASSWORD
The Maximo sysThis value is unique for each user.
tem password.
LANGUAGE
The alphabetical
code that represents the language used for
values in the
This value is unique for each user.
records that are
transferred
from GE Digital
APM.
Copyright © 2017 General Electric Company. All rights reserved. • Page 130 of 495
Deploy APM Connect
Parameters
MAXIMO_REST_URL
Description
The REST URL
for Maximo
Interface. This
value is used if
you want to use
the REST web
services to communicate with
the Maximo system.
Default or Recommended Value
You must enter a value in the following
format: http://<maximohost>:<port>/maxrest/rest/os
This value is not required if the value for the
MAXIMO_WEBSERVICE_URL parameter is
false.
Note: REST services are not fully supported in Maximo versions 7.1 and 7.5.
MAXIMO_
WEBSERVICE_URL
The web service
URL for Maximo
Interface. This
value is used if
you want to use
the SOAP web
services to communicate with
the Maximo system.
MAXIMO_
CONNECTION_
TIMEOUT
The duration,
measured in
seconds, until
which the Maximo Adapters
will wait for the
connection to
be established
with the Maximo system
before timing
out.
MAXIMO_RECEIVE_
TIMEOUT
The duration,
measured in
seconds, until
which the Maximo Adapters
The recommended value is 60.
will wait for the
response from
the Maximo system before timing out.
You must enter a value in the following
format: http://<maximohost>:<port>/meaweb/services
This value is not required if the value for the
MAXIMO_WEBSERVICE_URL parameter is true.
The recommended value is 30.
Copyright © 2017 General Electric Company. All rights reserved. • Page 131 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
MAXIMO_REST_
SRNAME
This value is
based on the
Service Request
object structure The default value is MISR.
that you created
in the Maximo
system.
MAXIMO_REST_
WONAME
This value is
based on the
Work Order
object structure The default value is MIWO.
that you created
in the Maximo
system.
MAXIMO_CREATE_
WO_SR
Determines if
the Maximo
Adapter will
transfer Maximo Work
Orders or Service Requests.
The site ID in
MAXIMO_DEFAULT_
the Maximo
SITE_ID
records.
For Notification Management jobs, a value is
required for this parameter. You can enter
one of the following values:
l
WO: Will transfer only Work Orders.
l
SR: Will transfer only Service Requests.
This value is unique for each user. You can
enter the value of the Site record that is linked
to the EAM System records that you are loading to Maximo.
Queue
Note: The Queue parameters apply only to a cloud deployment.
QUEUE_HOST
The queue host
name.
Enter your unique value, which was provided
during installation.
QUEUE_HOST_1
The additional
queue host
name.
Enter your unique value, which was provided
during installation.
QUEUE_HOST_2
The additional
queue host
name.
Enter your unique value, which was provided
during installation.
QUEUE_PORT
The queue port.
Enter your unique value, which was provided
during installation.
Copyright © 2017 General Electric Company. All rights reserved. • Page 132 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
QUEUE_PORT_1
The additional
queue port.
Enter your unique value, which was provided
during installation.
QUEUE_PORT_2
The additional
queue port.
Enter your unique value, which was provided
during installation.
QUEUE_USER
The queue user
name.
Enter your unique value, which was provided
during installation.
QUEUE_PASSWORD
The queue pass- Enter your unique value, which was provided
word.
during installation.
CUSTOMER_NAME
The coded customer name.
Enter your unique value, which was provided
during installation.
Email Notification
Note: The Email Notification parameters apply only to a cloud deployment.
EMAIL_TO
Email address
(es) to which the
Enter your unique value.
email will be
sent.
EMAIL_FROM
Email address
from which the
email will be
sent.
Enter your unique value.
REPORT_TARGET_
DIR
Directory where
the report file
will be
delivered.
Enter your unique value.
FAILURE_DETAIL_
REPORT_JRXML_
FILE_PATH
Directory where
the failure
report file will
be delivered.
Enter your unique value.
LOAD_SUMMARY_
REPORT_JRXML_
FILE_PATH
Directory where
the load complete report file
will be
delivered.
Enter your unique value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 133 of 495
Deploy APM Connect
Parameters
Description
Default or Recommended Value
SMTP_HOST
Host for SMTP
installation on
the APM Connect server.
Enter your unique value.
SMTP_PORT
Port for SMTP.
The default value is 25.
LOAD_SUMMARY_
REPORT_ENABLED
Indicates
whether the
load complete
report will be
loaded with
each extraction.
You must enter one of the following values:
l
l
true: The load complete report, detailing the number of records that were
extracted and successfully loaded into
GE Digital APM, will be sent.
false: The load complete report will not
be sent.
You must enter one of the following values:
FAILURE_DETAIL_
REPORT_ENABLED
Indicates
whether the failure detail report
will be sent
when a record
fails to load.
l
l
true: The failure detail report, detailing
the records that failed to load into
GE Digital APM and the reason for failure, will be sent.
false: The failure detail report will not
be sent.
SFTP
Note: The SFTP parameters apply only to a cloud deployment.
SFTP_HOST
The SFTP server
host name.
Enter your unique value, which was provided
during installation.
SFTP_USERID
The SFTP server
user name.
Enter your unique value, which was provided
during installation.
SFTP_PASSWORD
The SFTP server
password.
Enter your unique value, which was provided
during installation.
SFTP_PORT
The SFTP server
port.
Enter your unique value, which was provided
during installation.
Directory where
SFTP_LANDING_DIR the shared files
are stored.
Enter your unique value, which was provided
during installation.
Copyright © 2017 General Electric Company. All rights reserved. • Page 134 of 495
Deploy APM Connect
Parameters
USE_SSH_KEY
Description
Determines if
the SSH security
configuration
will be used by
the adapters.
Default or Recommended Value
You must enter one of the following values:
l
l
true: SSH security configuration will be
used.
false: SSH security configuration will not
be used.
Enter your unique value.
SSH_PRIVATE_KEY
Directory where
the SSH key is
stored.
The SSH key must be generated by the user in
the openSSH format. This key can be stored in
any directory on the APM Connect server, but
it is recommended to store it in the following
folder: C:\APMConnect\Config
Copyright © 2017 General Electric Company. All rights reserved. • Page 135 of 495
Deploy APM Connect
About Site Reference Configuration via the autojoin_control Table
The Equipment, Functional Location, and Work History records that are imported to
GE Digital APM are assigned to a Site based on a Site Reference. In the Maximo adapter,
the Site Reference is configured using the autojoin_control table in the Intermediate
Repository. In the table, the value in the site_reference column in each row defines the
Site that must be used while loading the data defined by the SQL statement specified in
that row. To modify the value assigned as the Site in the imported records, you must
modify the value in the site_reference column.
ŗIMPORTANT: Site records corresponding to the Sites that you want to assign to the
records must exist in GE Digital APM before you can import the records.
You can configure Site Reference in one of the following ways:
l
l
Direct Site Reference: The Site Reference is configured with a specific site name
(e.g., Site 100).
Indirect Site Reference: The Site Reference is configured to use the value in a specific GE Digital APM field to assign the Site in the imported records. The following
fields can be used as Site References for records extracted from Maximo Systems:
l
MI_FNCLOC00_SITE_C
l
MI_EQUIP000_SITE_C
By default, in the autojoin_control table, the site_reference column contains the following values:
l
#MI_FNCLOCOO_SITE_C# for Functional Location records
l
#MI_EQUIPOO_SITE_C# for Equipment records
These values indicate that the site assigned to the Functional Location and Equipment
records is determined by the value in the SITEID field in the Maximo system.
Additionally, in the autojoin_control table, if the value in the site_reference column is
null or blank in a row, the records will be assigned with a Site based on the value specified in the defaut_site_reference column. The default value in the default_site_reference column is *Global*, which assigns the Site Global to the imported records.
In the autojoin_control table, the value in the site_reference column for the rows that
define relationships of the Work History with Functional Locations and Equipment,
determines the Site assigned to the Work History records loaded by the Maximo
adapters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 136 of 495
Deploy APM Connect
The autojoin_control Table
The autojoin_control table is used to customize the data that is loaded into GE Digital
APM. Each row in the table contains an SQL statement that defines the fields that must
be imported to GE Digital APM. You can also specify the value to be used as Site Reference using the autojoin_control table. The following columns are available in the autojoin_control table:
Column
Description
AUTOJOIN_ID
An integer value used to identify each row in the table.
BATCH_NAME
The name of the batch to which the query belongs. When a job for
loading data is processed, queries with the same BATCH_NAME are
run together.
TABLE_NAME
The name specified in this column along with the unique ID for the
job is used to define the name of the temporary table that is created
to store the data extracted using the SQL statement specified in the
row.
SQL_
EXECUTION_
ORDER
The sequence in which the SQL statements will be run when they are
processed in batches. Within a batch, SQL statements for rows with
lower numbers in this column will be run first.
SQL
An SQL SELECT statement that defines the data that will be loaded to
GE Digital APM. The results of this statement are copied to the temporary table, whose name is defined by the unique ID of the job and
the value in the TABLE_NAME column. The columns defined in the
SELECT statement must match the column names in the GE Digital
APM family to which the data is being loaded.
SITE_
REFERENCE
APM_SITE_
REFERENCE_
COLUMN
The value used to determine the Site assigned to records generated
for the corresponding SQL statement. You can configure this value
to modify the Site Reference.
The default value is #MI_FNCLOCOO_SITE_C# for Functional Location
records and #MI_EQUIPOO_SITE_C# for Equipment records, indicating that the site assigned to the records is determined by the value
in the SITEID field in the Maximo system.
The GE Digital APM field that is used to store the names of the Site.
Unless you have customized the GE Digital APM database, this value
should be MI_SITE_NAME.
Copyright © 2017 General Electric Company. All rights reserved. • Page 137 of 495
Deploy APM Connect
APM_SITE_
REFERENCE_
FAMILY
The GE Digital APM family to which the Site Reference will be
applied. When the relationship is being built within the records of
the same entity, the value is <PRED_FAMILY_ID>. Unless you have
customized the GE Digital APM database, you do not need to modify
this value.
Specifies whether the row is for an entity or a relationship family.
USE_
RELATIONSHIP_ If the row is used to populate a relationship family, the value is 1.
Otherwise, the value is 0. This affects the way relationship references
LOOKUP
are defined in the resulting SQL statements.
A value that indicates the Site Reference that should be used in one
of the following scenarios:
l
DEFAULT_SITE_
REFERENCE
The value in the site_reference column is null.
-orl
The value in the field specified in the site_reference column
for indirect site reference is null.
If you want to assign the site as global, in this field, you must enter
*Global*. If you want to assign a site to the records, you must enter
the name of a site.
Copyright © 2017 General Electric Company. All rights reserved. • Page 138 of 495
Deploy APM Connect
Encrypt Passwords
Passwords in the APM Connect context file are not encrypted by default. However, you
can encrypt any password manually. This topic describes how to manually encrypt passwords.
Steps
1. On the machine on which you installed APM Connect, access the APM Connect
installation package, locate the Encrypt String_0.1.zip, and then unzip the file.
2. Open the EncryptString folder, and then select EncryptString_run.bat.
A command prompt opens, and then the Talend Open Studio window appears.
3. Enter the password that you want to encrypt in the Enter the text to be encrypted:
box.
4. Select OK.
5. In the command prompt, between the banners, copy the text that was generated.
6. Open the context file.
7. In the parameter that you want to encrypt, paste the generated text.
8. Append the highlighted parameter the with _AES, as shown in the following image.
9. Save the context file.
10. For each password that you want to encrypt, repeat steps 2 through 9.
The passwords are encrypted.
What's Next?
Return to the adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 139 of 495
Deploy APM Connect
Import Notification Management File
ŗIMPORTANT: Maximo does not support notification generation for multiple EAM
systems.
Steps
1. On the APM Connect server, navigate to the following folder: <root:>/APMConnect/Config
2. Copy the file Maximo_NotificationManagement.cfg to the following directory:
<root:>\APMConnect\Utilities\runtime\etc
3. Modify the file such that the following parameters have the stated values:
l
context = Default
l
CONFIG_FILE_PATH = <The directory path to your Maximo Context File>
Note: The path must use forward slashes (/).
4. Save the file.
5. Access the APM Connect installation package, and then copy the following file:
Maximo_NotificationManagement.jar
6. Navigate to the following directory: <root:>\APMConnect\Utilities\runtime\deploy
7. Paste the copied file Maximo_NotificationManagement.jar in the directory.
The Notification Management File is imported.
What's Next?
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 140 of 495
Deploy APM Connect
Configure Context Parameters
Steps
1. In the APM Connect Administration Center, in the Job Conductor workspace, select
the MAXIMO_MASTER_INTERFACE Job.
2. At the bottom of the Job Conductor workspace, select Context parameters.
The Context parameters section appears, displaying the following parameters:
Context Parameter
Description
CONFIG_FILE_DIRECTORY
The file path to context files
for the jobs.
SYSTEM_TO_RUN
Name of the folder in which
the context file is stored,
and is the <system name>
folder.
LOG4J_CONFIG_FILE
The file path for Log4j.
RUN_WORKHISTORY
The Work History Job.
RUN_EQUIPMENT
The Equipment Job.
RUN_FLOC
The Functional Location Job.
3. Select the Active check box for each parameter whose custom value you want to
edit.
4. To save the custom value, press Enter.
5. In the CONFIG_FILE_DIRECTORYCustom value box, enter the directory where the
context files are stored. If the default configuration was followed, the path will be
the following: <root:>\APMConnect\Config.
6. Press Enter.
7. In the SYSTEM_TO_RUNCustom value box enter:
l
The name of the system directory from which you want to extract data.
-or-
l
* to extract from all systems.
8. Press Enter.
The master job is configured.
What's Next?
Copyright © 2017 General Electric Company. All rights reserved. • Page 141 of 495
Deploy APM Connect
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 142 of 495
Deploy APM Connect
Create the Intermediate Repository Database
Before you can run an extraction job, you must prepare the intermediate repository.
This topic describes how to set up a repository in preparation to run your first job.
Note: For SAP adapters, you must first run the Static Data job.
ŗIMPORTANT: If you are using the Data Loaders and the SAP Adapters, you must
deploy and run the CreateIntermediateRepository job for each set of adapters.
Before You Begin
l
Before you can prepare and deploy the repository, you must import the Create
Intermediate Repository Job.
Steps
1. Open and log in to the APM Connect Administration Center web application.
Note: The user logging in must have access to the Job Conductor by being designated the Operations Manager role. By default, users designated as administrators do not have Job Conductor permissions.
2. In the Job Conductor workspace, in the appropriate project, select the CreateIntermediateRepository Job.
3. At the bottom of the Job Conductor workspace, select Context parameters.
The Context parameters section appears.
4. Configure the following parameters:
Context Parameter
Description
The file path to context files
for the jobs.
CONFIG_FILE_PATH
ŗIMPORTANT: You must
change the default value to
reflect the actual path to
your configuration file.
Copyright © 2017 General Electric Company. All rights reserved. • Page 143 of 495
Deploy APM Connect
IR_DATABASE
Enter your APM Connect
database name.
The default value is DINODB.
IR_HOST
Enter your APM Connect
server name. The default
value is localhost.
IR_PORT
Enter your APM Connect
server port. The default
value is 5432.
IR_SCHEMA
The schema for your APM
Connect database. The
default value is public.
IR_USERID
Enter your APM Connect
database username.
IR_PASSWORD
Enter your APM Connect
database password.
LOG4J_CONFIG_FILE
The file path to the log4j configuration file.
PG_ADMIN_PASSWORD
The password for the PostgreSQL IR.
PG_ADMIN_USER
The user name for the PostgreSQL IR.
5. Select Run.
The intermediate repository is created for the project.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
-or-
l
Return to the Maximo Adapter workflow for the next steps in the deployment process.
-or-
l
Return to the Data Loader workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 144 of 495
Deploy APM Connect
Configure Site Reference Values
This topic describes how to modify the autojoin_control table in the Intermediate Repository, to assign site references to records using values other than those in the default
configuration.
ŗIMPORTANT: Site records corresponding to the Sites that you want to assign to the
records must exist in GE Digital APM before you can import the records.
Steps: Configure the Site Reference Value to Use an Indirect Site
Reference Value
1. Using a database browser tool, access your Intermediate Repository.
A list of tables available in the repository appears.
2. In the list of tables, navigate to the autojoin_control table, and then, in the data
available for the table, locate the site_reference column.
3. For each row in which you want to modify the Site Reference, in the site_reference column, modify the value using the following format: #FIELD_ID#, where
FIELD_ID represents the ID of the GE Digital APM field from which you want to populate the site reference value.
For example, if you want the Site Reference for the Equipment and Functional
Location records to be assigned with the name of the CMMS System from which
the data was extracted, then modify the value in the site_reference column with
the following values:
l
l
Where the value #MI_EQUIPOO_SITE_C# occurs, replace the value with #MI_
EQUIP000_SAP_SYSTEM_C#.
Where the value #MI_FNCLOC00_SITE_C# occurs, replace the value with #MI_
FNCLOC00_SAP_SYSTEM_C#.
MI_EQUIP000_SAP_SYSTEM_C and the MI_FNCLOC00_SAP_SYSTEM_C are fields in
the Equipment and Functional Location records that store the name of the CMMS
System.
4. Save the autojoin_control table.
Your changes are saved. When you import records into GE Digital APM from your
Maximo system, the site assigned to the records will be based on the Site Reference that you specified in the autojoin_control table.
Steps: Configure the Site Reference Value to Use a Direct Site
Reference
Copyright © 2017 General Electric Company. All rights reserved. • Page 145 of 495
Deploy APM Connect
1. Using a database browser tool, access your Intermediate Repository.
A list of tables available in the repository appears.
2. In the list of tables, navigate to the autojoin_control table, and then, in the data
available for the table, locate the site_reference column.
3. For each row in which you want to modify the Site Reference, in the site_reference column, replace the value with the name of the Site that you want to
assign to the records.
4. Save the autojoin_control table.
Your changes are saved. When you import records into GE Digital APM from your
Maximo system, the site assigned to the records will be the Site that you specified
in the autojoin_control table.
What's Next?
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 146 of 495
Deploy APM Connect
Create Object Structures in Maximo
To connect your Maximo system and your GE Digital APM system, you will need to create object structures in Maximo for the following:
l
Asset
l
Location
l
Work Order
l
Service Request
Steps: Create Object Structure - Asset
1. In the Go To Application column, select Integration, and select Object Structures.
The Object Structure page appears.
2. In the Object Structure box, enter MXASSET, and then open the object structure.
3. In the Go To Application column, in the More Actions section, select Duplicate
Object Structure.
4. Enter the Object Structure name MIASSET.
5. In the Source Object for MIASSET section, remove all objects except the ASSET
object.
6. In the Go To Application column, in the More Actions section, select Exclude/
Include Fields.
The Exclude/Include Fields window appears.
7. On the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following fields:
l
ASSETID
l
ASSETNUM
l
ASSETTYPE
l
CHANGEDATE
l
DESCRIPTION
l
INSTALLDATE
l
ITEMNUM
l
LOCATION
Copyright © 2017 General Electric Company. All rights reserved. • Page 147 of 495
Deploy APM Connect
l
MANUFACTURER
l
PRIORITY
l
SERIALNUM
l
SITEID
l
STATUS
l
VENDOR
l
WARRANTYEXPDATE
8. On the Non-Persistent Fields tab, select the Include? check box on the row corresponding to the following field:
l
DESCRIPTION_LONGDESCRIPTION
9. Select OK.
Steps: Create Object Structure - Location
1. In the Go To Application column, select Integration, and select Object Structures.
The Object Structure page appears.
2. In the Object Structure box, enter MXOPERLOC, and then open the object structure.
3. In the Go To Application column, in the More Actions section, select Duplicate
Object Structure.
4. Enter the Object Structure name MIOPERLOC.
5. In the Source Object for MIOPERLOC section, remove all objects except the
LOCATION object.
6. Add the ASSET object with LOCATION as parent and ASSET as relationship.
7. In the Go To Application column, in the More Actions section, select Exclude/
Include Fields.
The Exclude/Include Fields window appears.
8. On the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following Fields:
l
CHANGEDATE
l
DESCRIPTION
Copyright © 2017 General Electric Company. All rights reserved. • Page 148 of 495
Deploy APM Connect
l
LOCATION
l
LOCATIONSID
l
SITEID
l
STATUS
l
TYPE
9. On the Non-Persistent Fields tab, select the Include ? check box on the row corresponding to the following fields:
l
FAILURECODE
l
PARENT
l
LOCPRIORITY
l
DESCRIPTION_LONGDESCRIPTION
10. Select OK.
Steps: Create Object Structure - Work Order
1. In the Go To Application column, select Integration, and select Object Structures.
The Object Structure page appears.
2. In the Object Structure box, enter MXWO, and then open the object structure.
3. In the Go To Application column, in the More Actions section, select Duplicate
Object Structure.
4. Enter the Object Structure name MIWO.
5. In the Source Object for MIWO section, remove all objects except the WORK
ORDER object.
6. In the Go To Application column, in the More Actions section, select Exclude/
Include Fields.
The Exclude/Include Fields window appears.
7. On the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following Fields:
l
ACTFINISH
l
ACTLABCOST
l
ACTLABHRS
Copyright © 2017 General Electric Company. All rights reserved. • Page 149 of 495
Deploy APM Connect
l
ACTMATCOST
l
ACTSERVCOST
l
ACTSTART
l
ACTTOOLCOST
l
ACTTOTALCOST
l
ASSETLOCPRIORITY
l
ASSETNUM
l
CALCPRIORITY
l
CHANGEBY
l
CHANGEDATE
l
CREWID
l
DESCRIPTION
l
ESTLABCOST
l
ESTLABHRS
l
ESTMATCOST
l
ESTSERVCOST
l
ESTTOOLCOST
l
JPNUM
l
JUSTIFYPRIORITY
l
LEAD
l
LOCATION
l
OUTLABCOST
l
OUTMATCOST
l
OUTTOOLCOST
l
PMNUM
l
REPORTDATE
l
SCHEDFINISH
l
SCHEDSTART
l
SITEID
Copyright © 2017 General Electric Company. All rights reserved. • Page 150 of 495
Deploy APM Connect
l
STATUS
l
TARGCOMPDATE
l
TARGSTARTDATE
l
WONUM
l
WOPRIORITY
l
WORKTYPE
8. On the Non-Persistent Fields tab, select the Include ? box on the row corresponding to the following Fields:
l
DESCRIPTION_LONGDESCRIPTION
9. Select OK.
Steps: Create Object Structure - Service Request
1. In the Go To Application column, select Integration, and select Object Structures.
The Object Structure page appears.
2. In the Object Structure box, enter MXSR, and then open the object structure.
3. In the Go To Application column, in the More Actions section, select Duplicate
Object Structure.
4. Enter the Object Structure name MISR.
5. In the Source Object for MIWO section, remove all objects except the service
request object.
6. In the Go To Application column, in the More Actions section, select Exclude/
Include Fields.
The Exclude/Include Fields window appears.
7. On the Persistent Fields tab, clear the Exclude? check boxes on the rows corresponding to the following Fields:
l
ASSETNUM
l
DESCRIPTION
l
LOCATION
l
SITEID
l
TICKETID
Copyright © 2017 General Electric Company. All rights reserved. • Page 151 of 495
Deploy APM Connect
8. On the Non-Persistent Fields tab, select the Include ? box on the row corresponding to the following Fields:
l
DESCRIPTION_LONGDESCRIPTION
9. Select OK.
What's Next?
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 152 of 495
Deploy APM Connect
Create Web Services in Maximo
Note: You must only complete this step if you are not using the REST services. REST
services are not fully supported in Maximo versions 7.1 and 7.5.
To complete the connection between your Maximo and your GE Digital APM System,
you need to deploy each of the following web services in your Maximo system:
l
MIASSET
l
MIOPERLOC
l
MIWO
l
MISR Steps
1. On the Go To Applications menu, select Integration, and then select Web Service
Library.
The Web Services Library page appears.
2. In the More Actions section, select Create Web Service, and then select Create
Web Service from Object Structure.
The Create Web Service from an Object Structure Service Definition window
appears.
3. In the Source Name column, select the check box next to the web service name
you want to create, and then select Create.
The web service name appears in the Web Services Library list.
4. In the More Actions tab, select Deploy to Product Web Service Container, and
then select Deploy Web Service.
5. Repeat Steps 1-4 to create the remaining web services.
What's Next?
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 153 of 495
Deploy APM Connect
Configure the Default Password
If you have enabled web service authentication in your Maximo system, then you must
configure a default user name and password in Maximo.
Steps
1. In Maximo, select System configuration, and then select Platform configuration,
and then select System properties.
2. Search for the following property: mxe.int.dfltuser.
3. For the mxe.int.dfluser property set the default user as mxintadm.
4. Refresh your Maximo system, and then search for the following property mxe.int.dfltuserpassword.
5. For the mxe.int.dfltuserpassword property, enter your default password, and then
refresh your Maximo system.
The default user name and password are configured.
Results
l
After configuring the default user name and password, you can run the web service, and authentication will be accomplished through the default user and password.
What's Next?
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 154 of 495
Deploy APM Connect
Set System Properties Settings for Web Service
Response
Steps
1. In the Go To Application column, select System Configuration, select Platform configuration, and then select System Properties.
The System Properties page appears displaying the Global Properties and
Instance Properties.
2. In the Global Properties section, navigate the property mxe.int.keyresponse.
3. On the mxe.int.keyresponse row, select .
The row is expanded, and the Global Properties Details appear.
4. In the Global Value box, enter 1.
The Global Value is equal to 1.
Results
l
Setting the Global Value to one enables Service Request numbers or Work Order
numbers on GE Digital APMRecommendation to be updated and the Request
Number field will be populated. It allows the response returned during the update
to contain key elements and will prevent the value from being null.
What's Next?
l
Return to the Maximo Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 155 of 495
Deploy APM Connect
Create EAM System Records
Steps
1. Create a new record , using the EAM System family.
2. In the Name box, enter the name of the Maximo system.
3. To populate the System ID: box, you must run the following query: UPDATE [MI_
SAPSYSTM] SET [MI_SAPSYSTM].[MI_SAPSYSTM_ID_C] = '<NAME>'
WHERE [MI_SAPSYSTM].[MI_SAPSYSTM_NAME_C] LIKE '%<NAME>%'
ŗIMPORTANT: In the query, you must replace <NAME> with the value you
entered into the Name box. By doing so, when you test the connection to the
Maximo system, the value in the Name field will match the value that will be populated automatically in the System ID field.
4. If this Maximo system is the system to and from which you want to send data by
default, select the Default EAM System? check box.
Results
l
l
An EAM system record is created for the EAM system to and from which you want
to establish a connection with GE Digital APM. This record should now be used to
link Site Reference.
Linking an EAM system to an EAM System record enables the APM Connect
Adapters to create Notifications against that EAM System.
What's Next?
l
Return to the Maximo workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 156 of 495
Deploy APM Connect
Deploy the SAP Adapters
The checklists in this section of the documentation contain all the steps necessary for
deploying and configuring this module whether you are deploying the module for the
first time or upgrading from a previous module.
Copyright © 2017 General Electric Company. All rights reserved. • Page 157 of 495
Deploy APM Connect
Deploy the SAP Adapters for the First Time
The following table outlines the steps that you must complete to deploy and configure
this module for the first time. These instructions assume that you have completed the
steps for deploying the basic GE Digital APM system architecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Step
Task
Notes
1
Deploy the APM Connect Base.
This step is required.
2
On the APM Connect Server, configure the context file directory.
This step is required.
3
On the APM Connect Server, configure the directory for multiple SAP
systems.
This step is required only if you are
using multiple SAP systems.
4
On the APM Connect Server, install
the SAP Java connector.
This step is required.
5
On the APM Connect Server, configure SSL.
This step is required.
6
On the APM Connect Server, configure the context file.
This step is required.
7
On the APM Connect Server, encrypt
passwords.
This step is required.
8
In the APM Connect Administration
Center, configure the context parameters.
This step is required.
9
Configure site filtering.
This step is required only if you do not
want to use the baseline configuration
for site references.
10
On the APM Connect Server and the
SAP server, mount a file share.
This step is required.
11
On the SAP Server and in SAP, establish SFTP Transfer in SAP.
This step is required only if you are
using SFTP to transfer files between
SAP and GE Digital APM and you are
not using the SAP PI Adapters.
12
On your SAP server, create file share
folder structure.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 158 of 495
Deploy APM Connect
13
In SAP, install the SAP Adapters ABAP
base service pack add-on.
This step is required.
14
In SAP, verify the SAP ABAP add-on.
This step is required.
ŗIMPORTANT: Each of the following tasks may be required depending on the
license that you have purchased and the APM Connect component that you are
deploying.
15
In SAP, identify the Operation values
that will be used to trigger the management of Inspection Task and Calibration Task records.
This step is required only if you are
using the Work Management Adapter.
16
In GE Digital APM, assign the desired
Security Users to the SAP Adapters
Security Groups.
This step is required.
17
In GE Digital APM, configure the
GE Digital APM system to create Noti- This step is required only if you are
fications from Recommendation
using the Notification Management
records belonging to customerAdapter.
defined Recommendation families.
18
Deploy the RFC Connector files.
The step required.
19
Deploy and configure the
RFC Connector configuration file.
This step is required only if you are
deploying SAP PI on-premises.
20
In GE Digital APM, configure the Priority values.
This step is required only if you are
using the Notification Management
Adapter.
This step is required only if you are
using one or more of the following:
21
In GE Digital APM, create EAM System
records to identify your SAP system
(s).
l
l
l
Work Management Adapter
Technical Characteristic
Adapters
Notification Management
Adapter
Copyright © 2017 General Electric Company. All rights reserved. • Page 159 of 495
Deploy APM Connect
This step is required only if you are
using the on-premises:
l
l
22
In GE Digital APM, test the SAP connection information that you specified in your EAM System records.
l
Work Management Adapter
Technical Characteristic
Adapters
Notification Management
Adapter
Note: This step is not required if
you are using the SAP Cloud
Adapters.
23
In the APM Connect Administration
Center, create the intermediate repos- This step is required.
itory.
24
In the APM Connect Administration
Center, run the Static Data job.
This step is required.
25
In GE Digital APM, configure SAP task
and confirmation creation.
This step is required only if you are
using the Work Management Adapter.
26
In GE Digital APM, configure the Get
Tasks for Work Order Generation
query.
This step is required only if you are
using the Work Management Adapter.
27
In GE Digital APM, create a scheduled
item to create Work Orders in SAP.
This step is required only if you are
using the Work Management Adapter.
28
In GE Digital APM, identify Classifications whose Characteristics you
want to extract.
This step is required only if you are
using the Technical Characteristic
Adapters.
29
In GE Digital APM, identify Characteristics that you want to extract.
This step is required only if you are
using the Technical Characteristic
Adapters.
30
Deploy the SAP PI Adapters for the
first time.
This step is required only if you are
deploying SAP PI on-premises.
Copyright © 2017 General Electric Company. All rights reserved. • Page 160 of 495
Deploy APM Connect
Upgrade SAP Adapters to SAP UDLP V2.2.0
The following tables outline the steps that you must complete to upgrade this module
to SAP UDLP V2.2.0. These instructions assume that you have completed the steps for
upgrading the basic GE Digital APM system architecture.
The steps that you must complete may vary depending on the version from which you
are upgrading. Follow the workflow provided in the appropriate section.
Upgrade from EAM SAP V1.5.0 through UDLP V2.1.0
Step
Task
Notes
1
Upgrade the APM Connect Base.
This step is required.
2
Complete the steps to deploy the SAP adapters
for the first time.
This step is required.
Upgrade from APM Connect V1.0.0 through V1.3.0
Step
Task
Notes
1
Upgrade the APM Connect Base.
This step is required.
2
Complete the steps to deploy the SAP adapters
for the first time.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 161 of 495
Deploy APM Connect
Configure the Context File Directory
Steps
1. On the APM Connect server, access your APM Connect installation package, and
then navigate to the Jobs folder.
2. Access the context file, and then copy the file.
3. Navigate to the directory C:\APMConnect\Config.
4. Rename the folder RENAME_TO_SYSTEM_NAME to represent the name of your
system. This folder will define the Systems Context Directory.
5. Paste the context file, in the C:\APMConnect\Config\<System_Name> directory you
renamed in step 4.
6. Delete the file place context file here and delete this file.deleteme.
The Context File Directory is configured.
What's Next?
l
Return to the adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 162 of 495
Deploy APM Connect
Configure the Context File Directory for Multiple
SAP Systems
ŗIMPORTANT: This step is required only if you are using multiple SAP Systems from
which you plan on extracting data. If you are not using multiple SAP systems, you can
skip this procedure and proceed to the next step, install the SAP Java connector, in the
APM Connect Base First-Time Deployment Workflow.
APM Connect allows you to extract data from multiple SAP Systems using the Master Job
to extract from multiple systems. You must set up the appropriate directory structures.
Additionally, jobs are automatically configured to run a full extraction or load per context file for each job cycle, allowing different configurations per SAP System.
Steps
1. On the machine on which you installed APM Connect, navigate to the following location: C:\APMConnect\Config\.
2. Create a new folder for each SAP System using the following folder structure:
C:\APMConnect\Config\<SAP System Name>.
3. In each SAP system folder, place a copy of the context file.
4. Label each copy of the context file using the following format: SAP_<system
name>_Contextfile.xml.
ŗIMPORTANT: You must label the context file with SAP_ at the beginning of the
file name, or APM Connect will be unable to read the context file during the
extraction.
The directory structure is in place with the complete file path: C:APMConnect\Config\<SAP system name>\SAP_<SAP system name>_Contextfile.xml.
For example, a configured directory will resemble the following: C:\APMConnect\Config\Q-66\SAP_Q66_Contextfile.xml.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 163 of 495
Deploy APM Connect
Install SAP Java Connector
To facilitate the data transfer, there must be a java connector between SAP and the APM
Connect server. This topic describes how to establish the connection via the SAP Java
Connector (SAP JCO).
Note: The APM Connect installer automatically places the files sapjco3.dll and
sapjco.jar into the location C:\APMConnect\Utilities\runtime\lib. You must complete
the remaining steps in this topic manually.
Steps
1. Navigate to the location where you downloaded the SAP Java Connector package
from the SAP marketplace, and copy the following files:
l
sapjco3.dll
l
sapjco3.jar
Note: If you are using a 64-bit machine, per the APM Connect system requirements, you must select the 64-bit installer.
2. Navigate to C:\APMConnect\Utilities\runtime\lib\wrapper, and then paste the
copied files in that location.
3. Copy the file sapjco3.dll again.
4. Navigate C:\windows\system32, and then paste the copied file in that location.
The Java Connecter is installed.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 164 of 495
Deploy APM Connect
Configure SSL
Adapters in APM Now require an SSL certificate to transfer files. As a part of implementation, GE Digital will supply you with an SSL certificate.
Steps
1. Access the SSL truststore file, provided at installation.
2. Copy the truststore file.
3. On your APM Connect Server, paste the truststore file in a secure file system location that is accessible by the APM Container service user.
4. In the context file, ensure you have configured the SSL Connection parameters,
USE_SSL, TRUSTSTORE_FILE, and TRUSTSTORE_PASSWORD.
The adapters are configured to use SSL.
Copyright © 2017 General Electric Company. All rights reserved. • Page 165 of 495
Deploy APM Connect
Configure the Context File
Before you can run a job in the APM Connect Administration Center, you must specify a
set of connection parameters and corresponding values to establish a connection
between APM Connect components, GE Digital APM, and your EAM system. Each of
these connections is used when running a job, and it is required. The connections are
established via context files. This topic describes how to access and configure parameters in these context files.
ŒTip: The SAP Adapters support connections between multiple SAP systems and multiple GE Digital APM databases by using one context file for each SAP system or
GE Digital APM database.
Steps
1. On the APM Connect server, access your context file. If you installed it in the
default location, navigate to the following folder: C:\APMConnect\Config
2. Configure the context file for your type of deployment (i.e., SAP Adapters on
premises, SAP Adapters in a cloud environment, or SAP PI Adapters).
ŗIMPORTANT: Changes made to the context file will override changes made in
the Context parameters section of APM Connect Administration Center.
Configure the Context File for Unified Adapters, SAP On
Premises, or APM Now
a. Enter the appropriate values for each parameter into the context file
according to the following table.
Parameters
Description
Default or Recommended
Value
Interface Mode Selection
SAP_CLOUD_
ENABLED
Determines
whether the
Adapter will be
used in a cloud
environment.
You must enter one of the
following values:
l
l
true: Adapter will be
run in the cloud.
false: Adapter will be
run on premises.
Copyright © 2017 General Electric Company. All rights reserved. • Page 166 of 495
Deploy APM Connect
You must enter one of the
following values:
Determines
whether the data
LOAD_MERIDIUM_
will be loaded into
APM
the Meridium database.
l
l
true: Data will be
loaded into the
Meridium database.
false: Data will not be
loaded into the
Meridium database.
You must enter one of the
following values:
LOAD_DIGITAL_
APM
Determines
whether the data
will be loaded into
the Predix database.
l
l
true: Data will be
loaded into the
Predix database.
false: Data will not be
loaded into the
Predix database.
Intermediate Repository (IR) Connection
IR_HOST
The IP address of
the IR.
Enter the host name of the
PostgresSQL server. If you
installed APM Connect
using the default settings,
then the value is localhost.
IR_PORT
The port number
of the IR.
Enter your PostgreSQL
port. The default value is
5432.
IR_DATABASE
The database in
which the IR data
is stored.
Enter a name for the IR
database. This value will be
used to create the IR database.
Copyright © 2017 General Electric Company. All rights reserved. • Page 167 of 495
Deploy APM Connect
The schema in
which the IR database will be created.
The default value is public.
IR_USERID
The IR user name.
Enter the user name for
the PostgresSQL database.
The default user name is
postgres.
IR_PASSWORD
Enter the password for the
The IR system pass- PostgresSQL database that
word.
was created during installation.
PG_ADMIN_USER
The IR user name
that is used to create the database.
Enter the user name for
the PostgreSQL database.
The default user name is
postgres.
PG_ADMIN_
PASSWORD
The IR system password that is used
to create the database.
Enter the password for the
PostgresSQL database that
was created during installation.
IR_SCHEMA
SAP Connection
Copyright © 2017 General Electric Company. All rights reserved. • Page 168 of 495
Deploy APM Connect
The CMMS ID is
used as the identifier for your SAP
system, and is
<SAP System ID><SAP Client ID>.
CMMS_ID
Enter your unique value.
For example, if
your SAP System
ID is D03 and your
SAP Client ID is
001, then your
CMMS ID would be
DO3-001.
SAP_CLIENT
The SAP client
from where the
data is imported.
Enter your unique value.
SAP_HOST
The IP address of
the SAP application server.
Enter your unique value.
SAP_LANGUAGE
The letter code
that represents the
language of the
Enter your unique value.
description to
transfer into
GE Digital APM.
SAP_SYSTEM_
NUMBER
The service port of
the SAP application server.
Enter your unique value.
SAP_USERID
The SAP system
user ID.
Enter your unique value.
SAP_PASSWORD
The SAP system
password.
Enter your unique value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 169 of 495
Deploy APM Connect
SAP_SYSTEM_
TIMEZONE
The SAP Application Server Operating System time
zone.
The default value is EST.
The default value is UTF8.
SAP_FILE_
ENCODING
Determines the
encoding of the
source data.
EXTRACT_NUM_
PARALLEL_JOB
Determines the
maximum number
The recommended value is
of SAP background
10.
jobs allowed during extraction.
IR_LOAD_NUM_
PARALLEL_JOBS
Determines the
maximum number
The recommended value is
of SAP background
10.
jobs allowed during loading.
All the character encoding
supported by the Java Virtual Machine (JVM) are correct.
File System
PLSAP_INPUT
The path of the directory you created,
which SAP uses to
Enter your unique value.
place data files
used by APM Connect.
Copyright © 2017 General Electric Company. All rights reserved. • Page 170 of 495
Deploy APM Connect
PLSAP_OUTPUT
The path of the directory used by
APM Connect to
search for the files
created by SAP.
Enter your unique value.
This directory
should be shared
with the SAP
server.
IR_TALEND_
OUTPUT
The temporary
workspace used
when moving files
from SAP to
APM Connect.
Enter your unique directory
path.
LOG_BASE_DIR
The directory path
to the log file.
C:\APMConnect\Logs
SFTP_STAGING_
DIR
The temporary
storage location
for files that are
waiting to be
loaded.
Enter your unique value
(e.g., C:\APMConnect\Staging).
UNC_FILE_PATH
The path of the directory of the data
Enter your unique value.
loader file share.
APM Connect
APM_CONNECT_
HOST
The host name of
the machine
where APM Connect Administration Center is
installed.
Enter your unique value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 171 of 495
Deploy APM Connect
APM_CONNECT_
PORT
The port name of
the machine
where APM Connect Administration Center is
installed.
Enter your unique value.
APM Connection
Note: The APM Connection Parameters are not required for a
cloud deployment.
APM_API_APP_
SERVER
The GE Digital
APM API application server name.
Enter the name of your
GE Digital APM API server.
APM_APP_SERVER
The GE Digital
APM application
server name.
Enter the name of your
GE Digital APM server.
APM_
DATASOURCE
The GE Digital
APM data source
to which the data
will be exported.
Enter the name of your
GE Digital APM data
source.
APM_USERID
The GE Digital
APM Framework
user ID.
Enter your unique value.
APM_PASSWORD
The GE Digital
APM Framework
password.
Enter your unique value.
Miscellaneous
Copyright © 2017 General Electric Company. All rights reserved. • Page 172 of 495
Deploy APM Connect
You must enter one of the
following values:
l
MANUAL_RUN
Determines how
the date parameters will be
treated.
l
true: The dates specified in the context
files will be used.
Additionally, the
dates of the last successful run stored in
the database will not
be updated.
false: The date range
used during the
extraction will be the
date of the last successful record as
stored in the database. Each time a job
is run successfully,
the database is
updated with those
dates and all the subsequent runs will use
the dates from the
last successful
record.
Filter
MAINT_PLANT
The ID(s) of the
Maintenance Plant
whose data you
want to extract.
Plant values cannot exceed
4 characters.
LANGUAGE
The SAP code that
represents the language.
The value must be a single
character.
Copyright © 2017 General Electric Company. All rights reserved. • Page 173 of 495
Deploy APM Connect
CREATE_DATE_
START
The date value that
limits the data
Date must be entered in
extracted to
the following format:
records created on
YYYYMMDD.
or after the specified date.
CREATE_DATE_
END
The date value that
limits the data
Date must be entered in
extracted to
the following format:
records created on
YYYYMMDD.
or before the specified date.
CHANGE_DATE_
START
The date value that
limits the data
Date must be entered in
extracted to
the following format:
records changed
YYYYMMDD.
on or after the specified date.
CHANGE_DATE_
END
The date value that
limits the data
Date must be entered in
extracted to
the following format:
records changed
YYYYMMDD.
on or before the
specified date.
CREATE_TIME_
START
The time value
that limits the data
extracted to
Time must be in the folrecords created on lowing format: HHMMSS.
or after the specified time.
Copyright © 2017 General Electric Company. All rights reserved. • Page 174 of 495
Deploy APM Connect
CREATE_TIME_
END
The time value
that limits the data
extracted to
Time must be in the folrecords created on lowing format: HHMMSS.
or before the specified time.
CHANGE_TIME_
START
The time value
that limits the data
extracted to
Time must be in the folrecords changed
lowing format: HHMMSS.
on or after the specified time.
CHANGE_TIME_
END
The time value
that limits the data
extracted to
Time must be in the folrecords changed
lowing format: HHMMSS.
on or before the
specified time.
Equipment Filter Criteria
EQUIPMENT_NO
The Equipment
that you want to
extract.
Equipment number should
not exceed 18 characters.
You cannot exceed 500
Equipment numbers.
EQUIPMENT_
CATEGORY
The ID of the
Equipment category that limits
the Equipment
extracted.
Must be a single character.
EQUIPMENT_TYPE
The ID of the
Equipment type
that limits the
Equipment extracted.
Equipment type should not
exceed 10 characters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 175 of 495
Deploy APM Connect
EQUIPMENT_
CLASS
The ID of the
Equipment classification that limits the Equipment
extracted.
Equipment classification
should not exceed 18 characters.
If an Equipment has multiple classifications, as long
as you specify one of those
classifications, the Equipment record will be extracted.
Functional Location Filter Criteria
FLOC_NO
The ID of the Functional Location
that limits the
Functional Locations extracted.
Functional Location ID
should not exceed 40 characters. You cannot exceed
500 Functional Location
numbers.
FLOC_TYPE
The ID of the Functional Location
Functional Location type ID
type that limits the should not exceed 10 charFunctional Locaacters.
tions extracted.
FLOC_CLASS
The ID of the Functional Location
Functional Location clasclassification that
sification ID should not
limits the Funcexceed 18 characters.
tional Locations
extracted.
FLOC_CATEGORY
The ID of the Functional Location category that limits
Must be a single character.
the Functional
Locations extracted.
Work History Filter Criteria
Copyright © 2017 General Electric Company. All rights reserved. • Page 176 of 495
Deploy APM Connect
NOTIFICATION_
NO
The number that
identifies the Notification record.
Notification number
should not exceed 12 characters.
WORK_ORDER_
NO
The number that
Work Order number
identifies the Work should not exceed 12 charOrder record.
acters.
NOTIFICATION_
TYPE
The Notification
type that limits the
orders that you
want to extract.
WORK_ORDER_
TYPE
The ID of the Work
Order type that limWork Order type should
its the orders that
not exceed 4 characters.
you want to
extract.
WORK_ORDER_
SYSTEM_STATUS
The Work Order
systems status
that limits the
Work Orders you
want to extract.
Work Order system status
should not exceed 4 characters.
WORK_ORDER_
USER_STATUS
The Work Order
user status that
limits the Work
Orders that you
want to extract.
Work Order user status
should not exceed 4 characters.
NOTIFICATION_
SYSTEM_STATUS
The Notification
system status that
limits the notifications that you
want to extract.
Notification system status
should not exceed 4 characters.
Notification type should
not exceed 2 characters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 177 of 495
Deploy APM Connect
NOTIFICATION_
USER_STATUS
Notification user
status that limits
the notifications
that you want to
extract.
Notification user status
should not exceed 4 characters.
Queue
Note: The Queue parameters apply only to a cloud deployment.
QUEUE_HOST
The queue host
name.
Enter your unique value,
which was provided during
installation.
QUEUE_HOST_1
An additional
queue host name.
Enter your unique value,
which was provided during
installation.
QUEUE_HOST_2
An additional
queue host name.
Enter your unique value,
which was provided during
installation.
QUEUE_PORT
The queue port.
Enter your unique value,
which was provided during
installation.
QUEUE_PORT_1
An additional
queue port.
Enter your unique value,
which was provided during
installation.
QUEUE_PORT_2
An additional
queue port.
Enter your unique value,
which was provided during
installation.
QUEUE_USER
The queue user
name.
Enter your unique value,
which was provided during
installation.
QUEUE_
PASSWORD
The queue password.
Enter your unique value,
which was provided during
installation.
Copyright © 2017 General Electric Company. All rights reserved. • Page 178 of 495
Deploy APM Connect
CUSTOMER_NAME
The coded customer name.
Enter your unique value,
which was provided during
installation.
FTP
FTP Connection is only supported for the SAP and SAP PI Adapters,
and configuration is only required if you are using FTP to transfer
information between your systems.
ŗIMPORTANT: If you are using an SAP System with the SAPFTP_
SERVERS table, you must configure that table to activate FTP servers according to the SAP Help system. You can refer to SAP OSS
1605054 for more details. Typically, this will apply to any SAP version later than ECC6 EHP5.
PLSAP_FTP_HOST
The FTP server
host name.
Enter your unique value.
PLSAP_FTP_
USERID
The FTP server
user name.
Enter your unique value.
PLSAP_FTP_
PASSWORD
The FTP server
password.
Enter your unique value.
If the default configuration
was followed, enter one of
the following values:
PLSAP_FTP_PORT
The FTP server
port.
l
l
21: For FTP connection.
22: For SFTP connection.
Copyright © 2017 General Electric Company. All rights reserved. • Page 179 of 495
Deploy APM Connect
Enter one of the following
values:
l
The mode by
PLSAP_FTP_MODE which files are
copied.
l
l
The remote FTP
PLSAP_FTP_SCAN_
directory used to
DIR
scan for files.
SERVER: To use file
shares.
FTP: To use standard
FTP.
SFTP: To use standard secure FTP.
Enter your unique value.
PLSAP_FTP_NUM_
OF_RETRY
The number of
times to scan the
FTP server for
files.
10
PLSAP_FTP_
SLEEP_TIME
The time in
seconds between
scans.
10
PLSAP_SFTP_SCP_
COMMAND
The command
name created
when establishing
the SFTP transfer
in SAP.
Enter your unique value.
SFTP
Note: The SFTP parameters apply only to a cloud deployment.
SFTP_HOST
The SFTP server
host name.
Enter your unique value,
which was provided during
installation.
SFTP_USERID
The SFTP server
user name.
Enter your unique value,
which was provided during
installation.
Copyright © 2017 General Electric Company. All rights reserved. • Page 180 of 495
Deploy APM Connect
SFTP_PASSWORD
The SFTP server
password.
Enter your unique value,
which was provided during
installation.
SFTP_PORT
The SFTP server
port.
Enter your unique value,
which was provided during
installation.
SFTP_LANDING_
DIR
The directory path
where the shared
files are stored.
Enter your unique value,
which was provided during
installation.
USE_SSH_KEY
SSH_PRIVATE_KEY
Determines if SSH
security configuration will be
used by the
adapters.
The directory
where the SSH key
is stored.
You must enter one of the
following values:
true: SSH configuration will
be used.
false: SSH configuration
will not be used.
Enter your unique value.
The SSH key must be generated by the user in the
openSSH format. This key
can be stored in any directory on the APM Connect
server, but it is recommended to store it in the
following directory:
C:\APMConnect\Config
Email Notification
Note: The Email Notification parameters apply only to a cloud
deployment.
EMAIL_FROM
The email address
from which the
notification email
will be sent.
Enter your unique value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 181 of 495
Deploy APM Connect
EMAIL_TO
The email address
(es) to which the
email will be sent.
Enter your unique value.
You must enter one of the
following values:
l
Indicates whether
the failure detail
FAILURE_DETAIL_
report will be sent
REPORT_ENABLED
when a record fails
to load.
l
FAILURE_DETAIL_
REPORT_JRXML_
FILE_PATH
true: The failure
detail report, detailing the records that
failed to load into
GE Digital APM and
the reason for failure, will be sent.
false: The failure
detail report will not
be sent.
Directory where
the JasperReport
file to generate the
Enter your unique value.
failure detail
report in PDF will
be delivered.
You must enter one of the
following values:
l
Indicates whether
the load complete
LOAD_SUMMARY_
report will be
REPORT_ENABLED
loaded with each
extraction.
l
true: The load complete report, detailing
the number of
records that were
extracted and successfully loaded into
GE Digital APM, will
be sent.
false: The load complete report will not
be sent.
Copyright © 2017 General Electric Company. All rights reserved. • Page 182 of 495
Deploy APM Connect
LOAD_SUMMARY_
REPORT_JRXML_
FILE_PATH
Directory where
the JasperReport
file to generate the
Enter your unique value.
summary detail
report in PDF will
be delivered.
REPORT_TARGET_
DIR
Directory where
the report file will
be delivered.
Enter your unique value.
SMTP_HOST
The host for SMTP
installation the
APM Connect
server.
Enter your unique value.
SMTP_PORT
The port for SMTP.
The default value is 25.
Guardrail
EQUIPMENT_
THRESHOLD
The maximum
number of records
that should be
transferred from
The default value is 100000.
SAP to GE Digital
APM in a single
run of the Equipment Adapter.
FLOC_
THRESHOLD
The maximum
number of records
that should be
transferred from
SAP to GE Digital
The default value is 100000.
APM in a single
run of the Function Location
Adapter.
Copyright © 2017 General Electric Company. All rights reserved. • Page 183 of 495
Deploy APM Connect
WORKHISTORY_
THRESHOLD
OVERRIDE_
GUARDRAILS
The maximum
number of records
that should be
transferred from
The default value is 50000.
SAP to GE Digital
APM in a single
run of the Work
History Adapter.
Indicates whether
the job will continue if the number of records
exceeds the
defined threshold.
The default value is Y,
which means that the job
will run regardless of the
number of records
included. A warning notification will also be sent to
the email address specified
in the EMAIL_TO parameter
within the Email Notification Parameters section
of this file. If you set this
parameter to N, the job will
be terminated when the
number of records exceeds
the defined threshold, and
an error notification will be
sent.
-or-
Configure the Context File for the SAP PI Adapters On
Premises
a. If you are deploying the SAP PI Adapters, which are the SAP Adapters
for Process Integration, enter the appropriate values for each parameter into the context file according to the following table.
SAP PI Parameters
Description
Default or Recommended
Value
Intermediate Repository Connection
Copyright © 2017 General Electric Company. All rights reserved. • Page 184 of 495
Deploy APM Connect
IR_HOST
The IP address of
the IR.
Enter the host name of
the PostgresSQL server. If
you installed APM Connect using the default settings, then the value is
localhost.
IR_PORT
The port number of
the IR.
5432 (PostgreSQL default)
IR_DATABASE
Database in which
the IR data is
stored.
APMconnectIR_<Release
Number>
IR_CREATE_
DATABASE
Database in which
the IR data is
stored.
APMconnectIR_<Release
Number>
IR_SCHEMA
Schema in which
the IR database will
be created.
The default value is public.
The IR user name.
Enter the user name for
the PostgresSQL database. The default user
name is postgres.
The IR system password.
Enter the password for
the PostgresSQL database that was created
during installation.
Name of the
GE Digital APM
server to which the
data will be loaded.
Enter your unique value.
IR_USERID
IR_PASSWORD
APM Connection
APM_APP_SERVER
Copyright © 2017 General Electric Company. All rights reserved. • Page 185 of 495
Deploy APM Connect
GE Digital APM data
APM_DATASOURCE source to which the
data will be loaded.
Enter your unique value.
APM_USERID
GE Digital APM user
name of the user
loading data with
the adapters.
Enter your unique value.
APM_PASSWORD
GE Digital APM password of the user
Enter your unique value.
loading data with
the adapters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 186 of 495
Deploy APM Connect
You can enter a value
defined in GE Digital
APM.
Note: The value that
is entered will be
applied to all records.
-or-
SITE_REFERENCE_
EQUIP
Used to map the
site reference value
to an SAP field. This
indicates which
SAP field will be
used as the site reference for
GE Digital APM
Equipment records.
You can use the character # at the beginning
and end of a GE Digital
APM field name to indicate the field that is used
to set the site reference.
For example, if you want
to use your SAP Maintenance Plant field as
your GE Digital APM site
reference, you should
enter the following:
<SITE_REFERENCE_
EQUIP>#MI_EQUIP000_
MAINT_PLANT_C#</SITE_
REFERENCE_EQUIP>
ŒTip: For more information, see About Site Filtering Configuration in
the Context File.
Copyright © 2017 General Electric Company. All rights reserved. • Page 187 of 495
Deploy APM Connect
You can enter a value
defined in GE Digital
APM.
Note: The value that
is entered will be
applied to all records.
-or-
SITE_REFERENCE_
FLOC
Used to map the
site reference value
to an SAP field. This
indicates which
SAP field will be
used as the site reference for
GE Digital APM
Functional Location
records.
You can use the character # at the beginning
and end of a GE Digital
APM field name to indicate the field that is used
to set the site reference.
For example, if you want
to use your SAP Maintenance Plant field as
your GE Digital APM site
reference, you should
enter the following:
<SITE_REFERENCE_
FLOC>#MI_FNCLOC00_
MAINT_PLANT_C#</SITE_
REFERENCE_FLOC>
ŒTip: For more information, see About Site Filtering Configuration in
the Context File.
Filter
Copyright © 2017 General Electric Company. All rights reserved. • Page 188 of 495
Deploy APM Connect
CREATE_DATE_
START
The date value that
limits the data
Dates must be entered in
extracted to records the following format:
created on or after
YYYYMMDD.
the specified date.
The date value that
limits the data
extracted to records
CREATE_DATE_END
created on or
before the specified
date.
Dates must be entered in
the following format:
YYYYMMDD. This parameter is optional.
CHANGE_DATE_
START
The date value that
limits the data
extracted to records
changed on or after
the specified date.
Dates must be entered in
the following format:
YYYYMMDD. This parameter is optional.
CHANGE_DATE_
END
The date value that
limits the data
extracted to records
changed on or
before the specified
date.
Dates must be entered in
the following format:
YYYYMMDD. This parameter is optional.
CREATE_TIME_
START
The time value that
limits the data
extracted to records
created on or after
the specified time.
Time must be in the following format: HHMMSS.
This parameter is
optional.
CREATE_TIME_END
The time value that
limits the data
extracted to records
created on or
before the specified
time.
Time must be in the following format: HHMMSS.
This parameter is
optional.
Copyright © 2017 General Electric Company. All rights reserved. • Page 189 of 495
Deploy APM Connect
CHANGE_TIME_
START
The time value that
limits the data
extracted to records
changed on or after
the specified time.
Time must be in the following format: HHMMSS.
This parameter is
optional.
CHANGE_TIME_
END
The time value that
limits the data
extracted to records
changed on or
before the specified
time.
Time must be in the following format: HHMMSS.
This parameter is
optional.
EQUIPMENT_NO
The Equipment that
you want to extract.
The Equipment number
should not exceed 18
characters. You cannot
exceed 500 Equipment
numbers.
FLOC_NO
The ID of the Functional Location that
limits the Functional Locations
extracted.
The Functional Location
ID should not exceed 40
characters. You cannot
exceed 500 Functional
Location numbers.
NOTIFICATION_NO
The number that
identifies the Notification record.
Notification number
should not exceed 12
characters.
WORK_ORDER_NO
The number that
identifies the Work
Order record.
Work Order number
should not exceed 12
characters.
MAINT_PLANT
The ID(s) of the
Maintenance Plant
whose data you
want to extract.
Plant values cannot
exceed 4 characters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 190 of 495
Deploy APM Connect
EQUIPMENT_
CATEGORY
The ID of the Equipment category that
limits the Equipment extracted.
Must be a single character.
EQUIPMENT_TYPE
The ID of the Equipment type that limits the Equipment
extracted.
The Equipment Type
should not exceed 10
characters.
The Equipment classification should not
exceed 18 characters.
EQUIPMENT_
CLASS
The ID of the EquipIf an Equipment has mulment classification
that limits the Equip- tiple classifications, as
long as you specify one
ment extracted.
of those classifications,
the Equipment record
will be extracted.
LANGUAGE
The SAP code that
represents the language.
Must be a single character.
NOTIFICATION_
TYPE
The Notification
type that limits the
orders you want to
extract.
Notification type should
not exceed 2 characters.
WORK_ORDER_
TYPE
The ID of the Work
Order type that limits the orders you
want to extract.
Work Order type should
not exceed 4 characters.
FLOC_CATEGORY
The ID of the Functional Location catMust be a single charegory that limits the
acter.
Functional Locations extracted.
Copyright © 2017 General Electric Company. All rights reserved. • Page 191 of 495
Deploy APM Connect
FLOC_TYPE
The ID of the Functional Location type Functional Location type
that limits the Func- should not exceed 10
tional Locations
characters.
extracted.
FLOC_CLASS
The ID of the Functional Location clas- Functional Location classification that limits sification should not
the Functional Loca- exceed 18 characters.
tions extracted.
WORK_ORDER_
SYSTEM_STATUS
The Work Order sysWork Order system
tem status that limstatus should not exceed
its the Work Orders
4 characters.
you want to extract.
WORK_ORDER_
USER_STATUS
The Work Order
Work Order user status
user status that limshould not exceed 4 charits the Work Orders
acters.
you want to extract.
NOTIFICATION_
SYSTEM_STATUS
The Notification sysNotification system
tem status that limstatus should not exceed
its the Notifications
4 characters.
you want to extract.
NOTIFICATION_
USER_STATUS
The Notification
user status that lim- User status should not
its the Notifications exceed 4 characters.
you want to extract.
Copyright © 2017 General Electric Company. All rights reserved. • Page 192 of 495
Deploy APM Connect
You must enter one of
the following values:
true: The dates specified
in the context files will be
used. Additionally, the
dates of the last successful run stored in the
database will not be
updated.
MANUAL_RUN
Determines how
the date parameters will be
treated.
MAX_FILE_WAIT_
SEC
Defines how long
the PI Adapters will
wait for the extraction to complete
before the job
times out.
The recommended value
is 1000.
EXTRACT_NUM_
PARALLEL_JOBS
The maximum number of parallel SAP
jobs that APM Connect will open in a
single extraction.
Select a value that corresponds to the number
of background processors that you have
available for APM Connect.
false: The date range
used during the extraction will be the date of
the last successful record
as stored in the database. Each time a job is
run successfully, the database is updated with
those dates and all the
subsequent runs will use
the dates from the last
successful record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 193 of 495
Deploy APM Connect
IR_LOAD_NUM_
PARALLEL_JOBS
The maximum number of IR load jobs
The recommended value
in a single extracis 30.
tion.
You must enter one of
the following values:
l
LOG_REQUEST
Logs the APM web
service requests.
l
true: Enables logging.
false: Disables logging. This is the
recommended
value.
You must enter one of
the following values:
l
LOG_RESPONSE
Logs the APM web
service responses.
l
true: Enables logging.
false: Disables logging. This is the
recommended
value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 194 of 495
Deploy APM Connect
You must enter one of
the following values:
l
COMPRESS_TYPE
Determines if the
files will be compressed and which
method of compression is being
used.
None: Files are not
compressed.
Note: If you do not compress files, large extractions will take a long
time.
l
l
SAPCAR: Files are
compressed by
SAP.
ZIP: Files are compressed through a
standard zip
method.
You must enter one of
the following values:
l
COMPRESS_SAP_
COMMAND_NAME
The value of the
command name created.
l
ZSAPCAR: The command name for
SAP compression.
ZSZIP: The command name for
standard compression.
SAP PI
SAP_SYSTEM_ID
The system IDs of
the SAP systems
from which you
want to extract.
Enter your unique value.
SAP_PI_HOST
The SAP PI server
host.
Enter your unique value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 195 of 495
Deploy APM Connect
SAP_PI_PORT
The SAP PI server
port.
SAP_PI_RECEIVER_
PARTY
The receiver determined in the comThis is optional and
munication channel unique to the user.
section in SAP.
SAP_PI_RECEIVER_
SERVICE
The receiver service
determined in the
communication
channel section in
SAP.
This is optional and
unique to the user.
SAP_PI_SENDER_
PARTY
The receiver sender
determined in the
communication
channel section in
SAP.
This is optional and
unique to the user.
SAP_PI_SENDER_
SERVICE
The sender service
determined in the
communication
channel in SAP.
If not specified, the
default value is
Meridium_APMConnect.
The value must match
what is in the communication channel in
SAP.
SAP_PI_USERID
The SAP user ID.
Enter your unique value.
SAP_PI_
PASSWORD
The SAP PI password.
Enter your unique value.
Enter your unique value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 196 of 495
Deploy APM Connect
You must enter one of
the following values:
Determines if APM
Connect should use
FILE_MOVE_USE_PI
SAP-PI to extract
and load data.
l
l
true: The file movement will use PI
between SAP and
APM Connect.
false: The file movement will not use
PI.
IR_TALEND_
OUTPUT
The temporary
workspace used
when moving files
from SAP into
APM Connect.
Enter your unique value.
PLSAP_INPUT
The base path of
the directory you
created that APM
Connect searches
for the generated
files from SAP.
Enter your unique value.
PLASAP_OUTPUT
The path of the directory where the
data is stored on
the SAP server prior
to sending it to the
APM Connect
server. This directory should be
shared with either
the SAP PI server or
the APM Connect
server, depending
on the value of
FILE_MOVE_USE_PI.
Enter your unique value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 197 of 495
Deploy APM Connect
SAP_PI_AAE
If you are using SAP
7.3 or above, you
may use the
Advanced Adapter
Engine (AAE). This
parameter allows
this functionality to
be used during
extraction.
You must enter one of
the following values:
l
l
true: If you are
using AAE.
false: If you are not
using AAE. This is
the default value.
Miscellaneous
MAINTENANCE_
PLAN
The number that
identifies the maintenance plan
record.
The maintenance plan
number must not exceed
12 characters.
You must enter one of
the following values:
l
WMI_USE_
HARMONIZE
Enables or disables
the harmonization
process in
GE Digital APM.
l
true: If you are
enabling the harmonization process.
false: If you are disabling the harmonization
process.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 198 of 495
Deploy APM Connect
Encrypt Passwords
Passwords in the APM Connect context file are not encrypted by default. However, you
can encrypt any password manually. This topic describes how to manually encrypt passwords.
Steps
1. On the machine on which you installed APM Connect, access the APM Connect
installation package, locate the Encrypt String_0.1.zip, and then unzip the file.
2. Open the EncryptString folder, and then select EncryptString_run.bat.
A command prompt opens, and then the Talend Open Studio window appears.
3. Enter the password that you want to encrypt in the Enter the text to be encrypted:
box.
4. Select OK.
5. In the command prompt, between the banners, copy the text that was generated.
6. Open the context file.
7. In the parameter that you want to encrypt, paste the generated text.
8. Append the highlighted parameter the with _AES, as shown in the following image.
9. Save the context file.
10. For each password that you want to encrypt, repeat steps 2 through 9.
The passwords are encrypted.
What's Next?
Return to the adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 199 of 495
Deploy APM Connect
Configure Context Parameters
For every job that is imported, certain context parameters in the APM Connect Administration Center must be configured. This topic describes how to configure the required
context parameters, so that you can run the job.
Steps
1. In the APM Connect Administration Center, in the Job Conductor workspace, select
the Job for which you would like to set parameters.
2. At the bottom of the Job Conductor workspace, select Context parameters.
The Context parameters section appears.
3. In the Context parameter column, scroll down to the context parameter you
would like to configure.
4. In the Custom value box, configure context parameters, and select the Active
check boxes for the following:
l
APM User_ID: Enter your GE Digital APM user name
l
APM_PASSWORD: Enter your GE Digital APM password.
l
IR_USERID:Enter your intermediate repository user name.
l
IR_PASSWORD: Enter your intermediate repository password.
l
SAP_USERID: Enter you SAP System user name.
l
SAP_PASSWORD: Enter your SAP system password.
l
l
l
CONFIG_FILE_PATH: Enter the file path to the location where the context file
is stored.
LOG4j_FILE_PATH: Enter the filed path to the location where the Log4j file is
stored. If you installed APM Connect in the defualt location, then enter
\APMConnect\Config\log4jproperties
MANUAL_RUN: Enter true or false to determine whether or not the dates
Copyright © 2017 General Electric Company. All rights reserved. • Page 200 of 495
Deploy APM Connect
recorded in the context file will be used during extraction.
Note: If the MANUAL_RUN parameter is set to true, the dates specified
in the context file will be used. Additionally, the dates of the last successful
run stored in the database will not be updated. If set to false, the date
range used during the extraction will be the date of the last successful run,
as stored in the database. Each time a Job is run successfully, the database
is updated with those dates, and all subsequent runs will use the dates
from the last successful run.
The context parameters are configured.
5. Repeat steps 1-3 for every imported Job you will run.
6. To configure the Master job to run, select the SAP_MASTER_INTERFACE Job.
7. At the bottom of the Job Conductor workspace, select Context parameters.
The Context parameters section appears, displaying the following parameters:
l
RUN_STATIC_DATA: The Static Data Job
l
RUN_EQUIPMENT: The Equipment Job
l
RUN_FLOC: The Functional Location Job
l
RUN_WORKHISTORY: The Work History Job
l
RUN_WORKMANAGEMENT: The Work Management Job
l
MASTER_CONFIG_FILE_DIR: The file path to context files for the jobs
l
SYSTEM_TO_RUN: The source system from which you want to extract data
l
RUN_TC_EQUIPMENT: The Equipment Technical Characteristic Job
l
RUN_TC_FLOC: The Functional Location Technical Characteristics Job
8. For each extraction jobs you want to run, in the Custom value column enter true,
and then select the Active check box.
9. In the MASTER_CONFIG_FILE_DIRCustom value box, enter the directory where the
context file(s) is stored.
10. In the SYSTEM_TO_RUNCustom value box enter:
l
The name of the system directory from which you want to extract data.
-or-
l
* to extract from all systems.
11. Press Enter.
The Jobs are configured to run.
What's Next?
Copyright © 2017 General Electric Company. All rights reserved. • Page 201 of 495
Deploy APM Connect
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 202 of 495
Deploy APM Connect
Configure the Context Parameters for APM Now
ŗIMPORTANT: The Extraction Wrapper job is required only for APM Now deployment
of the SAP Adapters.
The extraction wrapper job is a container job for the following APM Now SAP Adapters
extraction jobs:
l
RUN_STATIC_DATA
l
RUN_EQUIPMENT
l
RUN_FLOC
l
RUN_WORKHISTORY
In addition to the extractions jobs, the Extraction Wrapper contains additional context
parameters are required to configure the jobs to run.
Steps
1. In the APM Connect Administration Center, in the Job Conductor workspace, select
the Extraction Wrapper job, and then select Context parameters.
The Context parameters section appears.
2. Configure the Custom value for the following connection parameters:
l
l
l
CONFIG_FILE_DIR: Enter the directory path where your context file is stored.
SYSTEM_TO_RUN: Enter the name of the directory containing the context file
from which you want to extract data, or, to extract from all context directories, enter *.
LOG_BASE_DIR: Enter the directory path into which the log files will be written.
Copyright © 2017 General Electric Company. All rights reserved. • Page 203 of 495
Deploy APM Connect
l
LOG4J_CONFIG_FILE: Enter the directory path where your log4j properties
file is stored.
3. Select the Active check box corresponding to each of the connection parameters.
4. For each extraction jobs you want to run, in the Custom value column enter true,
and then select the Active check box.
For example, if you want run only the Equipment Adapter, in the RUN_
EQUIPMENT row, in the Custom value box enter true. Then, select the Active
check box.
The Extraction Wrapper job is configured to run. Once the job is executed, the
data designated to be extracted in the Connect parameters will be transferred
from your SAP System to your GE Digital APM system.
5. For each of the remaining jobs imported into the APM Connect Administration center, select the job, and then Context parameters.
6. Configure the following parameters:
l
l
CONFIG_FILE_PATH: Enter the directory path where your context file is
stored, including the name of the context file, e.g. C:\APMConnect\Config\SYS-001\SAP_ContextFile.xml
LOG4J_CONFIG_FILE: Enter the directory path where your log4j properties
file is stored, including the name of the context file, e.g. C:\APMConnect\Config\log4j.properties
7. Repeat steps 5-7 for each imported job that you plan to run.
The jobs are configured to run.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 204 of 495
Deploy APM Connect
Configure Site Reference Values
Note: If you are deploying the SAP PI and Maximo Adapters, site filtering is handled
by parameters in the context file.
To assign site references to records using values other than those in the baseline configuration, you must modify the autojoin_control table in the Intermediate Repository.
ŗIMPORTANT: Site Reference records corresponding to the site references that you
specify must exist in GE Digital APM before you can transfer records.
Steps: Configure the Site Reference Value to Use an Indirect Site
Reference Value
1. Access a database browser tool, and then access your Intermediate Repository
(PostgreSQL) database.
2. Locate the autojoin_control table, and then locate the site_reference column.
ŒTip: For details about what each column in the autojoin_control table contains, see About Site Filtering Configuration.
3. Update the value in the site_reference column using the format #FIELD_ID#,
where FIELD_ID represents the ID of the field from which you want to populate the
site reference value.
For example, if you want the site reference value to be the value in the SAP Maintenance Plant field of the corresponding Equipment or Functional Location.
l
l
Where the value #MI_FNCLOC00_SAP_SYSTEM_C# occurs, replace the value
with #MI_FNCLOC00_MAINT_PLNT_C#
Where the value #MI_EQUIPOO_SAP_SYSTEM_C# occurs, replace the value
with #MI_EQUIP000_MAINT_PLANT_C#
When you import record into GE Digital APM from your SAP System, its Site Reference Key will be the value in the field that you specified. In the example above, the
Site Reference Key will be the SAP Maintenance Plant of the corresponding Equipment or Functional Location.
Steps: Configure the Site Reference Value to be A Specific Site
Name
1. Access a database browser tool, and then access your Intermediate Repository
(PostgreSQL) database.
Copyright © 2017 General Electric Company. All rights reserved. • Page 205 of 495
Deploy APM Connect
2. Locate the autojoin_control table, and then locate the site_reference column.
ŒTip: For details about what each column in the autojoin_control table contains, see About Site Filtering Configuration.
3. Where the value #MI_FNCLOC00_SAP_SYSTEM_C# occurs, replace the value with
the Site name as defined in a GE Digital APM Site Reference record.
4. Where the value #MI_EQUIPOO_SAP_SYSTEM_C# occurs, replace the value with
the Site name as defined in a GE Digital APM Site Reference record.
When you import records into GE Digital APM from your SAP System, its Site Reference Key will be the name of the Site as defined in the APM Site Reference record.
Example: Configure MI_EQUIP000_CST_CNR_C as an Indirect Site
Reference
In this example, the database browser tool used in this example is pgAdmin4, the IR
database name is SAP_UDLP_EAMClient. You can use the database browser of your
choice.
1. On your APM Connect server, open pgAdmin4, your database browser tool.
PgAdmin4 is open displaying your available servers.
2. Navigate the server tree to the appropriate IR database, access your tables.
Copyright © 2017 General Electric Company. All rights reserved. • Page 206 of 495
Deploy APM Connect
In this example, the path is Servers(2)\roaperflabvm3\Databases\SAP_UDLP_
EAMClient\Schemas(1)\public\Tables (81). The list of tables in your IR database are
visible.
3. Locate the table autojoin_control, right click, and then select the View Data dropdown.
Copyright © 2017 General Electric Company. All rights reserved. • Page 207 of 495
Deploy APM Connect
4. Select View All Rows.
The Query -1 tab is populated with the autojoin table.
5. In each row, in the site_reference column, enter #MI_EQUIP000_CST_CNR_C#
ŒTip: This example assumes that the existing values in the site_reference
column correspond to values in the MI_EQUIP000 and MI_FNCLOC00 families. If
they do not, you must also update the apm_site_reference_family column to
the corresponding family.
The value in the MI_EQUIP000_CST_CNR_C field will be used to populate the Site
Reference Key in corresponding records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 208 of 495
Deploy APM Connect
About Site Filtering Configuration via the autojoin_
control Table
Site Reference values are managed in the Intermediate Repository, specifically in the
autojoin_control table as shown in the following image.
About the Baseline Site Reference Configuration
The baseline configuration of the SAP Adapters uses the SAP System to determine the
site to which a record should be assigned. More specifically, the value in the site_reference column in the autojoin_control table is #MI_FNCLOCOO_SAP_SYSTEM_C# for
Functional Location records and #MI_EQUIPOO_SAP_SYSTEM_C# for Equipment
records.
Additionally, if SAP System value is null or empty on a record in SAP, once transferred
into GE Digital APM, it will be assign the site reference defined in the defaut_site_reference column in the autojoin_control table. The default value is *Global*.
If you want to use your SAP System as the site for all records transferred from SAP to
APM then no additional configuration is needed. However, if necessary, you can configure different site reference values.
ŗIMPORTANT: A Site Reference record corresponding to your SAP System(s) must
exist in GE Digital APM before you can transfer records.
About the autojoin_control Table
You can specify site references using the autojoin_control table. The columns in this
table are described in the following table.
Column
Description
AUTOJOIN_ID
Surrogate ID used to uniquely identify a row; i.e., the primary key.
BATCH_NAME
When a load is processed, queries defined in this table are run
together in batches. All queries with the same BATCH_NAME are
executed together.
TABLE_NAME
The name of the temporary table that will be created for this row.
This name will be concatenated by the load UUID.
Copyright © 2017 General Electric Company. All rights reserved. • Page 209 of 495
Deploy APM Connect
SQL_
EXECUTION_
ORDER
Within a batch, the value in this column defines the order in which
the SQL statements will be executed. Lower numbers will be
executed first.
SQL
The SQL SELECT statement to be executed. The results of this statement will be copied to the temporary table defined by the load UUID
and the TABLE_NAME column. Columns defined in the
SELECT statement should match exactly the column names in the
GE Digital APM family for which data is being loaded.
SITE_
REFERENCE
This column specifies the value to use for the corresponding
record's Site Reference Key. This can be a direct site reference (i.e., a
specific site reference name) or it can contain an indirect site reference (i.e., a field that contains the site reference name to use). See
the topic Configure Site Reference Values for details.
Note: The baseline value is #MI_FNCLOCOO_SAP_SYSTEM_C#
for Functional Location records and #MI_EQUIPOO_SAP_SYSTEM_
C# for Equipment records. This means the SAP System will determine to which site records are assigned.
APM_SITE_
REFERENCE_
COLUMN
The GE Digital APM column used to store Site Reference values.
Unless you have customized the GE Digital APM database, this value
should be MI_SITE_NAME.
APM_SITE_
REFERENCE_
FAMILY
The GE Digital APM family to which the site reference will be applied.
When the relationship is being built within the records of the same
entity, the value is <PRED_FAMILY_ID>. Unless you have customized
the GE Digital APM database, you do not need to modify this value.
This column specifies whether the row is for an entity or relationship.
USE_
RELATIONSHIP_ If this row is populating a relationship, the value should be 1. If not,
LOOKUP
the value should be 0. This affects the way relationship references
are defined in the resulting SQL statements.
DEFAULT_SITE_
REFERENCE
If an indirect site reference is specified, this value defines the Site
Reference Key that should be used if the value in the specified indirect site reference column is NULL.
l
Enter *Global* to assign the site as global
l
Enter the name of a site to assign records to that site.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 210 of 495
Deploy APM Connect
Mount a File Share
To enable writing files between the servers within your APM Connect architecture, file
shares need to be mounted. This topic details the basic process for setting up a file
share based on your operating systems. Generally, this process involves, creating a file
share to be mounted, then mounting the file share, and then making the file share permanent.
ŗ IMPORTANT: The process can vary greatly between organizations based on network configurations. Additionally, this procedure should be completed by an administrator with the expertise to manage network configurations.
Before You Begin
l
Be sure that you understand the recommended configurations to enable file
shares within the APM Connect architecture.
l
You will need access to the Linux console and root privileges on your Linux server.
l
You will need the APM Connect server service account user name and password.
l
You should be a network administrator with working knowledge of your network
configurations.
Steps: Create a File Share on a Windows Server, and then Mount
the Share to a Linux Server
Create the File Share
1. On your APM Connect server (i.e., the Windows server on which you want to create
the share), create a new folder for file sharing.
Note: This share can be anywhere on your APM Connect server and can have
any name.
2. Right-click on the new folder, and then select Properties.
The <Folder Name> Properties window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 211 of 495
Deploy APM Connect
3. Select the Sharing tab, and then select Advanced Sharing.
The Advanced Sharing window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 212 of 495
Deploy APM Connect
4. Select the Share this folder check box.
The other fields on the window are enabled.
5. Optionally, edit the name in the Share name: box. If you do not edit this name,
the name will default to the folder name.
6. Select Permissions.
The Permissions for <Folder Name> window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 213 of 495
Deploy APM Connect
7. Select Add….
The Select, Users, Computers, Service Accounts, or Groups window appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 214 of 495
Deploy APM Connect
8. In the Enter the object names to select (examples) box, enter the name of your
APM Connect service account user.
Note: The user must have permission to read and write to the shared folder.
9. Select OK.
The Select, Users, Computers, Service Accounts, or Groups window closes.
10. On the Permissions for <Folder Name> window, in the Permissions for <Service
User Name> box, in the Allow column select the Full Control check box, the
Change check box, and the Read check box.
11. Select OK.
The Permissions for <Folder Name> window closes.
12. On the Advanced Sharing window, select OK.
The Advanced Sharing window closes. Then, on the <Folder Name> Properties
window, in the Network File and Folder Sharing section, the Network Path: subsection is populated.
13. Record the network path.
Mount the File Share
14. Access your SAP PI server or your SAP server (i.e., the Linux server to which you
want to mount the share) via a Linux Command Line Editor tool (e.g., Vim or
Nano).
15. Determine an existing directory that will be used as the share, or create a new directory.
16. In that directory, to initiate the connection between your source and target share,
execute a mount command. The command will likely require the APM Connect service account user, source of the file share folder you created on the APM Connect
server, and target for the share on your Linux server.
ŒTip: The exact mount command will vary based on the system that you are
using. An example of a mount command is mount -t smbfs -o username=Administrator //recurring/c$ /mnt/recurring
17. To verify that the new mount is configured correctly, enter the command mount.
The mount appears in the list of mounted shares.
Copyright © 2017 General Electric Company. All rights reserved. • Page 215 of 495
Deploy APM Connect
ŒTip: At this point, you should be able to write files from one share to another.
To test, place a file in the source folder on the Windows machine, and then the
file should appear in the target directory on the Linux machine.
Make the Share Permanent
18. On the Linux machine, navigate to the file /etc/fstab.
ŒTip: Mounting the share into the /etc/fstab file makes the file share permanent meaning that upon reboot the file share is still be mounted. If you do
not execute the mount in this location, once the machine is rebooted the mount
will be disconnected.
19. Open the file to be edited using a data base editor (e.g. Vim or Nano).
20. Add a new line to the file defining the share, mount point, file system driver, and
options.
ŒTip: The following is an example of the file syntax: //<Source Folder Name>
/<Target Folder Name <Systems Type or Driver> username=username password=<password> 02.
Additionally, the following is the same entry with sample values: //APMConnectServer1/WindowsSharedFolder /opt/LinuxSharedFolder cifs –o username=APMConnectSeriveAccount1 password=APMConnect 0 2
21. Close the file, and then return to the root directory.
22. To unmount the share created, execute the command umount (i.e., if the original
mount directory was /opt/LinuxFileShare, then execute the command unmount
/opt/LinuxFileShare).
ŒTip: You must unmount the share from the original location for it to be mounted from the /etc/fstab file.
23. Execute the command mount.
The original mount directory does not appear in the list of mounted shares, and
the new share in the /etc/fstab folder can be mounted.
Copyright © 2017 General Electric Company. All rights reserved. • Page 216 of 495
Deploy APM Connect
24. Execute the command mount –a.
ŒTip: Executing the command will read the configuration from the /etc/fstab
file, and then preform the mount operation based on the parameters in the file.
25. To verify that the share has been mounted, execute the command mount.
The new mount point added to the /etc/fstab file appears in the list.
At this point, you can place a file on the APM Connect server in the shared folder,
and it will be transferred to the shared Linux folder.
Steps: Create a File Share on a Linux Server, and then Mount the
Share to a Linux Server
Create the File Share
1. Access your SAP Server (i.e., the Linux server to which you want to mount the
share) via a Linux Command Line Editor tool (e.g., Vim or Nano).
2. Ensure that the nfs-kernel-server service is installed and running.
ŗIMPORTANT: The name of this service can vary based on the Linux system.
3. Create the directory that will be mounted to your SAP PI server or your SAP server.
4. To grant the remote server permission to mount a local directory, locate the file
/etc/exports.
5. In that file, enter the directory you created in Step 3, and then identify the server
that can mount the directory.
For example, if you wanted to create the directory /opt/PI_FileShare and grant all
users permissions to mount that directory, then you would enter the following:
/opt/PI_FileShare *(rw, sync, no_root_squash, not_subtree_check).
ŒTip: You can find all of the export options and access control lists in the
manual file accessed by executing the command man exports.
6. Restart the service /etc/init.d/nfs-kernel-server.
Mount the File Share
7. Access your SAP PI server or your SAP server (i.e., the Linux machine to which you
want to mount the share).
8. Create a directory to which files will be written from the share.
Copyright © 2017 General Electric Company. All rights reserved. • Page 217 of 495
Deploy APM Connect
9. Execute the mount command to mount the exported directory on to the SAP PI
server or the SAP server.
ŒTip: The exact mount command will vary based on the system that you are
using. An example of a mount command is mount example.hostname.com:/ubuntu/local/ubuntu.
For example, if your SAP server hostname is SAPServer1, your source directory is
/opt/PI_FileShare, and your target directory is /opt/SAP_FileShare, you would
enter the following: mount SAPServer1: /opt/PI_File_Share /opt/SAP_FileShare
10. The directory created in step 8 appears in the list of mounted directories.
ŒTip: At this point, you should be able to write files from one share to another.
To test, place a file in the source folder on the Windows machine, and then the
file should appear in the target directory on the Linux machine
Make the File Share Permanent
11. On the Linux machine on which the share will be mounted, navigate to the file
/etc/fstab.
ŒTip: Mounting the share into the /etc/fstab file makes the file share permanent, meaning that upon reboot the file share will still be mounted. If you do
not execute the mount in this location, once the machine is rebooted the mount
will be disconnected.
12. Open the file to be edited using a database editor (e.g., Vim or Nano).
13. Add a new line to the file defining the share, mount point, file system driver, and
options.
ŒTip: The following is an example of the file syntax: <exporting server hostname>:<exported Folder Name> <Target Folder Name> <Systems Type or
Driver> 0 2.
Additionally, the following is the same entry with sample values: APMConnectServer1.company.com:/exportedFolder /opt/mountpointFolder nfs 0 2
14. Close the file, and then return to the root directory.
15. To unmount the share in the directory created in step 8, execute the command
Copyright © 2017 General Electric Company. All rights reserved. • Page 218 of 495
Deploy APM Connect
umount.
For example if the original mount directory was /opt/LinuxFileShare, then execute
the command unmount /opt/LinuxFileShare.
ŒTip: You must unmount the share from the original location for it to be mounted from the /etc/fstab file.
16. Execute the command mount –a.
ŒTip: Executing the command will read the configuration from the /etc/fstab
file, and then preform the mount operation based on the parameters in the file.
17. To verify that the share has been mounted, execute the command mount.
The new mount point added to the /etc/fstab file appears in the list.
At this point, you can place a file on the APM Connect server in the shared folder,
and it will be transferred to the shared Linux folder.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 219 of 495
Deploy APM Connect
About File Shares and APM Connect
File shares mounted in the APM Connect architecture allow you to read and write files
between servers within your architecture configuration.
File Mount Configurations
If you are using SAP PI, create a file share on your APM Connect server, and then mount
it to your SAP PI server. Then, create a share on your SAP server, and then mount to
your SAP PI Server. Similarly, if you are not using SAP PI, or you are bypassing your SAP
PI server, you must create a file share on your APM Connect server, and then mount it to
your SAP Server.
Note: The SAP PI Adapters determine if SAP PI server will be used via the FILE_
MOVE_USE_PI parameter in the context file. If the parameter is true, then SAP PI will
be used to copy files from your SAP server to your APM Connect server. If it is false,
SAP PI will not be used to copy files from your SAP server to your APM Connect sever.
In both configurations however, the SAP PI server will be used to proxy RFC calls.
Additionally, in the most common architecture, the APM Connect server is hosted on a
Windows Sever with the SAP server and the SAP PI server hosed on a Linux server. The
following diagrams details the recommended configurations.
User’s Permissions for File Shares
When using a shared file system to facilitate data extraction from SAP to APM Connect,
Copyright © 2017 General Electric Company. All rights reserved. • Page 220 of 495
Deploy APM Connect
you will need to grant the service account user(s) the appropriate permissions to access
both systems.
Note: Using active directory to manage the service account is recommended.
The volume to be mounted can be in three configurations: NAS/SAN, Windows, or Unix.
Additionally, access control could be different for each configuration, as shown in the
following table:
ŒTip: When the shares are created and permissions configured correctly, run the
equipment job for a single equipment ID. This is a quick and easy way to check that
permissions are set up correctly. After you run the job, a file will be created using the
SAP service account, then opened and read by the APM Connect
Volume (Disk, Share, LUN)
Access Control
NAS/SAN
Vendor specific user mapping (i.e. NetApp), or active
directory integrations.
Windows
Users/Groups permissions are defined in Active Directory.
Unix
Active Directory integration, or user maps (i.e. Samba
or Config).
Copyright © 2017 General Electric Company. All rights reserved. • Page 221 of 495
Deploy APM Connect
Establish SFTP Transfer in SAP
Note: If you using SAP PI, then you can skip this procedure.
If you use (S)FTP to transfer files between SAP, APM Connect, and GE Digital APM, you
must complete additional configuration in SAP. You must download a puTTY file and set
up command names in SAP to use the puTTY file.
Steps
1. On your SAP system, in a browser, navigate to the PuTTY website.
2. Download the following puTTy file: pscp.exe.
3. Copy it into the PATH on your SAP system. The recommended directory is
%WINDIR%/System32.
4. In SAP, run the transaction code SM69.
The External Operation System Commands screen appears.
5. Select
.
The Create an External Command screen appears.
6. In the Command Section, in the Command Name box, enter a name for your command.
7. In the Definition section, in the Operating system command box, enter following
systems commands: pscp.
8. Select Save.
The puTTY file is on the SAP system, and the corresponding command names are
set up.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 222 of 495
Deploy APM Connect
Create File Share Folder Structure
Note: If you using SAP PI, then you can skip this procedure.
When SAP writes a data file, it is placed in a specific directory defined by the context
parameter PLSAP_INPUT. This topic describes how to create the appropriate directory
structure.
Steps
1. Navigate to the folder on which your SAP system writes files.
Note: This folder will be different for each customer, but will likely be labeled
PLSAP_INPUT.
2. Create a new folder for each of the following:
l
EQUIPMENT
l
FLOC
l
TC
l
WMI
l
WORKHISTORY
The file structure will look like the following image:
The directory is created, and SAP will be able to write files to the necessary location.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 223 of 495
Deploy APM Connect
Install the ABAP Base Service Pack Add-on
Note: To complete the following instructions successfully, you must use SAP client
000.
Before You Begin
l
Determine the release and level of your current ABAP installation by completing
the steps to verify the ABAP installation.
Steps
1. On a machine from which you can access the SAP Server, navigate to the ftp site
provided to you.
2. If your currently installed ABAP release is 400_600 and level is 0000, and you are
not installing the ABAP Add-on in an S/4 Hana SAP system, proceed directly to
Step 18. Otherwise, proceed to the next step.
3. Depending on your SAP environment, navigate to the folder \\SAP Interfaces
ABAP Add-On\Service Pack Files\ECC6 or \\SAP Interfaces ABAP Add-On\Service
Pack Files\S/4 Hana, and then select one of the following folders:
l
Exchange Upgrade: To upgrade the ABAP package when upgrading to a new
SAP version.
l
Install: To install the ABAP Package for the first time.
l
Upgrade: To upgrade the ABAP package.
4. Copy the .pat file(s). The file names begin with either D07 or H4S.
5. On the SAP Server, paste the copied file into the folder \\usr\sap\trans\EPS\in.
6. Log in to the SAP system as a user with:
l
SCTSIMPSGL and S_CTS_ADMIN authorizations.
-or-
l
SAP_ALL authorization.
7. Run the transaction code: SAINT.
The Add-On Installation Tool screen appears.
8. In the upper-left corner of the page, select Installation Package, then select Load
packages, and then select From Application Server.
Copyright © 2017 General Electric Company. All rights reserved. • Page 224 of 495
Deploy APM Connect
A message appears, asking if you want to upload OCS packages from the ECS
inbox.
9. Select Yes.
The SAINT: Uploading Packages from the File System screen appears.
Note: In an S/4 Hana environment, 2 files are uploaded and are displayed in
the SAINT: Uploading Packages from the File System screen.
On the row corresponding to the .pat file that you copied previously, the Message
Text column displays Uploaded successfully.
10. At the top of the screen, select
.
The Add-On Installation Tool screen appears again.
11. Select Start.
A new grid appears. MIAPMINT appears in the list of add-on packages that can be
installed.
12. Select the row containing the value MIAPMINT in the first column, and then select
Continue.
The Support Package selection screen appears.
13. Select Continue and then select Continue again.
Notes:
l
l
During the installation, the Add Modification Adjustment Transports to
the Queue dialog box might appear. If it does, select No.
During the installation, the Open data extraction requests dialog box
might appear. If it does, select Skip and then select Yes.
An indicator appears at the bottom of the screen to indicate the installation progress.
When the progress indicator disappears, a message appears, indicating that the
add-on package will be installed.
14. Select
.
Copyright © 2017 General Electric Company. All rights reserved. • Page 225 of 495
Deploy APM Connect
The status is updated to indicate that the add-on package will now be imported,
and the installation process continues. When the installation process is complete,
the status is updated to indicate that the add-on package was imported successfully.
15. Select Finish.
The MIAPMINT add-on package appears in the list of installed add-on packages on
the Add-On Installation Tool screen.
16. On the ftp site, navigate to the folder \\SAP Interfaces ABAP Add-On\Support
Package.
17. Depending on your SAP environment, navigate to the ECC6 folder or navigate to
the S/4 Hana folder, and copy the .pat file(s).
18. On the SAP Server, paste the copied file(s) into the folder \\usr\sap\trans\eps\in.
19. Log in to the SAP system.
20. Run the following transaction: SPAM.
The Support Package Manager screen appears.
21. Select Menu, the select Support Package, then select Load Packages, and then
select From Application Server.
A message appears, asking if you want to upload the package.
22. Select Yes.
A summary screen appears, indicating that the package was uploaded successfully.
23. Select Back.
24. Select Display/define.
The Component Selection dialog box appears.
25. Select the MIAPMINT component.
26. When prompted, confirm that the patch will be imported into the queue, and then
select
.
27. Select Menu, then select Support Package menu, and then select
.
The SPAM: Import: Queue dialogue box appears.
28. On the SPAM: Import: Queue dialogue box, select
.
The import process begins. When it is complete, a message appears, indicating
that the import process was successful.
Copyright © 2017 General Electric Company. All rights reserved. • Page 226 of 495
Deploy APM Connect
29. Select Continue.
Another message appears, indicating that the import process was successful.
30. Select
.
31. Select Menu, then select Support Package, and then select
.
The installation is complete.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 227 of 495
Deploy APM Connect
Verify ABAP Installation
Steps
1. In SAP, on the System menu, select Status....
The System: Status window appears.
2. In the SAP System data subsection, select
.
The System: Component information window appears.
3. If you have deployed the ABAP Add-On package for the SAP Adapter, scroll down
until you see the Software Component MIAPMINT. If you see the following values
in the following columns, the Add-On was applied successfully:
Copyright © 2017 General Electric Company. All rights reserved. • Page 228 of 495
Deploy APM Connect
l
Release:
ECC6: 400_600
S/4 Hana: 400_750
l
Level:
ECC6: 0033
S/4 Hana: 0033
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 229 of 495
Deploy APM Connect
Uninstall the ABAP Base Service Pack Add-on
If you are upgrading from one version of the ABAP service pack add-on to a newer version, you will need to uninstall the currently installed service pack.
Note: The uninstall feature is available only in SAP versions S/4 Hana 1511 and later.
To complete these steps, you must use SAP client 000.
Before You Begin
l
Verify the release and level of your ABAP installation.
Steps
1. On a machine with access to the SAP Server, insert the SAP Interfaces installation
DVD.
2. Navigate to the folder \\SAP Interfaces ABAP Add-On\Service Pack
Files\S4Hana\Uninstall, and then copy the .pat file(s).
3. On the SAP server, navigate to the folder \\usr\sap\trans\EPS\in, and then paste
the copied files.
4. Log in to the SAP server as a user with either SCTSIMPSGL and S_CTS_
ADMIN authorizations or SAP_ALL authorization.
5. Enter SAINT.
The Add-On Installation Tool screen appears.
6. Select Installation Package, then select Load packages, and then select From
Application Server.
A message appears, asking if you want to upload OCS packages from the ECS
inbox.
7. Select Yes.
The SAINT: Uploading Packages from the File System screen appears.
8. Select the .pat file(s) that you copied previously.
The Message Text column displays the message Uploaded successfully.
9. At the top of the screen, select
Copyright © 2017 General Electric Company. All rights reserved. • Page 230 of 495
Deploy APM Connect
.
The Add-On Installation Tool screen appears again.
10. Select the Uninstallable components tab.
MIAPMINT appears in the list of add-on packages that can be uninstalled.
11. Select MIAPMINT, and then select Continue.
The Start options dialog box appears.
12. Select Default options.
13. Select
.
The status is updated to indicate that the add-on package will now be imported
and the uninstallation process continues. When the process completes, the status
is updated to show that the add-on package was removed successfully.
14. Select Finish.
Results
The MIAPMINT add-on package is removed from the list of installed add-on packages in
the Add-On Installation Tool screen.
Copyright © 2017 General Electric Company. All rights reserved. • Page 231 of 495
Deploy APM Connect
Create APM Connect User Profile in SAP
1. In SAP, run the transaction PFCG.
The role maintenance screen appears.
2. In the Role box enter the role name ZRM_APMConnect_auth_profile, and then
select Single Role.
The Display Roles screen appears.
3. Select the Authorizations tab.
4. In the Maintain Authorization Data and Generate Profiles section, on the Change
Authorization Data row, select
.
The Choose Template window appears.
5. Select do not select templates.
The Change Role: Authorizations window appears.
6. Select Manually.
The Manual selection of authorizations pane appears.
7. In the Authorization Object box enter the following:
l S_RFC
l
S_BTCH_JOB
l
S_DATASET
l
S_TABU_NAM
l
S_LOG_COM
l
I_QMEL
l
I_AUART
l
I_BETRVORG
l
C_TCLA_BKA
8. Select
.
9. On the Cross-application Authorization Objects row to expand the workspace,
select
Copyright © 2017 General Electric Company. All rights reserved. • Page 232 of 495
Deploy APM Connect
10. On the Activity row, select
.
The Define Values window appears.
11. Select the Execute box.
Select
.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 233 of 495
Deploy APM Connect
SAP Interfaces Security Groups
The following table lists the baseline Security Groups available for users within this module, as well as the baseline Roles to which those Security Groups are assigned.
ŗIMPORTANT: Assigning a Security User to a Role grants that user the privileges associated with all of the Security Groups that are assigned to that Role. To avoid granting
a Security User unintended privileges, before assigning a Security User to a Role, be
sure to review all of the privileges associated with the Security Groups assigned to that
Role. Also, be aware that additional Roles, as well as Security Groups assigned to existing Roles, can be added via Security Manager.
Security Group
Roles
MI SAP Interface Administrator
None
MI SAP Interface User
None
The baseline family-level privileges that exist for these Security Groups are summarized
in the following table.
Family
MI SAP Interface Administrator
MI SAP Interface User
Entity Family
Confirmation
View, Update, Insert, Delete
View, Update, Insert
Equipment
View, Update, Insert, Delete
View, Update, Insert
Functional Location
View, Update, Insert, Delete
View, Update, Insert
SAP System
View, Update, Insert, Delete
View
Site Reference
View
View
Work History
View, Update, Insert, Delete
View, Update, Insert
Work History Detail
View, Update, Insert, Delete
View, Update, Insert
Equipment Has Equipment
View, Update, Insert, Delete
View, Update, Insert,
Delete
Functional Location Has
Equipment
View, Update, Insert, Delete
View, Update, Insert,
Delete
Functional Location Has
Functional Location(s)
View, Update, Insert, Delete
View, Update, Insert,
Delete
Relationship Families
Copyright © 2017 General Electric Company. All rights reserved. • Page 234 of 495
Deploy APM Connect
Has Confirmation
View, Update, Insert, Delete
View, Update, Insert,
Delete
Has Event Detail
View, Update, Insert, Delete
View, Update, Insert,
Delete
Has SAP System
View, Update, Insert, Delete
View, Update, Insert,
Delete
Has Work History
View, Update, Insert, Delete
View, Update, Insert,
Delete
User Assignment
View, Update, Insert, Delete
View, Update, Insert,
Delete
Copyright © 2017 General Electric Company. All rights reserved. • Page 235 of 495
Deploy APM Connect
Identify Trigger Values for Creating Task Records
The Work Management Adapter allows you to create Inspection Task and Calibration
Task records from SAP Maintenance Plans using Operations and Object Lists. This topic
describes how to identify which values in an Operation or Object list will trigger the creation of which Task records in GE Digital APM.
The baseline product is configured such that:
l
l
Operations with the control key ZMI2 will be used to create Calibration Task
records.
Operations with the control key ZMI1 will be used to create Inspection Task
records.
Note: You are not required to use the default configuration. If you want to use values in different Operation fields to trigger the creation of GE Digital APM Task records,
you can do so.
Steps
l
If you want to accept the baseline configuration complete the following:
a. Create the control keys ZMI1 and ZMI2.
b. In the context file, configure the following Work Management Parameters to
enable trigger values.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 236 of 495
Deploy APM Connect
Configure GE Digital APM to Create Notifications
from Recommendation Records
The SAP Interfaces feature allows you to create Recommendation records in GE Digital
APM that will be used to create SAP Notifications automatically. For a Recommendation
record to generate an SAP Notification automatically, the Create Work Request field
must exist on the Recommendation datasheet. This field is available on the baseline
datasheets for the baseline Recommendation families from which you are allowed to
create SAP Notifications.
If you want to generate SAP Notifications from Recommendation records that belong to
customer-defined subfamilies of the root Recommendation family, in addition to implementing the correct rules (for an example of the rules that you will need to implement,
you can look at any active baseline Recommendation family), you will need to add the
Create Work Request field to the desired datasheets for that family.
ŒHint: You can create multiple types of SAP Notifications (e.g., M1) from Recommendation records. By default, GE Digital APM creates M1 Notifications.
Steps
1. If you want to create different Notification types, you will need to:
a. Add the Notification Type field to the datasheet.
b. Configure the Notification Type field to accept values other than M1.
Note: In the baseline SAP Interfaces product, this field is disabled. If
desired, you could configure it to be enabled so that users can type a value
directly in the Notification Type cell on the datasheet. You might also consider creating a Valid Values rule that provides a list of acceptable values
so that users can select the desired value from the list.
What's Next?
l
Return to the workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 237 of 495
Deploy APM Connect
Deploy and Configure the RFC Connector Files
As recommended and by default, a RestFUL SAP web service call is used as an intermediary between SAP and GE Digital APM, thereby avoiding RFC calls directly between
GE Digital APM and your SAP sever. Complete these steps to deploy and configure the
files necessary to enable this connection.
Steps
1. Access the APM Connect installation package, and then copy the file SAP_RFC_Connector.jar.
2. On your APM Connect server, navigate to <root:>\APMConnect\Utilities\runtime\deploy.
3. Paste the copied file SAP_RFC_Connector.jar into the directory.
4. Access the APM Connect installation package again, and then copy the file SAP_
RFC_CONNECTOR.xml.
5. On your APM Connect server, navigate to <root:>\APMConnect\Utilities\runtime\etc.
6. Paste the copied file SAP_RFC_CONNECTOR.xml in the directory.
7. If you are not using SAP PI, the required parameters are configured by default, so
no further steps are required.
-orIf you are using SAP PI, open the file and configure the following parameters as
necessary.
Parameter
Description
Default or Recommended
Value
LOG_
REQUEST
Specified whether or not APM Web This setting is optional. The
default value is false, which
service requests are logged.
means that logging is not
enabled.
LOG_
RESPONSE
This setting is optional. The
Specified whether or not APM Web default value is false, which
service responses are logged.
means that logging is not
enabled.
SAP_USE_PI
Specifies whether or not you want
to use an SAP PI connection.
The default value is false.
Specify true to use SAP PI.
Copyright © 2017 General Electric Company. All rights reserved. • Page 238 of 495
Deploy APM Connect
SAP_PI_AAE
SAP System
ID tags
If you are using SAP 7.3 or above
you may use the Advanced
Adapter Engine (AAE). This parameter enables this functionality.
Replace the default value in both
the closing and opening tags with
the value in the name field (SAP_
SYSTEM_NAME) of the corresponding EAM System record.
For example, if the system name
defined in the EAM record is PRF800, the opening tag would be
<PRF-800> and the closing tag
would be </PRF-800>.
The default value is false.
Specify true if you want to
use AAE.
The default placeholder
value is D07-001. Within
these tags, you must specify
the relevant SAP PI details
using the parameters
described in the remainder
of this table.
SAP_PI_
HOST
The SAP PI server host.
This value is unique to the
user. Required only if you
are using SAP PI.
SAP_PI_
PORT
The SAP PI server port.
This value is unique to the
user. Required only if you
are using SAP PI.
SAP_PI_
USERID
A user ID associated with the SAP
PI system.
This value is unique to the
user. Required only if you
are using SAP PI.
SAP_PI_
INTERFACE_
NAMESPACE
An interface namespace determined in the communication channel section in SAP
This value is unique to the
user. Required only if you
are using SAP PI.
This value is unique to the
user.
SAP_PI_
The password associated with the
PASSWORD_
specified user.
AES
The password must be
encrypted before you enter it
into this parameter. See the
Encrypt Passwords topic for
details.
Required only if you are
using SAP PI.
Copyright © 2017 General Electric Company. All rights reserved. • Page 239 of 495
Deploy APM Connect
SAP_PI_
SENDER_
SERVICE
The sender service that matches
what is in the Communication
Channel in SAP.
The default value is
Meridium_APMConnect.
Required only if you are
using SAP PI.
SAP_PI_
RECEIVER_
PARTY
Receiver determined in the communication channel section in
SAP.
This value is optional and
unique to the user. Required
only if you are using SAP PI.
SAP_PI_
RECEIVER_
SERVICE
Receiver service determined in the
communication channel section in
SAP.
This value is optional and
unique to the user. Required
only if you are using SAP PI.
SAP_PI_
SENDER_
PARTY
Receiver sender determined in the
communication channel section in
SAP.
SAP_PI_
SERVICE_
INTERFACE
An interface determined in the
communication channel section in
SAP.
SAP_PI_URL
Custom URL defining the sender
service and receiver service. If this
is used, the SAP PI Configuration
parameters above, other than
Other than SAP_PI_USERID, SAP_
PI_PASSWORD_AES, are ignored.
This value is optional and
unique to the user. Required
only if you are using SAP PI.
This value is optional and
unique to the user. Required
only if you are using SAP PI.
This value is optional.
Required only if you are
using SAP PI.
8. Save and close the file.
The RFC Connector files are deployed and configured.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 240 of 495
Deploy APM Connect
Deploy and Configure the RFC Connector Configuration File
The RFC Connector Configuration file identifies the location of the context file and log4j
properties file for any client that uses SAP Remote Function Calls (RFC).
1. Access the APM Connect installation package, and then copy the file SAP_RFC_Connector.cfg.
2. Navigate to <root>\APMConnect\Utilities\runtime\etc, and then paste the copied
file in that location.
3. Open the file to edit, and then configure the following parameters:
Parameter
Description
Default or Recommended Value
context
Defines what
Talend context
Default. Do not change.
environment is
used.
CONFIG_
FILE_PATH
The directory
path to the
context file
C:/APMConnect/Config/SAP_ContextFile_Client.xml
used for extractions.
LOG4J_
CONFIG_
FILE
The directory
path to the
log4j.C:/APMConproperties file nect/Utilities/runtime/etc/log4j.properties
used for extractions.
Note: All file paths must use / in this configuration as a directory separator or
errors will occur.
4. Save the file.
Copyright © 2017 General Electric Company. All rights reserved. • Page 241 of 495
Deploy APM Connect
Configure Notification Priority
You can configure the priority value in GE Digital APM to match the priority value in SAP
by editing the MI_PRIORITY system code table.
Steps
1. Determine the values in your EAM system that determine priority.
2. For each priority that exist in you EAM System, modify the MI_PRIORITY system
table to match the values in your EAM system.
Results
l
When priority values are transferred from a GE Digital APM recommendation to
an SAP Notification, the priority values will match.
What's Next?
l
Return to the workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 242 of 495
Deploy APM Connect
Create an EAM System Record
You must configure an EAM System Record to establish a connection between any EAM
system and GE Digital APM.
Steps
1. Create a new record , using the EAM System family.
2. In the Name box, enter the name of your SAP system
3. If this SAP system is the system to and from which you want to send data by
default, select the Default EAM System? check box.
4. In the User ID box, enter a valid SAP User ID.
5. In the Password box, select ƭ.
The Enter SAP System Password window appears.
6. In the Enter Password box, enter the password that is associated with the specified user ID.
7. In the Confirm Password box, reenter the password.
8. Select OK.
9. In the Connection String box:
a. Replace the text SAP_SERVER_IP with the IP address of the SAP Server.
b. Replace the text SAP_SYSTEM_NUMBER with the SAP System number.
c. Replace the text SAP_CLIENT_NUMBER with the SAP Client number.
d. Delete all angle brackets.
10. In the ITS URL box:
a. Replace the text its_or_integrated_its_server_url with the ITS Server information. To locate the ITS Server information:
i. In SAP, run the following transaction: SE80.
Note: If you do not have access to this transaction, contact your
SAP BASIS team for assistance.
ii. On the toolbar, select Utilities, and then select Settings.
iii. In the upper-right corner of the screen, select
Internet Transaction Server tab appears.
repeatedly until the
Copyright © 2017 General Electric Company. All rights reserved. • Page 243 of 495
Deploy APM Connect
iv. Select the Internet Transaction Server tab.
The ITS Server information that you must enter in the ITS URL box in
GE Digital APM is <Log><Path>, where <Log> is the text in the Log section and <Path> is the text in the Path section.
b. Delete the angle brackets.
c. At the end of the URL, enter: webgui/!.
For example, the ITS URL that corresponds with the values in the image
above is http:// DOCROAECC6.meridium.com:8000/sap/bc/gui/sap/its/webgui/!.
11. Select dž.
The EAM System record is saved.
12. Select , and then select Test Connection.
The connection parameters are verified, and the System ID box is populated with
you EAM System ID.
Results
l
An EAM system record is created for the EAM system to and from which you want
to establish a connection with GE Digital APM. This record should now be used to
Copyright © 2017 General Electric Company. All rights reserved. • Page 244 of 495
Deploy APM Connect
link Site Reference.
l
Linking an EAM system to an EAM System record enables the APM Connect
Adapters to create Notifications against that EAM System.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 245 of 495
Deploy APM Connect
Test the Connection Defined in an EAM System
Record
Steps
1. In the GE Digital APM application, open the EAM System record whose connection
information you want to test.
2. To access the Associated Pages menu, select , and then select Test Connection.
The connection is tested.
Results
l
The connection information that you provided is tested, and a message appears,
indicating whether or not the test was successful. In addition, the System ID field
is populated automatically with the name of the SAP system, using the format
<SYSID>-<CLIENT>, where <SYSID> is the System ID of the SAP system, and
<CLIENT> is the Client number.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 246 of 495
Deploy APM Connect
Create the Intermediate Repository Database
Before you can run an extraction job, you must prepare the intermediate repository.
This topic describes how to set up a repository in preparation to run your first job.
Note: For SAP adapters, you must first run the Static Data job.
ŗIMPORTANT: If you are using the Data Loaders and the SAP Adapters, you must
deploy and run the CreateIntermediateRepository job for each set of adapters.
Before You Begin
l
Before you can prepare and deploy the repository, you must import the Create
Intermediate Repository Job.
Steps
1. Open and log in to the APM Connect Administration Center web application.
Note: The user logging in must have access to the Job Conductor by being designated the Operations Manager role. By default, users designated as administrators do not have Job Conductor permissions.
2. In the Job Conductor workspace, in the appropriate project, select the CreateIntermediateRepository Job.
3. At the bottom of the Job Conductor workspace, select Context parameters.
The Context parameters section appears.
4. Configure the following parameters:
Context Parameter
Description
The file path to context files
for the jobs.
CONFIG_FILE_PATH
ŗIMPORTANT: You must
change the default value to
reflect the actual path to
your configuration file.
Copyright © 2017 General Electric Company. All rights reserved. • Page 247 of 495
Deploy APM Connect
IR_DATABASE
Enter your APM Connect
database name.
The default value is DINODB.
IR_HOST
Enter your APM Connect
server name. The default
value is localhost.
IR_PORT
Enter your APM Connect
server port. The default
value is 5432.
IR_SCHEMA
The schema for your APM
Connect database. The
default value is public.
IR_USERID
Enter your APM Connect
database username.
IR_PASSWORD
Enter your APM Connect
database password.
LOG4J_CONFIG_FILE
The file path to the log4j configuration file.
PG_ADMIN_PASSWORD
The password for the PostgreSQL IR.
PG_ADMIN_USER
The user name for the PostgreSQL IR.
5. Select Run.
The intermediate repository is created for the project.
What's Next?
l
Return to the SAP Adapter workflow for the next step in the deployment process.
-or-
l
Return to the Maximo Adapter workflow for the next steps in the deployment process.
-or-
l
Return to the Data Loader workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 248 of 495
Deploy APM Connect
Run the Static Data Job
The Static Data job populates the database with static site information. This topic
describes how to run this job.
Steps
1. Open and log in to the APM Connect Administration Center web application.
Note: The user logging in must have access to the Job Conductor by being designated the Operations Manager role. By default, users designated admin do not
have Job Conductor permissions.
2. Select Job Conductor.
3. In the Job Conductor workspace, select an appropriate project, and then select the
CreateStaticData Job.
4. Select Run.
The static data pull is enabled.
You can now execute jobs.
Copyright © 2017 General Electric Company. All rights reserved. • Page 249 of 495
Deploy APM Connect
Configure SAP Task and Confirmation Creation
In order to transfer data between SAP items and GE Digital APM Task records and Event
records for Inspection and Calibration, you will need to configure the datasheets used
as the default datasheet.
Steps: Configure GE Digital APM to Transfer Data Between SAP
Items and Task Records
1. Set the following baseline datasheets as the default datasheets on the Inspection
and Calibration Task families:
l
Inspection Task for SAP Integration: Defined on the Inspection Task family.
l
Calibration Task for SAP Integration: Defined on the Calibration Task family.
Steps: Configure GE Digital APM to Create Confirmations from Calibration Event Records
1. Set the following baseline datasheets as the default datasheets on the Calibration
Event families:
l
l
l
l
l
l
Calibration, Analog: Defined on the Calibration, Analog family.
Calibration, Analyzer Multi-Component: Defined on the Calibration, Analyzer Multi-Component family.
Calibration, Analyzer Single Component: Defined on the Calibration, Analyzer Single Component family.
Calibration, Discrete: Defined on the Calibration, Discrete family.
Calibration, Functional Test: Defined on the Calibration, Functional Test family.
Calibration, Weight Scale: Defined on the Calibration, Weight Scale family.
Steps: Configure GE Digital APM to Create Confirmations from
Inspection Event Records
1. Set the following baseline datasheets as the default datasheets on the Inspection
Event families:
l
l
l
Bundle Inspection SAP Integration: Defined on the Bundle Inspection family.
Bundle Sub-Inspection SAP Integration: Defined on the Bundle Sub-Inspection family.
Visual Inspection SAP Integration: Defined on the Full Inspection family.
Copyright © 2017 General Electric Company. All rights reserved. • Page 250 of 495
Deploy APM Connect
l
l
l
General Inspection SAP Integration: Defined on the General Inspection family.
Pressure Test Inspection SAP Integration: Defined on the Pressure Test
Inspection family.
Pressure Test Sub-Inspection SAP Integration: Defined on the Pressure Test
Sub-Inspection family.
What's Next?
l
Return to the workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 251 of 495
Deploy APM Connect
Configure the Query Get Tasks for Work Order Generation
The query Get Tasks for Work Order Generation is used to determine which Task
records to use to create Orders in SAP.
The query contains the Task query source. For each record that is returned by the query,
GE Digital APM will create an Order in SAP. The baseline query is configured to transfer
Task records that meet specific criteria. If desired, you can modify the query to further
limit the Task records that you want to transfer.
Steps
1. Access the Catalog page.
2. In the left pane, select Public, then select Meridium, then select Modules, then
select SAP Integration Interfaces, and then select Queries.
A list of queries appears.
3. Select the Get Tasks for Work Order Generation query.
The workspace appears.
4. Select Design.
5. Modify the query to meet at least the following requirements:
l
Contains the following column:
l
Field: ([Task].[Next Date]-[Task].[Call Horizon])
l
Alias: Expr
l
l
Criteria (>=(? :d :caption='Last Successful Execution Date': id=LAST_
DATE) AND < Now())
Includes at least one field from the source family record.
What's Next?
l
Return to the workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 252 of 495
Deploy APM Connect
Schedule Work Orders
Steps
1. Access the APM Connect page.
The APM Connect Configuration page appears.
2. Select EAM Settings.
The EAM Settings page appears.
3. In the Scheduling Properties section, select Edit Schedule.
Note: If there is a previously schedule item, a schedule summary will be displayed next to Edit Schedule. If there is no scheduled item, Not scheduled
appears next to the Edit Schedule button.
4. On the Edit Schedule window, select the Recurrence check box.
5. In the Time Zone box, select the appropriate time zone.
6. In the Start box, select  to schedule the start date and time.
a. Select one of the following as appropriate:
l
The current date: Select this option to use the current time and date
as the starting point.
l
Clear: Select this option to clear the current selection.
l
<Date>: Select this option to use the selected date as the start date.
b. Select đ, and then select the appropriate time.
c. Select Close.
7. In the Every section, in the interval box, enter the numeric value for how often you
want the generation to occur.
8. In the Every section, in the units box, select the interval unit (i.e., minutes, hours,
years, etc).
9. In the Every section, in the begin box, select one of the following:
l
l
From start time: Select this option to start the recurrence from the previously selected start time.
After last occurrence: Select this option to begin the generation after the
last time the job ran.
10. In the End box, based on when you want the recurrence to end, use the dropdown to select one of the following:
Copyright © 2017 General Electric Company. All rights reserved. • Page 253 of 495
Deploy APM Connect
l
l
l
Never: If you select this option, then the recurrence will not end.
After: If you select this option, then you will enter a number of occurrences
after which the generation will end.
Time & Date: Select this option to use the calendar to select a time and date
when the generation will end.
11. Select OK.
The schedule summary appears next to the Edit Schedule. Additionally, the scheduled item can be viewed in Operations Manager in Scheduling.
Copyright © 2017 General Electric Company. All rights reserved. • Page 254 of 495
Deploy APM Connect
Identify Classifications to Extract
Before You Begin
l
Run the Static Data job.
Steps
1. Access the APM Connect Administration Center.
2. In the upper-right corner of the page, select Ʀ and search for the CMMS Classification Type record representing the item whose classifications you want to
extract (i.e., Equipment or Functional Location).
3. Select a record from the list.
4. Select the Details tab.
5. For each Classification whose Characteristics you want to extract, in the right
column of the Classification for Class Type grid, select the Extract From CMMS
System check box.
-orIf you want to stop extracting all Characteristics for a Classification, clear the
Extract From CMMS System check box for the Classification.
6. Select dž.
The CMMS Classification records are saved.
Results
If you chose to stop extracting all Characteristics for a Classification:
l
l
The Extract From CMMS System check box is cleared automatically in all CMMS
Characteristic records that are linked to the CMMS Classification record.
When you run the corresponding Characteristic extraction adapter, the Characteristics whose Extract From CMMS System check boxes were cleared automatically will not be extracted.
What's Next?
l
Return to the workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 255 of 495
Deploy APM Connect
About Classification Hierarchies
In SAP, for any given class, multiple characteristics can be inherited from another class.
For example, consider the following SAP classes:
l
EQ_CLASS_0001
l
Fasteners
l
Bolts
l
Hexagonal Bolt
As shown in the following image, EQ_CLASS_0001 has four unique characteristics:
As shown in the following image, Fasteners also has four sets of unique characteristics:
Copyright © 2017 General Electric Company. All rights reserved. • Page 256 of 495
Deploy APM Connect
Bolts, however, inherits all of the characteristics from EQ_CLASS_0001 and FASTENERS.
In addition, Bolts has two unique characteristics of its own: HEAD_SHAPE and BOLT_
TYPE:
Finally, Hexagonal Bolt also inherits all of the characteristics from EQ_CLASS_0001,
FASTENERS, and BOLTS. It also has one unique characteristic of its own: TOLERANCE:
Copyright © 2017 General Electric Company. All rights reserved. • Page 257 of 495
Deploy APM Connect
Using these SAP classes, in GE Digital APM system, if you were to select the Extract From
CMMS System check box for the HEXAGONALBOLT class, after selecting the Synchronize Characteristics link while viewing the HEXAGONALBOLT CMMS Classification
record, the following CMMS Characteristic records would be created automatically:
As you can see from the Classification column, some of the characteristics are inherited
from other classes:
Specifically, you can see that:
Copyright © 2017 General Electric Company. All rights reserved. • Page 258 of 495
Deploy APM Connect
l
l
l
l
The following characteristics are inherited from the class EQ_CLASS_0001:
l COLOR
l
LOCAL_REG_NUM
l
OPH
l
SAP_EHS_1017_003_TEST_TYPE
The following characteristics are inherited from the class FASTENERS:
l
FASTENER_DIAMETER
l
LENGTH
l
NUMBEROFTHREADS
l
THREAD_TYPE
The following characteristics are inherited from the class BOLTS:
l
HEAD_SHAPE
l
BOLT_TYPE
The characteristic TOLERANCE is assigned directly to the class HEXAGONALBOLT
(no highlighting).
If you selected the Extract From CMMS System check boxes for all of these characteristics, if you were to run the Equipment Characteristics Extraction Interface without
filters, all of these characteristics would be extracted.
If, however, you were to filter the report to extract only characteristics belonging to the
HEXAGONALBOLT class, only characteristics that are assigned directly at the
HEXAGONALBOLT level would be extracted. In other words, because only TOLERANCE is
assigned directly to HEXAGONALBOLT, only the TOLERANCE characteristic would be
extracted.
Copyright © 2017 General Electric Company. All rights reserved. • Page 259 of 495
Deploy APM Connect
Identify Characteristics to Extract
Steps
1. Open the CMMS Classification record representing the Classification whose Characteristics you want to extract. To do so, either:
l
Open the specific record in Record Manager.
-or-
l
Open the master CMMS Classification Type record to which it is linked, and
then view the CMMS Classification record in the grid on the datasheet.
2. Select ƌ.
3. In the grid on the CMMS Classification datasheet, in the row for each Characteristic
that you want to extract, select the Extract From CMMS System check box.
-orIf you want to stop extracting a Characteristic, clear the Extract From CMMS System check box for the Characteristic.
4. Select dž.
The CMMS Characteristic records are saved.
5. Commit the configuration by running the Static Data job.
The Characteristics to extract have been identified.
What's Next?
l
Return to the workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 260 of 495
Deploy APM Connect
About Extracting Characteristics
Note: If you using SAP PI, Classification and Characteristic synchronization are not
supported.
When you create CMMS Classification Type records using the CMMS System list, you
must select the SAP system from which you want to extract characteristics belonging to
that classification type. The CMMS System list displays the values in the Name field in
all existing EAM System records. When you save the CMMS Classification Type record,
GE Digital APM system finds the EAM System record whose Name field contains the
selected value, and the value in the System ID field in that EAM System record is copied
to the CMMS System ID field in the CMMS Classification Type record.
Then, when you create CMMS Classification or CMMS Characteristic records that are
associated with that CMMS Classification Type record, the value in the CMMS System ID
field in the CMMS Classification Type record is copied automatically to the CMMS System
ID field in those records.
CMMS Characteristic records are created automatically and linked to the CMMS Classification record. Each CMMS Characteristic record is created from a characteristic that
currently exists in the specified SAP system (using the CMMS System field in the CMMS
Classification record). The CMMS Characteristic records are displayed in a grid on the
CMMS Classification datasheet, as shown in the following image:
Note: The System ID field is available on the baseline EAM System datasheet, but
the CMMS System ID field is not available on the baseline CMMS Classification Type,
CMMS Classification, or CMMS Characteristic datasheets.
When you run the Equipment Characteristic Extraction Interface or the Functional Location Characteristic Extraction Interface, the GE Digital APM code needs to determine
which specific characteristics to extract from that system. To do so, it evaluates the
CMMS Characteristic records that exist in your GE Digital APM database. If it finds any
CMMS Characteristic records whose CMMS System ID field value identifies the SAP system from which you are running the interface, it will extract only those characteristics
from that SAP system (assuming that the Extract from CMMS System check box is selected in the CMMS Characteristic record).
Copyright © 2017 General Electric Company. All rights reserved. • Page 261 of 495
Deploy APM Connect
Import Notification Management File
Note: This step is needed only if the notification management file was not imported
when you ran the APM Connect installer.
ŗIMPORTANT: This step is required only for on-premises deployment of the SAP
Adapters. If you are not completing an on-premesis deployment, you can skip this procedure, and proceed to the next step in the SAP Adapter First-Time Deployment Workflow.
Steps
1. Access the APM Connect installation package, and then copy the file SAP_NotificationManagement.jar.
2. Navigate to <root:>\APMConnect\Utilities\runtime\deploy.
3. If you already have an existing SAP_NotificationManagement.jar file, delete it
before copying the new file into the directory.
4. Paste the copied file SAP_NotificationManagement.jar in the directory.
The Notification Management File is imported.
What's Next?
l
Return to the SAP Adapter First-Time Deployment Workflow.
Copyright © 2017 General Electric Company. All rights reserved. • Page 262 of 495
Deploy APM Connect
Deploy the SAP PI Adapters
This topic provides a list of all procedures related to the PI Specific setup, as well as
links to the related concept and reference topics.
Copyright © 2017 General Electric Company. All rights reserved. • Page 263 of 495
Deploy APM Connect
Deploy the SAP PI Adapters for the First Time
The following table outlines the steps that you must complete to deploy and configure
this module for the first time. These instructions assume that you have completed the
steps for deploying the basic GE Digital APM system architecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
Note: This GE Digital APM module is not available in the APM Now environment.
Step
Task
Notes
1
Deploy the SAP Adapters.
This step is required.
2
On the APM Connect Server, import the
notification management. jar file.
This step is required only if you are
completing an on-premises deployment.
3
On your SAP PI sever, import the design
object.
This step is required.
4
On your SAP PI sever, import the configuration object.
This step is required.
5
On your SAP PI sever, modify the
baseline communication channels.
This step is required.
6
On your SAP PI server, activate the
RFCReceiverToECC object.
This step is required.
7
On your SAP PI server, add entries to
the /MIAPM/TASK_CNF table.
This step is required.
8
In SAP, define the command name.
This step is required.
9
In SAP, install the SAPCAR file.
This step is required.
10
In SAP, create SAP PI directory structure. This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 264 of 495
Deploy APM Connect
Upgrade the SAP PI Adapters to EAM SAP PI V2.0.0
The following tables outlines the steps that you must complete to upgrade this module
to EAM SAP PI V2.0.0. These instructions assume that you have completed the steps for
upgrading the basic GE Digital APM system architecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that the tasks be completed in the order in which they are listed.
To Upgrade from EAM SAP PI V1.0.0 through V1.2.0
Step
Task
Notes
1
Upgrade the APM Connect Base.
This step is required.
2
Complete the steps to deploy the SAP adapters
for the first time.
This step is required.
3
Complete the steps to deploy the
SAP PI adapters for the first time.
This step is required.
Copyright © 2017 General Electric Company. All rights reserved. • Page 265 of 495
Deploy APM Connect
About Site Filtering Configuration in the Context
File
Note: This site filtering configuration applies only to SAP PI deployment. If you are
deploying the SAP Adapters, site filtering is handled by modifying the autojoin_control
table.
ŗIMPORTANT:
l
l
Site Reference records must exist in your GE Digital APM system, before you can
use the EAM Adapters to populate the Site Reference Key. Additionally, the site
entered into the context file must match the exact value in the corresponding
Site Reference record.
The user who is running the EAM Adapters jobs must be assigned, in GE Digital
APM, to the site to which the records being loaded will be assigned. Additionally,
the credentials for that user must be entered into the context file. If the user is
not a member of the appropriate site, then the data load will fail, and an error
message will appear.
The EAM Adapters are used to populate the Site Reference on Equipment, Functional
Location, and Work History records in GE Digital APM. The adapters populate the MI_
SITE_KEY system field with the ENTY_KEY system field associated with the Site Reference
value to be populated. On asset records, the Site Reference is stored in the MI_SITE_KEY
field, a system field in GE Digital APM. The EAM Adapters use the Site Name (MI_SITE_
NAME) to translate the value to the corresponding Site Reference Key and populate the
MI_SITE_KEY field; therefore, you do not need to know the key to be able to populate the
site reference. This functionality is important because this value can change from one
database to another.
When records are loaded using the Equipment, Function Location, and Work History
Adapters, the system will assign the Site Reference Key (MI_SITE_KEY) to the assets using
the value designated in the applicable context file (i.e., the file for SAP or for Maximo).
The following parameters are used to designate the Site Reference Key value:
l
l
SITE_REFERENCE_EQUIP: Used to populate the Site Reference Key on Equipment
records being loaded into GE Digital APM. The Site Reference Key determines the
Site to which the Equipment record(s) will be assigned.
SITE_REFERENCE_FLOC: Used to populate the Site Reference Key on Functional
Location records loaded into GE Digital APM. The Site Reference Key determines
Site to which the Functional Location record(s) will be assigned.
Note: The values entered into these parameters should match, because Equipment records are linked to Functional Location records. Therefore, they should
have the same site.
These parameters accept three types of values to determine the site reference value.
Copyright © 2017 General Electric Company. All rights reserved. • Page 266 of 495
Deploy APM Connect
a. Site Name: You can enter the site name directly as defined on the preexisting Site
Reference record (i.e., Site 100).
b. Column Name: You can enter a column value between two pound symbols (#) to
set the site reference. The following columns can be used:
l SAP columns:
l
MI_EQUIP000_SAP_SYSTEM_C
l
MI_EQUIP000_MAINT_PLANT_C
l
MI_FNCLOC00_MAINT_PLNT_C
l
MI_FNCLOC00_SAP_SYSTEM_C
For example, if you wanted to use your SAP maintenance plant field as your
GE Digital APM site reference, you would enter #MI_EQUIP000_MAINT_PLANT_C#.
After the adapters are run, records designated to be transferred into GE Digital APM will
be assigned to the site defined in the Site Reference parameters.
In addition to Equipment and Functional Location records loaded by the EAM adapters,
Work History records and shell records are impacted by site reference functionality as
detailed in the following table.
Action
Result
If the Work History Adapter is run
after the Equipment or Functional
Location Adapter...
The Work History records will inherit the Site
Reference Key of their parent Functional Location or Equipment records.
If the Work History Adapter is run
before the Equipment or Functional Location Adapter...
The Site Reference Key will be inherited from the
shell record that will be created for Equipment
and Functional Location.
If a shell record is created while
loading data...
The Site Reference Key will be the value set in
the context parameters.
Note: If you are using multiple SAP Systems, you must set up a context file for each
system, and then designate the appropriate site(s) for each EAM Systems.
Copyright © 2017 General Electric Company. All rights reserved. • Page 267 of 495
Deploy APM Connect
Import Notification Management File
Steps
1. On your APM Connect Server, in the <root:>\APMConnect\Utilities\runtime\etc directory create a context file named: SAP_PI_NotificationManagement.cfg.
ŗIMPORTANT: The file name must match SAP_PI_NotificationManagement.cfg
exactly.
2. Paste the following into the context file:
l
context = Default
l
CONFIG_FILE_PATH = <The directory path to your SAP PI Context File. >
Note: The path must use forward slashes (/).
3. Save the file.
4. Access the APM Connect installation package, and then copy the file SAP_PI_NotificationManagement.jar.
5. Navigate to <root:>\APMConnect\Utilities\runtime\deploy.
6. Paste the copied file SAP_PI_NotificationManagement.jar in the directory.
The Notification Management File is imported.
What's Next?
l
Return to the SAP PI Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 268 of 495
Deploy APM Connect
Import the Design Objects
Steps
1. Access the APM Connect installation package.
2. Navigate to the folder that corresponds to the version of SAP PI that you are using.
For example if you are using SAP PI version 7.3, navigate to SAP PI 730.
3. Copy the following files: l
APMConnect_DesignObjects_BaseV4_3.tpz
l
APMConnect_DesignObjects_SupportPackV4_3.tpz
4. On the SAP PI Server, paste the copied files to the folder \usr\sap\<SID>\SYS\global\xi\repository_server\import, where <SID> is the system ID
of the SAP PI Server.
-orPaste the copied files anywhere on your local machine.
5. If you are using a version prior to SAP PI 7.3, select Integration Repository.
-orIf you are using SAP PI 7.3 or above, select Enterprise Services Builder.
A login screen appears.
6. Log in as an administrator.
Depending on the SAP PI Server version you are using, the Design: Integration
Builder window or the Enterprise Services Builder window appears.
7. On the Tools menu, select Import design objects.
The Choose Import Source window appears.
8. Select Client if the files copied in Step 3 were pasted onto your local machine, or
select Server if the files copied in Step 3 were pasted in \usr\sap\<SID>\SYS\global\xi\repository_server\import
9. Select the Design Objects folder.
10. Select the file APMConnect_DesignObjects_BaseV4_3.tpz, and then select OK.
A confirmation dialog box appears.
11. Select Import.
The file is imported.
12. Select the file APMConnect_DesignObjects_SupportPackV4_3.tpz, and then select
Copyright © 2017 General Electric Company. All rights reserved. • Page 269 of 495
Deploy APM Connect
OK.
A confirmation dialog box appears.
13. Select Import.
The file is imported.
14. Select Close.
The design objects are imported and appear in the Objects section.
What's Next?
l
Return to the SAP PI Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 270 of 495
Deploy APM Connect
Import the Configuration Object
Steps
1. Access the APM Connect installation package.
2. Navigate to the folder that corresponds to the version of SAP PI that you are using.
For example if you are using SAP PI version 7.3, navigate to SAP PI 730.
3. Copy the file APMConnect_ConfigurationObjectsV4_3.tpz.
4. On the SAP PI Server, paste the copied file into the folder \usr\sap\<SID>\SYS\global\xi\directory_server\import, where <SID> is the system ID of
the SAP PI Server.
-orPaste the copied file anywhere on your local machine.
5. In a web browser, navigate to http://<SAP PI Server>:<port number>/rep/start/index.jsp, where <SAP PI Server> is the name of the SAP PI Server
and <port number> is the port number of the specified SAP PI Server.
The SAP Exchange Infrastructure window appears.
6. Select Integration Directory.
A login screen appears, prompting you to log in to the Configuration: Integration
Builder.
7. Log in as an administrator.
The Configuration: Integration Builder window appears.
8. On the Tools menu, select Import configuration objects.
The Choose Import Source window appears.
9. Select Client if the file copied in step three was pasted onto your local machine, or
select Server if the file copied in step one was pasted to \usr\sap\<SID>\SYS\global\xi\directory_server\import.
10. Select the Configuration Objects folder.
11. Select the file APMConnect_ConfigurationObjectsV4_3.tpz, and then select OK.
A confirmation dialog box appears.
12. Select Import.
The file is imported, and a confirmation message appears.
13. Select Close.
Copyright © 2017 General Electric Company. All rights reserved. • Page 271 of 495
Deploy APM Connect
The configuration object is imported, and the objects appear in the Configuration
Integration Builder.
What's Next? l
Modify the baseline communication channels. To do so, you will need to remain
logged in to the Configuration: Integration Builder.
Copyright © 2017 General Electric Company. All rights reserved. • Page 272 of 495
Deploy APM Connect
Modify the Baseline Communication Channels
Note: If the FILE_MOVE_USE_PI parameter is set to false in the context file, you can
skip this procedure.
The SAP PI adapters have four baseline communication channels: FileReceiver_APMConnect, SOAPSender_APMConnect, FileSender_SAP_ECC, and RFCReceiver_SAP_ECC. You
will need to modify the following baseline communication channels:
l
FileReceiver_APMConnect
l
FileSender_Meridium_ECC
Steps
1. In a web browser, navigate to http://<SAP PI Server>:<port number>/rep/start/index.jsp, where <SAP PI Server> is the name of the SAP PI Server
and <port number> is the port number of the specified SAP PI Server.
The SAP Exchange Infrastructure window appears.
2. Select Integration Directory.
A login screen appears, prompting you to log in to the Configuration: Integration
Builder.
3. Log in as an administrator.
The Configuration: Integration Builder window appears.
4. In the Configuration: Integration Builder, in the Scenarios section, expand the
APMConnect_IDConfigurationsV4_3 row.
5. Expand the Service Without Party row.
6. Expand the Business Service row.
7. Expand the Meridium_APMConnect row.
8. Expand the Communication Channel row.
The row expands, and the following APM Connect Communication Channels
appear:
l
FileReceiver_APMConnect
l
FileSender_Meridium_ECC
9. Select FileReceiver_APMConnect.
The Display Communication Channel screen appears.
10. Select
.
Copyright © 2017 General Electric Company. All rights reserved. • Page 273 of 495
Deploy APM Connect
11. In the File Access Parameters section, in the Target Directory box, enter the target directory file path.
ŗIMPORTANT: This path must match exactly the IR_TALEND_OUTPUT parameter in the context file.
12. In File Name Scheme, enter *.*.
13. Select
.
14. Select the FileSender_Meridium_ECC.
The Display Communication Channel screen appears.
15. Select
.
16. In the File Access Parameters section, in Source Directory box, enter the endpoint of the share between your SAP server and your SAP PI server exactly as it is
in the PLSAP_INPUT parameter in the context file.
17. In Processing Parameters section, the Poll Interval box, enter the recommended
value of 100.
18. In the Processing Mode box, select Delete.
19. In the File Name Scheme, enter *.*.
20. In Advanced section, complete the following steps:
a. In the Adapter-Specific Message Attributes section, select the following
options:
l
Set Adapter-Specific Message Attributes
l
File Name
l
File Type
b. In the Adapter Status section, in the Status box, select Active.
c. Select the Advanced Mode check box.
d. In the Additional Parameters section, in the Msecs to Wait Before Modification Check box, enter the recommended value of 1000 or more.
21. Select
.
The communication channels are modified.
What's Next?
l
Return to the SAP PI Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 274 of 495
Deploy APM Connect
Activate the RFCReceiver_SAP Object
Steps
1. In the Configuration: Integration Builder, select the Change Lists tab.
2. In the Change Lists section, select | Meridium_SAP | RFCReceiver_SAP.
Note: The Error Loading Adapter Metadata dialog box may appear. If it
appears, select Close.
The communication channel details appear on the right side of the screen.
3. On the right side of the screen, select
.
4. In the Parameters section, in the Adapter Type row, select
.
The Choose Adapter Metadata window appears.
5. Select the latest RFC Adapter from the list, and then select Apply.
The communication channel details return to focus.
6. In the Properties section, confirm or enter values for the following parameters:
l
RFC Server Type
Note: This parameter must be set to SAP System.
l
Application Server
l
System Number
l
Authentication Mode
Note: This parameter must be set to Use Logon Data for SAP System.
l
Logon User
l
Logon Password
l
Logon Language
l
Logon Client
7. Select
.
8. In the Change Lists section, right-click on PI <version number> Import, and then
select Activate.
A confirmation message appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 275 of 495
Deploy APM Connect
9. Select Activate.
The object is activated.
What's Next?
l
Return to the SAP PI Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 276 of 495
Deploy APM Connect
Add Entries to the /MIAPM/TASK_CNF Table
Steps
1. In the SAP system, run the following transaction: /n/MIAPM/MIPRO.
The Display IMG screen appears.
2. In the tree, expand Configurations In SAP.
3. Select Maintain GE Digital APM Parameters.
The Meridium Configuration and Connection Parameters Management window
appears.
4. In the APM Data Source column, enter the APM data source(s) from which and to
which you want to transfer data.
5. In the APM Application Server, enter your GE Digital APM Application server(s).
6. Select
.
The Meridium Configuration and Connection Parameters Management window
closes.
7. In the Maintain Task Configuration Parameters row, select
Copyright © 2017 General Electric Company. All rights reserved. • Page 277 of 495
Deploy APM Connect
.
The Task Configuration screen appears.
8. In the APM Data Source list, select the GE Digital APM data source for which you
want to identify which Operation values will create which Task records.
Note: When defining the data sources, you must maintain the value for the App
Server field.
9. Select
.
The Display View "Meridium Task Configuration Table": Overview screen
appears. The following image illustrates the baseline table in an SAP system
whose Client number is 000. Notice that there are two rows: one for Calibration
Task records and one for Inspection Task records. This image illustrates a configuration in which Operations with the control key ZMI2 are used to create Calibration Task records, and Operations with the control key ZMI1 are used to create
Inspection Task records.
10. To specify criteria that will be used to trigger the creation of Calibration Task and
Inspection Task records, modify the values in the existing rows, or build on top of
the current functionality by adding new rows. This documentation assumes that
you are familiar with your SAP data structure and that you know how to define the
criteria to achieve the desired result.
11. Select
.
The criteria is saved.
Example
Suppose that the following Task List exists in your SAP System.
Copyright © 2017 General Electric Company. All rights reserved. • Page 278 of 495
Deploy APM Connect
Although the list contains three Operations, only the second Operation, INSPECTION, is
an inspection task. Therefore, you would want to configure the /MIAPM/TASK_CNF table
such that when you run the Work Management Adapter, a GE Digital APM Inspection
Task record is created for only that Operation.
The following image illustrates how you might configure the /MIAPM/TASK_CNF table in
this scenario.
The first row in this table specifies that the value in the control key field (i.e., the STEUS
field) of the Operation must equal ZMI1. In addition, the second row specifies that the
description of the Operation (i.e., the value in the LTXA1 field) must be INSPECTION.
The criteria specified for the MI_TASKINSP family in this example creates the condition
shown in the following image.
Copyright © 2017 General Electric Company. All rights reserved. • Page 279 of 495
Deploy APM Connect
ŒHint: To access the Condition Value for the <APM Family ID> dialog box, select a cell
in the Value column, and then press F4.
The values that you specify in the Group ID column and the Pos column determine how
the criteria in each row is arranged within the condition. In this example, each row is
assigned to a different group, so the corresponding criteria is placed within different
sets of parentheses. Although it is not shown in this example, if multiple rows were
assigned to the same group, the value in the Pos column would determine the placement of the corresponding row's criteria within the parentheses.
When you run the Work Management Adapter, GE Digital APM records are created for
only the Operations that meet the specified criteria. Continuing with this example, an
Inspection Task record is created for only the INSPECTION Operation.
What's Next?
l
Return to the workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 280 of 495
Deploy APM Connect
Define the Command Name in SAP
Note: If you are not using a compression method during the extraction, then you
can skip this procedure.
If you are using a compression option in the context file, you need to define the command name for the compression type you are using. There are two types of compressions for APM Connect SAPCAR and ZIP. You can only use one type of compression.
Note: It is recommended to use SAPCAR as your compression type.
Steps
1. In SAP, run the transaction code SM69.
The External Operation System Commands screen appears.
2. Select
.
The Create an External Command screen appears.
3. In the Command section, in the Command Name box, enter one of the following
the command names:
l
ZSAPCAR: if you are using SAPCAR for compression.
-or-
l
ZZIP: if you are using ZIP for compression.
4. In the Definition section, in the Operating system command box, enter one of the
following systems commands:
l
SAPCAR -cvf: if you are using SAPCAR for compression.
-or-
l
ZIP -9 -j: if you are using ZIP for compression.
5. Select Save.
The Command Name is defined.
What's Next?
l
Return to the SAP PI Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 281 of 495
Deploy APM Connect
Install the SAPCAR File on the APM Connect Server
Note: If you are not using SAPCAR to compress files, then skip this procedure and
proceed to the next procedure in the installation workflow.
Steps
1. On the SAP Server, copy the SAPCAR.exe file.
2. Access the APM Connect Server.
3. In the windows system32 directory, paste the SAPCAR.exe file, as shown in the following image:
The SAPCAR file is installed.
What's Next?
l
Return to the SAP PI Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 282 of 495
Deploy APM Connect
Create SAP PI Directory Structure
You will need to set up a directory structure on your SAP server to facilitate transfers
from SAP PI to APM Connect. The structure depends on the FILE_MOVE_USE_PI parameter and the COMPRESS_TYPE parameter usage in the context file. Additionally, the
folder structure depends on whether you are using FTP to transfer files.
Steps
l
On your SAP server, create one directory and subdirectory according to the following grid:
If FILE_MOVE_USE_PI
is..
...and
COMPRESS_
TYPE is...
... create the following directory
structure:
false
NONE
<root:>/<New Directory
Name>
false
ZIP or SAPCAR
<root:><New Directory
Name>/Compress
true
NONE
<root:>/<New Directory
Name>
true
ZIP or SAPCAR
<root:>/<New Directory
Name>/Compress
If you are running the adapters in FTP Mode
true
NONE
<root:>/<New Directory
Name>/FTP
true
SAPCAR or ZIP
<root:>/<New Directory
Name>/FTP/Compress
Note: Each directory needs to be in a shared directory that APM Connect can
access, and should be the base path value in PLSAP_INPUT parameter. Additionally, once the job is run, the compress directory will be programmatically
added to the value PLSAP_INPUT in the context file.
The directories are created, and the SAP PI server and APM Connect server can
extract files from the SAP sever.
What's Next?
l
Return to the SAP PI Adapter workflow for the next step in the deployment process.
Copyright © 2017 General Electric Company. All rights reserved. • Page 283 of 495
Deploy APM Connect
Deploy the Automatic Data Loader Job
This section contains the procedures and concepts you need to configure and use the
automatic data loader job.
Copyright © 2017 General Electric Company. All rights reserved. • Page 284 of 495
Deploy APM Connect
Set up the Automatic Data Loader Job
Before you can use the automatic data loader job, you must set up the job in the
APM Connect Administration Center.
Before You Begin
APM Connect must be installed.
Steps
1. Access the APM Connect Administration Center.
2. In the Menu pane, in the Conductor section, select Job Conductor.
3. On the Job Conductor toolbar, select Add.
The Execution task pane is enabled.
4. In the Execution task pane, in the Label box, enter a label for the job.
5. In the Description box, enter a description for the job.
6. Select the Active check box.
7. In the Job section, select
.
The Import generated code window appears.
8. Select Browse..., and then navigate to the folder containing the updated jobs package.
9. Select the job dinokeeper.zip, and then select Launch upload.
The job is imported into the Job Conductor.
10. Configure the context file to identify the location of the load directory, the archive
directory, and the log file.
11. Modify the <Context_File_PATH> value in the job conductor context parameters to
point to the context file for the job.
12. Run the job.
Results
The job conductor indicates that the job ran successfully, and the automatic data loader
directories will be created, if they do not already exist.
You can now place workbooks in the appropriate data loader directory.
Copyright © 2017 General Electric Company. All rights reserved. • Page 285 of 495
Deploy APM Connect
Configure the Context File
The context file provides the automatic data loader job with the information it needs to
locate the directories and log the file it requires.
Before You Begin
You should have imported the automatic data loader job.
Steps
1. Navigate to the following folder: C:\APMConnect\Config\<system>
2. Modify the file ContextFile.xml to indicate the values for your system.
Parameter
Description
CONFIG_FILE_
PATH
The path to the
context file used
for extraction.
SCAN_DIR
The directory that
contains the directories from
which the job
retrieves workbooks to load
data.
Default or recommended value
Enter your unique value (e.g.,
C:\APMConnect\Config\ContextFile.xml).
Enter your unique value (e.g.,
C:\APMConnect\Dinokeeper).
ŗIMPORTANT: Because this job runs
with administrative authority, you
must control user access to this directory.
ARCHIVE_DIR
The directory that
the facility uses to Enter your unique value (e.g.,
archive workC:\APMConnect\Archives).
books.
LOG_BASE_DIR
The path that the
facility uses to
store the generated log files.
Enter your unique value (e.g.,
C:\APMConnect\Log).
Copyright © 2017 General Electric Company. All rights reserved. • Page 286 of 495
Deploy APM Connect
Parameter
Description
Default or recommended value
Enter your unique value (e.g.,
C:\APMConnect\Config\log4j.properties).
LOG4J_CONFIG_
FILE
The path to the
log4j configuration file.
Note: This can be the same log4j
configuration file that you use for
your Adapters. If you want to use log4j
settings that are different from the
EAM job, then you must configure the
context file with different log4j properties.
Copyright © 2017 General Electric Company. All rights reserved. • Page 287 of 495
Deploy APM Connect
About the Automatic Data Loader Job
GE Digital APM provides a method to automatically load data from correctly formatted
Excel workbooks into the system. You must place your data loader workbook in the correct directory for a successful data load.
The job monitors a configured load directory for the presence of a file in a subdirectory
and stages the contents of the file into the system. Multiple files moved into the directory are processed in descending order according to the last modified timestamp on
each file.
The system logs the staging progress and archives files it has successfully staged in an
archive directory. If data fails to stage, a message is written to the log indicating the
reason for failure, and the source files remain in the scan directory.
A service then retrieves the staged workbooks, and using an administrative account, the
service invokes the appropriate data loader to load the data contained in the workbooks.
Note: For cloud implementation, the archiving of files occurs before staging the
data for uploading to the cloud server.
Copyright © 2017 General Electric Company. All rights reserved. • Page 288 of 495
Deploy APM Connect
The Automatic Data Loader Directories
The automatic data loader job uses directories within the directory identified in the
SCAN_DIR parameter to identify the data loader to use for a particular workbook.
Data Loaders and Directories
The following table lists the directories that are created when the job starts that correspond to the various data loaders.
Data Loader Name
Directory Name
APM Family
ManageAPM
Asset Criticality Analysis (ACA)
ACADataLoader
Asset Ingestion Loader
AssetIngestionLoader
Asset Strategy Management (ASM)
ManageASM
Asset Strategy Management (ASM) Templates
ManageAssetStrategyTemplate
Calibration
Calibration Loader
Custom Asset Hierarchy
Custom Asset Hierarchy Loader
Equipment and Functional Location
ManageEquipmentAndFunctionalLocation
Failure Modes and Effects Analysis (FMEA)
ManageRCMFMEA
Failure Modes and Effects Analysis (FMEA)
Analysis Templates
ManageFMEAAnalysisTemplate
Failure Modes and Effects Analysis (FMEA)
Asset Templates
ManageFMEAAssetTemplate
Generation Availability Analysis (GAA)
Amplification Codes
GAA GADS Amplification Code
Generation Availability Analysis (GAA)
Cause Code
GAA GADS Cause Code
Geographic Information System (GIS)
GISDataLoader
Hazards
Hazards Loader
Copyright © 2017 General Electric Company. All rights reserved. • Page 289 of 495
Deploy APM Connect
Data Loader Name
Directory Name
Inspection Management (IM) Assets
ManageInspections
Inspection Management (IM) Functional
Location
ManageInspectionsFL
Production Loss Analysis (PLA)
Load PLA
Reliability Centered Maintenance (RCM)
ManageRCM
Risk Based Inspection (RBI) 580
ManageRBI580
Risk Based Inspection (RBI) 581
ManageRBI581
Risk Based Inspection (RBI) Corrosion
Loop
Load RBI Corrosion Loop
Role
RoleDataLoader
Root Cause Analysis (RCA)
Manage RCA
Rounds Allowable Values
Rounds Allowable Value
Rounds Readings
Rounds Readings
Rounds Routes
Rounds Route
Rounds Templates
Rounds MLTG
Tags to Assets Relationship
ManageTagLinks
Taxonomy
ManageTaxonomy
Thickness Monitoring (TM) Equipment
ManageTMLGroup
Thickness Monitoring (TM) Functional
Location
ManageTMLGroupFL
Work History
ManageWorkHistory
Copyright © 2017 General Electric Company. All rights reserved. • Page 290 of 495
Overview of APM Connect
Overview of APM Connect
GE Digital APM Connect is an integration framework designed to connect users to the
valuable data that exists in data stores, systems, and applications throughout the enterprise.
The framework delivers data transformation engines to convert data to their appropriate forms, a modular integration engine to handle complex routing scenarios, and
other engineered components to create a unified integration solution.
Built on the APM Connect framework are numerous adapters that can meet many integration needs by either pulling data from or pushing it into other sources in the data ecosystem. APM Connect offers new EAM connection adapters as replacement technology
for some existing EAM interfaces, and will continue to add additional adapters and capabilities in subsequent releases.
Adapters
The following adapters are currently available through the most recent release of APM
Connect:
l
ASI for SAP
l
EAM Adapters
l
l
l
l
SAP Adapters
l
Equipment Adapter
l
Functional Location Adapter
l
Work History Adapter
l
Notification Management Adapter
l
Technical Characteristics Adapter
l
Work Management Adapter
SAP PI Adapters
Maximo Adapters
l Equipment
l
Functional Location Adapters
l
Work History Adapter
l
Work Order and Service Request Adapter
Data Loaders
Copyright © 2017 General Electric Company. All rights reserved. • Page 291 of 495
Overview of APM Connect
Overview of the EAM Adapters
The APM Connect EAM Adapters transfer data from your existing Enterprise Asset Management (EAM) system into GE Digital APM using the APM Connect Administration
Center.
APM Connect is built upon a fundamental premise that you are using an external EAM
system to store information about your equipment, the locations in which the equipment exists, failures of the equipment and locations, and work that has been performed
on the equipment and locations.
GE Digital APM provides tools that let you analyze and process this data. Before you can
analyze the data in GE Digital APM, however, you must transfer it from your EAM system
into your GE Digital APM system. After the data exists in GE Digital APM, it can be analyzed to determine the state of your equipment and locations, and the reliability, trends,
potential risks, and probability of failures associated with them.
Copyright © 2017 General Electric Company. All rights reserved. • Page 292 of 495
Overview of APM Connect
About Time Zone Data
GE Digital APM stores the date and time of transaction in the Universal Coordinated
Time (UTC) format. This enables the data to flow through the system in a single time
zone format.
To provide information with the timestamp relevant to your operations, the system converts UTC to your time zone by using the time zone information configured in your user
definition.
ŗIMPORTANT: If you change the time zone information configured in your user definition, all the records will reflect the new time zone.
The following sections contain the time zone considerations relevant to specific systems.
Maximo
GE Digital APM stores the timestamp associated with the data extracted from Maximo in
UTC and displays the timestamp based on your configured time zone.
SAP
SAP provides a set of baseline time zone codes, which contain most of the standard
time zones across the world. SAP also provides the ability for administrators to define
their own custom time zone, as needed. Before you use a customized time zone, you
must configure the timezone_control table in APM Connect to reflect the customized
time zone.
SAP defines two types of time zones:
l
l
System: This time zone is based on SAP Application Server Operating System and
is derived from the context file. You cannot modify this type of time zone.
User: This time zone is based on the user who created the SAP record. You can
modify and store this type of time zone in the SAP user interface.
GE Digital APM stores the timestamp associated with the data extracted from SAP in
UTC and displays the timestamp based on the time zone configured for the user who
created the SAP record.
Note: If the data extracted from SAP contains only the date, then GE Digital APM will
assign the time 00:00:00 and the SAP system or user time zone to the data. This may
lead to date mismatch when you choose to display the data in GE Digital APM. To prevent this, GE Digital APM stores the reference timestamp as a string within the data,
which is hidden, by default. If you need this information, you can configure GE Digital
APM to display the data.
Copyright © 2017 General Electric Company. All rights reserved. • Page 293 of 495
Overview of APM Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 294 of 495
Overview of APM Connect
EAM Adapter Workflow
This workflow provides the basic, high-level steps for using this module. The steps and
links in this workflow do not necessarily reference every possible procedure. For more
procedures, see the links in the Related Information section.
1. Identity the records you want to transfer from your EAM system(s) to GE Digital
APM.
2. Apply filter parameters in the context file as necessary.
3. Schedule a job(s) to run in the APM Connect Administration Center.
-orExecute a run-now job.
4. Check that the record was transferred into GE Digital APM.
Note: This step is not necessary to complete the data transfer. However, it is a
check to ensure that the transfer was executed successfully.
5. If the transfer was not successful, view the execution log for errors.
Copyright © 2017 General Electric Company. All rights reserved. • Page 295 of 495
Overview of APM Connect
Overview of the SAP Adapters
Data extractions, also referred to as jobs, are orchestrated through the different
adapters. Depending on the type of data (i.e., Equipment, Functional Location, Work History) you want to extract, there is a corresponding job. SAP extractions are facilitated by
the APM Connect Administration Center and a corresponding context file. The context
file contains filter parameters that are applied to each extraction adapter Job. The filter
parameters define the scope of the data extraction.
More Details
The following SAP and SAP PI adapters are available for data extractions:
l
l
l
l
l
l
Equipment Adapter: Extracts records that are used to store information about
physical pieces of equipment, such as pumps, motors, and compressors.
Functional Location Adapter: Extracts records that are used to store information
about locations in your organization including, but not limited to, the locations at
which the physical pieces of equipment are installed.
Work History Adapter: Extracts records that are used to store data about work that
was performed against your locations and equipment, as well as failures that
occurred for those locations and equipment. Additionally, it allows you to transfer
Notifications and Orders from SAP to GE Digital APM.
Notification Management Adapter: Allows you to transfer Recommendation
records from GE Digital APM to SAP in the form of Notifications.
Technical Characteristics Adapter: Allows you to transfer Functional Location characteristics and Equipment characteristics from SAP to GE Digital APM.
Work Management Adapter: Allows you to manage scheduled work in SAP and
GE Digital APM.
Copyright © 2017 General Electric Company. All rights reserved. • Page 296 of 495
Overview of APM Connect
Employ the Notification Management Adapter
This topic provides a list of all procedures related to employing the Notification Management Adapter, as well as links to the related concept and reference topics.
Copyright © 2017 General Electric Company. All rights reserved. • Page 297 of 495
Overview of APM Connect
Create an SAP Notification from a Recommendation Record
Before you Begin
l
l
Ensure the Create EAM Notification field exists in the family of the necessary
Recommendation record and that it also exists on the datasheet.
Ensure the EAM Notification Type field exists in the family of the necessary Recommendation record and on the datasheet as an enabled field. In the baseline database, Notification Type is already available in all baseline Recommendation
families that exist for the purpose of using the SAP Adapters. It is not, however,
included on any baseline datasheets or configured as an enabled field. The following instructions assume that an administrative user has enabled the field and
added it to the datasheet.
Steps
1. Create a new General Recommendation record or access an existing Recommendation record.
2. Link the Recommendation record to an Equipment or Functional Location record
that represents an SAP Equipment or Functional Location.
Note: If you select an Equipment or Functional Location record that does not
exist in SAP, after you save the record, an SAP Notification will be created in SAP
but its Equipment or Functional Location field will be blank.
3. Select the Create EAM Notification? check box.
4. In the Notification Type box, specify the type of notification that you want to create.
Note: Unless otherwise configured, the default SAP Notification Type will be
M1.
5. Select dž.
The record is saved.
Results
After you create a new Recommendation record, the adapter does the following:
l
l
Creates an SAP Notification in SAP.
Populates the Work Request Reference field with the ID of the corresponding SAP
Notification.
Copyright © 2017 General Electric Company. All rights reserved. • Page 298 of 495
Overview of APM Connect
l
l
l
Populates the Work Request Equipment field with the value in the Equipment field
in the SAP Notification, as available.
Populates the Work Request Functional Location field with the value in the Functional Location field in the SAP Notification, as available.
After the Work Request Reference field is populated, the Create Work Request
field is disabled.
Note: If a Notification could not be created, a message appears indicating the
problem. In addition, you will be unable to save the Recommendation record
until you clear the Create EAM Notification? check box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 299 of 495
Overview of APM Connect
Update an SAP Notification from a Recommendation Record
Once an SAP Notification is created from a Recommendation record, the Recommendation record and the SAP Notification can be updated. This topic describes how to
update an existing SAP Notification by updating the corresponding Recommendation
record in GE Digital APM.
Note: Only Recommendation records with the Create EAM Notification? check box
selected can be updated.
Before You Begin
l
Create an SAP Notification from a Recommendation record.
Steps
1. Access a Recommendation record that you want to update.
2. Select the field you want to update.
3. Enter the updated information.
For example, if you would like to update the description of an existing Recommendation record, modify the text in the Description box as needed.
4. Select dž.
The Recommendation record is updated in GE Digital APM, and the SAP Notification is updated in your SAP system.
Copyright © 2017 General Electric Company. All rights reserved. • Page 300 of 495
Overview of APM Connect
Employ the Work Management Adapter
This topic provides a list of all procedures related to employing the Work Management
Adapter, as well as links to the related concept and reference topics.
Copyright © 2017 General Electric Company. All rights reserved. • Page 301 of 495
Overview of APM Connect
Work Management Workflow
This workflow provides the basic, high-level steps for using this module. The steps and
links in this workflow do not necessarily reference every possible procedure. For more
procedures, see the links in the Related Information section.
Manage Scheduled Work in SAP Workflow
1. In SAP, on a Maintenance Plan, enter a value, or the combination of values, configured to trigger the creation of a GE Digital APM Task record.
2. In the Administration Center, run the Work Management Job.
One or more Task records are automatically created in GE Digital APM.
Note: If the Task records are created from Maintenance Plans that are associated with Equipment or Functional Locations that do not already exist in
GE Digital APM, corresponding Equipment and Functional Location records will
be created automatically and linked to the new Task records. These Equipment
and Functional Location records will contain values only in key fields as defined
in the mappings (e.g., Equipment ID, Functional Location Internal ID, CMMS System). You will need to run the Equipment Extraction and Functional Location
Adapters to populate the remaining fields.
3. In GE Digital APM, create an Inspection record or Calibration Event record.
4. Link the new record to the Inspection Task or Calibration Task record that you created by running the Work Management Job.
5. Close the Work Order.
6. In GE Digital APM, update the Confirmation record with any modified information.
-orIn SAP, validate the Confirmation.
Manage Scheduled Work in GE Digital APM Workflow
1. In GE Digital APM, create a Task record.
2. creation.
3. In GE Digital APM, create an Inspection record or a Calibration Event record.
4. Link the new record to the Inspection Task or Calibration Task record that you created.
Copyright © 2017 General Electric Company. All rights reserved. • Page 302 of 495
Overview of APM Connect
5. Close the Work Order.
6. If needed, in GE Digital APM, update the Confirmation record.
-orIn SAP, validate the Confirmation.
Copyright © 2017 General Electric Company. All rights reserved. • Page 303 of 495
Overview of APM Connect
Create a Task Record
Note: To complete the following steps, use the Task datasheet that is configured for
use with the SAP Adapter. For Inspection Task records, use the Inspection Task for SAP
Integration Adapter datasheet. For Calibration Task records, use the Calibration Task
for SAP Integration datasheet. These datasheets are defined on the corresponding
Task family in the baseline database, but they are not set as the default datasheets.
To create the Task record, make sure to use the Task Builder and not the Record Manager. Otherwise, the Task record will not be linked to the Equipment or Functional
Location record, and the Work Management Adapter will not work as expected.
Before You Begin
You can create an SAP Order from a Task record only if all of the following conditions
are true:
l
The Work Order Number field in the Task record is blank.
l
The Task record was not created automatically from SAP data.
Steps
1. In GE Digital APM, create an Inspection Task or Calibration Task record.
2. In the Task record, in the Task List field, select ƭ.
The Locate Task List window appears.
3. In the Search Criteria section, enter the desired search criteria.
Note: If you accept the default criteria, the search results will return all Task
Lists.
4. Select Search.
The Task Lists that meet the search criteria appear in the Search Results section.
5. In the Search Results section, select the row containing the desired Task List, and
then select OK.
The Task List field on the Task record is updated with the Task List group number.
6. In the Last Date field, enter or select the last date on which the task was executed.
7. In the Desired Interval field, enter the desired interval.
The value in the Next Date field is updated automatically based on the Last Date
and the Desired Interval.
Copyright © 2017 General Electric Company. All rights reserved. • Page 304 of 495
Overview of APM Connect
8. In the Call Horizon field, enter the desired call horizon.
ŒTip: For details about call horizons, see the SAP Help, which is located at
http://help.sap.com/.
9. Save the Task record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 305 of 495
Overview of APM Connect
Create an Event Record or Inspection Record
Note: The following instructions work correctly only if the SAP Interfaces - Work
Management license is active.
When creating the Inspection record or Calibration Event record, be sure to use the
process defined by the module rather than the Record Manager. Otherwise, the record
will not be linked to the Equipment or Functional Location record, and the Work Management Adapter will not work as expected.
Steps
1. Using the process defined by the module, create an Inspection record or Calibration Event record. As you proceed through the Event Builder, on the Task(s)
Selection screen, select the appropriate Task record. This could be:
l
A Task record that was generated from SAP.
-or-
l
A Task record that you created manually to generate an SAP Order automatically.
2. If the Event record is an Inspection record, select values in the Commencement
Date and Completion Date fields. Ensure that the Completion Date is a date after
the Commencement Date.
Copyright © 2017 General Electric Company. All rights reserved. • Page 306 of 495
Overview of APM Connect
Close a Work Order
Steps
1. Access the event record linked to the task record you want to mark as complete.
2. In the Tasks Addressed box, select the task ID for the record you transferred from
SAP by running the Work Management Adapter.
3. In the Actual Work Time box, enter a value for the number of hours worked to
complete the task.
4. In the Event record, in the Actual Work Time box, enter the time (in hours) that
you spent completing the work.
5. If the Event record is a Calibration Event record, select the Calibration Close check
box.
-orIf the Event record is an Inspection record, select the Inspection Task Complete
check box.
6. Save the Event record.
The event record is saved, and the work order is closed. A confirmation record is
created in GE Digital APM and in SAP.
ŗIMPORTANT: When transferring Work Management data from SAP into
GE Digital APM, the Desired Interval field is populated with a null value. After the
Plan is called, the Next Date field will populate with the next execution date
based on calculations made by SAP.
Results
After saving the record, the following occurs:
l
A Confirmation record is created and linked to the Event record and the Task
records to which the Event record is linked. The number of Confirmation records
created equals the number of Task records that are linked to the Event record. In
addition, a Confirmation is created in SAP for each Confirmation record that is created in GE Digital APM.
If only one Confirmation record is created, the Actual Work Time in the Confirmation record matches the Actual Work Time in the Event record. If more than
one Confirmation record is created, the Actual Work Time in the Event record is
split evenly between those Confirmation records.
For example, if an Event record is linked to two Task records, two Confirmation
records will be created. If the Actual Work Time in the Event record is 14, the
Actual Work Time in each Confirmation record will be 7 (14/2).
Copyright © 2017 General Electric Company. All rights reserved. • Page 307 of 495
Overview of APM Connect
l
l
The Work Order Numbers in the Task records that are linked to the Event record
are removed.
The Confirmation that is created in SAP is marked as final.
Copyright © 2017 General Electric Company. All rights reserved. • Page 308 of 495
Overview of APM Connect
Update an SAP Confirmation by Updating the
Actual Work Time in a Confirmation Record
Steps
1. Access the Confirmation record that you want to modify.
2. Modify the Actual Work Time value, and then save the record.
Results
l
l
l
The associated SAP Confirmation is canceled in SAP, and a new SAP Confirmation
is created. The counter in the new SAP Confirmation is one digit higher than the
counter in the canceled SAP Confirmation.
The Actual Work Time field in the Inspection record or Calibration Event record to
which this Confirmation record is linked is updated automatically to reflect the
updated value in the Confirmation record. If this is the only Confirmation record
that is linked to the Inspection or Calibration Event record, the Actual Work Time
in the Inspection or Calibration Event record will match the value in the Confirmation record.
If more than one Confirmation record is linked to the Inspection or Calibration
Event record, the Actual Work Time in the Event record is updated to be the sum
of the values in the Actual Work Time fields in all of those Confirmation records.
For example, if an Event record is linked to this Confirmation record and two
other Confirmation records, and the final values in the Actual Work Time fields of
those Confirmation records are 7, 6, and 5, the Event record will contain the value
18 (7 + 6 + 5) in the Actual Work Time field.
Copyright © 2017 General Electric Company. All rights reserved. • Page 309 of 495
Overview of APM Connect
Validate SAP Confirmations Against GE Digital APM
Confirmation Records
After you have created SAP Confirmations from GE Digital APM Confirmation records,
you can validate the information in the SAP Confirmations against the information in
the GE Digital APM Confirmation records.
Steps
1. In SAP, run the following transaction: IW43.
The window appears.
2. If you know the Confirmation number of the Confirmation that you want to validate, in the Confirmation text box enter the Confirmation number, which appears
in the Confirmation Number field on the Confirmation datasheet in the GE Digital
APM system.
-orIf you know the Order number associated with the Confirmations that you want to
validate, in the Order text box, enter the Order number, which appears in the
Copyright © 2017 General Electric Company. All rights reserved. • Page 310 of 495
Overview of APM Connect
Work Order Number field on the Confirmation datasheet in the GE Digital APM system.
3. Select
.
If only one Confirmation meets the specified criteria, the Display PM Order Confirmation: Actual Data screen appears, displaying the values that appear on the
Confirmation datasheet in the GE Digital APM system.
-orIf more than one Confirmation meets the specified criteria, the Display PM Order
Confirmation: Confirmation Overview screen appears, displaying a list of the Confirmations that meet the specified criteria. In the list, you can see the values that
appear on the Confirmation datasheet in the GE Digital APM system.
Copyright © 2017 General Electric Company. All rights reserved. • Page 311 of 495
Overview of APM Connect
Manage Filter Parameters in the Context File
This topic provides a list of all procedures related to applying filter parameters in the
context file, as well as links to the related concept and reference topics.
Copyright © 2017 General Electric Company. All rights reserved. • Page 312 of 495
Overview of APM Connect
Apply Common Filter Parameters
There are common filter parameters in the context file that operate in the same manner, no matter which adapter you are using to extract data. This topic describes how to
configure the common filter parameters.
Before You Begin
Before you can transfer data with an adapter, you must complete the following:
l
Import an Adapter Job to which filters can be applied.
Steps
1. On the machine on which you installed APM Connect, navigate to
<root:\\>APMConnect\Config.
Note: If you are using multiple SAP systems, there will be multiple context
files to which you will need to apply the filter parameters.
2. Right-click on the context file file, and then select Edit.
The context file opens.
Copyright © 2017 General Electric Company. All rights reserved. • Page 313 of 495
Overview of APM Connect
3. As necessary, configure the following common parameters in the table:
Common Filter
Parameters
Description
Value Requirements
Required,
Optional
CHANGE_DATE_
START
Date value that limits
the data extracted to
Dates must be entered
records changed on or in the following
after the specified
format: YYYYMMDD.
date.
Optional
CHANGE_DATE_
END
Date value that limits
the data extracted to
Dates must be entered
records changed on or in the following
before the specified
format: YYYYMMDD.
date.
Optional
CREATE_DATE_
START
Date value that will
limits the data extracted to records created
on or after the specified date.
Dates must be entered
in the following
format: YYYYMMDD.
Optional
CREATE_DATE_
END
Date value that limits
the data extracted to
records created on or
before the specified
date.
Dates must be entered
in the following
format: YYYYMMDD.
Optional
LANGUAGE
The SAP code that rep- Must be a single charresents the language.
acter.
Required
MAINT_PLANT
ID(s) of the Maintenance Plant whose
data you want to
extract.
Optional
Plant values cannot
exceed four characters.
4. Save the changes to the context file.
The common filter parameters are configured and applied to all Adapter Jobs in the
APM Connect Administration Center.
Results
l
When Jobs are executed in the APM Connect Administration Center, APM Connect
will use the common filters in the context file to determine the scope of the extraction required by that Job. Now, you can configure the filter parameters specific to
the Adapter Job that you would like to run.
Example: Using the Common Filters
To extract English records created between January 1st and December 31, 2000, and
Copyright © 2017 General Electric Company. All rights reserved. • Page 314 of 495
Overview of APM Connect
changed between January 1st and December 31st, 2012, from maintenance plant 1000:
1. In the CREATE_DATE_START field, enter the following to reflect January 01, 2000:
20000101.
2. In the CREATE_DATE_END field, enter the following to reflect December 31, 2000:
20001231.
3. In the CHANGE_DATE_START field, enter the following to reflect January 01, 2012:
20120101.
4. In the CHANGE_DATE_END field, enter the following to reflect December 31, 2012:
20121231.
5. In the LANGUAGE field, enter the following SAP code for English: E.
6. In the MAINT_PLANT> field, enter the following maintenance plant ID: 1000.
The necessary filter parameters are entered into the context file, as shown in the
following image:
Copyright © 2017 General Electric Company. All rights reserved. • Page 315 of 495
Overview of APM Connect
7. Save the context file.
Only records with English descriptions created in 2000 and changed in 2012 from
maintenance plant 1000 will be extracted when an Adapter is run in the APM Connect Administration Center.
What's Next? l
Common filters can be applied to each adapter. After the necessary common filters are configured, you can apply the following adapter specific parameters:
l Equipment Adapter filter parameters.
l
Functional Location Adapter filter parameters.
l
Work History Adapter filter parameters.
l
Technical Characteristic filter parameters.
l
Work Management filter parameters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 316 of 495
Overview of APM Connect
Apply Equipment Filter Parameters
In the context file, there are filter parameters that apply specifically to the Equipment
Adapter Jobs. These filter parameters determine which Equipment data will be transferred from the EAM source system into GE Digital APM. This topic outlines the functions of Equipment-specific filters, and how to apply them.
Before You Begin
Before you can manipulate the Equipment Adapter data, you must first complete the following:
l
Import the Equipment Adapter Job into the APM Connect Administration Center.
Steps
1. On the machine on which you installed APM Connect, navigate to
<root:\\>\APMConnect\Config.
Note: If you are using multiple SAP systems, there will be multiple context
files to which you will need to apply the filter parameters.
2. Right-click the file context file, and then select Edit.
The context file opens.
3. As needed, configure the Common Filters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 317 of 495
Overview of APM Connect
4. As needed, configure the following Equipment Filter parameters in the table:
Equipment Filter
Parameters
Description
Value Requirements
Required or
Optional
EQUIPMENT_NO
Equipment that you
want to extract.
The Equipment number should not
exceed 18 characters.
You cannot exceed
500 Equipment numbers.
EQUIPMENT_
CATEGORY
ID of the Equipment
Category that will
limit the Equipment
extracted
The Equipment Category should not
exceed one character.
Optional
EQUIPMENT_
TYPE
ID of the Equipment
The Equipment Type
Type that will limit
should not exceed 10
the Equipment extraccharacters.
ted.
Optional
Optional
The Equipment Class
should not exceed 18
characters.
EQUIPMENT_
CLASS
ID of the Equipment
Classification that will
limit the Equipment
extracted.
If an Equipment has
multiple classifications, as long as
you specify one of
those classifications,
the Equipment record
will be extracted.
Optional
5. Save the changes to the context file.
Results
l
The Equipment filter parameters are configured, and the Equipment Adapter Job
can be run in the APM Connect Administration Center. When a Job is run in the
APM Connect Administration Center, the Job will look to the context files for the
parameters of the extraction. If no filters are entered to limit the records extracted, all Equipment records will be extracted.
Example: SAP Equipment Data Extraction
To extract Equipment records created between December 2009 and December 2010
with Equipment numbers 1001273-1001277:
Copyright © 2017 General Electric Company. All rights reserved. • Page 318 of 495
Overview of APM Connect
1. In the CREATE_DATE_START field, enter the following to reflect the date December
1, 2009: 20091201.
2. In the CREATE_DATE_END field, enter the following to reflect the date December
31, 2010: 20101231.
3. In the EQUIPMENT_NO field enter the following Equipment identification numbers: 000000000001001273,
000000000001001274,000000000001001275,000000000001001276,000000000001001277.
The necessary filter parameters are entered in the context file, as shown in the following image:
4. Save the context file.
Only Equipment records with the IDs 1001273-1001277 created between December
2009 and December 2010 are extracted when the Job is run in the APM Connect
Administration Center.
What's Next?
l
After you have applied the filters in the context file, you can run the associated job
in the APM Connect Administration Center.
Copyright © 2017 General Electric Company. All rights reserved. • Page 319 of 495
Overview of APM Connect
Apply Functional Location Filter Parameters
In the context file, there are filter parameters that apply specifically to the Functional
Location Adapter. These filter parameters determine which Functional Location data will
be transferred from the EAM source system into GE Digital APM. This topic outlines the
functions of Functional Location-specific filters, and how to apply them.
Before You Begin
Before you can manipulate the Functional Location data, you must first import the functional location adapter job into the APM Connect Administration Center.
Steps
1. On the machine on which you installed APM Connect, navigate to
<root:\\>\APMConnect\Config.
Note: If you are using multiple SAP systems, there will be multiple context
files to which you will need to apply the filter parameters.
2. Right-click the file context file, and then select Edit.
The context file opens.
3. As necessary, configure the Common Filters.
4. As necessary, configure the following Functional Location Filter parameters in the
table:
Functional Location
Parameters
Description
Value Requirements
Required or
Optional
FLOC_NO
The Functional Location number should
Number that idennot exceed 40 chartifies the Functional
acters. You cannot
Optional
Location record you
exceed 500 Funcwant to extract.
tional Location numbers.
FLOC_CATEGORY
ID of the Functional
Location Category
that will limit the
Functional Locations extracted.
The Functional Location Category
Optional
should not exceed
one character.
Copyright © 2017 General Electric Company. All rights reserved. • Page 320 of 495
Overview of APM Connect
FLOC_CLASS
ID of the Functional
Location Classification that will
limit the Functional
Locations extracted.
The Functional Location Class should
Optional
not exceed 18 characters.
FLOC_TYPE
ID of the Functional
Location Type that
will limit the Functional Locations
extracted.
The Functional Location Type should
Optional
not exceed ten characters.
TECHNICAL_
CHARACTERISTICS_
ENABLED
Determines
whether technical
characteristics are
extracted during
the static data job.
Setting the value to
False removes
these records and
improves performance.
True or False
Required
5. Save the changes to the context file.
Results
l
The Functional Location filters parameters are configured, and the Functional
Location Adapter Job can be run in the APM Connect Administration Center. When
a Job is run in the APM Connect Administration Center, the Job will reference the
context files for the parameters of the extraction. If no filters are entered to limit
the records extracted, all Functional Location records will be extracted.
Example: SAP Functional Location Extraction
To extract Functional Location records changed between January 1 and December 31,
2013, with the Functional Location class WCM:
1. In the CHANGE_DATE_START field, enter 20130101.
2. In the CHANGE_DATE_END field, enter 20131231.
3. In the FLOC_CLASS field, enter WCM to limit records extracted to those with the
Functional Location class of WCM, as shown in the following image:
Copyright © 2017 General Electric Company. All rights reserved. • Page 321 of 495
Overview of APM Connect
4. Save the context file.
Only Functional Location records with the Functional Location class WCM that
were modified between January 1 and December 31, 2013, are extracted when the
Job is run in the APM Connect Administration Center.
What's Next?
l
After you have applied the filters in the context file, you can run the associated job
in the APM Connect Administration Center.
Copyright © 2017 General Electric Company. All rights reserved. • Page 322 of 495
Overview of APM Connect
Apply Work History Filter Parameters
There are filter parameters in the context file that specifically apply to the Work History
Adapter. The filter parameters determine which Work History data will be transferred
from SAP into GE Digital APM. This topic describes the functions of Work History-specific filters, and how to apply them.
Before You Begin
Before you can manipulate the Work History data, you must import the work history
adapter job into the APM Connect Administration Center.
Steps
1. On the machine on which you installed APM Connect, navigate to
<root:\\>\APMConnect\Config.
2. Right-click the file context file, and then select Edit.
The context file opens.
3. As necessary, configure the Common Filters.
4. As necessary, configure the following Work History parameters in the context file:
Work History Parameters
Description
Value Requirements
CHANGE_TIME_
START
Time value. Retrieves
records changed at or after
the specified time.
Time values must be
entered in the following
format: HHMMSS.
CHANGE_TIME_END
Time value. Retrieves
records changed at or
before the specified time.
Time values must be
entered in the following
format: HHMMSS.
CREATE_TIME_START
Time value. Retrieves
records created at or after
the specified time.
Time values must be
entered in the following
format: HHMMSS.
CREATE_TIME_END
Time value. Retrieves
records created at or before
the specified time.
Time values must be
entered in the following
format: HHMMSS.
WORK_ORDER_
SYSTEM_STATUS
Work Order system status
that limits the work orders
you will extract.
Work Order System Status
should not exceed four
characters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 323 of 495
Overview of APM Connect
WORK_ORDER_
USER_STATUS
Work Order user status that
limits the work orders you
will extract.
Work Order User Status
should not exceed four
characters.
NOTIFICATION_
SYSTEM_STATUS
Notification system status
that limits the notifications
you will extract.
Notification system status
should not exceed four
characters.
NOTIFICATION_
USER_STATUS
Notification user status that
limits the notifications you
will extract.
User status should not
exceed four characters.
NOTIFICATION_NO
Number that identifies the
Notification record.
Notification Number
should not exceed 12 characters.
WORK_ORDER_NO
Number that identifies the
Work Order record.
Work Order Number
should not exceed 12 characters.
NOTIFICATION_TYPE
Order type that limits the
orders you will extract.
Notification type should
not exceed two characters.
WORK_ORDER_TYPE
ID of the work order that
limits the orders you will
extract.
Work Order type should
not exceed four characters.
EQUIPMENT_
CATEGORY
ID of the Equipment category that limits the Equipment data extracted.
Equipment category
should not exceed one
character.
EQUIPMENT_CLASS
ID of the Equipment class
that limits the Equipment
data extracted.
Equipment class should
not exceed 18 characters.
EQUIPMENT_TYPE
ID of the Equipment Type
Equipment type should
that will limit the Equipment
not exceed 10 characters.
extracted.
FLOC_CATEGORY
ID of the Functional Location Category that will limit
the Functional Locations
extracted.
Functional Location category should not exceed
one character.
FLOC_CLASS
ID of the Functional Location Classification that will
limit the Functional Locations extracted.
Functional Location class
should not exceed 18 characters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 324 of 495
Overview of APM Connect
FLOC_TYPE
ID of the Functional Location Type that will limit the
Functional Locations extracted.
Functional Location type
should not exceed 10 characters.
Results
l
The context file is configured, and the Work History Adapter Job can be run in the
APM Connect Administration Center. When a Job is run in the APM Connect Administration Center, the job will look to the context files for the parameters of the
extraction. If no filters are entered to limit the records extracted, all Work History
records for work orders and notifications will be extracted.
Example: SAP Work History Extraction
To extract Work History records created in 2014 between October 1-31st, changed
between the hours of 8:00 A.M. and 5:00 P.M., with the Work Order type maintenance
orders, with the Equipment Type mobile cranes:
1. In the CREATE_DATE_START field, enter the following to reflect October 1, 2014:
20141001.
2. In the CREATE_DATE_END field, enter the following to reflect October 31, 2014:
20141031.
3. In the CHANGE_TIME_START field, enter the following to reflect 8:00 A.M.: 080000.
4. In the CREATE_TIME_END field, enter the following to reflect 5:00 P.M.: 170000.
5. In the WORK_ORDER_TYPE field, enter the following SAP code for Maintenance
order: PAM.
6. In the EQUIPMENT_TYPE field, enter the following SAP code for Mobile Cranes:
007.
The necessary parameters are in the context file, as shown in the following image:
Copyright © 2017 General Electric Company. All rights reserved. • Page 325 of 495
Overview of APM Connect
7. Save the context file.
Only Work History records that are Maintenance Orders for Mobile Cranes created
in October 2014, changed between the hours of 8:00 A.M. and 5:00 P.M., will be
extracted when the Work History Job is run in APM Connect Administration
Center.
What's Next?
l
After you have applied the filters in the context file, you can run the associated job
in the APM Connect Administration Center.
Copyright © 2017 General Electric Company. All rights reserved. • Page 326 of 495
Overview of APM Connect
Apply Technical Characteristics Filters
In the context file, there are filter parameters that apply specifically to the Technical
Characteristics Adapter jobs. These filter parameters determine which Technical Characteristics data will be transferred from the EAM source system into GE Digital APM.
Before You Begin
Before you can manipulate the Technical Characteristics Adapter data, you must import
the Technical Characteristics Adapter job into the APM Connect Administration Center.
Steps
To configure filter parameters for the Equipment Technical Characteristics Adapter:
1. On the machine on which you installed APM Connect, navigate to
<root:\\>\APMConnect\Config.
2. Right-click on the context file file, and then select Edit.
The context file opens.
3. As needed, configure the Common Filters.
4. As needed, configure the following Technical Characteristics Filter parameters for
Equipment in the table:
Equipment Filter
Parameters
Description
Value Requirements
Required/
Default or
Optional
EQUIPMENT_NO
Equipment number
that defines the Equipment that you want to
extract
The Equipment
number should not
Optional
exceed 18 characters.
EQUIPMENT_
CATEGORY
ID of the Equipment
Category that will
limit the Equipment
extracted
The Equipment Category should not
Optional
exceed one character.
Copyright © 2017 General Electric Company. All rights reserved. • Page 327 of 495
Overview of APM Connect
EQUIPMENT_CLASS
ID of the Equipment
Classification that will
limit the Equipment
extracted. If an Equipment has multiple
classifications, as
long as you specify
one of those classifications, the Equipment record will be
The Equipment
extracted.
Class should not
exceed 18 charNote: When Tech- acters.
nical Characteristic
classifications are
updated in
GE Digital APM, they
will override any
changes made to
the EQUIPMENT_
CLASS parameter in
the context file.
Optional
EQUIPMENT_TYPE
The Equipment
ID of the Equipment
Type should not
Type that will limit the
exceed 10 charEquipment extracted
acters.
Optional
TECHNICAL_
CHARACTERISTICS_
ENABLED
Determines whether
technical characteristics and functional characteristics
are gathered during
True or False
static data. Setting the
value to False
removes these
records and improves
performance.
Required
5. Save the changes to the context file.
Results
l
The Equipment Technical Characteristics filter parameters are configured, and the
Equipment Technical Characteristics Adapter Job can be run in the APM Connect
Administration Center. When a Job is run in the APM Connect Administration
Center, the Job will look to the context files for the parameters of the extraction. If
Copyright © 2017 General Electric Company. All rights reserved. • Page 328 of 495
Overview of APM Connect
no filters are entered to limit the records extracted, all Equipment Technical Characteristics records will be extracted.
Steps
To configure filter parameters for the Functional Location Technical Characteristics
Adapter:
1. On the machine on which you installed APM Connect, navigate to
<root:\\>\APMConnect\Config.
2. Right-click on the context file file, and then select Edit.
The context file opens.
3. As necessary, configure the following Common Filters.
4. As needed, configure the following Functional Location Technical Characteristics
filter parameters in the table:
Functional Location Parameters
Description
Value Requirements
Required/
Default or
Optional
FLOC_NO
Functional Location
number that defines
the Functional Location that you want to
extract.
The Functional Location number should
not exceed 40 characters.
Optional
FLOC_
CATEGORY
ID of the Functional
Location Category
that will limit the
Functional Locations
extracted.
The Functional Location Category should
not exceed one character.
Optional
FLOC_CLASS
ID of the Functional
Location Classification that will
limit the Functional
Locations extracted.
The Functional Location Class should not
exceed 18 characters.
Optional
FLOC_TYPE
ID of the Functional
Location Type that
will limit the Functional Locations
extracted.
The Functional Location Type should not
exceed 10 characters.
Optional
5. Save the changes to the context file.
Results
Copyright © 2017 General Electric Company. All rights reserved. • Page 329 of 495
Overview of APM Connect
l
The Functional Location Technical Characteristics filters parameters are configured, and the Technical Characteristics Adapter Job can be run in the APM Connect Administration Center. When a Job is run in the APM Connect Administration
Center, the Job will look to the context files for the parameters of the extraction. If
no filters are entered to limit the records extracted, all Technical Characteristics
records will be extracted.
What's Next?
l
After you have applied the filters in the context file, you can run the associated job
in the APM Connect Administration Center.
Copyright © 2017 General Electric Company. All rights reserved. • Page 330 of 495
Overview of APM Connect
Apply Work Management Filters
There is a filter parameter in the context file that applies specifically to the Work Management Adapter. The filter parameter determines which Work Management data will
be transferred from SAP into GE Digital APM.
Before You Begin
Before you can apply Work Management filters, you must import the Work Management Job into the APM Connect Administration Center.
Steps
1. On the machine on which you installed APM Connect, navigate to
<root:\\>\APMConnect\Config.
2. Right-click the file context file, and then select Edit.
The context file opens.
3. As needed, configure the Common Filters.
4. As needed, configure the Work Management filter parameter in the table:
ŗIMPORTANT: If you change any of the required parameters after loading data,
you must rerun the Work Management job.
Work Management Filter
Parameter
MAINTENANCE_
PLAN
Description
Maintenance Plan ID
number that defines
the Work Management data that
you want to extract.
Value Requirements
The Maintenance
Plan ID is 12 characters.
Required/
Default or
Optional
Optional
Note: The following parameters do not apply to SAP PI. For SAP PI, you
must add entries to the /MIAPM/TASK_CNF table.
INSPECTION_
FAMILY
Determines to which
To use the default
family the Inspection
association, enter the Required
records are assovalue MI_TASKINSP.
ciated.
Copyright © 2017 General Electric Company. All rights reserved. • Page 331 of 495
Overview of APM Connect
INSPECTION_
CONDITION
CALIBRATION_
FAMILY
CALIBRATION_
CONDITION
Determines the SAP
control key used to
identify trigger values for Inspection
records.
Determines to which
family the Calibration records are
associated.
Determines the SAP
control key used to
identify trigger values for Calibration
records.
The parameter
requires specific syntax as follows: <SAP
Table>-<SAP Field>
EQ '<Key Value 1>,
<Key Value 2>,<Key
Value 3>, etc.'
Required
To use the default
configuration, enter
the following value
PLPO-STEUS EQ
'ZMI1'.
To use the default
configuration enter
the value MI_
TASKCALB .
The parameter
requires specific syntax as follows: <SAP
Table>-<SAP Field>
EQ '<Key Value 1>,
<Key Value 2>,<Key
Value 3>, etc.'
Required
Required
To use the default
configuration, enter
the following value
PLPO-STEUS EQ
'ZMI2'.
Note: For Inspection_Condition and Calibration_Condition you can only use the
PLPO, PLAS, and PLKO SAP tables. The valid comparison operators are:
EQ: Equal to.
GE: Greater than or equal to.
LE: Less than or equal to.
LT: Less than.
GT: Greater than.
NE: Not equal to.
Example 1: Configure Work Management to use Non-default Control Keys
Suppose you want to use the SAP field STEUS with the control keys PM01 and PM02 to
Copyright © 2017 General Electric Company. All rights reserved. • Page 332 of 495
Overview of APM Connect
trigger Calibration task records. Additionally, suppose you want to use the control keys
QM01 and QM02. In this case, you should configure the context file as follows:
1. In the INSPECTION_FAMILY parameter, enter MI_TASKINSP.
2. In the INSPECTION_CONDITION parameter, enter PLPO-STEUS EQ 'QM01,QM02'.
3. In the CALIBRATION_FAMILY parameter, enter MI_TASKCALB.
4. In the CALIBRATION_CONDITION parameter enter, PLPO-STEUS EQ 'PM01,PM02'.
The Work Management parameters are configured.
Example 2: Configure Work Management to use Non-default Control Keys
Suppose you want to use the SAP field USROO from the PLPO table, the control key values PM01 or PM02 for Calibration Task, and the control key QM01 or QM02 for Inspection Tasks.
1. In the INSPECTION_FAMILY parameter, enter MI_TASKINSP.
2. In the INSPECTION_CONDITION parameter, enter PLPO-USR00 EQ 'QM01,QM02'.
3. In the CALIBRATION_FAMILY parameter, enter MI_TASKCALB.
4. In the CALIBRATION_CONDITION parameter enter PLPO-USR00 EQ 'PM01,PM02'.
The Work Management parameters are configured.
Note: The conditions follow standard SAP select query filtering rules.
Consider the following example:
<INSPECTION_CONDITION>( PLPO-STEUS EQ 'QM01' ) OR ( PLKO-AENNR EQ '1234
, '4587' OR PLKO-AENNR EQ '5678' ) AND ( PLAS-TECHV EQ 'A1234' AND PLASTECHV EQ 'B1234' ) OR ( PLPO-AEDAT GE '20171218' ) OR ( PLPO-STEUS NE
'QM01' ) </INSPECTION_CONDITION>
Results
Copyright © 2017 General Electric Company. All rights reserved. • Page 333 of 495
Overview of APM Connect
l
The context file is configured, and the Work Management Adapter Job can be run
in the APM Connect Administration Center. When a Job is run in the APM Connect
Administration Center, the Job will look to the context file for the parameters of
the extraction. If no filters are entered to limit the records extracted, all Work Management records will be extracted.
What's Next?
l
After you have applied the filters in the context file, you can run the associated job
in the APM Connect Administration Center.
Copyright © 2017 General Electric Company. All rights reserved. • Page 334 of 495
Overview of APM Connect
About the SAP Adapters
This topic provides a listing of all overviews and high level explanatory information to
help you understand the SAP Adapters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 335 of 495
Overview of APM Connect
About the Equipment and Functional Location
Adapters
The Equipment Adapter lets you extract Equipment items from your SAP system into
your GE Digital APM system. When you do so, for each SAP Equipment item that meets
the criteria defined in the extraction Job, a corresponding Equipment record is created
in the GE Digital APM database.
Likewise, the Functional Location Adapter lets you extract Functional Locations from
your SAP system into your GE Digital APM system. When you do so, for each Functional
Location that meets the criteria defined in the extraction Job, a corresponding Functional Location record is created in the GE Digital APM database.
Because the SAP system allows you to define a hierarchy in which Functional Locations
are related to other Functional Locations, and because Equipment items are also related
to Functional Locations, when you run either the Equipment Adapter or the Functional
Location Adapter, the SAP hierarchy is maintained. In some cases, to maintain the hierarchy, placeholder records are created in the GE Digital APM database to represent the
SAP relationships.
For example, suppose that the SAP system contains the following Functional Locations
and Equipment items, where the Functional Locations are shaded red, and the Equipment items are shaded green.
In this case, if you were to run the Functional Location Adapter, the following Functional
Location records would be created automatically in the GE Digital APM database:
l
FL-101
l
FL-101-A
l
FL-101-A-01
Copyright © 2017 General Electric Company. All rights reserved. • Page 336 of 495
Overview of APM Connect
Then, if you were to run the Equipment Adapter, the following Equipment record would
be created automatically in the GE Digital APM database:
l
Equipment-1
This Equipment record would be linked automatically to the Functional Location record
for FL-101-A-01.
Suppose, however, that using the same SAP data structure example, you decide to run
the Equipment Adapter before running the Functional Location Adapter. In this case,
when running the Equipment Adapter, the Equipment record Equipment-1 would be created automatically to represent that SAP Equipment item. In addition, the following
placeholder Functional Location record would also be automatically created to represent the SAP Functional Location that is directly associated with the Equipment:
l
FL-101-A-01
The Equipment record would be automatically linked to the Functional Location record
FL-101-A-01. This placeholder record would contain a value only in the Functional Location key fields. You would need to run the Functional Location Adapter to populate the
remaining fields in the placeholder Functional Location record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 337 of 495
Overview of APM Connect
About the Work History Adapter
If Orders and Notifications are associated with a Technical Object, you can extract
Orders and Notifications from SAP to create Work History records and Work History
Detail records in GE Digital APM. To do so, you will need to run the Work History
Adapter Job.
When you extract an Order (with or without Notifications), the following Work History
records are created:
l
l
One Work History record to represent the Order Header, which appears on the
HeaderData tab in SAP. This Work History record will be created for the Technical
Objects that appears on the HeaderData tab in SAP. This means that the Work History record will be populated with values representing those Technical Objects,
and it will also be linked to the Equipment or Functional Location records representing those objects. Only this Work History record will contain cost values and
estimated and actual confirmed hours.
One Work History record per object that appears in the Order's object list (i.e., on
the Objects tab when you are viewing the Order). These Work History records will
be created for the Technical Objects that are specifically associated with those
items. This means that these Work History records will be populated with values
representing those Technical Objects, and they will also be linked to the Equipment or Functional Location records representing those Technical Objects.
When you extract a Notification that is not associated with an Order, one Work History
record is created to represent the Notification, and this Work History record will be
linked to Equipment and Functional Location records representing the Notification reference objects. Specifically:
l
l
l
If the Notification has only an Equipment reference object, the Work History
record for that Notification will be linked to an Equipment record.
If the Notification has only a Functional Location reference object, the Work History record for that Notification will be linked to a Functional Location record.
If the Notification has Equipment and Functional Location reference objects, the
Work History record for that Notification will be linked to an Equipment record
and a Functional Location record.
If a Notification has items, one Work History Detail record will be created to represent
each item.
The following tables detail what to expect when running a Work History Job based on
your SAP work order and notification combinations:
Orders Without Notifications
Copyright © 2017 General Electric Company. All rights reserved. • Page 338 of 495
Overview of APM Connect
...Run this
Job:
After you:
...Result:
Create an Order that is not associated with a Notification.
SAP_
A Work History record is creWorkHistory ated.
Update the Order referenced above.
SAP_
The corresponding Work History
WorkHistory record is updated.
Orders With Notifications
Notifications Without Items:
After you:
...Run this
Job:
...Result:
Create an Order that is associated with a Notification
without items.
A Work History record is created to
SAP_
capture the data in the Order and the
WorkHistory
Notification.
Update only the Order.
SAP_
The corresponding Work History
WorkHistory record is updated.
Update only the Notification.
The corresponding Work History and
SAP_
Work History Detail records are
WorkHistory
updated.
Update both the Order and
Notification.
The corresponding Work History and
SAP_
Work History Detail records are
WorkHistory
updated.
Notifications With Items:
After you:
...Run this
Job:
...Result:
Create a Notification with
items, but do not associate
it with an Order.
A Work History record and a Work HisSAP_
tory Detail record are created to capture
WorkHistory
the data in the Notification.
Update the Notification referenced above.
SAP_
The corresponding Work History and
WorkHistory Work History Detail records are updated.
Notifications and Work Orders transferred from SAP into GE Digital APM maintain their
SAP ID in the Work History Detail and Work History record naming convention.
For example, suppose Work Order 18652 and Notification 20087 are related in SAP.
Then, the Work Order and Notification are transferred into GE Digital APM. One Work
History record will be created using the following syntax: WH ~ <Notification Number> ~
Copyright © 2017 General Electric Company. All rights reserved. • Page 339 of 495
Overview of APM Connect
<Work Order Number>. In this example, the Work History record ID would be
WH~20087~18652.
The following diagram exemplifies how records in SAP are mapped to Work History
records in GE Digital APM.
Example: Order With Notification: Items on Object List
Suppose the following SAP Order exists, where the red outlines indicate that:
Copyright © 2017 General Electric Company. All rights reserved. • Page 340 of 495
Overview of APM Connect
l
The Order number is 4000483.
l
The associated Notification number is 10001363.
l
The reference Technical Objects are Functional Location ABC-PQR/12-34-56/8 and
Equipment TURBINE.
Copyright © 2017 General Electric Company. All rights reserved. • Page 341 of 495
Overview of APM Connect
In addition, you can see from the Objects tab that there are items on the object list:
If you were to extract this Order, two Work History records would be created:
l
One for the Order and Notification combination.
l
One for the object list item EQABC123.
Work History Record for the Order and Notification Combination
Suppose there is a Work History record for the Order and Notification combination,
where the associated Technical Object is TURBINE, and the Work History record is also
linked to the Equipment record TURBINE.
Note: The Equipment record TURBINE is created during the Order extraction process as a placeholder record. You would need to run the Equipment Adapter to populate the Equipment fields.
If the Notification contained items, a Work History Detail record would also be created
to capture additional information about that Notification.
Work History Record for the Object List Item EQABC123
Suppose the Work History record for the object list item EQABC123, and that the Work
History record is also linked to the Equipment record EQABC123.
Note: The Equipment record EQABC123 and the associated Functional Location
record ABC-XYZ-DE-VW-123456 are created during the Order extraction process as
placeholder records. You would need to run the Equipment Adapter and the Functional Location Adapter to populate the Equipment record and Functional Location
record fields.
Example: Order Without Notification: No Items on Object List
Suppose the following SAP Order exists, where the red outlines indicate that:
l
The Order number is 4000141.
l
There is no associated Notification.
l
The reference Technical Object is Equipment V100.
Copyright © 2017 General Electric Company. All rights reserved. • Page 342 of 495
Overview of APM Connect
In addition, you can see from the Objects tab that there are no items on the object list:
Copyright © 2017 General Electric Company. All rights reserved. • Page 343 of 495
Overview of APM Connect
If you were to extract this Order, the following Work History record would be created,
with the following:
l
The referenced technical object is V100.
l
The Work History record is linked to the Equipment record V100.
Note: The Equipment record V100 is created during the Order extraction process as
a placeholder record. You would need to run the Equipment Adapter to populate the
Equipment fields.
Example: Notification Without Order: Without Notification Items
Suppose the following SAP Notification exists, where the red outlines indicate that:
l
The Notification number is 10001364.
l
The reference Technical Object is Functional Location A1.
l
There are no items.
Copyright © 2017 General Electric Company. All rights reserved. • Page 344 of 495
Overview of APM Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 345 of 495
Overview of APM Connect
If you were to extract this Notification, the Work History record would be created, with
the following:
l
The Work History record is associated with the Notification's Technical Object A1.
l
The Work History record is linked to the Functional Location record A1.
Note: The Functional Location record A1 is created during the Notification extraction process as a placeholder record. You would need to run the Functional Location
Adapter to populate the Functional Location fields.
Example: Notification Without Order: With Notification Items
Suppose the following SAP Notification exists, where the red outlines indicate that:
l
The Notification number is 10001365.
l
The reference Technical Object is Functional Location F1.
l
There are two items.
Copyright © 2017 General Electric Company. All rights reserved. • Page 346 of 495
Overview of APM Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 347 of 495
Overview of APM Connect
If you were to extract this Notification, the following records would be created:
l
l
One Work History record.
Two Work History Detail records: one to capture additional information about the
first notification item, and another to capture additional information about the
second notification item.
The Work History record, would be created with the following:
l
The Work History record is associated with the Notification's Technical Object F1.
l
The Work History record is linked to the two Work History Detail records.
l
The Work History record is linked to the Functional Location record F1.
Note: The Functional Location record F1 is created during the Notification
extraction process as a placeholder record. You would need to run the Functional Location Adapter to populate the Functional Location fields.
Copyright © 2017 General Electric Company. All rights reserved. • Page 348 of 495
Overview of APM Connect
About the Technical Characteristics Adapter
Note: You can run the Technical Characteristics Adapters successfully only if the SAP
Technical Characteristics license is active.
In SAP, you can assign specific characteristics to Equipment and Functional Locations.
Each characteristic belongs to a Classification, and each Classification belongs to a Class
Type. For example, the Class Type Equipment Class might contain the classification Storage Tanks, which might contain the Characteristics Diameter and Wall Thickness, as illustrated in the following image:
When you extract Equipment and Functional Locations from SAP into the GE Digital
APM system, their corresponding Characteristics will not be extracted into the Equipment and Functional Location records that are created during the extraction process. If
you want to extract their corresponding Characteristics, you will need to run the Technical Characteristics Adapter. When you run these adapters, Technical Characteristic
records are created to store the Characteristics that have been configured to be extracted, and these records are linked automatically to the appropriate Equipment and Functional Location records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 349 of 495
Overview of APM Connect
Note: When Technical Characteristic classifications are updated in GE Digital APM,
they will override any changes made to the classifications parameter in the context
file.
Numeric Value Format
The format in which numbers are displayed in GE Digital APM is determined by the SAP
user that is used to extract the SAP data. For example, if the SAP user is configured to
display the value one thousand one hundred and one-tenth as 1.100,1. The value in
GE Digital APM will be displayed in the same format.
Multiple Objects Allowed
The Technical Characteristic Adapter can transfer Equipment and Functional Locations
configured for multiple objects allowed. This functionality is enabled by EQUIPMENT_
CLASS context parameter in the context file.
Equipment and Functional Locations are configured for multiple objects in SAP, as
shown in the following image.
This indicator tells you whether several different types of object can be classified in
classes of this class type. This allows you to classify objects that are logically related to
each other in the same class.
Copyright © 2017 General Electric Company. All rights reserved. • Page 350 of 495
Overview of APM Connect
GE Digital APM Actions and Results
In GE Digital APM, you can configure which Characteristics you want to extract from SAP.
When you do so, various actions that you perform in the GE Digital APM system and the
SAP system cause specific results, as seen in the following table.
Action
Result
Select
the Extract
From CMMS
The next time the Technical CharSystem
acteristics Adapter is run, the char check box in
acteristic is extracted.
a CMMS Characteristic
record.
Clear
the Extract
From CMMS
System
check box in
a CMMS Characteristic
record.
Notes
During the extraction process, a corresponding Technical Characteristic record is
created.
If a Technical Characteristic record has
been created using this CMMS Characteristic record, it is not deleted autoTo begin extracting the charmatically when you delete the CMMS
acteristic again, you will need
Characteristic record.
to select the Extract From
Instead, the next time that the TechCMMS System check box.
nical Characteristics Adapter is run,
the corresponding Technical Characteristic record is deleted.
Copyright © 2017 General Electric Company. All rights reserved. • Page 351 of 495
Overview of APM Connect
If a Technical Characteristic record has
To begin extracting the charbeen created using this CMMS Characteristic again, you will need
acteristic record, it is not deleted autoto:
matically when you delete the CMMS
Characteristic record.
l Refresh the GE Digital
Delete a
CMMS Characteristic
record.
APM system to reflect
the current SAP characteristics, which will
cause the CMMS Characteristic record to be
recreated.
Instead, the next time that the Technical Characteristics Adapter is run,
the corresponding Technical Characteristic record is deleted.
In addition, until the CMMS Characteristic record is recreated and
flagged for extraction, beginning with
the next time the Technical Characteristics Adapter is run, the characteristic is no longer extracted.
l
Select the Extract From
CMMS System check
box in that CMMS Characteristic record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 352 of 495
Overview of APM Connect
To begin extracting characteristics belonging to this
classification again, you will
need to:
All CMMS Characteristic records that
were linked to the CMMS Classification
record are deleted automatically.
If a Technical Characteristic record has
been created using this CMMS Classification record, it is not deleted automatically when you delete the CMMS
Classification record.
Delete a
CMMS Classification
record.
Instead, the next time that the Technical Characteristics Adapter is run,
the corresponding Technical Characteristic records are deleted automatically.
l
l
l
In addition, until the CMMS Classification record is recreated and
flagged for extraction, beginning with
the next time the Technical Characteristics Adapter is run, characteristics belonging to that
classification are no longer extracted.
l
Refresh the GE Digital
APM system to reflect
the current SAP classifications, which will
cause the CMMS Classification record to be
recreated automatically.
Select the Extract From
CMMS System check
box in the CMMS Classification record.
Refresh the GE Digital
APM system to reflect
the current SAP characteristics, which will
cause the CMMS Characteristic records that
were previously deleted
to be recreated automatically.
Select the Extract From
CMMS System check
box in the appropriate
CMMS Characteristic
records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 353 of 495
Overview of APM Connect
To begin extracting characteristics again, you will
need to:
All CMMS Classification and CMMS
Characteristic records that were linked
(directly or indirectly) to the CMMS
Classification Type record are deleted
automatically.
Delete a
CMMS Classification
Type record.
If a Technical Characteristic record has
been created using this CMMS Classification Type record, it is not deleted
automatically when you delete the
CMMS Classification Type record.
l
l
Instead, the next time that the Technical Characteristics Adapter is run,
the Technical Characteristic record is
deleted automatically.
In addition, until the CMMS Classification Type record is recreated and
its CMMS Classification and CMMS
Characteristic records are flagged for
extraction, beginning with the next
time the Technical Characteristics
Adapter is run, no characteristics are
extracted.
l
l
Recreate the CMMS Classification Type record.
Refresh the GE Digital
APM system to reflect
the current SAP classifications and characteristics, which will
cause CMMS Classification records to be
recreated.
Select the Extract From
CMMS System check
box in the desired
CMMS Classification
records.
Refresh the GE Digital
APM system to reflect
the current SAP classifications and characteristics, which will
cause CMMS Classification records to be
recreated.
Select the Extract From
CMMS System check
box in that CMMS Characteristic record.
SAP Actions and Results
Action
Specify a value for a characteristic that is configured to
be extracted.
Result
The next time the Technical Characteristics Adapter
is run, a Technical Characteristic record is created
and linked to the corresponding Equipment or Functional Location record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 354 of 495
Overview of APM Connect
Remove a value for a characteristic that is configured to
be extracted.
The next time the Technical Characteristics Adapter
is run, the corresponding Technical Characteristic
record is updated by removing the value from the
Value field.
Assign a new classification to
an Equipment or Functional
Location, and specify values
for the characteristics belonging to that class.
The next time the Technical Characteristics Adapter
is run, Technical Characteristic records representing
the new characteristic values are created and linked
to the corresponding Equipment or Functional Location record.
Remove the assignment of a
classification from an Equipment or Functional Location
record.
The next time the Technical Characteristics Adapter
is run or you refresh the GE Digital APM system to
reflect current SAP characteristics, the corresponding
Technical Characteristic record is deleted.
Delete a characteristic from a
classification.
The next time the Technical Characteristics Adapter
is run, the corresponding Technical Characteristic
record is deleted.
Copyright © 2017 General Electric Company. All rights reserved. • Page 355 of 495
Overview of APM Connect
About the Work Management Adapter
Note: You can run the Work Management Adapter only if the SAP Work Management license is active.
The Work Management Adapter facilitates integration with the SAP planning and
scheduling modules for condition assessment activities. The adapter allows you to manage scheduled work in SAP and GE Digital APM.
About Task Records
If an SAP Maintenance Plan has a Task List that has Operations and Object Lists that
meet the criteria defined in the context file, when you run the Work Management
Adapter in the APM Connect Administration Center, one or more Task records will be
created in GE Digital APM. The corresponding Task record will be created based on the
configuration defined in the context file.
If you modify a Maintenance Plan and then run the Work Management Adapter again,
the corresponding Task record will be updated automatically in GE Digital APM. Likewise, if you add an Order to the Maintenance Plan, the corresponding Task record will
also be updated automatically in GE Digital APM.
When you run the Work Management Adapter, it creates Tasks in GE Digital APM using
the following items in SAP:
• Operations
• Object Lists
For example, suppose you have a Maintenance Plan with two Operations and two Object
Lists. When you run the Work Management Adapter, six Tasks will be created and associated with the particular asset in GE Digital APM as show in the following image:
Copyright © 2017 General Electric Company. All rights reserved. • Page 356 of 495
Overview of APM Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 357 of 495
Overview of APM Connect
About Last and Next Date from SAP
When transferring Work Management data from SAP to GE Digital APM, the Desired
Interval field is populated with a null value. The Next Date field will populate with the
next execution date of the Task (GE Digital APM) or Operation (SAP) when it is transferred to GE Digital APM.
Note: Last Date and Next Date values are calculated in SAP, not in GE Digital APM.
The following chart includes the possibilities for the Last Date and Next Date fields upon
transferring data from SAP to GE Digital APM Task records:
Workflow Step
The Plan is created, but not
scheduled, and
the Work Management Job is
run.
Step Narrative
The Tasks of a Plan
are created in
GE Digital APM when
the Work Management Job is run.
Last Date Field
Null
Next Date Field
Null
The Plan is scheduled, but not
called, and the
Work Management Job is
run.
The Plan is scheduled.
The Task created preNull
viously is updated in
GE Digital APM.
If the Plan is On
Hold, the field will
contain the next execution date. Otherwise, the field is
Null.
The Plan is called
for the first time,
and the Work
Management Job
is run.
The Task previously
created will be
updated with information from the Work
Order from SAP.
The next date that
the task is scheduled to run.
The Task is
executed in
GE Digital APM.
An Inspection Event is
linked to the Task.
The Inspection Hours
Date is set to Date
field is set, and the
of Confirmation.
Inspection is closed. A
Confirmation record
is created.
Null
The next date that
the task is scheduled to run.
SAP Maintenance Plans Supported
The Work Management Adapter creates GE Digital APM Inspection or Calibration Tasks
Copyright © 2017 General Electric Company. All rights reserved. • Page 358 of 495
Overview of APM Connect
from SAP Operations on the Task List from the following plan types:
l
Single Cycle: Time-Based
l
Single Cycle: Performance-Based
l
Strategy Plan: Time-Based
l
Strategy Plan: Performance-Based
l
Multiple Counter Plan
About Discontinued Task Records
If a Task record was created from SAP data and you modify the SAP data in a way that
causes that Task record to become obsolete, you can run the Work Management Job to
resolve the differences.
When you run the adapter, the Tasks in APM are validated against the Operations in
SAP. The adapter will search for Task records in GE Digital APM and Operations in
SAP to determine associations based on the following values: Equipment or Functional
Location, Maintenance Plan, Maintenance Plan Item, Task List, and Operation. If a Task
record in GE Digital APM is found in SAP, it is determined to be valid. If the Task record
in GE Digital APM is not found in SAP, it will be discontinued. The adapter updates the
Task record in GE Digital APM as follows:
l
The Task ID for the record will be set to **DISCONTINUED**.
l
The value in the Reason field will be prepended with the following:
<Date> - <User ID> - <Previous Task ID> was discontinued due to changes in SAP.
The previous Task ID was <Previous Task ID>.
Where <Date> is the UTC date and time on which the Task ID was set to
**DISCONTINUED** and <User ID> is the user name of the user updating the
record.
For example, suppose a Calibration Task record was created from an Operation
with the control key ZMI2. If you later change the control key and run the report,
the Calibration Task record will be discontinued.
Note: When a Task ID in a Task record has been set to **DISCONTINUED**, if you
run Work Management Adapter again and the data is still not valid, the Task record
will be skipped. In other words, its Reason field will not contain more than one
instance of the text **DISCONTINUED**.
Note: If you modify the SAP data so that it corresponds to the existing discontinued
Task record, running the adapter will reactivate the discontinued Task record.
Copyright © 2017 General Electric Company. All rights reserved. • Page 359 of 495
Overview of APM Connect
About Call Horizon
When the scheduled item that GE Digital APM delivers for the purpose of creating SAP
Orders is executed, the GE Digital APM system performs a calculation on the Next Date
and Call Horizon values in all Task records. The calculated result is passed into the
query Get Tasks for Work Order Generation. If the result meets the criteria defined for
the query column ([Task].[Next Date] - [Task].[Call Horizon]), the Task record meets the
remaining criteria defined in the query, and the Task does not already contain a value in
the Work Order Number field, an Order will be created from the Task record.
Using the baseline query, an SAP Order will be created if the Task record meets all query
criteria (i.e., the Maintenance Plan field does not contain a value) and the calculated result meets the following criteria:
Task Next Date - Task Call Horizon = A date between the Last Executed Date and the
Next Execution Date of the scheduled item.
Example
Suppose the scheduled item contains the following values:
Last Executed Date
July 1, 2008 1:00:00 A.M.
Next Execution Date
July 2, 2008 1:00:00 A.M.
Based on these values, an SAP Maintenance Order will be created automatically if the
Next Date of the Task record minus its Call Horizon is between July 1, 12:00:00 A.M. and
July 2, 12:00:00 A.M.
Suppose a Task record contains the following values:
Next Date
July 11, 2008 3:00:00 A.M.
Call Horizon
10
Using these Task record values, if you subtract the Call Horizon, 10 days, from the Next
Date, July 11, 2008 3:00:00 A.M., the result is July 1, 2008 3:00:00 A.M.
Because July 1, 2008 3:00:00 A.M. falls between the Last Executed Date of July 1, 2008
1:00:00 A.M. and July 2, 2008 1:00:00 A.M., the Task record will be used to generate an
Order (assuming that the Task record meets the remaining query criteria).
In other words:
Copyright © 2017 General Electric Company. All rights reserved. • Page 360 of 495
Overview of APM Connect
July 11, 2008 3:00:00 A.M. (Task Next Date) - 10 (Call Horizon) = July 1, 2008 3:00:00 A.M.
(A date between the Last Executed Date and the Next Execution Date of the scheduled
item)
Note: If the scheduled item is being executed for the first time, GE Digital APM
assumes a Last Executed Date of 1/1/1900. Also, if the Call Horizon field does not contain a value, the value is treated as zero (0).
Copyright © 2017 General Electric Company. All rights reserved. • Page 361 of 495
Overview of APM Connect
About Filter Parameters
Filter parameters determine what data will be transferred from the EAM source systems
to GE Digital APM, and are applied to the extraction job in the context file. There are two
types of filter parameters: configuration parameters and adapter filter parameters. Each
adapter has specific filters that apply only to that adapter. Additionally, there are some
filter parameters that are common to all of the SAP adapters. When an adapter job
executes, it will apply all common filters and those unique to the specific adapter job.
This topic provides an overview of the adapter filter parameters for the following
adapters:
l
Equipment
l
Functional Location
l
Work History
l
Technical Characteristics
l
Work Management
Scope of the Filter Parameters
By entering a value into the parameter, you limit the scope of the extraction to the values in the parameter. If no value is entered into a parameter, all data for that parameter
will be transferred from the EAM system source into GE Digital APM.
Additionally, changes made in the context file will change the scope of all jobs connected to that context file. For example, if you changed the FLOC_CLASS value in the context file, all Functional Location jobs in the APM Connect Administration Center,
associated with that context file, will change accordingly. However, you can use more
than one context file for multiple SAP systems.
How Times and Dates are Used
There are certain conditions that apply to some of the common filter parameters, as
shown in the following table:
Condition
Expect Result
Notes
If the start date parameter is empty
The start date
defaults to 1/1/1900.
None
If the end date parameter is empty
The end date
defaults to the current date.
None
Copyright © 2017 General Electric Company. All rights reserved. • Page 362 of 495
Overview of APM Connect
If the start time parameter is empty
The start time
defaults to 00:00:00.
This only applies to the Work History
Adapter, and only if the start and end
dates are the same.
If the end time parameter is empty
The end time
defaults to the current time. This only applies to the Work History
Adapter.
If a date range is not
entered
The Job defaults to
the date of the last
successful run.
None
If it is the very first
execution and no
dates are specified
Records for all dates
will be extracted.
None
Using Multiple Values
ŗIMPORTANT: If you are using multiple values, you should not exceed 500 values.
Multiple values can be entered into the parameters using comma separated values. For
example, if you wanted to extract data from Equipment Classes M, S, and A, the equipment class parameter would look like the following: <EQUIPMENT_CLASS> M,S,A
</EQUIPMENT_CLASS>. Comma separated values can be used with the following parameters:
l
Plants
l
Equipment numbers
l
Equipment categories
l
Equipment classes
l
Equipment Types
l
Functional Location Numbers
l
Functional Location Categories
l
Function Location Classes
l
Function Location Types
l
Order System Status
l
Order user statuses
l
Notification system statuses
l
Notification user statuses
Copyright © 2017 General Electric Company. All rights reserved. • Page 363 of 495
Overview of APM Connect
l
Notification Numbers
l
Notification type
l
Work Order type
l
Work Order numbers
l
Maintenance Plans
Copyright © 2017 General Electric Company. All rights reserved. • Page 364 of 495
Overview of APM Connect
Reference Information: SAP Adapters
This topic provides a listing of all detailed reference information provided for the SAP
Adapters, such as command syntax, specifications, and table/field descriptions.
Copyright © 2017 General Electric Company. All rights reserved. • Page 365 of 495
Overview of APM Connect
SAP Adapter Data Model
The following diagram shows how families used by the APM Connect SAP Adapters are
related to one another:
Note: In the diagram, boxes represent entity families and arrows represent relationship families that are configured in the baseline database. You can determine the
direction of the each relationship definition from the direction of the arrowhead: the
box from which the arrow originates is the predecessor, and the box to which the
arrow head points is the successor.
Copyright © 2017 General Electric Company. All rights reserved. • Page 366 of 495
Overview of APM Connect
Like all GE Digital APM modules, the GE Digital APM SAP Adapters feature consists of
entity families, relationship families, and business rules. When attempting to understand and make use of the SAP Adapters functionality, it can be helpful to visualize the
SAP Adapters data model.
Because you should already be familiar with the concept of records and viewing records
in the GE Digital APM Record Manager, as you attempt to get your bearings in the SAP
Adapters feature, it may be useful to remember that the SAP Adapters feature simply
lets you create, view, and manage records.
Each adapter is responsible for creating or updating one or more records that are displayed in the image. For example, when you run the Equipment Extraction Interface,
Equipment records are created or updated.
Note: Although, the data model image does not show the relationship, Equipment
and Functional Location records are also linked to Site Reference records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 367 of 495
Overview of APM Connect
Family Field Descriptions
This topic provides a list of all detailed reference information provided for Family Field
Descriptions, such as command syntax, specifications, and table/field descriptions.
Copyright © 2017 General Electric Company. All rights reserved. • Page 368 of 495
Overview of APM Connect
CMMS Characteristic
CMMS Characteristic records are used by the SAP Adapters to facilitate data extracts and
loads to and from SAP.
This topic provides an alphabetical list and description of the fields that exist for the
CMMS Characteristic. The information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be
assigned to a specific site, and will then only be accessible to users who are assigned to
the same site and have the appropriate license and family privileges. See the Site Filtering section of the documentation for more information on using this feature.
Field
Data
Type
Description
The description of the
Characteristic
characteristic
Character
Description
(as it is
defined in the
SAP system).
The ID of the
characteristic
Characteristic
Character (as it is
Name
defined in the
SAP system).
Class Group
The SAP class
group to
Character which this
characteristic
belongs.
Classification
The classification to
Character which this
characteristic
belongs.
Behavior and Usage
This field is disabled.
On the datasheet, the value in this field is
formatted as a hyperlink, which you can
select to open the CMMS Characteristic by
itself, outside of the context of its master
CMMS Classification record.
This field is disabled.
The value in this field is set automatically,
and this field is disabled.
On the datasheet, the value in this field is
formatted as a hyperlink, which you can
select to open the CMMS Classification
record representing the classification to
which this characteristic belongs.
This field is disabled.
Copyright © 2017 General Electric Company. All rights reserved. • Page 369 of 495
Overview of APM Connect
CMMS System ID
Extract From
CMMS System
The ID of the
SAP System
from which
Character
this characteristic will
be extracted.
Boolean
This field is populated automatically
and used internally by the GE Digital APM
system. This field is not available on the
baseline datasheets.
A value that
identifies
On the datasheet, you can select this
whether or not
check box if you want to extract this charthis characteristic.
acteristic will
be extracted.
Copyright © 2017 General Electric Company. All rights reserved. • Page 370 of 495
Overview of APM Connect
CMMS Classification
CMMS Classification records are available on the baseline Classification Type Classifications master-detail datasheet, the table explains how these fields behave when you
are viewing CMMS Classification records in the context of this master-detail record.
This topic provides an alphabetical list and description of the fields that exist for the
CMMS Classification family. The information in the table reflects the baseline state and
behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be
assigned to a specific site, and will then only be accessible to users who are assigned to
the same site and have the appropriate license and family privileges. See the Site Filtering section of the documentation for more information on using this feature.
Field
Class Group
Data
Type
Description
The SAP class group
Character to which this classification belongs.
The ID of the classification (as it is
Classification Character
defined in the SAP
system).
Behavior and Usage
The value in this field is set automatically, and this field is disabled.
On the datasheet, the value in this
field is formatted as a hyperlink,
which you can select to see all of the
characteristics that belong to this
classification.
This field is disabled.
The description of
Classification
the classification (as
Character
Description
it is defined in the
SAP system).
CMMS System ID
The value in the System ID field in the
EAM System record
whose Name field
Character
contains the value
that is stored in the
CMMS System field
in this record.
This field is disabled.
This field is populated automatically
and used internally by the GE Digital
APM system. This field is not available on the baseline datasheets.
Copyright © 2017 General Electric Company. All rights reserved. • Page 371 of 495
Overview of APM Connect
Extract From
CMMS System
Boolean
A value that identifies whether or not
characteristics for
this classification
will be extracted
from the SAP system.
This value is used
Internal Clasinternally by the
sification
Character
GE Digital APM sysNumber
tem.
On the datasheet, you can select this
check box if you want to extract characteristics belonging to this classification.
The value in this field is set automatically, and this field is disabled.
Copyright © 2017 General Electric Company. All rights reserved. • Page 372 of 495
Overview of APM Connect
CMMS Classification Type Records
CMMS Classification Type records are used by the SAP Adapters to facilitate data
extracts and loads to and from SAP.
This topic provides an alphabetical list and description of the fields that exist for the
CMMS Classification Type family. The information in the table reflects the baseline state
and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be
assigned to a specific site, and will then only be accessible to users who are assigned to
the same site and have the appropriate license and family privileges. See the Site Filtering section of the documentation for more information on using this feature.
Field
Classification
Type
Classification
Type Code
CMMS System
Data
Type
Description
Behavior and Usage
Character
The item whose
characteristics will
be extracted.
You can select either Equipment or
Functional Location. This field is
required.
Character
A code assigned to
the item whose
characteristics will
be extracted.
This field is populated based on the
selection of the Classification Type
field. This value is used internally by
the GE Digital APM system.
Numeric
The SAP system
from which characteristics will be
extracted.
The field is read-only and populated
with the value in the Name field in
the EAM System record whose
Default EAM System field contains
the value True.
The value in the
System ID field in
the EAM System
record whose
Name field contains the value that
you selected in
CMMS System list
in this CMMS Classification Type
record.
This field is populated automatically
and used internally by the GE Digital
APM system. This field does not
appear on the baseline datasheets.
CMMS System
Character
ID
Copyright © 2017 General Electric Company. All rights reserved. • Page 373 of 495
Overview of APM Connect
EAM System
EAM System records are used to store information about your SAP Systems to facilitate
data extracts and loads to and from SAP.
When you transfer data from GE Digital APM to your EAM during any of the following
workflows, the GE Digital APM system uses EAM System records to determine which
EAM system to use:
l
l
l
Creating or updating SAP Notifications from GE Digital APM Recommendation
records.
Creating or updating SAP Confirmations from GE Digital APM Confirmation
records.
Creating SAP Orders from GE Digital APM Task records.
In addition, EAM System records are used by the Equipment Characteristics Extraction
Adapter and the Functional Location Characteristics Extraction Adapter in both of the following workflows:
l
l
When you create CMMS Classification Type records, EAM System records are used
to determine which EAM system information to use to populate the CMMS System
ID field.
When you refresh the GE Digital APM system to reflect the current SAP classifications and characteristics, EAM System records are used to determine the EAM
system in which to look for the current classifications and characteristics.
This topic provides an alphabetical list and description of the fields that exist for the
EAM System family and appear on the baseline EAM System datasheet. The information
in the table reflects the baseline state and behavior of these fields.
This family is not enabled for site filtering, which means that records in this family can
be accessed by any user with the appropriate license and family privileges. See the Site
Filtering section of the documentation for more information.
Field
Data
Type
Description
Behavior and Usage
Copyright © 2017 General Electric Company. All rights reserved. • Page 374 of 495
Overview of APM Connect
In new EAM System records, you will
need to delete all angle brackets and:
l
The connection
Connection
Character information for the
String
SAP system.
l
l
Replace the text SAP_SERVER_
IP with the IP address of the SAP
Server.
Replace the text SAP_SYSTEM_
NUMBER with the SAP System
number.
Replace the text SAP_CLIENT_
NUMBER with the SAP Client
number.
This field is available on the SAP System for RCMO datasheet, and is not
enabled by default.
The type of conConnection
nection that will be
Character
Type
used to connect to
the EAM system.
The default and recommended value
is RFC. This connection type uses a
REST web service call as an intermediary between SAP and GE Digital
APM, thereby avoiding RFC calls directly between GE Digital APM and your
SAP server.
Note: If necessary, you can change
the connection type to RFC Direct.
Changing this value will bypass APM
Connect and use a direct
RFC connection when connecting
your GE Digital APMsystem and your
SAP system.
To change this value, you must first
enable editing on the datasheet.
Default
EAM System?
Boolean
A value that indicates whether this
EAM system should
be used by default
when transferring
data between your
GE Digital APM system and your SAP
system.
On the datasheet, you can select the
check box to identify this SAP system
as the Default EAM System.
Copyright © 2017 General Electric Company. All rights reserved. • Page 375 of 495
Overview of APM Connect
The password to
the SAP system.
Password
Character
ITS URL
The URL to the ITS
Character
Server.
Name
Character
The name of the
SAP system.
The password that you type will be
encrypted and displayed as asterisks
on the datasheet.
In new EAM System records, you will
need to delete the angle brackets and
replace the text its_or_integrated_its_
server_url with the appropriate URL.
You can type any name, but we recommend that you use the format <SYSID><CLIENT>, where <SYSID> is the System
ID of the SAP system and <CLIENT> is
the Client number. By doing so, the
value in the Name field will match the
value that will be populated automatically in the System ID field.
This field is populated automatically
after you test the connection to the
SAP system using the Test
Connection link on the Associated
Pages menu.
The ID of the SAP
system.
System ID
Character
User ID
The User ID of a
user that can log
Character
into the SAP system.
Specifically, the System ID field is populated automatically with the name of
the SAP system, using the
format <SYSID>-<CLIENT>, where
<SYSID> is the System ID of the SAP system and <CLIENT> is the Client number.
None.
Copyright © 2017 General Electric Company. All rights reserved. • Page 376 of 495
Overview of APM Connect
Technical Characteristic
Technical Characteristics records are used to store information about your SAP Technical Characteristics to facilitate data extracts and loads to and from SAP.
This topic provides an alphabetical list and description of the fields that exist for the
Technical Characteristic family and appear on the baseline EAM System datasheet. The
information in the table reflects the baseline state and behavior of these fields.
This family is enabled for site filtering, which means that records in this family can be
assigned to a specific site, and will then only be accessible to users who are assigned to
the same site and have the appropriate license and family privileges. See the Site Filtering section of the documentation for more information on using this feature.
Field
Data Type
Description
Behavior and Usage
Name Character
The name of the
characteristic.
None
Value
The value assigned
to the characteristic.
If multiple values are assigned to a
characteristic in SAP, all of those values will be displayed in the Value field,
separated by commas.
Character
Copyright © 2017 General Electric Company. All rights reserved. • Page 377 of 495
Overview of APM Connect
SAP Transactions-Quick Reference
The following table provides a list of SAP transactions and their functions:
This transaction:
...Lets you:
/n/MIAPM/MIPRO
View a list of GE Digital APM-specific steps that can be performed in SAP.
/n/MIAPM/MANAGE_
PARAMS
Access and manage the /MIAPM/PARAMS table.
/n/MIAPM/MANAGE_
TSKCNF
Access the /MIAPM/TASK_CNF table.
SM37
Check the status of a background process.
IW43
Validate SAP Confirmations against that data in GE Digital APM
Confirmation records.
Copyright © 2017 General Electric Company. All rights reserved. • Page 378 of 495
Overview of APM Connect
SAP Adapter Mappings
This topic provides a listing of all SAP Adapter Mapping topics.
Copyright © 2017 General Electric Company. All rights reserved. • Page 379 of 495
Overview of APM Connect
SAP Equipment Mappings
The following table explains the SAP fields that are used to populate the baseline Equipment fields when you extract SAP Equipments to create Equipment records in GE Digital
APM:
GE Digital
APM Family ID
GE Digital
APM
Field ID
GE Digital
APM Field
Caption
SAP
Table
SAP Field
ID
SAP Field Caption
MI_
EQUIP000
MI_
EQUIP000_
Catalog Profile
CAT_
PROF_C
EQUZ
RBNR
Catalog Profile
MI_
EQUIP000
MI_
EQUIP000_
Catalog Profile
CAT_
Description
PROF_
DESC_C
T352B_T
RBNRX
Catalog Profile
Description
MI_
EQUIP000
MI_
EQUIP000_
Category
SAP_
CATEG_C
EQUI
EQTYP
SAP Category
MI_
EQUIP000
MI_
EQUIP000_
Category
SAP_
Description
CATEG_
DESC_C
T370U
TYPTX
SAP Category
Description
Copyright © 2017 General Electric Company. All rights reserved. • Page 380 of 495
Overview of APM Connect
MI_
EQUIP000
Note:
The time
zone
used for
the value
in the
CMMS
Creation
Date field
is the
same as
the SAP
server
time
zone.
MI_
EQUIP000_ CMMS Creation
EQUI
CREATE_
Date
DATE_D
ERDAT
SAP Creation
Date
MI_
EQUIP000_ CMMS Last
CHANGE_ Changed Date
DATE_D
EQUI
AEDAT
SAP Last
Changed Date
<SY-SID>
+ <SYMANDT>
Name of SAP
R/3 System R/3 System,
client number from
logon
MI_
EQUIP000
Note:
The time
zone
used for
the value
in the
CMMS
Last
Changed
Date field
is the
same as
the SAP
server
time
zone.
MI_
EQUIP000
MI_
EQUIP000_
CMMS System
SAP_
SYSTEM_C
Copyright © 2017 General Electric Company. All rights reserved. • Page 381 of 495
Overview of APM Connect
MI_
EQUIP000
MI_
EQUIP000_ Construction
CONSTN_
Type
TYP_C
MI_
EQUIP000
MI_
EQUIP000_ Construction
CONSTN_
Type DescripTYP_DESC_ tion
C
SUBMT
Construction
Type
MAKT
MAKTX
Construction
Type Description
MI_
EQUIP000
MI_
EQUIP000_ Criticality IndicCRITI_IND_ ator
C
ILOA
ABCKZ
Criticality Indicator
MI_
EQUIP000
MI_
Criticality IndicEQUIP000_
ator DescripCRITI_IND_
tion
DESC_C
T370C_T
ABCTX
Criticality Indicator Description
MI_
EQUIP000
MI_
EQUIP000_
EAM Reference
EAM_REF_
Creation Date
CREATE_
DT_C
EQUI
ERDAT
SAP Creation
Date
MI_
EQUIP000
MI_
EQUIP000_ EAM Reference
EAM_REF_ Last Changed
CHANGE_ Date
DT_C
EQUI
AEDAT
SAP Last
Changed Date
MI_
EQUIP000
MI_
EQUIP000_
EAM Reference
EAM_REF_
Purchase Date
PRCH_DT_
C
EQUI
ANSDT
Purchase Date
MI_
EQUIP000
MI_
EQUIP000_ EAM Reference
EAM_REF_ Valid From
VLD_FRM_ Date
DT_C
EQUZ
DATAB
Valid From
Date
EQUZ
Copyright © 2017 General Electric Company. All rights reserved. • Page 382 of 495
Overview of APM Connect
MI_
EQUIP000
MI_
EQUIP000_
EAM Reference
EAM_REF_
Warranty Expir- BGMKOBJ GWLEN
WRNTY_
ation Date
EXPR_DT_
C
Warranty Expiration Date
MI_
EQUIP000
MI_
EQUIP000_
Equipment ID
EQUIP_ID_
C
EQUI
EQUNR
Equipment ID
MI_
EQUIP000
MI_
EQUIP000_ Equipment
EQUIP_
Long DescripLNG_
tion
DESC_T
EQUI
Retrieved
using FM
READ_TEXT
with
ID=LTXT,
OBJECTT=EQUI
Equipment
Long Description
MI_
EQUIP000
MI_
Equipment
EQUIP000_
Serial Number
SN_C
EQUI
SERGE
Serial Number
MI_
EQUIP000
MI_
EQUIP000_ Equipment
EQUIP_
Short DescripSHRT_
tion
DESC_C
EQKT
EQKTX
Equipment
Short Description
MI_
EQUIP000
MI_
EQUIP000_ Equipment
EQUIP_
Technical Num- EQUZ
TECH_
ber
NBR_C
TIDNR
Equipment
Technical Number
MI_
EQUIP000
MI_
EQUIP000_ Equipment
EQUIP_
Vendor
VNDR_C
EQUI
ELIEF
Equipment
Vendor
MI_
EQUIP000
MI_
EQUIP000_ Functional
FNC_LOC_ Location
C
ILOA
TPLNR
Functional
Location
Copyright © 2017 General Electric Company. All rights reserved. • Page 383 of 495
Overview of APM Connect
MI_
EQUIP000
MI_
Functional
EQUIP000_
Location
FNC_LOC_
Description
DESC_C
MI_
EQUIP000
PLTXT
Functional
Location
Description
MI_
Inventory NumEQUIP000_
EQUI
ber
INV_NO_C
INVNR
Inventory Number
MI_
EQUIP000
MI_
EQUIP000_
Main Work
MAIN_
Center
WRK_CNR_
C
ARBPL
Main Work
Center
MI_
EQUIP000
MI_
EQUIP000_ Main Work
MAIN_
Center Descrip- CRTX
WRK_CN_ tion
DESC_C
KTEXT
Main Work
Center Description
MI_
EQUIP000
MI_
EQUIP000_ Maintenance
MAINT_
Plant
PLANT_C
ILOA
SWERK
Maintenance
Plant
MI_
EQUIP000
MI_
EQUIP000_ Maintenance
MAINT_
Plant DescripPLANT_
tion
DESC_C
T001W
NAME1
Maintenance
Plant Description
MI_
EQUIP000
MI_
EQUIP000_ Manufacturer
MFR_C
EQUI
HERST
Manufacturer
MI_
EQUIP000
MI_
EQUIP000_
Model Number
MOD_NO_
C
EQUI
TYPBZ
Model Number
MI_
EQUIP000
MI_
EQUIP000_ Object Type
OBJ_TYP_C
EQUI
EQART
Object Type
MI_
EQUIP000
MI_
EQUIP000_ Object Type
OBJ_TYP_
Description
DESC_C
T370K_T
EARTX
Object Type
Description
IFLOTX
CRHD
Copyright © 2017 General Electric Company. All rights reserved. • Page 384 of 495
Overview of APM Connect
MI_
EQUIP000
MI_
EQUIP000_ Part Number
PRT_NO_C
EQUZ
MAPAR
Part Number
MI_
EQUIP000
MI_
EQUIP000_
PLANT_
SECT_
DESC_C
T357
FING
Plant Section
Description
MI_
EQUIP000
MI_
EQUIP000_
Planner Group
PLANG_
GRP_C
EQUZ
INGRP
Planner Group
MI_
EQUIP000
MI_
EQUIP000_
Planner Group
PLANG_
Description
GRP_
DESC_C
T024I
INNAM
Planner Group
Description
MI_
EQUIP000
MI_
EQUIP000_
Planning Plant
PLNNG_
PLNT_C
EQUZ
IWERK
Planning Plant
MI_
EQUIP000
MI_
EQUIP000_
Planning Plant
PLNNG_
Description
PLNT_
DESC_C
T001W
NAME1
Planning Plant
Description
MI_
EQUIP000
MI_
EQUIP000_
Plant Section
PLANT_
SECTION_C
ILOA
BEBER
Plant Section
Person
Responsible
for Plant Section
Copyright © 2017 General Electric Company. All rights reserved. • Page 385 of 495
Overview of APM Connect
MI_
EQUIP000
Note:
The time
zone
used for
the value
in the
Purchase
Date field
is the
same as
the time
zone of
the user
who created the
Equipment.
MI_
EQUIP000_ Purchase Date
PRCH_D
EQUI
ANSDT
Purchase Date
MI_
EQUIP000
MI_
Purchase
EQUIP000_
Order Number
PO_NO_C
EQBS
KDAUF
Purchase
Order Number
MI_
EQUIP000
MI_
EQUIP000_
SAP Class
SAP_
CLASS_C
KLAH
CLASS
SAP Class
MI_
EQUIP000
MI_
EQUIP000_
SAP Class
SAP_
Description
CLASS_
DESC_C
SWOR
KSCHL
SAP Class
Description
MI_
EQUIP000
MI_
Size/DiEQUIP000_
mension
SZ_C
EQUI
GROES
Size/Dimension
MI_
EQUIP000
MI_
EQUIP000_
Sort Field
SORT_
FIELD_C
ILOA
EQFNR
Sort Field
MI_
EQUIP000
MI_
EQUIP000_ System Status
SYS_ST_C
TJ02T
TXT04
System Status
Copyright © 2017 General Electric Company. All rights reserved. • Page 386 of 495
Overview of APM Connect
MI_
EQUIP000
MI_
EQUIP000_
Technical DrawTECH_
EQUI
ing Number
DRW_NO_
C
HZEIN
Technical Drawing Number
MI_
EQUIP000_ Valid From
VLD_FRM_ Date
DAT_D
DATAB
Valid From
Date
MI_
EQUIP000
Note:
The time
zone
used for
the value
in the
Valid
From
Date field
is the
same as
the time
zone of
the user
who created the
Equipment
EQUZ
Copyright © 2017 General Electric Company. All rights reserved. • Page 387 of 495
Overview of APM Connect
MI_
EQUIP000
Note:
The time
zone
used for
the value
in the
Warranty
Expiration
Date field
is the
same as
the time
zone of
the user
who created the
Equipment.
MI_
EQUIP000_ Warranty ExpirBGMKOBJ GWLEN
WRNTY_
ation Date
EXPR_D
Date on which
the warranty
ends
MI_
EQUIP000
MI_
EQUIP000_
WBS Element
WBS_
ELMNT_C
ILOA
POST1
WBS Element
MI_
EQUIP000
MI_
EQUIP000_
Year ConYR_
structed
CONSTRD_
N
EQUI
BAUJJ
Year Constructed
Copyright © 2017 General Electric Company. All rights reserved. • Page 388 of 495
Overview of APM Connect
SAP Functional Location Mappings
The following table explains the SAP fields that are used to populate the baseline Functional Location fields when you extract SAP Functional Locations to create Functional
Location records in GE Digital APM:
GE Digital
APM Family ID
GE Digital
APM Field ID
MI_
FNCLOC00
MI_FNCLOC00_
BUS_AREA_C
MI_
FNCLOC00
GE Digital
APM Field
Caption
Business
Area
SAP
Table
SAP Field
Caption
GSBER
Business Area
Business
MI_FNCLOC00_
Area Descrip- TGSBT
BUS_AREA_D_C
tion
GTEXT
Business Area
Description
MI_
FNCLOC00
MI_FNCLOC00_
CAT_PROF_C
RBNR
Catalog Profile
MI_
FNCLOC00
Catalog ProMI_FNCLOC00_
file DescripCAT_PROF_D_C
tion
T352B_
RBNRX
T
Catalog Profile Description
MI_
FNCLOC00
MI_FNCLOC00_
CATEG_C
Category
IFLOT
FLTYP
Category
MI_
FNCLOC00
MI_FNCLOC00_
CATEG_D_C
Category
Description
T370F_
T
TYPTX
Category
Description
MI_FNCLOC00_
CREATE_DATE_
D
CMMS
Creation
Date
IFLOT
ERDAT
SAP Creation
Date
Catalog Profile
ILOA
SAP Field
IFLOT
MI_
FNCLOC00
Note:
The time
zone used
for the
value in
the CMMS
Creation
Date field
is the
same as
the SAP
server
time zone.
Copyright © 2017 General Electric Company. All rights reserved. • Page 389 of 495
Overview of APM Connect
MI_
FNCLOC00
Note:
The time
zone used
for the
value in
the CMMS
Last
Changed
Date field
is the
same as
the SAP
server
time zone.
MI_FNCLOC00_
CHANGE_
DATE_D
CMMS Last
Changed
Date
IFLOT
AEDAT
SAP Last
Changed Date
MI_
FNCLOC00
MI_FNCLOC00_
CO_AREA_C
CO Area
ILOA
KOKRS
Controlling
Area
MI_
FNCLOC00
MI_FNCLOC00_
CO_AREA_D_C
CO Area
Description
TKA01
BEZEI
Controlling
Area Description
MI_
FNCLOC00
MI_FNCLOC00_
CO_CD_C
Company
Code
ILOA
BUKRS
Company
Code
MI_
FNCLOC00
MI_FNCLOC00_
CO_CD_D_C
Company
Code
Description
T001
BUTXT
Company
Code Description
MI_
FNCLOC00
MI_FNCLOC00_
CONST_TYP_C
Construction
IFLOT
Type
SUBMT
Constr Type
Material of
Object
MI_
FNCLOC00
MI_FNCLOC00_
CONST_TYP_
DESC_C
Construction
Type Descrip- MAKT
tion
MAKTX
Constr Type
Material of
Object Desc
MI_
FNCLOC00
MI_FNCLOC00_
CST_CNR_C
Cost Center
ILOA
KOSTL
Cost Center
MI_
FNCLOC00
MI_FNCLOC00_
CST_CNR_D_C
Cost Center
Description
CSKT
KTEXT
Cost Center
Description
MI_
FNCLOC00
MI_FNCLOC00_
CRTCAL_IND_C
Criticality
Indicator
ILOA
ABCKZ
ABC Indicator
Copyright © 2017 General Electric Company. All rights reserved. • Page 390 of 495
Overview of APM Connect
MI_
FNCLOC00
MI_FNCLOC00_
CRTCAL_IND_
D_C
Criticality
Indicator
Description
T370C_
ABCTX
T
ABC Indicator
Description
MI_
FNCLOC00
MI_FNCLOC00_
EAM_REF_
CREATE_DT_C
EAM Reference
Creation
Date
IFLOT
ERDAT
SAP Creation
Date
MI_
FNCLOC00
MI_FNCLOC00_
EAM_REF_
CREATE_DT_C
EAM Reference Last
Changed
Date
IFLOT
AEDAT
SAP Last
Changed Date
Computed
from TPLNR
using FM
FunctLocation
CONVERSION_
EXIT_TPLNR_
OUTPUT
MI_
FNCLOC00
MI_FNCLOC00_
FNC_LOC_C
Functional
Location
IFLOT
MI_
FNCLOC00
MI_FNCLOC00_
FNC_LOC_
DESC_C
Functional
Location
Description
IFLOTX PLTXT
Description
MI_
FNCLOC00
Functional
MI_FNCLOC00_
Location
INTERNAL_ID_C
Internal ID
IFLOT
TPLNR
FunctLocation
MI_
FNCLOC00
MI_FNCLOC00_
FNC_LOC_
LNG_DESC_C
Functional
Location
Long
Description
IFLOT
Retrieved
using FM
READ_TEXT
Long Text
with ID=LTXT,
OBJECT=IFLOT
MI_
FNCLOC00
MI_FNCLOC00_
INSTLD_
ALWBL_C
Installation
Allowed
IFLOT
IEQUI
Installation
Allowed
MI_
FNCLOC00
MI_FNCLOC00_
LOCAT_C
Location
ILOA
STORT
Location
MI_
FNCLOC00
MI_FNCLOC00_ Location
LOCAT_DESC_C Description
T499S
KTEXT
Location
Description
MI_
FNCLOC00
MI_FNCLOC00_ Maintenance
ILOA
MAINT_PLNT_C Plant
SWERK
Maintenance
Plant
Copyright © 2017 General Electric Company. All rights reserved. • Page 391 of 495
Overview of APM Connect
MI_
FNCLOC00
MI_FNCLOC00_
MAINT_PLNT_
D_C
Maintenance
Plant
T001W
Description
NAME1
Maintenance
Plant Description
MI_
FNCLOC00
MI_FNCLOC00_
OBJ_TYP_C
Object Type
IFLO
EQART
Object Type
MI_
FNCLOC00
MI_FNCLOC00_
OBJ_TYP_
DESC_C
Object Type
Description
T370K_
EARTX
T
Object Type
Description
MI_
FNCLOC00
MI_FNCLOC00_
PLANNER_
GROUP_C
Planner
Group
IFLOT
INGRP
Planner
Group
MI_
FNCLOC00
MI_FNCLOC00_
PLANNER_
GRP_DESC_C
Planner
Group
Description
T024I
INNAM
Planner
Group
Description
MI_
FNCLOC00
MI_FNCLOC00_
PLNNG_PLNT_
C
Planning
Plant
IFLOT
IWERK
Planning
Plant
MI_
FNCLOC00
MI_FNCLOC00_
PLNNG_PLNT_
D_C
Planning
Plant
Description
T001W
NAME1
Planning
Plant Description
MI_
FNCLOC00
MI_FNCLOC00_
PLNT_SECT_C
Plant Section
ILOA
BEBER
Plant Section
MI_
FNCLOC00
MI_FNCLOC00_
PLNT_SECT_D_
C
Plant Section Descrip- T357
tion
FING
Plant Section
Description
MI_
FNCLOC00
MI_FNCLOC00_
ROOM_C
Room
ILOA
MSGRP
Room
MI_
FNCLOC00
MI_FNCLOC00_
SAP_CLASS_C
SAP Class
KLAH
CLASS
Class
MI_
FNCLOC00
MI_FNCLOC00_
SAP_CLASS_
DESC_C
SAP Class
Description
SWOR
KSCHL
Class Description
MI_
FNCLOC00
MI_FNCLOC00_
SORT_FLD_C
Sort Field
ILOA
EQFNR
Sort Field
MI_
FNCLOC00
MI_FNCLOC00_
STRUC_INDIC_
C
Structure
Indicator
IFLOT
TPLKZ
StrIndicator
Copyright © 2017 General Electric Company. All rights reserved. • Page 392 of 495
Overview of APM Connect
MI_
FNCLOC00
MI_FNCLOC00_
SUPR_FNC_
LOC_C
Superior
Function
Location
IFLOT
TPLMA
SupFunctLoc
MI_
FNCLOC00
MI_FNCLOC00_
SYS_STATUS_C
System
Status
TJ02T
TXT04
System Status
MI_
FNCLOC00
MI_FNCLOC00_
WRK_CNTR_C
Work Center
CRHD
ARBPL
Work Center
MI_
FNCLOC00
MI_FNCLOC00_
WRK_CNTR_
DESC_C
Work Center
Description
CRTX
KTEXT
Work Center
Description
Copyright © 2017 General Electric Company. All rights reserved. • Page 393 of 495
Overview of APM Connect
SAP Work History Mappings
The following tables explain the SAP fields that are used to populate the baseline Work
History fields when you extract Orders and Notifications from SAP. The tables are
divided into sections, depending on the source of the Work History records. The Work
History records can be created from:
l
Orders with Notifications
l
Orders without associated Notifications
l
Notifications without associated Orders
Values Mapped to Records That Were Created from Orders
with Notifications
GE Digital
APM Field ID
GE Digital APM
Field Caption
SAP Table
SAP Field ID
SAP Field
Caption
MI_EVWKHIST_
ORDR_PM_
ACT_C
Note: The
value in the
Activity Type
field is associated with
Order Preventive Maintenance.
Activity Type
ILART
VIAUFKST
Maintenance
activity type
Copyright © 2017 General Electric Company. All rights reserved. • Page 394 of 495
Overview of APM Connect
MI_EVWKHIST_
ORDR_PM_
ACT_DESC_C
Note: The
value in the
Activity Type
Description
field is associated with
Order Preventive Maintenance.
Activity Type
Description
T353I_T
ILATX
Description
of maintenance activity type
Actual Labor
AFVV
ISMNW
Actual work
MI_EVWKHIST_
ACT_LABOR_
TIME_N
Note: The
value in the
Actual Labor
field is calculated as
the sum of
actual hours
across all
Operations
that are associated with
the Order (in
the SAP user
interface, this
value is visible in the
Actual work
box in the
Act. Data section of the
Operation).
Copyright © 2017 General Electric Company. All rights reserved. • Page 395 of 495
Overview of APM Connect
MI_EVWKHIST_
ASMBLY_C
Assembly
VIAUFKST
MI_EVWKHIST_
Assembly DescripASMBLY_DESC_
MAKT
tion
C
BAUTL
Assembly
MAKTX
Material
description
MI_EVWKHIST_
ASST_TECH_ID_ Asset Tech ID
C
EQUZ
TIDNR
Technical
identification
number
MI_EVWKHIST_
BRKDN_IND_F
VIQMEL
MSAUS
Breakdown
Indicator
Breakdown Indicator
MI_EVWKHIST_
SAP_SYSTEM_C
CMMS System
SY-SYSID + “-” +
N/A
SY-MANDT
Name of SAP
R/3 System R/3 System,
client number from
logon
MI_EVWKHIST_
EAM_REF_
START_DT_C
EAM Reference
Event Start Date
VIQMEL
QMDAT, MZEIT
Date/Time of
Notification
MI_EVWKHIST_
EAM_REF_
MAINT_
COMPL_DT_C
EAM Reference
Maintenance
Completion Date
VIAUFKST
GETRI, GEUZI
Actual finish
date/time
MI_EVWKHIST_
EAM_REF_
MAINT_START_
DT_C
EAM Reference
Maintenance
Start Date
VIAUFKST
GSTRI, GSUZI
Actual start
date/time
MI_EVWKHIST_
EAM_REF_
MECH_AVAIL_
DT_C
EAM Reference
Mechanically
Available Date
VIQMEL
AUSBS, AUZTB
End of Malfunction
(Date/Time)
Copyright © 2017 General Electric Company. All rights reserved. • Page 396 of 495
Overview of APM Connect
MI_EVWKHIST_
EAM_REF_
MECH_UNAVL_
DT_C
EAM Reference
Mechanically
Unavailable Date
MI_EVWKHIST_
EAM Reference
EAM_REF_
Order Creation
ORDR_CRT_DT_
Date
C
VIQMEL
AUSVN, AUZTV
Start of Malfunction
(Date/Time)
VIAUFKST
ERDAT, ERFZEIT
Created on
Date/Time
AEDAT, AEZEIT
Change date/time for
Order
Master
MI_EVWKHIST_
EAM_REF_
ORDR_CHNG_
DT_C
EAM Reference
Order Last
Change Date
MI_EVWKHIST_
EAM_REF_
RQST_CRT_DT_
C
EAM Reference
Request Creation
Date
VIQMEL
ERDAT, ERZEIT
Date/Time
on which the
record was
created
MI_EVWKHIST_
EAM_REF_
ORDR_CHNG_
DT_C
EAM Reference
Request Last
Change Date
VIQMEL
AEDAT, AEZEIT
Date/Time of
Last Change
MI_EVWKHIST_
EAM_REF_
SCHED_
COMPL_DT_C
EAM Reference
Scheduled Completion Date
VIAUFKST
GLTRS, GLUZS
Scheduled
finish date/time
MI_EVWKHIST_
EAM_REF_
SCHED_START_
DT_C
EAM Reference
Scheduled Start
Date
VIAUFKST
GSTRS, GSUZS
Scheduled
start date/time
MI_EVWKHIST_
EFFCT_CD_C
Effect Code
VIQMEL
AUSWK
Effect on
Operation
AUSWKT
Text - Effect
on Operation
MI_EVWKHIST_
EFFCT_DESC_C
Effect Description
VIAUFKST
T357A_T
Copyright © 2017 General Electric Company. All rights reserved. • Page 397 of 495
Overview of APM Connect
MI_EVWKHIST_
ASST_CTGRY_
DESC_C
Equipment Category Description
T370U
TYPTX
Equipment
category
description
MI_EVWKHIST_
ASST_CL_
DESC_C
Equipment Class
Description
SWOR
KSCHL
Keywords
MI_EVENT_
ASST_ID_CHR
Equipment ID
VIAUFKST/OBJK EQUNR
Equipment
number
MI_EVENT_
ASST_DESC_
CHR
Equipment Short
Description
EQKT
EQKTX
Description
of technical
object
MI_EVWKHIST_
ASST_TYP_
DESC_C
Equipment Type
Description
T370K_T
EARTX
Text for
Object Type
Copyright © 2017 General Electric Company. All rights reserved. • Page 398 of 495
Overview of APM Connect
MI_EVWKHIST_
EST_LABOR_
TIME_N
Note: The
value in the
Estimated
Labor field is
calculated as
the sum of
planned
hours across
all Operations that
are associated with
the order (in
the SAP
Adapter, this
value is visible in the
Work box in
the Internal
section of the
Operation.)
Estimated Labor
AFVV
ARBEI
Work
involved in
the activity
Copyright © 2017 General Electric Company. All rights reserved. • Page 399 of 495
Overview of APM Connect
MI_EVWKHIST_
EVENT_DATE_
DESC_C
Note: If
the Notification is not
assigned to a
Work Order,
the Event
Date Description field is
populated
with the following static
value: Order
Actual Start
Date. Otherwise, this
field is populated with
the following
value: Notification Date.
MI_EVENT_ID
Event Date
Description
Event ID
N/A
N/A
N/A
VIQMEL,
VIAUFKST
QMNUM,
AUFNR (Combination of WHQMNUMAUFNR)
Notification
Number Order Number
MI_EVENT_
LNG_DSC_TX
Event Long
Description
QMEL, AUFK
LTXT, KOPF
Notification
long text work Order
long text
MI_EVENT_
SHRT_DSC_
CHR
Event Short
Description
VIQMEL
QMTXT
Short Text
Copyright © 2017 General Electric Company. All rights reserved. • Page 400 of 495
Overview of APM Connect
MI_EVENT_
STRT_DT
Note: The
value in the
Event Start
Date field is
the same as
the time zone
of the user
who created
the Notification.
Event Start Date
VIQMEL
QMDAT, MZEIT
Date/Time of
Notification
Event Type
N/A
N/A
N/A
MI_EVWKHIST_
FAILR_MODE_
CD_C
Failure Mode
Code
VIQMEL
QMCOD
Coding
MI_EVWKHIST_
FAILR_MODE_
DESC_C
Failure Mode
Description
QPCT
KURZTEXT
Short Text
for Code
MI_EVENT_
LOC_ID_CHR
Location ID
VIQMEL/OBJK
TPLNR
Functional
Location
MI_EVENT_
LOC_SHRT_
DESC_CHR
Location Short
Description
PLTXT
Description
of functional
location
MI_EVENT_
TYP_CHR
Note: The
value in the
Event Type
field is populated with
the following
static value:
Work History.
IFLOTX
Copyright © 2017 General Electric Company. All rights reserved. • Page 401 of 495
Overview of APM Connect
MI_EVWKHIST_
MAINT_
COMPL_D
Note: The
value in the
Maintenance
Completion
Date field is
the same as
the time zone
of the user
who created
the Work
Order.
Maintenance
Completion Date
VIAUFKST
GETRI, GEUZI
Actual finish
date/time
Sum of
(Period value
in ledger currency)
MI_EVWKHIST_
MAINT_CST_N
Maintenance Cost PMCO
Σ(WRT00 WRT16)
MI_EVWKHIST_
MAINT_CST_
UOM_C
Maintenance Cost
PMCO
UOM
COCUR
Maintenance
Cost UOM
Maintenance
Start Date
GSTRI, GSUZI
Actual start
date/time
MI_EVWKHIST_
MAINT_START_
D
Note: The
value in the
Maintenance
Start Date
field is the
same as the
time zone of
the user who
created the
Work Order.
VIAUFKST
Copyright © 2017 General Electric Company. All rights reserved. • Page 402 of 495
Overview of APM Connect
MI_EVWKHIST_
MECH_DWN_
TIME_N
Mechanical Down
Time
VIQMEL
AUSZT
Breakdown
Duration
AUSBS, AUZTB
End of Malfunction
(Date/Time)
AUSVN, AUZTV
Start of Malfunction
(Date/Time)
AUFNR
Work Order
Object number
MI_EVWKHIST_
MECH_AVAIL_D
Note: The
value in the
Mechanically
Available
Date field is
the same as
the time zone
of the user
who created
the Notification.
Mechanically
Available Date
VIQMEL
MI_EVWKHIST_
MECH_UNAVL_
D
Note: The
value in the
Mechanically
Unavailable
Date field is
the same as
the time zone
of the user
who created
the Notification.
MI_EVWKHIST_
OBJECT_
NUMBER_C
Mechanically
Unavailable Date
Object Number
VIQMEL
VIAUFKST
Copyright © 2017 General Electric Company. All rights reserved. • Page 403 of 495
Overview of APM Connect
MI_EVWKHIST_
ORDR_CALL_
NBR_C
Order Call Number
VIAUFKST
ABNUM
Maintenance
plan call
number
Order Creation
Date
VIAUFKST
ERDAT, ERFZEIT
Created on
Date/Time
MI_EVWKHIST_
ORDR_CRT_DT_
D
Note: The
value in the
Order
Creation Date
field is the
same as the
SAP server
time zone.
MI_EVWKHIST_
ORDR_DESC_C
Order Description VIAUFKST
KTEXT
Short text
MI_EVWKHIST_
ORDR_ID_C
Order ID
AUFNR
Order Number
VIAUFKST
MI_EVWKHIST_
ORDR_CHNG_
DT_D
Note: The
value in the
Order Last
Change Date
field is the
same as the
SAP server
time zone.
MI_EVWKHIST_
ORDR_MAINT_
ITEM_C
Order Last
Change Date
VIAUFKST
AEDAT, AEZEIT
Change date/time for
Order
Master
Order Maintenance Item
VIAUFKST
WAPOS
Maintenance
item
Copyright © 2017 General Electric Company. All rights reserved. • Page 404 of 495
Overview of APM Connect
MI_EVWKHIST_
ORDR_MAINT_
PLAN_C
Order Maintenance Plan
VIAUFKST
WARPL
Maintenance
plan
MI_EVWKHIST_
ORDR_PRTY_C
Order Priority
VIAUFKST
PRIOK
Priority
MI_EVWKHIST_
ORDR_PRTY_
DESC_C
Order Priority
Description
T356_T
PRIOKX
Priority Text
ANLZU
Overall condition of
technical system
ANLZUX
Text on Operating Condition
TJ02T
TXT04
Individual
status of an
object (short
form)
MI_EVWKHIST_
ORDR_TYP_CD_ Order Type Code
C
VIAUFKST
AUART
Order Type
MI_EVWKHIST_
ORDR_TYP_
DESC_C
T003P
TXT
Short Text
TXT04
Individual
status of an
object (short
form)
MI_EVWKHIST_
ORDR_SYS_
COND_C
Order System
Condition
MI_EVWKHIST_
ORDR_SYS_
CND_DES_C
Order System
Condition Descrip- T357M_T
tion
MI_EVWKHIST_
ORDR_SYS_
STAT_C
MI_EVWKHIST_
ORDR_USER_
STAT_C
Order System
Status
Order Type
Description
VIAUFKST
Order User Status TJ30T
Copyright © 2017 General Electric Company. All rights reserved. • Page 405 of 495
Overview of APM Connect
MI_EVWKHIST_
RQST_CRT_DT_
D
Note: The
value in the
Request
Creation Date
field is the
same as the
SAP server
time zone.
Request Creation
Date
VIQMEL
ERDAT, ERZEIT
Date/Time
on which the
record was
created
MI_EVWKHIST_
RQST_DESC_C
Request Description
VIQMEL
QMTXT
Short Text
MI_EVWKHIST_
RQST_ID_C
Request ID
VIQMEL/OBJK
QMNUM/IHNUM
Notification
Number
Request Last
Change Date
VIQMEL
AEDAT, AEZEIT
Date/Time of
Last Change
MI_EVWKHIST_
RQST_PRTY_C
Request Priority
VIQMEL
PRIOK
Priority
MI_EVWKHIST_
RQST_PRTY_
DESC_C
Request Priority
Description
T356_T
PRIOKX
Priority Text
MI_EVWKHIST_
RQST_CHNG_
DT_D
Note: The
value in the
Request Last
Change Date
field is the
same as the
SAP server
time zone.
Copyright © 2017 General Electric Company. All rights reserved. • Page 406 of 495
Overview of APM Connect
MI_EVWKHIST_
RQST_SYS_
STAT_C
Request System
Status
TJ02T
TXT04
Individual
status of an
object (short
form)
MI_EVWKHIST_
RQST_TYP_CD_
C
Request Type
Code
VIQMEL
QMART
Notification
Type
MI_EVWKHIST_
RQST_TYP_
DESC_C
Request Type
Description
TQ80_T
QMARTX
Notification
Type Texts
MI_EVWKHIST_
RQST_USER_
STAT_C
Request User
Status
TJ30T
TXT04
Individual
status of an
object (short
form)
MI_EVENT_
ASST_CTGRY_
CHR
SAP Category
EQUI
EQTYP
Equipment
category
MI_EVENT_
ASST_CL_CHR
SAP Class
KLAH
CLASS
Class Number
MI_EVENT_
ASST_TYP_CHR
SAP Type
EQUI
EQART
Type of Technical Object
Copyright © 2017 General Electric Company. All rights reserved. • Page 407 of 495
Overview of APM Connect
MI_EVWKHIST_
SCHED_
COMPL_D
Note: The
value in the
Scheduled
Completion
Date field is
the same as
the time zone
of the user
who created
the Work
Order.
Scheduled Completion Date
VIAUFKST
GLTRS, GLUZS
Scheduled
finish date/time
Scheduled Start
Date
VIAUFKST
GSTRS, GSUZS
Scheduled
start date/time
Sub Object Number
VIAUFKST/OBJK OBZAE
MI_EVWKHIST_
SCHED_START_
D
Note: The
value in the
Scheduled
Start Date
field is the
same as the
time zone of
the user who
created the
Work Order.
MI_EVWKHIST_
SUB_OBJECT_
NUM_C
Object List
Count
Values Mapped to Records That Were Created Without Notifications
GE Digital APM
Field ID
GE Digital
APM Field
Caption
SAP Table
SAP Field ID
SAP Field
Caption
Copyright © 2017 General Electric Company. All rights reserved. • Page 408 of 495
Overview of APM Connect
MI_EVWKHIST_
ORDR_PM_ACT_C
Note: The value
in the Activity
Type field is associated with Order
Preventive Maintenance.
Activity Type
VIAUFKST
ILART
Maintenance
activity type
ILATX
Description
of maintenance activity type
MI_EVWKHIST_
ORDR_PM_ACT_
DESC_C
Note: The value
in the Activity
Type Description
field is associated
with Order Preventive Maintenance.
Activity Type
Description
T353I_T
Copyright © 2017 General Electric Company. All rights reserved. • Page 409 of 495
Overview of APM Connect
MI_EVWKHIST_ACT_
LABOR_TIME_N
Note: The value
in the Actual
Labor field is calculated as the
sum of actual
hours across all
Operations that
are associated
with the Order (in
the SAP user interface, this value is
visible in the
Actual work box
in the Act. Data
section of the
Operation).
Actual Labor
AFVV
ISMNW
Actual work
MI_EVWKHIST_
ASMBLY_C
Assembly
VIAUFKST
BAUTL
Assembly
MI_EVWKHIST_
ASMBLY_DESC_C
Assembly
Description
MAKT
MAKTX
Material
description
MI_EVWKHIST_
ASST_TECH_ID_C
Asset Tech
ID
TIDNR
Technical
identification
number
N/A
Name of SAP
R/3 System R/3 System,
client number from
logon
EQUZ
MI_EVWKHIST_SAP_
SYSTEM_C
CMMS System
SY-SYSID + “-” +
SY-MANDTSY
MI_EVWKHIST_
EAM_REF_START_
DT_C
EAM Reference Event
Start Date
Date, Time
GSTRI, GSUZI
of Work
VIAUFKST/VIQMEL /
Order / NotiQMDAT/MZEIT
fication
Copyright © 2017 General Electric Company. All rights reserved. • Page 410 of 495
Overview of APM Connect
MI_EVWKHIST_
EAM_REF_MAINT_
START_DT_C
EAM Reference Maintenance
Start Date
MI_EVWKHIST_
EAM_REF_ORDR_
CRT_DT_C
EAM Reference Order
Creation
Date
MI_EVWKHIST_
EAM_REF_ORDR_
CHNG_DT_C
EAM Reference Order
Last Change
Date
MI_EVWKHIST_
ASST_CTGRY_DESC_
C
Equipment
Category
Description
MI_EVWKHIST_
ASST_CL_DESC_C
Equipment
Class
Description
MI_EVENT_ASST_ID_ Equipment
CHR
ID
GSTRI, GSUZI
Actual start
date/time
VIAUFKST
ERDAT,
ERFZEIT
Date/Time
on which the
record was
created
VIAUFKST
AEDAT, AEZEIT
Date/Time of
Last Change
T370U
TYPTX
Equipment
category
description
SWOR
KSCHL
Keywords
VIAUFKST/OBJK
EQUNR
Equipment
number
EQKTX
Description
of technical
object
EARTX
Text for
Object Type
VIAUFKST
MI_EVENT_ASST_
DESC_CHR
Equipment
Short
Description
MI_EVWKHIST_
ASST_TYP_DESC_C
Equipment
Type Descrip- T370K_T
tion
EQKT
Copyright © 2017 General Electric Company. All rights reserved. • Page 411 of 495
Overview of APM Connect
MI_EVWKHIST_EST_
LABOR_TIME_N
Note: The value
in the Estimated
Labor field is calculated as the
sum of planned
hours across all
Operations that
are associated
with the order (in
the SAP Adapter,
this value is visible in the Work
box in the
Internal section of
the Operation.)
Estimated
Labor
AFVV
ARBEI
Work
involved in
the activity
Event Date
Description
N/A
N/A
N/A
MI_EVWKHIST_
EVENT_DATE_DESC_
C
Note: If the
Notification is not
assigned to a
Work Order, the
Event Date
Description field
is populated with
the following
static value: Order
Actual Start Date.
Otherwise, this
field is populated
with the following
value: Notification
Date.
Copyright © 2017 General Electric Company. All rights reserved. • Page 412 of 495
Overview of APM Connect
MI_EVENT_ID
Event ID
VIAUFKST
AUFNR
Order Number
Long Desc
Short text
MI_EVENT_LNG_
DSC_TX
Event Long
Description
AUFK
Retrieved by
calling FM
READ_TEXT
with ID=LTXT,
OBJECT=AUFK
MI_EVENT_SHRT_
DSC_CHR
Event Short
Description
VIAUFKST/VIQMEL
KTEXT /
QMTXT
Event Start
Date
Date, Time
GSTRI, GSUZI
of Work
VIAUFKST/VIQMEL /
Order / NotiQMDAT/MZEIT
fication
Event Type
N/A
N/A
N/A
MI_EVENT_LOC_ID_
CHR
Location ID
VIAUFKST/OBJK
TPLNR
Functional
Location
MI_EVENT_LOC_
SHRT_DESC_CHR
Location
Short
Description
PLTXT
Description
of functional
location
MI_EVENT_STRT_DT
Note: The value
in the Event Start
Date field is the
same as the time
zone of the user
who created the
Notification.
MI_EVENT_TYP_CHR
Note: The value
in the Event Type
field is populated
with the following
static value: Work
History.
IFLOTX
Copyright © 2017 General Electric Company. All rights reserved. • Page 413 of 495
Overview of APM Connect
MI_EVWKHIST_
MAINT_COMPL_D
Note: The value
in the Maintenance Completion Date field
is the same as the
time zone of the
user who created
the Work Order.
Maintenance
Completion VIAUFKST
Date
GETRI, GEUZI
Actual finish
date/time
MI_EVWKHIST_
MAINT_CST_N
Maintenance
PMCO
Cost
Σ(WRT00 WRT16)
Sum of
(Period value
in ledger currency)
MI_EVWKHIST_
MAINT_CST_UOM_C
Maintenance
PMCO
Cost UOM
COCUR
Maintenance
Cost UOM
Maintenance
VIAUFKST
Start Date
GSTRI, GSUZI
Actual start
date/time
Object NumVIAUFKST
ber
AUFNR
Work Order
Object number
ABNUM
Maintenance
plan call
number
MI_EVWKHIST_
MAINT_START_D
Note: The value
in the Maintenance Start Date
field is the same
as the time zone
of the user who
created the Work
Order.
MI_EVWKHIST_
OBJECT_NUMBER_C
MI_EVWKHIST_
ORDR_CALL_NBR_C
Order Call
Number
VIAUFKST
Copyright © 2017 General Electric Company. All rights reserved. • Page 414 of 495
Overview of APM Connect
MI_EVWKHIST_
ORDR_CRT_DT_D
Order
Creation
Date
VIAUFKST
ERDAT,
ERFZEIT
Date/Time
on which the
record was
created
MI_EVWKHIST_
ORDR_DESC_C
Order
Description
VIAUFKST
KTEXT
Short text
MI_EVWKHIST_
ORDR_ID_C
Order ID
VIAUFKST
AUFNR
Order Number
Order Last
VIAUFKST
Change Date
AEDAT, AEZEIT
Date/Time of
Last Change
MI_EVWKHIST_
ORDR_MAINT_
ITEM_C
Order Maintenance
Item
VIAUFKST
WAPOS
Maintenance
item
MI_EVWKHIST_
ORDR_MAINT_
PLAN_C
Order MainVIAUFKST
tenance Plan
WARPL
Maintenance
plan
MI_EVWKHIST_
ORDR_PRTY_C
Order Priority
PRIOK
Priority
MI_EVWKHIST_
ORDR_PRTY_DESC_
C
Order Priority Descrip- T356_T
tion
PRIOKX
Priority Text
Note: The value
in the Order
Creation Date
field is the same
as the SAP server
time zone.
MI_EVWKHIST_
ORDR_CHNG_DT_D
Note: The value
in the Order Last
Change Date field
is the same as the
SAP server time
zone.
VIAUFKST
Copyright © 2017 General Electric Company. All rights reserved. • Page 415 of 495
Overview of APM Connect
MI_EVWKHIST_
ORDR_SYS_COND_C
Order System Condition
VIAUFKST
ANLZU
Overall condition of
technical system
MI_EVWKHIST_
ORDR_SYS_CND_
DES_C
Order System Condition
Description
T357M_T
ANLZUX
Text on Operating Condition
MI_EVWKHIST_
ORDR_SYS_STAT_C
Order System Status
TJ02T
TXT04
Individual
status of an
object (short
form)
MI_EVWKHIST_
ORDR_TYP_CD_C
Order Type
Code
VIAUFKST
AUART
Order Type
MI_EVWKHIST_
ORDR_TYP_DESC_C
Order Type
Description
T003P
TXT
Short Text
MI_EVWKHIST_
ORDR_USER_STAT_
C
Order User
Status
TJ30T
TXT04
Individual
status of an
object (short
form)
MI_EVENT_ASST_
CTGRY_CHR
SAP Category
EQUI
EQTYP
Equipment
category
MI_EVENT_ASST_
CL_CHR
SAP Class
KLAH
CLASS
Class Number
MI_EVENT_ASST_
TYP_CHR
SAP Type
EQUI
EQART
Type of Technical Object
VIAUFKST/OBJK
OBZAE
Object List
Count
MI_EVWKHIST_SUB_ Sub Object
OBJECT_NUM_C
Number
Values Mapped to Records That Were Created from Notifications
Without Associated Orders
GE Digital APM Field
ID
GE Digital
APM Field
Caption
SAP Table
SAP Field ID
SAP Field
Caption
Copyright © 2017 General Electric Company. All rights reserved. • Page 416 of 495
Overview of APM Connect
MI_EVWKHIST_
ASMBLY_C
Assembly
VIQMEL
BAUTL
Assembly
MI_EVWKHIST_
ASMBLY_DESC_C
Assembly
Description
MAKT
MAKTX
Material
description
MI_EVWKHIST_ASST_
TECH_ID_C
Asset Tech
ID
EQUZ
TIDNR
Technical
identification
number
MI_EVWKHIST_
BRKDN_IND_F
Breakdown
Indicator
VIQMEL
MSAUS
Breakdown
Indicator
Name of SAP
R/3 System R/3 System,
client number from
logon
MI_EVWKHIST_SAP_
SYSTEM_C
CMMS System
SY-SYSID + “-” +
N/A
SY-MANDTSY
MI_EVWKHIST_EAM_
REF_START_DT_C
EAM Reference Event
Start Date
VIQMEL
QMDAT,
MZEIT
Date/Time of
Notification
MI_EVWKHIST_EAM_
REF_MECH_AVAIL_DT_
C
EAM Reference Mechanically
Available
Date
VIQMEL
AUSBS,
AUZTB
End of Malfunction
(Date/Time)
MI_EVWKHIST_EAM_
REF_MECH_UNAVL_
DT_C
EAM Reference Mechanically
Unavailable
Date
VIQMEL
AUSVN,
AUZTV
Start of Malfunction
(Date/Time)
MI_EVWKHIST_EAM_
REF_RQST_CRT_DT_C
EAM Reference
Request
Creation
Date
VIQMEL
Date/Time
on which the
ERDAT, ERZEIT
record was
created
Copyright © 2017 General Electric Company. All rights reserved. • Page 417 of 495
Overview of APM Connect
MI_EVWKHIST_EAM_
REF_RQST_CHNG_DT_
C
EAM Reference
VIQMEL
Request Last
Change Date
AEDAT, AEZEIT
Date/Time of
Last Change
MI_EVWKHIST_EFFCT_
CD_C
Effect Code
VIQMEL
AUSWK
Effect on
Operation
MI_EVWKHIST_EFFCT_
DESC_C
Effect
Description
T357A_T
AUSWKT
Text - Effect
on Operation
MI_EVWKHIST_ASST_
CTGRY_DESC_C
Equipment
Category
Description
T370U
TYPTX
Equipment
category
description
MI_EVWKHIST_ASST_
CL_DESC_C
Equipment
Class
Description
SWOR
KSCHL
Keywords
MI_EVENT_ASST_ID_
CHR
Equipment
ID
VIQMEL
EQUNR
Equipment
number
MI_EVENT_ASST_
DESC_CHR
Equipment
Short
Description
EQKTX
Description
of technical
object
MI_EVWKHIST_ASST_
TYP_DESC_C
Equipment
Type Descrip- T370K_T
tion
EARTX
Text for
Object Type
Event Date
Description
N/A
N/A
EQKT
MI_EVWKHIST_EVENT_
DATE_DESC_C
Note: The value in
the Event Date
Description field is
populated with the
following static
value: Notification
Date.
N/A
Copyright © 2017 General Electric Company. All rights reserved. • Page 418 of 495
Overview of APM Connect
MI_EVENT_ID
Event ID
VIQMEL
QMNUM
Notification
Number
MI_EVENT_LNG_DSC_
TX
Event Long
Description
QMEL
Retrieved by
calling FM
Notification
READ_TEXT
Long Desc
with ID=LTXT,
OBJECT=QMEL
MI_EVENT_SHRT_DSC_
CHR
Event Short
Description
VIQMEL
QMTXT
Short Text
Event Start
Date
VIQMEL
QMDAT,
MZEIT
Date/Time of
Notification
Type field is populated with the following static value:
Work History.
Event Type
N/A
N/A
N/A
MI_EVWKHIST_FAILR_
MODE_CD_C
Failure
Mode Code
VIQMEL
QMCOD
Coding
MI_EVWKHIST_FAILR_
MODE_DESC_C
Failure
Mode
Description
QPCT
KURZTEXT
Short Text
for Code
MI_EVENT_LOC_ID_
CHR
Location ID
VIQMEL
TPLNR
Functional
Location
MI_EVENT_LOC_SHRT_
DESC_CHR
Location
Short
Description
PLTXT
Description
of functional
location
MI_EVENT_STRT_DT
Note: The value in
the Event Start Date
field is the same as
the time zone of the
user who created the
Notification.
MI_EVENT_TYP_CHR
Note: The Event
IFLOTX
Copyright © 2017 General Electric Company. All rights reserved. • Page 419 of 495
Overview of APM Connect
MI_EVWKHIST_MECH_
DWN_TIME_N
Mechanical
Down Time
AUSZT
Breakdown
Duration
Mechanically
Available
VIQMEL
Date
AUSBS,
AUZTB
End of Malfunction
(Date/Time)
Mechanically
Unavailable VIQMEL
Date
AUSVN,
AUZTV
Start of Malfunction
(Date/Time)
Object NumVIAUFKST
ber
AUFNR
Work Order
Object number
Request
Creation
Date
VIQMEL
Date/Time
on which the
ERDAT, ERZEIT
record was
created
MI_EVWKHIST_RQST_
DESC_C
Request
Description
VIQMEL
QMTXT
Short Text
MI_EVWKHIST_RQST_
ID_C
Request ID
VIQMEL
QMNUM
Notification
Number
VIQMEL
MI_EVWKHIST_MECH_
AVAIL_D
Note: The value in
the Mechanically
Available Date field
is the same as the
time zone of the
user who created the
Notification.
MI_EVWKHIST_MECH_
UNAVL_D
Note: The value in
the Mechanically
Unavailable Date
field is the same as
the time zone of the
user who created the
Notification.
MI_EVWKHIST_
OBJECT_NUMBER_C
Note: The value in
the Request Creation
Date field is the
same as the SAP
server time zone.
Copyright © 2017 General Electric Company. All rights reserved. • Page 420 of 495
Overview of APM Connect
MI_EVWKHIST_RQST_
CHNG_DT_D
Note: The value in
Request Last
VIQMEL
Change Date
AEDAT, AEZEIT
Date/Time of
Last Change
MI_EVWKHIST_RQST_
PRTY_C
Request Priority
PRIOK
Priority
MI_EVWKHIST_RQST_
PRTY_DESC_C
Request Priority Descrip- T356_T
tion
PRIOKX
Priority Text
MI_EVWKHIST_RQST_
SYS_STAT_C
Request System Status
TJ02T
TXT04
Individual
status of an
object (short
form)
MI_EVWKHIST_RQST_
TYP_CD_C
Request
Type Code
VIQMEL
QMART
Notification
Type
MI_EVWKHIST_RQST_
TYP_DESC_C
Request
Type Descrip- TQ80_T
tion
QMARTX
Notification
Type Texts
the Request Last
Change Date field is
the same as the SAP
server time zone.
VIQMEL
MI_EVWKHIST_RQST_
USER_STAT_C
Request
User Status
TJ30T
TXT04
Individual
status of an
object (short
form)
MI_EVENT_ASST_
CTGRY_CHR
SAP Category
EQUI
EQTYP
Equipment
category
MI_EVENT_ASST_CL_
CHR
SAP Class
KLAH
CLASS
Class Number
MI_EVENT_ASST_TYP_
CHR
SAP Type
EQUI
EQART
Type of Technical Object
MI_EVWKHIST_SUB_
OBJECT_NUM_C
Sub Object
Number
VIAUFKST/OBJK OBZAE
Object List
Count
Copyright © 2017 General Electric Company. All rights reserved. • Page 421 of 495
Overview of APM Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 422 of 495
Overview of APM Connect
SAP Work History Detail Mappings
The following table explains the SAP fields that are used to populate the baseline Work
History Detail fields when you extract Orders and Notifications from SAP.
Note: If a Technical Object in the object list is associated with a Notification that has
items, separate Work History Detail records will be created for each of those items.
The Work History Detail records will be linked to the Work History record that was created using that Technical Object.
GE Digital APM
Family ID
GE Digital
APM Field
ID
GE Digital APM
Field Caption
SAP
Table
SAP
Field
SAP Field
Caption
MI_DTWKHIST
MI_
DTWKHIST_
Cause Code
CAUSE_CD_
C
QMUR
URCOD
Cause Code
MI_DTWKHIST
MI_
DTWKHIST_ Cause DescripCAUSE_
tion
DESC_C
QPCT
KURZTEXT
Short Text
for Code
MI_
DTWKHIST_ CMMS Creation
CREATE_
Date
DATE_D
VIAUFKS
ERDAT,
ERZEIT
SAP
Creation
Date
MI_DTWKHIST
Note: The
time zone used
for the value in
the CMMS
Creation Date
field is the
same as the
SAP server time
zone.
Copyright © 2017 General Electric Company. All rights reserved. • Page 423 of 495
Overview of APM Connect
MI_DTWKHIST
Note: The
time zone used
for the value in
the CMMS Last
Changed Date
field is the
same as the
SAP server time
zone.
MI_
DTWKHIST_ CMMS Last
CHANGE_
Changed Date
DATE_D
VIAUFKS
AEDAT,
AEZEIT
SAP Last
Changed
Date
MI_DTWKHIST
MI_
DTWKHIST_
Condition Code
CNDTN_
CD_C
QMFE
FECOD
Problem
MI_DTWKHIST
MI_
DTWKHIST_ Condition
CNDTN_
Description
DESC_C
QPCT
KURZTEXT
Short Text
for Code
MI_DTWKHIST
MI_
DTWKHIST_
Detail Narrative
DTL_
NARTV_T
QMFE
LTXT
Long Text
MI_DTWKHIST
MI_
DTWKHIST_
EAM Reference
EAM_REF_
Creation Date
CREATE_
DT_C
VIAUFKS
ERDAT,
ERZEIT
SAP
Creation
Date
MI_DTWKHIST
MI_
DTWKHIST_ EAM Reference
EAM_REF_
Last Changed
CHANGE_
Date
DT_C
AEDAT,
VIAUFKS
AEZEIT
SAP Last
Changed
Date
MI_DTWKHIST
MI_
DTWKHIST_ Equipment CatASST_
egory
CTGRY_C
EQUI
Equipment
category
EQTYP
Copyright © 2017 General Electric Company. All rights reserved. • Page 424 of 495
Overview of APM Connect
MI_DTWKHIST
MI_
DTWKHIST_ Equipment CatASST_
egory DescripCTGRY_
tion
DESC_C
TYPTX
Equipment
category
description
MI_DTWKHIST
MI_
DTWKHIST_
Equipment Class KLAH
ASST_
CLASS_C
CLASS
Class Number
MI_DTWKHIST
MI_
DTWKHIST_
Equipment Class
ASST_
SWOR
Description
CLASS_
DESC_C
KSCHL
Keywords
MI_DTWKHIST
MI_
DTWKHIST_ Equipment ID
ASST_ID_C
VIQMEL
EQUNR
Equipment
number
MI_DTWKHIST
MI_
DTWKHIST_
Equipment Type
ASST_TYP_
C
EQUI
EQART
Type of
Technical
Object
MI_DTWKHIST
MI_
DTWKHIST_ Equipment Type
ASST_TYP_ Description
DESC_C
T370K_T
EARTX
Text for
Object Type
MI_DTWKHIST
MI_
DTWKHIST_ Location ID
LOC_ID_C
VIQMEL
TPLNR
Functional
Location
MI_DTWKHIST
MI_
DTWKHIST_ Maintainable
MAINT_
Item Code
ITEM_CD_C
QMFE
OTEIL
Part of
Object
MI_DTWKHIST
MI_
DTWKHIST_
Maintainable
MAINT_
QPCT
Item Description
ITEM_
DESC_C
KURZTEXT
Short Text
for Code
MI_DTWKHIST
MI_
DTWKHIST_ Maintenance
MAINT_
Action Code
ACTN_CD_C
MNCOD
Activity
Code
T370U
QMMA
Copyright © 2017 General Electric Company. All rights reserved. • Page 425 of 495
Overview of APM Connect
MI_DTWKHIST
MI_
DTWKHIST_ Maintenance
MAINT_
Action DescripACTN_
tion
DESC_C
QPCT
KURZTEXT
Short Text
for Code
MI_DTWKHIST
MI_
DTWKHIST_ Marked for DeleQMFE
MARKED_
tion?
FOR_DEL_F
KZLOESCH
Delete Data
Record
MI_DTWKHIST
MI_
Work History
DTWKHIST_
Detail DescripEVNT_DTL_
tion
DESC_C
VIQMEL
QMTXT
Short Text
MI_DTWKHIST
MI_
DTWKHIST_ Work History
EVNT_DTL_ Detail ID
ID_C
QMFE,
VIQMEL
QMNUM,
AUFNR,
FENUM
Notification
Number Order Number
MI_DTWKHIST
MI_
DTWKHIST_
WRK_
Work History ID
HISTRY_ID_
C
VIAUFKS QMNUM
Notification
Number
MI_DTWKHIST
MI_
DTWKHIST_ Order ID
ORDR_ID_C
VIAUFKS AUFNR
Order Number
MI_DTWKHIST
MI_
DTWKHIST_ Request ID
RQST_ID_C
VIQMEL
Notification
Number
QMNUM
Copyright © 2017 General Electric Company. All rights reserved. • Page 426 of 495
Overview of APM Connect
SAP Technical Characteristics Mappings
The following table explains the SAP fields that are used to populate the baseline Technical Characteristic fields when you extract SAP characteristics to create Technical Characteristic records in GE Digital APM.
GE Digital APM
Field Name
GE Digital APM Field
Name
SAP Table
SAP Field ID
Data Type
MI_TECHCHAR_TYPE_C
CABN
ATFOR
Length of Data
Type
MI_TECHCHAR_NUM_
CHARS_N
CABN
ANZST
Number of
Decimal Places
MI_TECHCHAR_NUM_
DEC_PLACES_N
CABN
ANZDZ
Description
MI_TECHCHAR_DESC_C
CABN
ATBEZ
Character Value
MI_TECHCHAR_CHAR_
VALUE_C
AUSP
ATWRT/ATFLB/ATFLV
Numeric Value
MI_TECHCHAR_
NUMERIC_VALUE_N
AUSP
ATWRT/ATFLB/ATFLV
AUSP
ATWRT/ATFLB/ATFLV
+
+
TCURC
ISOCD
T006
MSEH6
Multiple Value
Characteristic
MI_TECHCHAR_MULTI_
VALUE_C
CMMS System
MI_TECHCHAR_SAP_
SYSTEM_C
None
<SY-SID> + <SYMANDT>
Name
MI_TECHCHAR_NAME_C
CABN
ATNAM
Currency Value
MI_TECHCHAR_CURR_
VALUE_N
AUSP
ATWRT/ATFLB/ATFLV
Equipment ID
MI_TECHCHAR_EQUIP_
ID_C
EQUI
EQUNR
Functional Location ID
MI_TECHCHAR_FLOC_
ID_C
IFLOT
TPLNR
Technical Characteristics ID
MI_TECHCHAR_ID_C
CABNT
ATINN
Copyright © 2017 General Electric Company. All rights reserved. • Page 427 of 495
Overview of APM Connect
TCURC
ISOCD
T006
MSEH6
MI_TECHCHAR_IS_
RESTRICTABLE_F
CABN
ATGLA
MI_TECHCHAR_VALUE_
DESC_C
CABNT
ATBEZ
AUSP
ATWRT/ATFLB/ATFLV
+
+
TCURC
ISOCD
T006
MSEH6
Unit of Measurement
MI_TECHCHAR_UOM_C
Restrictable Characteristic Indicator
Technical Characteristic Value
Description
Interval Value
MI_TECHCHAR_
INTERVAL_VALUE_C
Copyright © 2017 General Electric Company. All rights reserved. • Page 428 of 495
Overview of APM Connect
SAP Work Management Mappings
The following table explains the SAP fields that are used to populate the baseline Work
Management fields when you extract SAP characteristics to create Work Management
records in GE Digital APM.
GE Digital APM
Family ID
GE Digital
APM Field
ID
SAP
Table
SAP
Field
SAP Field Caption
Mapping
Formula
AFVV
IEDD
Actual finish: Execution (date)
Null
AFVV
IEDD
Actual finish: Execution (date)
Null
MI_
TASKCALB/MITASKINSP
Note: The time
zone used for the
value in the Actual
finish: Execution
(date) field is the
same as the time
zone of the user
who created the
Work Management.
MI_TASK_
LAST_
DATE_DT
MI_
MI_TASK_
TASKCALB/MITASKIN- EAM_REF_
SP
LAST_DT_C
MI_
MI_TASK_
TASKCALB/MITASKINDESC_TX
SP
VIMPO- EQUN- EquipS/
R/
ment/Functional
PLKO
TPLNR Location
Concatenate
EQUNR or
TPLNR
with - and
PLPO.LTXA1+
PLPO.LTXA2
MI_TASK_
MI_
TASK_LIST_
TASKCALB/MITASKINGROUP_
SP
CNTR_C
PLKO
PLNAL Group Counter
PLNAL
MI_
MI_TASK_
TASKCALB/MITASKIN- TASK_LIST_
SP
GROUP_C
PLKO
PLNNR
PLNNR
Key for Task List
Group
Copyright © 2017 General Electric Company. All rights reserved. • Page 429 of 495
Overview of APM Connect
MI_TASK_
MI_
MAINT_
TASKCALB/MITASKIN- PLAN_
MPOS
SP
ITEM_NBR_
C
WAPOMaintenance item
S
WAPOS
MI_TASK_
MI_
MAINT_
TASKCALB/MITASKINPLAN_
SP
NBR_C
MPLA
WARPMaintenance Plan
L
WARPL
MHIS
NPLDA
Next planned date
Null
MI_
MI_TASK_
TASKCALB/MITASKIN- EAM_REF_ MHIS
SP
NEXT_DT_C
NPLDA
Next planned date
Null
MI_
MI_TASK_
TASKCALB/MITASKIN- DESIR_
Null
SP
INTER_NBR
Null
Null
Null
MI_TASK_
MI_
DESIR_
TASKCALB/MITASKININTER_
SP
UOM_C
Null
Null
Null
Null
MI_
MI_TASK_
TASKCALB/MITASKIN- MIN_
Null
SP
INTER_NBR
Null
Null
Null
MI_TASK_
MI_
MIN_
TASKCALB/MITASKININTER_
SP
UOM_C
Null
Null
Null
MI_
TASKCALB/MITASKINSP
Note: The time
zone used for the
value in the Next
planned date field
is the same as the
time zone of the
user who created
the Work Management.
MI_TASK_
NEXT_
DATE_DT
Null
Copyright © 2017 General Electric Company. All rights reserved. • Page 430 of 495
Overview of APM Connect
MI_
MI_TASK_
TASKCALB/MITASKIN- MAX_
Null
SP
INTER_NBR
Null
Null
Null
MI_TASK_
MI_
MAX_
TASKCALB/MITASKININTER_
SP
UOM_C
Null
Null
Null
Null
MI_
MI_TASK_
TASKCALB/MITASKIN- OPERATIOSP
N_NBR_C
PLPO
VORN- Operation/Activity
R
Number
VORNR
MI_
MI_TASK_
TASKCALB/MITASKINID
SP
PLPO
LTXA1, Operation/Activity
LTXA2 Number
Concatenate
MPOSEQUNR or
MPOSFLOC with
MPLAWARPL +
MPOSWAPOS +
PLKOPLNTY +
PLKOPLLNR +
PLKOPLNAL +
PLPOVORNR
MI_
MI_TASK_
TASKCALB/MITASKIN- TASK_LIST_
SP
TYPE_C
PLKO
PLNTY Task List Type
PLNTY
PLPO
ANDASAP Creation Date
T
ANDAT
MI_
TASKCALB/MITASKINSP
Note: The time
zone used for the
value in the SAP
Creation Date field
is the same as the
SAP server time
zone.
MI_TASK_
CREATE_
DATE_D
Copyright © 2017 General Electric Company. All rights reserved. • Page 431 of 495
Overview of APM Connect
MI_TASK_
MI_
EAM_REF_
TASKCALB/MITASKINCREATE_
SP
DT_C
PLPO
ANDASAP Creation Date
T
ANDAT
MI_
MI_TASK_
TASKCALB/MITASKIN- MAINT_
SP
PLANT_C
MPOS
SWERK
SAP Maintenance
Plant
SWERK
MI_TASK_
CHANGE_
DATE_D
PLPO
AEDAT
SAP Last Changed
Date
AEDAT
MI_TASK_
MI_
EAM_REF_
TASKCALB/MITASKINCHANGE_
SP
DT_C
PLPO
AEDAT
SAP Last Changed
Date
AEDAT
None
SYSID,
SYSAP System
MANDT
MI_
TASKCALB/MITASKINSP
Note: The time
zone used for the
value in the SAP
Last Changed Date
field is the same
as the SAP server
time zone.
MI_
MI_TASK_
TASKCALB/MITASKIN- SAP_
SP
SYSTEM_C
Concatenate
SY-SID
with SYMANDT
Copyright © 2017 General Electric Company. All rights reserved. • Page 432 of 495
Overview of APM Connect
SAP Recommendation Mappings
The following tables explain the Recommendation fields that are used to populate SAP
Notification fields when you use the Notification Management Adapter.
GE Digital
APM
Field ID
MI_REC_
ASSET_
ID_CHR
MI_REC_
LOC_ID_
CHR
GE Digital
APM Field
Caption
SAP
Table ID
SAP
Field ID
BAPI
Structure
BAPI
Field
BAPI2080_
EQUIPMENOTHD- NT
RI
Asset ID
VIQM- EQUEL
NR
Functional
Location ID
BAPI208VIQM- TPLN- 0_
FUNCT_
EL
R
NOTHD- LOC
RI
SAP
Field
Caption
Notes
Equipment
number
None
Functional
Location
None
Copyright © 2017 General Electric Company. All rights reserved. • Page 433 of 495
Overview of APM Connect
MI_REC_
NOTIF_
TYPE_C
M1
VIQM- QMANone
EL
RT
NOTIF_
TYPE
Notification
Type
In SAP,
the
Reported
By field
is populated
with the
first
twelve
characters of
the value
in the
User ID
field. The
value in
the User
ID field is
the user
ID of the
Security
user that
was
logged in
to
GE Digital APM
when the
Notification
was created.
Copyright © 2017 General Electric Company. All rights reserved. • Page 434 of 495
Overview of APM Connect
None
None
None
None
MI_REC_
LONG_
DESCR_
TX
Recommendation
Description
None
MI_REC_
SHORT_
DESCR_
CHR
Recommendation
Headline
VIQM- QMTEL
XT
None
Name of
BAPI208Person
0_
REPORTEDReportNOTHD- BY
ing NotiRI
fication
None
None
BAPI2080_
SHORT_
NOTHD- TEXT
RI
The
Reported
By field
is populated in
SAP with
the first
twelve
characters of
the user
ID of the
Security
User that
was
logged in
to
GE Digital APM
when the
Notification
was created.
Notification
Long
Text
The
value in
this field
appears
as a
string.
Short
Text
None
The following fields are updated in the Recommendation record based on data from the
created Notification.
GE Digital APM
Field ID
GE Digital APM
Field Caption
SAP
Table
ID
SAP
Field
ID
BAPI
Structure
BAPI
Field
SAP Field
Caption
Notes
Copyright © 2017 General Electric Company. All rights reserved. • Page 435 of 495
Overview of APM Connect
MI_REC_
EAM_REF_
CHANGE_
DATE_C
EAM Reference
VIQMEChange
L
Date
AEDAT/
AEZEIT
None
None
Changed
on
Date/Time
The
value in
this
field
appears as a
string
to
match
the
date
and
time in
SAP.
MI_REC_
EAM_REF_
CREATE_
DATE_C
EAM Reference
VIQMECreation
L
Date
ERDAT/
ERZEIT
None
None
Created on
Date/Time
The
value in
this
field
appears as a
string
to
match
the
date
and
time in
SAP.
MI_REC_
WR_
EQUIP_C
Work
Request
Equipment
EQUNR
None
None
Equipment
number
None
MI_REC_
WR_LOC_
C
Work
Request
VIQMEFunctional L
Location
TPLNR
None
None
Functional
Location
None
MI_REC_
WK_REQ_
REF_CHR
Work
Request
Reference
QMNUM
None
None
Notification
Number
None
VIQMEL
VIQMEL
Copyright © 2017 General Electric Company. All rights reserved. • Page 436 of 495
Overview of APM Connect
SAP Task Value Mappings
When you use the Work Management Interface to create Orders from GE Digital APM
Task records, several values in the GE Digital APM Task record are passed to the SAP
Order and its associated Operations. The following table explains the Task fields whose
values are passed to the SAP Function Module /MIAPM/MAINTAIN_ORDER (which calls
the SAP BAPI BAPI_ALM_ORDER_MAINTAIN).
GE Digital APM Field Caption
BAPI Structure
SAP BAPI
Field
Work Order Type
BAPI_ALM_ORDER_
HEADERS_I
ORDER_TYPE
Task Description
BAPI_ALM_ORDER_
HEADERS_I
SHORT_TEXT
Task List Type
None
TASKLIST_TYPE
Task List Group
None
TASKLIST_
GROUP
Task List Group Counter
None
TASKLIST_
GROUP_CTR
Task Details
None
IT_TEXT_LINES
Work Order Number
None
ORDER_
NUMBER
The GE Digital APM system maps a value
from the Equipment record to which the
Task record is linked, based upon the
configuration of the query Get SAP ID for BAPI_ALM_ORDER_
Equipment, which is stored in the CataHEADERS_I
log folder \\Public\Meridium\Modules\SAP Integration
Interfaces\Queries.
EQUIPMENT
The GE Digital APM system maps a value
from the Functional Location record to
which the Task record is linked, based
upon the configuration of the query Get
SAP ID for Functional Location, which is
stored in the Catalog folder
\\Public\Meridium\Modules\SAP Integration Interfaces\Queries.
FUNCT_LOC
None
Copyright © 2017 General Electric Company. All rights reserved. • Page 437 of 495
Overview of APM Connect
After these values are passed to the SAP BAPI, the Function Module then sends additional data from the associated SAP Task List to the SAP Order, as described in the following table.
Task List Field
BAPI Structure
Order Field
WERKS
BAPI_ALM_ORDER_HEADERS_I
PLANT
ARBPL
BAPI_ALM_ORDER_HEADERS_I
MN_WK_CTR
None. The value 4 is always
mapped.
BAPI_ALM_ORDER_HEADERS_I
SCHED_TYPE
IWERK
BAPI_ALM_ORDER_HEADERS_I
PLANPLANT
Also, for each Operation that belongs to the Task List, a corresponding Operation will
belong to the Order. The following table identifies the values that are mapped from
each Operation that is attached to the Task List to each Operation that is attached to the
Order.
Task List Field
BAPI Structure
Order Field
ARPBL
BAPI_ALM_ORDER_OPERATION
WORK_CNTR
VORNR
BAPI_ALM_ORDER_OPERATION
ACTIVITY
STEUS
BAPI_ALM_ORDER_OPERATION
CONTROL_KEY
WERKS
BAPI_ALM_ORDER_OPERATION
PLANT
LTXA1
BAPI_ALM_ORDER_OPERATION
DESCRIPTION
TXTSP
BAPI_ALM_ORDER_OPERATION
LANGU
KTSCH
BAPI_ALM_ORDER_OPERATION
STANDARD_TEXT_
KEY
LOANZ
BAPI_ALM_ORDER_OPERATION
NO_OF_TIME_
TICKETS
LOART
BAPI_ALM_ORDER_OPERATION
WAGETYPE
QUALF
BAPI_ALM_ORDER_OPERATION
SUITABILITY
LOGRP
BAPI_ALM_ORDER_OPERATION
WAGEGROUP
SORTL
BAPI_ALM_ORDER_OPERATION
SORT_FLD
LIFNR
BAPI_ALM_ORDER_OPERATION
VENDOR_NO
BMSCH
BAPI_ALM_ORDER_OPERATION
QUANTITY
Copyright © 2017 General Electric Company. All rights reserved. • Page 438 of 495
Overview of APM Connect
MEINH
BAPI_ALM_ORDER_OPERATION
BASE_UOM
PREIS
BAPI_ALM_ORDER_OPERATION
PRICE
PEINH
BAPI_ALM_ORDER_OPERATION
PRICE_UNIT
SAKTO
BAPI_ALM_ORDER_OPERATION
COST_ELEMENT
WAERS
BAPI_ALM_ORDER_OPERATION
CURRENCY
INFNR
BAPI_ALM_ORDER_OPERATION
INFO_REC
EKORG
BAPI_ALM_ORDER_OPERATION
PURCH_ORG
EKGRP
BAPI_ALM_ORDER_OPERATION
PUR_GROUP
MATKL
BAPI_ALM_ORDER_OPERATION
MATL_GROUP
ANZZL
BAPI_ALM_ORDER_OPERATION
NUMBR_OF_
CAPACITIES
PRZNT
BAPI_ALM_ORDER_OPERATION
PERCENT_OF_
WORK
INDET
BAPI_ALM_ORDER_OPERATION
CALC_KEY
LARNT
BAPI_ALM_ORDER_OPERATION
ACTTYPE
ANLZU
BAPI_ALM_ORDER_OPERATION
SYSTCOND
ISTRU
BAPI_ALM_ORDER_OPERATION
ASSEMBLY
VERTN
BAPI_ALM_ORDER_OPERATION
INT_DISTR
PLIFZ
BAPI_ALM_ORDER_OPERATION
PLND_DELRY
DAUNO
BAPI_ALM_ORDER_OPERATION
DURATION_
NORMAL
DAUNE
BAPI_ALM_ORDER_OPERATION
DURATION_
NORMAL_UNIT
EINSA
BAPI_ALM_ORDER_OPERATION
CONSTRAINT_
TYPE_START
EINSE
BAPI_ALM_ORDER_OPERATION
CONSTRAINT_
TYPE_FINISH
ARBEI
BAPI_ALM_ORDER_OPERATION
WORK_ACTIVITY
ARBEH
BAPI_ALM_ORDER_OPERATION
UN_WORK
AUFKT
BAPI_ALM_ORDER_OPERATION
EXECFACTOR
Copyright © 2017 General Electric Company. All rights reserved. • Page 439 of 495
Overview of APM Connect
SLWID
BAPI_ALM_ORDER_OPERATION
FIELD_KEY
USR00
BAPI_ALM_ORDER_OPERATION
USR00
USR01
BAPI_ALM_ORDER_OPERATION
USR01
USR02
BAPI_ALM_ORDER_OPERATION
USR02
USR03
BAPI_ALM_ORDER_OPERATION
USR03
USR04
BAPI_ALM_ORDER_OPERATION
USR04
USR05
BAPI_ALM_ORDER_OPERATION
USR05
USE05
BAPI_ALM_ORDER_OPERATION
USE05
USR06
BAPI_ALM_ORDER_OPERATION
USR06
USE06
BAPI_ALM_ORDER_OPERATION
USE06
USR08
BAPI_ALM_ORDER_OPERATION
USR08
USR09
BAPI_ALM_ORDER_OPERATION
USR09
USR10
BAPI_ALM_ORDER_OPERATION
USR10
USR11
BAPI_ALM_ORDER_OPERATION
USR11
Copyright © 2017 General Electric Company. All rights reserved. • Page 440 of 495
Overview of APM Connect
Overview of the Maximo Adapters
The APM Connect Maximo Adapters allow you to extract, transform, and load data
between your Maximo system and your GE Digital APM system.
Copyright © 2017 General Electric Company. All rights reserved. • Page 441 of 495
Overview of APM Connect
Create Maximo Work Orders or Service Requests
ŗIMPORTANT: You can only create either a Work Order or a Service Request in Maximo from GE Digital APM. You can not create both at the same time, so you must configure the context file to designate which to create.
Note: The following instructions assume that the Create Work Request field exists
on the baseline datasheets for the supported Recommendation families. This field
exists on the default datasheets in the baseline GE Digital APM database, so these
instructions assume that they have not been removed by an administrative user.
Steps
1. Create a new or open an existing Recommendation record .
2. If the Recommendation records is not already linked to the Equipment or Functional Location record that represents the equipment or location for which you
want to create a Maximo Work Order, link the records.
3. Select the appropriate datasheet for the Recommendation record.
4. Enter values into the fields as desired to provide information about the recommended action.
Note: The value in the Target Completion Date field must be a date other than
the current date.
5. Select the Create Work Request?.
6. Select dž.
The record is saved.
Results
After you save the recommendation record the following occurs:
1. A Work Order or Service Request is created in the Maximo system.
2. The Work Request Reference field is populated with the ID of the corresponding
Work Order or Service Request.
3. After the Work Request Reference field is populated, the Create Work Request
field becomes disabled.
Note: If a Work Order could not be created for any reason, a message appears,
describing the problem. You will be unable to save the Recommendation record until
you clear the Create Work Request? check box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 442 of 495
Overview of APM Connect
About Extracting Data From Maximo
The extraction adapters allow you to extract data from your Maximo system and import
it into your GE Digital APM system. To execute an adapter, you must configure the
appropriate parameters in the context file. After the context file is configured, you must
run the Adapter job in the APM Connect Administration Center, and then your data is
extracted, transformed, and loaded into GE Digital APM.
There are four jobs that can be used to extract data from Maximo and load data into
GE Digital APM.
l
l
l
l
Maximo_Asset: Loads Maximo Asset records to GE Digital APM as Equipment
records.
Maximo_Location: Loads Maximo Location records to GE Digital APM as Functional Location records.
Maximo_WorkHistory: Loads Maximo Work Order records, Service Request
records, and failure records as GE Digital APM Work History and Work History
Detail records.
Maximo_Master_Interface: Can be used as a wrapper job to run all of the extraction jobs simultaneously.
As a GE Digital APM user, after the adapter job runs, you can use standard GE Digital
APM tools (e.g., Search Tool) to access the records that were created automatically.
Details: Extracting Equipment Data
When the Equipment job is run, for each asset in the Maximo system that meets the criteria defined in context file, a corresponding Equipment record will be created in
GE Digital APM database. In addition, if that Maximo asset has a parent asset or location, GE Digital APM Equipment record will be linked automatically to a parent record
belonging to the Equipment family or the Functional Location family, as appropriate.
Note: If an asset is deleted in the Maximo system after an Equipment record has
already been created for it in the GE Digital APM system, rerunning the Equipment
Adapter job will not delete the GE Digital APM Equipment record.
Details: Extracting Functional Location Data
When the Functional Location Adapter job is run, for each location in the Maximo system that meets the criteria defined in the context file, a corresponding Functional Location record will be created in the GE Digital APM database. In addition, if that Maximo
location has a parent asset or location, the GE Digital APM Functional Location record
will be linked automatically to a parent record belonging to the Equipment family or the
Functional Location family, as appropriate.
Copyright © 2017 General Electric Company. All rights reserved. • Page 443 of 495
Overview of APM Connect
Note: The Functional Location Extraction Interface will not extract locations of the
type COURIER or LABOR. Additionally, store room functional locations are not extracted.
Note: If an asset is deleted in the Maximo system after a Functional Location record
has already been created for it in the GE Digital APM system, rerunning the Functional
Location Extraction Interface will not delete the GE Digital APM Functional Location
record.
Details: Extracting Work Orders
When the Work History Job is run, for each Work Order in the Maximo system that
meets the criteria defined in the scheduled item, a corresponding Work History record
will be created in the GE Digital APM database. Each Work History record will be linked
to one Equipment or Functional Location record identifying the asset or location against
which the Maximo Work Order is written.
If the Work Order is written against a location, the Work History record will be linked to
a Functional Location record, and the Location ID field in the Work History record will
be populated automatically with the Location ID of that Maximo location.
If the Work Order is written against an asset, the Work History record will be linked to
an Equipment record, and the Equipment ID field in the Work History record will be populated automatically with the Location ID of that Maximo asset. In addition, if that Maximo asset has a parent location, the Work History record will also be linked to a
Functional Location record representing that parent Maximo location. The Location ID
field in the Work History record will also be populated automatically with the Location
ID of that parent Maximo location.
Details: Extracting Service Requests
When the Work History Job is run, for each Service Request in the Maximo system that
meets the criteria defined in the scheduled item, a corresponding Work History record
will be created in the GE Digital APM database. Each Work History record will be linked
to one Equipment or Functional Location record identifying the asset or functional location against which the Maximo Service Request is written. Specifically:
If the Service Request is written against a location, the Work History record will be linked
to a Functional Location record, and the Location ID field in the Work History record will
be populated automatically with the Location ID of that Maximo location.
If the Service Request is written against an asset, the Work History record will be linked
to an Equipment record, and the Equipment ID field in the Work History record will be
populated automatically with the Location ID of that Maximo asset. In addition, if that
Copyright © 2017 General Electric Company. All rights reserved. • Page 444 of 495
Overview of APM Connect
Maximo asset has a parent location, the Work History record will also be linked to a
Functional Location record representing that parent Maximo location. The Location ID
field in the Work History record will also be populated automatically with the Location
ID of that parent Maximo location.
Details: Extracting Work History Details
When the Work History Job is run Work Order and Service Request failure information is
extracted from your Maximo system into your GE Digital APM system as Work History
Detail records.
Note: If a Work Order does not have any failure information, a Work History Detail
record will not be created.
Copyright © 2017 General Electric Company. All rights reserved. • Page 445 of 495
Overview of APM Connect
Reference Information: Maximo Adapters
This topic provides a listing of all detailed reference information provided for the Maximo Adapters, such as command syntax, specifications, and table/field descriptions.
Copyright © 2017 General Electric Company. All rights reserved. • Page 446 of 495
Overview of APM Connect
Maximo Data Model
The following diagram shows how the families used by the Maximo Adapter are related
to one another.
Note: In the diagram, boxes represent entity families and arrows represent relationship families that are configured in the baseline database. You can determine the
direction of each relationship definition from the direction of the arrow head: the box
from which the arrow originates is the predecessor, and the box to which the arrow
head points is the successor.
The GE Digital APM Maximo Interfaces feature consists of entity families, relationship
families, and business rules. When attempting to understand and make use of the
GE Digital APM Maximo Interfaces functionality, it can be helpful to visualize the Maximo Interfaces data model. You can use the Maximo Interfaces to create and view
records. This documentation assumes that you are familiar with the concept of records
and viewing records in the GE Digital APM Record Manager.
About Interface Log Records used by the Service Request and
Work Order Interface Record
Each time an interface is run, an Interface Log record is created automatically to store
information about the process, such as the status of the process (e.g., Completed with
Copyright © 2017 General Electric Company. All rights reserved. • Page 447 of 495
Overview of APM Connect
warnings), the date the interface was run, and the parameters that were used to run the
interface.
If the value in an Interface Log record is Completed with Warnings or Completed with
Errors, a Super User or a member of the MI CMMS Interfaces Administrator Security
Group can review the warnings or errors, and then change the status to Completed with
Warnings (Cleared) or Completed with Errors (Cleared).
Copyright © 2017 General Electric Company. All rights reserved. • Page 448 of 495
Overview of APM Connect
Maximo Values Mapped to GE Digital APM Records
This topic provides a listing of all mapping information provided for the Maximo
Adapters.
Copyright © 2017 General Electric Company. All rights reserved. • Page 449 of 495
Overview of APM Connect
Maximo Equipment Mappings
The following table contains a list of Maximo fields that populate the fields in the Equipment records created in GE Digital APM when you use the Maximo Equipment Adapter:
GE Digital
APM
Family
ID
GE Digital
APM
Field
ID
MI_
EQUIP000
MI_
EQUIP000_SAP_
SYSTEM_C
GE Digital APM
Field Caption
Maximo
Table
Maximo
Internal ID
Maximo
Adapter
Label
Comments
CMMS
SYSTEM
Automatically
populated
by the
Maximo
System.
Automatically
populated by
the Maximo System.
Automatically
populated
by the
Maximo
System.
This is a
GE Digital APM
key field.
MI_
EQUIP000
MI_
EQUIP000_
CHANGE_DATE_
D
CMMS
Last
Changed
Date
ASSET
CHANGEDATE
Changed
Date
None
MI_
EQUIP000
MI_
EQUIP000_
CRITI_
IND_C
Criticality
Indicator
ASSET
PRIORITY
Priority
None
MI_
EQUIP000
MI_
EQUIP000_
EQUIP_
ID_C
Equipment ID
Asset
This is a
GE Digital APM
key field.
MI_
EQUIP000
MI_
EQUIP000_
EQUIP_
LNG_
DESC_T
Equipment
Long
Description
ASSET
ASSETNUM
ASSET
On the
Maximo
interface,
DESCRIPTION_
this value
LONGDESCRIPTNone
appears in
ION
the Long
Description box.
Copyright © 2017 General Electric Company. All rights reserved. • Page 450 of 495
Overview of APM Connect
GE Digital
APM
Family
ID
GE Digital
APM
Field
ID
GE Digital APM
Field Caption
Maximo
Table
Maximo
Internal ID
Maximo
Adapter
Label
SERIALNUM
Manufacturer
Serial
Number
DESCRIPTION
On the
Maximo
interface,
this value
None
appears
next to
the Asset box.
Comments
MI_
EQUIP000
EquipMI_
ment
EQUIP0Serial
00_SN_C
Number
MI_
EQUIP000
MI_
EQUIP000_
EQUIP_
SHRT_
DESC_C
Equipment
Short
Description
MI_
EQUIP000
MI_
EQUIP000_
EQUIP_
TECH_
NBR_C
Equipment TechASSET
nical
Number
ASSETID
MI_
EQUIP000
MI_
EQUIP000_
EQUIP_
VNDR_C
Equipment
Vendor
VENDOR
Vendor
None
MI_
EQUIP000
MI_
EQUIP0- Functional
ASSET
00_FNC_ Location
LOC_C
LOCATION
Location
None
MI_
EQUIP000
MI_
EQUIP000_INV_
NO_C
ITEMNUM
Rotating
Item
None
Inventory
Number
ASSET
ASSET
ASSET
ASSET
None
None. This
field does
not
None
appear on
the Maximo interface.
Copyright © 2017 General Electric Company. All rights reserved. • Page 451 of 495
Overview of APM Connect
GE Digital
APM
Family
ID
GE Digital
APM
Field
ID
MI_
EQUIP000
MI_
EQUIP000_
MFR_C
Manufacturer
ASSET
MANUFACTURE- ManR
ufacturer
None
MI_
EQUIP000
MI_
EQUIP000_OBJ_
TYP_C
Object
Type
ASSET
ASSETTYPE
Type of
Technical
Object
None
MI_
EQUIP000
MI_
EQUIP000_
PRCH_D
Purchase
Date
ASSET
INSTALLDATE
Installation Date
None
MI_
EQUIP000
MI_
EQUIP0Site
00_SITE_
C
ASSET
SITEID
Site
None
MI_
EQUIP000
MI_
EQUIP000_SYS_
ST_C
ASSET
STATUS
Status
None
MI_
EQUIP000
MI_
EQUIP000_
WRNTY_
EXPR_D
WARRANTYEXPDATE
None. This
field does
not
appear on None
the Maximo interface.
GE Digital APM
Field Caption
System
Status
Warranty
Expiration
Date
Maximo
Table
ASSET
Maximo
Internal ID
Maximo
Adapter
Label
Comments
Copyright © 2017 General Electric Company. All rights reserved. • Page 452 of 495
Overview of APM Connect
Maximo Functional Location Mappings
The following table lists the Maximo fields that are used to populate the fields in the
Functional Location records created in GE Digital APM when you use the Maximo Functional Location Adapter:
GE Digital
APM
Family
ID
GE Digital APM
Field ID
GE Digital APM
Field
Caption
MI_
FNCLOCMI_
00_
FNCLOCCHANG00
E_DATE_
D
CMMS
Last
Changed
Date
MAXIMO
Table
Maximo
Internal ID
Maximo
Adapter
Label
Comments
CHANGEDATE
None. This
field does
not appear
None
on the
Maximo
interface.
LOCATION
DESCRIPTION
On the
Maximo
interface,
this value
appears
next to
the Location box.
LOCATION
MI_
MI_
FNCLOCFNCLOC- 00_FNC_
00
LOC_
DESC_C
Functional
Location
Description
MI_
FNCLOCMI_
00_FNC_
FNCLOCLOC_
00
LNG_
DESC_C
Functional
Location
Long
Description
LOCATION
This value
DESCRIPTION_
appears in
LONGDESCRIPT- the Long
ION
Description box.
MI_
MI_
FNCLOCFNCLOC00_FAIL_
00
CLASS_C
Failure
Class
LOCATION
FAILURECODE
MI_
MI_
FNCLOCFNCLOC00_FNC_
00
LOC_C
Functional
Location
LOCATION
LOCATION
None
None
Failure
Class
None
Location
This is a
GE Digital APM key
field.
Copyright © 2017 General Electric Company. All rights reserved. • Page 453 of 495
Overview of APM Connect
GE Digital
APM
Family
ID
GE Digital APM
Field ID
GE Digital APM
Field
Caption
MAXIMO
Table
Maximo
Internal ID
Maximo
Adapter
Label
Comments
MI_
MI_
FNCLOCFNCLOC- 00_
00
INTERNAL_ID_C
Functional
Location
Internal
ID
LOCATION
LOCATIONSID
None. This
field does
not appear
None
on the
Maximo
interface.
MI_
MI_
FNCLOCFNCLOC- 00_
00
CRTCAL_
IND_C
Criticality
LOCATION
Indicator
LOCPRIORITY
Priority
None
MI_
FNCLOCMI_
00_
FNCLOCSUPR_
00
FNC_
LOC_C
Superior
Functional
Location
LOCATION
PARENT
Parent
None
MI_
MI_
FNCLOCFNCLOC00_SITE_
00
C
Site
LOCATION
SITEID
Site
None
MI_
MI_
FNCLOCFNCLOC- 00_SYS_
00
STATUS_
C
System
Status
LOCATION
STATUS
Status
None
MI_
MI_
FNCLOC- Location
FNCLOC00_TYPE_ Type
00
C
LOCATION
TYPE
Type
None
MI_
MI_
FNCLOCFNCLOC- 00_SAP_
00
SYSTEM_
C
Automatically
populated
by the Maximo System.
AutoAutomatically
matically
populated by
populated
the Maximo Sys- by the Maxtem.
imo System.
CMMS
System
This is a
GE Digital APM key
field.
Copyright © 2017 General Electric Company. All rights reserved. • Page 454 of 495
Overview of APM Connect
Maximo Work History Mappings
The following tables list the Maximo fields that are used to populate the fields in the
Work History records created in GE Digital APM when you extract Work Orders and Service Request using the Maximo Work History Adapter:
Values Mapped from Maximo Work Orders to GE Digital APM Work
History Records
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
Maximo
Table
Name
Maximo
Internal ID
Maximo
Interface
Label
WORKORDER
ACTFINISH
Actual Finish
None
MI_
MI_
EVWKHI- Actual
EVWKHI- ST_ACT_ Labor
ST
LABOR_ Cost
COST_N
WORKORDER
ACTLABCOST
Actual
Labor Cost
None
MI_
MI_
EVWKHIActual
EVWKHI- ST_ACT_
Labor
ST
LABOR_
TIME_N
WORKORDER
ACTLABHRS
Actual
Labor
Hours
None
MI_
MI_
EVWKHI- Actual
EVWKHI- ST_ACT_ Material
ST
MTRL_
Cost
COST_N
WORKORDER
ACTMATCOST
Actual
Material
Cost
None
MI_
EVWKHIMI_
ST_
EVWKHIMAINT_
ST
COMPL_
D
Maintenance
Completion
Date
Comments
Copyright © 2017 General Electric Company. All rights reserved. • Page 455 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
Maximo
Table
Name
Maximo
Internal ID
Maximo
Interface
Label
Comments
MI_
MI_
EVWKHIActual Ser- WORKOREVWKHI- ST_ACT_
vice Cost DER
ST
SERV_
COST_N
ACTSERVCOST
Actual Service Cost
MI_
MI_
EVWKHI- MainWORKOREVWKHI- ST_
tenance
DER
ST
MAINT_
Start Date
START_D
ACTSTART
Actual Start None
MI_
MI_
EVWKHIActual
EVWKHI- ST_ACT_
Tool Cost
ST
TOOL_
COST_N
WORKORDER
ACTTOOLCOST
Actual Tool
Cost
None
MI_
MI_
EVWKHI- MainEVWKHI- ST_
tenance
ST
MAINT_
Cost
CST_N
WORKORDER
ACTTOTALCOST
Actual
Total Cost
None
MI_
EVWKHIMI_
ST_EQU_
EVWKHILOC_
ST
PRIORTY_N
Equipment
Location
Priority
WORKORDER
Asset/LocaASSETLOCPRIOtion PriNone
RITY
ority
MI_
MI_
EVENT_
EVWKHIASST_
ST
ID_CHR
Equipment ID
WORKORDER
ASSETNUM
Asset
None
None
Copyright © 2017 General Electric Company. All rights reserved. • Page 456 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
Maximo
Table
Name
Maximo
Internal ID
Maximo
Interface
Label
Comments
MI_
EVWKHIMI_
CalST_
EVWKHIculated
CALC_
ST
Priority
PRIORTY_N
WORKORDER
CALCPRIORITY
Asset/Location PriNone
ority
MI_
MI_
EVENT_
Modified
EVWKHIMODFD_ By
ST
BY_CHR
WORKORDER
CHANGEBY
Modified
By
MI_
EVWKHIMI_
ST_
EVWKHIORDR_
ST
CHNG_
DT_D
None
Order
Last
Change
Date
WORKORDER
CHANGEDATE
None. This
field does
not appear
None
on the Maximo interface.
MI_
MI_
EVWKHIEVWKHI- ST_
Crew ID
ST
CREW_
ID_C
WORKORDER
CREWID
Crew
MI_
MI_
EVWKHI- Order
EVWKHI- ST_
DescripST
ORDR_
tion
DESC_C
WORKORDER
DESCRIPTION
Description None
None
Copyright © 2017 General Electric Company. All rights reserved. • Page 457 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
MI_
MI_
EVENT_
EVWKHI- SHRT_
ST
DSC_
CHR
Event
Short
Description
MI_
MI_
EVENT_
EVWKHILNG_
ST
DSC_TX
Event
Long
Description
Maximo
Table
Name
Maximo
Internal ID
Maximo
Interface
Label
Comments
WORKORDER
DESCRIPTION
Description None
WORKORDER
DESCRIPTION_
LONGDESCRIPTION
This value
appears in
the Long
Description box.
None
ESTLABCOST
Estimated
Labor Cost
None
ESTLABHRS
Estimated
Labor
Hours
None
ESTMATCOST
Estimated
Material
Cost
None
ESTSERVCOST
Estimated
Service
Cost
None
MI_
MI_
EVWKHI- Estimated
WORKOREVWKHI- ST_EST_ Labor
DER
ST
LABOR_ Cost
COST_N
MI_
MI_
EVWKHIEstimated WORKOREVWKHI- ST_EST_
Labor
DER
ST
LABOR_
TIME_N
MI_
MI_
EVWKHI- Estimated
WORKOREVWKHI- ST_EST_ Material
DER
ST
MTRL_
Cost
COST_N
MI_
MI_
EVWKHI- Estimated
WORKOREVWKHI- ST_EST_ Service
DER
ST
SERV_
Cost
COST_N
Copyright © 2017 General Electric Company. All rights reserved. • Page 458 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
Maximo
Table
Name
MI_
MI_
EVWKHIEstimated WORKOREVWKHI- ST_EST_
Tool Cost DER
ST
TOOL_
COST_N
MI_
EVWKHIMI_
ST_
EVWKHIORDR_
ST
MAINT_
PLAN_C
Order
Maintenance
Plan
MI_
EVWKHIMI_
ST_
EVWKHIORDR_
ST
PRTY_
DESC_C
Order Priority
WORKORDescripDER
tion
WORKORDER
Maximo
Internal ID
Maximo
Interface
Label
Comments
ESTTOOLCOST
Estimated
Tool Cost
JPNUM
None. This
field does
not appear
None
on the Maximo interface.
None
JUSTIFYPRIORIT- Priority JusNone
Y
tification
MI_
MI_
EVWKHILead
EVWKHI- ST_
Craft
ST
LEAD_
CRAFT_C
WORKORDER
LEAD
Lead
None
MI_
MI_
EVENT_
EVWKHILOC_ID_
ST
CHR
WORKORDER
LOCATION
Location
None
Location
ID
Copyright © 2017 General Electric Company. All rights reserved. • Page 459 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
Maximo
Table
Name
MI_
EVWKHIMI_
ST_ACT_
EVWKHIOUT_
ST
LBR_
CST_N
Actual
Outside
Labor
Cost
WORKORDER
MI_
EVWKHIMI_
ST_ACT_
EVWKHIOUT_
ST
MTR_
CST_N
Actual
Outside
Material
Cost
MI_
MI_
EVWKHI- Actual
EVWKHI- ST_ACT_ Outside
ST
OUT_TL_ Tool Cost
CST_N
MI_
MI_
EVWKHI- PM NumEVWKHIST_PM_
ber
ST
NBR_C
MI_
MI_
EVWKHIRequest
EVWKHI- ST_
ID
ST
RQST_
ID_C
Maximo
Internal ID
Maximo
Interface
Label
Comments
OUTLABCOST
Outside
Labor Cost
None
WORKORDER
OUTMATCOST
Outside
Material
Cost
None
WORKORDER
OUTTOOLCOST
Outside
Tool Cost
None
WORKORDER
PMNUM
None. This
field does
not appear
None
on the Maximo interface.
WORKORDER
None. This
field does
not appear
ORIGRECORDID
None
on the Maximo interface.
Copyright © 2017 General Electric Company. All rights reserved. • Page 460 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
MI_
EVWKHIMI_
Request
ST_
EVWKHIType
RQST_
ST
Code
TYP_CD_
C
Maximo
Table
Name
WORKORDER
Maximo
Internal ID
Maximo
Interface
Label
Comments
None. This
field does
ORIGRECORDC- not appear
None
LASS
on the Maximo interface.
MI_
MI_
EVWKHI- EVENT_
ST
STRT_DT
Event
WORKORStart Date DER
REPORTDATE
Reported
Date
None
MI_
EVWKHIMI_
ST_
EVWKHISCHED_
ST
COMPL_
D
Scheduled Com- WORKORpletion
DER
Date
SCHEDFINISH
Scheduled
Finish
None
MI_
MI_
EVWKHI- SchedEVWKHI- ST_
uled Start
ST
SCHED_ Date
START_D
WORKORDER
SCHEDSTART
Scheduled
Start
None
MI_
MI_
EVWKHIEVWKHISite
ST_SITE_
ST
C
WORKORDER
SITEID
Site
None
STATUS
Status
None
MI_
EVWKHIMI_
Order SysST_
WORKOREVWKHItem
ORDR_
DER
ST
Status
SYS_
STAT_C
Copyright © 2017 General Electric Company. All rights reserved. • Page 461 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
MI_
EVWKHIMI_
ST_
EVWKHITARGET_
ST
COMPL_
D
GE Digital APM
Work History Field
Caption
Target
Completion
Date
Maximo
Table
Name
WORKORDER
Maximo
Internal ID
Maximo
Interface
Label
Comments
TARGCOMPDATE
Target Finish
MI_
MI_
EVWKHITarget
WORKOREVWKHI- ST_
Start Date DER
ST
TARGET_
START_D
TARGSTARTDATE
None. This
field does
not appear
None
on the Maximo interface.
MI_
MI_
EVWKHI- EVENT_
ST
ID
None
Event ID
WORKORDER
WONUM
Work
Order
None
MI_
MI_
EVWKHIEVWKHI- ST_
Order ID
ST
ORDER_
ID_N
WORKORDER
WONUM
Work
Order
None
WOPRIORITY
Priority
None
MI_
MI_
EVWKHIOrder Pri- WORKOREVWKHI- ST_
ority
DER
ST
ORDR_
PRTY_C
Copyright © 2017 General Electric Company. All rights reserved. • Page 462 of 495
Overview of APM Connect
GE Digital
APM
Family
Name
GE Digital APM
Work
History
Field ID
GE Digital APM
Work History Field
Caption
MI_
EVWKHIMI_
Order
ST_
EVWKHIType
ORDR_
ST
Code
TYP_CD_
C
Maximo
Table
Name
WORKORDER
Maximo
Internal ID
Maximo
Interface
Label
Comments
WORKTYPE
None. This
field does
not appear
None
on the Maximo interface.
MI_
EVWKHIMI_
ST_
Object
EVWKHIOBJECT_ Number
ST
NUMBER_C
WORKORDER
"OR"+WONUM
This field
None. This appears
field does
as a
not appear dropon the Max- down list
imo interbox in
face.
GE Digital APM.
MI_
MI_
EVWKHICMMS SysEVWKHI- ST_SAP_
tem
ST
SYSTEM_
C
Automatically
populated
by the
Maximo
System.
Automatically
populated by
the Maximo
System.
Automatically
populated
by the Maximo System.
This is a
GE Digital APM
key field.
Values Mapped from Maximo Service Request to GE Digital APM
Work History Records
GE Digital APM
Family
GE Digital APM
Work
History
Field ID
GE Digital APM
Work
History
Field
Caption
Maximo
Table
Maximo
Internal ID
Maximo
Interface
Label
Comments
Copyright © 2017 General Electric Company. All rights reserved. • Page 463 of 495
Overview of APM Connect
MI_
MI_
EVENT_
EVWKHISASST_ID_
T
CHR
Equipment ID
SR
ASSETNUM
Asset
None
MI_
MI_
EVENT_
EVWKHISSHRT_
T
DSC_CHR
Event
Short
Description
SR
DESCRIPTION
Summary
None
MI_
MI_
EVENT_
EVWKHISLOC_ID_
T
CHR
Location
ID
SR
LOCATION
Location
None
SR
SITEID
Site
None
SR
"QM"+TICKETID
None. This
field does
not appear
on the Maximo interface.
This is a
GE Digital
APM key
field.
MI_
EVWKHISMI_
T_RQST_ Change
EVWKHISID_
Date
T
CHNG_
DT_D
SR
None. This
field does
CHANGEDAT- not appear
None
E
on the Maximo interface.
MI_
MI_
EVWKHIS- Request
EVWKHIST_RQST_ ID
T
ID_C
SR
TICKETID
MI_
MI_
EVWKHIS- EVWKHIS- Site
T
T_SITE_C
MI_
EVWKHISMI_
T_
OBJECT
EVWKHISOBJECT_
NUMBER
T
NUMBER_C
Service
Request
None
Copyright © 2017 General Electric Company. All rights reserved. • Page 464 of 495
Overview of APM Connect
MI_
MI_
EVWKHISCMMS
EVWKHIS- T_SAP_
System
T
SYSTEM_
C
Automatically
populated
by the Maximo System.
Automatically
populated
by the Maximo System.
Automatically
populated
by the Maximo System.
This is a
GE Digital
APM key
field.
Copyright © 2017 General Electric Company. All rights reserved. • Page 465 of 495
Overview of APM Connect
Maximo Work History Detail Mappings
The following tables list the Maximo fields that are used to populate the fields in the
Work History Details records created in GE Digital APM when you extract Work Order
information and Service Request information using the Maximo Work History Adapter:
Values Mapped from Maximo Work History Details to GE Digital
APM Work History Detail Records
GE Digital
APM
Family
GE Digital APM
Work
History
Field ID
GE Digital APM
Work
History
Field
Caption
MI_
MI_
DTWKHI- EquipDTWKHIST_ASST_ ment ID
ST
ID_C
Maximo
Table
Maximo
Internal ID
WORKORDASSETNUM
ER
Maximo
Interface
Label
Comments
Asset
None
Description
None
MI_
DTWKHIMI_
ST_
DTWKHIEVNT_
ST
DTL_
DESC_C
Work History
WORKORDDetail
DESCRIPTION
ER
Description
MI_
MI_
DTWKHIDTWKHIST_DTL_
ST
NARTV_T
This value
DESCRIPTION_
appears in
Detail
WORKORDLONGDESCRIPT- the Long
Narrative ER
ION
Description box.
None
MI_
MI_
DTWKHIDTWKHIST_LOC_
ST
ID_C
Location
ID
None
WORKORDLOCATION
ER
Location
Copyright © 2017 General Electric Company. All rights reserved. • Page 466 of 495
Overview of APM Connect
MI_
MI_
DTWKHIDTWKHI- ST_
ST
CNDTN_
CD_C
Condition
Code
WORKORDProblem
PROBLEMCODE
ER
Code
None
MI_
MI_
DTWKHIDTWKHIST_SITE_
ST
C
Site
WORKORDSITEID
ER
Site
None
MI_
MI_
DTWKHIDTWKHI- ST_WRK_
ST
HISTRY_
ID_C
Work His- WORKORDWONUM
tory ID
ER
Work
Order
None
MI_
MI_
DTWKHIDTWKHI- ST_
ST
ORDR_
ID_C
Order ID
WORKORDWONUM
ER
Work
Order
None
MI_
DTWKHIMI_
ST_
DTWKHIEVNT_
ST
DTL_ID_
C
History
Detail ID
WORKORDWONUM
ER
Work
Order
This is a
GE Digital APM key
field.
CMMS
System
Automatically
populated
by the Maximo System.
Automatically
populated
by the Maximo System.
This is a
GE Digital APM key
field.
MI_
MI_
DTWKHIDTWKHI- ST_SAP_
ST
SYSTEM_
C
Automatically
populated by
the Maximo System.
Values Mapped from Maximo Service Request Details to GE Digital
APM Work History Detail Records
Copyright © 2017 General Electric Company. All rights reserved. • Page 467 of 495
Overview of APM Connect
GE Digital APM
Family
GE Digital APM
Work
History
Field ID
GE Digital APM
Work
History
Field
Caption
MI_
DTWKHIST
MI_
DTWKHIS- EquipT_ASST_
ment ID
ID_C
MI_
DTWKHIST
MI_
DTWKHIST_EVNT_
DTL_
DESC_C
MI_
DTWKHIST
MI_
DTWKHIS- Location
T_LOC_
ID
ID_C
MI_
DTWKHIST
Maximo
Table
Maximo
Internal ID
Maximo
Interface
Label
Comments
SR
ASSETNUM
Asset
None
Work History
Detail
SR
Description
DESCRIPTION
Summary
None
SR
LOCATION
Location
None
MI_
DTWKHIS- Site
T_SITE_C
SR
SITEID
Site ID
None
MI_
DTWKHIST
MI_
DTWKHIS- Request
T_RQST_
ID
ID_C
SR
TICKETID
Service
Request
None
MI_
DTWKHIST
MI_
DTWKHIS- History
T_EVNT_
Detail ID
DTL_ID_C
SR
TICKETID
Service
Request
This is a
GE Digital
APM key
field.
MI_
DTWKHIS- CMMS
T_SAP_
System
SYSTEM_C
Automatically
populated
by the Maximo System.
Automatically
populated
by the Maximo System.
Automatically
populated
by the Maximo System.
This is a
GE Digital
APM key
field.
MI_
DTWKHIST
Copyright © 2017 General Electric Company. All rights reserved. • Page 468 of 495
Overview of APM Connect
Copyright © 2017 General Electric Company. All rights reserved. • Page 469 of 495
Overview of APM Connect
Maximo Recommendation Mappings
The following tables contain a list of GE Digital APM Recommendation fields that are
used to populate Maximo Work Orders and Service Requests when you use the Maximo
Notification Management Adapter:
Values Mapped to Maximo Work Order from GE Digital APM
Recommendation
GE Digital APM
Family
GE Digital APM Field
Maximo Object
Structure
Maximo Field
MI_REC
MI_REC_ASSET_ID_CHR
WORKORDER
ASSETNUM
MI_REC
MI_REC_SHORT_DESCR_
CHR
WORKORDER
DESCRIPTION
MI_REC
MI_REC_LONG_DESCR_TX
WORKORDER
DESCRIPTION_
LONG
MI_REC
MI_REC_LOC_ID_CHR
WORKORDER
LOCATION
MI_REC
MI_REC_SITE_C
WORKORDER
SITEID
MI_REC
MI_REC_TARGE_COMPL_
DATE_DT
WORKORDER
TARGCOMPDATE
CONSTANT
WORKORDER
WORKORDER
WOCLASS
CONSTANT
PM
WORKORDER
WORKTYPE
CONSTANT
Add/Change
WORKORDER
@action
Values Mapped to Maximo Service Request from GE Digital APM
Recommendation
GE Digital APM
Family
GE Digital APM Field
Maximo Object
Structure
Maximo Field
MI_REC
MI_REC_ASSET_ID_CHR
SR
ASSETNUM
MI_REC
MI_REC_SHORT_DESCR_
CHR
SR
DESCRIPTION
Copyright © 2017 General Electric Company. All rights reserved. • Page 470 of 495
Overview of APM Connect
MI_REC
MI_REC_LONG_DESCR_TX
SR
DESCRIPTION_
LONG
MI_REC
MI_REC_LOC_ID_CHR
SR
LOCATION
MI_REC
MI_REC_SITE_C
SR
SITEID
MI_REC
MI_REC_TARGE_COMPL_
DATE_DT
SR
STATUSDATE
CONSTANT
SR
SR
CLASS
CONSTANT
Add/Change
SR
@action
Copyright © 2017 General Electric Company. All rights reserved. • Page 471 of 495
Overview of APM Connect
Manage Jobs in the Administration Center
This topic provides a list of all procedures related to running jobs in the APM Connect
Administration Center, as well as links to the related concept and reference topics.
Copyright © 2017 General Electric Company. All rights reserved. • Page 472 of 495
Overview of APM Connect
Schedule a Job
Using the APM Connect Administration Center, you can extract items from the
EAM source systems to create and update records in GE Digital APM. While you can run
a Job any time you want to extract new or updated items from the EAM source by executing a Run-Now Job, you will probably want to schedule the items to be extracted automatically based on the schedule parameters. This method ensures synchronization
between your EAM database and your GE Digital APM database. This topic describes
how to schedule a recurring Job in the APM Connect Administration Center.
Note: You cannot run two Jobs of the same kind at the same time. For example, you
cannot run two Equipment Jobs at the same time.
Before You Begin
Before you can schedule a Job, you must complete the following:
l
Ensure that a Job is imported in the Job Conductor.
l
Apply the filter parameters for the Job you want to execute in the context file.
Steps
1. From the Menu pane, in the Conductor section, select Job Conductor.
The Job Conductor pane appears, displaying the Jobs that can be executed.
2. Select the Job you want to schedule.
Note: If the Job you want to execute is not in the workspace, you must import
the Job into the Job Conductor.
3. At the bottom of the Job Conductor workspace, select Triggers.
The Triggers section appears.
4. In the Triggers section, select Add trigger.
A drop-down menu appears, displaying the options for the types of triggers you
can add.
Copyright © 2017 General Electric Company. All rights reserved. • Page 473 of 495
Overview of APM Connect
The following trigger is applicable to APM Connect data extractions:
l
CRON trigger: A time-based trigger that generates the Job and executes it
multiple times at a specified date and time. Cron Trigger is most widely used
because it allows the user to set the repetition of execution with more accuracy. For example, a Cron trigger can be set in such a way that it is executed
every 10 minutes starting from 10 A.M. to 11 A.M. on every Friday in January,
March, August, and December in the year 2015.
5. Select the Add CRON trigger button.
The Add CRON trigger section appears on the right side of the page.
6. Enter the trigger details using the following guidelines:
l
Label: Enter a name for the trigger.
l
Description: Enter a description for the trigger.
l
Time zone strategy: Select JobServer time.
l
l
l
l
l
l
Minutes: Enter the time interval (in minutes) after which the execution needs
to be repeated.
Hours: Enter the time (in hours) when the execution should begin.
Days of month: Enter the days of the month on which the Job should be
executed.
Months: Enter the months during which the Job should be executed.
Days of week: Enter the days of the week on which the Job should be
executed.
Years: Enter the year during which the Job should be executed.
7. Select Save.
The new trigger is created and appears in the Triggers section.
The Job is scheduled.
Copyright © 2017 General Electric Company. All rights reserved. • Page 474 of 495
Overview of APM Connect
Execute a Run-Now Job
While you can use the APM Connect Administration Center to schedule Jobs to run on a
recurring basis, you can run a previously scheduled Job at any time to extract new or
updated items. This topic describes how to execute a Run-Now Job.
ŗIMPORTANT: You cannot run two Jobs of the same kind at the same time. For
example, you cannot run two Equipment Jobs at the same time.
Steps
1. In the Job Conductor workspace, select the Scheduled Job that you want to run.
2. Select Run.
The Job is run.
Copyright © 2017 General Electric Company. All rights reserved. • Page 475 of 495
Overview of APM Connect
View the Execution Log
You can view the execution log for information about the Job execution such as its
status, ID, trigger type, and other details. The log also contains information about the
errors and warnings that occurred during the execution process. The execution details
are available for any Job that appears in the Job Conductor workspace. This topic
describes how to view the execution log.
Steps
1. In the Job Conductor workspace, select the
cution details you want to view.
button next to the Job whose exe-
The Task execution details window appears, displaying the details of the latest execution.
You can view three types of information in the Task execution details window:
l
l
l
In the Log section, view the sequence of execution, error messages, and
warning messages.
In the Context values section, view the values that were passed into the parameters of the executed Job.
In the Advanced Information section, view information about the executed
Job.
Copyright © 2017 General Electric Company. All rights reserved. • Page 476 of 495
Overview of APM Connect
Update Existing Jobs
Occasionally, changes will be made to the .zip files associated with an adapter Job.
When changes are made to the adapter through a .zip file, the existing Job must be
updated by reimporting the .zip file. This topic describes how to update an existing Job.
Steps
1. In the Job Conductor workspace, select the Job for which the file has been
updated.
2. On the Job Conductor toolbar, select Delete.
Note: If you do not delete the existing Job, the Job will not update properly,
and the Job cannot be executed.
3. On the Job Conductor toolbar, select Add.
The Execution task pane is activated.
4. In the Execution task pane, in the Label box, enter a label for the Job.
5. In the Description box, enter a description for the Job.
6. Select the Active check box.
7. In the Job section, select
.
The Import generated code window appears.
8. Select Browse to navigate to the file containing the adapter Jobs that have been
updated.
9. Select the appropriate file.
10. On the Import generated code window, select Launch upload.
11. The Project, Branch, Name, Version, and Context text boxes are automatically
populated with appropriate values.
12. In the Execution Server list, select the server on which the Job should be executed.
13. Select Save.
Copyright © 2017 General Electric Company. All rights reserved. • Page 477 of 495
Overview of APM Connect
The updated adapter Jobs are imported into the APM Connect Administration
Center.
Copyright © 2017 General Electric Company. All rights reserved. • Page 478 of 495
APM Connect Administrative Help
APM Connect Administrative Help
This topic provides a list of help topics related to the APM Connect administrative settings
Copyright © 2017 General Electric Company. All rights reserved. • Page 479 of 495
APM Connect Administrative Help
APM Connect EAM Jobs
The APM Connect EAM Jobs contains a result grid to access the details of the EAM SAP
Cloud jobs. Additionally, from the APM Connect EAM Jobs you can access the Interface
Log record for each SAP Cloud job.
Copyright © 2017 General Electric Company. All rights reserved. • Page 480 of 495
APM Connect Administrative Help
Access APM Connect EAM Jobs
Steps
1. Access Operations Manager , and then select APM Connect EAM Jobs.
The APM Connect EAM Jobs page appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 481 of 495
APM Connect Administrative Help
Access the Details of an EAM Job
You can view the details of EAM Adapter jobs such as status, time and date, and the associated interface log record.
Steps
1. Access the APM Connect EAM Jobs.
2. In the Status and Log column, view the status of each job.
ŒTip: If necessary, you can cancel an import job by selecting the Ź button that
appears in the Status and Log column. If you cancel a job, any changes that have
already occurred are not removed, therefore, you may need to manually modify
records to update or remove unnecessary data.
Status
Description
Waiting
Initial state when job is created. The data import job is queued
for pre-processing on the APM Connect Server.
Staging In Progress
The data import job is being prepared on the APM Connect
Server.
Staging Failure
The data import job failed during preparation.
Staging Complete
The data import job was prepared successfully.
Dataloader
Enqueued
The maximum number of data load jobs has been exceeded,
as determined in the APM Connect Connection Records, or
there is a job of the same type running. The data import will
begin once the other jobs are complete.
Configuring
Dataloader
The data import job is configuring the proper user roles and
arranging data processing for most efficient execution flow.
In Progress
The data import job is loading data into the GE Digital APM
Data Source.
Data Synchronization in
Progress
The data import job is synchronizing the loaded data and relationships across the APM Data Source.
Job Cancelling
The data import job is in the process of being canceled. This
occurs after you select Ź.
Copyright © 2017 General Electric Company. All rights reserved. • Page 482 of 495
APM Connect Administrative Help
Status
Description
The data import job was cancelled successfully.
Cancelled by
User
Note: When a job is cancelled, the data imported prior to
cancelling is not removed.
Errors
The data import is complete, but encountered one or more
errors. You can download the log file to view detailed error
messages.
Data has been imported into GE Digital APM.
Complete
Note: If the
icon appears, the data was imported with
warnings. You can download the log file to view detailed
warning messages.
3. In the Status and Log column, select Ɖ on the row corresponding to the EAM job
for which you want to access the log.
The log file is downloaded.
4. To access the Interface Log record for a specific job, in the Job ID column select
the job ID that you want to open.
The Record Manager page appears, displaying the datasheet for the selected job.
5. To view the information contained in the Log Text, select the  in the Log Text
box.
A window appears, displaying details about the job such as error messages, warnings concerning the data load, and general information regarding the data records
that were loaded.
Copyright © 2017 General Electric Company. All rights reserved. • Page 483 of 495
APM Connect Administrative Help
APM Connect
In the APM Connect section of Operations Manager, you can manage the connections
used by the APM Connect Adapters. The APM Connect Adapters facilitate data transfers
to and from GE Digital APM.
Copyright © 2017 General Electric Company. All rights reserved. • Page 484 of 495
APM Connect Administrative Help
Access the APM Connect Page
Steps
1. Access Operation Manager , then select Connections, and then select APM Connect.
The APM Connect workspace appears.
Copyright © 2017 General Electric Company. All rights reserved. • Page 485 of 495
APM Connect Administrative Help
Establish Connection from GE Digital APM
To load data into GE Digital APM using the APM Connect Data Loaders or the EAM
Adapters. You must establish the connection between your APM Connect component
and GE Digital APM.
Steps
1. Access the APM Connect page.
The APM Connect Configuration workspace appears.
2. In the APM Connect Configuration workspace, configure the parameters on the
APM Connect Connection record in the following sections.
l
General Settings: Established the connection between the APM Connect
server and GE Digital APM.
ŗIMPORTANT: The General Settings section must be configured if you
are using either the Data Loaders or the EAM adapters.
l
l
Data Loaders Settings: Stores the staging database parameters and the
remote file server settings.
EAM Settings: Used to schedule work orders, which determine how frequently work orders will be transferred to your SAP.
Note: These settings are only required for the SAP adapters.
3. Select Save.
The connection between APM Connect and GE Digital APM is established.
Copyright © 2017 General Electric Company. All rights reserved. • Page 486 of 495
APM Connect Administrative Help
Determine Logging Level
You can set the logging level that will determine the logging messages included in the
Data Loader log file.
Steps
1. Access the APM Connect page, and then select Data Loaders settings.
The Data Loaders Settings workspace appears.
2. In the Logging Level box, use the drop-down to select one of the following logging
levels:
l
l
Debug: The default logging level, and the highest level of logging. Selecting
debug will return the most details and is helpful when trying to debug the
application.
Info: Returns information message indicating the progress of the application, and is the second highest level of logging.
l
Warn: Returns warnings detected during the loading process.
l
Error: The lowest level of logging returning errors only.
Note: Logging levels are hierarchical. For example, if you select Info, you will
see all warnings and errors. If you select Error, you will only see errors.
3. Select Save.
The record is saved.
Results
l
Once the record is saved, subsequent data loads will return log files with the logging level you determined. The logging level will only apply to future data loads.
Meaning if you change the level from Error to Warn historic log files will not be
updated with more details. It will only apply to new data loads.
Copyright © 2017 General Electric Company. All rights reserved. • Page 487 of 495
APM Connect Administrative Help
Schedule Work Orders
Steps
1. Access the APM Connect page.
The APM Connect Configuration page appears.
2. Select EAM Settings.
The EAM Settings page appears.
3. In the Scheduling Properties section, select Edit Schedule.
Note: If there is a previously schedule item, a schedule summary will be displayed next to Edit Schedule. If there is no scheduled item, Not scheduled
appears next to the Edit Schedule button.
4. On the Edit Schedule window, select the Recurrence check box.
5. In the Time Zone box, select the appropriate time zone.
6. In the Start box, select  to schedule the start date and time.
a. Select one of the following as appropriate:
l
The current date: Select this option to use the current time and date
as the starting point.
l
Clear: Select this option to clear the current selection.
l
<Date>: Select this option to use the selected date as the start date.
b. Select đ, and then select the appropriate time.
c. Select Close.
7. In the Every section, in the interval box, enter the numeric value for how often you
want the generation to occur.
8. In the Every section, in the units box, select the interval unit (i.e., minutes, hours,
years, etc).
9. In the Every section, in the begin box, select one of the following:
l
l
From start time: Select this option to start the recurrence from the previously selected start time.
After last occurrence: Select this option to begin the generation after the
last time the job ran.
10. In the End box, based on when you want the recurrence to end, use the dropdown to select one of the following:
Copyright © 2017 General Electric Company. All rights reserved. • Page 488 of 495
APM Connect Administrative Help
l
l
l
Never: If you select this option, then the recurrence will not end.
After: If you select this option, then you will enter a number of occurrences
after which the generation will end.
Time & Date: Select this option to use the calendar to select a time and date
when the generation will end.
11. Select OK.
The schedule summary appears next to the Edit Schedule. Additionally, the scheduled item can be viewed in Operations Manager in Scheduling.
Copyright © 2017 General Electric Company. All rights reserved. • Page 489 of 495
APM Connect Administrative Help
APM Connect Connection Records
The APM Connect workspace stores information about connections used by APM Connect. Specifically, it manages the connection between GE Digital APM and APM Connect
components. This topic provides an alphabetical list and description of the fields that
exist in the APM Connect workspace. The information in the table reflects the baseline
state and behavior of these fields.
General Setting
Field
Application Server
Data
Type
String
Description
The name of your
GE Digital APM Server.
Behavior and Usage
Enter the name of your
GE Digital APM Server to
establish your connection to your APM
Connect Server.
This field is required.
The connection string is
a combination of the
APM Connect Connection parameters
APM_CONNECT_HOST
and APM_CONNECT_
PORT as defined in the
context file.
Connection String
String
The URL indicating the
APM Connect server host
and port used to connect
For example, if the host
GE Digital APM and the
was apmconnect and
APM Connect sever.
the port was 8040, the
connection string would
be http://apmconnect:8040/.
Note: This string is
used by the file SAP_
RFC_Connector.jar.
Copyright © 2017 General Electric Company. All rights reserved. • Page 490 of 495
APM Connect Administrative Help
Integration Server
String
The location of the
server where the Integration Services is
installed.
The number of Data
Maximum Concurrent
Loading jobs or EAM
Numeric
DL and EAM Jobs
jobs that can run at the
same time.
Password
Password
This field is required.
This field is required.
The default value is 1.
This means that only
one job can run at a
time. The maximum
value allowed is 5. When
the number of concurrent jobs is low, data
ingestion into GE Digital
APM is faster and the
system is less likely to
become overloaded.
Note: Two Data
Loaders of the same
type are not allowed
to run at the same
time. For example, if
you initiated two Taxonomy data loads at
the same time the
second job would not
begin loading until the
first is complete no
matter the value in the
field.
String
The password for the
APM Connect network.
This field is required
only if you are using network authentication.
String
The password of the
proxy server.
This field is required
only if you are using
proxy server authentication.
Copyright © 2017 General Electric Company. All rights reserved. • Page 491 of 495
APM Connect Administrative Help
The default value is
5432. This value must
match the value specified for the IR_PORT
parameter in the Context File.
String
The port number of the
PostgreSQL server.
Proxy Server
String
This field is required
The location of the proxy only if you are using
server.
proxy server authentication.
Timeout (ms)
The time in milliseconds
before the connection
between the APM ConNumeric
nect server and
GE Digital APM will
timeout.
The default value is
100,000 ms, and is populated automatically.
Boolean
Indicates whether or not
authorization will be
used.
If the check box is selected, then authentication
will be used, and you
must enter the network
user name and password.
Boolean
Indicates the whether or
not to use a proxy
server.
If the check box is selected, then the proxy
server will be used.
Boolean
Indicates whether or not
authentication will be
used to the proxy server.
If the check box is selected, then authentication
will be used for the
proxy server.
String
The user name for the
APM Connect network.
This field is required
only if you are using network authentication.
The user name for the
proxy server.
This field is required
only if you are using
proxy server authentication.
Port
Use Authentication
Use Proxy Server
Use Proxy Server
Authentication
Username
Username
String
Copyright © 2017 General Electric Company. All rights reserved. • Page 492 of 495
APM Connect Administrative Help
Data Loader Settings
Field
Data
Type
Description
Behavior and Usage
This field is required.
Base File Path
Database Name
Host Name
An example of a valid server
path is\\hostserver\share\subfolder. If an
invalid server path is
entered, an error message
will appear.
String
The path to the file
server.
String
The database name of the
Data Loader staging (IR)
None.
database.
String
The host name of the
Data Loaders staging (IR)
database.
None.
Copyright © 2017 General Electric Company. All rights reserved. • Page 493 of 495
APM Connect Administrative Help
The following logging levels
can be selected:
l
l
Logging Level
String
Determines the logging
level for the data loader
logs.
l
l
Debug: The default logging level, and the
highest level of logging. Selecting debug
will return the most
details and is helpful
when trying to debug
the application.
Info: Returns information message indicating the progress of
the application, and is
the second highest
level of logging.
Warn: Returns warnings detected during
the loading process.
Error: The lowest level
of logging returning
errors only.
Note: Logging levels are
hierarchical. For example,
if you select Info, you will
see all warnings and
errors. If you select Error,
you will only see errors.
Password
String
The Data Loader staging
database (IR) password.
None.
Password
String
The password of the file
server.
None.
Copyright © 2017 General Electric Company. All rights reserved. • Page 494 of 495
APM Connect Administrative Help
Boolean
Indicates whether or not
to use authentication
when accessing the file
server.
If selected, authentication
will be used for the file path.
UserName
String
The Data Loader staging
database (IR) user name.
None.
Username
String
The user name of the file
server.
None.
Use File Path
Authentication
EAM Settings
Field
Work Order Generation Schedule
Data
Type
Boolean
Description
Stores the scheduling mechanism for
transferring work orders to SAP.
Behavior and
Usage
To determine
the schedule,
you must
schedule work
orders.
Copyright © 2017 General Electric Company. All rights reserved. • Page 495 of 495
Download PDF

advertising