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 Contract 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.
- Add the Lifecycle Preset to Existing Workflow Configurations: You must add the preset to any existing workflow configurations, published and unpublished, in your account. New internal configurations will contain the preset automatically.
- Merge Duplicate Lifecycle Properties of the Same Data Type: Mitigate data duplication and confusion by merging equivalent custom properties with system-generated (“standard”) properties in Data Manager.
- Merge Duplicate Lifecycle Properties of Different Data Types: Use additional tools like Metadata Import and Bulk Actions to merge properties of different data types.
- Delete Unused Properties from Your Account: Remove unused custom properties from your account by deleting them with Data Manager.
Your Toolkit
- Workflow Designer: In Workflow Designer, add the Lifecycle Preset to your existing published and unpublished configurations. When needed, remove and replace custom properties with their corresponding Lifecycle Preset properties in your configurations.
- Data Manager: Manage all of your account’s properties in Data Manager. View property usages across your account, edit property settings, merge properties, and delete unused 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. Click on a dropdown below to begin:
Step One: Add the Lifecycle Preset to Existing Workflow Configurations
We recommend adding the the Lifecycle Preset to all of your workflow configurations to accurately and consistently track contract lifecycle and obligation data. If you do not add the Lifecycle Preset to your configurations, you risk having inconsistent and unreliable lifecycle and obligation data.
-
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.
-
Replace any properties in the configuration that are functionally the same with their corresponding preset properties. Use this template to track these changes to facilitate future data restructuring tasks in this guide. For example, if you currently use a Term Length property in your configuration, replace it with the preset’s Initial Term Length property in all of the places it could be in the configuration, 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.
- When ready, save and publish the workflow configuration to begin tracking standard lifecycle data points.
-
Repeat steps 2-10 for any additional workflow configurations in your account.
Step Two: Merge Duplicate Lifecycle Properties of the Same Data Type
Merge custom properties that are functionally the same with their corresponding standard, preset properties to ensure lifecycle and obligation data is tracked in a consistent, standardized format. You can only merge properties of the same data type with Data Manager. Proceed to Step 3 on page 11 to learn how to merge properties of different types.
-
In a tab or window, open the spreadsheet where you tracked property configuration replacements.
-
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, so that the properties at the beginning of the list are those you are able to merge with others. Note: You can only merge custom properties with 0 published workflow configuration usages. You cannot merge system-generated (“standard”) properties, and you cannot merge properties with more than 0 usages of published workflow configurations.
-
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
Notice the example custom properties listed above are all of the same type as their corresponding standard properties (e.g. date, duration). This is because you can only merge properties of the same data type with Data Manager. To merge properties of different types (e.g. a custom boolean property called “Auto-Renew” with the standard text property called “Renewal Type” with the value “Auto-Renew”), refer to Step 3. -
Once you locate the custom property, click it. In the right hand panel, under Usage, verify that published configurations is 0. If the published configuration usage is greater than 0, click the download icon to export a spreadsheet of links to the configurations that contain that property. You will have to manually replace the property in those configurations and republish them.
-
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.
-
Click Merge.
-
If desired, locate and select the standard property you merged the custom property into.
-
Scroll down to Schema, then select the View next to Retired properties. In the modal that appears, you should see the custom property listed.
-
Repeat steps 6-13 for any additional custom properties you need to merge with standard preset properties.
Step Three: Merge Duplicate Lifecycle Properties of Different Data Types
Merge custom properties that are functionally the same with their corresponding standard, preset properties to ensure lifecycle and obligation data is tracked in a consistent, standardized format. However, merging properties of different data types requires tooling outside of Data Manager, namely Metadata Import and Bulk Actions in the Repository.
-
In a tab or window, open the spreadsheet where you tracked property configuration replacements (step 9 on page 7). Refer to the list below of common custom properties that are functionally the same as preset properties of different data types:
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, navigate to the Repository. Ensure you are in the All records view.
-
Using your spreadsheet as a guide, add the preset properties into which you will merge your custom properties as columns to the view.
-
Click Save View to save this view as a custom view with your desired name.
-
In the upper right corner, click the three stacked dots > Export metadata.
-
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. Open the file in your spreadsheet application of choice (in this guide, Excel will be the example). Do not remove the Record ID column from the spreadsheet.
-
Use Excel formulas like the following to transform boolean (true/false) Auto-Renew and Optional Extension values into the singular Renewal Type column: (=IF(C2=TRUE, "Auto-Renew", IF(B2=TRUE, "Optional Extension", "None")))
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.
-
Ensure all columns with the “old” properties you are replacing are left blank.
-
When your spreadsheet is complete, save it to your desktop or device as desired.
-
In Ironclad, navigate to the Repository, then open the view you previously saved.
-
Click the three dots in the upper right corner > Metadata Imports.
-
On the following page, click New Import. Then, upload your spreadsheet.
-
On the Map CSV headers to property names page, ensure the headers in your spreadsheet are properly aligned to the standard, Lifecycle properties in your account. 16. 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, navigate to the saved view in the Repository. Verify the standard Lifecycle properties contain their proper values from the import.
-
Select the checkbox to the left of the headers (property names) to select all of the records in the view.
-
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.
-
Then, click Remove.
After this exercise, the “old” properties that you have replaced with their corresponding Lifecycle Preset properties should no longer have any record usages. If you followed the instructions in Step 1, they also should not have any workflow configuration usages. However, it is possible that these properties still have active workflow usages. This means that these properties cannot be deleted with Data Manager until those workflows are completed and the workflow usage becomes 0.
Step Four: Delete Unused Properties from Your Account
You can delete properties and record types that you no longer use. This ensures that your data stays up-to-date and free of data points you no longer use.
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.
Workflow Configuration usage refers to published configuration versions. This means, if you add a property to a workflow configuration, but have not published that version of the configuration containing the property, the property will be logged in Data Manager, but it will show 0 for configuration usage. If you delete a such property in Data Manager, any configurations containing that property will show an error message for that property.
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.