animated OSMT logo

How-To

A step-by-step guide and helpful tips for users to complete the core tasks within OSMT.

Starting a Local OSMT

OSMT is server-based software, but you can try it out locally with OSMT's Quickstart. This local installation is for evaluation purposes. You can export RSDs and Collections, but the database behind a local Quickstart should be considered "temporary".

The actual installation of a production OSMT might look different for every organizartion. WGU and the OSMT community are actively working on ways for organizations to deploy "permanent" production OSMT instances, including what we would call "reference architectures" -- prescriptive models that could be used by multiple customers within a given cloud provider's environment. Please follow and engage with this Issue in our GitHub.

Pre-requisites

To start OSMT using the Quickstart, you will need git and Docker installed, with at least 6GB allocated to Docker. More memory will be better.

    Running OSMT Quickstart on Windows

  • Installing Docker on Windows is a manageable task, but it is not a simple double-click installation. Starting OSMT Quickstart is simpler in MacOS or in Linux. If you are a Windows user, you can install Docker with these instructions.
  • Starting OSMT Quickstart will be done by entering commands and running BASH scripts in a "terminal" window. MacOS and Linux support this natively. In Windows, you can use "Git Bash", which comes installed with git.

Running OSMT Quickstart

  1. Open a "terminal" window, and create a directory for OSMT source code, and cd into it. Download the OSMT source code repo with this command: 
    git clone https://github.com/wgu-opensource/osmt.git
    Then cd into OSMT's project directory (just created by git) 
    cd osmt

    Using the OSMT CLI utility (osmt_cli.sh)

    • The OSMT source code includes a utility named osmt_cli.sh; this simplifies setting up an OSMT environment and doing routine tasks. You can run via a terminal window, from the OSMT git repo's root directory. Run this command to see the help output: 
      ./osmt_cli.sh -h
      If you are using Windows, and having trouble running this help command, please see the "Running OSMT Quickstart from Windows" thread in the Discussion area.
  2. Obtain a "free developer" Okta account. Please follow the steps in OAuth2 and Okta Configuration, and return here when complete.
    • If your organization uses Okta for other purposes, please note that this Okta account is completely separate from any other Okta accounts or logins you may have.
  3. Initialize your environment files by running this command: 
    ./osmt_cli.sh -i
    Next, edit the osmt-quickstart.env file and replace the 'xxxxxx' values with the correct values from your Okta account.
  4. Start the Quickstart configuration. This will take several minutes to download resources and build the software. If you continue to loop on errors that report "Retrying in 10 seconds...", there's something wrong. Search and reach out in the Discussion boards in GitHub. 
    ./osmt_cli.sh -q
  5. Open your browser to http://localhost:8080. You will be prompted to log in to OSMT using Okta.
  6. Pressing [Ctrl]+C in your terminal window will stop the Quickstart. You can restart it and resume your evaluation. Please take care to use Quickstart only for evaulation purposes. You can export whatever RSDs and Collections you create in Quickstart.
Add Skills to OSMT: How to Batch Import

When first accessing OSMT, there will not be any skills in the library.

To add skills, it is recommended to use the ‘Batch Import’ feature.

  1. Click the ‘Batch Import RSDs’ button under the primary RSD/Collections search bar.
  2. To batch import, be certain to use the most current CSV template. Either drag the Microsoft Excel CSV file containing the RSD data to the upload space or click ‘select a file to upload’ from the local device.
  3. Confirm the file is the correct file for RSD data import.
  4. Click ‘Next’ to continue.
  5. The RSD properties from the CSV file will be mapped and prepared for batch import. Note that the file can be confirmed (or changed) from this screen. There is also a preview to the total number of RSDs included for batch import.
  6. RSD fields, or CSV File Properties need to be confirmed and realigned if necessary. Click the drop-down arrow and select the correct ‘Map to Property’ if necessary.

    An extra step needs to be taken to map Occupation codes upon batch import. The Occupational Major Groups, Occupational Minor Groups, Broad Occupations, and O*NET Job Codes need to be manually mapped to ‘Occupations.’ Click the drop-down arrow and select ‘Occupations’ from the list for RSD aligned fields.

  7. Once the ‘CSV File Property’ and ‘Map to Property’ fields are aligned, click ‘Next’ to import the RSDs to OSMT for review.
  8. The RSDs initially imported from the CSV files are listed for review and validation prior to importing into OSMT. Once RSDs are validated and errors corrected (if any are identified), click ‘Import’ to add the RSDs to the OSN Pilot instance of OSMT.
  9. Pop-up will briefly appear at the top of the screen confirming the successful import of RSDs to the library.

    From here, you can view the library, import more RSDs, or use any of the features available in OSMT to create or edit individual RSDs, publish RSDs, conduct a basic or Advanced search, view existing Collections, or Create a Collection. Upon importing, it is recommended to View RSD Library.

  10. Although RSDs have been imported to OSMT, they are imported in draft form, meaning they are not publicly viewable with a unique URL. RSDs may be published individually, by selecting several RSDs to publish (using the radio buttons and ellipses for options), or by adding new RSDs to a Collection and publishing the complete Collection with RSDs.

    For the purpose of this guide, RSDs will be added to a Collection and published in that manner. Prior to adding RSDs to a Collection, a Collection must be created. View the next section of the guide for creating a Collection, adding RSDs, and publishing the Collection and RSDs.

Create a Collection and Add Skills to a Collection
  1. Before adding RSDs to a Collection, the Collection must first be created. Click the ‘Create Collection’ button to get started.
  2. Add the Collection name and Author of the Collection.

    Note: The Collection Name is required to search to add RSDs to the Collection. Take note of what you name the new Collection so it can be searched for easily.

  3. Click ‘Save’ to create the Collection.
  4. Once the Collection is created, note that it is in draft form, meaning it is not publicly viewable with a unique URL. For the purpose of this guide, RSDs will be added to a Collection and the RSD and Collection will be published simultaneously. Click ‘Add RSDs To This Collection’ to add the recently imported RSDs to the Collection.
  5. RSDs in the OSMT library need to be searched for to be added to a collection. RSDs may be searched for individually in the search bar or using the Advanced Search feature. For purposes of the pilot, it is recommended to use the ‘Advanced Search’ to curate the RSDs that were batch imported. Click ‘Advanced Search’ to continue.
  6. The Advanced Search feature offers specific searching for all RSD fields. For purposes of the pilot, it is recommended to search by ‘Author.’ Once search criteria is entered, click ‘Search RSDs’ to complete the search.
  7. Review the list of RSDs yielded from the Advanced search. RSDs need to be selected in order to be added to a collection. The ‘Select All’ button may be selected to select all RSDs yielded from the search, or RSDs may be selected individual using the radio buttons.
  8. Type in the name of the Collection that was created for the RSDs and press the enter (return) key to search for the collection.
  9. Click ‘Select Collection’ next to the Collection to add the selected RSDs to the Collection.
  10. A pop-up will briefly appear at the top of the screen confirming the successful addition of RSDs to the Collection. Next, the Collection and associated RSDs need to be published so they are publicly viewable and assigned a URL. To return to the Collection, click the ‘Collections’ button at the top of the OSN OSMT Page.
  11. Locate the Collection to be published in the Collections list. If the Collection is not immediately listed on the Collections page, search for the Collection name using the Search Bar or the Advanced Search function. Click the name of the Collection to view the Collection details.
  12. Review the draft RSDs in the draft Collection. Once the RSDs in the Collection are confirmed, click ‘Publish Collection.’
  13. An alert will appear that the Collection contains draft RSDs. To publish the RSDs along with the collection, click ‘Yes, Publish RSDs and Collection.’
  14. Pop-up will briefly appear at the top of the screen confirming the successful publication of the Collection.
  15. The Collection and RSDs are now published! From here, the URL can be copied and shared, a CSV version of the collection may be downloaded, and the JSON can be copied. Individual RSDs can also be publicly viewed and shared. To view an individual RSD, click the RSD short name. Additional tasks may be completed at the individual RSD level, such as editing, copying, viewing the published RSD, and archiving.
Create a Single RSD
  1. There may be instances where a single RSD needs to be added to OSMT. From any screen in OSMT, click on the ‘Create RSD’ button under the primary search bar.
  2. Enter the RSD fields on the Create Rich Skill Descriptor page.

    Required fields include:

    • RSD Name
    • Author
    • Skill Statement

    Optional fields include:

    • Category
    • Keywords
    • Standards
    • Certifications
    • Occupations
    • Employers
    • Alignment Name
    • Alignment URL
    See the table on the next page for RSD field descriptions.
  3. Once RSD fields have been entered, click the ‘Save’ button.

    Note: If there is a similarity to an existing RSD in the library, the similar skill will be indicated for review.

Export a Single RSD or an RSD Collection
  1. Single RSDs and Collections of RSDs may be exported from OSMT using CSV. To download the raw data, view the published version of the RSD or Collection.
  2. In the public (published) view, click Download CSV, and follow browser-specific prompts for downloading files.
  3. The CSV file will contain the data for each RSD field for the single RSD or the collection in its entirety. Note that a Canonical URL (Column A) has been added with a URL for each RSD with the data export. The Canonical URL is created when an RSD is published.