Creating a Report
Note: the following requires Admin permissions to your Shipstore environment.
1) To create a report, you'll need to navigate to the Administration menu by clicking Administration at the top of your Shipstore site.
2) Once you've selected Administration, the Navigation menu will appear on the left-hand side. Click Reports.
3) You'll be redirected to the Custom Reports page where you'll click the following button based on whether you wish to create a new report or modify an existing report:
Create new report - Click the blue button that contains the plus symbol (shown below).
Modify existing report - Click the blue edit (pencil) icon to the right of the report you wish to modify.
4) The Report Details page should appear next. This is where you'll configure the Report Name, API Key, Report Fields, and Default Search Fields (defined below).
Report key fields
- Report Name - What you want the report to be called
- API Key - identifier to be included if you want to generate this report via API
- Report Fields - The fields to display when the report runs
- Default Search Fields - The allowed search fields for the report
4a) Enter a Report Name.
4b) Enter an API Key. (optional)
4c) Add Report Fields you wish to see on your report.
1) Click the blue button with the plus sign to add a new field.
2) Select the Object from the dropdown containing the Field Name you wish to see in the report.
3) Select the Field Name you would wish to see in the report.
4d) Add Default Search Fields for the criteria you wish to use on your report.
1) Click the blue button with the plus sign to add a new default search field.
2) Select the Object from the dropdown containing the Field Name you would like to search by.
3) Select the Field Name you would like to search by in the next dropdown.
4) Select the Comparer.
5) Set the Field Data value you would like to have defaulted when the user chooses this report.(optional)
6) Set whether you want this search criteria to be visible to edit by the user or not (useful for creating reports for specific customers).
5) Click Save Changes once complete.
Assigning reports to users
Once a report is created, it may be restricted to one or more users via the Users section of the Administration menu.
1) Select Users.
2) Select the blue edit (pencil) icon next to the user you would like to assign a report to.
3) Toggle Restrict Profiles to ON.
4) Clicking the check box next to the reports you would like to allow the user to see and selecting the blue > icon will move the report to the Allowed side.
5) Be sure to hit the blue save button once complete to save your changes.
