Skip to main content

Creating a Data Collection Form

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 ID - The system ID number identifying the service
  • Name Name - The display name of the service in question.
  • Type - The type of the service. Defaults to "Scheduled"
  • Parent Group 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 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 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 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 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 form creation, deletion, and update actions

    • Only Create - Send a notification on form creation
    • Only Update - Send a notification on form update
    • Only Delete - Send a notification on form deletion 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)

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.

Form Configuration Manager

Custom data collection forms can be configured to collect any desired data including digital signatures from submitters.

ServiceConfig-DataFormConfig.png

  1. Title - The title of the form
  2. Allow Editing
    1. Yes (all) - Allow users to edit form submissions after submission
    2. Yes (Recieved Only) - Allow users to edit form submission as long as they are in the "Received" state
    3. No - Disallow form editing after submission
  3. Current Fields - Control and edit the forms for this data collection form

ServiceConfig-DataFormFieldConfig.png

  1. Label Field - Used to set the name of the field
  2. Data Key Field - Defines the name of the storage variable. Should be unique across all fields
  3. Field Type Selector
    • Markdown Block - Display a markdown formatted section of text
    • Text Field - Single Line Text Field
    • Text Area - Multi-line text field
    • Number - Floating point number field
    • Select - Single Item select
    • Multi-Select - multiple item select
    • Section Divider - Section Divider with or without   title
    • Signature Block - Email target for signature request
  4. Field Details/Config Button - Displays field type configurations
    • Markdown Block  
      DataFieldConfig - Markdown.png
    • Text Field - Single Line Text Field
    • Text Area - Multi-line text field
    • Number - Floating point number field
      DataFieldConfig - Text.png
    • Select - Single Item select
    • Multi-Select - multiple item select
      DataFieldConfig - Select.png
    • Section Divider - Section Divider with or without   title
    • Signature Block - Email target for signature request
  5. Move Field Up - Alters display position of field
  6. Move Field Down - Alters display position of field
  7. Copy Field Button
  8. Remove Field Button
Back to top