DataFlux Data Management Studio
The main configuration options for Data Management Studio are as follows:
| Option | Purpose | Source | Notes |
|---|---|---|---|
| Base/General Application | |||
| ODBC_INI | Overrides the location of the odbc.ini file | UNIX only. | |
| BASE/AUTH_SERVER_LOC | Location of DataFlux Authentication Server | Optional | If specified, contains the IOM URI to an Authentication Server. The basic format of the Authentication Server IOM URI is iom://<host>:<port>. Where <host> is the name of the computer where the Authentication Server is executing and <port> is the port in which the Authentication Server may be contacted. The port should be specified as 21030 unless the default port for the Authentication Server has been changed. For more information, see the topic "Run a Job with Domain-Enabled ODBC Connections" in the Data Jobs chapter of the DataFlux Data Management Studio User's Guide. |
| BASE/LIBRARY_PATH | Path for Java jar dependencies | Optional | Determined by startup code (DFEXEC_HOME/lib). |
| BASE/PLUGIN_PATH | Path used by all subsystems to find plugins | Optional | Determined by startup code. |
| BASE/EXE_PATH | Path containing executables | Optional | Calculated. |
| BASE/PRIMARY_LICENSE | Primary licensing method | Required by base | Must be set in the configuration file as DATAFLUX or SAS |
| BASE/PRIMARY_LICENSE_LOC | Location of the primary license file or server | Required by base | Must be set in the configuration file. |
| BASE/MACROS_PATH | Path for system macros.cfg file | Optional | If not specified, this file is located in the etc subfolder of the installation folder. |
| BASE/SECONDARY_LICENSE | Secondary licensing method | Required by base | Must be set in the configuration file as DATAFLUX or SAS. |
| BASE/SECONDARY_LICENSE_LOC | Location of the secondary license file or server | Required by base | Must be set in the configuration file. |
| BASE/LOGCONFIG_PATH | Full path to the log configuration file | Optional | Must be set in the configuration file or it defaults to logging.xml in the etc directory. |
| BASE/MESSAGE_PATH | Path to the message directory | Optional | Determined by startup code. |
| BASE/MESSAGE_LOCALE | Error message locale | Optional | If not specified, it is determined from the system locale. |
| BASE/MESSAGE_LEVEL | Error level of messages | Optional | 0 (or not specified) - normal messages; 1 - includes source file and line number in messages. |
| BASE/USER_PATH | Path for user configuration files | Optional | Automatically determined by dfcurver. |
| BASE/REPOS_DDL_LINE_PREFIX | Format the output of the DDL file that is generated for a repository from the Repository Definition dialog | Must be set in the configuration file. | For this macro and BASE/REPOS_DDL_LINE_SUFFIX only, specifying ^p as a value will cause a line break. |
| BASE/REPOS_DDL_LINE_SUFFIX | Format the output of the DDL file that is generated for a repository from the Repository Definition dialog. | Must be set in the configuration file. | For this macro and BASE/REPOS_DDL_LINE_PREFIX only, specifying ^p as a value will cause a line break. |
| BASE/REPOS_SYS_PATH | System path for repository configuration files | Optional | Automatically determined. |
| BASE/REPOS_USER_PATH | User directory for repository configuration files | Optional | Automatically determined by dfcurver. |
| BASE/REPOS_FILE_ROOT | Overrides the root of the repository for URI lookups | Optional | If specified this is used as the root for repository when resolving the URI. In other words, the path in the URI will be concatenated to this path to give the actual filename of a URI. |
| BASE/REPOS_EVENT_WAIT_QUERYMS | Repository event that processes the wait time between processing queries. | Optional | Specifies how frequently in milliseconds to query the repository for changes in the event table. This might need to be changed due to slow servers or IT issues. This is an overriding value and the default is used if no value is set by the user. A setting of -1 disables events from client. |
| BASE/REPOS_EVENT_CLEAN_TIMEMIN | Repository event processor that removes all events older than X minutes before startup. | Optional | |
| BASE/TEMP | Temporary directory | Optional | If not specified, it inherits the value of the TEMP environment variable. |
| BASE/DATE_FORMAT | Specific date formats | Optional | If specified, it is iso8601. |
| BASE/TIME_BASE | Whether to use GMT time | Optional | If this is set to GMT (not the default), the current date returns in GMT. This will affect anything that uses the current date timestamp. |
| BASE/SORTBYTES | Specifies the bytes to use when sorting | Optional | |
| BASE/SORTMERGES | Enables merge during sort | Optional | |
| BASE/SORTTEMP | Specifies the temporary path for sorts | Optional | |
| BASE/SORTTHREADS | Specifies the number of sort threads | Optional | |
| BASE/EMAILCMD | Specifies the command used to send email | Required | Can include %T and %B where %T is replaced with the recipient and %B is a file containing the body of the message; also used by monitor event as well as architect nodes. |
| BASE/FTPGETCMD | Specifies the command used for Ftp Get Functionality | Required |
Should default in the install, as follows:
|
| BASE/FTPPUTCMD | Specifies the command used for Ftp Put Functionality | Required | BASE/FTPPUTCMD |
| BASE/LOGEXCEPTIONS | Exception logging | Optional | Exception logging defaults to off. Set this option to either 1 or a combination of letters. A setting of 1 lists the modules loaded at the time the exception occurred, some information on those modules, and the call stack that caused the error. A setting with letters can include: m = do not show module info, V=turn verbose on, U=install the Unhandled Exception Filter, C=install the continue Exception Filter, f=do not install the first chance exception filter. This must be set before starting the application of interest, as this setting is read only at startup. |
| BASE/TEXTMINE_LITI_LANG_LOCATION | Doc extraction node option | Optional | This is the install location of Teragram liti files. This allows them to be in Teragram provided languages instead of in the DataFlux install. |
| BASE/DMSTUDIO | Studio indicator | Optional | If this option is set to true (value of 1), it indicates that it is using the dmstudio process (not processes started by dmstudio, like dfwfproc for instance). The user should not adjust this or override the value. |
| BASE/APP_VER | Application version number | Optional | Defaults to 2.3. |
| BASE/UPDATE_LEVEL | Application update level | Optional | Defaults to 0. Could be used as a minor revision number. |
| Data Access Component Logging | |||
| DAC/DISABLESYSCATENUM | Enumeration of syscat dsn's | Optional | When set to "yes", 1, or "true," this setting will disable the listing the SYSCAT type DSN's into DSN's that are on that server. |
| DAC/DFTKLOGFILE | DFTK logging | Optional | Filename. |
| DAC/TKTSLOGFILE | TKTS logging | Optional | Filename. |
| DAC/DFTKDISABLECEDA | Disables CEDA support | Optional | "Yes" turns it on. |
| DAC/SAVEDCONNSYSTEM | Location of system-saved connections | Optional | Defaults to DFEXEC_HOME/etc/dsn. |
| DAC/SAVEDCONNUSER | Location of user-saved connections | Optional | Defaults to the user settings folder, the folder where all of the application-specific settings supplied by a user are stored, such as the following path under Windows 7: C:\Users\[username]\AppData\Roaming\DataFlux\dac\9.x |
| DAC/DSN | DSN directory for TKTS dsns | Optional | Path that defaults to DFEXEC_HOME/etc/dftkdsn. |
| DAC/DFTK_PROCESS | Run DFTK out of process | Optional | "Yes" turns it on; off by default. |
| DAC/DFTK_PROCESS_TKPATH | TKTS path for DFTK out of process | Optional | Path that defaults to a core/sasext dir off the executable dir. |
| Address Update (NCOA) (in dfncoa_appcfg.h) | |||
| NCOA/DVDPATH | Path to the unpacked/unZIPped NCOA data | Required | Resides in macros/ncoa.cfg. |
| NCOA/QKBPATH | Path to the QKB used for Address Update name parsing | Required | Resides in macros/ncoa.cfg. |
| NCOA/USPSPATH | Path to the USPS CASS/DPV/etc data | Required | Resides in macros/ncoa.cfg. |
| NCOA/QKBPARSEDEFN | Name of the Addr. Updt. QKB parse definition to use | Optional | Default is "Name (Address Update)". Resides in macros/ncoa.cfg. |
| NCOA/REPOSDSN | Specifies DSN used to connect to the Address Update repository | Required | Is overridden by NCOA/REPOSCONNECTION. One or the other is required. This is typically set by the Address Update Admin utility. Resides in app.cfg. |
| NCOA/REPOSCONNECTION | Specifies the connection string used to connect to the Address Update repository | Required | Overrides NCOA/REPOSDSN. One or the other is required. This is typically set by the Address Update Admin utility. Resides in app.cfg. |
| NCOA/REPOSPREFIX | Table prefix used on the Address Update tables. | Required | This is typically set by the Address Update Admin utility. Resides in app.cfg. |
| NCOA/REPOSTYPE | Specifies the repository type | Required | Valid values are: 0 (Guess), 1 (ODBC), 2 (DFTK). If the value is 0, the node attempts to determine the type from the connection string. This is typically set by the Address Update Admin utility. Resides in app.cfg. |
| NCOA/DFAV_CACHE_SIZE | Set verify cache percentage. | Optional | The higher the value the more data is cached, the faster the processing, the more memory used. The default is 0. Resides in macros/ncoa.cfg. |
| NCOA/DFAV_PRELOAD | Set verify preload options. | Optional | Valid values are "ALL" or an empty string. Using "ALL" requires a large amount of memory. Resides in macros/ncoa.cfg. |
| Pooling | |||
| Note that for puddle options, the name of the puddle is placed after 'POOLING/', for example, POOLING/WFEJOB/MAXIMUM_PROCESSES. If no puddle name is specified, it is globally applied to all puddles. Here are a few puddles: WFEJOB - batch jobs on DMServer, WFESVC - Process services on DMSERVER, APISVC - DFAPI services (in the works) | |||
| POOLING/CHILD_MAXIMUM_LAUNCHES | Throttling for launches | Optional | When specified, the number of concurrent child process launches is limited by this value. If the current child launch request exceeds the specified value, the launch will wait until the number of launching processes is below the specified value. If zero or not specified, there is no limit of concurrent child launches. |
| POOLING/MAXIMUM_PROCESSES | Maximum number of concurrent pooled processes | Optional | If 0, the number of concurrent pooled processes is unlimited. Default is unlimited (previously was 10). If POOLING/GET_PROCESS_TIMEOUT is set, it will wait for that amount of time to get a new process if it needs one. This is a puddle option. |
| POOLING/GET_PROCESS_TIMEOUT | Acquire process timeout | Optional | Default is no timeout. Specifies the length of time, in seconds, the process requester should wait for a process to become available. If zero, the requester will wait indefinitely. The acquire process timeout is in terms of the acquisition of a process and the process pooling handshaking. It does not consider the time required by the requester to complete application level initialization. This is a puddle option. |
| POOLING/IDLE_TIMEOUT | Idle process timeout | Optional | Default is 0. Specifies the length of time, in seconds, a process remains idle before it is terminated. If zero, idle processes are not terminated. This is a puddle option. |
| POOLING/MAXIMUM_ERRORS | Maximum number of pooled process errors before process is terminated | Optional | Default is 0 (never terminate it). This controls how many times a process can fail (when it is reused for something else) before it is terminated. This is a puddle option. |
| POOLING/MAXIMUM_USE | Maximum number of pooled process uses before process is terminated. | Optional | Default is 0 (unlimited). The maximum number of times a pooled process may be used. After the pooled process has been used the specified number of times, it is terminated. This is a puddle option. |
| Process Flow | |||
| WFE/CANCEL_TIMEOUT | Amount of time to give remote processes to cancel in milliseconds | Optional | When user hits cancel the amount of time to wait for remote nodes to exit gracefully before killing them. |
| WFE/MAX_EMBED_COUNT | Maximum embedding level | Optional | Defaults to 100. Maximum level of embedding for process nodes. Helps prevent runaway recursion when recursively embedding jobs. |
| WFE/MAX_EMBED_COUNT | Maximum threads | Optional | Default unlimited. Allows the user to allocate a number of threads for running process nodes. Each thread runs a node (even when running out of process). If this count is reached, nodes scheduled for execution will queue up. |
| WFE/ENGINE_THREAD_LIMIT | Specifies the thread pool limits for the workflow engine. | Optional | Use this setting to limit the number of engine threads. The default is 0 meaning unbounded, which will defer to the system for the thread pool limits. The optimal setting is the number of processors + 1. |
| WFE/STATUS_FREQUENCY | How frequently to update status | Optional | This is milliseconds, the default is 250. This is how long to wait before obtaining status from a remote node. Setting to -1 disables polling for status (which may yield better performance). |
| Profile | |||
| PROF/DEBUG_MODE | Frequency distribution engine debug mode | Optional | Possible values include 0 not debug mode or 1 debug mode: default is not debug mode. The log is located at C:\Documents and Settings\<USER ID>\Local Settings\Temp. |
| PROF/PER_TABLE_BYTES | Frequency distribution engine per table bytes | Optional | Any numeric value. Default is -1 (frequency distribution engine default). |
| PROF/LOCK_RETRIES | SQLite repository connection attempts | Optional | Specifies the number of times to retry SQLite repository connection when a connect attempt times out or -1 to retry until a connection is established. Used by explorer too. |
| QKB | |||
| QKB/PATH | Path to QKB | Required by QKB products | Path is set to the default QKB defined in application. |
| QKB/SURFACEALL | Surfaces all parse definitions | Optional | Default is NO. Note that the application start-up creates a blue fusion pool that sets the option for all consumers (Profile, Explorer and Nodes) with the exception of the Expression Engine, which continue to have its own initialization. |
| QKB/COMPATVER | Denotes which compatible version to use when interacting with QKB | Optional | Possible values: dfpower82, dmp21, and dmp22. Default: dmp22. Note that the application start-up creates a blue fusion pool that sets the option for all consumers (Profile, Explorer and Nodes) with the exception of the Expression Engine, which continue to have its own initialization. |
| QKB/ALLOW_INCOMPAT | Allow use of incompatible Quality Knowledge Base definitions | Optional | Default is NO. Note that the application start-up creates a blue fusion pool that sets the option for all consumers (Profile, Explorer and Nodes) with the exception of the Expression Engine which continue to have its own initialization. |
| QKB/ON_DEMAND | Loads QKB definitions on demand | Optional | Default is YES. Note that the application start-up creates a blue fusion pool which sets the option for all consumers (Profile, Explorer and Nodes) with the exception of the Expression Engine, which continue to have its own initialization. |
| CUSTOMIZE/DISABLE_FILE_NOTIFICATIONS | Temporarily disables notifications | Optional | Read by ui.cfg when Customize starts. When QKB developers make numerous small changes to files in an editor while Customize is open, Customize sends a notification that warns that the file being changed and provides a list of all the definitions that are affected. To temporarily disable these notifications, edit ui.cfg by adding CUSTOMIZE/DISABLE_FILE_NOTIFICATIONS=1. |
| Architect Client (UI) settings | |||
| ARCHITECT/AutoPassThru | Client option to set mappings | Optional | Maintained by client; choices are 0 (target), 1 (Source and Target), and 2 (All). |
| Architect nodes, etc (Defined in ids.h) | |||
| CLUSTER/BYTES | Specifies the bytes use when clustering | Optional | |
| CLUSTER/LOG | Specifies whether a clustering log is needed | Optional | |
| CLUSTER/TEMP | Specifies the cluster temporary path | Optional | |
| FRED/LOG | Specifies whether a FRED log is needed | Optional | |
| JAVA/CLASSPATH | Specifies the Java classpath | Optional | |
| JAVA/DEBUG | Optional | ||
| JAVA/DEBUGPORT | Optional | ||
| VERIFY/USELACS | Enables or disables the LACSLink processing | Optional | Locatable Address Conversion System (LACS). |
| VERIFY/USEELOT | Enables or disables the eLOT processing | Optional | |
| VERIFYINTL/CFG | Verifies the international addresses | Required by international verification | Path maintained by component installation. |
| VERIFYWORLD/CONFIGFILE | Specifies the path to the SetConfig.xml file that is used by the Address Verification (World 2) data job node. Use this option to change the default location of this file. | Required by Address Verification (World 2) data job node | For more information about this file, see the Data Management Studio documentation for the Address Verification (World 2) node. |
| VERIFYWORLD/DB | Specifies the Platon data path | Required for Platon | Path maintained by component installation. |
| VERIFYWORLD/UNLK | Specifies the Platon library universal unlock code | Required for Platon | Path maintained by component installation. |
| WEBSERVICE/CONFIG_FILE | Specifies a user-defined configuration file for the Web Service node and the HTTP Request node. This file can be used to increase the time-out value, for example. | Optional | For more information about the user-defined configuration file, see the FAQ topic: "What Can I Do About Time-Out Errors in Data Jobs with the Web Service Node or the HTTP Request Node?" in the DataFlux Data Management Studio: User's Guide. |
| dfIntelliServer | |||
| DFCLIENT/CFG | Used for dfIntelliServer | Required | Maintained by dfIntelliServer installation; typical location is 'C:\Program Files\DataFlux\dfIntelliServer\etc\dfclient.cfg; modify the dfclient.cfg file to point to the server and port. |
| Repository | |||
| REPOS/CREATE_SPEC_PATH | Specifies how to create the repository table or index | Optional | This specification provides a means of configuring the commands to create tables and indexes in the repository. |
| REPOS/FORCE_FILE_BASED | Repository SQLite usage | Optional | If set to true all SQLite access will go through dfsqlite instead of DAC. |
| REPOS/LOCK_RETRIES | Specifies the number of attempts to connect to a SQLite repository | Optional | Number of times to retry SQLite repository connection when a connect attempt times out or -1 to retry until a connection is established. |
| REPOS/TABLE_LIST_PATH | Repository XML table definition | Optional | The directory that should contain XML files for any tables the repository library should add on creation or update. If set we look in here for XML files that will contain repository table definitions, if not set we look in DFEXEC_HOME/etc/reposcreate. |
| Other | |||
| EXPRESS_MAX_STRING_LENGTH | Specifies the maximum size of strings declared in expression nodes | Optional | Default maximum length of any string in this node is 5,242,880 bytes (5MB). This enables specifying a larger value in bytes. If performance issues arise, the suggested setting is 65536 bytes. |
| EXPRESSION/UDFDIR | Specifies where to look for UDF files | Optional | If not specified, UDF files will be sought in installationdir/etc/udf. |
| JAVA/COMMAND | Command used to launch Java | Optional | Default is java. This is the command used to launch the java proxy process. The Java command must be compatible with launching from the command line. Here are some examples: JAVA/COMMAND = javaJAVA/COMMAND = java -Djavax.net.ssl.trustStore=C:\Store\jssecacertsJAVA/COMMAND = java -Djavax.net.ssl.trustStore="C:\Cert Store\jssecacerts"JAVA/COMMAND = "C:\Program Files\Java\jre6\bin\java" |
| MDM/REPOSITORY_ROOT_FOLDER | Optional | Name/location of the root folder for mdm within a repository. This one allows for the “foundations/master_data” to be overwritten by the end user when putting the contents of [INSTALL_ROOT]/share/mdm into a repository. | |
| STEPENG/PROFILEBYNODE | Specifies the performance profiler by node instance. | Use only for design and testing. Do not use in a production environment | When set to Yes, this gives you each node instance and how many milliseconds were spent on each of three operations (prepare, pre-execute, execute), and how many times each was entered. The ID will correspond to the iid field in the XML file for the job, and will include the job name so you can see embedded jobs.
To turn on the functionality, go into your configuration files. To profile realtime services, update dfwsvc.cfg. To profile batch jobs, update dfwfproc.cfg. To profile from studio, update ui.cfg. To profile all three, update app.cfg. The results are written to the log under the DF.RTProfiler heading at trace level. An example of the output is: NX,inner2.ddf,1,0,5 where the values represent action type or operation (either NX - cumulative time spent processing rows, PR - time preparing, or PX - time pre-executing), job name, instance (iid field in the XML file), milliseconds, and entries (the number of times you've entered that code). |
| STEPENG/PROFILEBYTYPE | Specifies the performance profiler by node type. | Use only for design and testing. Do not use in a production environment | When set to Yes, this setting provides you each node type along with how many milliseconds were spent on each of three operations (prepare, pre-execute, execute), and how many times each was entered.
To turn on the functionality, go into your configuration files. To profile realtime services, update dfwsvc.cfg. To profile batch jobs, update dfwfproc.cfg. To profile from studio, update ui.cfg. To profile all three, update app.cfg. The results are written to the log under the DF.RTProfiler heading at trace level. An example of the output is: NX,ARCHITECT_EMBEDDED_JOB,0,5 where the values represent action type or operation (either NX - cumulative time spent processing rows, PR - time preparing, or PX - time pre-executing), node type, milliseconds, and entries (the number of times you've entered that code). |
| SAP_LIBPATH | Specifies the location of SAP RFC libraries on UNIX only. | Optional | These shared libraries are installed to support the SAP Remote Function Call node, a data job node in Data Management Studio. For more information, see "Installing Support for the SAP RFC Node" topic in the DataFlux Data Management Studio Installation and Configuration Guide. |
|
Documentation Feedback: yourturn@sas.com
|
Doc ID: dfU_Config_DMStudio.html |