Creating and Managing SmartLabels

Introduction #

This chapter describes how to view, create, edit, and delete a SmartLabel.

Viewing SmartLabels #

The SmartLabel Management page (Left menu > SmartLabels icon) displays information about existing SmartLabels.

• Lucidum SmartLabels tab. Lucidum includes pre-built SmartLabels, called Value-Oriented SmartLabels or VOSLs. You can find these VOSLs under the Lucidum SmartLabels tab. VOSLs are read-only. You can use them in queries but cannot edit them.

• My SmartLabels tab. When you create SmartLabels, the SmartLabels appear in the My SmartLabels tab. You can use these SmartLabels in queries and can edit them, delete them, or assign them to MetaBlocks.

• All SmartLabels tab. When your and your team-mates create SmartLabels, the SmartLabels appear in the All SmartLabels tab. Only accounts of type Admin or Lucidum Support can edit, delete and add these queries to MetaBlocks. All other accounts can edit, delete and add to MetaBlocks only queries they created.

Viewing Details about a SmartLabel #

To manage SmartLabels:

1. Go to Left menu > SmartLabels icon.

2. The SmartLabel Management page displays the following about each SmartLabel:

   

   • SmartLabel icon (tent). This SmartLabel includes one or more SmartLabels as rules. The number specifies how many SmartLabels are nested in the SmartLabel.

   • Sigma icon. This SmartLabel includes a function.

   • Tag icon (hang tag). This SmartLabel includes one or more Tags as rules. The number specifies how many Tags are nested in the SmartLabel.

   • Name. Name of the SmartLabel.

   • Description. Description of the SmartLabel.

   • Data Type. Specifies that Lucidum object type for the SmartLabel. Choices are:

     • Asset

     • User

   • Result Type. Specifies the data type for the output value stored in the SmartLabel. Choices are:

     • Boolean

     • Date Time

     • Float

     • Integer

     • List

     • String

   • Created By. User who created the SmartLabel.

   • Last Modified On. Date and time when the SmartLabel was created or last edited.

   • Actions. You can edit (pencil icon), clone (pages icon) or delete (trash icon) SmartLabels.

3. Expanding a SmartLabel (clicking the down arrow) in the SmartLabel Management page displays the list of rules for the SmartLabel and the list of dependencies. Dependencies are other functions in Lucidum that use the SmartLabel.

   

4. Clicking on the MetaBlocks dependencies icon displays:

   

   • Type. Displays the icon for the dependency. In this case, the MetaBlock icon.

   • Dependency Name. Name of the MetaBlock.

   • Created By. Lucidum user who created the MetaBlock.

5. Clicking on the Dashboard dependencies icon displays:

   

   • Type. Displays the icon for the dependency. In this case, the Dashboard icon.

   • Dependency Name. Name of the dashboard:chart that use the SmartLabel.

   • Created By. Lucidum user who created the dashboard.

6. Clicking on the Actions dependencies icon displays:

   

   • Type. Displays the icon for the dependency. In this case, the Action icon.

   • Dependency Name. Name of the Action that uses the SmartLabel.

   • Created By. Lucidum user who created the Action.

7. Clicking on the SmartLabels dependencies icon displays:

   

   • Type. Displays the icon for the dependency. In this case, the SmartLabel icon.

   • Dependency Name. Name of the SmartLabel that uses the current SmartLabel.

   • Created By. Lucidum user who created the SmartLabel.

8. Clicking on the Saved Query dependencies icon displays:

   

   • Type. Displays the icon for the dependency. In this case, the Saved Query icon.

   • Dependency Name. Name of the Saved Query.

   • Created By. Lucidum user who created the Saved Query.

Viewing SmartLabels for Individual Assets or Users #

You can view a list of all SmartLabels that have been populated for an asset or user and the values for each SmartLabel.

To do this, see the section on Viewing Data from SmartLabels.

Creating a SmartLabel #

There are multiple ways to create a SmartLabel:

• From the SmartLabel Management page
• From the Query Builder
• Cloning an existing SmartLabel
• Exporting and importing an existing SmartLabel

Creating a SmartLabel in the SmartLabel Management Page #

To create a SmartLabel in the SmartLabel Management page:

1. Navigate to the SmartLabel Management page (SmartLabel Management).

2. Click the Add SmartLabel icon (plus-sign) in the upper right.

   

3. In the Add SmartLabel page, enter the following in the top pane:

   • Name. Name of the SmartLabel. Must be unique among all SmartLabels (Lucidum SmartLabels, My SmartLabels, All SmartLabels).
   • Label Type. Specifies the data type for the value of the SmartLabel. Choices are:
     • Boolean
     • Date Time
     • Float
     • Integer
     • List
     • String
   • Data Type. Specifies that Lucidum object type for the SmartLabel. Choices are:
     • Asset
     • User
   • MetaBlock. Select one or more MetaBlocks to align with to this SmartLabel. For details on MetaBlocks, see Creating and Managing MetaBlocks.
   • Description. After saving the SmartLabel, Lucidum uses the Luci LLM to populate this field automatically. You cannot edit the value in this field.
   • Business Value. After saving the SmartLabel, Lucidum uses the Luci LLM to populate this field automatically. You cannot edit the value in this field.
   • Author Comments. Notes from the creator of the SmartLabel.

4. In the Configured Rules pane, click the + icon to add a rule. A rule can be a query or a tag or another SmartLabel.

5. The Build a Query page appears. In this page, you can create a query, select an existing SmartLabel, or select an existing Tag.

6. In the Build a Query page, click Apply.

