Enzo Unified SDK

Enzo Unified SDK Installation and Configuration Guide Version 1.7 – RTM Last Updated On February 28 2017

Any Data. Any Source. Now.

Contents Pre-Requisites ............................................................................................................................................... 2 Install Enzo Unified ....................................................................................................................................... 2 Key Enzo Unified Settings ......................................................................................................................... 3 Installing the Project Templates for Visual Studio ........................................................................................ 5 Create a New Adapter................................................................................................................................... 5 Change Default Settings ............................................................................................................................ 6 Adapter Built-In Help .................................................................................................................................... 6 Connecting to Enzo Unified with SSMS......................................................................................................... 8 Known Issues and Limitations ....................................................................................................................... 8

Pre-Requisites In order to successfully install the Enzo Unified SDK you will need to have the following configuration: -

-

Windows 2012 or higher, 64-bit Operating System A dedicated instance of SQL Server Express 2014 or higher o SQL Server Instance should be installed locally and local user should have admin rights to SQL Server so that databases can be created .NET 4.5 must be installed Visual Studio 2012 or higher with Visual C# o It is possible to use Visual Basic .NET to build adapters; however all examples and templates are available in C# only at this time

It is important to note that Enzo Unified uses SQL Server to store its configuration settings and other parameters. Four databases will be created on the SQL Server instance. There are two executables for installing Enzo Unified: one for AMD processors, and another for Intel processors. For compatibility reasons, it is highly recommended to install a dedicated instance of SQL Server for Enzo Unified. This release of Enzo Unified has certain limitations, documented at the end of this document.

Install Enzo Unified Run the MSI provided by the Enzo Unified support team on the server; this can be a physical machine, or a virtual machine running locally or in the cloud. There are two setup files available: one for Intel processors and another for ADM processors. You must be an administrator on the machine. The installation will make the following significant changes to your machine: 2

Any Data. Any Source. Now. -

A new Windows Service will be created (the name will start with Enzo) A new SSL certificate will be created in the certificate store Firewall rules will be changed to allow the TCP protocol to communicate on the selected port during installation Four databases will be created on the database server A shortcut to Enzo Manager will be created on the desktop 2 new environment variables will be added

Key Enzo Unified Settings The installer will prompt you for specific information, including: -

The Port on which Enzo Unified will listen for incoming SQL requests; by default this value is 9550, but you can change it if desired. The HTTP and HTTPS ports on which Enzo Unified will listen for incoming HTTP traffic; you can also change the default values.

During the installation process, you will be asked to type a namespace for your custom adapters. Although you can enter any short name, you should not use BSC or any company name you do not own.

No spaces or special characters should be provided in the namespace.

During the installation process, you will be asked to connect to the SQL Server instance where Enzo databases will be created. The Database Server name can be in any of the following formats: -

-

-

-

-

ipaddress (ex: 10.1.1.15) o This assumes that the Enzo databases will be installed on the default instance of SQL Server on port 1433 Servername (ex: laptop-ny) o This assumes that the Enzo databases will be installed on the default instance of SQL Server on port 1433 ipaddress,port (ex: 10.1.1.15,14388) servername\instance (ex: localhost\Enzo) o NOTE : when specifying an instance name, make sure the SQL Server Browser service is running .\instance (ex: .\Enzo) o NOTE : when specifying an instance name, make sure the SQL Server Browser service is running Servername,port (ex: laptop-ny,14377)

YOU MUST LOG OFF AND LOG BACK ON, OR RESTART YOUR MACHINE AFTER INSTALLATION

3


4


Installing the Project Templates for Visual Studio In order to create an adapter in Visual Studio 2012 or higher, you will need to copy a few files in the Visual Studio templates directory.  Copy SDK v1.7\Visual Studio\ to your Visual Studio 2012 (or higher) directory folder: C:\Users\...\Documents\Visual Studio 2012\ Once copied, you will see new project types in Visual Studio allowing you to create an adapter.

Create a New Adapter Open Visual Studio 2012 or higher with elevated privileges. Then follow these steps:  File -> New -> Project  Find the Enzo Unified Adapters for Developers project; if you do not see the Enzo Unified templates under Visual C#, the templates were not copied in the correct location

 Change the path of the adapter to your project directory including the namespace used during installation (C:\Program Files\Enzo Unified SDK\Adapters\MY3\ in this example)  Do NOT choose Create Directory for Solution  Click OK

5


Change Default Settings Before you can run the project, you must change the following settings: -

Open the project .cs file (MyAdapter1.cs) o Change the BSC namespace to your namespace, for example (this is the namespace you picked during installation): namespace MY3

-

Change the Configuration Manager to use Debug x64

-

Open the Project Properties (right-click on your project and select Properties) o Under Applications:  Change your Assembly Name so that is starts with your namespace: MY3.MyAdapter1

To successfully run Enzo Unified, you must run Visual Studio with elevated privileges

Adapter Built-In Help Each adapter provides built-in documentation on its use; when you create your own adapter, Enzo Unified will automatically generate the help output. To test help on your adapter, login to Enzo using SQL Server Management Studio, and type the following command (replace MYNAMESPACE with the namespace you provided during the installation process, and MyAdapter with the name of your adapter as specified when you created the project): EXEC MYNAMESPACE.MyAdapter.help This will return all the available commands for your adapter.

6


You can also request help on a specific method within the adapter; for example you can get help on the MyMethod1 method on your adapter by running this command: EXEC MYNAMESPACE.MyAdapter.MyMethod1 help

7


Connecting to Enzo Unified with SSMS When your project is running in debug mode, you can connect using SQL Server Management Studio (SSMS). Start SSMS and login to Enzo using the sa account.

NOTE: This is not the “sa” account of SQL Server; this is the “sa” account of Enzo Unified, which has a default password of “password”

Known Issues and Limitations The Enzo Unified 1.7 build has a few known issues which will be addressed in a future release: -

Cache adapter methods not supported At this time, the internal methods of every adapter that start with _cache are not supported and may not yield the expected result. Declarative Cache support is planned for a future release. You may instead use the _async calls to provide a form of caching.

-

TDS Encryption Generally speaking the SQL traffic is not encrypted, with the exception of the pre-login handshake during which the credentials (user id and password) are sent to Enzo Unified using SSL. Support for TDS encryption is planned for a future release.

-

ADO.NET and Entity Framework It is possible to connect to Enzo Unified with ADO.NET with the SqlCommand object, including support for SqlParameter as long as a value is provided. However the Entity Framework is not supported.

8

Any Data. Any Source. Now. -

Linked Server Linked Server is supported with the following options set:

9