Product
Support
Everything Else
Helix 6.1 — Editing Preferences
Introduction

Some behaviors of OS X Helix applications can be changed by setting preference values. These are semi-documented settings that are mostly designed to aid in the transtion from Classic Helix to OS X.

Currently most of these preferences can only be set by editing a preference file directly. A future release will bring all of the preferences into the stardard interface.

OS X Helix application preferences are stored in an XML formatted plist named com.qsatoolworks.helixapplication (where application is either server, engine, client, or rade) found in the user's ~/Library/Preferences/ folder.

Editing Preferences the Hard Way

The preference files can be edited with any XML editor. If you have installed Apple's Developer tools, you have their Property List Editor application and double clicking on the Helix Server preference file should launch it automatically. If you have installed the developer tools, we assume you don't need instructions on using Property List Editor.

All OS X installations include the Terminal application (in the Utilities folder), so the following instructions explain how to change preferences using Terminal.

To change a setting, make sure the OS X Helix application is not running, then open the Terminal application (/Applications/Utilities/) and enter a command in this format:
defaults write com.qsatoolworks.helixserver keyword -datatype value
The underlined words must be replaced with appropriate values taken from the chart found in the built-in help for your version of Helix Server. These three values represent the preference to be changed for the word keyword, the type of data required by the preference for the word datatype and the value to set the preference to for the word value.

Note: Keywords are case sensitive! If you enter a value with the wrong case, it will not cause a problem, but the entry has no effect on Helix's behavior.

Editing Preferences the Easy Way

QSA ToolWorks has created a simple AppleScript applet that you can use to edit most of these preferences. You can download it here.

To use this tool, simply double click the applet and follow the built-in prompts.

Note: This applet does not check your input to make sure you are entering logical values. If you enter text in a preference that expects an boolean, the applet will not warn you, and Helix may behave unpredictably. (When things go wrong, the Default button restored Helix's default behavior.) Likewise, if you specify a setting outside a preferences's accepted a range of values, the applet will not complain, and Helix's behavior is unpredictable.

In short: Use this tool with caution and make sure you know what you are doing!

Editable Preferences

Until we are able to add a reasonable user interface, please refer to this page for information on what each does.

PreferenceDefaultDatatypeLegal ValuesDescription
HxTimeStampAdvancefalse-booleantrue/falseTab to the next field after a Time Stamp command.
HxAbortDialogDelay1000 (msec)-integer1-?How long before the progress dialog appears for general activity.
Note: Setting this prefernece to any number less than 1 suppresses these dialogs altogether.
HxFastAbortDialogDelay1 (msec)-integer1-?How long before the progress dialog appears for actions that require feedback regardless of how quickly it happens.
Actions included: Post, Import, Export, Delete, Copy Records, Paste Records.
Note: Setting this prefernece to any number less than 1 suppresses these dialogs altogether.
HxAbortTestInterval20 (msec)-integer1-?How often to check if the user canceled.
HxClassicPictureCompatibilitytrue-booleantrue/falseForces OS X to operate incorrectly, but match the way Classic works when you have pictures that are recorded at other than 72 ppi. Classic assumes that all pictures are saved at 72 ppi and displays them as such. OS X uses the resolution fields recorded with the picture to determine the proper ppi. With this option off, some pictures appear reduced in OS X Helix, as they are displayed at their true resolution.
HxInvalidBackgroundColor004444DD-stringcolor name*, 8 digit hex value stringsThe color to shade an invalid field.
HxDefaultBackgroundColor00338855-stringcolor name*, 8 digit hex value stringThe color to shade a defaulted field.
HxOffPageAreaColor00C8C8C8-stringcolor name*, 8 digit hex value stringsThe color of the area in a window outside the printable page.
HxPageBoundaryColor0000, 0000, 0000, FFFF-array of strings4-4 digit hex value stringsThe color of the line around the printable page(s).
HxPageNumberCodeP#-stringAny charactersThe text string for which the actual page number is substituted.
HxDimHiliteColor7777, 7777, 7777, CCCC-array of strings4-4 digit hex value strings. Red, Green, Blue, AlphaThe highlight shade on a list that indicates an entry view is about to be opened. May also use color name* or 8 character hex string.
HxStrongHiliteColor0000, 0000, AAAA, 8888-array of strings4-4 digit hex value stringsThe highlight shade on a list that indicates a query has been formed. May also use color name* or 8 character hex string.
HxAutoOpenURINone-stringURI The path to a file (collection or structure) to automatically open when the Helix application is launched.

Note: Prefix path with file:///

HxAutoConnectToURINone-stringhostname or IP Address The address of a Helix Server to which Helix Client will attempt a transparent connection when the application is launched.
HxAutoConnectUsernameNone-stringname of a user icon in the collection Default value for the User Authentication dialog, or transparent authentication when a collection is opened (or connected to for Helix Client).
HxAutoConnectPasswordNone-string A password to use in conjunction with the HxAutoConnectUsername to for transparent authentication.
HxShadowFilePathsnone-array of stringsFilepath(s)Where to put the recovery file.
HxRAMJetSize0 MB-integer0-?Size of Collection buffer. Set via Preferences dialog.
HxShadowSize0 MB-integer0-?Size of Recovery File buffer. Set via Preferences dialog.
HxTotalBufferSize0 MB-integer0-?See help file.
HxClientInfoRefresh60 (seconds)-integer0-?See help file.
HxServerInfoRefresh60 (seconds)-integer0-?See help file.
HxCustomHelpPathCustomHelp/index.html-stringSee help file.
HxAutologPathSame as Collection-stringSee help file.
HxAutologPrefixLog_-stringshort text stringPrefix of Logfile name. If the total length of this prefix plus the collection name exceeds 26 characters, only the first 26 characters are used.
HxAutologSuffix.hlog-stringfile extenstion Extension for Logfile name. If the total length of the logfile prefix plus the collection name plus this suffix exceeds 31 characters, only the first 26 characters of the prefix+collection name are used. Do not change this unless you have a compelling reason to do so.
HxAutologgingYes-stringSee help file.
HxLogRecoveryAlertYes-stringSee help file.
HxDATSize100000000-integer0-?Allocate space (in bytes) for the DAT. Other useful values are 40000000, 20000000, and 0.
HxNextUpdateCheckAtn/a-float0-?The time (in seconds since Jan 1, 2001) of the next version update check. A CFAbsoluteTime. (Currently forces the About Helix Engine -> Current Version window open.)
HxNextUpdateCheckInterval7200 (seconds)-float0-?The number of seconds between update checks. A CFTimeInterval. (Currently opens the About Helix Engine -> Current Version window.)
New in 6.1.3
HxPrintBorderColorFFFFFFFF-stringcolor name*, 8 digit hex value stringsThe fill color for the space between the page rectangle and the paper rectangle. Default is opaque white (for Classic compatibility). The string is 4 - 2 digit hex values in the range of 00–FF (0-255) concatenated together in this order: alpha, blue, green, red.
HxAdjustPrintScaleIfNeededtrue-booleantrue/falseTurn off the automatic page scaling feature. A template that is sized so that the view requires 2 pages (horizontally or vertically) to print is scaled to fit onto a single page if the scaling is greater than 51%. Setting this to false forces Helix to print based on the Scale setting in Page Setup (100% by default) regardless of the number of pages required.
New in 6.1.4
HxDocumentPathpath to collection-stringFilepathThe path to a folder in which to place exported documents when On Original Path is specified, but the original path can not be resolved. If this path starts with a foreslash (/) it is treated as an absolute path. If it starts with tilde (~) it is relative to the user’s home directory. This path is also used as the working directory for the Open Original command, as internally stored documents need to be downloaded to a local volume before opening.
New in 6.1.5
HxDisableConnect false -boolean true/false

This was HxDisableVisit in Helix 6.1.5; it has been renamed in 6.1.6.

Reimplements the Classic feature that allows admins to disable the Connect command in the Client application, forcing users to open saved structure files.

Because this is a preference edit, it only disables the machine containing the preferences, but it is retained when a new version is released.

The Classic method (editing HVIS/0) is also supported, enabling distribution of a Connect-disabled Client.

New in 6.1.6
HxSequenceShowNamestrue-booleantrue/false Show name of sequence in sequence progress dialog.
HxSequenceShowStepsfalse-booleantrue/false Show currently executing sequence step in sequence progress dialog.
HxSequenceStepDialog2-integer-1 – n Sequence step count threshold before showing the sequence progress dialog. Changing this preference as follows causes the following behavior:
  • n: Show the sequence progress dialog only if the sequence has n or more steps.
  • 0: Show the sequence progress dialog with an indeterminate progress thermometer instead of discreet steps.
  • -1: Do not show the sequence progress dialog. When this preference is set, the generic progress dialog appears as determined by the setting in HxAbortDialogDelay.

* In place of a hex string, the following standard color names may be used. When entering a multi-word color name, enclose it in single quotes. (e.g. 'cadet blue'):

aquamarine, black, blue, blue violet, brown, cadet blue, coral, cornflower blue, cyan, dark gray, dark green, dark olive green, dark orchid, dark slate blue, dark slate gray dark turquoise, dim gray, firebrick, forest green, gold, goldenrod, gray, green, green yellow, indian red, khaki, light blue, light gray, light steel blue, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, navy, orange, orange red, orchid, pale green, pink, plum, purple, red, salmon, sea green, sienna, sky blue, slate blue, spring green, steel blue, tan, thistle, turquoise, violet, violet red, wheat, white, yellow, and yellow green.