-
Notifications
You must be signed in to change notification settings - Fork 5
Arrange user guide->administration docs and created new custom fields guide #69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
gonzalesedwin1123
merged 5 commits into
refactor-structure
from
various-fixes-in-docs-edwin
Aug 29, 2025
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a46f43b
Arrange user guide->administration docs and created new custom fields…
gonzalesedwin1123 ca7096e
Merge branch 'refactor-structure' into various-fixes-in-docs-edwin
gonzalesedwin1123 a6f21a5
Fix based on the gemini review
gonzalesedwin1123 7cc0345
Fix based on the gemini review
gonzalesedwin1123 f4a5fde
Fix based on the gemini review
gonzalesedwin1123 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| review-status: needs-review | ||
| review-date: 2025-08-29 | ||
| reviewer: migration-script | ||
| migration-notes: "Added during 2025 documentation reorganization" | ||
| --- | ||
|
|
||
| # Custom Fields | ||
|
|
||
| Custom fields are a powerful feature in OpenSPP that allow administrators to add new data fields to registrant profiles without requiring developer intervention. They can be used to capture additional information that is specific to a program's needs, such as a secondary contact number, a disability status, or any other piece of data not included in the standard OpenSPP setup. | ||
|
|
||
| This guide provides step-by-step instructions on how to create a simple custom field using the **Custom Fields UI**. We will create a field to store a "Secondary Phone Number" for an individual. | ||
|
|
||
| ```{note} | ||
| The Custom Fields UI is designed for creating straightforward, user-defined fields for direct data entry. For fields that require automatic calculation or complex logic, see the {doc}`indicator_fields` guide. | ||
| ``` | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| To create and manage custom fields, you need: | ||
| - A user account with the **System Admin** role. For more details, see the {doc}`user_access` guide. | ||
| - The **OpenSPP Custom Fields** (`spp_custom_field`) and **OpenSPP Custom Fields UI** (`spp_custom_fields_ui`) modules must be installed and activated in your OpenSPP instance. | ||
|
|
||
| ## Objective | ||
|
|
||
| After completing this tutorial, you will understand how to create, configure, and verify a custom field in OpenSPP. | ||
|
|
||
| ## Process | ||
|
|
||
| The process involves navigating to the Custom Fields menu, defining the properties of the new field, and verifying its presence on the individual records. | ||
|
|
||
| ### Navigate to Custom Fields | ||
|
|
||
| First, access the Custom Fields management interface. | ||
| 1. Click on the menu icon in the top-left corner and select **Registry**. | ||
| 2. In **Registry**, click the **Configuration** menu. | ||
| 3. Click on the **Custom Fields** sub-menu. | ||
|
|
||
|  | ||
|
|
||
| ### Create a New Field | ||
|
|
||
| On the **Custom Fields** page, you will see a list of existing custom fields. | ||
| 1. Click the **New** button to start creating a new custom field. | ||
|
|
||
|  | ||
|
|
||
| The **Custom Fields** form view will appear. | ||
|
|
||
|  | ||
|
|
||
| ### Configure Basic Properties | ||
|
|
||
| Now, define the basic characteristics of your new custom field. For this example, we are adding a secondary phone number field for individuals. | ||
|
|
||
| - **Field Draft Name**: Enter a technical name for the field, such as `secondary_phone`. This name should be unique and follow standard naming conventions (lowercase with underscores). | ||
| - **Field Label**: Provide a user-friendly label, like `Secondary Phone Number`. This is what users will see on the interface. | ||
| - **Field Type**: Select `Char`, as a phone number is best stored as a text string. | ||
| - **Target Type**: Choose `Individual`, because the field will be added to each individual's record. | ||
| - **Field Category**: Select `Custom`. This designates the field as a standard data entry field. | ||
| - **Field Help**: Specify a text that will appear as a tooltip or description for the field, for example, "Enter an alternative phone number for the individual." | ||
|
|
||
|  | ||
|
|
||
| ### Configure Properties (Optional) | ||
|
|
||
| Since this is a standard custom field, you do not need to provide computation logic. However, you can configure its behavior in the **Properties** tab. | ||
|
|
||
| - **Required**: Check this box if you want to make this field mandatory for all records. | ||
| - **Readonly**: Check this box to prevent users from editing the field's value through the user interface. | ||
| - **Index**: Check this box to create a database index on this field. This can improve performance for filtering and searching on large datasets. This option should typically be managed by a developer or system administrator. | ||
| - **Copied**: Determines if the value of this field is copied when a record is duplicated. | ||
|
|
||
| For our example, we will leave these options unchecked. | ||
|
|
||
|  | ||
|
|
||
| ### Save and Open an Individual Record | ||
|
|
||
| Once all properties are configured, save the new field. | ||
|
|
||
| 1. Click the **Save** button. OpenSPP will create the new field in the database. | ||
| 2. Navigate to the **Registry** and click the **Individuals** menu. | ||
|
|
||
|  | ||
|
|
||
| ### Verify the Custom Field | ||
|
|
||
| 1. To verify that the field was created, open any record in the **Individuals** list view. | ||
|
|
||
|  | ||
|
|
||
| 2. A new tab named **Additional Details** will appear on the form. Click on it. | ||
|
|
||
| 3. You should see your new "Secondary Phone Number" field, ready for data entry. | ||
|
|
||
|  | ||
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added
BIN
+87.8 KB
docs/user_guide/administration/custom_fields/step03_set_type_custom.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+85.8 KB
docs/user_guide/administration/custom_fields/step04_specify_advanced_props.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+144 KB
docs/user_guide/administration/custom_fields/step05_open_individual_list_view.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+106 KB
docs/user_guide/administration/custom_fields/step06_select_individual.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+113 KB
.../user_guide/administration/custom_fields/step06a_check_additional_field_tab.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+48.5 KB
...er_guide/administration/indicator_fields/step01_configuration_custom_fields.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+85 KB
...de/administration/indicator_fields/step02_click_new_custom_fields_list_view.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+115 KB
.../user_guide/administration/indicator_fields/step02a_custom_fields_form_view.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.