Data Objects
- Last updated
- Oct 23, 2022
- Save as PDF
- AdaptiveWork Release Notes
- 2025 Release Notes
- 2024 Release Notes
- 2024.R12 (December 8, 2024)
- 2024.R11 (November 1, 2024)
- 2024.R10 (September 24, 2024)
- 2024.R09 (August 18, 2024)
- 2024.R08 (July 21, 2024)
- 2024.R07 (June 9, 2024)
- 2024.R06 (May 19, 2024)
- 2024.R05 (April 14, 2024)
- 2024.R04 (March 31, 2024)
- 2024.R03 (March 3, 2024)
- 2024.R02 (January 21, 2024)
- 2024.R01 (January 7, 2024)
- 2023 Release Notes
- 2023.R15 (December 10, 2023)
- 2023.R14 (November 19, 2023)
- 2023.R13 (October 29 2023)
- 2023.R12 (October 8, 2023)
- 2023.R11 (September 10, 2023)
- 2023.R10 (July 30, 2023)
- 2023.R09 (July 9, 2023)
- 2023.R08 (June 11, 2023)
- 2023.R07 (May 23, 2023)
- 2023.R06 (April 23, 2023)
- 2023.R04 (March 19, 2023)
- 2023.R03 (February 19, 2023)
- 2022 Release Notes
- 2021 Release Notes
- Fall 2021 (October 3, 2021)
- Summer 2021 (July 25, 2021)
- Spring 2021 Update 4 (July 4, 2021)
- Spring 2021 Update 3 (June 13, 2021)
- Spring 2021 Update 2 (May 23, 2021)
- Spring 2021 Update 1 (April 25, 2021)
- Spring 2021 (April 4, 2021)
- Winter 2021 Update 3 (March 7, 2021)
- Winter 2021 Update 2 (February 14, 2021)
- Winter 2021 Update 1 (January 24, 2021)
- Winter 2021 (January 3, 2021)
- Clarizen 2021 Fall Product Release Webinar
- Clarizen 2021 Summer Product Release Webinar
- 2020 Release Notes
- Fall 2020 Update 3 (December 6, 2020)
- Fall 2020 Update 2 (November 15, 2020)
- Fall 2020 Update 1 (October 25, 2020)
- Fall 2020 (October 4, 2020)
- Summer 2020 Update 3 (September 6, 2020)
- Summer 2020 Update 2 (August 16, 2020)
- Summer 2020 Update 1 (July 5, 2020)
- Spring 2020 Update 4 (June 14, 2020)
- Spring 2020 Update 3 (May 24, 2020)
- Spring 2020 Update 2 (May 3, 2020)
- Spring 2020 Update 1 (April 5, 2020)
- Winter 2020 Update 3 (March 8, 2020)
- Winter 2020 Update 2 (February 16, 2020)
- Winter 2020 Update 1 (January 5, 2020)
- 2019 Release Notes
- Fall 2019 Update 3 (December 15, 2019)
- Fall 2019 Update 2 (November 24, 2019)
- Fall 2019 Update 1 (October 15, 2019)
- Summer 2019 Update 3 (September 15, 2019)
- Summer 2019 Update 2 (August 18, 2019)
- Summer 2019 Update 1 (July 7, 2019)
- Spring 2019 Update 5 (June 16, 2019)
- Spring 2019 Update 4 (June 2, 2019)
- Spring 2019 Update 3 (May 12, 2019)
- Spring 2019 Update 2 (April 21, 2019)
- Spring 2019 Update 1 (March 31, 2019)
- Winter 2019 Update 4 (March 10, 2019)
- Winter 2019 Update 3 (February 17, 2019)
- Winter 2019 Update 2 (January 27, 2019)
- Winter 2019 Update 1 (January 6, 2019)
- Release Notes Archive
- 2018 Release Notes
- Fall 2018 Update 1 (October 14, 2018)
- Fall 2018 Update 2 (November 4, 2018)
- Fall 2018 Update 3 (November 25, 2018)
- Spring 2018 Update 1 (April 29, 2018)
- Spring 2018 Update 2 (May 20, 2018)
- Spring 2018 Update 3 (June 10, 2018)
- Summer 2018 Update 1 (July 1, 2018)
- Summer 2018 Update 2 (July 22, 2018)
- Summer 2018 Update 3 (August 12, 2018)
- Summer 2018 Update 4 (September 2, 2018)
- Winter 2018 Update 1 (January 7, 2018)
- Winter 2018 Update 2 (January 28, 2018)
- Winter 2018 Update 3 (February 18, 2018)
- Winter 2018 Update 4 (March 11, 2018)
- Winter 2018 Update 5 (April 8, 2018)
- 2017 Release Notes
- Fall 2017 Update 1 (October 29, 2017)
- Fall 2017 Update 2 (November 12, 2017)
- Fall 2017 Update 3 (December 3, 2017)
- Fall 2017 Update 4 (December 17, 2017)
- Spring 2017 Update 2 (April 23, 2017)
- Spring 2017 Update 3 (May 14, 2017)
- Spring 2017 Update 4 (June 4, 2017)
- Spring 2017 Update 5 (June 18, 2017)
- Spring 2017 Update 6 (July 2, 2017)
- Summer 2017 Update 1 (July 16, 2017)
- Summer 2017 Update 2 (July 30, 2017)
- Summer 2017 Update 3 (August 20, 2017)
- Summer 2017 Update 4 (September 10, 2017)
- Summer 2017 Update 5 (October 1, 2017)
- Winter 2017 Update 1 (January 8, 2017)
- Winter 2017 Update 2 (January 22, 2017)
- Winter 2017 Update 3 (February 5, 2017)
- Winter 2017 Update 4 (February 19, 2017)
- Winter 2017 Update 5 (March 5, 2017)
- 2016 Release Notes
- Fall 2016 Update 19 (September 4, 2016)
- Fall 2016 Update 20 (September 18, 2016)
- Fall 2016 Update 21 (October 5, 2016)
- Fall 2016 Update 22 (October 30, 2016)
- Fall 2016 Update 23 (November 13, 2016)
- Fall 2016 Update 24 (November 27, 2016)
- Spring 2016 Update 10 (April 17, 2016)
- Spring 2016 Update 11 (May 8, 2016)
- Spring 2016 Update 12 (May 22, 2016)
- Spring 2016 Update 13 (June 5, 2016)
- Spring 2016 Update 14
- Spring 2016 Update 7 (March 13, 2016)
- Spring 2016 Update 8 (March 20, 2016)
- Spring 2016 Update 9 (April 3, 2016)
- Summer 2016 Update 15 (July 3, 2016)
- Summer 2016 Update 16 (July 17, 2016)
- Summer 2016 Update 17 (July 31, 2016)
- Summer 2016 Update 18 (August 14, 2016)
- Winter 2016 Update 1 (December 20, 2015)
- Winter 2016 Update 25 (December 11, 2016)
- Winter 2016 Update 2 (December 27, 2015)
- Winter 2016 Update 3 (January 17, 2016)
- Winter 2016 Update 4 (January 24, 2016)
- Winter 2016 Update 5 (February 8, 2016)
- 2015 Release Notes
- FA'15 Update 2 (September 15)
- FA'15 Update 3 (October 11)
- FA'15 Update 4 (October 25)
- Fall 2015 Update 5 (November 8, 2015)
- Fall 2015 Update 6 (November 22, 2015)
- WINTER 2015-2016 RELEASE: WHAT'S NEW
- Data Warehouse Export
- Document Publisher Support for PowerPoint with Macros
- External Collaborator Solution
- Interactive and Actionable Calendar View
- Obsolete System Property
- Quick Tasks and Action Items Import App
- Real-Time Updates for Multiple Editors
- Release at a Glance
- Report Enhancements
- The Activity Stream App
- Watch the Winter '15 '16 Product Webinar
- Notices
- Summary of AdaptiveWork Updates and Releases
- 2024.R03 (March 3, 2024) - restricted
- 2018 Release Notes
- Getting Started with AdaptiveWork
- Users and Resources
- Permissions
- Intro to User Types, Roles, and Permissions
- User Types
- Cases Inherit from Work Items
- Roles
- Extended Permissions for External Users in User Groups
- Financial Permissions for External Users
- Multiple Managers for Projects and Work Items
- Organization Permissions
- Permission Access Levels
- Permission Access Levels - from Project Template
- Restricted Field Sets
- Work Breakdown Structure (WBS)
- Adding Dependencies
- Advanced Export Work Plan
- Baseline Work and Costs are Saved on the Resource Link
- Export to and Import from Excel - Picklists
- Importing and Exporting to MS Project
- Importing and Updating Data Using MS Excel
- Interactive Gantt
- Lifecycle States
- Milestones
- My Work
- Portfolios
- Programs
- "Progress Update Request" Project Settings
- Projects
- Project Version Snapshots
- Reporting Progress
- Scheduling and Resource Conflicts
- Scheduling Work Items
- Shortcuts
- Subscribing to iCal
- Tasks
- Templates
- The Roadmap
- Understanding Work Policy Logic
- Working with Calendars
- Work Items Overview
- Work Item Module
- Work Plan 2.0
- Capacity Planning and Resource Management
- Financials
- Timesheets
- Timesheets Overview
- Timesheet Module
- Adding New Time Entries
- Timesheet Approvals
- Time Management - Best Practices
- Actuals Recognition Date
- AdaptiveWork Bot for Slack - Scheduling Options for Team Timesheet Reports
- Missing Timesheet Days API
- Pending Time
- Restorable Timesheets
- Setting Reportable Work Items
- Stopwatch
- Timesheet Reporting Enhancements
- Using AdaptiveWork Bot for Timesheet Management
- Strategic Planning
- More on AW modules
- Global Settings
- Email Notifications
- Enabling Global Setting 8.10
- Role-Based Financial Permissions
- Settings
- 'Manual' Progress Update Emails Setting for Projects
- Blocking File Types
- Change History
- Changing color of the icons in the navigation bar
- Configuring a Fiscal Calendar
- Contextual Menu for Work Plan
- Disable File Downloads in Profiles
- Dynamic Property Cards for Customer and Custom Object Entities
- Dynamic Property Card Layouts - Enhancements and General Availability
- Extensions
- Global Settings
- Instance Cloning
- InterAct Settings
- Layouts
- Packaging configurations and components for migration or backup
- Process Monitor
- Profiles
- Recycle Bin
- Settings Overview
- Subject Email Line
- System Settings
- Welcome to Modern Theme
- Whitelisting external IP addresses
- Setting Up Financial Planning (Admins)
- Configurations
- Configurations Overview
- Advanced Configuration Options
- Associate specific Case sub-items (i.e. requests, issues, risks, and bugs) as related items in discussion groups
- Business Rules
- Calculate Project Financials - A New Action for Custom Actions and Scheduled Workflow Rules
- Changes to Resource-related Relations/References in Configurations
- Configuration Best Practices
- Configuration Quotas
- Custom Actions
- Custom Fields
- Custom Objects
- Custom Objects - Icon Library
- Custom Objects - New Get Object By External ID Function for Referencing Custom Objects by External ID
- Custom Object Links Inherit Permissions from Related Items
- Custom Pages
- Custom Panels
- Data Model
- Dependent picklists
- Excel Import for Data Objects
- Field Types
- Filtered Lookups for Custom Action Forms
- Formula Editor
- Matching Current User Fields in Filtered Lookup Filters
- Migrate & Deploy
- Multiple Rules for Lookup Filters, and field selection from Source, Target or User
- New Logical Formula Function for Comparing Duration and Currency Fields with Zero (0) or Null Values
- Overview Field - workflow & configuration support
- Permanently deleting related items when object's state changes
- Predefined Lookup Rules in Reference to Object Fields
- Relabel, Edit Descriptions and Tooltips of Standard Fields
- Relations Summary in Custom Field Data Type Description
- Rich Text custom fields
- Set or Update Time-phase Financial Data using Workflow Rules
- Support for Followers on Custom Objects
- Support for Variables in Outbound Call URLs for Workflow Rules and Custom Actions
- Text Field Enhancements
- Time Phase Custom Field Support
- Time Phase Data Configuration Support
- Reporting
- Currency Fields in Exported Excel Reports are now Currency Fields
- Currency Summary in View Mode (Multi-Currency)
- Financial Planning Report Examples
- Reporting Best Practices
- Reports, Functions, and Relation Tables
- AdaptiveWork Functions
- Common Functions
- Catch Function
- GetCustomActionUrl Function
- GetCustomPanelUrl Function
- GetDocumentFileName Function
- GetFileURL Function
- GetHiddenRuntimeParameter Function
- GetHyperLink Function
- GetModuleViewUrl Function
- GetNextCounterValue Function
- GetObjectUrl Function
- GetObjectViewUrl Function
- GetPreviousValue Function
- GetReportUrl Function
- GetRuntimeParameter Function
- GetSessionId Function
- GetSystemSetting Function
- GetWidgetHyperLinkWithPassword Function
- GetWidgetHyperLink Function
- HyperLink Function
- IsCustomActionAvailable Function
- IsIPAddressInRange Function
- NumberOfAvailableLicenses Function
- ParseHyperLink Function
- PermissionsRole Function
- Convert Functions
- Currency Functions
- Date Functions
- DateAddCalendarFixedPeriod Function
- DateAdd Function
- DateDiff Function
- DateSubtract Function
- DateTimeValue Function
- DateTime Function
- DateValue Function
- Date Function
- Days Function
- Day Function
- GetAssignedWorkingTime Function
- GetEndWorkday Function
- GetEstimatedDueDate Function
- GetStartOfFinancialPeriod Function
- GetStartWorkday Function
- GetSumOfTimesheetReportHoursForFixedPeriod Function
- GetSumOfTimesheetReportHoursForGivenPeriod Function
- GetTimeZone Function
- GetWorkingTimeForFixedPeriod Function
- GetWorkingTimeForGivenPeriod Function
- Hours Function
- IsResourceAvailableForFixedPeriod Function
- IsResourceAvailableForGivenPeriod Function
- Minutes Function
- Months Function
- Month Function
- Now Function
- OrganizationNow Function
- Seconds Function
- Today Function
- ToOrganizationalDateTime Function
- ToTimeZone Function
- Weeks Function
- Week Function
- Years Function
- Year Function
- Financial Planning Functions
- Logical Functions
- Case Function
- Contains Function
- HasOverloadedResources Function
- HasPotentialActualWork Function
- HasRole Function
- If Function
- In Function
- IsChanged Function
- IsChangeType Function
- IsEditable Function
- IsEmptyOrZero
- IsFinancial Function
- IsFollower Function
- IsFromTemplate Function
- IsLeaf Function
- IsManuallySet Function
- IsMemberOfGroup Function
- IsMemberOfProfile Function
- IsMemberOf Function
- IsNew Function
- IsNull Function
- IsTeamMember Function
- IsTriggeredBy Function
- Not Function
- Math Functions
- ObjectReference Functions
- Pickup Functions
- Resource Utilization Functions
- Text Functions
- Common Functions
- AdaptiveWork Relations
- AdaptiveWork Reports
- Functions for Task Assignment
- New Functions for Currency Type, Billing and Cost Rates
- New Standard Fiscal Year Summary Fields for Budgeted Cost / Expected Revenue
- AdaptiveWork Functions
- Reports & Dashboards
- Additional Resource Utilization Reports
- Bubble and Scatter Charts - Overlap Detections
- Creating and Using Reports
- Creating a Dashboard
- Crosstab Report Date Range Available in View Mode
- Cumulative Time-Series Line Charts
- Enhancement: Hiding Grand Totals in Crosstab Tables
- Enhancements: Dashboard filters in shared widgets, revert option
- Enhancements: Freeze Columns in Crosstabs, Disable Tables
- Enhancements: Grouping in Tables, Leading Columns in Crosstabs and more
- Enhancements for Bar and Horizontal Charts
- Export Reports with Split Duration Fields and Converted Unit Type
- Filters in Dashboards
- Financial Resources Data in Reports
- Formula-based Totals in Report Tables
- Getting Started with Reports
- Mixed Charts
- Multi-Currency Support in Reports
- Notice: Changes to Aggregating Capacity Time Phased Data In Reports
- Reports and Dashboards Overview
- Report Enhancements for Formula Columns
- Show Login History in Reports
- Standard Reports List
- Support for sorting by reference to object fields in charts
- System Performance Report
- Time-phased Resource Utilization and Financial Reports
- Use Financial Time Frames in Resource Utilization Reports
- Using Capacity Time-Phased Data in Reports
- Utilization Time-phased Fields
- Timephase Financial Data in Reports & Dashboards
- Using the Resource Utilization Report
- Hybrid Work
- Integrations
- Add-ins/Apps
- Action Items and Tasks Import App
- Data Loader
- Document Publisher
- Excel Add-in
- Portal Page
- Slide Publisher
- 01. Slide Publisher Introduction
- 02. Installing Slide Publisher
- 03. SSO for Slide Publisher
- 04. Building the Presentation
- 05. Program and Customer-centric Presentations
- 06. Enhanced Support for Portfolios and Runtime Filters on Current Customers
- 07. Report Filter Enhancements and Support for Shortcuts
- 08. Meeting Notes, Action Items, and Decisions in Slide Publisher
- 09. Uploading, Publishing, and Scheduling
- 10. Enhanced Scheduling Options
- zzz Archive Color Format in your Slide Publisher
- Extensions
- File Management
- Box Integration
- Google Files
- SharePoint Integration
- Create Folders in SharePoint and Link to AdaptiveWork Work Items
- Define Default SharePoint Folder for Programs and Projects
- SharePoint - Default Integration Path for Cases, Related Files in Discussions Inherit the Default Integration Path
- SharePoint - Default Integration Path for Related Files
- SharePoint Bi-directional folder sync.
- SharePoint Online - Creating a New Folder from a Template Folder
- SharePoint Online - Managing Content
- SharePoint Online - Setting Up the Integration
- SharePoint Site Collection Paths per Customer
- SharePoint Support for Site Collections as Default Paths, Uploading Files via Customizations
- Support for Multi-User Access to SharePoint via a Single Organization Account
- SSO and User Provisioning
- Active Directory User Sync v2
- Authentication With Identity Providers (SSO)
- Automatic Allocation of Requestor Licenses to New or Suspended Users via SSO Login
- Cloud-Based User Provisioning with Microsoft Azure Active Directory
- Cloud-Based User Provisioning with OKTA
- Cloud-Based User Provisioning with OneLogin
- User Provisioning with On-Premise Active Directory
- Add-ins/Apps
- AdaptiveWork Mobile
- API
- Add and Remove Calendar Exceptions via Web Service API
- API Extraction of Deleted Time-phased Data
- API Keys Support
- API support for Project Assignment
- Overview field support in API - Predictable external ID
- REST API Guide Version 2
- Support for Number of Customers in API
- Upsert Feature in API
- Web Service API Guide Version 2
- AdaptiveWork Videos
- Video Tutorials
- 1.Foundation Overview
- AdaptiveWork Orientation - Getting Started
- Administration Part 1: Global and System Settings
- Administration Part 2: User Management
- Administration Part 3: View Management
- Administration Part 4: Profile Management
- AdaptiveWork Basics of Data Modeling
- Basic Project Budgeting
- Capacity Planning - Getting Set Up
- Capacity Planning - Staffing Request
- Creating a Project
- Custom Objects
- Data Loader - Advanced Topics
- Data Loader - Introduction and Essentials
- How to Create and Edit a Template
- How to Use Slide Publisher
- Import and Export Using Microsoft Project
- Import and Export Workplan List View
- Managing Resources Using the Capacity Planning Module
- New Project From a Template
- Project Mgmt 101: Part 1 Building Projects and Templates
- Project Mgmt 101: Part 2 Planning, Staffing, and Activation
- Project Mgmt 101: Part 3 Project Execution and Reporting Progress and Time
- Project Mgmt 101: Part 4 Basic Case Management
- Project Scheduling
- Project Scheduling with Dependencies
- Reporting Basics
- Reports and Analysis: Intro to Data Model, Reports, and Dashboards
- Resource Management
- Slide Publisher Introduction and Installation
- Slide Publisher Presentation Building and Formatting
- Slide Publisher Program Portfolio and Customer Presentation
- Slide Publisher Reports and Charts
- Slide Publisher Uploading and Publishing
- Time-Phased Reporting
- Time Tracking
- Understanding Project Roles
- Views - Overview
- Work Policy Tutorial
- Virtual Training
- Virtual Training FAQ's
- Video Tutorials
- Best Practices
- Tips and Tricks
- Data Science and AI
Contents
- Overview
- Creating Data Objects
- Viewing and Using Data Objects
- Deleting Related Data Objects
- Organizing Data Objects
- Configurations for Data Objects
- How to Create a New Data Object
- Exposing the data object in the content layout
- How to Display the Data Object In a Report
- How to Create a Custom Panel Exposing Data Objects
OVERVIEW
Important Note:
Custom Objects offer a newer, more scalable and overall superior solution to Data Objects by offering icons, detail views with dynamic property cards, full collaboration options (discussions, file attachments), field indexing, and overall better reporting experience which overcome the limitations encountered when implementing solutions using Data Objects.
The Data Object further enhances AdaptiveWork's configuration capabilities by allowing you to display new types of data in the system, either creating new objects or storing data on existing objects. Data Objects are a flexible repository that stores (for example, and not limited to) time-based snapshot and trend data and are populated only by workflow, API, or other automation.
The Data object stores as much log-type data as you need for your visualizations, charts and reports.
Data objects have no default workflow, business logic or user roles. No alerts or notifications are generated by the system for data objects and, by default, data objects do not affect any other AdaptiveWork behaviors or layouts.
Example use cases:
Use Scheduled or event-triggered Workflow to capture the key data points you need for your business questions
- Administrators may want to log every time a user logs into AdaptiveWork for User Analytics for licensing purposes.
- Every time an issue or request is changed can be collected for tracking audit trails.
- Project Managers may want to schedule workflows to capture remaining effort on a project for Burndown analysis
- Project Managers may want to capture Earned Value for a project on an EV graph.
The Data Object enables you to snapshot the key data you are looking to track, via the New Item action in workflows, and use or visualize it in Related Panels, Custom Panels or Reports.
Like Discussions, Data can not be a standalone item and must be related to a container "Source" item.
Like Discussions, Data can be linked to the following types of source items:
- Work Item (Project, Milestone, Task)
- Group (User Group & Discussion Group)
- Cases (Issue, Risk, Request, Bug)
- File
- Expense Sheet
- User
- Customer
- Expense
- Topic
- Folder and Report
Creating Data Objects
Data objects are created by workflow and other AdaptiveWork configurations. Use Custom Actions if you need to manually trigger creation of Data Objects.
Viewing and Using Data Objects
As Data objects are conceived as flexible and generic way to store many types of data records, Data objects cannot be viewed in a "Data Objects" panel as it is likely there will be a mix of data types which may not make sense to be displayed together. However, Data Objects can be viewed or edited in the Content Layout. The simplest way to access an item's related Data objects, is to configure a Reference to Object field on Data with a Reverse Reference to the relevant source item - which will expose the related Data items in a Related Items Panel - click here to learn more about how to configure this.
Protect data in Data object custom fields by using Read Only option when configuring the fields.
Deleting Related Data Objects
Data Objects can be deleted if the owner of the Data Object's container has Delete permissions.
The Data Object allows you to add time snapshot data with Scheduled Workflow Rules, without over-extending other AdaptiveWork items such as Notes and Discussions.
Organizing Data Objects
Use the “Type” picklist field on the Data Object to distinguish between the different types of logged data.
The Type picklist is editable and you should add data type labels to suit your data type, such as: "State Change", "Audit Trail", "User Login".
Configurations for Data Objects
AdaptiveWork supports the following Configuration types for the Data items:
- Scheduled Workflows
- Workflow Rules
- Custom Panels
- Custom Fields
- Validation Rules
How to Create A New Data Object
The Data Object being created in the example below is to track Cases (Issues, Requests, or Bugs) via a Workflow when a user changes an Issue, Request, or Bug's state.This is an example of a simple audit trail.
You could also use Scheduled Workflow Rules, Custom Actions, Interact, Data Loader and the API.
The example below describes capturing data every time the user changes the "State" of a Case, which means that if the state changes for Issues, Risks, Requests and Bugs it will be captured.
- Go to Settings > Configure > Data
- The Type picklist field is a standard field of the Data Object that can be editable so you can add data type labels to suit your data needs such as "State Changes", "Audit Trail", and "User Login".
- Click on Type from Settings> Configure> Data> Standard Fields.
-
Description, Tooltip, Reading, Financial and Sort Order can be edited.
- It is recommended that you use the Type Value field to distingush between logged and snapshotted data such as "Burn Down Chart", "User Analytics", "EV Graph", "Audit Trail".
-
Values can be entered individually or you can choose a file to insert a number of values.
- Type in a Value and click Add. This adds values to the Type picklist that can be retrieved in the Workflow, Custom Panel or Scheduled Workflow rules, Custom Actions, Interact, Data Loader and API.
- Each value can have an Image and/or Color to highlighting important information at a glance.
Note:
The Data Object is completely customizable. You can use any of the Data Object standard fields shown below in the Workflow Rule and Custom Panel as well as create new custom fields to suit your business needs.
- Create any Custom Fields you may want to use for the Data Object. These fields store data and can be defined in the Workflow Rule to be later displayed and used or visualized in the Custom Panel or Report. Below are the custom fields that were created for this Data Object.
- Type in a Value and click Add. This adds values to the Type picklist that can be retrieved in the Workflow, Custom Panel or Scheduled Workflow rules, Custom Actions, Interact, Data Loader and API.
- In Settings> Configure choose the relevant Source Item type, in this example we will using Cases.
- Click on Create New > Workflow Rule for Cases.Note:
You can relate Data Objects to the relevant Source Object such as: Work Item (Project, Milestone, Task), Group (User Group and Discussion Group, Cases (Issues, Requests, Bugs), File, Expense Sheet, User, Customer, Expense, Topic, Folder and Report.
- Type in the Name of the Workflow Rule.
- Set the Run Time, in this example, to Every Time a Record is created or edited to capture the user action of either creating the "State" or Changing the "State".
- Set the Evaluation Criteria to Run only when the following conditions are met when the state, isChanged(State). In this step you are determining when to execute the Workflow rule, so this rule will only run when the Case's state is changed.
-
Set Actions for creating a New Item (new record) in the System to run on the CurrentObject, which in this example is "Cases".
- For NewObject1 = New select Data, since is is a new Data Object.
- The $SourceObject is the CurrentObject() or the current record you are working on. In this example the Cases record that the User edited. This is a required field.
- You can add standard or custom fields of the Data Object to the Workflow. These fields are defined in the Workflow and will be stored in the Data Object. These stored fields can be displayed for usage and visualization in Custom Panels and Reports. Below are the fields that were added to the "Cases" Workflow.
-
DataObjectType, which in this example would be 'Case State Change', this value is stored in the Type field. This field was edited In the Report or Custom Panel and will be labeled as 'Case State Change'.
-
Name is 'State Change', one of the Standard Fields.
- New Value of the object 'toString($State)' is a custom field that captures the New Value of the State change of the individual Case.
- Previous Value of the object 'toString(GetPreviousValue($State))' is a custom field that captures the previous value of the individual Case.
- SourceItemID of the Current Object is '$SYSID' or System ID. This will display the system id and it is a custom field.
- SourceItemType of the Current Object 'toString($EntityType)'. This is a custom field.
- Description of the Current Object will display in HTML table rows "From the previous state value to the new state value". This is a standard field.
-
DataObjectType, which in this example would be 'Case State Change', this value is stored in the Type field. This field was edited In the Report or Custom Panel and will be labeled as 'Case State Change'.
- Save your changes
Exposing the data object in the content layout
Administrators can create a custom field of the Data Object with a field type of Reference to Object and a Reverse Reference to the parent object. This custom field will reference the parent object and automatically display field values of the Data Object in the Related Panels of modules if added in the View Editor. Upon creation of this custom field, users can add, edit and delete field values of the Data Object in the Content Layout such as Projects, and Work Items modules. Administrators need to create a custom field with a field type Reference to Object.
See also Predefined Lookup Rules in Reference to Object Fields
How to Create a Custom Field of the Data Object to view as a Relation
- In the Navigation bar click on Settings > Configuration > Data
- Click on Create New > Custom Field
- In the Field Type section select Reference to Object for the Field Type of the Custom Field
- In Referenced Entity, select the parent object, in this example the Cases object is selected
- In Field Properties enter the name of the Field Label
- The API Label and Tooltip are automatically entered after the Field Label is entered
Note:
In the API label, "C_" is always present preceding the name so it does not interfere with existing API names
- The API Label and Tooltip are automatically entered after the Field Label is entered
- Optionally you can enter a Description of the custom field
- Enable Reverse Reference by clicking the checkbox, meaning that the custom field in this example will access all case items and will be added automatically as a relation
- Enter a Field Label name for the Reverse Reference, this name will be shown in the relation
- The API Name is automatically entered after the Field Label is entered
Note:
In the API Name, "R_" is always present preceding the name so it does not interfere with existing API names
- Optionally you can click on the Read Only checkbox if you do not want to allow users to edit or delete field values as a relation
- Optionally you can click on the Financial checkbox if you want only Financial Users to view and update this field
- Click
to save the new custom field
- In the Field Type section select Reference to Object for the Field Type of the Custom Field
How to view Custom Fields in the View Editor
- In the Navigation bar click on Cases, or the appropriate parent module.
- Open the View Navigator
- The currently selected view is highlighted in blue
- Click Edit
- Scroll down in the Related Items Panels to ensure that the new custom field appears as a relation
- Save changes
Note:
You may not see the relation immediately if field values do not exist
- In this example to view data in the Data Object's custom field in Cases you will need to make changes to the state of issues, bugs, risks, or requests
- Change the state for a few items
- Click on the item to view the new relation
- You will see the Custom Field name of the Data Object in the Related Items Panel
- Users can now expand the Related Item to edit or delete field values in the data object
- Example of a read only custom field of a Data Object
- Items cannot be edited or updated via Relations because Read Only was checked
- All fields have a lock indication next to it noting the value is not editable
How to Display The Data Object In A Report
A report can be created to view the field values of the new Data Object defined above. You should only see data that you have permissions on, which is determined by the View permissions on the Container object (Work Item, Group, Cases, File, Expense Sheet, User, Customer, Expense, Topic, Folder and Report).
- In the Navigation bar click on Reports> New Report
- Enter the Report Name, in this case Audit Trail
- Select Data from the Report on dropdown
- Alternatively you can select the custom field of the Data Object, in the example below a custom field of Login was created on the parent object, User
- View of the Login custom field
- Select the columns you want to display in the Report, note these are the same fields we defined in the workflow
- Display of the Data Item Report for Cases
Note:
The description 'work was changed' was added to the Data object that was created so it is included in report
For more information see Creating Reports.
How to Create A Custom Panel Exposing Data Objects
Custom Panels uses stored fields in the Data Object to display data. The Custom Panel uses variables to “run on related” Data Object to generate tabular lists, aggregate data such as KPIs or Javascript (such as Google charts) Review more information on Custom Panels.
- Go to Settings>Configure> Cases
- Click on Create New> Custom Panel
- Type in the Custom Panel Name, "State Changes" in this case
- In the Permissions section select All Users
- You can select Allowed By then you will have to select the users to grant access
- Click on
- A dialog box will open for you to select the Users to access the panel. Note multiple selections can be inserted, you can choose from Roles, People, Groups, etc.
- You can select Allowed By then you will have to select the users to grant access
- In Visibility Rules click Show without conditions, meaning no conditions are required to show the information
- In Set Actions, Set a New Variable
- Fill in the required field name of the New Variable to "statechanges"
- Fill in the required fields, Type which is text and Value is null. This new field will be referenced in the HTML display table of selected fields.
- Set the second Variable to run on the new Data Object and Filter Related Items on the Data Object Type of 'Case State Change'. This step will filter the Data Object Type for only records with 'Case State Change' in the Type field.
- After the records have been filtered the following information will be appended to the statechanges variable: Date and Time, Created By and a description. The Value is written in HtML format so it will display each record as a row. You can specify the format of the date and time.
- You can set the content in HTML format to display an HTML table. You need to specify the HTML table tags with the "statechanges" variable to display the data from the Data Object.
- The Custom Panel will be displayed in Cases
For more information see Custom Panels.
Note:
You can work with Third Party Charts in Custom Panels
If you are using Google Charts you need to store your main data as text, so you can create a custom formula based text field
You can use JsonObjects for a Custom Panel
Best Practices
- As with Notes and Discussions, if you delete the main object you lose the Data too as it has nothing to be attached to. If you need to persist the data after items are deleted, you can protect the main objects with Validation rules or link the Data to an item that will never be deleted.