This article will walk you through a multi-step exercise to organize and align your lifecycle-related contract properties to Ironclad’s standard dataset to support consistent data tracking across all contracts in your account.
Note:
This content was created to be completed alongside the Manage Data in Ironclad course in Ironclad Academy. We highly recommend taking the course prior to completing the steps in this article.
Introducing Data Manager, Connected Properties, and the Lifecycle Preset
To get the most out of Ironclad, building and managing the data catalog your team understands and trusts is critical. A notable subset of your contract data includes lifecycle information, such as expirations and renewals, so your team can stay on top of key dates and obligations to your counterparties.
In order to effectively and consistently track these data points, Ironclad offers a variety of features and methods to support consistent, trustworthy, and usable data, most notably: Data Manager, Connected Properties, and the Lifecycle Preset. These features are the cornerstone of how you will reorganize your dataset to follow Ironclad best practices:
- Data Manager serves as a central location to view and manage all of your contract properties and record types across workflows and records. Admins can now create, merge, rename, and delete properties, and create and delete record types in Company Settings.
- Properties now span your workflow configurations, workflows, and records (hence, “Connected Properties”). If you edit the property in one location of the product, that change will be reflected in all other places where that property is present. Additional safeguards in Workflow Designer now prevent duplicate properties, and changes to property names and descriptions are limited to Administrators.
- To facilitate information collection across all of your company’s workflows, Ironclad has created the Lifecycle Preset in Workflow Designer. This feature contains a collection of properties, conditions, and launch form questions to track key contract lifecycle data, such as effective dates, expiration dates, and auto-renewal information. Future features that will introduce out-of-the-box reporting and automated lifecycle management will be powered by the data captured and stored as part of the Lifecycle Preset’s properties.
Process Overview
You must be an Administrator in your Ironclad account in order to complete these steps.
It is optional, yet recommended, to continue restructuring your account’s properties and record types beyond lifecycle-related data.
- Inventory and Map Lifecycle Properties: Identify the custom properties to replace, map them to standard Lifecycle Preset properties, and export data and usage information before making changes.
- Merge Duplicate Lifecycle Properties of the Same Data Type: Merge eligible custom properties into their corresponding standard properties before adding the preset. Resolve existing conflicts before merging.
- Add the Lifecycle Preset and Update Workflow Configurations: Add the preset to existing configurations, review references to merged properties, replace remaining custom properties, and publish the updated configurations.
- Migrate Lifecycle Data Between Different Property Types: Use Metadata Import and Bulk Actions to transform and transfer existing record values when the custom and standard properties have different data types.
- Delete Unused Properties from Your Account: After validating the merges, migrations, and configuration changes, delete custom properties that no longer have any usages.
Your Toolkit
- Workflow Designer: After completing eligible same-type merges, add the Lifecycle Preset to your existing configurations. Review references to merged properties, replace remaining custom properties, resolve duplicate questions and formulas, and publish the updates.
- Data Manager: View property usages, export usage information, edit property settings, merge eligible properties of the same data type, and delete unused custom properties.
- Repository Bulk Actions: Bulk update, replace, or remove contract properties on multiple records in the Repository with bulk actions. This tool is the best option if a property will inherit the same value for all of the records in question.
- Metadata Import: Bulk update (or replace) contract properties on multiple records in the Repository with a metadata import via .csv. This tool is the best option if a property will inherit several different values for all of the records in question.
Instructions
Complete the following steps in order. Expand each section to view its instructions. If you do not have properties of a particular data type to consolidate, skip that consolidation step and continue to the next section.
Step One: Inventory and Map Lifecycle Properties
Before adding the Lifecycle Preset or changing properties, identify which custom properties should be replaced and how their existing values will be preserved.
- In Ironclad, navigate to Company settings > Data Manager. Review your lifecycle-related custom properties and the corresponding standard Lifecycle Preset properties.
-
Create a tracking spreadsheet. For each replacement, record the following information:
Information What to record Custom property The source property's name and data type. Standard property The target Lifecycle Preset property's name and data type. Usages and dependencies The configurations, in-progress workflows, records, form questions, document tags, conditions, formulas, approval or signer assignments, views, and integrations that reference either property. Method A Data Manager merge for matching data types, or a data migration for different data types. Status Any conflicts to resolve, configuration changes to make, and validation results. - Export usage information for both the custom and standard properties. Export the existing record values and retain an unchanged copy before making changes.
- Confirm that each custom property and its proposed standard property represent the same information. Review records where either or both properties already contain values, and decide which values should be retained.
- Check whether both properties already exist in the same workflow configuration or in-progress workflow. Resolve these conflicts before attempting the same-type merges in Step Two. If an in-progress workflow blocks a merge, contact Ironclad Support for guidance before changing it.
- Confirm that the intended standard target property is available in Data Manager. If you cannot find it, contact Ironclad Support before proceeding. Do not create a custom property with the same name as a substitute.
Warning: Property merges are permanent and cannot be undone. Keep your exports and validate the proposed changes before merging. An export is a backup of data, not an automatic rollback for a merge.
Note:
Complete eligible same-type merges before adding the Lifecycle Preset to configurations that still use the custom properties. Adding the preset first can introduce both properties into the same configuration and block the merge.
Step Two: Merge Duplicate Lifecycle Properties of the Same Data Type
Merge eligible custom properties into their corresponding standard Lifecycle Preset properties before adding the preset to your workflow configurations. Data Manager merges require matching data types. For different data types, complete the configuration updates in Step Three, then follow Step Four to migrate existing record values.
- Open the tracking spreadsheet you created in Step One. Identify the properties marked for a same-type merge.
- In a separate tab or window, navigate to Company settings > Data Manager.
-
Set the Visibility filter to All, so that the Type, Usages, and Visibility filters are all set to All.
-
Add the System generated column to the view. This will differentiate standard (System generated = Yes) and custom (System generated = No) properties.
- Click the System generated column to sort the properties by System generated = No. Locate the custom source property you want to merge into a standard Lifecycle Preset property. Do not select the standard property as the source to retire.
-
Using your spreadsheet as a guide, locate the custom properties that should merge with standard preset properties of the same data type. Refer to the list below of common custom properties that are functionally the same as preset properties of the same type:
Common Custom Properties Corresponding Standard Preset Property - Start Date
- Agreement Effective Date
- Subscription Start Date
Effective Date (date) - End Date
- Agreement Expiration Date
- Subscription End Date
Expiration Date (date) - Term Length
- Contract Term
- Contract Term Length
- Term
- Order Form Term
Initial Term Length (duration) Note:
The examples above pair properties of the same data type. For example, a custom date property can be merged into a standard date property. A boolean Auto-Renew property cannot be merged into the text Renewal Type property. For different data types, use the migration procedure in Step Four.
-
Select the custom property and review its Usage information. Compare the source and target usage exports from Step One. If both properties are present in the same configuration, remove or replace the conflicting reference in Workflow Designer, review dependent questions and logic, and publish the update before merging. Do not delete the property from Data Manager to resolve a configuration conflict. If an in-progress workflow contains both properties and blocks the merge, contact Ironclad Support before proceeding.
- Click the pencil icon in the upper right corner.
-
Scroll to the bottom of the panel, then click Merge.
-
In the modal that appears, click the With dropdown, then select the standard preset property you wish to merge the custom property into.
- Confirm that you selected the correct standard target property and retained your exports. Click Merge.
- Locate and select the standard property that retained the merged data.
-
Scroll down to Schema, then select the View next to Retired properties. In the modal that appears, you should see the custom property listed.
- Validate the retained property values on affected records and review affected in-progress workflows, views, and integrations. Record the result in your tracking spreadsheet. Repeat steps 6–13 for each additional eligible same-type merge, validating each result. Then continue to Step Three.
Step Three: Add the Lifecycle Preset and Update Workflow Configurations
After completing eligible same-type merges, add the Lifecycle Preset to your existing workflow configurations to support consistent lifecycle tracking. Review references to merged properties and replace any remaining custom properties, including properties whose historical record values still need to be migrated in Step Four.
- In Ironclad, navigate to Workflow Designer.
- Select an existing configuration (published or unpublished).
-
In the left hand metadata panel, click Add Lifecycle Preset.
-
If you have conflicted properties, in the modal that appears, click Replace conflicts & add lifecycle preset.
Note:
Conflicted properties refer to properties that already exist in the configuration that have the same names and types as those contained in the preset. These will be accounted for in the following steps.
- If you had any conflicted properties with associated form questions prior to adding the preset, those questions will be retained. However, upon adding the preset, a new launch form question will be automatically generated, associated with that same property. To remove unnecessary duplicate questions, choose from the following options:
- Delete the original question
- Delete the newly generated question in the Contract Lifecycle section of the launch form
- If you had any conflicted properties that contained formulas, those formulas will be retained. However, Ironclad will show an error for that property, since the preset automatically adds a launch form question associated with that property, and formula properties cannot be referenced in forms. To resolve, choose from the following options:
- Remove the formula from the property
- Delete the associated launch form question
-
Upon adding the Lifecycle Preset, within the Create tab, a new section is added to the launch form titled “Contract Lifecycle.”
This section functions just like any other section form.* Edit the section and its questions to your liking, including:- Changing its name and description,
- Displaying it in either Both Create and Review or just Review,
- Moving the section up and down the form to reorder it among other sections,
- Reordering the questions within the section,
- Editing questions and help text within the section,
- Adding default values to questions,
- Locking questions
- Adding additional questions to the section that were not part of the default preset that you consider lifecycle-related data and want to categorize it as such
Note:
The exception to this rule is the Renewal Type question in the Contract Lifecycle section. This question’s options cannot be edited, nor removed. However, you can set a default value and lock the question, if that value will be the same for all of the contracts generated from the workflow configuration.
-
If desired, delete any properties, questions, and conditions that will never be applicable from the configuration entirely. For example, if the contracts generated from this configuration will never expire or renew (in other words, their Renewal Type is always Evergreen), you may choose to delete the following:
Item Type(s) Other Renewal Type Form Question Initial Term Length Property; Form Question Expiration Date Property; Form Question Renewal Term Length Property; Form Question Renewals Allowed Property; Form Question Renewal Opt Out Period Property; Form Question Renewal Type is Auto-Renew Condition Renewal Type is Optional Extension Condition Renewal Type is Auto-Renew OR Optional Extension Condition Renewal Type is None Condition Renewal Type is not Evergreen Condition Renewal Type is Other Condition Note:
In this particular scenario, you may also choose to set the Renewal Type question’s default value as Evergreen and lock it. Or, you may choose to remove the Renewal Type question from the launch form altogether and instead add “Evergreen” as a hardcoded value for the Renewal Type property with a formula.
-
Please refer to Use the Lifecycle Preset in Workflow Designer to verify which properties should never be removed from a configuration in order for lifecycle tracking mechanisms in Ironclad to function properly. If needed, add deleted properties or conditions back to the configuration by clicking Add property back to preset.
- Using the tracking spreadsheet from Step One, review each configuration for references to properties merged in Step Two. Replace any remaining custom properties with their corresponding preset properties, and update your spreadsheet. For example, replace a remaining Term Length property with Initial Term Length where appropriate. Review all places the property may be referenced, including:
- in the left-hand metadata panel,
- on the document,
- in forms in the Create tab,
- within conditions,
- within formulas of other properties,
- in custom emails, and
- in the Archive tab beneath Additional record properties.
- Review dependent approval and signer assignments and any integration mappings. Test the updated configuration, preferably in a non-production environment, and resolve errors before saving and publishing it. Confirm that future workflows will use the intended standard properties. Updating a configuration does not transfer existing record values; complete Step Four for properties that require a data migration.
- Repeat steps 2–11 for each additional workflow configuration in scope, and record the changes in your tracking spreadsheet.
Step Four: Migrate Lifecycle Data Between Different Property Types
Use this procedure when a custom property and its corresponding standard Lifecycle Preset property have different data types. Data Manager cannot merge these properties. Instead, transform the existing record values and import them into the standard properties, validate the results, and then remove the old custom properties from those records. Complete the configuration updates in Step Three first.
-
Open the tracking spreadsheet created in Step One and updated in Step Three. Identify the properties marked for a different-type migration. The following examples show custom properties and their corresponding standard targets:
Common Custom Properties Corresponding Standard Preset Property - Term Length (number) & Term Length Unit (text)
Initial Term Length (duration) - Auto-Renew = True/Yes (boolean)
Renewal Type = “Auto-Renew” (text/string) - Optional Extension = True/Yes (boolean)
Renewal Type = “Optional Extension” (text/string) -
In Ironclad, click the Dashboard tab. Ensure you are in the All view.
-
Using your tracking spreadsheet, add both the source custom properties and the target standard preset properties as columns in the view. Include the source values needed to calculate the target values, and limit the view to the records you intend to migrate.
-
Click Save to save this view as a custom view with your desired name.
-
In the upper right corner, click the three stacked dots > Export view.
-
In the modal that appears, in the Data column dropdown, ensure Visible columns is selected. Then, click Export.
- Within a few moments, you will receive an email from Ironclad with a link to download the exported .csv file. Keep an unchanged copy, then open a working copy in your spreadsheet application. This guide uses Excel. Do not remove the Record ID column.
-
Use Excel formulas to transform source values into the target Renewal Type column. For example, if column C contains boolean Auto-Renew values and column B contains boolean Optional Extension values, use
=IF(C2=TRUE, "Auto-Renew", IF(B2=TRUE, "Optional Extension", "None")). Adjust the cell references to match your file. This example gives Auto-Renew priority when both values are TRUE and uses None when neither is TRUE. Review blanks, conflicting values, and existing Renewal Type values before applying the formula.Note:
The values in the Renewal Type property are extremely important, as they govern how the Ironclad system will track key contract lifecycle, renewal, and expiration dates. To review what each Renewal Type value means, refer to Use the Lifecycle Preset in Workflow Designer in the Help Center.
- To transform text/string data types into the duration data type, input the time durations in the ISO 8601 duration format in the Initial Term Length, Renewal Term Length, Renewal Opt Out Period, and/or Termination Notice Period columns, as needed. For example: 1 year and 6 months = P1Y6M; 2 years = P2Y; 30 Days = P30D, etc.
- After calculating and validating the target values, keep the source columns in your unchanged backup. Prepare the import file with Record ID and the target properties you intend to update. Do not import blank source-property values to clear the old data; remove the old properties from records only after validating the migration below.
- When your spreadsheet is complete, save it to your desktop or device as desired.
From the Dashboard, click the three dots in the upper right corner > Import metadata.
- On the following page, click New Import. Then, upload your spreadsheet.
-
On the Map CSV headers to property names page, align the spreadsheet headers with the intended standard Lifecycle properties. At the bottom of the page, match records on Record ID.
- Click Next: Preview.
- Click Start Import. If Ironclad detected any errors with your spreadsheet, they will be flagged on this page. You must resolve any errors and reupload the file to proceed successfully.
- After the import is complete, open the saved view and compare the standard Lifecycle property values with your source export. Verify the transformation results and any previously populated target values before removing the old custom properties.
- Confirm that the view contains only records whose migration you have validated. Select the checkbox to the left of the headers to select those records.
- Click Edit properties in the upper right corner to use Bulk Actions to remove the “old,” unused properties from those records.
-
In the modal that appears, select Remove and add the unused properties.
- Click Remove. Update your tracking spreadsheet and recheck the old properties' usages in Data Manager. The old properties should no longer be used on the records you migrated. If you completed Step Three for all configurations in scope, those configurations should also no longer reference them. In-progress workflows or other records may still use the properties. Do not proceed to deletion until all remaining usages have been resolved.
Step Five: Delete Unused Properties from Your Account
After validating the merges, migrations, and workflow configuration changes, delete custom properties that you no longer need and that have no remaining usages. Keep your exports and tracking spreadsheet for reference.
You can only delete custom properties with 0 usages in your account. You cannot delete system-generated (“standard”) properties, and you cannot delete custom properties with any usages in published workflow configurations.
Before deleting a property, review its usages and check both published and unpublished workflow configurations for remaining references. Also review in-progress workflows, records, views, reports, and integrations. Remove or update references where appropriate, and resolve any remaining usages before proceeding. Do not delete a property to work around a blocked merge.
Warning: Deleting an event or property is a permanent action that cannot be undone. Verify that you no longer need the data before proceeding with the deletion.
To learn more about how to clean up your data, refer to Clean Up Your Data Using Data Manager.
- In Ironclad, navigate to Company settings > Data Manager.
- Add the System generated column to the view. This will differentiate standard (System generated = Yes) and custom (System generated = No) properties.
- Click the System generated column to sort the properties by System generated = No, so that the properties at the beginning of the list are those you are able to delete.
- Click the Usages filter, then deselect All usages. This will show properties with 0 usages in your account.
- Select a property you want to delete, then click the pencil icon in the upper right corner of the right hand panel.
- Scroll to the bottom of the panel, then click Delete.