Search

 

Version: 4.3.0 +

Applicable to: Futurama Website/Futurama Webservice/Futurama Export

 

Description

In case Futurama is running in Server/Batch mode (for Futurama Export). in Website mode or in Webservice mode it is possible to give some default locations in the configuration file. These settings are set in the mapping-section of the configuration file.

Configuration

Settings

Within the element the next code has to be included:


  
    

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


  

Explanation

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

document

Indicates which Futurama document will be loaded. Notes:

  • this attribute is optional. If this attribute is not included the default value is used
  • the default value is 'website.xml'
  • this attribute is only used in Website mode
  • it must refer to a valid Futurama xml-file
  • the value of this attribute can be overruled in the URL of a browser by with the parameter: '?Document={Document}'. For example http://servername/futurama/?Document=site.xml will load the Futurama document site.xml instead of the document that is defined in the configuration file 
folder

Indicates in which folder will be searched for the Futurama document, mentioned above. Notes:

  • this attribute is optional. If this attribute is not included the default value is used
  • the default value is 'default'
  • this attribute is only used in Website mode
  • the location of the folder is relative to the root of the web-application (the location of the default.aspx)
  • the value of this attribute can be overruled in the URL of a browser by with the parameter: '?Folder={Folder}'. For example http://servername/futurama/?Folder=application will load the configured default Futurama document within the folder 'application' instead of the folder that is defined in the configuration file
parentFolder

Indicates in which parentfolder the folder is. Notes:

  • this attribute is optional. If this attribute is not included the default value is used
  • the default value is empty (parentFolder="");
  • this attribute is only used in Website mode
  • the location of the folder is relative to the root of the web-application (the location of the default.aspx)
rootPath

Indicates within which path will be searched for the folder/document that is used in a webservice call of Futurama. Notes:

  • this attribute is optional. If the attribute is not included, the rootpath equals the location of the application (that is, the location of service.svc)
  • this attribute is only used in Webservice mode and Server/Batch mode (for Futurama Export)

Starting from Futurama 6, this property is also supported in Futurama Web. To be able to use a rootPath you have to make sure that all web requests, also for static files such as images, documents, javascript are managed by Futurama, instead of by IIS. You can do this by adding code like this to the web.config:


    
      
      
      
      
      
      
      
      
    
  

If a handler already exists, for example for Telerik, you need to merge these. In your situation you might need extra handlers if you use other files in your Futurama website.

allowedDocuments (from Futurama 16.11)

This field contains a comma separated list that allows filtering of the Futurama documents that are allowed to load.

  • This attribute is optional. If a value is absent, then the filtering mechanism is disabled, and all documents are allowed to be specified. Individual values must be separated by using the ',' or ';' character, and are case-insensitive.
allowedFolders (from Futurama 16.11)

This field contains a comma separated list that allows filtering of the Futurama folders that are allowed to load. Individual values must be separated by using the ',' or ';' character, and are case-insensitive.

  • This attribute is optional. If a value is absent, then the filtering mechanism is disabled, and any folder value is allowed to be specified.

Compatibility

These configuration settings are available from Futurama version 4.3.0. In previous versions you can find the mapping settings in the generic appSettings section of the configuration file. If the new mapping section is not included in the configuration file of Futurama version 4.3.0 or higher, Futurama will switch to its compatibility mode. This means that the 'old' appSettings will be loaded. It is recommended to convert these old settings to the new configuration. Below the mapping between the old and the new configuration.

Futurama Website

New configuration:

Where:

{Document} is the value of:

{Folder} is the value of:

{Parentfolder} is the value of:

Futurama Webservice

New configuration:

,

where:

{Rootpath} is value of

Futurama Export (running in Batch-mode)

New configuration:

,

where:

{Rootpath} is value of

Related Topics

- Cache: Settings regarding the caching of Futurama documents

- Debug: Settings to debug while developing with Futurama

- Format: Format settings of Futurama

- Identity provider: Settings how to use an external identity provider for determining the access to a website

- Log: Settings for displaying errors, warnings, information messages and developers messages

- Mail: Definition of the mailserver that is used to send e-mails with Futurama Vision

- Monitor: Settings for getting session information

- Rendering: Settings to allow Futurama to generate customized HTML

- Security: Additional possible security settings when using Futurama Website

- Server: Settings when using Futurama Export either in server or in batch mode

- Vision: Configuration of the connection between Futurama and Futurama Vision

Feedback

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

Updated: 2013-05-24