Admin

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.

Procedure

  1. Open a web browser, and then enter the following URL into your web browser: http://localhost or hostname provided:8080/apmconnect/.
  2. In the Data Parameters window (if it appears, refer to the Step 3), in the Password box, enter postgres, and then select OK.
  3. If the TAC license file was not provided during the install step you will get the Database Parameters window to setup the license. If already provided you will get the APM Connect Login Page (Check step 5).
  4. Select .

    The Database parameters window appears, and a check is performed by the APM Connect Administration Center.

    Important: If your license does not validate, you can validate your license manually.
  5. If your license validates, in the Database parameters window, select Go to login page.

    The Login page appears.

  6. In the Login window, enter the required information and then select Login.
    • In the Login box, enter the default username: [email protected].
    • In the Password box, enter the default password: admin.

    The APM Connect Administration Center is successfully deployed, and the APM Connect Administration Center Welcome page appears.

  7. Add an APM Connect Service User using the following steps:
    1. Select Users in the Menu Pane, and then select Add.
    2. Add the following information:
      • Login ID – preferably an e-mail id. For example, [email protected]
      • First Name and Last Name – Add an identifier name
      • Password – Preferably admin or user defined
      • Type – Data Integration/ESB
      • For the Role select all the roles except Auditor
    3. Select Save.
  8. Logout of the APM Connect Administration Center and then log back in as the Service user that you setup in Step 7 (For example, [email protected]/admin).
  9. Select a Project on the Welcome page.
    Note: If no project is displayed you can add a new project titled APMCONNECT_UNIFIED_PLATFORM with Project Type value set as Data Integration/ESB and Storage value set as None.
  10. In the Menu pane select Project Authorizations
  11. In the Project section select the project APMCONNECT_UNIFIED_PLATFORM, and provide the Read and Write access to the newly created service user.
  12. In the Menu pane select Servers to check the execution server details.
  13. If no Server is displayed, then add a server with Label value set as JobServer and other values configured as shown below:
  14. Select Save.
  15. In the Menu pane select Job Conductors to check if any jobs are deployed.
    Note: If jobs are not deployed then the APM Connect jobs provided need to be deployed manually.

Configure the APM Connect Administration Center

This topic describes how to configure the APM Connect Administration Center.

About This Task

Depending on whether you are using the EAM Adapters or the Data Loaders, configuring the APM Connect Administration Center requires defining parameters for some or all of the following components: Commandline, Job conductor, Monitoring, and Log4j.

Procedure

  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. Make sure that the folders already exist.
    ParameterDescriptionRecommended or Default Value
    Generated jobs folderThe path to the folder with the Job execution archives. C:\APMConnect\Logs\generated_jobs
    Tasks logs folderThe path to the folder with the Job execution logs.C:\APMConnect\Logs\execution_logs
  6. Select the Servers group to expand the workspace.
  7. In the workspace, select Add, and then select Add Server.
  8. In the Execution server section, configure the server.
    1. Enter the name of the administrator host in the Label:, Description:, and Host: boxes.
    2. Select the Meridium Runtime check box.
    3. Select Save.
      The server configuration is saved.
    4. Select the server you just added to verify the configuration.
      All of the server indicators should be green.
  9. Select the Monitoring (2 Parameters) group to expand the workspace.
    Note: Configuring this parameter is optional.
  10. Select the Log4j (4 Parameters) group to expand the workspace.
  11. Using the following table as a guide, enter the necessary parameters.
    ParameterDescriptionRecommended or Default Value
    Technical file appenderThe path to the technical log file of the APM Connect Administration Center. C:/APMConnect/Utilities/Tomcat/logs/technical.log
    Technical log threshold The level of logs you want to append. WARN
    Business log file path The path to the business log file of the APM Connect Administration Center.C:/APMConnect/Utilities/Tomcat/logs/business.log
    Technical logstash appenderThe host and port corresponding to the Logstash instance.localhost:8050

Results

The APM Connect Administration Center parameters are configured.

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.

Procedure

  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.
    Tip: 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.

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 the user roles.

Before You Begin

A user must be authorized for a project before they can view or change sections associated with a project.

