XML Queue Manager Installation and Setup Guide

XML Queue Manager
Application and Set Up Guide
Version No: 11.1.0
Prepared by:
Date:
01 AUG 2011
Nikki Bromwich
01 August 2011
Confidential – Internal Travelport Use Only
Page 1
XML Queue Manager
Travelport
Table of Contents
Purpose of the Document .................................................................................................................................... 3
Prerequisite .......................................................................................................................................................... 3
Installation ............................................................................................................................................................ 3
1.1
Setup Preparation Screen .................................................................................................................... 4
1.2
Welcome Dialog Box ............................................................................................................................ 4
1.3
Agent Sign ID User Input...................................................................................................................... 5
1.4
Task Maintenance File Name user input ............................................................................................. 6
1.5
Fail Queue / Queue Category Number ................................................................................................ 7
1.6
Email Alert 1 user input ....................................................................................................................... 8
1.7
Choose Destination Location ............................................................................................................... 9
1.8
Installation Setup Status Screen ........................................................................................................ 10
1.9
Installation Complete Screen ............................................................................................................. 11
Set Up ................................................................................................................................................................ 12
Configuration Settings ....................................................................................................................................... 13
1.10
Settings.ini File ................................................................................................................................... 13
1.11
Task Maintenance File ....................................................................................................................... 15
1.12
Agent Mapping File ........................................................................................................................... 16
Flight Centre Only Functionality ........................................................................................................................ 17
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 2
XML Queue Manager
Travelport
Introduction
The XML Queue Manager program runs on Galileo® XML API Desktop technology; which allows continuous
queue distribution over a Galileo Desktop terminal.
Purpose of the Document
This document is the installation and Set Up Guide for XML Queue Manager V11.1.0. It describes in detail the
steps involved to Install and set up the application.
Prerequisite

Galileo Desktop must be installed on the system to run this installation successfully.

SMTP Server settings and appropriate emails need to be updated into settings.ini file before
running the application.
Installation
The executable file is located on the Asia or Pacific Software Libraries.
Pacific Software Library – Access – XML Queue Manager
Asia Software Library – Access Products – XML Queue Manager
Please click on the “Download Now” option next to the installation file.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 3
XML Queue Manager
1.1
Travelport
Setup Preparation Screen
This shows the setup wizard preparation screen to prepare the XML Queue Manager setup.
1.2
Welcome Dialog Box
Is the setup welcome screen.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 4
XML Queue Manager
1.3
Travelport
Agent Sign ID User Input
The user can provide the Sign On ID that will be updated into the settings.ini file under the section
[Agent].
Note: If Galileo Desktop is not signed in when Queue manager is launched on the user system, then
the above entered sign on will be used to automatically sign onto the Galileo Desktop.
This field can be left blank and can be updated directly in the settings.ini file.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 5
XML Queue Manager
1.4
Travelport
Task Maintenance File Name user input
The user can provide the task maintenance file name that will be updated into the settings.ini file under
the section [FILE]. This is the original file name which the application will use to distribute the PNRs.
This field can be left blank and can be updated directly in the settings.ini file.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 6
XML Queue Manager
1.5
Travelport
Fail Queue / Queue Category Number
The user can input the Fail Queue number and the Fail Queue Category that will be updated into the
settings.ini file under the section [FailQueue].
This field can be left blank and can be updated directly in the settings.ini file.
Note: This functionality is not mandatory and is controlled in the settings.ini file under the section
[FailQueue].
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 7
XML Queue Manager
1.6
Travelport
Email Alert 1 user input
The user can provide the Email ID to send the Fail Queue PNR email alerts to, which will be updated
into the settings.ini file under the section [FailQueue].
Only the first email is updated from the installation file, the other 2 email addresses can be updated
directly in the settings.ini file if required.
This field can be left blank and can be updated directly in the settings.ini file.
Note: The email will only be sent if the Fail Queue functionality is “Activated”.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 8
XML Queue Manager
1.7
Travelport
Choose Destination Location
The user can choose the location where the Queue Manager Application will be installed. The “Browse”
option allows the use to choose an alternative location for the file.
By default application will installed at “C:\Program Files\Queue Manager”
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 9
XML Queue Manager
1.8
Travelport
Installation Setup Status Screen
This screen shows the current installation status of the application.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 10
XML Queue Manager
1.9
Travelport
Installation Complete Screen
This screen confirms that the setup has finished successfully.
The user will need to click “Finish” to exit the install wizard.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 11
XML Queue Manager
Travelport
Set Up
When Queue Manager is installed the following files are created by default:







Mapping123.csv
Settings.ini
Taskmain.csv
Queue Manager Exe file
Folder for Log Files
o Action Log – Summary of how Queue Manager Works
o Debug Log – Details of all host entries Queue Manager does
o Fail Queue Log – CSV file showing all PNR’s which are moved to the Fail Queue
o Fail Queue Log Archive – Maintains an archive of the Fail Queue log
o Failed PNR – Shows all PNR’s that failed
o PNR Queue List – Displays a list of all the PNRs present in a Queue
o Queue Manager LOG – 3rd level Support Log (Not-readable by End User)
o Success PNR – Shows all PNR’s moved by Queue Manager
DLL Folder – houses various DLL files
Help Folder for SMTP troubleshooting
o Email-Settings.ini – separate ini file for SMTP settings only (only required for troubleshooting)
o SendEmail.exe – an exe file to send a test email to ensure the SMTP settings are correct
Please note: These files must be in the above folders in order for Queue Manager to work, therefore please
do not move these. Additional Mapping123.csv files can be added if required.
For details on the log files please refer to the support guide.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 12
XML Queue Manager
Travelport
Configuration Settings
1.10 Settings.ini File
These are the fields found in the settings.ini file:
[AGENT] - sign-on ID of the XML queue manager.
The application will make an attempt to sign-on to
the Galileo Desktop using this ID in the case the
terminal is not signed on.
ID=ZIG
[USER] – this value is used in the received from
field when queue manager distributes a PNR.
NAME = QUEUE.MANAGER
[TIMER] – the countdown interval (in unit of
second) before a loop of task is started
COUNTER = 8
[DebugMode] – Flight Centre only functionality do
not update. For full details refer to the last page of
this guide.
[FILE] – the name of the task maintenance file.
TASKMAINTAIN=Taskmain.csv. This is the name
of the task maintenance file.
[LOG] – specifies the file size of the logging file in
the unit of bytes.
LOGFILESIZE = 5000000. The size 5000000 =
5MB. Do not change this size.
[TAU] – controls whether XML queue manager
changes the TAU date. This is dependent on
whether the application determines the TAU date is
a past date or not.
TAUCHECK = Y – the application will check the
TAU date and will compare it with the current date.
TAUCHECK = N – the application will not check
the PNR TAU date.
DATE = 26 – Specifies the number of days the
application uses to determine if the TAU is past
dated or not. The application compares the current
date to the date found in the TAU field of the PNR.
If it is less than or equal to 26 days behind the
current day, the program will change the TAU date
of the PNR to the current date before it makes an
attempt to distribute it. Do not change the number
in this field as 26 matches with the Galileo host
interval.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 13
XML Queue Manager
Configurations continued…
Travelport
[MOVE] – used to force the PNR to move to the
destination queue.
MUSTMOVE = N – Tries 3 times to move the PNR
MUSTMOVE = Y – Tries to move the PNR an
additional 3 times.
If the application has added or changed the NP
and/or TAU fields it will ignore and retrieve the PNR
first before trying to move it the additional 3 times.
[MOVEMODE] – Flight Centre only functionality do
not update. For full details refer to the last page of
this guide.
[EMails] – Determines the email addresses the
status email is sent to. The status email alert is sent
if any HOST error occurs during the running of the
application.
EmailInternal = customers email address
EmailGalileoHelpDesk = helpdesks email address
[MailSetting] – configures the SMTP address for
sending the status email.
SMTPServerString = customers SMTP Address or
IP Address used to send the email
FromString = customers From email address
SubjectString = This is free flow format used in
case of HOST issues
SMTPNeedLoginString = FALSE - not required
SMTPNeedLoginString = TRUE - authentication is
required to send the email, therefore the username
and password fields must be completed
SMTPUserNameString = customers user name
SMTPPasswordString = customers password
[ToQueue] – Flight Centre only functionality do not
update. For full details refer to the last page of this
guide.
[FailQueue] – allows failed PNRs to be moved to a
central queue / queue category for follow up action.
FailQueueNo=99 – The queue number the Failed
PNRs will be moved to
FailQueueCategoryNo=C02 – The queue category
number the Failed PNRs will be moved to
FailQueueActivated=Y – activate this functionality
FailQueueActivated=N – functionality not used
EmailAlert1= customers email address
EmailAlert2= customers email address
EmailAlert3= customers email address
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 14
XML Queue Manager
Travelport
Configurations continued…
[Others] – Additional checks
PCCCheck = Y – checks if PCC(s) entered within
each Task Maintenance / Mapping file(s) are different.
PCCCheck = N – Do not check the PCC(s)
SendEmailAfterEveryIteration = N – send the fail
queue email only if PNRs have been moved to fail
queue/category.
SendEmailAfterEveryIteration = Y – send the fail
queue email after every iteration regardless if PNRs
are moved to fail queue/category or not.
1.11 Task Maintenance File
The “Taskmain File” tells queue manager what queue’s to distribute and what mapping file to use when
distributing the PNR’s. It contains the data of the source PCC, the source queue number, the name and
location of the agent mapping file, add notepad indicator and the notepad details.
XML queue manager recognises the name of the header instead of the column alpha; hence, the header
names must be exact, as shown in the following table and in the same order or XML queue manager will not
be able to read them and prompt an error message.
Header
*From PCC
From Queue No
Function
This field indicates the source PCC on a single task.
This field indicates the source queue number, in the source PCC,
on a single task.
Example
XD8
10
*Mapping File
This field indicates the name and location of the agent mapping
file which contains the destination and agent details. While the
agent mapping file is stored in the same folder as the XML queue
manager program, only the file name is required and the complete
file path is not necessary. (Multiple mapping files accepted.)
The Y indicates adding a NP. Is required for the task and N
indicates no NP. Is required during the distribution.
This field contains the content of the notepad adding to the PNR
while distributing the queue.
By using the given template, the Notepad automatically appears
by copying the noted cell.
Mapping123.csv
Add Note
Notepad
Y
Testing Q10
* mandatory fields to run the application




