Editing Variables Used In Participant and Matter Type Objects in Builder

Custom data fields in Actionstep let you gather and store important information about participants and matter types. When you sync Actionstep with Builder, these fields are copied to Builder as object models and object variables so you can use them in your template. 

There may be times when you need to edit the properties of these variable once they are in Builder—for example, if you find your interview questions need better prompts or additional context. Or you may want to change the order questions are asked during the interview. You can make all these changes in Builder. 

There are different types of components in Builder you can edit:

• Editing Catalogs
• Editing System-Level Object Models
• Editing Custom Participant Type and Data Collection Object Variables
• Editing Variables Created in Builder

Editing Catalogs

Catalogs are where all the details about your matter types (like Estate Planning, Conveyancing, Employment Law, etc.) are stored. You can have multiple catalogs in Builder, and each one contains templates, variables, formulas, and apps.

To edit the details about the catalog itself:

1. In Builder, click the Catalog tab. (See Accessing the Builder Online Workspace for help launching Builder.)
2. In the Data Catalogs list, select the catalog you want to edit. 
3. In the Details section of the page, edit the following:
   • Item detail template: Use this field to add text or other instructions that will be displayed on the main Catalog view under the catalog title. You can include Builder variables in this field to better customize the information. 
   • Create record label: Use this option to customize the label on the Create Record drop-down list when viewing the catalog.
   • Apps on this catalog: Shows the apps associated with this catalog. (See Creating Builder 'Apps' to Use When Generating Documentsfor more information.) This group of options also allows you to: 
     • Enable or disable the app for use by selecting or clearing Enabled. 
     • Access previous versions of the app by clicking the “Live” Version drop-down list and choosing that version. When you select a previous version, that app will be used when users create records. When switching between versions, you can rename the version.    
4. Click the Save icon to save your changes.

To edit the components of a specific catalog:

1. In Builder, click the Designer tab. (See Accessing the Builder Online Workspace for help launching Builder.)
2. Select the catalog from the Elements list (catalogs have an as:mt_ prefix). 
3. In the main section of the page, click the Variables tab and select the object variable or variable or you want to edit. The sections below go into greater detail on how to do this. 

Editing System-Level Object Models

When you sync Actionstep and Builder, there are a handful of system-wide object models that are automatically copied over. These are as:system, as:action, as:action_participant, as:pt_Client_custom, and as:pt_special_options. Since these are system-level variables, you typically don’t need to do anything to update them since they typically have their Question Prompts set up with correct spacing, etc. 

If you do need to make adjustments, remember that since an object model is frequently used to build multiple object variables, any changes you make at the object model level will be passed to every object variable. Because of this, be very careful making changes. 

To edit system-based object models and variables:

1. In Builder, click the Designer tab. (See Accessing the Builder Online Workspace for help launching Builder.)
2. In the Elements list, find the system object model you want to edit:
   • as:system
   • as:action
   • as:action_participant
   • as:pt_Client_custom
   • as:pt_special_options
3. In the main area of the page, click the Variables tab. The variables associated with the object model are listed. 
4. Make your changes in the variable editor:
   • Variable Name: Shows the name of the variable. If you're working with Actionstep-based objects or variables, do not change these values.
   • Type: Shows the variable type. If you've selected an object variable, the name of the object model it's associated with is also displayed. 
   • Question Prompt: Enter the text that will be displayed with the field during the interview. If you don't want a prompt to be used, select Unlabeled.
   • Relevance (Condition): Choose whether the variable is visible in the interview or not. (See Knackly's help article Relevancy Guide for more information.)
   • Question Help: Enter the text that will be displayed for the field using a tooltip.
   • Notes: Include any annotations about the field. These are internal only.  
5. Answer any remaining fields, which are variable specific. 
6. Click the Save icon to save your changes.

Editing Custom Participant Type and Data Collection Object Variables

There are a few different aspects of an object variable that you can edit: 1) the properties of the object variable, and 2) the individual variables referenced in the object variable. 

Updating Object Variable Properties

As you have learned in Understanding and Using Object Models and Object Variables in Builder, an object variable is a catalog-specific “container” that organizes common variables into catalog-specific groups. You can change how these “containers” look and function during the interview.  For example, the container can appear inline or as a pop-up, or it can include a tooltip to provide additional help or context. 

To edit object variable properties:

