Configuring Integrations

To import data from external sources (3rd party, or another GideonSoft system), GideonSoft must be configured to accept this type of data.

 

Note: Configured Integration sources are shared throughout the Organization, so it is strongly recommended to not delete or edit any existing integrations unless you are certain the change will not affect any other Instances.

 

To begin, click “Data” … “Integrations”. (You can also access Integrations from the Manage Data page: Data… Tools… Integrations.)

 

Initial Integration Setup

• Click the green “New Integration” button.
• Select a source in the drop down:
  • Catapult … select one of two options:
    • Catapult GPS API … connects to a Catapult account directly to retrieve data.
    • Catapult GPS CSV … requires a CSV file generated by a Catapult device/system.
  • CSV … select one of two options:
    • Configurable CSV… the most flexible provider; imports CSV files from a variety of sources, and can be customized to accommodate most CSV output formats
    • Generic Evaluation CSV … a basic provider that imports CSV files with a specific format (Identifier, Variable, Value, Timestamp)
  • Jaguar CSV … (beta) requires a file generated from a Jaguar device/system.
  • OmegaWave API … (beta) requires a file generated by an OmegaWave device/system
  • Polar CSV … (beta) requires a file generated by a Polar Pro device/system
  • Xml Backup Import … accepts backup files generated by GideonSoft’s Data Transport tool (see Viewing and Exporting Data). Requires no other configuration options to use.
• Enter a name for this new connection.
• The initial setup is complete, and depending on the provider selected, there may be additional options to configure.

 

Configuring Source Options

Once a source connection has been created, there may be options required for it to properly import data as intended. If the “Integrations > Edit” screen is not already displayed, click the down arrow to the right of the source, and then click “Edit”.

 

General

These settings function the same for all providers.

• Description … the name entered on the initial setup screen (required)
• Integration … the provider selected on the initial setup screen (non-editable)

 

Source-specific settings

These options vary for each source.

• Catapult GPS
  • (API only) Integration Options … there are 2 sets of credentials required.
    • Client Id and Client Secret … for the organization
    • Username and Password … for the target department or program.
  • Evaluation Options … see Evaluation Options below.
  • (API only) Scheduling Options … (off by default) this option can enable the import to take place automatically, at hourly, daily, or weekly intervals.
• Configurable CSV
  • Integration Options … this section references the fields that make up the CSV file. Don’t leave any fields out, even if they are unused (you can let the import engine know if you need to ignore a field).
    • Number of rows to skip … if headers are not in the first row.
    • Fields … Name and Type are required, and Related Field is optional.
    • Fields can be set up manually or by uploading a sample spreadsheet.
      • (Manual) Click “Add new field”, or
      • Click “Upload sample spreadsheet” and drag and drop your CSV on to the designated area (GideonSoft will automatically attempt to apply a Type for each field). Each field will require some settings:
        • Provide a Name (must match the source CSV column headers exactly).
        • Select how GideonSoft should recognize the field:
          • Ignore … (do not import)
          • Identifier … the subject’s Instance Identifier
          • Evaluator … the assessor’s Instance Identifier
          • Timestamp … of the evaluation (not the import)
          • Variable Name … the name/label of the variable being imported (e.g. “Weight”)
          • Variable Data … the value of the variable being imported (e.g. “188”)
          • Variable Descriptive Data … additional information about the evaluation that may provide context (e.g. “Session Type”)
          • Score Data … to import as a raw score value
          • Person Descriptive Data … additional information about the person that may provide context
        • (Optional) Enter a related field … sometimes the label for a value is stored in a separate column, as opposed to being saved as the header for the value column. You can set the column with the value as “Variable Data”, the column with the label as “Variable Name”, and then enter the name of the column with the label in the Related Field box.
          • For example, the column with values is called “Score”, but there’s another column called “Event” that contains the label (or what you want the evaluation name to be saved as. E.g. Pushups, Pullups, Situps). The “Score” field would be set to Variable Data, with the Related Field “Event”, and the “Event” field would be set to Variable Name. Instead of a series of evaluations with the name “Score” but no way to tell which event it was, you’d have a set of evaluations clearly named “Pushups”, “Pullups” or “Situps” with the proper score data saved for each.
  • Evaluation Options … see Evaluation Options below.
• Generic Evaluation CSV
  • Evaluation Options … see Evaluation Options below.
• Jaguar CSV (beta)
  • Integration Options
  • Enter Jaguar Chip Score Name(s)
  • Separate entries by semicolon, comma, or by each line
• OmegaWave API (beta)
  • Integration Options
  • Base URL … select one from the drop down
  • OmegaWave Client ID … provided by OmegaWave
  • Evaluation Options … see Evaluation Options below.
• Polar CSV (beta)
  • Evaluation Options … see Evaluation Options below.
• Xml Backup Import
  • There are no additional options for this source. This is designed to import a GideonSoft XML backup file generated by the Data Transport utility.

 

Evaluation Options

These are applied to every evaluation integration source.

• Evaluation Variable Type … this provides a “Type” label for each imported evaluation that can be used to identify or group them (e.g. “GPA Import Evaluation”)
• Assigned Evaluator … this creates an Instance level object (if it doesn’t already exist) that will be associated as an “Assessor” for each imported evaluation. (e.g. “Academics Import”)
• Include Audit Information … if enabled, this adds a timestamp when the import occurred (not when the evaluation occurred), source file name and GideonSoft username of the person that performed the import.

 

Person Mapping Options

This group of settings “connects” the person in the import record to the person in GideonSoft, and functions the same for all sources (except Xml Backup).

• Person Identifier (Instance level) … (default) the value in the (Name/ID/Identifier/mapped) field in the source file must match the Instance Identifier value exactly.
• Global Identifier …  the value in the (Name/ID/Identifier/mapped) field in the source file must match the Global Identifier value exactly.
• Person Descriptive … for each person in the Instance, a person descriptive can be added just for mapping names/IDs. This descriptive would be entered here. For instance, a person descriptive called “Catapult_ID” could be added in GideonSoft in order to map the data being imported to the correct people in the system, so you would enter “Catapult_ID”.

 

 

 

= = = = =

Version(s): 18.3 and later