57.2 Document Viewer Agent Startup Switches

The Viewer Agent is configured by editing its startup file (gwdva.dva). The default location for the startup files varies by platform.

NetWare:

sys:\system

Linux:

/opt/novell/groupwise/agents/share

Windows:

c:\Program Files\Novell\GroupWise Server\WebAccess

The table below summarizes Document Viewer Agent startup switches for all platforms and how they correspond to configuration settings in ConsoleOne.

Switch starts with: a b c d e f g h i j k l m n o p q r s t u v w x y z

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

ConsoleOne Settings

/addrspacename

N/A

N/A

N/A

/cache

--cache

/cache

N/A

/domain

--domain

/domain

N/A

/email

--email

/email

N/A

/hold

--hold

/hold

N/A

/http

--http

/http

N/A

/httpport

--httpport

/httpport

N/A

/httppw

--httppw

/httppw

N/A

/httpuser

--httpuser

/httpuser

N/A

/ip

--ip

/ip

N/A

/lang

--lang

/lang

N/A

/log

--log

/log

N/A

/logdays

--logdays

/logdays

N/A

/loglevel

--loglevel

/loglevel

N/A

/logmax

--logmax

/logmax

N/A

/maxcache

--maxcache

/maxcache

N/A

/maxhold

--maxhold

/maxhold

N/A

/maxprobtime

--maxprobtime

/maxprobtime

N/A

/maxsize

--maxsize

/maxsize

N/A

/maxtime

--maxtime

/maxtime

N/A

/maxtrancache

--maxtrancache

/maxtrancache

N/A

/maxtrantime

--maxtrantime

/maxtrantime

N/A

/maxworkers

--maxworkers

/maxworkers

N/A

/minworkers

--minworkers

/minworkers

N/A

/port

--port

/port

N/A

/relay

--relay

/relay

N/A

/temp

--temp

/temp

N/A

57.2.1 /addrspacename

Runs each Document Viewer Agent worker thread in its own namespace. Specify the base name for the series of address space names that are created for the worker threads. The default base name is GWDVAWRKR, which results in address spaces named GWDVAWRKR1, GWDVAWRKR2, and so on.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/addrspacename-address_space_name

N/A

N/A

Example:

/addrspacename-GWDVA

N/A

N/A

See also /minworkers and /maxworkers.

57.2.2 /cache

Enables the documentation caching capability of the Viewer Agent. See Section 54.7.4, Document Cache

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/cache

--cache

/cache

See also /maxcache, /maxtrancache, /maxtrantime, and /maxprobtime.

57.2.3 /domain

Specifies the mail domain name for the Viewer Agent to use when sending e-mail notifications about quarantined documents. The Viewer Agent sends the notifications as gwdva@domain_name.This is necessary when you have configured the Viewer Agent to notify an administrator whenever a document is quarantined. See Section 54.7.3, Document Quarantine.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/domain-domain_name

--domain domain_name

/domain-domain_name

Example:

/domain-corporate.com

--domain novell.com

/domain-suse.com

See also /hold, /maxhold, /email, and /relay.

57.2.4 /email

Provides the e-mail address of a user that the Viewer Agent should notify when it places a document in quarantine. See Section 54.7.3, Document Quarantine.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/email-”e-mail_address

--email “e-mail_address

/email-”e-mail_address

Example:

/email-”admin@corporate.com”

--email “jsmith@corporate.com”

/email-”postmaster@corporate.com”

See also /hold, /maxhold, /domain, and /relay.

57.2.5 /hold

Enables the document quarantine feature of the Viewer Agent, which is disabled by default. See Section 54.7.3, Document Quarantine

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/hold

--hold

/hold

See also /maxhold, /email, /domain, and /relay.

57.2.6 /http

Enables the Viewer Agent Web console. See Enabling the Document Viewer Agent Web Console.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/http

--http

/http

See also /httpport, /httppw, and /httpuser.

57.2.7 /httpport

Sets the HTTP port number used for the Viewer Agent to communicate with the WebAccess Agent. The default is 7439; the setting must be unique. See Enabling the Document Viewer Agent Web Console.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/httpport-port_number

--httpport port_number

/httpport-port_number

Example:

/httpport-7430

--httpport 7420

/httpport-7410

See also /http, /httppw, and /httpuser.

57.2.8 /httppw

Specifies the password for the Viewer Agent to prompt for before allowing Viewer Agent status information to be displayed in your Web browser. Do not use an existing eDirectory password because the information passes over the non-secure connection between your Web browser and the Viewer Agent. See Enabling the Document Viewer Agent Web Console.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/httppassword-unique_password

--httppassword unique_password

/httppassword-unique_password

Example:

/httppassword-AgentWatch

--httppassword AgentWatch

/httppassword-AgentWatch

See also /http, /httpport, and /httpuser.

57.2.9 /httpuser

Specifies the username for the Viewer Agent to prompt for before allowing Viewer Agent status information to be displayed in a Web browser. Providing a username is optional. Do not use an existing eDirectory username because the information passes over the non-secure connection between your Web browser and the Viewer Agent. See Enabling the Document Viewer Agent Web Console.

NetWare POA

Linux POA

Windows POA

Syntax:

/httpuser-unique_name

--httprefresh unique_name

/httprefresh-unique_name

Example:

/httpuser-GWWebCon

--httpuser GWWebCon

/httpuser-GWWebCon

See also /http, /httpport, and /httppw.

57.2.10 /ip

Specifies the IP address that the Viewer Agent listens on for client/server requests from the WebAccess Agent. The default is the first IP address that the Viewer Agent finds on the server. See Section 54.7.7, Client/Server Configuration.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/ip-IP_address

--ip IP_address

/ip-IP_address

Example:

/ip-172.16.5.18

--ip 172.16.5.18

/ip-172.16.5.18

See also /port.

57.2.11 /lang

Specifies the ISO language code that the Viewer Agent should use if it cannot determine the language of a document that needs conversion. The default is en for English.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/lang-ISO_code

--lang ISO_code

/lang-ISO_code

Example:

/lang-fr

--lang de

/lang-es

See Section 7.0, Multilingual GroupWise Systems for a list of language codes.

57.2.12 /log

Sets the directory where the Viewer Agent stores its log files. The default location varies by platform.

NetWare:

sys:\system\gwdva.dir\log

Linux:

/var/log/novell/groupwise/gwdva

Windows:

c:\Program Files\Novell\GroupWise Server\WebAccess\gwdva.dir\log

For more information, see Section 56.4.3, Controlling Document Viewer Agent Logging.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

  • /log-[svr\][vol:]\dir
  • /log-\\svr\vol\dir
  • --log /dir
  • /log-[drive:]\dir
  • /log-\\svr\sharename\dir

Example:

  • /log-\agt\log
  • /log-\\server2\mail:\agt\log
  • /log-\\server2\mail\agt\log
  • --log /gwsystem/logs
  • /log-\agt\log
  • /log-m:\agt\log
  • /log-\\server2\c\mail\agt\log

Typically you find multiple log files in the specified directory. The first 4 characters represent the date. The next 3 characters identify the agent. A three-digit extension allows for multiple log files created on the same day. For example, a log file named 0518dva.001 indicates that it is a Viewer Agent log file, created on May 18. If you restart the Viewer Agent by restarting the WebAccess Agent on the same day, a new log file is created, named 0518dva.002.

See also /loglevel, /logdays, and /logmax.

57.2.13 /logdays

Specifies how many days to keep Viewer Agent log files on disk. The default is 30 days. See Section 56.4.3, Controlling Document Viewer Agent Logging.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/logdays-days

--logdays days

/logdays-days

Example:

/logdays-5

--logdays 10

/logdays-14

See also /log, /loglevel, and /logmax.

57.2.14 /loglevel

Controls the amount of information logged by the Viewer Agent. Valid settings are Normal, Verbose, Diagnostic, and Off. The default is Normal, which writes only the essential information suitable for a smoothly running Viewer Agent. Use Verbose to save the essential information, plus additional information helpful for troubleshooting. Verbose logging does not degrade Viewer Agent performance, but log files saved to disk consume more disk space when verbose logging is in use. See Section 56.4.3, Controlling Document Viewer Agent Logging.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/loglevel-level

--loglevel level

/loglevel-level

Example:

/loglevel-verbose

--loglevel verbose

/loglevel-verbose

See also /log, /logdays, and /logmax.

57.2.15 /logmax

Sets the maximum amount of disk space for all Viewer Agent log files. When the specified disk space is consumed, the Viewer Agent deletes existing log files, starting with the oldest. The default is 102400 KB (100 MB). The maximum allowable setting is 102400000 (1 GB). See Section 56.4.3, Controlling Document Viewer Agent Logging.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/logmax-kilobytes

--logmax kilobytes

/logmax-kilobytes

Example:

/logmax-3200

--logmax 130000

/logmax-1600

57.2.16 /maxcache

Specifies in megabytes the maximum amount of disk space that the library cache can occupy. The default is 100. To clear out the contents of the library cache, set /maxcache to 0 (zero); this also disables the library cache in the future. See Section 54.7.4, Document Cache.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxcache-megabytes

--maxcache megabytes

/maxcache-megabytes

Example:

/maxcache-150

--maxcache 200

/maxcache-300

See also /cache, /maxtrancache, /maxtrantime, and /maxprobtime.

57.2.17 /maxhold

Specifies in megabytes the maximum amount of disk space that the document quarantine can occupy. The default is 100. To clear out the contents of the quarantine, set /maxhold to 0 (zero); this also disables the quarantine in the future. See Section 54.7.3, Document Quarantine.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxhold-megabytes

