9 Preferences and notification features

9.1 ImageServer preferences

This chapter lists all the preferences that are pertinent to ImageServer. Find a description of how to set, view, change or delete preferences, with the HELIOS utility programs “prefdump”, “prefvalue”, and “prefrestore”, in the HELIOS Base manual.

Important:: Make sure that preference keys DO NOT start or end with a slash (“/”) character, and note that they are case-sensitive! Also, if any preference key or preference value includes spaces, that key or value must be enclosed in quotes.

9.1.1 OPI server preferences

: Key: Programs/opisrv/<preference>

HoldTime

int

(HELIOS Admin option Layout Delay)

This preference determines the time delay in seconds after which the layout file is generated from the original image file.

MaxProc

uint

This preference controls the maximum number of “opisrv” processes that may run simultaneously. Default is the number of CPU cores.

NiceIncr

int

The priority of the “opisrv” processes – compared to other executable programs on the HELIOS server – can be changed. This preference lets you increase/reduce the priority, and therefore the speed of a program. The higher the priority of a program, the less “nice” its behavior towards other applications. The values for NiceIncr are as follows:

`NiceIncr` > 0	Slower / “nice” towards other applications
`NiceIncr` < 0	Faster / less “nice” towards other applications

Facility

str

"daemon" or "user"

Specifies the facility which is used for system log messages. The string names the log facility. The default value depends on the program and is daemon for the “opisrv” program and user for the “layout” program. Valid names are listed below (please note that some names are not supported on every architecture):

“audit”, “sat”, “auth”, “security”, “cron”, “daemon”, “kern”, “lpr”, “mail”, “news”, “syslog”, “user”, “uucp”, “local0”, “local1”, “local2”, “local3”, “local4”, “local5”, “local6”, and “local7”.

RegisterTypes

strlist

Allows defining additional file types (Mac), which are registered for file events.

RegisterSuffixes

strlist

Allows definition of additional file suffixes (Windows PC), which are registered for file events.

RemoteAccess

bool

FALSE

If set to TRUE, access to the ImageServer Event port (2002) is enabled for remote users (subject to the restrictions in the “ipaccess” list). The default is that access to the ImageServer Event port is only enabled for users on the same host.

PreserveResources

strlist

"IPTC,PATH,XMP"

Determines additional resources, which will be read and preserved by “OpenImage” plug-ins. If the string contains PATH, IPTC or XMP, the named additional resource will be read. If no resources should be preserved, specify none.

RenderColor

str

"CMYK"

Sets the color space for rendered image objects. It is important that for PDF files this option is set to CMYK, to show proper overprints.

KeepPhysicalSize

bool

FALSE

If set to TRUE, this preference preserves the physical size of an image when the image size is changed via the resolution.

LayoutAlpha

bool

FALSE

The “layout” option -o LayoutAlpha can also be set as a server preference either for the “opisrv” service or globally, with the key: “Global/Opi/LayoutAlpha”.

9.1.2 Global OPI preferences

: Key: Global/Opi/<preference>

Fast

bool

FALSE

(HELIOS Admin pull-down menu Layout Quality)

This preference determines the quality of the generated layout image. If set to TRUE, layouts will be generated faster, will only reach standard quality and are not color matched.

PrintColor

str

"CMYK"

(HELIOS Admin pull-down menu Layout Color)

The print color space for all layout files that are generated on the server can be specified by use of this preference. At the same time, it defines an ICC profile which is used for color matching the layouts. This profile is taken from the ProfilePaths setting.

ScreenResolution

double

72.000000

(HELIOS Admin option Default Monitor Resolution)

Defines the default monitor resolution for layout files. Usually monitor resolutions have a range between 72 and 200 dpi.

PrintResolution

double

72.000000

(HELIOS Admin option Default Print Resolution)

Defines the default resolution for printouts of layout files.

ProfileRepository

str

"ICC-Profiles"

This preference specifies the volume name containing the ICC profiles. You may also specify the absolute path to the repository or the path relative to the “HELIOSDIR” directory.

ImageSearchPaths

strlist

Specifies a list of path names to search for high-resolution images during image replacement, in case they cannot be found in the standard locations. The setting reflects the entries in HELIOS Admin (ImageServer Settings > Image Search Paths...)

ProfilePaths

strlist

(see description)

