How to enable Maid ID acquisition in Maid Service IVR

Applies to:

Imagicle Hotel Pack for Cisco UC, Summer 2018 release and above.

Description:

This procedure allows to enable DTMF acquisition of Maid ID, while calling Maid service IVR number. Maid ID is acquired right before entering room status code. This procedure applies for FIAS and MITEL-based PMS.

How-to:

1. Start RDP session to Imagicle Application Suite's IP address and logon as Administrator.
2. Edit this file:
   <install_dir>\Apps\HotelLink\Vxml\MaidService\Built-In\MaidStatusMenu.vxml
3. Add or uncomment the lines marked below in Blue:

<!-- Existing lines -->

<form id="Welcome">
    <prompt>
         <audio expr="session.AudioPrefix + 'MaidWelcome.wav'" />
    </prompt>
    <var name="dialog.InputAttempt" expr="''" />
</form>​

<!-- End existing lines -->
<!-- 
If the PMS configured for a property supports "Maid ID" functionality and you want to use it, please clone this built-in Maid Status IVR into a custom Maid Status IVR for that property
-->
<form id="MaidId">
     <var name="dialog.InputAttempt" expr="InputAttempt + '1'" />
     <property name="timeout" value="10s" />
        
     <field name="maidId">
        <grammar mode="dtmf" type="X-OPAL/digits">minDigits=3;maxDigits=5;terminators=#</grammar>
        <prompt>
             <audio expr="session.AudioPrefix + 'MaidIdPrompt.wav'" />
        </prompt>
     </field>
     <filled>
        <var name="dialog.InputAttempt" expr="''" />
        <goto next="#GoToMenu" />
     </filled>
     <noinput>
         <goto next="#MaidIdError" />
     </noinput>
     <nomatch>
         <goto next="#MaidIdError" />
     </nomatch>
</form>
<form id="MaidIdError">
     <prompt>
         <audio expr="session.AudioPrefix + 'MaidIdInvalid.wav'" />
     </prompt>
     <if cond="InputAttempt=='111'">
         <disconnect />
     </if>
     <goto next="#MaidId" />
</form>

4. Save file with same name, in this folder: 
   <install_dir>\Apps\HotelLink\Vxml\MaidService\Custom\<PropertyName>\MaidStatusMenu.vxml
   Replacing <PropertyName> with the name of the property as per configured reported on :
   <install_dir>\Apps\PMSLink2\Properties\PropertyList.user.ini
5. Reboot the server