reports manager user manual - connxconnx reports manager enables the generation of reports in just a...

24
ConnX Reports Manager Implementation Manual Copyright © 2006 - 2018 ConnX Pty Ltd 1 of 24 REPORTS MANAGER USER MANUAL VERSION 5.2

Upload: others

Post on 19-Apr-2020

8 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 1 of 24

REPORTS MANAGER USER MANUAL

VERSION 5.2

Page 2: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

2 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

Copyright © 2006 - 2018 ConnX Pty Ltd ABN 46 108 567 960

Reproduction in whole or in part by electronic, mechanical or chemical means,

including photocopying recording or by any information storage and retrieval system,

in any language, is strictly prohibited except in accordance with the Copyright Act 1968.

The information contained within this document is for illustrative purposes only. ConnX

Pty Ltd and its employees accept no responsibility or liability whatsoever for any act or

omission upon the contents of this document.

ConnX Pty Ltd acknowledges that the product and company names mentioned in this

document may be the trademarks of their respective owners.

ConnX Pty Ltd

Level 8

303 Coronation Drive

MILTON QLD

PO Box 1122

MILTON QLD 4064

AUSTRALIA

Ph: 1300 CONNXHR

1300 266 694

Intl: +61 7 3368 2623

Web: www.connx.com.au

Page 3: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 3 of 24

TABLE OF CONTENTS

INTRODUCTION 5

DOCUMENT PURPOSE 5

TYPOGRAPHIC CONVENTIONS 5

GETTING HELP 6

ONLINE HELP 6

DOCUMENTED HELP 6

CONNX SUPPORT 6

1.0 OVERVIEW 7

1.1 WHAT IS CONNX REPORTS MANAGER? 7

1.2 ASSUMPTIONS 7

1.3 FLOWCHART FOR CONNX REPORTS MANAGER 8

2.0 USING CONNX REPORTS MANAGER 9

2.1 OPENING A REPORT 9

2.1.1 NAVIGATION BY DRILLING DOWN 11

2.2 FILTERING REPORTS 13

2.3 REPORTS TOOLBAR 14

2.4 PRINTING A REPORT 16

2.5 EXPORTING DATA 18

2.6 EMAILING A REPORT 20

2.7 SEARCHING A CONNX REPORT 22

2.8 OPENING A REPORT FROM A PAGE 23

Page 4: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

4 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

This page is intentionally blank.

Page 5: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 5 of 24

INTRODUCTION

Document Purpose

This manual has been written to assist you with the implementation of Reports in ConnX.

This manual is also a resource guide for your reference when necessary.

Typographic Conventions

Before you start using this guide, it is important to understand the terms and

typographical conventions used in the documentation.

The following kinds of formatting in the text identify special information.

Formatting

Convention

Type of Information

Bold

Bold text is used in procedures in this document to

show user interface field names, or user interface

items that can be selected or selected, such as buttons

or items in a list. For example,

When you have entered the information, select Next.

Select Update Report Details at the bottom of the

screen.

Italicised text

Italicised text is used in procedures in this document

to show Menus. For example,

Go to Reports > Report Administration.

NOTE

A note contains useful information that can help you

to get the most out of ConnX.

WARNING

A warning contains critical information about the

configuration options available to you which have an

impact on user access and security.

Page 6: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

6 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

Getting Help

Online Help

Immediate help is available in ConnX via the online help system by selecting ? icon in the

top-right of any screen. This is called “context sensitive help”. The help file shown is

related to the specific screen you are using.

Documented Help

This manual, and other manuals related to ConnX, are provided for your use. Please refer

to them if you have any questions about setting up ConnX, or using ConnX.

ConnX Support

Please contact your ConnX Support Representative if you require any assistance.

Contact Address

Ph: 1300 CONNXHR

1300 266 694

Intl: +61 7 3368 2623

Email: [email protected]

Level 8

303 Coronation Drive

MILTON QLD 4064

AUSTRALIA

PO Box 1122

MILTON QLD 4064

AUSTRALIA

Page 7: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 7 of 24

1.0 OVERVIEW

Welcome to the ConnX Reports Manager.

