XML File Integration

1.1 Introduction

This interface allows sending requests to LinQ2 through xml file saved in UTF 8 format. Linq2 application will read this file from already defined source directory. In case of successful processing this file will be move to destination directory. Otherwise, it will move into error directory. User can find out error and description from log monitoring section.

1.2 Configuration 

Authorized user can configure XML File request parameter setting from configuration >LinQ2 resources > File - Show List > LinQ2 page. Form this page authorized user can define source, destination, and error folder path.  

Ref: - Screen 1 – LinQ2 File backend management_1.

Ref: - Screen 2 – LinQ2 File backend management_2.

Ref: - Screen 3 – LinQ2 Define files backend parameters

 Screen 1 – LinQ2 File backend management_1

 Screen 2 – LinQ2 File backend management_2

 Screen 3 – LinQ2 Define file backend parameters.

1.3 Monitoring and Control

XML File handler service is available in services list. Authorized user can login in to LinQ2 system and can monitor the status of XML File handler service and recent errors and warning from status monitor section. User can also start and stop the Xml file handler service from this section.

Ref: - Screen 4 – LinQ2 XML File handler Service Status Monitoring and Control

Ref: - Screen 5 – LinQ2 XML File handler Error Monitoring

Ref: - Screen 4 – LinQ2 XML File handler Service Status Monitoring and Control

 Screen 5 – LinQ2 XML File handler Service Error Monitoring

1.3.1 Constraints

1. SMS template should be defined in both languages English and Arabic.
2. Email template should be defined in both languages English and Arabic. If email option is also selected.
3. Event id should be unique.
4. Xml format should be correct as mentioned structure.
5. XML File should be saved in UTF8 format.
6. File integration can't send SMS to groups created by other than administrator.

 1.3.2 Before You Apply Test

1. For samples and full structure details of LinQ2 XML format please take a look at “LINQ2 XML STRUCTURE” document. 

LinQ2 XML Structure

1.3.3 Supported File Formats: 

XML file can have one of the three encoding formats Utf8, Unicode or Unicode Little. The currently enabled encoding is determined by the property “linq2.config.xmlfile.unicoded” defined inside the “system.config” file, e.g. the following setting enables UTF-8 encoding for importing XML files.

linq2.config.xmlfile.unicode=utf8

If you are saving your XML using the Windows Notepad then be careful as the file format is UTF-8-BOM. In that case you must change the encoding using some other text editors and must save the file as UTF-8 before importing it to the LinQ2.