Converting Columns Between Text and WYSIWYG
Administrators can convert column types between Text and WYSIWYG without losing data. This optimizes record management across the platform and the portal.
You can convert columns in any table except the system tables (having the sys prefix) and the Platform application tables.
Role required: admin.
Performing conversion
To convert a column, perform the following steps:
- Open the column record you want to convert.
- In the burger menu , select Convert to WYSIWYG (or Convert to Text).
- Click Convert.
If any system scripts can break due to the column type change, a warning message and a list of the affected scripts appear in a modal window. You can proceed with the conversion and update the listed scripts later.
Column names within the system are not unique. Be careful when updating scripts after the conversion, ensure your fixes apply only to the scripts that reference the converted column in the target table, and do not update the scripts that reference the columns with the same name from the other tables.
By default, the WYSIWYG data is represented as text in responses to the Table API requests.
To pass data as a JSON-structured WYSIWYG, specify the column ID in the wysiwyg.columns.rest_api_json_mode system property.
To pass data of type WYSIWYG as a text in scripts, specify the column ID in the wysiwyg.columns.scripts_text_mode system property.
When the conversion finishes, a modal window displays one of the following status results on the column form:
- Completed: The column type changed successfully, and all records were updated.
- Partially completed: The column type changed, but some records were not updated. Error details are stored in the Main Log (sys_log). The conversion finishes automatically once you fix the errors.
- Error: The column type did not change. Error details are stored in the Main Log (sys_log).
Reverting the conversion
To revert a column to its original format, repeat steps 1–3 from the Performing conversion section.
If there are unresolved record conversion errors, you will be able to revert the column type only after 30 days. This limitation is due to the platform's retention period for column VCS records.
If the conversion completed without errors or all errors were resolved, you can revert the column type immediately.
Converting the column back to its original type restores the script's functionality if the script was not updated after the first conversion.