Documentation

We want to make sure we are all speaking the same language. So, here’s a list of the terms we use in these guides and in your dashboard. 

• Career Snapshot Dashboard: Your Career Snapshot Dashboard is where you go to manage existing code snippets and create new ones. 

• Items: Items are based on your school’s “programs”. Create an item for each program to then build a code snippet to display the careers that a program leads to

• Item Types: Item types are the types of programs your school offers (i.e. Degree, Certificate, Transfer, etc.). This can be general (i.e. Degree) or specific (i.e. Associate in Arts Degree). 

• Organization: The organization mimics your school’s organizational hierarchy  (i.e. Division → Department) 

• Custom Items: This is where you can build code snippets for items that are not based on your school's programs or standard organizations. For example, create a Career Cluster/Meta Major Item to build a code snippet to display the careers that a specific meta major leads to. Or create a Hot Jobs item to display careers from a variety of industries that are trending/growing. Custom Items can be anything you need/want/can imagine!

• Code Snippet: This is a fancy name for your “Embed Code”. After creating an item and adding careers to the item, you’ll get a Code Snippet. Just copy and paste it into your site, app, or wherever you want the career data to be displayed and voila — you’ll have real-time labor market data displaying for the careers you have selected.

Before creating your code snippets, you need to set up the organization and item types. This is not required — you could choose to create all code snippets using the Custom Items and not based on any organizational structure. But, if you want to align your code snippets to your organization, this is where you start! 

Organization Structure

1. Once logged in to your Career Snapshot Dashboard, go to Organization.
2. Start by adding additional units to the highest level of your organizational structure. For example, if your structure is Division → Department, start by adding each of the Divisions. Click Add New. A modal will open for you to enter the name and select the type of organization structure you’re adding. Click Continue to add. 
3. Next add the units for the next level in your organizational structure. Following the same example as above (Division → Department) add a department by clicking Add New, entering the and type and click Continue. After adding the department, you will be returned to the screen. Click edit next to its name and select the higher unit (i.e. Division) from the list that it belongs to. For example, if adding a “department”, you would select the “division” it belongs to. Complete this for each unit of your organizational structure.

Item Types

Item types are the types of programs your school offers (i.e. Degree, Certificate, Transfer, etc.).  To add your item types, go to Item Types from your Career Snapshot Dashboard. From here, follow these steps:

1. Click add new and give the name of your Item Type.
2. Click Add
3. Repeat for each item type

Use these instructions to create code snippets for your school’s programs. For example, if you have a Political Science AA Degree, you may create a Code Snippet of careers that the Political Science Degree could lead to. This could then be added to your Political Science Degree page. 

1. From your Career Snapshot Dashboard, go to Items.
2. Click Add New and enter the name of your Item (i.e. Political Science AA Degree). 
3. Select the Item Type from the dropdown. Note: If there are no Item Types, you will need to set those up before creating items.
4. Click Add to create the item. 
5. A success modal will appear. Click Continue and Edit to begin adding Careers to your item.
6. Under Careers, begin typing the name of the career you wish to display labor market data for. The field is autocomplete — as you type matching career options will appear in a dropdown menu. Select the name of the career and it will appear in the text field.
   • Note that careers you may select are limited to those provided from the Bureau Labor of Statistics. 
7. Once you have found the career(s) you wish to display click the Add Button and the career will be added to the Selected Career list. 
8. You can continue to add careers to build your snippet. Once in the Select Career List, you can drag and drop the careers to rearrange the order they will be displayed in.
9. The Organization area will display the structure you have set up in prior steps. Select the appropriate items to add the item to your organization structure. 
10. Click save to create your snippet and/or update it with the latest careers.

And that’s it! Once you have selected your careers, your code snippet will appear in the box under Embed Code! Just copy the code and paste it on your website, app or wherever you want the career data to be displayed.

Use these instructions to create code snippets for custom lists that are not based on your school's programs or standard organizations. For example, create a code snippet to display a list of careers that a meta major or Career Cluster may lead to. 

1. From your Career Snapshot Dashboard, go to Custom Items.
2. Click Add New and enter the name of your Custom Item (i.e. Hot Jobs in STEM). 
3. Select the Item Type from the dropdown. Note: If there are no Item Types, you will need to set those up before creating items.
4. Click Add to create the item. 
5. A success message will appear and you will now see the new Custom Item in your list of items. Click the Edit link next to the item to begin adding Careers to display.
6. Under Careers, begin typing the name of the career you wish to display labor market data for. The field is autocomplete — as you type matching career options will appear in a dropdown menu. Select the name of the career and it will appear in the text field.
   • Note that careers you may select are limited to those provided from the Bureau Labor of Statistics. 
7. Once you have found the career(s) you wish to display click the Add Button and the career will be added to the Selected Career list. 
8. You can continue to add careers to build your snippet. Once in the Select Career List, you can drag and drop the careers to rearrange the order they will be displayed in.
9. Click save to create your snippet and/or update it with the latest careers.

And that’s it! Once you have selected your careers, your code snippet will appear in the box under Embed Code! Just copy the code and paste it on your website, app or wherever you want the career data to be displayed.

The jobs displayed in your Code Snippets can be edited at any item - before or after they have been added to your website. 

To make a change go to Items or Custom Items (where ever the snippet was built) and click the edit link next to the name of Code Snippet you want to change. From here, remove jobs, add new ones and/or drag and drop the jobs into a new display order. Once finished, click save and your code snippet will automatically be updated with your changes. 

You do not need to change/update code snippet on your webpage (or wherever you have it added) to see the updates!. The Code Snippet always remains the same!

Accordion vs. Modal

Every code snippet comes with two display options — an Accordion (Default) or a Modal. You can use both in different places of your website. Just copy the code for the display you wish to use and paste it where you are using it!

Decide you want to change? No problem. Just copy the code the other display and paste it where you are using it.

Display Settings

The Display Settings allow you to customize the type job labor market data that is displayed for the careers selected in your code snippet.  

The Default Data displayed is:

• Job Description
• Median Hourly Wage
• Median Salary
• Job Growth
• Education
• Alternate Job Titles
• Employment (Current Number Employed)

To customize what data is displayed:

1. Under Display Settings toggle on “Custom display?”  (when green custom display it on). 
2. Once “Custom Display” is toggled on, a list of all types of data will appear. 
   • To have the Data Display, toggle it on (green).
   • To have the Data not display, toggle if off (gray).
3. Once finished, click save and your customized display will be updated.

Custom Colors

By default, all Code Snippets in your account will use the colors set up at your Account Level. But, you can also set custom colors at the code snippet level to have a specific code snippet display with different colors. 

To set custom colors:

1. Open the Item/Custom Item in your Dashboard. 
2. Under Color Themes, add the hex values for the corresponding item(s) you would like displayed is a custom color.
3. Once finished, click save and your code snippet display will be updated.

Note: You do not need to change the colors for all items. Any that don’t have custom colors set will be displayed in the default colors.