Manage automatic listing/delisting rules

Prerequisites

• Table asset: You have activated the Intelligent R&D Edition or purchased the Asset Operation-Standard Edition value-added module.

• Metric asset/Dashboard asset: You have activated the Intelligent R&D Edition or purchased the Asset Operation-Advanced Edition value-added module.

• API asset: You have activated the Intelligent R&D Edition or purchased the Asset Operation-Advanced Edition value-added module, and also purchased the DataService feature.

Permissions

• Super administrators, operations administrators, and users with a custom global role that includes On-shelves Management-Manage permissions can manage rule groups and rules, and view execution details.

• Rule owners can manage rules and view execution details within their assigned rule groups.

Procedure

1. In the top navigation bar of the Dataphin homepage, choose Assets > Data Catalog.

2. In the left-side navigation pane, choose Auto On/Off-shelves > Auto On/Off-shelves Rules to go to the Auto On/Off-shelves page.

   The page lists your rule groups and rules with their name, type, asset source, latest execution status, owner, last update time, and effective status. If you trigger a manual execution for a rule group, the page also shows the status of that execution.

3. (Optional) Search for a specific rule or rule group by name, or filter the list by rule type, asset type, asset source, effective status, latest execution status, or execution end time.

   Click the Instructions button to view asset listing guidelines.

4. In the Actions column for an asset, you can perform the following operations.

   Operation	Description
   Rule group operations
   View	If you do not have permission to edit a rule group, click View in the Actions column to review its configuration. To modify it, click Edit at the bottom of the page.
   Edit	Click Edit in the Actions column to modify the rule group. You can change any setting except the asset type. Changing the asset source may affect the scope of existing rules configured to apply to all assets. Switching to a different rule group permanently removes all existing configurations. Assess the impact before you proceed.
   New rule	Click New Rule in the Actions column to go to the rule creation page for that rule group.
   Sort	Click Sort in the Actions column. In the Sort Rules dialog box, drag the rules to reorder them, and then click OK. Note The sort order determines the execution sequence of the rules within the rule group. If a task is already running, this reordering does not affect it. The task uses the rule order from the snapshot taken at the time of execution.
   Run manually	To run the rules in a group on demand, click More > Run Manually in the Actions column. This action is unavailable if the last execution status is Pending or Running, or if the rule group contains no Enabled rules. Note If a manual execution is still running when the next scheduled execution is due, Dataphin skips the scheduled execution.
   Terminate	To stop a running execution, click More > Terminate in the Actions column. This action is available only when the last execution status of the rule group is Pending or Running. Note When you terminate a rule group execution, the action does not roll back changes to assets that have already been processed. Verify that the state of your assets meets your expectations.
   View details of last 10 executions	Click More > View Details of Last 10 Executions in the Actions column. In the Execution Details dialog box, each record shows the outcome of a rule's execution on a specific asset. You can filter the list to view all assets affected by a single rule, or to track all changes applied to a single asset by the rule group. The dialog box displays the asset type, scope, execution results, and execution details. From here, you can also edit assets, view rules, and filter the results. Execution detail list: Shows the details for each completed execution record, including asset name, parent table (for metric assets only), asset source, execution result, post-execution status, description, executed rule, and execution end time. Actions on execution records: Execution result: When you select a specific execution by its end time, you can view a summary of the results, including the total number of assets processed and a count of each outcome. Execution records: Records from the last 10 executions are displayed by default. Use the filter to view records for a specific execution time. Filter: Use quick filters to show only Failed or Skipped records. You can also filter by rule, asset, parent table (for metric assets only), execution result, or post-execution status. Edit asset: Click the Edit Asset icon in the Actions column for an asset to go to its edit page. You cannot edit an asset if it has been deleted or its status is Not to be Listed. View rule: Click the View Rule icon in the Actions column to go to the details page for that rule.
   Delete	Click More > Delete in the Actions column. Deleting a rule group also deletes all rules within it. If the rule group is running, Dataphin terminates the execution immediately.
   View details of last execution	After an execution completes, click the View Details of Last Execution icon in the Last execution status column. In the Execution Details dialog box, records are automatically filtered to show only the most recent execution for that rule group. The available information and actions are the same as those for the View details of last 10 executions operation.
   Rule operations
   View	Click a rule's name to view its configuration details. To make changes, click the Edit button at the bottom of the page.
   Edit	Click Edit in the Actions column to modify the rule's configuration.
   Run manually	Run a single rule: To run a rule on demand, click Run Manually in its Actions column. Run rules in bulk: To run multiple rules at once, select the checkboxes for the desired rules within the same rule group, and then click Run Manually at the bottom of the list. Note Dataphin always executes a rule group as a whole. When you manually run a single rule, Dataphin skips the other rules in the same group. However, the system still tracks the execution status and results at the rule group level. You cannot start a manual execution if the rule group's last execution status is Pending or Running, or if there are no Enabled rules in the group. When you run multiple rules in bulk, the action is only performed on the selected rules where you have the necessary permissions and the parent rule group's status allows for execution. Dataphin skips unselected rules within the group. If a manual execution is still running when the next scheduled execution for the entire rule group is due to start, the scheduled execution is skipped.
   Terminate	Terminate a single execution: To stop a running rule, click Terminate in its Actions column. Terminate executions in bulk: To stop multiple running rules, select their checkboxes and click Terminate at the bottom of the list. Note This action is available only when the rule group's last execution status is Pending or Running. Termination applies to the entire rule group. If you terminate a single rule, Dataphin also terminates any other running rules in the same group. When you terminate multiple rules in bulk, the action only applies to rule groups where you have the necessary permissions and the execution status is Pending or Running. The operation is skipped for other selected rule groups. When you terminate a rule group execution, the action does not roll back changes to assets that have already been processed. Verify that the state of your assets meets your expectations.
   View details of last 10 executions	Click More > View Details of Last 10 Executions in the Actions column. The Execution Details dialog box opens, showing execution records from the last 10 runs of the rule. The available information and actions are the same as those for rule groups.
   Clone	Click the Clone icon in the Actions column to quickly create a copy of the rule's configuration.
   Delete rule	Single deletion: Click Delete in the Actions column to delete the rule. Delete rules in bulk: To delete multiple rules, select their checkboxes and click Delete Rule at the bottom of the list. Note Deleting a rule does not affect an execution that is already Running or Pending. The task completes based on the rule's configuration at the time the task started.
   Enable	Enable a single rule: To enable a rule, toggle the switch in the Effective Status column to the on position. Enable rules in bulk: To enable multiple rules, select their checkboxes and click Enable at the bottom of the list.
   Disable	Disable a single rule: Click the switch in the Status column or click Disable at the bottom. Disable rules in bulk: To disable multiple rules, select their checkboxes and click Disable at the bottom of the list. Note After you disable a rule, any Running or Pending executions will continue to run. However, Dataphin skips the rule in all future scheduled executions.