Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

This guide provides an implementation configuration overview for establishing a direct access connection (ODBC/JDBC) to the CCC Data Warehouse for authorized CCC colleges and districts.

...

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#F4F5F7

Start with Your CRM: The initial request should be made to your College Relationship Manager. If you do not know who your CRM is, send an email to crms@ccctechcenter.org.

...

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: ES ICE engineer works with your primary IT contact(s) to facilitate the configuration of the VPN and establish the account credentials.

...

Note

Reminder: Ensure your ES ICE engineer has all necessary system configuration information, including your firewall make, model, and version, and your IP information.

...

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: ES ICE engineer establishes the service account and provides the account login credentials to primary IT contact.

...

Info

The <misScope> will appear in the user’s credentials (username) and also in the database schema formats used in SQL queries during the Connecting Using SQL Workbench validations.

...

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: College or district establishes their connection to the Data Warehouse (Redshift) databases using SQL Workbench.

...

Remote Connection: If you are working remotely and the district has authorized it, you will need to establish a connection to the district’s internal network using a separate VPN client the district has provided for this purpose.

...


Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: Follow the instructions to install SQL Workbench and configure database access connection.

...

The application is now installed and the Select Connection Profile screen appears.

...

 

...

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: At this point, you need to download Redshift drivers and test the connection.

...

Once your driver file is selected, click ‘OK’ on the Manage drivers screen.tipthe Manage drivers screen.

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: Configure the Connection Profile screen with account credentials (username and password) and connection string.

...

  • Name: The name for this connector that you will reference later when you want to access this database again. This is for your use only, so make it descriptive enough to where you understand clearly which DB you are accessing. For example, if you are going to query the COCI DB, something like `DWH-COCI` might be appropriate. Signifying the environment in this name is highly recommended.

  • URL: Where to reach the database. Edit the autofilled string here with your custom endpoint (example shown below).

Environment

Endpoint

Production

jdbc:redshift://dwh-prod.ccctechcenter.org:5439/{{database}}

Ex: jdbc:redshift://dwh-prod.ccctechcenter.org:5439/canvas

Note

Replace {{database}} with the specific Database Name shown in Table B below.
Where “database” is the name of the database to which you are trying to connect.

...

Table B: Application Database Names

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

The value of <misScope> can be derived from the prefix of your Data Warehouse Direct user name which is in the format of <misScope>_<firstInitial><lastName> i.e. 000_jdoe where 000 would represent their MIS scope value. An example of the resulting schema for accessing tables within the Application database = dw_apply_read_000.

Application (Data Source)

Database Name

Query Schema Format

CCCApply Application

application

dw_apply_read_<misScope>

CC College Promise Grant

bogfw_application

dw_apply_read_<misScope>

CCC International Application

intl_application

dw_apply_read_<misScope>

Multiple Measures Placement Service (MMPS)

mmps

dw_apply_read_<misScope>

Chancellor's Office Curriculum Inventory (COCI)

coci

dw_coci_read_<misScope>

Course Identification Numbering System (C-ID)

cid

dw_cid_read_<misScope>

Canvas

canvas

canvas_rs_<misScope>

Info

Note: Data dictionaries for the above data sources are available on the CCC Data Warehouse documentation site

Note

Troubleshooting: If the test fails, the two most common fixes are:

  1. Verify you have entered the URL, your username, and password correctly.

  2. Make sure you are connected to the Colleges’ VPN.

...

Panel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: Validate your connection and data access.

...

  • Using provided user documentation (this user guide), college configures BI tool to connect to the Data Warehouse.

  • College will confirm local connection and successful login, as well as perform optional data validation activities.

  • Online documentation is available to support data access validation activities for Researchers.

Tippanel
panelIconIdatlassian-check_mark
panelIcon:check_mark:
bgColor#F4F5F7

Next Step: Work with your ES ICE engineer to confirm access validation and query tests. Discuss any unfinished implementation steps before hand-off to ES Support.

...

Canvas DW Direct Connect Service

Colleges may request to access their Canvas data through the CCC Data Warehouse via direct access connection (ODBC/JDBC). The ability to access Canvas data will require the college Canvas Administrator to generate and pass their Canvas API credentials to the CCCTC Enabling Services Implementation Engineer as part of the configuration process. Once received and implemented, the data pipeline will be configured to pass your Canvas data to the CCC Data Warehouse. Following that initial pass, the data will be updated nightly. 

...