This article outlines the various methods a company admin or user with sufficient permissions can use to extract data from the system.
Analytics / Custom Reports
This tool is one of the primary ways that an admin can extract data from the system.
⚠️ Managers can also utilize the custom reporting tool if the report builder access feature is turned on. Please review this in the article here.
The custom reporting tool can be accessed from the left navigation bar on the home page and will show as either Custom Reports or Analytics (if you have Analytics enabled on your site). For further details on how to create and manage a custom report please see the article here.
An example of a report that can be run is the User details report. To run this report:
1. Navigate to Analytics Custom Reports.
2. Click on My Reports.
3. Search for User details report in the top right.
4. Click on the report to run it.
5. Once generated you will have all the data available in the included columns for all active and inactive users in your system.
6. You can make further adjustments to the report using the custom reporting article mentioned here. It is possible to add, remove or rename columns of data, add filters to return certain results and transform some data.
Standard Reports
Standard reports can be run for many modules with the ability to export the report data in a file.
These can be accessed by clicking on reports in the left navigation bar and then opening the Reports tab.
To Run a report and export the data:
1. Search for the report in the top right search bar.
2. Click the Report link.
3. Some reports may require details to be selected before generating. The form status report is one such report and requires the selection of the form before it will display results.
4. Reports will have some form of export button in the top right. Click Export in the top right for the form status report.
5. Reports may also have a variety of options available under the export feature. Choose the most appropriate option.
6. Exports will be available to download through a link in a notification sent to the requesting user's email.
Exports through the User Administration Menu
It is possible to do a bulk export of user data through the administration menu. This can be done for both General users and Onboarding users and will export User profile data or data from specific sections under the personal or payment details tabs.
⚠️ This method only allows filtering of included users in the administration view.
This method should be used to obtain a copy of current user data before making changes to then perform a user data import for updating user accounts in bulk. Please review the article here for more information on Imports and bulk updates.
1. Navigate to Administration → General → Users.
2. There are several options for exports through the administration menu. By clicking on the Export to CSV button a CSV file of a user's details and profile tab will be generated and sent to the requesting company administrator.
Alternatively Clicking on the dropdown next to Export to CSV provides several other export options.
Extended Profile: Combined export if user profile details and details from the personal and payment details tabs.
Emergency Contact/Next of Kin Details: Contact details from the personal details tab.
Bank Details: Bank details from the payment details tab.
Employment Details: employment details from the payment details tab.
Superannuation Details: superannuation details from the payment details tab.
Taxation Details: Taxation details from the payment details tab.
KiwiSaver Details: KiwiSaver details from the payment details tab.
⚠️ Before exporting an administrator may apply a filter in the top right to limit the list of users exported.
