Checking 3DSpace Server Software

Check Server Software Integrity

The DSYServerSoftwareMgt tool checks that all the installed 3DSpace server and web app files that are supposed to be present are effectively present and with the expected content. This is the same check integrity functionality that is part of the DSYSoftwareMgt tool on the native app side.

Non server-side software management tools are also provided by the DS Installer tools. For more specific information about the DS Installer, see Installation and Administration - 3DEXPERIENCE Platform - 3DEXPERIENCE Platform - Installation - DS Installer - Configuring Software.

The DSYServerSoftwareMgt tool is available in command line mode only.

Run the command:
- C:\DassaultSystemes\R2022x\3DSpace\win_b64\code\command\DSYServerSoftwareMgt.bat [additional_install_path ...] (Windows, in an elevated Command Prompt window)
  /usr/DassaultSystemes/R2022x/3DSpace/scripts/DSYServerSoftwareMgt.sh [additional_install_path ...] (Linux)
  It checks the integrity of the 3DSpace server and web apps installed in the 3DSpace server file tree.
- If some web apps are installed outside the 3DSpace server file tree, specify their installation paths as parameters to the DSYServerSoftwareMgt command.
  For example, to check DES and RNG, in addition to the server file tree, run the following command:
  
  C:\DassaultSystemes\R2022x\3DSpace\win_b64\code\command\DSYServerSoftwareMgt.bat C:\enoviaV6R2022x\DES C:\enoviaV6R2022x\RNG (Windows)
  /usr/DassaultSystemes/R2022x/3DSpace/scripts/DSYServerSoftwareMgt.sh /usr/DassaultSystemes/enoviaV6R2022x/DES /usr/DassaultSystemes/enoviaV6R2022x/RNG (Linux)
  
  A final status indicates if there is no integrity error at all or if at least one of the installations contains an integrity error.

Verify the results.

The results are displayed directly in a window on the screen. You can, of course, redirect the results to a text file. The two possible check integrity results are:

```
Check successful (no error)
```
if there is no installation with an integrity error

Check failed, there are integrity errors

if there are errors.

The DSYServerSoftwareMgt return codes are:


Error code	Description
0	Check successful (no integrity error in any server installation)
1	Command usage error (unexpected parameter)
2	Additional installation path not found or is not a correct installation path
3	Check failed (there are integrity errors in at least one server installation)

Here is an example:

INFO: 64-bit OS
INFO: Installer found in current media: " C:\DassaultSystemes\R2022x\3DSpace\InstallData\installer\inst\win_b64\code\bin\DSYInsAppliTUI.exe".
Logs are located in "C:\Users\techel\AppData\Local\Temp\InstallData-2018_01_25-070010+0000\log\2018_01_25-070010+0000"
Logs are located in "C:\DassaultSystemes\R2022x\3DSpace\InstallData\log\CODE\internal\DSYSoftwareMgt.media-2018_01_25-070010+0000"

***********************************************************************************************************
*** Begin Software Management for                                                                       ***
*** "C:\DassaultSystemes\R2022x\\3DSpace"
***********************************************************************************************************

INFO: 64-bit OS
INFO: Installer found in current media: "C:\DassaultSystemes\R2022x\3DSpace\InstallData\installer\inst\win_b64\code\bin\DSYInsAppliTUI.exe".
Logs are located in "C:\Users\techel\AppData\Local\Temp\InstallData-2018_01_25-070010+0000\log\2018_01_25-070010+0000"
Logs are located in "C:\DassaultSystemes\R2022x\3DSpace\InstallData\log\CODE\internal\DSYSoftwareMgt.media-2018_01_25-070010+0000"
...
...
...
CODE\win_b64\VENJavaServerJRE
CODE\win_b64\VENApacheTomEE_PRFEXT-CodeOnly
CODE\win_b64\DSYSMBInstall
.
CODE\win_b64\SWXWebPlatformApi
...
...
...
_______________________________________________________________________________

    Dassault Systemes Software Management
_______________________________________________________________________________

Input !q and hit Enter to quit. Just press Enter to continue.

File "C:\DassaultSystemes\R2022x\3DSpace\.\win_b64\code\tomee\conf\context.xml" has been modified after the installation.
File "C:\DassaultSystemes\R2022x\3DSpace\.\win_b64\reffiles\MQLFamilies\mql\VPLMxDataMigration-Execution-Wrapper-R420.mql" has been modified after the installation.

