PowerSchool Support

Refer to the below steps to configure PowerSchool in the Deledao Admin Console: 

1. Request a copy of the .XML file from support@deledao.com  

2. Install and configure the .XML installer within PowerSchool 

1. 1. System Managent > Server > Plugin configuration  

2. 
   

3. 
   

4. 
   

5.  2. Click Install (in Red) 

6. 
   

7. 
   

8.  

9. 3. Click "Choose File" and select the Deledao .XML that Support provided. Then, click the "Install" button on the right.  

10. 
    

11. 

    
    

    
    

    
    

    
    

    
    

12. 
    

    4. After the plugin finishes loading a pop up window will come up that provides details for the plugin: Client ID, Client Secret. After the Client Secret and Client ID are copied proceed to click "Register" in the bottom-right side of the window.  

    
    

    

    
    

    7. 5. In the Deledao admin console, go to Configuration > Rostering > PowerSchool, there are 4 fields that need to be filled: Client ID, Client Secret, Base URL, and Token URL.   

    8. 
       

    9.  

    10. 6. The Client ID and the Client Secret can be pulled from the XML details page seen above after the plugin is successfully registered in PowerSchool. The Base URL and Token URL can be written as follows:  

        1. 1. If the school has their own domain (example: kentwoodusd) then the Base URL can be written as follows: https://kentwoodusd.powerschool.com.  

        2. 
           

        3. 2. If the school does not have their own domain, they can stick with the default Base URL: https://sis.powerschool.com  

        4. 
           

        5. 3. If the school has their own domain (example: kentwoodusd.com) then the Token URL can be written as follows: https://kentwoodusd.powerschool.com/api/ims/oneroster/v1p1/token 

        6. 
           

        7. 4. If the school does not have their own domain, they can stick with the default Token URL: https://sis.powerschool.com/api/ims/oneroster/v1p1/token 
           
           

        8. After the user clicks 'Save' PowerSchool will start importing data and the process is complete. 

Skyward Integration

INTEGRATION ACCESS SETUP

NAVIGATING TO THE INTEGRATION LIST

Every Integration will have a record available within Qmlativ, which you can view by navigating to the Integration List screen. To locate this list of Integrations:

1. Open the Main menu within Qmlativ.

2. Select the Administrative Access portal.

3. Choose the API module.

4. Select the Integration feature.

EXPLANATION OF THE INTEGRATION LIST

On the Integration List screen, you will see a list of Integrations. By default, these Integrations are sorted by the Vendor Name (1) and then by the Product Name (2), which should make the Integrations easy to locate within the list.

The Description (3) column provides an explanation of the purpose of the Integration, and should help you, as the district, determine if the Integration will be useful for your district.

The Status (4) column shows the current state of the Integration, such as whether it is Available or if it has been Discontinued.  A Discontinued Integration that appears for you is one that has either recently been discontinued from use or one that you have used in the past which is no longer available.

The Has Development Permissions (5) column provides an indication of whether the Integration is allowed to access your environment while it is in development by the vendor.  In a Live environment, this should display as unchecked, however, in a Training environment, you may see this item checked if you are working with a vendor for development purposes.

The Can Generate Secret (6) column provides an indication as to whether you, as the district, are allowed to generate the secret that is used for the Integration’s authentication. If this box is checked, the vendor has enabled the option and expects that you will provide the secret to them using a secure method so they may authenticate with Qmlativ (see the Vendor Integration Setup below).  If this option is unchecked, the vendor has chosen to manage secret authentication themselves using Skyward’s secure Partner Portal.

STARTING INTEGRATION ACCESS SETUP

From the Integration List screen, click the Open (1) button on the Integration for which you want to grant access, this will take you to the Integration Details screen.

On the Integration Details screen, select the Integration Accesses (1) tab, which will display a list of Integration Access records available for this Integration (note that no records will display when you first view this screen). Click the Add Integration Access (2) button to begin the Add Integration Access workflow.

ADD INTEGRATION ACCESS WORKFLOW

In the Add Integration Access Workflow, you will need to set the following fields on the Integration:

1. Name (required): This is a “friendly” name that allows the district to easily identify the Integration Access and allow the district to differentiate it from another Integration Access for the same Integration. It is often useful to name this with the Integration’s name plus the year or purpose of the access being granted, such as “{Integration} 2023” or “{Integration} Vendor Testing”. Note: this name does not affect the access credentials used to connect to the API(s).

