All environment values targeting global configuration settings have a name beginning with PISASALES_WEBCLI_. The ID of the global setting is appended in lower case to the name.
Example:
export PISASALES_WEBCLI_wsv_frc_tls=trueSet a value to $NONE (literally) to force an empty configuration setting.
The following table lists all supported global configuration settings.
| ID | Type | Default | Name | Description |
|---|---|---|---|---|
app_cfg_pth | text | (empty) | Application Configuration path | Specifies a specific path for application configuration data to be used instead of the default path |
bas_wnd_hgt | text | 635 | Base window design height | The height of the window (display, monitor) that is used in dialog design. Must be at least 600. |
bas_wnd_wdt | text | 900 | Base window design width | The width of the window (display, monitor) that is used in dialog design. Must be at least 800. |
bsc_tmo_off | number | 0 | Wait animation - "off" timeout time | Minimal duration in milliseconds of a "wait" animation. Set to 0 for default value |
bsc_tmo_sho | number | 0 | Wait animation - "show" timeout time | Delay time in milliseconds before a "wait" animation is shown; Set to 0 for default value. |
chk_log_out | bool | false | Check for proper session termination | If set, the system checks whether the users log out properly. A warning is then shown if a previous session was not correctly logged out. |
cli_aut_dwn | bool | true | Automatic Download | The Automatic Download property determines whether downloads are started automatically, i.e. whether a file is immediately transferred to the client after a user request. It is recommended to leave automatic downloads enabled. If you are experiencing issues with browsers blocking the download process, then set this property to false. |
cus_css_url | text | (empty) | URL of custom CSS definition | If set, this URL is passed to the user's web browser to provide additional CSS definitions. The default is empty. |
cus_pvc_url | text | (empty) | Custom privacy URL | A URL that links to the privacy policy of your company. It must begin with either "https://" or "http://". Defaults to JustRelate Deutschland GmbH's privacy policy. |
dbg_adv_jslog | bool | false | Debug: Activate advanced logging of JavaScript errors | If active, more context information is stored for better analysis of possible JavaScript errors. It increases memory consumption of the web browser. |
dbg_cmd_avl | bool | false | Debug: Enable special debugging and test commands | Indicates whether debugging commands are available. The default is "false". |
dbg_mon_avl | bool | false | Debug: Enable JustRelate CRM Web Client Monitor | This setting controls whether the JustRelate CRM Web Client Monitor is available. The default is "false". |
dbg_mon_pwd | password | (empty) | Debug: Password required to access JustRelate CRM Web Client Monitor | Access to JustRelate CRM Web Client Monitor can be protected by a password. The default is not set, so anyone can access JustRelate CRM Web Client Monitor. |
dbg_wvw_avl | bool | false | Debug: Enable special "watch" view | Indicates whether the special "watch" view is available. The default is "false". |
dim_aut_lgi | bool | false | Enable JustRelate CRM Desktop integration based auto-login | Auto-login based on JustRelate CRM Desktop integration relies on the end user's user name and logon domain. A more secure procedure such as OpenID Connect is strongly recommend to be used instead. |
dim_frc_tls | bool | false | Force TLS for JustRelate CRM Desktop Integration | Forces the use of TLS for JustRelate CRM Desktop Integration web socket connections. |
dim_old_con | bool | false | JustRelate CRM Desktop Integration: Use legacy URI scheme to establish the connection | If set, the legacy URI scheme is used to establish the connection to JustRelate CRM Desktop integration. |
dim_ssn_tmo | number | 120 | JustRelate CRM Desktop Integration Session Timeout | Timeout in seconds after an inactive connection to the JustRelate CRM Desktop Integration will be closed. |
dim_use_lnk | bool | false | JustRelate CRM Desktop Integration Initialization Method | Specifies the method how the JustRelate CRM Desktop integration is initialized; Set to true to use a special hyperlink if the the default method using an iframe-element does not work in your environment. |
dim_wsc_url | text | /psawsc | JustRelate CRM Desktop Integration service URL (End user's browser's point of view) | The URL of the JustRelate CRM Desktop Integration service. The default is "/psawsc", meaning that the service is hosted by the same web server and has the servlet name "psawsc". The full syntax is "[hostame[:port]]/servlet" |
dis_brw_plg | bool | false | Disable JustRelate CRM Desktop Integration | Disables the JustRelate CRM Desktop Integration. Functions that require the JustRelate CRM Desktop Integration will not work. The default value is false. |
dis_dim_dnl | bool | false | Disable download of JustRelate CRM Desktop Integration | If set to true, users may not download the JustRelate CRM Desktop Integration installer module. |
dis_dyn_ttp | bool | false | QuickViews: Disable QuickViews | If activated, then all QuickViews are disabled and will not appear. |
dis_nfo_wdg | bool | false | Disable info widgets on login screen | If activated, no info widgets (version information etc.) will be shown on the login screen. |
dis_usr_cfg | bool | false | Discard user configuration | If activated, any user-specific configuration data is discarded so that each session starts with blank configuration data. |
dsk_nfy_off | bool | false | Disable Desktop Notifications | Disables any desktop notifications in the context of the JustRelate CRM Web Client. Consider disabling desktop notifications in portal mode. |
dsp_min_hgt | text | 768 | Minimal required display height | Specifies the minimal required display height in pixels. If the browser's page area height is smaller than this value, a scrollbar appears. The value 0 turns the scrollbar off. Any negative value causes the built-in default to be used. |
dsp_min_wdt | text | 1280 | Minimal required display width | Specifies the minimal required display width in pixels. If the browser's page area width is smaller than this value, a scrollbar appears. The value 0 turns the scrollbar off. Any negative value causes the built-in default to be used. |
edt_cke5_bsc | bool | true | Use basic CK Editor 5 | A setting that allows using the CK Editor 5 with reduced toolbar or balloons. This way the editor loads faster and consumes less memory. A full featured editor is still available. Defaults to true. |
ena_ssn_cookies | bool | true | Enable Session Cookies | Session cookies are used to identify running sessions while handling object links. If session cookies are disabled, each object link will require an explicit login. |
ena_wake_locks | bool | true | Enable Wake locks | Wake locks are used to prevent the user's computer from entering suspend or sleep mode. This avoids session timeouts. If not enabled, wake locks are globally turned off. If enabled, users can turn wake locks on or off. |
frc_dlg_mod_bar | bool | false | Force Dialog Modification Bar | This variable is valid only in portal mode. It forces the display of the dialog modification bar (Save/Cancel Buttons). The default value is false. |
glb_dbg_mod | bool | false | Web Client DEBUG mode | Allows the internal DEBUG mode to be turned on or off. The default value is "off". |
glb_dsp_nam | text | (empty) | JustRelate CRM Web Client's display name | An informational text that may identify this JustRelate CRM Web Client instance better. |
glb_ins_ids | text | (empty) | JustRelate CRM Web Client's instance ID | An ID string that may identify this JustRelate CRM Web Client instance better. |
glb_rdr_frc | bool | false | Global redirect forced | If this value is set to true, and a global redirect URL is specified, then this instance rejects logging in and redirects access to the specified redirect URL |
glb_rdr_url | text | (empty) | Global redirect URL | Specifies the global redirect URL |
hid_ext_lgi_nfo | bool | false | Hide extended info on login | Hides the link to the company home page, privacy settings and the info screen. |
imc_tim_tmo | number | 60 | Unread message count update timeout | Interval (in seconds) for the background task that updates the count of unread messages displayed in the top bar. A value of 0 disables the timer. |
ini_dis_lgi | bool | false | Login initially disabled | If set to true, the login is initially disabled after web server startup and must be enabled explicitly by an administrator. |
lgi_bkg_clr | text | (empty) | Background color of login screen | May be set to an HTML color value such as "#00796B". If set, this color is used instead of a background picture. Empty by default, causing the background picture to be shown. |
lgi_lng_lis | text | (empty) | Language list | Specifies the available languages on the login page. The syntax is "IDN(Title:code)[, IDN(Title:code)]". Example: "GER(Deutsch:de), ENG(English:us)". |
lgi_lng_sel | bool | true | Language selection on login page available | Specifies whether or not the user can select a specific language to be used in this session. This will not override the user's language settings in the repository. The default is true. |
lgi_nfo_txt | text | (empty) | Additional login info text | If set, this text is shown on the login page as special message / information to the users. You can set a hyperlink with the following syntax: {link:URL/title}. |
lng_loc_ovr | text | (empty) | Default language and locale overrides | Overrides the default locale for several languages. Enter a semicolon separated list of language codes according to BCP 47 / RFC 5646; example: "en-NZ; de-CH; es-AR" |
mac_use_tch | bool | false | Always redirect to mobile app on Macintosh platform | If set to true, any object link request from a Macintosh client computer will be redirected to the mobile app. This is due to a change in Safari on iPad stating to be a desktop system. |
nav_hst_siz | number | 5 | Navigation History Size | The navigation history size property is used only in portal mode. It determines the span of dialogs that can be navigated via the "Back" and "Forward" buttons. Dialogs outside that span are dropped and are not navigable. The number of navigable dialogs should be kept small because these dialogs are present also in the Browser DOM. You must allow for at least 1 navigable dialog. The expected value is an integer greater than or equal to 1. |
nfy_wnd_pos | text | BR | Notification window position | Specifies the position where notification windows appear. Possible values are "TL" (top/left), "TH" (top/center), "TR" (top/right), "VL" (center/left), "VH" (center/center), "VR" (center/right), "BL" (bottom/left), "BH" (bottom/center), "BR" (bottom/right). The default is "BR" (bottom/right). |
nfy_wnd_tmo | number | 14 | Notification window visibility time | Time in seconds that a notification window remains visible if the user does not close it. |
otn_tim_tmo | number | 0 | Open transactions timer timeout | Interval (in seconds) for the background task that checks whether any transactions are open. The default of 0 disables the timer. |
plg_log_lvl | text | WARN | Logging level of JustRelate CRM Desktop Integration | Sets the logging level of the JustRelate CRM Desktop Integration. The expected value is one of {TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF}. |
psc_blk_rdr | text | (empty) | Block redirect | If user access to the portal login screen is blocked, and if this parameter is set, the user is immediately redirected to the URL specified as a value. The URL value should be provided with a prefix, i.e., the expected value is of the form {fixed::www.xyz.com}. By default, this parameter is set to an empty string. |
psc_exi_rdr | text | login | Exit redirect option | The redirect option determines what happens when the user exits the application. The expected values are {login} to redirect to the login page, or {blank} to show a blank page, or {fixed::www.xyz.com} to redirect to specific URI. The default is {login}. The application server may override this. |
psc_exi_rto | number | 3 | Exit redirect timeout | The redirect timeout determines the number of seconds between the logout action and the triggering of the redirect process. Warning: this timeout is required to store the current user configuration of persistent application components. The recommended value is 10, the value is interpreted in seconds. Defaults to 10. |
psc_msg_ttl | text | (empty) | Message dialog title | The message dialog title determines the title of basic message boxes. The default title of these boxes is “JustRelate CRM client”. Set the value of this variable to a non-empty string to modify that title. The expected value type is string. The default value is an empty string. |
psc_por_app | text | (empty) | Portal application name | The portal application name defines a Sales application from the available applications which will be used as the Sales application for the portal mode. The user will not be presented with an option to choose a different application. Please ensure that the application is also defined in the application set. The expected value is a string. |
psc_por_blk | bool | false | Block portal login access | This parameter allows administrators to block access to the user login screen when portal mode is activated. This feature can be useful in cases where the client is used with server autologin, and serves a very specific functionality. The default value is false. |
psc_por_mod | bool | false | PSC Portal Mode | The portal mode property determines whether the web client is running in full mode (false) or portal mode (true). In portal mode, the users are presented with the PiSA Web Portal Interface, which provides simplified access to the system. |
shw_cli_nfo | bool | false | Show client information on login | If set to true, then some client information is displayed in the message window. In portal mode, this value is always false. |
ssn_alv_tim_out | number | 5 | Session Alive Timeout | The session alive timeout determines the amount of time in minutes after an inactive session is considered to be dead. A value of less than 2 minutes is not allowed. Time is measured in minutes, the default timeout is 5 minutes. |
ssn_frc_tls | bool | false | Force HTTPS protocol | Forces the use of the HTTPS protocol. The default is false. |
tmp_frc_rap_tbl | bool | false | Temporary: Force the use of the classic table control | A temporary option that forces the use of the classic table control. |
ttp_sho_tmo | number | 0 | QuickViews: Tooltip/QuickView delay time | Delay time in milliseconds before a tooltip or QuickView appears if the mouse pointer hovers over a tooltip or QuickView aware item. Set to 0 for the default value. |
url_cli_img_ret_svc | text | (empty) | URL of image retrieval service | If the provided URL value is not empty, this variable will force the client to retrieve resources (such as images) on the client side using the service. If the variable is empty, the web-client server must have access to the web. |
ver_nfo_rdc | bool | false | Reduced version information | If active, a greatly reduced version information is shown in the version information dialog. |
wai_for_dim | number | 10 | JustRelate CRM Desktop Integration Initialization Timeout | Timeout in seconds until a connection to the JustRelate CRM Desktop Integration must have been established. |
web_cli_uri | text | (empty) | URI of this JustRelate CRM Web Client instance | If this JustRelate CRM Web Client instance can be reached via different URIs, a common valid URI should be specified here. It must end with the correct servlet name. |
wsv_frc_tls | bool | false | Force TLS for backend web socket connection | Force the use of TLS for web socket connections created by the web client backend and the application server. |
wsv_wsc_url | text | /psawsc | JustRelate CRM Desktop Integration service URL (Web server's point of view) | The URL of the JustRelate CRM Desktop Integration service. The default is "/psawsc" which means that the service is hosted by the same web server and has the servlet name "psawsc". The full syntax is "[hostame[:port]]/servlet" |
All environment values targeting login sets have a name beginning with PISASALES_WEBCLI_LGI_. There's one overall value named PISASALES_WEBCLI_LGI_COUNT that specifies how many login sets are configured by environment values.
All login-set-specific values have a name prefix that provides the matching index: PISASALES_WEBCLI_LGI_n_ with n = 1, 2, 3, ...
For each login set to be created or updated from environment values, the login set name (also called application name) must be provided, i.e., the environment value PISASALES_WEBCLI_LGI_n_NAME must yield a non-empty name. Example:
export PISASALES_WEBCLI_LGI_COUNT=2
export PISASALES_WEBCLI_LGI_1_NAME="Application One"
export PISASALES_WEBCLI_LGI_2_NAME="Application Two"In order to create a new login set, the host name and the target port must be specified. All other values are optional.
Example:
export PISASALES_WEBCLI_LGI_1_HOST=crm-host1.domain.com
export PISASALES_WEBCLI_LGI_1_PORT=42042It is neither required nor possible to set all properties by environment variables. If a particular property is not set, the current value of an existing login set or the default value of a new login set becomes effective.
The following basic values are recognized:
| Name | Value | Description |
|---|---|---|
NAME | Application name | The name of the login set, shown in the application selector. |
HOST | host name | The hostname of the application server. |
PORT | 0 < port number < 65535 | The TCP port at which the application server is listening. |
USER | user name | The default user name. Usually not needed. |
SASHPROPS | y / n | Persistent sash positions. |
TABITEMS | y / n | Persistent tab item selection. |
FIXED | y / n | If set, the user cannot change the login name. In this case USER must be set. |
AUTOLOGIN | y / n | Setting AUTOLOGIN to y requires USER to be set any may be used to enter the application bypassing the login page if the web client is invoked with a matching URL. |
All extended application configuration options have the name prefix PISASALES_WEBCLI_LGI_n_CFG_ with n = 1, 2, 3, ...
The following extended application configuration options are recognized:
| Name | Value | Description |
|---|---|---|
FORCETMS | Timestamp in PisaCubes format | User configurations older than the given timestamp apply configuration settings from the login set. |
BRWVIEW | y / n | Shows or hides the "Browser" view. |
DSKVIEW | y / n | Shows or hides the "Desktop" view. |
FNCPANEL | y / n | Shows or hides the function panel. |
MSGVIEW | y / n | Shows or hides the "Messages" view. |
MULTIXTV | y / n | Activates or deactivates multiple external views. |
NOOVERFLOW | y / n | If active, main tabs that become invisible are closed immediately. |
PUSHSVC | y / n | Activates or deactivates the push notification service. |
QVWSHOWALL | y / n | Activates or deactivates the "show all QuickViews" feature. |
QVWSHOWEXT | y / n | Activates or deactivates the "show QuickViews in external views" feature. |
RCNCTRLS | y / n | Shows or hides the record navigation controls. |
TABGROUPING | y / n | Activates or deactivates the "tab grouping" feature. |
TBPINNED | y / n | Sets the second top menu bar to be pinned or unpinned. |
VIEWTGL | y / n | Sets the view toggle buttons to be visible or hidden. |
WSCTLS | y / n | Force TLS for push notification service. |
WSCURL | URL | Sets a specific web socket URL for the push notification service. |
XVIEWTAB | y / n | Specifies whether external views should be opened in a new browser tab (y) instead of a popup window (n). |
All options related to load balancing have the name prefix PISASALES_WEBCLI_LGI_n_LBA_ with n = 1, 2, 3, ...
The following options related to load balancing are recognized:
| Name | Value | Description |
|---|---|---|
LBA_USE | y / n | Activates or deactivates the load balancing feature. |
LBA_DEFHOST | y / n | Indicates whether to include the default host in the list of target hosts. |
LBA_TIMEOUT | seconds | A socket timeout in seconds to wait for a response of an application server. |
LBA_COUNT | k = 1, 2, 3, ... | The number of hosts to be contacted in the load balancing process. |
LBA_HOST_k_NAME | hostname | The hostname of the k'th host. k = 1, 2, 3, ... |
LBA_HOST_k_PORT | 0 < port number < 65535 | The TCP port of the k'th host. k = 1, 2, 3, ... |
The hostname and the TCP port must be specified for each load balancing host.
All options related to OpenID-Connect ("OIDC") have the name prefix PISASALES_WEBCLI_LGI_n_OIDC_ with n = 1, 2, 3, ...
The following options related to OpenID-Connect are recognized:
| Name | Value | Description |
|---|---|---|
DCU | URI | The URI of the discovery document. |
SVU | URI | The URI of the authentication service. |
TEU | URI | The URI of the token endpoint |
CID | text | The client ID. |
SEC | text | The client secret. |
RDR | URI | The re-direct URI. |
SCS | text | Additional scopes to be requested from the ID provider. |
FRC | y / n | If set to y, the user must always perform a full login procedure. |
POP | y / n | If set to y, the authentication service should show a popup window. |
POP | JSON | The size of the popup window as JSON. Example: {"cx": 420, "cy":640} |