Last updated: 2019-06-27

Prerequisites for the Log API

This page describes the prerequisites for successfully installing and running the Log API.

The Log API is a Web Application hosted within IIS and is installed as part of the Core Services package.

graph LR subgraph Integration Platform roLogSink[fal:fa-bolt Integration Flow Application] end subgraph App Server roLogSink2[fal:fa-bolt Custom Logging Solution ] end subgraph Web Server roLogAPI(fal:fa-cloud-download LogAPI) end subgraph SQL Server roSQL1(fal:fa-database Configuration Database) --- roSQL2(fal:fa-database Active Log Database) roLogSink -->|REST| roLogAPI roLogAPI -->| SQL, DTC, DNS, RPC |roSQL1 roLogSink2 -->| WCF |roLogAPI end
Verified Topic
MSDTC
Windows rights
Database rights
Firewall

Use the checklist above to verify that you have performed all steps required to get Nodinite flying

About WCF

If you need WCF then please read the 'Log using WCF' article for additional information and additional prerequisites.

Nodinite Supports WCF although we believe REST is the way to go today, use WCF for your legacy systems if you really need it

Microsoft Distributed Transaction Coordinator (DTC)

The Log API is involved in SQL Server related operations and Nodinite uses the Windows Service Microsoft Distributed Transaction Coordinator (DTC) that is responsible for coordinating transactions that span multiple resource managers. We have written a dedicated tutorial for Nodinite with our best practices for how to install and configure the DTC Windows Service.

You must configure the DTC as documented otherwise Nodinite will not be able to function

What Windows rights does the Log API require?

When you install Nodinite using the install and update tool the Log API is assigned an IIS App Pool. This IIS App Pool is set to run with a dedicated Windows Service account. The Log API uses integrated security which is a feature built into IIS and further call to SQL Server are being performed as this identity.

If the configured service account for IIS App Pool is not local administrator then the Windows Domain account must be added to the local 'IIS_IUSRS' group. The account used must also be assigned certain SQL Rights, see next paragraph.

NOTE: If the Windows User account for the Application pool is not assigned the sysadmin role, then you must make sure the account is added to the list of logins to apply correct user rights for (as new databases are created). This settings is governed by the ImLogServiceUsers system parameter.

What SQL Rights does the Log API require?

For performance reasons the Log API accesses the databases directly using the Windows Service Account configured for the Log API and must have the following SQL rights assigned:

  • Configuration Database
    • db_datareader
    • db_datawriter
    • db_ddladmin
    • Grant Execute rights on all existing and future stored procedures:
GRANT EXECUTE TO [Domain\user]

Replace [Domain\user] with the Windows account being used for the Log API

  • IMLog* (can be multiple )
    • db_datareader
    • db_datawriter
    • db_ddladmin

Note: db_ddladmin is required in order for the service account to have proper rights to read statistics. Without this permission performance may be degraded, especially true for remote servers (linked servers). Read more here. Contact our support if you have any questions about this.

NOTE: Review system parameters ImLogServiceUsers and ImLogAccessRoles

What Firewall settings are required for the Log API

The Log API requires both inbound and outbound ports to be opened. Since Nodinite is highly configurable, the actual ports in use may differ from what's being exampled here.

The Log API requires both inbound and outbound ports to be open. Depending on your environment different ports may be used. On a high level the following services must be allowed:

  1. REST - Inbound communication typically HTTP and HTTPS
  2. WCF - Inbound communication, ports used depends on your WCF bindings
  3. Configuration Database - ports used to communicate with SQL Server

1. TCP Ports for REST

  • 80 - HTTP
  • 443 - HTTPS
  • 1-65535 - It all depends on what port you have assigned using 'Edit Bindings' for the Web Site hosting the Log API
    • If your going to host Nodinite on non default ports, Please contact our support for guidance at support@nodinite.com
graph LR subgraph Integration Platform roLogSink[fal:fa-bolt Integration Flow Application] end subgraph Web Server roLogAPI(fal:fa-cloud-download LogAPI) roLogSink -->|80,443| roLogAPI end

2. TCP Ports for WCF

  • 80 - HTTP
  • 443 - HTTPS
  • ? Depending on WCFBinding, additional ports may be required
  • 1-65535 - It all depends on what port you have assigned using 'Edit Bindings' for the Web Site hosting the Log API
    • If your going to host Nodinite on non default ports, Please contact our support for guidance at support@nodinite.com
graph LR subgraph Integration Platform roLogSink[fal:fa-bolt Integration Flow Application] end subgraph Web Server roLogAPI(fal:fa-cloud-download LogAPI) roLogSink -->|80,443| roLogAPI end

3. TCP Ports between Log API and SQL Server

For performance reasons the Log API accesses the databases directly using the Windows Service Account configured.
You must ensure that TCP ports used are allowed by your firewalls, depending on location of the SQL database the actual ports used may differ. The following Windows Services are involved:

  • RPC Ports, kerberos 88 TCP
  • SQL Server ports, usually 1433, depends on your actual configuration
  • DTC - Facilitates transactional support
  • DNS - Windows needs to know where your servers are (can of course also be solved using hosts)
    • 53 both TCP/UDP
graph LR subgraph Web Server roLogAPI(fal:fa-cloud-download LogAPI) end subgraph SQL Server roSQL1(fal:fa-database Configuration Database) --- roSQL2(fal:fa-database Active Log Database) roLogAPI -->| SQL, DTC, DNS, RPC |roSQL1 end

Frequently asked questions

Common problems and FAQ for the Log API can be found in the troubleshooting page.

Can I secure the Log API?

Yes, the Log API supports the usage of SSL Certificates. Simply add your certificate to IIS and configure the Log API to only allow https


Next Step

Install Nodinite
Log using WCF
Log using REST