Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
3d7663c
#2546 Add upgrade to 11
pavlas77 Dec 1, 2025
34eae4b
#2546 Add upgrade to 11
pavlas77 Dec 1, 2025
55dd7c0
#2546 Add upgrade to 11
pavlas77 Dec 1, 2025
741f6ac
#2546 Add upgrade to 11
pavlas77 Dec 1, 2025
4a14b70
#2546 Add upgrade to 11
pavlas77 Dec 1, 2025
6f93e22
#2546 Add upgrade to 11
pavlas77 Dec 1, 2025
93ce7d6
#2546 Add upgrade to 11
pavlas77 Dec 1, 2025
ce0230f
Update docs/en/onsite/includes/warn-dbsetup-discontinued.md
pavlas77 Dec 2, 2025
a2204b0
Update docs/en/onsite/includes/warn-dbsetup-discontinued.md
pavlas77 Dec 2, 2025
b17aaad
Update docs/en/onsite/install/server/install-10.md
pavlas77 Dec 2, 2025
79d16b6
Update docs/en/onsite/install/server/install-10.md
pavlas77 Dec 2, 2025
086c9bd
Update docs/en/onsite/install/win-client/index.md
pavlas77 Dec 2, 2025
464dcab
Update docs/en/onsite/install/server/prepare-10.md
pavlas77 Dec 2, 2025
502f92c
Update docs/en/onsite/upgrade/to-11/index.md
pavlas77 Dec 2, 2025
afc9a6f
Update docs/en/onsite/upgrade/to-11/index.md
pavlas77 Dec 2, 2025
57cb823
Update docs/en/onsite/upgrade/to-11/index.md
pavlas77 Dec 2, 2025
9d45ebb
Update docs/en/onsite/install/server/prepare-10.md
pavlas77 Dec 2, 2025
97f0835
Update docs/en/onsite/upgrade/to-11/index.md
pavlas77 Dec 2, 2025
7e0119e
Update docs/en/onsite/upgrade/to-11/index.md
pavlas77 Dec 2, 2025
e191e5d
Update docs/en/onsite/upgrade/to-11/index.md
pavlas77 Dec 2, 2025
e728325
Update docs/en/onsite/upgrade/to-11/index.md
pavlas77 Dec 2, 2025
7958312
#2546 Add upgrade to 11
pavlas77 Dec 2, 2025
eb5f87b
#2546 Add upgrade to 11
pavlas77 Dec 2, 2025
a46b696
#2546 Add upgrade to 11
pavlas77 Dec 2, 2025
ff3135b
#2546 Add upgrade to 11
pavlas77 Dec 2, 2025
080a0e4
#2546 Add upgrade to 11
pavlas77 Dec 2, 2025
a834072
#2546 Add upgrade to 11
pavlas77 Dec 2, 2025
5d27fdc
#2546 Update metadata, fix formatting, minor edits
Dec 3, 2025
acb3e11
#2546 Add upgrade to 11
pavlas77 Dec 3, 2025
f98b803
#2546 Add upgrade to 11
pavlas77 Dec 3, 2025
387411a
#2546 Apply formatting and fix whitespace
Dec 4, 2025
3c3cada
#2546 Add topicHrefs and trim whitespace in toc
Dec 4, 2025
9e1c200
#2546 Add upgrade to 11
pavlas77 Dec 4, 2025
67a2f9e
#2546 Add upgrade to 11
pavlas77 Dec 4, 2025
263f607
#2546 Add upgrade to 11
pavlas77 Dec 4, 2025
f86a07b
#2546 Update metadata
Dec 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file added docs/assets/downloads/so11config_generators.zip
Binary file not shown.
6 changes: 6 additions & 0 deletions docs/en/onsite/includes/warn-dbsetup-discontinued.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!-- markdownlint-disable-file MD041 -->
> [!CAUTION]
> From SuperOffice 11.6, *ServerSetup.exe* and *DBSetup.exe* have been discontinued and replaced by the [CRMSetup.exe and CRMTask.exe][1] command-line utilities.

<!-- Referenced links -->
[1]: ../install/database/crmsetup-and-crmtask.md
14 changes: 7 additions & 7 deletions docs/en/onsite/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ metadata:
so.collection: collection
author: Bergfrid Dias
so.author: digitaldiina
so.date: 02.02.2022
so.date: 12.01.2025

