Appendix A: inserverOutput.ini for Linux - Output Agent Installation and Setup Guide for Linux - Foundation 24.1 - Foundation 24.1 - Ready - Perceptive Content - external

Output Agent Installation and Setup Guide for Linux

Platform
Perceptive Content
Product
Output Agent Installation and Setup Guide for Linux
Release
Foundation 24.1
License

The following table provides definitions and sample data for the settings in the inserverOutput.ini configuration file. This table displays the INI settings under group headings in brackets, for example, [Remote], in the order the groups appear in the INI file. The available settings are grouped and defined in the table below, and each setting offers two or more options, which are also identified in the table. Use this table as a guide when customizing the file.

Note: The following inserverOutput.ini [Layout], [Printer], and [DICOM] settings only apply to Output Agent running in a Windows environment. Although these settings appear in the inserverOutput.ini file in a Linux environment, they are not functional.
  • [Layout]
    • layout.annotations.show
    • layout.header
  • [Printer]
    • printer.input.tray
    • printer.name
    • printer.driver
    • printer.downscale.color.mode
    • printer.diffuse.black.level.threshold
    • printer.rotate.to.best.fit
  • [Dicom]
    • dicom.ip
    • dicom.port
    • dicom.store.title
    • dicom.external.title
Group Setting Options Description
Remote server.ip.address Any valid IP address

Specifies the IP address of Perceptive Content Server.

The default is specified during installation.

Remote server.ip.port Any existing port number

Specifies the port number of Perceptive Content Server.

The default is specified during installation.

Remote reconnect.interval Any positive integer

Specifies how many seconds Output Agent waits before attempting to reconnect to Perceptive Content Server after a lost connection.

Note: Do not change this value without first consulting Product Support.

The default is 60.

Remote authentication.token Any valid token Specifies the authentication token to use for authentication with Perceptive Content Server.
Documents search.maxresults Any positive integer

Specifies the maximum number of results that Output Agent outputs.

The default is 250000.

Note: The odbc.grid.max.fetch.count setting in the inow.ini file for Perceptive Content Server can also limit the results.
Monitor poll.interval Any positive integer

Specifies how often, in seconds, Output Agent searches the directory specified for the monitor.path setting for new output keyfiles.

Note: Do not change this value without first consulting Product Support.

The default is 15.

Monitor monitor.path Any valid directory

Specifies the path to the directory where Output Agent checks for new output keyfiles.

The default is $(IMAGENOWDIR)\output_agent\monitor.

Monitor monitor.extension Any valid file extension

Specifies the file extension that Output Agent uses to check for output keyfiles.

The default is txt.

General keyfile.delete

TRUE

FALSE

Specifies whether Output Agent deletes the keyfile from the monitor directory after it runs a query.

TRUE = Delete the keyfile.

FALSE = Do not delete the keyfile.

The default is TRUE.
General keyfile.move

TRUE

FALSE

Specifies whether Output Agent moves the keyfile after it runs a query.

TRUE = Moves the keyfile to the directory specified for the keyfile.move.path setting.

FALSE = Do not move the keyfile.

The default is TRUE.

Note: If set to TRUE, keyfile.move.path is required
.
General keyfile.move.path Any valid directory

Specifies the directory that Output Agent uses to store executed keyfiles.

The default is $(IMAGENOWDIR)\output_agent\moved.

Note: f keyfile.move is set to TRUE, this setting is required.
General keyfile.encoding

ANSI

UTF-8

Specifies the expected keyfile encoding.

The default is ANSI.

General output.mode EXPORT

Specifies the output mode that Output Agent uses.

No default is specified.

Note: PRINTER and DICOM are not available on Linux.
General output.incomplete.mailto Any text string

Specifies the email address that receives notifications when page rendering or any other output process does not complete.

The default is blank.

Note: Using a comma-delimited list, you can specify multiple email addresses.
Layout ayout.dpi.max DPI

Specifies the resolution, in dots-per-inch (DPI), that Output Agent uses for output pages.

The default is 300.

Layout layout.units

IMPERIAL

METRIC

PIXELS

Specifies the units of measurement that Output Agent uses.

IMPERIAL = Inches

METRIC = Millimeters

PIXELS = Pixels

The default is IMPERIAL.

