USYS$UD6_PARAMS Settings Reference

The settings listed here are commonly used, though some of them are mostly used by older customers who are using these settings to preserve 'old' functionality from previous versions of UD6

We provide some simple guides in the installation section and also in the latest What's New section.

Our support team can assist you with recommendations based on your goals.

See How To guide for how to use UD6 with GitHub including examples of how to use the 'collaborate github' driver setting for both GitHub Enterprise and GitHub Cloud.

what it writes to the 'constants' trigger:

;# --------- BEGIN AUTO GENERATED SECTION - WRITTEN BY UD6 DURING 
WRITE/COMPILE ----------
#define form_entities = <$UD6_FORM_ENTITIES>
#define paintedfields = <$UD6_PAINTEDFIELDS>
#define ud6_build_no = "<$UD6_BUILD_NO>"
#define ud6_pc_name = "<$UD6_PC_NAME>"

what you 'see' in the 'defines' trigger in Uniface 9:

;# --------- BEGIN AUTO GENERATED SECTION - WRITTEN BY UD6 DURING 
WRITE/COMPILE ----------
#define form_entities = FIRST.AAAA
#define paintedfields = THREE.FIRST,FOUR.FIRST,DUMMY_BUTTON.FIRST
#define ud6_build_no = "12341234"
#define ud6_pc_name = "JOES-PC-123"
;# --------- END AUTO GENERATED SECTION - WRITTEN BY UD6 DURING WRITE/COMPILE -
---------

The value for ud6_build_no comes from the environment variable UD6_BUILD_NO

   set UD6_BUILD_NO=12341234

   echo %UD6_BUILD_NO%

Note: The UD6 driver only ever checks the PRIMARY key (key number 1) for uniqueness, not other ‘candidate’ keys.

This setting is used by default in UD6 2.1.

The FILE setting can be used to set the TIMESTAMP field of UFORM to the value of the last modification timestamp on the file.

Note: The 'all' setting removes NOTIMESTAMP from ALL entities, not just the ones listed.

For compatibility with UD6 3.1 use:

USYS$UD6_PARAMS=notimestamp all

If a number is defined as Data Type:N / Interface:N, UD6 uses a default size of 20 characters (ie, the same as interface:N20), whereas the Uniface Oracle driver uses a size of 4. For compatibility this can be set by the user.

Valid values are from 1 to 32, default or disable. The setting for 'default' is the Uniface default numeric (N0 for Uniface 8 and later, or N20 for Uniface 7). Setting numforce disable disables numerics and forces Uniface to use an ASCII character string for numerics instead (C) and the string is not padded with additional zeros or spaces.

1:ASCII Boolean (0|1)
2:ASCII Boolean (F|T)
3:ASCII Boolean (N|Y)
4:Binary Boolean (0|1)
5:Binary Boolean (0|-1)

1:ASCII Date dd-mmm-yyyy
2:ASCII Date yyyymmdd
3:ASCII Date ddmmyyyy
4:ASCII Date yymmdd
5:ASCII Date ddmmyy
6:Binary Date yymd
7:Binary Date dmyy
8:Binary Date ymd
9:Binary Date dmy
10:Binary Date yymmdd
11:Binary Date ddmmyy
12:ASCII Date mm/dd/yyyy
13:ASCII Date yyyy-mm-dd

1:ASCII Time hh:nn:ss
2:ASCII Time hhnnss
4:Time hh:nn:ss
5:Time hh:nn:ss.s
6:Time hh:nn:ss.ss

1:SYBASE linear four-byte Date and four-byte Time
2:RMS linear Datetime
3:ASCII Date ddmmyyyy Time hh:nn:ss
4:ASCII Date ddmmyyyy Time hhnnss
5:Ingres Date dd-mmm-yyyy Time hh:nn:ss
6:ORACLE internal Datetime format
7:SYBASE ASCII Date mm/dd/yyyy hh:nn:ss.tt
8:ASCII Datetime yyyymmddhhnnss (like 2)
9:SYBASE binary Small Datetime
10:ASCII Datetime yyyy-mm-dd hh:nn:ss
11:Rdb date yyyy-mm-dd Time hh:nn:ss
13:Rdb date yyyy-mm-dd Time hh:nn:ss.ss