# highlightedContent section (optional)
# Maximum of 8 items
Expand Down Expand Up @@ -101,14 +101,10 @@ conceptualContent:
itemType: list
typeDesc: how-to-guide
text: Create MS SQL Server database
- url: install/database/create-oracle-db.md
- url: install/server/index.md
itemType: list
typeDesc: how-to-guide
text: Create Oracle database
- url: install/server/silent-serversetup.md
itemType: list
typeDesc: how-to-guide
text: Install SuperOffice server (silent)
text: Install SuperOffice server
- url: install/web-client/index.md
itemType: list
typeDesc: how-to-guide
Expand All @@ -121,6 +117,10 @@ conceptualContent:
- title: Upgrade
summary: Upgrade your onsite SuperOffice installation
links:
- url: upgrade/to-11/index.md
itemType: list
typeDesc: how-to-guide
text: To version 11
- url: upgrade/to-9/index.md
itemType: list
typeDesc: how-to-guide
Expand Down
308 changes: 308 additions & 0 deletions docs/en/onsite/install/database/crmsetup-and-crmtask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,308 @@
---
uid: crmsetup-crmtask-utils
title: CrmSetup and CrmTask utilities
description: CrmSetup.exe and CrmTask.exe utilities
keywords: crmsetup, crmsetup.exe, crmtask, crmtask.exe
author: pavlas77
date: 12.01.2025
version: 11
content_type: concept
deployment: onsite
---

# CrmSetup and CrmTask utilities

SuperOffice 11.6 Onsite has two tools to replace **ServerSetup** and **DBSetup**.

**CrmSetup** is for installation and maintenance of database and document templates. It covers tasks like installation, upgrade, inspection, import, export, and transfer of the database.
Document templates are installed when creating new and upgrading current installation.

**CrmTask** is for scheduling regeneration of freetext index, Saint counters and Status monitors, and running ERP sync.

*CrmSetup* and *CrmTask* are commandline tools - argument files can be made and reused to make the work easier, just copy them into the CrmSetup folder. You can <a href="../../../assets/downloads/so11config_example_argument_files.zip" download>download example argument files</a>. The first commented-out line in the example file has the full command for copy-paste into cmd. Remember to change all necessary values.

You can also use <a href="../../../assets/downloads/so11config_generators.zip" download>HTML-based argument generators</a>. The zip file contains two HTML files, each for one utility. Just unzip them and run locally.

## CrmSetup

Run the command prompt as administrator, `--help` gives possible options and arguments for the different options:

```dos
...>crmsetup --help
...>crmsetup new-installation --help

D:\SO Onsite 11.6\CrmSetup>CrmSetup.exe --help
Usage: CrmSetup [command]

CrmSetup is a command-line utility designed to manage SuperOffice CRM installations. It is a replacement
for the traditional SuperOffice CRM Setup tool and it provides commands for creating new installations,
upgrading existing setups, and inspecting databases.

Commands:
new-installation Create a new installation
upgrade-existing Upgrade existing installation
inspect-database Inspect existing database
kill-database Kill existing superoffice database
import-file Import an IMP data file to the database.
export-database Export a database to a file
import-database Import a database from a file, overwriting any existing database
transfer-database Transfer data from a source to a destination database

Options:
--arg-file Use arguments from argument file
-h, --help Show help message
--version Show version
```

### New installation

The `new-installation` option is used to prime an empty database and set it up for use.

```dos
D:\SO Onsite 11.6\CrmSetup>CrmSetup.exe --arg-file CRMSetupNew.txt
2025-11-07 15:02:45 [Info] Downloading license from server https://license.superoffice.com/LicenseSvc/LicenseService.svc
2025-11-07 15:02:46 [Info] Creating database with options (Online = False, Language = NO, MailClient = Outlook2007)
2025-11-07 15:02:58 [Warn] Not running as administrator - skipping creating ODBC DSN.
2025-11-07 15:02:58 [Info] Initializing database
2025-11-07 15:02:58 [Info] Creating owner contact Super ASA
2025-11-07 15:02:58 [Info] Creating company Super ASA with serial number 161xxxxxxx
2025-11-07 15:02:58 [Info] Saving license for Software License: Super ASA, 161xxxxxxx Expires: 10/27/2026 00:00:00
2025-11-07 15:02:58 [Info] Creating system user crm8
2025-11-07 15:02:58 [Info] Creating user AU (Admin User)
2025-11-07 15:02:58 [Info] Accepting license
2025-11-07 15:02:59 [Info] Copying embedded document template resources
2025-11-07 15:03:09 [Info] Starting NetServer
2025-11-07 15:03:10 [Info] Perform tasks after upgrade
Installation completed successfully
```

