Important Note

This space contains files and text snippets that are used throughout the Scheer PAS documentation.
This content is not meant to be read independently from the rest of the documentation.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

ChapterNameExcerptUsage
Array Operationsarrays_of_arrays

Arrays of arrays are not supported by the Designer.

  • Array Operations
Array Operationscreating_arrays

You can create arrays using the create statement (see action script example below):

create anArray;
append "Hello World!" to anArray;

Most of the time the xUML Runtime will create the array implicitly on appending the first item. There is one exception to this rule, though: Arrays that contain array elements having a complex type with multiplicity.

Let's assume you have an array of complex type ArrayElement and this complex type has a property subArray with multiplicity 0..*.

  • What you can do, if subArray is NULL:

    set array1[0].subArray = anotherArray;

    The reference subArray is changed to point to anotherArray.

  • What you can't do, if subArray is NULL:

    append "something" to array1[0].subArray;

    In this case (get statement on the right side of a statement), the Runtime will throw a get error for array1[0].subArray.

  • Array Operations
Blob Operationsblob_definition

A blob represents base64-encoded arbitrary binary data.

  • Available Base Types
DateTime Operationscalculate_dates

This is calculated e.g. as follows:

  1. 31.01.2017 + 1 month = 31.02.2017
  2. The resulting date 31.02.2017 is normalized to 03.03.2017.

DateTime Operationstimeticks

Within this context TimeTicks are UNIX timestamps.
Unix time, or POSIX time, is a system for describing points in time: it is the number of seconds elapsed since midnight UTC of January 1, 1970, not counting leap seconds. It is widely used not only on Unix-like operating systems but also in many other computing systems.

Integer Operationsboolean_definition

Boolean values represent binary-valued logic (true, false).

  • Available Base Types
Integer Operationsdatetime_definition

CCYY-MM-DDThh:mm:ss[.sss] [Z|[+|-]hh:mm]

Whereas "Z" stands for the time zone: Coordinated Universal Time (UTC). The W3C value space of DateTime is closely related to the dates and times described in ISO 8601.

  • Available Base Types
Integer Operationsfloat_definition

A float corresponds to the IEEE single-precision 32-bit floating-point type.

Lexical representation: [white spaces] [+|-][nnn][.nnn][e|E[+|-]nnn] (where white spaces are any tab or space character; nnn may be any number of digits)

  • Available Base Types
Integer Operationsinteger_definition

The W3C defines integers as "decimal", which represents arbitrary precision decimal numbers.

  • Available Base Types
  • Integer Operations
Integer Operationsstring_definition

A string is a set of finite-length sequences of a character set (the Bridge uses UTF-8 internally).

  • Available Base Types
JSONwriteTypeDiscriminator

Use writeTypeDiscriminator to suppress the generation of xUML type properties ("e2e:type") to the generated JSON. If this option is true, the Runtime will write the original xUML type to the generated JSON in form of "e2e:type": "<name of the original xUML type>" if the type being serialized does not match the expected metadata.


Typeslist_type_strings

Find below a list of all Base Types of the Designer together with their type string as returned by typeOf() and staticTypeOf().

Bridge Base TypeType String
Anyurn:Base_Types.Any
Arrayurn:Base_Types.Array
Bloburn:Base_Types.Blob
Booleanurn:Base_Types.Boolean
DateTimeurn:Base_Types.DateTime
Floaturn:Base_Types.Float
Integerurn:Base_Types.Integer
Stringurn:Base_Types.String

Other, e.g. model specific, types can be referenced via their path in the service panel, e.g. a class Customer that has been defined in a package Service/Classes/Customer would have the following type string: " urn:Service.Classes.Customer ".


XML MappingclassToXML_mapping_rules

By default the following mapping rules apply:

  • Class attributes are mapped to XML attributes.
  • Association ends are mapped to XML elements.

These default rules can be overridden by using the stereotypes XMLElementXMLAttribute, and XMLCharacters on  class properties.
More about these mapping rules, stereotypes and tagged values (e.g. for number and date & time formatting) can be found on Controlling the XML Serialization With Stereotypes.


XML MappingclassToXML_parse_options_example

xmlToClass() offers an optional parameter of type XMLParseOptions. It has various attributes to control schema and DTD location and validation:

Be aware that by default, schemas are parsed, but documents are not validated against them. Set the validation attribute to true if you want to enforce validation beyond well-formedness.
For example, assume that you want to validate your document against a schema called CustomerData.xsd having the namespace http://acme.com/customer. In this case, you need to set the following parse options:

OptionValue
externalSchemaLocationhttp://acme.com/customer
validationtrue

If the XML document refers a schema file (.xsd) with filename (and optional path), it is sufficient to upload the file to the Integration (Bridge) as a resource. It will be automatically loaded from there.

If the XML document refers no schema, or you would like to provide another than the referred one, use the XMLParseOptions structure and set externalSchemaLocation (or externalNoNamespaceSchemaLocation) accordingly. As above, missing or relative paths will be redirected to the resource folder of the Integration (Bridge). The same applies also for validating against DTDs. Be aware that validation is turned off by default (see option validation below).


XML MappingclassToXML_parse_options

The following table lists all available XML options. Default values used when an option is not explicitly set are written in bold. Since the Runtime is using the Xerces parser internally, more information for all options can be found on the Xerces home page by following the read more link in the Description column.



XML MappingclassToXML_compose_options

xmlToClass() offers an optional parameter of type XMLComposeOptions.

Its attributes are:

AttributeTypeDescriptionExample
prologArray of StringThe string values are inserted right before the root element of the generated document. This mechanism can be used to insert processing instructions (e.g. DTD and Schema references), comments, entities or any other prolog you may think of. However, be aware that using prolog arrays makes it easy to generate non-well-formed documents.
timezoneStringTime zone string as specified on Time Zones. The timezone is used to print dateTime expressions. If no timezone is given, UTC is used.
If " local" is used, the date/time is printed relative to the local timezone of the server, e.g. 2012-10-01T12:36:47.0+02:00 (the timezone of the server is UTC+02:00).

"Australia/Melbourne", "CET", "Etc/GMT+10"

dateFormatStringStringA format string to be used when printing DateTime values as xs:date (e.g. %F to print a date without timezone).
The allowed formats can be found on Time Zones. If nothing is defined, the XSD standard is used.
%F
encodingStringEncoding of the target xml. Default encoding is UTF-8.
For a list of possible encodings see Charset Definitions.
"UTF-8"
rootNameString

Name of the generated XML root element. Use this tagged value to override the default behavior.

TXTRAW01
rootNamespaceStringName of the namespace of the generated XML root element.


  • No labels