TOC PREV NEXT INDEX

HELIOS ImageServer UB User manual


8 Preferences and notification features
8.1 ImageServer preference keys
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 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.

Preference
Type Default (""=empty string)
8.1.1 OPI server preferences
Key: Programs/opisrv/<preference>
HoldTime
int 30
(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
int <Max. number of processes>
This parameter controls the maximum number of "opisrv" processes that may run simultaneously. Default is the number of physically available processors.
NiceIncr
int 10
The priority of the "opisrv" processes - compared to other executable programs on the OPI server - can be changed. This UNIX parameter 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".
RegisterType
strlist ""
Allows definition of additional file types (Macintosh).
RegisterSuffix
strlist ""
Allows definition of additional file suffixes (Windows PC).
url
str "opievent://<ip-number>
/?NAME=<hostname>
"
Specifies the SLP (Service Location Protocol) URL of the OPI server that is to be registered.
slplifetime
int 300
While logging on to the SLP server, each process sends along a "lifetime" value (in seconds). At intervals, the SLP server verifies that each service is still running. If so, it renews the lifetime. Otherwise, the SLP server removes the process registration from its list.
scope
str ""
This preference contains the scopes which this server uses for SLP registrations.

Important: If a Directory Agent is active and a Service Agent uses the scope that is NOT supported by a Directory Agent, its registrations are not available.

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 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.
8.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 and only reach standard quality.
PrintColor
str "CMYK"
(HELIOS Admin pull-down menu Layout Color)
The 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.
UseLayoutDir
bool TRUE
(HELIOS Admin option Layout Name)
This preference determines whether layouts are collected in a separate folder, or if they are assigned ".lay" extensions.
ScreenResolution
int 72.000000
(HELIOS Admin pull-down option Default Monitor Resolution)
Defines the default monitor resolution for layout files. Usually monitor resolutions have a range between 72 and 100 dpi.
PrintResolution
int 72.000000
(HELIOS Admin pull-down 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.
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 the HELIOS Admin tab Image Search Paths-.
ProfilePaths
strlist "RGB=CCIR-EBU-RGB",
"CMYK=Euro 2.6 UCR-370"
Defines RGB or CMYK profiles used if the color space for the destination layout file and the color space of the highresolution file are different. These profiles are used to match between color spaces properly. Each string has the format <color space>=<path name>.
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. See 3.3.5 "Additional channels in bitmap images" and 5.3 "Defining folder specific OPIásettings" for a description.
EpsPreviewPSLevel
int 1
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 parameter 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/<preference>"
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/ManagerPrivate/HeliosICC/<preference>"
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 Gray and Bilevel Compress)
If this preference is set, TIFF bilevel and grayscale layout images are compressed by use of the Compress method.
For this preference, the key must be extended to
"Global/Opi/ImageCompress/TIFF//Grayscale/<preference>" and
"Global/Opi/ImageCompress/TIFF//Bilevel/<preference>"
CompressPrint (EPSF)
str ""
(HELIOS Admin option EPSF JPEG Printable Preview)
If this preference is set, EPSF printable layout images are compressed in JPEG mode.
For this preference, the key must be extended to
"Global/Opi/ImageCompress/EPSF///<preference>"
ScreenColor
str ""
(HELIOS Admin option EPSF 8-bit Screen Preview)
If this preference is set, EPSF layout images for monitor use are compressed in JPEG mode, containing indexed colors (max. 256 colors).
For this preference, the key must be extended to
"Global/Opi/ImageColor/EPSF//<preference>"
8.1.3 OPI-related volume preferences
Key: Volumes/<volume name>/<preference>
AutomaticLayout
bool TRUE
(HELIOS Admin option Create Layouts)
Activates the automatic generation of layout files.
CrossPlatform-Layout
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.
8.1.4 Global printer preferences
Key: Global/Printers/<preference>
IgnoreMasks
bool FALSE
(HELIOS Admin option Ignore Mask for Bitmap Images During Printout)
If set to TRUE, this preference causes that an existing clipping path is ignored when printing an image. See 3.3.3 "Image paths and clipping paths" and 5.3 "Defining folder specific OPIásettings" for a description.
8.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 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 should only be set to TRUE if you print to a PostScript 3 device with in-RIP separation. The PostScript output of PDF original files will be optimized to use the PostScript 3/DeviceN features. 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.
CheckFonts
bool TRUE
(HELIOS Admin option Check Fonts)
If set to TRUE, 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 parameter above) to the given value. Usually, if this parameter is set to FALSE, the output resolution is adjusted to the image resolution if the image resolution is smaller. When setting this parameter 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 parameter is only meaningful when setting the DownSampling parameter to TRUE.
CompressPostScript
str ""
(HELIOS Admin "PostScript Output Compression")
This option specifies the compression mode for images while being printed. Two parameters are needed to set this preference: color space and compression mode.
Modes are:
None, CCITTG4, JPEG, 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
int 100
(HELIOS Admin "PostScript Output Compression")
With the CompressPostScript preference selected, this preference controls the output quality of JPEG compressed PostScript images. Valid values are 1-100.
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.
PSLevel
int 1
This preference controls what PostScript level is used during printing.
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. Can be overridden using the HELIOS ColorSync 2 XT.
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. Can be overridden using the HELIOS ColorSync 2 XT.
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 parameter. 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 HELIOS ColorSync 2 XT or using DefaultPrinterProfile.
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,
CIE-Lab and RGB 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 HELIOS ColorSync 2 XT or using the DefaultPrinterProfile preference.

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