Example argument file for a new installation.

```dos
# crmsetup --arg-file CRMSetupNew.txt
# replace the values
new-installation
--database-server SQL-server
--database-name SOnew11.6
--db-user crm7
--db-password xxx
--table-prefix crm7
--odbc-dsn SO116
--so-arc C:\soserver\SO_ARC
--email-client Outlook2007
--company-name Super ASA
--serial-number 161xxxxxxx
--license-url https://license.superoffice.com/LicenseSvc/LicenseService.svc
#--license-from-file c:\temp\license.xml
--first-name Admin
--last-name User
--user-id au
--user-name SOadmin@socrm.mailinator.com
--password au
--user-plan ten-salesservicemarketing
--system-user crm8
--system-password xxx
--language NO
--country NO
```

### Upgrade existing database

Upgrade existing installation.

```dos
D:\SO Onsite 11.6\CrmSetup>CrmSetup.exe upgrade-existing --arg-file CRMSetupUpgrade.txt
2025-11-18 12:40:44 [Info] Found a SuperOfficeCdd database
2025-11-18 12:40:44 [Info] Validating license for Super 85 with serial number 1010000006
2025-11-18 12:40:45 [Info] No pending upgrades
2025-11-18 12:40:45 [Info] Copying embedded document template resources
2025-11-18 12:40:45 [Info] Starting NetServer
2025-11-18 12:40:48 [Info] Perform tasks after upgrade
Upgrade completed successfully
```

Example argument file for a database upgrade.

```dos
# crmsetup --arg-file CRMSetupUpgrade.txt
# replace the values
upgrade-existing
--database-server SQL-server
--database-name SO85
--db-user crm7
--db-password xxx
--table-prefix crm7
--so-arc C:\soserver\SO_ARC
--email-client Outlook2007
--company-name Super 85
--serial-number 161xxxxxxx
--license-url https://license.superoffice.com/LicenseSvc/LicenseService.svc
--system-user crm8
--system-password xxx
--language NO
--country NO
```

### Inspect database

The `inspect-database` option is useful for testing how to use **CRMSetup** without changing the database.

```dos
D:\SO Onsite 11.6\CrmSetup>CrmSetup.exe inspect-database --arg-file CRMSetupInspect.txt
2025-11-13 08:57:13 [Info] Found a SuperOfficeCdd database
2025-11-13 08:57:13 [Info] Found 269 pending upgrades
Database inspection completed successfully
```

Example argument file for a database inspection.

```dos
# crmsetup --arg-file CRMSetupInspect.txt
# replace the values
inspect-database
--database-server SQL-server
--database-name SO85
--db-user crm7
--db-password xxx
--table-prefix crm7
```

### Kill database

Kills an existing SuperOffice database. It will remove the database content, not the database itself.

```dos
# crmsetup --arg-file CRMSetup.txt
# Kills content, not the db instance
# replace the values
kill-database
--database-server SQL-server
--database-name SO10Kill
--db-user crm7
--db-password xxx
--table-prefix crm7
```

### Import IMP file

The `import-file` option imports an IMP data file to the database.

```dos
# crmsetup --arg-file CRMSetupImportFile.txt
# replace the values
import-file
--database-server SQL-server
--database-name SO_11
--db-user crm7
--db-password xxx
--table-prefix crm7
--import-filename I_TestCurrency.imp
```

### Database export

During export, an *.sdb* file is created in the same folder as **CrmSetup.exe**. Other path can be used but the folder has to be created first.

```dos
# crmsetup --arg-file CRMSetupExport.txt
# replace the values
export-database
--database-server SQL-server
--database-name SO_10
--db-user crm7
--db-password xxx
--table-prefix crm7
--target-file ExportDB.sdb
```

