System Configuration

External Reference

One Network provides a general-purpose lookup table for mapping external values to internal values.

The following three fields are used on External Reference for mapping external values to internal values:

  • RefType

  • ExternalValue

  • LocalValue

The developer can use PLT.ExternalReference_IB inbound interface to load data to External Reference.

External Reference Configuration

The following table describes the list of external references developers can use for their specific use cases.

Table 25.1. External Reference Configuration



REF_TYPE

ONE:JIRA:EncryptInfo:PublicKey

EXTERNAL_VALUE

EncryptInfoPublicKey

LOCAL_VALUE

Encryption Public Key

Description

Public Key for encrypting sensitive information



REF_TYPE

ActionListAsyncThreshold

EXTERNAL_VALUE

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

LOCAL_VALUE

Number of records

Description

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



REF_TYPE

ActionListAsyncThresholdComputation

EXTERNAL_VALUE

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

LOCAL_VALUE

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

Description

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

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


REF_TYPE

AddressValidation.apiKey

EXTERNAL_VALUE

<validator name>:::<validator group>

LOCAL_VALUE

<Token>

Description

There are currently two service providers available for address validation:

Example:

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

  • AddressValidation.apiKey,Shippo:::testing,shippo_test_2763c79b5a590fa645fb94b71ad5d5f5d4cad971po_test_2763c79b5a590fa645fb94b71ad5d5f5d4cad971


REF_TYPE

Alerts

EXTERNAL_VALUE

EnableEmailHyperlinkForAllModels

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

AntiVirus

EXTERNAL_VALUE

VectorScanException

LOCAL_VALUE

PollFile

PollSFTP

PollAWSS3

PollAZURE

HttpUpload

InternallyGenerated

Description

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.


REF_TYPE

AntiVirus

EXTERNAL_VALUE

FilenameRegexScanException

LOCAL_VALUE

<regular expression>

Description

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


REF_TYPE

AsyncAction.MaxAttempts

EXTERNAL_VALUE

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

LOCAL_VALUE

Number - desired number of attempts

Description

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

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


REF_TYPE

AsyncAction.MaxRetryDelay

EXTERNAL_VALUE

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

LOCAL_VALUE

Number - max retry delay in millis

Description

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


REF_TYPE

AsyncAction.MaxRuntime

EXTERNAL_VALUE

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

LOCAL_VALUE

Number - max runtime in millis

Description

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


REF_TYPE

Audit

EXTERNAL_VALUE

ValueChainID~ModelType

LOCAL_VALUE

boolean

Description

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

Example -

EXTERNAL_VALUE: 8001~Shipment

LOCAL_VALUE: true/false


REF_TYPE

AuthenticationControl

EXTERNAL_VALUE

DisableBatchPasswordAuth

LOCAL_VALUE

Boolean

Description

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


REF_TYPE

BucketTransform

EXTERNAL_VALUE

DefaultBucketTransform

LOCAL_VALUE

Transform function name

Description

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'


REF_TYPE

CdnWebFonts

EXTERNAL_VALUE

Disabled

LOCAL_VALUE

Boolean

Description

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


REF_TYPE

ClickThroughSplash

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

boolean

Description

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>


REF_TYPE

ConcatenatedEDIInboundProcessor.EnqueueSingleChunk

EXTERNAL_VALUE

<full-qualified queue name>


REF_TYPE

ConcatenatedEDIInboundProcessor.HeaderBasedEnqueue

EXTERNAL_VALUE

Header IDs given as Input

LOCAL_VALUE

String QueueName

Description

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


REF_TYPE

ConsolidateCsvUploadValidationErrors

EXTERNAL_VALUE

<InboundInterfaceName>~<InboundInterfaceVersion>

LOCAL_VALUE

true or false

Description

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


REF_TYPE

ConsolidatedValidationErrorsFormatter

EXTERNAL_VALUE

<InboundInterfaceName>~<InboundInterfaceVersion>

LOCAL_VALUE

name of formatter class

Description

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


REF_TYPE

Content-Security-Policy

EXTERNAL_VALUE

HeaderValue

LOCAL_VALUE

<Desired Content-Security Policy value>

Description

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: *


REF_TYPE

CORSFilter

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

Boolean (True\False)

Description

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.


REF_TYPE

CORSFilter

EXTERNAL_VALUE

