Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Applies to: (tick) Kyvos Enterprise  (tick) Kyvos Cloud (SaaS on AWS) (tick) Kyvos AWS Marketplace

...

Column masking for Column Level Security 

You can apply unconditional column masking for Masking can be applied to a single-level hierarchy, multilevel hierarchy, Parent Child Hierarchy, attributeparent-child hierarchy, attributes, base measure, calculated measure, and measure used in the calculationmeasures, calculated measures, and measures used in calculations. For column-level security, both unconditional and conditional masking can be applied. By implementing masking at the column level, you can effectively manage data accessibility and privacy, ensuring that users only access information necessary for their roles while protecting sensitive data from exposure.

  • Unconditional column masking: Applies masking to specific columns. It is supported only for Spark-based deployments.

  • Conditional column masking (Beta): Applies masking only part of the data while masking based on specific conditions It is supported for both Spark and No-Spark-based deployments.

Unconditional column masking
Anchor
unconditionalcolumnmasking
unconditionalcolumnmasking

Unconditional column masking is used in Spark-based deployments where the entire column is masked uniformly. In this approach, any user who accesses the masked column will see only obfuscated or masked values rather than the actual data, regardless of their access permissions.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

  • Column masking is not applied to Member Properties, Unknown and Calculated members, and Predefined time type hierarchy.

  • Currently, column masking does not support the SQL interface.

  • Partial masking on numerical dimension field is not supported.

  • Merging of measure values for fully masked only attribute/single level hierarchy is not supported.

  • The original column data is preserved while masking because numeric data is masked with a number, and a date is masked with a date. You can specify a fixed pattern or a Regex expression for any string data type. 

  • The masked value is displayed while browsing the semantic model on any BI tool with an MDX connection. 

  • If using Tilde (~) for column masking and want to apply a filter on the masked value from Kyvos UI, then you must change the value of the field value separator as the default value of the kyvos.filter.value.separator property is also Tilde (~). Hence, you must change the default value of this property so that column masking with the Tilde character can function.

  • To apply column masking to a pre-defined hierarchy, you need to select the full name of the hierarchy.

  • You can create, delete, update, save, and assign column security (masking) rules by using the Security Rest API's.

To mask apply unconditional column data masking for Column Level Security (CLS), perform the following steps. 

  1. From the Toolbox, click Semantic Models.

  2. Select the semantic model name from the list and click the Process tab if needed.

  3. Click the Action menu (...) in the work area, then click Data Security.
    If the option is not displayed, you must save the semantic model and try again.

  4. Click users or groups that this rule will apply to.

  5. Click the plus sign in the Rules column.

  6. Add a rule name and description.

  7. From the Column Level area, click the Mask Data link, and then select the field on which you want to apply the column masking. By default, the Mask data is applied. This indicates unconditional data mask.

    image-20241113-061911.pngImage Added
  8. Click the value link, and the Mask with dialog box is displayed. You must enter the required value for unconditional column masking. The available choices vary depending on the data you are using.  

    image-20241113-062246.pngImage Added
    1. For any string data type, choose one of the following: 

      • Fixed: Use this option to specify a fixed value for column masking. Enter a value that you want to apply for column masking. The entered value is displayed in the Preview area. 
        NOTE: You can specify any character or special characters, such as #, *, @. If you keep the field blank, then while semantic model browsing, the field value is displayed as blank.  

      • Regex: Use this option to specify a Regex expression for column masking.

        image-20241113-062459.pngImage Added
        1. Enter a Regex expression that you want to specify for the field value, and then provide a value that you want to use for column masking.

        2. You can also select a Regex expression from the Choose from common expressions list. 

        3. To verify whether the Regex expression is successfully masked with the value, enter a relevant value in the Test Value field. The result is displayed in the Preview field. If the expression is not masked successfully, you can modify the expression, as needed.  
          NOTE: In an expression, the Delimiter (/) and the flags (g,m,i,u,s,d) are not supported.

  9. Click the plus sign to add additional fields, if required.  

  10. Click Add

...

Conditional masking (Beta)
Anchor
columnmasking
columnmasking

Conditional column masking allows for more granular control by masking data in a column based on certain conditions.

Panel
panelIconIdatlassian-note
panelIcon:note:
bgColor#DEEBFF

Note

  • Kyvos does not support conditional masking on date field.

  • Partial masking on numerical dimension field is not supported

  • Merging of measure values for fully masked only attribute/single level hierarchy is not supported.

  • Masking on measure is not supported.

To apply conditional column masking for Column Level Security (CLS), perform the following steps. 

  1. From the Toolbox, click Semantic Models.

  2. Select the semantic model name from the list and click the Process tab if needed.

  3. Click the Action menu (...) in the work area, then click Data Security.
    If the option is not displayed, you must save the semantic model and try again.

  4. Click users or groups that this rule will apply to.

  5. Click the plus sign in the Rules column.

  6. Add a rule name and description.

  7. From the Column Level area, click Mask Data and select Conditionally mask data, and then select the field on which you want to apply the column masking. 

    image-20241113-054755.pngImage Added
  8. Click the Conditional Mask Data link and click the field link. The field list is displayed. Select the field that you want to conditionally mask.

  9. Click the value link, and the Conditional Mask with dialog box is displayed. You must enter the required value for unconditional conditional column masking. The available choices vary depending on the data you are using.  

    image-20240111-100035.pngImage Removed
    1. For any string data type, choose one of the following: 

      • Fixed: Use this option to specify a fixed value for column masking. 
        For any string data type, choose one of the following: 

        image-20240111-100215.pngImage Removedimage-20241113-060806.pngImage Added
        • Enter a value that you want to apply for column masking. The entered value is displayed in the Preview area. 
          NOTE: You can specify any character or special characters, such as #, *, @. If you keep the field blank, then while semantic model browsing, the field value is displayed as blank.  

      • Regex: Use this option to specify a Regex expression for column masking.

        image-20240111-100624.pngImage Removedimage-20241113-061042.pngImage Added
        1. Enter a Regex expression that you want to specify for the field value, and then provide a value that you want to use for column masking.

        2. You can also select a Regex expression from the Choose from common expressions list. 

        3. To verify whether the Regex expression is successfully masked with the value, enter a relevant value in the Test Value field. The result is displayed in the Preview field. If the expression is not masked successfully, you can modify the expression, as needed.  
          NOTE: In an expression, the Delimiter (/) and the flags (g,m,i,u,s,d) are not supported.

  10. Click the field link to select the field on which you want to apply conditional column masking.

    image-20241113-061348.pngImage Added
  11. Click the plus sign to add additional fields, if required.  

  12. Click Add

    Image Removed

...

Examples of rule criteria

...