Difference between revisions of "Object Properties"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 95: Line 95:
:The dropdown list that accompanies each option lists the available JSP pages.
:The dropdown list that accompanies each option lists the available JSP pages.
:''Learn more:'' [[Pages#Presentation Pages for Record Data|Creating Presentation Pages for Record Data]]
:''Learn more:'' [[Pages#Presentation Pages for Record Data|Creating Presentation Pages for Record Data]]
</blockquote>


====Description Information====
====Description Information====

Revision as of 20:00, 25 June 2013

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

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

Notepad.png

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

About Object Properties

The object Properties page displays object characteristics and it's relationship to other objects.

Object Relationships

In the Cases object, for example, in the Object Relationships section, you see lines that looks like this:

Object Alias Relationship Type ...
Accounts Many to One ...

The way to read that line is "Many (Cases) to One (Account)". Or, in general terms:

"Many (of the current object) to One (of the object on this line)"

Notepad.png

Note: To change an object relationship, click the appropriate entry in that section. (The [Edit] button applies to the properties above. When you click it, you no longer see the relationships.)
Learn more: Object Relationships.

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 (File:Sections-expand.gif) to see that information, and then click the section-collapse icon (File:Sections-collapse.gif) to close it again.

Notepad.png

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 New Object Properties.

Object Properties Settings

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.
  • 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

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

Role Based Permissions

Default Roles

The out-of-the box implementation includes a default role, to get you started.

Role Access Permissions
Manager By default, a manager has full permissions to create and delete records in application objects, and has full access to records owned by other team members.

Learn more: Access to Records Owned by Others Within the Team

Custom Roles

Additional roles can be added and existing roles can be modified as the needs of the organization change. Note that Visibility Controls are an extension of Object Properties, and also affect the data that is available to users.

For example, a Web Tab can be created that is only available to managers.

Roles and Data Visibility

Standard Access Controls

A user's access to data is normally determined by a number of factors, shown here. It is also possible to define custom access criteria, described subsequently.

  • The user's Access Profile specifies global access permissions and administrative permissions.
  • The Application Access settings determine which applications the user can run. The Objects available to the user are therefore the combination of
a. Objects that are part of the running application
b. Objects that are shared from other applications.
  • The user's Role in the application, as specified by the Application Access settings, specifies high-level access rights to individual application objects.
  • The privileges granted in Access Profiles and Roles are additive. If either the Access Profile or the user's Role grants permission to perform some operation on an object, then the user has that permission.
  • By default, Role privileges are additive, as well. If a user has been assigned multiple roles in an application, then the user has the sum of the privileges accorded to those roles.
  • If the Switch User Roles capability is turned on, then the user has the ability to select which role is active, and has the privileges accorded to that role.
  • The Team the user belongs to, and the access to records owned by other team members, as determined by the user's Role.
  • Team Data Sharing Policies, which allow data to be shared across Teams. (These settings override the record-level access permissions specified in the individual's Visibility Controls.)
  • Task-based access allows access to records that may not otherwise be visible:
  • Users who own a Task, or whose team owns the task, can view the record the Task is attached to.
  • If the Task has open ownership, the record the Task is attached to can be viewed by anyone, for as long as the Task is unassigned.
  • When a Process Task specifies that the task is to be closed with an accompanying Form, the user can view and edit record the Task is attached to while they are completing the task.
  • When user lacks permission to view an object, they will be able to view the record in that object by following a link to it (for example, in the task's Related To field). They also see the record when completing the task. But there is no tab for viewing other records in that object, and a search will not reveal it.

Role Permissions

These are the permissions that can be specified for a role:

Record Access Permissions
For each object, specify the ability to Create, and Delete records.
If Record Level Visibility is enabled for an object, specify the ability to Control Visibility.
(In general, the ability to access an object implies the ability to view any of the records it contains. However, if Record Level Visibility is enabled, a role can also specify the ability to set visibility criteria for individual records, in order to restrict visibility of that record to a designated audience.)
Access to Records Owned by Others Within the Team
Specify the ability to Update, Delete, and View records contained in a each object.
(These permissions apply to records owned by a different member of the team.)

Custom Access Controls

Custom Access Criteria can be defined, as well. Those criteria can evaluate field values and apply functions to return true or false for different kinds of actions that can be taken on a record.

For example, records with a salary in excess of a certain amount can be made available to designated roles, only.


User, Team and Role Guidelines

In conjunction with Access Profiles, the combination of Team and Role assignments controls the user's ability to view and access data.

  • Users
  • Users can be members of multiple Teams
  • When users are given access to an application, they are assigned one or more Roles
  • Roles
  • Roles are defined for applications
  • Roles define the types of data users can access and share with other team members
  • Default Roles are available in the platform
  • Additional roles can be created and the default roles can be modified as needed
  • Teams
  • Each user must be assigned to a Primary Team.


Custom Presentation Pages

With this option, custom JSP/Html Pages are used to access object data.

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 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 option lists the available JSP pages.
Learn more: Creating Presentation Pages for Record Data

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.