Workflow to Create a Custom Object State Action Definition

You can create an Object State Definition (state model) with specific Object State Values and Object State Transitions. In the Object State Definition, you can define custom actions that call specific transitions using an Apex Class or Omniscript.

In this example, we’re creating a simple state model that moves a contract from draft to signed using the Sign Contract custom action button.

Note Object State Models are only supported for use in Salesforce Contracts. Only the CLM Admin User can configure object state models; other Salesforce Contract users can view and generate documents using the object state models.

1. Create a contract record type.
   Contract Record Type groups multiple contract records for a specific contract type under a contract object. Contract record types allow you to have a different page layout, and fields (required or not) with different picklist values. See Create Contract Record Type.
2. Create a contract type and map it to a contract record type.
   Use Contract Type to manage different types of contracts within an org. From Setup, create a contract type or clone and modify an existing contract type. Then, map the contract type to one or more contract record types. See Create Contract Type and Map to a Contract Record Type.
3. Create an object state definition.
   1. From the App Launcher, find and select Object State Definition.
   2. Click New.
   3. Enter these details:

      • Name: Name for your object state definition.

      • Reference Object: Contract

      • Reference Field: Status

      • Additional Field: ContractType

      • Additional Field Value: Name of the contract type to map to this object Object State Definition.

        

        Note The Object State Definition you created has no default state values or transitions. You need to configure these values.
4. Create object state values.
   1. From the App Launcher, find and select Object State Definition.
   2. Click the object state definition that you created in the previous step.
   3. Click the Related tab.
   4. From the Object State Values section, click New.
   5. Enter these details:

      • Name: Name for your state value. For example, Draft.

      • Description: Description for the state value.

      • Reference Record Access Type: ReadOnly

      • Object State Definition: The field is populated by default.

   6. Save your changes.
   7. Repeat the above steps to add more state values. For example, Signed.
5. Configure contract status picklist values.
   The Contract Status field controls the contract Object State Definition. Salesforce Contracts provides a default set of contract status picklists, it includes draft and signed. You can create additional contract status picklists and reorder the sequence of contract status values from Setup.

   Attention The one-to-one mapping between the status picklist and the object state value and its order must be maintained. For example, if you change the Draft status picklist value to New, the mapping between that status and its corresponding object state value becomes out of sync and the Object State Definition won’t work. For more information, see Default Contract Status Picklist Values.
   1. From Setup, click Object Manager.
   2. Click Contract,and then click Fields & Relationships.
   3. Click Status.
   4. In the Contract Status Picklist Values section, click New.
   5. Enter a Label and API name.
   6. Select a default status category from the list.
   7. Select the record type for the status.
   8. Save the changes.
   9. To reorder the picklist value, click Reorder.
   10. Use the arrow keys to reorder the picklist values.
   11. Save your changes.
6. Create object state transitions.
   1. From the App Launcher, find and select Object State Definition.
   2. Click the object state definition you created.
   3. Click the Related tab.
   4. In the Object State Transitions section, click New.
   5. Enter these details:

      • Name: Name for your state transitions value. For example, Draft_To_Signed.

      • From State: Enter the state to transition from. For example, Draft.

      • To State: Enter the state to transition to. For example, Signed.

      • Description: Description for the state value.

      • Object State Definition: The field is populated by default.

   6. Save your changes.
   7. Repeat the above steps to add more state transitions.
   8. Select Active on the Object State Definition and save your changes.
7. Create an object state action definition.
   By creating an object state action definition, you're defining a custom action button based on an Apex class or Omniscript. Use one of these options:

   • Create an Object State Action Definition using Apex Class

   • Create an Object State Action Definition using Omniscript

8. Create an object state transition action.
   To link the object state action definition and object state transition, create an object state transition action. For more information, see Create an Object State Transition Action
9. Configure contract type configs.
   At a minimum, configure the DocumentFileNameFormat, and AutoGenerateDocFileType contract type configuration values. For more information, see Create Contract Type Config Setting. To view all the available settings, see Contract Type Config Settings.
10. Test your custom action on a contract.
    1. Create a contract.
    2. From the Documents tab, click the custom action you created.

       • For Omniscripts, the Omniscripts modal opens based on your configuration.

       • For Apex classes, the status of the contract moves based on the defined custom action.