Admin

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

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.

   Parameter	Description	Recommended or Default Value
   Generated jobs folder	The path to the folder with the Job execution archives.	C:\APMConnect\Logs\generated_jobs
   Tasks logs folder	The path to the folder with the Job execution logs.	C:\APMConnect\Logs\execution_logs

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.

    Parameter	Description	Recommended or Default Value
    Technical file appender	The 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 appender	The host and port corresponding to the Logstash instance.	localhost:8050

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.

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.

   Role	Read Permissions by Module	Write Permissions by Module
   Administrator	None.	License, Configuration, Users, Projects, Rights Management, Backup, Notifications, Software Updates
   Operations Manager	Projects, EBS Publisher, Service Activity Monitoring, Authorization, Service Registry, Studio, Repository Browser	Configuration, Lock, Notifications, Servers, Job Conductor, ESB Conductor, Execution Plan, Monitoring Audit BRMS (Drools), Service Locator
   Designer	Configuration, Projects, Servers, Job Conductor, EBS Conductor, EBS Conductor, EBS Publisher, Execution Plan, Monitoring	Execution Plan, Audit, BRMS (Drools), Service Locator
   Viewer	Servers, Job Conductor, Execution Plan, Audit, Studio, Repository	None.

5. Select Validate, and then select Save.
6. Select .

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.

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.

APM Connect uses log4j version 1.2 to log events and provides a default configuration for logging events. These steps describe how to modify this default configuration.

1. On the APM Connect Server, navigate to the folder C:\APMConnect\Config.
2. Open the file log4j.properties in an application that you can use to modify a text file (for example, Notepad).
3. Modify the log4j.rootLogger statement to select the correct severity level and appender. Consider the following example of a modified statement:

   log4j.rootLogger=ERROR, fileout

   ...where the first value is the severity level and the second value is the appender to use. You can enter any of the following values as the severity level:

   • TRACE
   • DEBUG
   • INFO
   • WARN
   • ERROR
   • FATAL
   • OFF

   Note: The TRACE level is not advised when using APM Connect. Use DEBUG only when actively researching an issue as the log files can be large and cause performance issues. The ERROR level is the recommended level for normal operation.

   The severity level that you configure controls the messages written to the log. Each severity causes the system to filter messages above that type in the preceding list.

   Note: The appender value must be either fileout or consoleout.

   Important: To collect the most complete information, do not change the conversion pattern on any appender you use.
4. Modify the log4j.logger.org.apache.cd statement to log the Web Service request and response messages. The format is similar to that previously shown for log4j.rootlogger.
5. Modify the log4j.logger.org.apache.activemq statement to enable the logging levels for ActiveMQ messages. The format is similar to to that previously shown for log4j.rootlogger.
6. If you use the console appender, uncomment all statements containing consoleout and comment the statements containing fileout. Consider the following example:

   # consoleout is set to be a ConsoleAppender.
   log4j.appender.consoleout=org.apache.log4j.ConsoleAppender
   log4j.appender.consoleout.Threshold=DEBUG
   log4j.appender.consoleout.layout=org.apache.log4j.PatternLayout
   log4j.appender.consoleout.layout.ConversionPattern=[%-5p][%d{dd MMM yyyy HH:mm:ss}][%t][%c][%M] %x - %m%n
   #fileout uses fileAppender
   #log4j.appender.fileout=org.apache.log4j.RollingFileAppender
   #log4j.appender.fileout.Threshold=debug
   #log4j.appender.fileout.MaxFileSize=1MB
   #log4j.appender.fileout.MaxBackupIndex=2
   #log4j.appender.fileout.File=${LOG}/${LOG_FILE}
   #log4j.appender.fileout.Append=true
   #log4j.appender.fileout.layout=org.apache.log4j.PatternLayout
   #log4j.appender.fileout.layout.ConversionPattern=[%-5p][%d{dd MMM yyyy HH:mm:ss}][%t][%c][%M] %x - %m%n

7. If you use the file rolling appender:
   1. Modify the log4j.appender.fileout.MaxFileSize value to the appropriate size for your installation.
   2. Modify the log4j.appender.fileout.MaxBackupIndex value to the number of log files you want to keep.
8. Save the file.

   Event logging has been configured.

There may be times when you need to either map values from Predix Essentials to your source system or add a default value for a field in your source system from Predix Essentials. This topic describes how to achieve this goal.

About This Task

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

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

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.

1. Using a database tool, navigate to the Predix Essentials 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 configure	How to configure
   Field mapping	In the apm_field_name column, enter the name of the Predix Essentials 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 Predix Essentials 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 value	In 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.

1. In the module navigation menu, select Admin > Operations Manager > APM Connect EAM Jobs.

   The APM Connect EAM Jobs page appears, displaying the list of APM Connect EAM jobs that are running or complete.

2. Identify the EAM job record that is an active status that you want to cancel.
3. In the Status and Log column of the job record that you want to cancel, select .
   The job is cancelled and the status of the job is changed to Cancelled by User.

   Note: If you cancel a job, any changes that are already done are not removed. Therefore, you may need to manually modify records to update or remove unnecessary data.

When upgrading in a cloud environment or an adapter, you have to delete the old adapter job before installing the new job.

1. Access the APM Connect Administration Center.
2. In the Menu pane, in the Conductor section, select Job Conductor.

   The Job Conductor workspace appears.

3. In the Job Conductor workspace, select the job you want to delete, and then, at the top of the workspace, select .

1. Access the APM Connect page.

   The APM Connect Configuration workspace appears.

2. In the APM Connect Configuration workspace, configure the parameters on the APM Connect Connection record in the following sections.
   • General Settings: Established the connection between the APM Connect server and Predix Essentials.
     Important: The General Settings section must be configured if you are using either the Data Loaders or the EAM adapters.
   • Data Loaders Settings: Stores the staging database parameters and the remote file server settings.
   • EAM Settings : Used to schedule work orders, which determine how frequently work orders will be transferred to your SAP.
     Note: These settings are only required for the SAP adapters.
3. Select Save.

1. Access the APM Connect page, and then select Data Loaders settings.

   The Data Loaders Settings workspace appears.

2. In the Logging Level box, use the drop-down to select one of the following logging levels:
   • Debug: The default logging level, and the highest level of logging. Selecting debug will return the most details and is helpful when trying to debug the application.
   • Info: Returns information message indicating the progress of the application, and is the second highest level of logging.
   • Warn: Returns warnings detected during the loading process.
   • Error: The lowest level of logging returning errors only.

   Notes:

   • Logging levels are hierarchical. For example, if you select Info, you will see all warnings and errors. If you select Error, you will only see errors.
   • If you are loading a large amount of data, you should use logging level Warn or Error to improve performance, unless debugging a problem.
3. Select Save.

   The record is saved.