TemporaryTagging
bool TRUE
This parameter 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 parameter to specify whether non-existing layout images should be ignored when printing layout quality.
IgnoreUntagged
bool TRUE
This parameter controls whether non-tagged images should be ignored when printing to an ICC color matched queue.
PrintSpotToProcess
bool FALSE
Forces layout images to always contain only the default inks of the layout color space. Spot colors defined in a high-resolution image will be converted into the appropriate values of the layout color space.
8.1.6 Script Server preferences
Key: Programs/scriptsrv/<preference>
scriptdebug
int 0
The value is exported as SCRIPTDEBUG environment.
HoldTime
int 10
Specifies the time interval (in seconds) after the file event is received before the script is executed.
MaxProc
int 2
Specifies the maximum number of concurrently executing scripts in order to limit server load.

Note: It is recommended that the value for MaxProc be less or equal to the number of physical CPUs.

RemoteAccess
bool FALSE
If set to TRUE, access to the Script Server service port (2024) is enabled to remote users (subject to the restrictions in the ipaccess list). The default is that access to the Script Server service port is only enabled for users on the same host.
ipaccess
str ""
Specifies the file name of the IP access list that makes the particular volume visible for clients which have one of the IP numbers on the IP access list.
TelnetPort
int 2024
Specifies the Script Server service port.
RunTime
int 120
This preference determins how long a script may run. Specifying - 0 disables the running time (i.e. "run forever").
TermTime
int 30
This preference determins how long "scriptsrv"should wait before the process is killed. This happens only if RunTime (see above) has timed out.
8.1.7 Spot color editor preferences
Key: Library/OpenImage/CustomColors/<Color_Name>
Color_Name
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 vallues of 100% are represented as 1.0.
For a and b, values between -128 and 128 are represented in a range between 0.0 to 1.0, with 0 being 0.5.
Examples:
(1) L0.450000000 0.757812480 0.527343744
(2) C0.0214 0.8991 0.1767 0.0091
8.2 Notification features
File change events will be reported to custom applications by the ImageServer TCP/IP connection via port "2002".

Note: These events are used by third-party applications, e.g. Cumulus (Canto), MediaBeacon (Brightech), or OPAS-G (OKS).

The output is preceded by a number (mostly 4), followed by the event type and the path to the file.
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 8.1.1 "OPI server preferences".

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 and can be used to map the path name to the corresponding volume.
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, but used recursively.

Note: The next three event features can optionally be specified with a file type 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
Register for layout events. Whenever a new layout file is generated, the path name of the new file will be reported.
registerfiles
Register for file change events. This allows receiving all events for newly created files, as well as for files deleted by Macintosh 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
Register for directory change events. This allows receiving all events for newly created directories, as well as for directories deleted by Macintosh and Windows clients. Optionally, you may delimit the file events by specifying a path to a certain directory. The specified path must be absolute.
registertype
Register for file change events with a particular Macintosh 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.
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.
switchprotocol0
Switch to old output format (up to ImageServer 2.5 compatibility; protocol 0). The default behavior is protocol 0.
switchprotocol1
Switch to new extended output format. The default behavior is protocol 0.
8.2.1 Notification features (new protocol)
In addition to the event type and the path to the file, the new protocol (protocol 1) shows as well 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:
r=resource fork
Example:
4 - close "/opitest/InDesign/Project1" 105 r
s=Windows file streams
Example:
4 - close "/opitest/InDesign/Project1" 105 s "Comments"
Wildcard in protocol 1
The file event commands RegisterType and RegisterSuffix may also be specified with the new output format (see switchprotocol1). If you wish to set "wildcard" registrations for file types and suffixes under the protocol 1, use the registerfiles feature instead. The old protocol wildcard statement registersuffix "\0" is not allowed with protocolá1, whereas registertype "\0\0\0\0" will be interpreted as a certain file type (e.g. as a file type which is commonly used for images from digital cameras).
Example:
ankh:~ $ 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 - delete "/opitest/InDesign/Project1 copy" 105
4 - close "/opitest/InDesign/Project1 copy" 105

© 2005 HELIOS Software GmbH