With this option set in conjunction with the ofields option and file, the UD6/CMtool passes the contents of the FORMPIC of UFORM to the Form ToolKit for translation to and from XML.

This produces a human-readable form paint tableau.

Component source code will be updated on write. This setting incurs a performance penalty, so should only be used when required.

This setting will only be used if the SINGLE INTERPRET option is switched on (on by default). If the setting NOTRX is used then the setting MMF BINARY must also be used to enable GOLD conversion.

In the DEMO driver this option is limited to processing only 10 rows.

When used in this mode, the UD6/CMtool driver reads delimited text files (e.g.: comma separated format) and writes XML files.

For this to function, you need to name the file TABLENAME.XML, and alter the OVERFLOWS file (which is in the Uniface bin directory by default) so that it contains a line for the (overflow) table. Eg:

            OCSVDATA:LONG_FIELD+

See the section How to use the driver to load CSV files with LONG fields for more information.

See the section How to use the driver to load CSV files with LONG fields for more information.

Note: This setting should be used in conjunction with the USYS$UD6_PARAMS=mmf binary, setting if used to store the Uniface repository.

NOTE: You cannot use UD6/CMtool to store the UGLYPH or UCSDIA entities when ‘notrx’ is specified. This may cause unstable behavior in the driver.

Since GLYPHS usually remain fairly stable in the life cycle of a software development, March Hare recommend storing these using the DB3 driver, which will generate 2 files plus indexes for the entire table. These files can then be controlled using your CM or VM tool.

If this setting is not used when NOTRX is enabled, then Bold, Gold and Frame characters will not be converted to XML. See also GOLD and BOLD settings.

The FONT setting sets the default Uniface font (Font 1=51). If the encoding is ISO-8859-1, then characters 160-254 are set to Uniface font 1, regardless of the setting for FONT. The FONT information for individual characters can be specified in the nlsn file (where n is the number of the codepage, usually 0).

The ENCODING setting sets the default encoding for the XML and XSL files, and is used when setting the default FONT, see above for more information.

This setting should be the same as the MAXFILES setting in the [SETTINGS] section of the assignment file.

NOTE 1: This may not be set to a value larger that what is supported by your operating environment. Details of how you can determine the correct value for your operating environment are in the UD6 Installation Guide.

NOTE 2: This feature increases the speed of similar information being frequently accessed (eg: Model definitions, templates etc), by maintaining it in memory. The larger the value for mmf files the more files that will be kept open and in memory. UD6 assumes that there will be enough available memory to cache the number of files you request. If there is insufficient memory UD6 will abort and the IDF may crash. The amount of memory per file varies, but is typically around 24K per mmf file on Windows NT 4..

The NODENY setting can either specify that ALL write failures are ignored, or only on certain tables (as specified in the file declared by FILENAME filename), or the user is given a choice at run-time (DIALOG).

Note: The DIALOG setting is only available on Windows, and when Polyserver is NOT being used. Since March Hare recommend the use of Polyserver with UD6, there are very few installations where the Dialog setting is useful.

This setting is most often used because during the compilation of a form, Uniface writes to it the last compiled date/time, and also updates the descriptor information. The NODENY option tells UD6 to not report Access Denied messages on Update/Delete/Write for joined files.

Note: Since the descriptor information is stored in the form.xml file, the resulting .frm file may not be able to execute due to ‘old’ descriptor information.

To avoid this store the descriptors either in a different data format (eg: DB3) or in a different XML file (specified using the joins configuration file). e.g (assignment file).:

