2023-Nov-03-R11.1a

Enrich Basic Table Data with Column Groups

For a base table created via the application path, column groups can be added to cover more data. The system supports several methods to populate dynamic columns for a path-based table. The table below briefly describes each of the methods. After the columns are added to ADT, you can build and update ADT data and add tags to the automation column and map column.

MethodWhen do I need to use this method?
Use Case
Intent Template

Add some additional intent columns to an ADT.

Required Necessary Condition:

  • A suitable intent template.
Intent Template (on-demand replication and Auto-Replicated) is selected and used. with the intent template, you add an intent column (mandatory), then the intent outputs to additional columns.
Intent Cluster

Add some additional intent columns to an ADT.

Required Necessary Condition:

  • A suitable network intent cluster
Match and filter a member intent for each valid row and add the intent outputs to additional columns.
Monitoring Probe
Add some additional probe columns to an ADT.

Required Necessary Condition:
  • Pre-generate some probes
Filter a probe by the probe name using the current ADT data.
Path Intent Filtering

Add filtered path intents to the path intent column of ADT.

Required Necessary Conditions:

  • The ADT should contain path column (path property).
Filter matched path intents (by intent name or intent tag) from the path objects in the ADT to add path intent column and relevant intent output columns to ADT. 
Imported CSV

CSV file and want to enrich table data with it.

Required Necessary Condition:

  • A suitable CSV file
Use selected key columns to match the rows in CSV files and append specified columns from CSV files to the ADT for new columns in the matched rows.
Function CallEnrich ADT with some key column properties.Specify a column with the type of device and use device properties and functions to fill in additional columns.
Intent Replication for Path

Generate some suitable path intent for application paths.

Required Necessary Condition:

  • Save some application paths in Path Browser
  • Some suitable intent templates

See Create Path Intent for Application Path in ADT for more information.

  

Information Note: The Intent Replication for Path method is only applicable when the base table is created via application path.

When the base table is built via the application path, the details for adding automation columns by each method given below:

Add Automation Column from Intent Template

Based on the base table data of ADT, the intent template in the automation column can be used to replicate one intent for each ADT row. This replicated intent includes the automation data in this ADT and the detailed information of the replicated intent, shown in intent output columns. You can select a base table column containing device information for replicating intent.

The follow diagram illustrates how intent template functions in Column Group Builder:
Table Description automatically generated

To build the column group with selected intent template, follow the steps below:

Prerequisites: Pre-generate an intent template, for example, an intent template named "Route Summary".

  1. Go to Automation Data Table Builder, then create a new group and name it (for example, NIT).

  2. Under the new group tab, define the following settings:

    • Description: Input descriptions for the column group to describe its use and function, e.g., "Use intent template to check critical route".
    • Select Method to Build Group Table: Select Intent Template.
    • Intent Template: Click Select, then select the prepared intent template ("Route Summary") for building this column group.
  1. Mapping available fields to Column Group: Drag and drop the available fields to the column group definition area to create ADT columns automatically. 

    There are two field categories in this area to be selected:
    • Built-in Fields: The built-in field available for this group table is the Replicated Intent field. 
    • Intent Outputs: Other intent information can be displayed in the intent output columns of the ADT, such as intent message, intent status code, intent devices, intent map, intent CLI commands, and last execution time.
      Information Note: To configure a column of the column group, perform operations from the drop-down menu of the column.
  1. Define logic to Populate New Columns for Each Row: In this area, you can define the logic of adding data to ADT columns via the intent template.
  2. Select Device Column to Replicate Intent: Select devices for cloning intents, e.g., Path Devices.

  • Replication Settings: Select from the two options Use Live Data and Use Cached Data from Decode Results. This will determine how intents are replicated to fill in the ADT column.
    • Use Live Data: If this mode is selected, the system will retrieve live data, then test and replicates intent.
    • Use Cached Data: If this mode is selected, the system will use pre-decoded device data to replicate intent.
  1. Set variables with the column data in ADT: Select an ADT column from the drop-down list, e.g., Application Name, then the data in this column will be used as values of variables. 

    Information Note: This area is visible when the NIT has pre-decoded macro variables. 
  2. Maximum number of command sections included in the cloned intent (the default value is 99): Enter a number (e.g., 20) which is the maximum number to set limits to the command sections displayed in ADT to reduce noise device property data.

  1. Click Save and Build to save the settings.
    Information Tip: If you click Save, the system will save the settings without building the column group data, and the Automation Data Table Builder will remain open.

If settings for building the ADT are configured in ADT Builder, but you are not satisfied with the settings, you can click Reset All from the ADT Builder to clear all the settings. A message will appear to ask you to confirm this operation.

The following table describes available fields for building a group table if the intent template is the data source.

Field TypeFieldsDescription
Built-in FieldReplicated IntentThe built-in fields are created from the replicated intent from the intent template.
Intent Output Field

Intent Message

Intent Status Code

Device Status Code

Intent Devices

Intent Map

Intent CLI Commands

