Guidelines for dataset metadata definition

Helpful guidelines to ensure that the datasets that are defined work correctly on Dashboard Application Services Hub and are able to publish Dashboard Application Services Hub events.

• Share query definitions across multiple datasets. When a query definition deals with the same DataAccess API query type and the same query parameter or metrics IDs, multiple datasets can use the same query definition. The Query Definition must capture all mandatory and optional parameters as defined by DataAccess API. The dataset definition can choose to expose only a subset of the query optional parameters as dataset parameters.
• Dataset definition must define all the mandatory parameters for underlying query definitions as their own mandatory parameters or the dataset can choose not to expose the parameter. But the query definition must specify a default value for the mandatory parameter, which can be used in every execution, since no value is passed for that parameter from the dataset.
• It is advised to use the same IDs for dataset parameters and dataset columns that denote the same information. It ensures that the datasets can participate in drill-down operation. In a drill-down operation, the source widget published event data with using its datasets column IDs, and these values are mapped on destination widgets’ parameter IDs. If the IDs match, the destination widget refreshes itself by filtering its data by using the new parameter values.