From 9c02cc06b2af056c028c4618bddfd276762a9f8d Mon Sep 17 00:00:00 2001 From: Akanksha Date: Wed, 10 Jul 2024 09:20:03 -0300 Subject: [PATCH] DDST-166: Update readme --- .../modules/dgi_actions_handle_constraints/README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/modules/dgi_actions_handle/modules/dgi_actions_handle_constraints/README.md b/modules/dgi_actions_handle/modules/dgi_actions_handle_constraints/README.md index 2b91a36..8c95b76 100644 --- a/modules/dgi_actions_handle/modules/dgi_actions_handle_constraints/README.md +++ b/modules/dgi_actions_handle/modules/dgi_actions_handle_constraints/README.md @@ -4,6 +4,11 @@ This module is part of the DGI Actions Handle package. It provides functionality to add unique constraints to certain fields of an entity and handles the preservation of these fields during entity save operations. +## Notes + +* This module should only be installed when a field is being used as a suffix field. +* The developer or site administrator should note that this module would make the suffix field always required and unique. + ## Requirements This module requires the following modules/libraries: @@ -37,8 +42,8 @@ Once the configuration is set up, the module will handle the rest. ## Configuration The module uses the `dgi_actions_handle_constraints.settings` configuration, which should be set up with the appropriate constraint settings. -For each field that is used as a suffix or identifier, a new value should be added to the constraint_settings array. An example configuration file which -uses the field_pid as suffix and field_handle as identifier is provided with the module. +For each field that is used as a suffix or identifier, a new value should be added to the constraint_settings array. A default configuration file which +uses the field_pid as suffix and field_handle as identifier is provided with the module. This can be updated with the appropriate field names. ## Troubleshooting/Issues