***********************************************************************************************************
*** End of Software Management for                                                                      ***
*** "C:\DassaultSystemes\R2022x\3DSpace"
***********************************************************************************************************


***********************************************************************************************************
*** Begin Software Management for                                                                       ***
*** "C:\DassaultSystemes\R2022x\3DSpace\Apps\EnterpriseChangeMgt\V6R2022x"
***********************************************************************************************************

INFO: 64-bit OS
INFO: Installer found in current media: "C:\DassaultSystemes\R2022x\3DSpace\InstallData\installer\inst\win_b64\code\bin\DSYInsAppliTUI.exe".
Logs are located in "C:\Users\techel\AppData\Local\Temp\InstallData-2018_01_25-070048+0000\log\2018_01_25-070048+0000"
Logs are located in "C:\DassaultSystemes\R2022x\3DSpace\Apps\EnterpriseChangeMgt\V6R2022x\InstallData\log\CODE\internal\DSYSoftwareMgt.media-2018_01_25-070048+0000"
......
......
_______________________________________________________________________________

    Dassault Systemes Software Management
_______________________________________________________________________________

Input !q and hit Enter to quit. Just press Enter to continue.

No integrity errors found.

***********************************************************************************************************
*** End of Software Management for                                                                      ***
*** "C:\DassaultSystemes\R2022x\DMA"
***********************************************************************************************************

Check failed, there are integrity errors.

Check Database Consistency

The tool checks the coherence between the data schema present in the database and the data schema of the applications deployed in the application server.

It is available in command line mode only.

Run the command:
C:\DassaultSystemes\R2022x\3DSpace\win_b64\code\command\DSYCheckAppServerVsDB.bat deployedWebApp_path [-v] (Windows)
/usr/DassaultSystemes/R2022x/3DSpace/scripts/DSYCheckAppServerVsDB.sh deployedWebApp_path [-v] (Linux)
where:
- deployedWebApp_path is the path to the web application deployed in the application server, for example C:\DassaultSystemes\R2022x\3DSpace\win_b64\code\tomee\webapps\3dspace. It contains a file, generated at installation, containing the application versions to be compared to the database.
- -v is verbose mode, and also displays the same application versions found in this file and in the database.

Verify the results.

The results are displayed directly in a window on the screen. You can, of course, redirect the results to a text file. The results contain:

elements missing from the application server (present in the database only)
extra elements in the application server (not present in the database)
elements with an invalid version in the application server (present in the database with another version)
the same elements in both the database and the application server (optional, and available using the -v parameter only).

For example:

***********************************************************************************************************
*** Missing elements from the application server (present in database only):                            ***
***********************************************************************************************************
0 errors

***********************************************************************************************************
*** Extra elements in the application server (not present in database):                                 ***
***********************************************************************************************************
0 errors

***********************************************************************************************************
*** Elements with invalid version in the application server (present in database with another version): ***
***********************************************************************************************************
0 errors

***********************************************************************************************************
*** Same elements in both database and application server:                                              ***
***********************************************************************************************************
appVersion3DEXPERIENCE MyApps (R43.HF1)
appVersionBusinessProcessServices (R424.HF1)
appVersionCollaborative Space Management (R424.HF1)
appVersionData And Behavior Administration (R424.HF1)
appVersionENOVIA VPM Multi-discipline Collaboration Platform (R424.HF1)
appVersionEffectivityFramework (R424.HF1)
appVersionEnterpriseChangeMgt (R424.HF1)
appVersionProductLine (R424.HF1)
appVersionRequirementsManagement (R424.HF1)
appVersionServiceManagement (R424.HF1)
10 successes

Check successful (no error).

The two possible results are:

```
Check successful (no error)
```
if all elements are the same in both database and application server
```
Check failed (n errors)
```
if there are errors.

The DSYCheckAppServerVsDB return codes are:


Error code	Description
0	Check successful (no errors, all elements are the same in both the database and the application server)
1	Command usage error (missing or unexpected parameter)
2	Path to the web application deployed in the application server not found, or installAppVersionsList.txt file not found in the path, or `mql.exe` file not found in the current server installation file tree
3	Check failed (there are integrity errors in at least one server installation)
4	Usage error in the Java code launched from `mxmrun` and during the comparison
5	One of the files containing the versions (from app server or database) is not readable
6	Check failed (there are differences between the app server and the database)