Data Export Reports
|
>What are Data Export Reports? >Prerequisites for Working with Data Export Reports >Predefined Data Export Reports and Supported Custom Attributes >Working with Data Export Reports |
>New to Sentinel EMS?
>More on Data Export Reports
|
What are Data Export Reports?
Data export reports provide a way for you to get better insights into your software business dynamics. Data export reports are a collection of reports used for asynchronous data processing and reporting. Predefined data export reports are based on the customer requirements identified through research. These reports can be customized and configured to provide meaningful data. Report generation of data export reports can be triggered manually through the Sentinel EMS user interface or automated through the Sentinel EMS REST API.
You use data export reports to export information of entities such as entitlements, activations, channel partners, customers, products, and custom entities to a CSV file. You can visualize the generated CSV file using any commercial business intelligence tool, such as Microsoft Power BI. Included in the release is a Power BI template offering ready-to-use reference visualization for your business, based on the exported data. Included are views on purchases, deployment rates, new and existing customer growth, and deployment information on channel partners. The Power BI template can also be customized to meet additional requirements.
The benefits of data export reports include:
>Ease of customization and configuration, requiring no SQL expertise.
>Simplicity in selecting custom attributes and filtering by date range.
>Utilization of predefined data export reports to create your own reports that include your custom attributes.
>Provide a mechanism to generate data export asynchronously.
>Downloadable in the widely-compatible CSV format.
Prerequisites for Working with Data Export Reports
>To set up user-defined data export reports: The user must have administrative rights in Sentinel EMS.
>To generate data export reports: The user must have administrative rights or Report Management permissions in Sentinel EMS.
For details, see Roles.
Predefined Data Export Reports and Supported Custom Attributes
Sentinel EMS provides out-of-the-box data export reports that you can configure to display custom attribute details and create user-defined data export reports.
NOTE You cannot create user-defined data export reports for the following:
>The Custom Entities data export report because this report already includes all custom entity attributes.
>
All predefined data export reports for SCL Add-on for RMS because these reports do not support custom attributes and any customization.
The following table lists the predefined data export reports and the input custom attribute entity types, if applicable:
| Predefined Data Export Report | Description | Entitlement | Product Key | Activation | Product | Customer | Channel Partner |
|---|---|---|---|---|---|---|---|
| Entitlements and Activations | Predefined data export report based on entitlement and activation attributes along with their custom attributes. |
|
|
|
|||
| Channel Partners | Predefined data export report based on channel partner attributes and custom attributes. |
|
|||||
| Customers | Predefined data export report based on customer attributes and custom attributes. |
|
|||||
| Products | Predefined data export report based on product attributes and custom attributes. |
|
|||||
| Extended Activations |
Predefined data export report based on additional activation attributes that are not available in the Entitlements and Activations report, such as associated products |
|
|||||
| Custom Entities |
Predefined data export report that retrieves all attributes that are defined for a specific custom entity. You select the custom entity name when generating the report. User-defined data export reports are not supported for the Custom Entities data export report because all of the custom entity attributes are already included in this report. |
||||||
| Data Export Reports Relevant only for SCL Add-on for RMS | |||||||
| Raw Usage | A data export report that displays all usage records for the specified time period. | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable |
| Granular Usage Transactions | A data export report that displays session-related records for individual licensing API calls (login, refresh, and logout) for the specified time period. | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable |
| Vendor Info Usage | A data export report that displays the total usage count per feature for the specified time period, grouped by vendor. | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable |
| Product Usage | A data export report that displays the total usage count per feature for each user of a selected customer, grouped by product. | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable |
| Feature Usage | A data export report that displays the total usage count per feature for the specified time period. | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable |
| User Usage | A data export report that displays the total usage count per feature for the specified time period, grouped by user. | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable | Not Applicable |
Working with Data Export Reports
The following tasks can be performed for data export reports:
>Creating user-defined data export reports: Predefined data export reports are available in Sentinel EMS. If supported, you can configure custom attributes in a predefined data export report to create a new, user-defined data export report. For more information, see Creating User-Defined Data Export Reports.
>Generating data export reports: The predefined and user-defined data export reports can be generated in CSV format. For more information, see Generating Data Export Reports.
>Downloading data export reports: After a data export report is generated, the report can be downloaded from the Data Export Downloads page. For more information, see Downloading Data Export Reports.
Creating User-Defined Data Export Reports
If the Copy 
button is available in the Actions column for an existing data export report, you can create a user-defined data export report that is based on that report.
To create user-defined data export reports:
1.From the navigation pane, select Reports > Data Export Reports to view the Data Export Reports page.
2.In the Actions column for the report that you want to use as a basis for the new data export report, click the Copy button. The Copy Report Template page opens, as shown in the example below:
3.Modify the Data Export Report Attributes as needed.
4.Associate Custom Attributes as needed.
5.Click Save. The report is created and listed in the Data Export Reports page. You can expand the report to view its details. The report is now available for generation, as described in Generating Data Export Reports.
Data Export Report Attributes
The following table explains the attributes that are used to create a data export report:
| Attribute | Description | Required/Optional | Valid Values |
|---|---|---|---|
| Name | Name of the data export report. | Required |
Must be unique |
| Description | Additional information about the data export report. | Optional |
0 to 500 characters |
Associate Custom Attributes
After defining the data export report attributes, you can associate custom attributes, using the Associate Custom Attributes pane displayed below:
The points to remember when you associate a custom attributes with a data export report:
>Custom attributes must already exist for the entity of the data export report being created. For information on creating custom attributes, see Custom Attributes.
>The Entity Type list displays all of the custom attribute entity types supported for the data export report being created. For information on supported custom attribute entity types for each predefined data export report, see Predefined Data Export Reports and Supported Custom Attributes.
>Use the Entity Type and Search lists to filter the custom attributes in this pane.
>Select an Available Custom Attribute from the list to add it to the data export report. The custom attribute appears under Associated Custom Attributes.
>Click 
for an associated custom attribute to remove it from the Associated Custom Attributes list.
Generating Data Export Reports
You must generate data export reports before you can download them. All users with permissions to view reports can generate a data export report.
To generate a data export report:
1.From the navigation pane, select Reports > Data Export Reports to view the Data Export Reports page.
2.In the Actions column for the data export report that you want to generate, click the Generate Report button. The Generate Data Export Report page is displayed.
3.Specify Start Date, End Date, and other attributes (if available) based on which you want to generate the data export report.
4.Click Generate to generate the data export report in CSV format. You can download the report from the Data Export Downloads page. For more information, see Downloading Data Export Reports.
NOTE Data export reports are generated asynchronously, and there may be a delay before they are available for download in the Data Export Downloads page.
Best Practices for Generating Data Export Reports
Some notes on best practices to generate data export reports:
>If you have a large dataset, use relevant filters to reduce the time taken in report generation. Instead of creating one report with a massive amount of data, we recommend running multiple reports with segmented data.
For example, instead of a monthly report, consider generating weekly reports.
Similarly, rather than generating reports for all customers, entitlements, products, or features, narrow it down to specific ones.
> It is recommended to schedule report generation during off-peak hours. Keep in mind that once a report is in progress, it cannot be canceled, so plan accordingly.
Actions for Data Export Reports
The following table lists the actions available for data export reports:
| Action | Description | |
|---|---|---|
|
|
Copy |
Duplicates a predefined data export report to create a new one. This action is available only for predefined data export reports that support the creation of user-defined data export reports. For more information, see Creating User-Defined Data Export Reports. |
|
Edit |
Enables you to update information for an existing data export report. This action is available only for user-defined data export reports and is not available for predefined data export reports. |
|
|
Delete |
Deletes a data export report. This action is available only for user-defined data export reports and is not available for predefined data export reports. |
|
Generate Report |
Initiates the process of generating a data export report. |