When connecting to a PTC Server that uses 2-way Secure Socket Layer (SSL) HTTPS client authentication, you must provide the SSL certificate serial number for that PTC Server. This serial number is used to select the correct certificate from the store to authenticate with the specified PTC Server. You can have multiple SecurityCertificateSerialNumber entries, each representing a different PTC Server.

The serial number information contained in the ParameterValue element must be in the following format:

Following is an example of the ParameterName element value:

When connecting to a PTC Server that uses 2-way Secure Socket Layer (SSL) HTTPS client authentication, you must specify in which certificate store or stores to search for the SSL certificate used to authenticate with that PTC Server. You can have multiple SecurityCertificateStoreName entries, each representing a different PTC Server.

The certificate store information contained in the ParameterValue element must be in the following format:

This value is required.

Following are examples of the ParameterName element values:

This parameter is set to off by default. To enable baseline support, set the value to on. If you leave baseline support off, then whether a baseline is created for an object is determined by the PTC Server preferences Create Baseline upon Check In and Create As Stored.

If the useroverride burst configuration setting is set to off in the atidefaults.bcf system-wide burst configuration file, the baseline creation options are still available to users if PromptForBaseline is set to on. In this case, only the options for creating baselines will be available in the Check In and Save As Properties dialog boxes.

You can set this parameter to the following values:

This is the default value.

The PTC Server connection can override this value when necessary.

This enables you to hide Arbortext Editor for a time enabling a user to open the editor from the PTC Server HTML Interface more quickly and without having to reconnect to the PTC Server. If this parameter is not set, when a user chooses File > Exit in Arbortext Editor the editor closes as usual.

If you set this parameter to a number higher than zero, when a user chooses File > Exit in Arbortext Editor the editor will run hidden in the background for the number of minutes indicated by the parameter value. For example, if you set the value to 30, Arbortext Editor runs in the background for 30 minutes and then automatically exits and disconnects from the PTC Server. In this case, there is a new choice added to the File menu named Exit and Close PTC Server Connection Session. When a user selects this choice, Arbortext Editor closes as usual and does not run in the background.

This parameter is set to on by default. To disable HTTP compression, set the value to off. If you leave HTTP compression on, then both request and response metadata is compressed using the gzip format for HTTP 1.1 encoding. The XML text content is always transferred uncompressed, regardless of the setting of this parameter.

HTTP compression is a way to compress the content transferred between web servers and clients. Compression reduces the size of the transmitted content and improves network performance. Note that data compression does increase the processing required for the PTC Server and clients. The PTC Server zips the data before sending it across the network and the client must unzip the received data before processing it. Therefore, enabling HTTP compression improves data transfer time over the network but increases processing time. If you notice your PTC Server has higher processing needs than desired, disable HTTP compression.

This parameter is set to false by default indicating to search a graphic's representations, primary content, and secondary content to find content that matches that specified in the notation parameter. Set this parameter to true to disregard the notation parameter and always use the graphic’s primary content.

This parameter is set to on by default. When set to on, the PTC Server creates content reference links for cross references, DITA content references, and similar DITA references (those indicated in the document-type-specific burst configuration file by a customref element with the mode attribute set to the value dita-partial). Note that content reference links do not enforce referential integrity.

Content reference links do enable you to include the objects associated with these DITA references in save as and similar operations on the PTC Server HTML interface by including all dependent objects in the operation. The content reference objects are also now listed in the References Documents table in the HTML interface for the referencing object, though this part of the feature is only supported for PTC Servers running releases 10.0 M040 or later and 10.1 F000 or later.

Set this parameter to off to disable the creation of content reference links for DITA documents.

This parameter is set to false by default. When set to true, Arbortext Editor reloads modified documents from the PTC Server whenever one of the following operations is performed successfully:

Reloading documents in these cases can affect performance, so you should only set this parameter to true if you do some sort of document processing on the PTC Server after a successful save and check in.

This parameter is set to false by default. When set to true, the PTC Server uses a workspace update format that requires less information be exchanged between the PTC Server and Arbortext Editor during operations that require workspace updates. Examples of this type of operation include Check Out Object, Undo Check Out Object, and Check In Object. Setting this parameter to true can improve performance for these operations when the workspace contains a large number of objects.

When this parameter is set to the true and logging is enabled in the userprefs.xml configuration file, then the PTC Server connection writes a message to the log file indicating either that this parameter has been set or that the current PTC Server version does not support the new update format. This feature is only supported for PTC Servers running releases 10.0 M040 or later and 10.1 F000 or later.

