Skip to main content
Delphix

Application Settings API (KBA4539)

 

KBA

KBA# 4539

Applicable Delphix Versions 

This applies to Masking Engine 5.2 and onwards. Note that this document has been updated to include 5.3.6.0.

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 |
|                                         |           |                                           | 2  3  3  3  3  3  3  3 |
| setting_group / setting_name            | flags     | value                                     | -  0  1  2  3  4  5  6 |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| algorithm                               |           |                                           |                        |
| * AbortOnSegmentMappingPatternFailure   | t,f,,     | false                                     | -  Y  Y  Y  -  -  -  - |
| * DefaultNonConformantDataHandling      | t,f,,     | DONT_MASK^DONT_MASK$|^FAIL$               | -  -  -  -  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| analytics                               |           |                                           |                        |
| * CpuTime                               | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * LoadAverage                           | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * MemoryUsage                           | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * OffCpu                                | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * OnCpu                                 | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * StepPerformance                       | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * TcpUsage                              | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| async                                   |           |                                           |                        |
| * HistoryExpirationDays                 | t,f,0,    | 30                                        | -  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| database                                |           |                                           |                        |
| * DB2zDateFormat                        | t,f,,     | yyyy-MM-dd                                | -  -  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| engineSync                              |           |                                           |                        |
| * DocPurgePeriod                        | t,f,1,    | 24                                        | -  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| fileUpload                              |           |                                           |                        |
| * PurgePeriod                           | t,f,0,    | 24                                        | -  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| general                                 |           |                                           |                        |
| * AllowPasswordResetRequest             | t,f,,     | true                                      | Y  Y  Y  Y  Y  Y  Y  Y |
| * EnableMonitorRowCount                 | t,f,,     | true                                      | Y  Y  Y  Y  Y  Y  Y  Y |
| * JobOutputCleanerPeriodIntervalSeconds | t,f,,     | 86400                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * MaximumQueuedJobs                     | t,f,,     | 0                                         | -  Y  Y  Y  Y  Y  Y  Y |
| * PasswordCount                         | t,f,0,    | 3                                         | Y  Y  Y  Y  Y  Y  Y  Y |
| * PasswordResetLinkDuration             | t,f,,     | 5                                         | Y  Y  Y  Y  Y  Y  Y  Y |
| * PasswordTimeSpan                      | t,f,0,    | 23                                        | Y  Y  Y  Y  Y  Y  Y  Y |
| * PasswordTimeSpan                      | t,f,0,    | 0                                         | -  -  -  -  -  -  -  - |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| job                                     |           |                                           |                        |
| * JobLoggingLevel                       | t,f,,     | Basic^Basic$|^Detailed$                   | -  -  -  -  -  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| ldap                                    |           |                                           |                        |
| * Enable                                | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * LdapBasedn                            | t,f,,     | DC=tbspune,DC=com                         | Y  Y  Y  Y  Y  Y  Y  Y |
| * LdapFilter                            | t,f,,     | (&(objectClass=person)(sAMAccountName=?)) | Y  Y  Y  Y  Y  Y  Y  Y |
| * LdapHost                              | t,f,,     | 10.10.10.31                               | Y  Y  Y  Y  Y  Y  Y  Y |
| * LdapPort                              | t,f,0,    | 389                                       | Y  Y  Y  Y  Y  Y  Y  Y |
| * LdapTlsEnable                         | t,f,,     | false                                     | -  Y  Y  Y  Y  Y  Y  Y |
| * MsadDomain                            | t,f,,     | AD                                        | Y  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| mask                                    |           |                                           |                        |
| * BulkDataSeparator                     | t,f,,     | #;#                                       | Y  Y  Y  Y  Y  Y  Y  Y |
| * DatabaseCommitSize                    | t,f,1,    | 10000                                     | Y  Y  Y  Y  Y  Y  Y  Y |
| * DefaultMaxMemory                      | t,f,1024, | 1024                                      | Y  Y  Y  Y  Y  Y  Y  Y |
| * DefaultMinMemory                      | t,f,1024, | 1024                                      | Y  Y  Y  Y  Y  Y  Y  Y |
| * DefaultStreams                        | t,f,1,    | 1                                         | Y  Y  Y  Y  Y  Y  Y  Y |
| * DefaultUpdateThreads                  | t,f,1,    | 1                                         | Y  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| profile                                 |           |                                           |                        |
| * IgnoreDatatype                        | t,f,,     | BIT,BOOLEAN,CHAR#1,VARCHAR#1,VARCHAR2#1,  | Y  Y  Y  Y  Y  Y  Y  Y |
|                                         |           | NCHAR#1,NVARCHAR#1,NVARCHAR2#1,BINARY,    |                        |
|                                         |           | VARBINARY,IMAGE,LOB,LONG,BLOB,CLOB,NCLOB, |                        |
|                                         |           | BFILE,RAW,ENUM,BFILE                      |                        |
| * DataLevelPercentage                   | t,f,0,    | 80                                        | Y  Y  Y  Y  Y  Y  Y  Y |
| * DataLevelRows                         | t,f,1,    | 100                                       | Y  Y  Y  Y  Y  Y  Y  Y |
| * DefaultMaxMemory                      | t,f,1024, | 1024                                      | Y  Y  Y  Y  Y  Y  Y  Y |
| * DefaultMinMemory                      | t,f,1024, | 1024                                      | Y  Y  Y  Y  Y  Y  Y  Y |
| * DefaultStreams                        | t,f,1,    | 1                                         | Y  Y  Y  Y  Y  Y  Y  Y |
| * EnableDataLevelCount                  | t,f,,     | false                                     | Y  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+
| smtp                                    |           |                                           |                        |
| * EmailAddressFrom                      | t,f,,     | noreply@delphix.com                       | -  Y  Y  Y  Y  Y  Y  Y |
| * EmailAddressFrom                      | t,f,,     | masking@delphix.com                       | Y  -  -  -  -  -  -  - |
| * EmailEnabled                          | t,f,,     | false                                     | -  Y  Y  Y  Y  Y  Y  Y |
| * EmailEnabled                          | t,f,,     | true                                      | Y  -  -  -  -  -  -  - |
| * EmailSubject                          | t,f,,     | Delphix Masking                           | Y  Y  Y  Y  Y  Y  Y  Y |
| * Host                                  | t,f,,     |                                           | Y  Y  Y  Y  Y  Y  Y  Y |
| * Password                              | t,t,,     |                                           | Y  Y  Y  Y  Y  Y  Y  Y |
+-----------------------------------------+-----------+-------------------------------------------+------------------------+

Flags (in order):
  * is_user_enabled - this indicates if the application setting can be modified by the user using the API.
  * 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