System Parameters¶
System parameters are global parameters for the installation. These parameters defines the behavior in a wide range of areas like Background jobs, Reporting and User Assistance.
All system parameters:
Parameter | Category | Behavior |
IFS.ai Copilot Chat | AI | Values ON/OFF defines the IFS.ai Copilot Chat being enabled or disabled. Default value is ON. |
IFS.ai Copilot access to IFS public documentation | AI | Allow access to IFS public documentation from IFS.ai Copilot chat. Default value is ON |
Logging of background processes | Background Jobs | Logging of background processes. Default value is OFF. |
Cleanup age limit in days for completed background jobs | Background Jobs | The age of completed background jobs to be removed by cleanup processes. Default value is 7 (days). (Note: Background jobs marked as "Exclude From Cleanup" will not be removed.) |
Scheduled tasks process startup | Background Jobs | The values are ON/OFF and defines if the scheduled tasks process is started or not. Default value is ON. |
Number of background processes | Background Jobs | This parameter limits the number of job slave processes for the Scheduler. The maximum number of job slave processes for Scheduler is determined by the lesser of the values of JOB_QUEUE_PROCESSES and this parameter. This cannot be set to 0. Default value is 10. NOTE: This parameter is deprecated from IFS Applications 9 onwards. The parameter does not have an impact on controlling the number of background jobs as it has been deprecated from Oracle Database 11g Release 2 (11.2) onwards. In future this parameter will be obsolete in IFS Applications as well, use JOB_QUEUE_PROCESSES oracle parameter instead. |
Cleanup age limit in days for inactive Scheduled tasks | Background Jobs | The age of inactive scheduled tasks to be removed by cleanup processes. Default value is 7 (days). |
Cleanup age limit in days for background jobs with warning | Background Jobs | The age of background jobs with state "warning" to be removed by cleanup processes. Default value is 30 (days). (Note: Background jobs marked as "Exclude From Cleanup" will not be removed.) |
Cleanup age limit in days for background jobs with errors | Background Jobs | The age of background jobs with state error to be removed by cleanup processes. Default value is 180 (days). (Note: Background jobs marked as "Exclude From Cleanup" will not be removed.) |
Scheduled tasks process startup interval (seconds) | Background Jobs | This parameter defines how often the scheduled tasks process wakes up and checks if there are any scheduled tasks to submit on the batch queues. Default value is 60 (every minute). |
Connectivity Inbox process available | Connectivity | The values are ON/OFF and controls the use of IFS/Connectivity Inbox background job process. Default value is OFF. |
Connectivity Outbox process available | Connectivity | The values are ON/OFF and controls the use of IFS/Connectivity Outbox background job process. Default value is OFF. |
Connectivity Inbox process restartup interval (seconds) | Connectivity | This is the number of seconds for the process running Inbox background jobs to wait before checking for new jobs to process. Default value is 30 (seconds). |
Connectivity Outbox process restartup interval (seconds) | Connectivity | This is the number of seconds for the process running Outbox background jobs to wait before checking for new jobs to process. Default value is 30 (seconds). |
Cleanup age limit in days for accepted messages in Outbox | Connectivity | Age of accepted messages in the Outbox to be removed by cleanup processes. Default value is 7 (days). |
Cleanup age limit in days for accepted messages in Inbox | Connectivity | Age of accepted messages in the Inbox to be removed by cleanup processes. Default value is 7 (days). |
Cleanup age limit in days for Application Message Statistics | Connectivity | Age of Application Message Statistics to removed by cleanup processes. Default value is 7 (days). |
Tablespace for custom LOBs | Configuration Items | Default tablespace for LOBs in Configuration Items |
Custom Fields framework | Configuration Items | Custom Fields framework enabled or disabled. Default value is ON. |
Tablespace for custom indexes | Configuration Items | Default tablespace for indexes in Configuration Items |
Tablespace for custom tables | Configuration Items | Default tablespace for tables in Configuration Items |
Custom Pages framework | Configuration Items | Custom Pages framework enabled or disabled. Default value is ON. |
Data archive process startup | Data Archive | Data archive process started or not. Default value is OFF. |
Data archive process startup interval (seconds) | Data Archive | This parameter defines how often the data archive process wakes up and checks if there are any data archive orders to execute. Default value is 3600 (every hour). |
Data Migration default tablespace for dynamically created tables | Data Migration | Default tablespace for tables used by the IFS Data Migration. Default value is ‘*’ (No tablespace defined). |
Data Migration default tablespace for dynamically created indexes | Data Migration | Data Migration default tablespace for dynamically created indexes |
Data Migration alternative user for replication jobs | Data Migration | Data Migration alternative user for replication jobs |
Event Registry date and time format | Event Management | The date and time format used by Event Registry. This parameter controls the syntax when defining conditions in the Event Registry. Default value is YYYY-MM-DD HH24.MI.SS. |
Event Registry date format | Event Management | The date format used by Event Registry. This parameter controls the syntax when defining conditions in the Event Registry. Default value is YYYY-MM-DD. |
Event Registry time format | Event Management | The time format used by Event Registry. This parameter controls the syntax when defining conditions in the Event Registry. Default value is HH24.MI.SS. |
Enable file scan to detect malware | File Scan Settings | This parameter defines whether file uploads and downloads needs to be scanned for malware. Default value is ENABLED. |
Allow to skip individual file to scan | File Scan Settings | This parameter defines whether it's allowed to skip individual file scans. Default value is NOT_ALLOWED. |
Proxy Server used for HTTP requests | HTTP | Sets the proxy to be used for requests of the HTTP or other protocols, excluding those for hosts that belong to the domain specified in "List of hosts and domains for which no proxy should be used". The proxy may include an optional TCP/IP port number at which the proxy server listens. The syntax is [http://]host[:port][/], for example, www-proxy.my-company.com:80. If the port is not specified for the proxy, port 80 is assumed. Default value is "*" (no proxy). |
List of hosts and domains for which no proxy should be used | HTTP | A comma-, semi-colon-, or space-separated list of domains or hosts for which HTTP requests should be sent directly to the destination HTTP server instead of going through a proxy server. Optionally, a port number can be specified for each domain or host. If the port number is specified, the no-proxy restriction is only applied to the request at the port of the particular domain or host, for example, corp.my-company.com, eng.my-company.com:80. When no_proxy_domains is NULL and the proxy is set, all requests go through the proxy. When the proxy is not set, UTL_HTTP sends requests to the target Web servers directly. Default value is "*" (no hosts or domains). |
Permission set to be granted Lobby presentation objects by default | Lobby | Permission set to be granted Lobby presentation objects by default. No default permission set. |
Maximum time for executing a query of a lobby element | Lobby | Maximum time for executing a query of a lobby element. Default Value is 180 (seconds). |
Number of days ahead of expiration for subscription renewal prompt | Object Subscriptions | This parameter controls the number of days before the subscription renewal message should be sent for a subscription which is about to expire. |
Url or path of the company logo file used in quick print | Output Channels | This is initially automatically set during the Extended Sever installation but can be edited manually here. |
Replication process available | Replication | Values are ON/OFF and control the replication background process on a master site. The replication background process checks the replication queue. When the background process finds a row in the replication queue it creates a Connectivity message. Connectivity sends the message to the slave(s). The process is only needed on a master site. Default value is OFF. |
Replication process restartup interval (seconds) | Replication | Controls the replication background process interval between wake-ups of the process. The process will sleep for the specified number of seconds before checking for a new row in the replication queue. The replication background process creates a connectivity message and place it in the connectivity outbox. The message will be processed by the connectivity outbox process. This means that the Connectivity Outbox process available parameter needs to be ON in order for connectivity to process the message. Default value is 30 (medium restart) |
Cleanup age limit in days for replicated messages | Replication | Controls the cleanup of the replication queue and the cleanup of replication messages in the connectivity outbox and inbox. The cleanup only removes rows that have been successfully processed. The value is specified in days. Fraction of days is allowed. Default value is 0.007 days (1 minute). |
Log Replication Send warnings | Replication | Values are ON/OFF and controls if warnings on the receiving instance should be sent or not. Default value is ON. |
Log Replication Send information | Replication | Values are ON/OFF and controls if information on the receiving instance should be sent or not. Default value is OFF. |
Log Replication Receive warnings | Replication | Values are ON/OFF and controls if warnings, on the receiving instance should be logged or not. Default value is ON. |
Log Replication Receive information | Replication | Values are ON/OFF and controls if information, on the receiving instance should be logged or not. Default value is OFF. |
Collect Replication statistics information | Replication | Values are ON/OFF and controls the collection of statistics upon replication. Default value is OFF. |
Replication statistics date key format | Replication | Values are YYYY-MM-DD/ YYYY-MM-DD-HH24 and controls the sum up interval for the statistics. With a value of YYYY-MM-DD statistics will be summed up daily and a value of YYYY-MM-DD-HH24 will sum up the statistics hourly. Default value is YYYY-MM-DD. |
Report Plug-in output directory | Reporting | Path where the output of the report formatter plug-ins are saved. Default value is *. |
Default paper format | Reporting | Values are A4/LETTER/OTHER and defines what paper format should be used by default when printing reports. This parameter will be overridden per user if specific settings of paper format are made for users. Default value is A4. |
Show only the assigned logical printers and default physical printer | Reporting | This parameter defines whether the default printer settings in APPSRV module are used. The values are YES/NO. If value is YES, the printers shown when ordering a report through the print dialog are filtered. i.e. Only the default physical printer and the logical printers assigned for the report/user are displayed. Default value is YES. |
Cleanup age limit in days for printouts in Print Manager | Reporting | The age of printout logs to be removed by cleanup processes. Default value is 7 (days). |
Cleanup age limit in days for reports in Archive | Reporting | The age of archive items to be removed by cleanup processes. Default value is 7 (days). |
<IFSINFO> schemaOracle user | Reporting | The name of the Oracle user representing the owner of the so called <IFSINFO> schema. |
Base path for Report Designer graphics on the application server | Reporting | This is initially automatically set during the Extended Sever installation but can be edited manually here. |
Maximum allowed XML size for Report Designer reports (KB) | Reporting | This parameter controls the size of the XML data, to prevent the out of memory crashes in middle tier. This limitation is checked before formatting the report from Report Formatter and if the memory consumption exceeds the allowed values, appropriate messages are shown to the user. The default values is 0 (zero), which is meaning that there is no limit. |
Breakpoint XML size for when to format Report Designer reports in memory or using disk storage (kB) | Reporting | This parameter controls the Disc Cache. With it, you can make sure that small reports are handled in memory without being swapped out to disc. Disc Cache will slow the PDF generation down by 30%. However large reports needs to be swapped out to disc in order to save memory. The parameter sets the limit of XML data size (Kb). If the data is larger than this limit, the Formatting Processor (FOP) will use Disc Cache. A good setting for this is 100kB. This is also the default. |
The machine name where the Crystal Web Service is installed | Reporting | The machine name to be used when accessing Crystal Web Service is installed. The default value is *. |
The protocol of the Web Server where the Crystal Web Service is running | Reporting | The protocol to be used when accessing the Crystal Web Service. Normally this is the IIS default protocol. The default value is https. |
The IIS port for the above mentioned Web Server | Reporting | The port to be used when accessing the Crystal Web Service. Normally this is the IIS default port. The default value is 443. |
The Virtual Directory name given to the Crystal Web Service in IIS | Reporting | The Virtual Directory name be used when accessing the Crystal Web Service. This is the name one would specify when installing the Crystal Web Service. The default value is IFSCRWebSetup. |
Specify if web database access security check is required | Reporting | Specify if web database access security check is required when previewing/printing Quick Reports. Default value is NO. |
Default tablespace for <IFSINFO> schema tables | Reporting | Default tablespace for tables in <IFSINFO> schema |
Extended Server Url | Reporting | This is initially automatically set during the Extended Sever installation but can be edited manually here. This parameter is deprecated, but will be set to the same value as Server Url by the installer. The parameter named Server Url (Category System Settings) should be used instead. |
Make Report Designer PDF/A compliant | Reporting | Make Report Designer PDF/A compliant. Default value is NO. |
Set automatic rotate and center for Report Designer layouts | Reporting | Set automatic rotate and center for Report Designer layouts. Default value is ON. |
Report preview timeout before the preview operation runs in background (seconds) | Reporting | This is the number of seconds / duration that the report preview operation would take place. Once this duration is up, report preview would continue in the background and archive the report. |
Report rule advanced logging ON/OFF | Reporting | Report rule advanced logging. Default value is OFF. |
Default tablespace for <IFSINFO> schema table indexes | Reporting | Default tablespace for <IFSINFO> schema table indexes. |
Default logical printer ID to be used when none of the Report level or User level default Logical printer value is not set | Reporting | Specifies the default Logical Printer to use in Print Jobs when no Logical Printer is passed or when no user, report or user/report default Logical Printer is defined. Default value is NO_PRINTOUT. |
Send a notification email when an archived report is distributed | Reporting | Specifies if to send a notification email to the distributed user(s) or users in a distribution group when a report is distributed. Default value is YES. |
Prevent overwrite of report life when RDF is deployed | Reporting | Specifies if to overwrite the modified report lifetime changed through Report Definition with the report lifetime specified in the RDF. Default value is NO. |
Message Queue for report email and routing | Reporting | Specifies the queue used by IFS Connect to send the generated report through email. This is also used to process the application message created when routing the report or the generated data through IFS Connect when printing to SEND_*_TO_CONNECT logical printers. Changing this requires a restart of the application server. The Default value is OUT1. |
Scheduling Optimization Queue ID | Scheduling Optimization | Batch Queue ID for Scheduling Optimization. |
Input Data Compression | Scheduling Optimization | Controls whether the input data to Scheduling Optimization is being submitted in compressed format or not. In addition to setting the parameter to "ON" or "OFF" it's possible to define a threshold value in bytes for when data compression will be applied using the format "ON=<bytes>", e.g. the setting "ON=1000000" will apply compression for input data above 1.000.000 bytes (1 MB). The default value is "ON=1000000" which means compression is applied when submitting the input data if it is exceeding 1.000.000 bytes (1 MB). |
Control Parameters | Scheduling Optimization | Special control parameters for Scheduling Optimization. The following parameters can be defined using the format "PARAMETER=value", separated with ";" if having multiple parameters set: PARALLEL_BATCH_QUEUES - Defines the number of additional batch queues to be used for processing Scheduling Optimization Datasets in parallel. DATASET_LOCK_TIMEOUT - Defines the time in seconds that scheduled updates and manual updates will wait for an ongoing update to complete before timing out. Supported values are: 0, 1, 2, 5, 10, 30, 60, 120, 300 and 600. Default timeout interval is 30 seconds. BG_PROGRESS_INFO - Controls whether Progress Info is output on the background jobs for Scheduling Optimization or not. The progress info can be turned off by setting the control parameter to FALSE. By default the progress info is turned on, but will only be written if the Log Level is set to Info, Trace or Debug in Scheduling Optimization Configuration. |
Ignore security info for application owner | Security | Values are ON/OFF/SHIFT and indicate whether fetching of security information may be skipped when running the application as application owner. Ignoring the security information will lead to a faster login. Option SHIFT gives the possibility to control this setting at runtime by pressing shift during login. Default value is SHIFT. |
Cleanup age limit in days for Security Checkpoint Log | Security | The age of Security Checkpoint Log records to be removed by cleanup processes. Default value is 7 days. |
Security checkpoint framework available | Security | This parameter determines whether Security Checkpoint framework is used. Values are ON/OFF, default value is OFF. ON means that Security Checkpoint Gates in the server code should be checked. OFF means that no Security Checkpoint check is performed. |
Security Checkpoint username timeout | Security | Security Checkpoint username timeout. Default value is -1 |
Time a session is allowed to be idle before it expires | Security | Time a session is allowed to be idle before it expires. Default value is 7200 |
Max time before a session is expired | Security | Max time before a session is expired. Default value is 36000 |
Number of days to keep streams messages before removal | Streams | This parameter controls the number of days streams messages should be kept. Any messages older than this value will be removed by the cleanup process |
Default file encoding for files read/written by Oracle | System Settings | This parameter controls which default character set a file will be written by Oracle Database server using UTL_FILE is using if Database_SYS package functionality. Default value is Oracle Database Character Set. Valid values are any Oracle Character Set. |
Location to store BLOB data | System Settings | Values are EXT/INT/ASK and controls where the BLOB data should be saved or if the user should be asked for each save. Default value is ASK. |
HTTP transfer timeout for outbound calls (seconds) | System Settings | HTTP transfer timeout for outbound calls (seconds). Default is 1200. |
Microsoft Bing Map license key for Virtual Map | System Settings | Microsoft Bing Map license key for Virtual Map |
Delete Object Connections When Parent Objects are Deleted | System Settings | If set as 'ON', the connections between the parent and attachments will be deleted when deleting parent objects. For example, if a business object which has attached documents is deleted, the connections between the business object and attached documents will be deleted, not attached documents. Default value is 'OFF'. |
Remote Debugging allowed, should be OFF for production installations | System Settings | This parameter controls whether it is allowed to do Remote Debugging or not in this installation. The values is ON/OFF, default is OFF. It is recommended to set this parameter to OFF for production installations. |
SQL Trace allowed | System Settings | Should be OFF for production installations |
Profiling allowed | System Settings | Should be OFF for production installations |
System Settings Profiling directory, where the profiler writes its files | System Settings | Not used |
Name of the Application Owner | System Settings | Default Application Owner is IFSAPP |
Name of the field that uniquely identifies an object in GIS Map | System Settings | This parameter identifies the field name on GIS Objects in ArcGIS and where IFS business object ID is stored. Default value for the field name is IFSID. |
Map provider for map control | System Settings | Enable HERE Maps in IFS Cloud Web *: Here Maps are disabled. HERE_MAPS: Here Maps are enabled. HHERE_MAPS_JAPAN**: Here Maps Japan is enabled. |
Customer Id to connect RCM Toolkit | System Settings | Customer Id to connect RCM Toolkit. Only available when RCM Integration is installed |
Web service Token to connect RCM Toolkit | System Settings | Web service Token to connect RCM Toolkit. Only available when RCM Integration is installed |
In-Memory compression level | System Settings | The level of compression to use when tables are loaded to the In-Memory storage. For further information see here |
Translation Environment Mode | System Settings | This is for R&D Internal use only. Values are SUPP/DEV and controls the translation admin functionalities in the Text Translations window. Default value is DEV. |
System Url | System Settings | System Url is the main entry url for the system. This parameter will be updated by the installer. |
Secondary System Url | System Settings | Secondary Url (external proxy URL) Used if there is an external proxy fronting the system - typically for exposing the system on two diferent domains at the same time - internally and externaly for e.g. mobile clients. This parameter will be updated by the installer. |
Download Url | System Settings | Download Url is used by e.g. click once applications that need to know the url of the addon-page (as referenced on the landing page). This parameter will be updated by the installer. |
Feature update | System Settings | Will show current Feature update version. This parameter will be updated by the installer. |
Service update | System Settings | Will show current Service update version. This parameter will be updated by the installer. |
Comma separated list of disabled features | System Settings | Specify the disabled features, specify empty if everything needs to be turned on. Possible values: EMPTY, POWERBI_LOBBY_ELEMENT, POWERBI_REPORT_GENERATOR_LOBBY_ELEMENT, PROCESSVISUAL_LOBBY_ELEMENT, SAS_TOKEN_PAGE |
Allowed File Extensions except which are specified in DOCMAN and Media Extension | System Settings | Specify which file type are allowed to upload/download. (extension should not include '.') Default Values are: ACH,BIM,BPMN,CER,CERT,CLASS,CRT,CSV,DAT,EXP,GIF,GZ,IAL,INS,JAR,JAR,JAVA,JPEG,JPG,JSON,KEY,LNG,LOG,OLD,OTF,P12,PDF,PEM,PFX,PNG,RDL,RPL,SQL,TMSL,TRS,TTC,TTF,TXT,WOFF,WOFF2,XLSM,XLSX,XML,XSD,XSL,XSL,ZIP |
Excel Extension Mode | System Settings | This parameter can be set to change the behavior of the Excel Export Extension. For further information see here |
Use local cache when assembling metadata with dynamic content | System Settings | Metadata that contain dynamic content can use a local cache to improve the performance. The dynamic content will then be resolved only once and later re-used on behalf of consuming more memory while the projection and/or page metadata is being assembled. |
Behavior Analytics On | System Settings | Enables IFS to collect anonymous user behavior data for product enhancement purposes. The data remains secure and private. This feature is disabled by default. |
Behavior Analytics Key | System Settings | A unique identifier that links the user behavior analytics data to the correct entity. IFS's ID by default. |
Behavior Analytics A ID | System Settings | A unique Identifier for IFS Cloud’s assets supplied to IFS’s Digital Experience Intelligence. IFS's SHA ID by default. |
Base address for HTML help | User Assistance | Base URL for the top-tree of the application end-user documentation when HTML is used as on-line document format. Default value is "DEFAULT" meaning that the Documentation container will be used. |
IFS Portal | User Assistance | IFS Portal. Default value is http://www.ifsworld.com/corp/login/ |
IFS online | User Assistance | URL for on-line helpdesk on Internet (towards vendor) or intranet (at customer side). Default value is http://www.ifsworld.com and should be changed to enable usage of IFS Support. |
Default server language setup | User Settings | Controls the default language used in the server environment, when the client running the application defines no language. This parameter is to be used for translation test purposes. Default value is ‘en’ (English). |
Define the characters which should not appear in Key Fields | User Settings | This parameter can be set with characters which should not appear in the key fields. The key fields where the relevant business logic is implemented will not accept these characters and will return an error message. Moreover character ^ is the text separator in IFS so it will be validated internally and it is not required to be included.If multiple characters need to be restricted they should be enclosed within a pair of parentheses [ i.e - (XXX) ], in the default character set two periods '..' are restricted using this syntax. The Default character set is (..)&%_<>=;~” Use the special markers LF and CR to include Carriage Return and Line Feed respectively. Note: If ‘(‘ and ‘)’ are to be used as restricted characters, they have to be included as ‘((‘ and ‘))’ respectively. |
Time a popup message is displayed before disappearing | User Settings | Default value is 1. Optional values: • 0 : Keep the toasts on screen before manually closing). No time out. • Any number representing the number of seconds to keep a toast on the screen. Configure desired custom value for timeout messages. |
Time an error popup message is displayed before disappearing | User Settings | Default value is 1. Optional values: • 0 : Keep the toasts on screen before manually closing). No time out. • Any number representing the number of seconds to keep a toast on the screen. Configure desired custom value for timeout messages. |
Password for new users | User Creation Settings | This parameter set the global value on how to set password for new users. Available options - Ask ( Default), Email, Username and Custom. |
Multiple login for users synchronized through SCIM | User Creation Settings | Multiple login for users synchronized through SCIM. ON - Users will be able to login using an external IDP and internal IAM. OFF - Only external IDP Authentication is available for users synchronized through SCIM. |
Mobile App Queue | IFS Cloud Mobile | Batch Queue ID for Mobile Batch Data Synchronization and Scheduled Activation |
Mobile App Sync Warning Treshold (Seconds) | IFS Cloud Mobile | Threshold time for a single entity to be synchronized before a warning is written to the Mobile Logs. |
Truncate Excel Data | System Settings | When enabled truncates the cell data in the Export Excel functionality if it is more than 32767 characters. |
Extended Method Traces | System Settings | When enabled, adds invoked PLSQL method stack details to the debug response for requests with debugging enabled. NOTE: Enabling this can lead to a performance hit due to the additional methods invoked. Hence, it is recommended to keep this disabled when not actively used. |
Odata Provider Projection Cache Refresh Interval (Seconds) | System Settings | The value of this parameter defines the interval at which the projection cache needs to be checked and, in case it is outdated, refreshed. The default interval is 10 seconds. |
Odata Provider Site Cache Refresh Interval (Seconds) | System Settings | The value of this parameter defines the interval at which the site timezone cache needs to be checked and, in case it is outdated, refreshed. The default interval is 600 seconds (10 minutes). |