API Docs for: 1.3.12
Show:

MedbiqImport Class

Importer methods to create competencies based on a Medbiquitous competency XML file

Methods

analyzeFile

(
  • file
  • success
  • [failure]
)
static

Analyzes a Medbiquitous XML file for competencies and saves them for use in the import process

Parameters:

  • file Object

    Medbiquitous XML file

  • success Callback1>

    Callback triggered on succesfully analyzing competencies, returns an array of all of the competencies found

  • [failure] Callback1 optional
                                        Callback triggered on error analyzing file

importCompetencies

(
  • serverUrl
  • owner
  • success
  • [failure]
  • [incremental]
)
static

Method for actually creating the competencies in the CASS repository after a Medbiquitous XML file has been parsed. Must be called after analyzeFile

Parameters:

  • serverUrl String

    URL Prefix for the created competencies (and relationships?)

  • owner EcIdentity

    EcIdentity that will own the created competencies (and relationships?)

  • success Callback1>

    Callback triggered after successfully creating the competencies from the XML file

  • [failure] Callback1 optional
                                        Callback triggered if there is an error while creating the competencies
  • [incremental] Callback1 optional
                                        Callback triggered incrementally while the competencies are being created to show progress,
                                        returns an object indicating the number of competencies created so far

    importCompetencies

    (
    • text
    • serverUrl
    • owner
    • success
    • [failure]
    • [incremental]
    • repo
    )
    static

    Method to create competencies (and relationships if the parameters are passed in) based on a CSV file and references to which columns correspond to which pieces of data.

    Parameters:

    • text Object

      Text to extract competencies from

    • serverUrl String

      URL Prefix for the created competencies (and relationships?)

    • owner EcIdentity

      EcIdentity that will own the created competencies (and relationships?)

    • success Callback2, Array>

      Callback triggered after the competencies (and relationships?) have been created

    • [failure] Callback1 optional
                                         Callback triggered if an error during creating the competencies
    • [incremental] Callback1 optional
                                         Callback triggered incrementally during creation of competencies to indicate progress,
                                         returns an object indicating the number of competencies (and relationships?) created so far
    • repo EcRepository

      Repository to save any new data to, or to use to generate IDs.

    • medbiqXmlLookForCompetencyObject

      (
      • obj
      )
      private static

      Does the legwork of looking for competencies in the XML

      Parameters:

      • obj Object

        Parsed XML Object

      medbiqXmlParseCompetencyObject

      (
      • obj
      )
      private static

      Does the legwork of parsing the competencies out of the parsed XML

      Parameters:

      • obj Object

        Parsed XML Object