Configure access to the Client Data Management Utility

Whether
Workpapers CS
is installed locally or in a network environment, the Client Data Management Utility uses a temporary path during the backup and restore processes. The default folder used for the temporary path is the SQL server data location, such as
X:\Program Files\Microsoft SQL Server\<SQL_Instance_Name>\MSSQL\Data
(where X represents your local or network drive).
Internal use only:
CDMU calls can be handled by non-System reps. Remember, System reps are not trained on CDMU.
You cannot access the Client Data Management Utility in
Workpapers CS
when the local machine's path to the SQL server data location doesn't match the server machine's path to the SQL server data location, or when you don't have full permissions set up to access the SQL server data location.
important
We recommend that you notify your certified IT professional and advise them of the issue.
Follow these steps for each workstation if you receive a message that indicates an issue with the path to the SQL server data location, or if your IT administrator makes significant changes to your SQL server (for example, an installation of a new SQL instance). This procedure shows you how to add an alternate temporary path in the NetworkInstallation.ini file that will be used instead of the default SQL server data location when you launch the application.
note
Make sure that you can view file extensions in Windows Explorer before completing the following steps.
  1. Close
    Workpapers CS
    .
  2. Add a new subfolder in the WINCSI folder, such as \\SERVER\WINCSI\ClientBackup (where \\SERVER represents the location of your WINCSI folder).
  3. In Notepad or a similar text editor, open the NetworkInstallation.ini file (not the NetworkInstallation.ini.readme file) for
    Workpapers CS
    found at \\SERVER\WINCSI\
    Workpapers CS
    (where \\SERVER represents the location of your WINCSI folder).
  4. Enter the following line in the [appSettings] section of the file, using the following format and the path you created in step 2 after the equal sign:
    ClientBackupRestoreWorkingPath=\\SERVER\WINCSI\ClientBackup
    important
    When you add the alternate path in the NetworkInstallation.ini file, be sure that you are referencing the UNC (universal naming convention) path and not a path for a mapped drive, which often varies across different computers.
  5. Save and close the NetworkInstallation.ini file.
  6. Reopen
    Workpapers CS
    and select
    File
    , then
    Client Data Management Utility
    .
    note
    • If the SQL version used to create the client backup file is newer than your current SQL version,
      Workpapers CS
      will not allow you to select the file and display a message about the SQL versions in use. To continue with restoring the client backup file, contact your certified IT professional or contact our Support team and ask about alternate configurations to allow the file to be restored.
      Internal use only
      If a customer needs to restore data to a database using a SQL version that is older than the SQL version the database the backup was created from, pass along the following information:
      • Option 1: Upgrade the SQL version of the instance hosting the database to restore the file into.
      • Option 2: Install a new SQL instance (even if it's the free Express edition) side-by-side with the SQL instance hosting the database. Take note of the new MACHINENAME\SQLINSTANCE. Open the NetworkInstallation.ini file and update the following line items in the [appsettings] section:
        • DisableCDMUSqlServerVersionValidation=true
        • ClientRestoreDBServer=MACHINENAME\SQLINSTANCE
    • In some circumstances with restrictive network permissions (for example, when integrating with other applications or reading/writing files from/to your local and network drives), you may need to run the application as an administrator (by right-clicking the
      Workpapers CS
      icon, choosing Properties, and marking the
      Run this program as an administrator
      checkbox in the Compatibility tab).

Permissions

There are 2 users who need full permissions to the backup folder:
  • The user making the backup.
    In most situations, this should not need any changes if you are using a folder in the WINCSI folder because the user already has full control.
  • The user account that is running the SQL server service.
    To find the user account:
    1. Select
      Start
      ,
      Control Panel
      ,
      Administrative Tools
      , then
      Services
      .
    2. Right-click the
      SQL Server
      service and select Properties.
    3. Select the
      Log On
      tab to see the user account that is displayed. For SQL 2014 and higher, a user with the instance name is created (e.g., Service\MSSQL$SQL2014, where my instance name is SQL2014.)
    To set the permissions for the user account:
    1. Right-click the folder you created for backups and select Properties.
    2. On the
      Security
      tab of the folder, provide full control for the user account.
    3. On the
      Sharing
      tab, select the
      Advanced Sharing
      button, and then the
      Permissions
      button. Set the permissions to enable access to the shared drive or folder.
note
The SQL instance should be configured so that the CreativeSolutionsPracticeCsDatabaseOwner user has the
sysadmin
role.

Error logs

Error logs can be helpful in figuring out what the cause of the problem is. You can find the error logs at C:\users\{windows login}\appdata\local\Creative Solutions\
Workpapers CS
\log.txt.
  • An error that includes the words "Unable to determine local path to server file" most likely means that the path doesn't exist, although it may also be a permissions issue:
    CS.Accounting.Schema.BackupRestoreDataErrorsException: map FS1\CREATIVESOLUTION, \\FS1\W:\BackupRestoreTempPath\dummy_e8892f37b57949a99a011176673cf6fd.junk ---> System.InvalidOperationException:
    Unable to determine local path to server file:
    \\FS1\W:\BackupRestoreTempPath\dummy_e8892f37b57949a99a011176673cf6fd.junk at CreativeSolutions.Common.DataAccess.SqlServer.SqlServerAccessProvider.MapFileServerToLocalPath(String serverName, String filePath)
  • An error that includes the words "Access Denied" always points to a permissions issue:
    CS.Accounting.Schema.BackupRestoreDataErrorsException: map FS1\CREATIVESOLUTION, \\FS1\WinCS\AccountingCSBackup\dummy_ae4d7fa18fc8402fa353f1e956e2abd4.junk ---> System.Data.SqlClient.SqlException: Cannot open backup device '\\FS1\WinCS\AccountingCSBackup\dummy_ae4d7fa18fc8402fa353f1e956e2abd4.junk'. Operating system error 5(
    Access is denied
    .)

Error: The path to the SQL server data location ... does not exist or you do not have proper permission to it

For non-network installations
: You can resolve this error message by following the path listed in the message and opening the folder. Do not change anything in this folder, just open it and give yourself permission to the folder when prompted. If
Workpapers CS
was open when you opened the folder, make sure to close and re-open the program again.