Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For a full list of plugins file attributes, go to Plugins File Documentation Plugin Descriptor File.


Info
titlePlugin descriptor

Note that the artifact ids defined in a plugin should match the name of the Java projects - the artifact ids specified when the Java projects were created in the steps above.



Code Block
languagexml
titleplugins.xml
collapsetrue
<pluginconfig>
	<plugins>
		<plugin>
			<name>example-ejb-plugin</name>
			<description>Example ejb plugin<plugin for getting started</description>
			<enabled>true</enabled>
			<vendor>CRM.COM</vendor>
			<version>1.0.0</version>
			<organisations>
				<organisationid>SUBSCRIPTIONS_DB</organisationid>
				<organisationid>ADMIN_DB</organisationid>
			</organisations>
		</plugin>
		<plugin>
			<name>example        <artifacts>
		        <artifactid>example-ejb-plugin</artifactid>
		        <artifactid>example-web-plugin</name>artifactid>
			<description>Example web plugin</description>
			<enabled>true</enabled>
			<vendor>CRM.COM</vendor>
			<version>1.0.0</version>        </artifacts>
			<organisations>
				<organisationid>SUBSCRIPTIONS_DB</organisationid>
				<organisationid>ADMIN_DB</organisationid>
			</organisations>
		</plugin>
	</plugins>
</pluginconfig>

...

A detailed explanation of the model layer can be found at Developing the Model layer, and a detailed explanation of the controller layer can be found at Developing the Controller layer


Property Files

Development Properties 

The dev.properties file is used by developers to enable/disable specific functionalities of the application in order to help them troubleshoot and debug more easily.

...


Code Block
languagexml
titledev.properties
collapsetrue
#Enable/disable development mode - if set to true this will enable some useful development features such as displaying Exception stack traces in error messages. The default value is false.
isdevelopment=true

#Enable/disable automatic initialization  of the organisations during server startup. If this is disabled, each organisation will be initialized during the first login. The default value is true.
initializeOrganizationsOnStartUp=false

#Enable/disable automatic update of the organisation databases during organisation initialization. This property should be used in combination to the initializeOrganizationsOnStartUp. Default value is true.
autoUpdateOrganisationsDatabase=false

#When set, this property will enable logging of SQL statements slower than the specified time (in milliseconds)
sql_log_duration_threshold=1000

#When set, this property will enable logging of Web API calls slower than the specified time (in milliseconds)
api_call_log_duration_threshold=1000


Cache Properties

CRM.COM uses Hibernate second-level caching to cache configuration records for maximum performance.

To enable this caching and set its parameters, you can use cache.properties file located in your CRM_HOME directory.

...

Code Block
languagexml
titlecache.properties
collapsetrue
#enable/disable caching - true/false
enabled=true

#multicast address | multicast host name
multicastGroupAddress=224.0.0.251

#Multicast port
multicastGroupPort=4446
         
#0-255
#0 is restricted to the same host
#1 is restricted to the same subnet
#32 is restricted to the same site
#64 is restricted to the same region
#128 is restricted to the same continent
#255 is unrestricted
#The default value in Java is 1, which propagates to the same subnet. Change the timeToLive property to restrict or expand propagation.
timeToLive=1

#the hostname or IP of the interface to be used for sending and receiving multicast packets 
hostName=cyn1lnx007localhost

#Mandatory - the port the listener listens on.
port=40001

#Optional - the number of seconds client sockets will wait when sending messages to this listener until they give up. By default this is 2000ms.
socketTimeoutMillis=2000


Quartz Properties

CRM.COM uses Quartz Scheduler for process scheduling. Using quartz.properties,  you can set it's parameters.

However, we suggest to avoid modifying the default file unless in case you need to.

Code Block
languagexml
titlequartz.properties
collapsetrue
org.quartz.scheduler.instanceName = DefaultQuartzScheduler
org.quartz.scheduler.rmi.export = false
org.quartz.scheduler.rmi.proxy = false
org.quartz.scheduler.wrapJobExecutionInUserTransaction = false

org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount = 5
org.quartz.threadPool.threadPriority = 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true

org.quartz.jobStore.misfireThreshold = 60000

org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreCMT

# Comment out the following line for PostgreSQL
#org.quartz.jobStore.driverDelegateClass =  org.quartz.impl.jdbcjobstore.StdJDBCDelegate

# Uncomment the following line for PostgreSQL
org.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.PostgreSQLDelegate

org.quartz.jobStore.tablePrefix = QRTZ_

org.quartz.jobStore.dataSource = QUARTZ
org.quartz.jobStore.nonManagedTXDataSource = QUARTZ_NO_TX

org.quartz.dataSource.QUARTZ.jndiURL=defined in ecenter.properties default is jdbc/ecenter
org.quartz.dataSource.QUARTZ.validationQuery=SELECT * FROM ECENTERS WHERE 1=0

org.quartz.dataSource.QUARTZ_NO_TX.jndiURL=defined in ecenter.properties default is jdbc/ecenter
org.quartz.dataSource.QUARTZ_NO_TX.validationQuery=SELECT * FROM ECENTERS WHERE 1=0

# Uncomment the following line for SQLServer 2005:
# org.quartz.jobStore.selectWithLockSQL = SELECT * FROM {0}LOCKS UPDLOCK WHERE LOCK_NAME = ?


ETL Properties

Using the etl.properties file, you can set specific parameters that are used by Pentaho Data Integration to execute the data tranformations.

Code Block
languagexml
titleetl.properties
collapsetrue
#External Kettle directory and launch command for Windows
win_dir=C:/data-integration
win_cmd=C:/data-integration/Pan.bat

#External Kettle directory and launch command for Linux
linux_dir=/opt/data-integration
linux_cmd=/opt/data-integration/pan.sh

#The URL to be used by transformations to call the Web API
webservice_URL=http://localhost:9080/crmapi/rest/v2/

#for diagnostic: if set to 1 does not delete temporary transformation files which are created during their execution.
keepTempTransformation=0