AgileApps Support Wiki Pre Release

Difference between revisions of "Networking.properties"

From AgileApps Support Wiki
imported>Aeric
 
(66 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:networking.properties}}
{{DISPLAYTITLE:networking.properties}}
The <tt>networking.properties</tt> configuration file is used to enable or disable backend servers and configure performance parameters.
The <tt>networking.properties</tt> configuration file is used to enable or disable back end servers and configure performance parameters. These settings apply to all the tenants.


This file is configured automatically at installation, based on options defined in the <tt>[[installation.properties]]</tt> file.  
The <tt>networking.properties</tt> file can also be modified manually, after which the server should be shut down and started again.  


This file can also be modified manually, after which the server will need to be restarted. Often, other servers will need to be modified in compatible ways. When that is the case:
In case of multiple servers, the <tt>networking.properties</tt> configurations should be in sync across all the servers.  
# The modifications should be made to the <tt>networking.properties</tt> files for all servers.
# All the servers should then be brought down
# The servers can then be restarted.


The <tt>networking.properties</tt> file is located in the following directory:
#Modify the <tt>networking.properties</tt> file for all the servers.
:<tt>{install_dir}/tomcat/conf/RN directory</tt>
#Shut down the servers.
#Start the servers.


==Changing Configuration Parameters==
The <tt>networking.properties</tt> file is located at <tt>{install_dir}/profiles/IS_default/configuration/tomcat/conf/RN directory</tt>


To enable a configuration parameter, remove the Hash mark <tt>(#)</tt>:
==Changing configuration parameters==
 
To enable a configuration parameter, remove the pound key <tt>(#)</tt>:
:: <tt>config_param</tt> (Enabled)
:: <tt>config_param</tt> (Enabled)
To disable a configuration parameter, add a Hash mark <tt>(#)</tt>:
To disable a configuration parameter, add a pound key <tt>(#)</tt>:
:: <tt>#config_param</tt> (Disabled)
:: <tt>#config_param</tt> (Disabled)
After changing parameters, [[Restart the Application Server]] to read the new values.


{{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.}}


The <tt>networking.properties</tt> file includes the following configuration options:
{{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===
:{| border="1" cellpadding="5" cellspacing="0"
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
|align="center"|'''Parameter'''
!Default Setting
!Default Setting
|-
|colspan="2"|'''Report Scheduler Service'''
|-
|-
|
|
Line 38: Line 45:
<tt>#report_scheduler_manager_instance =1</tt> (Disabled)
<tt>#report_scheduler_manager_instance =1</tt> (Disabled)
<tt>#report_threads=2 </tt> (Disabled, Default = 2)
<tt>#report_threads=2 </tt> (Disabled, Default = 2)
|-
|}
|colspan="2"|'''Import Service'''
 
===Import service===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|
|
Line 47: Line 58:
:''Learn more:'' [[Data Import]]'
:''Learn more:'' [[Data Import]]'
|<tt>#import_manager_instance = 1 </tt> (Disabled)
|<tt>#import_manager_instance = 1 </tt> (Disabled)
|-
|}
|colspan="2"|'''Export Service'''
 
===Export service===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|
|
Line 56: Line 71:
:''Learn more:'' [[Export Queue]]
:''Learn more:'' [[Export Queue]]
|<tt>#export_manager_instance = 1</tt> (Disabled)
|<tt>#export_manager_instance = 1</tt> (Disabled)
|-
|}
|colspan="2"|'''Memcached Service'''
 
===Memcached service===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|
|
Line 72: Line 91:
:''Learn more:'' [[Configuring memcached]]  
:''Learn more:'' [[Configuring memcached]]  
|<tt>#MemCachedServers=localhost:1121</tt> (Disabled)
|<tt>#MemCachedServers=localhost:1121</tt> (Disabled)
|}
===Bounce service===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|
:<tt>third_party_marketing_campaign_bounce_processing</tt>
:''Learn more:'' [[Email#Email_Bounce_Notification|Email Bounce Notification]]
|<tt>third_party_marketing_campaign_bounce_processing=1 </tt> (Enabled)
|}
===One-click document viewing===
When enabled, <tt>.docx</tt> 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.
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Notes
|-
|
<syntaxhighlight lang="apache" enclose="div">
#One-Click Document Viewing
open_office_enabled=1
open_office_host=
open_office_port=
</syntaxhighlight>
|valign="top"|
* Requires OpenOffice to be installed on the application server.<br>''Learn more:'' [[Software Requirements]]
* Default OpenOffice port is 8100.
* Default host is <tt>localhost</tt>.
|}
===CacheType===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|
:<tt>CacheType</tt>
::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
|<tt>#CacheType=1</tt> (Disabled)
|}
===CacheName===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|
:<tt>CacheName</tt>
::Notes and Usage:
::* Comes into effect when EHCache is selected. <tt>CacheType=2</tt>
::* '''local''' is for in-memory EHCache, '''distributed''' is for distributed EHCache using Terracotta Server
::* local or distributed cache is defined at <tt>{install_dir}/profiles/LJP/configuration/tomcat/conf/RN directory/ehcache.xml</tt>
::* New cache configuration can be created in <tt>{install_dir}/profiles/LJP/configuration/tomcat/conf/RN directory/ehcache.xml</tt> with a unique name for the cache and CacheName property can be set to this unique name
::* By default, “localCache” is selected
|<tt>#CacheName=localCache</tt> (Disabled)
|}
===On behalf of email disabled===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
<!--
|
|colspan="2"|'''Snapshot Service'''
:<tt>on_behalf_of_email_disabled</tt>
::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.
|<tt>#on_behalf_of_email_disabled=0</tt> (disabled)
|}
 
