Understanding and Using Object Models and Object Variables in Builder

In this article:

• Participant-Based Object Models and Object Variables
• Matter Type Object Models
• Creating Object Models and Variables

Many of the documents you'll use with your matter type include information about the different parties associated with a matter, like plaintiff/defendant, testator/beneficiary, employer/employee, etc. Your documents may also include client or matter data you gather from your clients using custom data fields. Actionstep Builder implements some unique ways of pulling this information in to your Builder environment so you can use it to automate your templates.

Participant-Based Object Models and Object Variables

In Actionstep, you can have many different participant types, such as lawyer, client, paralegal, trustee, executor, etc. Each of these participant types uses a set of common fields, like name, address, gender, birth date, etc. 

When these participant types are copied to Builder for use in your templates, a few different things happen:

• A primary object model called as:action_participant is created. It contains all of the fields that are common across all participant types.
• Using the action_participant object model as the base, object variables are then created for the participant types you've identified for your individual matter types (pt_Buyer, pt_Client, and pt_Seller in the example below). The fields that are available in the action_participant object model are then referenced in these object variables. 

By creating a common set of variables and then referencing those variables in each individual object variable, you can save time and effort you would normally spend creating these fields for each individual participant type.

When syncing data from Actionstep, there are other system-wide object models that are automatically created. These are:

• as:system
• as:action
• as:pt_Client_custom
• as:pt_special_options

Like the as:action_participant object model, these object models are used to create object variables that can then be used to gather and merge information about a client or matter in your template. For example, the as:action object model is used to create a Matter object variable for each catalog in your system.

Matter Type Object Models

In addition to participant-based object models and variables, matter type-specific data collections are also copied and created as object models. 

These object models are used to gather information unique to specific matter types. 

Creating Object Models and Variables

If you are using data pulled from Actionstep, you shouldn't need to create object models and object variables because the system creates them for you (as described in the sections above). However, if you are using your own Builder-only variables, the following instructions show you how to take advantage of these object models. 

There are two parts to creating and using object models:  

• Create the object model with your general variables. 
• Create object variables based on the object model for specific use cases.  

Part 1: Creating the Object Model  

An object contains a set of variables that relate to its main subject.  For example, the most popular model to create is about any given party. 

To do this: 

1. Review the documents you typically associate with your matter types and identify the variables you would typically reuse for different areas.
   
   

   For example, in bankruptcy, you might have details about debtors, creditors, attorneys, and trustees. So, you might determine that you need variables like First Name, Last Name, Phone Number, Street Address, City, etc.
   
   

2. Open the Builder Workspace (see Accessing the Builder Online Workspace) and select the catalog / matter type you want to associate the object with in the Elements list. 
3. Click Add a new element, located at the bottom of the Elements list. The New Element window appears.  
4. Enter a Name. 
5. Select Model. 
6. Click OK. The object is created and the details for it are displayed in the main (center) part of the page.  

   Next, you will create the generic variables you want associated with the object. 

7. Click the Variables tab. 
8. For each variable you need, click Add a new variable and complete the information for that variable. (See Creating Builder Variablesfor help.)  
   TIP: Remember to click the Save icon frequently as you create these variables.
9. Once all your variables are created, click Save to save all your changes.  
10. Proceed to Part 2: Creating an Object Variable, below.  

Part 2: Creating an Object Variable 

Once you have created your model, you can create your object variables, which you can insert in your template. An object variable can be a single group of variables or a list of variables.  For example, in an estate planning catalog or matter type, you might create a single testator object variable based on the party object. You can also create a list of beneficiaries based on the same party object.

To do this:  

1. Complete the steps in Part 1: Creating the Object Model, above. 
2. While viewing the Online Workspace, select the catalog (in the left-side pane) where you’ve created the object.  
3. In the Details section of the page, click the Variables tab, and then click Add a new variable.  
4. Select one of the following Type options:  
   • Single: Choose this option if you want to merge only one set of answers in the document (e.g., information for just one testator).  
   • List of: Choose this option if you want to create a list of answers (e.g., a list of beneficiaries and their information).  
5. Click the drop-down list and choose Object.  
6. Click the Based on model drop-down list and choose the name of the object you created in Part 1.  
7. Enter a Variable Name.  
8. Click the Save icon to save your work.  
9. Once the object variable is created, you can insert it in your Word template.  
10. Edit your Word template and launch the Word Designer. (See Editing a Builder Template File for help.)
11. In the Word Designer pane, locate and expand the object variable.  
12. Find the variable(s) you want to insert and click and drag them into the template. (See Creating Builder Variables help.) 

Related Articles:

Understanding How Actionstep Data is Used in Builder

Editing Variables Used In Participant and Matter Type Objects in Builder

Builder Glossary