SkyNet Reports
Build your own reports, run them, and get the file in Excel, CSV or by email.
What SkyNet Reports does
SkyNet Reports lets you make your own reports from your company's data, without asking a developer each time. You choose the columns, add filters, and get the result on screen, as an Excel or CSV file, or by email.
A developer prepares views (ready-made lists of data with friendly column names). A Manager connects them as a data source. From there, everything is done on screen by you.
Signing in
- Open the address your Manager gave you.
- Type your username and password and choose Sign In.
- The first time, or after a reset, you are asked to set your own password.
Finding your way around
- Left menu: Dashboard, Reports with your data sources listed under it, and Configuration (Managers only).
- Dashboard: lists your data sources. Click one to open its reports.
- Tabs at the top: every area you open stays open as a tab, so you can switch back and forth.
- Your name (bottom left): My profile, change password, sign out.
- Help: opens this manual.
The report list
| You want to | Do this |
|---|---|
| Find a report | Type in the search box. The list narrows as you type. |
| See one data source | Click its name under Reports in the left menu. The name is then shown at the right of the tabs, and Reports, History and Schedules all show only that data source. Click Reports to see everything again. |
| See only some reports | Choose Favorites, Mine or Public. |
| Keep a report at the top | Click the star. Favorites are always listed first. |
| Open a report | Click its row. |
| Sort the list | Click a column heading. |
| Make your own version | Copy. The copy is private and yours. |
| Use a report on other data sources | Copy, then tick the data sources under Copy to. One copy is made in each ticked data source. If a report with that name is already there, the copy gets 1, 2 and so on after its name. The copy works when that data source has the same view; if not, it tells you the view is not available and you can choose another view. |
| Share or unshare | Make public / Make private (owner or Manager). |
| Remove a report | Delete (owner or Manager). |
Building a report
- Choose + New report.
- Pick a data source and a view. If you have only one, it is chosen for you.
- Untick the columns you do not need. Use the small arrows to change their order.
- Look at the Preview on the right. It shows the first 50 rows and updates after every change.
- Choose Save, give the report a name, and you are done.
Filters and sorting
A filter keeps only the rows you want. Choose + Add filter, pick a column, pick a rule, and type a value. Several filters work together: a row must pass all of them.
| Kind of column | Rules you can use |
|---|---|
| Text | contains, does not contain, is exactly, starts with, is empty, is not empty |
| Number | equals, is not, more than, at least, less than, at most, between, is empty, is not empty |
| Date | this month, last month, today, yesterday, last 7 days, last 30 days, this year, last year, on, before, after, between, is empty, is not empty |
| Yes/No | is Yes, is No |
Sorting: choose + Add sort, pick a ticked column, and choose low to high or high to low. You can sort by up to 5 columns.
Totals and groups
To summarize instead of listing every row, choose a total next to a number column: Sum, Average, Smallest, Largest or Count. The other ticked columns become groups.
Running a report
- In the report list choose Run on a report, or Run inside the builder. A new report must be saved once first.
- If you want, type email addresses to receive the file.
- Choose Excel file or CSV file.
- You are taken to History. Keep working; a big report may take a while.
Filter values in the Run window
When a report has filters, the Run window shows them with the values used last time. Change the values if you want, for example the two dates of a date range, then choose the file type. The values you run with become the preset for the next run.
| Who you are | What you can change |
|---|---|
| Owner of the report, or a Manager | Everything in the report. In the builder, Run also saves any changes you just made. |
| Anyone else on a public report | Only the filter values, and only in the Run window. Inside the report everything is locked. |
History and downloads
| Status | Meaning |
|---|---|
| Waiting | In the queue. It starts by itself. |
| Running | Being made. The number of rows so far is shown. |
| Ready | Finished. The file can be downloaded or emailed. |
| Failed | Stopped, with the reason shown under the status. |
| Cancelled | You or a Manager stopped it. |
- Download gives you the stored file again, exactly as it was made.
- Run again makes a fresh file with today’s data.
- Cancel stops a waiting or running report.
- Delete removes the run and its file.
- To delete several runs, tick them (the box in the heading ticks all on the page) and choose Delete ticked. A window lists exactly the runs that will be deleted.
| Run of | Who can delete it |
|---|---|
| A private report | You. |
| A public report | Only the owner of that report and Managers. Such runs are skipped even when ticked. |
| Any run that is still waiting or running | Nobody. Cancel it first. |
Emailing a file
- In History, choose Email on a Ready row.
- Type one or more addresses, separated by commas (up to 10).
- Add a short message if you like and choose Send.
Schedules
A schedule runs a report by itself and can email the file, for example every Monday at 7:00.
- Open Reports > Schedules and choose + New schedule.
- Pick the report.
- Choose how often: every day, every week (pick the days), or every month (pick the day).
- Set the time and the file type.
- Optionally type who should receive the file by email, then Save.
- Turn off pauses a schedule without deleting it.
- Scheduled files also appear in History.
- For a monthly schedule, day 31 means the last day in shorter months.
Data sources
A data source is one database, or one web API, your users may report on. Open Configuration > Data sources.
| Field | What to enter |
|---|---|
| Type | SQL Server, Oracle or Web API (JSON). For a web API see the next chapter. |
| Server, Port | The database server. The usual port is filled in for you. For SQL Server on the same machine you can enter (local) and leave the port empty. |
| Database | The database name (Oracle: the service name). |
| Schema | Users only see views in this schema. The suggested name is rpt. |
| User name, Password | A database account for reporting. The password is stored encrypted and never shown again. |
| Encrypt / Trust | Leave Encrypt on. Tick Trust only for your own server with a self-made certificate. |
| Save report files in Amazon S3 | Shown when Amazon S3 is filled in under Settings. Ticked: the files of this data source go to the bucket instead of the folder. |
- Fill in the form and choose Test connection.
- When it says Connected, choose Save.
- Use Views on the list to check which views and columns users will see.
Web API data sources
A web API data source lets users report on data that another system gives out as JSON over the web, in the same way as a database view. Users pick a list, tick columns, sort, add totals and run, the same way as with a view. Only the Filters section is not there.
1. Add the data source
| Field | What to enter |
|---|---|
| Type | Web API (JSON). |
| Base address | The start of the address that all lists share, for example https://api.company.com/v1. It must start with https. |
| Sign-in | None, an API key in a header, a bearer token, or a user name and password. The key, token or password is stored encrypted and never shown again. |
| This is an address inside our own network | Leave it off for an API on the internet. Tick it only for a server inside your own network; only then are internal addresses and plain http allowed. |
- Fill in the form and choose Test connection. A result window opens with the status, the time it took, the size, and the answer.
- Choose Create.
2. Add the lists
A list is one address of the API that returns rows, for example the orders. Choose Lists on the row of the data source, then + New list.
| Field | What to enter |
|---|---|
| Name users see | A friendly name, for example Open orders. |
| Address after the base | The rest of the address, for example /orders?status=open. |
| Pages | How the API hands out many rows: everything in one answer, by page number, by offset and limit, or with a link to the next page. The usual parameter names are filled in for you. |
| Rows are in | Normally found automatically. If not, choose it in the test window. |
- Choose Test. The result window opens on Rows and shows the first rows with the columns and their kinds (text, number, date, yes/no).
- If the rows are not the right ones, open Body and choose Use as rows on the part of the answer that holds them.
- Choose Save list. The columns are remembered; save the list again when the API gets new columns.
| Tab in the result window | What it shows |
|---|---|
| Body | The answer of the API. JSON is shown as a tree you can open and close. |
| Headers | The headers the API sent back. |
| Rows | The first 50 rows the way users will see them. |
/orders?status=open, and add another list when users need another selection. Sorting and totals are worked out after the rows arrive. The preview uses only the first page; a run reads all pages, up to 200,000 rows.Preparing views (for developers)
Users never see tables, only views in the schema of the data source. Give every column a friendly name; that name is what users see.
CREATE SCHEMA rpt;
GO
CREATE VIEW rpt.[Sales Orders] AS
SELECT o.ord_no AS [Order No],
o.ord_dt AS [Order Date],
c.cust_nm AS [Customer],
o.amt AS [Amount]
FROM dbo.orders o
JOIN dbo.customers c ON c.cust_id = o.cust_id;
GO
CREATE LOGIN report_reader WITH PASSWORD = '...';
CREATE USER report_reader FOR LOGIN report_reader;
GRANT SELECT ON SCHEMA::rpt TO report_reader;
- Join and clean the data inside the view, so users do not have to.
- Leave out columns users must not see.
- A new view appears to users right away; nothing has to be set in SkyNet Reports.
- If you rename or remove a column, reports that use it show a message asking to save the report again.
Users and data sources
- Open Configuration > Users and choose + New user.
- Enter the name, username and email and choose Create.
- The person gets an email with a link to set a password. The link works for 24 hours.
- The new user gets the role User. Change the role if needed and tick the data sources this person may use, then save.
| Status | Meaning |
|---|---|
| Pending | Created, but the password is not set yet. The person cannot sign in. It changes to Active by itself when the password is set. |
| Active | Can sign in. |
| Inactive / Suspended | Switched off by a Manager. |
- If the email was lost or the link ran out, open the user and choose Send link again.
- If the server cannot send email, type a temporary password when you create the user and give it to the person. They must change it at the first sign-in.
- At least one active Manager must always remain, and the Manager role cannot be deleted.
Roles and permissions
Two roles are ready to use: Manager and User. Most companies never need more.
- Roles: add a role if some people need a different set of rights, for example users who may run but not build reports.
- Permissions: tick the pages, tabs and actions for each role.
- The Manager role always keeps full access, so you cannot lock yourself out.
Settings
| Setting | What it does |
|---|---|
| Name | The name shown on the sign-in page, the menu and in emails. |
| Largest report file (MB) | A report that grows past this size is stopped. |
| Most rows in one report | A report with more rows is stopped. Excel itself holds 1,048,575 rows. |
| Keep report history (days) | Older runs and their files are removed automatically. |
| Allowed email domains | Reports can only be emailed to these domains, for example company.com, partner.org. Empty means no emails. |
| Largest email attachment (MB) | A bigger file is not attached; the email says where to download it. |
| Report files folder | The folder on the server where finished report files are saved. Leave it empty to use the reports folder of the web site. |
Amazon S3 (optional)
Report files can be saved in an Amazon S3 bucket instead of the folder on the server. Fill in the Amazon S3 box once; all data sources share the one bucket.
| Field | What to enter |
|---|---|
| Bucket | The name of the bucket only, for example my-company-reports. |
| Region | The region of the bucket, for example us-east-1. |
| Access key, Secret key | The keys of an AWS user that may read, write and delete files in this bucket only. The secret key is stored encrypted and never shown again. |
- Choose Test. It writes a small test file, reads it and deletes it again.
- When it says Connected, choose Save.
- Open Data sources, edit a data source and tick Save report files in Amazon S3. Data sources without the tick keep using the folder.
- Files are saved in the bucket as
UserId / DataSourceId / file name, the same way as in the folder. - Users notice no difference: download and email work as before. A download always goes through SkyNet Reports; nobody gets a link to the bucket.
- Deleting a run, and the automatic clean-up, also delete the file in the bucket.
- To switch S3 off, empty the bucket and both keys and choose Save.
Activity log
Configuration > Activity shows who signed in and what was changed. When a report could not be run, the technical reason is written here for you, while the user only sees a plain message.
The report service
Reports are made by a small program on the server, the SkyNet Report Service. It starts with Windows and keeps working when nobody is signed in.
- Finished files are saved in the report files folder (see Settings), in one folder per user and data source. The database keeps only the history.
- An icon near the clock shows its state: green = running, grey = stopped.
- Click the icon for its settings: database, encrypt key, mail server, how many reports run at the same time, and the longest time one report may take.
- Right-click the icon to start, stop or restart the service, or to open its log folder.
- Exit closes only the icon. The service keeps running.
If something does not work
| What you see | What to do |
|---|---|
| A run failed with a message about Amazon S3 | Tell your Manager. The Amazon S3 box in Settings needs to be checked with its Test button. |
| A run failed: the data source answered with an error | The web API did not answer correctly. Try again later, or ask your Manager to test the list in Data sources. |
| "You have no data source yet" | Ask your Manager to tick a data source for you. |
| The preview says the data source cannot be reached | Tell your Manager. The connection needs to be checked in Data sources. |
| "This took too long" in the preview | Add a filter (for example a date), then try again. Or save and Run; a run may take much longer than a preview. |
| A run failed: too many rows / file too big | Add a filter, untick columns, or choose CSV instead of Excel. |
| A run failed: the file could not be saved | Tell your Manager. The report files folder in Settings is missing or the server may not write to it. |
| "A column in this report is not in the view any more" | Open the report, check the columns, and save it again. |
| Reports stay on Waiting | The report service is not running. Tell your Manager. |
| An email address is refused | Only allowed domains can receive reports. Ask your Manager. |
| Email failed | Check the address. If it is right, tell your Manager; the mail settings of the service may need a look. |
| Locked after wrong passwords | Wait 15 minutes, or use Forgot password. |
Keeping data safe
- You only see the data sources your Manager gave you.
- Private reports stay private. Make a report public only when it is meant for everyone on that data source.
- A downloaded or emailed file leaves the system. Treat it like any company document.
- Sign out on shared computers.
- Changing your password signs out your other devices.