Data Collections and Fields

Introduction

The data collections and fields screen demonstrates how to manage custom fields which are used to assign arbitary data values to other domain objects within Actionstep, primarily matters. This screen demonstrates performing read, create, update, and delete operations on both data collections and the individual data fields within those collections.

API Functionality Demonstrated

• Retrieving data collections individually and by paging, and using filters.
• Populating a matter type selector using fieldsets.
• Creating individual data collections and data fields.
• Modifying existing data collections and data fields.
• Deleting existing data collections and data fields.

Overview

When selecting the Custom Data Fields menu option the page initially displays the first page of data collections in id order. You can use the matter type selector (filter by matter type) to filter the data collections by their associated matter type, page up and down using the page navigator, or change the page size. Clicking on any data collection will display the list of individual fields associated with the selected data collection in the table shown on the right-hand side of the screen (see below).

Creating and Modifying a Data Collection

A data collection represents a logical container for a collection of individual data fields. A data collection is typically created to group a collection of logically related data fields, for example, to capture data values relating to a property transaction. To create a new data collection click on the Add+ button displayed above the list of data collections. This will display a drop down panel for entering the details of a new data collection. The Edit button on each row also displays this same panel allowing you to change the properties of a data collection.

Creating and Modifying a Data Field

A data field represents an individual data item (associated with a parent data collection) that is used to capture a value from the user and asscociate it with another Actionstep domain object, e.g. a matter. To create a new data field click on the Add+ button displayed above the list of data fields. This will display a drop down panel for entering the details of a new data field. The Edit button on each row also displays this same panel allowing you to change the properties of an individual data field.

Deleting Data Collections and Data Fields

Use the Delete button to delete an individual data field or data collection. If a data collection contains one or more data fields a warning message is displayed to prevent orphaned data fields.