Application server settings

The following properties in the server or environment file must be configured for IBM WebSphere, or NexJ Server. Depending on your configuration, you may also need to deploy additional settings which are also described in this section. The XML Attribute and Notes column in the following tables show the attribute names that are used in the environment file.
Table 1. Overview settings for a typical NexJ CRM deployment
Attribute XML Attribute and Notes Value
Anonymous HTTP Server URL httpAnonymousURL

HTTP server anonymous content URL.

 http://server.example.com:port/nexj/anon
Authentication Domain authDomain

Authentication domain or Kerberos realm, usually DOMAIN.EXT in capital letters.

 EXAMPLE.COM
Authentication Service authService

The Kerberos service principal name (SPN) for the environment.

 HTTP/localhost.example.com
Batch Email Recipient List Enabled batchEmailRecipientListEnabled

Enables users to view a list of selected email recipients and modify the list.

 false
Batch Notifications batchNotifications

Enables batch task and document creation notifications.

 false
Birthday Mailers Batch Printing Enabled birthdayMailerEnabled

Enables batch printing of birthday mailers for contacts.

 false
Call Records Enabled callRecordsEnabled

Enables call records functionality.

 false
Client Performance Status Enabled clientPerfStatusEnabled

Enables the client performance banner.

true
Client Performance Status Mobile Red Criteria clientPerfStatusMobileRedCriteria

Specifies performance banner mobile red criteria space separated values: TOTAL_TIME TOTAL_SQL MAX_RESPONSE_SIZE_IN_KB MAX_LAZY_LOAD.

 1500 45 400 30
Client Performance Status Mobile Yellow Criteria clientPerfStatusMobileYellowCriteria

Specifies performance banner mobile yellow criteria space separated values: TOTAL_TIME TOTAL_SQL MAX_RESPONSE_SIZE_IN_KB MAX_LAZY_LOAD.

 750 45 200 15
Currency Conversion Enabled currencyConversionEnabled

Enables currency conversion to allow developers to convert values between currencies for the NexJ application.

 false
Debug debug

Enables debugging.

 true
Deployment Location location

The location where you want to deploy NexJ CRM.
Description description

A meaningful description of what is being deployed.

 Local machine with the bootstrap container in the default location
Email Draft Enabled emailDraftEnabled

Enables users to preview batch emails before sending them to recipients.

 false
Email Signature Enabled emailSignatureEnabled

Enables users to include email signatures when sending batch emails.

 false
Hierarchy Security Enabled hierarchySecurityEnabled.

Enables hierarchy based access for entities, opportunities, and activities.

 false
HTTP Forbidden Enabled httpForbiddenEnabled

Enables the HTTP 403 Forbidden response for a permanent authentication failure. Otherwise, HTTP 404 Not Found is used to hide the existence of an HTTP resource, as a deterrent.

 true
HTTP Report URL httpReportURL

Provides the HTTP URL for reports.

 http://server.example.com:port/nexj/reports
HTTP Server URL httpURL

HTTP server URL.

 http://server.example.com:port/nexj/
Journal Directory journalDirectory

The directory in which to store the transactional journal. If a relative path is specified then the journal directory is placed under the server data directory. The journal files are placed in a subdirectory named after the node name.

 tx${test.clone}
Name Change Context Audit nameChangeContextAudit

Enables automatic context auditing of changes to the name attribute for audited instances.

 true
Password password

The password corresponding to the deployment user ID.

 Deployment_Password
Persistent Session persistentSession

Enables session persistence. Session information is stored using a file system or a database.

 true
Preview Threshold previewThreshold

Maximum document size, in bytes, for automatic preview.

 202,400
Push Password pushPassword

Specifies the password of the push user when used with the Push User property or the keystore password when used with the Push Certificate property.

 Push_Password
Push Redirector URL pushRedirectorURL

Specifies the host, port, and context path of the push redirector.

 http://localhost:port/nexj/pushRedirect
