Share this page
Batch utility scripts
Batch utility scripts allow you to use the Connect capabilities more efficiently. The utilities are documented by category: Connection, Data Source, Synchronization, Mapping, and Maintenance scripts.
General run notes
The following notes apply to all batch scripts:
-
The batch scripts are located in the utilities folder under the Connect installation.
-
Run batch files as an Administrator.
-
The syntax for a batch script is mfc<script_name>[.bat|.sh], depending on your operating system. For example, to run the Purge script on Windows, use mfcPurge.bat in your syntax. For simplicity, this documentation only refers to the script name, without the mfc prefix and without the extension.
-
The scripts modify the Connect database.
-
For most of the scripts, you should stop the Connect server, run the script, and then restart the server. For details, see Connection management scripts.
-
The following scripts can run without stopping the Connect server: DataSourceUsers, QueryTemplates, RunOneIteration, and StartConnection.
Note: If the script contains a placeholder value, for example, ConnectionName, you must edit it in a text editor and replace the placeholder value with your own value. Make sure to use the exact case-sensitive names for your values. To retrieve an accurate list of your connection names, run mfcQueryStatus.bat. From the generated list, copy and paste the exact name of the connection into your script.
Deprecated batch scripts
The following batch scripts have been deprecated from version 25.3.
| Script name | Area | Remarks |
|---|---|---|
| Audit | Maintenance | Auditing is now available in the Connection settings. For details, see Create and manage connections. |
| CopySyncSets | Synchronization and mapping | - |
| DataSourceExtracts | Data source | - |
| DeleteConnection | Connection | Connection deletion is now available in the Connection settings. For details, see Create and manage connections. |
| Fix | Maintenance | The Fix functionality is now part of the Purge script. For details, see mfcPurge script. |
| ImportXrefs | Connection | Importing cross references is available in the Connection settings. For details, see Manage cross references. |
| PurgeDisabledProjects | Maintenance | - |
| PurgeDisabledTypes | Maintenance | - |
| PurgePreviousPasswords | Maintenance | - |
See also:
