Managing Policy

The Data Portal Module allows users to manage Policies in the OSDU® Data Platform.

User Permissions

To view, evaluate, or translate a policy, the user must have the service.policy.user role in the provided data partition.
To update or add a policy, the user must have the service.policy.admin role in the provided data partition.

List of Policies

The Policies section allows users to view the list of policies available in the EDI Data Platform.
The policies are listed in a table format with the following columns:

• Name: The name of the policy.
• Kind: The kind of policy: instance or partition.

To open the policy details, click on the Name of the policy.

Filter Policies

You can filter the policies by entering the name of the policy in the Search field. The table will be updated to show only the policies that match the filter criteria.

Instance Policies

Instance policies are applied to the entire Data Platform instance. They are used to manage the overall behavior and configuration of the Data Platform. They are read-only and cannot be modified by users.

Policy Details

To view the details of a policy, click on the Name of the policy in the list of policies. A modal window will appear showing the details of the policy. The details include the following information: - Name: The name of the policy. - Kind: The kind of policy: instance or partition. - Data: The policy data in Rego format.
To update or delete a policy, the user must have the service.policy.admin role in the specified data partition.

Update Policy

The user can edit a policy using the Rego language.
After making changes, click the UPDATE POLICY button to save them.
A confirmation dialog will appear asking you to confirm the update.

Delete Policy

To delete a policy, click on the Delete button next to the policy you want to delete. A confirmation dialog will appear asking you to confirm the deletion.

Evaluate Policy

To evaluate a policy, click on the Evaluate button.
A modal window will appear where you can enter the input data for the policy evaluation. The input data should be in JSON format. After entering the input data, click on the Evaluate button to evaluate the policy. The evaluation result will be displayed in the response pane. The result will show whether the policy passed or failed, along with any additional information provided by the policy.

Add New Policy

To add a new policy, click on the Add New Policy button. A modal window will appear where you can enter the details of the new policy.

Fill in the policy name and policy data. The policy uses the Rego language to define the policy rules. More information about Rego language can be found in the Rego documentation.
After entering the details, click on the ADD button to create the new policy. The new policy will be added to the list of policies.
You can only add a new policy if the policy kind is set to Partition. The application automatically sets the policy kind from the policy name.

Update/Add/Delete Policy Delay

Warning

Changing or adding a new policy can take some time to propagate through the system.
If you do not see the changes immediately, please wait for a few minutes and reload the policy list.

Translate Policy

To translate a policy, click on the Translate button next to the policy you want to translate. A pop-up window will appear where you can enter the input data for the policy translation. The input data should be in JSON format. After entering the input data, click on the Translate button to translate the policy. The translation result will be displayed in the response pane. The result will show the translated policy in the desired language, along with any additional information provided by the policy.

If the translation data is not correct, an error message will be displayed in the pop-up window.
The error message will indicate the issue with the input data and provide guidance on how to correct it.