--maxhold megabytes

/maxhold-megabytes

Example:

/maxhold-150

--maxhold 200

/maxhold-300

See also /hold, /email, /domain, and /relay.

57.2.18 /maxprobtime

Specifies in days the maximum amount of time a document that cannot be converted remains on the list of problem documents. The default is 5. Section 54.7.4, Document Cache.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxprobtime-days

--maxprobtime days

/maxprobtime-days

Example:

/maxprobtime-3

--maxprobtime 7

/maxprobtime-10

See also /cache, /maxcache, /maxtrancache, and /maxtrantime.

57.2.19 /maxsize

Specifies in kilobytes the maximum size to which a file can grow during the conversion process. The default is 1024. Section 54.7.5, Agent Performance.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxsize-kilobytes

--maxsize kilobytes

/maxsize-kilobytes

Example:

/maxsize-2048

--maxsize 4096

/maxsize-3072

See also /maxtime.

57.2.20 /maxtime

Specifies in seconds the maximum amount of time a worker thread can work on a converting a single document. The default is 120 (2 minutes). Section 54.7.5, Agent Performance.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxtime-seconds

--maxtime seconds

/maxtime-seconds

Example:

/maxtime-240

--maxtime 360

/maxtime-60

See also /maxsize.

57.2.21 /maxtrancache

Specifies in megabytes the maximum amount of disk space that the transient cache can occupy. The default is 20. To clear out the contents of the transient cache, set /maxtrancache to 0 (zero); this also disables the transient cache in the future. See Section 54.7.4, Document Cache.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxtrancache-megabytes

--maxtrancache megabytes

/maxtrancache-megabytes

Example:

/maxtrancache-30

--maxtrancache 50

/maxtrancache-60

See also /cache, /maxcache, /maxtrantime, and /maxprobtime.

57.2.22 /maxtrantime

Specifies in days the maximum amount of time a document remains in the transient cache. The default is 1. Section 54.7.4, Document Cache.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxtrantime-days

--maxtrantime days

/maxtrantime-days

Example:

/maxtrantime-2

--maxtrantime 3

/maxtrantime-5

See also /cache, /maxcache, /maxtrancache, and /maxprobtime.

57.2.23 /maxworkers

Specifies the maximum number of worker threads that the Viewer Agent starts. The default is 8. The maximum number of threads is limited only by available memory resources on the server. Section 54.7.5, Agent Performance.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/maxworkers-number

--maxworkers number

/maxworkers-number

Example:

/maxworkers-6

--maxworkers 7

/maxworkers-8

See also /minworkers.

57.2.24 /minworkers

Specifies the minimum number of worker threads that the Viewer Agent starts. The default is 5. The maximum number of threads is limited only by available memory resources on the server. See Section 54.7.5, Agent Performance.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/minworkers-number

--minworkers number

/minworkers-number

Example:

/minworkers-10

--minworkers 20

/minworkers-30

See also /maxworkers.

57.2.25 /port

Specifies the port number where the Viewer Agent listens for client/server requests from the WebAccess Agent. The default is 7440. Worker threads are assigned ascending port numbers from the primary port number. For example, the first 5 worker threads would be assigned ports 7441 through 7445. See Section 54.7.7, Client/Server Configuration.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/port-port_number

--port port_number

/port-port_number

Example:

/port-7450

--port 7460

/port-7470

See also /ip.

57.2.26 /relay

Specifies the IP address of a relay host if your system includes one. This is necessary if you have configured the Viewer Agent to notify an administrator whenever a document is quarantined. See Section 54.7.3, Document Quarantine.

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

/relay-IP_address

--relay IP_address

/relay-IP_address

Example:

/relay-172.16.5.18

--relay 172.16.5.19

/relay-172.16.5.20

See also /hold, /maxhold, /email, and /domain.

57.2.27 /temp

Sets the path to the directory where the Viewer Agent creates its temporary files. The default varies by platform. See Section 54.7.2, Document Conversion.

NetWare:

sys:\system\gwdva.dir\temp

Linux:

/opt/novell/groupwise/agents/bin/gwdva.dir/temp

Windows:

c:\Program Files\Novell\GroupWise Server\WebAccess\gwdva.dir\temp

NetWare Viewer Agent

Linux Viewer Agent

Windows Viewer Agent

Syntax:

  • /temp-[svr\][vol:]\dir
  • /temp-\\svr\vol\dir
  • --temp /dir
  • /temp-[drive:]\dir
  • /temp-\\svr\sharename\dir

Example:

  • /temp-\dva\temp
  • /temp-\\server2\mail:\dva/temp
  • /temp-\\server2\mail\dva/temp
  • --temp /gwsystem/temp
  • /temp-\dva\temp
  • /temp-m:\dva\temp
  • /temp-\\server2\c\mail\dva\temp