Create and Manage Custom Object Classes and Properties

Create and Manage Custom Object Classes and Properties

Overview

Custom properties add metadata fields to DocuShare object classes. Custom object classes let a site model a type of content or record that is not represented by the standard classes. Plan the class and property structure before applying changes because an object-class update can affect every object of that class.

Plan the Design

• Identify the object class that should own the property. Use a standard class when it meets the requirement; create a custom class only when a distinct object type is needed.
• Choose unique, descriptive names. Avoid generic property names such as name, title, date, or location, which may conflict with existing properties or behavior.
• Select an appropriate property type and define required values, choices, defaults, and visibility before applying the change.
• Back up the site and schedule broad schema updates during a maintenance window.

Add a Custom Property to an Object Class

1. Open Admin Home > Object Properties.

2. Select the object class to which the property should apply.

3. Select the property type from Add Custom Property, then select Go.

4. Complete the required fields. Use a unique property name and a clear user-facing label.

5. Select Add to add the property to the class definition.

6. Open Object Properties > Update Properties.

7. Review the proposed change and submit it to apply the property to objects of the class.

When adding a Menu property, use a menu item ID rather than its display label for a default value. A required Menu property needs a valid default or a configured choice so users can create objects successfully.

Edit or Delete a Custom Property

1. Open the object class under Admin Home > Object Properties.

2. Select Edit next to the custom property and make the required change, or select Delete to remove it.

3. Open Object Properties > Update Properties.

4. Review the change and submit it.

Editing or deleting a property can update or remove property data across objects of that class. Confirm the impact and backup status before submitting. Only custom properties can be deleted; system properties do not provide a Delete action.

Create a Custom Object Class

Use Admin Home > Object Properties > Custom Objects to create a class when a distinct class is needed. Select an appropriate base class and define its class properties, default properties, and permissions. After creating or modifying a class, use Update Properties to review and apply the change.

Troubleshooting

• If the class or property does not appear where expected, confirm that the schema update was submitted and completed.
• If a property is missing from object creation or editing, review its visibility, required status, object class, and default values.
• If a schema update affects many objects or takes longer than expected, do not repeatedly resubmit it. Review server logs and contact DocuShare Support if the operation fails.