WhitelistDomainPattern

LOCAL_VALUE

String (regex)

Description

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


REF_TYPE

CSRFPreventionFilter

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

Boolean

Description

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.


REF_TYPE

CSRFPreventionFilter

EXTERNAL_VALUE

RequireCSRFRequestToken

LOCAL_VALUE

Boolean

Description

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


REF_TYPE

CurrencyCodeForUI

EXTERNAL_VALUE

Enterprise Name

LOCAL_VALUE

Currency code (e.g. GBP)

Description

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


REF_TYPE

CSRFPreventionFilter

EXTERNAL_VALUE

WhitelistedHostPatterns

LOCAL_VALUE

String (regex)

Description

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.


REF_TYPE

DelimiterTransform:Field

EXTERNAL_VALUE

QueueName~Interface~Version

LOCAL_VALUE

Desired Custom Delimiter for Fields

Description

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


REF_TYPE

DEMO_SETTINGS

EXTERNAL_VALUE

DemoMode

LOCAL_VALUE

boolean

Description

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


REF_TYPE

DisableProblemGeneration

EXTERNAL_VALUE

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

LOCAL_VALUE

ProblemTypeName

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

Description

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


REF_TYPE

DistanceServerGoogleConnect

EXTERNAL_VALUE

String - API Key

LOCAL_VALUE

APIKey

Description

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


REF_TYPE

DocumentTypePermissionHandler

EXTERNAL_VALUE

modeltype~category~doctypename

LOCAL_VALUE

fully-qualified class name

Description

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


REF_TYPE

DynamicEnumeration

EXTERNAL_VALUE

ActingVCAdminRoleType

LOCAL_VALUE

role type name

Description

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.


REF_TYPE

EdiConfig:PartnerTypeToMaster

EXTERNAL_VALUE


LOCAL_VALUE

Description


REF_TYPE

EdiConfig:PartnerTypeToMaster

EXTERNAL_VALUE

Partner TypeName

LOCAL_VALUE

Description


REF_TYPE

Email

EXTERNAL_VALUE

AllowedSuffixes

LOCAL_VALUE

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

Description

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.


REF_TYPE

FileUploadExtension

EXTERNAL_VALUE

Whitelist

LOCAL_VALUE

String-ExtensionList

Description

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


REF_TYPE

FormulaInjectionPrevention

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

Boolean

Description

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


REF_TYPE

CSRFPreventionFilter

EXTERNAL_VALUE

RequireCSRFRequestToken

LOCAL_VALUE

Boolean

Description

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


REF_TYPE

GeoGraphApiKey

EXTERNAL_VALUE

String - API Key

LOCAL_VALUE

Instance

Description

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


REF_TYPE

GraphHopperAPI

EXTERNAL_VALUE

X-RateLimit-Remaining.LogThreshold

LOCAL_VALUE

long value

Description

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.


REF_TYPE

IntegrationSubscriptionContextEntQueue

EXTERNAL_VALUE

EnterpriseName

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

IntegrationSubscriptionContextQueue

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

IntegrationSubscriptionTaskPerformer

EXTERNAL_VALUE

OneIdPerOutbound

LOCAL_VALUE

boolean

Description

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


REF_TYPE

Interface.AutoTruncateStaging

EXTERNAL_VALUE

<interface name>~<interface version>

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

Interface.ChunkSize

EXTERNAL_VALUE

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

LOCAL_VALUE

Number - chunk size

Description

Chunk size used for processing this interface

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


REF_TYPE

Interface.DisableStagingCleanup

EXTERNAL_VALUE

<interface name>~<interface version>

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

Interface.MaxAttempts

EXTERNAL_VALUE

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

LOCAL_VALUE

Number - desired number of attempts

Description

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


REF_TYPE

Interface.MaxRetryDelay

EXTERNAL_VALUE

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

LOCAL_VALUE

Number - max retry delay in millis

Description

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


REF_TYPE

Interface.MaxRuntime

EXTERNAL_VALUE

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

LOCAL_VALUE

Number - max runtime in millis

Description

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


REF_TYPE

JASPER_SERVER_URL

EXTERNAL_VALUE

EnterpriseName or Stage, i.e. DEV, QA

LOCAL_VALUE

URL

Description

Entry with EnterpriseName will take precedence over Stage


REF_TYPE

JASPER_SERVER_AUTH_INFO

EXTERNAL_VALUE

Stage, i.e., Dev, QA

LOCAL_VALUE

Description


REF_TYPE

OAuth

EXTERNAL_VALUE

TokenExpiryInSeconds

LOCAL_VALUE

integer

Description

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


REF_TYPE

OnBoard:Integ:PltInst

EXTERNAL_VALUE

PROD_INST

LOCAL_VALUE

Instance Name

Description


REF_TYPE

OnBoard:Integ:PltInst

EXTERNAL_VALUE

SPT_INST

LOCAL_VALUE

Instance Name

Description


REF_TYPE

ONE:Enable:CreateJIRA

EXTERNAL_VALUE

CreateJIRA

LOCAL_VALUE

Description


REF_TYPE

ONE:OnboardingFlowDoc

EXTERNAL_VALUE

PartnerOnboardingPath

LOCAL_VALUE

Document Path

Description


REF_TYPE

ONE:JIRA:IssueURL

EXTERNAL_VALUE

JIRAURL

LOCAL_VALUE

Instance Name

Description


REF_TYPE

ONE:JIRA:OAuth:AccessToken

EXTERNAL_VALUE

OAuthAccessToken

LOCAL_VALUE

Access Token

Description


REF_TYPE

ONE:JIRA:OAuth:PrivateKey

EXTERNAL_VALUE

OauthPrivatekey

LOCAL_VALUE

Private Key

Description


REF_TYPE

ONE:JIRA:RestPath

EXTERNAL_VALUE

JIRARestPath

LOCAL_VALUE

Instance Name

Description


REF_TYPE

ONE:RIO-APP

EXTERNAL_VALUE

RIOTestNetwork

LOCAL_VALUE

InstanceName

Description

PlatformInstance Name


REF_TYPE

OpenExchange

EXTERNAL_VALUE

ID

LOCAL_VALUE

0e3f298adb2e4c07b81d4f6095c6a258

Description

OpenExchange library to be used for currency conversion


REF_TYPE

OutboundMail

EXTERNAL_VALUE

MaxDaysToKeepRelayedMail

LOCAL_VALUE

No of days

Description

Configuration to delete the outbound emails after N days.


REF_TYPE

OutboundSMS

EXTERNAL_VALUE

MaxDaysToKeepRelayedSMS

LOCAL_VALUE

No of days

Description

Configuration to delete the outbound SMS after N days.


REF_TYPE

PartitionKeys

EXTERNAL_VALUE

TableName

LOCAL_VALUE

ColumnNames

Description


REF_TYPE

PersonalizedIssueCompActivity

EXTERNAL_VALUE

DisableFor

LOCAL_VALUE

<ModelType> or <ModelType>~<ActionName>

Description

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

Example - PersonalizedIssueCompActivity,DisableFor,ZBKS.Book


REF_TYPE

PKI_AUTHENTICATION

EXTERNAL_VALUE

HIDE_UPLOAD_CERT_BUTTON

LOCAL_VALUE

true/false

Description

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


REF_TYPE

PKI_AUTHENTICATION

EXTERNAL_VALUE

UploadCertificate

LOCAL_VALUE

true/false

Description

Whether the admin user can upload certificates or not.


REF_TYPE

PLT.Address

EXTERNAL_VALUE

DisablePostalCodeValidation

LOCAL_VALUE

true/false

Description

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.


REF_TYPE

PLT.Address

EXTERNAL_VALUE

DisablePostalCodeValidationForCountry

LOCAL_VALUE

Country code

example: US

Description

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.


REF_TYPE

PLT.Alerts

EXTERNAL_VALUE

EnablePushOnNewAlert

LOCAL_VALUE

true/false

Description

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


REF_TYPE

PLT.Backchain

EXTERNAL_VALUE

ContractAddress

LOCAL_VALUE

0xc5d4b021858a17828532e484b915149af5e1b138

Description

Base64-encoded contract address starting with "0x"


REF_TYPE

PLT.Backchain

EXTERNAL_VALUE

DisputeContractAddress

LOCAL_VALUE

0x4a6886a515a4b800f4591a6d6a60e6004a3645ab

Description

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


REF_TYPE

PLT.Backchain

EXTERNAL_VALUE

MaxMerkleGenerationTime

LOCAL_VALUE

Description