[ENTITIES]
USIMPL.DICT   $DB3:USIMPL.*
USOPER.DICT   $DB3:USOPER.*
USISPARM.DICT $DB3:USISPARM.*
USPARM.DICT   $DB3:USPARM.*
USIOPER.DICT  $DB3:USIOPER.*
USIPARM.DICT  $DB3:USIPARM.*
USSPEC.*      $DB3:USSPEC.*

The next most common use is to ignore spurious write/update requests from the IDF on certain tables, when you are just browsing, but the IDF has inadvertently modified the form causing a write to occur.

The FILENAME filename may be any you wish, and is located in the current working directory unless otherwise specified in the assignment file. E.g.:

USYS$UD6_PARAMS=nodeny dialog filename c:\nodenys.txt

The format of the NODENYS file is:

; Write failures to these entities are ignored
:UFORM:
:UCTABLE:
:UCSCH:

01-Feb-2001T12:55:15.

If a temporary file cannot be created in the temp directory for any reason, the driver may unexpectedly fail (e.g.: out of disk space).

This command forces the driver to reload the list of currently renamed files (useful for when a configuration manager is being used to specify that a file is ‘checked out’).

This command forces the driver to reload the default font mapping from the nls0 configuration file.

This command forces the driver to release all cached open file handles. SCM tools like PVCS require that a file not be open, even for READ-ONLY access before they can be checked back in. Use this command from the SQL workbench with the data path set to UD6 to release these open files.

If you have just made changes to a component, and want the file ‘unlocked’, the correct sequence should be:

1) close current component
2) open another component
3) open SQL workbench and set path to UD6 and enter the SQL/DML command CLEANMMF and press the 'SQL' button.

The CLEANMMF AUTO or CLEANMMF HARD AUTO option may be used in the ASN file to instruct the driver to close files as soon as possible. This option may negatively impact performance.

This allows each developer or workgroup to have their own ‘list’. Files checked out by other developers or workgroups will not be seen, so therefore the ‘reference copy’ of those files will be used.

The default directory/filename is ‘inuse’ in the current working directory.

The shadow-folder setting specifies which directory is the ‘root’ for the read-only copy of the files (from the workstation). If for example, all workstations mount the NT Share on v:\ then the setting would be :

            shadow-folder v:\

This setting must agree with the directory names specified in the JOINS file, e.g.:

    UFORM:ULABEL:ULABEL::v:\components\*
    UCTABLE:U_VLAB,U_TLAB:U_VLAB,U_TLAB::v:\tables\*
    UCGROUP:U_GLAB,U_VLAB:U_GLAB,U_VLAB::v:\sub-types\*

The sandpit setting specifies which directory is the ‘working directory’ for the checkout out copy of the files (on the workstation). For this reason each developer would typically have their own personal ASN file set to their own sandpit. If the developer has several sandpits, and needs to switch between them, they can use the ‘sandpit’ command from the SQL workbench (set Path to UD6).

            sandpit c:\sandpit

Within this directory, the checked out files must still exist in the same ‘tree’, e.g.:

    C:\sandpit\components\basu0011.xml
    C:\sandpit\tables\csaaa-customer.xml
    C:\sandpit\sub-types\customer-csaaa-customer.xml

If the source code control tool you are using supports the use of triggers, using the triggers to activate the add2list and del2list utilities to maintain the INUSE file will provide significantly greater performance than use of the SANDPIT setting.

The performance parameter is a bitwise value, where each bit sets a performance optimisation ON. The value zero (0) turns all performance optimisation off. See performance parameter for more information.

If there are compatibility problems with later releases of the IDF it is advisable to turn this setting off by specifying ‘performance 0’ in the assignment file.

The setting ‘performance’ is the same as specifying ‘performance 127’ which is also the default.

Once you have created your XML files by loading your repository into UD6 you should not modify this setting, as most of the values effect the names of tables via the joins mechanism.

With the INTERPRET option the TRX encoding is converted to readable format.

