16.1 Configuring a Connector Instance for PTM

The PlateSpin Transformation Manager Appliance includes an instance of the PlateSpin Migrate Connector that is automatically installed and configured to work with the PTM Server on the Appliance. It works with all projects by default. After you set up multiple projects in Transformation Manager, you can add a ptm_project_id to the /opt/microfocus/migrate_connector/config/settings.cfg file on the Appliance to assign the Connector instance to a specific project.

You must manually configure each PlateSpin Migrate Connector instance that you deploy on your own Linux server.

16.1.1 About Connector Configuration Options

You must configure local settings for each PlateSpin Migrate Connector instance to enable it to connect to your PTM Server. Settings are in the /opt/microfocus/migrate_connector/config/settings.cfg file on the Connector host server.

Table 16-1 describes the configurable parameters in the PlateSpin Transformation Manager Server section and their default values.

Table 16-1 Configurable PTM Parameters for PlateSpin Migrate Connector

Parameter	Description	Examples
ptm_host	Specify the host name or IPv4 address of the PTM Appliance. The Migrate Connector instance on the Appliance uses localhost for this setting.	ptm_host=localhost ptm_host=10.10.10.101 ptm_host=myptm.example.com
ptm_port	Specify the port to use for HTTPS (secure) or HTTP (not secure) communications with the PTM Server application on the PTM Appliance. The default ports are 8183 for HTTPS or 8182 for HTTP. NOTE:Ensure that you open this port in the firewall on the Connector host and on network firewalls between the Connector host and the PTM Server.	ptm_port=8183
ptm_ssl	Specify a value of true to use SSL to connect to the PTM Server. Valid values are true and false.	ptm_ssl=true
verify_ptm_ssl_cert	Specify whether you want to require the certificate to be validated for connections to the PTM Server. Valid values are false or true. The default is to disable validation (false). NOTE:We recommend that you enable verification of the PTM Server certificate for remote instances of the Connector. Certificate validation is not necessary for the Connector instance installed on the Appliance.	verify_ptm_ssl_cert=true
local_ptm_ssl_cert	Specify one of the following: The local PTM Server certificate store for authenticating the PTM server certificate The directory location to use a local certificate authority for certificate validation If no value is set, the Connector will use Mozilla’s root certificates.	local_ptm_ssl_cert=
ptm_username	Specify the email address of a valid System user account on your PTM Server that has been assigned a at least a Project Architect role at the Project level. The Transformation History can distinguish Connector-initiated actions by this User object. NOTE:We recommend that you create a dedicated user account in PTM for the Connector instance to use. Create this special User object as a System user, then assign it a Project Architect role at the Project level. Create a dedicated User object for each Connector instance with permissions appropriate for its assigned project.	ptm_username=john.doe@example.com
ptm_password	Specify the password for the user account. NOTE:When you save the settings.cfg file and restart the Connector service, the password is encrypted and the file is modified to store the encrypted password instead of plain text.	ptm_password=yourpassword

Table 16-2 describes the configurable parameters in the Connector Settings section and their default values.

Table 16-2 Configurable Connector Parameters for PlateSpin Migrate Connector

Parameter	Description	Examples
log_level	Valid options are CRITICAL, ERROR, WARNING, INFO, or DEBUG. The default is INFO.	log_level=INFO log_level=DEBUG
log_file_path	The path to the log file on the Connector host server, including the log file name.	log_file_path=/var/opt/microfocus/migrate_connector/logs/migrate_connector.log
ptm_project_id	(Optional) Specify the numeric project ID for the project in Transformation Manager to restrict the Connector to a single project instead of making it available for all projects. The Connector processes only events and actions within the assigned project. Comment out this parameter if the Migrate Connector should be available to all projects.	ptm_project_id=1234

Parameter

Description

Examples

log_level

Valid options are CRITICAL, ERROR, WARNING, INFO, or DEBUG. The default is INFO.

log_level=INFO

log_level=DEBUG

log_file_path

The path to the log file on the Connector host server, including the log file name.

log_file_path=/var/opt/microfocus/migrate_connector/logs/migrate_connector.log

ptm_project_id

(Optional) Specify the numeric project ID for the project in Transformation Manager to restrict the Connector to a single project instead of making it available for all projects. The Connector processes only events and actions within the assigned project.

Comment out this parameter if the Migrate Connector should be available to all projects.

ptm_project_id=1234

16.1.2 Configuring PTM Server Settings for a Connector

To set up the Connector instance to work with PTM, or to modify settings:

Log in to the Connector host server with a root user account.
In a text editor, open the /opt/microfocus/migrate_connector/config/settings.cfg file.
Specify values for the parameters in the top section called [PlateSpin Transformation Manager Server].

See Table 16-1, Configurable PTM Parameters for PlateSpin Migrate Connector.
Save the file, then exit the text editor.
Start or restart PlateSpin Migrate Connector. In a terminal console, enter
```
rcps_migrate_connector restart
```
For the Migrate Connector instance installed on the PlateSpin Transformation Manager Appliance, you can alternatively restart the Connector from the Appliance Management Console.

See Section 16.5, Starting, Restarting, or Stopping the Connector Service.

16.1.3 Configuring a Dedicated Project for a Connector

To discover the numeric ID associated with a project in PTM:

In the Web Interface, go to Planning > Projects.
Select the project, then click Edit.
In the Edit Project dialog, pause over the project name in the dialog title area. A tooltip displays the numeric ID of the project.

To configure the Connector instance for a specific project:

Log in to the Connector host server with a root user account.
In a text editor, open the /opt/microfocus/migrate_connector/config/settings.cfg file.
If you have not yet configured the connector, specify the values for parameters in the top section called [PlateSpin Transformation Manager Server].

See Table 16-1, Configurable PTM Parameters for PlateSpin Migrate Connector.
Specify the Project ID value for the ptm_project_id parameter under the section called [Connector Stings].

See Table 16-2, Configurable Connector Parameters for PlateSpin Migrate Connector.
Save the file, then exit the text editor.
Start or restart PlateSpin Migrate Connector. In a terminal console, enter
```
rcps_migrate_connector restart
```
For the Migrate Connector instance installed on the PlateSpin Transformation Manager Appliance, you can alternatively restart the Connector from the Appliance Management Console.

See Section 16.5, Starting, Restarting, or Stopping the Connector Service.