Configuration

Installation > Configuration > Recording

Version: 5.3.0 +

Applicable to: Futurama Website

Prerequisites

- Futurama-HTML/Web

Introduction

Explains the usage of the ScenarioRecorder

Description

Scenariorecording allows the recording of a scenario file, which can be used by the Futurama development team to reproduce various situations. The recorded scenario will consist of a .scenario file in a proprietary XML format, that contains a sequential collection of Step-elements, that are made up out of Request and Response pairs. These steps will show what actions have been executed by the systems user, and the resulting WebPage/WebPanel contents that Futurama has generated in response. This contents is formatted in so-called FICO XML-code, which can be transformed into (X)HTML code by applying an XSL file.

Settings

Within the configuration element the next code has to be included

<configSections>
	<sectionGroup name="futuramaSettings">
		<section name="recording" type="ActuIT.Futurama.Config.RecordingSection, ActuIT.Futurama.Engine, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"/>
	</sectionGroup>
</configSections>

Next to this code, also within the configuration element the next code has to be included:

<futuramaSettings>
	<recording includeHtmlOutput="{true/false}" savepath="{path to scenario files}" enabled="{true/false}"/>
</futuramaSettings>

The futuramaSettings element is the general part for more configuration settings. Within this element the recording element is set.

Explanation

Within the recording element some attributes can be set. Below are the possible values of these attributes.

enabled

Set whether the scenario recording system is enabled. Notes:

default value is 'false'
this attribute is required whenever the recording element is included within the configuration file.

savePath

If the recording system is to be used, then this field must be filled with a location where the webserver is allowed to create files. For instance, a directory could be made on the systems C-drive called “C:\scenarios”, then this path should be entered as the ‘savePath’ value.

includeHtmlOutput

Set whether the HTML output should be included in the recorded response. Notes:

default value is 'false'
this attribute is optional. If this attribute is not included the default value is used

Recording

From the moment this feature has been enabled within the configuration file, a scenario file will be generated for every session that users will initiate. So when a user logs in, a file will be created with the following filename: "C:\temp\scenarios\{foldername}-{sessionid}.scenario".

Scenario file format

If a scenariofile is opened, the following structure will be found:

<!--?xml version="1.0" encoding="utf-8"?-->
<scenario xmlns="http://www.ActuIT.nl/Futurama/TestScenario/2014/10/" daterecorded="13-8-2015 14:54:22" rootpath="C:\inetpub\wwwroot\CurrentFuturama">
  <step>
    <name>step 1</name>
    <request>...</request>
    <response>...</response>
  </step>  
  <step>
    <name>step 2</name>
    <request>...</request>
    <response>...</response>
  </step>
  ...
</scenario>

The scenario will record the location of the webapplication, the recording date, and a list of steps.

The list of steps will contain a name, a request and a response, which are WebAPI requests and responses, which is a system used within the replaying functionality.

Usage in combination with Futurama Web API

The scenario recorder makes it possible to study the inner workings of Futurama Web, to recreate the same behaviour using Futurama WebAPI and a customized front-end application.

For instance, when Futurama Web is used to show a webpage, the Scenario Recorder can be used to view the data that is used to create the webpage. One of these variables is the “reqStateid” variable, which indicates the sequence of events, and this same variable can be used to perform the “Back-navigation” action of a webbrowser.

Another use is the recording how complex controls like websliders, radiobuttons or dateboxes can be used or manipulated. By creating a small testing Futurama Web Application, containing a WebPage, and a single control, you can examine interactions with the running Futurama Application.

The best way to examine these variables is by creating a simple sample application, and keeping an eye on the scenario file while performing steps, and comparing the Request and Response objects to view the changes in State.

Feedback

If you have any questions about this subject or if you want to provide us feedback please send us an e-mail.

Updated: 2018-04-17