Batch Utility Scripts

The following scripts allow you to make your usage of Micro Focus Connect more efficient.

General run notes

Each batch file should be run as Administrator.

The scripts modify the Micro Focus Connect database.

Except for mfcQueryTemplates, each listed script stops the Micro Focus Connect server, runs the appropriate utility, and then restarts the Micro Focus Connect server.

Back to top

mfcClearWaterMarks

Resets the watermarks for all active connections.

This is done so that a full synchronization will be performed by each connection on the first iteration after the server restarts.

Back to top

mfcDataSourceUsers

Extracts identifiable user information from Micro Focus ALM/QC, ALM Octane, Jira, Azure Dev Ops, Broadcom Rally, CollabNet VersionOne, and ServiceNow data sources. This information can be edited in a spreadsheet and then written out to a file(s) that will become the input to the mfcUserMaps utility.

The script takes three sequential arguments:

  1. jira, almqc, octane, or azuredevops.

  2. A path to a property bag file that contain key value pairs that provide connectivity and credential information for the data source.

  3. The input and output separator, which defaults to “|”.+

Back to top

mfcDeleteConnection

Deletes the connection identified by name in the script.

There is a placeholder variable called ConnectionNameToDelete.

The placeholder must be replaced by a case sensitive exact match of the connection name to be deleted.

Caution: After a connection is deleted, any possible synchronization cross-references associated with this connection will also be deleted.

Back to top

mfcFix

Cleans up any corrupt or stale data in the database that is the consequence of an upgrade from earlier versions of Micro Focus Connect.

This script typically will not be used, except immediately after an upgrade.

Back to top

mfcPurge

Performs the following actions:

  1. Generates a de-normalized .txt flat file representation of the audit GUI log entries using the “|” character as the column separator.

    The file is timestamped and written to the Connect/AppData/backup folder. The file can be imported into a spreadsheet or SQL database for backup, querying, reporting or general processing.

  2. Deletes all iteration data from the Micro Focus Connect database.
  3. Purges the dead space from the file system.

You can also produce a subset of the audit columns using the columnnames=columnname1,columnname2,… parameter.

The set of available columns are: itemactionid, iterationid, sourceproject, targetproject, sourcetype, targettype, itemid, associatedid, action, actionvalue, syncguid, fieldname, fieldvalue, starttime, endtime, stacktrace

Example:  

Produce the default report with all column names:

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

Produce a report with a subset of the columns:

"%JRE_PATH%\java.exe" -jar "%UTILITIES_PATH%\mfcAudit.jar" "%CONNECT_PATH%" "|" "%BACKUP_PATH%" "columnnames=starttime,sourceproject,itemid,fieldname,fieldvalue,actionvalue"

Recommended configuration

Set the script to run as a nightly scheduled batch process, preferably at a time that causes the least inconvenience to the user community.

If run every night, this script should require no more than 15 minutes of Micro Focus Connect server downtime.

Stopping and restarting the Micro Focus Connect server clears out the process runtime memory cache.

Back to top

mfcQueryTemplates

Targets the running Micro Focus Connect server.

This script does not stop or restart the server, it does not run direct queries against the Micro Focus Connect database.

This script is a template to query types, properties, and property lists from the data sources.

It is useful when discovering case sensitive property names and/or enum names to set up sync criteria and calculated values.

It is useful for debugging issues with mappings, and is often used by support engineers when working one-on-one with the customer.

Back to top

mfcResetPassword

Resets the password of the Micro Focus ConnectAdministrator user, replacing it with the string changeme.

This script is especially useful when a customer is locked out of Micro Focus Connect.

A subsequent login through the UI requires changeme to be the specified password, and Micro Focus Connect immediately asks the user to provide a new password.

Back to top

mfcDataSourceUsers and mfcUserMaps

This pair of utilities automates the process of storing mapped user representations from different systems into Micro Focus Connect.

It is useful when the user data is accessible from a common authentication store such as Active Directory or LDAP.

For details, see Automatically create user maps.

Back to top