NewLogoMicroworksSmallest.png
menu

ATTACHMENTS

Configuring attachments using file share

March 5, 2024

CaseManager_Icon.png

Hugo Breedt

VoyagerNetz and Case Manager SA

bigstock-Man-Pushing-A-Start-Button-Wit-226805050.jpeg

File share attachments

Case Manager supports file attachments to cases by making use of the extensions. At the time of writing this post, there are two extensions available: one to access file attachments via an FTP protocol, and another making use of Windows folders shared on a local network. In a previous blog post we walked through setting up SFTP on Azure Cloud Storage to save our Case Manager file attachments securely in the cloud. Here, we will look at setting up a local shared folder.

Video Overview

Installing the extension

The Case Manager Attachment File Share extension makes use of a shared location on the network, specified as a setting, to create separate subfolders per case to store associated files. A case’s associated folder can be accessed by clicking the silver paperclip icon on the toolbar.

WindowsAttachmentScreenshot 7

If the Attachments icon is not available on the toolbar, it may be that the extension is not installed. This can be verified in the Configuration Tools in the Extension Management section. If “Attachment File Share” is listed and active, you may have to customize the toolbar to view the button. This can be done by an administrative user in Case Manager by right-clicking on the toolbar and selecting “Customize”. Under the Commands tab you will find a list of toolbars each with its actions. The Attachments action can be found in the “Basic” toolbar. From the commands list you can drag the Attachments action to an appropriate location on the toolbar. When you close the customization form, you will be able to save the toolbar customization.

If, however, the Attachment File Share extension is not listed in the Extension Management section you will have to install it. Click “Add Extension” and browse to the extension file:

CaseManager.Extension.AttachmentFileShare.dll

This file may be in the CaseManagerExtensions folder on the server, or can be downloaded from the casemanger.tech website.

When the file is loaded you will need to confirm the extension to be installed. This may include a database installation process, depending on whether the extension was previously installed in the system. After completion the Attachment File Share extension will be listed in the Extension Management section.

WnidowsAttachmentScreenshot 8

Setting up the extension

If the extension is installed and active, opening the Extension Settings in the Configuration Tools will present extension-specific settings. The Attachment File Share has only one setting, the network location of the file attachments. Note that the network path is specified, for example \\server\CaseManagerAttachments and not a local path (such as C:\CaseManager\CaseManagerAttachments ) since this will be used by the agent workstations to connect to the server location.

WindowsAttachmentScreenshot 9

Network Setup

Access to the case-associated attachment folders are not managed by Case Manager, but instead by the protocols and settings provided by the Windows operating system. The extension settings in the previous section will simply point Case Manager to the right location; an administrator is still required to set up the network to allow users the required access. This blog article makes a few suggestions to allow network access to workstation, but it remains vital for the administrator to understand the security impact of the decision made and settings set.

Choosing a Location

Any folder on the network can be used for Case Manager attachments, given that users on the network have both read and write access to this location. In general, we make use of the CaseManagerAttachments folder in the CaseManager folder on the server. Other folders in the CaseManager folder are typically shared on the network as well, such as the CaseManagerApps folder to install the applications on the agent workstations. For this folder, however, you do not want to give write access. The security settings will be covered in the Share the folder section of this post.

It is also important to take the chosen folder for attachments into consideration for your backup processes. Since the attached files are stored in the Windows file system and not in the Case Manager database, they will not be included in the database backup. Your backup processes should therefore include at least the database backup file (.fbk) and the attachments folder.

Configure the Network

File Sharing in Windows requires the network to be a Private Network and to have file sharing enabled. Our first steps to sharing the attachments folder will be to verify that the network is set up to allow this.

Windows 10

  • Open the Windows (Start) Menu and open Settings. Click on Network & Internet.
  • Verify that the network is Private. If not, click on Properties and select Private Network.

WindowsAttachmentsScreenshot
  • Back in the Network & Internet setting, click “Change advanced sharing options”
    • In the Private Networks section
      • Turn on Network Discovery
      • Turn on file and printer sharing
