System Configuration

<EnterpriseName>~<ModelLevelType>~<ActionName> or
<EnterpriseName>~<ModelLevelType> or
<ModelLevelType>~<ActionName> or <ModelLevelType>

Action will be processed asynchronously if the number of records is equal to or greater than the provided local value

Example - ActionListAsyncThreshold,SampleEnterprise~ZBKS.Book~ZBKS.Publish,2

<EnterpriseName>~<ModelLevelType>~<ActionName> or
<EnterpriseName>~<ModelLevelType> or <ModelLevelType>~<ActionName> or <ModelLevelType>

Fully-qualified class name implementing com.onenetwork.platform.data.model.ActionListAsyncThresholdComputation

Action will be processed asynchronously if ActionListAsyncThresholdComputation returns true. This takes priority over ActionListAsyncThreshold

Example - ActionListAsyncThreshold,SampleEnterprise~ZBKS.Book~ZBKS.Publish,2

AddressValidation.apiKey

<validator name>:::<validator group>

<Token>

There are currently two service providers available for address validation:

• goshippo
• lob

Example: 

• AddressValidation.apiKey,Lob:::testing,2763c79b5a590fa645fb94b71ad5d5f5d4cad971
• AddressValidation.apiKey,Shippo:::testing,shippo_test_2763c79b5a590fa645fb94b71ad5d5f5d4cad971po_test_2763c79b5a590fa645fb94b71ad5d5f5d4cad971

Alerts

EnableEmailHyperlinkForAllModels

boolean

Enable or disable the inclusion of a deep link to a related transaction in the email or mobile alert.

This flag will apply to all alerts in the respective Value Chain.

AntiVirus

VectorScanException

PollFile

PollSFTP

PollAWSS3

PollAZURE

HttpUpload

InternallyGenerated

When present, these cause the automatic anti-virus scan to be skipped for the given use case. For example, PollSFTP would cause no files received via SFTP to be scanned.

AntiVirus

FilenameRegexScanException

<regular expression>

When present, any file whose name matches the regular expression will not be scanned.

AsyncAction.MaxAttempts

<EnterpriseName>~<ModelLevelType>~<ActionName> or <EnterpriseName>~<ModelLevelType> or <ModelLevelType>~<ActionName> or <ModelLevelType> or Global

Number - desired number of attempts

Defines the maximum number of attempts to process an AsyncAction. The default is 2

Example - AsyncAction.MaxAttempts,SampleEnterprise~ZBKS.Book~ZBKS.Publish,2

AsyncAction.MaxRetryDelay

<EnterpriseName>~<ModelLevelType>~<ActionName> or <EnterpriseName>~<ModelLevelType> or <ModelLevelType>~<ActionName> or <ModelLevelType> or Global

Number - max retry delay in millis

The time to wait after receiving a retry return code before retrying this task. The default is 60000 ms.

Example - AsyncAction.MaxRetryDelay,SampleEnterprise~ZBKS.Book~ZBKS.Publish,1000

AsyncAction.MaxRuntime

<EnterpriseName>~<ModelLevelType>~<ActionName> or <EnterpriseName>~<ModelLevelType> or <ModelLevelType>~<ActionName> or <ModelLevelType> or Global

Number - max runtime in millis

The maximum amount of time allowed for processing a single attempt. The default is 1 hour.

Example - AsyncAction.MaxRuntime,SampleEnterprise~ZBKS.Book~ZBKS.Publish,36000

Audit

ValueChainID~ModelType

boolean

Enable or disable the audit for the provided value chain id and model type combination.

Example -

EXTERNAL_VALUE: 8001~Shipment

LOCAL_VALUE: true/false

AuthenticationControl

DisableBatchPasswordAuth

Boolean

Controls the batch authentication at the platform level and is to be used when PKI is enabled for SSO.

BucketTransform

DefaultBucketTransform

Transform function name

This default transform function will be used if the BucketTranform function is not provided in the TLV definition or override.

The following standard transform functions are available in the Platform:

first, last, fairShare, fairShareRoundedFavorFirst, fairShareRoundedFavorLast, byDuration, byDurationRoundedFavorFirst, byDurationRoundedFavorLast.

You can create your own transform function by implementing 'com.onenetwork.platform.data.tlv.BucketTransformer'

CdnWebFonts

Disabled

Boolean

Set this value to "true" to prevent the download of fontawesome and OpenSans webfonts from CDNs (Google, Cloudflare).

ClickThroughSplash

Enabled

boolean

When true, shows a "click-through splash screen" on each login, which the user must "Accept" to use the application. Leverages the following messages.properties values to determine the content shown in the splash screen. These can contain HTML tags.

ClickThroughSplash.agreement.title=For Official Use Only

ClickThroughSplash.agreement.message=By Accepting, you agree to follow the terms of use for this system.

ClickThroughSplash.agreement.lastLogin=<p>Last logged in <b>{0}</b> from IP address {1}.</p>

ConcatenatedEDIInboundProcessor.EnqueueSingleChunk

