Skyward Document Viewer Integration

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).

In Skyward link

Add a new attachment type:

1. Navigate to Administrative Access > System > Attachment Type. Click Add Attachment Type and enter:
   • Object: Student
   • Attachment Type Code: SameGoal
   • Attachment Type Description: Special Programs Documentation
   • Set other parameters on this page according to district preferences. Under MENU SECURITY DISPLAY, ensure attachment type access is set to "Yes" for desired access.
2. Navigate to Administrative Access > Student > System Configuration.
   • On the Student Profile Pop-Up Attachments tab, ensure Student Attachments to Display is set to either
     • Show All Student Attachments; or
     • Show Selected Student Attachments

Create an Integration Access Record:

1. Navigate to Administrative Access > API > Integration.
2. Select the Integration with Product Name SameGoal Document Viewer.
3. Select the Integration Accesses tab, and then click Add Integration Access.
4. 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.
5. After the Integration Access record is created, SameGoal will receive a notification in its Skyward Partner Portal and will be able to generate a secret to pair with this key.

In SameGoal link

• 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.
• This integration runs nightly. PDF attachments should appear the following morning.