enviromap documentation - read the docs€¦ · enviromap documentation, release 0.1 note: the...

EnviroMap DocumentationRelease 0.1

ZJ Palasz

Dec 12, 2018

Contents

1 Topics 31.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Requirements & Download Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.3 Getting Started - Analyst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.4 Getting Started - Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261.5 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641.6 Tutorials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651.7 Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

i

EnviroMap Documentation, Release 0.1

Note: The following is a work in progress.

To help you understand EnviroMap and how it works, the following documents are being provided. Feel free to sendany questions to [email protected].

Contents 1

mailto:[email protected]


2 Contents

CHAPTER 1

Topics

1.1 Overview

EnviroMap is a web based sample management application. It is designed to help with everything from scheduling toreporting, while integrating seemlessly with any LIMS system that your company may use. Feel free to browse thesupport documentation to learn more about EnviroMap. If you have any questions or would like to schedule a demoplease contact [email protected].

1.1.1 Key Features

• Automatic Scheduling

• Label & Barcode Printing

• Form Generation

• Customizable Dashboard

• Result Mapping, Charting and Reporting

• Scheduled Reporting

• LIMS Integration

• Site Mapping

• Custom Fields & Workflows

• Out of Limit Alerts

• Mitigation / Reswab Tracking

• Historical Result Importing

Check out the Features page to see more of what EnviroMap can do.

3



1.2 Requirements & Download Links

The following contains the requirements for the various applications that make up EnviroMap. If you have any ques-tions please contact [email protected].

In this article:

• EnviroMap Application Requirements

• Printer Requirements

• EnviroMap Cloud Printer Application Requirements

• EnviroMap Local Printer Application Requirements

• Calibration Instructions

• Printer Firmware Update Instructions

• Troubleshooting

1.2.1 EnviroMap Application Requirements

1. Microsoft Internet Explorer 11, Google Chrome, or Mozilla Firefox

1.2.2 Printer Requirements

1. EnviroMap Cloud Printer Application or EnviroMap Local Printer Application installed

2. ZPL compatible printer attached to local computer via USB or by Ethernet to the LAN

1.2.3 EnviroMap Cloud Printer Application Requirements

1. Server with at least Microsoft Windows Server 2008 R2 installed or PC with at least Microsoft Windows 7installed (Windows 8.x and 10 work as well)

2. Microsoft .NET Framework 4.5 or greater installed

3. Local or domain Administrator account with password that will not change

4. TCP Port 2011 open for communication with our cloud server’s static IP (Provided upon request - [email protected])

