Skip to content

Manage Identification Frameworks

Requirements:

Create an identification framework

Create an identification framework with no identifiers

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Click Create New.
  3. Enter a Name and Description for the identification framework.
  4. Select the option to Create empty framework.
  5. Click Create.

After you create the identification framework, you can create new identifiers.

Copy an existing identification framework and its identifiers

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Click Create New.
  3. Enter a Name and Description for the identification framework.
  4. Select the option to Create identifiers from an existing framework.
  5. Select the checkbox for the framework you want to copy. You can only copy a single framework. For more information about a framework, click the framework name to open a new tab with details about the framework.
  6. Click Create.

Manage an identification framework's identifiers

Add an identifier to a framework

To add an identifier to a framework,

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Select the framework name for the identification framework you want to edit.
  3. Click Add Identifier.

  4. Choose in the dropdown to add an identifier from those already in Immuta or create a new identifier for the framework.

    • For existing identifiers: Opt to edit the tags. Then click Add Identifier.
    • For new identifiers:
      1. Fill out a Name and Description.
      2. Enter criteria: Select the Type of criteria.
        1. For regex, enter a regex to be matched against column values. The default criteria encoding is case-sensitive. You can change this encoding using the regex criteria. The regex must use RE2.
        2. For column name regex, enter a regex to be matched against column names. The default criteria encoding is not case-sensitive. You can change this encoding using the regex criteria. The regex must use RE2 syntax.
        3. For a dictionary, enter the values in a comma-separated list to match against column values. Opt to toggle the Case insensitive switch to on if you want the dictionary to be case sensitive.
      3. Select the tags to apply: Use the text box to search for a tag under the "Discovered" hierarchy or type a tag name to create a new tag under the "Discovered" hierarchy to apply to columns that match your identifier.
      4. Click Next to review your new identifier and click Create Identifier to create it.

Edit an identifier in a framework

Only tags can be edited within a framework. Edits made to an identifier within a framework will only impact that specific identifier. To fully edit an identifier (including the name, description, or criteria) for all frameworks, use the Edit an identifier how-to guide.

To edit the tags applied by an identifier for a framework,

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Select the framework name for the identification framework you want to edit.
  3. Click the more actions icon for an identifier and select Edit tags.
  4. Remove the tags or type a tag name to add tags.
  5. Click Save.

Delete an identifier from a framework

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Select the framework name for the identification framework you want to edit.
  3. Click the more actions icon for an identifier and select Delete.
  4. Click Delete again in the modal.

Manage an identification framework's data sources

Assign an identification framework to data sources

To assign a framework to run on specific data sources,

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Select the framework you want to assign and navigate to the Data Sources tab.
  3. Click Add Data Sources.
  4. Select the checkbox for the data source you want this framework to run on. You may select more than one.
  5. Click Add Data Source(s).

Remove data sources from an identification framework

After a data source is removed from a framework, it will use the global framework for any SDD scans and the tags applied by the removed framework will be replaced. The global framework is signified by the globe icon.

To remove data sources from a framework,

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Select the framework you want to remove data sources from and navigate to the Data Sources tab.
  3. Select the checkbox for the data source you want to remove from the framework. You may select more than one.
  4. Select Remove and click Remove again in the modal.

Delete an identification framework

Requirement: No data sources assigned to the framework

To delete a framework,

  1. Click the Discover icon in the navigation menu and select the Identification tab.
  2. Click the more actions icon in the Action column for the framework you want to delete. The global framework cannot be deleted. If you want to delete it, configure a different framework as the global framework.
  3. Select Delete and click Delete again in the modal.