COBISOFT Documentation

User Tools

Site Tools

You are here: English » COBI.time » COBI.time Installation
cobi.time:installation_guide

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
cobi.time:installation_guide [2023/10/12 10:18] – hbernhardtcobi.time:installation_guide [2026/08/04 09:10] (current) – thuth
Line 3: Line 3:
 ===== Requirements ===== ===== Requirements =====
  
-  * [[https://nodejs.org/en/download/|NODE.js LTS]] Version 17 +  * Node.js Version 22.14.0 LTS 
-  * Microsoft IIS (WebServer) +  * Microsoft IIS (Web Server) 
-  * [[https://www.iis.net/downloads/microsoft/url-rewrite|Module for Microsoft IIS (URL Rewrite)]] +  * [[https://www.iis.net/downloads/microsoft/url-rewrite|URL Rewrite Module for Microsoft IIS]] 
-  * SAP Business One ServiceLayer +  * PostgreSQL Database 
-  * SAP Business One 10 Patchlevel 2+  * SAP Business One Service Layer 
 +  * SAP Business One 10 (Patch Level 2 or higher)
  
-===== Installation =====+===== Preparation & Prerequisites =====
  
-==== NODE.js Installation ====+==== Node.js Installation ====
  
-Download the NODE.js LTS Version (See link in Requirements) and install it. Do not alter any values in the installation process. Just install it in the default way.+Download the LTS version of Node.js: \\ 
 +[[https://nodejs.org/dist/v22.14.0/node-v22.14.0-x64.msi|nodejs.org/dist/v22.14.0/node-v22.14.0-x64.msi]] and run the installer. \\ 
 +Keep all default settings during the installation process. 
 + 
 +----
  
 ==== IIS Installation ==== ==== IIS Installation ====
  
-If Microsoft IIS is already installed you this Installation Guide may not be applicable for you. Just make sure the dynamic compression is installed for Microsoft IIS.+If Microsoft IIS is already installed, ensure that **Dynamic Content Compression** is enabled. \\ 
 +Also verify whether IIS has already been installed:
  
-Make sure Microsoft IIS is not installed:+\\\
  
 {{:1.png?800|}} {{:1.png?800|}}
 +
 +\\\
  
 If not, install Microsoft IIS: If not, install Microsoft IIS:
 +
 +\\\
  
 {{:2.png?300 |}} {{:2.png?300 |}}
Line 29: Line 39:
 \\\ \\\
  
-Picture 1: Add Roles or Features+Add Roles and Features: \\
  
-\\+Click **Next** through the wizard steps:
  
-Press Next:+\\\
  
-{{:5.png?500|}}+{{:5n.png?500|}}
  
 \\\ \\\
  
-Press Next:+{{:6n.png?500|}}
  
-{{:6.png?500|}}+\\\ 
 + 
 +{{:7n.png?500|}}
  
 \\\ \\\
  
-Press Next: +Select the **Web Server (IIS)** role. \\ 
- +Under **Performance**, ensure that **Dynamic Content Compression** is enabled.
-{{:7.png?500|}}+
  
 \\\ \\\
- 
-Install Webserver IIS with standard Features (just click on Webserver) but also add under Performance: Dynamic Compression: 
  
 {{:3.png?500 |}} {{:3.png?500 |}}
Line 57: Line 66:
 \\\ \\\
  
-Press next untill you get install. Then Install the Features. You normally don’t need to restart the computer.+Click **Next** and complete the installation. \\ 
 +A server restart is usually not required.
  
-\\\+----
  
-==== IIS Module URL Rewrite Installation ====+==== IIS URL Rewrite Module Installation ====
  
-Install the URL Rewrite from the requirements after you have installed IIS successfully:+After IIS has been installed successfully, install the Microsoft URL Rewrite Module: \\ 
 +[[https://www.iis.net/downloads/microsoft/url-rewrite|https://www.iis.net/downloads/microsoft/url-rewrite]]
  
-https://www.iis.net/downloads/microsoft/url-rewrite+----
  
-\\\+===== COBI.time Setup Wizard =====
  
-==== COBI.time Installation ====+Run the setup executable vX.X.X.X.exe as Administrator to start the installation wizard.
  
-Install COBI.time via the Installation File which you get from us. COBI.time then gets installed to the standard folder: ''C:\Program Files (x86)\COBI.time\''+==== Step 1: Start the Setup ====
  
-Navigate to that folder and then edit the ''.env'' file with Notepad. (Make sure you have administrator rights. Otherwise start notepad as admin and then open the ''.env'' from Open File context):+Start the installation using the provided installer file. \\ 
 +{{:de:playground:1_setup_symbol.png?100|}}
  
-\\\+----
  
-{{:4.png?450 |}}+==== Step 2: Select Setup Language ====
  
-\\\+(1) Select your preferred language (e.g., German or English) from the list. \\ 
 +(2) Confirm with **OK**. \\ 
 +{{:de:playground:2_setup_sprache.png?600|}}
  
-<code> +----
-MODE=production (production or development – put it in production to minimize logs) +
-PORT=62000 (specify any port here for COBI.time Backend) +
-SAP_URL=https://localhost:50000/b1s/v1 (ServiceLayer URL – Replace Localhost with ServiceLayerIP) +
-SAP_USER=manager (SAP User with indirect Access License or higher) +
-SAP_PASSWORD=**** (SAP User Password) +
-SAP_DB=SBODemoDE93 (SAP Database Name) +
-SSLPass=1234 (Password for custom SSL Certificate. Leave 1234 if you don’t provide with an extra SSL Certificate) +
-SECRET=iosncaonmwdo1! (Change to any random string for authorization token encryption) +
-</code>+
  
-Don’t change any other fields!+==== Step 3: PostgreSQL Configuration ====
  
-You have the possibility to change the SSL Certificate if you want to host COBI.time outside of your internal network and specify a domain. In ''C:\Program Files (x86)\COBI.time\server\certs'' replace the ''cert.pem'' with the certificate and the ''key.pem'' with the private password protected key.  Change the SSLPass accordingly.+Enter the connection information for your PostgreSQL database (host, port, username, password, and database name). \\ 
 +Then click **Next**. \\ 
 +{{:de:playground:3_setup_postgresql.png?600|}}
  
-\\\+----
  
-==== COBI.time Service Installation ====+==== Step 4: SAP Service Layer Configuration ====
  
-Open Powershell as Administrator and navigate to: ''C:\Program Files (x86)\COBI.time\server''+(1) Enter the SAP Service Layer URL (e.g., http://10.200.17.93:50001/b1s/v1). \\ 
 +(2) Enter the SAP username (e.g., manager). \\ 
 +(3) Enter the corresponding password. \\ 
 +(4) Enter the exact SAP company database name (e.g., SBODemoDE). \\ 
 +(5) Click **Test Connection** and ensure the message Login successful appears. \\ 
 +(6) Click **Next**. \\ 
 +{{:de:playground:4_setup_servicelayer.png?750|}}
  
-Install a global NPM Package for Microsoft service creation with the command (Make sure NODE.JS LTS Version is installed. After new NODE.JS Installation restart powershell):+----
  
-<code> +==== Step 5: Select Installation Directory ====
-npm i -g qckwinsvc +
-</code>+
  
-After that use that new package to install a COBI.time Microsoft Service.  Make sure all values in the command are correct:+Choose the installation path. By default, COBI.time will be installed under C:\Program Files (x86)\COBI.time. \\ 
 +Click **Next**. \\ 
 +{{:de:playground:5_setup_auswaehlen.png?600|}}
  
-<code> +----
-qckwinsvc --name "COBI-time" --description "COBI.time Backend Server" --script "C:\Program Files (x86)\COBI.time\server\server.js" -–startImmediately +
-</code>+
  
-If you install COBI.time to a different folder change the command accordingly.+==== Step 6: Ready for Installation ====
  
-If you get an Powershell Execution Policy Error execute this Command beforehand:+Review your settings and click **Install** in the bottom-right corner. \\ 
 +{{:de:playground:6_setup_installation.png?600|}} 
 + 
 +---- 
 + 
 +==== Step 7: Installation & Database Initialization ==== 
 + 
 +The installation process takes approximately 5 to 15 minutes. \\ 
 +Confirm the information window PostgreSQL installed and connection successful! by clicking **OK**. \\ 
 +{{:de:playground:7_setup_installation_.png?600|}} 
 + 
 +---- 
 + 
 +==== Step 8: Finish Setup ==== 
 + 
 +Click **Finish** to close the wizard. \\ 
 +{{:de:playground:8_setup_finish.png?600|}} 
 + 
 +---- 
 + 
 +===== Post Configuration & Service Setup ===== 
 + 
 +==== Configure the .env File ==== 
 + 
 +Navigate to the folder C:\Program Files (x86)\COBI.time\server and open the .env file using a text editor with Administrator privileges: \\ 
 +{{:de:playground:9_setup_env.png?1000|}} 
 + 
 +Verify the values. For productive use, adjust the following parameters:
  
 <code> <code>
-Set-ExecutionPolicy RemoteSigned+MODE=production (Production or development mode. Set to production to minimize logging.) 
 +PORT=62000 (Specify the backend port for COBI.time.) 
 +SAP_URL=https://localhost:50000/b1s/v1 (Service Layer URL. 
 +Replace localhost with the actual Service Layer IP address.) 
 +SAP_USER=manager (SAP user with an indirect access license or higher.) 
 +SAP_PASSWORD=**** (SAP user password.) 
 +SAP_DB=SBODemoDE93 (SAP database name.) 
 +SSLPass=1234 (Password for a custom SSL certificate. 
 +Keep 1234 if you do not provide another SSL certificate.) 
 +SECRET=iosncaonmwdo1! (Replace with any random string used for token encryption.)
 </code> </code>
  
-\\\+> **SSL Certificate Note:** If you want to use your own SSL certificate, replace the files `cert.pem` and `key.pem` in the folder `C:\Program Files (x86)\COBI.time\server\certs` and adjust the `SSLPass` value in the `.env` file.
  
-==== IIS Configuration ====+----
  
-Open IIS-Manager:+==== Install the COBI.time Service via PowerShell ====
  
-{{:8.png?550|}}+Open Windows PowerShell as Administrator and execute the following commands:
  
-\\\+(1) Change to the server directory:
  
-Change the default Website to COBI.time Folder: +<code> 
 +cd "C:\Program Files (x86)\COBI.time\server" 
 +</code>
  
-\\+(2) Install the Windows service helper package globally:
  
-{{:9.png?550|}}+<code> 
 +npm i -g qckwinsvc2 
 +</code> 
 + 
 +(3) Register and start the COBI.time service: 
 + 
 +<code> 
 +qckwinsvc2 install name="COBI-time" description="COBI.time Backend Server" path="C:\Program Files (x86)\COBI.time\server\server.js" args="-a -c" now 
 +</code>
  
 \\ \\
 +{{:de:playground:10_setup_powershell.png?600|}}
  
-Change the Physical Path Property to: ''C:\Program Files (x86)\COBI.time\dist''+Ensure that the confirmation message `[INFO] Service COBI-time started.` appears at the end. 
 + 
 +---- 
 + 
 +==== Verify the Service in Windows Services ==== 
 + 
 +Open the Windows Services Manager (`services.msc`). \\ 
 +Locate the **COBI-time** service and ensure that its status is **Running** and its startup type is set to **Automatic**.
  
 \\\ \\\
  
-{{:10.png?700|}}+{{:de:playground:11_setup_dienst.png?800|}}
  
-\\+\\\
  
-Open Server Certificates and add COBI.time Servercertificate to it:+----
  
-{{:11.png?700|}}+===== IIS Web Server Configuration =====
  
-\\+1. Open **Internet Information Services (IIS) Manager**.
  
-Right Click -> Import+{{:8.png?550|}}
  
-Select the .pfx from ''C:\Program Files (x86)\COBI.time\server\certs\cobitime.pfx'' (Or use your own Certificate).  The default Password is 1234.+2. Select the **Default Web Site** and change the physical path to: \\ 
 +   `C:\Program Files (x86)\COBI.time\dist`
  
 \\\ \\\
  
-Edit the Default Web Site Binding Settings:+{{:9.png?550|}}
  
-{{:12.png?300|}}+\\\ 
 + 
 +{{:10.png?700|}}
  
 \\\ \\\
  
-Remove http from the list and add only https to it. Select the SSL Certificate which you just imported:+3. **Import the Server Certificate:** 
 +   * Open **Server Certificates**. 
 +   * Right-click → **Import...** 
 +   * Select the certificate file `C:\Program Files (x86)\COBI.time\server\certs\cobitime.pfx` (default password: `1234`) or use your own SSL certificate.
  
-{{:13.png?700|}}+\\\ 
 + 
 +{{:11.png?700|}}
  
 \\\ \\\
  
-Important: SNI (Server Name Indication) must be ticked!+{{:12.png?300|}}
  
-After this Step the COBI.time Website should be up and running under: ''https://serverNameHere'' or ''https://localIpAddressHere''.+4. **Adjust Site Bindings:** 
 +   * Remove the HTTP binding. 
 +   * Add an HTTPS binding and select the imported SSL certificate. 
 +   * Important: Enable the **Require Server Name Indication (SNI)** option.
  
-\\\+{{:13.png?700|}} 
 + 
 +----
  
-===== COBI.time Setup Website Backend Connection =====+===== Configure Backend Connection in the Frontend =====
  
-Navigate to: ''C:\Program Files (x86)\COBI.time\dist\cfg'' and edit the ''settings.js'' file:+Navigate to the folder `C:\Program Files (x86)\COBI.time\dist\cfg` and open the file `settings.js`.
  
 {{:14.png?350|}} {{:14.png?350|}}
  
-\\\+For the backend URL, enter the server IP address or hostname including the port configured in the `.env` file (e.g., `https://10.200.17.93:62000`).
  
-Change the URL to the Backend IP Address + Port which you specified in the ''.env'' File.+----
  
-\\\+===== Initial Setup of COBI.time Data Structures (Web Setup) =====
  
-===== COBI.time Database Setup =====+> **Important:** Since COBI.time creates custom tables and fields in SAP Business One, make sure that **all users are logged out of SAP Business One** during the initial setup.
  
-Warning: COBI.time will alter the SAP Database. Make sure every User is logged out from SAP before doing this Step +1. Ensure that the **COBI-time** service is running. 
-Make sure the previously installed service is running. Navigate to COBI.time Website: https://localhost/Setup +2. Open your browser and navigate to the setup page: \\ 
- +   `https://localhost/Setup` (or your server address). \\
-This site should display a changelog and every table COBI.time wants to create:+
  
 {{:15.png?600|}} {{:15.png?600|}}
  
-\\\+3. The web setup will automatically guide you through the creation of the required SAP tables, fields, and initial data: 
 +   * **Create Tables:** Click **Execute**. Once completed, restart the **SAP Service Layer** and confirm with **OK**. 
 +   * **Create Fields:** Click **Execute** again. Restart the **SAP Service Layer** a second time and confirm with **OK**. 
 +   * **Import Initial Data:** Click **Execute** one final time.
  
-Click on execute and wait until all tables have been created. COBI.time then asks you to restart the Service Layer.+{{:16.png?400|}}
  
-After you have restarted the Service Layer click ok:+4. After completion, you will automatically be redirected to the login page (`https://localhost/Login`).
  
-{{:16.png?400|}}+You can now log in using the default administrator credentials:
  
-The Website will reload and you can now create the fields for the tables. After that it asks you to restart the service layer one more time. After restarting press on OK. The Website again should reload. After it has reloaded press execute one more time for the COBI.time initial data. Once it is done you can just press ok and the website will reload and you should be taken to the login page. If the automatic transfer to the login page does not work, just navigate to it manually: https://localhost/Login+  * **Username:** `admin` 
 +  * **Password:** `admin`
  
-You have successfully installed COBI.time. You can now login as Administrator with:+> **Security Notice:** Change the administrator password immediately after the first login!
  
-Username: admin+==== PIN Activation (optional) ====
  
-Password: admin+To enable PIN entry in COBI.time, an activation password is required.
  
-Make sure to change that password. If you have further questions regarding COBI.time usage is answered in the COBI.time manual. +Prerequisite (Server):   
 +On the server, a password must be defined in the .env file (activation password). \\   
 +This password is not stored in COBI.time itself but is only used once to activate the PIN function on the device. \\  
  
-\\+Content example:   
 +<file env .env> 
 +PinLoginPassword=test 
 +</file>
  
 ====== Uninstallation ====== ====== Uninstallation ======
Line 230: Line 316:
  
 After that you can just remove the COBI.time installation from your computer. After that you can just remove the COBI.time installation from your computer.
- 
- 
- 
- 
- 
cobi.time/installation_guide.1697098704.txt.gz · Last modified: by hbernhardt
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki