Skip to main content
Delphix

Application Settings API (KBA4539)

 

KBA

KBA# 4539

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases
6.0 6.0.0.0, 6.0.1.0, 6.0.1.1, 6.0.2.0, 6.0.2.1, 6.0.3.0, 6.0.3.1, 6.0.4.0, 6.0.4.1, 6.0.4.2, 6.0.5.0, 6.0.6.0, 6.0.6.1, 6.0.7.0

5.3

5.3.0.0, 5.3.0.1, 5.3.0.2, 5.3.0.3, 5.3.1.0, 5.3.1.1, 5.3.1.2, 5.3.2.0, 5.3.3.0, 5.3.3.1, 5.3.4.0, 5.3.5.0, 5.3.6.0, 5.3.7.0, 5.3.7.1, 5.3.8.0, 5.3.8.1, 5.3.9.0

5.2

5.2.2.0, 5.2.2.1, 5.2.3.0, 5.2.4.0, 5.2.5.0, 5.2.5.1, 5.2.6.0, 5.2.6.1

How to set Application Settings

Application Settings are configured using the Masking API and they are found under the EndPoint: applicationSettings.

For more information see:

Available Application Settings (and versions)

The following Application Settings are available.

+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
|                                         |               |                                                                        | 5 5 5 5 5 5 5 5 5 6 6 6 6 6 6 6 6 |
|                                         |               |                                                                        | 2 3 3 3 3 3 3 3 3 0 0 0 0 0 0 0 0 |
|                                         |               |                                                                        | - 0 1 2 3 4 5 6 9 0 1 2 3 4 5 6 7 |
| setting_group / setting_name            | flags         | value                                                                  | - 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| algorithm                               |               |                                                                        |                                   |
|   DefaultNonConformantDataHandling      | f,,           | DONT_MASK^DONT_MASK$|^FAIL$                                            | - - - - - Y Y Y Y Y Y Y Y Y Y Y Y |
|   AbortOnSegmentMappingPatternFailure   | f,,           | false                                                                  | - Y Y Y - - - - - - - - - - - - - |
|   LogRateLimitBytesPerSecond            | f,100,1000000 | 2000                                                                   | - - - - - - - - - - - - Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| analytics                               |               |                                                                        |                                   |
|   StepPerformance                       | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   OnCpu                                 | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   OffCpu                                | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   LoadAverage                           | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   CpuTime                               | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   MemoryUsage                           | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   TcpUsage                              | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| async                                   |               |                                                                        |                                   |
|   HistoryExpirationDays                 | f,0,          | 30                                                                     | - Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| database                                |               |                                                                        |                                   |
|   DB2zDateFormat                        | f,,           | yyyy-MM-dd                                                             | - - Y Y - Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| engineSync                              |               |                                                                        |                                   |
|   DocPurgePeriod                        | f,,1          | 24                                                                     | - Y Y Y - Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| fileUpload                              |               |                                                                        |                                   |
|   PurgePeriod                           | f,0,          | 24                                                                     | - Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| general                                 |               |                                                                        |                                   |
|   AllowPasswordResetRequest             | f,,           | true                                                                   | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   PasswordResetLinkDuration             | f,,           | 5                                                                      | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   EnableMonitorRowCount                 | f,,           | true                                                                   | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   JobOutputCleanerPeriodIntervalSeconds | f,,           | 86400                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   MaximumQueuedJobs                     | f,,           | 0                                                                      | - Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   MountConsistencyCheckPeriod           | f,,1          | 5                                                                      | - - - - - - - - - Y Y Y Y Y Y Y Y |
|   RulesetRefreshThreads                 | f,,           | 8                                                                      | - - - - - - - - - Y Y Y Y Y Y Y Y |
|   NumSimulJobsAllowed                   | f,,           | 7                                                                      | - - - - - - - - - - - - Y Y Y Y Y |
|   MaximumMemoryForJobs                  | f,,           | 0                                                                      | - - - - - - - - - - - - - Y Y Y Y |
|   UserManagementHandler                 | f,,           | 1                                                                      | - - - - - - - - - - - - - - - - Y |
|   DefaultApiVersion                     | f,,           | (v5.0.0|v5.1.0|v5.1.1|v5.1.2|v5.1.3|v5.1.4|v5.1.5|v5.1.6|v5.1.7|^$)    | - - - - - - - - - - - - - - - - Y |
|   DefaultApiVersion                     | f,,           | (v5.0.0|v5.1.0|v5.1.1|v5.1.2|v5.1.3|v5.1.4|v5.1.5|v5.1.6|^$)           | - - - - - - - - - - - - - - - Y - |
|   DefaultApiVersion                     | f,,           | (v5.0.0|v5.1.0|v5.1.1|v5.1.2|v5.1.3|v5.1.4|v5.1.5)                     | - - - - - - - - - - - - - - Y - - |
|   PasswordCount                         | f,0,          | 3                                                                      | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   PasswordTimeSpan                      | f,0,          | 0                                                                      | - - - - - - Y - - - - - - - - - - |
|   PasswordTimeSpan                      | f,0,          | 23                                                                     | Y Y Y Y Y Y - Y Y Y Y Y Y Y Y Y Y |
| job                                     |               |                                                                        |                                   |
|   JobLoggingLevel                       | f,,           | Basic^Basic$|^Detailed$                                                | - - - - - Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| ldap                                    |               |                                                                        |                                   |
|   Enable                                | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   LdapHost                              | f,,           | 10.10.10.31                                                            | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   LdapBasedn                            | f,,           | DC=tbspune,DC=com                                                      | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   LdapFilter                            | f,,           | (&(objectClass=person)(sAMAccountName=?))                              | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   MsadDomain                            | f,,           | AD                                                                     | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   LdapTlsEnable                         | f,,           | false                                                                  | - Y Y Y - Y Y Y Y Y Y Y Y Y Y Y Y |
|   LdapPort                              | f,0,          | 389                                                                    | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| mask                                    |               |                                                                        |                                   |
|   BulkDataSeparator                     | f,,           | #;#                                                                    | Y Y Y Y Y Y Y Y Y - - - - - - - - |
|   DefaultStreams                        | f,,1          | 1                                                                      | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DefaultUpdateThreads                  | f,,1          | 1                                                                      | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DatabaseCommitSize                    | f,,1          | 10000                                                                  | Y - Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DatabaseFetchSizeOverride             | f,,           | true                                                                   | - - - - - - - - - - - - Y Y Y Y Y |
|   DatabaseCommitSize                    | f,1,          | 10000                                                                  | - Y - - - - - - - - - - - - - - - |
|   DefaultMaxMemory                      | f,1024,       | 1024                                                                   | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DefaultMinMemory                      | f,1024,       | 1024                                                                   | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| profile                                 |               |                                                                        |                                   |
|   IgnoreDatatype                        | f,,           | BIT,BOOLEAN,CHAR#1,VARCHAR#1,VARCHAR2#1,NCHAR#1,NVARCHAR#1,NVARCHAR2#1 | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|                                         |               | BINARY,VARBINARY,IMAGE,LOB,LONG,BLOB,CLOB,NCLOB,BFILE,RAW,ENUM,BFILE   |                                   |
|   EnableDataLevelCount                  | f,,           | false                                                                  | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DefaultStreams                        | f,,1          | 1                                                                      | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DataLevelRows                         | f,,1          | 100                                                                    | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DefaultMultiphiAlgorithm              | f,,           | NullValueLookup                                                        | - - - - - - - - - - - - - - - Y Y |
|   OptimizationLevel                     | f,,           | -1                                                                     | - - - - - - - - - - - - - - Y Y Y |
|   DefaultMaxMemory                      | f,1024,       | 1024                                                                   | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DefaultMinMemory                      | f,1024,       | 1024                                                                   | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   DataLevelPercentage                   | f,0,          | 80                                                                     | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
| smtp                                    |               |                                                                        |                                   |
|   Host                                  | f,,           |                                                                        | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   Password                              | t,,           |                                                                        | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   EmailSubject                          | f,,           | Delphix Masking                                                        | Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y |
|   EmailAddressFrom                      | f,,           | noreply@delphix.com                                                    | - Y Y Y - Y Y Y Y Y Y Y Y Y Y Y Y |
|   EmailEnabled                          | f,,           | false                                                                  | - Y Y Y - Y Y Y Y Y Y Y Y Y Y Y Y |
|   EmailEnabled                          | f,,           | true                                                                   | Y - - - Y - - - - - - - - - - - - |
|   EmailAddressFrom                      | f,,           | masking@delphix.com                                                    | Y - - - Y - - - - - - - - - - - - |
|   UserName                              | f,,           | noreply@delphix.com                                                    | - - - - - - - - - Y Y Y Y Y Y Y Y |
|   Port                                  | f,,           | 25                                                                     | - - - - - - - - - Y Y Y Y Y Y Y Y |
|   TlsEnabled                            | f,,           | false                                                                  | - - - - - - - - - Y Y Y Y Y Y Y Y |
|   AuthEnabled                           | f,,           | false                                                                  | - - - - - - - - - Y Y Y Y Y Y Y Y |
+-----------------------------------------+---------------+------------------------------------------------------------------------+-----------------------------------+
Flags (in order):
  * is_sensitive    - this indicates if the data is sensitive and if so it will be displayed with "**" in the API.
  * min_value       - Minimum possible value for this setting. User can't exceed this from the API.
  * max_value       - Max possible value for this setting. User can't exceed this from the API.

 

 

Additional Information