Wathdoc Tools - WDIS - modes of use

Principle

You can use the WDIS tool to manage an export in an isolated case using a command prompt.

You can also design a task for automating the generation of exports according to a predefined frequency (batch file).

Running a WDIS command

The WDIS tool is saved on the server hosting the kernel1 (by default: C:\Program Files\Doxense\Watchdoc).

In order to generate exports using wdis.exe:

1. check the path to the executable file wdis.exe;

2. open a command prompt;

3. in the command prompt tool, enter the path for accessing the executable file wdis.exe;

4. run the export commands with the correct syntax and using the arguments and values provided below:
   
   

 

Creating an automated export task

In order to automate the generation of exports using WDIS:

1. open a text file (using a notepad-type application);

2. in this file, list the export commands that you want to automate (with the correct syntax and using the arguments and values provided below);

3. save the text file in the C:\Program Files\Doxense\Watchdoc folder, adding the extension .bat;

4. MSWindows^®, create a scheduled task running the saved batch file:

• Windows 2008 R2: https://technet.microsoft.com/fr-fr/library/cc725745.aspx

• Windows 2012: https://technet.microsoft.com/fr-fr/library/aa570151.aspx

Designing WDIS commands

Syntax

The syntax to be used is as follows:

WDIS[OPTIONS]EXPORT EXPORTID

 

The parameters are preceded by a forward slash / and followed by an equal sign = which precedes the value.

The command is constituted from a data model (template) specified by the argument EXPORTID.

This data model can be exported as is, or it can be refined using optional arguments.

Parameters

EXPORTID

This parameter is compulsory and is used to select a data model (template).

• Server: information on the print server status;

• Jobs: print job log;

• Failures : Incident log;

• Transactions: payment transaction histories;

• Queues: print queue status;

• Users: statement per user;

• Roles: statement per role;

• Codes: statement per dynamic code;

• Stations: print statement per work station;

• Formats: statement on the paper formats used;

• Status: statement on the statuses of the print devices;

• Supplies: consumables running low (by default <20);

• Availability: availability of print devices;

• HardwareCounters: counter statement per print device.
  
  

[OPTIONS]

These arguments are not compulsory and are used to specify the scope of the data exploited and the export conditions:

• Format

  • csv: generates an export file in CSV format;

  • xml: generates an export file in XML format;

  • excel: generates an export file in MS Excel^® format.

• Media

  • Email: specifies the email address to which the report is sent;

  • file: used to save the result in a specific file (specify the full path with the file name);

• Period

  • from: specifies the export start date (to be used with 'to');

  • to: specifies the export end date (to be used with 'from');

  • period: specifies an export period (e.g. lastmonth/thismonth/this year/-24h). Cannot be used with 'from' or 'to';

  • range: time in relation to the period (to be used with period);

• Location of the data to be exploited

  • server: specifies the address of the Watchdoc server for which WDIS must exploit the data (in the case of a clustered installation or master installation).

  • site: specifies the website address for which WDIS must exploit the data;

  • group: specifies the identifier of the printer group whose data is to be used by WDIS;

  • queue: specifies the printer group ID for which WDIS must exploit the data;

  • role: specifies the ID of the roles for which WDIS must exploit the data;

  • station: specifies the ID of a specific work station for which WDIS must exploit the data;

• smtp: used to specify the properties of an SMTP server to be used to send the generated report by email. By default, WDIS uses the SMTP settings configured in Watchdoc;

• level: specifies, as a percentage, a threshold below which Watchdoc reports that the consumables are running low. The default value of this threshold is 20%.

 

Values of the Period parameter

The following values can be used for the period parameter:

Current period	today	To select the current specified period. Ex.: /period=thisweek: data from the Monday of the week in which the order is carried out, up to the present time.
	thisweek
	thismonth
	thisyear
Past period	yesterday	To select all of the past period. E.g.: /period=lastmonth: when run in August, this command selects the data from 01 July to 31 July of the same year.
	lastweek
	lastmonth
	lastyear
Rolling period	-<number>[hdwmy]	To select a rolling period depending on the specified duration: h: hour d: day h: hour d: day w: week m: month y: year Ex.: /period=-48h :data for the last 48 hours.
Alternative to the rolling period	range	lastcan be added to the periodparameter, followed by a range parameter to specify the duration. Ex.: /period=last /range=2m: data for the 2 months preceding the execution date.
Specific month or year	YYYYMM	To select the data for the month MM of the year YYYY. Ex.: /period=201508: data from 01 August to 31 August 2015.
	YYYY	To select the data from 01 January to 31 December of the year YYYY.