How to use Appian Records

Appian Max Team — Tue, 23 Apr 2024 13:12:23 GMT

Current Revision posted to Guide by Appian Max Team on 4/23/2024 1:12:23 PM

Skills Covered

Appian Records bring together all important and relevant enterprise data into a searchable collection of information.

When you leverage Appian Records, each row of source data is displayed as a record in Appian. But a record is more than just a row of data—it’s a combination of record views and actions, so users can gather insights and take action in the same place.

As such, records are a foundation for solutions built in Appian.

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: Architecture

How to use Appian Records

Appian Max Team — Thu, 22 Feb 2024 21:34:50 GMT

Revision 14 posted to Guide by Appian Max Team on 2/22/2024 9:34:50 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: Architecture

How to use Appian Records

joel.larin — Wed, 01 Nov 2023 13:40:02 GMT

Revision 13 posted to Guide by joel.larin on 11/1/2023 1:40:02 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: Architecture

How to use Appian Records

matt.cosenza — Tue, 17 Oct 2023 19:17:53 GMT

Revision 12 posted to Guide by matt.cosenza on 10/17/2023 7:17:53 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

How to use Appian Records

Devon Lee — Wed, 22 Mar 2023 17:01:44 GMT

Revision 11 posted to Guide by Devon Lee on 3/22/2023 5:01:44 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: records, Architecture

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 20:32:23 GMT

Revision 10 posted to Guide by joel.larin on 2/7/2023 8:32:23 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: records, Architecture

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 17:04:19 GMT

Revision 9 posted to Guide by joel.larin on 2/7/2023 5:04:19 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: records, Architecture

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:51:16 GMT

Revision 8 posted to Guide by joel.larin on 2/7/2023 4:51:16 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: records, Architecture

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:50:29 GMT

Revision 7 posted to Guide by joel.larin on 2/7/2023 4:50:29 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

Tags: records, Architecture

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:49:50 GMT

Revision 6 posted to Guide by joel.larin on 2/7/2023 4:49:50 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

SRecommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Record Security

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:47:39 GMT

Revision 5 posted to Guide by joel.larin on 2/7/2023 4:47:39 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data Model

A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
Learn more about data modeling with Appian Records.

Record Views

Create unique record titles so they’re easily identifiable in the record list.
Display dynamic information on the top of the summary view so users get the most recent information first.

For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
Create additional record views to display reports or related information.

For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?

Record List

Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.

Record Actions

Configure record list actions to display on the record list so users can add new records to the list.
Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Secure Your Records

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:44:15 GMT

Revision 4 posted to Guide by joel.larin on 2/7/2023 4:44:15 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data model:
- A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
- Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
- Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
- Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
- Learn more about data modeling with Appian Records.
Record views:
- Create unique record titles so they’re easily identifiable in the record list.
- Display dynamic information on the top of the summary view so users get the most recent information first.
  
  For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
- Create additional record views to display reports or related information.
  
  For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
- Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?
Record list:
- Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
- Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
- Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
- Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.
Record actions:
- Configure record list actions to display on the record list so users can add new records to the list.
- Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Secure Your Records

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:43:18 GMT

Revision 3 posted to Guide by joel.larin on 2/7/2023 4:43:18 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data model:
- A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
- Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
- Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
- Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
- Learn more about data modeling with Appian Records.
Record views:
- Create unique record titles so they’re easily identifiable in the record list.
- Display dynamic information on the top of the summary view so users get the most recent information first.
  
  For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
- Create additional record views to display reports or related information.
  
  For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
- Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?
Record list:
- Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
- Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
- Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
- Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.
Record actions:
- Configure record list actions to display on the record list so users can add new records to the list.
- Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Secure Your Records

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:41:00 GMT

Revision 2 posted to Guide by joel.larin on 2/7/2023 4:41:00 PM

Skills Covered

Record Type Use Cases

What makes a good record type?

Ideal Use Case

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Wrong Use Case

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data model:
- A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
- Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
- Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
- Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
- Learn more about data modeling with Appian Records.
Record views:
- Create unique record titles so they’re easily identifiable in the record list.
- Display dynamic information on the top of the summary view so users get the most recent information first.
  
  For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
