Objects

From LongJump Support Wiki

Jump to: navigation, search
Objects in the Platform
Objects are the basic building blocks used to collect information in Applications.

Objects often represent entities in the real world and are modeled based on specific delineations needed by the business. For example, if an application for tracking dogs is required, the Dogs object may define the characteristics of each dog. However, if tracking dogs and cats is required, it may be necessary to define the object as Pets. Or if the need is to track dogs, cats, zebras or trees, a Species object may need to be defined.

Compare to System-Generated Objects

Contents

Considerations

  • Objects are represented by Tabs in the user interface
    • Objects typically contain a list of records (like a spreadsheet)
    • Records in Objects can be viewed individually
    • Each record contains data, presented as Fields in a Form Layout
    • Records can also contain lists of records in related objects
  • Objects are things: customers, products, services, invoices, transactions, etc.
  • Web Tabs are types of Objects that extend the platform with these elements: a URL, HTML code, Components, Pages, Widgets or a Database View
  • The Log Activity icon cannot be displayed in a List View
  • Fields associated with the Record Identifier are clickable in System-Generated Objects
  • Clicking the link to an Account Name, Contact Name, or other System-Generated Objects opens the record for viewing
  • By contrast, Objects provide a Details link to open the record for viewing

How Are Objects Used?

The platform provides a framework for building information structures that can be used to house data and extract it for a multitude of purposes. Objects, and the data associated with these objects, are the primary information structures in an application.

Objects provide the ability to collect data and share it with other users (based on their team, user role, and access permissions that are assigned). Data is contained in fields, as a data entry form. Data can be typed directly into fields via a Form Layout, or data can be imported from CSV files.

Once an object is created, its properties, field attributes, print templates, web forms, and other associated options can be modified.

Understanding the Power of Objects

In the platform, objects are the core of any data model, defining the primary information structure. Objects include not only rows and columns of data (like a spreadsheet), objects contain these additional elements that support building nimble business applications in the platform:

Presentation

  • Display custom forms for manual data entry
  • Present data as charts, graphs, tables for display or print
  • Display dashboards: high-level status updates in real-time

Processing

  • Interface to external systems (import/export)
  • Model business policies/rules/processes that match the unique needs of your organization
  • Validate data for improved accuracy
  • Improve staff time management with email notifications and task-based activities via an integrated calendaring system
  • Build data relationships

Administration

  • Define security permissions and access control for users/teams/roles
  • Manage mass data operations
  • Monitor activity and change logs
  • Design data entry forms, views and reports that are personalized to the needs of the users/teams/roles

Development

  • Use the web browser-based IDE to design objects and applications
  • Design fully customized objects and applications with the APIs and Web Services tools
  • Design a UI to coordinate with organizational style guides


Accessing Objects

To Access object properties and layout:

  1. Click Setup | Customize | Objects
  2. The Customize Objects page opens. Make any required changes, then save your changes.

Manage Objects

File:Lock-tiny.gif

Users in Roles with Customize Objects permission rights enabled can can manage Objects 

Add a New Object

  1. Click Setup | Customize | Objects
  2. Click the [New Object] button
  3. In the Object Information Section, complete the following information:
    Object Name
    Used by the system
    Only alphanumeric (a-z A-Z 0-9) and underscore (_) characters are allowed, no spaces
    Must be 20 characters or less
    Display Label (Plural)
    Plural form of the Object Name
    Display Label (Singular)
    Object Name
    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
    Available for Reporting
    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
    Checked by Default
    • If checked, this object is available for use in Searches
    • If unchecked, this object is not available for use in Searches
    Help URL (Base URL for the custom help web page which can be specified for an Object)
    Optional. If this field is empty, the default Help Domain is used (Help Domain is defined in the Basic Service Configuration of Service Provider Settings (or MSP Settings). If this field is not empty, and contains a valid URL, it overrides the default help URL for the object. When creating custom help URLs either Absolute or Relative URLs can be conigured. To create an Absolute custom help URL to the object, create a web page with an absolute URL (format is: http://www.examplehelp.com or http://www.examplehelp.com/objectname) and enter the URL in the Help URL field of the Object. The custom help URL is invoked when the Help icon is clicked. To create Relative custom help URLs, configure the custom help for the object using the Custom Help Domain feature in Service Provider Settings (or MSP Settings).
    Import Object Data from CSV file
    When checked, an option appears to allow a CSV file to be selected; Click the [Choose File] button to select a CSV file to be loaded
  4. In the Notes and Activity Management Section, complete the following information:
    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
  5. In the Inheritance section, complete the following information:
    Parent Object
    Select the parent object; Learn more: Object Inheritance
  6. In the Role Based Access Permissions section, select the Role(s) that will have access to this object
    • The Default Roles are displayed, along with any additional roles created in the platform
    • When checked, users in the specified Roles can access this object
  7. Click the [Next] button to continue
    Add Fields to the Object, or click [Cancel] to stop the action
  8. Click the [Save] button to save your changes, or click [Cancel] to stop the action

Create or Edit Objects

When an Object is created or edited, the following options are available for customization:

Note: System-Generated Objects may not include all of these options

Object Tab Description
PropertiesDefine Object information and set preferences for Email Campaign tracking, Notes and Activities management
Form LayoutsCreate data entry forms (Form Layouts) and set Team/Role access permission
FieldsAdd/Edit/Delete Fields, or set Field Audit Log preferences
ActionsCreate custom actions that can be tied to a Component, Page or JavaScript to execute an operation on a Record or group of Records
Record LocatorsDefine the methods to locate records (define the fields to display in Lookup or Search results, create a unique Record Identifier, or define fields to include in a Search)
IndexesDefine a unique identifier to improve search performance and prevent duplicate record creation
ValidationsPrevents bad data from being entered into the database
Data PoliciesModel your business rules and enable automation of processes around data records
AssignmentsAutomatically assign record ownership and trigger notification via email; Visible only in the Prospect or Cases Objects
Print TemplatesPrint Templates create a mail-merge forms to print a record (as an invoice, receipt, certificate, etc.)
Web FormsCollect information from your company web site, and automatically add it to this object
WorkflowsAutomate business processes (request, approve/deny, escalate, etc.)

Delete an Object

When an object is deleted, the associated Data Tab will not be available in your application. All of the records and Related Information in the object are deleted. Deleting an Object moves all associated records to the Recycle Bin.

To delete an object:

  1. Click Setup | Customize | Objects | <object name>
  2. From the Properties tab, click the [Delete] button
  3. Enter your name and click the [Delete] button to delete this object and all associated records, or click [Cancel] to stop the action
Personal tools
Categories