Difference between revisions of "Object Properties"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 33: Line 33:
:;Active:When clicked, this object is active in the system
:;Active:When clicked, this object is active in the system


:;Make this object available as Tab:Checked by Default
:;Available as a Tab:Checked by Default
::*If checked, this object is available as a tab in the UI (User Interface)
::*If checked, this object is available as a tab in the UI (User Interface)
::*If unchecked, this object is hidden
::*If unchecked, this object is hidden
Line 61: Line 61:
::*If checked, ''Soft Delete'' is enabled; Deleted items are placed in the [[Recycle Bin]], and can be [[Recycle_Bin#Restore|Restored]]
::*If checked, ''Soft Delete'' is enabled; Deleted items are placed in the [[Recycle Bin]], and can be [[Recycle_Bin#Restore|Restored]]
::*If unchecked, ''Hard Delete'' is enabled; Deleted items are [[Recycle_Bin#Delete_Forever|Deleted Forever]], and are not moved to the [[Recycle Bin]]
::*If unchecked, ''Hard Delete'' is enabled; Deleted items are [[Recycle_Bin#Delete_Forever|Deleted Forever]], and are not moved to the [[Recycle Bin]]
:;Use Indexing for Faster UI Search: Select from any of the following options:
{{Note|You can set indexing only for the parent objects. The child objects use the same indexing as that of the parent objects. Also, the index type creation is hidden for child objects.}}
::*Btree - This is the regular indexing that is currently available across the application.
::*Full Text - This allows you to index the items within your application and helps you to perform faster search in the existing UI. When using Full Text, ensure to provide the complete word when performing a search.
{{Note|Full Text indexing is available only for users running MySQL version 5.7 or above.}}
::*None - No indexing is performed. A search performed with no indexing results in slower search results. 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.
:;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.

Revision as of 12:07, 9 April 2019

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
Help URL
  • Base URL for the custom help web page which can be specified for an Object)
  • Optional.
Learn more: Help URL
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
Use Indexing for Faster UI Search
Select from any of the following options:

Notepad.png

Note: You can set indexing only for the parent objects. The child objects use the same indexing as that of the parent objects. Also, the index type creation is hidden for child objects.

  • Btree - This is the regular indexing that is currently available across the application.
  • Full Text - This allows you to index the items within your application and helps you to perform faster search in the existing UI. When using Full Text, ensure to provide the complete word when performing a search.

Notepad.png

Note: Full Text indexing is available only for users running MySQL version 5.7 or above.

  • None - No indexing is performed. A search performed with no indexing results in slower search results. 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.

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.