WindowsAttachmentScreenshot 2
    • In the All Networks section
      • You may keep the Public folder sharing off
      • Choose Use 128-bit encryption. If you have older versions of Windows connecting to this server you are required to choose lower encryption.
      • Password-protected sharing requires that a user connect to a local user on the machine. Typically we leave this setting off. This however can be switched on should you prefer this behavior.
    • Save the settings.

WindowsAttachmentScreenshot 3
  • We will make use of the server name to connect to the shared folder over the network. If you are unsure of the name of the server you may type in “View PC name” in settings search to view system information such as the name of server.

Windows 11

  • Open the Windows (Start) Menu and open Settings. Click on Network & Internet.
  • Verify, next to the network name, that the network is Private. If not, you may change this setting by clicking on Properties.

WindowsAttachmentScreenshot 4
  • In the Network & Internet settings, click on Advanced Network Settings. In the window opened, click on Advanced Sharing Settings
    • In the Private Networks section
      • Turn on Network Discovery
      • Turn on file and printer sharing
    • In the All Networks section
      • You may keep the Public folder sharing off
      • Choose Use 128-bit encryption. If you have older versions of Windows connecting to this server you are required to choose lower encryption.
      • Password-protected sharing requires that a user connect to a local user on the machine. Typically we leave this setting off. This however can be switched on should you prefer this behavior.

WindowsAttachmentScreenshot 5
  • We will make use of the server name to connect to the shared folder over the network. If you are unsure of the name of the server you may type in “View your PC name” in settings search to view system information such as the name of server.

Other versions of Windows

The required settings remain the same for other versions of Windows. How to navigate to these settings may differ a bit. In essence, be sure that:

  • The network is set to Private
  • Network discovery, and File and Printer Sharing are both on for Private Networks
  • On all networks you may typically disable the Public folder sharing, use 128-bit encryption, and disable password-protected sharing.

Share the folder

  • Browse to the chosen attachments folder in Windows Explorer.
  • Right click the folder and select Properties. Select the Sharing tab.
  • Click Advanced Sharing
  • Enable “Share this folder”
  • You may edit the Share Name. Typically, when the folder in the CaseManager directory is shared, CaseManagerAttachments is used - the same as the folder name.
  • Click on Permissions. This will show a list of all the users who can see this folder.
  • Here, you may consult your network administrator. In general, we may share this folder with everyone on the network. If “Everyone” is not listed in the list of group or user names click Add.
    • Type in “Everyone” and click OK.
  • Select Everyone in the list and allow Full Control.
  • Click OK on the open windows until you’re on the Properties windows again.
  • Select the Security tab. If there is no Security tab, it may be that the underlying file system is the older FAT32 which does not support further security. You may then ignore the relevant steps.
  • The users/group to which the folder was shared (in step 7) also requires access to the folder. Select the appropriate group from the list (as in our case “Everyone”) to verify that Full Control is allowed . If the group (e.g. “Everyone”) is not in the list it can be added in the following steps. If Full Control is not allowed, the same step can be followed.
    • Click Edit
    • If the group (e.g. “Everyone”) is not listed, it can be added by clicking on the Add button, similar to step 7a.
    • Select the group in the list (e.g. “Everyone”) and allow Full Control.
    • Click OK.

WindowsAttachmentScreenshot 6

Test the shared folder

Once the folder is shared, you can access it via the network path: \\{SERVER}\{SHARE NAME} where {SERVER} is the name of the server hosting the attachment files, and {SHARE NAME} is name of the file share as set up. Open a file explorer window and type in the network path, for example \\CMSERVER\CaseManagerAttachments. If set up correctly, you would be able to see the contents of the shared folder. Also, create a new file - something simple such as a text file - to verify that you have write access to the shared folder. Repeat the test on another machine on the network.

The network path as described here should be set in the extension settings as explained previously. We will then be able to test attachment access from Case Manager:

  1. Open Case Manager. Note that if Case Manager was open before the extension setting was set, close and reopen the application.
  2. Open any case.
  3. Click on the silver paper clip toolbar action, “Attachments”.
  4. This should open a folder (a subfolder of the shared folder) specifically for the current case.