Merge pull request #43 from RegestaItalia/updateCore

Update core

README.md

@@ -49,10 +49,10 @@ List of all commands is available [here](/docs/commands.md).
 
 # Contributing <!-- {docsify-remove} -->
 
-Like every other TRM open-soruce projects, contributions are always welcomed ❤️.
+Like every other TRM open-source projects, contributions are always welcomed ❤️.
 
 Make sure to open an issue first.
 
 Contributions will be merged upon approval.
 
-[Click here](https://docs.trmregistry.com/#/CONTRIBUTING) for the full list of TRM contribution guidelines.
+[Click here](https://docs.trmregistry.com/#/CONTRIBUTING) for the full list of TRM contribution guidelines.

docs/commands.md

@@ -23,7 +23,7 @@ where `logType` can be one of the following values:
 
 To enable logging of debug data, add this option
 
-`-v, --verbose`
+`-dbg, --debug`
 
 to any command.
 

docs/setup.md

@@ -16,7 +16,11 @@ After installing NodeJs and npm, make sure to have the following environment var
 
 Running the command `npm` in your system CLI should output all of the possible commands.
 
-## SAP NW RFC SDK
+## SAP NW RFC SDK (Optional)
+
+> [!NOTE]  
+> As of trm-core 6.0.0 (December 2024), SAP NW RFC SDK has become optional in TRM installation. This comes with the end of the support of node-rfc library ([#329](https://github.com/SAP/node-rfc/issues/329)).
+
 TRM Client communicates with SAP systems through RFC.
 
 For this reason, it's necessary to have the RFC SDK installed on your system.
@@ -27,69 +31,142 @@ To sum up the installation:
 
 - Download the RFC SDK from the SAP® Support Portal (follow the updated link of the note in [this section](https://support.sap.com/en/product/connectors/nwrfcsdk.html?anchorId=section_1291717368))
 
-> **TRM DOESN'T PROVIDE THE REQUIRED SDK, IT CAN BE DOWNLOADED FROM OFFICIAL SOURCES**
-
 - On Windows
-    - Create the folder `C:\nwrfcsdk`
+
+    1. Create the folder `C:\nwrfcsdk`
 
-    - Place the content downloaded into this folder (extract if needed)
+    2. Place the content downloaded into this folder (extract if needed)
 
-    - Make sure `C:\nwrfcsdk\bin` exists
+    3. Make sure `C:\nwrfcsdk\bin` exists
 
-    - Make sure the libraries are also included in the bin folder (`C:\nwrfcsdk\bin\icudt50.dll` ...), if not, copy the content of the folder `C:\nwrfcsdk\bin\lib` into `C:\nwrfcsdk\bin`
+    Make sure the libraries are also included in the bin folder (`C:\nwrfcsdk\bin\icudt5x.dll` ...), if not, copy the content of the folder `C:\nwrfcsdk\bin\lib` into `C:\nwrfcsdk\bin`
 
-    - Running the command `rfcexec` through cmd, in the folder `C:\nwrfcsdk\bin`, should list the mandatory fields of the command
+    Running the command `rfcexec` through cmd, in the folder `C:\nwrfcsdk\bin`, should list the mandatory fields of the command
 
-    - Create an enviroment variable named `SAPNWRFC_HOME`, with the path `C:\nwrfcsdk`
+    4. Create an enviroment variable named `SAPNWRFC_HOME`, with the path `C:\nwrfcsdk`
 
-    - Add `C:\nwrfcsdk\bin` to the PATH variable (same procedure done earlier for checking the npm install)
+    5. Add `C:\nwrfcsdk\bin` to the PATH environment variable
+
+    6. Run the command `npm install node-rfc -g`
+
+## ICU common library
 
-## R3Trans program
+If you installed the [SAP NW RFC SDK](#SAP-NW-RFC-SDK-Optional) you can **skip this step**, as the library should be already provided with the SDK.
 
-For this step, installing [SAP NW RFC SDK](#SAP-NW-RFC-SDK) is necessary.
+Start by downloading **SAPCAR** (for more information refer to SAP Note [212876](https://me.sap.com/notes/212876)), which will be used for unpacking SAPEXE.
 
-The R3Trans program is used by TRM Client to unpack the packages downloaded from a registry.
+> SAPCAR is a utility used by SAP to compress and/or uncompress SAP archive files (SAR: SAP Archive)
 
-For this reason, it's necessary to have the R3Trans program on your system.
+1. Go to [Software downloads in SAP for Me](https://me.sap.com/softwarecenter)
+2. Click the **SUPPORT PACKAGES & PATCHES** section
+3. Expand the **By Alphabetical Index (A-Z)** section
+4. Click the **S** letter
+5. Click the **SAPCAR** element of the list
+6. Select the highest available version
+7. Select your operating system
+8. Click the element you want to download
 
-A guide on installing the program can be found [here](https://github.com/RegestaItalia/node-r3trans#installation) (The command `npm install node-r3trans` should be skipped from the linked guide).
+Now, download **SAPEXE**
 
-To sum up the installation:
+1. Go to [Software downloads in SAP for Me](https://me.sap.com/softwarecenter)
+2. Click the **SUPPORT PACKAGES & PATCHES** section
+3. Expand the **By Alphabetical Index (A-Z)** section
+4. Click the **K** letter
+5. Select a 64bit kernel
+6. Select your operating system
+7. Click on the SAPEXE element you want to download
 
-- Download the R3trans program from [SAP® Software Download Center](https://support.sap.com/en/my-support/software-downloads.html)
+After downloading SAPCAR and SAPEXE, unpack its content with the command
 
-> **TRM DOESN'T PROVIDE THE R3TRANS PROGRAM, IT CAN BE DOWNLOADED FROM OFFICIAL SOURCES**
+`sapcar -xvf <SAPEXE file>.SAR`
 
 - On Windows
 
-    - Create the folder `C:\R3Trans`
+    1. Create the folder `C:\ICU`
+
+    2. Move the ICU common library dlls (icuuc5*x*.dll, icudt5*x*.dll, icuin5*x*.dll) into that folder
+
+    3. Add `C:\ICU` to the PATH environment variable
+
+- On Linux
+
+    1. Create the folder `C:\ICU`
+
+    2. Move the ICU common library files (libicuuc5*x*.so, libicudata5*x*.so, libicui18n5*x*.so) into that folder
+
+    3. Create an enviroment variable named `LD_LIBRARY_PATH`, with the path `C:\ICU`
+
+## R3trans program
+
+For this step, installing [SAP NW RFC SDK](#SAP-NW-RFC-SDK-Optional) or having the [ICU common library](#ICU-common-library) is necessary.
+
+The R3trans program is used by TRM Client to unpack the packages downloaded from a registry.
 
-    - Place the content downloaded into this folder (extract if needed)
+Start by downloading **SAPCAR** (for more information refer to SAP Note [212876](https://me.sap.com/notes/212876)), which will be used for unpacking the R3trans program.
 
-    - Make sure `C:\R3Trans\R3trans.exe` exists
+> SAPCAR is a utility used by SAP to compress and/or uncompress SAP archive files (SAR: SAP Archive)
 
-    - Running the command `R3trans` through cmd, in the folder `C:\R3Trans`, should list possible commands
+1. Go to [Software downloads in SAP for Me](https://me.sap.com/softwarecenter)
+2. Click the **SUPPORT PACKAGES & PATCHES** section
+3. Expand the **By Alphabetical Index (A-Z)** section
+4. Click the **S** letter
+5. Click the **SAPCAR** element of the list
+6. Select the highest available version
+7. Select your operating system
+8. Click the element you want to download
 
-    - Create an enviroment variable named `R3TRANS_HOME`, with the path `C:\R3Trans`
+To download the **R3trans** program:
+
+1. Go to [Software downloads in SAP for Me](https://me.sap.com/softwarecenter)
+2. Click the **SUPPORT PACKAGES & PATCHES** section
+3. Expand the **By Alphabetical Index (A-Z)** section
+4. Click the **K** letter
+5. Select a 64bit kernel
+6. Select your operating system
+7. Click on the R3trans element you want to download
+
+After downloading SAPCAR and R3trans, unpack the program with the command
+
+`sapcar -xvf <R3trans file>.SAR`
+
+- On Windows
+
+    1. Create the folder `C:\R3Trans`
+
+    2. Place the extracted content into this folder
+
+    3. Make sure `C:\R3Trans\R3trans.exe` exists
+
+    Running the command `R3trans` through cmd, in the folder `C:\R3Trans`, should list possible commands
+
+    4. Create an enviroment variable named `R3TRANS_HOME`, with the path `C:\R3Trans`
 
 # trm-client Install
 
 For this step, installing [all of the requirements](#trm-client-requirements) is necessary.
 
-Before executing this step, it's recommended to close and reopen the CLI (if the same instance was used for setting environment variables, they might be ineffective until reloading).
+> Before executing this step, it's recommended to close and reopen the CLI (if the same instance was used for setting environment variables, they might be ineffective until reloading).
 
 Run this command in your system CLI:
 
 `npm install trm-client -g`
 
 this will install the [trm-client package](https://www.npmjs.com/package/trm-client) in your system.
 
-If all of the requirements are met, running the command
+If all of the requirements are installed, running the command
 
 `trm`
 
 in your CLI should output all of the possible commands.
 
+# trm-rest (Optional)
+
+As of trm-core 6.0.0 (December 2024), it is now possible to connect to an SAP system through REST APIs.
+
+> trm-rest is the porting/exposure of the legacy RFC trm-server functions in REST APIs. 
+
+Install guide for trm-rest can be found [here](https://github.com/RegestaItalia/trm-rest).
+
 # Virtual System (Recommended)
 
 It's highly recommended to make use of Virtual Systems in order to release transports without worrying about leaving them in queues.