ON THIS PAGE:
These are the default settings in the configuration file: C:\Program Files\P2 Energy Solutions\P2 Explorer\Configuration\ServerConfig.xml
Note: If any of the default settings are modified, you will need to:
- Restart the services in the Services tab of the Configuration tool.
- Recycle P2 Explorer REST API App Pool and P2 Explorer Web Management UI App Pool.
- Re-build the ElasticServer index.
If the setting does not take effect on the client side, clearing the browser cache should resolve the problem.
Global group
Locate these settings under the <ConfigGroup Name="Global"> node. These settings apply to all of the IFS OI Server components.
| Debug | When set to True, the service will throw any error that occurred in the service back to the UI, instead of displaying the standard error message “The server was unable to process the request due to an internal error”. Default: false |
| ServerHost | The hostname of the IFS OI Server machine. Note that this may need to be the fully qualified machine name in order for the SSL certificate to validate correctly in a browser. Default: localhost. |
| WebPort | The port that the SSL Web Site is bound to. Default: 443 |
| ServicePort | Defines the port that the backend services are exposed on. This must be different to the port that the SSL Web Site is bound to and must also have a SSL certificate bound to it. If there is no SSL Certificate bound, the services will fail to start correctly. Default: 8080 |
| MessagePort | Defines the port that message transport services are exposed on. This must be a different value to that configured for ServicePort or WebPort. Default: 8883 |
| MessagePortCertificateThumbprint | Defines the SSL certificate thumbprint to use with the message transport service. This value is normally updated via the Configuration Utility when applying web settings and should typically not be modified by a user. |
| ServiceRootAlias | The path on the IFS OI Explorer machine that specifies where to host the services. Default: P2.Server |
| HelpCenterUrl | The root address for links to articles on the IFS OI Help Center. Default: https://e4helpcenter.petroleumplace.com/help/p2-explorer/ |
| IgnoreMessageTransportCertificateRevocation | If set to True, security checks are weakened for Message Transport clients running internally: they will ignore any errors raised when checking for revocation of the transport server certificate. This value should only be set to True in scenarios where a required OCSP server will always be unreachable, such as for a certificate from a public CA used on a host with no internet access. |
Database group
Locate these settings under the <ConfigGroup Name="Database"> node. These settings apply to the IFS OI Server database.
| ConnectionString | The connection string that IFS OI Server uses to connect to the database. This value is initially defined in the Configuration Utility during the installation process. Do not change this setting. The password is captured from the Configuration Utility and is encrypted. To change the password, use the IFS OI Server Configuration Utility. |
| CaseInsensitiveCollation | Collation of case-insensitive columns in the database. If the collation of columns in the database is updated, this setting must be changed as well. Default: Latin1_General_CI_AS |
| CaseSensitiveCollation | Collation of case-sensitive columns in the database. If the collation of columns in the database is updated, this setting must be changed as well. Default: Latin1_General_100_CS_AS_WS_SC |
DataBroker group
Locate these settings under the <ConfigGroup Name="DataBroker"> node. These settings apply to the Data Broker component.
| EnableDefaultPageSize | When set to true, requesting a dataset that supports paging will result in the default paging being applied, if the paging parameters are not provided on the request. Default: true |
| DefaultPageSize | The number of rows to display on a single page when using pagination. Default: 100 |
| AdaptorInactivityTimeout | The timeout, in seconds, for the Adaptor in the adaptor pool. Specifies the period of inactivity after which IFS OI Server will unload the Adaptor. Default: 1800 |
| InitFailureLockTimeout | After an Adaptor initialisation failure, this specifies the amount of time (in seconds) for IFS OI Server to deny further initialisation requests to the Adaptor. Default: 5 |
| MinimumSampleIntervalInSeconds | The lowest sample interval, in seconds, that will be permitted in calculations. Default: 1 |
| ShiftHrs | The length of time, in hours, for the duration of each shift. Options: 6, 8 or 12. Default: 8 |
| FirstDayOfWeek | What the system considers to be the first day of the production week. This must be a number between 0 and 6. 0 means Sunday, 1 means Monday, 2 means Tuesday… and 6 means Saturday. Default: 0 |
| StartOfDayOffsetMins | The default start time of the day is at 12 midnight. This can be changed by adding the number of minutes to this time that you would like the day to commence. The system will then see this time as the start of the day. E.g. 30 would mean a 30 minute offset. 150 would mean a 2.5 hour offset. Default: 0 |
| CalendarTimeZone | The time zone that calendar-based calculation functions (e.g. CalendarDayStart()) will use. This must be a TZDB time zone identifier (e.g. Australia/Perth) or a fixed offset (e.g. UTC+08:00). Default: UTC |
| ProductionTimeZone | The time zone that production-based calculation functions (e.g. ProductionDayStart()) will use. This must be a TZDB time zone identifier (e.g. Australia/Perth) or a fixed offset (e.g. UTC+08:00). Default: UTC |
| CalculationConfidenceCutoffBehavior | Determines how data values with a confidence less than or equal to the configured threshold are treated when performing calculations. Options: Disabled, ReplaceWithLastKnownValue, ReplaceWithDatumError. Default: ReplaceWithLastKnownValue |
| CalculationConfidenceCutoffThreshold | A value is regarded as bad if it is less than or equal to this confidence value. This must be an integer number between 0 and 100. Default: 80 |
| MaxDataPointsFetchedPerTag | The maximum number of data points that can be retrieved per tag in a single adaptor request. For sampled fetches, the actual number of data points a fetch will return can be calculated in advance. For raw fetches, the value will be estimated using data intervals or scan rates from the tag, datasource, and system (in that order). Fetches which exceed this limit for a single tag will be declined with an error in IFS OI Explorer (The fetch request was declined…). Default: 15000 |
| MinimumCalculationEngineCount | The number of calculation engine instances that will be created at all times regardless of other settings. If the value is set to 0 then the system will automatically set this to 4 * CPU core count. This setting was added in Explorer v 4.9.4. Default value: 0 |
| MaximumCalculationEngineCount | The maximum number of calculation engine instances that can be created. If the value is set to 0 then the system will automatically set this to 8 * CPU core count. This setting was added in Explorer v 4.9.4. Default value: 0 |
| MemoryLoadPercentThreshold | When the percentage of available physical memory in use reaches this threshold, the system stops creating new instances of the calculation engine. The minimum number of calculation engine instances will be created and used to keep the system responsive even if this threshold is reached. This setting was added in Explorer v 4.9.4. Default value: 80 |
| MaxPercentOfAdaptorsUsedForAdaptiveRawRequests (previously MaxPercentOfAdaptorsUsedForLowPriorityRequests) | This setting controls the maximum number of raw requests that will be sent to a datasource in parallel while processing adaptive raw requests. The maximum number of parallel requests is calculated as the configured percent of the maximum adaptor pool size of the target datasource (minimum: 1). This setting applies to all datasources and was added in Explorer v4.9.4. Default value: 50 |
| MaxRawDataPointsFetchedPerTagForAdaptiveRawRequests | The maximum number of raw data points that can be requested for resolving adaptive raw requests. The number of retrieved raw values will be estimated using data intervals/scan rates from the tag, datasource and system (in that order). This setting was added in Explorer v 4.9.4. |
| MaximumExpressionProcessedInParallelCount | Limits the number of expressions that the calculation engine (SER)/Data Broker can process in parallel. This limit is applied across all expression batches. This setting was added in Explorer v4.11.1. Default value: 0 (no limit is applied) |
DataCache Group
Locate these settings under the <ConfigGroup Name="DataCache"> node. These settings apply to the Data Cache component, which was introduced in v4.9.1.
| DataCacheDirectory | The path on disk the data ingestor should persist data batches. Default: "%programdata%P2 Energy SolutionsDataCache" |
| DataIngestorMetricsDatasourceName | The name of the Datasource which is used to write data cache metrics data to. |
| DataCacheMaxDataPointsToWrite | Maximum batch size of data points to write to data cache. NOTE: setting too high a value may cause writes to be ignored. Default: 15000 |
| DataCacheMaxParallelWrites | Maximum Data Cache Parallel writes Default: 16 |
| DataCacheWriteTimeout | Timeout (secs) for waiting until a Data Cache write is completed. Default: 60 |
| DataCacheWritePrecision | Timestamp precision for datums written to a Data Cache. Options are: Seconds, Milliseconds. Default: Seconds |
| DataIngestorTransferThrottleMBperMinute | Maximum compressed MB per minute of data to write to the Data Cache. Default: 30 |
| DataIngestorHistoryFetchDays | Number of days in the past to start caching historical data. Changing this setting without service restarts will cause Scan groups to restart history fetching if history recovery is enabled. Default: 30. |
| DataIngestorRecentFetchDays | Number of days in the past to start caching recent data. Default: 1 |
| DataIngestorDelayOffset | Delay offset (in seconds) for reading data for ingestion. Setting to -1 will use the Scan group period as the offset. Default: -1 |
| DataIngestorDataItemsPerRequest | Maximum number of datums to return in ingestion batch read. NOTE: Increasing this value may impact performance and/or cause timeouts. Default: 50000 |
| DataIngestorMaxEntitiesPerRequest | Maximum number of entities to return in ingestion batch read. NOTE: Increasing this value may impact performance and/or cause timeouts. Default: 200 |
| DataIngestorDisable | Disable the Data Ingestion. Default: false |
Security group
Locate these settings under the <ConfigGroup Name="Security"> node. These settings specify the OI and custom modules that can access the Security function in IFS OI Explorer.
| SecurityAdditionalAllowedModuleHosts | List of additional host names (fully qualified domain name) where IFS OI Operational Intelligence (OI) modules reside. This is populated by the IFS OI Explorer Configuration utility. |
| SecurityAllowedModulePaths | List of IFS OI OI module paths for Security Authentication. Default: APlus, P2.Server.Management, P2.Server, P2.Explorer, Sentinel, Shift Log |
| SecurityAllowedCustomUrls | A list of custom application or module URLs for Security Authentication. Default: (blank) |
| SecurityGenerateSecureCookies | Indicates whether Security should generate secure cookies. When set to true, this means that the IFS OI Explorer website must run using the HTTPS protocol. This flag should only be set to false where there is a module deployed under the HTTP protocol which depends on IFS OI Explorer’s Security module for authentication i.e. when IFS OI Explorer needs to run using HTTP. Default: true (Recommended value for optimal security). |
| SecurityAutoLoginIdentityProvider | Indicates whether Security should automatically login with the configured identity provider. Values are: none, Azure, Windows. Default: Windows |
| SecurityDnsHostAlias | The DNS host name of the IFS OI Server machine. This value should only be set if IFS OI Explorer is running the HTTP protocol via a DNS alias. This key allows our communications API (Data Dictionary and Data Broker) to route cross-domain calls with the correct DNS hostname, instead of the actual server name. This setting was added in Explorer v4.9.2. |
| SecurityTokenExpiry | Allows the security token expiry time to be configured to anywhere between 1 hour and 3 days. The value is expressed in minutes. Recycle all application pools after updating this setting. |
Security.Azure group
Locate these settings under the <ConfigGroup Name="Security.Azure"> node. This group contains the security settings required for integration of IFS OI Explorer Authentication via Azure Active Directory.
| DirectoryId | The Azure Directory (Tenant) Id to connect for authentication. |
| AppClientId | The registered IFS OI Explorer Application Client Id. |
| AppAllowedDelegateDirectoryId | If the registered application allows any organizational directory, this is the allowed Azure directory Id to connect for delegated authentication. |
| AutoProvisionUser | Indicates whether an identity authenticating via Azure AD will have an associated Explorer user created if one does not already exist. Default is True. |
Security.Windows group
Locate these settings under the <ConfigGroup Name="Security.Windows"> node. This group contains the security settings required for a Windows Domain sign in to IFS OI Explorer.
| UserDisplayNameFormat | Indicates the user display name format to use during auto provisioning Windows user and AD Sync operation. Options are: CommonName, RawDisplayName, FirstLastName, LastFirstName. Default: CommonName. Note: Prior to v4.11.0 this was known as SecurityUserDisplayNameFormat. |
| AutoProvisionUser | Indicates whether an identity authenticating via IIS Windows Authentication will have an associated Explorer user created if one does not already exist. Default is True. |
API group
Locate these settings under the <ConfigGroup Name="API"> node. These settings apply to APIs.
| MaxFileUploadSizeMB | The maximum size, in megabytes, of files which can be uploaded to IFS OI Explorer. Default: 5 |
| ShiftChangeWarningRangeMinutes | The duration before and after a shift change during which a user should be asked to select a shift. Default: 30 |
Python Adaptor group
Locate these settings under the <ConfigGroup Name="Python Adaptor"> node. These settings apply if the Python Adaptor has been enabled.
| PythonDllAbsolutePath | The file path where the Python DLL is located. E.g. C:\Program Files\Python\ Python311\python311.dll |
| PythonAdaptorEnabled | True or False. Whether the Python Adaptor is enabled. Default: False. |
| PythonAdaptorMinPoolSize | Smallest number of Python adaptor instances that will always be available to execute Python scripts. Default: 2 |
| PythonAdaptorMaxPoolSize | Largest number of Python scripts that the system will attempt to execute simultaneously. Default: 8 |
| PythonAdaptorInitTimeout | Time limit (in seconds) allowed for the Python adapor to initially set up and configure the Python engine before timing out. Default 60 |
| PythonAdaptorRequestTimeout | Time limit (in seconds) applied to all non-initialisation operations against the Python adaptor. Default: 600 |
| PythonAdaptorDisabledFunctions | Comma-separated list of Python functions which are not allowed to be executed in Python scripts. |
| PythonAdaptorEnabledModules | Comma-separated list of Python modules (e.g. pandas) which will be pre-loaded by the Python adaptor for executing Python scripts. |
R Adaptor group
Locate these settings under the <ConfigGroup Name="R Adaptor"> node. These settings apply if the R Adaptor has been enabled.
| RHome | Main folder of the R installation. E.g.: C:\Program Files\Microsoft\R Open\R-4.0.2 |
| RRelativePath | Relative path of the R engine within the RHome folder. E.g.: bin\x64 |
| RAdaptorEnabled | Indicates whether the R adaptor and thus executing R scripts is enabled. Default: false |
| RAdaptorMinPoolSize | The smallest number of R adaptor instances that will always be available to execute R scripts. Default: 2 |
| RAdaptorMaxPoolSize | Largest number of R scripts that the system will attempt to execute simultaneously. Default: 8 |
| RAdaptorInitTimeout | Time limit (in seconds) allowed for the R adaptor to initially set up and configure the R engine before timing out. Default: 60 |
| RAdaptorRequestTimeout | Time limit (in seconds) applied to all non-initialisation operations against the R adaptor. Default: 600 |
| RAdaptorDisabledFunctions | Comma-separated list of R functions which are not allowed to be executed in R scripts. |
| RAdaptorEnabledPackages | Comma-separated list of R packages which will be pre-loaded by the R adaptor for executing R scripts. |
Web group
Locate these settings under the <ConfigGroup Name="Web"> node. These settings enable web features that are off by default. Add each feature as a <value>Feature</value> pair.
| Analytics | Controls whether or not the Auditing feature is enabled. Default: Enabled |
| Mentions | Allows users to use # and @ in commentary and other fields, to mention entities and people respectively. Default: Enabled |
| RibbonCsvExport | Allows Explorer pages to be exported from the Admin ribbon tab. Disabling this setting will hide the relevant buttons in the Explorer ribbon. Default: Enabled |
CaseManagement group
Locate these settings under the <ConfigGroup Name="CaseManagement"> node. These settings apply to the Case Management feature.
| PriorityCalculatorTime | The daily time, in UTC format, at which the priority calculation function should run. This automatically calculates the priority of all cases in the system according to the rules specified in the AutoCaseCalculations.xslx spreadsheet. |
RulesEngine group
Locate these settings under the <ConfigGroup Name="RulesEngine"> node. These settings apply to the email server for the Rules Engine.
| EntryAdminUser | The username used for Entry creation or modification in the Rules Engine. Default value: admin |
| MailServerAddress | The address of the email server. No default value. |
| MailServerUsername | The username used to connect to the email server. No default value. |
| MailServerPassword | The password used to connect to the email server. No default value. Do not change this setting. The password is captured from the Configuration Utility and is encrypted. To change the password, use the IFS OI Explorer Configuration Utility. |
| MailServerEnableSSL | Set to True if the email server connection required SSL. Default: false |
| MailServerEmailFromAddress | The ‘from' email address to attach to emails. No default value. |
| MailServerEmailFromAddressDisplayName | The 'from' email address display name to attach to emails. Default: P2ExplorerNotification |
License Group
Locate these settings under the <ConfigGroup Name="License"> node. These settings apply to License Audit page.
| LicenseData | The license data required for the License Audit Report in Explorer. |
Data Layer Group
Locate these settings under the <ConfigGroup Name="Data Layer"> node. These settings apply to Security page.
| TagGroupSecurityEnabled | If set to true, tags will be secured based on Tag Groups. Tags would not be able to be individually secured. Default: False. |