Last Execution Time

CSV Columns

The intent output fields are created from intent details of the intents generated from the intent template.

Add Automation Column from Intent Cluster

Based on the row data of ADT, the intent cluster in the automation column can be used to replicate member intents for each ADT row. The generated member intents include the automation data in this ADT and the detailed member intent information shown in intent output columns.

The follow diagram illustrates how Intent Cluster functions in Column Group Builder:

Graphical user interface, table Description automatically generated with medium confidence

To build the column group with a selected intent cluster, follow the steps below:

Prerequisites: Pre-generate an Intent Cluster, e.g., intent cluster named "2-Neighbor Pair Sample".

  1. Go to Automation Data Table Builder, then create a new group and name it (e.g., NIC).

  2. Under the new Group tab, define the following settings:
    • Description: Input descriptions (e.g., Use intent cluster to check neighbor pair) for the column group to describe its use and function.
    • Select Method to Build Group Table: Select Intent Cluster.
    • Intent Cluster: Click Select, then select the pre-created intent cluster (2-Neighbor Pair Sample) for building this column group.
  1. Mapping Available Fields to Column Group: Drag and drop the available fields to the column group definition area to create ADT columns automatically. 

    There are three field categories in this area to be selected.
  • Built-in Fields: The built-in fields available for this column group are listed in this area. Applicable fields include Member Intent (the member intent link) and Member Intent Devices.
  • Signature Variables: Select data fields to use the data as the signature variables for the intent cluster.
  • Intent Outputs: Other intent information can be displayed in the intent output columns of the ADT, such as intent message, intent status code, intent devices, intent map, intent CLI commands, and last execution time.
    Information Note: To configure a column of the column group, perform operations from the drop-down menu of a column.
  1. Define logic to Populate New Columns for Each Row: You can define the logic of adding data to ADT columns via the intent cluster.
    Define Conditions to Match Intent for Each Row of ADT: The created member intents are filtered to reduce unnecessary data. Specifically, you can set the filter conditions, such as the member intent device and member intent tag, to match the intents for each ADT row.

  • Intent Identifier: Select the intent identifier from the drop-down list (member intent device, member intent tag, and signature variables, e.g., you can select Member Intent Devices).

  • Operator: Select one operator, for example "Contains".
  • Data Field of Automation Data Table: Select one column of the ADT as matching condition (for example, the Path Devices column).
  • Boolean Expression: Enter the Boolean Expression, such as A. 
  1. Click Save and Build to save the settings.

The following table describes available fields for building a group table if the intent cluster is the data source.

Field TypeFieldsDescription
Built-in Field

Member Intent

The built-in fields are created from the replicated intent from the intent cluster.
Intent Output Field

Intent Message

Intent Status Code

Device Status Code

Intent Devices

Intent Map

Intent CLI Commands

Last Execution Time

The intent output fields are created from intent details of the intents generated from the intent cluster.

Associate Probes for Automation Asset Preventive Automation

Probes installed for ADT can trigger the automation process associated with the ADT automation assets. The corresponding PDAS flow is shown in the diagram below.
A picture containing timeline Description automatically generated

A probe column can be defined for using the primary and secondary probes to trigger automation with assets in the ADT. The probe properties are used as the built-in data for the probe column. The Flash alerts generated by the probes can also be the available data source.

The follow diagram illustrates how Monitoring Probe functions in Column Group Builder:
Graphical user interface Description automatically generated

For the specific steps of building the column group with probes, see Preventive Automation via ADT.

Add Automation Column from Filtered Path Intents 

Based on path properties that already exist in ADT, the path intents associated with the paths in ADT can be filtered by defined filter conditions. Then the filtered path intents will be added to path intent-related columns of ADT. The Path Intent and intent output columns show the filtered path intents and the path intent information.

To build the column group by filtered path intents, follow the steps below:

Prerequisites: Ensure that the ADT has path objects, that is, columns containing path properties. 

  1. Go to Automation Data Table Builder, then create a new group and name it (for example Filtered Path Intents).

  2. Under the new group tab, define the following settings:

    • Description: Input descriptions for the column group to describe its use and function, e.g., "This is for adding path intents to check Azure Network".
    • Select Method to Build Group Table: Select Path Intent Filtering.
  1. Mapping available fields to Column Group: Drag and drop the available fields to the column group definition area to create ADT columns automatically. 

    There are two field categories in this area to be selected:
    • Built-in Fields: The built-in field available for this group table is "Path Intent" field. It is required to drag this field to the column group area to proceed. 
    • Intent Outputs: Other intent information can be displayed in the intent output columns of the ADT, that is, intent message, intent status code, intent devices, intent map, intent CLI commands, and last execution time.
      Information Note: To configure a column of the column group, perform operations from the drop-down menu of the column.
  1. Populate Column Logic for Path Intent: You can define the logic of adding data to ADT columns via the filtered path intents. 
    Define Intent for Paths: "Path" option is available.
    Define Conditions to Filter Intent for Each Path: The path intents are filtered for each path. You can set the filter conditions, that is the Path Intent Identifier, Operator and the intent name/tag to find the matched path intents.

  • Path Intent Identifier: Select the path intent identifier from the drop-down list (Intent Name, Intent Tag).

  • Operator: Select one operator, for example "Contains", "Match any".
  • Manually Input/Select Tags: For Intent Name, input keywords for matching intent name to filter path intent. For intent Tag, click, then select tags for filtering path intent (for example, the "Drift" tag).

  • Boolean Expression: Enter the Boolean Expression, such as A and B. 
  1. Click Save and Build to save the settings.
