The sources or rather data sources are lodged as text in the format CSV, JSON or XML and can be worked up through the FORMCYCLE Designer/the form. To have an access to data sources in the script area via javascript too, all data sources are converted into a JSON structure and customized in the object XFC_METADATA.urls.datasource_[csv|json|xml]. The structure of this JSON structure for the different data sources is expounded in the respective section.

CONTENTS

• Creating a data source
  • Import of data sources from files
• CSV
  • Editing CSV tables
  • Header of CSV data sources
  • Servlet parameters
  • Application example
  • Exeption selection element
• XML
  • Example for an XML data source
  • Servlet parameter
• JSON
  • Example for a JSON data source
  • Servlet-Parameter

Servlet URL
The servlet URL of a data source will be displayed on the configuration screen (see point 4 in figure) and is provided in the JS object XFC_METADATA.urls.datasource_[csv|json|xml].

Creating a data source

Open the module "Data > Sources" and click the button "New"   in the header of the list (see point 1 in figure). After that you will be prompted to either create an empty data source or import one from a file. Three types of data sources can be created: XML, CSV und JSON.

Every data source needs:

• a unique name (in the settings panel: see point 3 in figure)
• the actual data in the editing area (see point 2 in figure)

Import of data sources from files

The following Data types can be used to import data sources:

• XML: .xml
• CSV: .csv, .xls, .xlsx (Excel)
• JSON: .json

CSV data sources

CSV data sources can be imported from different file types:

• .csv
  Opens up a dialog for configuring the import:
  • Delimiter: Determines which symbol is used in the file for separating data fields/ colunms (typically: comma).
  • Text qualifier: Determines the text qualifier. This symbol is used to support special characters inside data fields (e.g. comma in numbers with decimal places).
  • Start at line: Determines where to start importing the data source from.
  • Ignore empty lines: When activated ignores empty lines during import.

• .xls, .xlsx
  Opens up a dialog for configuring the import:
  • Sheets to import: Determines which worksheets/tables should be imported from the file.

Drag&Drop

Data sources can be imported by Drag&Drop as well. If a file is being dropped over the list (green area) than a new data source of the corresponding type will be created (for Excel files: one data source per worksheet will be created). If a file is being dropped over an existing data source than it will be updated. Changes will only take effect after the "Save"   button is clicked.

CSV

CSV data sources can be viewed in a source code view or in a table view. The view can be switched by clicking the appropriate button  /  beneath the editing area.

Source code view of a CSV data source: (CSV file format)

Table view of a CSV data source:

Editing CSV tables

There is a row of buttons beneath the editing area for editing the CSV data table:

•   Insert: Inserts new rows or columns relative to the selected cell.
•   Remove: Removes the selected row(s) or column(s) or empties the selected cell.
•   Import: Opens up the dialog for importing CSV data sources.
•   Source code view: Switches to source code view.

Header of CSV data sources

There is an additional option for CSV data sources in the data source settings. The option First row is header determines how the values of the data sources are being accessed via its servlet (XFC_METADATA.urls.datasource_csv):

• Activated:
  The cells of the first row will be used as keys for accessing the values of the respective columns (see example).
• Deactivated:
  The keys for accessing the values of individual data fields/ rows are enumerated, starting with 0. These keys have the following form: colX where X stands for the column index.

CSV data sources can be accessed in the FORMCYCLE Designer via its servlet: XFC_METADATA.urls.datasource_csv.

Servlet parameters

Servlet-URL
http(s)://<server>/formcycle/datenquellecsv?mandantName=&name=

Always use the global variables object XFC_METADATA when accessing data sources from the FORMCYCLE Designer, see also global designer variables. The servlet URK can be accessed as follows: XFC_METADATA.urls.datasource_csv.

The following parameters are possible:

Application example

A CSV data source with the option activated: First row is header. It has the following content:

title,firstName,lastName,zip,city
Herr,Max,Mustermann,1000,Musterhausen
Frau,Monika,Mustermann,2000,Musterdorf
Frau, Luise,Musterfrau,3000,Musterstadt

In the FORMCYCLE Designer the following script is used in the script area for pre-filling form fields:

$.getJSON( XFC_METADATA.urls.datasource_csv + "?name=Demo&mandantName=xima.de", function(json) {
    var obj = json.returnValue[0];

    $('[name=tfTitle]').val(obj.title);
    $('[name=tfFirstName]').val(obj.firstName);
    $('[name=tfLastName]').val(obj.lastName);
    $('[name=tfZIP]').val(obj.zip);
    $('[name=tfCity]').val(obj.city);
 });

This form example is provided as a download.

Exeption selection element

If the CSV data source has to be loaded directly in a selection element, this happens via through the properties of the selection element in the FORMCYCLE Designer.

The content of the CSV data source is processed in a selection element.

visible value, assigned value, optional value, optional value, ...

Columns of the data source are use as follows for selection elements:
col + column index.

If a data source has more than two columns than it contains optional values. These optional values can be accessed with JavaScript via the following jQuery selector:

$('[name=sel2]').find('option:selected').attr('col2');

Optinal values start at column index 2.
If the first row is marked as a header than it will be ignored for selection elements.

XML

The XML data source acts analogously to the CSV data source, but cannot be bound to a selection element.

Example for an XML data source

<root>
  <person>
    <anrede>
      Herr
    </anrede>
    <vorname>
      Max
    </vorname>
    <nachname>
      Mustermann
    </nachname>
  </person>
   <person>
    <anrede>
      Frau
    </anrede>
    <vorname>
      Monika
    </vorname>
    <nachname>
      Musterfrau
    </nachname>
  </person> 
</root>

Servlet parameter

Servlet-URL
http(s)://<server>/formcycle/datenquellexml?mandantName=&name=

If you access from the FORMCYCLE Designer, always use the global variable object XFC_METADATA, see also global designer variables. For example it can be accessed as follows: XFC_METADATA.urls.datasource_xml.

The following parameter are possible:

JSON

The JSON data source acts analogously to the CSV data source, but cannot be bound to a selection element directly.

Example for a JSON data source

{"person":[
  {
      "anrede":"Herr",
      "vorname":"Max",
      "nachname":"Mustermann"
  },
  {
      "anrede":"Frau",
      "vorname":"Monika",
      "nachname":"Musterfrau"
  }
]}

Servlet-Parameter

Servlet-URL
http(s)://<server>/formcycle/datenquellejson?mandantName=&name=

At an access from the FORMCYCLE Designer always use the global variable object XFC_METADATA, see also global designer variables. For example you can access as follows: XFC_METADATA.urls.datasource_json.

The following parameter are possible: