2022 June Release

Actions of FSCVAPP@1.1001 Permanent link for this heading

Return Type

Signature

void

Abort()

void

AbortRoot()

void

AddHeaderValue(
  string name,
  string value)

void

AddJavaScript(
  object javascript,
  dictionary parameters)

void

AddLocalObjects(
  object[] objects)

string

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

string

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

object

AttrGetUDMasterGroup(
  out retval object mastergroup)

void

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

void

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

string

BackupStateTransaction(
  out retval string transcationbackup)

void

CacheClear(
  optional boolean prepare)

void

CallAppStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

void

CallStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

void

CleanupState(
  string statetoken)

void

CollectRibbonConfig(
  ref dictionary tpconfigvaluedict)

void

Commit()

void

CommitRoot(
  optional boolean keepmarkedvariables,
  optional boolean keepall,
  optional AttributeDefinition[] variablestokeep)

void

CommitStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

void

CompressWebContent(
  string input,
  string output)

void

EndTimeTravel()

void

ExecInService(
  ref dictionary applictionroot)

void

Explain(
  object[] attrpath,
  ref Explanation[] explanations)

void

ExplainBranch(
  Branch[] branchobj,
  ref Explanation[] explanations)

void

ExploreNode(
  interface context,
  object dispatcher,
  object node,
  out dictionary[] children,
  optional boolean compoundonly,
  optional SortMode sortmode,
  optional boolean setversions,
  optional dictionary parameters,
  optional dictionary parametersex,
  out object filter)

void

FilterDisplayElement(
  ref string displaytext)

object[]

FilterObjectListForDisplay(
  ref retval object[] objects,
  object parent,
  object view)

ObjectStateDisplay[]

FilterObjectStateDisplay(
  ref retval ObjectStateDisplay[] objectstatedisplay,
  object parent,
  object view,
  boolean important,
  boolean isintimetravel)

void

GenerateView(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  dictionary parameters,
  object applicationview)

Activity[]

GetActivity(
  object[] objects,
  out retval Activity[] activities)

Activity[]

GetActivityEstimation(
  object[] objects,
  out retval Activity[] activities,
  optional boolean quickcheck)

dictionary

GetAggregationMenu(
  object[] aggregations,
  out retval dictionary menudict)

void

GetAppFeedbackButton(
  out object symbol,
  out string buttontext,
  out string hovertext,
  out string appid,
  out string formid)

object

GetApplication(
  object action,
  out retval object application)

object[]

GetAvailableThemes(
  out retval object[] themes)

void

GetBranches(
  object appview,
  ref OptionalBranches[] branches)

string

GetBreadcrumbObjectName(
  out retval string name,
  optional object contextobject)

boolean

GetButtonBarMode(
  out retval boolean issimple)

interface

GetContext(
  out retval interface context)

string

GetCSPHeader(
  ref optional CSPDirective[] directivelist,
  optional boolean reportonly,
  optional CSPDirectiveNames directive,
  out retval string headervalue,
  optional CSPRequestType requesttype)

dictionary[]

GetCustomizedControlsExternal(
  out retval dictionary[] entries,
  optional ThirdPartyExternalState tpstate,
  optional RibbonControlSite rcsite)

dictionary[]

GetCustomizedControlsObject(
  out retval dictionary[] entries,
  optional ThirdPartyObjectState tpstate,
  optional RibbonControlSite rcsite)

dictionary[]

GetCustomizedControlsOpen(
  out retval dictionary[] entries,
  optional RibbonControlSite rcsite)

Device

GetDevice(
  out retval Device device)

object

GetDispatcher(
  out retval object dispatcher)

string[]

GetDisplayEffectColors(
  optional DisplayEffect[] displayeffects,
  optional integer tintshadefrom,
  optional integer tintshadeto,
  optional integer count,
  out retval string[] colorvalues)

AttributeDefinition[]

GetFormAttributes(
  out retval AttributeDefinition[] attributes,
  optional object[] action,
  optional object formpage,
  optional object objclass,
  optional boolean isedit,
  optional dictionary exprstate,
  out optional AttributeDefinition[] changeableattributes,
  out optional AttributeDefinition[] mustbedefattributes,
  optional boolean ignorevisible,
  optional boolean iscommonedit,
  optional boolean allowfields)

void

GetFormBasedLoginSettings(
  out CookieSettings cookiesettings,
  out SamlSettings samlsettings,
  out object defaultdispatcher,
  out ProxySettings proxysettings,
  out LogoutSettings logoutsettings)

FormPageAttributes[]

GetFormPageAttributes(
  out retval FormPageAttributes[] formpageattributes,
  optional boolean nodynamic,
  optional object[] action,
  optional object objclass,
  optional boolean usegeneric,
  optional boolean addattributeonce,
  optional object formpage,
  optional boolean isedit,
  optional boolean ignorevisible,
  optional dictionary exprstate,
  optional boolean iscommonedit,
  optional boolean iscelledit,
  optional integer pageslimit,
  optional boolean allowfields)

object[]

GetFormViews(
  out retval object[] formviews)

void

GetGlobalTasks(
  object[] selobjects,
  ref object[] tasks,
  object menu)

string

GetHeaderValue(
  string name,
  out retval string value)

void

GetHelpRoot(
  object appview,
  ref object helproot)

string

GetHTML(
  string url,
  out retval string htmlutf8,
  optional string context,
  optional string cutprefix,
  optional string cutsuffix)

integer

GetImportLimit(
  out retval integer limit,
  optional integer contsize,
  optional string filename,
  optional boolean callhook,
  optional object target,
  out optional integer limitperimport)

void

GetImportLimitMax(
  ref integer maxcontsize)

object

GetLanguage(
  string langstring,
  out retval object language)

dictionary

GetMenu(
  string arguments,
  out retval dictionary menutree,
  optional object clipboard,
  optional integer expansionidx)

void

GetObjectActivity(
  string arguments,
  out string result)

void

GetObjectContext(
  ref object ctxobj,
  ref object ctxtype,
  ref string context,
  ref string category)

void

GetObjectInfo(
  out optional object targetobject,
  out optional string[] description,
  out optional string imagepath,
  out optional CardStyle imagestyle,
  optional object view)

ObjectStateDisplay[]

GetObjectStateDisplay(
  ref retval ObjectStateDisplay[] objectstatedisplay,
  object parent,
  object view,
  boolean important,
  boolean isintimetravel,
  object filter,
  optional object context)

ObjectStateDisplay[]

GetObjectStateDisplayCached(
  out retval ObjectStateDisplay[] objectstatedisplay,
  object parent,
  object view,
  boolean important,
  boolean isintimetravel,
  object filter,
  optional object context)

string

GetPath(
  out retval string path,
  optional SymbolFormat format,
  optional boolean usedefaulttheme,
  optional boolean identonly)

string

GetPluginInfo(
  string key,
  out retval string parameters)

object

GetPortalTheme(
  out retval object theme)

void

GetPostCommitUIParameters(
  ref object object,
  ref object action,
  out dictionary parameter)

void

GetPublicActionsHtml(
  optional string objaddress,
  out string html,
  out string logo,
  out string title,
  out string description)

void

GetPublicPageNotFound(
  out string html)

DisplayViewList[]

GetQueryColumns(
  string query,
  out retval DisplayViewList[] displayviewlist)

void

GetSelDependentTasks(
  object[] selobjects,
  ref object[] tasks,
  object menu)

SessionInfo[]

GetSessionInfo(
  out retval SessionInfo[] all,
  out SessionInfo[] active,
  out SessionInfo[] inactive,
  optional boolean orderbyloginat,
  optional SessionType type,
  optional AuthMeth authmeth,
  optional string ipaddress,
  optional string sessionid,
  optional integer limit)

string

GetStrings(
  string idents,
  out retval string strings)

void

GetSupportContext(
  object container,
  object[] context,
  out string supportteamname,
  out string headerlogourl,
  out string headercolor,
  out string additionaldata)

ListView[]

GetSupportedListViews(
  out retval ListView[] listviews)

object

GetTheme(
  out retval object theme)

string

GetUserAgent(
  out retval string useragent,
  out dictionary info)

content

GetValueView(
  optional object dispatcher,
  optional object application,
  object attrdef,
  optional string controlid,
  optional string argument,
  any value,
  out retval content htmlcontent)

dictionary

GetVAPPInformation(
  out retval dictionary information,
  optional boolean preventcontentread)

string

GetVersion(
  out retval string version,
  optional string separator)

object[]

GetVisibleWidgetObjects(
  out retval object[] widgets,
  optional object widgetcontainer,
  optional object widgetattrdef,
  optional boolean ordered)

dictionary

GetWidgetSettings(
  out retval dictionary widgetsesttings,
  optional object widgetcontainer,
  optional object widgetattrdef)

void

GroupLoginSessionSettingsGet(
  out GroupLoginSessionSettings grouploginsessionsettings)

void

GroupNativeClientSettingsGet(
  out GroupNativeClientSettings groupnativeclientsettings)

void

IsClientDebug(
  out boolean isclientdebug)

boolean

IsColumnValueFilterEnabled(
  out retval boolean isenabled)

boolean

IsInTimeTravel(
  out retval boolean isintimetravel,
  out optional datetime pointintime)

void

IsObjectAllowed()

boolean

IsPluginInstalled(
  out retval boolean isplugininstalled)

boolean

IsSearchableAttribute(
  out retval boolean issearchable)

boolean

IsSupported(
  Feature feature,
  out retval boolean issupported)

boolean

IsVAPP(
  out retval boolean isactive)

boolean

IsVAPPUI(
  out retval boolean isvappui)

void

KeepAliveState(
  string statetoken)

void

LogError(
  string errormsg)

void

Login(
  interface context,
  object application)

Breadcrumb[]

MakeBreadcrumb(
  string breadcrumbstring,
  out retval Breadcrumb[] breadcrumb)

void

ObjectAccessTypesGet(
  ref object[] accesstypes,
  optional boolean isclass)

object[]

PairedDeviceGetCACertificates(
  out retval object[] cacertificates)

void

ParseFormData(
  interface piwsio,
  ref dictionary paramdict)

void

PrepareStyleSheet(
  string[] srcfiles,
  string dstpath,
  string swc)

void

ProcessApplication(
  interface context,
  optional object application,
  optional any parameters)

string

ProcessLocal(
  object application,
  optional string arguments,
  optional interface request,
  out retval string response,
  optional string contenttype)

void

ProcessRequest(
  interface context)

void

ProcessStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

void

ProcessWebDAVRequest(
  interface context,
  integer loginrc,
  string loginmsg)

void

QueryStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

void

QueueEvent(
  string event,
  optional string arguments,
  optional boolean enablefocus,
  optional boolean refresh)

void

RaiseStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

integer

ReadViewResults(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  dictionary parameters,
  dictionary branchparameters,
  object applicationview,
  out retval integer branchid)

void

RestoreStateTransaction(
  string transcationbackup)

void

RunApplication(
  optional integer unused1,
  optional integer unused2)

void

ServiceStarted()

void

ServiceStopped()

void

SessionTerminate(
  optional string logonuser,
  optional string idpsessionid,
  optional string fscsessionid)

void

SetAttributeStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

void

SetButtonBarMode(
  boolean issimple)

interface

SetContext(
  interface context,
  out retval interface oldcontext)

void

SetErrorApplication(
  object application,
  dictionary parameters)

string

SetLanguageHTML(
  ref retval string str,
  optional boolean isattribute)

void

SetParameterStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

void

SetPostCommitUIParameters(
  object object,
  object action,
  dictionary parameter)

void

SetSelection(
  object view,
  optional object[] selobjects,
  optional boolean navigatetoview)

void

SetSound(
  Sound sound)

boolean

ShowWelcomeScreen(
  ref retval boolean show)

void

Starting(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot)

void

StartUseCase(
  string usecasereference)

void

Stopping(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot)

string

TransformToXml(
  object obj,
  object form,
  out retval string xml)

any

UIGetPathValue(
  any root,
  Field[] fieldattr,
  integer[] fieldindx,
  out retval any value)

void

UISetPathValue(
  any root,
  Field[] fieldattr,
  integer[] fieldindx,
  any value,
  optional boolean replace)

void

UISort(
  ref object[] objects,
  DisplayColumnList[] columns,
  optional object filter,
  optional string[] sortcolumns,
  optional object view,
  optional boolean usefilterkeyword,
  optional object filtercont)

void

UISortIndex(
  ref object[] objects,
  out integer[] index,
  DisplayColumnList[] columns,
  optional object filter,
  optional string[] sortcolumns,
  optional object view,
  optional boolean usefilterkeyword,
  optional object filtercont)

string

UpdateExportKey(
  string exportid,
  datetime exporttime,
  out retval string newexportid)

string

UpdateImportKey(
  string importid,
  datetime importtime,
  out retval string newimportid)

boolean

UsePDFViewer(
  out retval boolean usepdfjs)

boolean

UseVAppsOnMobileClients(
  out retval boolean usevappsonmobile)

boolean

ValidateSamlMetadata(
  out retval boolean valid,
  content metadata,
  out optional string entityid,
  out optional datetime validuntil,
  out optional string[] errors)


FSCVAPP@1.1001:Abort Permanent link for this heading

void FSCVAPP@1.1001:Abort()

Additional Information


FSCVAPP@1.1001:AbortRoot Permanent link for this heading

void FSCVAPP@1.1001:AbortRoot()

Additional Information


FSCVAPP@1.1001:AddHeaderValue Permanent link for this heading

void FSCVAPP@1.1001:AddHeaderValue(
  string name,
  string value)

Name

Description

name

value

Additional Information


FSCVAPP@1.1001:AddJavaScript Permanent link for this heading

