Return Type |
Signature |
Abort() |
|
AddHeaderValue( |
|
AddJavaScript( |
|
AddLocalObjects( |
|
AttrApplyToGetDisp( |
|
AttrGetDictSelDisp( |
|
AttrGetUDMasterGroup( |
|
AttrRelatedGet( |
|
AttrRelatedSet( |
|
BackupStateTransaction( |
|
CacheClear( |
|
CallAppStep( |
|
CallStep( |
|
CleanupState( |
|
CollectRibbonConfig( |
|
Commit() |
|
CommitRoot( |
|
CommitStep( |
|
CompressWebContent( |
|
ExecInService( |
|
Explain( |
|
ExplainBranch( |
|
ExploreNode( |
|
FilterDisplayElement( |
|
FilterObjectListForDisplay( |
|
FilterObjectStateDisplay( |
|
GenerateView( |
|
GetActivity( |
|
GetActivityEstimation( |
|
GetAggregationMenu( |
|
GetAppFeedbackButton( |
|
GetApplication( |
|
GetAvailableThemes( |
|
GetBranches( |
|
GetBreadcrumbObjectName( |
|
GetButtonBarMode( |
|
GetContext( |
|
GetCSPHeader( |
|
GetCustomizedControlsExternal( |
|
GetCustomizedControlsObject( |
|
GetCustomizedControlsOpen( |
|
GetDispatcher( |
|
GetDisplayEffectColors( |
|
GetFormAttributes( |
|
GetFormBasedLoginSettings( |
|
GetFormPageAttributes( |
|
GetFormViews( |
|
GetGlobalTasks( |
|
GetHeaderValue( |
|
GetHelpRoot( |
|
GetHTML( |
|
GetImportLimit( |
|
GetImportLimitMax( |
|
GetLanguage( |
|
GetMenu( |
|
GetObjectActivity( |
|
GetObjectContext( |
|
GetObjectInfo( |
|
GetObjectStateDisplay( |
|
GetObjectStateDisplayCached( |
|
GetPath( |
|
GetPluginInfo( |
|
GetPortalTheme( |
|
GetPostCommitUIParameters( |
|
GetPublicActionsHtml( |
|
GetPublicPageNotFound( |
|
GetQueryColumns( |
|
GetSelDependentTasks( |
|
GetSessionInfo( |
|
GetStrings( |
|
GetSupportContext( |
|
GetSupportedListViews( |
|
GetUserAgent( |
|
GetValueView( |
|
GetVAPPInformation( |
|
GetVersion( |
|
GetVisibleWidgetObjects( |
|
GetWidgetSettings( |
|
GroupLoginSessionSettingsGet( |
|
GroupNativeClientSettingsGet( |
|
IsClientDebug( |
|
IsColumnValueFilterEnabled( |
|
IsInTimeTravel( |
|
IsPluginInstalled( |
|
IsSearchableAttribute( |
|
IsSupported( |
|
KeepAliveState( |
|
MakeBreadcrumb( |
|
ObjectAccessTypesGet( |
|
PairedDeviceGetCACertificates( |
|
ParseFormData( |
|
PrepareStyleSheet( |
|
ProcessApplication( |
|
ProcessLocal( |
|
ProcessRequest( |
|
ProcessStep( |
|
ProcessWebDAVRequest( |
|
QueryStep( |
|
QueueEvent( |
|
RaiseStep( |
|
ReadViewResults( |
|
RestoreStateTransaction( |
|
RunApplication( |
|
SessionTerminate( |
|
SetAttributeStep( |
|
SetButtonBarMode( |
|
SetContext( |
|
SetErrorApplication( |
|
SetLanguageHTML( |
|
SetParameterStep( |
|
SetPostCommitUIParameters( |
|
SetSelection( |
|
ShowWelcomeScreen( |
|
Starting( |
|
StartUseCase( |
|
Stopping( |
|
TransformToXml( |
|
UIGetPathValue( |
|
UISetPathValue( |
|
UISort( |
|
UISortIndex( |
|
UpdateExportKey( |
|
UpdateImportKey( |
|
UsePDFViewer( |
|
UseVAppsOnMobileClients( |
|
ValidateSamlMetadata( |
void FSCVAPP@1.1001:Abort()
Additional Information
void FSCVAPP@1.1001:AbortRoot()
Additional Information
void
FSCVAPP@1.1001:AddHeaderValue(
string
name,
string
value)
Name |
Description |
name |
|
value |
Additional Information
parameters
.<%[escape:javascript] value %>
: used if the value should be
used in a JavaScript string (escapes quotes, backslash, CR/LF, <, >)<%[escape:jsstring+xml] value %>
: similar to rule
"javascript", but & is escaped, too<%[escape:xml] value %>
: used if the value should be used as
HTML (escapes only &, ", <, > as character entities)<%[escape:base64] value %>
: used if the value should be
encoded to base64<%[escape:base16] value %>
: used if the value should be
encoded to base16
...
string myobjnamestring = cooobj.objname;
...
coouser.AddJavaScript(#MyJavascriptComonentObject, this);
(function() {
var teststring = '<%[escape:javascript]myobjnamestring%>';
var teststringbase64 = '<%[escape:base64]myobjnamestring%%>';
...
alert(teststring);
...
document.getElementById("myNameElement").innerHTML =
"<div%><%[escape:javascript]coouser.EscapeHTML(myobjnamestring)%%></div%>";
})();
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
void
FSCVAPP@1.1001:AddLocalObjects(
object[]
objects)
Name |
Description |
objects |
Additional Information
FSCVAPP@1.1001:AttrApplyToGetDisp
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
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
object
FSCVAPP@1.1001:AttrGetUDMasterGroup(
out retval object
mastergroup)
Name |
Description |
mastergroup |
user data master group
|
Additional Information
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
void
FSCVAPP@1.1001:AttrRelatedSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
FSCVAPP@1.1001:BackupStateTransaction
string
FSCVAPP@1.1001:BackupStateTransaction(
out retval string
transcationbackup)
Name |
Description |
transcationbackup |
the serialized transaction
|
Additional Information
void
FSCVAPP@1.1001:CacheClear(
optional boolean
prepare)
Name |
Description |
prepare |
Additional Information
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
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
void
FSCVAPP@1.1001:CleanupState(
string
statetoken)
Name |
Description |
statetoken |
the state token
|
Additional Information
FSCVAPP@1.1001:CollectRibbonConfig
void
FSCVAPP@1.1001:CollectRibbonConfig(
ref dictionary
tpconfigvaluedict)
Name |
Description |
tpconfigvaluedict |
Additional Information
void FSCVAPP@1.1001:Commit()
Additional Information
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
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
void
FSCVAPP@1.1001:CompressWebContent(
string
input,
string
output)
Name |
Description |
input |
|
output |
Additional Information
void FSCVAPP@1.1001:EndTimeTravel()
Additional Information
void
FSCVAPP@1.1001:ExecInService(
ref dictionary
applictionroot)
Name |
Description |
applictionroot |
Additional Information
void
FSCVAPP@1.1001:Explain(
object[]
attrpath,
ref Explanation[]
explanations)
Name |
Description |
attrpath |
|
explanations |
Additional Information
void
FSCVAPP@1.1001:ExplainBranch(
Branch[]
branchobj,
ref Explanation[]
explanations)
Name |
Description |
branchobj |
|
explanations |
Additional Information
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
void
FSCVAPP@1.1001:FilterDisplayElement(
ref string
displaytext)
Name |
Description |
displaytext |
Additional Information
FSCVAPP@1.1001:FilterObjectListForDisplay
object[]
FSCVAPP@1.1001:FilterObjectListForDisplay(
ref retval object[]
objects,
object
parent,
object
view)
Name |
Description |
objects |
|
parent |
|
view |
Additional Information
FSCVAPP@1.1001:FilterObjectStateDisplay
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
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
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
objects
.
The Activity list returned in parameter activities
will only contain values for member actobject.quickcheck
is true an approximate estimation should be done since performance is relevant.
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
dictionary
FSCVAPP@1.1001:GetAggregationMenu(
object[]
aggregations,
out retval dictionary
menudict)
Name |
Description |
aggregations |
|
menudict |
Additional Information
FSCVAPP@1.1001:GetAppFeedbackButton
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
object
FSCVAPP@1.1001:GetApplication(
object
action,
out retval object
application)
Name |
Description |
action |
|
application |
Additional Information
FSCVAPP@1.1001:GetAvailableThemes
object[]
FSCVAPP@1.1001:GetAvailableThemes(
out retval object[]
themes)
Name |
Description |
themes |
Additional Information
void
FSCVAPP@1.1001:GetBranches(
object
appview,
ref OptionalBranches[]
branches)
Name |
Description |
appview |
|
branches |
Additional Information
FSCVAPP@1.1001:GetBreadcrumbObjectName
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
boolean
FSCVAPP@1.1001:GetButtonBarMode(
out retval boolean
issimple)
Name |
Description |
issimple |
Additional Information
interface
FSCVAPP@1.1001:GetContext(
out retval interface
context)
Name |
Description |
context |
Additional Information
directive
.
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
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
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
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
Device
FSCVAPP@1.1001:GetDevice(
out retval Device
device)
Name |
Description |
device |
Additional Information
object
FSCVAPP@1.1001:GetDispatcher(
out retval object
dispatcher)
Name |
Description |
dispatcher |
Additional Information
FSCVAPP@1.1001:GetDisplayEffectColors
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
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
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
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
object[]
FSCVAPP@1.1001:GetFormViews(
out retval object[]
formviews)
Name |
Description |
formviews |
Additional Information
void
FSCVAPP@1.1001:GetGlobalTasks(
object[]
selobjects,
ref object[]
tasks,
object
menu)
Name |
Description |
selobjects |
|
tasks |
|
menu |
Additional Information
string
FSCVAPP@1.1001:GetHeaderValue(
string
name,
out retval string
value)
Name |
Description |
name |
|
value |
Additional Information
void
FSCVAPP@1.1001:GetHelpRoot(
object
appview,
ref object
helproot)
Name |
Description |
appview |
|
helproot |
Additional Information
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
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
void
FSCVAPP@1.1001:GetImportLimitMax(
ref integer
maxcontsize)
Name |
Description |
maxcontsize |
Additional Information
object
FSCVAPP@1.1001:GetLanguage(
string
langstring,
out retval object
language)
Name |
Description |
langstring |
|
language |
Additional Information
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
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
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
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
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
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
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
string
FSCVAPP@1.1001:GetPluginInfo(
string
key,
out retval string
parameters)
Name |
Description |
key |
|
parameters |
Additional Information
object
FSCVAPP@1.1001:GetPortalTheme(
out retval object
theme)
Name |
Description |
theme |
Additional Information
FSCVAPP@1.1001:GetPostCommitUIParameters
action
will be started with the object
.parameter
is the parameter dictionary when running that
application.sys_postcommitui
.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
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
void
FSCVAPP@1.1001:GetPublicPageNotFound(
out string
html)
Name |
Description |
html |
Additional Information
FSCVAPP@1.1001:GetQueryColumns
DisplayViewList[]
FSCVAPP@1.1001:GetQueryColumns(
string
query,
out retval DisplayViewList[]
displayviewlist)
Name |
Description |
query |
|
displayviewlist |
Additional Information
FSCVAPP@1.1001:GetSelDependentTasks
void
FSCVAPP@1.1001:GetSelDependentTasks(
object[]
selobjects,
ref object[]
tasks,
object
menu)
Name |
Description |
selobjects |
|
tasks |
|
menu |
Additional Information
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
string
FSCVAPP@1.1001:GetStrings(
string
idents,
out retval string
strings)
Name |
Description |
idents |
|
strings |
Additional Information
FSCVAPP@1.1001:GetSupportContext
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
ListView[]
FSCVAPP@1.1001:GetSupportedListViews(
out retval ListView[]
listviews)
Name |
Description |
listviews |
Additional Information
object
FSCVAPP@1.1001:GetTheme(
out retval object
theme)
Name |
Description |
theme |
Additional Information
string
FSCVAPP@1.1001:GetUserAgent(
out retval string
useragent,
out dictionary
info)
Name |
Description |
useragent |
|
info |
Additional Information
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
dictionary
FSCVAPP@1.1001:GetVAPPInformation(
out retval dictionary
information,
optional boolean
preventcontentread)
Name |
Description |
information |
|
preventcontentread |
Additional Information
string
FSCVAPP@1.1001:GetVersion(
out retval string
version,
optional string
separator)
Name |
Description |
version |
|
separator |
Additional Information
FSCVAPP@1.1001:GetVisibleWidgetObjects
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
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
void
FSCVAPP@1.1001:GroupLoginSessionSettingsGet(
out GroupLoginSessionSettings
grouploginsessionsettings)
Name |
Description |
grouploginsessionsettings |
Group login session settings
|
Additional Information
FSCVAPP@1.1001:GroupNativeClientSettingsGet
void
FSCVAPP@1.1001:GroupNativeClientSettingsGet(
out GroupNativeClientSettings
groupnativeclientsettings)
Name |
Description |
groupnativeclientsettings |
Additional Information
void
FSCVAPP@1.1001:IsClientDebug(
out boolean
isclientdebug)
Name |
Description |
isclientdebug |
Additional Information
FSCVAPP@1.1001:IsColumnValueFilterEnabled
boolean
FSCVAPP@1.1001:IsColumnValueFilterEnabled(
out retval boolean
isenabled)
Name |
Description |
isenabled |
Additional Information
boolean
FSCVAPP@1.1001:IsInTimeTravel(
out retval boolean
isintimetravel,
out optional datetime
pointintime)
Name |
Description |
isintimetravel |
|
pointintime |
Additional Information
FSCVAPP@1.1001:IsObjectAllowed
void FSCVAPP@1.1001:IsObjectAllowed()
Additional Information
FSCVAPP@1.1001:IsPluginInstalled
boolean
FSCVAPP@1.1001:IsPluginInstalled(
out retval boolean
isplugininstalled)
Name |
Description |
isplugininstalled |
Additional Information
FSCVAPP@1.1001:IsSearchableAttribute
boolean
FSCVAPP@1.1001:IsSearchableAttribute(
out retval boolean
issearchable)
Name |
Description |
issearchable |
The return value
|
Additional Information
boolean
FSCVAPP@1.1001:IsSupported(
Feature
feature,
out retval boolean
issupported)
Name |
Description |
feature |
|
issupported |
Additional Information
boolean
FSCVAPP@1.1001:IsVAPP(
out retval boolean
isactive)
Name |
Description |
isactive |
Additional Information
boolean
FSCVAPP@1.1001:IsVAPPUI(
out retval boolean
isvappui)
Name |
Description |
isvappui |
Additional Information
void
FSCVAPP@1.1001:KeepAliveState(
string
statetoken)
Name |
Description |
statetoken |
the state token
|
Additional Information
void
FSCVAPP@1.1001:LogError(
string
errormsg)
Name |
Description |
errormsg |
Additional Information
void
FSCVAPP@1.1001:Login(
interface
context,
object
application)
Name |
Description |
context |
|
application |
Additional Information
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
void
FSCVAPP@1.1001:ObjectAccessTypesGet(
ref object[]
accesstypes,
optional boolean
isclass)
Name |
Description |
accesstypes |
|
isclass |
Additional Information
FSCVAPP@1.1001:PairedDeviceGetCACertificates
object[]
FSCVAPP@1.1001:PairedDeviceGetCACertificates(
out retval object[]
cacertificates)
Name |
Description |
cacertificates |
list of certificates (Certificate)
|
Additional Information
void
FSCVAPP@1.1001:ParseFormData(
interface
piwsio,
ref dictionary
paramdict)
Name |
Description |
piwsio |
|
paramdict |
Additional Information
FSCVAPP@1.1001:PrepareStyleSheet
void
FSCVAPP@1.1001:PrepareStyleSheet(
string[]
srcfiles,
string
dstpath,
string
swc)
Name |
Description |
srcfiles |
|
dstpath |
|
swc |
Additional Information
FSCVAPP@1.1001:ProcessApplication
void
FSCVAPP@1.1001:ProcessApplication(
interface
context,
optional object
application,
optional any
parameters)
Name |
Description |
context |
|
application |
|
parameters |
Additional Information
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
void
FSCVAPP@1.1001:ProcessRequest(
interface
context)
Name |
Description |
context |
Additional Information
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
void
FSCVAPP@1.1001:ProcessWebDAVRequest(
interface
context,
integer
loginrc,
string
loginmsg)
Name |
Description |
context |
|
loginrc |
|
loginmsg |
Additional Information
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
pageevents
.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());
coouser.QueueEvent("OpenPortalTool",
#PageBranding.GetAddress() + "|1");
coouser.QueueEvent("ClosePortalTools");
coouser.QueueEvent("NavigateTo",
"COO.1.1149.3.1372|deleted");
coouser.QueueEvent("NavigateTo",
"COO.1.1149.3.1372");
coouser.QueueEvent("NavigateTo",
"COO.1.1149.3.1372||COO.1.1001.1.223007");
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
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
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
void
FSCVAPP@1.1001:RestoreStateTransaction(
string
transcationbackup)
Name |
Description |
transcationbackup |
the serialized transaction
|
Additional Information
void
FSCVAPP@1.1001:RunApplication(
optional integer
unused1,
optional integer
unused2)
Name |
Description |
unused1 |
|
unused2 |
Additional Information
void FSCVAPP@1.1001:ServiceStarted()
Additional Information
void FSCVAPP@1.1001:ServiceStopped()
Additional Information
FSCVAPP@1.1001:SessionTerminate
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
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
void
FSCVAPP@1.1001:SetButtonBarMode(
boolean
issimple)
Name |
Description |
issimple |
Additional Information
interface
FSCVAPP@1.1001:SetContext(
interface
context,
out retval interface
oldcontext)
Name |
Description |
context |
|
oldcontext |
Additional Information
FSCVAPP@1.1001:SetErrorApplication
void
FSCVAPP@1.1001:SetErrorApplication(
object
application,
dictionary
parameters)
Name |
Description |
application |
|
parameters |
Additional Information
FSCVAPP@1.1001:SetLanguageHTML
string
FSCVAPP@1.1001:SetLanguageHTML(
ref retval string
str,
optional boolean
isattribute)
Name |
Description |
str |
|
isattribute |
Additional Information
FSCVAPP@1.1001: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
action
will be started with the
object
.parameter
is the parameter dictionary when running that
application.sys_postcommitui
.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
void
FSCVAPP@1.1001:SetSelection(
object
view,
optional object[]
selobjects,
optional boolean
navigatetoview)
Name |
Description |
view |
|
selobjects |
|
navigatetoview |
Additional Information
void
FSCVAPP@1.1001:SetSound(
Sound
sound)
Name |
Description |
sound |
Additional Information
FSCVAPP@1.1001:ShowWelcomeScreen
boolean
FSCVAPP@1.1001:ShowWelcomeScreen(
ref retval boolean
show)
Name |
Description |
show |
Additional Information
void
FSCVAPP@1.1001:Starting(
interface
context,
object
dispatcher,
object
application,
integer[]
applicationpath,
dictionary
applicationroot)
Name |
Description |
context |
|
dispatcher |
|
application |
|
applicationpath |
|
applicationroot |
Additional Information
void
FSCVAPP@1.1001:StartUseCase(
string
usecasereference)
Name |
Description |
usecasereference |
Additional Information
void
FSCVAPP@1.1001:Stopping(
interface
context,
object
dispatcher,
object
application,
integer[]
applicationpath,
dictionary
applicationroot)
Name |
Description |
context |
|
dispatcher |
|
application |
|
applicationpath |
|
applicationroot |
Additional Information
string
FSCVAPP@1.1001:TransformToXml(
object
obj,
object
form,
out retval string
xml)
Name |
Description |
obj |
|
form |
|
xml |
Additional Information
any
FSCVAPP@1.1001:UIGetPathValue(
any
root,
Field[]
fieldattr,
integer[]
fieldindx,
out retval any
value)
Name |
Description |
root |
|
fieldattr |
|
fieldindx |
|
value |
Additional Information
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
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
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
string
FSCVAPP@1.1001:UpdateExportKey(
string
exportid,
datetime
exporttime,
out retval string
newexportid)
Name |
Description |
exportid |
|
exporttime |
|
newexportid |
Additional Information
FSCVAPP@1.1001:UpdateImportKey
string
FSCVAPP@1.1001:UpdateImportKey(
string
importid,
datetime
importtime,
out retval string
newimportid)
Name |
Description |
importid |
|
importtime |
|
newimportid |
Additional Information
boolean
FSCVAPP@1.1001:UsePDFViewer(
out retval boolean
usepdfjs)
Name |
Description |
usepdfjs |
Additional Information
FSCVAPP@1.1001:UseVAppsOnMobileClients
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
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