<full-qualified queue name>

ConcatenatedEDIInboundProcessor.HeaderBasedEnqueue

Header IDs given as Input

String QueueName

Fully Qualified Queue Name to be Specified

Example -

LOCAL_VALUE: VC ID~QueueName : For a VC Level Queue

LOCAL_VALUE: VC ID~EntName~QueueName : For a Enterprise Level Queue

ConsolidateCsvUploadValidationErrors

<InboundInterfaceName>~<InboundInterfaceVersion>

true or false

When true, all validation errors will be returned as ";" separated instead of a single validation error (this is the default behavior)

Example - ConsolidateCsvUploadValidationErrors,ZBKS.BookUpload~1.0,true

ConsolidatedValidationErrorsFormatter

<InboundInterfaceName>~<InboundInterfaceVersion>

name of formatter class

When ConsolidateCsvUploadValidationErrors is set to true, all consolidated validation errors will be passed to given class provided with fully qualified class name for apply custom formatting to errors

Example - ConsolidatedValidationErrorsFormatter,ZBKS.BookUpload~1.0,com.onenetwork.ZBKS.ConsolidatedValidationErrorsFormatter

Content-Security-Policy

HeaderValue

<Desired Content-Security Policy value>

By default, Content-Security-Policy headers are not set. You can configure this external reference to set it. Sample value: default-src 'self' 'unsafe-inline' 'unsafe-eval' data: *

CORSFilter

Enabled

Boolean (True\False)

By default, CORS pre-flight requests are not handled. By setting this to true, it will allow the system to process CORS pre-flight requests for cross-domain POSTs.

CORSFilter

WhitelistDomainPattern

String (regex)

Only origin domains matching these patterns will be allowed to make CORS requests. Example: .*\\.onenetwork\\.com$

CSRFPreventionFilter

Enabled

Boolean

If true, restricts allowable "referer" header values for incoming HTTP requests to help prevent CSRF. By default, only the instance's own host is allowed as a referer.

CSRFPreventionFilter

RequireCSRFRequestToken

Boolean

If true, requires a CSRF request token on every incoming POST, PUT or DELETE HTTP request. (When true, the Platform will auto-generate CSRF tokens from the UI so that this check will not fail, and only malicious CSRF attacks will fail.)

CurrencyCodeForUI

Enterprise Name

Currency code (e.g. GBP)

By default, the application puts USD at the top of the lengthy Currency Code combobox.  You can set this value to override that and bring another currency code to the top

CSRFPreventionFilter

WhitelistedHostPatterns

String (regex)

You may have multiple Ext Ref rows with this ref type / external value combination. Each is a regex that will be matched against referer hosts. Any path matching will NOT be subject to the CSRFPreventionFilter. Example: .*\.gov would allow all .gov sites as valid referrers.

DelimiterTransform:Field

QueueName~Interface~Version

Desired Custom Delimiter for Fields

When specified, used to write the payload with a custom delimiter instead of the delimiter specified on the interface for outbound messages and for inbound messages, to convert the payload with a custom delimiter to the one specified on the interface

DEMO_SETTINGS

DemoMode

boolean

Set to true to enable demo-only (non-production-supported) features

DisableProblemGeneration

OrganizationName (e.g., SampleOrg) for which Problem generation needs to be disabled

ProblemTypeName

We can have comma-separated ProblemTypeName(s) or separate ExternalReference entries for each ProblemTypeName.

If exists, Problems will not be generated for Organization and ProblemType combination.

DistanceServerGoogleConnect

String - API Key

APIKey

The valid API key is provided by Google to connect to Google Distance Matrix API.

DocumentTypePermissionHandler

modeltype~category~doctypename

fully-qualified class name

An entry to register an interface for implementing custom permission on DocumentTypes.

Example -

EXTERNAL_VALUE: Shipment~Attachments~Bill Of Lading

LOCAL_VALUE: com.onenetwork.mybooks.DocumentTypePermissionHandler

DynamicEnumeration

ActingVCAdminRoleType

role type name

When present, allows the given role type to edit dynamic enumerations as if they were a VC Admin, i.e., add/remove directly to the vc-level entries rather than adding enterprise-level overrides.

EdiConfig:PartnerTypeToMaster

EdiConfig:PartnerTypeToMaster

Partner TypeName

Email

AllowedSuffixes

Comma-delimited list of suffixes. For example: .mil,.gov

If present, outbound mail will be sent ONLY for emails matching the given suffixes. Additionally, certain parts of the application (for example, Users and Issue Subscriptions) will disallow the writing of records that do not match the given suffixes.

FileUploadExtension

Whitelist

String-ExtensionList

Comma-delimited list of file extensions. UI Users will be permitted to upload files only with these extensions.

FormulaInjectionPrevention

Enabled

Boolean

Set this value to "true" to provide additional escaping of values starting with = + - @ to avoid possible "formula injections" into spreadsheets.

CSRFPreventionFilter

RequireCSRFRequestToken

Boolean