7. In the Configured Rules pane, enter values in the following fields:

   • Priority. Specifies the order in which rules are applied. If you specify multiple rules, you can use the arrows to move rules up and down the list of rules to change priority.

   • Rule Description. Click in this field and enter a description for the rule.

   • Result Value. Click in this field and enter a value or or select a field that is applied to each user or asset that matches the rule.

   • Default Label Value. Specify a value that is applied to each user or asset that does not match one or more rules. If left blank, no value is assigned to users or assets that do not match one or more rules.

   NOTE: Rules are OR statements. The results of the SmartLabel include assets or users that match only one rule, more than one rule, or all rules.

8. You can drag-and-drop rules to change the order.

Creating a SmartLabel in the Query Builder #

1. Follow the steps to Create a query.

2. In the Build a Query page, click the Add SmartLabel icon in the lower right.

   

3. The Add SmartLabel dialog page appears, with the Configure Rules pane populated with the query:

   

4. In the Add SmartLabel page, enter the following in the top pane:

   • Name. Name of the SmartLabel. Must be unique among all SmartLabels (Lucidum SmartLabels, My SmartLabels, All SmartLabels).

   • Label Type. Specifies the data type for the value of the SmartLabel. Choices are:

     • Boolean

     • Date Time

     • Float

     • Integer

     • List

     • String

   • Data Type. Specifies that Lucidum object type for the SmartLabel. Choices are:

     • Asset

     • User

   • MetaBlock. Select one or more MetaBlocks to align with to this SmartLabel. For details on MetaBlocks, see Creating and Managing MetaBlocks.
   • Description. After saving the SmartLabel, Lucidum uses the Luci LLM to populate this field automatically. You cannot edit the value in this field.
   • Business Value. After saving the SmartLabel, Lucidum uses the Luci LLM to populate this field automatically. You cannot edit the value in this field.
   • Author Comments. Notes from the creator of the SmartLabel.

5. In the Configured Rules pane, enter values for the already-populated rule:

   • Priority. Specifies the order in which rules are applied. If you specify multiple rules, you can use the arrows to move rules up and down the list of rules to change priority.

   • Rule Description. Click in this field and enter a description for the rule.

   • Result Value. Click in this field and enter a value or select a field that is applied to each user or asset that matches the rule.

6. To add an additional rules, in the Configured Rules pane, click the + icon. A rule can be a query or a tag or another SmartLabel.

7. The Build a Query page appears. In this page, you can create a query, select an existing SmartLabel, or select an existing Tag.

8. In the Build a Query page, click Apply to add the new additional rule.

9. In the Default Label Value field, specify a value that is applied to each user or asset that does not match one or more rules. If left blank, no value is assigned to users or assets that do not match one or more rules.

   NOTE: Rules are OR statements. The results of the SmartLabel include assets or users that match: only one rule, more than one rule, or all rules.

10. You can drag-and-drop rules to change their order in a SmartLabel.

Cloning a SmartLabel #

You can clone an existing SmartLabel that appears in the Lucidum SmartLabels tab, My SmartLabels tab, or the All SmartLabels tab.

To clone a SmartLabel:

1. Navigate to the SmartLabel Management page (Left menu > SmartLabels icon).

2. Find the SmartLabel you want to clone.

   

3. Click the Clone icon (two pages) for that SmartLabel.

4. In the Clone SmartLabel page, provide a new name for the cloned SmartLabel and click Save.

   

5. The cloned SmartLabel appears in the My SmartLabels tab.

   

Using a SmartLabel in the Query Page #

After you create a SmartLabel, you can see the field in the Query page when creating a query.

To use a SmartLabel in a query:

1. Click Query.

   

2. In the Build a Query page , click on the SmartLabels category.

3. The right pane displays a list of SmartLabels you can use in your query.

Editing a SmartLabel #

To edit a SmartLabel:

1. Navigate to the SmartLabel Management page (Left menu > SmartLabels icon).
2. Select a tab, either My SmartLabels or All SmartLabels.
3. Find the SmartLabel you want to edit. Click its edit icon (pencil).

   NOTE: If you have permission to edit a SmartLabel, the pencil icon appears active. If you do not have permission to edit a SmartLabel, the pencil icon is grayed out.

4. The Edit SmartLabel page appears.

   

5. In the Edit SmartLabel page, you can edit the following:
   • Name. Name of the SmartLabel. Must be unique among all SmartLabels (Lucidum SmartLabels, My SmartLabels, All SmartLabels).
   • MetaBlock. Select one or more MetaBlocks to align with to this SmartLabel. For details on MetaBlocks, see Creating and Managing MetaBlocks.
   • Author Comments. Notes from the creator of the SmartLabel.
6. In the Configured Rules pane, you can:
   • delete an existing rule
   • edit all fields for an existing rule, including the query
   • add additional rules
   • change the priority of rules
   • drag-and-drop to change the order or rules.
7. Click Save.

Deleting a SmartLabel #

To delete a SmartLabel:

1. Navigate to the SmartLabel Management page (Left menu > SmartLabels icon).

2. Find the SmartLabel you want to edit. Click its Delete (trash can) icon.

3. If the SmartLabel has dependencies, the Delete This SmartLabel? modal page displays the dependencies for the SmartLabel.

   

4. the Delete This SmartLabel? modal page displays:

   • Type. The Type column displays an icon for one of the following: Dashboards, Actions, SmartLabels and Saved Query. These icons match the icons in the main navigation bar and show which other parts of Lucidum are using a SmartLabel.

   • Dependency. Name of the dependency.

   • Created By. Lucidum user who created the action.

5. Before you can delete the SmartLabel, you must manually remove all the dependencies in the Delete This SmartLabel? modal page. You can then re-try the Delete action.

6. Click Confirm to delete the SmartLabel.