Southbound Service Installation and Configuration

Overview

APM as part of the Install Package also delivers an installation package setup of the Southbound Service from the APM to the EAM system. The topics outline the steps that you must complete to deploy and configure this module for the first time. These instructions assume that you have completed the steps for deploying the basic APM system architecture.

Note: This service can be deployed on the APM Connect Server, APM server, or a dedicated server. The service should have access to the APM Connect Postgres Staging Database.

Installation Procedure

Before You Begin

Before you run the Southbound Services installer, you must:

Ensure that your system meets the System Requirements.
Ensure that you have access to the Southbound Services installation package.
Ensure that you can access the APM Server host URL and the ActiveMQ from the server where you plan to install the Service.
Ensure that you have access to the Postgres IR database of the APM Connect server.

Procedure

Sign in as a user with administrative privileges to the server where you plan to install the application.
Access the APM distribution package and then navigate to the folder.
Run the file installer APMConnect-Base.exe with administrative privileges.
The Setup - APMConnect window appears. Select Next.
Select Browse and select the destination folder where the services need to be installed.
Then, select the components that need to be installed and select Next, as shown in the screenshot below:
1. PostgreSQL is used for the Intermediate Repository. If you already have one, then clear the checkbox.
2. APM Connect Southbound Service is used for the Southbound Interfaces.
3. Boomi is used in an air-gapped situation (with no internet connectivity).
Select the Start Menu Folder for the Program Shortcuts and then select Next.
Then, verify the components that are ready for installation.
Select Install and the progress of the installation will be displayed.
After the Installation is complete, select Yes, restart the computer now and select Finish to restart the server.
After the restart, validate if the service APM Connect Southbound Service is running in the Service Panel and binaries in the installation folder.
After the installer is installed, the southbound service will not be in the start state. User needs to configure appsettings.json and then start the service manually.

Uninstall Boomi or Postgres Application

Procedure

Open the APMConnect - Uninstaller application. Select the required checkbox and select Uninstall.
Then, check if the service is removed from the Windows Service Panel.

APMC Southbound Service Configuration

Before starting the Southbound Service, the required configuration needs to be set up.

Southbound Service Configuration

The APM Connect Southbound Service configuration needs to be provided in the appsettings.json file in C:\\Program Files\APM.Connect.Southbound.

It consists of following sections:

Logging - Logging Level
FileWSDL - Contains the configuration for the EAM file receiver.
AppConfiguration contains the following:
- IR staging Database information
  - IR_Host
  - IR_Port
  - IR_Database
  - IR_Schema
  - IR_UserId
  - IR_Password
- ADL configuration
  - Default_Base_Directory - This is for the CSV file shared for the DL between APM and the APMC Southbound Service.
  - Directory_Path – This is for the ADL root folder of the Scan and Archive.
  - Polling_Frequency_In_MilliSeconds
  - Max_File_Size_In_Bytes
  - Max_Filename_Length
  - Valid_Extensions
  - Valid_Zip_Extensions
- APM (Application Server) configuration
  - Apm_Api_Test_Path
  - Web_Api_Path
  - DatasourceId
  - Id. (user-id)
  - Password
- EAM Server Connection Type Configuration
  - Sap_Connection_Type (Application/Message)
  - Use_API_Key (True/false)
  - API_Key
- APM Application ActiveMQ Credentials - For the v5 Audit Job:
  - ActivemqName (Queue name where the Asset Ingestion Completion Messages are posted by the Ingestor)
  - ActivemqUri
  - ActivemqUsername
  - ActivemqPassword

Southbound Service Configuration Example File

{
  "Urls": "http://0.0.0.0:8040",
  "Logging": {
    "LogLevel": {
      "Default": "Trace",
      "Microsoft.AspNetCore": "Trace"
    }
  },
  "Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware": "Information",
  "FileWSDL": {
    "UrlOverride": "",
    "VirtualPath": "",
    "WebServiceWSDLMapping": {
      "EamFileReceiver": {
        "UrlOverride": "EamFileReceiver",
        "WsdlFile": "EamFileReceiver.wsdl",
        "SchemaFolder": "Schemas",
        "WsdlFolder": "Schemas"
      }
    }
  },
  "AllowedHosts": "*",
  "AppConfiguration": {
    "IR_Host": "",
    "IR_Port": "5432",
    "IR_Database": "",
    "IR_Schema": "public",
    "IR_UserId": "",
    "IR_Password": "",
    "Is_Linux": false,
    "Linux_Base_Path": "",
    "Default_Base_Directory": "C:\\APMConnect\\ ADL",
    "Apm_Api_Test_Path": "/meridium/api/internal/connect/connectionstatus/ApmcToApm",
    "Use_SSL": false,
    "CmmsId": "", 
    "Integration_Api_Key": "",
    "Integration_Use_Api": true,
    "Sap_Connection_Type": "Application",
    "Use_API_Key": false,
    "API_Key": "",
    "DownStream_Request_Timeout_In_Minutes": 2,
    "Directory_Path": "\\\\{APM_CONNECT_HOST}\\APMConnect\\ ADL",
    "Web_Api_Path": "http://{APM_HOSTNAME}/meridium/api/v1",
    "Ingestor_Api_Path": "http://{Ingestor_HOSTNAME}/meridium/connect/api/v1",
    "DatasourceId": "",
    "Id": "",
    "Password": "",
    "Polling_Frequency_In_MilliSeconds": 0,
    "Max_File_Size_In_Bytes": 100000000,
    "Max_Filename_Length": 100,
    "Valid_Extensions": "zip,xlsx",
    "Valid_Zip_Extensions": "csv",
    "Sap_Cloud_Enabled": false,
    "Asset_Ingestion_Enabled": false,
    "Enable_G2DL_Ingestion": true,
	"ActivemqName": "ApmConnectIngestionCompleted",
    "ActivemqUri": "activemq://{APM_ACTIVE_MQ_HOST}:61616",
    "ActivemqUsername": "",
    "ActivemqPassword": ""
  },
  "ASPNETCORE_URLS": "http://+:8040",
  "DOTNET_PRINT_TELEMETRY_MESSAGE": false,
  "ASPNETCORE_ENVIRONMENT": "Production"
}