If true, requires a CSRF request token on every incoming POST, PUT or DELETE HTTP request. (When true, the Platform will auto-generate CSRF tokens from the UI so that this check will not fail, and only malicious CSRF attacks will fail.)

GeoGraphApiKey

String - API Key

Instance

Instance level valid API key provided by Google for the Google Maps JavaScript API.

GraphHopperAPI

X-RateLimit-Remaining.LogThreshold

long value

When present, sets the number of remaining allowable graphhopper API calls below which a WARN will be logged. When not present, the threshold is 1000.

IntegrationSubscriptionContextEntQueue

EnterpriseName

boolean

If set to true, this will add IntegrationSubscriptionTaskPerformer tasks using a "grid queue" formed from the user context's enterprise name. This ensures that for action-based subscriptions, they will be executed in the order the actions were executed for that user context, within that Enterprise.  It applies only to the context of the user executing the action, not the "governing enterprise" of the business transaction. 

IntegrationSubscriptionContextQueue

Enabled

boolean

If set to true, this will add IntegrationSubscriptionTaskPerformer tasks using a "grid queue" formed from the user context. This ensures that for action-based subscriptions, they will be executed in the order the actions were executed for that user context. 

IntegrationSubscriptionTaskPerformer

OneIdPerOutbound

boolean

if true, each sysId passed will be executed as a separate outbound

Interface.AutoTruncateStaging

<interface name>~<interface version>

boolean

When set to true for the given interface, it will automatically truncate the staging table for the given interface before the load of new records. This can ONLY be used with interfaces of type SQL Loader.

This should ONLY be used in scenarios where you KNOW the interface will never be executed twice concurrently. If concurrent usage is a legitimate usecase for you, you cannot use this property and should instead ensure your interface SQLs make proper use of the LOAD_ID field for disambiguation of incoming records.

Note - when Interface.AutoTruncateStaging is set to true, Interface.DisableStagingCleanup is ignored.

Interface.ChunkSize

<qualified queue name>~<interface name>~<interface version> or <interface name>~<interface version>

Number - chunk size

Chunk size used for processing this interface

Example - Interface.ChunkSize,9328~SampleEnterprise~inbox/Bookstore~ZBKS.BookLoad~1.0,20

Interface.DisableStagingCleanup

<interface name>~<interface version>

boolean

When set to true, then the staging table records for the current load will NOT be automatically deleted after each file finishes processing.

Note - when Interface.AutoTruncateStaging is set to true, Interface.DisableStagingCleanup is ignored.

Interface.MaxAttempts

<qualified queue name>~<interface name>~<interface version> or <interface name>~<interface version>

Number - desired number of attempts

Defines the maximum number of attempts to process a message for this interface. The default is 2

Example - Interface.MaxAttempts,9328~SampleEnterprise~inbox/Bookstore~ZBKS.BookLoad~1.0,2

Interface.MaxRetryDelay

<qualified queue name>~<interface name>~<interface version> or <interface name>~<interface version>

Number - max retry delay in millis

The time to wait after receiving a retry return code before retrying this task. The default is 100 ms

Example - Interface.MaxRetryDelay,9328~SampleEnterprise~inbox/Bookstore~ZBKS.BookLoad~1.0,1000

Interface.MaxRuntime

<qualified queue name>~<interface name>~<interface version> or <interface name>~<interface version>

Number - max runtime in millis

The maximum amount of time allowed for processing a single attempt. The default is 10 Min

Example - Interface.MaxRuntime,9328~SampleEnterprise~inbox/Bookstore~ZBKS.BookLoad~1.0,700000

JASPER_SERVER_URL

EnterpriseName or Stage, i.e. DEV, QA

URL

Entry with EnterpriseName will take precedence over Stage

JASPER_SERVER_AUTH_INFO

Stage, i.e., Dev, QA

OAuth

TokenExpiryInSeconds

integer

When provided, this is the number of seconds in which a newly granted OAuth token will last before expiry. The default is 3600 (1 hour).

OnBoard:Integ:PltInst

PROD_INST

Instance Name

OnBoard:Integ:PltInst

SPT_INST

Instance Name

ONE:Enable:CreateJIRA

CreateJIRA

ONE:OnboardingFlowDoc

PartnerOnboardingPath

Document Path

ONE:JIRA:IssueURL

JIRAURL

Instance Name

ONE:JIRA:OAuth:AccessToken

OAuthAccessToken

Access Token

ONE:JIRA:OAuth:PrivateKey

OauthPrivatekey

Private Key

ONE:JIRA:RestPath

JIRARestPath

Instance Name

ONE:RIO-APP

RIOTestNetwork

InstanceName

PlatformInstance Name

OpenExchange

ID

0e3f298adb2e4c07b81d4f6095c6a258

OpenExchange library to be used for currency conversion

OutboundMail

MaxDaysToKeepRelayedMail

No of days

Configuration to delete the outbound emails after N days.

OutboundSMS

MaxDaysToKeepRelayedSMS

No of days

Configuration to delete the outbound SMS after N days.

