Chat now with support
Chat with Support

Coexistence Manager for GroupWise 1.7.1 - Program Parameters Reference Guide

How to specify or edit program parameters

IMPORTANT: The Coexistence Manager for GroupWise Management Console must be closed before you open a configuration file as described here. When you select File|Save in the Management Console, the Console saves all of its open data to the Configuration.xml file, and this will overwrite any manual changes to the file that may have been entered and saved while the Console was open.
CAUTION: Be very careful when manually entering or editing values in the Configuration.xml file, where incorrect syntax or even a single-character typo could disable a connector or the DC service altogether.

The contents of a configuration XML file can be edited by any XML editor:

Configuration.XML file for Directory Connector is in:

Coexistence Manager for GroupWise's \Directory Connector\ folder

Configuration.XML file for Mail Connector is in:

Coexistence Manager for GroupWise's \Mail Connector\ folder

4
Save and close the Configuration.XML file.

 

Directory Connector parameters

NOTE: Parameters that appear in the DC Configuration.xml file but that are not listed here are associated with UI entries in the DC Management Console, and should not be edited manually (in the xml file) except at the direction of Quest Support.

Type: string. Default: [null] (connector will overwrite target attributes with source attributes if they differ)

Specifies a list of one or more target object attributes whose values will be appended to, rather than replaced by source attribute data, when the connector is running in Update mode and attribute data differs between an existing object in the target and a corresponding source object. Available for either G-to-E or E-to-G connector, specified separately per connector.

This parameter is optional, and is configured separately for each DC connector in the connector's section of the DC Configuration.xml file. To designate the attribute(s) that should function this way in Update mode for a particular connector, find (or add) the <AppendAttributes> tags for the connector, and enter the names of the target attributes separated by a pipe character ("|") between the tags, like this:

Note that a manual change to an attribute value in a Coexistence Manager for GroupWise target container will persist through subsequent connector runs if the corresponding source object record has not also been changed. A connector compares the source object data to a copy of the source object record from the preceding connector run, and updates the target object only if the source object has changed.

Type: boolean. Default: false (off)

Determines whether a G-to-E connector will present to the user a single Novell login question or a page of multiple Novell login credentials. Available for G-to-E connector only, specified separately per connector.

Type: boolean. Default: false (off)

Determines whether Coexistence Manager for GroupWise will restart the QCService (the DC "engine") if it encounters an error during a connector syncyhronization. Applies to the Directory Connector as a whole (not just a particular connector).

Type: string. Default: [null] (connector will copy all attributes for user objects)

Determines which attributes a GroupWise-to-Exchange connector will capture and copy for user objects. Available for a G-to-E connector only, specified separately per connector. This is one of three DC parameters that do the same thing for the three object types:

These GwXxxxAttributeList parameters are unspecified by default, so the connector will copy all attributes. But if particular attributes (one or more) are unnecessary for a particular object type, these parameters let you specify which attributes to include for a particular connector. The attribute(s) not listed will be excluded.

This feature can improve connector performance, perhaps dramatically, in an environment with slow response times and long distribution lists. The feature can be configured only by these Configuration.xml parameters (not in the Connector Creation Wizard), and is available only for existing connectors in the G-to-E direction. The feature is applied per connector, in the <ConnectorSetting> section for a particular connector.

For each object type, enter the parameter name with a list of all attributes to be included, all in one continuous line and separated by pipe characters ("|"), with no spaces between. For example:

To create a suitable list of attributes for the parameter value:

1
Open the file ...\Directory Connector\attributes\groupwiseConnector_XXX, where XXX is the object type (user or group or resource). The attributes in this file appear listed one attribute per line.
3
For the remaining attributes in the list (the ones you want to include), replace all the hard returns with pipe characters ("|"), to produce a single-line continuous list (no spaces) of attributes separated by pipe characters.

Then you can insert that list as the parameter value in the DC Configuration.xml file.

Type: string. Default: [null] (connector will copy all attributes for group objects)

Determines which attributes a GroupWise-to-Exchange connector will capture and copy for group objects. Available for G-to-E connector only, specified separately per connector. This is one of three DC parameters that do the same thing for the three object types:

These GwXxxxAttributeList parameters are unspecified by default, so the connector will copy all attributes. But if particular attributes (one or more) are unnecessary for a particular object type, these parameters let you specify which attributes to include for a particular connector. The attribute(s) not listed will be excluded.

This feature can improve connector performance, perhaps dramatically, in an environment with slow response times and long distribution lists. The feature can be configured only by these Configuration.xml parameters (not in the Connector Creation Wizard), and is available only for existing connectors in the G-to-E direction. The feature is applied per connector, in the <ConnectorSetting> section for a particular connector.

