HELIOS ImageServer User manual


8 ImageServer preferences and notification features
8.1 Image Server preference keys
This chapter lists all the preferences that are pertinent to Image Server.
Find a description of how to set, view, change or delete preferences, with the HELIOS utility programs "prefdump", "prefvalue", and "prefrestore", in the chapter "HELIOS utility programs" of the HELIOS Base manual.
Preference
Type Default (""=empty string)
8.1.1 OPI Server preferences
Key: Programs/opisrv/<preference>
HoldTime
int 30
(EtherShare 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.
scopes
strlist ""
Specifies a list, separated by commas, which comprises the defined SLP-zones on the server.
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.
8.1.2 Global OPI preferences
Key: Global/Opi/<preference>
ProfileRepository
str "ICC-Profiles"
This preference specifies the volume name containing the ICC profiles.
ProfilePaths
strlist RGB="ICC-Profiles:Scanner:
HELIOS:CCIR-EBU-RGB",
CMYK="ICC-Profiles:Printer:
HELIOS: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>.
IgnoreMasks
bool FALSE
(EtherShare Admin option Ignore mask for bitmap images)
If set to TRUE, this preference causes that an existing clipping path is ignored when creating a layout image. See 3.3.3 "Clipping paths" and 5.3 "Defining folder specific OPI settings" for a description.
IgnoreSpots
bool FALSE
(EtherShare 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.
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 EtherShare Admin's Lists > PDF Settings menu.
For this preference, the key must be extended to
"Global/Opi/Formats/PDF ///AutomaticLayout".
UseProfile
bool TRUE
Process color matching for layout files, if the high-resolution files have tagged ICC profiles.
IncludeProfile
bool FALSE
A generated layout will contain an embedded profile, even if the original image only contains a reference. This preference is only applicable if the UseProfile option is also set. Useful, if the layout will be used on a different computer and where the specified profile might not be available.
OmitProfile
bool FALSE
A generated layout/picture will not contain any profile even if a profile was specified for the generation of the layout/picture. This option is useful if the generated layout/picture is small while the specified profile was large.
8.1.3 OPI-related volume preferences
Key: Volumes/<volume name>/<preference>
AutomaticLayout
bool TRUE
(EtherShare Admin option Create Layouts)
Activates the automatic generation of layout files.
CrossPlatform-Layout
bool FALSE
(EtherShare Admin option PC Layouts)
Causes that "opisrv" generates PC-compatible layouts.
8.1.4 OPI-related printer queue preferences
Key: Printers/<printer queue>/<preference>
OpiEnabled
bool FALSE
(EtherShare 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
(EtherShare 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
(EtherShare 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
(EtherShare 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 profiles for color matching whenever the correct profile is missing.
PreserveDeviceN
bool FALSE
(EtherShare Admin option PostScript3/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
(EtherShare Admin option Check Fonts)
If set to TRUE, this preference will induce the OPI server to issue an error message if the current print job contains any fonts that are not available.
ResolveAll
bool FALSE
(EtherShare 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
(EtherShare Admin pop-up 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
int 0
(EtherShare Admin pop-up 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 in this dialog (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.
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 ""
(EtherShare Admin "PostScript Output Compression")
This option selects a compression mode for images while being printed. CCITTG4, JPEG, Flate, and Compress are currently supported.
For this preference, the key must be extended to "Printers/<printer queue>/PostScriptImage
/<color space>/CompressPostScript
".
PrintCompressQuality
int 0
(EtherShare 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.
For this preference, the key must be extended to "Printers/<printer queue>/PostScriptImage
/<color space>/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.
ImageSearchPaths
strlist ""
(EtherShare Admin button Image Search Paths-)
Specifies a list of path names where to search high-resolution images during image replacement, in case they cannot be found in the standard locations.
ImageSearchVolumes
strlist ""
Specifies a list of volume names where to search high-resolution images during image replacement, in case they cannot be found in the standard locations.
ImageIDSearch
bool TRUE
This preference - if it is set to TRUE - enables the use of the EtherShare desktop database to locate moved image files.
DefaultPrinterProfile
str ""
(EtherShare Admin pop-up 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 ""
(EtherShare Admin pop-up 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.
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.5 Script Server preferences
Key: Programs/scriptsrv/<preference>
debug
int 0
Turns on debugging of the "scriptsrv" daemon if debug is 1 or higher.
scriptdebug
int 0
The value is exported as "SCRIPTDEBUG" environment of the script.
EventHost
str 127.0.0.1
Specifies the TCP/IP address of the ImageServer to register file events.
EventPort
int 2002
Specifies the TCP/IP port used to register file events with the ImageServer.
HoldTime
int 10
Specifies the time interval 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.

8.2 ImageServer notification features
File changed events will be reported to custom applications via the ImageServer TCP/IP connection. This can be issued via the command:
telnet localhost 2002
Type help for the command overview.
These file changed events are used by third-party applications. e.g:
Type help for the command overview.
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
Issues a change event for a given file, e.g. to generate a layout file.
touchdir
Issues a change event for a directory, e.g. to generate layouts for all files in the directory.
touchtree
Same as touchdir, but used recursively.
sendlayout
Send a layout event to the registerlayout clients. This is usually done by the "layout" and "opisrv" programs.
registerlayout
Register for layout events. Whenever a new layout file is generated, the path name of the new file will be reported.
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 an EtherShare file server. For example, registertype "EPSF" will report a list of all file changes of the type EPSF. registertype "\0\0\0\0" is a "wildcard" register to report all file changes done by Macintosh AFP clients. The "\0\0\0\0" option should be used carefully because it can cause hundreds of events per second and hence may dramatically slow down the server performance.
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 PCShare file server. For example, registersuffix ".eps" will report a list of all file changes of the file suffix .eps. registersuffix "\0" is a "wildcard" register to report all file changes done by Windows SMB clients. The "\0" 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 events for all newly created directories, as well as for deleted directories by Macintosh and Windows clients.

© 2002 HELIOS Software GmbH