PartitionKeys

TableName

ColumnNames

PersonalizedIssueCompActivity

DisableFor

<ModelType> or <ModelType>~<ActionName>

When defined, PersonalizedIssueCompActivity task(s) won't be created in the system for the ModelType or ModelType~ActionName

Example - PersonalizedIssueCompActivity,DisableFor,ZBKS.Book

PKI_AUTHENTICATION

HIDE_UPLOAD_CERT_BUTTON

true/false

Whether to show the Upload Certificate button or not when PKI_AUTHENTICATION is enabled.

PKI_AUTHENTICATION

UploadCertificate

true/false

Whether the admin user can upload certificates or not.

PLT.Address

DisablePostalCodeValidation

true/false

If set to true, then postal code validation will be disabled for all countries. This applies to updates via UI as well as through system-to-system integration.

PLT.Address

DisablePostalCodeValidationForCountry

Country code

example: US

Disables postal code validation for a specific country. If postal code validation needs to be disabled for multiple countries, then this external reference entry should be added for each country.

PLT.Alerts

EnablePushOnNewAlert

true/false

If set to true, adds a new grid task which will be processed asynchronously and push the messages to the push server

PLT.Backchain

ContractAddress

0xc5d4b021858a17828532e484b915149af5e1b138

Base64-encoded contract address starting with "0x"

PLT.Backchain

DisputeContractAddress

0x4a6886a515a4b800f4591a6d6a60e6004a3645ab

Base64-encoded dispute contract address starting with "0x."

PLT.Backchain

MaxMerkleGenerationTime

Merkle tree generation time in milliseconds

PLT.Backchain

MaxMerkleLeaves

PLT.Backchain

PrivateKey

0x8ad0132f808d0830c533d7673cd689b7fde2d349ff0610e5c04ceb9d6efb4eb1

Base64-encoded private key starting with "0x"

PLT.Backchain

Url

https://backchain.com

Backchain server URL

PLT.Backchain

ValueChainId~ModelType

boolean

To determine if backchain is enabled or not for a model

PLT.ConcurrencyVersion

ModelLevel or ModelLevel~ActionName

Disable

If present, disable the concurrency versioning check. Concurrency versioning validation is to avoid business data inconsistency when multiple users can update the same model (e.g., Shipment) concurrently using UI, or same user can open multiple detail tabs for the same model and perform updates in one tab and can try to update the same model in the second tab without refreshing it from DB.

PLT.DBSession

MinBlockedSessionCount

Long value

If the number of blocked sessions by some root blocking session is greater or equal to this value, it will be killed by the Platform DB session monitor shortly. The default value is 2.

PLT.DBSession

BlockedSessionTimeout

Long value (timeout will be in minutes) 

If the blocking session takes more than this many minutes, it will be killed by the Platform DB session monitor shortly thereafter. The default value is 5 minutes.

PLT.DBSession

KillHistoryRetentionDays

Long value

The Platform DB session monitor retains logs of killed sessions for this number of days, and after that, it will be purged. The default value is 10 days.

PLT.DBSession

UIRequestQueryTimeoutInMinutes

Long value

If a query within a UI request takes more than this many minutes, it will be killed by the Platform DB session monitor shortly thereafter. The default value is 2 minutes.

PLT.DefaultOrEntTimezonePrefs

Enabled

boolean

By default TZ on create user screen will be selected based on browser locale but instance can provide the external reference to select the TZ based on the parent enterprise (or default server TZ if its not set for the enterprise).

PLT.DirectModelAccess

ChildIdFilterAlignTarget

integer (default is 1000)

Configures how many parameter slots will be generated when using ModelQueryExtension.whereChildren(cls, withSysIds(ids)) query component.

PLT.DirectModelAccess

MaxChildRowsChunkSize

integer (default is 300000)

Configures what is the maximum number of child rows that can be unloaded in each ReadChunk (see above). Replaces the previous default of 50K rows imposed by the In-Memory SQL Result API.

PLT.DirectModelAccess

ReadChunkSize

integer (default is 150)

Configures how many sysIds are included in each read chunk, as well as how many parents are in each request to unload children, internally

PLT.DisableCsvFormulaInjectionForUIExport

FullyQualifiedReportName~EntName

or

EntName

boolean

If set to true, disables the feature which adds leading tabs to values which might cause problems for Excel.

For example, a value of "0011234" will be shown as simply 11234 by Excel if this feature is disabled.  

PLT.DocTypePerm

StrictRoleTypeDocPermDisabled

boolean

If true, inherited role type document type permissions are enabled for the document types.

PLT.DocumentAlertListener

EnterpriseName

fully-qualified className

PLT.DvceBatchUploadQueueCleanup

ThresholdInDays

90

By default, the Platform deletes records from DVCE_BATCH_UPLOAD_QUEUE after 90 days. You can change that threshold by configuring this external reference entry.

PLT.EnableParentRecordChunking

EnterpriseName~ModelType~ActionName

or

EnterpriseName~ModelType

boolean