2. Description (optional): This description allows you to provide more details on the purpose of the Integration Access if the Name field does not provide enough context.

3. Integration (required): When starting the Add Integration Access Workflow from the Integration Details screen, the Integration will be automatically set to the Integration which was selected at the start of the workflow. When starting the workflow from other locations, such as the Integration Access List screen, this field will need to be filled in with the name of the Integration to which you are granting access.

4. Key (required): This key functions as the Client Key or “username” by the third-party vendor when authenticating with Qmlativ’s APIs. This value must be unique, and the third-party vendor may require that the value be configured to a specific value (see Vendor Integration Setup below).

5. Authentication Type (required): The indicates the type(s) of authentication are available to the third-party vendor when authenticating with Qmlativ.  Skyward recommends setting this option to “Any”, as this will allow the vendor to access the Integration using their preferred authentication type, and it will not require any changes to be made if other authentication types are added or removed in the future.

    a. NOTE: “Basic” is currently offered as an option for the authentication type, but this option will be removed at the start of the 2024-25 school year and is not recommended.

6. Is Active (required): Indicates whether the Integration Access is active.

7. Effective Date (required): The date from which the Integration Access becomes available to the third-party vendor.

• NOTE: an Integration Access is only truly active if the “Is Active” checkbox is checked and if the current date falls after the Effective Date.

ADDITIONAL CONFIGURATION

Beyond the above settings on the Add Integration Access workflow, there may be additional configuration necessary depending on the APIs used by the third-party Integration. If any additional configuration is necessary, a Configuration section will appear below the Connection Queue Size field.

ONEROSTER CONFIGURATION

Description: the OneRoster API allows third-party Integrations access to rostering information, such as name and certain demographic information, as well as information related to scheduling and grading.

Click the arrow (1) next to the OneRoster Configuration selector, this will display a list of available OneRoster Configurations. Click the Select (2) button next to the appropriate configuration, if one is available, or click the Add One Roster Configuration (3) button to add a new configuration.

Adding a OneRoster Configuration

On the Add One Roster Configuration workflow, you will need to fill in several fields:

1. One Roster Vendor (required): this is the name of the vendor as configured for the purposes of OneRoster communications. Click the arrow next to the selector to select the name of an existing vendor or click the Add One Roster Vendor button within the list to add a new vendor.  The workflow for adding a new vendor contains a single field, which is the vendor’s name.

2. Code (required): this is a generic code that can be used to identify the OneRoster configuration.

3. Description (optional): this description allows you to provide additional context for the configuration, such as notes about a specific vendor or Integration.

4. District (required): select your district from the list.

5. Allow Grade Pass Back (optional): this option allows the third-party vendor’s Integration to write grade information back into Qmlativ. 

    a.    NOTE: Selecting this option requires additional licensing from Skyward for the grade pass back to function. If you are uncertain if your district has the appropriate licensing, you may look in Administrative Access > System > System Profile, then select the Products Owned tab and search for the “QM OneRoster API with writeback” product. If you do not have this products owned record available and would like to use the grade pass back option, please contact your Sales Representative.

Setting up OneRoster 1.2 Role Crosswalk

For OneRoster 1.2, Open the integration access details and select the OneRoster 1.2 Role Crosswalk tab to create crosswalks between the standard OneRoster roles to the user-defined Staff Types and Relationships.

SAVING THE INTEGRATION ACCESS

After filling in the main section of the Add Integration Access workflow (1) and any additional configuration (2), click the Save button to complete the first step of the workflow.

Completing the Add Integration Access Workflow

After saving the workflow, you will be presented with a window indicating that the process was completed successfully, which means the Integration Access record was created.  

If the Integration allows you to generate a secret, you will have a Generate Secret (1) button displayed at the top along with the Close (2) button.  If you are not allowed to generate the secret, you will only see the Close button.  Click the Generate Secret (1) button to generate a secret for this Integration Access.

NOTE: the Generate Secret button will generally only be available to you if the third-party vendor offers a form of self-setup for the Integration or if the Integration is being used from a physical device that requires setup at the district (such as a time tracking device). This option is entirely dependent upon the third-party vendor’s Integration setup, and when available, should include instructions in the Vendor Integration Setup section below.

