Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

This guide is for the Data Warehouse Report Server (CCC Data 2.25.0) released to production on January 27August 16, 2023.

In This User Guide

Table of Contents
maxLevel1
absoluteUrltrue

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#F4F5F7

Note: All hyperlinks in this document open in the same window.

Part 1: Overview

The information provided in this document serves as a "Quick Start" guide for users of the CCC Data Warehouse Report Server (“DW Report Server”, “Report Server”, “DWRS”), including:

...

Access to the DW Report Server is restricted to authorized users to ensure the privacy and security of the data within the CCC Data Warehouse. Users must request access using via one of the appropriate processes below , and upon approval will be granted an account based on their user type.

...

Getting Started

Establishing an authorized DWRS user account is a two-part workflow between a CCCTC Administrator and the approved user. An Enabling Services Implementation Configuration Engineer (ICE) will create and configure the account in our internal system and then work with the user to complete the final steps and loginlog in, depending on the user type. This section of the document outlines the roles and responsibilities - and setup tasks - for the CCCTC Administrator and the approved DWRS user.

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Contact your College Relationship Manager (CRM) from the CCCTC Enabling Services team to request authorized access or setup an approved account, today.

User Accounts

Access to the DWRS requires an authorized user account configured based on user type. There are two types of authorized user accounts:

  • SSO Users: Colleges and Districts using their institution’s IDP for single sign-on. The institution’s login may include (CCCTC does not manage your institution’s two-factor authentication (2FA) , but this SSO mechanism is not managed by the CCCTC.mechanism, if implemented.)

  • Non-SSO Users: CCCCO, CVCOEI, and other authorized external users will authenticate directly to the DWRS using 2FA to secure and protect our systemwide student data.

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFFFF

College & District SSO Users: See Appendix A: Data Warehouse Report Server URLsfor your custom IdP URL.

Set Up & Log In Processes

The process for account setup and login log in will be different depending on user type, access level, and the mechanism used to authenticate. Working with an Implementation & Configuration Engineer (ICE) from the CCCTC Enabling Services team to set up and configure your account, college & district users (SSO Users) will be are provided a custom URL configured to your institution’s institution MIS code and internal IdP link. Non-SSO Users will be directed to the DWRS directly to log in and complete URL to complete additional setup & verification tasks steps to facilitate authentication.

Below is an explanation of the setup process followed by summaries of the login process for each of the two authentication methods.

...

Prerequisites for All Users

Before a user can log into in to the DWRS the following conditions must be met:

  1. The authorized user has followed the Getting Started tips above and has coordinated with CCCTC Enabling Services to begin the account creation setup and configuration process based on their user type and access level.

  2. The account has been configured CCCTC Enabling Services has added and configured your account with the appropriate roles , and attributes, and - for SSO Users only - their institution’s IDP linkhas sent your account credentials via secure method.

  3. SSO Users have received their Only: You have bookmarked your unique college or district DWRS URL, configured to their IDP, and know their your institution’s IdP single sign-on credentials provided to them by their (managed locally by your college or district’s district IT department).

  4. Non-SSO Users Only: You have received their account credentials and your temporary password from a CCCTC Enabling Services Administrator,have installed the authentication app software, and have completed theFirst-Time User Log Inprocess (setup and verification tasks) required to facilitate initiate two-factor authentication at the generic DWRS URL.

SSO Users: Account Setup & Log In Process

Colleges College & DistrictsDistrict Users

  1. The User coordinates with the CCCTC Enabling Services

...

  1. team to ensure their account is configured with the required roles, attributes, and

...

  1. IDP

...

  1. link.

  2. The User is

...

  1. provided the appropriate DWRS URL for their IDP and logs in.

  2. The User is authenticated locally through their

...

  1. institution’s IDP (SSO) and

...

  1. logs in to the DWRS.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

College & district user credentials are set by their institution IdP for single sign-on (SSO). These users should know their unique credentials or should contact their institution’s IT department to change or update themusers should contact their institution’s IT team for information on their local SSO credentials. These credentials are not managed by the CCCTC.

Non-SSO Users: Account Setup & Log In Process

All Other Users

  1. The User coordinates with the CCCTC Enabling Services

