servicemax adapters - general electric€¦ · chapter\㈴ ㈀㨀尲㐰data extraction jobs3. data...
Post on 20-Aug-2020
7 Views
Preview:
TRANSCRIPT
ServiceMax Adapters
© 2020 General Electric Company
Contents
Chapter 1: Overview 1Overview 2
Chapter 2: Data Extraction Jobs 3Data Extraction Jobs 4
About Extracting Data from ServiceMax 4
Create ServiceMax Work Orders or Service Requests 6
Schedule Work Orders 7
Chapter 3: Deployment 8Deploy ServiceMax Adapters 9
Upgrade the ServiceMax Adapters to ServiceMax UDLP V2.9.0 9
Create a ServiceMax EAM System Record 9
Configure the ServiceMax Context File 10
Configure Site Reference Values 17
Configure GE Digital APM to Create Notifications Recommendation Records 19
Information to Complete ServiceMax and APM Connect Communications 20
Chapter 4: Reference 21General Reference 22
ServiceMax Mappings 26
Chapter 5: Release Notes 47First Quarter of 2020 48
Third Quarter of 2019 48
Third Quarter of 2018 48
ii ServiceMax Adapters
Copyright GE Digital© 2020 General Electric Company.
GE, the GE Monogram, and Predix are either registered trademarks or trademarks of All other trademarksare the property of their respective owners.
This document may contain Confidential/Proprietary information of 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 ORWARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TOWARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHERLIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLYDISCLAIMED.
Access to and use of the software described in this document is conditioned on acceptance of the EndUser License Agreement and compliance with its terms.
© 2020 General Electric Company iii
Chapter
1OverviewTopics:
• Overview
© 2020 General Electric Company 1
OverviewServiceMax adapters provide communication between GE Digital APM and a ServiceMax system.
GE Digital APM and ServiceMax Interaction
After installing and configuring the ServiceMax adapters, use GE Digital APM to initiate and track work tobe done for assets managed by a ServiceMax system. Consider the following example of GE Digital APMand ServiceMax interaction:
• A GE Digital APM user creates a Recommendation Record in GE Digital APM.• The Recommendation Record results in a Notification record that is sent to the ServiceMax system.• The receiving system creates a Service Request Record from the Notification record that the
ServiceMax administrator uses to create work orders.• A technician updates the work order in ServiceMax after completing the work indicated by the work
order.• The GE Digital APM user runs the Work History job that extracts information from the ServiceMax
Service Request record and updates the Work History records in GE Digital APM.
2 © 2020 General Electric Company
Chapter
2Data Extraction JobsTopics:
• Data Extraction Jobs• About Extracting Data from
ServiceMax• Create ServiceMax Work
Orders or Service Requests• Schedule Work Orders
© 2020 General Electric Company 3
Data Extraction JobsData extractions, also referred to as jobs, are orchestrated through the different adapters. Depending onthe type of data (that is, Equipment, Functional Location, Work History) you want to extract, there is acorresponding job. ServiceMax extractions are facilitated by the APM Connect Administration Center anda corresponding context file. The context file contains filter parameters that are applied to each extractionadapter job. The filter parameters define the scope of the data extraction.
Available Adapters
The ServiceMax adapters transfer data between GE Digital APM and ServiceMax.
• Equipment Adapter: Extracts records that are used to store information about physical pieces ofequipment such as pumps, motors, and compressors.
• Functional Location Adapter: Extracts records that are used to store information about locations inyour organization including, but not limited to, the locations at which the physical pieces of equipmentare installed.
• Work History Adapter: Extracts records that are used to store data about work that was performedagainst your locations and equipment, as well as failures that occurred for those locations andequipment. Additionally, it allows you to transfer Notifications from ServiceMax to GE Digital APM.
• Notification Management Adapter: Allows you to transfer Recommendation records from GE DigitalAPM to ServiceMax in the form of Notifications.
About Extracting Data from ServiceMaxBefore extracting data from ServiceMax, you must load enterprise, site, and taxonomy information intothe Predix database using the same site name you defined.
The extraction adapters allow you to extract data from your ServiceMax system and import it into your GEDigital APM system. To run 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 AdministrationCenter, at which point your data is extracted, transformed, and loaded into GE Digital APM.
There are three jobs that can be used to extract data from ServiceMax and load data into GE Digital APM.
• ServiceMax_Asset: Loads ServiceMax Asset records to GE Digital APM as Equipment records. Afterimporting, this will display as the RUN_EQUIPMENT job.
• ServiceMax_Location: Loads ServiceMax Location records to GE Digital APM as Functional Locationrecords. After importing, this will display as the RUN_LOCATION job.
• ServiceMax_WorkHistory: Loads ServiceMax Work Order records, Service Request records, and failurerecords as GE Digital APM Work History and Work History Detail records. After importing, this willdisplay as the RUN_WORKHISTORY job.
• ServiceMax_Master_Interface: Can be used as a wrapper job to run all of the extraction jobssimultaneously.
As a GE Digital APM user, after the adapter job runs, you can use standard GE Digital APM tools (forexample, the Search tool) to access the records that were created automatically.
Details: Extracting Equipment Data
When the Equipment Adapter job is run, for each asset in the ServiceMax system that meets the criteriadefined in context file, a corresponding Equipment record will be created in the GE Digital APM database.In addition, if that ServiceMax asset has a parent asset or location, the GE Digital APM Equipment record
4 © 2020 General Electric Company
will be linked automatically to a parent record belonging to the Equipment family or the FunctionalLocation family, as appropriate.
Note: If an asset is deleted in the ServiceMax system after an Equipment record has already been createdfor it in the GE Digital APM system, rerunning the Equipment Adapter job will not delete the GE DigitalAPM Equipment record.
Details: Extracting Functional Location Data
When the Functional Location Adapter job is run, for each location in the ServiceMax system that meetsthe criteria defined in the context file, a corresponding Functional Location record will be created in the GEDigital APM database. In addition, if that ServiceMax location has a parent asset or location, the GE DigitalAPM Functional Location record will be linked automatically to a parent record belonging to theEquipment family or the Functional Location family, as appropriate.
Note: If a Location record is deleted in the ServiceMax system after a Functional Location record hasalready been created for it in the GE Digital APM system, rerunning the Functional Location ExtractionInterface 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 ServiceMax system that meets the filteringcriteria defined in Work History job, a corresponding Work History record will be created in the GE DigitalAPM database. Each Work History record will be linked to one Equipment or Functional Location recordidentifying the asset or location against which the ServiceMax Work Order is written.
If the Work Order is written against a location, the Work History record will be linked to a FunctionalLocation record, and the Location ID field in the Work History record will be populated automatically withthe Location ID of that ServiceMax location.
If the Work Order is written against an asset, the Work History record will be linked to an Equipmentrecord, and the Equipment ID field in the Work History record will be populated automatically with theLocation ID of that ServiceMax asset. In addition, if that ServiceMax asset has a parent location, the WorkHistory record will also be linked to a Functional Location record representing that parent ServiceMaxlocation. The Location ID field in the Work History record will also be populated automatically with theLocation ID of that parent ServiceMax location.
Details: Extracting Service Requests
When the Work History job is run, for each Service Request in the ServiceMax system that meets thefiltering criteria defined in the Work History job, a corresponding Work History record will be created inthe GE Digital APM database. Each Work History record will be linked to one Equipment or FunctionalLocation record identifying the asset or functional location against which the ServiceMax Service Requestis written. Specifically:
• If the Service Request is written against a location, the Work History record will be linked to aFunctional Location record, and the Location ID field in the Work History record will be populatedautomatically with the Location ID of that ServiceMax location.
• If the Service Request is written against an asset, the Work History record will be linked to anEquipment record, and the Equipment ID field in the Work History record will be populatedautomatically with the Location ID of that ServiceMax asset. In addition, if that ServiceMax asset has aparent location, the Work History record will also be linked to a Functional Location recordrepresenting that parent ServiceMax location. The Location ID field in the Work History record will alsobe populated automatically with the Location ID of that parent ServiceMax location.
© 2020 General Electric Company 5
Details: Extracting Work History Details
When the Work History job is run, detailed Work Order and Service Request information is extracted fromyour ServiceMax system to 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 becreated.
Create ServiceMax Work Orders or Service Requests
About This Task
Important: You can create either a Work Order or a Service Request in ServiceMax from GE Digital APM.You cannot create both at the same time, so you must configure the context file to designate which tocreate.
Note: The following instructions assume that the Create Work Request box exists on the baselinedatasheets for the supported Action Management families. This field exists on the default datasheets inthe baseline GE Digital APM database, so these instructions assume that they have not been removed byan administrative user.
Procedure
1. Access an existing recommended action.2. If the Recommendation record is not already linked to the Equipment or Functional Location record
that represents the equipment or location for which you want to create a ServiceMax Service Request,link the records.
3. Select the appropriate datasheet for the Recommended Action record.4. As needed, enter values in the available fields to provide information about the recommended action.
Note: The value in the Target Completion Date field must be a future date.
5. Select .6. Select the Create Work Request? check box.
7. Select .
The record is saved.
Results
After you save the recommended action, the following occurs:
1. A Work Order or Service Request is created in the ServiceMax 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 is disabled.4. The Service Record Id field is populated.
Note: If a Service Request cannot be created for any reason, a message appears, describing the problem.You will not be able to save the recommended action record until you clear the Create Work Request?check box or resolve the problem.
6 © 2020 General Electric Company
Schedule Work Orders
Procedure
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 scheduled item, a schedule summary will be displayed next to the EditSchedule button. If there is no scheduled item, Not scheduled appears next to the Edit Schedulebutton.
4. In 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:
• The current date: Select this option to use the current time and date as the starting point.• Clear: Select this option to clear the current selection.• <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 workorder generation to occur.
8. In the Every section, in the Units box, select the interval unit (that is, minutes, hours, years, etc.).9. In the Every section, in the Begin box, select one of the following:
• 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, select one of the following:
• Never: If you select this option, the recurrence will not end.• After: If you select this option, 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 button. Additionally, the scheduled itemcan be viewed in the Scheduling feature in Operations Manager.
© 2020 General Electric Company 7
Chapter
3DeploymentTopics:
• Deploy ServiceMax Adapters• Upgrade the ServiceMax
Adapters to ServiceMax UDLPV2.9.0
• Create a ServiceMax EAMSystem Record
• Configure the ServiceMaxContext File
• Configure Site Reference Values• Configure GE Digital APM to
Create NotificationsRecommendation Records
• Information to CompleteServiceMax and APM ConnectCommunications
8 © 2020 General Electric Company
Deploy ServiceMax AdaptersTo ensure that the ServiceMax adapter transfers data correctly between GE Digital APM, and ServiceMax,you must perform these steps.
Before You Begin
• The correct version of GE Digital APM is installed.• The correct version of APM Connect is installed.• You have received the necessary information about the ServiceMax system the adapter is connecting
to GE Digital APM.• Your ServiceMax system must be prepared correctly.
Procedure
Preparing the ServiceMax System1. Load the Product Catalogue into ServiceMax. Make sure that all product external IDs in ServiceMax are
identical to the product IDs you load into GE Digital APM.
2. Load account IDs into ServiceMax. These account IDs must match the Site Names you load into GEDigital APM.
3. Add Location Types FLOC and Ship To to the Location object in ServiceMax. If your source systemuses a Location Type other than FLOC, use that type designation.
Upgrade the ServiceMax Adapters to ServiceMax UDLP V2.9.0The following tables outlines the steps that you must complete to upgrade this module toServiceMaxUDLP V2.9.0.
About This Task
These instructions assume that you have completed the steps for upgrading the basic systemarchitecture.
These tasks may be completed by multiple people in your organization. We recommend, however, that thetasks be completed in the order in which they are listed.
Procedure
• Upgrade from ServiceMax UDLP V2.2.0 through Maximo UDLP V2.9.0• On the APM Connect Server, run the third-party software batch file.• On the APM Connect Server, update existing jobs.
Create a ServiceMax EAM System RecordYou must configure an EAM System record to establish a connection between any EAM system and GEDigital APM.
Procedure
1. Create a new EAM System record.
© 2020 General Electric Company 9
2. In the Datasheet ID box, select ServiceMax.3. In the Name box, enter the name of your system.4. If this system is the system to and from which you want to send data by default, select the Default
EAM System? check box.5. In the System Type box, select SERVICE_MAX.6. In the User ID box, enter a valid User ID.
7. In the Password box, select .8. In the Enter EAM System Password window, in the Password box, enter the password that is
associated with the specified user ID.9. In the Confirm Password box, reenter the password.10. Select OK.11. In the Connection String box, replace the template connection string with the URL of the ServiceMax
application endpoint, for example, https://login.salesforce.com/services/oauth2/token.
12. In the Auth Client box, enter the ID of the client.
13. In the Auth Client Secret box, select .14. In the Auth Client Secret box, enter the secret associated with the specified user ID.15. In the Confirm Client Secret box, reenter the client secret.16. Select OK.
17. Select .The EAM System record is saved.
18. Select , and then select Test Connection.The connection parameters are verified, and the System ID box is populated with your EAM SystemName.
Results
• An EAM system record is created for the EAM system that defines a connection with GE Digital APM.The ID for this EAM record should now be used in the Name field of a Site Reference record.
• Linking an EAM system to an EAM System record enables the APM Connect Adapters to createNotifications against that EAM System.
Configure the ServiceMax Context FileThis topic describes how to access and configure parameters in the context file.
About This Task
Before you can run a job, you must specify a set of connection parameters and corresponding values toestablish connections between APM Connect components, GE Digital APM, and ServiceMax. Each of theseconnections is used when executing a job, and they are required. The connections are established viacontext files.
Procedure
On the APM Connect Server, navigate to the context file, and then open the context file to edit.
Important: Changes made to the context file will override changes made in the APM ConnectAdministration Center Context parameters section.
10 © 2020 General Electric Company
Interface Mode Selection
Parameter Description Default or Recommend Value
LOAD_MERIDIUM_APM Determines if data will be loaded into the Meridiumdatabase.
The default value is true.
true: data will be loaded into theMeridium database.
false: data will not be loaded into theMeridium database.
LOAD_DIGITAL_APM Determines if data will be loaded into the Predixdatabase.
The default value is true.
true: data will be loaded into the Predixdatabase.
false: data will not be loaded into thePredix database.
CMMS_ID The CMMS ID used as the identifier for your ServiceMaxSystem, taking the form <System ID>-<Client ID>.
For example, if your System ID is D03 and your Client IDis 001, then your CMMS ID would be DO3-001.
This value is required.
Enter your unique value.
SOURCE_SYSTEM_TYPE Identifies the type of system connecting with GE DigitalAPM.
This value is required.
You must enter the value SERVICEMAX.
Intermediate Repository (IR) Connection Parameters
Parameter Description Default or Recommended Value
IR_HOST IP address of the IR. Enter the host name of the PostgreSQLserver. If you installed APM Connect usingthe default settings, then the value islocalhost.
IR_PORT Port number of the IR. The default value is 5432.
IR_DATABASE Database in which the IR data is stored. Enter a name for the IR database. Thisvalue will be used to create the IRdatabase.
IR_SCHEMA The schema in which the IR database will be created. The default value is public.
IR_USER_ID The IR user name. Enter the user name for the PostgreSQLdatabase. The default user name ispostgres.
IR_PASSWORD The IR system password. Enter the password for the PostgreSQLdatabase that was created when runningthe installer.
APM Connection Parameters
Parameter Description Default or Recommend Value
APM_API_APP_SERVER The GE Digital APM API application server name. Enter the name of your GE Digital APMAPI Server.
APM_API_USE_SSL Specifies whether the GE Digital APM API applicationuses SSL.
The valid values are:
• true: The API application uses SSL.• false: The API application does not
use SSL.
The default value is false.
APM_APP_SERVER The GE Digital APM application server name. Enter the name of your GE Digital APMServer.
© 2020 General Electric Company 11
APM Connection Parameters
Parameter Description Default or Recommend Value
APM_DATASOURCE The GE Digital APM data source to which the data will beexported.
Enter the name of your GE Digital APMdata source.
APM_PASSWORD The GE Digital APM Framework password. Enter your unique value.
APM_USERID The GE Digital APM Framework User ID. Enter your unique value.
UNC_FILE_PATH The path of the directory of the data loader file share. Enter your unique value.
ServiceMax Organization Information
Parameter Description Default or Recommended Value
CUSTOMER_NAME The coded customer name. Enter your unique value, which wasprovided at installation.
ServiceMax Connection Parameters
Parameter Description Default or Recommended Value
SERVICEMAX_CLIENT_ID ServiceMax client from which data will be extracted. Enter your unique value.
CLIENT_SECRET The secret associated to the ServiceMax Client. Enter your unique value.
GRANT_TYPE The value ServiceMax uses to grant access to thesystem.
The default value is password.
SERVICEMAX_TOKEN_REQUEST_URL
IP address of the ServiceMax Server that providessecurity tokens to users.
Enter your unique value.
USERNAME ServiceMax system user ID. Enter your unique value.
PASSWORD ServiceMax system password. Enter your unique value.
SERVICE_REQUEST_URL The URL of the service that GE Digital APM uses tocreate service requests in ServiceMax.
Enter your unique value.
ROWS_TO_PROCESS The number of assets to extract in each batch fromServiceMax.
The default value is 100.
LANGUAGE The ServiceMax code that represents the language. Must be a single character.
EXTRACT_NUM_PARALLEL_JOB
Determines the maximum number of background jobsallowed during execution.
The recommended value is 10.
IR_LOAD_NUM_PARALLEL_JOBS
The maximum number of IR load jobs in a singleextraction.
The recommended value is 30.
MANUAL_RUN Determines how the date parameters will be treated. The default value is true.
true: The dates specified in the contextfile will be used, and the dates of the lastsuccessful run stored in the database willnot be updated.
false: The date range used during theextraction will be the date of the lastsuccessful record, as stored in thedatabase. Each time a Job is runsuccessfully, the database is updatedwith those dates, and all subsequent runswill use the dates from the last successfulrecord.
12 © 2020 General Electric Company
File System Parameters
Parameter Description Default or Recommended Value
PLSERVICEMAX_INPUT Path of the directory you created in which ServiceMaxwrites files.
Enter your unique value.
PLSERVICEMAX_OUTPUT Path of the directory where APM Connect will access thefiles written by ServiceMax.
Enter your unique value.
IR_TALEND_OUTPUT The root directory for all internal file processing. This isthe directory where files will be transformed.
Enter a file system location to which fileswill be written. You can create a directoryin the following location: C:\IR\TalendOutput.
LOG_BASE_DIR The directory path to the log file. None.
SFTP_STAGING_DIR Temporary storage location for files that are waiting tobe loaded.
Enter your unique value, which wasprovided at installation.
USE_SSL Determines if an SSL certificate will be used whentransferring files.
Enter true.
An SSL certificate is required, and true isthe only valid value.
TRUSTSTORE_FILE The directory path where the SSL certificate is stored. Enter the directory path where the SSLtruststore is stored on the APM ConnectServer.
TRUSTSTORE_PASSWORD The password to the SSL certificate file. Enter your unique value, which wasprovided at installation.
Filter Parameters
Parameter Description Recommended or Default Value
CREATE_DATE_START Date value that limits the data extracted to recordscreated on or after the specified date.
Dates must be entered in the followingformat: YYYYMMDD.
CREATE_DATE_END Date value that limits the data extracted to recordscreated on or before the specified date.
Dates must be entered in the followingformat: YYYYMMDD.
CHANGE_DATE_START Date value that limits the data extracted to recordschanged on or after the specified date.
Dates must be entered in the followingformat: YYYYMMDD.
CHANGE_DATE_END Date value that limits the data extracted to recordschanged on or before the specified date.
Dates must be entered in the followingformat: YYYYMMDD.
CREATE_TIME_START Time value that limits the data extracted to recordscreated at or after the specified time.
Time must be in the following format:HHMMSS
CREATE_TIME_END Time value that limits the data extracted to recordscreated at or before the specified time.
Time must be in the following format:HHMMSS.
CHANGE_TIME_START Time value that limits the data extracted to recordschanged at or after the specified time.
Time must be in the following format:HHMMSS.
CHANGE_TIME_END Time value that limits the data extracted to recordschanged at or before the specified time.
Time must be in the following format:HHMMSS.
© 2020 General Electric Company 13
Equipment Filter Criteria
Parameter Description Recommended or Default Value
SERVICEMAX_MAX_ASSETID
Specifies the IDs of the assets that you want to extract. Enter your unique value.
Suppose that you want to extract assetsbetween IDs 12345 and 98764. Yourconfiguration would contain thisstatement:
<SERVICE_MAX_ASSETID>2345,98764</SERVICEMAX_ASSETID>
SERVICE_MAX_WONUM Specifies the Work Order numbers you want to extract. Enter your unique value.
Suppose you want to extract work ordersbetween IDs 8756 and 9875. Yourconfiguration would contain thisstatement:
<SERVICE_MAX_WONU>8756,9875</SERVICEMAX_WONUM>
SERVICE_MAX_SRNUM Specifies the Service Request numbers you want toextract.
Enter your unique value.
Suppose you want to extract servicerequests a2C1I000000F2y andb2C1I000000F2z. Your configurationwould contain this statement:
<SERVICE_MAX_SRNUM>a2C1I000000F2y, b2C1I000000F2z</SERVICEMAX_SRNUM>
Note: This filter will only extract servicerequests that do not have associatedwork orders.
EQUIPMENT_NO Equipment that you want to extract. The Equipment number cannot exceed 18characters. You cannot exceed 500Equipment numbers.
EQUIPMENT_CATEGORY ID of the Equipment Category that will limit theEquipment extracted.
The Equipment Category cannot exceedone character.
EQUIPMENT_TYPE ID of the Equipment Type that will limit the Equipmentextracted.
The Equipment Type cannot exceed 10characters.
EQUIPMENT_CLASS ID of the Equipment Classification that will limit theEquipment extracted.
The Equipment Class cannot exceed 18characters.
If an Equipment has multipleclassifications, as long as you specify oneof those classifications, the Equipmentrecord will be extracted.
Predix Parameters
Parameter Description Recommendation or Default Value
TOKEN_REQUEST_URL The URL of the service that issues tokens for a client. Enter your unique value.
CLIENT_ID The client ID to access the Predix application. Enter your unique value.
14 © 2020 General Electric Company
Predix Parameters
Parameter Description Recommendation or Default Value
INGESTION_USERNAME The user name to request asset data from the Predixapplication.
Enter your unique value.
INGESTION_PASSWORD The password for the ingestion user name that requestsasset data from the Predix application.
Enter your unique value.
ASSET_INGESTION_URL The URL the Predix application uses to respond torequests for asset information.
Enter your unique value.
TENANT_UUID The userid of the tenant used to access the Predixapplication.
Enter your unique value.
PREDIX_GRANT_TYPE The value the Predix application uses to grant access tothe system.
The default value is password.
Functional Location Filter Criteria
Parameter Description Recommended or Default Value
FLOC_NO ID of the Functional Location that will limit theFunctional Locations extracted.
The Functional Location number cannotexceed 40 characters. You cannot exceed500 Functional Location numbers.
FLOC_TYPE ID of the Functional Location Type that will limit theFunctional Locations extracted.
Functional Location type cannot exceed10 characters.
FLOC_CLASS ID of the Functional Location Classification that will limitthe Functional Locations extracted.
Functional Location class cannot exceed18 characters.
FLOC_CATEGORY ID of the Functional Location Category that will limit theFunctional Locations extracted.
Functional Location category cannotexceed one character.
Work History Filter Criteria
Parameter Description Recommended or Default Value
NOTIFICATION_NO Number that identifies the Notification record. Notification Number cannot exceed 12characters.
WORK_ORDER_NO Number that identifies the Work Order record. Work Order Number cannot exceed 12characters.
NOTIFICATION_TYPE Order type that limits the orders that you want toextract.
Notification type cannot exceed twocharacters.
WORK_ORDER_TYPE ID of the work order that limits the orders that you wantto extract.
Work Order type cannot exceed fourcharacters.
WORK_ORDER_SYSTEM_STATUS
Work Order systems status that limits the work ordersyou want to extract.
Work Order System Status cannot exceedfour characters.
WORK_ORDER_USER_STATUS
Work Order user status that limits the work orders thatyou want to extract.
Work Order User Status cannot exceedfour characters.
NOTIFICATION_SYSTEM_STATUS
Notification system status that limits the notificationsthat you want to extract.
Notification system status cannot exceedfour characters.
NOTIFICATION_USER_STATUS
Notification user status that limits the notifications thatyou want to extract.
User status cannot exceed fourcharacters.
MAINT_PLANT ID(s) of the Maintenance Plant whose data you want toextract.
Plant values cannot exceed fourcharacters.
© 2020 General Electric Company 15
Miscellaneous Parameters
Parameter Description Recommended or Default Value
SITE_REFERENCE_EQUIP Used to map the site reference value to a ServiceMaxfield. This dictates which ServiceMax field will be used asthe site reference for GE Digital APM Equipmentrecords.
You can enter a value defined in GE DigitalAPM.
Note: The value that is entered will beapplied to all records.
-or-
You can use the character # at thebeginning and end of a GE Digital APMfield name to indicate the field that isused to set the site reference.
For example, if you wanted to use yourServiceMax maintenance plant field asyour GE Digital APM site reference, youwould enter a value in the following form:<SITE_REFERENCE_EQUIP>#MI_EQUIP000_MAINT_PLANT_C#</SITE_REFERENCE_EQUIP>.
SITE_REFERENCE_FLOC Used to map the site reference value to a ServiceMaxfield. This dictates which ServiceMax field will be used asthe site reference for GE Digital APM Equipmentrecords.
Specify the value with either of thefollowing methods:
• Enter a value defined in GE DigitalAPM.
Note: The value that is entered willbe applied to all records.
• You can use the character # at thebeginning and end of a GE DigitalAPM field name to indicate the fieldthat is used to set the site reference.
For example, if you wanted to use yourServiceMax maintenance plant field asyour GE Digital APM site reference, youwould enter a value in the following form:<SITE_REFERENCE_FLOC>#MI_FNCLOC00_MAINT_PLANT_C#</SITE_REFERENCE_FLOC>.
Email Notification Parameters
Parameter Description Recommenced or Default Value
EMAIL_TO The email address(es) to which the notification emailwill be sent.
Enter your unique value.
EMAIL_FROM The email address from which the notification email willbe sent.
Enter your unique value.
REPORT_TARGET_DIR The directory path where the report file will be delivered. Enter your unique value.
FAILURE_DETAIL_REPORT_JRXML_FILE_PATH
The directory path where the failure report file will bedelivered.
Enter your unique value.
LOAD_SUMMARY_REPORT_JRXML_FILE_PATH
The directory path where the load complete report filewill be delivered.
Enter your unique value.
SMTP_HOST The SMTP host for the APM Connect Server installation. Enter your unique value.
SMTP_PORT The port for SMTP. Default value is 25.
16 © 2020 General Electric Company
Email Notification Parameters
Parameter Description Recommenced or Default Value
LOAD_SUMMARY_REPORT_ENABLED
Indicates whether the Load Complete report will be sentwith every extraction.
True: The Load Complete report will besent detailing the number of records thatwere extracted and successfully loadedinto GE Digital APM.
False: The Load Complete report will notbe sent.
FAILURE_DETAIL_REPORT_ENABLED
Indicates whether the Failure Detail report will be sentwhen a record fails to load.
True : The Failure Detail report will besent detailing the records that failed toload and the reason why.
False: The Failure Detail report will not besent.
Configure Site Reference ValuesTo assign site references to records using values other than those in the baseline configuration, you mustmodify the autojoin_control table in the Intermediate Repository.
About This Task
Note: Site Reference records corresponding to the site references that you specify must exist in GEDigital APM before you can transfer records.
Procedure
• 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 SiteFiltering Configuration.
3. Update the value in the site_reference column using the format #FIELD_ID#, where FIELD_IDrepresents 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 Functional Location field ofthe corresponding Equipment or Functional Location.
◦ Where the value #MI_FNCLOC00_SERVICEMAX_SYSTEM_C# occurs, replace the value with#MI_FNCLOC00_FNC_LOC_DESC_C#
◦ Where the value #MI_EQUIPOO_SERVICEMAX_SYSTEM_C# occurs, replace the value with#MI_EQUIP000_FUNC_LOC_C#
When you import a record into GE Digital APM from your ServiceMax system, its Site Reference Keywill be the value in the field that you specified. In the example above, the Site Reference Key will bethe ServiceMax Maintenance Plant of the corresponding Equipment or Functional Location.
• 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.
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 SiteFiltering Configuration.
© 2020 General Electric Company 17
3. Where the value #MI_EQUIPOO_SERVICEMAX_SYSTEM_C# occurs, replace the value with theSite name as defined in a GE Digital APM Site Reference record.When you import records into GE Digital APM from your ServiceMax system, its Site Reference Keywill be the name of the Site as defined in the APM Site Reference record.
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 IRdatabase name is ServiceMax_UDLP_EAMClient. You can use the database browser ofyour choice.
1. On your APM Connect Server, open the application pgAdmin4.The application pgAdmin4 opens, displaying your available servers.
2. Navigate the server tree to the appropriate IR database, access your tables.In this example, the path is Servers(2)\roaperflabvm3\Databases\ServiceMax_UDLP_EAMClient\Schemas(1)\public\Tables (81). The list of tables inyour IR database are visible.
3. Locate the table autojoin_control, then right-click the table, and then selectView Data.
18 © 2020 General Electric Company
4. Select View All Rows.The Query -1 section 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 columncorrespond to values in the MI_EQUIP000 and MI_FNCLOC00 families. If they donot, you must also update the apm_site_reference_family column to thecorresponding family.
The value in the MI_EQUIP000_CST_CNR_C field will be used to populate the SiteReference Key in corresponding records.
Configure GE Digital APM to Create NotificationsRecommendation Records
ServiceMax allows you to create Recommendation records in GE Digital APM that will be used to createServiceMax Notifications automatically.
About This Task
For a Recommendation record to generate an ServiceMax Notification automatically, the Create WorkRequest field must exist on the Recommendation datasheet. This field is available on the baselinedatasheets for the baseline Recommendation families from which you can create ServiceMaxNotifications.
If you want to generate ServiceMax Notifications from Recommendation records that belong to customer-defined subfamilies of the root Recommendation family, in addition to implementing the correct rules (foran example of the rules that you will need to implement, you can look at any active baseline
© 2020 General Electric Company 19
Recommendation family), you will need to add the Create Work Request field to the applicable datasheetsfor that family.
Tip: You can create multiple types of ServiceMax Notifications (for example, general) fromRecommendation records. By default, GE Digital APM creates general notifications.
Procedure
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 general.
Note: In the baseline ServiceMax product, this field is disabled. If desired, you could configure it to beenabled so that users can enter a value directly in the Notification Type cell on the datasheet. Youmight also consider creating a Valid Values rule that provides a list of acceptable values so that userscan select the desired value in the list.
Information to Complete ServiceMax and APM ConnectCommunications
To enable communications between ServiceMax and APM Connect, the ServiceMax administrator mustupdate ServiceMax correctly. To configure communications, you must provide the ServiceMaxadministrator with specific information.
Provide the ServiceMax administrator with the userid configured in the context file as USERNAME forAPM Connect.
Provide the ServiceMax administrator with the following information:
• The EVENT NAME and CLASS NAME are APMServiceRequestEvent. The administrator will configurethese values in the IoT Events section on the IoT Setup page in ServiceMax.
• The INSTALLED PRODUCT FIELD NAME is Record ID and the EXTERNAL FIELD NAME is RecordID. Theadministrator will configure these values in the Installed Product Lookup section in the IoT Setuppage in ServiceMax.
20 © 2020 General Electric Company
Chapter
4ReferenceTopics:
• General Reference• ServiceMax Mappings
© 2020 General Electric Company 21
General Reference
RequirementsFor successful data transfer between ServiceMax and GE Digital APM, your installation must meetminimal requirements.
Each component listed must also meet the preferred system requirements.
• ServiceMax Version Winter '18 or later.
ServiceMax Data ModelThe following diagram shows how the families used by the ServiceMax Adapter are related to oneanother.
Note: In the diagram, boxes represent entity families and arrows represent relationship families that areconfigured in the baseline database. You can determine the direction of each relationship definition fromthe direction of the arrow head: the box from which the arrow originates is the predecessor, and the boxto which the arrow head points is the successor.
The GE Digital APM ServiceMax feature consists of entity families, relationship families, and businessrules. When attempting to understand and make use of the GE Digital APM ServiceMax functionality, itcan be helpful to visualize the ServiceMax data model. You can use the ServiceMax to create and viewrecords. This documentation assumes that you are familiar with the concept of records and viewingrecords in the GE Digital APM Record Manager.
22 © 2020 General Electric Company
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 aboutthe process, such as the status of the process (for example, Completed with warnings), the date theinterface 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 Useror 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).
EAM SystemEAM System records are used to store information about your systems to facilitate data extractions andloads.
When you transfer data from GE Digital APM to your EAM or service management system, the GE DigitalAPM system uses EAM System records to determine which EAM system to use.
In addition, EAM System records are used by the Equipment Adapter and the Functional Location Adapter.
This topic provides an alphabetical list and description of the fields that exist for the EAM System family.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 anyuser with the appropriate license and family privileges. For more information, refer to the Sites section ofthe documentation.
Field Data Type Description Behavior and Usage
Authentication Client ID Character The client ID for the
ServiceMax system.
Enter your unique value.
Authentication Client Secret Character The secret associated with the
ServiceMax client.Enter your unique value.
The value that you enter will be encrypted
and displayed as asterisks on the
datasheet.
Authentication Token Character The token assigned to the
ServiceMax client.Enter your unique value.
The value that you enter will be encrypted
and displayed as asterisks on the
datasheet.
© 2020 General Electric Company 23
Field Data Type Description Behavior and Usage
Connection String Character The connection information
for the system.Note: The value of this field is for all
systems that require a connection string,
even though the template values contain
the characters SAP.
In new EAM System records, you need to
delete all angle brackets and:
• Replace the text SAP_SERVER_IP with
the IP address of the server.
• Replace the
text SAP_SYSTEM_NUMBER with the
system number.
• Replace the
text SAP_CLIENT_NUMBER with the
client number.
• For ServiceMax, enter the URL for the
ServiceMax endpoint, for example,
https://login.salesforce.com/services/oauth2/token.
Default EAM System? Boolean A value that indicates whether
this system should be used by
default when transferring data
between your GE Digital APM
system and your system.
On the datasheet, you can select the
check box to identify this system as the
Default EAM System.
The default EAM system is used when
creating a notification from a General
Recommendation when there is no
technical object from which to obtain the
EAM system for the creation of the
notification.
Name Character The name of the system. You can enter any name, but we
recommend that you enter a name in the
format <SYSID>-<CLIENT>, where
<SYSID> is the System ID of the 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.
Password Character The password to the system. The password that you enter will be
encrypted and displayed as asterisks on
the datasheet.
Reconnect Delay Numeric Specifies the delay in seconds
between when a
communication failure is
encountered when connecting
and when the system should
try to connect again.
The default value is 0.
Enter your unique value.
24 © 2020 General Electric Company
Field Data Type Description Behavior and Usage
System ID Character The ID of the system. This field is populated automatically after
you test the connection to the system
using the Test Connection link on
the Associated Pages menu.
Specifically, the System ID field is
populated automatically with the name of
the system, using the format <SYSID>-
<CLIENT>, where <SYSID> is the System
ID of the system and <CLIENT> is the
Client number.
System Type Character EAM system type. Enter the value SERVICE_MAX.
User ID Character The User ID of a user that can
log in to the system.
None
ServiceMax Security GroupsThe following table lists the baseline Security Groups available for users within this module, as well as thebaseline Roles to which those Security Groups are assigned. Roles are assigned to Security Users throughpermission sets.
Important: Assigning a Security User to a Role grants that user the privileges associated with all of theSecurity 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 theSecurity Groups assigned to that Role.
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 followingtable.
Family MI CMMS InterfaceAdministrator
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
Site Reference View View
Relationship Families
© 2020 General Electric Company 25
Family MI CMMS InterfaceAdministrator
MI CMMS Interface User
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
Family Field Descriptions
ServiceMax Mappings
ServiceMax Equipment Records MappingsThe following tables contain the list of ServiceMax fields that populate the fields in the Equipment recordscreated in GE Digital APM when you use the ServiceMax Equipment Adapter.
ServiceMax to GE Digital APM Mappings
All of these fields belong to the GE Digital APM Equipment family (ID: MI_EQUIP000).
ServiceMaxTable
ServiceMaxAttribute
ServiceMaxAdapterLabel
GE DigitalAPM FieldCaption
GE DigitalAPM Field ID
Comments
SVMXC__Inst
alled_Produc
t
Id Installed
product ID
Equipment ID MI_EQUIP000_EQUIP
_C
This is a GE Digital APM key field.
SVMXC__Inst
alled_Produc
t__c.SVMXC_
_Serial_Lot_
Number__c-
SVMXC__Inst
alled_Produc
t__c.id
Id Installed
product ID
Unique ID MI_EQUIP000_UNIQ
UE_ID_C
The value of this field is populated by GE
Digital APM unless you specified a Unique
ID value when you create the record in
ServiceMax. In this case, the value of Unique
ID from ServiceMax is used.
SVMXC__Co
mpany__r
Name Account
Name
Site
Reference
Name
MI_SITE_NAME None
SVMXC__Pro
duct__c
Name Product
name
Equipment
Short
Description
MI_EQUIP000_EQUIP
_SHRT_DESC_C
None
26 © 2020 General Electric Company
ServiceMaxTable
ServiceMaxAttribute
ServiceMaxAdapterLabel
GE DigitalAPM FieldCaption
GE DigitalAPM Field ID
Comments
SVMXC__Pro
duct__c
Description Product
description
Equipment
Long
Description
MI_EQUIP000_EQUIP
_LNG_DESC_T
None
SVMXC__Site
__c
Id Location ID Functional
Location
MI_EQUIP000_FNC_
LOC_C
None
SVMXC__Site
__c
Name Location
Name
Functional
Location
Description
MI_EQUIP000_FNC_
LOC_DESC_C
None
SVMXC__Inst
alled_Produc
t__c
SVMXC__Seri
al_Lot_Numb
er__c
Installed
product
serial/lot #
Equipment
Serial
Number
MI_EQUIP000_SN_C None
SVMXC__Inst
alled_Produc
t__c
SVMXC__Stat
us__c
Installed
product
status
System
Status
MI_EQUIP000_SYS_S
T_C
None
SVMXC__Pro
duct__c
ProductCode Product code Equipment
Type
MI_EQUIP000_OBJ_T
YP_C
None
SVMXC__Pro
duct__c
Name Product
name
Equipment
Type
Description
MI_EQUIP000_OBJ_T
YP_DESC_C
None
SVMXC__Inst
alled_Produc
t__c
LastModified
Date
Last
modified
date
CMMS Last
Changed Date
MI_EQUIP000_CHAN
GE_DATE
None
SVMXC__Inst
alled_Produc
t__c
CreatedDate Creation
date
CMMS
Creation Date
MI_EQUIP000_CREA
TE_DATE
None
SVMXC__Inst
alled_Produc
t__c
SVMXC__War
ranty_End_D
ate__c
Warranty
End Date
EAM
Reference
Warranty
Expiration
Date
MI_EQUIP000_EAM_
REF_WRNTY_EXPR_D
T_C
The equipment warranty expiration date as
specified in the source system.
Organization Id Org ID CMMS
System
MI_EQUIP000_SAP_S
YSTEM_C
This is a GE Digital APM key field.
© 2020 General Electric Company 27
GE Digital APM to ServiceMax Mappings
All ServiceMax fields are in the SVMXC__Installed_Product__c object.
GE DigitalAPM Field ID
GE DigitalAPM FieldCaption
ServiceMaxAttribute
ServiceMax AdapterLabel
Comments
MI_EQUIP000_
MI_EQUIP000_
SN_C
Equipment
Serial Number
SVMXC__Serial_
Lot_Number__c
Serial Lot Number The serial number of the installed equipment as it
exists in GE Digital APM.
MI_EQUIP000_
EAM_REF_WRN
TY_EXPR_DT_C
EAM Reference
Warranty
Expiration Date
SVMXC__Warra
nty_End_Date__
c
Warranty End Date The date the warranty for the equipment expires.
MI_EQUIP000_
EQUIP_LNG_DE
SC_T
Equipment
Long
Description
SVMXC__Install
ation_Notes__c
Installation Notes This is the equipment description as it exists in GE
Digital APM.
MI_EQUIP000_
EQUIP_SHRT_D
ESC_C
Equipment
Short
Description
Name Name The serial number of the equipment as it exists in
GE Digital APM.
MI_EQUIP000_
EQUIP_TECH_N
BR_C
Equipment
Technical
Number
SVMXC__Asset_
Tag__c
Asset Tag The technical number assigned to the equipment
as it exists in GE Digital APM.
MI_EQUIP000_
SYS_ST_C
Equipment
Status
SVMXC__Status
__c
Status The installation status for the equipment as it
exists in GE Digital APM.
MI_EQUIP000_
UNIQUE_ID_C
Unique ID SVMXC__SM_Ex
ternal_ID__c
ID This field is the unique ID of the equipment as it
exists in GE Digital APM.
MI_EQUIP000_
UNIQUE_ID_C
Unique ID of
parent in the
hierarchy
SVMXC__SM_Ex
ternal_Parent__
c
Parent This field is the ID of the parent equipment as it
exists in GE Digital APM.
MI_EQUIP000_
SAP_SYSTEM_C
& "-" &
MI_EQUIP000_
FNC_LOC_C
Unique ID of
functional
location
SVMXC__SM_Ex
ternal_Site__c
Site This field is the unique functional location of the
equipement as it exists in GE Digital APM. For
example, if this equipment is recorded in SystemB
at functional location ROA3, the value would be
SystemB-ROA3.
MI_EQUIP000_
SITE_C
Site SVMXC__SM_Ex
ternal_Compan
y__c
Company This field is the site associated with the
equipment as it exists in GE Digital APM.
MI_EQUIP000_
CONSTN_TYP_
C
Construction
Type
SVMXC__SM_Ex
ternal_Product_
_c
Product This field associates the installed equipment in GE
Digital APM to the product catalogue configured
in ServiceMax
ServiceMax Functional Location MappingsThe following tables contain the list of ServiceMax fields that populate the fields in the FunctionalLocation records created in GE Digital APM when you use the ServiceMax Equipment Adapter.
28 © 2020 General Electric Company
ServiceMax to GE Digital APM Mappings
All of these fields belong to the GE Digital APM Functional Location family (ID: MI_FNCLOC000).
ServiceMax Table ServiceMaxAttribute
ServiceMaxAdapter Label
GE DigitalAPM Field ID
GE Digital APMField Caption
Comments
SVMXC__Site__c Id Location ID MI_FNCLOC00_INT
ERNAL_ID_C
Functional Location
Internal ID
None
SVMXC__Site__c Id Location ID MI_FNCLOC00_FNC
_LOC_C
Functional Location This is a GE Digital
APM key field.
SVMXC__Site__c.Na
me-
SVMXC__Site__c.id
Id Location ID MI_FNCLOC00_UNI
QUE_ID_C
Unique ID The value of this
field is populated
by GE Digital APM
unless you
specified a Unique
ID value when you
create the record in
ServiceMax. In this
case, the value of
Unique ID from
ServiceMax is used.
SVMXC__Company_
_r
Name Account name MI_SITE_NAME Site Reference
Name
None
SVMXC__Site__c Name Location name MI_FNCLOC00_FNC
_LOC_DESC_C
Functional Location
Description
None
SVMXC__Site__c Name Location name MI_FNCLOC00_FNC
_LOC_LNG_DESC_C
Functional Location
Long Description
None
SVMXC__Site__c SVMXC__Location_
Type__c
Location Type MI_FNCLOC00_CAT
EG_C
Category None
SVMXC__Site__c SVMXC__Parent__c Parent functional
location
MI_FNCLOC00_SUP
R_FNC_LOC_C
Superior Function
Location
None
Organization Id Org ID MI_FNCLOC00_SAP
_SYSTEM_C
CMMS System This is a GE Digital
APM key field.
© 2020 General Electric Company 29
GE Digital APM to ServiceMax Mappings
All ServiceMax fields are in the SVMXC__Site__c object.
GE Digital APM Field ID GEDigitalAPMFieldCaption
ServiceMax Attribute ServiceMaxAdapterLabel
Comments
MI_FNCLOC00_UNIQUE_ID_C Unique
ID
SVMXC__SM_External_ID
__c
External
ID
This is the external ID ServiceMax uses
to associate a location with a funtional
location in GE Digital APM.
MI_FNCLOC00_UNIQUE_ID_C Unique
ID of
Superio
r
Locatio
n
SVMXC__SM_External_P
arent__c
External
Parent ID
This is the immediate parent location of
this functional location.
MI_FNCLOC00_SITE_C Site SVMXC__SM_External_C
ompany__c
External
Company
Id
MI_FNCLOC00_FNC_LOC_DESC_C Functio
nal
Locatio
n
Descript
ion
Name Location
name
This is the description of the functional
location from GE Digital APM.
MI_FNCLOC00_TYPE_C Locatio
n Type
SVMXC__Location_Type_
_c
Location
name
The type associated with the functional
location as it exists in GE Digital APM.
The default value is FLOC.
ServiceMax Work History MappingsThe following table contains the list of GE Digital APM Family ID fields in the Work History records createdin GE Digital APM that are populated by the ServiceMax Work History Adapter.
ServiceMaxObject Name
ServiceMaxField ID
ServiceMaxCaption
GEDigitalAPM FamilyID
GE DigitalAPM FieldID
GE DigitalAPM FieldCaption
Behavior
SVMXC__Service_
Order__c
SVMXC__Pu
rpose_of_Visi
t__c
Purpose of
Visit
MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_P
M_ACT_C
Activity
Type
The value of this field is the reason for
the service visit, for example, Repair.
SVMXC__Service_
Order__c
SVMXC__Tot
al_Work_Ord
er_Cost__c
Total Work
Order
Amount
MI_EV
WKHIS
T
MI_EVWKHI
ST_ACT_SER
V_COST_N
Actual
Service Cost
The value of this field is the actual cost
for this service visit, for example, 100.
30 © 2020 General Electric Company
ServiceMaxObject Name
ServiceMaxField ID
ServiceMaxCaption
GEDigitalAPM FamilyID
GE DigitalAPM FieldID
GE DigitalAPM FieldCaption
Behavior
SVMXC__Service_
Order__c
SVMXC__Cu
stomer_Dow
n__c
Customer
Down
MI_EV
WKHIS
T
MI_EVWKHI
ST_BRKDN_I
ND_F
Breakdown
Indicator
The value of this field indicates
whether this service request was
generated because the customer was
disabled, for example, TRUE.
SVMXC__Service_
Contract__r
Name Service
Contract
MI_EV
WKHIS
T
MI_EVWKHI
ST_CNTRCT_
NMR_C
Contract
Number
The value of this field, if specified, is
the service contract number
associated with this request.
SVMXC__Service_
Group__r
Name Service
Team
MI_EV
WKHIS
T
MI_EVWKHI
ST_CREW_ID
_C
Crew ID This field, if specified, contains the
name of the service team assigned to
this request, for example, My Techs.
SVMXC__Compon
ent__r, if the
source record is a
work order.
SVMXC__Serial_N
umber__r, if the
source record is a
service request.
id Component MI_EVE
NT
MI_EVENT_A
SST_ID_CHR
Equipment
ID
This is a key field.
This field identifies the asset
associated with this service request,
for example, a0N1I0000030QZl.
SVMXC__Service_
Order__c
SVMXC__Tot
al_Estimate_
_c
Total
Estimate
MI_EV
WKHIS
T
MI_EVWKHI
ST_EST_SERV
_COST_N
Estimated
Service Cost
The value of this field is the estimated
cost of the service to be performed,
for example, 9000.
SVMXC__Service_
Order__c and
Service_Request_
_r
Concatenati
on of WH-
Service_requ
est__r.Name
and
SVMXC__Ser
vice_Order__
c.NAME
Work Order MI_EVE
NT
MI_EVENT_I
D
Event ID This is a key field.
The value in this field identifies the
work order associated with this
service request For example, WH-
SR-00000341-WO-00000025.
If there is no service request, the field
would have the format WH-
WO-00000025.
If there is no work order present, the
field would have the format WH-
SR-00000341
SVMXC__Service_
Order__c
SVMXC__Pro
blem_Descri
ption__c
Problem
Description
MI_EVE
NT
MI_EVENT_S
HRT_DSC_CH
R
Event Short
Description
The value in this field is a brief
description of the problem that
generated the service request, for
example, Burning smell coming from
equipment.
SVMXC__Service_
Order__c
CreatedDate Create By MI_EVE
NT
MI_EVENT_S
TRT_DT
Event Start
Date
The value in this field is the UTC
creation date and time of the service
request, for example,
2018-03-27T20:16:35.000+0000.
© 2020 General Electric Company 31
ServiceMaxObject Name
ServiceMaxField ID
ServiceMaxCaption
GEDigitalAPM FamilyID
GE DigitalAPM FieldID
GE DigitalAPM FieldCaption
Behavior
SVMXC__Service_
Order__c
SVMXC__Ord
er_Status__c
Status MI_EV
WKHIS
T
MI_EVWKHI
ST_STATUS_
C
Event Status The value in this field is the current
status of the service request, for
example, Closed.
SVMXC__Service_
Order__c
SVMXC__Ord
er_Type__c
Order Type MI_EVE
NT
MI_EVENT_T
YP_CHR
Event Type The value in this field is the type of
service request, for example, Field
Service.
SVMXC__Service_
Order__c
SVMXC__Fail
ure_Location
__c
Failure
Location
MI_EV
WKHIS
T
MI_EVWKHI
ST_FAILR_M
ODE_CD_C
Failure Mode The value in this field identifies the
location where the failure occurred.
SVMXC__Service_
Order__c
SVMXC__Fail
ed_Assembl
y__c
Failed
Assembly
MI_EV
WKHIS
T
MI_EVWKHI
ST_FAILR_M
ODE_DESC_
C
Failure Mode
Description
The value in this field identifies the
equipment that failed.
SVMXC__Service_
Order__c
SVMXC__Cus
tomer_Failur
e_Feedback_
_c
Customer
Failure
Feedback
MI_EV
WKHIS
T
MI_EVWKHI
ST_FAILURE_
REM_T
Failure
Remarks
This field contains pertinent
information from the customer to the
service technician.
SVMXC__Compon
ent__r, if the
source record is a
work order.
SVMXC__Serial_N
umber__r, if the
source record is a
service request.
SVMXC__Sit
e__c
Location MI_EVE
NT
MI_EVENT_L
OC_ID_CHR
Location ID The value in this field identifies the
location of the equipment to be
serviced.
SVMXC__Service_
Order__c
CreatedDate Create By MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_CR
T_DT_D
Order
Creation
Date
The value in this field is the UTC
creation date and time of the work
order, for example,
2018-03-27T20:16:35.000+0000.
SVMXC__Service_
Order__c
SVMXC__Pro
blem_Descri
ption__c
Problem
Description.
MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_DE
SC_C
Order
Description
The value in this field describes the
problem addressed by this work order.
SVMXC__Service_
Order__c
Name Work Order MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_ID_
C
Order ID The value in this field identifies the
work order associated with this
service request.
SVMXC__Service_
Order__c
LastModified
Date
Last
Modified By
MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_CH
NG_DT_D
Order Last
Change Date
The value in this field is the UTC date
and time the work order was updated,
for example,
2018-04-01T16:46:52.000+0000.
32 © 2020 General Electric Company
ServiceMaxObject Name
ServiceMaxField ID
ServiceMaxCaption
GEDigitalAPM FamilyID
GE DigitalAPM FieldID
GE DigitalAPM FieldCaption
Behavior
SVMXC__Service_
Order__c
SVMXC__Pri
ority__c
Priority MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_PR
TY_C
Order
Priority
This is the priority associated with the
work order, for example, Medium.
SVMXC__Service_
Order__c
SVMXC__Ord
er_Type__c
Order Status MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_SY
S_STAT_C
Order
System
Status
The value in this field is the current
status of the work order, for example,
Closed.
SVMXC__Service_
Order__c
SVMXC__Ord
er_Type__c
Order Type MI_EV
WKHIS
T
MI_EVWKHI
ST_ORDR_TY
P_CD_C
Order Type The value in this field identifies the
type of work order, for example, Field
Service.
SVMXC__PM_Plan
__r
Name Preventive
Maintenance
Plan
MI_EV
WKHIS
T
MI_EVWKHI
ST_PM_NBR_
C
PM Number The value in this field identifies the
maintenance plan associated with this
work order, for example, PM Test.
Service_Request_
_r
CreatedDate Create By MI_EV
WKHIS
T
MI_EVWKHI
ST_RQST_CR
T_DT_D
Request
Creation
Date
The value in this field is the UTC date
and time this service request was
created, for example,
2018-03-27T12:02:38.000+0000.
Service_Request_
_r
SVMXC__Sub
ject__c and
SVMXC__Pro
blem_Descri
ption__c
Problem
Description
MI_EV
WKHIS
T
MI_EVWKHI
ST_RQST_DE
SC_C
Request
Description
The value in this field identifies the
problem associated with this service
request, for example, Normal
preventative maintenance.
Service_Request_
_r
Name Service
Request
MI_EV
WKHIS
T
MI_EVWKHI
ST_RQST_ID_
C
Request ID This is a key field.
The value in this field identifies the
service request associated with this
work order.
Service_Request_
_r
LastModified
Date
Last
Modified By
MI_EV
WKHIS
T
MI_EVWKHI
ST_RQST_CH
NG_DT_D
Request Last
Change Date
The value in this field is the UTC date
and time the service request was
changed, for example,
2018-04-01T14:16:49.000+0000.
Service_Request_
_r
SVMXC__Pri
ority__c
Priority MI_EV
WKHIS
T
MI_EVWKHI
ST_RQST_PR
TY_C
Request
Priority
The value in this field identifies the
priority associated with this service
request, for example, High.
Service_Request_
_r
SVMXC__Sta
tus__c
Status MI_EV
WKHIS
T
MI_EVWKHI
ST_RQST_SY
S_STAT_C
Request
System
Status
The value in this field identifies the
status of the service request, for
example, CREATED.
Service_Request_
_r
SVMXC__Typ
e__c
Type MI_EV
WKHIS
T
MI_EVWKHI
ST_RQST_TY
P_CD_C
Request
Type
The value in this field identifies the
type of service request, for example,
GENERAL.
© 2020 General Electric Company 33
ServiceMaxObject Name
ServiceMaxField ID
ServiceMaxCaption
GEDigitalAPM FamilyID
GE DigitalAPM FieldID
GE DigitalAPM FieldCaption
Behavior
SVMXC__Service_
Order__c
SVMXC__Pre
ferred_End_T
ime__c
Preferred
End Time
MI_EV
WKHIS
T
MI_EVWKHI
ST_TARGET_C
OMPL_D
Target
Completion
Date
The value in this field is the UTC date
and time work should be completed
on this service request, for example,
2018-03-31T22:57:00.000+0000.
SVMXC__Service_
Order__c
SVMXC__Pre
ferred_Start
_Time__c
Preferred
Start Time
MI_EV
WKHIS
T
MI_EVWKHI
ST_TARGET_S
TART_D
Target Start
Date
The value in this field is the UTC date
and time work should start on this
service request, for example,
2018-04-05T22:57:00.000+0000.
SVMXC__Service_
Order__c
SVMXC__Ser
vice_Duratio
n__c
Service
Duration
MI_EV
WKHIS
T
MI_EVWKHI
ST_TIME_TO_
REPR_N
Time To
Repair (TTR)
The value in this field is the amount of
time, in minutes, it took to complete
the service, for example, 3600.
SVMXC__Service_
Order__c
SVMXC__Tot
al_Work_Ord
er_Cost__c
MI_EV
WKHIS
T
MI_EVWKHI
ST_TOTL_CST
_N
Total Cost The value in this field is the actual cost
to perform the work identified on the
work order, for example, 1000.
ServiceMax Work History Detail MappingsThe following table contains the list of ServiceMax fields that populate the fields in the Work HistoryDetail records created in GE Digital APM when you use the ServiceMax Work History Detail Adapter.
All of the fields belong to the GE Digital APM MI_DTWKHIST family.
GE Digital APM Field ID GE DigitalAPM FieldCaption
ServiceMaxObjectName
ServiceMaxField ID
ServiceMaxCaption
Behavior
MI_DTWKHIST_ASST_ID_C Equipment
ID
SVMXC__Ser
vice_SVMXC
__Serial_Nu
mber__r
id Equipment
ID
This is a key field.
MI_DTWKHIST_LOC_ID_C Location ID SVMXC__Ser
vice_SVMXC
__Serial_Nu
mber__r
SVMXC__Sit
e_c
Location This is a key field.
MI_DTWKHIST_ORDER_ID_C Order ID SVMXC__Se
rvice_Order_
_r
Name Work Order
Number
This is a key field.
MI_DTWKHIST_ RQST_ID_C Request ID SVMXC__Ser
vice_Order_r
Service_Req
uest__c
Service
Request
Number
This is a key field.
34 © 2020 General Electric Company
GE Digital APM Field ID GE DigitalAPM FieldCaption
ServiceMaxObjectName
ServiceMaxField ID
ServiceMaxCaption
Behavior
MI_DTWKHIST_EVNT_DTL_D
ESC_C
Work
History
Detail
Description
SVMXC__Ser
vice_ Order_
Line__c
See
comments.
Multiple If this field is not null, the value could
be any of the following:
• Activity:
SVMXC__Service_Order_Line__c.S
VMXC__Activity_Type__c
• Cost Category:
SVMXC__Service_Order_Line__c.S
VMXC__Cost_Category__c
• Expense Type:
SVMXC__Service_Order_Line__c.S
VMXC__Expense_Type__c
• Status:
SVMXC__Service_Order_Line__c.S
VMXC__Line_Status__c
• Type:
SVMXC__Service_Order_Line__c.S
VMXC__Line_Type__c
• Description:
SVMXC__Service_Order_Line__c.S
VMXC__Work_Description__c
• Part:
SVMXC__Serial_Number__r.id
MI_DTWKHIST_EVNT_DTL_I
D_C
Work
History
Detail ID
SVMXC__Ser
vice_Order__
c and
Service_Req
uest__r
Concatenati
on of WH-
Service_Req
uest__r.Nam
e
+SVMXC__Se
rvice_Order_
_c .NAME
Work Order The value of this field identifies the
associated work order. For example,
WH-SR-00000341-WO-00000025. If
there is no service request, the field
has the format WH-WO-00000025.
MI_DTWKHIST_WRK_HISTRY
_ID_C
Work
History ID
SVMXC__Ser
vice_Order_L
ine__c,
SVMXC__Ser
vice_Order__
c and
Service_Req
uest__r
Concatenati
on of WHD-
Service_Req
uest__r.Nam
e
+SVMXC__Se
rvice_Order_
_c .NAME
+SVMXC__Se
rvice_Order_
Line__c.Nam
e
Work Detail
Number
The value in this field identifies the
record that contains the details of
work performed. For example, WHD-
SR-00000341-WO-00000025-
WL-0000123. If there is no service
request, the field has the format
WHD-WO-00000025-WL-0000123.
© 2020 General Electric Company 35
ServiceMax Work History EstimatesWork History records contain information received from ServiceMax about the estimates of time andresources required to perform required work for an asset.
All of these fields belong to the GE Digital APM FSM Estimate family (ID: MI_FSM_EST_WHD).
ServiceMax Field ServiceMaxAdapter Label
GE DigitalAPM FieldID
GE DigitalAPMFamilyFieldCaption
Comments
Concatenation of WH-
Service_Request__r.Name and
SVMXC__Service_Order__c .NAME
N/A MI_FSM_ES
T_WHD_EV
NT_DTL_ID_
C
Work
History
Detail ID
This is a key field.
If both service request and work order
are present, this field has the format
WH-SR-00000341-WO-00000025.
If no service request is present, then
this field has the format WH-
WO-00000025.
Concatenation of WHD-
Service_Request__r.Name and
SVMXC__Service_Order__c .NAME and
SVMXC__Service_Order_Line__c.Name
N/A MI_FSM_ES
T_WHD_WR
K_HIST_ID_
C
Work
History IDThis is a key field. This field has the
format WHD-SR-00000341-
WO-00000025-WL-0000042.
Name WO MI_FSM_ES
T_WHD_OR
DR_ID_C
Order ID This is a key field.
The value of this field is the Work Order
Number in ServiceMax.
Name WL MI_FSM_ES
T_WHD_DT
L_ID_C
Detail ID The value of this field is the Work Detail
Number in ServiceMax.
Name Record Type MI_FSM_ES
T_WHD_RE
C_TP_C
Record
Type
The value of this field is the Record
Type in ServiceMax.
SVMXC__Line_Type__c Line Type MI_FSM_ES
T_WHD_DT
L_TP_C
Line Type The value of this field is the Line Type in
ServiceMax. This value can be Parts,
Labor, or Expenses.
SVMXC__Activity_Type__c Activity Type MI_FSM_ES
T_WHD_AC
T_TP_C
Activity
Type
The value of this field is the Activity
Type in ServiceMax. The value is usually
present for labor line types.
SVMXC__Product__c Part MI_FSM_ES
T_WHD_PA
RT_ID_C
Part Record
ID
The value of this field is the product
estimated as defined in a Salesforce
product record.
SVMXC__Estimated_Quantity2__c Estimated
Quantity
MI_FSM_ES
T_WHD_QT
Y_N
Estimated
Quantity
The value of this field is the Estimated
Quantity in ServiceMax. The value is
context-sensitive. For example, the
quantity for travel expenses would be
in miles.
36 © 2020 General Electric Company
ServiceMax Field ServiceMaxAdapter Label
GE DigitalAPM FieldID
GE DigitalAPMFamilyFieldCaption
Comments
SVMXC__Use_Price_From_Pricebook__c Use Pricebook MI_FSM_ES
T_WHD_PRI
CEBOOK_L
Use
Pricebook
The value of this field specifies whether
to use the default price defined in a
price book for the estimate. Valid
values are TRUE or FALSE.
SVMXC__Estimated_Price2__c Estimated Unit
Price
MI_FSM_ES
T_WHD_UNI
T_PRICE_N
Estimated
Unit Price
The value of this field is the total
estimated price for this line item,
whether it is for parts, labor, or
expense.
SVMXC__Discount__c Discount
Percentage
MI_FSM_ES
T_WHD_DIS
C_N
Discount
Percentage
The value of this field is the percent
discount applied to this line item.
SVMXC__Include_in_Quote__c Included in Quote MI_FSM_ES
T_WHD_IN_
QUOTE_L
Included in
Quote
The value of this field specifies whether
this expense is covered by a warranty
or contract. The valid values are:
• TRUE - Include this expense in a
quote for approval by a customer.
• FALSE - The expense is covered by
a warranty or contract and should
not be included in a quote.
SVMXC__Cost_Category__c Cost Category MI_FSM_ES
T_WHD_CO
ST_CAT_C
Cost
Category
The value of this field is the Cost
Category in ServiceMax that is applied
to this line item.
SVMXC__Expense_Type__c Expense Type MI_FSM_ES
T_WHD_EX
P_TP_C
Expense
Type
The value of this field is the Expense
Type in ServiceMax.
© 2020 General Electric Company 37
ServiceMax Field ServiceMaxAdapter Label
GE DigitalAPM FieldID
GE DigitalAPMFamilyFieldCaption
Comments
SVMXC__Start_Date_and_Time__c Start Time MI_FSM_ES
T_WHD_ST
ART_DT_D
Start Time The value of this field is the estimated
date and time to begin the activity is
this is a Labor Line Type.
The value of this field has the format
YYYY-MO-DDTHH:MN:SS.ttt+OOOO,
where:
• YYYY is the 4-digit year.
• MO is the 2-digit month.
• DD is the 2-digit day.
• HH is the 2-digit hour in 24-hour
time.
• MN is the 2-digit minute.
• SS is the 2-digit second.
• ttt is the 3 digit thousandths of a
second.
• OOOO is the 4-digit offset from
UTC.
SVMXC__End_Date_and_Time__c End Time MI_FSM_ES
T_WHD_EN
D_DT_D
End Time The value of this field is the estimated
date and time to end the activity is this
is a Labor Line Type.
The value of this field has the format
YYYY-MO-DDTHH:MN:SS.ttt+OOOO,
where:
• YYYY is the 4-digit year.
• MO is the 2-digit month.
• DD is the 2-digit day.
• HH is the 2-digit hour in 24-hour
time.
• MN is the 2-digit minute.
• SS is the 2-digit second.
• ttt is the 3 digit thousandths of a
second.
• OOOO is the 4-digit offset from
UTC.
SVMXC__Work_Description__c Work Description MI_FSM_ES
T_WHD_DT
L_DESC_TX
Work
Description
This field specifies an assessment of
the work or additional details about the
line item.
38 © 2020 General Electric Company
ServiceMax Field ServiceMaxAdapter Label
GE DigitalAPM FieldID
GE DigitalAPMFamilyFieldCaption
Comments
SVMXC__Total_Estimated_Price__c Total Estimated
Price
MI_FSM_ES
T_WHD_TTL
_PRICE_N
Total
Estimated
Price
The value of this field is the Total
Estimated Price which is calculated
using the values of the Estimated
Quantity and Estimated Unit Price
(Estimated Quantity x Estimated Unit
Price).
Description Record Type MI_FSM_ES
T_WHD_RE
C_TP_DESC
_C
Record
Type
Description
The value of this field is a description of
the Record Type.
Name Part Name MI_FSM_ES
T_WHD_PA
RT_NM_C
Part Name The value of this field is the product
estimated as defined in a Salesforce
product record.
SVMXC__Line_Status__c Line Status MI_FSM_ES
T_WHD_DT
L_STATUS_
C
Line Status The value of this field is the current
status of this line item.
ServiceMax Work History Request/ReceiptWork History records contain information received from ServiceMax about the work requested for anasset and any acknowledgements that the request has been received.
The following table describes the fields that belong to the GE Digital APM FSM Request/Receipt family (ID:MI_FSM_RR_WHD).
© 2020 General Electric Company 39
ServiceMax Field ServiceMax Adapter Label GE DigitalAPM Field ID
GE DigitalAPM FamilyField Caption
Comments
Concatenation of WH-
Service_Request__r.Name and
SVMXC__Service_Order__c .NA
ME
Work Order MI_FSM_RR_
WHD_EVNT_D
TL_ID_C
Work History
Detail IDThis is a key
field.
If both service
request and
work order
are present,
this field has
the format
WH-
SR-00000341-
WO-0000002
5.
If no service
request is
present, then
this field has
the format
WH-
WO-0000002
5.
Concatenation of WHD-
Service_Request__r.Name and
SVMXC__Service_Order__c .NA
ME and
SVMXC__Service_Order_Line__
c.Name
Work Detail Number MI_FSM_RR_
WHD_WRK_HI
ST_ID_C
Work History
IDThis is a key
field.
This field has
the format
WHD-
SR-00000341-
WO-0000002
5-
WL-0000042.
Name Work Order MI_FSM_RR_
WHD_ORDR_I
D_C
Order ID This is a key
field.
The value of
this field is
the Work
Order
Number in
ServiceMax.
Name Work Line MI_FSM_RR_
WHD_DTL_ID_
C
Detail ID The value of
this field is
the Work
Detail
Number in
ServiceMax.
40 © 2020 General Electric Company
ServiceMax Field ServiceMax Adapter Label GE DigitalAPM Field ID
GE DigitalAPM FamilyField Caption
Comments
Name Record Type MI_FSM_RR_
WHD_REC_TP
_C
Record Type The value of
this field is
the Record
Type in
ServiceMax.
SVMXC__Product__c Part MI_FSM_RR_
WHD_PART_I
D_C
Part Record ID The value of
this field is
the product
requested as
defined in a
Salesforce
product
record.
SVMXC__Requested_Quantity
2__c
Requested Quantity MI_FSM_RR_
WHD_REQ_QT
Y_N
Requested
Quantity
The value of
this field is
the number of
uits required
for this
location.
SVMXC__Date_Requested__c Date Required MI_FSM_RR_
WHD_REQ_DT
_D
Date Required The value of
this field is
the date the
part is
required at
this location.
The format of
this field is
MM/DD/YYYY.
SVMXC__From_Location__c From Location MI_FSM_RR_
WHD_FROM_
LOC_C
From Location The value of
this field is
the ID of the
location from
which parts
are required.
Name From Location Name MI_FSM_RR_
WHD_FROM_
LOC_NM_C
From Location
Name
The value of
this field is
the name of
the location
from which
parts are
required.
SVMXC__Requested_Location_
_c
To Location MI_FSM_RR_
WHD_TO_LOC
_C
To Location The value of
this field is
the ID of the
requesting
location.
© 2020 General Electric Company 41
ServiceMax Field ServiceMax Adapter Label GE DigitalAPM Field ID
GE DigitalAPM FamilyField Caption
Comments
Name To Location Name [MI_FSM_RR_
WHD_TO_LOC
_NM_C
To Location
Name
The value of
this field is
the name of
the
requesting
location.
SVMXC__Requested_Street__c Requested Street MI_FSM_RR_
WHD_REQ_ST
_C
Requested
Street
The value of
this field is
the street
address of the
requesting
location.
SVMXC__Requested_City__c Requested City MI_FSM_RR_
WHD_REQ_CI
TY_C
Requested
City
The value of
this field is
the city of the
requesting
location.
SVMXC__Requested_State__c Requested State MI_FSM_RR_
WHD_REQ_ST
ATE_C
Requested
State
The value of
this field is
the state of
the
requesting
location.
SVMXC__Requested_Country_
_c
Requested Country MI_FSM_RR_
WHD_REQ_CO
UNTRY_C
Requested
Country
The value of
this field is
the country of
the
requesting
location.
SVMXC__Requested_Zip__c Requesting Zip MI_FSM_RR_
WHD_REQ_ZI
P_C
Requesting
Zip
The value of
this field is
the postal
code of the
requesting
location.
SVMXC__Received_Quantity2_
_c
Received Quantity MI_FSM_RR_
WHD_REC_QT
Y_N
Received
Quantity
The value of
this field is
the current
quantity of
parts
received.
42 © 2020 General Electric Company
ServiceMax Field ServiceMax Adapter Label GE DigitalAPM Field ID
GE DigitalAPM FamilyField Caption
Comments
SVMXC__Date_Received__c Date Received MI_FSM_RR_
WHD_REC_DT
_D
Date Received The value of
this field is
the most
recent date
on which
parts were
received.
Name Part Name MI_FSM_RR_
WHD_PART_N
M_C
Part Name The value of
this field is
the product
requested as
defined in a
Salesforce
product
record.
SVMXC__Line_Status__c Line Status MI_FSM_RR_
WHD_DTL_ST
ATUS_C
Line Status The value of
this field is
the current
status of this
line item.
Description Record Type Description MI_FSM_RR_
WHD_REC_TP
_DESC_C
Record Type
Description
The value of
this field is an
assessment
of the work to
be performed
or additional
details about
this line item.
SVMXC__Line_Type__c Line Type MI_FSM_RR_
WHD_DTL_TP
_C
Line Type The value of
this field is
the type of
this line item.
Valid values
are Parts,
Labor, or
Expenses.
ServiceMax Work History Usage/ConsumptionWork History records contain information received from ServiceMax about the actual resources used tocomplete the work requested for an asset.
All of these fields belong to the GE Digital APM FSM Usage/Consumption family (ID: MI_FSM_USG_WHD).
© 2020 General Electric Company 43
GE DigitalAPM Field ID
GE DigitalAPM FamilyField Caption
ServiceMax Field ServiceMaxAdapter Label
Comments
MI_FSM_USG_
WHD_EVNT_DT
L_ID_C
Work History
Detail ID
Concatenation of WH-
Service_Request__r.Na
me and
SVMXC__Service_Order_
_c .NAME
Work Order This is a key field.
If both service request and work order are present,
this field has the format WH-SR-00000341-
WO-00000025.
f no service request is present, then this field has
the format WH-WO-00000025.
MI_FSM_USG_
WHD_WRK_HI
ST_ID_C
Work History
ID
Concatenation of WHD-
Service_Request__r.Na
me and
SVMXC__Service_Order_
_c .NAME and
SVMXC__Service_Order_
Line__c.Name
Work Detail
NumberThis is a key field.
This field has the format WHD-SR-00000341-
WO-00000025-WL-0000042.
MI_FSM_USG_
WHD_ORDR_ID
_C
Order ID Name WO This is a key field. The value of this field is the Work
Order Number in ServiceMax.
MI_FSM_USG_
WHD_DTL_ID_C
Detail ID Name WL The value of this field is the Work Detail Number in
ServiceMax.
MI_FSM_USG_
WHD_REC_TP_
C
Record Type Name Record Type The value of this field is the Record Type in
ServiceMax.
MI_FSM_USG_
WHD_DTL_TP_
C
Line Type SVMXC__Line_Type__c Line Type The value of this field is the Line Type in
ServiceMax. Valid values are Parts, Labor, or
Expenses.
MI_FSM_USG_
WHD_ACT_TP_
C
Activity Type SVMXC__Activity_Type_
_c
Activity Type The value of this field is the Activity Type in
ServiceMax. The value is usually present for labor
line types.
MI_FSM_USG_
WHD_PART_ID_
C
Part Record ID SVMXC__Product__c Part The value of this field is the product used as
defined in a Salesforce product record.
MI_FSM_USG_
WHD_QTY_N
Line Quantity MI_FSM_USG_WHD_QTY
_N
Line Quantity The value of this field is the actual units used. The
value is context sensitive. For example, the
quantity for travel expenses would be miles.
MI_FSM_USG_
WHD_PRICEBO
OK_L
Use Pricebook SVMXC__Use_Price_Fro
m_Pricebook__c
Use Pricebook The value of this field specifies whether to use the
default price defined in a price book. Valid values
are TRUE or FALSE.
MI_FSM_USG_
WHD_UNIT_PRI
CE_N
Line Unit Price SVMXC__Actual_Price2_
_c
Line Unit Price The value of this field is the actual price of this line
item, whether it is for parts, labor, or expenses.
MI_FSM_USG_
WHD_IS_BILL_L
Billable SVMXC__Is_Billable__c Is Billable The value of this field specifies whether this line
item is billable to the customer. Valid values are
TRUE or FALSE.
44 © 2020 General Electric Company
GE DigitalAPM Field ID
GE DigitalAPM FamilyField Caption
ServiceMax Field ServiceMaxAdapter Label
Comments
MI_FSM_USG_
WHD_COST_CA
T_C
Cost Category SVMXC__Cost_Category
__c
Cost Category The value of this field is the Cost Category in
ServiceMax that is applied to this line item.
MI_FSM_USG_
WHD_EXP_TP_
C
Expense Type SVMXC__Expense_Type_
_c
Expense Type The value of this field is the Expense Type in
ServiceMax.
MI_FSM_USG_
WHD_START_D
T_D
Start Time SVMXC__Start_Date_an
d_Time__c
Start Time The value of this field is the actual start date and
time of the work.
The value of this field has the format YYYY-MO-
DDTHH:MN:SS.ttt+OOOO, where:
• YYYY is the 4-digit year.
• MO is the 2-digit month.
• DD is the 2-digit day.
• HH is the 2-digit hour in 24-hour time.
• MN is the 2-digit minute.
• SS is the 2-digit second.
• ttt is the 3 digit thousandths of a second.
• OOOO is the 4-digit offset from UTC.
MI_FSM_USG_
WHD_END_DT_
D
End Time SVMXC__End_Date_and
_Time__c
End Time The value of this field is the actual end date and
time of the work.
The value of this field has the format YYYY-MO-
DDTHH:MN:SS.ttt+OOOO, where:
• YYYY is the 4-digit year.
• MO is the 2-digit month.
• DD is the 2-digit day.
• HH is the 2-digit hour in 24-hour time.
• MN is the 2-digit minute.
• SS is the 2-digit second.
• ttt is the 3 digit thousandths of a second.
• OOOO is the 4-digit offset from UTC.
MI_FSM_USG_
WHD_DTL_REF
_TX
Reference
Information
SVMXC__Reference_Info
rmation__c
Reference
Information
The value of this field is additional information
about the completed work. For example, a travel
ticket number.
MI_FSM_USG_
WHD_TTL_PRIC
E_N
Total Line Price SVMXC__Total_Line_Pric
e__c
Total Line Price The value of this field is the actual total price of
this line item.
MI_FSM_USG_
WHD_REC_TP_
DESC_C
Record Type
Description
Description Record Type
Description
The value of this field is a description of the Record
Type.
© 2020 General Electric Company 45
GE DigitalAPM Field ID
GE DigitalAPM FamilyField Caption
ServiceMax Field ServiceMaxAdapter Label
Comments
MI_FSM_USG_
WHD_PART_N
M_C
Part Name Name Part Name The value of this field is the part name as defined
in a Salesforce product record.
MI_FSM_USG_
WHD_DTL_STA
TUS_C
Line Status SVMXC__Line_Status__c Line Status The value of this field is the current status of the
service order.
ServiceMax Recommendation MappingsThe following table explains the GE Digital APM Recommendation fields that are used to populateServiceMax Service Request records when using the ServiceMax Adapter.
All of these fields belong to the GE Digital APM Recommendation family (ID: MI_REC).
ServiceMax Field ServiceMax Label GE Digital APM Field
SVMXC__Subject__c Product description MI_REC_SHORT_DESCR_CHR
SVMXC__Problem_Description__c Problem description MI_REC_LONG_DESCR_TX
SVMXC__Priority__c Priority MI_REC_PRIORITY_C
None Create date MI_REC_CREAT_DATE_DT
SVMXC__Type__c Alert type MI_REC_TYPE_CHR
SVMXC__Status__c Status of the service request MI_REC_STATU_CHR
SVMXC__Preferred_start_Time__c Start time for the service request EVNT_START_DT
SVMXC__Service_Request_Source__c The source of the service request APM
The request comes from the GE Digital
APM system.
Record_ID Service record Id MI_REC_EAM_SERVICE_REQ_ID_C
Equipment_ID__c Equipment ID Equipment ID
46 © 2020 General Electric Company
Chapter
5Release NotesTopics:
• First Quarter of 2020• Third Quarter of 2019• Third Quarter of 2018
© 2020 General Electric Company 47
First Quarter of 2020
Release Date: March 27, 2020This topic provides a list of product changes released for this module on this date.
Table 1: Known Issues and Limitations
The following known issues and limitations exist.
Description Tracking ID
For ingestion of Assets to Predix APM, you can ingest a file of size up to 10 MB. DE120299
Third Quarter of 2019
ServiceMax UDLPThis topic contains a list of product changes released for this adapter.
Release Date: September 27, 2019
Table 2: Known Issues
The following issues are unresolved in this release.
Description Tracking ID
The synchronization of data from GE Digital APM to ServiceMax is not functional. DE119075
Third Quarter of 2018
ServiceMax UDLP V2.5.0This topic contains a list of product changes released for this adapter.
To view the release notes for versions released prior to Q3 2018, see https://www.ge.com/digital/documentation/meridium/ReleaseNotes/APMConnect/APMConnect.htm.
Release Date: September 21, 2018
There are no release notes for this release.
48 © 2020 General Electric Company
top related