Platform by default considers the child records when chunking models for a write operation, but this policy needs to be set (true) if, for some reason, needs to chunk only for parent records irrespective of how many children each parent has.

PLT.FileExport

ExportTimeoutInMinutes

value in minutes (e.g. 60)

By default, Platform will timeout UI-initiated exports after 4 hours.  That timeout can be configured here.

PLT.Flashback

UndoRetentionInSeconds

value in seconds (e.g. 300)

By default, it is assumed that flashback is not available.  When this value is set, then the oracle log retention is assumed to be sufficiently large that moving back this number of seconds will be functional.  Users using PLT Flashback features will be able to go back in time this many seconds.

PLT.GridPoller

SleepTimeInMillis or SleepTimeInMillis~<IP Address of node>

Polling interval in milliseconds

Specifies polling interval to be used by Grid Poller on a node, if IP address of a node is mentioned or for the instance.

PLT.GridTaskAccessor

ChunkSize

Integer value

Chunk size to be used while saving grid job containing a large number of grid tasks.

PLT.InboundInterface.ChildErrorRollsBackAll

ModelType~ActionName

boolean

By default, the platform will rollback all child records when executing an action on the header if any child fails.  This can be overridden to false for a specific model type + action to 

allow it to write the header plus the children without errors.

PLT.Integ

CsvCellMaxLength

Number

Maximum characters permitted in a cell of inbound CSV file. If not provided then default value is 10,48,576 (i.e. 1024 x 1024).

PLT.Integ

PrecomputeCsvErrorSummaries

boolean

True if you would like all to compute and store error message summaries (error plus occurrence count) on enqueue for all messages for CSV interface errors to be used for later reporting. Defaults to false. Ignored if PrecomputeCsvRecordCounts is false.

PLT.Integ

PrecomputeCsvRecordCounts

boolean

True if you would like all to compute and store record counts on enqueue for all messages for CSV interfaces to be used for later reporting. Defaults to false.

PLT.Integ.X12

SkipCustomValidation

boolean

Skip extra validation for X12 files that oboe is not supporting (like control number and segment count validation). If either EDIInboundRoute.isSkipEdiValidation or this configuration is true, then extra validation will be skipped.

PLT.Kafka

Url

https://kafkaurl.com

Kafka base URL

PLT.KafkaTopic

BkChainEntTopic-<OAuthToken>

<Token>

PLT.KafkaTopic

enabled

<Topic Name>

PLT.LocalizedInboundSampleCSVHeader

Enabled

boolean

By default, templates for UI CSV Uploads are not internationalized.  By setting this value to true, they will be internationalized when exported.

PLT.MagicNumberForRead

Enabled

boolean

If magic value (-128) is available in DB for number field then that will not be displayed for reports as that is an UNSET value in PLT. But instance can add this external reference to display the same on UI.

PLT.Menus

FileAgeInHours

Number

Number of hours after which menu JSON files should be deleted from the cache. The default value is 8 hours.

PLT.MessageDetail:Enable

<VC ID>~<Queue Name>~<Ent Name>~<interface name>~<interface version>   Enable for Enterprise-level queue and interface

<VC ID>~<Queue Name>~<interface name>~<interface version>   Enable for VC-level queue and interface

<VC ID>~<Queue Name>~<Ent Name>   Enable for Enterprise-level queue, for all interfaces

<VC ID>~<Queue Name>  Enable for VC-level queue, for all interfaces

<interface name>~<interface version>   Enable for given interface across all Queues

• AllRecords: Message Detail enabled for all records
• ErrorRecordsOnly: Message Detail enabled for only error records
• None: Message Detail disabled

Enables "message detail" feature, where specific records are pulled from inbound/outbound integration files and stored in the database for searching purposes.

See https://docs.onenetwork.com/devnet/latest/platform-user-s-guide/integration/message-detail/enabling-message-detail for more information.

PLT.MessageDetail:SqlBasedPrimaryRef

<interface name>~<interface version>   for example: ZPTS.Book_IB~1.0

<primary model field ref>     for example: ZBKS.Book$Title      ( use $ between model level and field name )

When populating message detail, SQL Based interface metadata is not sufficient to describe what from the original CSV should populate into the PRIMARY_REF_TRANS_NO and PRIMARY_REF_MODEL_TYPE_NAME columns.  By setting this external reference, it will find the appropriate field in the incoming CSV and use it in the message detail record.

PLT.ModelAuditPurge

ModelType (e.g. PTA.TestModel) for which table needs to be purged

Retention policy in days (e.g., 365 = delete records older than one year)

When specified audit table will have old records deleted daily. WARNING - you should add an index on LAST_MODIFIED_DATE and PTX_SEQ for your model's ADT table before enabling this setting to ensure the best performance of the delete.

PLT.ModelPurge

ModelType (e.g. PTA.TestModel) for which table needs to be purged

Retention policy in days (e.g., 365 = delete records older than one year)

When specified audit table will have old records deleted daily. WARNING - you should add an index on LAST_MODIFIED_DATE for your model table before enabling this setting to ensure the best performance of the delete.

