Skip to main content

Soft Deleter Installation Guide

Raise a support ticket

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

  1. In Content Manager Click on The Home Tab, click on the Create New Button

    image.png

  2. Select Location from the drop-down menu

    image.png  

  3. When the New Window appears Select Group and Click on the OK button

    image.png

  4. 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

    image.png  

  5. In the Profile Tab set the security of the Group so that it has the following settings

  • Bypass all access controls

  • Highest Security

    image.png

  1. 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.

  2. Right click on the properties pane and select Customize

    image.png

  3. Locate and Highlight Unique Identifier from Available Fields List and Click on the Add button

    image.png  

  4. The Unique Identifier will be added to the Display Fields list, click on the OK button

    image.png

  5. The Unique Identifier of the group will now be displayed in the properties window

    image.png

    Note

    You are not required to add any users or administrators under this Group location yet

INSTALLATION​

  1. Create an FYB Add-ins folder on the appropriate server that contains Content Manager

    image.png

  2. Right click on the FYB Add-ins folder > Properties > click on the Sharing tab

    image.png

  3. Click on the Advanced Sharing button

    image.png

  4. 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

    image.png

  5. Click on the Permissions button

  6. Give Everyone the Full Control permission

    image.png

  7. A Network Path will now be available

  8. 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

image.png

  1. Place the license file in this folder Note: You will be asked to enter the shared path of this file during the installation

  2. Launch the softdeleter-xxx-32bit/64bit.msi

  3. Click on the Next button

    msi1.png

  4. On the Configuration Settings screen, enter the information from the below table and click on the Next button

    image.png

    NAMEDESCRIPTION
    Dataset IDThe two-character dataset identifier
    Workgroup Server NameThe workgroup server name used to connect to the dataset. Connection to the dataset can be completed using either the workgroup name or workgroup URL
    Workgroup Server URLThe workgroup server URL used to connect to the dataset. Connection to the dataset can be completed using either the workgroup name or workgroup URL
    License PathThe shared path to your license file, including the ".lic"
    Temp PathThe shared path to the temporary path where the logs are stored
    Use Event ProcessorIf enabled, soft deletion is delegated to the Event Processor
    Soft Delete Location UriUri of the Soft Delete group location
  5. If your environment is configured to only allow OpenId authentication (e.g. Azure AD or ADFS) for your Content Manager, you'll receive the following message:

    image.png

    Note

    If you have not already, please ensure you are using a Workgroup Server URL not the Workgroup Server Name for the connection defined on the previous screen

  6. Click OK to navigate to the Open Id settings screen and enter the required values.

    image.png

    Note

    Please refer to the below guides on how to configure the Confidential Client App and Trusted User:

    NAMEDESCRIPTION
    Client IdThe Client/App Id of the Open ID application used to secure Content Manager. For ADFS authentication, this will be the username of the Confidential Client app.
    Client SecretThe Client/App Secret of the Open ID application used to secure Content Manager. For ADFS authentication, this will be the password of the Confidential Client app.
    Trusted UserThe Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app.
  7. On the External Link screen, allows for the set up of the External Link via Soft Deleter. This is optional and can be skipped.

    image.png

    NAMEDESCRIPTION
    Link NameThe name used for the external link within Content Manager
    Folder PathThe shared path to your installation path
    Record Type URIsThe record type URIs used within the external link, separated by commas ','
  8. On the Destination Folder screen, select the install location, click on the Next button

    Note

    The installation location must be inside the FYB Add-ins folder you created earlier in this guide.

    2021-11-22_10-52-27.jpg

  9. On the Confirm Installation window, click on the Install button

    msi4.png

  10. The installation will commence

    msi5.png

  11. Click on the Finish button

    msi6.png

COMMAND-LINE ARGUMENTS (OPTIONAL)​

The following command-line arguments can be passed to the MSI if required.

