Java & DFC Profile Management

dqMan comes with a profile management feature allowing users to define multiple profiles using different Java and DFC versions.

This can be used by Documentum professionals who need to work with many different Documentum Content Server versions/environments while using just one dqMan installation.

dqMan can be started with any profile, thus providing the respective Java and DFC environment for working with specific Documentum Content Servers.

Managing Profiles

Profiles can be created, edited and deleted using the JRE & DFC Profiles page in the dqMan Options dialog (Extras menu>Options)

On the first launch after deployment dqMan will attempt to auto-detect the default Java and DFC installations present on the maching and if this is successful, it will create a profile called [0] Default. To make sure that dqMan will be able to correctly auto-detect the Java and DFC installations on the local machine please follow the instructions in Prerequisites.

Profile [0] Default is a reserved profile which is managed automatically by dqMan and is not recommended to be edited or deleted. Although editing this profile is not prohibited, it is recommended to be used only for troubleshooting purposes.

JRE & DFC Profile management page in dqMan Options

Function	Description
Existing profiles list	Selects the profile which is to be edited or deleted
New Profile	Creates a new (blank) profile
Delete Profile	Deletes the selected profile. The user is prompted to confirm the delete action. If you have deleted a profile inadvertently press Cancel to close the Options window, thus discarding the latest changes, including deletion
Name	Set a name for a newly created profile OR Rename the selected profile
JRE Path	Path to the installation folder of the Java Runtime Environment to be used for the current profile See Prerequisites for more information about supported Java versions
Java Options	JVM parameters can be added here. They can be found in the documentation of each version of Java as java.exe parameters
DFC Program Path	Path to the installation folder of the DFC to be used for the current profile See Prerequisites for more information about supported DFC versions
DFC User Path	Path to the DFC user folder (the folder containing the config\dfc.properties file)
OK	Save changes to Java & DFC Profiles and close Options dialog
Cancel	Discard changes to Java & DFC Profiles and close Options dialog

Loading Profiles

dqMan can be launched with any of the available profiles. It is also possible to run multiple dqMan instances using different profiles.

The recommended way for using profiles is to create custom dqMan shortcuts, with each shortcut used to load a specific profile:

1. Hold Alt & drag dqman.exe from your dqMan folder to the Desktop to create a shortcut

2. Rename the shortcut to something suggestive

3. Edit the shortcut's properties and append either of the following to the command line in the shortcut's Target field:

Argument	Example shortcut Target field
-profile <index>	<dqMan path>\dqman.exe -profile 2 Starts dqMan with the profile identified by index number 2
-profile <name>	<dqMan path>\dqman.exe -profile "My Profile" Starts dqMan with the profile named My Profile Hint: profile names need to quoted only if they contain spaces

To confirm the expected profile has been loaded, open Help>About and verify the profile name and Java and DFC information in the About window's System information section.

If an invalid profile is specified to be loaded, dqMan will automatically fall back to loading the [0] Default profile instead. A message is then displayed on startup informing the user that the specified profile is invalid and could not be loaded.

Troubleshooting profiles and editing the dqman.properties file

dqMan saves all profile related information to the %localappdata%\dqMan\Config\dqman.properties file. Although it is not recommended to edit this file directly, it may be required to do so in certain situations.

We always recommend making a backup before editing any configuration file.

dqMan fails to detect locally installed Java and/or DFC

if dqMan fails to automatically detect the default Java and/or DFC installed on the local machine it is usually due to either of these not having been installed as per their respective vendor's installation instructions, as outlined in Prerequisites. We recommend following the instructions from the Prerequisites page and then restarting dqMan to allow it to correctly detect the default Java and/or DFC installations.

If it still isn't possible for dqMan to detect the default Java and/or DFC installations despite having followed the instructions outlined in Prerequisites it may be necessary to edit or create the dqman.properties file manually. Please follow the below steps to edit/create the file manually:

1. Open the %localappdata%\dqMan\Config\dqman.properties file with your text editor If the file does not exist, create a new file in your text editor and save it as %localappdata%\dqMan\Config\dqman.properties

2. Copy and paste the template dqman.properties file's content from Template for dqman.properties fileinto the text editor

3. Edit the paths from the template to match your Java and DFC installations

4. Save the dqman.properties file and start dqMan

The default Java and/or DFC detected initially by dqMan has been removed/uninstalled later and now dqMan cannot start

If the Java and/or DFC auto-detected during dqMan's first start is later removed/uninstalled then dqMan will run into errors as it won't find the required prerequisites anymore. To reset dqMan's default profile and re-trigger dqMan's auto-detect functionality, follow the steps below:

1. Open the %localappdata%\dqMan\Config\dqman.properties file with your text editor

2. Delete all lines starting withdqman.profile.....[0]= (pay attention at the [0] (zero) index and do not delete other lines containing non-zero indices)

3. Save the file and start dqMan dqMan should now auto-detect your newly installed Java and/or DFC instead of the previously uninstalled versions

4. If step 3. fails, fall back to dqMan fails to detect locally installed Java and/or DFC above

Template for dqman.properties file

Use the below template to create a new dqman.properties file if needed.

The below paths are only examples and will need to be edited to match the actual paths where the respective software is installed on the dqMan host machine

dqman.profile.name[0]=Default dqman.profile.path.jre[0]=C:\Program Files\openjdk-11.0.14 dqman.profile.path.dfc.program[0]=C:\Program Files\Documentum dqman.profile.path.dfc.user[0]=C:\Documentum

Add external jars

In certain scenarios, such as when utilizing TBOs that rely on custom libraries not provided as modules, it becomes necessary to integrate these custom libraries with dqMan. This integration can be accomplished through two distinct methods:

1. Directly place the custom JAR files into the /Java folder located within the installation path of dqMan (ensure that the Java folder already exists).

or

1. Modify the dqMan profile by navigating to Extras -> Options -> General -> JRE & DFC Profiles -> Java Options.

The syntax for adding jars is: -classpath full_path_to_library1.jar;full_path_to_library2.jar

Jre/DFC Profiles

E.g: -classpath d:\some_external_lib_folder\ObfuscationAnnotation-4.0.0.jar