Skip to main content

Black Box Sample Processing Service Config

Black Box Sample Processing (BBSP) services for the resource system represent an order for services that have an item quantity and price per item. BBSP Services also include limited sample configuration and data storage ability.

Creating a new service

A new service can be created by clicking the "Create New Service" button located above the service list search box

ServiceConfig-CreateButton.png

Newly created services will not exist until saved after initial configuration. This means that some functionality that needs an id number such as creating service rates will not be available until the user click the "Save" button to save a newly created service.

ServiceConfig-NewRecord.png

Identifiers

ServiceConfig-Identifiers.png

  • Record ID - The system ID number identifying the service
  • Name - The display name of the service in question.
  • Type - The type of the service. Defaults to "Scheduled"
  • Parent Group  - The group to which this service belongs. Defaults to the currently active group but may be changed to any group that the creating user is listed as a manager for

Visuals

ServiceConfig-Visuals.png

  • Color - The color of the button to access the service as it appears in the group services list. This field will accept and valid CSS color in string format. Ex:
    ServiceConfig-ColorDetail.png
  • Display Weight  - How high in the list a service will be displayed. Higher values will display first. Ex: 10 will appear after 50
  • Display Path - For facilities with large numbers of instruments / services it can be helpful to have some additional level of organization. The display path setting allows managers to organize services into folder style nested groupings. The convention follow standard unix pathing conventions. Ex: "/Microscopes/" will display the given service under an expandable section with all other services that have the same configuration.

Contact Information

ServiceConfig-Contacts.png

  • Location - The location the service is located at. This field is optional and will display after the service name on the list of services
  • Contact Email - The list of email addresses that should be send a notification message. The contact email list can be configured to send emails to any number of addresses. Generally this will be the email of the person or persons responsible for managing the instrument. Email contacts can be configured to receive emails on the following events:
    • All Events - Send a notification for order creation, deletion, and update actions
    • Only Create - Send a notification on order creation
    • Only Update - Send a notification on order update
    • Only Delete - Send a notification on order deletion 
  • Note: The contact email configuration does NOT override the general "Notification Verbosity" setting for the service. If a service is configured to suppress all notification messages then no emails will be sent regardless of the contact email configuration. Also note that Line Item orders only generate "Create" notifications.

General Config

ServiceConfig-General.png

  • Enabled - Whether this services is actively in use
    • Yes - Active
    • No - Inactive
    • Archived - Inactive and hidden from search list. (Used for removing services from general use and declutting un-used service records
  • Notification Verbosity - When to send notification emails for actions that occur on the service
    • No Messages - No notifications sent
    • On Create - Only send order creation notifications
    • On Delete Only - Only send event deletion notifications (Delete not applicable for Line Item Orders)
    • On Create/Delete - Only order notification when an event is created or deleted (Delete not applicable for Line Item Orders)
    • All Messages - Send notification for all event creation, update, and delete actions (Delete and Update not applicable for Line Item Orders)
  • Manager Only - Controls if service is visible/available to all users of a facility or just facility managers

Tags

ServiceConfig-Tags.png

Tag strings used by the system for categorization and certain actions. No special tags are defined for services at this time.

Custom Data Config

ServiceConfig-DataConfig.png

ServiceConfig-LineItemDataField.png

Some services may require additional information to perform. Up to 5 custom data fields may be enabled for the ordring user to enter custom information. These custom fields will appear as text input boxes at the bottom of the line details with the provided data label/query.

Service Presets

Service presets for the BBSP system function as 

ServiceConfig-BBSPPresetConfig.png

  1. Process Type - The name of the process to be selected. Users will be able to select among the provided presets.
  2. Type - Whether the preset should be treated as a required fee or as a process to be performed on samples
    • Process - Charge Per Sample
    • Unused (1) - Can be selected if service is converted from another service type
    • Unused (2) - Can be selected if service is converted from another service type
  3. $/Sample - The rate to charge per sample
  4. $/Sample (Commercial) - The rate to charge per sample
  5. Min Sample # - The minimum number of samples a user needs to submit to be able to select this process
  6. Maximum Quantity - The maximum number of samples a user can to submit to be able to select this process