Skip to content

Vendor and Claimset Management

The StartingBlocks Admin App allows appropriately permissioned users to manage Vendors and Claimsets for the StartingBlocks Environments or Ed-Fi Tenants owned by their team. These directions outline steps to create and manage both of these resources.

Vendor Creation

  1. Navigate to the Vendors section under StartingBlocks Environment > Ed-Fi Tenant.

    sbaa_vendor_nav.gif

  2. If the user has the appropriate permissions, the user will be able to see the + New button at the top right of the Vendors box on this page. If you do not see this button but you believe you should have permissions to do so, please reach out to StartingBlocks support.

    new_vendor.png

  3. After clicking the + New button on the vendors page, a Create New Vendor form will pop up on the next page. To create a new vendor in Ed-Fi, you will need to enter the Company name, the Namespace prefix that governs data segmentation in the ODS, a Contact name, and a Contact email address. Your new vendor will be available to use after clicking Save on the creation page.

    vendor_creation.gif

Vendor Management

SBAA users also have the ability to manage (update and delete) vendors within their StartingBlocks Environments or Ed-Fi Tenants.

  1. Navigate to the Vendors section under StartingBlocks Environment > Ed-Fi Tenant.

  2. If the user has the appropriate permissions the user will be able to delete or update a Vendor record within their team.

    a. You can update or delete a vendor from the overall Vendors page, or by navigating to the specific Vendor's page.

    vendor_mgmt.gif

    vendor_mgmt_buttons.png

Claimset Management

SBAA users can delete, import, export, and copy claimsets within their Team, if they have the appropriate permissions.

Claimset Import

  1. Navigate to the Claimsets section under StartingBlocks Environment > Ed-Fi Tenant.

    sbaa_claimset_nav.gif

  2. If the user has appropriate permissions, they will be able to see an Import button. This button will allow a user to upload the JSON definition of a claimset that they'd like to use within their Ed-Fi Tenant.

    claimset_import.png

NOTE: There is a basic validation that happens within SBAA to ensure the JSON structure is valid to load to Ed-Fi and will notify a user if the JSON is malformed. Below is an example of a malformed claimset definition.

bad_claimset_import.gif

Claimset Export

Users can export claimset JSON definitions from SBAA using the export feature.

  1. There are 3 locations to initiate a claimset export from in SBAA.

    a. On the main claimset page there are icons when hovering over a claimset. sbaa_claimset_export_1.png

    b. When selecting a claimset with the check box on the main claimset page, a button to export the selected claimset(s) appears at the top right. sbaa_claimset_export_2.png

    c. When clicking into any claimset, there is an option to export the claimset on the claimset's specific page. sbaa_claimset_export_3.png

  2. Clicking export will activate a prompt to choose where to download the JSON definition.

NOTE: If you are selecting a claimset from the main Claimsets page, you have the option to export multiple claimsets by checking multiple boxes.

Claimset Deletion or Copy

  1. Navigate to the Claimsets page within your StartingBlocks Environment > Ed-Fi Tenant.

  2. There are 2 places that users can navigate to in order to copy or delete an existing claimset.

    a. On the main claimset page, there are icons to delete or copy a selected claimset. delete_claimset_1.png copy_claimset_1.png

    b. When clicking into a selected claimset, there are options to delete or copy the selected claimset. claimset_delete_copy.png

NOTE: Users can only delete claimsets where Is System-Reserved is False .

As with other resources and actions within SBAA, it is possible to achieve the same action multiple ways through the UI. Feel free to explore what SBAA has to offer and if you ever need extra support or would like to report an issue, please submit a ticket here!