The recommended way to integrate with WISEflow is to use the WISEflow API
The integration client is a basic off-the-shelf solution. UNIwise will build a scalable integration client that communicates and maps data between your external API and WISEflow. The integration client is based on an integration data model provided by UNIwise which can be set up with data relevant to your workflow.
The integration client is split up into various parts:
Fetch
The fetch part is used to look up information on specific assessments using the institution's external API and can use one or more assessment entities to create and synchronise a flow.
The data being synchronised could be:
- Start and end dates for participants and assessors
- Participants and their unique exam ID
- Assessors
- Assessor distribution
- Assessment type
This part is mandatory for a working integration client.
List
The list part provides the opportunity to build a list of fetchable assessment entities on given parameters.
This can be a help for users who do not know all fetch parameters but identifies assessment entities by e.g., title.
This part is not mandatory.
Export
The export part is used to export grades submitted by assessors/reviewers in WISEflow.
Can be customised in multiple ways e.g., to allow overwriting of already exported grades.
This part is not mandatory.
User Stories and Workflow
The integration client covers two basic user stories:
- As a manager in WISEflow, I would like to create a flow based on information from SIS and have it automatically synchronised with potential changes registered in SIS. This way SIS will be my primary source of information.
- As a manager in WISEflow, I would like to send the marks from a flow back to SIS.
Workflow
- The manager clicks "Create"
- The manager chooses the source and enters the SIS parameters identifying the unit of assessment
- The manager clicks "Request source data"
- The manager chooses the flow type (FLOWmulti, FLOWassign, etc.)
- The manager clicks "Create flow"
- WISEflow will then send these parameters to SIS through the web service which will return to WISEflow with the assessment information (students, dates, the title of flow, etc.)
- The manager will then finalise the flow set up in WISEflow and activate the flow.
- After the end of the marking period, the manager will open the flow and click “Export to SIS” to export the marks
- WISEflow will then send the marks to SIS through the web service
Prerequisites
An external API that exposes the data needed in WISEflow:
- At least one GET endpoint is required for the fetch part
- This could be one endpoint that includes all necessary data or split up in multiple for exam data, student data, staff data, etc.
- One GET endpoint is required for the list part
- One POST or PATCH endpoint is required for the export part
UNIwise will also need access to test data.
Initial Questions in Preparation for an Integration Client
- What data do you want to be imported into WISEflow?
- What do you want WISEflow to export?
- How does WISEflow pull and push the data? What web service is used?
- Are you able to provide login-ID on the students and assessors to be imported so WISEflow can create them as users?
- Does the manager know the code that uniquely identifies the exam in your SIS? Or should the manager choose from a list of exams after entering a known code such as the course code?
- In relation to a time plan, do you currently have a web service for WISEflow to use or do you need to develop one?
After the initial process, UNIwise will be able to estimate the project:
- The institution builds the API needed and hands over specifications to UNIwise
- UNIwise builds the integration client