PLT.MongoDB

DatabaseName

MongoDB DB Name

PLT.MongoDB

Url

Mongo DB URL

PLT.MultiSelectFilterMacro

FillLengths

comma-delimited fill lengths to "round up" to when binding multi select values

Provides a mechanism for "rounding up" the number of bindings for a multiselect filter
to one of a set of numbers, and then binding the extra values with null.

This helps avoid too many Oracle hard parses by cutting down on the number of possible generated queries.  This can lead to significant performance gains.

Sample value: 1,10,100,1000,10000

For the sample value, if the user gave "X" it would be generated and bound as ["X"]

If the user gave "X;Y" it would be generated and bound as ["X","Y",null,null,null,null,null,null,null,null]

PLT.NativeSaml

boolean

Base64EncodedReq

Set to true for encoding SAML request to IdP using only Base64. The default value is false. If false, then the request is encoded using deflate followed by Base64.

PLT.NativeSaml

boolean

Enabled

If set to true Native SAML authentication mode is used to authenticate users. To use this option, install the server using nativesamlfilter.enabled=true in node.properties. This option bypasses ONE SSO and performs authentication with SAML compliant identity server(IdP).

This option is applicable for all the enterprises in the system.

PLT.NativeSaml

boolean

IdPLogoutDisabled

Set to true for disabling logout from IdP server if logout is invoked from ONE System UI. The default value is false.

PLT.NativeSaml

DisableEncodingOrigRequestURL

boolean

Set this flag to true to prevent the propagation of JSESSION ID in the URL.

PLT.NativeSaml

File path

IdpMetadataFile

Absolute file path of IdP metadata file. This file is provided by IdP owner. Server restart is required if value for this external reference or file content is changed. This is required if Native SAML authentication mode is enabled.

PLT.NativeSaml

File path

SpMetadataFile

Absolute file path of SP metadata file. Here SP i.e. Service Provider is ONE Platform. Server restart is required if value for this external reference or file content is changed. If this value is not provided and Native SAML authentication is enabled then default metadata file is generated at INSTALL_DIR/setup/sp-metadata.xml and used for executing the authentication flow.

PLT.NativeSaml

Id Attribute Name

IdAttributeName

Name of the attribute in IdP response(Assertion) which will be used to identify an user in ONE System for authentication. This value is provided by IdP owner. This is required if Native SAML authentication mode is enabled.

PLT.NativeSaml

NameID format value

NameIDFormat

NameIDFormat to be set in NameIDPolicy of SAML request which will be sent to IdP. This is an optional configuration for Native SAML authentication.

PLT.NativeSaml

Refresh interval in minutes

IdPMetadataRefreshIntervalInMins

Interval, in minutes, after which metadata from IdPMetadataUrl will be refreshed. The default value is 30 minutes.

PLT.NativeSaml

URL of IdP metadata

IdPMetadataUrl

URL to fetch IdP metadata. This option can be used instead of IdpMetadataFile if IdP has published metadata over the public network. A server restart is required if the value for this external reference is changed. If metadata returned by this URL has changed then these changes will be refreshed after minutes provided for IdPMetadataRefreshIntervalInMins. This is required if Native SAML authentication mode is enabled and IdpMetadataFile is not provided.

PLT.NeoHyperbots

DynamicSequenceLimit

Numerical Value. eg: 3

When dynamicSequence is true for a bot, it defined the instance default number of times the prescriptions should be re-evaluated and run. Default is 3 or unless no more prescriptions are computed (whichever condition is reached first).

PLT.NeoHyperbots

DynamicSequenceLimit~PTA.TestSampleBot
(Here PTA.TestSampleBot is the fully qualified name of the Subnet type)

Numerical Value. eg: 3

When dynamicSequence is true for a bot, this overrides the instance default to specify specific values per subnet for the dynamic seq limit (no. of times the prescriptions are recomputed)

PLT.NeoNotifications

PollingIntervalInSeconds

integer

Polling interval in seconds to check if new NeoUINotifications are available for the user. If not provided, the default value used will be 30.

PLT.NeoUI

DefaultMaxOpenPerspectives

number

To overwrite the system max limit of Open Perspectives.

PLT.NeoUI

MakeEnterpriseBrandingPrimary

boolean

If true, we show the Enterprise Branding Image on top of the Neo Global Sidebar with the ONE logo at the bottom

PLT.NeoUI

NeoShowPerspectiveAsTabs

boolean

When set to true, Neo UI will show the perspective as Tabs, i.e., same as old CC UI

PLT.OAuthAccessToken

DisableTokenAsRequestParam

boolean

If true, the access token for OAuth authorization can't be sent as a request parameter and should only be accepted as a header

PLT.PerspectiveBrowserHistory

Enabled

boolean

Can be used to disable navigation to different perspectives via "browser history" using anchor tags.  

By default this is true.  When true, it means when you change a perspective, it will change the browser URL bar with to add a perspective-identifying anchor, for example: /oms/base/home.action#PLT.AsyncJobStatus

