Not logged in - Login
< back

Create or edit an application

Contents [hide]

Application Management Interface

The interface for creating and/or managing a Technical Integrator Application is based around four tabs.

The first tab defines the Application Tile that is presented to the customer. The second tab handles Single Sign On Integrations. The third tab handles Data exchange Integrations. The final Tab allows the Technical Integrator to review their application and CapitaESS to approve that application. Moving between tabs saves that data on those tabs.

The Application configuration page

This page is used to add the following application information.

  • Application Name - The name of your application and must be unique
  • Tile Name - The title shown on the Application Tile. Please see the live tile preview for how this displays.
  • Description - the short description shown on the Application Tile
  • Icon - The image shown on the tile, this should be 1:1 aspect ratio
  • Background Colour - this is the background colour of the tile
  • Text Colour - The colour of the text on the tile
  • Target URL - The URL clicking on the Application Tile will take the Local Site Admin or end-user to.
  • GDPR Summary URL - Information on how the application uses data
  • Privacy Statement URL - The Application's or Technical Integrator's Privacy notice
  • Support URL - A link to the support information of the Application
  • General Product Information URL - Product marketing website
  • * Requires Vendor Approval Post Install* slider - set this to yes if you wish to approve site installs of your application. This allows the Technical Integrator to confirm payment and/or complete additional product setup before the tile and any associated integration is made active.
  • * Audienceable* slider - By enabling the Audienceable option you allow users the ability to add the Tile to specified groups of users' Launcher Home Page. This is generally set to yes for SSO applications.

When finished and to save entered data click next.

The SSO Integration page

There are three SSO options:

  1. None
  2. OAuth/OIDC
  3. SAML 2

If your application does not require an SSO integration leave this set to None

SSO using OAuth/OIDC

If you are using OAuth/OIDC based SSO fill in the detail on this tab

  • SSO URL - This is the URL for the Integrated Application
  • Required Scopes - you can select one or more scope in addition to openid details of the scopes are in the SDK Site
  • Redirect URL - This is the URL that will be called on a successful authentication
  • Logout URL - - This is the URL that will be called on a successful logout
  • Custom Claims 1-3 - These are items of information the customer will be required to provide upon installing the application. The customer provided string will be presented in the access token on successful authentication.

Custom claims can be used to supply license codes or other sites specific static information required by your application

SSO using SAML2.0

If you are using SAML 2.0 based SSO fill in the detail on this tab

  • SSO URL - This is the URL for the Integrated Application
  • ACS URL - This is the Assertion Consumer Service URL for the Integrated Application
  • Metadata URL - This is the SIMS ID IDP Metadata URL you will require to reference in your integration
  • Custom Assertions 1-3 - these are items of information the customer will be required to provide upon installing the application. The customer provided string will be presented in the assertion returned by the SAML IDP on successful Login.

When finished and to save entered data click next.

The Data Exchange page

There are four data integration options:

  1. None
  2. One Roster & RAP API
  3. SIMS Primary API
  4. One Roster & RAP API AND SIMS Primary API

If your application does not require Data Exchange integration leave this set to None

Data Exchange using OneRoster or SIMS ID RAP API

For One Roster & RAP API Data exchange set the following:

  • Send Key/Secret to customer slider - Client Keys and Secrets are always provided to the third-party integrator. Optionally they can also be provided to the Local Site Administrator (the customer) for them to provide to you or add to your product

A list of Data Attributes exchanged for each user type. Clicking the Set button next to each user type will open a WYSIWYG editor that allows basic text formating.

Data Exchange using SIMS Primary APIs

For SIMS Primary Data exchange set the following:

  • Send Key/Secret to customer slider - Client Keys and Secrets are always provided to the third-party integrator. Optionally they can also be provided to the Local Site Administrator (the customer) for them to provide to you or add to your product

A list of Data Attributes exchanged for each user type. Clicking the Set button next to each user type will open a WYSIWYG editor that allows basic text formating.

Data Exchange using OneRoster or SIMS ID RAP API AND SIMS PRIMARY APIS

It is possible to exchange data with both data exchange sources.

When finished and to save entered data click Next

The Application Management Confirmation Page

All settings can be reviewed on the Confirmation Page.

If you need to make any changes you can use the back buttons or click on the appropriate section tab.

When finished and to save entered data click Finish.

What happens next? A member of the Capita SIMS Partner support team will review your application and if all is OK will approve your application. The Approval slider shown on the screenshot is only visible to CapitaESS Staff.

Technical Integrator Application information

Overview of the Technical Integrator Application | Managing TI Applications | Creating and Editing Applications | Authorising TI Applications installed at a site | How schools authorise your application