Howto13r1:Running XML files
This information applies to
v13r1 SR4 and up
Please note that this description and the pictures are taken with Version 13r1 SR4, newer versions could make this description obsolete or with other layout.
If you want write or run an existing VM Script, for example one of the example in the “various tools, scripts and examples” section of the innovaphone download site, you have to observe some issues described in the following step by step instruction guide.
We will use as an example in this article the universal track recording tool (trackrecord).
To install an XML you must have full access to the app “devices” and “files”.
XMLs works correct only from V13r1 SR4 on, if your V13 installation is older you have to update at least the app “files” and the webdav server. Updating just those two apps can be done using the app “apps”, clicking on the “App Store” button on the top and select the relative update button.
Copy the solution on your PC. Please note that the source files (the XML itself and all the other files, typically text and Audio files) must be first unzipped locally on you PC. So you need uncompressed files.
Please observe and read first the "Known Problems" chapter in this article.
Now open the app “files” and create a new folder using the “+” symbol on the right upper corner and name it. Using drag and drop copy all the files of the solution in the folder, here the result using our example:
Now you must convert this directory in a shared directory because only in this way the PBX can access the script and files in there. Switch back on level in the directory clicking on the arrow on the left upper corner:
Click on on the right directory name and hold the left mouse button down for some seconds. The result will be a checkmark on the directory and on the right side of the window a small menu appears:
To become a shared directory click on the right arrow and the share menu appears:
Put in a user and a password, these credentials will be used later on by the PBX to access, so don’t forget them. You can use also already used credentials in your setup, for example your admin credentials.
Confirming “Share” you will now note that the directory symbol has an arrow in to display that this is a shared folder.
Now click again in the left directory icon, on the right upper corner now a “I” symbol is shown:
Click on it and the path is shown. Copy this path because we will it need after.
We suggest to copy the path in an editor, because you must modify it in an HTTPS path.
Open devices and create a new Voicemail Object as usual, open the Voicemail Tab and enter the modified link extended by the name of the XML application (not shown in the following picture but the link ends with
Please note the “s” added in the path.
Last task is to give the PBX the right to access to the shared directory. This is done in the Menu “Services/Client” of the PBX:
The credentials are the one indicated before in sharing the directory.
Now your XML should work as in the previous PBX versions.
- In V13 files are stored in a database and can therefore not have the dimension zero (0 byte). Especially empty text files can have this dimension. While in writing all XML samples write always at least a space or a dot in avoiding the zero byte file, some setup files in the solution could be empty. In this case the XML will not work at all when in execution this file should be read out or checked. Our recommendation therefor is to check before copy the files in the directory of myApps if there is some empty file and if open it with an editor and put a space in.
- The app platform webserver interprets URLs case-sensitive. In other words, http://<addr>/file.xml is not the same as http://<addr>/FILE.XML
- The files folder has to be shared by uid/pwd. Sharing by fileskey does not work as the voicemail interpreter tries to interpret the fileskey as script-argument which then prevents access to the shared data.