Merkle tree generation time in milliseconds


REF_TYPE

PLT.Backchain

EXTERNAL_VALUE

MaxMerkleLeaves

LOCAL_VALUE

Description


REF_TYPE

PLT.Backchain

EXTERNAL_VALUE

PrivateKey

LOCAL_VALUE

0x8ad0132f808d0830c533d7673cd689b7fde2d349ff0610e5c04ceb9d6efb4eb1

Description

Base64-encoded private key starting with "0x"


REF_TYPE

PLT.Backchain

EXTERNAL_VALUE

Url

LOCAL_VALUE

https://backchain.com

Description

Backchain server URL


REF_TYPE

PLT.Backchain

EXTERNAL_VALUE

ValueChainId~ModelType

LOCAL_VALUE

boolean

Description

To determine if backchain is enabled or not for a model


REF_TYPE

PLT.ConcurrencyVersion

EXTERNAL_VALUE

ModelLevel or ModelLevel~ActionName

LOCAL_VALUE

Disable

Description

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.


REF_TYPE

PLT.DBSession

EXTERNAL_VALUE

MinBlockedSessionCount

LOCAL_VALUE

Long value

Description

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.


REF_TYPE

PLT.DBSession

EXTERNAL_VALUE

BlockedSessionTimeout

LOCAL_VALUE

Long value (timeout will be in minutes)

Description

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.


REF_TYPE

PLT.DBSession

EXTERNAL_VALUE

KillHistoryRetentionDays

LOCAL_VALUE

Long value

Description

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.


REF_TYPE

PLT.DBSession

EXTERNAL_VALUE

UIRequestQueryTimeoutInMinutes

LOCAL_VALUE

Long value

Description

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.


REF_TYPE

PLT.DefaultOrEntTimezonePrefs

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PLT.DirectModelAccess

EXTERNAL_VALUE

ChildIdFilterAlignTarget

LOCAL_VALUE

integer (default is 1000)

Description

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


REF_TYPE

PLT.DirectModelAccess

EXTERNAL_VALUE

MaxChildRowsChunkSize

LOCAL_VALUE

integer (default is 300000)

Description

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.


REF_TYPE

PLT.DirectModelAccess

EXTERNAL_VALUE

ReadChunkSize

LOCAL_VALUE

integer (default is 150)

Description

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


REF_TYPE

PLT.DisableConditionallyRequiredFields

EXTERNAL_VALUE

<Queue Name or *> ~ <Interface Name or *> ~ <Interface Version or *>

LOCAL_VALUE

true

Description

Disable conditional requiredness checking for the <queue> ~ <interface> ~ <version> combination. "*" may be used to match all queue names, interface names, or interface versions.


REF_TYPE

PLT.DisableCsvFormulaInjectionForUIExport

EXTERNAL_VALUE

FullyQualifiedReportName~EntName

or

EntName

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.DocTypePerm

EXTERNAL_VALUE

StrictRoleTypeDocPermDisabled

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PLT.DocumentAlertListener

EXTERNAL_VALUE

EnterpriseName

LOCAL_VALUE

fully-qualified className

Description


REF_TYPE

PLT.DvceBatchUploadQueueCleanup

EXTERNAL_VALUE

ThresholdInDays

LOCAL_VALUE

90

Description

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.


REF_TYPE

PLT.EnableParentRecordChunking

EXTERNAL_VALUE

EnterpriseName~ModelType~ActionName

or

EnterpriseName~ModelType

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.FileExport

EXTERNAL_VALUE

ExportTimeoutInMinutes

LOCAL_VALUE

value in minutes (e.g. 60)

Description

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


REF_TYPE

PLT.Flashback

EXTERNAL_VALUE

UndoRetentionInSeconds

LOCAL_VALUE

value in seconds (e.g. 300)

Description

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.


REF_TYPE

PLT.GridPoller

EXTERNAL_VALUE

SleepTimeInMillis or SleepTimeInMillis~<IP Address of node>

LOCAL_VALUE

Polling interval in milliseconds

Description

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


REF_TYPE

PLT.GridTaskAccessor

EXTERNAL_VALUE

ChunkSize

LOCAL_VALUE

Integer value

Description

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


REF_TYPE

PLT.InboundInterface.ChildErrorRollsBackAll

EXTERNAL_VALUE

ModelType~ActionName

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.Integ

