Newer Version Available

This content describes an older version of this product. View Latest

AppUsageAssignment

The AppUsageAssignment object defines the type of application that consumes information from a certain record. When an application attempts an application-specific action on the record, the application first evaluates that the object has the correct AppUsageAssignment for that application. If the assignment is correct, the action proceeds normally. If the assignment is incorrect or doesn’t exist, the application may return an error. Each AppUsageAssignment has an AppUsageType metadata type that contains the actual application definition. This way, the AppUsageAssignment acts as a junction object for assigning a certain AppUsageType across multiple objects. This object is available in API version 50.0 and later.

Salesforce application developers configure the AppUsageType metadata. Depending on the platform's requirements, some partners and system integrators may need to create AppUsageAssignments and assign them to records on their own. In other cases, the application is provided with flows used to assign app usage assignments to records in an org. For example, let's say you have a ShoppingCart application that provides commerce services with custom Shopping Cart fields on the order. When a user orders from the shopping cart application, the application has a flow that creates an order with a Shopping Cart app usage assignment. The assignment has an AppUsageType field with a value of ShoppingCart. This value represents the ShoppingCart metadata type that the flow configured for the app usage assignment.

AppUsageType metadata types are configured by Salesforce application developers only. They can't be accessed or reviewed by users. Users can

Important

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Field Details
AppUsageType
Type
string
Properties
Create, Filter, Group, Sort
Description
The name of the application that the AppUsageAssignment represents.
Name
Type
string
Properties
Filter, Group, idLookup, Sort
Description
Optional user-defined name for the AppUsageAssignment.
RecordId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The specific record that the AppUsageAssignment has been assigned to.
This is a relationship field.
Relationship Name
Record
Relationship Type
Lookup
Refers To
Order

Usage

This flowchart shows the record relationships in a sample AppUsageAssignment configuration. In this case, the org has two applications that provide additional features to orders, called "Industrial Orders" and "Healthcare Orders." When a sales rep makes an order, they set the order's Industry Type field to Industrial or Healthcare based on the order details. The Industrial Orders and Healthcare Orders applications both have flows that evaluate the order's Industry Type field, and then create and assign an app usage assignment accordingly. This flowchart shows an instance where a sales rep has created one Industrial order and two Healthcare orders.

A flowchart showing a sample AppUsageAssignment configuration.