Administration

Administration for Instrument is not required within Instrument itself, the functionality of Instrument does rely on your data model and additional configuration from within workbench.

This section goes over administration specific to Instrument. You may also reach STEP-specific information via the Help link within workbench or via the STEP Documentation link on your system's Start Page.

Prerequisites

  • Be on the most recent STEP version. Going forward, update to the latest version when available. Instrument updates will not be backported.

  • Verify that you have set up (integrated and configured) a faceted search solution to use the search functionality. Refer to the Elasticsearch Setup topic / section in the STEP Documentation.

  • Verify that your system has In-Memory. Refer to the In-Memory Database Component for STEP topic / section in the STEP Documentation.

  • Verify that you have a classification folder with the ID of "IllustrationRoot" set up in STEP. If not, you will need to set one up to allow users to make a selection for their work area image. If the user encounters an error (i.e., "Error with asset upload configuration."), checking to ensure this classification folder is set up should be the first step in troubleshooting.

  • Users that will be accessing the classification folder need proper privileges to do so.

  • Verify that you have set up business actions and designated a specific setup group for Instrument users to access and use. By default, no business actions are shown without this setup. Refer to Setting business action availability for instructions.

  • Finally, verify that you have a classification folder set up to allow users to make a selection for their work area image. The default ID for the classification folder is ID = IllustrationRoot, but can be changed based on user requirements via a GraphQL mutation. Refer to Setting default asset upload classification for instructions.