ConnX Reports Manager enables the generation of reports in just a few steps.

This manual describes how to use and operate the ConnX Reports Manager module, load

new reports and how to run, print and export ConnX reports.

1.1 What is ConnX Reports Manager?

ConnX Reports Manager is a powerful reporting module integrated into ConnX to enable

users to generate reports.

ConnX Reports Manager includes a suite of useful reports available for immediate use.

Additional custom reports can be added to your Reports Manager module if required.

Each report has security settings, enabling an organisation to select who in the

organisation has access to the report, and what information they have access to.

Frequently used reports can be ‘linked’ to pages in ConnX, enabling the user to access

these reports with ease.

The Reports Manager module does NOT provide the ability to write reports in ConnX. If

you want to write reports (called authoring reports) you will need to purchase the correct

Crystal Reports software, install it, and have the appropriate skills to use Crystal Reports.

This manual does not explain how to use Crystal Reports. There are various training

providers that can instruct you on how to create or modify a Crystal Report file.

1.2 Assumptions

• You are familiar with navigating web pages.

• You are familiar with PDF files and using Adobe Acrobat®.

• You understand what a “link” is and how to identify one.

• You are familiar with Windows® applications.

Page 8: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

8 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

1.3 Flowchart for ConnX Reports Manager

Create a Report

in Crystal Reports

Register

Report into

ConnX

Set Access

Security

Select

Categories

Set Parameter

Options

Set Report

Users

Link Report

with Page/sOptional

View ReportsSelect a

Category

Select a

Report

Enter

Parameters

Page 9: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 9 of 24

2.0 USING CONNX REPORTS MANAGER

2.0

ConnX Reports Manager allows for the easy viewing and navigating of reports and

information.

2.1 Opening a Report

To access a specific report:

1. Open the Reports Menu via Reports.

2. Select the category (or categories) of report that you want to create by selecting

the category name or icon.

The text label for a category is shown with bold text when that category is selected.

Select the category again to remove the selection. The text label will be shown as

normal text.

You can select more than one category at a time. Only the categories that have

reports are made available on the Reports Menu page.

When you select a category, ConnX shows a list of the related reports at the bottom

of the screen.

Page 10: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

10 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

3. Select View adjacent to the report ID to show that report.

4. Use the filter function at the top of the screen to create reports with more specific

information.

5. Select Show Report.

Page 11: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 11 of 24

2.1.1 Navigation by Drilling Down

The most common way to quickly navigate the reports is to select a specific item in the

report, which then drills down into the report for more detail.

Reports that allow you to drill down will cause the cursor to change from an arrow to a

hand (as shown in the following image) when you move the cursor over objects that can

drill-down or link to another part of the report. Graphs and section headings are common

objects that provide this function.

In the example shown above, selecting the bar “6-10 years” in the graph will “drill down”

and show a list of employees who have been employed with your organisation between

six and ten years.

Page 12: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

12 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

An item opens on a new tab when you drill down into that item, as shown on the

following page. The original result is shown on the Main Report tab.

Page 13: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 13 of 24

2.2 Filtering Reports

You can filter the report to show only a specific subset of the original data if the report

is shown with these parameter settings.

To use the filter function on an open report:

1. Select a value on the drop-down lists to filter the data you want to view. It is not

necessary to enter parameters, even if the fields are available.

2. Select Show Report when you have set any applicable parameters. ConnX shows

the filtered report.

Page 14: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

14 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

2.3 Reports Toolbar

The Report Toolbar is shown at the top of each report. You can use the buttons on the

toolbar to navigate, print, and export the report.

NOTE

The filter at the top of the ConnX Report Viewer screen

determines the primary content of the report.

A description of each button on the toolbar is shown in the following table.

Icon Name Description

Export Data

Export the report to other file formats, such as

Microsoft Word, Microsoft Excel, Adobe

Acrobat, and Crystal Reports.

Print Print the report as a PDF file.

Parameters

All parameters for the report are set using the

filter at the top of the screen,

Group Tree

Enable/disable the Group Tree. The Group

Tree is a navigation tool that appears on the