Defines RGB and CMYK profiles used if the color space for the destination layout file and the color space of the high-resolution file are different. These profiles are used to match between color spaces properly. Each string has the format <color space>=<path name>.

The default profiles are “RGB=sRGB_IEC61966-2-1_noBPC.icc” for RGB, and “CMYK=ISOcoated_v2_eci.icc” for CMYK.

IgnoreSpots

bool

FALSE

(HELIOS Admin option Ignore Additional Channels for Bitmap Images)

This preference default causes that additional channels (e.g. spot colors) are used when creating a layout image, printing the resolved high-resolution image or converting an image. See 3.3.4 “Additional channels in bitmap images” and 5.2 “Define folder specific OPI settings” for a description.

EpsPreviewPSLevel

int

Determines the preview PostScript level for EPSF files. By default, this is PostScript level 1, optionally PostScript level 2 can be specified.

EventPort

int

2002

Controls the TCP/IP port number where to listen for OPI event registration requests. If this preference is not set, “opisrv” uses the port number given by the TCP service “OPIEvent”. If this service is not defined it uses the default port number 2002.

AutomaticLayout

bool

TRUE

If set to TRUE, this preference causes that a layout image is created from a PDF file. The setting of this attribute reflects that of the PDF OPI Layout Generation checkbox in the HELIOS Admin Settings > PDF HandShake Settings menu.

For this preference, the key must be extended to:

Global/Opi/Formats/PDF ///AutomaticLayout

SpotToEps

bool

TRUE

Causes the creation of EPSF layout images if a high-resolution raster image contains extra colors like spot colors.

MaskToEps

bool

TRUE

Causes the creation of EPSF layout images if a high-resolution raster image contains a clipping path.

AntiAlias

bool

TRUE

If set to TRUE, the screen preview in layout files, generated from PDF documents, offers an enhanced readability. This is recommended for monitor screen resolutions up to 96 dpi. The setting of this attribute reflects that of the Antialias Screen Preview checkbox in the HELIOS Admin Settings > PDF HandShake Settings menu.

For this preference, the key is:

Library/OpenImage/ManagerPrivate/HeliosPDF/AntiAlias

UsePredictors

bool

TRUE

The HELIOS TIFF plug-in uses so called “predictors” for the “Flate” and “Compress” compression methods, which results in smaller file sizes after compression. If this preference is set to FALSE, no “predictors” are used.

For this preference, the key is:

Library/OpenImage/ManagerPrivate/HeliosTIFF/UsePredictors

UseEuroCMYK

bool

TRUE

(HELIOS Admin pull-down menu CMYK Default Profile)

This preference defines the type of CMYK color space, if an image which is transformed into CMYK or vice versa and if – in a situation like that – a CMYK output (printer) or input (image) profile has not been explicitly defined.

For this preference, the key is:

Library/OpenImage/UseEuroCMYK

UseProfile

bool

TRUE

Process color matching for layout files, if the high-resolution files have tagged ICC profiles.

IncludeProfile

bool

FALSE

If set to TRUE, a generated layout will contain an embedded profile, even if the original image only has a referenced profile. This preference is only applicable if the UseProfile option is also set. It is useful, if the layout will be used either on a different computer or in an environment where the specified profile is not available.

OmitProfile

bool

FALSE

If set to TRUE, a generated layout/original will omit any specified profile. This preference is useful if the generated layout/original has a smaller size than the specified profile.

CompressPrint (TIFF)

str

(HELIOS Admin option TIFF Compress)

If the value “Compress” is specified for this preference, TIFF layout images are compressed.

For this preference, the key must be extended to:

Global/Opi/ImageCompress/TIFF///CompressPrint

CompressPrint (EPSF)

str

(HELIOS Admin option EPSF JPEG Printable Preview)

If the value “JPEG” is specified for this preference, EPSF layout images are compressed.

For this preference, the key must be extended to:

Global/Opi/ImageCompress/EPSF///CompressPrint

ScreenColor

str

(HELIOS Admin option EPSF 8-bit Screen Preview)

If this preference is set, EPSF layout images for monitor use contain indexed colors (max. 256 colors).

For this preference, the key must be extended to:

Global/Opi/ImageColor/EPSF//ScreenColor

PDFNativeWorkflow

bool

FALSE

This preference enforces the generation of PDF-native workflow compatible layout images from vector-based EPS images, even if TIFF layout images are supposed to be generated (e.g. via a “%t” folder syntax).