...

  1. team

...

  1. to get their temporary password and first-time log in information via secure method (i.e., Privnote).

  2. The User downloads and installs

...

  1. compatible authentication software on their desktop or mobile device.

  2. The User completes the “First-time User Log In” process, which enables entry of account credentials, one-time QR code verification, and authentication to the DWRS.

  3. Optional: After logging in, the User may update their temporary password using the Forgot Password? link to reset their password.

Receiving Your Secure Account Credentials

For security purposes, all non-SSO users will receive their account credentials and a temporary password in one or two separate emails from the an CCCTC Enabling Services Administrator. The email(s) will include a link to a secure Privnote message , sent to their the user’s institution email address (.edu).

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#F4F5F7

Note: The password will not be passed to the authorized user until they have started initiated the implementation process with the CCCTC Enabling Services teamfor added security.

Implementing the Authentication Software

...

Expand
titleExpand here to see instructions for downloading and installing the Chrome Authenticator app.

To Install the Chrome Authenticator:

  1. Navigate to the Chrome Web Store and search for Authenticator by authenicator.cc

  2. Click on “Add to Chrome” button to initiate the download and follow very simple instructions to install.

  3. When the Authenticator app has been installed, a shortcut will appear in your Extensions toolbar in your browser.

Note

WARNING: If you have already installed Chrome Authenticator (Authenticator.cc) don’t re-install this application as it will overwrite you previous download of this same application.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

NEXT: Start the “First-Time User Log In” process below to initiate the authentication process and loginlog in.

Google Authenticator App for Mobile Device

...

Expand
titleExpand here to see instructions for downloading and installing the Google Authenticator App.

Google Authenticator is compatible with multiple different mobile devices, operating systems, and browsers. The process for downloading and installing can be found here.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

NEXT: Start the “First-Time User Log In” process below to initiate the authentication process and loginlog in.

Panel
panelIconIdatlassian-light_bulb_on
panelIcon:light_bulb_on:
panelIconText:light_bulb_on:
bgColor#FFFFFF

Suggestion: Although any six-digit TOTP compatible authentication software should work for the Report Server User Account, the tools that we’ve found to be most user friendly are: Chrome Authenticator for desktop use and Google Authenticator for mobile devices. Both are free downloads and both can also be used together.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

NEXT: Start the “First-Time User Log In” process below to initiate the authentication process and log in.

...

The First-Time User Log In Process

For Non-SSO Users Only: The first time a new non-SSO user attempts to log in to the DWRS they must establish the connection between their user account credentials, a shared secret key (QR Code), and the authentication software to enable the two-factor (2FA) login log in authentication.