This can be bookmarked to come directly to the perspective, and browser back/forward buttons also navigate across these.

When explicitly set to false, this feature is removed.  This can be used to prevent bookmarks and browser history navigation across perspective.  Disabling this also disables deeplinks.

PLT.Pipeline

NodeProcessingMaxRunTime

Time in minutes

Default max runtime for Plasma based pipeline nodes are 5 mins but network author can use this external reference to increase the max runtime for plasma based nodes.

PLT.PollChatMessage

PollingSequence

Comma separated integers. Eg. "5,10,15,30,60"

PLT.PTXADTRecords

Enabled

Boolean

If enabled, populates ADT records with timestamps that are as accurate as possible.

PLT.PTXLogMiner

Password

password

Oracle system password to create sys DBA connection.

PLT.PTXLogMiner

SID

localhost:1521/XE

Oracle system SID to create sys DBA connection.

PLT.PTXLogMiner

Username

System

Oracle system user name to create sys DBA connection.

PLT.PurgeAuditTable

Audit table Name (e.g., ENTERPRISE_ADT) to be purged

Retention policy in days (e.g., 365 = delete records older than one year)

When specified audit table will have old records deleted daily. WARNING - you should add an index on LAST_MODIFIED_DATE for your ADT table before enabling this setting to ensure the best performance of the delete.

PLT.PurgeAuditTableChunkSize

Chunk size

Number of audit records to be purged in a single commit. Defaults to 1000

PLT.PurgeNeoNotifications

NotificationExpireInDays

integer

Number of days after which the NeoUINotifications will expire and are available for purging. If not provided, the default value used will be 07.

PLT.PurgePtxAudit

MaxRetentionInDays

Retention policy in days (e.g. 30 = delete records older than 30 days)

Policy to purge PTX_ADT records. If not provided, the default value of 30 days will be used

PLT.Report.Disabled

Report Name

Boolean

If present and "true", the Report indicated will raise an error when executed. This allows production support to disable a report on the fly in the event of a severe performance issue.

PLT.Reports

MaxRowsAllowedInMemory

Integer

Non-streaming report exports (like excel) allow at most this many rows in memory.  The default value is 50,000.

WARNING: setting this value can put your server at risk for OutOfMemoryErrors, so consider your adjustments to this carefully.

PLT.Session

BrowserSessionCheckIntervalInSeconds

Interval (in seconds) at which browser should check for session status.  

If the browser sees that the session is inactive, it will immediately force a logout action.  This interval controls the rate at which this check for session activity is made.  It is primarily useful for scenarios when a user "walks away" from the application so that the UI will pro-actively logout the user, rather than waiting for the user to come back and click an action (which would also result in going to the logout page).

This value should not be set too low, as every active browser window will make a request at this interval to check for session health.  

Default value is 300 (5 minutes).

PLT.Session

MaxConcurrentWebSessions

A user is permitted no more than this number of concurrent sessions.

When a user's max concurrent web sessions is exceeded, their oldest active session will be killed.  Thus, this setting will never prevent a successful login, but will be used to invalidate older sessions.

There is no default value for this setting; users by default are permitted as many concurrent web sessions as desired.

PLT.Session

MaxWebSessionDurationMinutes

Time in minutes at which a web session will be killed, regardless of whether it is active or not.

There is no default value for this setting; users with an active session are never required to logout.

PLT.SSLTrustMgr

TrustAllCertsDevOnly

boolean

Disables SSL certificate validation for back-channel calls from Platform server if set to true.

e.g., If the Platform server is executing a back channel call to the SSO server (using HTTPS) and the certificate received from SSO has expired, then no SSL exception will be logged in the Platform server, and it will proceed with further execution.

Note

This configuration should only be used in the development or testing environment. If enabled in production, then there can be a security breach.

PLT.StrictJSONEncoding

Enable

boolean

When true, strict JSON encoding is going to be enabled for an instance which is disabled by default.

PollAndEnqueueFiles

MaxRuntimeInMillis

Number - max runtime in milliseconds

Maximum time for a PollAndEnqueueFiles task to run

PurgeMSSFiles

TimeInDays

No of days

Number of days for purging files stored in MessageStorageService.

RelationalFileReader.StrictDuplicateCheckingEnabled

ModelType~ActionName

boolean

When set to true for a given model type and action, will disallow any duplicate children under the same parent, failing the entire parent.

RESTEnqueueFileExtension

Whitelist

String-ExtensionList

Comma-delimited list of file extensions. REST uploads (e.g., "enqueue") will be permitted to upload files only with these extensions.

RESTExceptionMapper

DefaultStatusCode

Integer

By default, the status code returned for unexpected exceptions in REST resources is 400 (bad request). To return a different error code, e.g. 500 (internal server error), you can provide a value for this external reference.

ScheduledSftpPoll

{ messageSourceName: 'ProgressiveRetailerFileDrop', messageSourceEnterpriseName: 'ProgressiveRetailer', * host: 'mysftp.com', port: 22, Username: 'foo', Password: 'bar', polledDir: '/my/polleddir' }