MaxLayoutSize

uint32

2540

Defines the maximum allowed rows and columns in a layout image.

9.1.3 OPI-related volume preferences

: Key: Volumes/<volume_path>/<preference>

Important:

If the key contains a path, the “/” characters within the path must be “marked” by preceding each with a “\” character.

Example:

# prefvalue -k '/Volumes/\/images/SpotToEps' -t bool FALSE

AutomaticLayout

bool

TRUE

(HELIOS Admin option Create Layouts)

Activates the automatic generation of layout files.

CrossPlatformLayout

bool

FALSE

(HELIOS Admin option PC Layouts)

Causes that “opisrv” generates PC-compatible layouts.

SpotToEps

bool

TRUE

Causes the creation of EPSF layout images if a high-resolution raster image contains extra colors like spot colors.

MaskToEps

bool

TRUE

Causes the creation of EPSF layout images if a high-resolution raster image contains a clipping path.

9.1.4 Global printer preferences

: Key: Global/Printers/<preference>

IgnoreMasks

bool

FALSE

(HELIOS Admin option Ignore Mask for Bitmap Images During Output)

If set to TRUE, this preference causes that an existing clipping path is ignored when printing an image. See Image paths and clipping paths and 5.2 “Define folder specific OPI settings” for a description.

UseAlpha

bool

TRUE

If set to FALSE, ImageServer ignores alpha channels in image files.

9.1.5 OPI-related printer queue preferences

: Key: Printers/<printer queue>/<preference>

OpiEnabled

bool

FALSE

(HELIOS Admin option OPI Active)

If this preference is set to TRUE it activates OPI for the specified printer queue.

CustomColorTinting

bool

TRUE

This preference applies to composite printing only: Spot colors are output in Level 2 Separation color space. This becomes necessary when printing to a Create PDF printer queue or to in-RIP separation devices, in order to preserve the spot colors. If set to FALSE, all spot colors that are incorporated in the image are converted to the process colors of the output color space, e.g. CMYK.

PrintDraft

bool

FALSE

(HELIOS Admin option Print Layout Images)

If set to TRUE, the printouts from the specific printer queue will only contain layout images. The copies of the images – which you have used for layouting your document – will be sent to the OPI server and then be replaced by the layout files instead of the high-resolution originals.

CheckImages

bool

TRUE

(HELIOS Admin option Check Images)

With this preference set to TRUE, the OPI server will try to find all images that are included in a print job. If any images are missing, the job will be stopped, and issue an error message for every missing file. If CheckImages is set to FALSE, single images may be missing on the printouts.

CheckICCProfiles

bool

TRUE

(HELIOS Admin option Check ICC Profiles for Pictures)

This preference will induce the OPI server to check whether all image profiles that have been tagged to any of the image files are available (the Check Images option must be activated, otherwise this preference has no effect!). The server will automatically stop the print job if a single profile is missing and issue a corresponding error message. If you set CheckICCProfiles to FALSE, OPI will execute all print jobs and use standard output profiles for color matching whenever the correct profile is missing.

PreserveDeviceN

bool

FALSE

(HELIOS Admin option PostScript 3/DeviceN Output)

This preference optimizes the PostScript output of PDF original files to use PostScript 3/DeviceN features. It should only be set to TRUE if you print to a PostScript 3 device with in-RIP separation. This applies for Hexachrome printing, colorized images (Duotone), etc. When printing host-based separations with applications like QuarkXPress, this feature must be turned off, otherwise the output will lead to unexpected results.

PureWhite

bool

FALSE

(HELIOS Admin option Preserve Raster Colors – White)

Exclude white colored raster objects in PDF files from color transformation, so that they remain white even if color matching is done. CMYK values will be zero, i.e. no ink is applied to the plates.

PureGrays

bool

FALSE

(HELIOS Admin option Preserve Raster Colors – Gray)

Exclude gray colored raster objects in PDF files from color transformation, so that they remain gray even if color matching is done. Gray raster objects in Gray/RGB/CIELab/Indexed color spaces are detected and converted to Gray only for CMYK output.

PureBlack

bool

FALSE

(HELIOS Admin option Preserve Raster Colors – Black)

Exclude black colored raster objects in PDF files from color transformation, so that they remain black even if color matching is done. Black raster objects in Gray/RGB/CIELab/Indexed color spaces are detected and converted to Black only for CMYK output.

