LabCollector Lab Cross Search Software User Guide

LabCollector Lab Cross Search Software

Introduction

LabCollector’s Lab Cross Search application allows you to search for records in modules across different LabCollector instances. This can be useful for organizations that have multiple LabCollector instances and wish to enable searching between these instances. The Lab Cross Search application allows:

• simultaneous searches across LabCollector instances connected to t.
• searching any record in from either the default or custom modules.
• searching on instances hosted on same or different servers.
  The Lab Cross Search platform has a different view for administrators and end users. Both are explained in detailed in the next sections.

The link to Lab Cross Search user portal will be given by the Lab Cross Search administrator. It can be for example: https://xxxx.yyyy.com/LabCrossSearch/ In this case the link to the administration would be like:
https://xxxx.yyyy.com/LabCrossSearch/admin.php?page=home.php The Lab Cross Search user portal can be included in any other web portal.

Integrating Lab Cross Search into a website

To integrate cross-search into a website you need to insert the application in a web page (WordPress for example) by copying the code below in the HTML content of the page:

IMPORTANT: Replace [URL] in the above code by the URL of Lab Cross Search application (for example: https://mydomain.com/lab_cross_search).

Lab Cross Search Administration

• The administration menu gives access to the pages containing the settings of the Lab Cross Search application.
• The URL to the administration pages will be given by the super-administrator of the Lab Cross Search application.
• Enter your login credentials to access the admin menu.
  The initial login credentials will be provided by AgileBio or the manager of Lab Cross Search application

Once you enter the login details, you will access the following page:

1. The name of the user who has logged in.
2. If you are on the settings page, you can return to the homepage by clicking “Home” button.
3. Add or edit the settings for Lab Cross Search platform:
   •  Users section allows admin user to add other users who can access admin portal of Lab Cross Search.
   • Instances section allows the admin to add instances connected to Lab Cross Search
4. Logout using this button.
5. This button hides the left black admin settings panel.
6. The search bar where you can search a record information from all connected LabCollector instances.

“Settings - > Users” page

The Settings -> Users section displays the list of all users (admin) that are added to the Lab Cross Search platform and allows you to add new users with the following options: For now, all users are admin level.

1. This tab shows the list usernames and allows to find a specific user with the help of search bar.
2. Password (hidden) of each user.
3. This tab shows emails of all users and allows to find an email using the search bar.
4. This tab shows full name of the users and the tab to search amongst various users.
5. Clicking on the “Add” button will open a pop-up which will allow you to add users:
   • Add the username for the person who is going to access Lab Cross Search
   • Add the password
   • Add the email of the admin-user
   • Add the full name of the admin-user.
   • Save the admin-user details.
6. The search filter allows you search among various admin-users. You can search and filter using the username, e-mail, or full name.
7. Click on the red bin icon to delete the user.

Allowing Lab Cross Search in LabCollector instances

To allow Lab Cross Search to access data from modules of an instance, you have to create a token in the instance by following these steps:

• Connect to the LabCollector instance to connect to Lab Cross Search
• Go to Admin -> Setup -> Web Services API
•  Read our Knowledge Base on how to generate token for API connections.
• Carefully select the modules that will be accessible from Lab Cross Search
• Configure a new LabCollector instance in Lab Cross Search administration with this token (see “Settings -> Instances” ).

“Settings - > Instances” page

Clicking on the Instances menu link brings to a page where you can add instances that need to be connected to Lab Cross Search.

1. This tab shows the names of all connected instances and the possibility to find a specific instance using the search bar.
2. This tab shows the URL link of the instances and the possibility to find a specific instance link using the search bar.
3. API token to connect to the instance partly visible and search using the token.
4. API version used to connect to LabCollector instance.
5. When you click on “Add” you will see a pop-up to enter instance credentials:
   • Add the name of your LabCollector instance
   • Add your LabCollector instance link URL.
   • The token to connect to the LabCollector instance generated in the
   • LabCollector instance via -> Admin -> Setup ->Web Services API
   •  Select the API v2.
   •  Save information.
6. Search bar where you can filter or search using the various fields.
7.  For each instance defined the options are:
   • After defining an instance click on this icon to synchronize the database of modules of the add-on with the Lab Cross Search platform.
   • When the synchronization is done the list of modules and fields available to search in Lab Cross Search will be displayed. The names of the Default modules are on a blue bar, the names of Custom modules are on a green bar.
   • All the searchable fields from all the modules of the connected instances are visible in this list.
   • To make a module unsearchable in Lab Cross Search, turn OFF button.
   • In order for the fields searchable in a module of an instance (See Allowing Lab Cross Search in LabCollector instances) to be also searchable/unserchable in Lab Cross Search, the admin-user must activate ( ) or deactivate ( ) the field.
   •  To remove an instance click on the red bin icon.

Lab Cross Search User portal

• The Lab Cross Search user portal is dedicated to end users doing searches on LabCollector instances.
• The URL to the Lab Cross Search portal will be given by the administrator of Lab Cross Search.

Searches are performed by typing the text you want to search, and the following searching rules are applied:

• Search is only possible for plain text and not selective fields like checkbox or multiselect present in the target instance.
• The searched text can be included into another text (searching “TEXT” may return for example a record containing “theTEXToftheexample”)
• Search by adding various word (ex: “my search text”) will consider spaces between words of the search and will search the exact phrase.
• Extra space before and after your search text will not be considered.
• Searching two words (for example “test,text”) separated by a comma will search the first word OR the second word (test OR text) in the records.
• The combination of words and sentences separated by commas is possible.
• The search result will retrieve all the records containing your search classified by instance and module. A search results will for example look like:
• By clicking on the name of the owner a pop-up card will open with the information of the owner of the record
• To send an email to the owner of the record click on the email: automatically your email application will open with a prewritten text, which can be edited before sending an email.
• When your search returns more than 10 results in a module of an instance, page numbers will appear at the bottom of each module: a click on the number will display the 10 results of the corresponding page or the first/previous/next/last page of 10 results.
• The list of instances and modules can be displayed/hidden using the +/- buttons at the left of the name of instance or module.

Making a field searchable in a LabCollector instance

To make a field of a LabCollector instance to be searchable in Lab Cross Search:

• The field must be in a module accessible through the TOKEN used to connect the instance
• If the field is a Default field, it must be of Text type
• If the field is a Custom field, it must be “SEARCHABLE” and “ACTIVE”.
  Only modules can be connected for now and not add-ons.

Making a record NOT searchable in a LabCollector instance

To hide ONE record from being searchable in Lab Cross Search :

• Create a custom field of type Yes/No Select , exactly called “hide_from_cross_search” in the module of interest and activate it (Read how to create a custom field in module).
• In the module of interest, Edit the record to hide and select the option “Yes” to hide the record from the Lab Cross Search application.
• A record with an empty “hide_from_cross_search” or “hide_from_cross_search” defined as No will be searchable.
• Resynchronize the instance by clicking on in the corresponding instance page of Lab Cross Search admin (see “Settings -> Instances” section)

Version of document and contact

References

• AgileBio - Accueil
• AgileBio - Accueil
• All-in-One Lab Management & Notebook | LabCollector LIMS
• All-in-One Lab Management & Notebook | LabCollector LIMS
• How do you create a custom field? - LabCollector
• How to generate a token to link to API services? - LabCollector

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>