send2pls.exe - Usage¶
send2pls.exe is a command line tool that sends files to a PLOSSYS 4 or PLOSSYS Output Engine.
You can integrate it in any batch script.
Overview¶
| Server-related | Job-related | Other |
|---|---|---|
-dest |
-assocfile |
-cleanheader |
-failoverhost |
-defaultheader |
-cleaninf |
-followtime |
-file |
-cleanup |
-host |
-grepnographicfile |
-help or -h |
-lboff |
-jobidfile |
-logfile |
-lbrandom |
-jobname |
-loglevel |
-lbserver |
-noheader |
-msg |
-maxconnectretry |
-noplotid |
-noclean |
-no_ipp_halfclose |
-noquick |
-nomsg |
-pingtimeout |
-numheaditems |
-rdonlyheader |
-pipe |
-param |
-version or -v |
-port |
-plotter |
-wait |
-retrymax |
||
-retrywait |
||
-serverlist |
List of Options¶
Hint - mandatory option
The -file option is the only one that is mandatory.
All other options are optional.
-assocfile¶
Extension of an optional file, which is to be transferred to the gate.
Specify the extension without preceding dot, e. g. stp.
-
Syntax:
-assocfile <EXTENSION> -
Values:
Value Description allall nonone <EXTENSION>only the file with the specified extension -
Default:
all
-cleanheader¶
Delete the header file after sending job.
-cleaninf¶
Delete the .inf file of the port monitor after sending job.
-cleanup¶
Delete all job files after printing.
Hint - default
-cleanup is the default, if no cleaning option is specified.
-defaultheader¶
Values from this file are put in front of the values from the job header file.
This way they have a lower priority.
- Syntax:
-defaultheader <default_header_file>
-dest¶
Target directory to which the job is sent.
-
Syntax:
-dest <gate> -
Default:
-
As of version 1.79:
%PLSIO%/stargate -
Earlier versions:
%PLSIO%/ps2tiffgate
-
-eval_win_inf_copies¶
Defines whether the WIN_INF_COPIES header item is to be read from the .inf file.
Hint - SEAL Master Driver only
This option is used only for spool files of SEAL Master Driver.
-
Syntax:
-eval_win_inf_copies yes -
Values:
Value Description yesWIN_INF_COPIESis setnoWIN_INF_COPIESis not set -
Default:
yes
-failoverhost¶
List of servers, which is used, if none of the servers listed in the -serverlist option can be reached.
- Syntax:
-failoverhost "<host>:<port> <host1>:<port1>..."
Hint - -serverlist vs. -failoverhost
If load balancing is activated, send2pls uses the servers in -serverlist to find one with fewer jobs. If the selected server is not reachable, send2pls searches through the servers in -serverlist to find another one.
If none of the serves in -serverlist is reachable, send2pls switches to -failoverhost. If -failoverhost contains a list of servers, the load balancing continues with those servers.
Additional options, e.g. -lbrandom, -lbserver or -lboff allow for adjustments of this behaviour according to your needs.
-file¶
Name of the graphic file to be printed.
- Syntax:
-file <file>
-followtime¶
Time in seconds to send a following job to the same load balancing server.
- Syntax:
-followtime <seconds>
Hint - only for load balancing
If the -followtime option is used, severals jobs are sent to the same server, despite the active load balancing.
This ensures the jobs are printed one after the other without mixing them up.
-grepnographicfile¶
Disables the parsing of header items in a graphic file.
Caution - PLOSSYS Output Engine
In case of a PLOSSYS Output Engine this option is mandatory.
-help or -h¶
Prints the usage of send2pls.exe to the command line.
-host¶
Server to which the job is to be sent.
-
Syntax:
-
-host <host> -
In case of load balancing:
-host "server1 server2 server3"
-
-
Default:
-
If this option is absent, the value is read from the spool file.
-
If this does not work, the value is finally read from
knetclnt.cfg. -
If load balancing is activated, you have to enter a list of possible servers.
-
Hint - port number required
If you transfer the data via kNet connection, you have to specifiy both, the -host option and the -port option.
-jobidfile¶
Path and name of the result file for collecting the JobIds that are returned via IPP.
Each JobId is written into a separate line.
If the file already exists, the new JobId is added at the end of the file.
-
Syntax:
-jobidfile <file> -
Default:
JobIds returned via IPP are logged as info messages.
-jobname¶
-
Syntax:
-jobname <name> -
Default:
-
The
job-nameattribute is set for IPP transfer. -
The
PLS_PLOTIDheader item is always set to the specified name.
-
-lboff¶
No loadbalancing
-lbrandom¶
Loadbalancing by random choice
Hint - IPP/IPPS
For IPP/IPPS communication this option is set automatically.
-lbserver¶
Loadbalancing only for server list
-logfile¶
Name of the log file
-
Syntax:
-logfile <log file> -
Default:
-
The value is taken from the
.inffile of the port monitor, if it is specified there. -
Otherwise the log messages are printet to the screen.
-
-loglevel¶
-
Syntax:
-loglevel <log level> -
Values:
Value Description 0none 1errors 2infos 3diagnose 4debug 5debug IPP (only to log file) -
Default:
-
The value is taken from the
.inffile of the port monitor, if it is specified there. -
Otherwise
1is used.
-
-maxconnectretry¶
Sets the maximum number of retries to connect to kNet.
-
Syntax:
-maxconnectretry <number of retries> -
Default:
0
-msg¶
Command to be executed in case of an error, e.g. net send %PLS_USERNAME%.
-
Any variables are expanded before calling the command.
-
PLS_USERNAMEandPLS_SRCNODEare set in the programm before this call. -
The option without any argument displays a message box.
-
Syntax:
-msg <command or message text>
-no_ipp_halfclose¶
After finishing the IPP transmission send2pls closes the sending socket connection and waits for the status response from the receiving server.
If the receiving server does not support this behavior, send2pls can disable the unidirectional closing of the connection by using the no_socket_halfclose switch. Then send2pls closes the bidirectional socket connection only after receiving the status response.
-noclean¶
Do not delete any files after printing.
-noheader¶
Do not generate a header file.
-nomsg¶
Supress message boxes.
Hint - terminal servers only
This option is necessary, if send2pls is used on Microsoft Windows terminal servers.
-noplotid¶
Disables the generation of a new PLOTID. This way, the old PLOTID is preserved.
-noquick¶
The file type recognition is omitted.
-numheaditems¶
Header items are serially numbered by replacing the # placeholder.
-
Syntax:
-numheaditems <value> -
Values:
Value Description pp"per page"
Placeholders are replaced by page numbers.po"per order"
Placeholders are replaced during enumeration.no"no"
Placeholders are not replaced. -
Default:
pp
-param¶
Sets the specified value for the header item specified as <key>.
This option may be used multiple times.
-
Syntax:
-
-param <key>=<value> -
-param <key1>=<value1> -param <key2>=<value2> -param <key3>=<value3>
-
-pingtimeout¶
Timeout in seconds if availability of loadbalancing servers is to be checked additionally by SEAL ping command:
-
Syntax:
-pingtimeout <seconds> -
Values:
Value Description 0no check (default) [1..100]Specified number is used as timeout in seconds. other values Default timeout is used. -
Default:
5
Hint - only for -lbrandom or -lboff
-pingtimeout is only required for -lbrandom or -lboff.
-pipe¶
Pipe name of the FRANS server without FRANS_
-
Syntax:
-pipe <name> -
Default:
PLOSSYS
Hint - data transfer via IPP
Use the ipp pipe name and 631 port number or the configured port number of PLOSSYS-IPP-Server.
Hint - data transfer via IPP with SSL encryption
Use the ipps or https pipe name and the 443 port number or the configured port number of PLOSSYS-IPP-Server.
-plotter¶
Value to be used with the PLS_PLOTTER header item.
- Syntax:
-plotter <plotter>
Hint - priority
This option takes precedence over any value specified in the spool file.
Hint - PLOSSYS header items
This option is to be used with drivers that do not have PLOSSYS header items in the spool file, e. g. HPGL or generic/text.
-port¶
Port number of the FRANS server
-
Syntax:
-
-port <number> -
In case of load balancing:
-port "7001 7002 7005 7185"
-
-
Default:
-
If this option is absent, the value is read from the spool file.
-
If this does not work the value is finally read from
knetclnt.cfg.
-
Caution - numbers of hosts and ports
The number of elements in the list of port numbers has to match the number of servers specified in the -host option.
-retrymax¶
Maximum number of connection retries for any specified server
-
Syntax:
-retrymax <number> -
Default:
0
-retrywait ¶
Waiting time in seconds between two attempts to set up a connection to kNet.
-
Syntax:
-retrywait <seconds> -
Default:
0
-rdonlyheader¶
Do not modify the header file.
-
Default:
The
PLS_PLOTTYPE,PLS_SRCNODE,PLS_USERNAME,PLS_PLOTIDitems and the content of an optional default header are inserted at the beginning of the header.
-serverlist¶
List of servers used for load balancing.
- Syntax:
"<host>:<port> <host1>:<port1> <host2>:<port2> ..."
Hint - priority
This option takes precedence over the -host and -port options.
Hint - -serverlist vs. -failoverhost
If load balancing is activated, send2pls uses the servers in -serverlist to find one with fewer jobs. If the selected server is not reachable, send2pls searches through the servers in -serverlist to find another one.
If none of the serves in -serverlist is reachable, send2pls switches to -failoverhost. If -failoverhost contains a list of servers, the load balancing continues with those servers.
Additional options, e.g. -lbrandom, -lbserver or -lboff allow for adjustments of this behaviour according to your needs.
-version or -v¶
Prints the version of send2pls.exe to the command line.
-wait¶
Waiting time in seconds until the job files are to be accessed by the following process.
This may be useful in slow file systems, e. g. network file systems. If a process has successfully written and closed a file, it may still take a few seconds until the next process can access this file.
-
Syntax:
-wait <seconds> -
Default:
0