PureCMY

bool

FALSE

(HELIOS Admin option Preserve Raster Colors – CMY)

Applies to CMYK to CMYK conversions of pixels of raster images, and preserves the input color if, and only if, black is 0% and exactly one CMY primary color is 100% and all other primary colors are 0%.

CheckFonts

bool

TRUE

(HELIOS Admin option Check Fonts)

This preference will induce the OPI server to stop the print job and issue an error message if the current print job contains any fonts that are not available.

ResolveAll

bool

FALSE

(HELIOS Admin option Replace Images)

If set to FALSE, the OPI server will only replace layout images during printing. High-resolution originals you may have placed in your document, will not be replaced. In case you want the OPI server to replace all images during printing (e.g. if you want to use the Omit... options in the print dialog) you should set this preference to TRUE.

DownSampling

bool

FALSE

(HELIOS Admin pull-down menu Downsampling)

Defines a uniform output resolution for all raster-based images – no matter whether you print layout images or high-resolution originals. The resolution for downsampling may be specified with the Resolution preference (see below).

Resolution

double

0.0

(HELIOS Admin pull-down menu Downsampling)

With DownSampling (see above) set to TRUE, the resolution of an image can be specified with this preference. If the resolution of a given image (e.g. 300 dpi) is higher than the value specified for this preference (e.g. 222,30 dpi), the OPI server will apply the value you have chosen for downsampling and then re-calculate and scale the image accordingly. Images with a resolution smaller than the value entered in this dialog, will remain unchanged because increasing the resolution automatically decreases the dimensions of an image. This would entail upward scaling and lead to a loss in quality. Zero induces the software to use the default resolution of the printing device as specified in the queue’s PPD file.

FixedSampling

bool

FALSE

This preference allows fixing the downsampling resolution (see Resolution preference above) to the given value. Usually, if this preference is set to FALSE, the output resolution is adjusted to the image resolution if the image resolution is smaller. When setting this preference to TRUE the printer interfaces will use the given Resolution as is for downsampling. This may cause upsampling of images with resolutions smaller than the given one. This preference is only meaningful when setting the DownSampling preference to TRUE.

CompressPostScript

str

(HELIOS Admin section “PostScript Output Compression”)

This option specifies the compression mode for images while being printed. Two preferences are needed to set this preference: color space and compression mode. JPEG 2000 makes sense only in a “pdfresolve” workflow.

Modes are:
None, CCITTG4, JPEG, JPEG 2000, Flate, and Compress

Color spaces are:
RGB, CMYK, CIELab, Grayscale, and Bilevel

For this preference, the key must be extended to:
Printers/<printer queue>/PostScriptImage/<colorspace>/CompressPostScript

PrintCompressQuality

double

(see description)

HELIOS Admin section “PostScript Output Compression”)

With the CompressPostScript preference selected, this preference controls the output quality of JPEG compressed PostScript images (valid values 1...100; default value 75) or JPEG 2000-compressed images (valid values 0...100 default value 0 for lossless).

Color spaces are:
RGB, CMYK, and Grayscale

For this preference, the key must be extended to:
Printers/<printer queue>/PostScriptImage/<colorspace>/PrintCompressQuality

KeepInfo

bool

TRUE

Specifies whether in case of resolving an already resolved PostScript job, the use of fonts and other resources should still be accounted.

ImageIDSearch

bool

TRUE

This preference – if it is set to TRUE – enables the use of the HELIOS desktop database to locate moved image files.

ImageSearchVolumes

strlist

Specifies a list of volume names to search for high-resolution images during image replacement, in case they cannot be found in the standard locations.

Note:: When remote OPI is used, the remote client must not use “layouts” as directory name for low-res images, in case the “ImageSearchVolumes” feature is used.

DefaultPrinterProfile

str

(HELIOS Admin pull-down menu Default Printer Profile)

This preference specifies the path name of the default ICC profile describing the printing device.

DefaultProofProfile

str

(HELIOS Admin pull-down menu Default Proof Profile)

This preference specifies the path name of the default ICC profile describing the proof device. The string will only be recognized if a default printer profile is set.

DefaultDevLinkProfile

str

(HELIOS Admin pull-down menu Default DeviceLink Profile)

