Upsert® Markdown Field

Prerequisites

System requirements for installation

Supported Versions

• 12.x

Supported Editions

• Sell
• Serve
• Enterprise
• Professional

Supported Databases

• MySQL
• MSSQL
• Oracle
• DB2

Supported Languages

• English

Overview

Upsert^® Markdown Field is a custom field type in Sugar that allows users to use markdown text for tables and lists in a textarea field.

The Upsert^® Markdown Field is available as a field type to all administrative users in Studio.

Installation

Once you complete your order for the Upsert^® Markdown Field plug-in, you should receive an email with instructions to download the necessary file. Complete these steps to install the plug-in to your Sugar instance:

1. Log in to your Sugar instance as an admin user
2. Go to Admin > Module Loader
3. Select the Upsert^® Markdown Field ZIP file and click ‘Upload’
4. Click the ‘Install’ button
5. Review the license agreement, toggle the option to ‘Accept’, and click ‘Commit’

Once the installation completes, the Upsert^® Markdown Field will be available in Studio.

Configuration

Once Upsert^® Markdown Field is installed, you can begin creating markdown fields in Studio.

Creating Markdown Fields in Studio

To configure a Markdown Field:

1. Go to Admin > Studio

2. Select the module you would like to create a field for (Accounts, for example)
3. Select the ‘Fields’ component

4. Click ‘Add Field’

5. Set the ‘Data Type’ to ‘Upsert^® Markdown Field’ and enter all other necessary information

6. Click ‘Save’

7. Add the field to the desired layout(s) for the module

   Note: For further assistance navigating Studio, please refer to the documentation for your version and edition of Sugar.

Adding Field to Layout

Although the Upsert^® Markdown Field will function in a single column on the layout,

it is better suited for display spanning a whole row on the Record layout.

To add a Markdown Field to a record layout:

1. Go to Admin > Studio
2. Select the module you created the markdown field for (Accounts, for example)
3. Select the ‘Layouts’ component
4. Select the ‘Record’ component
5. Create a new row on the layout
6. Drag the markdown field to the new row
7. Click ‘Save’
8. Click the ‘+’ icon next to the markdown field’s name to expand the field to span both columns in the layout.
9. Click ‘Save & Deploy’

Utilization

Using Markdown Fields

Once a Markdown Field is added to a module layout, you can add and edit information in the field like standard textarea fields in Sugar. In the edit view, the field will display in plain text format with a toolbar of formatting options at the top of the field:

Selecting the side-by-side icon in the toolbar will open the field in fullscreen and enable the user to edit the field information while seeing a preview of what the formatted text will look like:

Selecting the preview view icon in the toolbar will display a preview of the formatted text:

Uninstalling the Plug-In

Follow the steps below to remove the plug-in from your Sugar instance.

1. Log in to your Sugar instance as an admin user
2. Go to Admin > Studio
3. Delete any markdown fields you previously created
4. Go to Admin > Module Loader
5. Locate the ‘Upsert^® Markdown Field for SugarCRM’ package in the list of installed packages and click ‘Uninstall’
6. Select the desired option for handling the related database tables:
   1. Do Not Remove Tables - You either want to upgrade the plug-in to a newer release or you want to retain the Markdown Field audit log data.
   2. Remove Tables - You want all data associated with the plug-in to be deleted and you have no intention of upgrading.
7. Click ‘Next’

The uninstall will process and provide a confirmation upon successful completion.