Example environment settings for NexJ CRM deployment
The following are example environment settings for a typical NexJ CRM deployment on Model Server.
For detailed descriptions of all environment properties, see the Environment topic in the Model Description Language Reference at https://community.nexj.com/documentation/reference/modl/latest/Environment.html.
Specifying environment settings
You can specify all environment variables in a single .environment file or use an environment file as a template in combination with a .properties file. For more information, see Creating environment files.
Using the environment file as a template is the recommended method. For more information, see Using the environment file as a template with .properties files.
Application server settings
https://community.nexj.com/documentation/reference/modl/latest/Server.html<Environment>
Additional environment variables for a typical NexJ CRM deployment
Attribute | Description | Value |
---|---|---|
| Sets the interval (in ms) at which the system retrieves data from the AdvisorStream third-party. | 24 hrs (86 400 000 ms) |
| Specifies the client secret used to retrieve data from the AdvisorStream APIs. | None, must be set individually if integrating with Inform feature. |
| Specifies the URL to retrieve data through APIs from the AdvisorStream service. | |
applicationType | Determines the type of configuration data (for example, users, contacts, households, and custom fields ) that will be seeded into NexJ CRM for on-premise deployments or NexJ CRM for Wealth Management (NexJ CRM deployed in the Cloud). The attribute's value can be either "ecrm" for on-premise CRM or "wm" for Wealth Management. Both application types have their own set of sample data, which will be seeded in only if the | ecrm |
b2bLeadsEnabled | Enables users to set the lead mode. For more information, see Setting the lead mode. | false |
| Enables users to view a list of selected email recipients and modify the list. | false |
batchNotifications | Enables batch task and document creation notifications. | false |
birthdayMailerEnabled | Enables batch printing of birthday mailers for contacts. | false |
callRecordsEnabled | Enables call records functionality. | false |
config | In a .properties file, indicates which .environment file is used as the template. Not supported in a .environment file. For more information about using a .properties file to configure your environment, see Using the environment file as a template with .properties files. | Development.environment |
crm.document.richTextEnabled
| Enables the text field in documents, including notes, to include rich-text formatting such as bold or italic fonts, numbered or bulleted lists, images, and tables. When disabled, only plain text can be used when creating documents in the Document Manager or adding Document activities to a contact, opportunity, or service request. | true |
currencyConversionEnabled | Enables currency conversion to allow developers to convert values between currencies for the NexJ application. | false |
debug | Enables debugging. | true |
emailDraftEnabled | Enables users to preview batch emails before sending them to recipients. | false |
emailSignatureEnabled | Enables users to include email signatures when sending batch emails. | false |
emailToServiceRequest | Enables users to automatically create service requests from customer emails. | false |
exchangeLogEnabled | Enables including Exchange synchronization process logs in the application logs. | true |
hideErrorValveReport
| Hides the presentation of the Apache Tomcat server error report when an error occurs by configuring the Tomcat | false |
hideErrorValveServerInfo
| Hides the presentation of the Apache Tomcat server version information when an error occurs by configuring the Tomcat | false |
hierarchySecurityEnabled | Enables hierarchy-based access for entities, opportunities, and activities. | false |
materialDesign | Reserved for future use. Do not enable. | false |
nameChangeContextAudit | Enables automatic context auditing of changes to the name attribute for audited instances. | true |
pageSizeMultiplier | Enables users to display 20 or more items in all data tables using the Items per page drop-down in the user interface. The default global setting is If you change the multiplier attribute, it is your responsibility to ensure that the observed performance meets your requirements. | |
portal.Portal.locationEnabled | Enables the location (#) part of the url to support back button functionality. source project: afl-portal | false |
ruleSLA | Enables service level agreements functionality for service requests. | false |
sampleData | Specifies whether sample data is generated. | false |
theme | The theme which should be used to override the default look and feel of the application. | mono |
uowListenerEnabled | Enables the unit of work listener component that shares NexJ CRM transactional data with registered listeners. | false |
Related links
For information about environment variables used to configure ad hoc reporting, see Setting up ad hoc reporting.
For information about environment variables used to configure the cluster discovery protocol, see Configuring the cluster discovery protocol.
For information about environment variables related to auditing (eventAudit, readAudit, and updateAudit), see Configuring audit trails.
For information about environment variables that affect system performance and behavior, see Specifying JVM arguments and system properties.
Data source connection settings
A typical deployment of NexJ CRM requires the following data sources to be configured with appropriate properties.
The SessionDatabase data source is required when using session persistence.
The following data sources are required for a typical deployment:
- AuditLogDatabase
- call:Call
- Conversation
- DefaultRelationalDatabase
- ecr:ECR
- flow:Flow
- LockDatabase
- msg:Messaging
- ObjectQueueDatabase
- rules:Rules
- SessionDatabase
- sso:SSO
- StagingDatabase
- StatDatabase
- uicomp:UIComponent
The suggested properties and values are the same for all data sources and may be included under one data source connection. For detailed descriptions of database connection properties, see the DataSourceConnections topic in the Model Description Language Reference at https://community.nexj.com/documentation/reference/modl/latest/t_Connections_DataSourceConnections.html.
Channel connection settings
A typical deployment of NexJ CRM requires that you add certain channels to the environment file. Some common channels and channel types are listed below.
For detailed descriptions of channel connection properties, see the Channel Connections topic in the Model Description Language Reference at https://community.nexj.com/documentation/reference/modl/latest/t_Environment_ChannelConnections.html.
MessageQueueConnection
For detailed descriptions of MessageQueueConnection channel connection properties, see https://community.nexj.com/documentation/reference/modl/latest/t_ChannelConnections_MessageQueueConnection.html .
- ErrorQueue
- RetryQueue
MailConnection
For detailed descriptions of MailConnection channel connection properties, see https://community.nexj.com/documentation/reference/modl/latest/t_ChannelConnections_MailConnection.html.
HTTPConnection
For detailed descriptions of HTTPConnection channel connection properties, see https://community.nexj.com/documentation/reference/modl/latest/t_ChannelConnections_HTTPConnection.html.
HelpChannel HTTPConnection channel
- HelpChannel
For HelpChannel, the possible values for the url
property are:
https://<intranet.example.com:8080>/help/
to specify an internally-run help server running on port 8080.https://documentation.nexj.com/pubuser95
to point to the public end-user documentation for NexJ CRM 9.5.
HTTPConnection channels for Exchange
- ExchangeEWSSender
- ExchangeEWSNotificationReceiver
For the ExchangeEWSSender channel connection, the value for the url
property should be http://<host>/ews/Exchange.asmx
and the value for the readTimeout
property should be true
.
HTTPConnection channels for Inform
- inform:ArticleSearch
- inform:RelatedObject
For the inform:ArticleSearch channel connection, the value for the url
property is provided by Grapevine6.
HTTPConnection channels for rest
HTTP channel connections are required for using the REST API. For more information, see Enabling and configuring REST API v2.
- rest:OpenAPI
- rest:REST
- rest:SelectionOptions
InfluxDB HTTPConnection channel
- monitor:influxdb:HTTPSenderchannel
For the InfluxDB channel connection the value for the url
property should be
https://<intranet.example.com:8086>/write
?db=database/
, to indicate the secure user-accessible URL for the server that writes to the specified InfluxDB database, including the port number, if required.
FileConnection
For detailed descriptions of FileConnection channel connection properties, see https://community.nexj.com/documentation/reference/modl/latest/t_ChannelConnections_FileConnection.html.
- ReportingOutputFileChannel
KafkaConnection
For detailed descriptions of KafkaConnection channel connection properties, see https://community.nexj.com/documentation/reference/modl/latest/t_ChannelConnections_KafkaConnection.html.
- kafkaChannel
You can define some attributes both at the channel level and the channel connection level. Channel connection settings override any individual channel settings.
If your NexJ application uses the Avro format to send Kafka messages, the Kafka channel requires additional configuration. For more information, see Additional configuration for sending Avro messages.
SOA connection settings
A typical deployment of NexJ CRM requires that you add certain SOA connections to the environment file.
The following SOA connections are required for a typical deployment:
- nexj:act:ActTemplate:1.0
- nexj:act:ActivityPlan:1.0
- nexj:act:ApprovalObject:1.0
- nexj:act:DocumentService:1.0
- nexj:act:Task:1.0
- nexj:call:InboundCall:1.0
- nexj:crm:AssignmentModel:1.0
- nexj:crm:EntityParticipation:1.0
- nexj:crm:Household:1.0
- nexj:crm:Interaction:1.0
- nexj:crm:Note:1.0
- nexj:crm:Person:1.0
- nexj:crm:ScheduleItem:1.0
- nexj:crm:Task:1.0
- nexj:crm:User:1.0
- nexj:crm:UserPerson:1.0
- nexj:flow:FlowObject:1.0
- nexj:flow:QuestionnaireService:1.0
- nexj:flow:SecurityDelegateService:1.0
- nexj:ilm:DistributeActionCommandClient:1.0
- nexj:ilm:Lead:1.0
- nexj:leaf:Leaflet:1.0
- nexj:rules:CreateActivityPlanCommandClient:1.0
- nexj:rules:CreateTaskCommandClient:1.0
- nexj:rules:MessageActionCommandClient:1.0
- nexj:rules:Rule:1.0
- nexj:rules:SetActionCommandClient:1.0
- nexj:soa:Audit:1.0
- nexj:soa:Bulletin:1.0
- nexj:soa:ConversationService:1.0
- nexj:soa:DataMatchService:1.0
- nexj:soa:DataMatchServiceConfiguration:1.0
- nexj:soa:DesktopBeaconPushService:1.0
- nexj:soa:DesktopPushService:1.0
- nexj:soa:DesktopStreamRefreshPushService:1.0
- nexj:soa:EmailNotificationService:1.0
- nexj:soa:MobilePushService:1.0
- nexj:soa:NotificationService:1.0
- nexj:soa:PortalIntegration:1.0
- nexj:soa:PortletRegistry:1.0
- nexj:soa:Registry:1.0
- nexj:soa:SubscriptionEngineService:1.0
- nexj:soa:UserRegistry:1.0
- nexj:soa:UserRegistryClient:1.0
- nexj:sso:Authentication:1.0
- nexj:ui:ObjectComponentClient:1.0
- nexj:ui:UIComponent:1.0
- nexj:ui:UIComponentClient:1.0
- nexj:ui:WorkQueueItemRelatedObject:1.0
The suggested attributes and values are the same for all SOA connections. For detailed descriptions of SOA connection settings, see https://community.nexj.com/documentation/reference/modl/latest/t_SOAConnections_SOAConnection.html.
Example XML environment file for NexJ CRM deployment on Model Server
The settings from the previous sections are reflected in the following example environment file.
Using the environment file as a template with .properties files
You can use the example environment file above to create an environment file that can be used as a template for multiple environments. It would be similar to the example, but some of the values would be replaced with variables. For example, in the example environment file above, a relational database connection could be defined with the following settings:
<RelationalDatabaseConnection adapter="MSSQL" database="finance" host="localhost" password="nexj" path="jtds-1.2.2-9.jar" port="1433" user="nexj">
In an environment file used as a template, it would be defined with the following settings instead:
<RelationalDatabaseConnection adapter="${RelationalDatabaseConnection.Adapter}" database="${RelationalDatabaseConnection.DEF.Db.Name}${test.clone}" host="${RelationalDatabaseConnection.Db.Host}" password="${RelationalDatabaseConnection.Db.Password}" path="${RelationalDatabaseConnection.Db.Path}" port="${RelationalDatabaseConnection.Db.Port}" user="${RelationalDatabaseConnection.Db.User}">
You would then also need to create one or more .properties files that refer to specific databases used in different deployment environments. For example, you can create a DeploymentMSSQL.properties file that contains the following code:
RelationalDatabaseConnection.Adapter=MSSQL
RelationalDatabaseConnection.DEF.Db.Name=finance
RelationalDatabaseConnection.Db.Host=localhost
RelationalDatabaseConnection.Db.Password=nexj
RelationalDatabaseConnection.Db.Path=jtds-1.2.2-9.jar
RelationalDatabaseConnection.Db.Port=1433
RelationalDatabaseConnection.Db.User=nexj
config=Deployment.environment
You could also create a DeploymentOracle.properties file that contains the following code:
RelationalDatabaseConnection.Adapter=Oracle11g
RelationalDatabaseConnection.DEF.Db.Name=finance
RelationalDatabaseConnection.Db.Host=localhost
RelationalDatabaseConnection.Db.Path=ojdbc14.jar
RelationalDatabaseConnection.Db.Port=1521
RelationalDatabaseConnection.Db.User=nexj_dba
config=Deployment.environment
Note that both of these .properties files also specify the config
setting, which refers to the environment file that is being used as a template.
All the settings described in this topic and in the Model Description Language Reference can be included in an .environment file used as a template, either with either variable or constant values.