This preference specifies the path name of the default DeviceLink profile. The string will only be recognized if a default printer profile is set.

ProcessColorspace

str

"CMYK"

This preference sets the color space used while printing separations. The default is "CMYK" for a four color print process. Spot colors are not affected by this preference. Valid color spaces are "CMYK" and "Multi". If you set the string to "Multi" you have to define the names and order of the color components. Furthermore, the usage of the "Multi" color space requires the use of ICC profiles. For (future) ICC profiles that include the names of the color components this preference will become obsolete. Note that the value you choose for this preference can be overridden by the printer profile you have selected using the DefaultPrinterProfile preference.

ProcessInks

strlist

"Cyan","Magenta","Yellow","Black"

This preference controls, in conjunction with the ProcessColorspace preference, the names of the process inks used for separations. Spot colors are not affected.

CompositeColorspace

str

"CMYK"

This preference sets the color space used while printing composite. The default is CMYK. Setting this preference to None causes all color images in a print job to be kept and printed in their original color space. This applies to CMYK, RGB and CIELab images only. Valid strings are "CMYK", "RGB", and "CIELab". Please note that the value you choose for this preference can be overridden by the printer profile you have selected using the DefaultPrinterProfile preference.

Note:: In a “Create PDF” queue, the default behavior is “None”.

TemporaryTagging

bool

TRUE

This preference enables the use of the ICC info files while printing images. If it is set to TRUE, every non-tagged image will be temporarily tagged during printing provided that the ICC info file specifies tagging for that kind of image.

IgnoreMissingLowRes

bool

TRUE

Use this preference to specify whether non-existing layout images should be ignored when printing layout quality.

IgnoreUntagged

bool

TRUE

This preference controls whether untagged images should be ignored when printing to an ICC color matched queue. If set to TRUE, the images are printed with the default profile. If set to FALSE, the print job is passed to the error queue.

PrintSpotToProcess

bool

FALSE

If this preference is set to TRUE, all spot colors in the print job will be printed with the appropriate process color values.

9.1.6 Script Server preferences

The following keys require a restart of the service to take effect:

: Key: Programs/scriptsrv/<preference>

TelnetPort

int

2024

Specifies the Script Server service port.

HoldTime

int

Specifies the time interval (in seconds) after the file event is received before the script is started. The setting reflects that of the Script Delay field in the HELIOS Admin “Script Server Settings” window.

RunTime

int

120

This preference determines how long a script may run. Specifying 0 disables the running time (i.e. “run forever”). The setting reflects that of the Script Timeout field in the HELIOS Admin “Script Server Settings” window. Compare Timeout in 9.1.7 “Script queue preferences”.

TermTime

int

This preference determines how long “scriptsrv” should wait before the process is killed. This happens if RunTime has timed out.

MaxProc

int

This preference controls the maximum number of “scriptsrv” processes that may run simultaneously. Default is the number of CPU cores.

Note:: It is recommended that the value for MaxProc be less than or equal to the number of CPU cores.

scriptdebug

int32

Specifies whether verbose output is written. The value is exported as the SCRIPTDEBUG environment variable.

RemoteAccess

bool

FALSE

If set to TRUE, access to the Script Server service port is enabled to remote users (subject to the restrictions specified in the IP access list).

ipaccess

str

ipaccess

Specifies the file name of the IP access list that controls client access to the Script Server.

9.1.7 Script queue preferences

: Key: Programs/scriptsrv/Config/<queue>/<preference>

