PDXpert service configuration settings

Last update 2020-12-08

Topic contents

Warnings

Fully test any change to these settings. The settings' default values are carefully selected for most conditions.

Retain a copy of changes that you make to the configuration file. Consider maintaining a revision history of the file as a document in PDXpert.

The service configuration file may be reset or replaced during application upgrade.

Review and, if needed, re-apply your custom settings after each system upgrade, or when you move your PDXpert Server to another computer.

How to edit the configuration file§

  1. Ensure all users are logged out of the PDXpert client application.

  2. On the server computer, close the PDXpert application server window.

  3. In the Administrator Tools > Services window: Stop the PDXpert Server service. If asked, stop the PDXpert Filter service.

  4. In the Program Files folder, go to the installed PDXpert application location. This is typically C:\Program Files\PDXpert\PDXpert PLM\Website\bin.

  5. Select Notepad, Notepad++ or other plain text editor (not Word, Wordpad or other formatted text editor). Right-click to show the editor software's context menu, and select Run as administrator.

  6. Using the text editor, find and open the PDXpert.Service.exe.config file in the installed PDXpert application location.

    Do not edit the PDXpert.Server.exe.config file.

  7. Edit the setting, save the file, and close the text editor.

  8. In the Administrator Tools > Services window: Start the PDXpert Server service.

    Do not start the PDXpert Filter service; it is started by the PDXpert Server service only when needed.

Values in <appSettings />

<add key="ClientInstallerPath" value="" />§

Purpose: Administrators can substitute their own network resource for users to download the PDXpert client installer.

Expected values: The URI or UNC absolute path to a network file. It could be a web server link, or the PDXpert Client Setup installer, or a text file with installation instructions.

For example, this setting:

value="M:\path\to\PDXpertClientSetup-x64.msi"

results in an email with text as highlighted below (text is not highlighted in the actual email):

If the PDXpert PLM client is not installed, download this file to install the software:

M:\path\to\PDXpertClientSetup-x64.msi

To use PDXpert software:

  1. Run the PDXpert PLM application.
  2. Enter your account name: david.sarnoff
  3. Enter your account password: tmpPsswrd123
  4. Enter the server name (or IP address): PDXpertServer
  5. Click the OK button.

Manage your password by selecting the Passwords... command from the Tools menu.

If you need help, contact Arthur Kennelly or press the F1 key on your keyboard to open the PDXpert PLM help file.

Although the email sent by PDXpert uses only plain text for the path and file, some email clients may automatically format this text as a hyperlink.

Setting this value has no effect on the path shown on the PDXpert Server or copied by the Copy Installer Link button.

Default value: None - when empty, the new user's email shows a link to the client installer on the server (as modified by the HostName or ServiceTcpPort settings), similar to http://PDXpertServer:48084/client/setup

<add key="Culture" value="en-US" />§

Purpose: Identify the PDXpert service's culture resources. This setting is deprecated. Most service operations use InvariantCulture; database operations are generally fixed as en-US.

Expected values: Any Microsoft Language Culture Name value. These are similar to the IETF language tag, and generally use a ISO 639 two-letter language code with a ISO 3166 two-letter country code.

Default value: en-US

<add key="HostName" value="" />

Purpose: Specify the client installer's network location for the server's Manage page's Copy Installer Link, Save Client Installer... and new user email. The value replaces the placeholder http://{location}:48084/client/setup For example, for <add key="HostName" value="10.0.2.127"/>, the link becomes http://10.0.2.127:48084/client/setup

Expected values: Any IP address or domain name that resolves to the server location.

Default value: None - the server computer's machine name is used when empty.

<add key="JobFactor" value="1" />§

Purpose: Service scheduled task processing rate, where a higher number represents a longer delay between scheduled events like indexing. Faster task processing (a smaller number) results in a heavier load on system resources.

Expected values: Numbers from 0.1 (fast) to 10 (slow); values outside this range are assigned the closest upper or lower value.

Default value: 1

<add key="LDAPContextOptions" value="0" />§

Purpose: Specifies the AD/LDAP options that are used for binding to the server. The value can include multiple options that are summed to an integer value, and then applied to the ValidateCredentials(string, string, ContextOptions) method overload.

Some settings may require or exclude other settings; or not be useful with the LDAP PrincipalContext(ContextType.Domain, string) parameter. System.DirectoryServices.AccountManagement.PrincipalContext

Name Value Summary
(default) 0 The ContextOptions value is not specified, and uses the ValidateCredentials(user, password) overload with .NET default value.
Negotiate 1 The client is authenticated by using either Kerberos or NTLM. When the user name and password are not provided, the Account Management API binds to the object by using the security context of the calling thread, which is either the security context of the user account under which the application is running or of the client user account that the calling thread represents.
SimpleBind 2 The client is authenticated by using the Basic authentication.
SecureSocketLayer 4 The channel is encrypted by using the Secure Sockets Layer (SSL). Active Directory requires that the Certificate Services be installed to support SSL.
Signing 8 The integrity of the data is verified. This flag can only be used with the Negotiate context option and is not available with the simple bind option.
Sealing 16 The data is encrypted by using Kerberos.
ServerBind 32 Specify this flag when you use the domain context type if the application is binding to a specific server name.

See: .NET ContextOptions reference

Expected values: Summed value from 0 to 63; values outside this range are assigned 0. For example:  Negotiate + Signing + Sealing = 25 

Default value: 0 or empty

Introduced: PDXpert 15.0. If the PDXpert.Service.exe.config file doesn't include this tag, you can add it to the file after the JobFactor setting:

<appSettings>

 ...

 <add key="JobFactor" value="1"/>

 <add key="LDAPContextOptions" value="25"/>

 <add key="ServiceTcpPort" value="48084"/>

 ...

</appSettings>

<add key="ServiceHostName" value="" />§

Purpose: Specify the binding IP address used to listen for client communications. For example, you can exclude all LAN/WAN IP addresses in favor of the server's VPN address.

Expected values: Any IP address assigned to server computer.

Default value: None - server listens on all available network connections when empty.

<add key="ServiceTcpPort" value="48084" />§

The PDXpert client uses the default base value of 48084, unless it is directed to use a different value when the user logs into the client.

After setting a new ServiceTcpPort value, the PDXpert client log-in must include the same value in the Server computer's machine name textbox. For example, if the server's machine name is PLMSERVER and the ServiceTcpPort is set as 24042, then the client log-in value would be PLMSERVER:24042

Purpose: Specify the base TCP port number for client communications. Ports are defined as

  • BASE+0 is used to send software updates to PDXpert client application. The value is also used in the client download links as http://servername:{base port}/client/setup
  • BASE+1 is used for unencrypted communications, usually when local workstations connect to the server on a trusted network or VPN.
  • BASE+2 is used for encrypted communications, usually when remote workstations connect to the public IP address of the server.
  • BASE+3 is reserved for future use.

Expected values: Any available range of four sequential TCP ports starting from 0 to 65532.

Default value: 48084