Upsert® Masked TextField

System requirements for installation

Supported Versions

• 9.x
• 10.x
• 11.x
• 12.x

Supported Editions

• Sell
• Serve
• Enterprise
• Professional

Supported Databases

• MySQL
• MSSQL
• Oracle
• DB2

Supported Languages

• English

Overview

Upsert Masked TextField is a custom field type in Sugar that allows administrators to conceal the values of certain fields containing data such as social security numbers and other PII, that is better shown on a need-to-know basis. The Upsert Masked TextField is available as field type to all administrative users in Studio..

Installation

Once you complete your order for the Upsert Masked TextField 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 Masked TextField 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, proceed to the ‘Configuring Masked TextField in Studio' section.

Configuration

Once Upsert Masked TextField is installed, you can begin creating masked text fields in Studio.

Creating Masked TextFields in Studio

To configure a Masked Textfield:

1. Go to Admin > Studio
2. Select the module you would like to create a field for (Contacts, for example)
3. Select the ‘Fields’ component
4. Click ‘Add Field’
5. Set the ‘Data Type’ to ‘Upsert Masked TextField’ 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.

Utilization

Using Masked TextFields

Once a Masked TextField is added to a module layout, you can add and edit information in the field like standard text fields in Sugar. The field will be populated with asterisks if there is information saved. If you mouse over the field, two additional icons will appear:

• Eyeball - Toggles the visibility of the information saved in the Masked TextField
• Stacked paper - Copies the information stored in the Masked TextField to your clipboard

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 > Module Loader
3. Go to Admin > Studio
4. Delete any masked text fields you previously created
5. Locate the ‘Upsert Masked TextField 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 Masked TextField 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.