Object Properties

Designer > Data > Objects > {object} > [Edit]

About Object Properties

If Data Policies and Action buttons are verbs (things you can do with the object), the properties are nouns--attributes of the object, like the color or number of wheels of a vehicle.

When viewing an object, you click the [Edit] button to modify properties. You can also click the section-expand icon (File:Sections-expand.gif) to see that information, and then click the section-collapse icon (File:Sections-collapse.gif) to close it again.

Note: The object ID is only visible when you expand the properties section using the [File:Sections-expand.gif]] icon. (That information is never needed in the GUI, however, and even the APIs work with object names.) Only a subset of the properties are shown when creating an object. To see that subset, visit Object Properties when Adding.

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 32 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

Make this object available as 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
• 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

Help URL (Base URL for the custom help web page which can be specified for an Object)

Optional. The help URL is invoked when the clicks the Learn More link in the Gear menu ().

If this field is empty, the default Help Domain is used, as defined by the Service Provider.

If this field is not empty, and contains a valid URL, it overrides the default help URL for the object. Either an absolute or relative URL can be specified.

The format for an absolute URL is: http://www.examplehelp.com or http://www.examplehelp.com/objectname.

A relative URL does not begin with "http://". That kind of URL is relative to the Help Domain defined by the Service Provider.

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

• If checked, Soft Delete is enabled; Deleted items are placed in the Recycle Bin, and can be Restored
• If unchecked, Hard Delete is enabled; Deleted items are Deleted Forever, and are not moved to the Recycle Bin

Note:

• For objects created in AgileApps Cloud platform V6.2 and earlier, the default value is Soft Delete
• For all new Objects, the default value is Soft Delete

View Configuration

Standard View

Default, allows creation of Views based on the fields present in this object

Database View

Allows creation of Views based on Database Views that contain this object

Note: A Database View can be selected for a View Configuration in (at most) one object

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

Learn more: Role Based Permissions

Custom Access Criteria

Learn more: Custom Access Criteria

Packaging Options

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.

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:

<syntaxhighlight lang="java" enclose="div">

<%@ taglib uri="/c" prefix="c" %> ${param.objectId} ${param.objectName} ${param.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.

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.