Sources
The sources or rather data sources are lodged as text in the format CSV, JSON or XML and can be worked up through the Xima® 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.
CSV
Here you can insert data sets in the CSV format.
- Choose the option CSV under type.
- Assign an explicit name.
- Insert the data sperated with a comma in the arrey value.
Example for a CSV data source
The readout of the values in the Xima® Formcycle Designer ensues through the servlet with the namen datenquellecsv.
Servlet parameters
At an access of the Xima® Formcycle Designer always use the global variables object XFC_METADATA, see also global designer variables. For example it can be accessed as follows: XFC_METADATA.urls.datasource_csv.
The following parameters are possible:
name of the parameter | description | necessary |
---|---|---|
name | Must match the name of the CSV data source. | Yes |
mandantName | Must match the name of the client under which the data source was created. | Yes, if projektId is not given. |
projektId | Must match the ID of the form. These information can be recalled via XFC_METADATA.currentProject.id. | Yes, if mandantName is not given. |
kopfzeile | Indicates a comma seperated list with column name of the CSV table. If this is not given, the first line of the CSV is used. | No |
spaltenNamen | Indicates a comma seperated list of the column, which columns are redelivered of the servlet with the corresponding value. At this, according to using, the names of the columns of the parameter headline or the name of the first line of the CSV databaseHierbei are expected. | No |
csvTrennzeichen | Indicates the seperator between the single data cells. If this is not set, a comma , is used by default. | No |
csvQuote | The seperator with which the values of the lines are seperated. If this is not set, a inverted comma " is used by default. | No |
Application example
Herr,Max,Mustermann,1000,Musterhausen
Frau,Monika,Mustermann,2000,Musterdorf
Frau, Luise,Musterfrau,3000,Musterstadt
In the Xima® Formcycle Designer the following script is used in the script area.
var obj = json.returnValue[0]
$('[name=tfAnrede]').val(obj.anrede)
$('[name=tfVorname]').val(obj.vorname)
$('[name=tfName]').val(obj.nachname)
$('[name=tfPLZ]').val(obj.plz)
$('[name=tfOrt]').val(obj.ort)
})
This example as a data source for the Xima® Formcycle Designer .
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 Xima® Formcycle Designer.
The content of the CSV data source is processed in a selection element.
If more than the visible and the assigned value are indicated, so optional values, the can be invoked in JavaScript through the following jQuery selector.
Every optional value is stored to the selection element as attribute col + index of the optional value. At e.g. three optional values, there would be col0, col1 and col2.
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
<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
If you access from the Xima® 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:
Parameter name | Description | Neccessary |
---|---|---|
mandantName | Must match the name of the client under which this data source was created. | Yes |
name | Must match the name of the CSV data source. | Yes |
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
{
'anrede':'Herr',
'vorname':'Max',
'nachname':'Mustermann'
},
{
'anrede':'Frau',
'vorname':'Monika',
'nachname':'Musterfrau'
}
]}
Servlet-Parameter
At an access from the Xima® 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:
Parametername | Description | Neccessary |
---|---|---|
mandantName | Must match the name of the client under which this data source was created. | Yes |
name | Must match the name of the CSV data source. | Yes |