Difference between revisions of "Networking.properties"
From AgileApps Support Wiki
Wikieditor (talk | contribs) |
Wikidevuser (talk | contribs) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 22: | Line 22: | ||
{{Warn|Do not change the <tt>DBSource</tt> property. It's value (<tt>RN</tt>) is the alias used by the Application Server to connect to the data source. If inadvertently changed, the platform won't run.}} | {{Warn|Do not change the <tt>DBSource</tt> property. It's value (<tt>RN</tt>) is the alias used by the Application Server to connect to the data source. If inadvertently changed, the platform won't run.}} | ||
{{Note | This note is applicable only for SLO functionality. As SAML SLO mandates digitally signed requests, any certificates added to the trustStore are used for signing purposes. It is necessary to configure the certificate information in the networking.properties file. Provide the certificate file location for "keystoreFile" property and the certificate password for "keystorePass" property. <br>To use the SLO functionality, update the following in the networking.properties file. | |||
<syntaxhighlight>keystoreFile=C:\SoftwareAG_mysql5.7\profiles\IS_default\configuration\tomcat\conf\RN\testsso.jks | |||
keystorePass=**************== | |||
keyAlias={{alias_name}} | |||
single_logout=1</syntaxhighlight> }} | |||
===Report scheduler service=== | ===Report scheduler service=== | ||
| Line 282: | Line 289: | ||
<tt>max_email_body_size=5242880</tt> (meaning 5*1024*1024) | <tt>max_email_body_size=5242880</tt> (meaning 5*1024*1024) | ||
|} | |} | ||
===EOM Marker=== | |||
:{| border="1" cellpadding="5" cellspacing="0" | |||
|align="center"|'''Parameter''' | |||
!Default Setting | |||
|- | |||
| | |||
::disable_eom_marker | |||
::Notes and Usage: | |||
:* This property enables you to remove the end-of-message text, "Please type your response ABOVE THIS LINE to reply. Case $case_number." (or the translated message in some cases) in the customized emails sent via the AgileApps platform. | |||
:* It is not recommended for customers who want to utilize the Email2Case functionality. | |||
:* This is for on-premise only. | |||
|<tt>disable_eom_marker=1</tt> | |||
|} | |||
===Schedule business rule=== | |||
:{| border="1" cellpadding="5" cellspacing="0" | |||
|align="center"|'''Parameter''' | |||
!Default Setting | |||
|- | |||
| | |||
::max_records_per_connection_br_exe | |||
::Notes and Usage: | |||
:* This property improves the performance of long-running scheduled business rules. | |||
:* The value must be greater than or equal to 1. | |||
|<tt>max_records_per_connection_br_exe=10</tt> | |||
|} | |||
<noinclude> | <noinclude> | ||
Latest revision as of 11:50, 11 January 2024
The networking.properties configuration file is used to enable or disable back end servers and configure performance parameters. These settings apply to all the tenants.
The networking.properties file can also be modified manually, after which the server should be shut down and started again.
In case of multiple servers, the networking.properties configurations should be in sync across all the servers.
- Modify the networking.properties file for all the servers.
- Shut down the servers.
- Start the servers.
The networking.properties file is located at {install_dir}/profiles/IS_default/configuration/tomcat/conf/RN directory
Changing configuration parameters
To enable a configuration parameter, remove the pound key (#):
- config_param (Enabled)
To disable a configuration parameter, add a pound key (#):
- #config_param (Disabled)
After changing parameters, Restart the Application Server to read the new values.
Warning: Do not change the DBSource property. It's value (RN) is the alias used by the Application Server to connect to the data source. If inadvertently changed, the platform won't run.
Note: {{{1}}}
Report scheduler service
Parameter Default Setting - report_scheduler_manager_instance
- report_threads
- Notes and Usage:
- If report_scheduler_manager_instance is enabled, then report_threads must also be enabled
- The report_threads parameter defines the number of threads to be spawned. It can be changed to manage performance.
- Notes and Usage:
- Learn more: Tuning Report Threads
#report_scheduler_manager_instance =1 (Disabled) #report_threads=2 (Disabled, Default = 2)
Import service
Parameter Default Setting - import_manager_instance
- Notes and Usage:
- In distributed server environments, this parameter should be enabled on a single server, only
- Notes and Usage:
- Learn more: Data Import'
#import_manager_instance = 1 (Disabled) - import_manager_instance
Export service
Parameter Default Setting - export_manager_instance
- Notes and Usage:
- In distributed server environments, this parameter should be enabled on a single server, only
- Notes and Usage:
- Learn more: Export Queue
#export_manager_instance = 1 (Disabled) - export_manager_instance
Memcached service
Parameter Default Setting - MemCachedServers=localhost:1121
- Notes and Usage:
- Hostname and Port must match values set at installation
- Learn more: Installation FAQs
- Distributed Caching
- Notes and Usage:
- Multiple memcached servers can be used for distributed access, and minimized response time:
- MemCachedServers=172.28.1.10:11211 172.28.0.120:11211
- Notes:
- The value is space-separated list of server IP addresses and port numbers (11211, in this example)
- Make sure that all instances are configured the same way, to keep the caches in sync.
- Learn more: Configuring memcached
#MemCachedServers=localhost:1121 (Disabled) - MemCachedServers=localhost:1121
Bounce service
Parameter Default Setting - third_party_marketing_campaign_bounce_processing
- Learn more: Email Bounce Notification
third_party_marketing_campaign_bounce_processing=1 (Enabled)
One-click document viewing
When enabled, .docx files and PDFs added as attachments appear in a pop-up PDF viewer when clicked. When turned off, only images appear in a popup when clicked. Other documents must be downloaded to be viewed.
Parameter Notes <syntaxhighlight lang="apache" enclose="div">
- One-Click Document Viewing
open_office_enabled=1 open_office_host= open_office_port= </syntaxhighlight>
- Requires OpenOffice to be installed on the application server.
Learn more: Software Requirements - Default OpenOffice port is 8100.
- Default host is localhost.
CacheType
Parameter Default Setting - CacheType
- Notes and Usage:
- CacheType value determines the cache to be used - EHCache or Memcached
- CacheType value 1 is for Memcached, CacheType value 2 is for EHCache
- By default, “1” is selected
- Notes and Usage:
#CacheType=1 (Disabled) - CacheType
CacheName
Parameter Default Setting - CacheName
- Notes and Usage:
- Comes into effect when EHCache is selected. CacheType=2
- local is for in-memory EHCache, distributed is for distributed EHCache using Terracotta Server
- local or distributed cache is defined at {install_dir}/profiles/LJP/configuration/tomcat/conf/RN directory/ehcache.xml
- New cache configuration can be created in {install_dir}/profiles/LJP/configuration/tomcat/conf/RN directory/ehcache.xml with a unique name for the cache and CacheName property can be set to this unique name
- By default, “localCache” is selected
- Notes and Usage:
#CacheName=localCache (Disabled) - CacheName
On behalf of email disabled
Parameter Default Setting - on_behalf_of_email_disabled
- Notes and Usage:
- This property is used to disable the emails which are sent by email ids or domains other than AgileApps emails to avoid email spoofing.
- Notes and Usage:
#on_behalf_of_email_disabled=0 (disabled) - on_behalf_of_email_disabled
Digitally sign email enabled
Parameter Default Setting - digitally_sign_email_enabled
- Notes and Usage:
- This property is used to enable digital signature for the emails which are sent by AgileApps.
- Notes and Usage:
#digitally_sign_email_enabled=0 (disabled) - digitally_sign_email_enabled
Digitally sign digest algorithm
Parameter Default Setting - digitally_sign_digest_algorithm
- Notes and Usage:
- This property is used to select a valid digest algorithm.
- Supported algorithms are DIGEST_SHA1, DIGEST_MD5, DIGEST_SHA256, DIGEST_SHA384, and DIGEST_SHA512.
- Notes and Usage:
#digitally_sign_digest_algorithm=DIGEST_SHA512 (disabled) - digitally_sign_digest_algorithm
Digi sign email key alias
Parameter Default Setting - digiSignEmailKeyAlias
- Notes and Usage:
- This property specifies the key alias in the digital signature certificate.
- Notes and Usage:
#digiSignEmailKeyAlias=longjump (disabled) - digiSignEmailKeyAlias
Passman configuration file
Parameter Default Setting - passmanConfigFile
- Notes and Usage:
- This property specifies the file path of the configuration file that is used for securing keystore password of the certificate.
- Notes and Usage:
#passmanConfigFile=<file_path> (disabled) - passmanConfigFile
Code instrumentation enabled
Parameter Default Setting - code_instrumentation_enabled
- Notes and Usage:
- This property enables code instrumentation for custom class and JSP.
- Notes and Usage:
code_instrumentation_enabled=0 (disabled) mcode_instrumentation_enabled=1 (enabled)
- code_instrumentation_enabled
Messaging channel
Parameter Default Setting - messaging_channel
- Notes and Usage:
- This property enables Process Engine to communicate through Universal Messaging allowing you to create a case when a step executes and a case spawns a process.
- Notes and Usage:
messaging_channel=0 (disabled) messaging_channel=1 (enabled)
- messaging_channel
Page dimension
Parameter Default Setting - page_dimension
- Notes and Usage:
- This property allows you to configure the page size of the PDF file that is generated by clicking Print from the Actions dropdown of a record.
- Notes and Usage:
page_dimension=Letter (enabled) Other sample values:
- page_dimension=A4
- page_dimension=A3
- page_dimension
Integration server
Parameter Default Setting - integration_server
- Notes and Usage:
- This property enables AgileApps to connect with Integration Server.
- Notes and Usage:
integration_server=1 (enabled) integration_server=0 (disabled)
- integration_server
E-mail Channel
Parameter Default Setting - max_email_attachment_count
- max_email_attachment_size:
- max_email_body_size:
- Notes and Usage:
- This property allows you to configure several attachments, the File size, and the E-mail body size sent over an E-mail.
max_email_attachment_count=5 max_email_attachment_size=5242880 (meaning 5*1024*1024)
max_email_body_size=5242880 (meaning 5*1024*1024)
EOM Marker
Parameter Default Setting - disable_eom_marker
- Notes and Usage:
- This property enables you to remove the end-of-message text, "Please type your response ABOVE THIS LINE to reply. Case $case_number." (or the translated message in some cases) in the customized emails sent via the AgileApps platform.
- It is not recommended for customers who want to utilize the Email2Case functionality.
- This is for on-premise only.
disable_eom_marker=1
Schedule business rule
Parameter Default Setting - max_records_per_connection_br_exe
- Notes and Usage:
- This property improves the performance of long-running scheduled business rules.
- The value must be greater than or equal to 1.
max_records_per_connection_br_exe=10