Skip to main content

Couchbase - NoSQL

To create a task in Couchbase, go to NoSQL > Couchbase > Tasks. This will display the Task Definitions screen. To create a new task, click the Add New Task Definition tab. The following screenshot shows the user interface for creating a task:

  1. Enter a unique task name in the Task Name field. This field supports numeric and character values.

  2. Enter a Task Description of maximum 254 characters. This field supports numeric and character values.

  3. Select the attribute name from the Task Attribute drop-down. This option allows to add tags to the created task.

    *Note: Task Attribute field is not applicable for NoSQL tasks.

  4. Enter a numeric value for Duplicate Damping Factor. It is used to specify the maximum hit count for any given type of sensitive type.

     

  5. PK Protect is equipped with data sampling to limit the area of scan which helps in reducing the time taken for detection. By default, there are two options to scan sample data from the database are:

    1. Random 1000 Documents - It will sample approximate 1000 documents from the data, randomly.

    2. Read random 5% of data – It will sample 5 percent of the data, randomly.

      Select the Sampling Configuration from the drop-down.

      By default, Random 1000 rows/documents option is selected. To define a sampling configuration, go to NoSQL > MongoDB > Tasks > Sampling Configuration tab. Click + Add button. To create a sample in the Add New Task Definition screen, click the +Add button next to the Sampling Configuration drop-down.

      The Sampling Configuration screen is depicted below:

       

      1. Enter the name and description of the sampling configuration in the Name and Description textbox. These fields accepts both numerals and character values.

      2. Check the option Set Sampling Config as Default to set the Sampling Configuration as the default configuration for all your tasks.

      3. By: To specify how to pick data for sampling from the database, there are two ways:

        1. Rows/Documents: Select Rows/Documents from the drop-down, to sample data based on the number of rows/documents.

        2. Percent: Select Percent from the drop-down, to sample a percentage of the data.

           

      4. Value: Enter the numeric value. It will specify the total number of records to be processed if sampling By-Rows is selected. It denotes the percentage of sampling if By-Percent is selected.      

      5. Type: Select the sampling configuration type from the Type option.

         

        1. Random: This option in the Type field scans random entries in the database. It will scan the number of entries based on the value entered in the Value field.

        2. Complete: Select Complete to use the complete data for sampling.

           

      6. After setting up the required configuration, click Add to add the user-defined sampling configuration to the list. Click the Save button to save the changes.

  6. The Connections Panel lists down all the available connections. Any number of connections can be selected for a task. You can also create a new connection by clicking the +Add New Connection button.  To know more about how to create and manage connections, refer to section Connection Manager. Perform the following steps to choose a connection:

    To select a connection, check the checkbox available with the connection name. The list of connections can be segregated based on the group values specified in the Select Group drop-down. There are five options based on which connections can be sorted.

    The Select Group drop-down at top right corner has five options:

    1. Connection IDP: Categorizes the available connections based on the types of IDPs available, i.e., Detection and Masking.

    2. Connection Type: Categorizes the available connections based on the type of server connected to, i.e., Oracle, Teradata, SQL server etc.

    3. Host Name: Categorizes the list of available connections based on Host Names.

    4. Location: Categorizes the available connections based on the location of the target source system server, i.e., On-Premises and Cloud.

    5. User Name: Categorizes the list of available connections based on the Usernames.

      The Select Group Value drop-down displays the values based on the selection made in the Select Group drop-down. The panel gets populated as per the selection made in the Select Group drop-down.

      Check the checkbox available with the connection name that you want to select, only then the Test option will get enabled.

      The Test button lets you to test the connection before executing the task. It will show the pop-up on successful completion of testing.

       

  7. The Compliance Policies panel displays all the Pre-Defined and Customized Policies. You can select any number of policies while creating or editing a task. Sensitive types associated with the selected policy can be viewed in the Pre-Defined and Custom Sensitive Types panel. Selecting a policy is not a mandatory step, users can also proceed to select individual sensitive types. You can also add a new policy by clicking the +Add Policy button. To know more, refer to section Policy.

     

  8. The Pre-Defined and Custom Sensitive Types panel lists down all the Sensitive Types. The Sensitive Type associated with the policy gets selected in the Pre-Defined and Custom Sensitive panel and cannot be removed once selected, however any number of sensitive types can be added to the panel. You can also add a new sensitive type by clicking the +Add New Sensitive Data Type button. To know more, refer to section Sensitive Types.

     

  9. Click Save button to save the task. To execute the task instantly after saving, click Save and Execute button. Click Save As button, if you want to save the task with the same configuration but with different name.

  10. Click Cancel if you do not want to save the changes.

    To edit an existing task, select the required task from the Tasks screen. Click Pen icon  in the Actions column.

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.