Core LIMS Training: Advanced Administration

Course Topics Creating Custom Applications Custom Naming Templates Conditional Formatting Rules User-Defined Equations Note: This training assumes that you have reviewed and understand Basic Administration Training Other Advanced Topics are separate slide decks: Triggers, CoreScripts, and Velocity Templates 8/8/2018 Confidential

What is an Application? An application is a limited set of related functionality a user might need to use to perform a given process or role An individual user can have one or more applications that they might need to use All applications are pointed at the same database but actions a user is allowed to perform on the data are different Core LIMS provides several applications off the shelf – users can toggle between any application that is available to them from the Application menu located in the upper right corner of every page Changing applications will automatically change the Application-Specific menus on the left side of the page LIMS administrators can also create their own custom applications 8/8/2018 Confidential

Finding Current Application Types 1) Navigate to the Main Admin Panel 2) Navigate to the Application Entity Type List 8/8/2018 Confidential

Finding Current Applications Select List All to see the current applications Core standard applications will have a ci_app_ prefix in the name; click on the hyperlink to see the record 8/8/2018 Confidential

Configuring Custom Applications LIMS Administrators can now create their own applications for users for greater control over what a user will specifically see Only expose required functionality Simplifies user navigation Another method to control user access Admins can configure: URL Icons Java menus Details page hyperlinks User access 8/8/2018 Confidential

Steps to Build a Custom Application Create a New Application Give Your Account Access To Application Create Main Menu and Menu Items (Add Super Types and Entity Types) Modify Sub-Menu Functions or Hyperlinks (optional) Provide Users Access to Application Migrate Application From Dev to Production System 8/8/2018 Confidential

Create a New Application Navigate to Main Admin Panel > Application > Core Application > New Enter the general metadata for the application Tip: The word “Application” will appear in the welcome message so you should avoid using “Application” in the display name 8/8/2018 Confidential

Application Home Page In a blank application there are no Application-specific menus yet Users without administrative privileges will only see the Welcome message; Currently you can not configure the content on this home page Will allow you to build the application content Will allow you to edit the metadata you just entered 8/8/2018 Confidential

Grant Your Account Access to the Application Use the User menu in the upper left corner to navigate to your Employee Details page Edit the record and add your application to make it available in your Application menu 8/8/2018 Confidential

Create Main Menus Navigate to your Application Home Page Select Edit Navigation hyperlink Select a Super Type that a user would need access to in the application and select the Edit button 8/8/2018 Confidential

Create Main Menu Items Any previously saved Entity Types will be displayed on the left Remove the number and leave a blank text box to delete the current menu item If there are no Entity Type menu items with numbers on either the left or the right, then the Super Type menu will be removed Available Entity Types that you can add as a menu item are on the right side Type in a number for any Entity Type you want to display as a menu item Menu items will be displayed in numerical order Click Submit to save changes 8/8/2018 Confidential

Order Main Menus After you have selected some Super Types and underlying Entity Types, the Super Types will be listed in the Existing Super Types section Edit the numbers on the right to select an order to display the main menus and select Reorder to save changes New menus will be created here To edit or remove Entity Types or Super Types use the Edit button Special Cases: Sample-lots will automatically be under Sample menus Report Formats (Entity under List Super Type) will get its own menu 8/8/2018 Confidential

Sub-Menu Functions Functions in the sub-menus are automatically inherited from previously set up applications However, administrators can reconfigure them: Navigate to the Main Admin panel > Select List All Entity Types on the desired Super Type> Select Navigation on the desired Entity Type > 8/8/2018 Confidential

Editing Sub-Menu Functions Just like menu item selections, current sub-menu functions are on the left and available ones are on the right Type a number next to any function you want to display Functions will be displayed in numerical order Leave text boxes blank to remove them Scroll to the very bottom Submit button to save changes Can copy these changes to other Entities of the same Super Type Changes will apply to ALL applications that use these Entity Types 8/8/2018 Confidential