5. EnviroMap Cloud Printer Application Installation Walkthrough downloaded (http://print.managementsolutionsofva.com/downloads/HowtoInstallEnviroMapCloudPrinterApplication.pdf)

6. Zebra Setup Utilities downloaded and installed (http://print.managementsolutionsofva.com/downloads/zsu-1191204.exe)

7. EnviroMap Cloud Printer Application downloaded and installed (http://print.managementsolutionsofva.com/Downloads/enviromapcloudprinter.zip)

8. If remote support is necessary, TeamViewer 10 Host downloaded and installed (http://get.teamviewer.com/enviromap) or TeamViewer 10 QuickSupport downloaded and running (http://download.teamviewer.com/download/version_10x/TeamViewerQS.exe). The 9-digit TeamViewer ID and password must also be providedto [email protected]

4 Chapter 1. Topics




http://print.managementsolutionsofva.com/downloads/HowtoInstallEnviroMapCloudPrinterApplication.pdf

http://print.managementsolutionsofva.com/downloads/HowtoInstallEnviroMapCloudPrinterApplication.pdf

http://print.managementsolutionsofva.com/downloads/zsu-1191204.exe


http://print.managementsolutionsofva.com/Downloads/enviromapcloudprinter.zip

http://print.managementsolutionsofva.com/Downloads/enviromapcloudprinter.zip

http://get.teamviewer.com/enviromap


http://download.teamviewer.com/download/version_10x/TeamViewerQS.exe




1.2.4 EnviroMap Local Printer Application Requirements

Attention: EnviroMap Local Printer Application must be installed for each user on each PC that will need to print

1. Server with at least Microsoft Windows Server 2008 R2 installed or PC with at least Microsoft Windows 7installed (Windows 8.x and 10 work as well)

2. EnviroMap Local Printer Application Installation Walkthrough downloaded (http://print.managementsolutionsofva.com/downloads/HowtoInstallEnviroMapLocalPrintClientUSB.pdf)

3. Zebra Setup Utilities downloaded and installed (http://print.managementsolutionsofva.com/downloads/zsu-1191204.exe)

4. Choose either A or B below depending on the model of your Zebra printer

A. Zebra GX420d - EnviroMap Local Printer Application* downloaded and installed (http://print.managementsolutionsofva.com/downloads/zebraprinter.zip)

B. Zebra ZD410 - EnviroMap Local Printer Application* downloaded and installed (http://print.managementsolutionsofva.com/downloads/zebraprinternew.zip)

5. If remote support is necessary, TeamViewer 10 Host downloaded and installed (http://get.teamviewer.com/enviromap) or TeamViewer 10 QuickSupport downloaded and running (http://download.teamviewer.com/download/version_10x/TeamViewerQS.exe). The 9-digit TeamViewer ID and password must also be providedto [email protected]

*Utilizes Zebra Test Form Application (©2016 ZIH Corp)

1.2.5 Calibration Instructions

1. If you are using the EnviroMap Cloud Printer Application, calibration should be performed by contacting [email protected]. Please include your name, location, and printer that you would like to be calibrated.

2. If you are using the EnviroMap Local Printer Application, download and unzip the calibration label, double-click the label, and a calibration label will print. (http://print.managementsolutionsofva.com/downloads/CalibrationLabel.zip)

1.2.6 Printer Firmware Update Instructions

1. Verify the model of your Zebra printer and download the latest firmware version below:

A. Zebra GX420d: http://print.managementsolutionsofva.com/downloads/v56-17-17z.exe

B. Zebra ZD410: http://print.managementsolutionsofva.com/downloads/v77-20-01z.exe

2. Follow the detailed instructions for your printer:

A. Zebra GX420d: http://print.managementsolutionsofva.com/downloads/HowtoUpdateZebraGX420dFirmware.pdf

B. Zebra ZD410: http://print.managementsolutionsofva.com/downloads/HowtoUpdateZebraZD410Firmware.pdf

1.2. Requirements & Download Links 5

http://print.managementsolutionsofva.com/downloads/HowtoInstallEnviroMapLocalPrintClientUSB.pdf

http://print.managementsolutionsofva.com/downloads/HowtoInstallEnviroMapLocalPrintClientUSB.pdf



http://print.managementsolutionsofva.com/downloads/zebraprinter.zip

http://print.managementsolutionsofva.com/downloads/zebraprinter.zip

http://print.managementsolutionsofva.com/downloads/zebraprinternew.zip

http://print.managementsolutionsofva.com/downloads/zebraprinternew.zip








http://print.managementsolutionsofva.com/downloads/CalibrationLabel.zip

http://print.managementsolutionsofva.com/downloads/CalibrationLabel.zip

http://print.managementsolutionsofva.com/downloads/v56-17-17z.exe

http://print.managementsolutionsofva.com/downloads/v77-20-01z.exe

http://print.managementsolutionsofva.com/downloads/HowtoUpdateZebraGX420dFirmware.pdf

http://print.managementsolutionsofva.com/downloads/HowtoUpdateZebraGX420dFirmware.pdf

http://print.managementsolutionsofva.com/downloads/HowtoUpdateZebraZD410Firmware.pdf

http://print.managementsolutionsofva.com/downloads/HowtoUpdateZebraZD410Firmware.pdf


1.2.7 Troubleshooting

• If the client is connected and the printer information seems correct, but cloud printing is still not working, makesure the cloud application is only running on one computer. A new client/key can be created if issues persist.

1.3 Getting Started - Analyst

The following steps will walk you through getting started using EnviroMap as an Analyst. For more information aboutwhat you can do in EnviroMap, check out the Features and Tutorials sections.

1.3.1 Log In

Logging in is required to access any of EnviroMap’s features. The first time you log in you will be required to agree tothe Terms of Use and reset your password. Every subsequent login will simply direct you to your personal Dashboardpage. Please see Setup Dashboard for more information on how to configure your dashboard.

In this article:

• Logging In

• Agreeing to the Terms of Use

• Resetting your Password

Logging In

Open your browser and navigate to your company’s EnviroMap website.

Enter your Login and Password.

Note: Your user name and password will be provided to you by your company.

6 Chapter 1. Topics


Tip: If you forget your password, any user with an Administrator account should be able to reset it for you. Alterna-tively, you can contact [email protected] to assist you.

Click the Sign In button.

Agreeing to the Terms of Use

Read the Terms of Use, then click the Accept button to continue.

1.3. Getting Started - Analyst 7



Resetting your Password

Enter the following fields:

Old Password: Enter the password you just logged in with.

New Password: Enter what you want your new password to be.

Confirm Password: Re-enter what you want your new password to be (this must be the same as what you entered forNew Password above).

Note: Depending on your company’s policies, there may be password requirements that you must meet. If yournew password does not meet these policies you will see an error message that will provide you with the miniumumrequirements for your new password.

8 Chapter 1. Topics


Click the Change Password button.

1.3.2 Setup Dashboard

Dashboards consist of widgets that are selected and customized by each user. The following articles describe how tosetup your dashboard for initial use, for a more in depth look at using and customizing your dashboard, see Dashboard.

In this article:

• Adding a Calendar Widget

• Customizing Dashboard Layout

• Adding Dashboard Pages



Adding a Calendar Widget

If your dashboard is empty, click on either of the Click to Add Widget boxes.

Attention: Screenshot Placeholder: Empty Dashboard

If your dashboard already has widgets, scroll to the bottom of the page, then click on the Click to Add Widget box.

In the pop-up dialog, fill in the following fields:

Type: Calendar

Title: Calendar

Height: Medium

Color By: Status

Business Units: Inherit

Sampling Programs: Inherit

Statuses: Leave all statuses unselected

Attention: Screenshot Placeholder: Filled out Calendar Widget

Click the Create button.

Attention: Screenshot Placeholder: Calendar visible on page

Customizing Dashboard Layout

Click the page layout button in the top right of the dashboard page.

10 Chapter 1. Topics


Choose a layout from the dropdown menu.

Each layout specifies the number columns and the width of each column, for example:

- - - - Represents a four column dashboard, with each of equal width

Attention: Screenshot Placeholder: 4 column layout

- – - Represets a three column dashboard, with the middle column twice as large as the left and right columns


– – Represents a two column dashboard, both of equal width




Adding Dashboard Pages

Click the Add Page button in the top right of the dashboard.

Click on the Click to Customize text in the top left of the new dashboard page.

Enter in a title for this new dashboard page, when finished, press the enter key or click anywhere on the dashboard tosave the new title.



To navigate your various dashboard pages, use the Previous and Next buttons.

You can now customize each page to display the widgets and information most relevant to you. To further customizeeach page, see Dashboard Page Filters.

1.3.3 View & Print Samples

Viewing Samples within a Collection is performed within the calendar widget from your dashboard. If you haven’talready setup your dashboard please see Setup Dashboard.

In this Article

• Viewing Samples within a Collection

• Adding or Editing Samples for a Collection

• Printing Samples for a Collection

Viewing Samples within a Collection

Right click on the collection that you would like to View Samples for. From the context menu, select View Samples.



Note: If this is the first time this collection has been opened, you will first need to confirm the samples. Click the SaveChanges button on the Select Samples popup to continue, or proceed to Adding or Editing Samples for a Collectionto make any changes.

A window will popup, showing all of the samples defined for this collection. You can view their placement on thebuilding map by selecting the Show Maps button on the lower right, and can revert back to the sample list view byselecting the button once more, which will now be labeled Show Samples

Adding or Editing Samples for a Collection



Note: If this collection does not have samples defined from the collection wizard, you will have to add any samplesyou wish to include by using the Add Samples dropdown in the top-right hand corner of the popup window.

If there are any changes you would like to make to the samples listed, you may click the sideways arrow or the pencilicon to the left of the sample you wish to edit. If you want to delete a particular sample, you may click the red X tothe right of the sample you wish to remove.

Note: any changes made through this process will not affect any other collections. If you wish to make a change tohow a collection’s samples are chosen, contact your administrator.

Printing Samples for a Collection

When Viewing samples for a particular collection, you have the option to print off the samples. You can select thePrint button in the lower right of the popup window, or the Print w/Maps button to include an image of the samples’placement within the building along with your samples. Both methods of printing will bring up a separate browserwindow or tab. Most browsers will attempt to walk you through printing on the default printer for the computer youare using. If you have trouble using your browser’s print dialog, please contact your administrator.

1.3.4 Printing Labels

Label printing is performed within the calendar widget from your dashboard. If you haven’t already setup yourdashboard please see Setup Dashboard.

In this article:

• Printing Labels to a Remote Printer

• Printing Labels to a Local Printer

• Printing Labels from Multiple Collections

• Printing All Labels

Printing Labels to a Remote Printer

Right click on the collection that has the samples you would like to print. From the context menu, select PrintBarcodes.



Note: If this is the first time this collection has been opened, you will first need to confirm the samples. Click theSave Changes button on the Select Samples popup to continue. See View & Print Samples for more information.

Selecting Samples and Remote Printer

In the popup window check the samples you would like to print.



From the Print Per dropdown, select if you would like to print per Sample or Test.

From the Printer dropdown, select the printer you would like to print to.

Note: Your printer will be setup during the initial EnviroMap install, if you don’t see your printer listed you cancontact [email protected].




Click the Save button.



Tip: Do you want to see something different on your label? Your labels can be customized by an administrator.Please contact your administrator or [email protected] if you need help setting this up.

Printing Labels to a Local Printer

Right click on the collection that has the samples you would like to print. From the context menu, select PrintBarcodes.





Selecting Samples and Local Printer

In the popup window check the samples you would like to print.



From the Print Per dropdown, select if you would like to print per Sample or Test.

From the Printer dropdown, select Save to File.



Click the Save button.



After the file download completes, double click the file to send the labels to your local printer.

Tip: Do you want to see something different on your label? Your labels can be customized by an administrator.Please contact your administrator or [email protected] if you need help setting this up.

Printing Labels from Multiple Collections

Attention: This method only works for collections that already have confirmed samples. If you haven’t alreadyconfirmed the samples via the Select Samples popup, then this method will not work for you.

Begin by left clicking on two or more collections that contain samples you want to print.

Tip: Having trouble selecting a collection? When selecting the collection, try clicking on the collection’s text andkeeping your mouse still.




Attention: Screenshot Placeholder: Show multiple selected collections

When ready to print, right click on one of the selected collections and from the context menu select Print All Barcodes.

Attention: Depending on the size of your labels, your printer may not have enough memory to print them all atonce. If you notice all your labels are not printing, try printing them one collection at a time using either PrintingLabels to a Remote Printer or Printing Labels to a Local Printer.

Attention: Screenshot Placeholder: Show print all barcodes in context menu

Follow one of the following to finish printing your labels:

• Selecting Samples and Remote Printer

• Selecting Samples and Local Printer

Printing All Labels

Attention: This method only works for collections that already have confirmed samples. If you haven’t alreadyconfirmed the samples via the Select Samples popup, then this method will not work for you.

Right click on a day with mutiple collections. From the context menu, select Print All Barcodes.

Attention: Depending on the size of your labels, your printer may not have enough memory to print them all atonce. If you notice all your labels are not printing, try printing them one collection at a time using either PrintingLabels to a Remote Printer or Printing Labels to a Local Printer.

Attention: Screenshot Placeholder: Show print all barcodes in context menu

Follow one of the following to finish printing your labels:

• Selecting Samples and Remote Printer

• Selecting Samples and Local Printer

1.3.5 Submit Collection

Submitting samples for a Collection is performed within the Calendar widget from your dashboard. If you haven’talready setup your dashboard please see Setup Dashboard.

Submitting Samples for a Collection

Right click on the collection that you would like to submit. From the context menu, select Other Actions, and thenselect Submit.




In the popup window, fill in the data for the samples in the collection. The copy down features is enabled by default,it will copy any data entered down to all the fields below it.

Once all data has been entered, click the Submit button. If you will need to return and enter some data later, select theSave Changes button.

Note: If your samples are being electronically submitted to a LIMS system, this process may take some time. Please



wait until the the popup window closes to confirm that your samples were successfully submitted.

1.4 Getting Started - Administrator

1.4.1 Create a Business Unit

Select the Administration dropdown from the navigation bar at the top, then select the Business Units item from thelist. Alternatively, if you are already in one of the Administration pages, you can navigate to the Business Units fromthe list on the left.

Click or tap the + Create button to the top-right of the Business Units list.

Fill in the name of the new Business Unit, choose their time zone, and select a new color from the color picker

When finished, click or tap the Save Changes button at the top-right.



1.4.2 Create a Risk Level

Select the Administration dropdown from the navigation bar at the top, then select the Risk Levels item from the list.Alternatively, if you are already in one of the Administration pages, you can navigate to the Risk Levels from the liston the left.

Click or tap the + Create button to the top-right of the Risk Levels list.

Fill in the name of the new Risk Level and select a new color from the color picker


1.4.3 Create a Sample Type

Select the Administration dropdown from the navigation bar at the top, then select the Sample Types item from thelist. Alternatively, if you are already in one of the Administration pages, you can navigate to the Sample Types fromthe list on the left.

1.4. Getting Started - Administrator 27


Click or tap the + Create button to the top-right of the Sample Types list.

Fill in the name of the new Sample Type


1.4.4 Create a Test

Select the Administration dropdown from the navigation bar at the top, then select the Tests item from the list.Alternatively, if you are already in one of the Administration pages, you can navigate to the Tests from the list on theleft.



Click or tap the + Create button to the top-right of the Tests list.

Fill in the name of the new Test, any possible values, and check the Numeric Result box if the test can handle numbersas input.


1.4.5 Add Users

Select the Administration dropdown from the navigation bar at the top, then select the Users item from the list.Alternatively, if you are already in one of the Administration pages, you can navigate to the Users from the list on theleft.



Click or tap the + Create button to the top-right of the Users list.

Fill in the name of the new User, their first and last name, and their email to be used for any notifications. Then selecttheir permission level, and which business units they may access. You will not be able to select any business units thatyou do not have access to, or a permission level for the new user that is higher than your own. The types of permissionsare outlined here: User Permissions.


1.4.6 Create a Barcode

Select the Administration dropdown from the navigation bar at the top, then select the Barcodes item from the list.Alternatively, if you are already in one of the Administration pages, you can navigate to the Barcodes from the list onthe left.



Click or tap the + Create button to the top-right of the Barcodes list.

Select what object the Barcode will be used for, and a description the Barcode will be known by. You may also selectwhat Business Unit, Sample Type, and Test the Barcode will be used for. The Test option will only appear if Test isselected for Barcode Type. Place the relevant ZPL code in the Code text box.




1.4.7 Add Groups

Detailing the addition of Groups to the Sites and Groups tree.

In this Article

• Navigating to and through the Sites and Groups

• Selecting the Parent Group for the new Groups to be added

• Using the Create Groups dialog

Navigating to and through the Sites and Groups

Select the Sites dropdown from the navigation bar at the top, then select the Sites and Groups item from the list.Navigate through the Sites and Groups Tree by selecting any Group with a folder icon to view all Sites and Groupscontained within that Group.

Selecting the Parent Group for the new Groups to be added

To add a group, you will select the group you wish to add the new group to, then select the menu icon at the top of theSites and Groups tree.

Note: You may also access the group menu by right-clicking on the parent group.

Select the Add Groups item from the menu dropdown which will open the Create Groups dialog.

Using the Create Groups dialog

Enter the name(s) of the Group(s) you wish to add to the parent group, and then click or tap Save Changes to finalizethese groups. You may also click or tap Cancel to stop adding new groups.



The new groups should appear in the parent group that was selected earlier.

1.4.8 Add a Map

Detailing the addition of a Map to the Sites and Groups tree.

In this Article

• Navigating to and through the Sites and Groups Page

• Placing the new Map in the correct group

• Using the Upload Map dialog

Navigating to and through the Sites and Groups Page

Select the Sites dropdown from the navigation bar at the top, then select the Sites and Groups item from the list.Navigate through the Sites and Groups Tree by selecting any Group with a folder icon to view all Sites and Groupscontained within that Group. Ensure the Group to which you wish to upload a map is showing on the screen.



Placing the new Map in the correct group

To add a Map, select the image file on your local machine, and then drag the file to the group you wish that image tobe a map for.

Note: If the Group already has a map associated with it, this new map will replace the old one.

Releasing the file while it is over the group will open the Upload Map dialog.

Using the Upload Map dialog

Enter the name the map should be known by.

After all relevant Information has been added, click or tap Save Changes to upload this map. You may also click ortap Cancel to stop uploading this map.

The new map should appear in the right side of the screen, and the parent group associated with this map should nowhave a globe icon to the right of its name in the Sites and Groups tree.

1.4.9 Add Sites

Detailing the addition of Sites to the Sites and Groups tree.



In this Article

• Navigating to and through the Sites and Groups

• Selecting the Parent Group to which the new Sites will be added

• Using the Create Sites dialog

Navigating to and through the Sites and Groups

Select the Sites dropdown from the navigation bar at the top, then select the Sites and Groups item from the list.Navigate through the Sites and Groups Tree by selecting any Group with a folder icon to view all Sites and Groupscontained within that Group.

Selecting the Parent Group to which the new Sites will be added

To add a site, you will select the group you wish to add the new site to, then select the menu icon at the top of the Sitesand Sites tree.

Note: You may also access the group menu by right-clicking on the parent group.

Select the Add Site(s) item from the menu dropdown which will open the Create Sites dialog.

Using the Create Sites dialog

Enter the name(s) of the Site(s) you wish to add to the parent group, as well as the risk level, and any additionalproperties for these sites.

Note: If you wish to add multiple Sites, separate individual names for Sites by placing them on a new line with thereturn or enter key.



After all relevant Information has been added, click or tap Save Changes to finalize these sites. You may also click ortap Cancel to stop adding new sites.

The new sites should appear in the parent group that was selected earlier.

1.4.10 Create a Sampling Plan

This will detail how to set up a Sampling Plan. Sampling Plans are used to organize and manage the Collectionsgenerated by EnviroMap



Click the Sampling drop down menu at the top of the screen, and then click on the Sampling Plans item from the list.

Once on the Sampling Plans page, click the + Create button at the top right of the page, which will bring up the CreateSampling Plan pop-up

Fill in the information required for the Sampling Plan, then click the Save Changes button



Description: This is what the Sampling Plan will be known by. It is best to have this be something that will help toindicate what collections are used in this Sampling Plan.

Abbreviated Description: This is what will be used to identify the Sampling Plan when there is not enough space toshow the full Description for the Sampling Plan.

Business Unit: This is what Business Unit the Sampling Plan will live under. The Sampling Plan may also be a“Global” Sampling Plan, which would mean it is accessible to all business units.

1.4.11 Create a Collection

Detailing the steps to create a Collection

In this Article

• Navigating to the Create new Collection Wizard

• Filling in basic information and Sample Selection

• Adding Samples

• Adding Rules

• Managing Statuses

• Managing Actions



• Managing Views

• Adding Filters

Navigating to the Create new Collection Wizard

Select the Samples dropdown from the Navigation bar at the top of the page, and then the Collection item from thedropdown menu that appears.

Select the + Create button at the top right of the Collections page to open the Create new Collection wizard.

Filling in basic information and Sample Selection

Fill out all fields for the Collection

Description: This is what the Collection will be known by.

Business Unit: This is what Business Unit the Collection will operate within.

Sampling Plan: This is which sampling plan the Collection is associated with. If there are no Sampling Plans set up,please refer to Create a Sampling Plan.

Sample Selection Type: This may be Default, which will let the system decide how samples are generated, givenparameters in a later step, or Predefined Samples, which allows for a set groupd of samples to be generated eachtime.

When all fields are filled out, select the Save Changes button to move on to selecting how samples are chosen for thisCollection



Choose how samples will be chosen for this collection, and any necessary fields for that particular choice.

Select the Save and Continue button when finished detailing sample sources

Adding Samples

To add a Sample to this Collection, select the + Add Sample button



Fill out the fields required for making a new sample



Sample Index Type: This is how the samples will be indexed. Default will allow the system to number and order thesamples for you.

Description: This is how the Samples will be identified. This can be defaulted to allow the system to build a descrip-tion from the site description.

System Type: This will either set the samples to be individual sites, a composite site, or sampled from unmonitoredsites.

Sample Type: This is the Sample Type for these samples, if there are no sample types, please refer to Create a SampleType.

Tests: These are what tests will be run on these samples

Select the Add button to close this pop-up and add this rotation to the Collection

To add filters to any sample, please refer to Adding Filters

Select the Save and Continue button when finished adding Collection rotations



Adding Rules

To add a Rule to this Collection, select the + Add Rule button, this will bring up the Add Rule pop-up

Select a number of samples that must adhere to this rule from the list.

Number of Samples: This is the smallest number of samples that must adhere to this rule.

Select the Add button to close this pop-up and add this Rule to the Collection

Select what enforcement strategy these rules must follow from the drop down selection box.



To add filters to any rule, please refer to Adding Filters

Select the Save and Continue button when finished adding Collection Rules

Managing Statuses

All collections are created with the Collection Status Definitions created for that location, as seen in the AdministrationCollection Status Definition page. If more statuses are needed, please create them at that page.

Select the Continue button when finished managing Collection Statuses

Managing Actions

Two collection Actions, Start Sampling and Submit, are already supplied for all Collections, which will move thecollection from Scheduled to Sampling and from Sampling to Sampled, respectively.

To manage the Collection Action Fields, which are fields collected when this action is started, please refer to

Select the Continue button when finished managing Collection Actions.

Managing Views

Views allow for alternate displays of data when viewing a collection. To add a view

To manage the Collection Action Fields, which are fields collected when this action is started, please refer to

Select the Save and Complete button when finished managing Collection Views, This will save all work done for theCollection

Adding Filters

To add a Filter to a sample or rule, select the dropdown arrow to the left of the object that needs to have a Filter appliedto view the list of Filters for that object

Select the + Add Filter button, which will bring up the Create Filter pop-up.

Select the Filter Type, and what qualifiers will be used to help build the sample.



Type: This is the field that will be evaluated to check when building a given sample.

Filter Description: This is a way to refer to the specific filter. It can be defaulted to display what the field is beingevaluated for.

Operation: This is the operation that the value of the field will be checked with. This field will only appear for someselections of Filter Type

Value: This is the value that the value of the field will be checked against, in conjunction with the Operation field.This field will only appear for some selections of Filter Type

Group: These are the groups that will be used as a Filter when building a given sample. This field will only appear ifthe Filter Type is set to Group.

Site(s): These are the sites that will be used as a Filter when building a given sample. This field will only appear ifthe Filter Type is set to Site.

Risk Level: These are the Risk Levels that will be used as a Filter when building a given sample. This field will onlyappear if the Filter Type is set to Risk Level.



Virtual Group: This is the Virtual Group that will be used as a Filter when building a given sample. This field willonly appear if the Filter Type is set to Virtual Group.

Property: This is the Property that will be used as a Filter when building a given sample. This field will only appearif the Filter Type is set to Property.

Property Name: This is the name of the property that will be used as a Filter when building a given sample. Thisfield will only appear if the Filter Type is set to Generic.

Select the Add Button to close this pop-up and add this Filter to the sample or rule.

1.4.12 Create a Sampling Program

Detailing the steps to create a Sampling Program

In this Article

• Navigating to the Create new Sampling Program Wizard

• Filling in basic information and choosing instances

• Adding Rotations

• Adding Sampling Plans

• Adding Test Limits

• Adding Events

• Adding Rotation Sources

• Adding Test Limit Filters

• Adding Event Jobs

Navigating to the Create new Sampling Program Wizard

Select the Samples dropdown from the Navigation bar at the top of the page, and then the Sampling Program itemfrom the dropdown menu that appears.

Select the + Create button at the top right of the Sampling Programs page to open the Create new Sampling Programwizard.

Filling in basic information and choosing instances

Fill out all fields for the Sampling Program



Description: This is what the Sampling Program will be known by. It is best to have this be something that will helpto indicate what collections are used in this Sampling Program.

Abbreviated Description: This is what will be used to identify the Sampling Program when there is not enough spaceto show the full Description for the Sampling Program.

Business Unit: This is what Business Unit the Sampling Program will live under. The Sampling Program may alsobe a “Global” Sampling Program, which would mean it is accessible to all business units.

Start Date: This is what date this Sampling program will go into effect.

When all fields are filled out, select the Save Changes button to move on to creating instances of this SamplingProgram

Choose a Business Unit that this Sampling Program should have an instance for, and then select the + Add Instancebutton to add that instance to the Sampling Program



Select the Continue button when finished adding Sampling Program instances

Adding Rotations

To add a rotation to this Sampling Program, select the + Add Rotation button

Fill out the fields required for making a new sampling Rotation



Description: This is what the Rotation will be known by.

Sampling Program Instance: This is what Sampling Program Instance the Rotation will be associated with.

Interval: This is how long this Rotation will last for. This field couples with the Frequency field and should beunderstood together(i.e. 1 week)

Frequency: This is the unit of time that the Interval field is applied to in order to dictate how long this Rotation willlast for. This field couples with the Interval field and should be understood together(i.e. 1 week)

Start Date: This is what date this Rotation will go into effect.

Select the Add button to close this pop-up and add this rotation to the Sampling Program



To add rotation sources to any rotation, please refer to Adding Rotation Sources

Select the Continue button when finished adding Sampling Program rotations

Adding Sampling Plans

To add a Sampling Plan to this Sampling Program, select the + Add Sampling Plan button, this will bring up the AddSampling Plan pop-up

Select a Sampling Plan from the list, and what type of collection schedule should be used with this Sampling Planwithin this Sampling Program. If you have not already made a Sampling Plan, please refer to Create a Sampling Plan.



Sampling Plan: This is a Sampling Plan that this Sampling Program will utilize.

Type: This is the scheduling type of the Sampling Plan. Values include On Demand; which will only happen whenspecially ordered, Once; which will only occur the once on the chosen date and time, Recurring; which willrequire a recurrence pattern to be set up that will dictate how often this sampling plan is implemented, andMitigation; which will only occur on set triggers such as out of limit test results.

Select the Add button to close this pop-up and add this Sampling Plan to the Sampling Program

Select the Continue button when finished adding Sampling Program Sampling Plans

Adding Test Limits

To add a Test Limit to this Sampling Program, select the + Add Test Limit button, this will bring up the Add TestLimit pop-up



Select a Business Unit, and a Test from the list, and what color any results that violate this limit will be shaded. If youhave not already made a Test, please refer to Create a Test.



Description: This is what the Test Limit will be known by.

Business Unit: This is what Business Unit the Test Limit will apply to. All is an option that would apply this testlimit to all Business Units that this Sampling Plan has instances for.

Test: This is the Test that this Limit wil check for the filters that are applied to it.

Color: This is the color that any out-of-limit results will be shaded when viewed on the results map or any charts.

Select the Add button to close this pop-up and add this Test Limit to the Sampling Program

To add any filters for a test limit, please refer to Adding Test Limit Filters

Select the Continue button when finished adding Sampling Program Test Limits

Adding Events

To add an Event to this Sampling Program, select the + Add Event button, this will bring up the Create Event pop-up



Select which Test Limits this Event will trigger on, which Business Unit this event will occur within, as well as thestipulations for starting and ending this event.



Description: This is what the Event will be known by.

Test Limit: These are the Test Limits that this Event wil trigger from.

Business Unit: This is what Business Unit the Event will apply to.

Start Range: This is the window of time that will start the Event if the Minimum Number to Start number of out-of-



limit results are hit within the window.

Minimum Number To Start: This is the amount of out-of-limit results that must be reported in order to start thisevent.

Stop Range: This is the amount of time that the Event will stop after.

Select the Add button to close this pop-up and add this Event to the Sampling Program

To add specific jobs to be executed with an event, please refer to Adding Event Jobs

Select the Save and Complete button when finished adding Sampling Program Events, This will save all work donefor the Sampling Program

Adding Rotation Sources

To add a source to a rotation, select the dropdown arrow to the left of the Rotation that needs to have a source appliedto view the list of sources for that rotation

Select the + Add Source button, which will bring up the Create Rotation Source pop-up.



Select the Source Type, which source of that type, and what percentage or multiplier of that source will be used forthis rotation.



Source Type: This can be another Rotation, a Group, or a Virtual Group. If there have not been any groups set up,please refer to Add Groups.

Rotation: This is a separate Rotation that will be used as a source for this current Rotation. This field will only appearif the Source Type is set to Rotation.

Rotation Percentage: This is the percentage of the source Rotation that will be used to supply the current rotation.This field will only appear if the Source Type is set to Rotation.

Group: This is the group that will be used as a source for this current Rotation. This field will only appear if theSource Type is set to Group.

Group Multiplier: This is the amount that the sites in this group will be multiplied by when populating the rotation.This field will only appear if the Source Type is set to Group.

Virtual Group: This is the virtual group that will be used as a source for this current Rotation. This field will onlyappear if the Source Type is set to Virtual Group.



Virtual Group Multiplier: This is the amount that the sites in this virtual group will be multiplied by when populat-ing the rotation. This field will only appear if the Source Type is set to Virtual Group.

Select the Add Button to close this pop-up and add this source to the rotation.

Adding Test Limit Filters

To add a Filter to a Test Limit, select the dropdown arrow to the left of the Test Limit that needs to have a Filter appliedto view the list of Filters for that Test Limit

Select the + Add Filter button, which will bring up the Create Filter pop-up.

Select the Filter Type, and what qualifiers will be checked on that type for this Test Limit.



Type: This is the field that will be evaluated to check for a given sample to determine if it is violating the Test Limit.

Filter Description: This is a way to refer to the specific filter. It can be defaulted to display what the field is beingevaluated for.

Operation: This is the operation that the value of the field will be checked with. This field will only appear for someselections of Filter Type

Value: This is the value that the value of the field will be checked against, in conjunction with the Operation field.This field will only appear for some selections of Filter Type

Group: These are the groups that will be used as a Filter for this current Test Limit. This field will only appear if theFilter Type is set to Group.

Site(s): These are the sites that will be used as a Filter for this current Test Limit. This field will only appear if theFilter Type is set to Site.

Risk Level: These are the Risk Levels that will be used as a Filter for this current Test Limit. This field will onlyappear if the Filter Type is set to Risk Level.

Sample Types: These are the Sample Types that will be used as a Filter for this current Test Limit. This field will



only appear if the Filter Type is set to Sample Type.

Property: This is the Property that will be used as a Filter for this current Test Limit. This field will only appear ifthe Filter Type is set to Property.

Property Name: This is the name of the property that will be used as a Filter for this current Test Limit. This fieldwill only appear if the Filter Type is set to Generic.

Select the Add Button to close this pop-up and add this Filter to the Test Limit.

Adding Event Jobs

To add a Job to a Event, select the dropdown arrow to the left of the Event that needs to have a Job applied to view thelist of Jobs for that Event

Select the + Add Event Job button, which will bring up the Create Event Job pop-up.



Select the Job Type, and what additional information is needed for that particular event job type.



Type: This is the Type of Event Job that wil be executed when the event occurs.

Trigger Type: This will trigger the job either every time the event is triggered, once per sample, or once per numberof set iterations.



Iterations: This is the number of iterations that the job will be triggered.

Select the Add Button to close this pop-up and add this Job to the Event.

1.5 Features

List of features



1.5.1 Dashboard

Dashboard Page Filters

1.5.2 Sampling

Samples

Sampling Plans

Collections

Sampling Programs

Sample Allocators

Scheduled Sampled Allocators

1.6 Tutorials

1.6.1 Screenshot Example

1.6. Tutorials 65


1.7 Advanced

1.7.1 Terminology & Architecture

1.7.2 User Permissions


enviromap documentation - read the docs€¦ · enviromap documentation, release 0.1 note: the...

Documents