DocumentDistribution.xls

Overview

The Document Distribution spreadsheet is the primary definition for all custom reports for all Vital Signs applications. The file consists of a select sheet, multiple "Frequency" sheets and two additional configuration sheets.

• Select Sheet

This sheet contains global select definitions available to all report requests. Selections for simple exports and QlikView PDF reports must be defined here. Selections for Excel Template Reports may be defined here or in the template definition file.

• Frequency Sheets (Daily, Weekly, Monthly, ...)

By default, the spreadsheet contains three sheets that define the standard reporting frequencies: Daily, Weekly and Monthly.

The name of the sheet must match the report frequency that is passed via vsreload:

 /VSJOBS/JVSRELOAD task 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 task Load=N Print=BoardReports

Document Distribution Overview

Note: Whenever a new frequency sheet is added, a corresponding change must be made to the vReportFrequencies variable in the main Vital Signs configuration file.

Select Sheet

Selections defined in the select sheet of the DocumentDistribution file are global and are accessible to all report requests. A selection consists of one or more steps that share the same selection name. Each step is entered on a separate row and is given a unique step number that determines the order of execution for that step within the overall selection. The step is defined by the Type, TypeName and TypeValue columns which are described in more detail.

Name

The Unique name of the selection. All steps in the same selection use the exact same name.

Step

Sequence number (1 to N), the execution order of each step.

Type

The type of action for the current step of the selection. Types can be actions, field selections, bookmark selections, ...

TypeName

Name of the Action, Bookmark, Field or Dimension

TypeValue

Corresponding value that varies depending on the type of action. For example, it could be the name of the bookmark, or a value for a field selection.

Frequency Sheets: Daily, Weekly, Monthly, ...

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

Configuration Sheets

There are two configuration sheets that must be setup: PDFConfig and EmailConfig.

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)