Description
This package contains a basic order portal plugin to create new orders and samples which has a separate interface from SLIMS.
The package includes some entities that can be used in combination with the portal:
- Three fields to indicate if an entity can be shown in the portal:
- Content Type
- Order Type
- Requestable
- A field to connect an User to a specific customer reference data record
- A reference data type, Portal: Custom Tab, to create additional read-only tabs in the portal
- A role that can be assigned to users that only interact with SLIMS via the portal
How to use the package
Pre-requisite
All data that should be shown in the portal should already be configured in SLIMS, this requires finalization of setup for the following:
- Content types
- Order types
- Requestables; either in the Requestable module or Workflow Management
- Fields on content
- Fields on orders
Configuration
After import the following should be set in SLIMS:
- Indication which content types can be selected
- Indication which order types can be selected
- Indication which requestables, if any, can be selected
- Any read-only tabs that should be displayed
Any customer that requires access to the portal should be created in SLIMS as an user with basic requester entitlement in their role.
In the portal configuration at least the following parameters should be updated:
- orderFormFields
- orderGridFields
- sampleFormFields
- sampleGridFields
- defaultLocationUid
- This can be removed or should have the location UID (barcode) filled in
- orderWindowHelpText
The portal will be accessible via the following link: <http address of slims instance>/slims/slims-vaadin/?plugin<name of plugin>&renderer=<portal id>
The portal contains the following parameters that can be adjusted:
|
Name
|
Description
|
|---|---|
|
Name
|
Description
|
| portalId | The name of the renderer in the http address |
| portalTitle | Name as shown in the top bar of the portal |
| oderTabTitle | The name of the tab where the customer will see all orders submitted by them |
| orderFormFields | The list of fields that are shown when a customer creates or updates the order item |
| orderAttachmentFormFields | Any attachment fields where a customer can upload a field
Fields from which a customer should only download a file, should not be listed here |
| orderGridFields | The fields shown in the order overview grid |
| orderGridSortingField | The sorting field of the order grid |
| sampleFormField | The list of fields that are shown when a customer creates or updates an sample |
| sampleGridFields | The fields shown in the sample overview grid when an order is opened |
| requiredSampleFieldsInPortal | Fields that required for a sample to be filled before being able to submit |
| allowedStatusUidToEditSamples | Statuses where the customer is allowed to update the sample data |
| allowedStatusUidToEditOrder | Statuses where the customer is allowed to update the order data |
| customerFormFields | The customer data fields, that are allowed to be updated by an customer |
| contentRequestablesField | Field which holds the link between the samples to be submitted and the requestables that were indicated |
| contentTypeShowInPortalField | Checkbox field for indication of the content types that are shown in the portal for selection |
| requestableShowInPortalField | Checkbox field for indication of the requestables that are shown in the portal for selection |
| orderTypeShowInPortalField | Checkbox field for indication of the order types that are shown in the portal for selection |
| customerField | Field that links the user to the correct customer reference data |
| defaultOrderTypeUid | Order type to use if the order type field is not available in the portal |
| defaultContentStatusUid | Content status to use if selection in portal is not available |
| defaultLocationUid | The location where the samples created by the portal are stored
Parameter should be removed if the content should not be automatically placed in location |
| orderWindowHelpText | Text that shows up at the bottom of the create order pop-up window |
| addAllApplicableRequestables | Setting that adds all requestables that are allowed on a created order if set to true |
| scheduleOrderOnCreation | Automatically schedule the contents of an order to the workflow if set to true
Does not work in combination with specifications to be checked Not recommended if orders are reviewed before work is started on them |
| showSpecificationsToBeChecked | A boolean to show or not show the active products |
| customTabTitle | The reference data record field to use as the tab header |
| customTabContents | The reference data record field to use for the body of the read-only tab |
| customTabSeqNo | The reference data record field that determines the sequence of the additional tabs |
| customTabRdtyUid | The reference data type used for the custom tabs |
In case no upload of attachments is required in the portal, the following configuration needs to be set:
orderAttachmentFormFields:- "" |
Where to Look Next
These references have further information on how to configure or use the package contents after the initial installation and integration.
- SLIMS Administration Manual:
- Access Control and Session Management > Access Rights > Users
- Miscellaneous > Plugins Module
- Miscellaneous > Fields > Custom Fields