Details Page Hyperlinks Similarly, the functions or reports that are hyperlinked of a record (Details Page) have already been configured with a default setting, but an administrator can edit those 8/8/2018 Confidential

Modifying Details Page Hyperlinks Navigate back to the Navigation hyperlink of the Entity you want to edit: Navigate to the Main Admin panel > Select List All Entity Types on the desired Super Type> Select Navigation on the desired Entity Type Scroll down to the Functions section Make changes exactly like the Sub-Menu Functions 8/8/2018 Confidential

Granting Many Employees Access (Load Entities) Use the Load Entities tool on Employee to batch update the new application to many users at the same time Separate multiple applications by commas Don’t forget to include their current applications or you will write over them 8/8/2018 Confidential

Granting Many Employees Access (List Functions) List All Employees and send desired users to Employee List Function page Don’t forget to include current application or you will write over them 8/8/2018 Confidential

Transferring an Application From Dev Applications can be transferred between systems using the Application Import/Export links There are 2 options to export an application on the application’s home page from the development system 8/8/2018 Confidential

Transferring an Application Into Prod In the main admin panel of the production system, select the Application Import hyperlink Click on apps hyperlink to get correct components displayed 8/8/2018 Confidential

Transferring an Application Into Prod cont. After the preview, select Force Load Recursive to import the application Scroll down to the bottom of the page Browse to the XML file you exported from Dev Use the Preview button first to verify what will be loaded Deselect any unwanted items 8/8/2018 Confidential

What is a Custom Naming Template? Way to provide a formula to automatically name a record without user input Creates a consistent naming convention Can make it easier to search for records 8/8/2018 Confidential

Templates are Defined in Admin Panel Go to Main Admin Panel > Edit Attributes of desired Entity > enter a formula in Name Template section Available attributes that could be used are listed below – copy and paste any desired attributes into formula 8/8/2018 Confidential

Formula Rules Available attributes in the list can be used as formula variables (copy and paste them to ensure exact spelling) Enclose variables within curly brackets and precede by a $ (Example: ${Attribute1}_${Attribute2}) Alphanumeric text that will be a constant value can be typed directly into the string without brackets (Example: Employee_${Attribute1}) User-provided input will overwrite formula value Formula must produce a unique name – if it creates a duplicate name already in the system then the name will default to the barcode 8/8/2018 Confidential

What is a Conditional Format? Just like in Excel, you can set specific attributes to be displayed as a colored cell if they meet criteria specified by administrators 8/8/2018 Confidential

Specifying Conditional Formatting 1) Navigate to the main admin panel > select desired Entity > select Conditional Formats 2) Enter desired conditions, values, and colors 3) Select Add Rules to save changes Current rules are listed at the bottom; Click Remove to delete them Can use a simple color name or hexadecimal code to choose color 8/8/2018 Confidential

What is a Rule? A rule is a way to limit values are allowed for an attribute or an associated attribute. It is enforced when records are created or updated. Example rules for an Entity Type Example system message when trying to update a record that does not have an allowed value – user must change value in order to save the record 8/8/2018 Confidential

Specifying a Rule 1) Navigate to the main admin panel > select desired Entity > select Rules 2) Choose whether rule is for an attribute or an attribute of an associated Entity Type 3) Enter Conditions/Values and select Add Rules 8/8/2018 Confidential

What is a User-Defined Equation? A user-defined equation can create an attribute by performing math operations on other attributes or fixed constants 2 Major Use Cases Admin stores an attribute calculated from other attributes End User adds column to Report Format that calculates new attribute on the fly Once created, a user equation can be a data type that is reused for other Entity Types 8/8/2018 Confidential

Specifying a User-Defined Equation Navigate to the main admin panel > select desired Entity > select Edit Attributes Give an Attribute name, select NEW USER EQUATION for Data Type, make sure Call Seq is last, check the Select checkbox and save changes 8/8/2018 Confidential

Entering an Equation Attributes and fixed constants can be used as variables Do not use brackets for variables Available Attributes to use are listed below Available Functions to use are listed below When you Update the record, the equation will be tested using the Test Values 8/8/2018 Confidential