--- title: "Integrating RapidIdentity with Incident IQ" slug: "integrating-rapididentity-with-incident-iq" description: "Instructions for integrating RapidIdentity with Incident IQ." tags: ["User Account Information", "Data", "Administrator", "IncidentIQ"] updated: 2024-04-02T21:02:06Z published: 2024-04-02T21:02:06Z canonical: "help.rapididentity.com/integrating-rapididentity-with-incident-iq" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.rapididentity.com/llms.txt > Use this file to discover all available pages before exploring further. # Integrating RapidIdentity with Incident IQ ## Synchronizing Data with Incident IQ Identity Automation provides two different methods for synchronizing RapidIdentity Account information including Identity Data and Roster Data with Incident IQ. Either method can be used individually or they can both be used together depending on your institution's specific needs. **Identity Data** vs **Roster Data** - Identity Data references information about all users in the institution including contractual and temporary users and is typically sourced from other systems than the Student Information System. Identity Data includes information such as Group Memberships, Affiliations, Responsibilities, Authorizations etc. - Roster Data references information about students and teaching staff in relation to their enrollments in courses and classes. Roster Data is primarily sourced from the Student Information System. ### Integrating Identity Data in Real-time with Incident IQ To integrate identity data in real-time with Incident IQ, download and install the **[IncidentIQ Connect Project](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/IncidentIQ.dssproject)** into RapidIdentity Connect. Data Restriction: The IncidentIQ Connect Project and following instructions provide real-time data integration between RapidIdentity and IncidentIQ however, districts with a large amount of users, groups and/or group memberships will exceed it's ability to return that information in real-time. When integrating a large amount of users, groups and/or group memberships please use the **[IncidentIQ_Batch Connect Project](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/IncidentIQ_Batch.dssproject)** instead. Instructions for installing the **[IncidentIQ_Batch Connect Project](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/IncidentIQ_Batch.dssproject)** can be found [here](/v1/docs/integrating-rapididentity-with-incident-iq-batch) #### Install the IncidentIQ Project To install the **[IncidentIQ Connect Project](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/IncidentIQ.dssproject)**, navigate to the Connect Module in RapidIdentity Portal, click the Settings icon from the right-side navigation menu and select Projects. ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28259%29.png) Click the **Import** command from the bottom command menu, browse for the downloaded **IncidentIQ.dssproject** file on your computer. Click **Save** to import the **IncidentIQ** project into Connect. ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28344%29.png) The IncidentIQ project creates three RESTful endpoints that return information for Groups, Group Memberships and Users in RapidIdentity. All three endpoints are accessible via the GET method. - https://server[:port]/api/rest/restpoints/IncidentIQ/groups *Uses the **(objectClass=groupOfNames)** filter to return LDAP group information* ``` { "DN": "ou=Groups", "Id": "28795ee3-3235-40db-a766-7ce59df7d169", "Name": "Administrative Staff" } ``` - https://server[:port]/api/rest/restpoints/IncidentIQ/members *Uses the **(objectClass=groupOfNames)** filter to return group membership information* ``` { "GroupId": "28795ee3-3235-40db-a766-7ce59df7d169", "MemberIds": [ "idautoID=11d80529-400a-419c-9855-98a5064b008a,ou=Accounts,dc=meta", "idautoID=39963242-00dd-41a8-a83d-30d996179b93,ou=Accounts,dc=meta" ] } ``` - https://server[:port]/api/rest/restpoints/IncidentIQ/users *Uses the **(&(objectClass=idautoPerson)(!(idautoDisabled=TRUE)))** filter to return user information* ``` { "BusinessPhone": "5559234879", "Email": "fred@flintstone.com", "FirstName": "Fred", "Id": "39963242-00dd-41a8-a83d-30d996179b93", "LastName": "Flintstone", "LocationCode": "30001", "LocationName": "Boulder High School", "MobilePhone": "2817487050", "RoleName": "Sponsored", "SchoolIdNumber": "stu-45698", "Username": "fflintstone" } ``` #### Create the Consumer Key and Secret for Incident IQ With the IncidentIQ project chosen, select OAuth1 Consumers from the right navigation menu and click the **ADD OAUTH1 CONSUMERS** button to create the **Consumer Key** for Incident IQ. ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28351%29.png) To display the **Consumer Secret**, click the **Details** button associated with the **Consumer Key** and click the **Show** button. ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28352%29.png) Provide both the Consumer Secret and Consumer Key to Incident IQ. #### Add or Change Attributes Shared with Incident IQ Use the following instructions to add or change the attribute data that is shared with Incident IQ. **Advanced Capability** Adding or changing the attributes shared with Incident IQ is an advanced capability that requires a basic understanding of RapidIdentity Connect Action Sets and and the Global Attribute List in RapidIdentity. Customers who are not familiar with these advanced capabilities are advised to contact Identity Automation [Support](https://identityautomation.force.com/helpcenter/s/case/Case/00Bj0000001eNkBEAU) for assistance. 1. Select **Connect** from the top module selection menu to enter Connect 2. Select **IncidentIQ** project from the left-hand project filter to open the Project Settings 3. Select **Action Sets** from the left-hand navigation panel to display the IncidentIQ Action Sets 4. Hover over the **users** Action Set and click **Details** to open the IncidentIQ users Action Set 5. Double-click the `getLDAPRecords()` action in the *Fetch Records* section to open the action that retrieves the user attributes from OpenLDAP ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28452%29.png) 6. Add the required attribute or attributes, separated by commas, into the **attributes** input area and click **Update** when done **NOTE:** The attribute or attributes to be added must be in the Global Attribute List (GAL). For instructions on modifying GAL items can be found [here](/v1/docs/global-attribute-list) 7. Change the `key` value in the JSON being sent to Incidient IQ if necessary By default, the newly added attribute or attributes will automatically be included in the JSON response to IncidentIQ using the name of the attribute as the `key`. To change the `key` name, double-click the `renameRecordFields()` action in the *Process Records* section to open the action that defines the `key` for each attribute. ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28451%29.png) Add each attribute to the comma delimited list of `oldFields` and the associated `key` name to the comma delimited list of `newFields`. Click **Update** when done. 8. When the necessary edits have been made click the **Save** button on the bottom action menu to save the Action Set. ### Integrating Roster Data with Incident IQ RapidIdentity Studio provides two pre-defined, OneRoster compliant, out-of-the-box integrations with Incident IQ that produces roster files such as Classes, Courses, Orgs and Users in either REST or .CSV formats and based on information gathered from the Student Information System. Using RapidIdentity Studio and one of the two Incident IQ Consumer Applications enables advanced functionality in Incident IQ like My Classes which allows teachers to easily submit help requests on behalf of their students. **To integrate Roster Data with Incident IQ using RapidIdentity Studio:** 1. As an Admin in RapidIdentity, navigate to the Studio Module **Note:** Studio is a licensed module in RapidIdentity and is only available to customers who have purchased Rapididentity Rostering from Identity Automation. If you would like to roster with Rapididentity Studio but do not have a license, please contact your customer success representative or, click [here](https://www.identityautomation.com/contact-us/). 2. Select Applications from the Left Navigation Menu, click the **Add Application** button in the top right corner of the page and select **From App Library** ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28361%29.png) 3. Search for **Incident IQ**, select the REST or CSV Consumer Application and click the **Install** button at the bottom of the page ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28362%29.png) 4. Use the default **IIQ** Consumer Prefix or enter your own. Prefixes must be capitalized, from 1 to 16 characters long, begin with a letter and be unique within the Studio Module. ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28363%29.png) 5. Configure the **Connection Settings** to share Roster Data with Incident IQ. - For REST connections: ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28364%29.png) > *Click [here](/v1/docs/rest-api-consumer-from-catalog) to learn more about installing a REST Consumer from the Studio Catalog* 1. Create a **Consumer Secret** and copy it to a safe location. 2. Generate a **Consumer Key** and copy it to the same location. 3. Share the **Consumer Secret** and **Consumer Key** with Incident IQ along with the **Base URL** and **Access Token** URL - For CSV connections: ![image.png](https://cdn.document360.io/4d958006-b877-42af-8de5-00e3bb7fe41d/Images/Documentation/image%28365%29.png) > *Click [here](/v1/docs/delimited-textcsv-consumer-from-catalog) to learn more about installing a CSV Consumer from the Studio Catalog* 1. Enter the **Host** name of the SFTP server provided from Incident IQ 2. Confirm or update the **Path** as advised by Incident IQ 3. Enter the **Port** number used by the SFTP server provided from Incident IQ 4. Enter the **Username** and **Password** of the SFTP server provided from Incident IQ 5. Click **Save** and use the **Test Connection** button to ensure the Connection Settings are correct 6. Configure one or more **Access Groups** to limit the Roster Data shared with Incident IQ. If **Access Groups** are not configured, all Roster Data will be shared. > *Click [here](/v1/docs/studio-access-groups) to learn more about **Access Groups** in Studio* 1. Enable and/or Run the Incident IQ Jobs to Select **Jobs** from the left navigation menu to enable and/or run the Incident IQ job 1. Click **All Jobs** 2. Search for **Incident IQ** 3. Select **All** Incident IQ jobs and: 1. Click **Enable** from the bottom menu to add them to the job schedule 2. Click **Run** from the bottom menu to run them immediately **CSV Export** When running CSV consumer jobs you must run the **Export** job separately, after all mapping jobs have been run successfully > *Click [here](/v1/docs/studio-scheduling-update) to learn more about **Job Scheduling** in Studio* ## Related - [Force.com Adapter Actions](/forcecom-adapter-actions.md) - [Rostering Applications Catalog](/rostering-applications-catalog.md) - [Setting up REST API Target from Catalog](/rest-api-consumer-from-catalog.md) - [Network Actions](/network-actions.md) - [Setting up a Delimited Text CSV Target from Catalog](/delimited-textcsv-consumer-from-catalog.md) - [Studio](/rostering-with-rapididentity-studio.md) - [Studio Job Scheduling Update in RapidIdentity 2022.4.5](/studio-scheduling-update.md)