Example: New Horizons

In the remaining sections of this Getting Started chapter, you will be guided to build a Frank configuration yourself. Your configuration will serve an imaginary firm New Horizons. New Horizons allows travelers to book travels online, which constitute visits to hotels, apartments, campings or any other place where travelers can sleep. New Horizons makes traveling easier, because the traveler with a complex travel does not have to negotiate with the individual hosts. New Horizons takes the responsibility of paying them.

Of course New Horizons has many user stories. In the Getting Started, we focus on a very specific task. A booking accepted by New Horizons, which can constitute multiple visits, should be stored in a relational database for further processing.

To get started, please do the following:

  1. In the franks directory you created in Frank!Runner Installation, add a new project directory Frank2Manual. Within that directory, create configurations/NewHorizons for the configuration you are going to create.

  2. In the NewHorizons directory, open a new file Configuration.xml.

  3. Give that file the following contents:

    <Configuration
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="../FrankConfig.xsd">
    </Configuration>
    

Please take your time to configure your development environment. The GitHub page of the Frank!Runner contains all the information you need. You will use the non-Maven directory structure that is explained there. You can see how to work with FrankConfig.xsd and the code completion and syntax checking that it supports. You can also see how you can easily start the Frank!Runner during development.

  1. To check these steps, please start the Frank!Framework and go to the Adapter Status page. You should see a tab “NewHorizons”.

  2. Check that your directory Frank2Manual/configurations now contains FrankConfig.xsd, the file referenced within Configuration.xml. Placing this file is the job of the Frank!Runner.

  3. The Frank!Runner should also create a .gitignore file that ignores FrankConfig.xsd for checkin. Please check that such a file has been created.

The details of what we want to build are in the next section.