Adds a JavaScriptComponentObject to the page.
The JavaScript will be executed on the client side.
It is possible to use placeholders in the JavaScript by enclosing expressions in "<% %>". The local scope of the expression will be determined by parameter parameters.
Note: When data is dynamically added to the script by help of placeholders it must be escaped appropriately. You may use the following escaping rules:
&lt;%[escape:javascript] value %&gt;: used if the value should be used in a JavaScript string (escapes quotes, backslash, CR/LF, <, >)
&lt;%[escape:jsstring+xml] value %&gt;: similar to rule "javascript", but & is escaped, too
&lt;%[escape:xml] value %&gt;: used if the value should be used as HTML (escapes only &, ", <, > as character entities)
&lt;%[escape:base64] value %&gt;: used if the value should be encoded to base64
&lt;%[escape:base16] value %&gt;: used if the value should be encoded to base16
You may also use the escape methods EscapeHTML in placeholder expressions to escape values.

Example:
Server side code inside the application:

...
string myobjnamestring = cooobj.objname;
...
coouser.AddJavaScript(#MyJavascriptComonentObject, this);

Client side code inside the JavaScriptComponentObject #MyJavascriptComonentObject:

(function() {
var teststring = '&lt;%[escape:javascript]myobjnamestring%&gt;';
var teststringbase64 = '&lt;%[escape:base64]myobjnamestring%%&gt;';
...
alert(teststring);
...
document.getElementById("myNameElement").innerHTML =
"&lt;div%&gt;&lt;%[escape:javascript]coouser.EscapeHTML(myobjnamestring)%%&gt;&lt;/div%&gt;";
})();

void FSCVAPP@1.1001:AddJavaScript(
  object javascript,
  dictionary parameters)

Name

Description

javascript

The JavaScriptComponentObject which will be added to the page.

parameters

This dictionary is used to deliver the values that could be used to be patched inside the JavaScriptComponentObject.
If you want to use the current dictionary this will be the proper value.

Additional Information


FSCVAPP@1.1001:AddLocalObjects Permanent link for this heading

void FSCVAPP@1.1001:AddLocalObjects(
  object[] objects)

Name

Description

objects

Additional Information


FSCVAPP@1.1001:AttrApplyToGetDisp Permanent link for this heading

Display action for the property applytofield ("Apply To Field").

string FSCVAPP@1.1001:AttrApplyToGetDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

Name

Description

attrdef

string

value

language

attrdeflist

flags

index

Additional Information


FSCVAPP@1.1001:AttrGetDictSelDisp Permanent link for this heading

string FSCVAPP@1.1001:AttrGetDictSelDisp(
  AttributeDefinition attrdef,
  out retval string string,
  optional any value,
  optional Language language,
  optional AttributeDefinition[] attrdeflist,
  optional integer flags,
  optional integer index)

Name

Description

attrdef

string

value

language

attrdeflist

flags

index

Additional Information


FSCVAPP@1.1001:AttrGetUDMasterGroup Permanent link for this heading

Retrieves user data master group

object FSCVAPP@1.1001:AttrGetUDMasterGroup(
  out retval object mastergroup)

Name

Description

mastergroup

user data master group

Additional Information


FSCVAPP@1.1001:AttrRelatedGet Permanent link for this heading

void FSCVAPP@1.1001:AttrRelatedGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCVAPP@1.1001:AttrRelatedSet Permanent link for this heading

void FSCVAPP@1.1001:AttrRelatedSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCVAPP@1.1001:BackupStateTransaction Permanent link for this heading

Backup the transaction and return the serialized transaction This action check whether a state server in use

string FSCVAPP@1.1001:BackupStateTransaction(
  out retval string transcationbackup)

Name

Description

transcationbackup

the serialized transaction

Additional Information


FSCVAPP@1.1001:CacheClear Permanent link for this heading

void FSCVAPP@1.1001:CacheClear(
  optional boolean prepare)

Name

Description

prepare

Additional Information


FSCVAPP@1.1001:CallAppStep Permanent link for this heading

ApplicationStep CallAppStep

void FSCVAPP@1.1001:CallAppStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:CallStep Permanent link for this heading

ApplicationStep CallStep

void FSCVAPP@1.1001:CallStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:CleanupState Permanent link for this heading

Call to delete the token on the state server

void FSCVAPP@1.1001:CleanupState(
  string statetoken)

Name

Description

statetoken

the state token

Additional Information


FSCVAPP@1.1001:CollectRibbonConfig Permanent link for this heading

void FSCVAPP@1.1001:CollectRibbonConfig(
  ref dictionary tpconfigvaluedict)

Name

Description

tpconfigvaluedict

Additional Information


FSCVAPP@1.1001:Commit Permanent link for this heading

void FSCVAPP@1.1001:Commit()

Additional Information


FSCVAPP@1.1001:CommitRoot Permanent link for this heading

Commits all transaction scopes

void FSCVAPP@1.1001:CommitRoot(
  optional boolean keepmarkedvariables,
  optional boolean keepall,
  optional AttributeDefinition[] variablestokeep)

Name

Description

keepmarkedvariables

keep selected transaction variables such as selected Variables: COODESK@1.1: TV_SELECTIONCONTEXT TV_SELECTIONCONTAINER COOATTREDIT@1.1: TV_EDITCOMMONATTRIBUTES FSCVAPP@1.1001: TV_ETCURLARGS TV_REFRESHPENDING TV_BREADCRUMB TV_APPLICATIONDISPATCHER TV_RENDERTREE TV_TRANSFORMTOXML FSCVENV@1.1001: TV_ISCOMMONEDIT TV_SENDASCOPY_PDF TV_CALLEDFROMTHIRDPARTY TV_ISEXTENDEDCOMMONEDIT This variables are defined due the boolean parameter txvariablekeptonapplyinae at the attribute definition defining the transaction variable

keepall

keep transaction variables from all Software Components

variablestokeep

list for transaction variables to be kept additionally to the selection from COODESK@1.1, COOATTREDIT@1.1, FSCVAPP@1.1001 and FSCVENV@1.1001

Additional Information


FSCVAPP@1.1001:CommitStep Permanent link for this heading

ApplicationStep CommitStep

void FSCVAPP@1.1001:CommitStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:CompressWebContent Permanent link for this heading

void FSCVAPP@1.1001:CompressWebContent(
  string input,
  string output)

Name

Description

input

output

Additional Information


FSCVAPP@1.1001:EndTimeTravel Permanent link for this heading

void FSCVAPP@1.1001:EndTimeTravel()

Additional Information


FSCVAPP@1.1001:ExecInService Permanent link for this heading

void FSCVAPP@1.1001:ExecInService(
  ref dictionary applictionroot)

Name

Description

applictionroot

Additional Information


FSCVAPP@1.1001:Explain Permanent link for this heading

void FSCVAPP@1.1001:Explain(
  object[] attrpath,
  ref Explanation[] explanations)

Name

Description

attrpath

explanations

Additional Information


FSCVAPP@1.1001:ExplainBranch Permanent link for this heading

void FSCVAPP@1.1001:ExplainBranch(
  Branch[] branchobj,
  ref Explanation[] explanations)

Name

Description

branchobj

explanations

Additional Information


FSCVAPP@1.1001:ExploreNode Permanent link for this heading

void FSCVAPP@1.1001:ExploreNode(
  interface context,
  object dispatcher,
  object node,
  out dictionary[] children,
  optional boolean compoundonly,
  optional SortMode sortmode,
  optional boolean setversions,
  optional dictionary parameters,
  optional dictionary parametersex,
  out object filter)

Name

Description

context

dispatcher

node

children

compoundonly

sortmode

setversions

parameters

parametersex

filter

Additional Information


FSCVAPP@1.1001:FilterDisplayElement Permanent link for this heading

void FSCVAPP@1.1001:FilterDisplayElement(
  ref string displaytext)

Name

Description

displaytext

Additional Information


FSCVAPP@1.1001:FilterObjectListForDisplay Permanent link for this heading

object[] FSCVAPP@1.1001:FilterObjectListForDisplay(
  ref retval object[] objects,
  object parent,
  object view)

Name

Description

objects

parent

view

Additional Information


FSCVAPP@1.1001:FilterObjectStateDisplay Permanent link for this heading

Filter the state display evaluated during GetObjectStateDisplay

ObjectStateDisplay[] FSCVAPP@1.1001:FilterObjectStateDisplay(
  ref retval ObjectStateDisplay[] objectstatedisplay,
  object parent,
  object view,
  boolean important,
  boolean isintimetravel)

Name

Description

objectstatedisplay

the object states

parent

parent of the current object

view

view where the current objects exists

important

are important states requested

isintimetravel

time travel is active

Additional Information


FSCVAPP@1.1001:GenerateView Permanent link for this heading

void FSCVAPP@1.1001:GenerateView(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  dictionary parameters,
  object applicationview)

Name

Description

context

dispatcher

application

applicationpath

applicationroot

parameters

applicationview

Additional Information


FSCVAPP@1.1001:GetActivity Permanent link for this heading

Returns a detailed list of recent events for the objects passed in parameter object.

Activity[] FSCVAPP@1.1001:GetActivity(
  object[] objects,
  out retval Activity[] activities)

Name

Description

objects

The list of object to check whether there are recent events available

activities

The recent events @see GetActivityEstimation

Additional Information


FSCVAPP@1.1001:GetActivityEstimation Permanent link for this heading

Checks whether there are recent events available for the objects passed in parameter objects. The Activity list returned in parameter activities will only contain values for member actobject.
For a detailed description of events GetActivity will be used.
If parameter quickcheck is true an approximate estimation should be done since performance is relevant.
Recent events will be shown as bubbles in the card view.

Activity[] FSCVAPP@1.1001:GetActivityEstimation(
  object[] objects,
  out retval Activity[] activities,
  optional boolean quickcheck)

Name

Description

objects

The object list that should be checked for recent events

activities

A list of Activity items for objects that may have recent events

quickcheck

If true only an approximate estimation with low performance impact should be done @see GetActivity

Additional Information


FSCVAPP@1.1001:GetAggregationMenu Permanent link for this heading

dictionary FSCVAPP@1.1001:GetAggregationMenu(
  object[] aggregations,
  out retval dictionary menudict)

Name

Description

aggregations

menudict

Additional Information


FSCVAPP@1.1001:GetAppFeedbackButton Permanent link for this heading

void FSCVAPP@1.1001:GetAppFeedbackButton(
  out object symbol,
  out string buttontext,
  out string hovertext,
  out string appid,
  out string formid)

Name

Description

symbol

buttontext

hovertext

appid

formid

Additional Information


FSCVAPP@1.1001:GetApplication Permanent link for this heading

object FSCVAPP@1.1001:GetApplication(
  object action,
  out retval object application)

Name

Description

action

application

Additional Information


FSCVAPP@1.1001:GetAvailableThemes Permanent link for this heading

object[] FSCVAPP@1.1001:GetAvailableThemes(
  out retval object[] themes)

Name

Description

themes

Additional Information


FSCVAPP@1.1001:GetBranches Permanent link for this heading

void FSCVAPP@1.1001:GetBranches(
  object appview,
  ref OptionalBranches[] branches)

Name

Description

appview

branches

Additional Information


FSCVAPP@1.1001:GetBreadcrumbObjectName Permanent link for this heading

Retrieves name for an object displayed in the breadcrumb

string FSCVAPP@1.1001:GetBreadcrumbObjectName(
  out retval string name,
  optional object contextobject)

Name

Description

name

the new calculated object name

contextobject

context object in the breadcrumb

Additional Information


FSCVAPP@1.1001:GetButtonBarMode Permanent link for this heading

boolean FSCVAPP@1.1001:GetButtonBarMode(
  out retval boolean issimple)

Name

Description

issimple

Additional Information


FSCVAPP@1.1001:GetContext Permanent link for this heading

interface FSCVAPP@1.1001:GetContext(
  out retval interface context)

Name

Description

context

Additional Information


FSCVAPP@1.1001:GetCSPHeader Permanent link for this heading

Get the value for the Content-Security-Policy or Content-Security-Policy-Report-Only header.
You may also retrieve the value of a single policy by help of parameter directive.
The directives are retrieved from the configuration property cspdirectives. For subsequent calls to the method you may pass the directive list to the action to increase performance.
For a detailed description of the Content Security Policy refer to: http://www.w3.org/TR/CSP2/

string FSCVAPP@1.1001:GetCSPHeader(
  ref optional CSPDirective[] directivelist,
  optional boolean reportonly,
  optional CSPDirectiveNames directive,
  out retval string headervalue,
  optional CSPRequestType requesttype)

Name

Description

directivelist

If omitted the method will retrieve the currently configured values and return the current configuration. If the method must be called multiple times you may pass the directive list to increase performance.

reportonly

The method will return only the policies marked with "report-only" (cspreportonly).

directive

If you are interested in only a single policy you may pass a policy name.

headervalue

The configured policy as return value.

requesttype

Additional Information


FSCVAPP@1.1001:GetCustomizedControlsExternal Permanent link for this heading

Retrieves all ThirdParty controls for external documents

dictionary[] FSCVAPP@1.1001:GetCustomizedControlsExternal(
  out retval dictionary[] entries,
  optional ThirdPartyExternalState tpstate,
  optional RibbonControlSite rcsite)

Name

Description

entries

contains configured items

tpstate

allows to filter for an external context state

rcsite

allow to filter for an appropriate site

Additional Information


FSCVAPP@1.1001:GetCustomizedControlsObject Permanent link for this heading

Retrieves all ThirdParty controls for internal documents

dictionary[] FSCVAPP@1.1001:GetCustomizedControlsObject(
  out retval dictionary[] entries,
  optional ThirdPartyObjectState tpstate,
  optional RibbonControlSite rcsite)

Name

Description

entries

contains configured items

tpstate

allows to filter for an object context state

rcsite

allows to filter for an appropriate site

Additional Information


FSCVAPP@1.1001:GetCustomizedControlsOpen Permanent link for this heading

Retrieves all ThirdParty controls for all types of documents in open state

dictionary[] FSCVAPP@1.1001:GetCustomizedControlsOpen(
  out retval dictionary[] entries,
  optional RibbonControlSite rcsite)

Name

Description

entries

contains configured items

rcsite

allows to filter for an appropriate site [TPOS_OPEN] is assumed as object context state

Additional Information


FSCVAPP@1.1001:GetDevice Permanent link for this heading

Device FSCVAPP@1.1001:GetDevice(
  out retval Device device)

Name

Description

device

Additional Information


FSCVAPP@1.1001:GetDispatcher Permanent link for this heading

object FSCVAPP@1.1001:GetDispatcher(
  out retval object dispatcher)

Name

Description

dispatcher

Additional Information


FSCVAPP@1.1001:GetDisplayEffectColors Permanent link for this heading

Calculates display effect color values according to the current theme of the object. The theme is calculated using GetTheme.

string[] FSCVAPP@1.1001:GetDisplayEffectColors(
  optional DisplayEffect[] displayeffects,
  optional integer tintshadefrom,
  optional integer tintshadeto,
  optional integer count,
  out retval string[] colorvalues)

Name

Description

displayeffects

tintshadefrom

tintshadeto

count

colorvalues

Additional Information


FSCVAPP@1.1001:GetFormAttributes Permanent link for this heading

Calculate the attributes displayed on a form or formpage

AttributeDefinition[] FSCVAPP@1.1001:GetFormAttributes(
  out retval AttributeDefinition[] attributes,
  optional object[] action,
  optional object formpage,
  optional object objclass,
  optional boolean isedit,
  optional dictionary exprstate,
  out optional AttributeDefinition[] changeableattributes,
  out optional AttributeDefinition[] mustbedefattributes,
  optional boolean ignorevisible,
  optional boolean iscommonedit,
  optional boolean allowfields)

Name

Description

attributes

the list of attributes on the form

action

defining the form

formpage

the formpage as source instead of a form

objclass

class used as starting point to calculate the pages of the form

isedit

with this parameter the parameter ::isedit inside the global scope used for evaluating the visible/changeable/mustbedef expression can be set

exprstate

this dictionary is used as base for the localscope for evaluating the visible/changeable/mustbedef expression.
The parameters venv_object, venv_parent, venv_view and sys_selobjects are also set in the Dictionary according to the values in the SelectionContext.
Since the locale scope is only valid during the evaluation of the particular expression, it is recommended to split the given Dictionary. Furthermore, it is not useful to set values in these scopes.

changeableattributes

the list of changeable attributes on the form

mustbedefattributes

the list of mustbedef attributes on the form

ignorevisible

do not calculate the visible expressions

iscommonedit

calculate Forms for EditCommonAttributes

allowfields

treat fields as valid attributes

Additional Information


FSCVAPP@1.1001:GetFormBasedLoginSettings Permanent link for this heading

void FSCVAPP@1.1001:GetFormBasedLoginSettings(
  out CookieSettings cookiesettings,
  out SamlSettings samlsettings,
  out object defaultdispatcher,
  out ProxySettings proxysettings,
  out LogoutSettings logoutsettings)

Name

Description

cookiesettings

samlsettings

defaultdispatcher

proxysettings

logoutsettings

Additional Information


FSCVAPP@1.1001:GetFormPageAttributes Permanent link for this heading

Calculate the FormPageAttributes struct for a form or formpage

FormPageAttributes[] FSCVAPP@1.1001:GetFormPageAttributes(
  out retval FormPageAttributes[] formpageattributes,
  optional boolean nodynamic,
  optional object[] action,
  optional object objclass,
  optional boolean usegeneric,
  optional boolean addattributeonce,
  optional object formpage,
  optional boolean isedit,
  optional boolean ignorevisible,
  optional dictionary exprstate,
  optional boolean iscommonedit,
  optional boolean iscelledit,
  optional integer pageslimit,
  optional boolean allowfields)

Name

Description

formpageattributes

the FormPageAttributes struct for the form

nodynamic

this parameter defines the nodynamic parameter for the form builder

action

defining the form

objclass

class used as starting point to calculate the pages of the form

usegeneric

this parameter defines whether the form should be calculated as generic form

addattributeonce

this parameter defines whether the form item should be handled only once

formpage

the formpage as source instead of a form

isedit

with this parameter the parameter ::isedit inside the global scope used for evaluating the visible/changeable/mustbedef expression can be set

ignorevisible

this parameter defines whether the visible expression on an item should be ignored. So invisible items will also be written in the result struct.

exprstate

this dictionary is used as base for the localscope for evaluating the visible/changeable/mustbedef expression.
The parameters venv_object, venv_parent, venv_view and sys_selobjects are also set in the Dictionary according to the values in the SelectionContext.
Since the locale scope is only valid during the evaluation of the particular expression, it is recommended to split the given Dictionary. Furthermore, it is not useful to set values in these scopes.

iscommonedit

calculates forms for EditCommonAttributes

iscelledit

calculates forms for editing cells with F2

pageslimit

maximum number of valid form pages to be calculated

allowfields

treat fields as valid attributes

Additional Information


FSCVAPP@1.1001:GetFormViews Permanent link for this heading

object[] FSCVAPP@1.1001:GetFormViews(
  out retval object[] formviews)

Name

Description

formviews

Additional Information


FSCVAPP@1.1001:GetGlobalTasks Permanent link for this heading

void FSCVAPP@1.1001:GetGlobalTasks(
  object[] selobjects,
  ref object[] tasks,
  object menu)

Name

Description

selobjects

tasks

menu

Additional Information


FSCVAPP@1.1001:GetHeaderValue Permanent link for this heading

string FSCVAPP@1.1001:GetHeaderValue(
  string name,
  out retval string value)

Name

Description

name

value

Additional Information


FSCVAPP@1.1001:GetHelpRoot Permanent link for this heading

void FSCVAPP@1.1001:GetHelpRoot(
  object appview,
  ref object helproot)

Name

Description

appview

helproot

Additional Information


FSCVAPP@1.1001:GetHTML Permanent link for this heading

string FSCVAPP@1.1001:GetHTML(
  string url,
  out retval string htmlutf8,
  optional string context,
  optional string cutprefix,
  optional string cutsuffix)

Name

Description

url

htmlutf8

context

cutprefix

cutsuffix

Additional Information


FSCVAPP@1.1001:GetImportLimit Permanent link for this heading

integer FSCVAPP@1.1001:GetImportLimit(
  out retval integer limit,
  optional integer contsize,
  optional string filename,
  optional boolean callhook,
  optional object target,
  out optional integer limitperimport)

Name

Description

limit

contsize

filename

callhook

target

limitperimport

Additional Information


FSCVAPP@1.1001:GetImportLimitMax Permanent link for this heading

void FSCVAPP@1.1001:GetImportLimitMax(
  ref integer maxcontsize)

Name

Description

maxcontsize

Additional Information


FSCVAPP@1.1001:GetLanguage Permanent link for this heading

object FSCVAPP@1.1001:GetLanguage(
  string langstring,
  out retval object language)

Name

Description

langstring

language

Additional Information


FSCVAPP@1.1001:GetMenu Permanent link for this heading

dictionary FSCVAPP@1.1001:GetMenu(
  string arguments,
  out retval dictionary menutree,
  optional object clipboard,
  optional integer expansionidx)

Name

Description

arguments

menutree

clipboard

expansionidx

Additional Information


FSCVAPP@1.1001:GetObjectActivity Permanent link for this heading

Retrieves the recent events that should be shown in bubbles of the card view or in the task pane. This action is called asynchronously after rendering of the card view.

void FSCVAPP@1.1001:GetObjectActivity(
  string arguments,
  out string result)

Name

Description

arguments

A comma separated list of object addresses

result

A JSON string representing the recent events of the objects @see GetActivity @see GetActivityEstimation

Additional Information


FSCVAPP@1.1001:GetObjectContext Permanent link for this heading

void FSCVAPP@1.1001:GetObjectContext(
  ref object ctxobj,
  ref object ctxtype,
  ref string context,
  ref string category)

Name

Description

ctxobj

ctxtype

context

category

Additional Information


FSCVAPP@1.1001:GetObjectInfo Permanent link for this heading

Provides some information about the current object that should be displayed in the user interface.
The action may provide a logo or image and a description.
The logo (image) and the description is displayed on top of the current view in the content area (e.g. in dashboards, list views or the document view).
By default the path to the logo of the current object (or its logo container - see GetLogoContainer) is returned in imagepath.

void FSCVAPP@1.1001:GetObjectInfo(
  out optional object targetobject,
  out optional string[] description,
  out optional string imagepath,
  out optional CardStyle imagestyle,
  optional object view)

Name

Description

targetobject

An alternate object the information in the header refers to. The user has the possibility to open the IntelliHelp for that object if it differs from the current object.

description

A max. of two short strings describing the current object or the targetobject in more detail.

imagepath

The path to the image that should be shown in the header. By default the object logo is displayed by returning the result of GetLogoPath.

imagestyle

The style how the image should be displayed in the header. The image will be resized to fit into the available space (default behavior) or cropped at top and bottom (CARDSTYLE_COVER). Cropping may be useful for portrait photos.

view

The attribute definition of the current list. This parameter is set when a single list is displayed.

Additional Information


FSCVAPP@1.1001:GetObjectStateDisplay Permanent link for this heading

Delivers an ObjectStateDisplayArray according to the actual state of the object

ObjectStateDisplay[] FSCVAPP@1.1001:GetObjectStateDisplay(
  ref retval ObjectStateDisplay[] objectstatedisplay,
  object parent,
  object view,
  boolean important,
  boolean isintimetravel,
  object filter,
  optional object context)

Name

Description

objectstatedisplay

the object states

parent

parent of the current object

view

view where the current objects exists

important

are important states requested

isintimetravel

time travel is active

filter

used filter

context

context object

Additional Information


FSCVAPP@1.1001:GetObjectStateDisplayCached Permanent link for this heading

Delivers an ObjectStateDisplayArray according to the actual state of the object This Action is cached during the transaction (actcacheable)

ObjectStateDisplay[] FSCVAPP@1.1001:GetObjectStateDisplayCached(
  out retval ObjectStateDisplay[] objectstatedisplay,
  object parent,
  object view,
  boolean important,
  boolean isintimetravel,
  object filter,
  optional object context)

Name

Description

objectstatedisplay

the object states

parent

parent of the current object

view

view where the current objects exists

important

are important states requested

isintimetravel

time travel is active

filter

used filter

context

context object

Additional Information


FSCVAPP@1.1001:GetPath Permanent link for this heading

Calculates the web server path of a symbol or theme.

string FSCVAPP@1.1001:GetPath(
  out retval string path,
  optional SymbolFormat format,
  optional boolean usedefaulttheme,
  optional boolean identonly)

Name

Description

path

format

usedefaulttheme

identonly

Additional Information


FSCVAPP@1.1001:GetPluginInfo Permanent link for this heading

string FSCVAPP@1.1001:GetPluginInfo(
  string key,
  out retval string parameters)

Name

Description

key

parameters

Additional Information


FSCVAPP@1.1001:GetPortalTheme Permanent link for this heading

object FSCVAPP@1.1001:GetPortalTheme(
  out retval object theme)

Name

Description

theme

Additional Information


FSCVAPP@1.1001:GetPostCommitUIParameters Permanent link for this heading

Reads a PostCommitUI value set matching to the input parameter.
PostCommitUI information defines a value set to start an application when the current code finishes. The application associated to the action will be started with the object.
The parameter is the parameter dictionary when running that application.
Internally the PostCommitUI information is stored in the root dictionary with the key sys_postcommitui.
Every entry in this list triggers a separate application in a new transaction.
If there is an entry for a specific object/action, GetPostCommitUIParameters will return values for object/action/parameter. Otherwise null values are returned.

void FSCVAPP@1.1001:GetPostCommitUIParameters(
  ref object object,
  ref object action,
  out dictionary parameter)

Name

Description

object

Object on which the application will be started.

action

This action defines (due to an action/application mapping on an object class) which application will be started.

parameter

The parameter dictionary for the application to run.

Additional Information


FSCVAPP@1.1001:GetPublicActionsHtml Permanent link for this heading

void FSCVAPP@1.1001:GetPublicActionsHtml(
  optional string objaddress,
  out string html,
  out string logo,
  out string title,
  out string description)

Name

Description

objaddress

html

logo

title

description

Additional Information


FSCVAPP@1.1001:GetPublicPageNotFound Permanent link for this heading

void FSCVAPP@1.1001:GetPublicPageNotFound(
  out string html)

Name

Description

html

Additional Information


FSCVAPP@1.1001:GetQueryColumns Permanent link for this heading

DisplayViewList[] FSCVAPP@1.1001:GetQueryColumns(
  string query,
  out retval DisplayViewList[] displayviewlist)

Name

Description

query

displayviewlist

Additional Information


FSCVAPP@1.1001:GetSelDependentTasks Permanent link for this heading

void FSCVAPP@1.1001:GetSelDependentTasks(
  object[] selobjects,
  ref object[] tasks,
  object menu)

Name

Description

selobjects

tasks

menu

Additional Information


FSCVAPP@1.1001:GetSessionInfo Permanent link for this heading

SessionInfo[] FSCVAPP@1.1001:GetSessionInfo(
  out retval SessionInfo[] all,
  out SessionInfo[] active,
  out SessionInfo[] inactive,
  optional boolean orderbyloginat,
  optional SessionType type,
  optional AuthMeth authmeth,
  optional string ipaddress,
  optional string sessionid,
  optional integer limit)

Name

Description

all

active

inactive

orderbyloginat

type

authmeth

ipaddress

sessionid

limit

Additional Information


FSCVAPP@1.1001:GetStrings Permanent link for this heading

string FSCVAPP@1.1001:GetStrings(
  string idents,
  out retval string strings)

Name

Description

idents

strings

Additional Information


FSCVAPP@1.1001:GetSupportContext Permanent link for this heading

Action to evaluate the support context for support requests

void FSCVAPP@1.1001:GetSupportContext(
  object container,
  object[] context,
  out string supportteamname,
  out string headerlogourl,
  out string headercolor,
  out string additionaldata)

Name

Description

container

The current container

context

The current context (usually the current breadcrumb)

supportteamname

The name of the responsible support team

headerlogourl

The URL to the header logo

headercolor

The color of the header (HEX)

additionaldata

Additional data for the support request

Additional Information


FSCVAPP@1.1001:GetSupportedListViews Permanent link for this heading

ListView[] FSCVAPP@1.1001:GetSupportedListViews(
  out retval ListView[] listviews)

Name

Description

listviews

Additional Information


FSCVAPP@1.1001:GetTheme Permanent link for this heading

Calculates the theme of an object.

object FSCVAPP@1.1001:GetTheme(
  out retval object theme)

Name

Description

theme

Additional Information


FSCVAPP@1.1001:GetUserAgent Permanent link for this heading

string FSCVAPP@1.1001:GetUserAgent(
  out retval string useragent,
  out dictionary info)

Name

Description

useragent

info

Additional Information


FSCVAPP@1.1001:GetValueView Permanent link for this heading

content FSCVAPP@1.1001:GetValueView(
  optional object dispatcher,
  optional object application,
  object attrdef,
  optional string controlid,
  optional string argument,
  any value,
  out retval content htmlcontent)

Name

Description

dispatcher

application

attrdef

controlid

argument

value

htmlcontent

Additional Information


FSCVAPP@1.1001:GetVAPPInformation Permanent link for this heading

dictionary FSCVAPP@1.1001:GetVAPPInformation(
  out retval dictionary information,
  optional boolean preventcontentread)

Name

Description

information

preventcontentread

Additional Information


FSCVAPP@1.1001:GetVersion Permanent link for this heading

string FSCVAPP@1.1001:GetVersion(
  out retval string version,
  optional string separator)

Name

Description

version

separator

Additional Information


FSCVAPP@1.1001:GetVisibleWidgetObjects Permanent link for this heading

Get the list of widget objects filtered to the restrictions performed by the user and persisted in user settings dictionary

object[] FSCVAPP@1.1001:GetVisibleWidgetObjects(
  out retval object[] widgets,
  optional object widgetcontainer,
  optional object widgetattrdef,
  optional boolean ordered)

Name

Description

widgets

the list of visible widgets

widgetcontainer

the object containing the widgets

widgetattrdef

the attribute definition describing the list containing the widgets

ordered

return the widgets as ordered by the user

Additional Information


FSCVAPP@1.1001:GetWidgetSettings Permanent link for this heading

Get the user settings dictionary containing information about the widgets (e.g. visibility, size, ...)

dictionary FSCVAPP@1.1001:GetWidgetSettings(
  out retval dictionary widgetsesttings,
  optional object widgetcontainer,
  optional object widgetattrdef)

Name

Description

widgetsesttings

the dictionary describing the widgets

widgetcontainer

the object containing the widgets

widgetattrdef

the attribute definition describing the list containing the widgets

Additional Information


FSCVAPP@1.1001:GroupLoginSessionSettingsGet Permanent link for this heading

Action for determining group login session settings

void FSCVAPP@1.1001:GroupLoginSessionSettingsGet(
  out GroupLoginSessionSettings grouploginsessionsettings)

Name

Description

grouploginsessionsettings

Group login session settings

Additional Information


FSCVAPP@1.1001:GroupNativeClientSettingsGet Permanent link for this heading

Action for determining group native client settings

void FSCVAPP@1.1001:GroupNativeClientSettingsGet(
  out GroupNativeClientSettings groupnativeclientsettings)

Name

Description

groupnativeclientsettings

Additional Information


FSCVAPP@1.1001:IsClientDebug Permanent link for this heading

void FSCVAPP@1.1001:IsClientDebug(
  out boolean isclientdebug)

Name

Description

isclientdebug

Additional Information


FSCVAPP@1.1001:IsColumnValueFilterEnabled Permanent link for this heading

Action to evaluate whether an attribute can be filtered in a list column with the help of a value filter

boolean FSCVAPP@1.1001:IsColumnValueFilterEnabled(
  out retval boolean isenabled)

Name

Description

isenabled

Additional Information


FSCVAPP@1.1001:IsInTimeTravel Permanent link for this heading

boolean FSCVAPP@1.1001:IsInTimeTravel(
  out retval boolean isintimetravel,
  out optional datetime pointintime)

Name

Description

isintimetravel

pointintime

Additional Information


FSCVAPP@1.1001:IsObjectAllowed Permanent link for this heading

void FSCVAPP@1.1001:IsObjectAllowed()

Additional Information


FSCVAPP@1.1001:IsPluginInstalled Permanent link for this heading

boolean FSCVAPP@1.1001:IsPluginInstalled(
  out retval boolean isplugininstalled)

Name

Description

isplugininstalled

Additional Information


FSCVAPP@1.1001:IsSearchableAttribute Permanent link for this heading

Action to evaluate whether an attribute is search able

boolean FSCVAPP@1.1001:IsSearchableAttribute(
  out retval boolean issearchable)

Name

Description

issearchable

The return value

Additional Information


FSCVAPP@1.1001:IsSupported Permanent link for this heading

boolean FSCVAPP@1.1001:IsSupported(
  Feature feature,
  out retval boolean issupported)

Name

Description

feature

issupported

Additional Information


FSCVAPP@1.1001:IsVAPP Permanent link for this heading

FOR INTERNAL USE. The current scope depth.

boolean FSCVAPP@1.1001:IsVAPP(
  out retval boolean isactive)

Name

Description

isactive

Additional Information


FSCVAPP@1.1001:IsVAPPUI Permanent link for this heading

boolean FSCVAPP@1.1001:IsVAPPUI(
  out retval boolean isvappui)

Name

Description

isvappui

Additional Information


FSCVAPP@1.1001:KeepAliveState Permanent link for this heading

Call to extend the lifetime on the state server

void FSCVAPP@1.1001:KeepAliveState(
  string statetoken)

Name

Description

statetoken

the state token

Additional Information


FSCVAPP@1.1001:LogError Permanent link for this heading

void FSCVAPP@1.1001:LogError(
  string errormsg)

Name

Description

errormsg

Additional Information


FSCVAPP@1.1001:Login Permanent link for this heading

User role property

void FSCVAPP@1.1001:Login(
  interface context,
  object application)

Name

Description

context

application

Additional Information


FSCVAPP@1.1001:MakeBreadcrumb Permanent link for this heading

Calculates a breadcrumb from the breadcrumbstring string input parameter.
It calculates the breadcrumb aggregate and writes the result into the transaction variable (TV_BREADCRUMB).

Breadcrumb[] FSCVAPP@1.1001:MakeBreadcrumb(
  string breadcrumbstring,
  out retval Breadcrumb[] breadcrumb)

Name

Description

breadcrumbstring

JSON defining the breadcrumb.
example: "{\"breadcrumb\":[{\"p$object\":\"COO.1.3285.1.1773\",\"p$view\":\"COO.1.1.1.333\",\"_\":\"Christina Baumann0001\"},{\"p$object\":\"COO.1.3285.3.137\",\"p$view\":\"COO.1.1001.1.324006\",\"_\":\"Test Teamroom\"}]}"

breadcrumb

A list of Breadcrumb entries.

Additional Information


FSCVAPP@1.1001:ObjectAccessTypesGet Permanent link for this heading

Create a component object for the first selected softrware component.

void FSCVAPP@1.1001:ObjectAccessTypesGet(
  ref object[] accesstypes,
  optional boolean isclass)

Name

Description

accesstypes

isclass

Additional Information


FSCVAPP@1.1001:PairedDeviceGetCACertificates Permanent link for this heading

Get list of CA certificates for device binding

object[] FSCVAPP@1.1001:PairedDeviceGetCACertificates(
  out retval object[] cacertificates)

Name

Description

cacertificates

list of certificates (Certificate)

Additional Information


FSCVAPP@1.1001:ParseFormData Permanent link for this heading

void FSCVAPP@1.1001:ParseFormData(
  interface piwsio,
  ref dictionary paramdict)

Name

Description

piwsio

paramdict

Additional Information


FSCVAPP@1.1001:PrepareStyleSheet Permanent link for this heading

Obsolete since 18.2.0 - theme colors are added via scss now

void FSCVAPP@1.1001:PrepareStyleSheet(
  string[] srcfiles,
  string dstpath,
  string swc)

Name

Description

srcfiles

dstpath

swc

Additional Information


FSCVAPP@1.1001:ProcessApplication Permanent link for this heading

void FSCVAPP@1.1001:ProcessApplication(
  interface context,
  optional object application,
  optional any parameters)

Name

Description

context

application

parameters

Additional Information


FSCVAPP@1.1001:ProcessLocal Permanent link for this heading

string FSCVAPP@1.1001:ProcessLocal(
  object application,
  optional string arguments,
  optional interface request,
  out retval string response,
  optional string contenttype)

Name

Description

application

arguments

request

response

contenttype

Additional Information


FSCVAPP@1.1001:ProcessRequest Permanent link for this heading

void FSCVAPP@1.1001:ProcessRequest(
  interface context)

Name

Description

context

Additional Information


FSCVAPP@1.1001:ProcessStep Permanent link for this heading

void FSCVAPP@1.1001:ProcessStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:ProcessWebDAVRequest Permanent link for this heading

void FSCVAPP@1.1001:ProcessWebDAVRequest(
  interface context,
  integer loginrc,
  string loginmsg)

Name

Description

context

loginrc

loginmsg

Additional Information


FSCVAPP@1.1001:QueryStep Permanent link for this heading

ApplicationStep QueryStep

void FSCVAPP@1.1001:QueryStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:QueueEvent Permanent link for this heading

Sends an event to another portal page or application. The events supported by a portal page are defined in the property pageevents.
In addition there are also some events that do not relate to particular portal pages:
  • Event OpenPortalTool (available in responsive UI only)
    Opens the tool passed in parameter arguments. The tool is identified by the address of the corresponding portal page. For a list of tools refer to property portaltools of DefPortal. Sample to open the tool for Teamroom branding:
    coouser.QueueEvent("OpenPortalTool", #PageBranding.GetAddress());
    By default the tool opened will be stored in the current user environment. If this should not be the case you may append "|1" to the arguments.
    Sample to open the tool for Teamroom branding but do not store this operation in the user environment:
    coouser.QueueEvent("OpenPortalTool", #PageBranding.GetAddress() + "|1");
  • Event ClosePortalTools (available in responsive UI only)
    Closes the tool currently shown.
    Sample:
    coouser.QueueEvent("ClosePortalTools");
  • Event NavigateTo (available in all application views with a bread crumb)
    Changes the current object shown (e.g. in the document view). You may send this event if the current object is no longer valid and another object should be shown instead (e.g. because the object is canceled or replaced by another one). This event is also used, when the current object in the document view is deleted by the user.
    • If the current object is deleted, navigate to the next or previous object if available, otherwise the parent folder is shown.
      coouser.QueueEvent("NavigateTo", "COO.1.1149.3.1372|deleted");
    • Navigate to a particular object (available in responsive UI only).
      coouser.QueueEvent("NavigateTo", "COO.1.1149.3.1372");
    • Navigate to a dedicated view inside a particular object (available in responsive UI only).
      coouser.QueueEvent("NavigateTo", "COO.1.1149.3.1372||COO.1.1001.1.223007");
    • Navigate to the next or previous object if available, otherwise the parent folder is shown (available in responsive UI only).
      coouser.QueueEvent("NavigateTo");

void FSCVAPP@1.1001:QueueEvent(
  string event,
  optional string arguments,
  optional boolean enablefocus,
  optional boolean refresh)

Name

Description

event

The name of the event sent. The event is sent to all portal pages that have registered for this event in the property pageevents.evtident.

arguments

The arguments passed to the event.

enablefocus

The portal page or application that handles this event will take the focus.

refresh

The portal page or application that handles this event will be refreshed.

Additional Information


FSCVAPP@1.1001:RaiseStep Permanent link for this heading

ApplicationStep RaiseStep

void FSCVAPP@1.1001:RaiseStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:ReadViewResults Permanent link for this heading

integer FSCVAPP@1.1001:ReadViewResults(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  dictionary parameters,
  dictionary branchparameters,
  object applicationview,
  out retval integer branchid)

Name

Description

context

dispatcher

application

applicationpath

applicationroot

parameters

branchparameters

applicationview

branchid

Additional Information


FSCVAPP@1.1001:RestoreStateTransaction Permanent link for this heading

Restores the transaction backup onto the transaction This action check whether a state server in use

void FSCVAPP@1.1001:RestoreStateTransaction(
  string transcationbackup)

Name

Description

transcationbackup

the serialized transaction

Additional Information


FSCVAPP@1.1001:RunApplication Permanent link for this heading

void FSCVAPP@1.1001:RunApplication(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVAPP@1.1001:ServiceStarted Permanent link for this heading

void FSCVAPP@1.1001:ServiceStarted()

Additional Information


FSCVAPP@1.1001:ServiceStopped Permanent link for this heading

void FSCVAPP@1.1001:ServiceStopped()

Additional Information


FSCVAPP@1.1001:SessionTerminate Permanent link for this heading

void FSCVAPP@1.1001:SessionTerminate(
  optional string logonuser,
  optional string idpsessionid,
  optional string fscsessionid)

Name

Description

logonuser

idpsessionid

fscsessionid

Additional Information


FSCVAPP@1.1001:SetAttributeStep Permanent link for this heading

ApplicationStep SetAttributeStep

void FSCVAPP@1.1001:SetAttributeStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:SetButtonBarMode Permanent link for this heading

void FSCVAPP@1.1001:SetButtonBarMode(
  boolean issimple)

Name

Description

issimple

Additional Information


FSCVAPP@1.1001:SetContext Permanent link for this heading

interface FSCVAPP@1.1001:SetContext(
  interface context,
  out retval interface oldcontext)

Name

Description

context

oldcontext

Additional Information


FSCVAPP@1.1001:SetErrorApplication Permanent link for this heading

void FSCVAPP@1.1001:SetErrorApplication(
  object application,
  dictionary parameters)

Name

Description

application

parameters

Additional Information


FSCVAPP@1.1001:SetLanguageHTML Permanent link for this heading

string FSCVAPP@1.1001:SetLanguageHTML(
  ref retval string str,
  optional boolean isattribute)

Name

Description

str

isattribute

Additional Information


FSCVAPP@1.1001:SetParameterStep Permanent link for this heading

ApplicationStep SetParameterStep

void FSCVAPP@1.1001:SetParameterStep(
  dictionary parameters,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot,
  integer pathdepth,
  EnterType entertype,
  ref LeaveType leavetype,
  Step[] step,
  interface context,
  integer scopedept)

Name

Description

parameters

dispatcher

application

applicationpath

applicationroot

pathdepth

entertype

leavetype

step

context

scopedept

Additional Information


FSCVAPP@1.1001:SetPostCommitUIParameters Permanent link for this heading

Provides the parameters to start an application when the current code finishes. The application associated to the action will be started with the object.
The parameter is the parameter dictionary when running that application.
Internally the PostCommitUI information is stored in the root dictionary with the key sys_postcommitui.
Every entry in this list triggers a separate application in a new transaction.
If there is an entry for a specific object/action SetPostCommitUIParameters will update the parameter dictionary. Otherwise a new aggregate with object/action/parameter will be appended to the PostCommitUI list.

void FSCVAPP@1.1001:SetPostCommitUIParameters(
  object object,
  object action,
  dictionary parameter)

Name

Description

object

Object on which the application will be started.

action

This action defines (due to an action/application mapping on an object class) which application will be started.

parameter

The parameter dictionary for the application to run. The values inside the dictionary have to match to the application to be started.

Additional Information


FSCVAPP@1.1001:SetSelection Permanent link for this heading

void FSCVAPP@1.1001:SetSelection(
  object view,
  optional object[] selobjects,
  optional boolean navigatetoview)

Name

Description

view

selobjects

navigatetoview

Additional Information


FSCVAPP@1.1001:SetSound Permanent link for this heading

void FSCVAPP@1.1001:SetSound(
  Sound sound)

Name

Description

sound

Additional Information


FSCVAPP@1.1001:ShowWelcomeScreen Permanent link for this heading

boolean FSCVAPP@1.1001:ShowWelcomeScreen(
  ref retval boolean show)

Name

Description

show

Additional Information


FSCVAPP@1.1001:Starting Permanent link for this heading

void FSCVAPP@1.1001:Starting(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot)

Name

Description

context

dispatcher

application

applicationpath

applicationroot

Additional Information


FSCVAPP@1.1001:StartUseCase Permanent link for this heading

void FSCVAPP@1.1001:StartUseCase(
  string usecasereference)

Name

Description

usecasereference

Additional Information


FSCVAPP@1.1001:Stopping Permanent link for this heading

void FSCVAPP@1.1001:Stopping(
  interface context,
  object dispatcher,
  object application,
  integer[] applicationpath,
  dictionary applicationroot)

Name

Description

context

dispatcher

application

applicationpath

applicationroot

Additional Information


FSCVAPP@1.1001:TransformToXml Permanent link for this heading

string FSCVAPP@1.1001:TransformToXml(
  object obj,
  object form,
  out retval string xml)

Name

Description

obj

form

xml

Additional Information


FSCVAPP@1.1001:UIGetPathValue Permanent link for this heading

any FSCVAPP@1.1001:UIGetPathValue(
  any root,
  Field[] fieldattr,
  integer[] fieldindx,
  out retval any value)

Name

Description

root

fieldattr

fieldindx

value

Additional Information


FSCVAPP@1.1001:UISetPathValue Permanent link for this heading

void FSCVAPP@1.1001:UISetPathValue(
  any root,
  Field[] fieldattr,
  integer[] fieldindx,
  any value,
  optional boolean replace)

Name

Description

root

fieldattr

fieldindx

value

replace

Additional Information


FSCVAPP@1.1001:UISort Permanent link for this heading

UISort delivers objects according to the settings set in ui

void FSCVAPP@1.1001:UISort(
  ref object[] objects,
  DisplayColumnList[] columns,
  optional object filter,
  optional string[] sortcolumns,
  optional object view,
  optional boolean usefilterkeyword,
  optional object filtercont)

Name

Description

objects

objects sorted and filtered

columns

current columns

filter

filter object used to filter the values

sortcolumns

columns defining the sort order and grouping

view

attribute definition where objects are contained

usefilterkeyword

use filterkeywords defined in columns for additional filtering

filtercont

container used for calling attruifilter action defined on view

Additional Information


FSCVAPP@1.1001:UISortIndex Permanent link for this heading

void FSCVAPP@1.1001:UISortIndex(
  ref object[] objects,
  out integer[] index,
  DisplayColumnList[] columns,
  optional object filter,
  optional string[] sortcolumns,
  optional object view,
  optional boolean usefilterkeyword,
  optional object filtercont)

Name

Description

objects

index

columns

filter

sortcolumns

view

usefilterkeyword

filtercont

Additional Information


FSCVAPP@1.1001:UpdateExportKey Permanent link for this heading

string FSCVAPP@1.1001:UpdateExportKey(
  string exportid,
  datetime exporttime,
  out retval string newexportid)

Name

Description

exportid

exporttime

newexportid

Additional Information


FSCVAPP@1.1001:UpdateImportKey Permanent link for this heading

string FSCVAPP@1.1001:UpdateImportKey(
  string importid,
  datetime importtime,
  out retval string newimportid)

Name

Description

importid

importtime

newimportid

Additional Information


FSCVAPP@1.1001:UsePDFViewer Permanent link for this heading

Action to determine the usage of a PDF Viewer for a specific object class. obsolete since 20.2.0: look at VAPPdefaultpdfcontrol.defaultpdfcontrol

boolean FSCVAPP@1.1001:UsePDFViewer(
  out retval boolean usepdfjs)

Name

Description

usepdfjs

Additional Information


FSCVAPP@1.1001:UseVAppsOnMobileClients Permanent link for this heading

This method is used as interface. Will be overridden by FSCMOBILEAPPS@1.1001 with actual implementation. Actual implementation will evaluate a customization point from FSCMOBILEAPPS@1.1001 to determine if Virtual Applications should be executed on mobile clients (e.g.: Android or iOS Apps)

boolean FSCVAPP@1.1001:UseVAppsOnMobileClients(
  out retval boolean usevappsonmobile)

Name

Description

usevappsonmobile

when true, the mobile client should run vApps.

Additional Information


FSCVAPP@1.1001:ValidateSamlMetadata Permanent link for this heading

boolean FSCVAPP@1.1001:ValidateSamlMetadata(
  out retval boolean valid,
  content metadata,
  out optional string entityid,
  out optional datetime validuntil,
  out optional string[] errors)

Name

Description

valid

metadata

entityid

validuntil

errors

Additional Information