### Database import

The `import-database` option imports a database from a file, overwriting any existing database.

```dos
# crmsetup --arg-file CRMSetupImport.txt
# replace the values
import-database
--database-server SQL-server
--database-name SO10_import
--db-user crm7
--db-password xxx
--table-prefix crm7
--source-file ImportDB.sdb
```

### Transfer database

The `transfer-database` option transfers data from a source to a destination database.

```dos
# crmsetup --arg-file CRMSetupTransfer.txt
# replace the values
transfer-database
--source-database-server SQL-server
--source-database-name SO10
--source-db-user crm7
--source-db-password xxx
--source-table-prefix crm7
--target-database-server SQL-server
--target-database-name SOTransfer
--target-db-user crm7
--target-db-password xxx
--target-table-prefix crm7
```

## CrmTask

**CrmTask** is for scheduling regeneration of the freetext index, SAINT counters and status monitors, and running ERP sync.

```dos
C:\SuperOffice\CrmSetup>crmtask --help
Usage: CrmTask [command]

CrmTask is a command-line utility designed to manage various CRM-related operations efficiently.
It provides functionalities to regenerate critical CRM components such as Saint counters, status monitors,
free-text indexes, and ERP sync, ensuring that your CRM data is up-to-date and optimized for performance.

More information about each command can be found by referencing the command's specific help section.


Commands:
regenerate-saint-counters Regenerate Saint counters
regenerate-status-monitors Regenerate status monitors
regenerate-free-text-index Regenerate free text index
erp-sync-all Run ERP sync process

Options:
--arg-file Use arguments from argument file
-h, --help Show help message
--version Show version
```

Example argument file for Saint counters regeneration:

```dos
# crmtask --arg-file CRMTaskRegenerateSaint.txt
# replace the values
regenerate-saint-counters
--database-server SQL-server
--database-name SO11.6
--db-user crm7
--db-password xxx
--table-prefix crm7
--system-user crm8
--system-password xxx
```

### CrmTask as scheduled task

To run **CrmTask** automatically, you can use the Windows task scheduler to schedule it to run for example every night. As arguments, use `--arg-file` and add the corresponding argument file for the given task. If you do not specify the **CrmTask** command on the command line, you need to have it on the first line in the argument file (for example, regenerate-saint-counters).

![Scheduled Task -screenshot][img1]

![Scheduled Task -screenshot][img2]

<!-- Referenced links -->

<!-- Referenced images -->
[img1]: media/scheduledcrmtask1.png
[img2]: media/scheduledcrmtask2.png
8 changes: 6 additions & 2 deletions docs/en/onsite/install/database/dbsetup-exe.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
uid: dbsetup-exe
title: DbSetup.exe
uid: dbsetup_exe
description: DBSetup.exe - Database maintenance
keywords: DBSetup
author: SuperOffice Product and Engineering
keywords:
date: 12.01.2025
version: 10
content_type: concept
deployment: onsite
---

# DBSetup.exe - Database maintenance

[!include[DBSetup](../../includes/warn-dbsetup-discontinued.md)]

Earlier versions of DBSetup may differ a bit in the user interface, but the basic functionality is still the same. Please note the warning - there is no turning back once you have started the different operations.

See also the [SoTables.ini info][1] - but with CDD note that the priming data provided by SuperOffice are no longer packaged as individual files; this function is only intended for adding new data specific to a customer or partner feature.
Expand Down
11 changes: 6 additions & 5 deletions docs/en/onsite/install/database/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
uid: install-database
title: Install database
uid: install_database
description: "How to prepare and install the SuperOffice database."
author: SuperOffice Product and Engineering
date: 09.12.2023
description: How to prepare and install the SuperOffice database.
keywords: install, database, Oracle, MSQL
author: pavlas77
date: 12.01.2025
version: 11
content_type: howto
deployment: onsite
---
Expand All @@ -15,7 +16,7 @@ The central database may be running on either Microsoft SQL Server or Oracle bef

## Supported databases

The latest versions are MS SQL Server 2019 and Oracle 18c. Also, check out the [complete list of supported databases][4] and our [compatibility reports][1].
For the list of supported database versions, check out the [complete list of supported databases][4] and our [compatibility reports][1].

## Unicode and ANSI database?

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading