Login
Home CMS Documentation Home Cartella Using Cartella Settings Customization Object Builder Building Custom Objects

Building Custom Objects

Prerequisites: Users require site administrator permissions to complete this task.

To create code (SQL, C#, etc.) that can be integrated with your Cartella site, generate custom objects with the Custom Object Builder tool fields. Use the fields to define your custom object.

Important
The Custom Object Builder only builds the files and scripts needed for creating a new module. A developer must install the module before changes take effect.
To build custom objects:
  1. Log in to Cartella.
  2. Navigate to Settings > Customize > Object Builder.
    Fastpath
    Clicking Customize opens Object Builder by default.
  3. Enter values for the following fields.

    Object Builder View in Settings

    FieldDescription
    LabelLabel of the custom object that displays in the form. The label allows spaces.
    Restriction
    Labels don't allow special characters and cannot use same name as other Cartella objects (e.g., blog post).
    NameProperty name of the custom object.
    IconFilepath to the thumbnail icon that represents the custom object.

    Example: images/img/i1.png

    Note
    The absolute path for the example icon is similar to [Site_Root]\Images\img.
  4. Enter the following fields for each row the Properties table.
    Note
    The first two rows for Name and Description populate by default and cannot be removed. Cartella includes these fields automatically.
    Column FieldDescription
    LabelLabel of the custom object property. The label allows spaces.
    Restriction
    Labels don't allow special characters and cannot use same name as other properties for the object.
    NameName of the custom object property.
    TypeType of content the custom object property contains. Select the type from the drop-down list.
    Note
    The options don't include Link List. However, this option can be configured outside of the Cartella user interface.
    Caution
    Selecting the Drop Down option isn't recommended.
    Additional InfoSub-Type of content the custom object property contains. Select the sub-type from the drop-down list.
    Note
    Additional Info is only available for the following Type values:
    • Drop-down. Click Add Choice to create choice(s) to include in the drop-down property list. Enter a Display name and parameter Name for each choice. Click X remove choices.
    • Asset. Select Image or Document from the drop-down list to identify the type of asset.
    • Asset List. Select Image or Document from the drop-down list to identify the type of assets.
    • Entity. Select an entity type from the drop-down list to identify the type of module content.
    • Entity List. Select an entity type from the drop-down list to identify the type of module content.
    RequiredSelect or clear the checkbox to make the property required or optional.
  5. Optional: Click Add Property to add properties.
    Note
    Click X in a property's table row to remove the property.
  6. Select or clear the Include Module checkbox.
    Important
    Selecting this checkbox includes the module code in the generated object files. In general, select this checkbox. Clear this checkbox only in special cases.
  7. Click Generate to generate the custom object.
    The following message displays: 
    Your files were successfully generated.
    Note
    Navigate to [Site_Root]\App_Data\ObjectBuilder to view custom object files.
    Note
    Click Download to download the custom object zip file.

    Tip
    Use Download only if you don't have access to your server. If you download the files, move the zip file to [Site_Root]\App_Data\ObjectBuilder when you have access to your server.

  8. Click OK.
  9. Configure the custom object to use in Cartella. See Setting Up Generated Custom Objects for details.
 

Related Topics