Path: str
""; Specifies the path to the Script Server hot folder. The setting reflects that of the Hot Folder field in the General tab of the HELIOS Admin “Script” configuration window.
Script: str
""; Specifies the desired script for the script queue. The setting reflects that of the Script field in the General tab of the HELIOS Admin “Script” configuration window.
User: str
(see description); Specifies the user whose permissions are used to execute the script. The setting reflects that of the User field in the General tab of the HELIOS Admin Script configuration window. If this preference is not specified, the script is executed as superuser.
Enabled: bool
FALSE; Determines whether the script queue is active at all. The setting reflects that of the Enable checkbox in the General tab of the HELIOS Admin “Script” configuration window.
Timeout: int
(see description); This preference determines how long the script may run. Specifying 0 disables the running time (i.e. “run forever”). The setting reflects that of the Timeout field in the General tab of the HELIOS Admin Script configuration window. If this preference is not specified, Script Server uses the global value RunTime (see above).
Recursive: bool
FALSE; Determines that all subdirectories underneath the specified directory for the hot folder (see Path) are considered. The setting reflects that of the Include Subdirectories checkbox in the General tab of the HELIOS Admin “Script” configuration window.
Directory: bool
FALSE; Determines that directory events rather than file events are notified to the Script Server. The setting reflects that of the Folder Changes checkbox in the File Types tab of the HELIOS Admin “Script” configuration window.
RemoveEvents: bool
FALSE; If set to TRUE, this preference allows getting notified via a ScriptServer script when files are being deleted. The same works for deleted folders when the Directory preference is set.
scriptdebug: int32
(see description); Specifies whether verbose output is written. The value is exported as the SCRIPTDEBUG environment variable. The setting reflects that of the Debugging checkbox in the General tab of the HELIOS Admin “Script” configuration window. If this preference is not specified, Script Server uses the global value scriptdebug.
Ftypes: strlist
""; Allows specifying file types for which script execution should be triggered. If no type is specified, the script is executed for any file event. The setting reflects that of the entries in the Types list in the File Types tab of the HELIOS Admin Script configuration window.
Suffixes: strlist
""; Allows specifying file suffixes for which script execution should be triggered. If no suffix is specified, the script is executed for any file event. The setting reflects that of the entries in the Suffixes list in the File Types tab of the HELIOS Admin “Script” configuration window.
Environment: strlist
""; Allows specifying additional environment variables, which are considered while the script runs. The setting reflects that of the entries in the Environment list in the Environment tab of the HELIOS Admin “Script” configuration window.

9.1.8 Spot color editor preferences

: Key: Library/OpenImage/CustomColors

CustomColors*

str

(HELIOS Admin Spot Colors)

Defines a preview color for a given spot color name either in the Lab or in the CMYK color space. If the color is defined in Lab (1), the string is preceded by an “L”. If the value is entered in CMYK (2), the string has a leading “C”.

For C, M, Y, K, and L color values of 0% are represented as 0.0, while values of 100% are represented as 1.0.
For a and b, values of -128 are represented as 0.0, while color values of 127 are represented as 1.0.

* The actual key is Library/OpenImage/CustomColors/color name.

Examples:

(1) prefvalue -k "Library/OpenImage/CustomColors/Bleen"
       -t str "L0.450000000 0.757812480 0.527343744"
(2) prefvalue -k "Library/OpenImage/CustomColors/Grellow"
       -t str "C0.0214 0.8991 0.1767 0.0091"

9.2 Notification features

File change events will be reported to custom applications by the ImageServer TCP/IP connection via port 2002.

The output is preceded by a number. and followed by the event type (see 9.2.1 “Event types” below) and the file path:

	0	Simple OK
	1	Informational message
	2	Command syntax error
	3	UNIX error
	4	OPI event

: Issue the command socket localhost 2002, type help for the command overview and quit to leave.

Note:: By default, the ImageServer event port can only be reached from localhost. See RemoteAccess in 9.1.1 “OPI server preferences”.

9.2.1 Event types

ushowq/showq

Show the “opisrv” event queue as a list of files which are waiting to be processed into layout images. ushowq additionally includes the user ID of the job initiator.

showvols

Show list of exported volumes by EtherShare and PCShare. Can be used to map the path name to the corresponding volume. The following flags are possible:

`E`	EtherShare
`P`	PCShare
`U`	UTF-8 encoded
`A`	Automatic layout generation

touchfile

Issue a change event for a given file, e.g. to generate a layout file.

touchdir

Issue a change event for a directory, e.g. to generate layouts for all files in the directory.

touchtree

Same as touchdir above, but used recursively.

Note:: For the next three event features a file type can optionally be specified for the current event.

sendclose

Send a file close event to the “opisrv”:

sendclose "file name" [file type]

sendrename

Send a file rename event to the “opisrv”:

sendrename "file name old" "file name new" [file type]

senddelete

Send a file delete event to the “opisrv”:

senddelete "file name" [file type]

sendlayout

Send a layout event to the registerlayout clients. This is usually done by the programs “layout” and “opisrv”:

sendlayout "file name"

sendrenamedir

Send a directory rename event to the “opisrv”:

sendrenamedir "directory name old" "directory name new"

sendcreatedir

Send a directory create event to the “opisrv”:

sendcreatedir "directory name"

senddeletedir

Send a directory delete event to the “opisrv”:

senddeletedir "directory name"

registerlayout

registerfiles

Register for file change events. This allows receiving all events for newly created files, as well as for files renamed or deleted by Mac and Windows clients. Optionally, you may delimit the file events by specifying a path to a certain directory. The specified path must be absolute.

registerfiles [directory path]

This option should be used carefully because it can cause hundreds of events per second and hence may dramatically slow down the server performance.

registerdirs

Register for directory change events. This allows receiving all events for newly created directories, as well as for directories renamed or deleted by Mac and Windows clients. Optionally, you may delimit the file events by specifying a path to a certain directory. The specified path must be absolute.

registerdirs [directory path]

registertype

Register for file change events with a particular Mac file type. The “opisrv” process will report all changes for a given file type done by a HELIOS file server. For example, registertype "EPSF" will report a list of all file changes of the type EPSF. Optionally, you may delimit the file events by specifying a path to a certain directory. The specified path must be absolute.

When used with protocol 0, registertype "\0\0\0\0" is a wildcard register to report all file changes done by clients. This option should be used carefully because it can cause hundreds of events per second and hence may dramatically slow down the server performance. See also Wildcard in protocol 1 or protocol 2.

registersuffix

Register for file change events with a particular Windows file suffix. The “opisrv” process will report all changes for a given file suffix done by a HELIOS file server. For example, registersuffix ".eps" will report a list of all file changes of the file suffix “.eps”. Optionally, you may delimit the file events by specifying a path to a certain directory. The specified path must be absolute.

When used with protocol 0, registersuffix "\0" is a wildcard register to report all file changes done by clients. This option should be used carefully because it can cause hundreds of events per second and hence may dramatically slow down the server performance. See also Wildcard in protocol 1 or protocol 2.

switchprotocol0

Switch to old output format (up to ImageServer 2.5 compatibility; protocol 0). This behavior (protocol 0) is the default.

switchprotocol1

Switch to extended output format.

switchprotocol2

Switch to advanced format including dirclose events and flags (stream, resource, Finder info, etc.)

9.2.2 Notification features (newer protocols)

In addition to the event type and the path to the file, the protocols protocol 1 and protocol 2 show also the ID of the user who caused the file change event. For “close” events, the string may contain flags that show which parts of the file have been changed:

event path [path2] uid [flags] [stream [stream2]] [fileid]

`event`	close, rename, exchange, delete, dirclose, dircreate, dirrename, dirdelete
`path`	File path
`path2`	Second file path (rename, exchange, dirrename)
`uid`	User ID
`flags`	`r` Resource; `f` Finder info; `s` Stream; `i` File ID; `c` File created (Windows only)
`stream`	Name of stream
`stream2`	Name of second stream
`fileid`	File ID

Example:

(r = Resource fork)

4 - close "/opitest/InDesign/Project1" 105 r

Example:

(s = File stream)

4 - close "/opitest/InDesign/Project1" 105 s "Comments"

Example:

(f = Finder info)

4 - close "/opitest/InDesign/Project1" 105 f

Example:

(i = File ID)

4 - dirrename "/opitest/untitled folder" "/opitest/WORK" 105 i 10736

Wildcard in protocol 1 or protocol 2

The file event commands registertype and registersuffix may also be specified with the newer output formats (see switchprotocol1 and switchprotocol2). If you wish to set wildcard registrations for file types and suffixes under protocol 1 or protocol 2, use the registerfiles feature instead. The old protocol wildcard statement registersuffix "\0" is not allowed with protocol 1 and protocol 2, whereas registertype "\0\0\0\0" will be interpreted as an empty file type.

Example:

$ socket localhost 2002 
0 - Welcome to the HELIOS ImageServer event listener

The protocol for the session is switched to protocol 1:

switchprotocol1
0 - OK

Then a wildcard command is set, which limits the notifications to files below the stated path:

registerfiles "/opitest/InDesign"
0 - OK

When duplicating the file “Project1”, the following file event is issued (Note that the user ID “105” is displayed when protocol 1 is active):

4 - close "/opitest/InDesign/.DS\_Store" 105
4 - close "/opitest/InDesign/Project1 copy" 105
4 - delete "/opitest/InDesign/Project1 copy" 105

HELIOS Manuals April 1, 2020