Vista Plus Output Manager output connector

Output Manager web service

The Vista Plus Output Manager web service must be running before you can submit jobs to Output Manager. For more information about this web service, see the Vista Plus Output Manager documentation.

Platform connector settings

Note:

Some settings for the connector are available in both the platform and runtime configuration. If you specify the same option in both places, the runtime setting is used.

Property	Description
Web Service Profile	Click and select the web service profile. For information about setting up a web service profile, see Creating a web service profile for Output Manager.
Queue	The queue to add the job to. You must specify the queue in either the platform or runtime connector settings.
Account Code	The account number for billing or tracking the job.
Device	The name of the printer or device. Maximum field length = 31 characters.
JME Hosts	The Job Manage (JME) hosts to assign the job to. You can specify multiple hosts using the format: host1,host3,host3
Callback Notifications	Indicates whether Output Manager sends notifications about the job status back to the StreamServer application. This is required to track the Output Manager job status.
Callback Service Name	The service name that will receive the job status notifications. You must also enter this name in the Service name box of the Service Request input connector that receives the job status notifications.
External Job Completion	True – StreamServer applications wait for a job completion notification from Output Manager before marking the top job as completed in the runtime repository. False – StreamServer applications mark the job as completed in the runtime repository after the StreamServe job is successfully delivered from the output connector.

 

Runtime connector settings

 