This is a functional and performance enhancement.

Entity closing tags must finish in an end of line character, eg: </XMLuform>

not: </XMLuform><XMLuform><label>PM0001</label>

March Hare recommend this option be disabled if you experience performance limitations. However if you are satisfied with the performance of your system (e.g.: using polyserver), then it may be used.

See the Installation guide section on the Ofields file.

NOTE: It is not possible to change this setting from IE5 to W3C. If your Schema.XML files were generated using one setting, do not change the setting to the alternative. This can cause unreliable behaviour and possibly crashes in the driver. Delete the existing Schema.XML files before changing this setting from IE5 to W3C or W3C to IE5 (IE5 schemas have the tag <Schema ...> wheras W3C schemas have the tag <schema ...>).

Specify IE5, to produce an XSL file compatible Microsoft Internet Explorer 5 or greater. Use W3C to produce an XSLT file compatible with a browser that supports W3C standard XSLT files.

The W3C setting gives preliminary support for the W3C XSLT standard.

This setting will only be used if the SINGLE INTERPRET option is switched on (on by default). If the setting NOTRX is used then the setting MMF BINARY must also be used to enable BOLD conversion.

March Hare recommend this option be disabled if you experience performance limitations. However if you are satisfied with the performance of your system (e.g.: using polyserver), then it may be used.

See the Installation guide section on the Ofields file.

The format of the tag is

<trigger name="name">text</trigger>

NOTE: When you try and view the files with a web browser NOT from within CVSWEB, the load of these external files will fail. The opposite behavior is true if this is not set.

For backward compatibility with UD6 1.02 and earlier use:

USYS$UD6_PARAMS=newsubtypes disable

For backward compatibility with UD6 1.03 Beta 2 use:

USYS$UD6_PARAMS=newsubtypesb2 enable

For backward compatibility with UD6 1.03 and earlier (with clustering using just one pattern for all object types) use:

USYS$UD6_PARAMS=newglobals disable

For compatibility with UD6 3.1 use:

USYS$UD6_PARAMS=newglobals v2

With the MODELNAME as the first key, it's possible to store DTD's in sub-directories by MODELNAME

Note: you must also change the 'joins' file. There are comments in the joins file to explain the change.

For compatibility with UD6 3.1 use:

USYS$UD6_PARAMS=newdtd enable

With the language (ULAN) as the first key, it's possible to store UMSG's in sub-directories by language (ULAN)

With the library (UVAR) as the first key, it's possible to store UMSG's clustered by library name (UVAR)

Note: you must also change the 'joins' file. There are comments in the joins file to explain the change.

newmsg v2: (one message per file, files grouped by language)
joins: UMSG:UVAR,ULABEL,ULAN:UVAR,ULABEL,ULAN::.\sources\globals.dir\messages.dir\*
result: sources\globals.dir\messages.dir\NL.dir\HYBD-A0001.XML

newmsg enable: (one library/language per file)
joins: UMSG:UVAR,ULABEL:UVAR,ULABEL,ULAN::.\sources\globals.dir\messages.dir\*
result: sources\globals.dir\messages.dir\HYBD-NL.XML

newmsg disable: (one message per file)
joins: UMSG:UVAR,ULABEL:UVAR,ULABEL,ULAN::.\sources\globals.dir\messages.dir\*
result: sources\globals.dir\messages.dir\HYBD-A0001.XML

For compatibility with UD6 3.1 use:

USYS$UD6_PARAMS=newmsg enable

This parameter can cause performance issues.

Note: you must also change the 'joins' file. There are comments in the joins file to explain the change.

For compatibility with UD6 3.1 use:

USYS$UD6_PARAMS=newrels disable

Improves efficiency of allocating small amounts of memory. The HPUX memory allocation algorithm allocates all blocks below the size of size in large groups, then doles them out very quickly. The default value for maxfast is zero.

Eg: USYS$UD6_PARAMS=mallopt mxfast 64 nlblks 200