ARGUMENTPURPOSE
DBIDSets the Database ID that connects to Content Manager dataset to run the application
WORKGROUP_SERVERSets the Workgroup Server Name that connects to Content Manager dataset to run the application
WORKGROUP_SERVER_URLSets the Workgroup Server URL that connects to Content Manager dataset to run the application
LOCATIONSets the Soft Deleter Group Location. This value must be the URI of the Location Group in Content Manager
LICENSE_PATHSets the license that connects to the application
TEMP_PATHSets the shared path to the temporary path where the logs are stored

CONFIGURATION​

CREATING THE EXTERNAL ICON​

  1. Open Content Manager and click on Tools> Administration > External Icons

  2. Right Click, and select New External Icon

  3. Enter the Name as Soft Deleter Icon

  4. Enter the File Name by selecting the SoftDeleter.ico from the installation path of the Soft Deleter External Link.

    image.png

info

If the external link was created by the MSI, this step can be skipped

  1. Open Content Manager and click on Tools > Administration > External Links

  2. Click on New Executable

  3. Enter the Link Name as FYB Soft Deleter

  4. Under ‘Folder or Subfolder’, enter the Network Location of the FYB Add-ins\Soft Deleter folder obtained in the INSTALLATION section

  5. Under Executable File Name browse to the Soft Deleter folder and select the executable file

    image.png

  6. Check “Link supports tagged processing”

  7. Enter ^!Urilist^ into the Command Line Parameters when doing tagged processing field.

  8. Check Use tagged command line format for single selection

    2021-11-25_12-23-34.jpg

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

    2021-11-25_12-25-25.jpg

PUBLISHED ADDITIONAL FIELD​

Note

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.

  1. Perform a search for all Additional Fields

    image.png

  2. Right-click and select new Additional Field from the right-click menu

    addf1.png

  3. In the New Additional Field Window select Boolean for the data format and click on the Next button

    addf2.png

  4. Enter Published? Into the name field and click on the Next button

    Note

    There is no specific name required, the name can be determined based on your domain requirements to mark a record as being published.

    addf7.png

  5. In the Applies To window click on the Finish button

    addf4.png

  6. Once the Published Additional is created, it will need to be enabled for the required Record Types

INSTALLING THE EVENT PROCESSOR ADD-IN​

Note

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.

Content Manager Settings Required

Within Content Manager > System Options ensure to enable 'Create events for notifying modifications to additional field values' this will make sure the event add-in can identify any soft deleted records.

Image

INSTALLATION​

  1. Identify the server that handles the Content Manager event processing

  2. Extract the files from the softdeletereventaddin.zip to the installation directory of Content Manager. For example: C:\Program Files\Micro Focus\Content Manager

  3. Open the SoftDeleterAddin.dll.config file and update as follows.

    image.png

    NAMEDESCRIPTION
    SoftDeleteGroupUri of the soft delete group location.
    LogFolderThe location that the log file will be written to if any errors are produced.
    RemoveCaveatsRemove any attached security caveats on records when soft deleting.
    TempFolderUri of a temporary folder in Content Manager. The event add-in will use this folder to temporarily store deleted documents
    LicenseThe local path to your license file, including ".lic"
    PrependTitlingThe title that will be prepended to the soft deleted record's title. If this is not populated no additional titling will be added.

CONFIGURATION​

  1. Open Enterprise Studio and drop down the Datasets list

    image.png

  2. Right-click on the Dataset that the Soft Deleter Add-in is to connect to click on Event Processing then Configure

    image.png

  3. Click on the Custom Processes tab then click on the Add button

    image.png

  4. Enter in the following details and click on the OK button

    image.png

  5. Click on Test to ensure you receive a message indicating that the Add-In has loaded successfully

  6. Set Configuration Status to Enabled and Run-on Workgroup Server to the Event Processing Server

    image.png

  7. 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.

  1. Perform a search for all Additional Fields

    image.png

  2. Right-click in the search results and select new Additional Field from the right click menu

    addf1.png

  3. In the New Additional Field Window select Boolean for the data format and click on the Next button

    addf2.png

  4. Enter exactly Soft Deletion Requested Into the name field, set the Abbreviation to SDR, and click on the Next button

    addf3.png

  5. In the Applies to Window click on the Finish button

    addf4.png

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