diff --git a/docs/assets/downloads/so11config_example_argument_files.zip b/docs/assets/downloads/so11config_example_argument_files.zip new file mode 100644 index 00000000000..e0679013c91 Binary files /dev/null and b/docs/assets/downloads/so11config_example_argument_files.zip differ diff --git a/docs/assets/downloads/so11config_generators.zip b/docs/assets/downloads/so11config_generators.zip new file mode 100644 index 00000000000..41aa9790979 Binary files /dev/null and b/docs/assets/downloads/so11config_generators.zip differ diff --git a/docs/en/onsite/includes/warn-dbsetup-discontinued.md b/docs/en/onsite/includes/warn-dbsetup-discontinued.md new file mode 100644 index 00000000000..2a8472233df --- /dev/null +++ b/docs/en/onsite/includes/warn-dbsetup-discontinued.md @@ -0,0 +1,6 @@ + +> [!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. + + +[1]: ../install/database/crmsetup-and-crmtask.md diff --git a/docs/en/onsite/index.yml b/docs/en/onsite/index.yml index a2085b6fb4c..6f1250ca305 100644 --- a/docs/en/onsite/index.yml +++ b/docs/en/onsite/index.yml @@ -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 @@ -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 @@ -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 diff --git a/docs/en/onsite/install/database/crmsetup-and-crmtask.md b/docs/en/onsite/install/database/crmsetup-and-crmtask.md new file mode 100644 index 00000000000..74e9c79fbeb --- /dev/null +++ b/docs/en/onsite/install/database/crmsetup-and-crmtask.md @@ -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 download example argument files. 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 HTML-based argument generators. 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] + + + + +[img1]: media/scheduledcrmtask1.png +[img2]: media/scheduledcrmtask2.png diff --git a/docs/en/onsite/install/database/dbsetup-exe.md b/docs/en/onsite/install/database/dbsetup-exe.md index ad219249619..93cc3b5de49 100644 --- a/docs/en/onsite/install/database/dbsetup-exe.md +++ b/docs/en/onsite/install/database/dbsetup-exe.md @@ -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. diff --git a/docs/en/onsite/install/database/index.md b/docs/en/onsite/install/database/index.md index 94852b6e491..52dc1ef1649 100644 --- a/docs/en/onsite/install/database/index.md +++ b/docs/en/onsite/install/database/index.md @@ -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 --- @@ -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? diff --git a/docs/en/onsite/install/database/media/scheduledcrmtask1.png b/docs/en/onsite/install/database/media/scheduledcrmtask1.png new file mode 100644 index 00000000000..1ce5419cba7 Binary files /dev/null and b/docs/en/onsite/install/database/media/scheduledcrmtask1.png differ diff --git a/docs/en/onsite/install/database/media/scheduledcrmtask2.png b/docs/en/onsite/install/database/media/scheduledcrmtask2.png new file mode 100644 index 00000000000..0615f258aab Binary files /dev/null and b/docs/en/onsite/install/database/media/scheduledcrmtask2.png differ diff --git a/docs/en/onsite/install/database/sotables-ini.md b/docs/en/onsite/install/database/sotables-ini.md index c591c40fee0..d1f37b62973 100644 --- a/docs/en/onsite/install/database/sotables-ini.md +++ b/docs/en/onsite/install/database/sotables-ini.md @@ -1,15 +1,18 @@ --- +uid: sotables-ini title: SoTables.ini -uid: sotables_ini description: SoTables.ini -author: Bergfrid Dias -date: 12.10.2021 keywords: database, DBSetup, SoTables.ini +author: digitaldiina +date: 12.01.2025 +version: 10 content_type: reference --- # SoTables.ini +[!include[DBSetup](../../includes/warn-dbsetup-discontinued.md)] + Used by [DBSetup.exe][1] * This file is up until 8.1 used during the setup phase - it describes which prime data files are to be loaded into the newly created or upgraded database. diff --git a/docs/en/onsite/install/guide.md b/docs/en/onsite/install/guide.md index 92c21999163..18c6a9e8999 100644 --- a/docs/en/onsite/install/guide.md +++ b/docs/en/onsite/install/guide.md @@ -4,8 +4,8 @@ title: Set-up guide description: SuperOffice set-up guide keywords: onsite installation author: SuperOffice Product and Engineering -date: 11.25.2025 -version: 10 +date: 12.04.2025 +version: 11 content_type: howto deployment: onsite --- @@ -19,18 +19,14 @@ deployment: onsite 2. [Prepare database][7] 3. [Prepare IIS Web server][9] 4. [Prepare for Service][3] -5. [Prepare Windows client computer][2] (optional) -6. [Install SuperOffice Win Server][4] -7. [Install Windows client][5] (optional) -8. [Install Service][8] -9. [Install SuperOffice Web][6] +5. [Install SuperOffice Win Server][4] +6. [Install Service][8] +7. [Install SuperOffice Web][6] [1]: server/prepare.md -[2]: win-client/prepare-client.md [3]: service/prepare.md [4]: server/index.md -[5]: win-client/index.md [6]: web-client/index.md [7]: database/index.md [8]: service/index.md diff --git a/docs/en/onsite/install/server/index.md b/docs/en/onsite/install/server/index.md index 53e9a4a7510..6156101d3fc 100644 --- a/docs/en/onsite/install/server/index.md +++ b/docs/en/onsite/install/server/index.md @@ -1,70 +1,82 @@ --- +uid: install-crm-server title: Install SuperOffice Win Server -uid: install_crm_server description: Install SuperOffice Win Server +keywords: install, server author: SuperOffice Product and Engineering -keywords: +date: 12.01.2025 +version: 11 content_type: howto deployment: onsite --- -# Install CRM Server +# Install CRM Server 11 and newer ## Prerequisites -Prerequisites are available in the installation package. - -After you start the SuperOffice CRM Server installer you will find the **Install prerequisites**. Here you can click the Advanced button to see what will be installed and select or unselect if you want to do it another way. - -To install the .NET Framework an internet connection is required. If the server where the installation is done doesn't have an internet connection, the [correct][1] .NET framework must be installed from another source. - -A warning will be given when installing prerequisites if the installation of the .NET Framework fails, and ServerSetup will not start if .Net is not installed on the server. - -The reason is the prerequisites installation program on the installation package contains only the boot-strapper for the .NET installation and not the entire setup program (approx 2.5 MB versus 250 MB). - The server where you install SuperOffice CRM Server needs to have an internet connection and access to our License server on [https://license.superoffice.com][4]. ## Install -Choose one of: - -* [Silent install][2] -* [Install on Citrix or Terminal server][3] - -### Automatic update of clients (for SuperOffice Windows client only) - -In the last screen of ServerSetup, **Installation is complete**, you can select to use an automated update for client installations. - -The client setup file will be run from the location selected in ServerSetup, so this location must be available for the user and sufficient rights must have been granted. - -If Active Directory is to be used for updates, the automatic update should not be selected in ServerSetup. - -The automatic client update feature replaces the use of SoLoader in earlier versions. - -Automated updates for client installations will ask the user if she wants to update SuperOffice CRM client if the client setup files have been updated by ServerSetup. The check is done by comparing the version of SuperOffice CRM client with the highest version of ServerSetup installation on this database. - -The user can select to not update, the question will then be asked again next time she starts SuperOffice CRM client. - -If the user selects to update, the SuperOffice CRM client will exit and the client setup file will be run. When the installation is finished, SuperOffice CRM client must be started again. - -### Install with several languages - -You can choose to install SuperOffice CRM  in one or more languages. - -In a new installation, only the main language is used for most of the translated texts that are installed in the database. This will remain the same even if you install with several languages, and later select to run SuperOffice CRM in another language than the main language. This will cause some of the text in the application to be in the main language and most in the selected language. (Seen in dropdown lists for example.) - -If you are upgrading from an earlier version of SuperOffice, make sure to select the same main language as in the last installation, or you risk getting a mix of languages in the database/program. +From SuperOffice 11, the SuperOffice server and database are installed with [CrmSetup][2] utility. + +Run **CrmSetup.exe** with the `new-installation` option and supply the corresponding argument file, see an example below. This will prime the database with all necessary data and the license. + +```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 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 +``` *** -[Previous][11] | [Next (Web)][12] | [Next (Win)][14] | [Back to guide][13] +[Previous][11] | [Next][12] | [Back to guide][13] -[1]: ../../requirements/crm-server.md -[2]: silent-serversetup.md -[3]: install-on-citrix.md +[2]: ../../install/database/crmsetup-and-crmtask.md [4]: https://license.superoffice.com [11]: ../service/prepare.md [12]: ../service/index.md [13]: ../guide.md -[14]: ../win-client/index.md diff --git a/docs/en/onsite/install/server/install-10.md b/docs/en/onsite/install/server/install-10.md new file mode 100644 index 00000000000..abe7f7ffb63 --- /dev/null +++ b/docs/en/onsite/install/server/install-10.md @@ -0,0 +1,64 @@ +--- +uid: install-crm-server-10 +title: CRM Server 8-10 +description: Install SuperOffice Server versions 8-10 +keywords: install SuperOffice 10, install SuperOffice 9, install SuperOffice 8 +author: SuperOffice Product and Engineering +date: 12.01.2025 +version: 10 +content_type: howto +deployment: onsite +--- + +# Install CRM Server 8-10 + +## Prerequisites + +Prerequisites are available in the installation package. + +After you start the SuperOffice CRM Server installer you will find the **Install prerequisites**. Here you can click the Advanced button to see what will be installed and select or unselect if you want to do it another way. + +To install the .NET Framework an internet connection is required. If the server where the installation is done doesn't have an internet connection, the [correct][1] .NET framework must be installed from another source. + +A warning will be given when installing prerequisites if the installation of the .NET Framework fails, and ServerSetup will not start if .Net is not installed on the server. + +The reason is the prerequisites installation program on the installation package contains only the boot-strapper for the .NET installation and not the entire setup program (approx 2.5 MB versus 250 MB). + +The server where you install SuperOffice CRM Server needs to have an internet connection and access to our License server on [https://license.superoffice.com][4]. + +## Install + +Choose one of: + +* [Silent install][2] +* [Install on Citrix or Terminal server][3] + +### Automatic update of clients (for SuperOffice Windows client only) + +In the last screen of ServerSetup, **Installation is complete**, you can select to use an automated update for client installations. + +The client setup file will be run from the location selected in ServerSetup, so this location must be available for the user and sufficient rights must have been granted. + +If Active Directory is to be used for updates, the automatic update should not be selected in ServerSetup. + +The automatic client update feature replaces the use of SoLoader in earlier versions. + +Automated updates for client installations will ask the user if she wants to update SuperOffice CRM client if the client setup files have been updated by ServerSetup. The check is done by comparing the version of SuperOffice CRM client with the highest version of ServerSetup installation on this database. + +The user can select to not update, the question will then be asked again next time she starts SuperOffice CRM client. + +If the user selects to update, the SuperOffice CRM client will exit and the client setup file will be run. When the installation is finished, SuperOffice CRM client must be started again. + +### Install with several languages + +You can choose to install SuperOffice CRM  in one or more languages. + +In a new installation, only the main language is used for most of the translated texts that are installed in the database. This will remain the same even if you install with several languages, and later select to run SuperOffice CRM in another language than the main language. This will cause some of the text in the application to be in the main language and most in the selected language. (Seen in dropdown lists for example.) + +If you are upgrading from an earlier version of SuperOffice, make sure to select the same main language as in the last installation, or you risk getting a mix of languages in the database/program. + + +[1]: ../../requirements/crm-server.md +[2]: silent-serversetup.md +[3]: install-on-citrix.md +[4]: https://license.superoffice.com diff --git a/docs/en/onsite/install/server/prepare-10.md b/docs/en/onsite/install/server/prepare-10.md new file mode 100644 index 00000000000..9727503fa54 --- /dev/null +++ b/docs/en/onsite/install/server/prepare-10.md @@ -0,0 +1,23 @@ +--- +uid: prepare-crm-server-10 +title: Prepare CRM Server 8-10 +description: Prepare CRM Server computer +keywords: prepare CRM server +author: SuperOffice Product and Engineering +date: 12.01.2025 +version: 10 +content_type: howto +deployment: onsite +--- + +# Prepare CRM Server computer for SuperOffice 8-10 + +1. Prepare the program files folder: + + *Program Files* is where the server software will be installed. By default, we put this in *C:\Program Files\SuperOffice\SuperOffice Server*. Here you will find the tools for database maintenance (*Dbsetup.exe*) and create and edit the install files (*SoCreateMST.exe*). + + In *SuperOffice Server*, we also create a subfolder called *Client*, which must be available for all users who want to install the Win client. We recommend you share the *Client* folder and not the *SuperOffice Server* folder. + +2. Prepare the document archive folder: + + This folder is the central document archive, and all users must have access to this location via the application. For Win client users, this folder must be shared, the user must be able to create and edit folders and files. diff --git a/docs/en/onsite/install/server/prepare.md b/docs/en/onsite/install/server/prepare.md index 0870e55ed0e..5a510984b57 100644 --- a/docs/en/onsite/install/server/prepare.md +++ b/docs/en/onsite/install/server/prepare.md @@ -1,22 +1,22 @@ --- +uid: prepare-crm-server title: Prepare CRM Server computer -uid: prepare_crm_server description: Prepare CRM Server computer -author: SuperOffice Product and Engineering keywords: install +author: SuperOffice Product and Engineering +date: 12.01.2025 +version: 11 content_type: howto deployment: onsite --- -# Prepare CRM Server computer - -1. Prepare the program files folder +# Prepare CRM Server computer for SuperOffice 11 - This is where the server software will be installed. By default, we put this in *C:\Program Files\SuperOffice\SuperOffice Server*. Here you will find the tools for database maintenance (*Dbsetup.exe*) and create and edit the install files (*SoCreateMST.exe*). +1. Prepare the program files folder: - In *SuperOffice Server* we also create a subfolder called *Client*, which must be available for all users who want to install the Win client. We recommend you share the Client folder and not the SuperOffice Server folder. + We recommend to unzip the content of the **CrmServer.zip** file into *C:\Program Files\SuperOffice\CrmSetup* folder. Here you will find the tools for database maintenance and running scheduled tasks. -2. Prepare the document archive folder +2. Prepare the document archive folder: This folder is the central document archive, and all users must have access to this location via the application. For Win client users, this folder must be shared, the user must be able to create and edit folders and files. diff --git a/docs/en/onsite/install/server/silent-serversetup.md b/docs/en/onsite/install/server/silent-serversetup.md index f79f3f9511f..cf8c696da8b 100644 --- a/docs/en/onsite/install/server/silent-serversetup.md +++ b/docs/en/onsite/install/server/silent-serversetup.md @@ -1,15 +1,19 @@ --- +uid: silent-serversetup title: Silent install of ServerSetup -uid: silent_serversetup description: Silent install of ServerSetup +keywords: ServerSetup author: SuperOffice Product and Engineering -keywords: +date: 12.01.2025 +version: 10 content_type: reference deployment: onsite --- # Silent install of ServerSetup +[!include[DBSetup](../../includes/warn-dbsetup-discontinued.md)] + ServerSetup can be installed silently without using the user interface. All functionality is covered by the available arguments. Error messages or ServerSetups user interface will be displayed on error. ## Examples diff --git a/docs/en/onsite/install/service/index.md b/docs/en/onsite/install/service/index.md index 7543c5fc0b1..8493532e9c6 100644 --- a/docs/en/onsite/install/service/index.md +++ b/docs/en/onsite/install/service/index.md @@ -3,11 +3,11 @@ uid: install-service title: Set-up guide description: Guide to installing SuperOffice Service and what to do before you start. keywords: install, Service, ejTermsetup.exe, CustomerService.exe, SymmetricKey, SymmetricSecret -author: Martin Pavlas -date: 11.21.2025 +author: pavlas77 +date: 12.04.2025 +version: 11 content_type: howto deployment: onsite -version: 8.1 redirect_from: /en/service/install/ --- diff --git a/docs/en/onsite/install/service/prepare.md b/docs/en/onsite/install/service/prepare.md index 3e809a456ce..e67c8845b5a 100644 --- a/docs/en/onsite/install/service/prepare.md +++ b/docs/en/onsite/install/service/prepare.md @@ -3,8 +3,9 @@ uid: prepare-service title: Prepare to install Service description: From SuperOffice 8 you also need to install Service. Here's what you need to do before you start the installation. keywords: install -author: SuperOffice Product and Engineering -date: 11.21.2025 +author: pavlas77 +date: 12.04.2025 +version: 11 content_type: howto deployment: onsite redirect_from: /en/service/install/prepare @@ -62,12 +63,11 @@ In MSSQL, create a user, which has **dbowner** access (and not sysadmin access *** -[Previous][11] | [Next (Web)][12] | [Next (Win)][14] | [Back to guide][13] +[Previous][11] | [Next][12] | [Back to guide][13] [11]: ../iis/index.md [12]: ../server/index.md [13]: ../guide.md -[14]: ../win-client/prepare-client.md diff --git a/docs/en/onsite/install/win-client/index.md b/docs/en/onsite/install/win-client/index.md index 7f239206258..4f6238c1fbd 100644 --- a/docs/en/onsite/install/win-client/index.md +++ b/docs/en/onsite/install/win-client/index.md @@ -1,9 +1,11 @@ --- +uid: install-win9-client title: Install SuperOffice 9 or 10 Windows client -uid: install_win9_client description: Install SuperOffice 9 or 10 Windows client -author: SuperOffice Product and Engineering keywords: install, win, client +author: SuperOffice Product and Engineering +date: 12.01.2025 +version: 10 content_type: howto deployment: onsite platform: win @@ -11,7 +13,7 @@ platform: win # Install SuperOffice 9 or 10 Windows client -From SuperOffice 9 the SuperOffice Windows client is not available. The *SuperOffice9.exe* (or *SuperOffice10.exe* for SuperOffice 10) installer contains SuperOffice Admin client, Reporter Studio and Travel Gateway. +From SuperOffice 9, the SuperOffice Windows client is not available. The *SuperOffice9.exe* (or *SuperOffice10.exe* for SuperOffice 10) installer contains the SuperOffice Admin client, Reporter Studio and Travel Gateway. **From SuperOffice 11, the client installer is discontinued.** The installer is found on the SuperOffice CRM Server in the *Client* folder. @@ -52,19 +54,12 @@ After the installation is completed all components are installed. * [Tested Microsoft SQL Server versions][3] * [Tested Oracle versions][4] -*** - -[Previous][11] | [Next][12] | [Back to guide][13] - [1]: ../../compatibility/server-os.md [2]: ../../compatibility/browser.md [3]: ../../compatibility/ms-sql-server.md [4]: ../../compatibility/oracle.md [5]: prepare-client.md -[11]: ../server/index.md -[12]: ../service/index.md -[13]: ../guide.md [img1]: media/crm-9-win-install1.png diff --git a/docs/en/onsite/install/win-client/prepare-client.md b/docs/en/onsite/install/win-client/prepare-client.md index d8ed661ff0c..2e50e31adf3 100644 --- a/docs/en/onsite/install/win-client/prepare-client.md +++ b/docs/en/onsite/install/win-client/prepare-client.md @@ -1,9 +1,11 @@ --- +uid: prepare-win-client title: Prepare Win client computer -uid: prepare_win_client description: Prepare Win client computer +keywords: Win client author: SuperOffice Product and Engineering -keywords: +date: 12.04.2025 +version: 10 content_type: howto deployment: onsite platform: win @@ -56,14 +58,5 @@ Migration Tool uses ADO.NET to connect to the database. It also uses Win client ![Migration Tool -screenshot][img1] -*** - -[Previous][11] | [Next][12] | [Back to guide][13] - - -[11]: ../service/prepare.md -[12]: ../server/index.md -[13]: ../guide.md - [img1]: media/dd952b42-6d72-454f-a4de-8af1e500b04d.png diff --git a/docs/en/onsite/requirements/crm-server.md b/docs/en/onsite/requirements/crm-server.md index 387d91b387d..16560bf2b12 100644 --- a/docs/en/onsite/requirements/crm-server.md +++ b/docs/en/onsite/requirements/crm-server.md @@ -1,10 +1,11 @@ --- +uid: crm-server-requirements title: Requirements -uid: crm_server_requirements description: System requirements for SuperOffice server +keywords: system requirement, SuperOffice server, server OS author: SuperOffice Product and Engineering -date: 11.28.2025 -keywords: +date: 12.04.2025 +version: 11 content_type: reference deployment: onsite --- diff --git a/docs/en/onsite/requirements/index.md b/docs/en/onsite/requirements/index.md index 680c53c2112..bf407c46b1b 100644 --- a/docs/en/onsite/requirements/index.md +++ b/docs/en/onsite/requirements/index.md @@ -1,9 +1,11 @@ --- +uid: onsite-system-requirements title: Requirements -uid: onsite_system_requirements description: System requirements - onsite +keywords: system requirements onsite author: SuperOffice Product and Engineering -keywords: +date: 12.01.2025 +version: 11 content_type: reference deployment: onsite --- @@ -61,6 +63,7 @@ See: [.NET system requirements][13] | Versions | Web client | Service client | |----------|------------|----------------| +| 11 | services88 | services88 | | 10 | services88 | services88 | | 9 | services88 | services88 | | 8.5 R09 - R15 | services88 | services88 | diff --git a/docs/en/onsite/requirements/web-client.md b/docs/en/onsite/requirements/web-client.md index af90afc45b2..7be084f5bbb 100644 --- a/docs/en/onsite/requirements/web-client.md +++ b/docs/en/onsite/requirements/web-client.md @@ -1,10 +1,11 @@ --- +uid: client-requirements title: Client requirements -uid: client_requirements description: Client requirements for SuperOffice Web and Win +keywords: requirement, processor, memory, operating system author: SuperOffice Product and Engineering -date: 09.12.2023 -keywords: +date: 12.04.2025 +version: 11 content_type: reference deployment: onsite platform: web diff --git a/docs/en/onsite/toc.yml b/docs/en/onsite/toc.yml index 6f3c2477741..d08caef2496 100644 --- a/docs/en/onsite/toc.yml +++ b/docs/en/onsite/toc.yml @@ -3,8 +3,10 @@ items: href: index.yml items: - name: Install Onsite + topicHref: requirements/index.md items: - name: Pre-requisites + topicHref: requirements/index.md items: - name: System requirements href: requirements/index.md @@ -53,6 +55,9 @@ items: items: - name: Prepare CRM Server href: install/server/prepare.md + items: + - name: Prepare for SuperOffice 8-10 + href: install/server/prepare-10.md - name: IIS web server href: install/iis/index.md items: @@ -70,8 +75,11 @@ items: - name: Install SuperOffice server href: install/server/index.md items: - - name: Silent install - href: install/server/silent-serversetup.md + - name: Install CRM Server 8-10 + href: install/server/install-10.md + items: + - name: Silent install + href: install/server/silent-serversetup.md - name: Install on Citrix or Terminal server href: install/server/install-on-citrix.md items: @@ -108,8 +116,25 @@ items: - name: WCF primer href: install/netserver/wcf-primer.md - name: Upgrade Onsite + topicHref: upgrade/to-11/index.md items: + - name: To version 11 + href: upgrade/to-11/index.md + - name: To version 9 or 10 + href: upgrade/to-9/index.md + - name: To version 8.1 - 8.5 + href: upgrade/to-81/index.md + items: + - name: Using old Service domain + href: upgrade/to-81/using-old-service-domain.md + - name: Using old Sales domain + href: upgrade/to-81/using-old-sales-domain.md + - name: Using new domains + href: upgrade/to-81/using-new-domains.md + - name: Move CRM Server + href: upgrade/to-81/move-crm-server.md - name: To version 8.0 + href: upgrade/75-to-8/index.md items: - name: Upgrade scenarios 7.5 to 8 href: upgrade/75-to-8/index.md @@ -121,26 +146,13 @@ items: href: upgrade/75-to-8/netserver.md - name: Windows client href: upgrade/75-to-8/win-client.md - - name: To version 8.1 - 8.5 - href: upgrade/to-81/index.md - items: - - name: Using old Service domain - href: upgrade/to-81/using-old-service-domain.md - - name: Using old Sales domain - href: upgrade/to-81/using-old-sales-domain.md - - name: Using new domains - href: upgrade/to-81/using-new-domains.md - - name: Move CRM Server - href: upgrade/to-81/move-crm-server.md - - name: To version 9 or 10 - href: upgrade/to-9/index.md - - name: Upgrade Service - href: upgrade/service/index.md - name: Configuration href: config/index.md items: - name: Feature toggles href: feature-toggles.md + - name: CrmSetup and CrmTask + href: install/database/crmsetup-and-crmtask.md - name: DBSetup href: install/database/dbsetup-exe.md - name: SoTables.ini @@ -165,6 +177,7 @@ items: - name: Report parameters href: config/service/report-parameters.md - name: Integrate + topicHref: integrate/web-client/index.md items: - name: With the Web client href: integrate/web-client/index.md diff --git a/docs/en/onsite/upgrade/to-11/index.md b/docs/en/onsite/upgrade/to-11/index.md new file mode 100644 index 00000000000..f519a5941ed --- /dev/null +++ b/docs/en/onsite/upgrade/to-11/index.md @@ -0,0 +1,82 @@ +--- +uid: upgrade-to-11 +title: Upgrade to 11 +description: Upgrade to 11 +keywords: upgrade +author: pavlas77 +date: 12.01.2025 +version: 11 +content_type: howto +deployment: onsite +--- + +# Upgrade to SuperOffice 11 + +You can upgrade to SuperOffice 11 from SuperOffice 8.0 or newer. The recommended installation scenarios and setup requirements are the same as from SuperOffice 8.1. + +[!include[ALT](../../includes/warn-win-client-discontinued.md)] + +## Upgrade from SuperOffice 8.0 + +If you are running SuperOffice 8.0, you need to make sure the full stack of SuperOffice applications (SuperOffice Server, SuperOffice Web, and SuperOffice Service) is installed. You also need to [move all products under one domain][1], as seen from the browser. It might be beneficial to [upgrade to SuperOffice 8.1][1] first and follow the corresponding guides for different installation scenarios. + +## Upgrade from SuperOffice 8.1 or newer + +A SuperOffice 8.1 or newer installation already has the full stack of SuperOffice applications installed, and it is running under one domain, which makes it easier to upgrade. + +### 1. Upgrade SuperOffice Server + +From SuperOffice 11, the SuperOffice server and database are upgraded with [CrmSetup][2] utility. + +Run CrmSetup.exe with `upgrade-existing` option and supply the corresponding argument file, see an example below. This will upgrade the database to the current version. + +```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 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 +``` + +### 2. Upgrade SuperOffice Web + +To upgrade SuperOffice Web, run *Setup.exe* from *SnMWeb* installation file. The setup can upgrade both NetServer and SuperOffice Web files. + +[!include[Remote NetServer](../../includes/remote-netserver-web.md)] + +### 3. Upgrade SuperOffice Service + +To upgrade SuperOffice Service, run the *SuperOffice.CustomerService.exe* file from the *CS* installation folder. After the Service program files are upgraded you need to run *upgrade.exe* to upgrade Service's database values. + +### 4. Uninstall SuperOffice 8 Win clients + +The SuperOffice Win app has been discontinued since SuperOffice 9. If you used the SuperOffice 8 Win app, it needs to be uninstalled from all clients. + + +[1]: ../to-81/index.md +[2]: ../../install/database/crmsetup-and-crmtask.md