Use Synced Record Types in Existing Apps

Overview

Appian's data fabric is powered by record types. When you enable data sync on your record types, you unlock powerful features that help accelerate application development. We call these synced record types.

If you’re working on an existing application, especially one that’s a few years old, your application may be built using custom data types (CDTs) or data store entities (DSEs) instead of record types. This page describes how you can use synced record types in your existing applications without any application refactoring.

Benefits of using synced record types in existing apps

You can easily incorporate synced record types into your existing applications by creating new record types that connect to the same data source as your existing DSEs.

This way, you can use your existing DSEs and CDTs to maintain your current interfaces, queries, and process models, and you can use the new synced record types to:

• Use Process HQ. Business users can explore data from synced record types in Process HQ. By simply creating a synced record type and enabling the Show in Data Catalog setting, users can instantly start exploring their data fabric and building custom reports and dashboards.
  
  

• Use AI features. Features such as the records chat component and AI Copilot in data fabric insights are only available for use with synced record types. By creating synced record types to use AI features, you can allow business users to be more productive and easily gain new insights about your organization.
  
  

• Build new additions to your applications. If you're adding a new report or dashboard to your application, consider creating synced record types to use in your interface. This way, you can leverage features like record type relationships and custom record fields in your interface, and experience faster performance since data sync can make your applications overall more performant.

How to use synced record types in existing apps

Appian does not recommend refactoring your entire existing application to use record types instead of CDTs and DSEs. This is because you don’t need to. You'll get the most benefits by using synced record types in Process HQ and in new additions to your app.

Additionally, when you use a synced record type that connects to the same database as your existing CDTs and DSEs, your process models are likely already set up to update and sync data in the record type. This is because creating or updating data using certain smart services, like Write to Data Store Entity and Delete to Data Store Entity, will also automatically sync the data in the record type.

Example

Let's look at an example of how you can incorporate synced record types into an existing application.

Existing application objects

Imagine you're a developer working on the Appian Retail application. This app was built a few years ago, so it only uses CDTs and DSEs to write and display data.

For example, the Order DSE and Order CDT are used to build record views, queries, and process models that display and update order data.

Now, the Appian Retail company wants to allow employees to build self-service reports in Process HQ, and they want you to add more enhancements to existing interfaces in the app.

Use Process HQ

To allow users to access data so they can build reports, you can create synced record types for Process HQ that use the same data source as the existing DSEs.

For example, you could create a synced Orders record type that connects to the same database table as the Orders DSE. Once you enable the record type to show in the Data Catalog, business users can instantly build order reports, and ask questions to AI Copilot to gain real-time insights into their data.

Build new additions to the app

You can also leverage the Orders record type to build new additions to the application. For example, you have an interface that uses the Orders CDT and DSE to show profit and revenue for orders. However, stakeholders have long requested more key performance indicators (KPIs) on this interface so they can quickly understand the current state of the business.

You can enhance your existing interface by adding new charts and KPIs that use the Orders record type as the source. Using a record type is the fastest and easiest way to configure a component, so you can display key information in just a few clicks.

You could even add custom record fields on your Orders record type to aggregate data and then use those fields to display and sort data in your interface.

Seamlessly keep data the record type up to date

Now that you're using the Orders record type in Process HQ and in your application, you want to ensure that the record type always has the latest order data.

Right now, orders are created and updated using a process model with the Write to Data Store Entity smart service. Since your process model is already using a smart service that automatically syncs data, any data changed by these smart services will be immediately synced and available in the Orders record type.

Since Appian is the only system writing to the Orders table, you can be confident that the Orders record type always has the latest data without any further action. If other systems were also writing to the table, you could enable other sync options on the record type to easily capture and sync these changes.

Feedback