Loading...

How to ensure your UIP data is sent

Is UIP streaming switched on?

There is a hidden setting in your Wisenet that we can update for you, where UIP streaming can be switched on or off.

  • If UIP streaming is not switched on, nothing gets sent to UIP when you create or update records
  • We will update this setting for you as we work together with you to pass the initial compliance tests and prepare for live streaming
Create, update, save?

Once you’re live streaming updates to UIP, then when a record is saved, Wisenet checks whether it’s a new record that’s just created; an existing record with a UIP relevant update; or an existing record updated but in a way not relevant for UIP.

  • for a new record that meets the rules for UIP and all required fields are present, we will generate a new UIP record and send it
  • for an existing record that meets the rules for UIP and has some UIP field change, we will send an update to the existing UIP record
    • e.g. client ethnicity is updated
  • for a new or existing record that meets the rules for UIP, but a field required for the UIP record was left empty, then we will not send any update to UIP but we will email you
    • e.g. client ethnicity is updated and ethnicity 1,2, or 3 is Maori and iwi is empty
  • for an existing record that is updated, and meets the rules for UIP, but the field that was updated is not part of the UIP record, then we will do nothing
    • e.g. client ‘Sync to Xero’ is updated
  • for an existing record that is updated, but does not meet the rules for UIP, we will do nothing
    • e.g. a unit is saved with ‘For UIP’ switched off
Empty fields will stop a record from being sent

The Wisenet UIP service checks records that appear to need sending to UIP. If any required field for a UIP message is empty, the record will not be sent to UIP, and we will instead send an email to your nominated address describing why the record was not sent to UIP.

  • Monitor these emails carefully! You need to correct your data so it will send via Wisenet UIP services
  • Example: a unit is saved with ‘For UIP’ switched on but ‘Register Level’ is empty. The record will not be sent to UIP
Settings

On save, the Wisenet UIP web service will update a record for your organisation if you have updated a field that appears in UIP, as long as no required fields for this message are empty.

  • owner name
  • provider code
Unit – the UIP ‘Component’

As long as no required fields for this message are empty:

  • This record will be created the first time that the unit is saved with For UIP switched on
  • This record will be updated when any of its fields changes AND it is saved with ‘For UIP’ switched on
    • code (must not contain spaces)
    • description
    • SCED Field of Study
    • Credits as listed on the NZQA website
    • NZQA Register Level
    • Date First offered
    • Date Last offered (Optional. Leaving this field empty will not prevent UIP record being sent.)

Learn More? Units

Client – the UIP ‘Learner’

The UIP ‘learner’ has 3 components:

  1. Identity
    • This record will be created the first time that a client has a Course Enrolment which is saved with For UIP switched on
    • This record will be updated when any of its fields changes AND client has a Course Enrolment which is saved with ‘For UIP’ switched on:
      • name (first, middle, last. If client contains only one name, enter the name(s) in the Last Name and put ~ in the First Name)
      • date of birth
      • gender
      • NSN
  2. Demographic
    • This record will be created the first time that a client has a Course Enrolment which is saved with ‘For UIP’ switched on
    • This record will be updated when any of its fields changes AND client has a Course Enrolment which is saved with ‘For UIP’ switched on
      • Ethnicity
      • iwi (only required if Ethnicity is recorded as Maori)
  3. Residency
    • This record will be created the first time that a client has a Course Enrolment which is saved with ‘For UIP’ switched on
    • This record will be updated when any of its fields changes AND client has a Course Enrolment which is saved with ‘For UIP’ switched on
      • Country of citizenship
      • Immigration status
      • Passport number

On save, the Wisenet UIP web service will create or update a record if:

  • client has a course enrolment where For UIP is true
  • as long as no required fields for the particular message are empty
Course Enrolment – the UIP ‘Provider Enrolment’ and ‘Qualification Completion’

Provider Enrolment

As long as no required fields for the message are empty:

  • This record will be created the first time that the Course Enrolment is saved with ‘For UIP’ switched on
  • This record will be updated when any of its fields changes AND is saved with ‘For UIP’ switched on
    • Course Enrolment> Start Date
    • Course Enrolment> Actual End Date. Note, if actual end is empty, we will use the nominal end instead. Leaving this field empty will not prevent UIP record being sent, unless nominal end is also empty
    • Course Enrolment> Nominal End Date

Qualification Completion

As long as no required fields for the message are empty:

  • This record will be created the first time that the Course Enrolment is saved with For UIP switched on AND Qual Issued is TRUE
  • This record will be updated when any of its fields changes AND is saved with ‘For UIP’ switched on
    • Course> Code
    • Course> Qualification Source
    • Course Enrolment> Qualification Date Issued
Unit Enrolment – the UIP ‘Learner Component Enrolment’ and ‘Learner Component Completion’

Learner Component Enrolment

As long as no required fields for the message are empty:

  • This record will be created the first time that the unit enrolment record is saved AND all UIP required fields have some value in them WHILE Course Enrolment has ‘For UIP’ switched on AND WHILE Unit ‘For UIP’ is switched on
  • This record will be updated when any of its fields changes AND WHILE Course Enrolment has ‘For UIP’ switched on AND WHILE Unit ‘For UIP’ is switched on
    • Unit enrolment> start date
    • Unit enrolment> end date
    • Unit enrolment> actual end date. Note, if actual end is empty, we will use the nominal end instead. Leaving this field empty will not prevent UIP record being sent, unless nominal end is also empty
    • Unit enrolment> delivery location code
    • Unit enrolment> nominal hours
    • Unit enrolment> tuition weeks
    • Unit enrolment> fee
    • Course Enrolment> Funding Source > 02, 03 or 12 are the correct codes for UIP
    • Course> Qualification Source
    • Course> Code

Learner Component Completion

As long as no required fields for the message are empty:

  • This record will be created the first time that the unit enrolment record is saved AND SDR Outcome is 2,3,4 or 9 WHILE Course Enrolment has ‘For UIP’ switched on AND WHILE Unit ‘For UIP’ is switched on
  • This record may also be created when a unit enrolment is deleted. See UIP: Deleting or removing a unit enrolment
  • This record will be updated when any of its fields changes AND WHILE Course Enrolment has ‘For UIP’ switched on AND WHILE Unit ‘For UIP’ is switched on
    • Unit enrolment> end date
    • Unit enrolment> actual end date. Note, if actual end is empty, we will use the nominal end instead. Leaving this field empty will not prevent UIP record being sent, unless nominal end is also empty
    • Unit enrolment> SDR outcome code (note that updates will only be sent if the saved code is 2,3,4 or 9)
Initial Load

On initial load, every record that is already is a state to meet the UIP rules will be uploaded

  • units with For UIP true
  • course enrolments with For UIP true
  • as long as no required fields for each message are empty
SMS Information

Wisenet also sends a UIP web service message with information about the Wisenet SMS service.

  • You will not need to make any adjustments to this message as Wisenet will take care of it
  • Details of the SMS Information message are in the UIP: Wisenet Fields Map page
  • Our SMS Information message is submitted for Ministry of Education compliance testing as well as initial load and live streaming, where required

Was this Resource helpful?