WARNING: if the combination of NLBLKS and MXFAST is too high, the UD6 driver may fail with -1016 (cannot create buffer this size) errors.

Improves efficiency of allocating small amounts of memory. The HPUX memory allocation algorithm allocates all blocks below the size of MALLOPT MXFAST in large groups each containing size blocks. Numlblks must be greater than 1. The default value for numlblks is 100.

Eg: USYS$UD6_PARAMS=mallopt mxfast 64 nlblks 200

WARNING: if the combination of NLBLKS and MXFAST is too high, the UD6 driver may fail with -1016 (cannot create buffer this size) errors.

Indicates that the HPUX operating system should not swap out the DATA area of the UD6 driver. Requires that the user running IDF or Polyserver has the MLOCK privelege.

Eg: USYS$UD6_PARAMS=plock

Specifies a minimum and maximum working set size for the process.

MIN The virtual memory manager attempts to keep at least this much memory resident in the process whenever the process is active.

MAX virtual memory manager attempts to keep no more than this much memory resident in the process whenever the process is active and memory is in short supply.

Eg: USYS$UD6_PARAMS=working set min 16384 max 32768

NOTE: both minimum and maximum must be set, the process must had PROCESS_SET_QUOTA access rights and SE_INC_BASE_PRIORITY_NAME privilege (Administrators and Power Users groups generally have this privilege).

The current working set minimum and maximum are displayed in the message frame if the listoptions setting is used.

If you wish to store the contents of another entity in UD6 (eg: a user defined menu system), and those tables allow spaces in the primary key name - you must specify the table names with this setting.

Eg: USYS$UD6_PARAMS=tableswithspaces ;menu_choice;menu_set;, listoptions, etc etc

Version Control should be used to prevent more than one developer gaining write access to the same file at the same time - however the EXCLUSIVEWR option is provided for situations where this is not practical.

USYS$UD6_PARAMS=exclusivewr, cleanmmf hard auto, optlocking disable

On Microsoft Windows platforms the file is exclusively locked. Other users will not be able to read or write the file while it is locked. If another user or process attempts to access a locked file and their copy of UD6 has cached the contents of the file and the file has not yet changed then that user may still be able to read the file.

On Unix platofrms the lock is a write-only lock and other users may still read the file.

Default is ENABLE for Uniface Six and Seven and DISABLE for Uniface Eight.

Set the last modified time of the filename to the current time.

This setting enables the automatic generation of a Makefile. A Makefile is a standard file that specifies the relationships of various "source code" files to an object code (compiled) file. Eg: the compiled form TEST.frm is made up of the source TEXT.xml and tables.dir/CUSTOMER.xml. This allows a tool such as MAKE to automatically re-compile forms when the source (entities etc) changes.

The WAIT setting (default) causes UD6 to keep trying to gain write access to the Makefile (wait until write access is permitted). If NOWAIT is specified then changes will not be written to the Makefile and may result in incomplete build management.

FILENAME should be the last setting specified. This is the full name and PATH of the Makefile. The default in Windows is makefile.mak and Unix is Makefile. The file is created in the current directory by default.

The CHECKOUT command is not currently supported but will enable a future version of UD6 to automatically include a "checkout" line before the compile line in the Makefile. The GROUP feature allows UD6 to group the components by type so you have different make targets for services and reports and DTD's etc. The full list of make targets are:

      ALL
      ALL_SVCS
      ALL_RPTS
      ALL_ESVS
      ALL_SSVS
      ALL_FRMS
      ALL_USPS
      ALL_DSPS
      ALL_DTDS
      ALL_APSS
      CLEAN
      CLEAN_SVCS
      CLEAN_RPTS
      CLEAN_ESVS
      CLEAN_SSVS
      CLEAN_FRMS
      CLEAN_USPS
      CLEAN_DSPS
      CLEAN_DTDS
      CLEAN_APSS