left side of the report. It allows access to each

section by selecting a field.

First Go to the first page of the report.

Previous Go to the previous page before the current

page.

Page 15: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 15 of 24

Icon Name Description

Page

Numbers /

Go to page

Show the current page number and the total

number of pages. If the number of pages is

shown as 1+, the report has not yet completely

loaded all of the pages.

Key in a number into the page number text

box and press Enter to open that page.

Next Go to the next page after the current page.

Last Go to the last page of the report.

Drill Up

Level

Drill up one level of the report. This is only

available on drill down reports.

Zoom Change the zoom percentage of the report

Find

Search the document for a specific word or

phrase. Key in the word into the text box and

select the binoculars button.

Page 16: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

16 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

2.4 Printing a Report

Reports are printed using Adobe Acrobat Reader®. Acrobat Reader® must be installed

on your computer to print the reports. It is a free program, and available from the Adobe

website at www.adobe.com.

To print a report:

1. Open the report with the data you want to print.

2. Select the Print button on the Report toolbar. ConnX shows the following

window.

3. Set the Page Range that you want to print.

4. Select Export.

Page 17: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 17 of 24

5. Select if you want to Open the file or Save the file to a folder on your computer or

network. The report is opened as a PDF file. You can view and print this file as you

would any other PDF file.

6. Select the Print button in Adobe Acrobat Reader®.

7. Select your print settings.

8. Select Print.

Page 18: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

18 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

2.5 Exporting Data

You can export the data contained in a ConnX report to a variety of file formats (e.g.,

Microsoft Excel®, PDF, XML). This allows you change the format of the report before

printing it or sending it via email, or to perform advanced analysis in another software

application. Any changes that you make to the exported data are not shown in ConnX.

To export the data contained in a report:

1. Open the report with the data you want to export.

2. Select the Export button on the Reports Toolbar. ConnX shows a popup

window.

3. Select the File Format for the report.

4. Select the Page Range to export.

5. Select Export.

Page 19: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 19 of 24

6. Save the document to a folder on your computer or network.

NOTE

It is best practice to save the report before you open it,

as this will ensure you get full functionality in the

associated application.

Page 20: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

20 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

2.6 Emailing a Report

Although there is no email button in the navigation bar, email is a common distribution

method for reports.

To email a report:

1. Select Export on the reports toolbar.

2. Set the file format to PDF.

3. Save the file to a folder on your computer or network. Please refer to Exporting

Data in section 2.5 for more information.

4. Open the folder that the exported file was saved to.

5. Right-click the exported file and select the Send To menu.

6. Select Mail Recipient.

A new email draft opens in your email application. The exported report file is

attached to the email.

Page 21: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 21 of 24

7. Complete the necessary details for sending the email.

8. Select Send.

Page 22: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

22 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

2.7 Searching a ConnX Report

The search box in the Report Toolbar allows you to search for specific information

contained in the report.

To search for specific information in a report:

1. Enter the text that you want to locate into the search box.

2. Select the binocular icon to begin the search. Any text that is the same as your

search text is highlighted.

Page 23: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

Copyright © 2006 - 2018 ConnX Pty Ltd 23 of 24

2.8 Opening a Report from a Page

Most pages in ConnX can show report links if the applicable settings are made on the

Report Page Settings page.

A page can have a report link attached to it if the Reports button is shown in the

top-right corner of the screen.

Select the Reports button to show the user-linked reports for that page.

If a user has permission to access reports, and reports have been set up for a page, the

user can select Report to open the report. ConnX shows the following window.

If there are no reports linked to the page, or if the user is not a report user, ConnX shows

a message that tells the user the reason that the reports are not available.

NOTE

Only Administrators can set up and edit linked reports.

Page 24: REPORTS MANAGER USER MANUAL - ConnXConnX Reports Manager enables the generation of reports in just a few steps. This manual describes how to use and operate the ConnX Reports Manager

C o n n X R e p o r t s M a n a g e r I m p l e m e n t a t i o n M a n u a l

24 of 24 Copyright © 2006 - 2018 ConnX Pty Ltd

This page is intentionally blank.