1. In Builder, click the Designer tab. (See Accessing the Builder Online Workspace for help launching Builder.)
2. In the Elements list, select the catalog/matter type with the variables you want to edit. 
3. Click the Variables tab. 
4. Select the object variable in the list. Participant object variables have names like pt_Seller or pt_Buyer. Data collections have names like dc_PropertyDetails or dc_SpecialPurchaseConditions. 
5. Make your changes in the variable editor:
   • Variable Name: Shows the name of the variable. If you're working with Actionstep-based objects or variables, do not change these values.
   • Type: Shows the variable type. If you've selected an object variable, the name of the object model it's associated with is also displayed. 
   • Question Prompt: Enter the text that will be displayed with the field during the interview. If you don't want a prompt to be used, select Unlabeled.
   • Relevance (Condition): Choose whether the variable is visible in the interview or not. (See Knackly's help article Relevancy Guide for more information.)
   • Question Help: Enter the text that will be displayed for the field using a tooltip.
   • Style: Choose how you want questions in the object variable to be displayed in the interview: Popup, Inline, or Accordion. You can also choose to hide the object variable. 
   • Notes: Include any annotations about the field. These are internal only.  
6. Click the Save icon to save your changes.

Updating Individual Variables in an Object Variable

Where you edit the variables referenced by an object variable depends on whether it’s a participant or matter variable. 

To edit participant type variables:

1. In Builder, click the Designer tab. (See Accessing the Builder Online Workspace for help launching Builder.)
2. In the Elements list, select as:action_participant.
3. Click the Variables tab. 
4. Select the specific variable you want to edit.
5. Make your changes. The list of possible properties you can edit depends on the variable type. Common fields are:
   • Variable Name: Shows the name of the variable. If you're working with Actionstep-based objects or variables, do not change these values.
   • Type: Shows the variable type. If you've selected an object variable, the name of the object model it's associated with is also displayed. 
   • Question Prompt: Enter the text that will be displayed with the field during the interview. If you don't want a prompt to be used, select Unlabeled.
   • Relevance (Condition): Choose whether the variable is visible in the interview or not. (See Knackly's help article Relevancy Guide for more information.)
   • Question Help: Enter the text that will be displayed for the field using a tooltip.
   • Notes: Include any annotations about the field. These are internal only.  
6. Answer any remaining fields, which are variable specific.
7. Click the Save icon to save your changes.

To edit data collection variables:

1. In Builder, click the Designer tab. (See Accessing the Builder Online Workspace for help launching Builder.)
2. In the Elements list, select the data collection object model (e.g., as:dc_[DataCollectonName]).
3. Click the Variables tab. 
4. Select the specific variable you want to edit.
5. Make your changes. The list of possible fields depends on the variable type. Common fields are:
   • Variable Name: Shows the name of the variable. If you're working with Actionstep-based objects or variables, do not change these values.
   • Type: Shows the variable type. If you've selected an object variable, the name of the object model it's associated with is also displayed. 
   • Question Prompt: Enter the text that will be displayed with the field during the interview. If you don't want a prompt to be used, select Unlabeled.
   • Relevance (Condition): Choose whether the variable is visible in the interview or not. (See Knackly's help article Relevancy Guide for more information.)
   • Question Help: Enter the text that will be displayed for the field using a tooltip.
   • Notes: Include any annotations about the field. These are internal only.  
6. Answer any remaining fields, which are variable specific.
7. Click the Save icon to save your changes.

Editing Variables Created in Builder

You can create variables directly in Builder. These variables are always associated with a specific catalog. 

To edit Builder-created Variables:

1. In Builder, click the Designer tab. 
2. In the Elements list, select the catalog/matter type with the variables you want to edit. 
3. Click the Variables tab. 
4. Select the Builder variable. These have variable-specific icons rather than the object variable icon:
   
5. Make your changes in the variable editor. Which options appear depends on the variable type:
   • Variable Name: Shows the name of the variable. If you're working with Actionstep-based objects or variables, do not change these values.
   • Type: Shows the variable type. If you've selected an object variable, the name of the object model it's associated with is also displayed. 
   • Question Prompt: Enter the text that will be displayed with the field during the interview. If you don't want a prompt to be used, select Unlabeled.
   • Relevance (Condition): Choose whether the variable is visible in the interview or not. (See Knackly's help article Relevancy Guide for more information.)
   • Question Help: Enter the text that will be displayed for the field using a tooltip.
   • Notes: Include any annotations about the field. These are internal only.  
6. Click Save when you are finished.