Pre-requisitesPrerequisites:

  • The User has the Data Warehouse Report Server URL (httpDWRS direct access URL: (https://dw-reports.ccctechcenter.org/jasperserver-pro/login.html).

  • The User has received their account credentials and temporary password from the a CCCTC Enabling Services Administrator.

  • The User has installed and configured a compatible authentication software app on their desktop and/or mobile device.

Expand
titleExpand here to see the First-Time User Log In steps (one-time process).
Note

Non-SSO Users Only: Complete this one-time process using the steps below.

Step 1: Enter Your Account Credentials on the Log In

Page

Pages

  1. Ensure you have one of the compatible authenticator apps installed on your desktop or mobile device.

  2. Navigate to the Data Warehouse Report Server URL for non-SSO users (https://dw-reports.ccctechcenter.org/jasperserver-pro/login.html); land on the log in page.

  3. Enter the account credentials provided to you into the following fields:

User ID: Enter your
  1. your Username or Email Address (institutional email address) in the

User ID
  1. Username or email input field (.edu or .org is required) on the “Sign in to your account” screen. Click “Sign In” to proceed to the nextscreen.

Password:
  1. Enter the temporary

password
  1. Password provided to you by the CCCTCEnabling Services Administrator (sent separately via Privnote).


  1. Click the “Sign in” button to continue to the QR Code Scan

page
  1. screen.

Image RemovedScreen shot of the Data Warehouse Report Server Sign In Email screen.Image Added

Screen shot of the Data Warehouse Report Server Sign In Password screen.Image Added

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

The temporary password is generated by the a CCCTC Enabling Services Administrator during the account creation process. You can change this password at any time by using the “Forgot Password?” link.

Step 2: Scan the QR Code Page

The Scan the QR Code page is displayed once during the “first-time user log in” process. The user must have the authentication software installed on their desktop or mobile device in order to scan the QR code that appears on the page. The code is captured by the authenticator app which establishes the connection between the account (shared secret key hidden in the barcode) and the authenticator app to complete the initial two-factor authentication process.

  1. With your Authenticator App installed, scan the QR code that appears in the center of the page.

    1. Scanning the QR Code with Chrome Authenticator (from desktop).

    2. Scanning the QR Code with Google Authenticator(usinga mobile device).

  2. As the authenticator scans the barcode (QR Code), a six-digit verification code will appear/register in your authenticator app.

  3. As soon as you see the six-digit code appear in your authenticator app, copy the code and then click “Submit” to go to the next page.

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#F4F5F7

NOTE: This step requires the user to use theirauthentication app previously installed on their desktop or mobile device to scan the onscreen barcode. The “secret” key identified by the barcode will add the required attribute to the User’s account.

Using Chrome Authenticator to Scan the QR Code

  1. Once the Chrome Authenticator app has been installed, a shortcut will appear in your Extensions toolbar in your browser.

  2. Click the Authenticator icon in your Extensions toolbar to open the tool.

  3. Click the scan icon and move your mouse over the QR barcode in the center of the page.

  4. Click + hold the mouse to drag the scan functional across the bar code.

  5. The secret key hidden within the barcode will register as a six digit code in the Authenticator registered to your Report Server account.

Using Google Authenticator to Scan the QR Code

  1. Once the Google Authenticator app has been installed on your mobile device, an icon will appear on your phone wall or homepage.

  2. Click to open the Google Authenticator app

  3. Point the camera on your mobile device at the barcode on the screen and snap a picture.

  4. The secret key hidden within the barcode will register as a six digit code in the GA app registered to your DW Report Server account.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Tip: After scanning the QR code and confirming the verification code is captured by the authentication software, snap a screen shot of the code and store in a secure place. For security purposes, don’t store the verification code with the URL or other credentials to the DWRS.

...

For Non-SSO Users Only: After the user completes the one-time “First-Time User Log In” process, the user is “verified” and will not have to repeat the Scan the QR Code Page stepagain UNLESS they need to re-install their authentication software and/or generate a new QR code. For all subsequent loginss, the verified user needs only to enter their account credentials and the verification code retrieved from their authenticator app.

...

Step 1: Log in Page Enter Username or Email

  1. Navigate to the Data Warehouse Report Server URL (httphttps://dw-reports.ccctechcenter.org/jasperserver-pro/) and land on the Log In page.login.html).

  2. Enter your user account credentials and password username or institution’s email address in the input fields.

  3. User ID: Enter your institutional email address in the User ID field (.edu, or org) (Required)

  4. Password: Enter your unique

    field.

  5. Click the “Sign In” button.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Tip: Your Username is your institution or organization email address used during the initial account setup with the CCCTC Enabling Services team.

Screen shot of the Data Warehouse Report Server Sign In Password screen.Image Added

Step 2: Enter Password

  1. Enter your password in the Password input field or click the Forgot Password? link to reset your password.

  2. Click the “Sign In” button.

Panel
panelIconIdatlassian-light_bulb_on
panelIcon:light_bulb_on:
panelIconText:light_bulb_on:
bgColor#F4F5F7

Reminder: Click the Forgot Password? link on the Log In page to recover your account password or to change your password at any time.

Step 23: Enter Verification Code Page

...

  1. Immediately upon landing on the “One-time code” screen, copy the verification code from your Authenticator app within 30 seconds of making the request (clicking on Sign In button on Log In screenafter entering password).

  2. Verification Code: Enter the code from the authenticator app into verification code in to the “One-time code” field.Click the “Sign in” button to complete the log in process and access the DWRS. ” field.

  3. Click the “Sign in” button to complete the process and access the DWRS.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Best Practice: To save time retrieving your verification code, consider labelling the DWRS entry in your Authenticator tool, especially if you are using the tool for more than one application.

Password Reset Process

To change or update your account password:

  1. Navigate to the Data Warehouse Report Server at https://dw-reports.ccctechcenter.org/jasperserver-pro/login.html.

  2. Click the “Forgot Password?” link which is available on every screen.

...

  1. Enter your email address that was used to create your account.

  2. Click Submit.

...

A confirmation message appears on the screen directing you to retrieve an email.

...

4. Open the Reset Password email, click the embedded link to go to the Update Password page.

...

Enter your new password in the New Password box. Confirm your new password, then click Submit to return to the Sign In page.

...

Email Address Update Process

DWRS user accounts require a unique email address that identifies the user in the CCCTC secure identity management system. To change or update the email address associated with your account, please contact the CCCTC Support team to update the email address manually in the system. With verbal confirmation that the change has been made, the user should return to the Data Warehouse Report Server Sign In page to repeat the sign in process.

User Type

Authentication

Update Email Address

Update Password

College User

SSO User

SSO access via college/district IdP

Contact CCCTC Support

Contact your college/district IT Dept

District User

SSO User

SSO access via college/district IdP

Contact CCCTC Support

Contact your college/district IT Dept

Chancellor's Office User

Non-SSO User

Direct access (non-IdP) via two-factor authentication (2FA)

Contact CCCTC Support

Use the self-serve Forgot Password? process

CVCOEI User

Non-SSO User

Direct access (non-IdP) via two-factor authentication (2FA)

Contact CCCTC Support

Use the self-serve Forgot Password? process

CCCTC Administrator

Non-SSO User

Direct access (non-IdP) via two-factor authentication (2FA)

Contact CCCTC Support

Use the self-serve Forgot Password? process

...

Appendix A: Data Warehouse Report Server URLs

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Click here for college and district-specific Data Warehouse Report Server URLs.

...

Part 3: Using the Report Server

...

  1. On the Home page, click Create in the Reports block. The Create Report wizard opens.

  2. Select the Ad Hoc view you want to use as the basis for your report.

  3. Select a report template. To use a template other than the default, select Custom Report Template, click Browse and select the desired template. See Report Templates for more information.

  4. Click OK. If asked, enter the input controls needed. See Using Input Controls.

...

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

See the online help topic under the Reports workflow View tutorial link. At around the 3:35 mark the tutorial begins to demonstrate scheduling a report.

Back to Top

...

Part 4: Creating Custom Ad Hoc Views & Reports

...

  1. Click the chart icon in the tool bar in the Ad Hoc Editor to display the “Select Visualization Type” dialog box.

  2. Click on the Table icon - or your preferred type - to highlight your selection.

  3. Click the “Apply and Close” button to save your change.

...

Back to Top

Working with Tables

This section explains how to populate, edit, and format your table type report view, including:

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

For more reportformatting tips, such as managing column sizes and adding spacing to your table-type report, see Working With Tables section of the JasperReports Server v7 User Guide.

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Creating Filters with Relative Dates

You can filter information in your view based on a date range relative to the current system date. You can accomplish this using date-based filters, and entering a text expression describing the relative date or date span you want to display, using the format <Keyword>+/-<Number> where:

  • Keyword indicates the time span you want to use. Options include: DAY, WEEK, MONTH, QUARTER, SEMI, and YEAR. An option used by itself (without +/-<Number>) gives the current value for that option.

  • or - indicates whether the time span occurs before or after the chosen date.

  • Number indicates the number of the above-mentioned time spans you want to include in the filter.

For example, if you want to see all of the CC Promise Grant Applications submitted during the prior week, your expression would be: WEEK-1.

Steps to create a relative date filter:

Following the instructions in Using Filters, create a filter based on a date field. The filter appears in the Filters panel.

...

General Best Practice

Example

View/Report Organization

  • Keep your Views organized in folders that have the word "View" in their name to make the Views easier to find

  • Keep your reports organized in folders that have the word "Reports" in their name to make the reports easier to find

  • Use the same name for the View as you do for its corresponding Report but include "View" or "Report" in its name to further help with organization

When Creating a View by Copying an Existing View

  • Only copy a report's View if you need to edit or customize it; otherwise, always run a Public report from the Public folder in the Repository

  • When copying or customizing an existing View, add the word "Report" or "View" onto the end of the new name to keep the report/View distinction clear

  • If you want to keep the original View when making changes, use the Save As button to save the View with a different name and then make your changes (and use the Description field in the Save As dialog box to add information)

  • Public reports and their Views cannot be edited or deleted (though in some reports you may have the option to filter out certain data from the displayed results)

  • Remember: If you change a View, you will need to create/run a report from it in order to see the changes in report form

Back to Top

...

Creating New Ad Hoc Reports

There are two ways to create a new custom or customize a report:

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

This section may reference features and functionality covered in the Working with the Ad Hoc Editorand the Working with Tables sections. Please refer to

...

those sections as needed.

Copy and Customize An Existing Report View

...

Note

Important: To make a change to a saved Report, you must make the change to its original View in the Ad Hoc Editor.


Copy Steps:

  1. Log in to the Data Warehouse Report Server.

  2. Locate the View file that you want to copy from a folder in the Repository, or in the Library, and click on it.

  3. Copy: With the file name highlighted, copy it using one of the following methods:

    1. Click the Copy button in the tool bar.

    2. Right-click the file name and select Copy from the context menu.

  4. Paste the copy into a folder available to you in the Repository (one of your college or district organization folders).

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

You can now customize your new View copy as desired, and save it with a new name. See more Save & Export options below.

Customize & Save View Steps:

  1. Locate the new file you just copied, and click on it. Click the Open button. The View will open in the Ad Hoc Editor.

  2. If desired, you can customize the new View you just copied or saved by using the functional controls in the Ad Hoc Editor. Customization options include:

    • Add or remove data Columns to your format

    • Add or remove Groups to your format

    • Add or remove Filters to further analyze your data

    • Reorder the columns by dragging the tabs in the Columns or Groups rows.

    • See the Working with Tables section above for help using the functionality in the Ad Hoc Editor.

  3. When you are ready to save your new View, hover over the Save icon in the tool bar to display the menu options available.

  4. Select Save Ad Hoc View As...

  5. When the Save As dialog box displays:

    1. Edit the Data View Name (required).

    2. Edit the Data view Description field (optional).

    3. Scroll through the list of available Organizations folders to select which folder you want to save your college's report View.

    4. Click Save.

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#F4F5F7

Review the section The Ad Hoc Editorsectionabove to revisit the components and functionality of the Ad Hoc Editor

...

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#F4F5F7

Reminder: In order to create a new ad hoc report, you must first design the report in the Ad Hoc Editor and save it as a View. Then it can be saved and run as a report.

Create New Ad Hoc View Steps:

  1. Log in to the Data Warehouse Report Server.

  2. From the main menu, select Create > Ad Hoc View to display the Select Data dialog box.

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Data Warehouse-related specific data sources have contain a "DW" in the name of the source and "Topic" as a part of their name.

...

Note

Before you begin adding fields, measures and other customization customizations to your new ad hoc View, select a view typefrom the “Select Visualization Type” dialog box.

...

Support Using the Report Server

Contact College Support (staffsupportccctc@openccc.zendesk.com) to report technical issues with the Data Warehouse Report Server - or visit our online community support site , CCCTechnology.info.

Panel
panelIconIdatlassian-light_bulb_on
panelIcon:light_bulb_on:
panelIconText:light_bulb_on:
bgColor#F4F5F7

For more help using the Data Warehouse Report Server, please refer to the onlineHelpdocumentation available from the provider TIBCO Jaspersoft.

Back to Top

...

Part 5: Report Templates

The Data Warehouse Report Server is a structured source of master data that can be used to generate the reports, templates, data marts, and analytics that end-users need.

...

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Helpful Tip: When saving the details of your custom Ad Hoc View and corresponding Report, keep the names and descriptions the same - or very similar - so you can identify the pair if you want to update your report in the future. Remember that every report is based on its original View, and if you want to change your report you need to make the changes in the corresponding View, and then save the changes as a new report.

Back to Top