2022 April Release

Software Component COOAR@1.1 Permanent link for this heading

In its basic concept, Active Reporting follows the same pattern as Active Server Pages in IIS. There is the concept of a template which consists of two fundamental parts: a static document frame and generative script code snippets. The code snippets are called the active parts of the document. They can be spread across the template by embedding them into the static document frame, like text text [% Report.Write(Hello World") %]text text where text text is part of the static document frame and the text inside [% %] is active text, i.e. script code. Unlike Active Server Pages in IIS, Active Reporting supports several mechanisms for embedding active text into a document template. Using some type of brackets like in the example above is one of currently three possible options. The decision which approach to take for designing, building and maintaining Active Reports (the term Active Report is used in the FSC context for referring to templates) depends on several factors, like the availability of document creation tools, performance requirements, skills of the designers of Active Reports etc. Further it provides the creation of text modules that contain "active reporting" elements, managing of text modules in text module collections and the compilation of documents from predefined text modules.

Classes Permanent link for this heading

Component

Reference

Description

COOAR@1.1

ActiveReport

Active Report

COOAR@1.1

ActiveReport_Text

Active Report (Text)

COOAR@1.1

ActiveReport_Web

Active Report (Web)

COOAR@1.1

ActiveReportClass

Object Class for Active Reports

COOAR@1.1

ActiveReportingAction

Active Reporting Action

COOAR@1.1

BasicActiveReport

Basic Active Report

COOAR@1.1

BasicActiveReport_Text

Basic Active Report (Text)

COOAR@1.1

BasicActiveReport_Web

Basic Active Report (Web)

COOAR@1.1

BasicTextModule

Basic Text Module

COOAR@1.1

BasicTextModule_Web

Text Module (Web)

COOAR@1.1

BasicTextModuleEx_Web

Text Module

COOAR@1.1

ContentEvaluationAction

Content Evaluation Action

COOAR@1.1

StaticTextModule

Static Text Module

COOAR@1.1

StaticTextModuleText

Static Text Module (Text)

COOAR@1.1

StaticTextModuleWord

Static Text Module (Word)

COOAR@1.1

StdTextModuleCollection

Standard Text Module Collection

COOAR@1.1

StdTextModulePackage

Standard Text Module Package

COOAR@1.1

TextModule

Basic Text Module Component Object

COOAR@1.1

TextModule_Web

Text Module (Web) Component Object

COOAR@1.1

TextModuleCategory

Text Module Category

COOAR@1.1

TextModuleCategoryComp

Text Module Category Component Object

COOAR@1.1

TextModuleCollection

Text Module Collection

COOAR@1.1

TextModuleDoc

Document With Text Modules

COOAR@1.1

TextModuleDocComp

Document With Text Modules Component Object

COOAR@1.1

TextModuleEx_Web

Text Module Component Object

COOAR@1.1

TextModuleFolder

Text Module Folder

COOAR@1.1

TextModulePackage

Text Module Package

COOAR@1.1

TextModulePointer

Text Module Pointer

Properties Permanent link for this heading

Type

Property

Name

Object[]

activereports

Apply These Active Reports

Object[]

allowedcategories

Allowed Text Module Categories

AttributeContentDef

attrforcreate

Property to Be Used for Content Creation

Object

category

Category

string[]

categorycontext

Context

Object[]

categorymodules

Assigned Text Modules

ContentObjectClass

classforcreate

Class to Be Used for Content Creation

ActiveReportDefinitionEntry[]

classreportdefs

Active Reports

Object[]

collectedtextmodules

Text Modules

SoftwareComponent

defentrycomp

Belongs to

Object[]

doctextmodules

Text Modules

Object[]

includes

Additional Scripts

boolean

keepplaceholder

Keep Text Module Placeholders in Document

string

markupattrname

Attribute Name

string

markupattrval

Attribute Value (Empty = All Values Match)

Object[]

modulecategory

Text Module Categories

string[]

moduleexpression

Expression

TextModuleVisibilityType

modulevisibility

Additional Restrictions

string[]

modulevisibleexpr

Expression for Further Restrictions of Usability

Object[]

packagedtextmodules

Text Modules

AttributeAggregateDef[]

pathforcreate

Path to Be Used for Content Creation

ContentObject[]

referencedin

Templates

ActiveReportingAction

reportingaction

For This Action

Result[]

result

Result

integer

resultcode

Format Code

CharacterEncodingScheme

resultencoding

Character Set

string

resultpattern

File Name Pattern

Object[]

subcategorylist

Sub Categories

Object[]

submodules

Sub Text Modules

Object

supercategory

Superordinate Category

string

textembattribute

Attribute Name

MarkupAttribute[]

textembattributes

Filter

string

textembbeg

Opening Bracket

string

textembelement

Element Name

string

textembend

Closing Bracket

MarkupPart

textembinput

The Active Text Is { }

boolean

textemboperator

All of These Attributes Must Be Present

MarkupPart

textemboutput

The Result Replaces { }

Object[]

textmodulecollections

Related Text Module Collections

Object[]

textmodules

Text Modules

string(39)

transactive

Active Text

Application

transapp

Converter

TextEmbeddingMarkup

transembmarkup

Embedding of Active Text Into Markup Text

TextEmbeddingPlain

transembplain

Embedding of Active Text Into Unformatted Text

CharacterEncodingScheme

transencoding

Character Set

Transformation

transform

Transformation

Format

transpassive

Format

Object[]

TV_CATEGORIES

Text Module Categories

boolean

TV_CATEGORIES_RESTRICTED

Restricted Text Module Categories

Object

TV_CATEGORY_CONTEXT

Text Module Category Context

dictionary

TV_GLOBALSCOPE

Global Scope

interface

TV_HOOK

Hook

Object[]

TV_STATICTEXTMODULETEXT_CONTENTPROCESSED

Static Text Module (Text) - Objects with Processed Content

boolean

usefortemplates

Evaluate Additional Restrictions in Templates

Actions Permanent link for this heading

Return Type

Signature

void

AllowedCollectionsFilter(
  ref object[] collections)

void

AttrCategoryModulesGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

object[]

AttrCategoryModulesUIFilter(
  ref retval object[] objects,
  AttributeDefinition attrdef)

void

AttrCategorySet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrReferencedInGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

CopyModuleHierarchy(
  optional integer handle,
  optional integer index,
  optional object view,
  optional object container)

void

CopyModuleHierarchySelected()

void

CreateEvaluation(
  object evaluation,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent,
  optional content externalcontent,
  ref optional integer externalcookie)

void

CreateEvaluationSelected(
  optional integer unused1,
  optional integer unused2)

void

CreateReport(
  object report,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent)

void

CreateReportSelected(
  optional integer unused1,
  optional integer unused2)

void

DisplayEvaluation(
  object evaluation,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent,
  optional content externalcontent,
  ref optional integer externalcookie)

void

DisplayEvaluationSelected(
  optional integer unused1,
  optional integer unused2)

void

DisplayReport(
  object report,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent)

void

DisplayReportSelected(
  optional integer unused1,
  optional integer unused2)

void

EndReport(
  object report,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent)

void

EvaluateTextModule(
  any modules,
  out string content,
  optional any globalscope)

void

ExploreTextModule()

void

ExportEvaluation(
  object evaluation,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent,
  optional content externalcontent,
  ref optional integer externalcookie)

void

ExportEvaluationSelected(
  optional integer unused1,
  optional integer unused2)

void

ExportReport(
  object report,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent)

void

ExportReportSelected(
  optional integer unused1,
  optional integer unused2)

void

GetCreateReportMenu(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetCreateReportMenuEntry(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetDisplayReportMenu(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetDisplayReportMenuEntry(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetExportReportMenu(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetExportReportMenuEntry(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetPrintReportMenu(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetPrintReportMenuEntry(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

void

GetTextModuleRoots(
  object trigger,
  out object[] rootobjects,
  out optional boolean restrictedmode)

boolean

IsTextModuleVisible(
  object context,
  optional boolean silent,
  out retval boolean isvisible)

void

PrintEvaluation(
  object evaluation,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent,
  optional content externalcontent,
  ref optional integer externalcookie)

void

PrintEvaluationSelected(
  optional integer unused1,
  optional integer unused2)

void

PrintReport(
  object report,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent)

void

PrintReportSelected(
  optional integer unused1,
  optional integer unused2)

string

ResultGetDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

void

RunReport(
  object report,
  optional boolean keeprunning,
  ref optional integer resultformat,
  ref optional string resultdestination,
  ref optional content resultcontent)

void

StdTextModulesGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

string

TextEmbeddingMarkupGetDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

string

TextEmbeddingPlainGetDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

void

TextModuleCategoryFilter(
  out object[] categories)

string

TransformationGetDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

Types Permanent link for this heading

Component

Reference

Description

COOAR@1.1

ActiveReportDefinitionEntry

For giving the possibility to show those reports that can be used for objects of this class

COOAR@1.1

Application

For giving the possibility to specify a pre-converter

COOAR@1.1

Format

This type is used for specifying the format of the primary content of an active report

COOAR@1.1

MarkupAttribute

For giving the possibility to further qualify the setting which is defined in the property

COOAR@1.1

MarkupPart

Markup Part

COOAR@1.1

Result

Define all the properties

COOAR@1.1

TextEmbeddingMarkup

For giving the possibility to define information concerning the embedding of active text into mark up text

COOAR@1.1

TextEmbeddingPlain

This type is used for defining the type of brackets to be used for embedding active text into the static part of an unformatted text

COOAR@1.1

TextModuleVisibilityType

Type for calculating the visibility of static text modules

COOAR@1.1

TransactionVariable

COOAR@1.1

Transformation

For giving the possibility to specify detailed information concerning the format of the text of the primary content

Prototypes Permanent link for this heading

Component

Reference

Description

COOAR@1.1

EvaluationPrototype

The prototype for Active Reporting Evaluation Actions

COOAR@1.1

ProtoGetTextModuleRoots

The prototype for actions to calculate the text module roots

COOAR@1.1

ReportingPrototype

The prototype for Active Reporting Actions

ActiveReports Permanent link for this heading

Component

Reference

Description

COOAR@1.1

StandardEvaluation

Standard Evaluation

COOAR@1.1

StandardEvaluationUTF8

Standard Evaluation (UTF8)

DeskForms Permanent link for this heading

Component

Reference

Description

COOAR@1.1

FormTextModuleCategoryTree

ErrorMessages Permanent link for this heading

Component

Reference

Description

COOAR@1.1

ConfigEmbMarkupNeedAttribute

%s: Attribute name must be specified.

COOAR@1.1

ConfigEmbMarkupNeedElement

%s: Element name must be specified.

COOAR@1.1

ContApp

No application to open report template (%s).

COOAR@1.1

ContAtt

Report template property is not valid (%s).

COOAR@1.1

ContEmpty

Report template is empty.

COOAR@1.1

ContFile

Report template file is not retrievable (%s).

COOAR@1.1

ContGet

Report template is not accessible (%s).

COOAR@1.1

ContInv

Report template is invalid (%s).

COOAR@1.1

ContObj

Active Report is invalid (%s).

COOAR@1.1

ContType

Type of report template not supported.

COOAR@1.1

FileMove

Cannot move data from [%1$s] to [%2$s] (%3$s).

COOAR@1.1

FileTemp

Cannot create file [%1$s] in [%2$s] (%3$s).

COOAR@1.1

ScriptCode

Error when initializing [%1$s] (%2$s).

COOAR@1.1

ScriptHost

Cannot activate Fabasoft Folio Scripting Integration (%s).

COOAR@1.1

ScriptItem

Error when preparing script execution (%s).

COOAR@1.1

ScriptPrep

Error when generating script code (%s).

COOAR@1.1

ScriptRun

Script execution error (%s).

COOAR@1.1

SourceClose

Cannot close template file [%1$s] (%2$s).

COOAR@1.1

SourceOpenMapFile

Cannot open template file [%1$s] (%2$s).

COOAR@1.1

SourceOpenMapOpen

Cannot create memory mapping for template data in [%1$s] (%2$s).

COOAR@1.1

SourceOpenMapSize

Cannot get size of template file [%1$s] (%2$s).

COOAR@1.1

SourceOpenMapView

Cannot map template data [%1$s] into memory (%2$s).

COOAR@1.1

TargetClose

Cannot close result file [%1$s] (%2$s).

COOAR@1.1

TargetOpenMapFile

Cannot create file [%1$s] for result data (%2$s).

COOAR@1.1

TargetOpenMapOpen

Cannot create memory mapping for result data in [%1$s] (%2$s).

COOAR@1.1

TargetOpenMapView

Cannot map [%1$s] into memory for creating result data (%2$s).

FormPages Permanent link for this heading

Component

Reference

Description

COOAR@1.1

PageCategoryModules

COOAR@1.1

PageStaticTextModuleSettings

COOAR@1.1

PageStaticTextModuleSettingsReduced

COOAR@1.1

PageSubCategoryList

COOAR@1.1

PageTemplateReferencedIn

COOAR@1.1

PageTextModuleCategory

COOAR@1.1

PageTextModulePointer

COOAR@1.1

PageTextModules

COOAR@1.1

PageTextModuleTextExContent

COOAR@1.1

PageTextModuleWebExContent

COOAR@1.1

PageTextModuleWebExSettings

Menus Permanent link for this heading

Component

Reference

Description

COOAR@1.1

MenuCopyModuleHierarchy

Copy Hierarchy

COOAR@1.1

MenuExportReportEntry

<report to export>

COOAR@1.1

MenuExportReportRoot

Export Report

COOAR@1.1

MenuPrintReportEntry

<report to print>

COOAR@1.1

MenuPrintReportRoot

Print Report

COOAR@1.1

MenuSeparator1

Separator

ObjectEditForms Permanent link for this heading

Component

Reference

Description

COOAR@1.1

FormActiveReport

COOAR@1.1

FormActiveReportDV

COOAR@1.1

FormActiveReportText

COOAR@1.1

FormActiveReportTextDV

COOAR@1.1

FormExploreTextModuleCategory

COOAR@1.1

FormStaticTextModule

COOAR@1.1

FormStaticTextModuleReduced

COOAR@1.1

FormTextModuleCategoryDV

COOAR@1.1

FormTextModuleCategoryUV

COOAR@1.1

FormTextModulePointer

COOAR@1.1

TextModuleDocForm

SimpleConfigurationObjects Permanent link for this heading

Component

Reference

Description

COOAR@1.1

TextModuleSearchScope

Query for Text Modules

Strings Permanent link for this heading

Component

Reference

Description

COOAR@1.1

exportcaption

Export %1$s for "%2$s"

COOAR@1.1

StrCreateTextModuleTranslationStateText

You can create a translation for the text module.

COOAR@1.1

StrTextModulePageTranslations

Translations receive, among other things, the text module category and settings for usage from the text module of the main language.

COOAR@1.1

tm_hide

Hide %1$s "%2$s"

COOAR@1.1

tm_insert

Insert %1$s into %2$s

COOAR@1.1

tm_link

Link %1$s into %2$s

COOAR@1.1

tm_multisel

%u Text Modules

COOAR@1.1

tm_show

Show %1$s "%2$s"