EXTERNAL_VALUE

CsvCellMaxLength

LOCAL_VALUE

Number

Description

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


REF_TYPE

PLT.Integ

EXTERNAL_VALUE

PrecomputeCsvErrorSummaries

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.Integ

EXTERNAL_VALUE

PrecomputeCsvRecordCounts

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.Integ.X12

EXTERNAL_VALUE

SkipCustomValidation

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.Integ.X12

EXTERNAL_VALUE

SkipCustomValidation ~<Sender>

LOCAL_VALUE

boolean

Description

Similar to PLT.Integ.X12 / SkipCustomValidation, but applies to a specific sender.


REF_TYPE

PLT.Integ.EDIFact

EXTERNAL_VALUE

SkipCustomValidation

LOCAL_VALUE

boolean

Description

Skip extra validation for EDIFact 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.


REF_TYPE

PLT.Integ.EDIFact

EXTERNAL_VALUE

SkipCustomValidation ~<Sender>

LOCAL_VALUE

boolean

Description

Similar to PLT.Integ.EDIFact/ SkipCustomValidation, but applies to a specific sender.


REF_TYPE

PLT.Integ.EDIFact

EXTERNAL_VALUE

<Sender>

LOCAL_VALUE

boolean

Description

Similar to PLT.Integ.EDIFact/ SkipCustomValidation~<Sender>. This <Sender> only form of the configuration is deprecated and not recommended, please prefer SkipCustomValidation~<Sender>.


REF_TYPE

PLT.Kafka

EXTERNAL_VALUE

Url

LOCAL_VALUE

https://kafkaurl.com

Description

Kafka base URL


REF_TYPE

PLT.KafkaTopic

EXTERNAL_VALUE

BkChainEntTopic-<OAuthToken>

LOCAL_VALUE

<Token>

Description


REF_TYPE

PLT.KafkaTopic

EXTERNAL_VALUE

enabled

LOCAL_VALUE

<Topic Name>

Description


REF_TYPE

PLT.LegacyReportDownloadFormat

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

boolean

Description

Beginning in NEO 3.9, downloads are Excel by default instead of CSV. This flag can be set to "true" to restore the original behavior, i.e. default is export to CSV.


REF_TYPE

PLT.LocalizedInboundSampleCSVHeader

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PLT.Menus

EXTERNAL_VALUE

FileAgeInHours

LOCAL_VALUE

Number

Description

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


REF_TYPE

PLT.MessageDetail:Enable

EXTERNAL_VALUE

<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

LOCAL_VALUE

  • AllRecords: Message Detail enabled for all records

  • ErrorRecordsOnly: Message Detail enabled for only error records

  • None: Message Detail disabled

Description

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.


REF_TYPE

PLT.MessageDetail:SqlBasedPrimaryRef

EXTERNAL_VALUE

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

LOCAL_VALUE

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

Description

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.


REF_TYPE

PLT.ModelAuditPurge

EXTERNAL_VALUE

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

LOCAL_VALUE

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

Description

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.


REF_TYPE

PLT.ModelPurge

EXTERNAL_VALUE

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

LOCAL_VALUE

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

Description

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.


REF_TYPE

PLT.MongoDB

EXTERNAL_VALUE

DatabaseName

LOCAL_VALUE

Description

MongoDB DB Name


REF_TYPE

PLT.MongoDB

EXTERNAL_VALUE

Url

LOCAL_VALUE

Description

Mongo DB URL


REF_TYPE

PLT.MultiSelectFilterMacro

EXTERNAL_VALUE

FillLengths

LOCAL_VALUE

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

Description

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]


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

boolean

LOCAL_VALUE

DeflateRequest

Description

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


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

boolean

LOCAL_VALUE

Enabled

Description

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.


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

boolean

LOCAL_VALUE

IdPLogoutDisabled

Description

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


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

DisableEncodingOrigRequestURL

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

File path

LOCAL_VALUE

IdpMetadataFile

Description

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.


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

File path

LOCAL_VALUE

SpMetadataFile

Description

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.


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

Id Attribute Name

LOCAL_VALUE

IdAttributeName

Description

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.


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

NameID format value

LOCAL_VALUE

NameIDFormat

Description

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


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

Refresh interval in minutes

LOCAL_VALUE

IdPMetadataRefreshIntervalInMins

Description

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


