Before you begin

This topic provides and overview of how to plan a synchronization between your endpoints using Micro Focus Connect.

Planning guide and worksheet

Before you begin using Micro Focus Connect to synchronize your projects, we recommend that you consult the Planning Guide and Worksheet. (PDF format)

The document provides important resources, checklists and planning tables that will help you create the optimal setup for your needs.

Tip: In planning your synchronizations, we highly recommend that you run the Purge script as a nightly task. Failure to do so will cause the file folders to grow in size and overload the Micro Focus Connect memory. This will also affect the Micro Focus Connect overall system performance. For details, see Purge scripts.

We strongly recommend that you start using Micro Focus Connect actively only after you have addressed the large majority of the questions and considerations in the Planning Guide.

Note: Smooth operation of Micro Focus Connect requires its admin to have the skills for common backend systems. For details, refer to the Service Configuration – Roles and Responsibilities section in the Planning Guide and Worksheet.

Back to top

Deployments

Micro Focus Connect is available in both on-premises and SaaS deployments.

The on-premises deployment is very robust, and allows you to work independent of a network connection. However, with an on-premises deployment, you will be required to upgrade your local instillation periodically. For a SaaS deployment , you receive tenant information at your initial registration, and Micro Focus automatically upgrades the software.

To learn more about the options, see the Micro Focus Connect Core at the ADM Marketplace.

For information about downloading and installing the on-premises version, see Windows installation and upgrade and Linux installation.

Back to top

System resource considerations

Micro Focus Connect is a network-processor--memory-intensive service. Each connection increases the amount of processing performed by Micro Focus Connect. This includes reading and writing data to and from endpoint systems such as ALM/QC, ALM Octane, Jira, Azure DevOps, ServiceNow, Rally, and VersionOne. It also includes caching artifacts and metadata in the machine's memory, running algorithms to determine what has changed at an endpoint and how to present those changes to the opposite endpoint. The server must perform and process these operations in parallel depending upon the number of running connections.

The Micro Focus Connect user interface only allows you to run connections in parallel. Connections can be configured to have a specified time in minutes, with a minimum of 1 minute. As a result, the more connections actively running at a given time, the larger the load on the Micro Focus Connect instance. This load affects the memory, processors, disk operations, network bandwidth, and threads. While it is possible to separate connection iterations by a specific sleep time, it is very difficult to determine how many connections will be running in parallel at any given time.

The recommended Infrastructure requirements for a Micro Focus Connect on-premise instance is a 64-bit quad core CPU with a minimum of 32 GB of RAM. For details, see the Support Matrix.

The actual size or cost of any individual connection itself cannot be accurately predetermined. It depends upon some or all of the following factors:

  • the quality of the network

  • the number of other connections contending for the processor and threads

  • the number or projects being synchronized at each endpoint

  • the number of types being synchronized within those projects at each endpoint

  • the raw number of artifacts in each syncset, for example each source project, source type, target project, and target type

  • the quantity of data changing at these endpoints

The threshold is 25 connections running in parallel. This is typically the saturation point for the recommended infrastructure per instance, after which you would need to run a second instance of Micro Focus Connect.

Back to top

Use batch scripts to balance connections

Although Micro Focus Connect does not support sequential iterations, you can utilize batch scripts to manually configure them.

Using batch scripts, an administrator can run one connection at a time with an optional break after each connection. You can also combine the running of connections with purging, audits and other maintenance scripts. This requires prior knowledge of operating system features such as the Windows Task Scheduler, and the ability to create, edit, and configure command .bat or Powershell .ps script files. For details, see Batch utility scripts.

In addition, refer to the Roles and Responsibilities section in the Planning worksheet. For details, see Planning guide and worksheet.

A disadvantage of the batch scripts is that it incurs an additional cost. Running a single iteration causes the Micro Focus Connect engine to fetch metadata for the connection, and then discard it at the end of the iteration. The number of queries on the data and metadata from the target endpoint increases, since Micro Focus Connect does not cache connection data.

With this model, the total cost of a complete run of all connections, is the cumulative cost of all of the connections running in a sequence. Each scheduled run needs to be configured to wait for the prior instance to completed. This is the default behavior for the Windows Task Scheduler.

The following example shows a .bat file that runs a series of connections in sequence using the mfcRunIterationsInSequence.bat script. For details, see Batch utility scripts.

net stop ConnectWebServer ‘Stop the connect service.

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcPurge.jar" "%CONNECT_PATH%" ‘Run a purge.

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcClearWaterMarks.jar" removenulls "%CONNECT_PATH%" ‘Clear watermarks across all connections.

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcToggleConnections.jar" stop "%CONNECT_PATH%" ‘Stop all connections, and ensure that none start on service startup.

net start ConnectWebServer ‘Start the connect service

‘Run each connection in sequence, and make sure to wait for a connection to end before the next one starts.

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcFullRESTClient.jar" -c Administrator,"%PASSWORD%" -h localhost:8081 -runOneIteration “ConnectionOne”

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcFullRESTClient.jar" -c Administrator,"%PASSWORD%" -h localhost:8081 -runOneIteration “ConnectionTwo”

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcFullRESTClient.jar" -c Administrator,"%PASSWORD%" -h localhost:8081 -runOneIteration “ConnectionThree”

‘…

‘After all connections are done,run the audit report and email it to the administrator.

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcAudit.jar" "%CONNECT_PATH%" "|" "%BACKUP_PATH%"

‘Micro Focus Connect sits ‘idle’, until the next time the scheduled task launches.

By implementing this script, you can suffice with a single Micro Focus Connect instance. Keep in mind that each connection will only synchronize when its scheduled turn arrives. Schedule this .bat file to run as a Windows Scheduled Task at the desired interval—hourly, daily, or weekly.

Back to top