===Digitally sign email enabled===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|
:<tt>digitally_sign_email_enabled</tt>
::Notes and Usage:
::* This property is used to enable digital signature for the emails which are sent by AgileApps.
|<tt>#digitally_sign_email_enabled=0</tt> (disabled)
|}
 
===Digitally sign digest algorithm===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|
|
:<tt>snapshot_server</tt>
:<tt>digitally_sign_digest_algorithm</tt>
::Notes and Usage:In distributed server environments, this parameter should be enabled on a single server, only
::Notes and Usage:
:''Learn more:'' [[Snapshots]]
::* This property is used to select a valid digest algorithm.
|<tt>#snapshot_server=1</tt> (Disabled)
::* Supported algorithms are DIGEST_SHA1, DIGEST_MD5, DIGEST_SHA256, DIGEST_SHA384, and DIGEST_SHA512.
-->
|<tt>#digitally_sign_digest_algorithm=DIGEST_SHA512</tt> (disabled)
|}
 
===Digi sign email key alias===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|colspan="2"|'''Marketing Email Service'''
|
:<tt>digiSignEmailKeyAlias</tt>
::Notes and Usage:
::* This property specifies the key alias in the digital signature certificate.
|<tt>#digiSignEmailKeyAlias=longjump</tt> (disabled)
|}
 
===Passman configuration file===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|
|
:<tt>marketing_mail_server_instance</tt>
:<tt>passmanConfigFile</tt>
:''Learn more:'' Email [[Campaigns]]
::Notes and Usage:
|<tt>marketing_mail_server_instance=1 </tt> (Enabled)
::* This property specifies the file path of the configuration file that is used for securing keystore password of the certificate.
|<tt>#passmanConfigFile=<file_path></tt> (disabled)
|}
 
===Code instrumentation enabled===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|colspan="2"|'''Bounce Service'''
|
:<tt>code_instrumentation_enabled </tt>
::Notes and Usage:
::* This property enables code instrumentation for custom class and JSP.
|<tt>code_instrumentation_enabled=0</tt> (disabled)
<tt>mcode_instrumentation_enabled=1</tt> (enabled)
|}
 
===Messaging channel===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|
|
:<tt>third_party_marketing_campaign_bounce_processing</tt>
:<tt>messaging_channel</tt>
:''Learn more:'' [[Email#Email_Bounce_Notification|Email Bounce Notification]]
::Notes and Usage:
|<tt>third_party_marketing_campaign_bounce_processing=1 </tt> (Enabled)
::* 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.
|<tt>messaging_channel=0</tt> (disabled)
<tt>messaging_channel=1</tt> (enabled)
|}
 
===Page dimension===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|colspan="2"|'''Vertical Response'''
|
:<tt>page_dimension</tt>
::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.
|<tt>page_dimension=Letter</tt> (enabled)
Other sample values:
:<tt>page_dimension=A4</tt>
:<tt>page_dimension=A3</tt>
|}
 
===Integration server===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''Parameter'''
!Default Setting
|-
|-
|
|
:<tt>vr_integration_master_username</tt>
:<tt>integration_server</tt>
:<tt>vr_integration_master_password</tt>
::Notes and Usage:
::Notes and Usage:
::* Configure master VerticalResponse credentials to be used throughout the platform.
::* This property enables AgileApps to connect with Integration Server.
:''Learn more:'''' [http://www.verticalresponse.com/support/ VerticalResponse]
|<tt>integration_server=1</tt> (enabled)
|valign="top"| These variables are optional. They are not automatically included in the configuration file, and have no default value.
<tt>integration_server=0</tt> (disabled)
|}
 
===E-mail Channel===
:{| border="1" cellpadding="5" cellspacing="0"
|align="center"|'''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.
 
|<tt>max_email_attachment_count=5</tt>
 
<tt>max_email_attachment_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>
[[Category:Installation]]
</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.

  1. Modify the networking.properties file for all the servers.
  2. Shut down the servers.
  3. 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.

Warn.png

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.

Notepad.png

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.
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
Learn more: Data Import'
 #import_manager_instance = 1 (Disabled)

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
Learn more: Export Queue
 #export_manager_instance = 1 (Disabled)

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
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)

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">

  1. 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
 #CacheType=1 (Disabled)

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
 #CacheName=localCache (Disabled)

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.
 #on_behalf_of_email_disabled=0 (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.
 #digitally_sign_email_enabled=0 (disabled)

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.
 #digitally_sign_digest_algorithm=DIGEST_SHA512 (disabled)

Digi sign email key alias

Parameter Default Setting
digiSignEmailKeyAlias
Notes and Usage:
  • This property specifies the key alias in the digital signature certificate.
 #digiSignEmailKeyAlias=longjump (disabled)

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.
 #passmanConfigFile=<file_path> (disabled)

Code instrumentation enabled

Parameter Default Setting
code_instrumentation_enabled
Notes and Usage:
  • This property enables code instrumentation for custom class and JSP.
 code_instrumentation_enabled=0 (disabled)

mcode_instrumentation_enabled=1 (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.
 messaging_channel=0 (disabled)

messaging_channel=1 (enabled)

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.
 page_dimension=Letter (enabled)

Other sample values:

page_dimension=A4
page_dimension=A3

Integration server

Parameter Default Setting
integration_server
Notes and Usage:
  • This property enables AgileApps to connect with Integration Server.
 integration_server=1 (enabled)

integration_server=0 (disabled)

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
Retrieved from "https://agileappscloud.info/aadev-src/index.php?title=Networking.properties&oldid=30511"