Soft Deleter Installation Guide
DISCLAIMER
Any advice FYB provide in relation to setting up any FYB App, FYB Add-in, FYB Connector and or advice in relation to opening access to your on-premises or in the cloud systems will be general advice only. This means that the advice is of a general nature and will not consider your network setup, network infrastructure or any security requirements that you may have or in fact need. It is highly advised that you seek advice from internal or external providers to ensure that they are comfortable with what is required prior to going ahead with any deployment, setup, or configuration for external access.
LICENSE DETAILS
Please contact FYB for a valid license if you are yet to obtain one for your Add-in.
INSTALLATION COMPONENTS
The following installation components are required to ensure full functionality of the FYB Soft Deleter:
- FYB Soft Deleter Add-in allows access to the add-in through the CM desktop client. This is a server-side deployment
- FYB Soft Deleter Event Processor add-in is required to run the Soft Deleter without the Modify record access permission (profile and folder). This is a server-side deployment
INSTALLING FYB SOFT DELETER ADD-IN
PRE-INSTALL CONFIGURATION
SOFT DELETER GROUP
As part of the Soft Deletion process, the View Metadata Access Control of the record gets updated to a specific Content Manager group. The group location must be set up in Content Manager prior to installing the add-in. Please follow the instructions below on how to create and configure the Soft Deleter Group
-
In Content Manager Click on The Home Tab, click on the Create New Button

-
Select Location from the drop-down menu
-
When the New Window appears Select Group and Click on the OK button

-
In the General Tab, enter “Group – SoftDeleter” into the Name field and mark the location as Internal. Note: There is no specific name required however a name such as ‘Group – Soft Deleter’ is appropriate and recommended
-
In the Profile Tab set the security of the Group so that it has the following settings
-
Bypass all access controls
-
Highest Security

-
Click on the OK button to create the Location. Once the Location is created, please take note of this location as this will be required for further configuration of the SoftDeleter Add-in.
-
Right click on the properties pane and select Customize
-
Locate and Highlight Unique Identifier from Available Fields List and Click on the Add button
-
The Unique Identifier will be added to the Display Fields list, click on the OK button

-
The Unique Identifier of the group will now be displayed in the properties window
NoteYou are not required to add any users or administrators under this Group location yet
INSTALLATION
-
Create an FYB Add-ins folder on the appropriate server that contains Content Manager
-
Right click on the FYB Add-ins folder > Properties > click on the Sharing tab

-
Click on the Advanced Sharing button

-
In the Advanced Sharing window, tick ‘Share this folder’ and remove the space between FYB and Add-ins, then add a ‘$’ sign which will keep the folder hidden

-
Click on the Permissions button
-
Give Everyone the Full Control permission
-
A Network Path will now be available
-
Create a folder to house the license file (.lic) on the server Note: If there is a pre-existing license folder, use the existing folder
-
Place the license file in this folder Note: You will be asked to enter the shared path of this file during the installation
-
Launch the softdeleter-xxx-32bit/64bit.msi
-
Click the Next button

-
On the Configuration Settings screen, enter the information from the below table and click the Next button

NAME DESCRIPTION Dataset ID The two-character dataset identifier License Path The shared path to your license file, including the ".lic" Temp Path The shared path to the temporary path where the logs are stored Use Event Processor If enabled, soft deletion is delegated to the Event Processor Soft Delete Location Uri Uri of the Soft Delete group location -
On the Destination Folder screen, select the install location, click the Next button
NoteThe installation location must be inside the FYB Add-ins folder you created earlier in this guide.

-
On the Confirm Installation window, click the Install button

-
The installation will commence

-
Click the Finish button

COMMAND-LINE ARGUMENTS (OPTIONAL)
The following command-line arguments can be passed to the MSI if required.
| ARGUMENT | PURPOSE |
|---|---|
| DBID | Sets the Database ID that connects to Content Manager dataset to run the application |
| LOCATION | Sets the Soft Deleter Group Location. This value must be the URI of the Location Group in Content Manager |
| LICENSE_PATH | Sets the license that connects to the application |
| TEMP_PATH | Sets the shared path to the temporary path where the logs are stored |
CONFIGURATION
EXTERNAL LINK
-
Open Content Manager and click on Tools > Administration > External Links
-
Click on New Executable
-
Enter the Link Name as FYB Soft Deleter
-
Under ‘Folder or Subfolder’, enter the Network Location of the FYB Add-ins\Soft Deleter folder obtained in the INSTALLATION section
-
Under Executable File Name browse to the Soft Deleter folder and select the executable file
-
Check “Link supports tagged processing”
-
Enter ^!Urilist^ into the Command Line Parameters when doing tagged processing field.
-
Check Use tagged command line format for single selection

-
Select the ‘Used By’ tab and ag all document record types you wish to use the add-in with

PUBLISHED ADDITIONAL FIELD
The published additional field is an optional feature of the Soft Deleter, it will prevent records that are published from being soft deleted by users.
Please follow the steps below to create a published additional field for your system.
-
Perform a search for all Additional Fields
-
Right-click and select new Additional Field from the right-click menu
-
In the New Additional Field Window select Boolean for the data format and click on the Next button
-
Enter Published? Into the name field and click on the Next button
NoteThere is no specific name required, the name can be determined based on your domain requirements to mark a record as being published.

-
In the Applies To window click on the Finish button

-
Once the Published Additional is created, it will need to be enabled for the required Record Types
INSTALLING THE EVENT PROCESSOR ADD-IN
The event processor add-in is only required in environments where end-users do not have the Modify record access permission (profile and folder). If your users have this permission then do not install the event processor add-in.
To make use of the event add-in users will require the modify additional field values permission.
INSTALLATION
-
Identify the server that handles the Content Manager event processing
-
Extract the files from the softdeletereventaddin.zip to the installation directory of Content Manager. For example: C:\Program Files\Micro Focus\Content Manager
-
Open the SoftDeleterAddin.dll.config file and update as follows.

NAME DESCRIPTION SoftDeleteGroup Uri of the soft delete group location. LogFolder The location that the log file will be written to if any errors are produced. RemoveCaveats Remove any attached security caveats on records when soft deleting. TempFolder Uri of a temporary folder in Content Manager. The event add-in will use this folder to temporarily store deleted documents License The local path to your license file, including ".lic"
CONFIGURATION
-
Open Enterprise Studio and drop down the Datasets list
-
Right-click on the Dataset that the Soft Deleter Add-in is to connect to click on Event Processing then Configure

-
Click on the Custom Processes tab then click on the Add button

-
Enter in the following details and click on the OK button

-
Click on Test to ensure you receive a message indicating that the Add-In has loaded successfully
-
Set Configuration Status to Enabled and Run-on Workgroup Server to the Event Processing Server
-
Complete a Save and Deploy
SOFT DELETION REQUESTED ADDITIONAL FIELD
The Soft Deletion Requested field is required if using the event processor. Please see the steps below to create the field.
-
Perform a search for all Additional Fields
-
Right-click in the search results and select new Additional Field from the right click menu
-
In the New Additional Field Window select Boolean for the data format and click on the Next button
-
Enter exactly Soft Deletion Requested Into the name field, set the Abbreviation to SDR, and click on the Next button

-
In the Applies to Window click on the Finish button

-
Once the Soft Deletion Requested additional field has been created it will need to be enabled on all applicable record types
