Add / Edit Data Set

Info Center > Configure & Design > Name Value Parts > New Data Set or Edit Data Set

The New Data Set or Edit Data Set window specifies the custom data set used to return a single value from a SQL database. The custom data set uses either a SQL select statement or a stored procedure to return data. The value in a selected column, returned by the first row of data, is the value displayed in the report.

Action

• Create Registration File - Once you have added or edited a name value part using this dialog:
  1. Click Create Registration File. A link to a generated data set XML displays on the subsequent dialog page.
  2. Download the data set XML and place it in the following location: \<KServerInstallDirectory>\Xml\Reporting\Custom\DataSetRegistration\1
  3. Click the System > Server Management > Configure > Change Reporting Configuration > Run Registration button to register the new or modified data part XML with your VSA.

Properties

• Name - The name of the custom data set.
• Description - A longer description of the custom data set.
• Category - The Name Value Parts folder, typically corresponding to a module, that a custom data set is located in.

SQL Definition

• Return Column - The data column in the SQL select statement that contains the value that will be used in the published report. The value in the first row of data returned is used.
• Caption - The caption displayed with the value on the published report.
• Data Type - The data type returned. This data type must be compatible with the data type of the data column in the SQL select statement.
  • STRING
  • INT
  • DECIMAL
  • DATE
  • BOOLEAN
• Context - Determines the type of filter displayed just before a report is generated. The context should be compatible with the data returned by the SQL definition. For example, if the data returned by the SQL definition supports filtering primarily by agent machines, then the selected context should be MachineFilter.
  • MachineFilter
  • ServiceDeskFilter
  • AssetsFilter
  • DevicesFilter
  • MobileDevicesFilter
  • TicketingFilter
• Text - A SQL select statement that returns one or more columns of data. Only the first row of data returned by the SQL select statement is used.
• Stored Procedure - The name of a stored procedure and any user defined parameters. Only the first row of data returned by the stored procedure is used.

Parameters

User-defined parameters specified by a SQL select statement or stored procedure must be registered here. This enables report templates and name value parts to display these parameters in configuration dialogs.

Actions

• Add Row - Adds a parameter row.
• Delete Row - Deletes a selected parameter row.

Columns

• Param Name - The name of the parameter.
• Param Value - The default value for the parameter.
• Param Type - The data type of the parameter.
  • STRING
  • INT
  • DECIMAL
  • DATE
  • BOOLEAN
• Size - The size of the parameter.
• Description - Enter a description of the acceptable values supported by this parameter. When selecting a different value for a parameter, users can reference this description by hovering the cursor over a parameter's name to display its tooltip.