2022 April Release

Software Component FSCBAI@1.1001 Permanent link for this heading

"Business Application Integration" is a software component that handles the communication between the system (eGOV,...) and any business applications. The business applications have to use a specific interface design for the communication, but they can be implemented with different technolgies - e.g. ASP.NET or C#. "FSC Business Application Integration" defines settings (Business Application Configuration) and SOAP actions that are used in relation to the integration of business applications - e.g. SOAPSetData, SOAPGetData to save any xml data of the business application as a content to an object. It uses other components like COOXML and FSCOWS for the basic XML handling and SOAP message interchange.

Classes Permanent link for this heading

Component

Reference

Description

FSCBAI@1.1001

BusinessApp

Business Application Definition

FSCBAI@1.1001

ConfigurationClass

Business Applications Configuration

FSCBAI@1.1001

Department

Department

Properties Permanent link for this heading

Type

Property

Name

Appearance

appearance

Appearance

AvailableDept[]

availabledept

Available Departments

ConfigurationClass

baiconfiguration

Business Applications

string

baseurlgui

GUI Base URL

BaseURLConfiguration[]

baseurls

Configuration for Business Application Calls

HttpConnector

baseurlsoapif

HTTP Connector for SOAP Interface

BusinessApp[]

businessapprv

Business Application

SoftwareComponent

component

Software Component

ComponentObject

context

Context

ComponentObject[]

contextlist

Context

Data[]

data

Business Application Data

Department

dept

Department

AttributeDefinition[]

deptlistpath

Path to List of Departments

Department[]

depts

Departments

string[]

desc

Description

string[]

disabledexpr

Expression for Disabled Menu Entry

DocumentMenuDef[]

documentsmenu

Case Documents Menu

string

foreignkey

Foreign Key

string[]

guiaction

Expression for GUI Action (URL)

string[]

initobjclass

Object Type for Default Initialization in Departments

string[]

invisibleexpr

Expression for Invisible Menu Entry

MenuConfiguration[]

menuconfig

Business Application Calls

LanguageContentList[]

mlxmlreptransform

Transformation (XSLT)

Namespaces[]

namespaces

Namespaces

string

nsprefix

Prefix

string

nsuri

URI

ObjectClass

objclass

Object Class

string[]

parameter

Expression for Optional GUI Parameters

string

progname

Code Reference

string[]

propagatedexpr

Expression for Objects Where to Set a Propagated Lock

PropagatedLock[]

propagatedlocks

Propagated Locks

string[]

returnurl

Expression for Return URL (Post-GUI)

RecordSet

rs

Business Application Recordset

string

rsdept

Department (Object Address)

XMLSchema

schema

Schema

SchemaDef[]

schemadefs

Schema for Business Application Data

XMLElementMapping

schemamapping

Mapping

SchemaMap[]

schemamaps

Schema Maps

boolean

separator

Pre-Ruler

string[]

soapsteps

Steps for Business Application Call (SOAP)

ComponentObject[]

trigger

Trigger

string

webdavurl

Local WebDAV URL

HttpConnector

wsdl

HTTP Connector for WSDL

content

xmlcont

XML Content

string

xmlcontexpr

Expression for XML Content

ComponentContentObject

xmlreptransform

Transformation Object (XSLT)

XmlTransformation[]

xmltransformation

Case Document Transformation

Department

xpathdept

Department

string

xpathexpr

XPath Expression

XPathExpressionConfiguration[]

xpathexprconfig

XPath Expression Configuration for Business Documents

Actions Permanent link for this heading

Return Type

Signature

void

CallSOAPAndGetURL(
  integer menudynkey,
  out string url)

void

CallSoapXmlEx(
  object dept,
  string operation,
  any xmlin,
  out any xmlout)

void

GetAppCallIndex(
  string progname,
  out integer inx)

void

GetBAIMapping(
  object dept,
  object ctx,
  out object mapping)

void

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

void

GetData(
  object dept,
  out Data[] data,
  out integer inx)

string

GetDataValue(
  object dept,
  string xpath,
  out retval string val)

