2RING SCRIPTS & FORMS · If a license is missing or invalid, you will still be able to change...

2RING SCRIPTS & FORMS ADMINISTRATOR GUIDE (DOCUMENT VERSION 3.2)

10-Sep-19 .. © 2Ring .. www.2Ring.com 2

2Ring .. AMERICAS 2Ring .. EMEAR

Address

2Ring America, Inc. 8880 Cal Center Dr. Ste.400 Sacramento, CA 95826 USA (916) 426-3790 (916) 426-3791 [email protected] www.2Ring.com

Address.

2 Ring, spol. s r.o. Plynárenská 5 821 09 Bratislava 2 Slovak Republic +421 2 5822 4550 +421 2 5822 4199 [email protected] www.2Ring.com

http://www.2ring.com/mailto:[email protected]://www.2ring.com/mailto:[email protected]://www.2ring.com/

2RING SCRIPTS & FORMS


TABLE OF CONTENTS

CHAPTER 1 INTRODUCTION

CHAPTER 2 INSTALLATION GUIDE

2.1. Installation Prerequisites 5 2.1.1. System Preparation 5

2.2. Installation Process 9

2.3. Import 2Ring GADGETS Public Key 15

CHAPTER 3 OPERATIONS GUIDE

3.1. Uninstall Process 16

CHAPTER 4 LICENSE

http://www.2ring.com/



CHAPTER 1

INTRODUCTION

This document serves as an administration guide for the 2Ring SCRIPTS & FORMS application. The document describes the installation process, security configuration, and licensing.

The abbreviations 2Ring SF or SF may be used instead of the full application name throughout this document.




CHAPTER 2

INSTALLATION GUIDE

2.1. Installation Prerequisites

This chapter describes the installation of the following components on the Application Server:

SF Web Application

SF Database

2.1.1. System Preparation

Preparing the 2Ring SF Application Server consists of the following steps:

Install the operating system and apply the available updates

Add server roles and services

Install Dependencies

Operating System Requirement

Application Server supports the following Windows Server versions:

Windows Server 2012

Windows Server 2012 R2

Windows Server 2016

Windows Server 2019

SQL Server Requirement

Database Server supports the following SQL Server versions (Express Edition or above):

SQL Server 2012

SQL Server 2014

SQL Server 2016

SQL Server 2017

SQL Server 2019




Operating System Installation

Install the operating system of your choice and install all critical updates before continuing. Once the operating system is ready, add the following roles to the operating system:

Web Server (IIS) with ASP.NET

HTTP Redirection

Windows Authentication

To do so follow these steps:

Windows Server 2012 / 2016

In Server Manager click Manage -> Add Roles and Features

In the Server Roles part of the wizard, click Web Server (IIS) and click Next.




In the Role Services part of the wizard, enable the following:

Web Server -> Common HTTP Features

o HTTP Redirection

Web Server -> Security

o Windows Authentication

Web Server -> Application Development

o On Windows Server 2012, ASP.NET 4.5

o On Windows Server 2016, ASP.NET 4.6

Finish wizard by clicking Install.




Dependencies Installation

Install the following dependency packages.

Web Deploy 3.5 (also accessible via Platform Installer) http://www.microsoft.com/en-us/download/details.aspx?id=39277 (WebDeploy_amd64_en-US.msi)

If installing on Windows Server older than 2016 install MS .Net Framework 4.6.2:

MS .Net Framework 4.6.2

https://www.microsoft.com/en-us/download/details.aspx?id=53344

Once MS .Net Framework 4.6.2 is installed, register ASP.NET 4.6.2. Go to CMD prompt,

enter:

%WINDIR%\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis.exe -i

Microsoft SQL Server 2016 SP1 Feature Pack


ATTENTION! From the download link choose these two msi files listed below.

(ENU\x64\SharedManagementObjects.msi)

(ENU\x64\SQLSysClrTypes.msi)

2Ring SF can use SQL server running directly on Application Server as well as a remotely accessible SQL server. Depending on your needs install either the SQL Server or the SQL Server Client Components:

If you DO intend to run SQL server on the Application Server install:

Any supported commercial version of SQL Server on the application server

or

Microsoft SQL Server 2017 Express


If you DO NOT intend to run SQL server on the application server install the client components:

Microsoft Core XML Services (MSXML) 6.0

http://go.microsoft.com/fwlink/?LinkId=3999

(msxml6_x64.msi)

Microsoft ODBC Driver 13.1 for SQL Server x64


(msodbcsql.msi)

http://www.2ring.com/http://www.microsoft.com/en-us/download/details.aspx?id=39277https://www.microsoft.com/en-us/download/details.aspx?id=53344https://www.microsoft.com/en-us/download/details.aspx?id=52676http://go.microsoft.com/fwlink/?LinkId=3999https://www.microsoft.com/en-us/download/details.aspx?id=53339



2.2. Installation Process

Installing SF requires the following steps in the order listed:

Install SF Database.

Install SF Web Application.

Unzip the distribution package to a directory where the components will run from. The recommended path is: C:\Program Files\2Ring\SF.

ATTENTION! Do not remove the unzipped package after installation.

Database Installation

Navigate to Database folder in the distribution package after unzipping.

Open Connection.xml in Database folder.

ServerName

Type the hostname or IP\InstanceName of the SQL Server that will be hosting the

new SF database. If SQL Server is not on default port, use the following format:

hostname or IP\InstanceName, Port

DBName

Type the name of the database that is going to be created for SF.

UserName (Optional)

Type the username of a sysadmin user that will be used to create the SF database.

Leave blank to use integrated security mode. If the username is left blank, the

password must be blank as well. The user installing the SF database must have

Sysadmin role in SQL Server assigned.

Notice: These credentials are only used during the installation process and are not stored elsewhere.

Password (Optional)

Type in the password for the SQL sysadmin user. Only type it in if the username was

specified. If this value is left blank with the username filled out, user will be

prompted to enter the password on runtime.

Notice: It is recommended to skip this field and supply it during the installation process to avoid storing it on the disk in a readable form.




Save the file.

Open a command prompt as Administrator and run Install.cmd

Open InstallParameters.xml.

Edit the following fields:

DBUserName

This user will be used to connect to the SF database at runtime after installation.

It may be a new user account or an existing one. If the user account is new it will

automatically be created. This cannot be the same account used in the

Connection.xml file.

If using an existing account, make sure that:

This account is an SQL type login.

This account does not have sysadmin server role assigned to avoid security

risks.

This account has Public server role assigned.

The login does not have "User must change password at next login" policy

enabled.

DBUserPassword

Enter the password of the user above (DBUserName).




Web Application Installation

Open the Internet Information Services (IIS) Manager.

In IIS Manager, browse to the website to which you want to deploy SF.

Right click the website, choose Deploy, and then Import Application:




Browse to C:\Program Files\2Ring\SF\Web to find the installation package

(2Ring_SF_vX.X.X.zip) and click Open and then Next:

Click Next:




Enter the application package information and then click Next:

Application Path: Virtual folder name for the application.

Connection String (connect to the application database): This user will be used to

connect to the SF database and should be the same user specified in the

InstallParameters.xml file. Fill out the connection string with the following

information:

Server

hostname or IP\instance of SQL Server where SF database is installed.

Database

SF database name.

User ID

User used to connect to SF database.

Password

Password of user to connect to SF database.

JsonConfigurationFileURLPathParameter: Path to JSON configurations. Default path

is ~/../Client/Content/ when default application path 2Ring/SF is used.




If you are installing SF for the first time, ignore this step (you will not see such a question).

Otherwise, choose: "Yes, delete all extra files and folders on the destination that are not in

the application package" and then click Next:




Wait until installation ends and click Finish to complete installation process.

In IIS Manager, verify that the application pool for a new website is configured to run using

.NET framework version 4.0 and that the Managed pipeline mode is set to Integrated.

2.3. Import 2Ring GADGETS Public Key

2Ring SF communicates over a secured channel with 2Ring GADGETS. SF must store the GADGETS public key certificate. To create the secure channel, follow the steps below:

Export the public key from 2Ring GADGETS (refer to the Gadgets Admin guide).

Notice: In the 2Ring GADGETS Configuration Page, navigate to section Server -> Encryption, click the Export Public Key button.

Navigate to the base folder of 2Ring SF. The Base folder is the place where you installed the

application (usually C:\inetpub\wwwroot\2Ring\SF\). In the WebAPI directory, save the

exported XML file to folder PublicKey (if it is missing, create it).




CHAPTER 3

OPERATIONS GUIDE

3.1. Uninstall Process

Uninstalling SF requires the following steps in the order listed:

Uninstall SF Application.

Uninstall SF Database.

3.1.1. Application Uninstall

Open IIS Manager.

Right click on 2Ring SF application.

Select Deploy and then Delete Folder and Content.

Click Ok.

3.1.2. Database Uninstall

Connect with SQL Management Studio to the instance where the SF database is installed.

Delete the database.

Notice: The SQL Server login must have sysadmin rights.




CHAPTER 4

LICENSE

A valid license is required to use 2Ring SCRIPTS & FORMS.

If you are an existing customer and your installation is covered by any of our support packages, then the fastest way to handle any license changes is by opening a new RFC ticket in our case tracking system – https://apps.2Ring.com/supportcental. If you do not know your credentials, please contact us via email at [email protected].

Information about a missing or expired license is displayed every time, as shown below when trying to connect to the server (see Figure 1).

If a license is missing or invalid, you will still be able to change forms, but you will not be able to save the changes.

Figure 1: Invalid license message in SF

To insert a valid license or replace an existing one, copy the license file to folder License (if it is missing, create it). License folder is located in the WebAPI web application folder. Default installation path: C:\inetpub\wwwroot\2Ring\SF\WebAPI\License\
http://www.2ring.com/https://apps.2ring.com/supportcentalmailto:[email protected]

2RING SCRIPTS & FORMS · If a license is missing or invalid, you will still be able to change...

Documents

Transcript of 2RING SCRIPTS & FORMS · If a license is missing or invalid, you will still be able to change...