Difference between revisions of "DocumentDistribution.xls"
>Johno (→Overview) |
>Johno (→Overview) |
||
Line 15: | Line 15: | ||
/VSJOBS/JVSRELOAD taskgroup Load=N Print=BoardReports | /VSJOBS/JVSRELOAD taskgroup Load=N Print=BoardReports | ||
− | [[Setting up Document Distribution| | + | [[Setting up Document Distribution|Document Distribution Overview]] |
== Select Sheet == | == Select Sheet == |
Revision as of 21:11, 18 April 2013
Contents
Overview
The Document Distribution spreadsheet is used to create specific tasks to generate custom reports and schedule their distribution.
By default, the spreadsheet contains the following sheets: Select, Daily, Weekly, Monthly, Pdfconfig and Emailconfig.
The name of the sheet "Daily", "Weekly", "Monthly" matches the report frequency that is passed via vsreload:
/VSJOBS/JVSRELOAD taskgroup Load=N Print=Daily
Additional custom frequency sheets can be added, for example BoardReports, Finance, Tuesday etc.
Custom frequencies are executed via a call to JVSRELOAD
/VSJOBS/JVSRELOAD taskgroup Load=N Print=BoardReports
Document Distribution Overview
Select Sheet
Name
The Unique name of the selection grouping
Step
Sequence number (1 to N), the execution order of each step
Type
The type of action for the step of the selection
TypeName
Name of the Action, Bookmark, Field or Dimension
TypeValue
Corresponding value for the action.
Daily, Weekly, Monthly Sheets
DocumentName
The name of the QlikView (qvw) file Note: the extension .qvw is not required Note: a quick way to temporarily disable the printing of a document is to precede the name with a #
ExportType
Excel
- For Excel, the definition must be the name of an Excel Definition File.
Report
- For Report, specify the QlikView report name (or report ID) for the report that you wish to print.
Export
- For Export, specify the QlikView object ID for the chart (or table) that you wish to export.
Definition
The QlikView object ID or report name Note: for excel exports, it must be the object ID
OutputFilename
The name of the Excel or PDF file being created Available tags for dynamic file names: <band> - The current banding value <date> - The current date $(varname) - The value of any qlikview variable
FileExistsAction
Purge is the only action currently supported
Selection
The name of a selection to execute prior to export. Selections are listed in the Select tab
Banding
The field that the export should use for every distinct value, example: MBR_BRANCH_NAME
PrinterName
The name of a printer to physically print the report Note: this field is usually blank
EmailList
A list of email addresses (separated by a semi-colon) to receive a copy of the created file(s)
Selection Options
Type | TypeName | TypeValue | Description |
---|---|---|---|
Action | Clear | N/A | Clears all selections |
ClearAll | N/A | Same as Clear | |
LockAll | N/A | Locks all currently selected fields | |
UnlockAll | N/A | Unlocks all currently selected fields | |
ClearField | FIELDNAME | Clears the specified field | |
ClearOther | FIELDNAME | Clears all fields except the specified field | |
Lock | FIELDNAME | Locks the specified field | |
Unlock | FIELDNAME | Unlocks the specified field | |
SelectPossible | FIELDNAME | Selects all possible values for the specified field | |
SelectExcluded | FIELDNAME | Selects all of the excluded values for the specified field | |
Execute | ButtonID | Executes a click for the button ID | |
Field | FIELDNAME | value | Perform a selection on the specified field using the value
Note: may contain any value that you enter in a selection box search window is valid and may contain $(varname) |
SetDim | GROUPNAME | value | Selects the specified value in the GROUP to set a dimension |
Bookmark | BM_NAME | N/A | Execute the specified bookmark by name |
BM_ID | N/A | Execute the specified bookmark using the bookmark ID |
Pdfconfig Sheet
PDFPrinterName
The name of the PDF printer, default : VitalSignsPDF
FileCreatePath
EmailLinkPath
The root url to an intranet path to pre-pend in report links within emails
Emailconfig Sheet
FromUserName
This will appear as the From in the Email
SmtpServer
The IP address of the SMTP server
SmtpPort
The Port that the SMTP server is listening on
SendUserName
The Username for authentication with the SMTP server
SendPassword
The Password for authentication with the SMTP server
SendUsing
Values 1 to 3 (Default 2) 1 cdoSendUsingPickup 2 cdoSendUsingPort 3 cdoSendUsingExchange
SmtpAuthenticate
0 or 1 (Default 1)
SmtpUseSSL
0 or 1 (Default 0)
SmtpTimeOut
Timeout in seconds (Default 60)
AttachmentsOk
Yes or No (Default: No)