Property	Description
Job Name	A name for the job. This does not have to be unique. Maximum field length = 19 characters.
Queue	The queue to add the job to. You must specify the queue in either the platform or runtime connector settings.
Comments	A description of the job.
Print Range	The parts of the output you want to print. If you leave this blank, the entire output is printed. You can specify pages, percentages, characters, or a combination of these: • p<page_number> – For specifying a single page. • p<page_number>-<page_number> – For specifying a page range. • #{-#}% – For specifying percentages. • b <start_character>-<end_character> – For specifying a character range. For example: p1-10,p20,95-100%,b2400-36000 Maximum field length = 63 characters.
Queue Priority	The queue priority between 25 (highest priority) and 255 (lowest priority). Note: This has no effect on the Output Manager run-time nice level.
Account Code	The account number for billing or tracking the job.
Spool File Type	Specifies how the print file is spooled: • BINARY – No CR-LF translation is done. Use this option for files with internal formatting characters, such as word processing documents. • TEXT – The print file is spooled as text. We recommend you specify the Spool File Type when transferring files between Windows and UNIX environments.
Device	The name of the printer or device. Maximum field length = 31 characters.
Retention Time	The time a print file is held in a retention queue after it is printed. For information about automatically extracting this by using a script, see Vista Plus Output Manager documentation. Format: This can be either a relative time (e.g. +24:00 – hold for 24 hours) or an absolute time (e.g. 20:00 – hold until 8 p.m.). For a description of the formats, see Deferral Time property.
Page Count	A page count that overrides the calculated value.
Copies	The number of copies to print. The default is 1.
Max. Conc. Jobs	Specifies the maximum number of jobs with the same job name that the Queue Manager (QME) can run concurrently. This applies for both print and batch queues. If you submit several jobs with the same job name and different values for this option, then the QME uses the lowest value.
Printer Form	The name of the form to print the job on.
Device Bind	Use this option to specify a printer, but submit the job to a preliminary queue for pre-processing before it is moved to the queue for printing. If you do not use this option, when a printer is specified for a job, the job waits for that printer until it is available. • COMMAND – The device is bound if $PRINTER is given in the Queue Process of the queue. The job only runs if the associated device is available. • DEVICE – The device is bound if the printer is specified on submission. • NONE – The device is not bound. • REQUIRED – The device being bound is already defined in Output Manager, see Vista Plus Output Manager documentation for more information about defining devices. If the device is defined, the job is sent to the selected device and all the other bind options, such as COMMAND and DEVICE, that are specified are applied.
Device Class Option	The device class option for the job: • CLASSFIRSTAVAIL – Uses the first available device. • CLASSIGNORE – Ignores the class of the device and sends it to any available device. • CLASSFAILOVER – Sets the job recovery for automatic failover so that the system automatically resubmits failed jobs when an error occurs.
Compress	Compresses the output that is sent to Output Manager. Output Manager automatically decompresses the output when it is received.
Encrypt	Encrypts the output that is sent to Output Manager.
Group	The name of the Output Manager group that the job belongs to.
JME Hosts	The JME hosts to assign the job to. You can specify multiple hosts using the format: host1,host3,host3
Output Destination	The destination to send the output to. The default destination is determined by the Queue property. You can specify multiple destinations by separating them with semicolons. Maximum field length = 127 characters.
Deferral Time	The time and date to run the job. You can use a number of formats and keywords to specify the time and date: • HH – Delays the job until the hour specified. • HH:MM – Delays the job until this time. You can add AM or PM. Otherwise, a 24-hour clock is the default. • MM/DD/YYYY – The date to run the job. The year is optional. • MM/DAY – Where DAY is the day or an abbreviation of the day to run the job. For example, both 03FRI and 03FRIDAY run the job on the first Friday in March. • today • tomorrow If no date is specified and the time is later than the current time, the job is run today. If the time is earlier than the current time, the job is run tomorrow. If the given month is earlier in the year than the current month and no year is specified, the job is run next year.
Current Time	The submission time for the job. For information about the format of this time, see Deferral Time property. If you leave this blank, the system time is used as the submission time.
User Name	Submits the job under another user name. Format: <user name>/<password>
Calendar Name	Attaches a predefined calendar to the job. You must have already created and uploaded the calendar to Output Manager by using the calendar utility (qmcal command) or the Windows Administration client.
Schedule Name	Attaches a predefined schedule to the job. You must have already created and uploaded the schedule to Output Manager by using the schedule utility (schedule command) or the Windows Administration client. This option overrides any calendar assigned.
Schedule Options	When to reschedule a repeating job. This is only valid if you use a schedule or a repeat interval. You can use one of the following: • IMMEDIATE – The job is resubmitted after the first job run starts (default). • AFTERSUCCESS – The job is resubmitted after it successfully completes. If it fails, it is removed from the queue. • AFTERCOMPLETION – The job is resubmitted after the first run completes regardless of whether it succeeds or fails.
Orientation	The page orientation for printing the output: • PORTRAIT – The default. • LANDSCAPE • UNDEFINEDORIENT
Plex	Specifies how the printer prints successive pages: • SIMPLEX – On one side of the paper (default). • DUPLEX – Double-sided for binding along the long edge of the paper. • TUMBLE – Double-sided for binding along the short edge of the paper.
Input Tray	The feed tray from which the printer paper is drawn: • UNDFINEDTRAY (Default) • AUTOMATIC • ENVELOPE • MANUAL • TRAY<number> – The tray number, which must be between 1 and 9.
Output Tray	The output tray for the printed pages: • 0 – Undefined (default). • 1 to 50 – The output tray number.
File type	By default the connector determines the file type based on the driver. You can also specify the file type.
Finishing	The type of binding that the printer uses: • NOFINISH or NONE – Does not bind the pages (default). • STAPLE • SINGLEPORTRAITSTITCH • DUALPORTRAITSTITCH • SINGLELANDSCAPESTITCH • DUALLANDSCAPESTITCH • SADDLESTITCH • BIND • UNDEFINEDFINISH
Page Sort	Indicates the order in which the pages are printed: • 1TON – Print from page one to the last page (default). • NTO1 – Print from the last page backwards to page one. • UNDEFINED
Collated	Enables collation, which sends each copy of a multiple-copy job to a separate output tray.
Header	Indicates that a header file must be attached to the beginning of the print file before it is sent to the printer. You can attach the header by using a qmlpd script, or by using another script or program. The location of the header file must be determined by the script or program.
Trailer	Indicates that a trailer file must be attached to the end of the print file before it is sent to the printer. You can attach the trailer file by using a qmlpd script, or by using another script or program. The location of the trailer file must be determined by the script or program.
Reference Directory	The path where the job executes. The default is the directory where the JME process that executes the job runs.
Job Variables	For custom variables and metadata, such as an external job ID, which are used to run the job on the JME host. Format: <variablename1>=<value1>;<variablename2>=<value2> StreamServe Connect for SAP – Delivery Manager To use the SAP Delivery Manager script functions for job tracking, you must set up job variables for the Spool ID, RMG ID, and Device ID. For example: sap_spoolid=$spoolid;sap_rmg_id=$rmgid;sap_device=$device You must create these variables in a script that comes before the output connector, for example before Process.
Queue Entry Access	Specifies the access level for a queue entry in Output Manager. By default, Private is set. This will not enable all web client users to access queue entries when security is enabled for connecting with the web client. • Private – Access is restricted to the user who submitted the job. • Read – Allows web client users to access queue entries. • Update – Allows web client users to access queue entries. • Read Update – Allows web client users to access queue entries.