Procedure

  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 section is activated.

  3. In the Data section, next to the Role: box, select .
  4. In the Role Selection window, select each check box to assign the user all roles, or select the box of the role(s) you want to assign the user, based on the following table:
    Important: To access the Job Conductor, you must designate at least one user the role of Operation Manager.
    RoleRead Permissions by ModuleWrite Permissions by Module
    AdministratorNone.License, Configuration, Users, Projects, Rights Management, Backup, Notifications, Software Updates
    Operations ManagerProjects, 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
    DesignerConfiguration, Projects, Servers, Job Conductor, EBS Conductor, EBS Conductor, EBS Publisher, Execution Plan, MonitoringExecution Plan, Audit, BRMS (Drools), Service Locator
    ViewerServers, Job Conductor, Execution Plan, Audit, Studio, RepositoryNone.
  5. Select Validate, and then select Save.

Results

The user permissions are set.

Configure Logging

APM Connect uses Apache log4j version 2 to log events. It includes a default xml configuration for logging events. You can personalize logging by using an xml-based custom configuration file, which can be passed through the JVM argument parameter in the Job Conductor task, Dlog4j.configurationFile={path to custom xml file}. For more details, refer to the apache logging framework.

Deploy Audit Job for Adapters

The Audit job helps to get audit data, including Date Control and Success/Failure records from GE Digital APM. An Audit job can be scheduled to run for specified minutes or hours, or on a daily basis in the APM Connect Administration Center.

Set Up the Audit Job

Before You Begin

  • APM Connect must be installed.
  • Context file must be set up and have details of IR, GE Digital APM, and ActiveMQ.

Procedure

  1. Access the APM Connect Administration Center.
  2. In the Menu pane, in the Conductor section, select the Job Conductor tab.
  3. In the Job Conductor menu, 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 AuditJob.zip, and then select Launch upload.
    The job is imported into the Job Conductor.
  10. Configure the context file to identify the details of the IR, GE Digital APM, and APM ActiveMQ.
  11. Modify the <Context_File_PATH> value in the Job Conductor context parameters to point to the context file for the job.
  12. Schedule a trigger or run the job.

Results

The Job Conductor indicates that the job ran successfully or the trigger is active.

Configure the Context File

Before You Begin

You should have imported the audit job.

About This Task

The context file provides the audit job with the information it needs to connect to ActiveMQ, IR, and GE Digital APM.

Procedure

  1. Navigate to the following folder: C:\APMConnect\Config\<system>.
  2. Modify ContextFile.xml to indicate the values for your system.

Results

ParameterDescriptionDefault or Recommended Value
CONFIG_FILE_PATHThe path to the context file used for extraction.Enter your unique value (for example, C:\APMConnect\Config\ContextFile.xml).
IR_HOSTIntermediary Repository host name.Enter your unique value.
IR_DATABASEDatabase for the dinoloader job.Enter your unique value.
IR_USERIDIntermediary Repository username.Enter your unique value.
IR_PASSWORDIntermediary Repository password.Enter your unique value.
IR_SCHEMAThe schema in which the IR database will be created.The default value is public.
IR_PORTIntermediate Repository port.Default value is 5432.
APM_USERIDThe APM user ID.Enter your unique value.
APM_PASSWORDThe APM password.Enter your unique value.
APM_DATASOURCEThe name of the APM data source to which the data will be exported.This is a required parameter.

Enter your unique value.

APM_API_APP_SERVERThe name of the APM API server.This is a required parameter.

Enter your unique value.

APM_APP_SERVERThe name of the APM server.This is a required parameter.

Enter your unique value.

TRUSTSTORE_FILEThe directory path to the dinoloader SSL configuration file.Enter your unique value.
TRUSTSTORE_PASSWORDThe password for the keystore files.Enter your unique value.
USE_SSLDetermines if SSL is used.

True: will use SSL.

False: will not use SSL.

QUEUE_HOSTThe host name of the APM ActiveMQ.Enter your unique value.
QUEUE_PORTAPM ActiveMQ port.Default port is 61616.
QUEUE_USERAPM ActiveMQ user.Enter your unique value.
QUEUE_PASSWORDAPM ActiveMQ password.Enter your unique value.
CMMS_IDEnter your EAM system IDEnter your unique value.

Create the Intermediate Repository Database

