AgileApps Support Wiki Pre Release

Difference between revisions of "Database Views"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 38: Line 38:


:;Filter by Record Ownership:
:;Filter by Record Ownership:
::For each object use the Checkbox [[File:checkboxicon.gif]] icon to enable filtering by record ownership when creating a [[Report]].<br>(The person running the report then has the option of selecting
::For each object use the Checkbox [[File:checkboxicon.gif]] icon to enable filtering by record ownership when creating a [[Report]].<br>(A report can then be run on all available records, or on records owned by specific users or teams.) 


:;Custom Aliases:
:;Custom Aliases:

Revision as of 23:57, 22 July 2011

Designer > Data > Database Views

A Database View lets you define a complex data model by specifying a join across Related Objects. Fields from the related records in each object are then available when running a Report, providing greatly augmented reporting capability.

Using a Database View

After a Database View has been created, it can be used as the basis for a Report. (It appears in the Categories tab of a Report, along with other Objects and Database Views.)

Using that Database View, a report operates on "records" that result from combining fields from each of the objects specified in the Database View.

Working with Database Views

Lock-tiny.gif

Users that have the Customize Objects permission can create a Database View 
Considerations
  • Database Views can be used to build Reports or Web Tabs
  • Edits to a Database View are only allowed after checking against existing reports
  • Fields can be removed from the Database View for various reasons - an object can be removed and replaced with a new object or a new set of fields can be selected
  • If any fields that are being removed are used in reports based on this Database View, the edits to the Database View will not be allowed; You will have to remove the fields from the affected reports before completing the edit on this Database View

Create or Edit a Database View

To create or edit a Database View:

  1. Click Designer > Data > Database Views
  2. Choose one of the following options:
    • Click the [New Database View] button to create a new Database View
    • Click the name of the Database view to edit
  3. In the Select tab, specify the objects to use in the Database View. (more below)
    Note: At least two objects must be selected.
  4. Click [Next]
  5. In the Joins tab, define the relationship (Joins) between the selected objects. (more below)
  6. Click [Next]
  7. Give the database View a name.
  8. Click [Save]

Select Tab

Start by selecting objects to participate in the view.

Select Objects to Join
Select the desired Objects by moving them to the Selected Objects column).
(You need to select two at a minimum, in order to create a join.)
Filter by Record Ownership
For each object use the Checkbox Checkboxicon.gif icon to enable filtering by record ownership when creating a Report.
(A report can then be run on all available records, or on records owned by specific users or teams.)
Custom Aliases
This section is relevant only to programmers, who may need to reference the alias (name) for an object in a Database View when using one of the platform APIs.
The alias fields are auto-populated with default values, but can be changed as needed to make programming easier:
  • The default alias a System Object is the object name.
    (These aliases rarely need to be changed.)
  • The default alias for a System Object is custom_{numeric_object_ID}
    These aliases are routinely changed to something more readable, when programmers access them using APIs. Otherwise, they can be left alone.)

Joins Tab

Define Relationships (Joins)

Create New Reports Using a Database View

To create a new report using a Database View

  1. Create a Database View that includes the Related Objects of interest
  2. From the application, click the Reports tab.
  3. Click [Add Report]
  4. In the Category tab, choose the Database View
    (Database Views are shown along with the standard single-object report categories.)
  5. The field list for the report includes all fields available in the objects that part of the Database View.
Learn more: Add or Edit a Report

Delete a Database View

To delete a Database View:

  1. Click GearIcon.png > Customization > Database Views
  2. Click the Delete link next to the Database View to delete it

Considerations

  • In order to delete a Database View, you must first delete any report that uses that category; If a Database View is used in any report, and you attempt to delete the Database View, you will get an error message
  • The report(s) must be deleted first, then the Database View can be deleted
  • If a Database View is used in a report and you attempt to delete the Database View, you will get an error message