Difference between revisions of "Object Properties"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
Line 82: Line 82:


===Presentation Pages===
===Presentation Pages===
:'''Note:''' This section appears when viewing an object. The options it contains appear when editing the object.  
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.
A Presentation Page gives you full control over the layout a user sees when 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:
You can specify:
:* '''View Record Page''' - The page to use when viewing a record.
:* '''View Record Page''' - The page to use when viewing a record.
:* '''Add Record Page''' -  The page to use when adding a record.
:* '''Add Record Page''' -  The page to use when adding a record.
Line 94: Line 94:
{{Tip|A good naming strategy makes it easier to pick the right page.}}
{{Tip|A good naming strategy makes it easier to pick the right page.}}


Within the JSP page, these parameters can be referenced:
Within the JSP page, these record-parameters can be referenced, using the <tt>param</tt> tag from standard JSTL library:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
<%@ taglib uri="/c" prefix="c" %>
<%@ taglib uri="/c" prefix="c" %>
Line 102: Line 102:
</syntaxhighlight>
</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.
In the JSP page, you can use [[REST API]]s or [[Java API]]s to get data from the platform, and use {{jQuery}} controls or standard [[JavaScript]] forms to display data 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 Information===
:;Description: Summarize the object in a paragraph or less.
:;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.
:;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.

Revision as of 22:10, 19 October 2011

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

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

Working with Object Properties

Lock-tiny.gif

Users that have the Customize Objects permission can edit Fields 

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

Notepad.png

Note:

  • The object ID is only visible when you expand the properties section using the 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 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
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
Web Enabled
  • This option is available only for Custom Objects and Prospects.
  • 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

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

Notepad.png

Note: Permissions settings take precedence over Access Control.

Packaging Options

Allow subscribers to extend data model
When an object is part of a published package, this option lets subscribers add new fields and inherit from this object.

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

Thumbsup.gif

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

This section appears when viewing an object. The options it contains appear when editing the object.

A Presentation Page gives you full control over the layout a user sees when 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.

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.

Thumbsup.gif

Tip: A good naming strategy makes it easier to pick the right page.

Within the JSP page, these record-parameters can be referenced, using the param tag from standard JSTL library:

<%@ taglib uri="/c" prefix="c" %>
${param.objectId}         <!-- The object ID -->
${param.objectName}       <!-- The object name -->
${param.id}               <!-- The Record ID -->

In the JSP page, you can use REST APIs or Java APIs to get data from the platform, and use Template:JQuery controls or standard JavaScript forms to display data 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.