Distribute Queue 10 using mapping123 Q10.csv, adding the notepad “Moved from Q10” into the PNR
Distribute Queue 11 using mapping123 Q11.csv, adding the notepad “Moved from Q11” into the PNR
Distribute Queues 13 and 15 using mapping123.csv, don’t add a notepad
Distribute Queue 17 using mapping123 Q17.csv, don’t add a notepad
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 15
XML Queue Manager
Travelport
1.12 Agent Mapping File
The “Mapping Files” tells queue manager where to place the PNR’s. It defines the Destination PCC and
Destination Queue No. The header names must be exact, as shown in the following table and in the same
order or otherwise XML queue manager will not be able to read them and prompt an error message.
All fields used within the file are explained below:
Header
Agent Name
Agent Sine
*Destination PCC
*Queue No
Category
Distributed By
Function
This field contains the agent name; while the distribution is by
name, the application compare the data in this field with the data
in the first phone field on a PNR to determine what to do on the
distribution task.
This field contains the RSPR TEAM CODE (not the Agent Sine
as the field name suggests); the application compares the data
in this field with the upper left hand corner code in the PNR to
determine what to do on the distribution task.
This field indicates which PCC the application should distribute
for a specified agent.
This field indicates what queue number, in the destination PCC,
that the application should distribute for a specified agent.
This field indicates (where if applicable), what is the queue
category that the application should distribute, under the
destination PCC and queue number, for a specified agent.
This filed advises the application whether the distribution should
be based on the agent name or agent sine data. SINE = by
agent sine, NAME = by agent name.
Example
John Smith
51
XD8
70
C02
SINE
The above mapping file tells XML Queue Manager to move the following PNR to Q93 in PCC XD8.
01 AUG 2011
Confidential – Internal Travelport Use Only
Page 16
XML Queue Manager
Travelport
Flight Centre Only Functionality
Allows the application to identify and move un-ticketed PNR’s that are due to depart within the defined search
criteria to a designated queue.
[DebugMode] – Used in conjunction with MOVEMODE to distribute un-ticketed PNR’s to the designated
queue.
debugString = “FALSE’ It is the default settings, no GUI will be display and used to run the application in
background.
debugString = “TRUE”, If we set the value TRUE then user screen would be displayed with progress window.
[MOVEMODE] – This field controls if the move un-ticketed PNRs functionality is activated or not. If activated,
the application will copy the un-ticketed PNRs and place these on a new queue which is designated in the
[ToQueue] field.
PNRMODE = "DEFAULT" – do not use the move un-ticketed PNRs functionality
PNRMODE = UTK – move un-ticketed PNRs to the designated queue
[ToQueue] – This is the destination queue number which the un-ticketed PNRs will be moved to.
DestQueue = 93 – this is the default for this field. After this change all un-ticketed PNRs will be copied to
queue 93 within each PCC.
Note: A second “Task Maintenance” file is used and this must be updated along with the PNRMODE field in
the settings.ini file each time the application is being used to check the un-ticketed PNR’s. Once the unticketed process is complete an email is sent to the agent to advise this functionality is finished. The agent
must then change the setting.ini file back in order for XML Queue Manager to run in the default manner.
Header
*From PCC
From Queue No
*Mapping File
Add Note
Notepad
*Airline
*Days
01 AUG 2011
Function
This field indicates the source PCC on a single
task.
This field indicates the source queue number, in
the source PCC, on a single task.
Example
XD8
This field indicates the name and location of the
agent mapping file which contains the destination
and agent details. While the agent mapping file is
stored in the same folder as the XML queue
manager program, only the file name is required
and the complete file path is not necessary.
(Multiple mapping files accepted.)
The Y indicates adding a NP. Is required for the
task and N indicates no NP. is required during the
distribution.
This field contains the content of the notepad
adding to the PNR while distributing the queue.
By using the given template, the Notepad
automatically appears by copying the noted cell.
Mapping123.csv
Airline is configurable setting to specify
Airline. ‘Airline = All’ will fetch data from all
airlines.
Days is configurable date range setting which
would help user to set number of days starting
from run date. Default is set to 15 days.
QF
Confidential – Internal Travelport Use Only
This field should be left blank
for this requirement.
Y
Testing Q10
NumofDays = 3
Page 17