This parameter is set to true by default. In this case, when the user enters a topic reference into a map to a topic stored on a PTC Server, the PTC Server connection both downloads the topic reference information from the PTC Server and also adds the referenced topic to the active workspace.

When this parameter is set to the false, the PTC Server connection only downloads the topic reference information from the PTC Server. The referenced topic is not added to the workspace. This can improve performance when several topic references are added to a map at the same time. However, when the map has been opened from the PTC Server, then other operations such as File > Save on the map can take longer.

The property is set to false by default. In this case, when the user clicks Open all topics in Arbortext Editor to open the related topics stored on the PTC server, the RDE that is created has both read and write access.

When the property is set to true, the RDE is created as a read only document.

The specified directory must exist, as the connection will not create it automatically.

If you do not specify a value for this parameter, the user.home\.wcAdapter directory is used by default. Note that user.home is a Java system property. For example, the default home directory might be the following: C:\Documents and Settings\jsmith\Application Data\PTC\Windchill Integration\.wcAdapter

If the specified directory does not exist, the connection will automatically create it. If you do not specify a value for this parameter, the default temporary file directory for the operating system is used.

This parameter can take two values. The first value contains the path to the file to use for the log and is required. The second value is optional and enables you to set the level of logging that you want reported to the file.

Set the file parameter value to a directory path and base file name for the log to enable logging. The path must be for a directory that already exists. Arbortext Editor uses this value to create a log file containing its unique process ID (PID). If you do not specify a value for this parameter, logging is disabled.

The log file name takes the form filename-PID.ext, where the file name and file extension are specified by the parameter setting, and PID is the process ID for the active Arbortext Editor executable. For example, if you set the parameter to the following value:

The PTC Server connection could create a log file such as the following:

Each log file is cumulative for its unique process ID.

If desired, set the logging level parameter value to one of the following levels:

By default, only LEVEL_VERYIMPORTANT information is logged and this is usually sufficient.

Even when set to log just very important information, the log contains a lot of information so you should only use logging when needed. The log file is not deleted when a session ends. If you use logging, you should delete the log files periodically.

Following is an example of this parameter:

This parameter enables you to specify the format of the log file in Apache log4j format. For example, if you want the entries in your log to contain the date and time add the following parameter and value to your file:

The parameter has the following format:

The parameter allows the following values:

The default is 3.

The default is 800000.

Following are some example settings for this parameter:

This example sets both the download threads and upload request size for Server1.

This example sets just the upload request size for Server2.

This example sets just the download threads for Server3.

For example, setting the parameter value to 10 results in all objects that are not checked out being removed on disconnect when there are more than 10 documents in the workspace:

Setting the parameter value to 0 results in all objects that are not checked out being removed from the workspace whenever a user disconnects:

This parameter is set to yes by default. In this case, the PTC Server connection opens the Change Active Workspace dialog box when the context of the requested object and the context of the active workspace are not the same. The user must change the active workspace to one appropriate for the object.

When this parameter is set to the no, the PTC Server connection only opens the dialog box in two cases. First, when the context of the requested object is a project and the current context is a different project, product, or library. Second, when the context of the requested object is a product or library and the current context is a project.

This parameter is set to false by default. This indicates to use the default authentication process and dialog boxes when connecting to a PTC Server.

When this parameter is set to true, the authentication process is changed so that the initial options on the Connect dialog box only request the name of the PTC Server to which you want to connect. The dialog box displayed after that depends on the type of authentication used by the server. Once the user is authenticated, the Connect dialog box enables you to select the context and workspace in which you want to work.

If you use HTTPS Client Authentication to connect to your PTC Server, it is recommended you set this parameter to true. The alternate authentication process provides a better user experience in this case.

This parameter is not set by default. In this case, the default value is the setting of the Remove objects from Workspace after Check In preference in the PTC Server HTML interface.

When this parameter is set to Yes, the Remove From Workspace option is selected on the dialog boxes. In this case, any documents affected by the dialog box are removed from the client workspace after being checked into the server.

When this parameter is set to No, the Remove From Workspace option is not selected on the dialog boxes. In this case, any documents affected by the dialog box are not removed from the client workspace after being checked into the server.

In some cases your site might have multiple contexts, such as a product, that have the same name but are in different organizations. This parameter enables you to display the organization for a context in the Browser.

The default setting for the parameter is no meaning not to display organization names. Set the parameter to yes to display the organization name next to the context in the Browser.