Reports options

Build 1501 on 14/Nov/2017  This topic last edited on: 25/Aug/2014, at 13:11

Reports options can be stored in the database as global configuration objects, using the standard prefix 'report_'. The reporting options file of the example above can be imported executing

cmd4 config -in report_FolderObjectSize.xml-username xxxx -password yyyy

where PPPP is the path of the archive, xxxx is the name of a GN4 user who can logon to system with sufficient permissions to perform this operation and yyyy is the password.

Note: the above connects to the default connection: should you want to specify the connection or server name, see cmd4 examples.

Once the options have been imported in this way it is possible to use them just specifying their name without the prefix - e.g.

srv4 report -opt FolderObjectSize -out c:\temp\fo.xml -pars folderPath:/system/users/administrator

will produce the same report file as in the previous examples.

SpikedHandling attribute

This attribute allows to read from the database also the data of the deleted objects.

<ropt:ReportOptions

  wfres:activityName="reportArticleFootprintTable"

  xmlns:ropt="http://www.teradp.com/schemas/GN4/1/ReportOptions.xsd"

  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  NavOptions="None"

  SpikedHandling="Include"

  TableName="ReportArticleFootprintTable"

  IsAudit="true">

. . .       

</ropt:ReportOptions>

The possible values are:

Exclude: it reads only the normal (non-deleted) objects

Include: it reads both the normal (non-deleted) and deleted objects

Only: it reads only the deleted objects

If the 'SpikedHandling' attribute is missing then the default value is 'Exclude' (it reads only the non-deleted objects).