Quick Start Guide

Getting Started

You will need to have a few things ready before you can start creating alerts, references or glossaries. You will only have to set up these steps once and you can then use them over and over again for your three rule types.

Step Description Related Documentation
Step 1: Setup an Agent This will be the worker that orchestrates your data and completes the actions that you have ruled out. Here is a link to learn more about the agent
Step 2: Add Connections These are your data sources and targets. Read more about connections
Step 3: Create a Project This will categorise your rules (alerts, references and glossaries). Learn about projects here
Step 4: Add users to Application Roles These roles will give permissions to your selected users. You can select which users can create rules and which can see read-only results. Find more information about user application roles here
Step 5: Create your first Rule A rule can be an alert, reference or glossary. A rule will trigger notifications and instigate a business workflow. Read about our rule types here

The following sections will show you how to complete each step needed to create and run a rule.

See our application roles page to learn which roles have permission to take the following actions.

How to Add an Agent

Follow the instructions below to add an agent. You will have to download and run the Loome agent installer for your platform of Windows, Linux, Docker Run or Azure Container instances.

Click on Agents in the top-right drop down.

Agent Menu

Click on Setup Agent.

Setup Agent Button

This will expand the slide-out where you can select your platform. Choose from Windows, Linux, Docker Run or Azure Container instances.

Agent Slideout

Once you have selected your platform, you will be shown the steps you can follow to install an agent. This varies for the platform that you have selected. Please read more about the agent, its requirements and detailed instructions here.

Learn how to install the agent for Windows and Linux here.

Learn how to install the agent for Docker and Azure Container instances here.

How to Add a Connection

Click on Connections in the top-right settings dropdown menu.

Menu Dropdown

Click on Add Connection to start creating a connection to your data platform.

Add a connection

Select a connection type.

Connection Types

Once you have selected a connection type, follow the next steps to complete the fields you need to create a connection.

Add a SQL server connection

First, provide a friendly name to easily identify this connection.

If required, you can then add your username and password (or your Personal Access Token) in these fields to provide your username and password separately from the connection string. What details you provide here can vary depending on the connector type. This would be the same credentials you use to log into the account of this data source or target. For example, if you were adding a SQL Server connection, this would be your SQL Server account username and password.

Then add your connection string. Find connection string templates for Microsoft SQL Server here and Snowflake Data Warehouse here.

Next, select the agent that will validate this connection.

Once you have completed these fields, save at the top right corner.

You will now be able to find this connection when creating and editing rules.

Read more about connections here.

How to Add a Project

You can create a new project from the left-hand sidebar.

Create new project from the slideout

Provide a friendly name to easily identify the type of rules that you will add to this project.

Click on Create Project in the bottom right corner and you will then be able to select this project on the homepage or left-hand project slide-out.

New project

Learn how to manage projects here.

How to Add a User to an Application Role

Find the application role page from the top right settings menu, as shown in the image below.

Application roles in the menu

Beside the role that you would like to add a user to, click on the Add button in the top right corner of that role and a slide-out will be expanded.

Add a user

In this slide-out, type in the email address of the user and then click Add.

Type in email address

Click on Invite and this user will now be able to log in using this role.

Invite a user

If they have only been sent an invitation their status will remain as ‘Invited’ until they log in, in which their status will change to ‘Verified’.

Invited user

To delete a user from an application role, find the user on the application roles page and click on the Delete button at the end of a row beside the user’s name.

Delete a user

Please read more about application roles and learn which roles provide which permissions here.

How to Create a Rule

A rule will trigger notifications and instigate a business workflow.

There are three types of rules.

  • Alert: An alert is used to define a data quality or process compliance exception that you want to keep track of and assign to someone to resolve.

  • Glossary: A glossary will annotate an existing list of terms, fields or tables with explanatory notes and classifications.

  • Reference: You can use a reference to define a data set that requires a data steward to manually update additional attributes for reporting purposes.

In the project you created earlier, click on Create New Item.

The first step in creating a rule, no matter the type, is providing a name for the rule. Rule names should be user friendly, unique, and summarizes the purpose of the rule. 

You also have the option to add a description for this rule. Here you can describe the rule and its purpose in more detail.

Select an agent that will execute this rule. An agent contains all the code that allows rules to run.

Select a name and agent

Choose your Connections

Rules consist of two connections; the source connection and the output connection. First select the source connection, your rule’s query will be retrieving data from this connection. Then select the output connection and a dedicated schema will be created in this database connection.

These can be the connections we created earlier or you can add a new connection using the ‘Add’ button beside the connection dropdown fields.

Add a connection

Write your Query

Provide a query that will retrieve data from your source connection for this rule.

This query should be written using the same SQL variant that your source connection utilizes. Loome Monitor will validate the query as you type and provide any errors or warnings below the query box.

Write in a query

Choose your Key Columns

In this next window, select one or more Key Columns for the rule. Examples of key columns are unique identifiers such as primary keys or a combination of columns to form a composite key. In the event of Key Columns not being entirely unique Loome Monitor will not behave as expected.

You will need to choose at least one key column and leave at least one column unselected.

Choose your key column/s

If using a column with the varchar/nvarchar type as a key column, there is a maximum value for the total length of the index for output tables. For multiple key columns, the total length of the combination of all key columns must be lower than the following limits.

Version Limit
The maximum length for SQL Server 2016 CU1 and below 900 for varchar, and 450 for nvarchar.
The maximum length for SQL Server 2016 CU2 and above 1700 for varchar, and 850 for nvarchar.

Create Custom Fields

You can choose to create custom fields to capture feedback for your results in this next step, but it is not a requirement and you can proceed without adding any custom fields. Loome will create a dedicated schema for your custom field metadata and it will be independent from the results table generated from this rule.

To create a custom field, click on Add Custom Field and a slide-out will be expanded with the option to choose from six different field types.

Add a custom field

Read more about custom fields here.

Add Communication Rules

Next, you can create communication rules. You can choose to create a branch that will send communications only on specific conditions or choose to send an email to a target audience.

Create a communication rule

Learn more about communication rules on this page here.

Click on Create to save and complete this rule.

Create the alert

Run the Rule

You will be shown a page where you have the option to either return to your project, edit, or run this rule.

Run this rule to view the results it will generate.

Run the rule

Once you click on Run, you will be able to see the progress of this rule as each step is listed under ‘Execution Steps’.

Execution Steps

Once you have run this rule, any communication steps you added while creating or editing this rule will have been sent during the above rule execution process.

View and Edit your Results

Click on the Results button, which is the table icon in the top right of these execution steps, to be directed to your Results page.

View the progress of the rule

View and filter your results using the slideout on the right.

Filter your results

Edit your results using the edit button on the right of the row you want to edit.

This will expand a slide-out where you can edit who is assigned to this result, whether a result is ignored, and each custom field you added when creating or editing this rule.

Edit your results

Read more about viewing and editing your results here.