Class FSCREPORTING@1.1001:Report

Base report template

Class Hierarchy

Direct Subclasses

Properties

Type	Property	Name
LanguageStringList[]	mlname	Multilingual Name
AttributeDefinition[]	reportattributes	Content of the Report
ObjectClass[]	reportclasses	Report Classes
string[]	reportdictionaryvalueexpr	Expression for Calculating Dictionary Values
boolean	reportfilter	Filter Values
string[]	reportfilterexpr	Expression for Filtering Values
boolean	reportgenerictechnicalreport	Generic Technical Report
Language	reportlanguage	Report Language
boolean	reportlanguagevisible	Visible for all Languages
Locale	reportlocale	Report Locale
boolean	reportlocalevisible	Visible for all Locales
string[]	reportobjectvalueexpr	Expression for Calculating Object Values
ObjectClass[]	reportreleaseversionsexceptions	Exceptions for Release Versions
boolean	reportreleaseversionsonly	Include Release Versions Only
Object[]	reportrestrictedto	Restrict Report Creation to
Object	reportscope	Scope of Analysis
boolean	reportstoretodashboard	Store Report Result in Personal Dashboard
boolean	reportvalidonly	Include Valid Objects Only

Actions

Return Type	Signature
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)

Properties

Multilingual Name (COOSYSTEM@1.1:mlname)

Defines the multilingual name of the object. It stores one name for each supported language.

Explanation:
This field defines the multilingual name of the object.

unique LanguageStringList[] COOSYSTEM@1.1:mlname

Content of the Report (FSCREPORTING@1.1001:reportattributes)

Defines the properties which are used as data source for t report.

unique AttributeDefinition[] FSCREPORTING@1.1001:reportattributes not null

Additional Information

Object Classes Allowed: AttributeDefinition

Report Classes (FSCREPORTING@1.1001:reportclasses)

Defines a list of available report classes.

ObjectClass[] FSCREPORTING@1.1001:reportclasses not null

Expression for Calculating Dictionary Values (FSCREPORTING@1.1001:reportdictionaryvalueexpr)

Expression to calculate a list of dictionaries. Currently, only object and dictionary lists are supported for value expressions.

Explanation:
Defines an app.ducx expression that computes dictionary values.

string[] FSCREPORTING@1.1001:reportdictionaryvalueexpr not null

Local Scope: object
Global Scope: dictionary
Returns: dictionary[]

Filter Values (FSCREPORTING@1.1001:reportfilter)

Defines an app.ducx expression that filters result values.

boolean FSCREPORTING@1.1001:reportfilter

Expression for Filtering Values (FSCREPORTING@1.1001:reportfilterexpr)

Expression to calculate whether an object should be included in a report. The object of the current row is the local scope. If the expression should return false if the object should be skipped. If the expression returns true or null the object is included in the report.

Explanation:
Defines an app.ducx expression that filters result values.

string[] FSCREPORTING@1.1001:reportfilterexpr not null

Local Scope: object
Global Scope: dictionary
Returns: boolean

Generic Technical Report (FSCREPORTING@1.1001:reportgenerictechnicalreport)

Allows the definition of a report that is used in a use case implemented in the app.
When calling generic technical report, the report result must be created with " CreateReportResult".
After creating the report result, the attribute "reportscopeobjects" of the report result must be filled with the objects of the report.
In addition, "AddAdditionalReportColumns" can be overwritten for a report container to modify the workbook used to create the report result.

boolean FSCREPORTING@1.1001:reportgenerictechnicalreport

Report Language (FSCREPORTING@1.1001:reportlanguage)

Stores the language of the report.

Language FSCREPORTING@1.1001:reportlanguage

Additional Information

Object Classes Allowed: Language

Visible for all Languages (FSCREPORTING@1.1001:reportlanguagevisible)

Defines if the report is visible for all languages used in the user environment.

boolean FSCREPORTING@1.1001:reportlanguagevisible

Report Locale (FSCREPORTING@1.1001:reportlocale)

Stores the locale of the report.

Locale FSCREPORTING@1.1001:reportlocale

Additional Information

Object Classes Allowed: Locale

Visible for all Locales (FSCREPORTING@1.1001:reportlocalevisible)

Defines if the report is visible for all locales used in the user environment.

boolean FSCREPORTING@1.1001:reportlocalevisible

Expression for Calculating Object Values (FSCREPORTING@1.1001:reportobjectvalueexpr)

Expression to calculate a list of objects. Currently, only object and dictionary lists are supported for value expressions.

Explanation:
Defines an app.ducx expression that computes object values.

string[] FSCREPORTING@1.1001:reportobjectvalueexpr not null

Local Scope: object
Global Scope: dictionary
Returns: Object[]

Exceptions for Release Versions (FSCREPORTING@1.1001:reportreleaseversionsexceptions)

List of object classes that are always provided in the current version.

Explanation:
For the specified object classes, no release versions are used if instances of these object classes occur in values of objects.

unique ObjectClass[] FSCREPORTING@1.1001:reportreleaseversionsexceptions not null

Additional Information

Object Classes Allowed: ObjectClass

Include Release Versions Only (FSCREPORTING@1.1001:reportreleaseversionsonly)

Defines if only the release versions of the data source objects are considered.

boolean FSCREPORTING@1.1001:reportreleaseversionsonly

Restrict Report Creation to (FSCREPORTING@1.1001:reportrestrictedto)

Defines to which users or group the report generation is restricted.

Explanation:
You can restrict the creation of reports to certain users, organizations, organizational units, teams or external organizations.

unique Object[] FSCREPORTING@1.1001:reportrestrictedto

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Object Classes Allowed: User, Group

Scope of Analysis (FSCREPORTING@1.1001:reportscope)

Stores the scope of the data used for report generation.

Object FSCREPORTING@1.1001:reportscope not null

Additional Information

Object Classes Allowed: ObjectClass, ComponentTemplateCategory

Store Report Result in Personal Dashboard (FSCREPORTING@1.1001:reportstoretodashboard)

Defines if the report is stored in the personal dashboard of the user.

boolean FSCREPORTING@1.1001:reportstoretodashboard

Include Valid Objects Only (FSCREPORTING@1.1001:reportvalidonly)

Defines if only objects with a valid validity period are considered in the report.

boolean FSCREPORTING@1.1001:reportvalidonly

Actions

COOTC@1.1001:GetDraftTemplate

Gets the draft version of the template. The action can be called both on the draft version and on the release version of a template.

object COOTC@1.1001:GetDraftTemplate(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

COOTC@1.1001:IsDraftTemplate

Checks if the template is a draft which can be released.

If the release mechanism is to be used for an object class, then this action can be implemented for example with: isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();

boolean COOTC@1.1001:IsDraftTemplate(
out retval boolean isdrafttemplate)

Name	Description
isdrafttemplate	the result