Difference between revisions of "DocumentDistribution.xls"

From Vital Soft Wiki
Jump to: navigation, search
>Jeremyb
>Jeremyb
Line 62: Line 62:
 
'''EmailList'''
 
'''EmailList'''
 
     A list of email addresses (separated by a semi-colon) to receive a copy of the created file(s)
 
     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
 +
  - Any value that you enter in a selection box search window is valid
 +
  - Can include $(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
 +
    |}
  
  

Revision as of 17:31, 4 September 2012

Overview

The Document Distribution spreadsheet is used to create specific tasks to generate custom reports and schedule their distribution.

The spreadsheet contains the following sheets: Select, Daily, Weekly, Monthly, Pdfconfig and Emailconfig.

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

   Options: Excel or Report

ReportName

   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

Definition

   Reserved for future enhancements, contact Vital Soft support for information

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

TypeName | TypeValue | Description
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
FIELDNAME | value | Perform a selection on the specified field using the value
 - Any value that you enter in a selection box search window is valid
 - Can include $(varname)
GROUPNAME | value | Selects the specified value in the GROUP to set a dimension
BM_NAME | N/A | Execute the specified bookmark by name
BM_ID | N/A | Execute the specified bookmark using the bookmark ID


Pdfconfig Sheet

Emailconfig Sheet