Export Options

You can specify export options to customize the XML output.

Export options are specified as CommandArguments (report parameter) for Export/Report buttons and in the reportName argument for QueryReport actions. For information on the syntax.

The following matrix shows which export options are available (Y) for the various export types:

  Fat Client Compatible Encoding Emit Configuration Emit Native Format Emit Invariant Format Emit Catalogs Emit Conditions Emit Links

List

FALSE

Y

Y

Y

Y

Y

Y

Y

Details

FALSE

Y

Y

Y

Y

Y

N

Y

Tree

FALSE

Y

Y

N

N

N

N

N
                 

List

TRUE

Y

Y

Y

Y

Y

Y

Y

Details

TRUE

N

N

N

N

N

N

N

Tree

TRUE

N

N

N

N

N

N

N
Note: Not every combination of the options listed here is actually meaningful, e.g. exporting catalogs for a tree view does not make sense, because a tree export contains table captions only and no catalog fields.

Export.ContentDisposition

inline … the browser tries to display the report results in the current browser window

attachment (default) … the browser asks the user to save the report results or open them in a separate window.

Export.EmitRepNames

Determines what is exported from rep ID fields in queries and lists:

true (default) ... rep names are exported.

false ... rep IDs are exported.

Export.Encoding

UTF-8 … the export is encoded using UTF-8.

UTF-16 … the export is encoded using UTF-16.

Export.Xml.EmitCatalogs

true … the XML elements <Catalogues/> and <Languages /> are included in the XML export. <Catalogues> contains all values of all catalogs used in the exported data. The catalog values are included in two languages: the user's language and the catalog base language. The core catalog IDs are also output.

Information about the fixed catalogs used in a report is output to an XML node analogous to variable catalogs (with the difference that values of fixed catalogs are output only in the current language).

false (default) … no catalogs are included with the XML export.

Export.Xml.EmitConditions

true … when exporting query results, this option exports the conditions (=filters) used when executing the query. The filters are output to the XML element <Conditions/>. Variable conditions like $curDay, $curRep etc. are replaced with their actual value.

false (default) … no conditions are included with the XML export.

Export.Xml.EmitConfiguration

true … the XML element <Configuration/> containing the configuration (e.g. of the field group or the tree view) is included in the XML export. This allows you to format a report's output e.g. based on field attributes.

false (default) … no configuration data is included in the XML export.

Export.Xml.EmitBaseFieldIds

true … an attribute fidcore (short notation: fic) containing the base field number is output for the <row/> and <fields/> tags. The base catalog IDs are output as well. The base info area shortcuts tableshortcore are also output to allow the creation of base reports.

Export.Xml.EmitInvariantFormat

true … all exported field values are formatted using Aurea CRM's internal culture invariant representation:

Field type

Formatting

Date

YYYYMMDD

Time

HHMM

Time (with seconds)

HHMMSS

Time (with milliseconds)

HHMMSSTTT

Boolean

1 or 0

Other field types

No special formatting is applied.

false (default) … all exported field values are formatted according to the users locale settings stored as Web Configuration parameters in the users configuration. For further details, see Locale Parameters.

Export.Xml.EmitLineBreaks

true (default)...Line breaks are exported.

false...Line breaks are removed from the XML output.

Export.Xml.EmitLinks

true … for every record, a hyperlink and a title for this link is included in the XML export. The titles are formatted using the default table caption of the record's info area, e.g.

<field_link tableshort="FI">http://.../ </field_link> <field_ref tableshort="FI">Aurea Software</field_ref>

false (default)… no hyperlinks are included in the XML export.

Export.Xml.EmitLocaleSettings

true (default) ... the XML element <LocaleSettings/> containing the users locale settings is included in the XML export.

false ... no locale setting data is included with the XML export.

Export.Xml.EmitNativeFormat

true … all exported field values are formatted using an XML-compliant format:

Field type

Formatting

Date

YYYY-MM-DD

Time

HH:MM

Time (with seconds)

HH:MM:SS

Time (with milliseconds)

HH:MM:SS.TTT

Boolean

t or f

Other field types

No special formatting is applied.

false (default) … all exported field values are formatted according to the users locale settings (stored as Web Configuration parameters in the user's configuration). For further details, see Locale Parameters.

Export.Xml.EmitOnlyBaseFields

true … only fields having a base ID are included in the XML output. The base info area shortcuts tableshortcore are also output to allow the creation of base reports.

Export.Xml.EmitVariables

true … the XML element <Variables/> is included in the XML export. <Variables> contains all the variables that are valid for the currently logged-in user.

false (default) … no variables are included in the XML export.

Export.Xml.ExportPhysicalInfoAreaIds

Relevant when using virtual info areas. For further details, see Virtual Info Areas.

true … the exported XML always contains the physical info area ID.

false (default) … the exported XML contains the actual info area ID, i.e. the virtual info area ID, if applicable.

Example:

<field tableshort="VDOC" tablename="Doctor" fieldno="2" fieldname="Company" …> <field tableshort="FI" tablename="Company" fieldno="2" fieldname="Company" …>

Export.Xml.FatClientCompatible

true … XML Export uses a Aurea CRM win-compatible schema.

false (default) … XML Export uses the Aurea CRM.Web schema.

Export.Xml.NamesOption

Short … the XML output contains shorter XML attribute and tag names. If your reports are very large, this options helps to reduce the file size (but has the disadvantage that the XML is much less readable).

Default Name

Short Name

Default Name

Short Name

Default Name

Short Name

catalog

c

fieldno

fn

recid

ri

catalogs

cs

fieldplaceholder

fph

sortnr

sn

catNo

cn

fields

fs

table

t

catNoCore

cnc

fieldtype

ft

tableCaption

tc

catval

cv

field_link

fl

tablelabel

tlb

extKey

e

field_ref

fr

tablename

tn

fid

fid

fixedCatalogues

fcs

tables

ts

fidcore

fic

langid

li

tableshort

tsr

field

f

mnr

mnr

tableshortcore

tsrc

fieldlabel

flb

name

nm

type

ty

fieldlength

fl

parCatNo

pcn

value

v

fieldmandatory

fmt

parCatVal

pcv

Variable

var

fieldname

fnm

prefix

p

Variables

vars

Every other value than Short results in the default names being used.