Allows one to explicitly poll SFTP

SecurityEvent

SharePartnerData

enterprisename  (for example: ProgressiveRetailer)

When present for a given enterprise, that enterprise will see not only their own security events but their partners' security events as well when querying the Security Event Report and/or REST API

SESSION_CACHE

CACHE_CAPACITY

cache capacity

If provided, the cache will be initialized with the specified cache capacity or else a default value of 500

SESSION_CACHE_CLEANUP

TIME_IN_HOURS

Session Cleanup Value In Hours

If Specified, then session cleanup would be done N hrs; else, it will use a default value of 3 hours.

SetDefaultCurrencyCodeForUI

User's enterprise

Currency code (e.g. USD, GBP)

When set, this will default all empty Currency fields in the application to the given value.

SplitPayload

QueueName~Interface~Version

Count

Desired count on which the payload needs to be split. For ex: if the SplitPayload external reference entry is set up with a local value of 10000, then the payload will be split into chunks of 10000 rows, and if the file has lesser than 10000 rows, it will simply enqueue the payload as-is.

SqlInboundProcessor:MaxErrorLines

interface~version

Number

If Specified result will contain N number of error lines or else a default of 1000 lines

SQLLoader

SID

SystemTimex

UseServerTimeInBrowser

true

If true, then the browser is set to use the server's current date as today.

TaxService.username

avatax

String - username to be used for TAX service API

Username to be used for TAX service API

TaxService.password

avatax

String - password to be used for TAX service API

Password to be used for TAX service API

TLV.EntCustomizationAllowableRoleTypes

<RoleEnterpriseName>

~ separated string of Allowable Role Types

If there's no list of roletypes, then everyone has permission; else, if there's a list of roletype, then roletype pertaining to customization has to either be in the reference list or be derived from one in the list.

UIPreferenceDefaults

NumberFormat.MinimumFractionDigits

Integer between 0-9

Used to define the Global default for Minimum Fraction Digits. However, the user preference value for Minimum Faction Digits takes precedence over this global default.

UIPreferenceDefaults

NumberFormat.MaximumFractionDigits

boolean

When set to true for a given model type and action, it will disallow any duplicate children under the same parent, failing the entire parent.

URLRestriction

server.ipaddress. For example:

172.20.0.68

(Match against this node)

or

^(?!172.20.0.68).*$

(Match against other nodes)

URL Expression.  For example:

/oms/rest/queue/enqueue.*|/oms/rest/session.*

(allowed)

or

^(?!/oms/rest/queue/enqueue).*$

(not allowed)

If server.ipaddress matches, then the requested URL must match this to be accessible or restricted.

UserTermsAndConditions

ExpiryTimeMinutes

Number - minutes until the Terms and Conditions must be accepted again

If present, the user will have to re-accept the Terms and Conditions after LOCAL_VALUE minutes have elapsed. If the LOCAL_VALUE is set to 0, users must accept the Terms and Conditions every time they log in.

UserTermsAndConditions

Selector

{"className":"com.transcendsys.platform.server.user.StandardTermsAndConditionsSelectorImpl", "params":{'userTermsId' : 'idvalue'}}

If specified, user will be forced to accept "Terms and Conditions" at the time of first login.

The LOCAL_VALUE should be a JSON string consisting of two parameters:

• className: Fully-qualified class name implementing "com.onenetwork.platform.common.user.UserTermsAndConditionsSelector". A simple, reusable implementation is available which specifies a single UserTerms record to use: com.transcendsys.platform.server.user.StandardTermsAndConditionsSelectorImpl

• params:

  • If using the standard implementation, it should be a JSON consisting of {'userTermsId': 'idvalue'} (where userTermsId is the Id of a UserTermsAndConditions record to be used)

  • If using a custom implementation, it can contain arbitrary JSON, which the custom implementation interprets as it sees fit.

X-Content-Type-Options

nosniff

boolean

Defaults to true. Set to false to NOT configure header X-Content-Type-Options with value 'nosniff' for security purposes.

XSSPreventionFilter

AllowSemicolon

Boolean

By default, the value is false.  URLs with semicolon in the path are disallowed to help prevent potential Web Cache Deception issues.  However, in specific situations where the semicolon is required (e.g. jsessionid in some specific redirect contexts), this rule can be relaxed by setting this to true.

XSSPreventionFilter

Enabled

Boolean

If true, enables aggressive filtering across all inputs for potential XSS attacks, rejecting inputs like <script, javascript:, etc. Defaults to true, so it must be explicitly set to false to disable.

XSSPreventionFilter

WhitelistedPathPatterns

String (regex)

You may have multiple Ext Ref rows with this ref type / external value combination. Each is a regex that will be matched against Request URI paths. Any path matching will NOT be subject to the XSSPreventionFilter. Those paths are expected to check XSS on their own instead. Example: .*/oms/rest/ZBKS/mySpecialResource.*