This integration adds a single PDF attachment for a student named "Special Programs" when the student participates in one or more special programs. This PDF provides links to a "document viewer" screen of each special program plan document in SameGoal, including a dropdown to view all attachments and additional views (including at-a-glance summary views).
Steps
To setup document viewer integration with Skyward Qmlativ:Add a new attachment type:
- Add a new attachment type named "SameGoal" with description "Special Programs Documentation".
- Navigate to Administrative Access > Student > System Configuration.
- On the Student Profile Pop-Up Attachments tab, change the Student Attachments to Display setting to either Show All Student Attachments or Show Selected Student Attachments.
- Grant appropriate users access to this attachment type.
Create an Integration Access Record:
- Navigate to Administrative Access > API > Integration.
- Select the Integration with Product Name SameGoal Document Viewer.
- Select the Integration Accesses tab, and then click Add Integration Access.
- Set a Name, Key, and Authentication Type for the Integration Access.
- Name can be whatever you choose.
- Access defaults to expire a year after creation date; you may extend or even delete this expiration.
- For Custom API Entities, select your District Entity and any entity you wish to include in integration.
- Authentication type should be OAuth 2.0.
- After the Integration Access is created, SameGoal will be able to generate a secret to pair with this key.
- Email tier2help@samegoal.com from your district email with subject “Complete SameGoal Document Viewer Integration” (no additional information needed).
- Our technical team will verify that the Integration Access record has been created for your district.
- Our technical team will generate the required secret for this Integration Access record. Full API credential information for this integration will then appear in SameGoal. To view/verify this information:
- Log in to SameGoal as an administrative user.
- Visit Settings (left menu) > District Information.
- Under STUDENT INFORMATION SYSTEM INTEGRATION, locate Skyward Qmlativ.
- The “add Doc Viewer” section will be expanded and contain API Base URL, Client Key and Client Secret.
- You will receive a confirmation reply email once SameGoal setup is complete.
- This integration runs nightly. PDF attachments should appear the following morning.