Historical Data Migration Request Formatting

Document created by Scott Wasilewski Employee on Dec 21, 2017Last modified by Renee Carney on Dec 22, 2017
Version 3Show Document
  • View in full screen mode

 

Bridge Implementation is now conducting historical data migrations for users in an effort to reduce the turnaround time for our customers. Due to the ever increasing demand for data migration and the limited resources available, managing expectations between customers and internal teams can become difficult. Following the instructions on this page will allow us to manage expectations, both, internally and externally.

 

 

File Formatting

 

The customer will have to supply a CSV file with all the items that they would like imported into Bridge. There are some formatting and data considerations that will need to be addressed:

    • This CSV file will have to be UTF-8 encoded.
    • Date formats should be in YYYY-MM-DDTHH:MM:SS.mmm format.
    • Data provided must match EXACTLY with the data in Bridge it should match to.
      • "Seven" does not equal "7"
      • "&" does not equal "and"
      • "1234" is not the same as "1 234" or "1234 "
    • The column headers should match the spelling and formatting of the required/optional fields they correspond to.

 

Data Requirements

 

There are a few different types of content migration that customers request. To accommodate these differing requests we require different information:

    • Add Users
      • Required:
        • uid: A unique Identifier for the user. Either this or a unique email address is required.
        • email: The users email address. Either this or a unique identifier is required.
      • Optional
        • first_name: User first name
        • last_name: User last name
        • full_name: User full name
        • sortable_name: User sortable name (last, first in European-American culture)
        • locale: The user's language code
        • manager_id: ID of the user's manager. Alternatively, the UID of the user's manager, prefixed with "uid:"
        • hire_date: Date that user was hired, in ISO 8601 format (YYYY-MM-DD)
        • custom_fields: Optional custom fields. These must be created before assigning them to users.
    • Add Course Enrollments (Requires that the course exists in their instance):
      • Required:
        • course_template_id: The course number for the enrollment to be created.
        • user_id: User to enroll. Either user_id or group_id must be included, but not both.
        • group_id: Group to enroll. Either user_id or group_id must be included, but not both.
      • Optional:
        • end_at: Due date for this enrollment.
        • state: Current state of enrollment. One of 'created', 'active', or 'failed'.
        • required: Is this enrollment required.
    • Add Completed Course Enrollments (Requires that the course exists in their instance):
      • Required:
        • course_template_id: The course number for the enrollment to be created.
        • user_id: ID of the user to be enrolled.
        • score: Score (out of 100) for completed enrollment.
        • completed_at: Completion date for this enrollment.
      • Optional:
        • expires_at: Expiration date for this enrollment.
    • Adjust Existing Course Enrollments (Requires that the course exists in their instance):
      • Required
        • course_template_id: The course number for the enrollment to be created.
        • user_id: ID of the user to be enrolled.
      • Optional:
        • end_at: Due date for this enrollment.
        • expires_at: Expiration date for this enrollment.
        • score: Score (out of 100) for completed enrollment.
        • completed_at: Completion date for this enrollment.
        • end_at: Due date for this enrollment.
        • state: Current state of enrollment. One of 'created', 'active', or 'failed'.
        • required: Is this enrollment required.
    • Add Live Training Enrollment (Requires that the live training exists in their instance):
      • Required:
        • live_course_id: Path parameter. Live course id for the learners we want
        • user_id: User id of the learner
    • Add Completed Live Training Enrollment (Requires that the live training and a live session exists in their instance)
      • Required:
        • live_course_id: Path parameter. Live course id for the learners we want
        • user_id: User id of the learner
      • Optional:
        • live_course_session_id: Live course session id
    • Adjust Existing Live Training Enrollment (Requires that the live training and a live session exists in their instance)
      • Required:
        • live_course_id: Path parameter. Live course id for the learners we want
        • user_id: User id of the learner
      • Optional:
        • live_course_enrollment_id: Enrollment id of existing Live Course enrollment.
    • Other
      • Please reach out to an IC before submitting a ticket to discuss the feasibility of your request.

Attachments

Outcomes