IFS Connector User Documentation and Administrative Guide

Back to Configure IFS Connector Back to IFS Connector Home Back to IFS Excalibur/IFS Land Installation & Configuration Back to IFS Enterprise Upstream/IFS AFE Installation & Configuration Back to IFS Enterprise Upstream/IFS ProCount Installation & Configuration Back to IFS Land and IFS iLandMan Installation and Configuration

1 Introduction
2 Assumptions and Constraints
3 Interop Software Modules
- 3.1 Interop Software Modules Setup
- 3.2 Data Mapping
- 3.3 IFS Connector Multi Threaded Setting
4 Service Call Request Timeout

Introduction

IFS Connector allows for interoperability between various IFS applications, including: IFS Merrick ProCount (volume accounting software); IFS BOLO, Excalibur and Enterprise Upstream, Qbyte FM (revenue and financial accounting systems), IFS AFE; IFS Land, iLandMan (land systems) applications. Interoperability means that data can be transferred between supported combinations of these applications such as from IFS Merrick ProCount to Enterprise Upstream and vice versa.

The IFS Connector consists of the following three components: the IFS Connector Client Console Application, the IFS Connector Windows Service, and the IFS Connector Dashboard (website). For information on installation, refer to the IFS Connector Installation Guide.

This user guide contains detailed information about how IFS Connector is configured, deployed, used, and maintained.

Assumptions and Constraints

Certification can be found in the IFS Connector release notes in the P2 Store with the IFS Connector release.

IFS Connector Windows Service can handle multiple instances of IFS ProCount for the same customer, but the customer still has the option to install multiple instances of IFS Connector to handle each IFS ProCount instance separately.
All dates are saved in UTC in the IFS Connector Window Service’s database. The Connector Dashboard will show all the dates depending on the user’s browser time zone.
If IFS Connector Windows Service failed to process a request at any point of execution, it will not try to re-execute the same request unless it gets scheduled again by Windows Task Scheduler.
IFS Connector Windows Service will execute the requests sequentially (one-by-one) as they were queued up in the IFS Connector Message Queue unless the multi threaded setting is turned on.
IFS Connector Windows Service and IFS Connector Console Application use only one pre-configured Message Queue per installed instance.

Interop Software Modules

The software modules required for integration to work are as follows:

1) IFS Connector
2) Accounting System and its Web Services
3) IFS Merrick and its Web Services for Production integration with Accounting
4) IFS AFE and its Web Services for AFE integration with Accounting
5) IFS Land or iLandMan and its Web Services for Land integration with Accounting

Interop Software Modules Setup

Module	Module Description/Setup Requirements	System Requirements

Module	Module Description/Setup Requirements	System Requirements
IFS Connector Client Console Application	A console app that allows the scheduler to send messages to the Connector’s Message Queue.	.NET Framework 4.5 (or Higher) SQL Server 2008 R2 (or Higher) 4 CPU 2.5GHz (or Higher) 16GB RAM 50MB HDD Space
IFS Connector Windows Service	A Windows service that retrieves requests from its Message Queue, executes the command by pulling and pushing data from the source and destination systems via Web Services, based on the request rules. This service notifies other systems of the success or failure of the executed request.	.NET Framework 4.5 (or Higher) SQL Server 2008 R2 (or Higher) 4 CPU 2.5GHz (or Higher) 8GB RAM 50MB HDD Space
IFS Connector Dashboard (Website)	A Web Portal to view the IFS Connector Windows Service, IFS Connector Client Console Application, and system statuses and logs.	.NET Framework 4.5 or higher 4 CPU 2.5GHz or higher 16GB RAM 30MB HDD Space IIS 8.0 or higher
Windows Task Scheduler	Ensure schedules are set up to schedule requests to IFS Connector.	See the Task Scheduler Setup Guide for setting up task schedules manually using the Windows Task Scheduler. Note: A new installation of IFS Connector will automatically setup the Windows Task Schedules if the source and destination systems are indicated during the installation process. See IFS Connector Installation Guide for reference.
IFS Merrick ProCount Web Services	Ensure the ProCount WCF Web Services are set up for each ProCount instance.	Refer to the IFS Merrick Installation Guide for system and setup requirements accessible via P2 Store for the pertinent product release.
Enterprise Upstream Web Services	Ensure Enterprise Upstream REST Web Services are set up.	Refer to the EU Installation Guide for system and setup requirements accessible via P2 Store for the pertinent product release.
Qbyte FM Web Services	Ensure Qbyte FM REST Web Services are set up.	Refer to the Qbyte FM Interoperability Settings for system and setup requirements.
IFS AFE Web Services	Ensure the IFS AFE REST Web Services are set up.	Refer to the IFS AFE Interoperability Settings for system and setup requirements.
BOLO Web Services	Ensure the BOLO REST Web Services are set up.	Refer to the IFS BOLO Web Services Installation Guide for system and setup requirements.
Excalibur Web Services	Ensure the Excalibur REST Web Services are set up.	Refer to the Web Services Installation Guide for IFS BOLO and IFS Excalibur for system and setup requirements.
IFS Land Web Services	Ensure the IFS Land REST Web Services are set up.	Refer to the IFS Land Installation Guide for system and setup requirements accessible via P2 Store for the pertinent product release.
iLandMan Web Services	Ensure the iLandMan REST Web Services are set up.	Refer to the iLandMan user guide accessible through the iLandMan application for iLandMan API setup.

Data Mapping

IFS Connector Multi Threaded Setting

In the P2.Services.Connector.WindowsService folder created by the installer, in the configuration file, the section for appSettings allows you to set the key value for Connector.MaximumThreads. This allows you to configure the number of routes to be processed simultaneously. The default is set to four concurrent routes, but can be changed by the system administrator as needed.

Service Call Request Timeout

The maximum length of time service call requests to the various IFS products can process before IFS Connector times them out is 5 minutes by default. This means that if a service call request takes longer than 5 minutes to process, it will timeout and fail.
The administrator can change the request timeout value for each service call request in the IFS Connector database from the RequestTimeoutInMinutes column in the Request table.

The timeout value can be made shorter or longer as desired. A value of 0 means that the service request will never timeout. Changes to the timeout value are saved automatically (restarting the IFS Connector Windows Service is not required to save the new value).