User Tools

Site Tools


system_five_web_api_service

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
system_five_web_api_service [2017/09/20 13:42]
aschumph [System Five Web API Installation and Updating]
system_five_web_api_service [2017/09/20 13:48] (current)
aschumph Removed content in favour of the Google document
Line 1: Line 1:
 ====== System Five Web API Service Installation and Updating ====== ====== System Five Web API Service Installation and Updating ======
  
-This document ​describes ​the System Web API and provides installation and update instructions.+This document ​is deprecated; please see the document on Google Drive:
  
-===== What is a Windows Service? =====+[[https://​docs.google.com/​document/​d/​e/​2PACX-1vS3aJApHutaHKtK4ZiDhix-I99RkTn7zplnw6gY0085o6vt5eNNmOA5NdWXTwdfhx5S1JCz_bgZSTu_/​pub]]
  
-A Windows service is a computer program that operates in the background; it does not need a user to be logged into the computer and does not have a normal GUI interface. It allows the computer to run the program whenever ​the computer is running.+If you need to edit that document you can find the source here:
  
-===== What is a Web API? ===== +[[https://docs.google.com/document/d/​1F_VPVicW8OAqhS0ajYn8-XQggajCmu6TV4YqEnl9P7c/​edit?​ts=58dab427#]]
- +
-A Web API is a method of data exchange, typically over the Internet.  +
- +
-====== What is the System Five Web API Service? ====== +
- +
-The System Five Web API is a component of System Five that was originally release as part of the 6.1.11 beta. It is now included with all server installs since version 6.2.2.30. This service is not required for all installations,​ only customers who have purchased the Web API can have the System Five Web API installed on their servers. +
- +
-===== System Five Web API Service Files ===== +
- +
-The System Five Web API Service is comprised of four files: +
-  * S5WebAPISvc.exe:​ the service executable +
-  * S5WebAPISvc.ini:​ the configuration file +
-  * S5WebAPISvc_Install.bat:​ a utility batch file to install the service +
-  * S5WebAPISvc_Uninstall.bat:​ a utility batch file to uninstall the service +
- +
-These files can be found in the S5AppServer.exe installation file; the S5WebAPISvc.exe file is also bundled with the zS5AppServer.exe auto-update file. All four of these files need to be placed in the /BIN directory on the customer’s serverThis is typically the same computer that hosts the Pervasive database +
- +
-===== System Five Web API Service User Account in System Five ===== +
- +
-The System Five Web API uses the accounts that have been created in System Five. Typically, you will need to create an account for each third-party that will be connecting to the System Five Web API. The following list identifies a few are common examples of accounts needed for third-parties:​ +
- +
-  * 24Seven: This is the account name that should be used when our customer is integrating with the 24-Seven Channel +
-  * XOLights: This is the account name that should be used when our customer is integrating with XO Lights +
-  * LightsAmerica:​ This is the account name that should be used when our customer is integrating with Lights America +
- +
-===== A Special Note on Passwords ===== +
-Do not use a simple password for these accounts; ensure the password is: +
-  * at least 12 characters long +
-  * contains lower-case letters +
-  * contains upper-case letters +
-  * contains numbers +
-  * does NOT contain special characters +
- +
-Ideally, these passwords should be auto-generated using an online tool. One such example is http://passwordsgenerator.net. +
- +
-===== DSN Setup ===== +
- +
-DSN is one is one of the requirements before installing WEB API service. When setting up DSN for WEB API, use the Pervasive.SQL Databases. Pervasive.SQL DSN-Less Connection is NOT supported. +
- +
-===== Record-State Tracking ===== +
- +
-The System Five Web API uses Record State Tracking for a variety of functions and MUST be enabled for the System Five Web API Service to operate. +
- +
-To enable this option, on System5 go to Setup Wizard > Miscellaneous > Use Record-State Tracking. When first enabling this option this may take some time to complete depending on the size of the database.  +
- +
-===== System Five Web API Service Configuration ===== +
- +
-The System Five Web API is configured by manually editing the S5WebAPISvc.ini file. This file is a normal text file and can be edited using any text editor (such as NotePad that is installed by default on Windows). The file itself is broken into four sections: System Five Web API Service, System Five Database, HTTP and HTTPS. +
- +
-==== System Five Web API Service ==== +
- +
-This section describes the Windows Service: +
-Service Name: The name of the System Five Web API Service; this name will be visible in the Windows Services. You can leave this as default, it only needs to be changed if multiple System Five Web APIs are installed on the same server +
- +
-==== System Five Database ==== +
- +
-This section describes the database connection. Most of these values can be found logging into System Five and navigating to Help - About. +
-  * Directory:​ The full path to the shared directory (not the _datafiles directory) +
-  * Serial: The serial number +
-  * Department:​ The default department for the service +
-  * Terminal: The default terminal for the service +
-  * TerminalName:​ The default terminal name for the service +
-  * Identifier:​ The default identifier for the service +
- +
-==== HTTP ==== +
- +
-This section defines the settings to use for HTTP connections. +
-  * Port: The port number to listen for HTTP connections (typically 2121) +
-  * Session Timeout:​ The timeout (in seconds) for HTTP connections (typically 30) +
- +
-==== HTTPS ==== +
- +
-This section defines the settings to use for HTTPS connections (secured HTTP). If a customer is implementing HTTPS they will need to have a cert file, key file, and root cert file. +
-  * Port: The port number to listen for HTTPS connections (typically 2122) +
-  * Session Timeout:​ The timeout (in seconds) for HTTPS connections (typically 30) +
-  * Cert File: The full path to the cert file +
-  * Key File: The full path to the key file +
-  * Root Cert File: The full path to the root cert file +
- +
-====== Installing the System Five Web API Service ====== +
- +
-Ensure that the WEB API Service files are located in training bin directory. If not then download the latest S5WebAPISvc installer and extract it on the specific bin directory where you want to install it. +
-  - Log in as an administrator in Windows +
-  - Open the “S5WebAPISvc.ini” in a text editor(Ex. Notepad or Notepad ++) +
-  - Update all settings to match the system the service is being installed on+
  
  
system_five_web_api_service.txt · Last modified: 2017/09/20 13:48 by aschumph