AgileApps Support Wiki

Difference between revisions of "Object Properties"

From AgileApps Support Wiki
imported>Aeric
 
imported>Aeric
 
(86 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Designer > Data & Presentation > Objects > {object} > [Properties]'''
'''[[File:GearIcon.png]] > Customization > Objects > {object} > [Edit]'''


{{Note|This page lists all object properties--the list that is shown when editing an object. Only a subset of available properties is shown when creating an object. To see that subset, visit [[Object Properties when Adding]].}}
Object properties are attributes of an object, akin to the color or model of a motor vehicle.<br>''See also:'' [[Object Relationships]]


===Object Information===
{{Note|This page shows chosen options only. Click '''[Edit]''' to see the full range of choices.}}
 
===Working with Object Properties===
{{PermissionRef|Customize Objects|edit Fields}}
 
# Go to '''[[File:GearIcon.png]] > Customization > Objects > {object} > [Edit]'''
# Click '''Properties'''
# The first part of the page displays individual properties, in sections.
#* Click '''[Edit]''' below that part of the page to modify them.
# 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
# Click '''[Save]''' when done
 
{{Note|<br>
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
:;Object Name:Used by the system
::Only alphanumeric (<tt>a-z A-Z 0-9</tt>) and underscore (<tt>_</tt>) characters are allowed, no spaces
::Only alphanumeric (<tt>a-z A-Z 0-9</tt>) and underscore (<tt>_</tt>) characters are allowed, no spaces
::Must be 32 characters or less
::Must be 64 characters or less
 
:;Display Label (Plural):Plural form of the Object Name
:;Display Label (Plural):Plural form of the Object Name
:;Display Label (Singular):Object Name
:;Display Label (Singular):Object Name
:;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
:::*Hidden tabs are used to hold information and support related objects
:::*Hidden tabs are used to hold information and support related objects
:::*These tabs are available but not currently being displayed
 
:;Web Enabled:When checked, this object is web enabled, and data can be added to the object, from a [[Web Form]]
:;Web Enabled:
:;Help URL (Base URL for the custom help web page which can be specified for an Object): Optional. {{:Help URL}}
::* This option is available only for {{type|}}s.
::* 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]]
:;Available for Reporting:Optionally, make this object unavailable for [[Reports]]
::Checked by Default
::Checked by Default
::*If checked, this object is available for use in [[Reports]]
::*If checked, this object is available for use in [[Reports]]
::*If unchecked, this object is not 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]]
:;Available for Search:Optionally, make this object unavailable for [[Search]]
::Checked by Default
::Checked by Default
::*If checked, this object is available for use in [[Search]]es
::*If checked, this object is available for use in [[Search]]es
::*If unchecked, this object is not available for use in [[Search]]es
::*If unchecked, this object is not available for use in [[Search]]es
:;Recycle Deleted Records:Define how deleted items are discarded from [[Objects]]
:;Recycle Deleted Records:Define how deleted items are discarded from [[Objects]]
::Checkbox, checked by default
::Checkbox, checked by default
::*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]]
:::Note:
:::*For objects created in {{enterprisebrand}} V6.2 and earlier, the default value is ''Soft Delete''
:::*For all new [[Objects]], the default value is ''Soft Delete''


===View Configuration===
:;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:
:;Standard View:Default, allows creation of [[Views]] based on the fields present in this object
::*Btree - Use a balanced search tree index.
:;Database View:Allows creation of [[Views]] based on [[Database View]]s that contain this object
::*Full Text - Use a full-text search index. This performs faster searches than Btree indexing.
::Note: A Database View can be selected for a ''View Configuration'' in (at most) one object
{{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 <tt>innodb_ft_min_token_size</tt> parameter in the MySQL database configuration file <tt>my.ini</tt>. For example, <tt>innodb_ft_min_token_size=2</tt>.
::::*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.


===Permissions===
:;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>.
{{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<br/>'''Note:''' ''For any action that is disabled, the related action buttons are hidden in the UI, and access via APIs is also disabled.''
:*Enabled by default, these options determine if the specified action is available for the object<br/>'''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
:*To disable an action, uncheck the checkbox
Line 47: Line 81:
::*Delete: Delete records from the object, enabled by default
::*Delete: Delete records from the object, enabled by default


===Access Control===
====Access Control====
:;Role Based Permissions:''Learn more: [[Role Based Permissions]]''
:* '''Role Based Permissions -'''
:;Custom Access Criteria:''Learn more: [[Custom Access Criteria]]''
:: 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]]


===Packaging Options===
====Description Information====
:;Allow subscribers to extend data model: When an object is part of a published package, this option lets subscribers add fields and data policies to the object.
:;Description: Summarize the object in a paragraph or less.
 
===Email Campaign Tracking===
To enable Email Campaign Tracking, complete the following information:
::If the records in this object are targeted for an email campaign, specify the fields that will contain email address and other related fields
::;Email Field:Field that will contain the email address
::;Do Not Mass Email Field:Field that will contain the ''Do Not Mass Email'' flag
::;Hard Email Bounce Count Field: Field that will contain the ''number of Hard Bounce'' email messages
::;Soft Email Bounce Count Field:Field that will contain the ''number of Soft Bounce'' email messages
:''Note: If an object is not enabled for email campaigns, the fields in that object are not available in [[Template Variables]]''
 
===Notes and Activities Management===
:;Track Notes and Attachments:When selected, this object will track [[Notes and Attachments]] in the [[Related Information]] section.
:;Track Activities:When selected, this object will track Activities in the related information section
 
{{Tip|If an object is not Active or Web Enabled, or if you did not select the options to Track Notes, Attachments, and Activities, you can do so at any time. This feature lets you publish an application to the web, add notes, attachments, tasks, and appointments, log calls, send email, and perform other actions related to object records.}}
 
===Presentation Pages===
:'''Note:''' This section appears when viewing an object. The options it contains appear when editing the object.
 
Presentation pages give you full control over the layout of a page that a user sees when they are adding, updating, or deleting a record. You can define a different JSP [[Pages|Page] for each purpose, and use any layout controls you like in the page.
 
With this feature, you can specify:
:* '''View Record Page''' - The page to use when viewing a record.
:* '''Add Record Page''' -  The page to use when adding a record.
:* '''Update Record Page''' -  The page to use when updating a record.
 
The dropdown list that accompanies each of those choices lists the available JSP pages.
{{Tip|A good naming strategy makes it easier to pick the right page.}}


Within the JSP page, these parameters can be referenced:
<noinclude>
:<syntaxhighlight lang="java" enclose="div">
<%@ taglib uri="/c" prefix="c" %>
${param.objectId}        <!-- The object ID -->
${param.objectName}      <!-- The object name -->
${param.id}              <!-- The Record ID -->
</syntaxhighlight>


In the JSP page, you can use REST APIs or Java APIs to get data from the platform, and use jQuery controls or standard JavaScript forms to display it to the user. The user's data can then be sent to classes defined in the platform, or data can be modified directly using REST APIs or explicit Java calls.
[[Category:Object Aspects]]
 
</noinclude>
===Description Information===
:;Description: Summarize the object in a paragraph or less.
:;Extended Meta Data: An area that can be used to include any additional class-specific data that an application may need. Examples include keywords and HTML code to use when displaying data.

Latest revision as of 12:05, 24 January 2020

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.
Retrieved from "https://agileappscloud.info/aawiki-src/index.php?title=Object_Properties&oldid=7344"