REF_TYPE

PLT.NativeSaml

EXTERNAL_VALUE

URL of IdP metadata

LOCAL_VALUE

IdPMetadataUrl

Description

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.


REF_TYPE

PLT.NeoHyperbots

EXTERNAL_VALUE

DynamicSequenceLimit

LOCAL_VALUE

Numerical Value. eg: 3

Description

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


REF_TYPE

PLT.NeoHyperbots

EXTERNAL_VALUE

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

LOCAL_VALUE

Numerical Value. eg: 3

Description

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)


REF_TYPE

PLT.NeoNotifications

EXTERNAL_VALUE

PollingIntervalInSeconds

LOCAL_VALUE

integer

Description

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


REF_TYPE

PLT.NeoUI

EXTERNAL_VALUE

DefaultMaxOpenPerspectives

LOCAL_VALUE

number

Description

To overwrite the system max limit of Open Perspectives.


REF_TYPE

PLT.NeoUI

EXTERNAL_VALUE

MakeEnterpriseBrandingPrimary

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PLT.NeoUI

EXTERNAL_VALUE

NeoShowPerspectiveAsTabs

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PLT.OAuthAccessToken

EXTERNAL_VALUE

DisableTokenAsRequestParam

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PLT.PerspectiveBrowserHistory

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.PollChatMessage

EXTERNAL_VALUE

PollingSequence

LOCAL_VALUE

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

Description


REF_TYPE

PLT.PTXADTRecords

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

Boolean

Description

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


REF_TYPE

PLT.PTXLogMiner

EXTERNAL_VALUE

Password

LOCAL_VALUE

password

Description

Oracle system password to create sys DBA connection.


REF_TYPE

PLT.PTXLogMiner

EXTERNAL_VALUE

SID

LOCAL_VALUE

localhost:1521/XE

Description

Oracle system SID to create sys DBA connection.


REF_TYPE

PLT.PTXLogMiner

EXTERNAL_VALUE

Username

LOCAL_VALUE

System

Description

Oracle system user name to create sys DBA connection.


REF_TYPE

PLT.PurgeAuditTable

EXTERNAL_VALUE

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

LOCAL_VALUE

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

Description

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.


REF_TYPE

PLT.PurgeAuditTableChunkSize

EXTERNAL_VALUE

Chunk size

LOCAL_VALUE

Description

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


REF_TYPE

PLT.PurgeNeoNotifications

EXTERNAL_VALUE

NotificationExpireInDays

LOCAL_VALUE

integer

Description

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


REF_TYPE

PLT.PurgePtxAudit

EXTERNAL_VALUE

MaxRetentionInDays

LOCAL_VALUE

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

Description

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


REF_TYPE

PLT.Report.Disabled

EXTERNAL_VALUE

Report Name

LOCAL_VALUE

Boolean

Description

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.


REF_TYPE

PLT.Reports

EXTERNAL_VALUE

MaxRowsAllowedInMemory

LOCAL_VALUE

Integer

Description

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.



REF_TYPE

PLT.Session

EXTERNAL_VALUE

BrowserSessionCheckIntervalInSeconds

LOCAL_VALUE

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

Description

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


REF_TYPE

PLT.Session

EXTERNAL_VALUE

MaxConcurrentWebSessions

LOCAL_VALUE

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

Description

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.


REF_TYPE

PLT.Session

EXTERNAL_VALUE

MaxWebSessionDurationMinutes

LOCAL_VALUE

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

Description

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


REF_TYPE

PLT.SSLTrustMgr

EXTERNAL_VALUE

TrustAllCertsDevOnly

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

PLT.StrictJSONEncoding

EXTERNAL_VALUE

Enable

LOCAL_VALUE

boolean

Description

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


REF_TYPE

PollAndEnqueueFiles

EXTERNAL_VALUE

MaxRuntimeInMillis

LOCAL_VALUE

Number - max runtime in milliseconds

Description

Maximum time for a PollAndEnqueueFiles task to run


REF_TYPE

PurgeMSSFiles

EXTERNAL_VALUE

TimeInDays

LOCAL_VALUE

No of days

Description

Number of days for purging files stored in MessageStorageService.


REF_TYPE

RelationalFileReader.StrictDuplicateCheckingEnabled

EXTERNAL_VALUE

ModelType~ActionName

LOCAL_VALUE

