The Cascading Lookup Console is a command-line tool designed to help organizations migrate SharePoint lists that use the Cascading Lookup Plus field type so they can be used with the Cascading Lookup feature in SharePoint Online.
This tool
- Converts Cascading Lookup fields into Out-of-the-Box (OOB) lookup fields so they can be migrated to SharePoint Online.
- Enables conversion from OOB fields to Cascading Lookup fields after migration.
- Provides reporting capabilities to identify where Cascading Lookup fields type are used within a site.
Prerequisites
- Must be run on SharePoint 2013 or newer.
- KWIZ Cascading Lookup must be installed before using this tool.
- Must be run by a user with sufficient permissions to modify sites and columns.
Usage Instructions
- You must specify a scope for this tool: either a site URL or a CSV file with multiple sources.
- You can specify list and column names for the tool, If omitted, the tool will process all lists and columns within the given scope.
Best Practices
- It is highly recommended to use the verbose logging option and save the log file with the
-v and -z switches. This allows changes to be revert and restore your column settings to its condition prior to running this tool should the need arises. - It is highly recommended to test the tool in a non-production environment before running it in production. The use of this tool is subjected to the EULA agreement and conditions that came with the Cascading Lookup product license.
- It is highly recommended to use scan-only mode first (
-x switch) first to generate a report without making any changes to the server. Always review the log file before proceeding for errors and warnings, before running it again without the scan only switch.
Command
clc -o [operation] [additional switches]
Switches
|
|
|
|---|
|
|
Required. Specifies the operation to perform:
• UpdateSettings – Modify source/target web and list settings.
• FixRelations – Perform system update on each list item to fix broken relations.
• ConvertToApp – Convert the column to an out-of-the-box (OOB) lookup for use with Cascading LookApp.
Use --scan-only to produce a warning report without committing changes.
• ConvertToFTC – Revert the column back to the FTC Cascading Lookup after running ConvertToApp. Use if breaking changes are found in the app version.
|
|
|
Provide a CSV file with a list of sources:
• Column 1: Site URL (required)
• Column 2: List name (optional)
• Column 3: Column name (optional)
If list or column names are missing, all lists/columns will be scanned.
|
|
|
|
|
|
Specify the list name. If omitted, all lists in the site will be scanned.
|
|
|
Specify the field (column) name. If omitted, all fields in the list will be scanned.
|
|
|
(Default: false) Run in scan-only mode. Produces a report without making changes.
|
|
|
Provide a path/name for the output log file. A CSV-formatted log will be created.
|
|
|
(Default: false) Enable verbose logging in the log file. Recommended in production for easier rollback in case of errors.
|
|
|
|
Examples
Convert the "Country" Cascading Lookup in the "Contact" list on a specific site to the app version:
clc -o ConvertToApp -s https://portal.company.lab/siteA -l Contacts -f Country -v -z log.csv
Convert back to Cascading Lookup in case there is a problem with the app:
clc -o ConvertToFTC -s https://portal.company.lab/siteA -l Contacts -f Country -v -z log.csv
Convert all Cascading Lookup columns in the site to the app version:
clc -o ConvertToApp -s https://portal.company.lab/siteA -v -z log.csv
Convert a list of sources from a CSV file to the app version (see Sample Source.csv for more info):
clc -o ConvertToApp -c sample sources.csv -v -z log.csv