Required permissions for eShare Backup Restore tool

Using eShare Backup Restore tool requires the following permissions and settings to Windows, SQL Server, and Internet Information Services (IIS) Manager.

SQL Server permissions

The SQL principal is whoever the eShare connection string in ConnectionStrings.config authenticates as:

  • Integrated Security (Windows Auth): the principal is the Windows account running the tool (the elevated administrator).

  • SQL Auth (SQL Authentication): the principal is the SQL login whose credentials are stored in ConnectionStrings.config.

The -c / --connectionstring flag overrides this; in that case the principal is whatever the override string authenticates as.

Per-verb SQL permissions

Verb

Server-level role

Main database (EShare or per Initial Catalog)

Project databases

backupproject

none required

db_datareader

db_datareader on every project database

backupserver

none required

db_datareader

db_datareader on every project database

restoreproject

dbcreator (only when the target project database does not yet exist)

db_owner (DELETE / INSERT into Project, UserAccount, Permission, schema migrations)

db_datareader on every project database and db_owner on the target project database

restoreserver

dbcreator (for any project database that does not yet exist)

db_owner

db_owner on every project database referenced by the backup

Notes:

  • restoreserver --configs overwrites ConnectionStrings.config. After that point the tool re-initialises and may target a different SQL principal than it started with. Both must satisfy the requirements above.

  • The tool runs schema migrations during restore, this requires DDL rights on the target database. db_ddladmin alone is not sufficient because the tool also performs bulk-copy with SET IDENTITY_INSERT , which requires ALTER on the user table, so db_owner is the floor.

Windows / command-line prerequisites

All apply to every verb.

  • Console launched with Run as Administrator (UAC-elevated). The Microsoft.Web.Administration.ServerManager API the tool uses requires elevation to read C:\Windows\System32\inetsrv\config\applicationhost.config and to stop/start the eShare site and application pool.

  • Read access to the eShare site's physical path (typically C:\Program Files\Cadmatic\eShare\ ). This is needed to read Web.config, AppSettings.config, and ConnectionStrings.config.

  • Write + Delete access to the eShare site's physical path and to %ProgramData%\Cadmatic\eShare\ (only required by restoreserver --configs).

  • Write access to the backup destination passed with -d / --directory (backup verbs) or read access to the backup file passed with -f / --file (restore verbs).

  • Write access to %TEMP%\eShareBackupRestore\ , the tool unpacks and stages files there.

  • Network reachability to the eShare URL passed with -u / --url . The tool issues GET <url>/api/ServerInfo at startup to read the server version.

eShare data folders

Backup verbs read these folders and restore verbs write them. If these have been moved to a non-default location, check AppSettings.config for the override key.

Folder

Default path

AppSettings.config override key

EBM (models, scenes)

%ProgramData%\Cadmatic\eShare\ebm

Cadmatic.EbmFolderName

Document

%ProgramData%\Cadmatic\eShare\document

Cadmatic.DocumentFolderName

Maps

%ProgramData%\Cadmatic\eShare\maps

Cadmatic.MapsFolderName

Point cloud

%ProgramData%\Cadmatic\eShare\pointCloud

Cadmatic.PointCloudFolderName

During server backup/restore, the tool also reads/writes two folders under the eShare site root:

  • App_Data\icons (POI icons)

  • App_Data\markupReportTemplates (markup report templates)

Note: During restore, the tool automatically grants IIS APPPOOL\<eShareAppPoolName>. Modify rights on any files it writes into these folders. This is required for eShare to read the restored files at runtime.