- Create additional record views to display reports or related information.
  
  For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
- Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?
Record list:
- Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
- Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
- Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
- Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.
Record actions:
- Configure record list actions to display on the record list so users can add new records to the list.
- Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Secure Your Records

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.

How to use Appian Records

joel.larin — Tue, 07 Feb 2023 16:33:03 GMT

Revision 1 posted to Guide by joel.larin on 2/7/2023 4:33:03 PM

Skills Covered

This article outlines how to make flexible, reusable, and dynamic workflows in Appian in an effort to make design, maintenance, and change management easy.

Creating Memory Efficient Models covers many useful strategies for designing process models that follow best practices. This article will dive deeper into design patterns that will assist with creating workflows with many sequential steps. Creating an entire workflow into a single process model has negative memory implications, is difficult to maintain, and can result in backwards compatibility issues for future releases. Below are some strategies for designing processes that alleviate those risks.

This type of design can be used for all applications whether they are data-centric or focus more on a linear task-based workflow.

Legacy Design Pattern

What makes a good record type?

Enable data sync whenever possible so you can leverage additional features that accelerate app development. See when to use data sync.
Create a record type for each entity in your business.

For example, a customer and their orders are two key business entities in almost any organization selling products or services. So you would have two record types: a Customer record type and an Order record type.
Create a record type for reference data. For example, customer locations, like the state and country are unlikely to change and may also be referenced in orders. So you could have a reference record type called Countries or Locations.
Connect data using record type relationships. Seamlessly reference related data by connecting them using relationships. For example, you can connect Customers and Orders to easily display a customer and their relevant order information.

Don't

Create record types based on security. You can easily secure the records in your record type using record-level security, visibility expressions, or source filters to ensure that only the right users can see the right information.

Recommended Record Design

When building out your record type, including the data model, record views, actions, and list, consider the following:

Data model:
- A record type can connect to data from a relational database, integration, or process. So you should have a record type for each of your sources.
- Use record type relationships to relate your enterprise data—regardless of where it lives. This allows you to seamlessly reference related data from your base record type.
- Set any username or group fields to the Appian data type User or Group. This allows you to reference these fields in your record-level security.
- Create custom record fields to extend and manipulate your data and save it as a new field on the record type. This allows you to sort or filter by transformed data, or simply display it in a grid, report, or query.
- Learn more about data modeling with Appian Records.
Record views:
- Create unique record titles so they’re easily identifiable in the record list.
- Display dynamic information on the top of the summary view so users get the most recent information first.
  
  For example, a case’s status, assigned engineer, and the latest case comment would be important to have at the top of the view.
- Create additional record views to display reports or related information.
  
  For example, a Case record could have a summary view to display relevant case information, and a Customer view to learn more about the customer associated with the case.
- Add record links so users can learn more about related records. What orders do I have for this customer? Which user opened the support case?
Record list:
- Configure your record list directly in the record type. When you create a records-powered grid, the grid will automatically populate with your record list configuration.
- Do not display all fields from your record type in the list. The list is meant to give a high-level overview of the information in each record. Users can always drill into an individual record to learn more.
- Add user filters and a search box to your list to allow users to filter and navigate to the appropriate record.
- Consider whether to display a grid-style or feed-style list. Feed-style lists can only display the first 100 records, so if you have a larger dataset, consider a grid-style list.
Record actions:
- Configure record list actions to display on the record list so users can add new records to the list.
- Configure related actions to display on your record views so users can perform specific actions, like Edit or Delete, from the record. Each related action starts a process using the record’s context.

Secure Your Records

To ensure your enterprise data is only available to the correct users, Appian provides a layered approach to securing your records.

Record type security: Determine who can see and edit the record type object using groups and role maps.
Record-level security: Determine who can view which records. This security option is only available for record types with data sync enabled. If your record type does not have data sync enabled, you can use default filters to determine user access.
Record view and record action visibility: Configure visibility expressions on your record views and record actions to determine which record views they can see and which actions they can take.

Learn more about Security in Appian Records.