AgileApps Support Wiki Pre Release

Object Properties

From AgileApps Support Wiki
Revision as of 12:05, 24 January 2020 by imported>Aeric
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

GearIcon.png > Customization > Objects > {object} > [Edit]

Object properties are attributes of an object, akin to the color or model of a motor vehicle.
See also: Object Relationships

Notepad.png

Note: This page shows chosen options only. Click [Edit] to see the full range of choices.

Working with Object Properties

Lock-tiny.gif

Users that have the Customize Objects permission can edit Fields. 
  1. Go to GearIcon.png > Customization > Objects > {object} > [Edit]
  2. Click Properties
  3. The first part of the page displays individual properties, in sections.
    • Click [Edit] below that part of the page to modify them.
  4. The Related Information section at the end of the page displays Child Objects and Object Relationships
    • Click [New Child Object] or select an object to modify it
    • Click on an object relationship to modify that relationship
  5. Click [Save] when done

Notepad.png

Note:
Only a subset of the properties are shown when creating an object. To see that subset, visit New Object Properties.

Editable Properties

Click the [Edit] button at the end of these sections to make changes.

Object Information

Object Name
Used by the system
Only alphanumeric (a-z A-Z 0-9) and underscore (_) characters are allowed, no spaces
Must be 64 characters or less
Display Label (Plural)
Plural form of the Object Name
Display Label (Singular)
Object Name
Active
When clicked, this object is active in the system
Available as a Tab
Checked by Default
  • If checked, this object is available as a tab in the UI (User Interface)
  • If unchecked, this object is hidden
  • Hidden tabs are used to hold information and support related objects
Web Enabled
  • This option is available only for Custom Objects.
  • When checked, this object is web enabled, and data can be added to the object, from a Web Form
Available for Reporting
Optionally, make this object unavailable for Reports
Checked by Default
  • If checked, this object is available for use in Reports
  • If unchecked, this object is not available for use in Reports
Available for Search
Optionally, make this object unavailable for Search
Checked by Default
  • If checked, this object is available for use in Searches
  • If unchecked, this object is not available for use in Searches
Recycle Deleted Records
Define how deleted items are discarded from Objects
Checkbox, checked by default
Make ui search faster with index
To perform faster searches using the UI search box in AgileApps user interface, use indexing. You can enable indexing only for the parent objects. The child objects inherit the indexing setting of the parent objects. Therefore, you do not see indexing options for child objects. Select an indexing option:
  • Btree - Use a balanced search tree index.
  • Full Text - Use a full-text search index. This performs faster searches than Btree indexing.

Notepad.png

Note: Full-text indexing is available only with MySQL version 5.7 or above.

  • If you use full-text indexing, provide the entire word when you perform a search.
  • Full-text index includes words that are at least 3 characters. You can change this value by adding innodb_ft_min_token_size parameter in the MySQL database configuration file my.ini. For example, innodb_ft_min_token_size=2.
  • The NDB cluster does not support full-text indexing.
  • Only those fields that are selected in the Record Identifier Fields for an object using the Record Locator support full-text indexing.
  • Full-text indexing requires extra space for storing the index.
  • None - The system does not perform indexing. This is the default selection.
CMIS Document Type
Type the name for the custom document type. You can add a custom document type at the tenant level as a fallback option. If you use Alfresco as your external document storage system, then append D: to the custom document type. For example, D:<custom_document_type_name>.

Notepad.png

Note: This option is available only when you enable the CMIS Configuration by going to Settings > Administrator > Account Management > External Document Storage

.

Permissions

  • Enabled by default, these options determine if the specified action is available for the object
    Note: For any action that is disabled, the related action buttons are hidden in the UI, and access via APIs is also disabled.
  • To disable an action, uncheck the checkbox
  • These selections work with Custom Access Criteria options in the Access Control section
  • Add: Add records to the object, enabled by default
  • Retrieve: Access records individually or via Views/Reports, enabled by default
  • Update: Update records in the object, enabled by default
  • Delete: Delete records from the object, enabled by default

Access Control

  • Role Based Permissions -
With this option, Roles and teams determine record access.
Learn more: Role Based Permissions
  • Custom Access Criteria -
With this option, you specify the conditions that must be met to allow different kinds of access.
Learn more: Custom Access Criteria

Description Information

Description
Summarize the object in a paragraph or less.