For each object type, enter the parameter name with a list of all attributes to be included, all in one continuous line and separated by pipe characters ("|"), with no spaces between. For example:

To create a suitable list of attributes for the parameter value:

1
Open the file ...\Directory Connector\attributes\groupwiseConnector_XXX, where XXX is the object type (user or group or resource). The attributes in this file appear listed one attribute per line.
3
For the remaining attributes in the list (the ones you want to include), replace all the hard returns with pipe characters ("|"), to produce a single-line continuous list (no spaces) of attributes separated by pipe characters.

Then you can insert that list as the parameter value in the DC Configuration.xml file.

Type: string. Default: [none] (connector will copy all attributes for resource objects)

Determines which attributes a GroupWise-to-Exchange connector will capture and copy for resource objects. Available for G-to-E connector only, specified separately per connector. This is one of three DC parameters that do the same thing for the three object types:

These GwXxxxAttributeList parameters are unspecified by default, so the connector will copy all attributes. But if particular attributes (one or more) are unnecessary for a particular object type, these parameters let you specify which attributes to include for a particular connector. The attribute(s) not listed will be excluded.

This feature can improve connector performance, perhaps dramatically, in an environment with slow response times and long distribution lists. The feature can be configured only by these Configuration.xml parameters (not in the Connector Creation Wizard), and is available only for existing connectors in the G-to-E direction. The feature is applied per connector, in the <ConnectorSetting> section for a particular connector.

For each object type, enter the parameter name with a list of all attributes to be included, all in one continuous line and separated by pipe characters ("|"), with no spaces between. For example:

To create a suitable list of attributes for the parameter value:

1
Open the file ...\Directory Connector\attributes\groupwiseConnector_XXX, where XXX is the object type (user or group or resource). The attributes in this file appear listed one attribute per line.
3
For the remaining attributes in the list (the ones you want to include), replace all the hard returns with pipe characters ("|"), to produce a single-line continuous list (no spaces) of attributes separated by pipe characters.

Then you can insert that list as the parameter value in the DC Configuration.xml file.

Type: boolean. Default: true (on)

Determines whether the Connector Creation Wizard will (false) or will not (true) verify data on pages searching for and displaying OUs (insofar as verifications are possible by other entries and/or environmental inferences). Applies to the Directory Connector as a whole (not just a particular connector). Note that the parameter is defined (named) in terms of not verifying, so a true setting turns off the verifications.

Type: string. Default: 127.0.0.1 (local host)

Specifies the IP address to which Coexistence Manager for GroupWise listens when allowing connections.

Type: string. Default: QCService

Specifies the banner Coexistence Manager for GroupWise inserts into Coexistence Manager for GroupWise logs to identify data coming from the DC engine.

Type: string. Default: QCService

Specifies the string Coexistence Manager for GroupWise will insert into the DC engine logs to mark where Coexistence Manager for GroupWise splits the line and logs everything to the left of the indicated string.

Type: integer. Default: 9091

Specifies the UDP port to which Coexistence Manager for GroupWise listens when logging activity by the DC engine. Available for either G-to-E or E-to-G connector, specified separately per connector.

Type: bool. Default: false (off)

Determines whether a connector will continue operating if it encounters an error in its process. If enabled (true), the connector will continue to the next step.

Type: string. Default: 127.0.0.1 (local host)

Specifies an alternate location (a computer other than the local Coexistence Manager for GroupWise admin host computer) where the QCService (the DC "engine") resides. Ordinarily the QCService is installed on the local machine, but this parameter permits redirection to a different QC installation. Applies to the Directory Connector as a whole (not just a particular connector).

Type: integer. Default: 9081

Specifies the communications port for the DC service. Available for the Directory Connector service overall (not specified separately per connector).

Specifies which communications port the Directory Connector should use for data transmissions between the DC service and the DC Management Console, on the server where these applications reside. The port for this is set to 9081 by default, and this will be the correct setting in almost all environments.

But if port 9081 is assigned to some other service or function in your environment, you must change this communications port setting in the Directory Connector configuration file. The <ServicePort> parameter is usually at or near the end of the <DirectoryConnectorSettings> section.

Type: string. Default: Contacts

Specifies an alternate object type (instead of Contact objects) in the source whose objects a connector should sync to the target—to a target object type specified by the <TargetContactObject> parameter described below. This feature permits the designation of a particular connector to synchronize a particular object type other than the default Contact object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: string. Default: Groups