Field TypeFieldsDescription
Built-in Field

Path Intent

The built-in field is generated from the  filtered Path Intents in ADT.
Intent Output Field

Intent Message

Intent Status Code

Device Status Code

Intent Devices

Intent Map

Intent CLI Commands

Last Execution Time

The intent output fields are created from intent details of the intents generated from the intent cluster.

Add Automation Column from Function Call

Populate ADT columns from the function call.

The follow diagram illustrates how Function Call works in Column Group Builder:

Timeline Description automatically generated

To build the column group via Function Call, follow the steps below:

  1. Go to Automation Data Table Builder, then create a new group and name it (for example, Function Call).

  2. Under the new group tab, define the following settings:

  • Description: Input descriptions (for example, "Use function call to obtain column data") for the column group to describe its use and function.
  • Method: Select Function Call.
  • Column Type: To enrich the data of ADT, two function column types are provided:
    • Select Properties from Specified Column (Default): Specify a column with the type of convention, then use the properties to fill in the additional columns. The major properties are described in the following table:
      No.Source  Column TypeProperties
      1Device, Device ListAll device properties in the GDR definition
      2Interface, Interface ListAll Interface properties in the GDR definition
      3Automation Intent/Source Intent

      Intent Message

      Intent Status Code

      Device Status Code

      Intent Devices

      Intent Map

      Intent CLI Commands

      Last Execution Time

      4Path

      Application Name

      Path Name

      Path Devices

      Path hops (device interfaces)

      Path Map

      Source

      Destination

      Path Status

      5Map

      Map Name

      Map Page

      Map Devices

      Map Device Interfaces

      6Site

      Site Name

      Site Devices

      Site Device Interfaces

      7Device Group

      Device Group Name

      Devices in Group

      Device Interface in Group

      Device Group Map

      8Probe

      Probe Devices

      Probe Name

  • Convert Column Value by Function: Specify a source column, then use the function to fill in the additional columns. The two available functions are described in the table below:
    No.FunctionDescription
    1
    IP to Device
    		Convert an IP address to the device or convert the IP address list to the device list.
    2Subnet to Device listFind all the devices listed in the specified subnet.

  • Source Column: Select an ADT column from the drop list as the data source, for example, the Path Devices column, then available build-in fields will be listed below.

  1. Mapping Available Fields to Column Group: Drag and drop the available fields to the column group definition area to create ADT columns automatically. 

    Information Note: To configure a column of the column group, perform operations from the drop-down menu of  the column.
    There is one field category in this area to be selected.
  • Built-in Fields: If the property from the specified column is set as the data source, the built-in fields are the properties in the source column; if the data source is the converted column value, the built-in fields are the final fields obtained from converting process.
  1. Click Save and Build to save the settings.

Add Automation Column from Imported CSV

If local CSV files containing data to be used in ADT, the CSV file can be imported to be used for creating an ADT column group. By default, all columns in the CSV are added as available fields to the ADT. To merge the CSV columns to the base table, select fields from the CSV and fields in ADT as the table keys to be paired.

The diagram below illustrates how Imported CSV is used in Column Group Builder to build ADT:
Table Description automatically generated with medium confidence

To build the column group with CSV file, follow the steps below:

Prerequisites: A suitable CSV file (for instance, CSV file named All EIGRP Devices). CSV can also be exported from ADT (For more information, see Export ADT File)

  1. Go to Automation Data Table Builder, then create a new group and name it (for example, CSV). 

  2. Under the new group tab, define the following settings:

    • Description: Input descriptions for the column group to describe its use and function.
    • Method: Select Imported CSV.
    • CSV: Click Select, then click Browse from the Select CSV dialog to select the CSV file to be imported and used for building the ADT.

      You can set the column's display name in ADT and the data type to be added to ADT in this dialog. By default, the Data Type for each column is "string". You can change the data type according to the column property. 

  1. Mapping Available Fields to Column Group: Drag and drop the available fields to the column group definition area to create ADT columns automatically.

    Information Note: To configure a column of the column group, perform operations from the drop-down menu of a column.

    There is one field category in this area to be selected.
    • Built-in Fields: By default, the built-in fields available for this base table are all the columns in the CSV file.
  1. Define Paired Keys to Merge CSV with ADT: Select columns in ADT and columns in CSV to add CSV column data to ADT column data.

  2. Click Save and Build to save the settings.