Layout layout.margin Any range in the unit specified for the layout.units setting

Specifies the margin space that Output Agent uses for output pages.

The default is 0.

Note: The layouts.units setting determines the unit of measurement used for the margin space.
Layout layout.pages.per.sheet Any positive integer

Specifies the number of pages that Output Agent outputs per sheet.

The default is 1.

Layout layout.pages.per.sheet.spacing Any range in the unit specified for the layout.units setting

Specifies the spacing that Output Agents uses between output sheets.

The default is 0.25.

Note: The layouts.units setting determines the unit of measurement used for the spacing.
Layout layout.pages.per.row Any positive integer

Specifies the number of output pages per row that Output Agent uses for each output sheet.

The default is 1.

Layout layout.width Any range in the unit specified for the layout.units setting

Specifies the width that Output Agent uses for output sheets.

The default is 8.5.

Note: The layouts.units setting determines the unit of measurement used for the width.
Layout layout.height Any range in the unit specified for the layout.units setting

Specifies the height that Output Agent uses for output sheets.

The default is 11.

Note: The layouts.units setting determines the unit of measurement used for the height.
Layout layout.color.depth Any positive integer representing bits

Specifies the color depth, in bits per pixel, that Output Agent uses for output sheets.

The default is 24.

Layout layout.color.mode

COLOR

GRAYSCALE

Specifies whether Output Agent uses color or grayscale for output sheets.

The default is COLOR.

Export export.file.type

The following file formats are most commonly used:

2

3

6

10

11

17

27

29

75

87

146

147

149

150

Specifies the file type that Output Agent uses for output files. The following file formats are most commonly used:

2 = GIF

3 = TIFF

6 = Windows BMP

10 = JPEG

75 = PNG

11 = TIFF with JPEG compression 17 = TIFF with LZW compression

27 = TIFF with G3 compression 29 = TIFF with G4 compression

87 = TIFF with RLE compression

146 = Raster PDF uncompressed

147 = Raster PDF with G3 compression

149 = Raster PDF with G4 compression

150 = Raster PDF with JPEG compression

The default is 17.

Export export.file.extension

The following file extensions are most commonly used:

GIF

BMP

JPG

PDF

PNG

TIFF

Specifies the file extension that Output Agent uses for exported files.

The default is TIFF.
Export export.file.directory Any valid directory

Specifies the directory that Output Agent uses to store exported files.

The default is $(IMAGENOWDIR)\output_agent\export.

Export export.filename.format Any valid text string or the variables listed in Appendix B, "Variables to Create Export File Names."

Specifies the naming scheme that Output Agent uses for exported files. You can define one or more variables and choose to include text for Perceptive Content to generate the file name of an exported document. Enclose variables in brackets. You can separate text and variables with underscores (such as [DOCID]_Page_Number_[PAGENUM]) to make the file name easier to read.

You can also specify the width of some variables (such as [%0[PAGENUM]). Defining the width of a variable helps with file organization when you export multiple files. For more information, refer to Appendix B, "Variables to Create Export File Names."

The default is OutputAgent_[DOCID]_[PAGENUM].

Export export.multipage.document

TRUE

FALSE

Specifies whether Output Agent appends exported files when export.filename.format matches an existing file name.

TRUE = Append exported files to existing documents.

FALSE = Do not append exported files.

The default is FALSE.

Export export.file.dpi Any positive integer

Specifies the dots-per-inch (DPI) that Output Agent uses for exported files.

The default is 150.

Logging debug.level.file 0, 1-6, 9

Specifies the level that Output Agent uses to log errors for troubleshooting.

0 = Turn off logging.

1 = Use the least verbose logging.

6 = Use the most verbose logging. This logging shows the amount of time Output Agent uses to execute calls such as queries from the server to the database.

9 = Turn on logging for timing image processing.

The default is 0.

Logging debug.level.pipe 0, 1-3, 6

Specifies the level that Output Agent uses to log pipe errors for troubleshooting.

0 = Turn off logging.

1 = Use the least verbose logging.

6 = Use the most verbose logging.

The default is 0.

Logging socket.level.file

1

0

Specifies whether to log communication between Perceptive Content Server and Output Agent.

1 = Log communication.

0 = Do not log communication.

The default is 0.