boolean

Description

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


REF_TYPE

RESTEnqueueFileExtension

EXTERNAL_VALUE

Whitelist

LOCAL_VALUE

String-ExtensionList

Description

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


REF_TYPE

RESTExceptionMapper

EXTERNAL_VALUE

DefaultStatusCode

LOCAL_VALUE

Integer

Description

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.


REF_TYPE

ScheduledSftpPoll

EXTERNAL_VALUE


LOCAL_VALUE

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

Description

Allows one to explicitly poll SFTP


REF_TYPE

SecurityEvent

EXTERNAL_VALUE

SharePartnerData

LOCAL_VALUE

enterprisename (for example: ProgressiveRetailer)

Description

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


REF_TYPE

SESSION_CACHE

EXTERNAL_VALUE

CACHE_CAPACITY

LOCAL_VALUE

cache capacity

Description

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


REF_TYPE

SESSION_CACHE_CLEANUP

EXTERNAL_VALUE

TIME_IN_HOURS

LOCAL_VALUE

Session Cleanup Value In Hours

Description

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


REF_TYPE

SetDefaultCurrencyCodeForUI

EXTERNAL_VALUE

User's enterprise

LOCAL_VALUE

Currency code (e.g. USD, GBP)

Description

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


REF_TYPE

SplitPayload

EXTERNAL_VALUE

QueueName~Interface~Version

LOCAL_VALUE

Count

Description

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.


REF_TYPE

SqlInboundProcessor:MaxErrorLines

EXTERNAL_VALUE

interface~version

LOCAL_VALUE

Number

Description

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


REF_TYPE

SQLLoader

EXTERNAL_VALUE

SID

LOCAL_VALUE

Description


REF_TYPE

SystemTime x

EXTERNAL_VALUE

UseServerTimeInBrowser

LOCAL_VALUE

true

Description

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


REF_TYPE

TaxService.username

EXTERNAL_VALUE

avatax

LOCAL_VALUE

String - username to be used for TAX service API

Description

Username to be used for TAX service API


REF_TYPE

TaxService.password

EXTERNAL_VALUE

avatax

LOCAL_VALUE

String - password to be used for TAX service API

Description

Password to be used for TAX service API


REF_TYPE

TLV.EntCustomizationAllowableRoleTypes

EXTERNAL_VALUE

<RoleEnterpriseName>

LOCAL_VALUE

~ separated string of Allowable Role Types

Description

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.


REF_TYPE

UIPreferenceDefaults

EXTERNAL_VALUE

NumberFormat.MinimumFractionDigits

LOCAL_VALUE

Integer between 0-9

Description

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.


REF_TYPE

UIPreferenceDefaults

EXTERNAL_VALUE

NumberFormat.MaximumFractionDigits

LOCAL_VALUE

boolean

Description

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.


REF_TYPE

URLRestriction

EXTERNAL_VALUE

server.ipaddress. For example:

172.20.0.68

(Match against this node)

or

^(?!172.20.0.68).*$

(Match against other nodes)

LOCAL_VALUE

URL Expression. For example:


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

(allowed)

or


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

(not allowed)

Description

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


REF_TYPE

UserTermsAndConditions

EXTERNAL_VALUE

ExpiryTimeMinutes

LOCAL_VALUE

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

Description

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.


REF_TYPE

UserTermsAndConditions

EXTERNAL_VALUE

Selector

LOCAL_VALUE

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

Description

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.


REF_TYPE

UseXAPIKeyAsAccessToken

EXTERNAL_VALUE

access_token

LOCAL_VALUE

boolean

Description

When present and "true", allows clients to use the request header " X-API-Key" as an alternative key for sending an oauth token. Defaults to "false".


REF_TYPE

X-Content-Type-Options

EXTERNAL_VALUE

nosniff

LOCAL_VALUE

boolean

Description

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


REF_TYPE

XSSPreventionFilter

EXTERNAL_VALUE

AllowSemicolon

LOCAL_VALUE

Boolean

Description

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.


REF_TYPE

XSSPreventionFilter

EXTERNAL_VALUE

Enabled

LOCAL_VALUE

Boolean

Description

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.


REF_TYPE

XSSPreventionFilter

EXTERNAL_VALUE

WhitelistedPathPatterns

LOCAL_VALUE

String (regex)

Description

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.*