Push Server URLs pushServerURLs

Specifies the list of full paths to each instance of the push server running on each node of the application cluster. Multiple servers are separated with a space.

 http://app1.local:8080/nexj/push http://app2.local:8080/nexj/push
Push Type pushType

Specifies the Comet mode that the NexJ application users for push notifications. If the selected type isn't supported by the client web browser, polling is used.

 streaming
Push User pushUser

Specifies the user that authenticates with the NexJ application when connecting to the push server.

 Push_ID
Read Audit readAudit

Specifies whether to log read actions by users in NexJ CRM based on attributes selected for read audit in the NexJ model.

 none
RPC Privilege rpcPrivilege

The privilege required for access to generic Remote Procedure Call (RPC) protocols. If not set, the access is unrestricted and a validation warning is generated. Generic RPC protocols are HTTP/soap, HTTP/text, HTTP/web, HTTP/xml and EJB. Generic RPC is used by all the clients except for the flat page client.

 InternalManage
Rules for Service Level Agreements ruleSLA

Enables service level agreements functionality for service requests.

 false
Secure Transport Protocol (use SSL) secureTransport

Enables encrypted SSL communication and server authentication.

 false
Type type
  • For WebSphere, the value is WebSphere.
  • For NexJ Server, the value is Generic.
Unit of Work Listener Enabled uowListenerEnabled

Enables the unit of work listener component that shares NexJ CRM transactional data with registered listeners.

 false
Update Audit updateAudit

Determines whether create, update, and delete actions that users perform on objects are logged, for example, changing a contact name.

 false
User user

The ID that will be provided if the server that you deploy to requests an ID and password before allowing metadata to be copied.

 Deployment_ID
Table 2. Additional settings for a typical NexJ CRM deployment
Attribute XML Attribute and Notes Value
Authentication Group authGroup

The Group ID used for coarse grained authentication. Application users must be part of the group.

 nexjusers
Authentication Protocol authProtocol

The authentication protocol.

 custom or spegno
Cluster Discovery Port clusterDiscoveryPort

The Cluster Manager’s discovery port.

 39001
Cluster Discovery Protocol clusterDiscoveryProtocol

The Cluster Manager’s discovery protocol.

 unicast
Configuration config

The template environment file that is used.
Distributed distributed

Enables clustering services.

 true
Keystore Password keystorePassword

The password used to the application servers ssl.keystore files.

 text:keypass
Material Design materialDesign

Reserved for future use. Do not enable.

 false
Message Port messagePort

TCP/IP port used for intra-cluster communication with the Object Queue engine.

 1111
Message User messageUser

The user ID used for Object Queue messaging.

 adminID
Sample Data sampleData

Specifies whether sample data is generated.

 false
Test test

Specifies whether the server may be used for testing.

 false
Table 3. LDAP settings for a typical NexJ CRM deployment
Attribute XML Attribute and Notes Value
Authentication Protocol ldapAuthProtocol

The authentication protocol for connecting the LDAP server.

 simple
Group Context DN ldapGroupContextDN

The distinguished name (DN) used to search for groups.

 LDAP_Group_Context_DN
Group Filter ldapGroupFilter

The LDAP filter used to identify objects that are groups.

 (objectCategory=group)
Group Name Attribute ldapGroupNameAttribute

The group attribute that holds the group's name.

 sAMAccountName
Password ldapPassword

The password corresponding to the LDAP user ID.

 LDAP_Password
URL ldapURL

The LDAP server URL for determining the user group membership.

 LDAP_URL
User ldapUser

The user ID to use to connect to the LDAP server.

 LDAP_User_ID
User Context DN ldapUserContextDN

The DN used to search for users.

 LDAP_User_Context_DN
User Filter ldapUserFilter

The LDAP filter used to identify objects that are users.

 (objectCategory=user)
User Login Attribute ldapUserLoginAttribute

The login name that is used to authenticate users.

 userPrincipalName