This topic describes how to set up a repository in preparation to run your first job.

Before You Begin

Important: If you are using both the Data Loaders and an EAM Adapter, you need only one Intermediate Repository Database.
  • Before you can prepare and deploy the repository, you must import the CreateIntermediateRepository job.
  • If you are using the Data Loaders and the EAM Adapters, you must deploy and run the CreateIntermediateRepository job for each set of adapters.
  • For SAP adapters, you must first run the Static Data job.
  • For multiple EAM systems, the context file parameter values for a specific type of system must be identical except for the value of CMMS_ID.
  • For multiple EAM systems, the Intermediate Repository Connection parameters have the same values for all adapters connected to this GE Digital APM system.
Important: Each time you run the CreateIntermediateRepository you recreate the GE Digital APM database to the baseline settings, removing any previous configuration. When you run the addSourceSystem job, the job will add new source systems based on the CMMS_ID and the SOURCE_SYSTEM_TYPE. If the job is run an additional time with the same configuration, it will reset the control values of an existing source system.

Procedure

  1. 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.
    Note: For ServiceMax, this job is called CreateIntermediateRepository_ServiceMax.
  3. Select Context parameters.

    The Context parameters section appears.

  4. Configure the following parameter.
    Context ParameterDescription
    CONFIG_FILE_PATHThe file path to context files for the jobs.
    Important:
    • You must change the default value to reflect the actual path to your configuration file.
    • CMMS_ID and SOURCE_SYSTEM_TYPE must be set in the context file.
  5. Select Run.
    If you are configuring a single system, you have completed your configuration.
    The intermediate repository database is created for the project.

If you are configuring multiple EAM systems, perform the remaining steps in this topic.

  1. In the Job Conductor workspace, in the appropriate project, select the addSourceSystem job.
  2. Configure the following parameter.
    Context ParameterDescription
    CONFIG_FILE_PATHThe file path to context files for the jobs.
    Important:
    • You must change the default value to reflect the actual path to your configuration file.
    • CMMS_ID and SOURCE_SYSTEM_TYPE must be set in the context file.
  3. Select Run.
  4. Repeat steps 6 through 8 for all adapters.

Configure Source System Custom Field Mappings or Default Values

APM Connect documents a baseline set of fields that are considered standard in the APM to SAP Notification Creation integration with SAP. Additionally, there is capability to configure these and other fields to be included in the Notification Creation process. For information on the available fields to add to mapping, refer to the List of attributes that can be added to Notification Creation from APM to SAP topic. This topic describes how to configure additional baseline fields or make changes to default values.

Before You Begin

To successfully perform this task, you must have the following:

  • Administrative rights to the APM Connect database from which you are retrieving the field values or setting the default values.
  • A database tool, such as DBeaver or DBVisualizer.

About This Task

There are times when you need to have information that is stored in GE Digital APM displayed in your source system database. To achieve this goal, you need to modify tables used by GE Digital APM to send data to your source system.

Note: If Custom field mappings are needed, or fields that are not in this list, customization options exist with our Integration Center of Excellence engagement process.

The following procedure describes how to either configure a mapping between GE Digital APM and your source system or to set a default in your source system from GE Digital APM.

The following image is an example of the southbound_mapping_control table as displayed by a database tool.



Note: This feature is not available for creating work orders.

Procedure

  1. Using a database tool, navigate to the GE Digital APM database you want to configure.
  2. In the database navigation, in the Tables folder, select southbound_mapping_control.
  3. Navigate to the target_field_name and target_field_map_name column you want to configure.
  4. Configure the field mapping or default value for your source system.
    Item to configureHow to configure
    Field mapping

    In the apm_field_name column, enter the name of the GE Digital APM field that contains the value to apply in the source system, and then set the value in the mapping_enabled column to true

    For example, if you want to set the source system value of REPORTEDBY in map table REPORTEDBY_NOTIFHEADER from the GE Digital APM field CurrentUserID, the table would resemble the following when you complete your update.

    Important: If, after configuring the mapping, you see a blank value for the field, make sure the value you entered in the apm_field_name column is correct.
    Default valueIn the target_field_default column, enter the value you want to be the default in your source system and set the value in the mapping_enabled column to false.

Results

Your source system mappings or default values are configured.