void

GetDeptFromString(
  string deptid,
  out object dept)

void

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

void

GetForeignkey(
  object dept,
  out string foreignkey)

void

GetValueFromXMLContent(
  object dept,
  content xmlcont,
  string[] xpaths,
  out dictionary values)

void

GetValueFromXPathConfig(
  string progname,
  out string value)

void

InitBA(
  object dept)

void

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

void

LockPropagated(
  object ctx,
  out object[] objarrsuccess,
  out object[] objarrfail)

void

MapContentToObject(
  object dept,
  object ctx,
  content content)

void

MapObjectToContent(
  object dept,
  object ctx,
  out content content)

void

MenuStartBusinessApp(
  optional integer unused1,
  optional integer unused2,
  integer menudynkey)

void

MenuStartSelBusinessApps(
  optional integer unused1,
  optional integer unused2,
  integer menudynkey)

void

MenuViewDocument(
  optional integer unused1,
  optional integer unused2,
  integer menudynkey)

void

MenuViewSelDocuments(
  optional integer unused1,
  optional integer unused2)

void

SOAPCheckAccess(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPCheckIn(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPCheckOut(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPCreateContentObjectSWA(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPCreateObject(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPCreateVersion(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPDeleteVersion(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPDestroyObject(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPEvaluateExpression(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPGenericGetProperties(
  any xmlin,
  out content xmlout,
  optional interface xmldoc,
  optional object mapping)

void

SOAPGenericSetProperties(
  any xmlin,
  out content xmlout,
  optional interface xmldoc,
  optional object mapping)

void

SOAPGetContentSWA(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPGetData(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPReadVersion(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPRemovePointer(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPRestoreVersion(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPSearch(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPSetContentSWA(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

SOAPSetData(
  optional dictionary httpheadersin,
  optional content[] soapheadersin,
  content soapbodyin,
  optional dictionary soapattachmentsin,
  optional dictionary options,
  out optional dictionary httpheadersout,
  out optional content[] soapheadersout,
  out content soapbodyout,
  out optional dictionary soapattachmentsout)

void

StartBusinessApp(
  string progname)

void

StartBusinessAppUI(
  optional integer unused1,
  optional integer unused2,
  integer menudynkey)

Types Permanent link for this heading

Component

Reference

Description

FSCBAI@1.1001

Appearance

Configures the Appearance for a Menu Entry

FSCBAI@1.1001

AvailableDept

Configures all Available Departments

FSCBAI@1.1001

BaseURLConfiguration

Contains the Base URLs for the Business Application Calls

FSCBAI@1.1001

Data

Contains the Business Application Object's identification

FSCBAI@1.1001

DocumentMenuDef

Software Component

FSCBAI@1.1001

MenuConfiguration

Definition of internal names for use in calls of StartBusinessApp and Context

FSCBAI@1.1001

Namespaces

Configures all Available Departments

FSCBAI@1.1001

PropagatedLock

FSCBAI@1.1001

RecordSet

Configures all Available Departments

FSCBAI@1.1001

SchemaDef

FSCBAI@1.1001

SchemaMap

FSCBAI@1.1001

XmlTransformation

FSCBAI@1.1001

XPathExpressionConfiguration

Decodes the given base-64content

ErrorMessages Permanent link for this heading

Component

Reference

Description

FSCBAI@1.1001

ERR_BAIOBJNOTFOUND

Object containing business application data not found

FSCBAI@1.1001

ERR_CHECKINMODIFIED

Object has been changed since Checking out. Cannot Check-In

FSCBAI@1.1001

ERR_CONT_INVALID

Specified container not found

FSCBAI@1.1001

ERR_CREATE_FAILED

Could not create Object

FSCBAI@1.1001

ERR_DATEREQUIRED

Date of version could not be found

FSCBAI@1.1001

ERR_DEPTINVALID

Department invalid

FSCBAI@1.1001

ERR_DEPTNOTFOUND

Department "%s" not found

FSCBAI@1.1001

ERR_DESCRREQUIRED

Description for version could not be found

FSCBAI@1.1001

ERR_DOMAPPING

Couldn't map xml data to object

FSCBAI@1.1001

ERR_IDNOTFOUND

Invalid data interchange format. Field 'id' not found

FSCBAI@1.1001

ERR_INIT_XML

XML Initialization Content not found

FSCBAI@1.1001

ERR_INVALIDATTACHMENT

Invalid Attachment

FSCBAI@1.1001

ERR_INVALIDBAXML

Invalid XML for business application data

FSCBAI@1.1001

ERR_INVALIDOBJECT

Object can't be checked out. Invalid object

FSCBAI@1.1001

ERR_INVALIDSOAPREQUEST

Invalid SOAP request

FSCBAI@1.1001

ERR_INVALIDSOAPRESPONSE

Invalid SOAP Response

FSCBAI@1.1001

ERR_ISINITIALIZED

object allready initialized in business application

FSCBAI@1.1001

ERR_LOADXML_CONTENT

Error loading XML from CONTENT

FSCBAI@1.1001

ERR_LOADXML_UNKNOWN

Error loading XML from COMINTERFACE (CCooUnknown)

FSCBAI@1.1001

ERR_LOADXMLCONTENT

Error loading XML content

FSCBAI@1.1001

ERR_LOCKPROPINVALID

Error while propagating Lock - expression invalid

FSCBAI@1.1001

ERR_MAPPING

No matching Mapping found in Configuration

FSCBAI@1.1001

ERR_MAPPINGINVALID

Mapping invalid

FSCBAI@1.1001

ERR_NO_EXTERNALEDIT

invalid fileprocstate: must be EXTERNAL_EDITING

FSCBAI@1.1001

ERR_NOAPPDATA

No business application data found

FSCBAI@1.1001

ERR_NOATTACHMENTFOUND

No Attachment found

FSCBAI@1.1001

ERR_NOMATCHINGCFGENTRY

No matching entry for business application call found in configuration

FSCBAI@1.1001

ERR_NONODE_XPATH

No node could be found using given XPath

FSCBAI@1.1001

ERR_OBJATTR_INVOBJ

Object "%1$s" could not be set to attribute "%2$s" (%3$s)

FSCBAI@1.1001

ERR_OBJCLASS_INVALID

Specified Object Class invalid

FSCBAI@1.1001

ERR_OBJNOTFOUND

Object according to given address not found

FSCBAI@1.1001

ERR_TYPE_MISMATCH

Type mismatch for attribute "%1$s".

FSCBAI@1.1001

NO_CONF_NAMESPACE

No Namespaces found in Configuration

FSCBAI@1.1001

NO_CONF_XPATHEXPR

No XPath Expression found in Configuration

FSCBAI@1.1001

NO_DEPT_NAMESPACE

No Namespaces found for Department "%s"

Menus Permanent link for this heading

Component

Reference

Description

FSCBAI@1.1001

MenuBusinessApp

FSCBAI@1.1001

MenuBusinessApps

Business Applications

FSCBAI@1.1001

MenuDocument

FSCBAI@1.1001

MenuDocuments

Case Documents

SimpleConfigurationObjects Permanent link for this heading

Component

Reference

Description

FSCBAI@1.1001

DefaultConfig

Strings Permanent link for this heading

Component

Reference

Description

FSCBAI@1.1001

STR_SOAPCHECKINVERSION

Version generated before Check in

FSCBAI@1.1001

STR_SOAPCHECKOUTVERSION

Version generated before Check out

XMLSchemas Permanent link for this heading

Component

Reference

Description

FSCBAI@1.1001

DataSchema

FSCBAI@1.1001

EvalExprSchema

FSCBAI@1.1001

GenericObjectSchema

FSCBAI@1.1001

SOAPCheckInOutSchema

FSCBAI@1.1001

SOAPObjectSchema

FSCBAI@1.1001

SOAPSearchSchema

FSCBAI@1.1001

SOAPSWAContentSchema

FSCBAI@1.1001

SOAPVersionSchema