¶ Delete Cube Records Documentation
This documentation provides an overview of the Delete Cube Records task in Planning. This task allows users to remove specific data records from cubes within the Planning system based on defined criteria.
¶ Purpose and Overview
The Delete Cube Records task enables targeted removal of data from multidimensional cubes. This is useful for:
- Removing obsolete or incorrect data
- Clearing specific dimensional intersections
- Data cleanup operations
- Preparing cubes for fresh data imports
- Managing cube data lifecycle
Important: You must have write permissions for the target cube to delete records. Without sufficient permissions, the deletion task will fail.
¶ Configuring the Delete Cube Records Task
Before using the Delete Cube Records task, you need to configure the task parameters. These include:
¶ Required Fields
- Name: A descriptive name for the task (e.g., "Delete Records From Financial Cube")
- Description: A brief explanation of what the task does
- Task Type: Select "Delete Cube Records" from the dropdown
- Model: The Planning model that contains the target cube
- Cube: The specific cube from which records will be deleted
- Filter Criteria: Define conditions that identify which records to delete:
- Column Name: The dimension or attribute to filter on
- Operator: The comparison operator (e.g., =, >, <, etc.)
- Column Value: The value to match against
¶ Optional Settings
- Mark output file as private: Check this box if you want to restrict access to any output files generated during the deletion process
¶ Filter Criteria Configuration
The filter criteria section is crucial for specifying which records to delete:
- Column Name: Select the dimension or attribute name from the dropdown
- Operator: Choose the appropriate comparison operator:
- = (equal to)
- != (not equal to)
(greater than)
- < (less than)
= (greater than or equal to)
- <= (less than or equal to)
- LIKE (pattern matching)
- IN (multiple values)
- Column Value: Enter the value to compare against
- Click the + button to add additional filter criteria (for compound conditions)
Multiple filter criteria are combined using AND logic, meaning all conditions must be met for a record to be deleted.
¶ Using the Delete Cube Records Task
Once the task is configured, you can utilize it within a Planning flow. Follow these steps:
- Open the Planning web application in your web browser
- Log in to your Planning account using your credentials with appropriate permissions
- Go to the "Task" section and click on "Create New" button
- Fill in all required fields as described above
- Configure your filter criteria to specify which records to delete
- Click on the "Save" button to create the task
- Go to "Flow" section and click on "Create New"
- Fill in required fields for the flow and click on "Add Task"
- Select the Delete Cube Records task you created
- Click on "Save" button to save the flow
- Click on "Execute" button to execute the flow
- Planning will delete the records that match your specified criteria from the cube
¶ Conclusion
The Delete Cube Records task in Planning provides a powerful way to remove specific data from Planning cubes based on defined criteria. By carefully configuring the task parameters and filter conditions, users can efficiently manage cube data and maintain data quality. Remember that write permissions are required for the target cube, and deletion operations should be performed with caution as they permanently remove data from the system.