STARTING THE GENERATE SECRET WORKFLOW

If you clicked the Generate Secret button above, you will automatically begin the Generate Secret Workflow. However, if you clicked the Close button instead, or you otherwise need to generate a new secret for an Integration, you can navigate to the Integration Accesses tab (1) on the Integration Details screen, as explained above, and look at the Can Generate Secret column (2) to see if you are allowed to generate a secret.  If you can generate a secret, you can click the down arrow on the row (3) and click the Generate Secret button to start the workflow, and you can continue the workflow as outlined in the Completing the Add Integration Access step above.

Completing the Workflow

After starting the Generate Secret Workflow, you will need to copy the Secret that is generated from the box on the screen. To make this easy, you can click the Copy (1) button.  Once you have copied the information, you need to make sure the I Have Copied This Data (2) box has been checked (this will happen automatically when you click the Copy button), then click the Run Process (3) button to complete the process.

Providing the Generated Secret

If you had the option to generate the secret, this information must be provided to the third-party vendor. Please see the instructions below in the Vendor Integration Setup to determine how this information is to be provided to the third-party vendor.

VENDOR INTEGRATION SETUP

This section is to be completed by the vendor and is intended to provide any configuration instructions that exist outside of Qmlativ for the Integration.  This information may be provided to the district customer to assist them with the setup of the third-party integration and may be used by Skyward for the purpose of troubleshooting setup issues with the integration.

NOTE: If the Integration is using the “Allow Customer to Set Secret” option in the Partner Portal, then this section must provide instructions on how the customer is to provide the secret to the vendor.

Skyward Qmlativ Integration

How to Connect with a Third-Party Vendor via API

Once API server software has been loaded to your database, there are a few pieces of

information you will likely need to provide to third parties so that they can access your

Skyward data. If you have never used the API before please review the Launch Kit for

information on loading the API Server software.

Generating a Key and Secret

Each third-party vendor you share data with will need a unique key and secret. These are

the credentials the company will use when accessing your data. This is like a username and

password. Follow these steps to generate a key and secret:

    1. Add a new secured user for the third party

        a. Navigate to Product Setup > Skyward Contact Access > Security > Secured

User.

        b. Click Add.

        c. Select the Organization radio button.

        d. Enter the organization’s name (for example Schoology or Canvas), confirm

            there is not an existing user for the company, and click Add Entered Name to

            Secured Users.

        e. Enter Address information (optional) and Save.

        f. Enter Contact name, phone, and/or email (optional) and Continue Add.

        g. Enter Security Info and Save. They must be an active secured user but do not

            need any other permissions and will not use the entered password.

    2. Generate a key and secret

        a. Highlight the new Organization user in the Secured User list and click the API

        button in the lower right corner of the screen (If the API button is not

        available, contact Skyward).

        b. Click Generate a New Secret.

SKYWARD DOCUMENTATION – API QUICK START GUIDE

    c. The key and secret displayed here will need to be shared with the third party.

    d. If needed, the secret can be regenerated here as well. Be sure to share the

    updated secret with the appropriate third party so they do not lose access.

Locating the correct API URL to share

1. Navigate to Product Setup > Skyward Contact Access > District Setup >

Configuration > API Configuration.

2. Determine which URL the third party needs. Typically, they will specify which they

would like. It will likely be one of the following:

    a. LMS API URL: Sometimes referred to as the Skyward API.

    b. OneRoster API URL: This API meets OneRoster specifications.

3. Share the URL, key, and secret with the third party. Sometimes they ask that this

information is sent to them and sometimes you will enter it directly on their site.

SKYWARD DOCUMENTATION – API QUICK START GUIDE

Vendor Partnerships

A list of Skyward’s service partners is available here. Not all these partners deal directly

with student data integrations; those that are listed have an existing relationship with

Skyward. Clever, Canvas, itslearning, Microsoft, and Schoology are a few examples of

vendors who have potential API integrations available.

Each vendor generally has their own configuration options within their software. It is

recommended to reach out to the specific vendor for documentation specific to their

software.

There are many other companies that can also integrate with us even if they are not listed

as an official partner. If the vendor is OneRoster certified or has worked with Skyward

before, there is a chance this would be an option.

We recommend new or potential partners visit our Partner Portal to communicate with us

directly about integration and access tools and resources