Specifies an alternate object type (instead of Group objects) in the source whose objects a connector should sync to the target—to a target object type specified by the <TargetGroupObject> parameter described below. This feature permits the designation of a particular connector to synchronize a particular object type other than the default Group object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: string. Default: Resources

Specifies an alternate object type (instead of Resource objects) in the source whose objects a connector should sync to the target—to a target object type specified by the <TargetResourceObject> parameter described below. This feature permits the designation of a particular connector to synchronize a particular object type other than the default Resource object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: string. Default: Users

Specifies an alternate object type (instead of User objects) in the source whose objects a connector should sync to the target—to a target object type specified by the <TargetUserObject> parameter described below. This feature permits the designation of a particular connector to synchronize a particular object type other than the default User object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: integer. Defaults: 0, 0 and 0 (SQL execution history log file is emptied once each day, at midnight)

A set of three parameters that together configure the cleanup of SQL connector-execution logs. Available for DC overall (not specified separately per connector).

Coexistence Manager for GroupWise deletes the contents of DC’s SQL connector-execution histories at regular intervals. This feature is controlled by these parameters in the DC's Configuration.xml file:

The values in this example tell the Directory Connector to empty the history log file every other day (SqlStatusRetainDays=2) at 11:59pm local time (SqlStatusCleanupHour=23, SqlStatusCleanupMinute=59). The defaults (SqlStatusRetainDays=0, SqlStatusCleanupHour=0, SqlStatusCleanupMinute=0) tell the DC to delete the execution logs at midnight every day. These parameters usually appear at or near the end of the Configuration.xml file, in the <root> node, typically between <SvcPassword> and <LogAccepterPort>.

Type: bool. Default: true (on)

Determines whether the Connector Creation Wizard will combine multiple OU trees (in a multi-domain AD forest) into one for presentation in the Wizard's Source Object Selection screen. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: string. Default: Contacts

Specifies an alternate object type (instead of Contact objects) in the target to be synchronized with objects from the source of the type specified by the <SourceContactObject> parameter described above. This feature permits the designation of a particular connector to synchronize a particular object type other than the default Contact object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: string. Default: Groups

Specifies an alternate object type (instead of Group objects) in the target to be synchronized with objects from the source of the type specified by the <SourceGroupObject> parameter described above. This feature permits the designation of a particular connector to synchronize a particular object type other than the default Group object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: string. Default: Resources

Specifies an alternate object type (instead of Resource objects) in the target to be synchronized with objects from the source of the type specified by the <SourceResourceObject> parameter described above. This feature permits the designation of a particular connector to synchronize a particular object type other than the default Resource object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

Type: string. Default: Users

Specifies an alternate object type (instead of User objects) in the target to be synchronized with objects from the source of the type specified by the <SourceUserObject> parameter described above. This feature permits the designation of a particular connector to synchronize a particular object type other than the default User object. Available for either a G-to-E or E-to-G connector, specified separately per connector, in the connector’s <Section> of the Configuration.xml file.

 

Mail Connector parameters

NOTE: Only a very few of the parameters that appear in the MC Configuration.xml file are documented here, because the others are associated with UI entries in the MC Management Console, and should not be edited manually (in the xml file) except at the direction of Quest Support.

Type: boolean. Default: false

Summary: Optional "pass-through" mode to disengage message processing.

Determines whether Coexistence Manager for GroupWise’s optional "pass-through" mode will disengage Coexistence Manager for GroupWise’s message-processing features while Coexistence Manager for GroupWise continues to pass mail between the servers. This feature is off (false) by default, which tells the MC to not enable its pass-through mode—which would disable message processing. (A false setting here tells the MC to continue processing messages in addition to routing them to the other environment.) This feature is available only by manually setting this parameter in MC’s Configuration.xml (is not offered in the Management Console).

Type: integer. Default: 300 (seconds; = 5 minutes)

Summary: Duration of wait for a socket connection.

Sets the number of seconds Coexistence Manager for GroupWise will wait for a socket connection before timing out.

Type: integer. Default: 5

Summary: Configure socket channel usage.

This is a "throttling" feature to enforce a time interval for Coexistence Manager for GroupWise to conclude its communications protocol with a channel before opening another. The actual delay, in seconds, is a "delay factor" (5 by default) x the ratio of the number of open channels to the maximum allowed number of channels. This parameter, in the <root> node of the MC’s Configuration.xml, specifies the delay factor. By default, the Mail Connector waits up to 5 seconds for an available socket channel before opening a new one (if none are then available).

 

Related Documents