This guide outlines the procedure for managing Custom Field Types within GimCore. Custom Field Types define the fundamental structure and behavior of custom fields that can be added to various entities throughout the system. Administrators can define, modify, and remove these types to ensure data consistency and flexibility.
Accessing Custom Field Type Management
To access the Custom Field Type management screen, navigate to the Project menu in the left navigation pane and select Field Type.
Upon successful navigation, the screen will display a data table listing all existing Custom Field Types configured in the system. This table provides a centralized view of previously defined types and offers options for further management.
Custom Field Type Data Table
The data table serves as the central repository for all Custom Field Types. Each row represents a unique Field Type, and the columns provide key information:
- Name: Displays the unique identifier name for the Custom Field Type.
- Description: Provides a brief explanation or purpose of the Custom Field Type.
- Actions: This column contains inline action buttons for managing individual Custom Field Types.
- Edit (📝 icon): Click this icon to modify the details of an existing Custom Field Type.
- Delete (🗑️ icon): Click this icon to permanently remove a Custom Field Type from the system.
Adding a New Custom Field Type ➕
To create a new Custom Field Type:
- Click the Add New button, typically located in the page header.
- A modal dialog will appear, prompting for the new Custom Field Type's details.
- Enter a unique Name for the Field Type. This name should be descriptive and reflect its intended use.
- Provide a comprehensive Description explaining the purpose and characteristics of this Field Type.
- Click the Create button within the modal to save the new Custom Field Type.
Editing an Existing Custom Field Type ✏️
To modify the details of an existing Custom Field Type:
- Locate the desired Custom Field Type in the data table.
- Click the Edit (📝 icon) in the Actions column corresponding to that Field Type.
- A modal dialog will appear, pre-populated with the current details of the selected Field Type.
- Adjust the Name or Description as required.
- Click the Update button within the modal to save the changes.
Deleting a Custom Field Type 🗑️
To remove a Custom Field Type from the system:
- Locate the Custom Field Type you wish to delete in the data table.
- Click the Delete (🗑️ icon) in the Actions column corresponding to that Field Type.
- A confirmation dialog will appear, asking you to confirm the deletion. This is a critical step, as deletion is permanent.
- Confirm the action to proceed with the deletion. If the Field Type is in use by other system components, a warning or error message may appear, preventing its deletion until dependencies are resolved. Ensure all linked custom fields are removed or reconfigured before deleting a Custom Field Type.