2022 June Release

Actions of FSCVPORT@1.1001 Permanent link for this heading

Return Type

Signature

void

AddObjectToPortal()

void

AddSelectedObjectsToPortal(
  object sys_object,
  object sys_action,
  object sys_view,
  object[] sys_selobjects,
  integer[] sys_selindices,
  optional string sys_dynkey,
  optional any sys_branchattr,
  optional any sys_branchindex)

void

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

void

CreatePortalEntry(
  out object portalentry)

void

FillUserRoleSettings(
  ref UserRole[] userroles,
  ref object[] clientdomains,
  ref object[] userenvironments,
  ref object[] userprofiles,
  out integer substrolecnt)

void

FilterPortalSymbol(
  object image,
  out boolean isvalid)

void

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

object[]

GetFavorites(
  out retval object[] favorites,
  optional boolean dorefresh,
  optional boolean includedisabled)

string

GetLogoPath(
  out retval string logopath,
  optional LogoType type,
  out Content logo,
  out object source)

void

GetOptionsMenu(
  string arguments,
  out string menuref)

void

GetPersonalizedAttr(
  out string name,
  out object icon,
  out object theme)

string

GetPublicLogoPath(
  string tokenpath,
  out retval string logopath,
  optional LogoType type,
  out object source)

void

GetRoleMenu(
  out string menuref)

string

GetUserDisplayName(
  ref retval string displayname)

void

GetUserRoleGroupName(
  object group,
  out string name)

void

GetUserRoleInformation(
  out string displayname,
  out string substitutionstr,
  out string positioninfostr,
  out string domainstr,
  out optional object currentposition,
  out optional object currentgroup,
  out optional object currentsubstitution,
  out optional object currentenvironment,
  out optional object currentdomain)

void

GetUserRoleSymbol(
  UserRoleList[] userrole,
  ref boolean usepersimage,
  out string location)

void

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

Content

LogoFriendlyURL(
  string address,
  out retval Content logo,
  optional LogoType type)

Content

LogoPublicURL(
  out retval Content logo,
  optional LogoType type)

void

PortalSettingsAddTab(
  integer position,
  out PortalPart[] portalpart)

void

PortalSettingsEdit(
  integer operation,
  optional integer position)

void

PortalSettingsGet(
  ref object portal,
  out PortalPart[] portalparts)

object

ResetPersonalizedPortal(
  out retval object theme)

void

SaveCurrentTool(
  object newtool,
  object oldtool,
  boolean minimize,
  optional object currobj,
  optional integer width,
  optional object additionaltool,
  optional object additionalkey)

void

SetPersonalizedAttr(
  string name,
  object icon,
  out object theme)

void

SetPortalEntryWidth(
  string args)

void

SetUserRole(
  ref string returnurl,
  optional UserRole[] userrole,
  optional object userdomain,
  optional object userenv,
  optional object userprofile)

void

UpdateMinimized(
  string args)

void

UpdateOverlays(
  string arguments,
  out string result)

void

UserRoleSettingsHook()

void

UserRoleSymbolHook()


FSCVPORT@1.1001:AddObjectToPortal Permanent link for this heading

void FSCVPORT@1.1001:AddObjectToPortal()

Additional Information


FSCVPORT@1.1001:AddSelectedObjectsToPortal Permanent link for this heading

void FSCVPORT@1.1001:AddSelectedObjectsToPortal(
  object sys_object,
  object sys_action,
  object sys_view,
  object[] sys_selobjects,
  integer[] sys_selindices,
  optional string sys_dynkey,
  optional any sys_branchattr,
  optional any sys_branchindex)

Name

Description

sys_object

sys_action

sys_view

sys_selobjects

sys_selindices

sys_dynkey

sys_branchattr

sys_branchindex

Additional Information


FSCVPORT@1.1001:AttrPortalPartsSet Permanent link for this heading

void FSCVPORT@1.1001:AttrPortalPartsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCVPORT@1.1001:CreatePortalEntry Permanent link for this heading

void FSCVPORT@1.1001:CreatePortalEntry(
  out object portalentry)

Name

Description

portalentry

Additional Information


FSCVPORT@1.1001:FillUserRoleSettings Permanent link for this heading

void FSCVPORT@1.1001:FillUserRoleSettings(
  ref UserRole[] userroles,
  ref object[] clientdomains,
  ref object[] userenvironments,
  ref object[] userprofiles,
  out integer substrolecnt)

Name

Description

userroles

clientdomains

userenvironments

userprofiles

substrolecnt

Additional Information


FSCVPORT@1.1001:FilterPortalSymbol Permanent link for this heading

Filter available symbols for portal parts.

void FSCVPORT@1.1001:FilterPortalSymbol(
  object image,
  out boolean isvalid)

Name

Description

image

isvalid

Additional Information


FSCVPORT@1.1001:GetAddToPortalMenu Permanent link for this heading

void FSCVPORT@1.1001:GetAddToPortalMenu(
  optional integer unused1,
  optional integer unused2,
  ref MenuStructList[] menuentries,
  optional object menu,
  optional object[] selobjects,
  out optional boolean addchildren)

Name

Description

unused1

unused2

menuentries

menu

selobjects

addchildren

Additional Information


FSCVPORT@1.1001:GetFavorites Permanent link for this heading

Obsolete implementation for GetFavorites Use GetFavorites instead

object[] FSCVPORT@1.1001:GetFavorites(
  out retval object[] favorites,
  optional boolean dorefresh,
  optional boolean includedisabled)

Name

Description

favorites

dorefresh

includedisabled

Additional Information


FSCVPORT@1.1001:GetLogoPath Permanent link for this heading

Returns a relative path to the logo of the current object. This path may be used in a src property of an IMG tag. In addition to the path the method provides also the image content.
This method will call GetLogo to retrieve the logo and builds a path that uses the friendly URL "logo" (see LogoFriendlyURL).

string FSCVPORT@1.1001:GetLogoPath(
  out retval string logopath,
  optional LogoType type,
  out Content logo,
  out object source)

Name

Description

logopath

A relative path for the logo. This may be used e.g. in a src property of an IMG tag.

type

The type of logo.

logo

The logo image as content.

source

The source object of the logo

Additional Information


FSCVPORT@1.1001:GetOptionsMenu Permanent link for this heading

void FSCVPORT@1.1001:GetOptionsMenu(
  string arguments,
  out string menuref)

Name

Description

arguments

menuref

Additional Information


FSCVPORT@1.1001:GetPersonalizedAttr Permanent link for this heading

Get portal parts.
If personalized is true the personalized view (delta) to the portal is given back.

void FSCVPORT@1.1001:GetPersonalizedAttr(
  out string name,
  out object icon,
  out object theme)

Name

Description

name

icon

theme

Additional Information


FSCVPORT@1.1001:GetPublicLogoPath Permanent link for this heading

Returns a path to the logo of the current object. This path will be used on public link pages. The path will be added to the end of the tokenpath. In addition to the path the methods provides also the image content. This method will call GetLogo to retrieve the logo and builds a path that uses the public friendly URL "logo" (see LogoPublicURL).

string FSCVPORT@1.1001:GetPublicLogoPath(
  string tokenpath,
  out retval string logopath,
  optional LogoType type,
  out object source)

Name

Description

tokenpath

The path of the public link.

logopath

The tokenpath extended by the path for the logo. This may be used e.g. in a src property of an IMG tag.

type

The type of logo.

source

The source object of the logo

Additional Information


FSCVPORT@1.1001:GetRoleMenu Permanent link for this heading

void FSCVPORT@1.1001:GetRoleMenu(
  out string menuref)

Name

Description

menuref

Additional Information


FSCVPORT@1.1001:GetUserDisplayName Permanent link for this heading

Action that calculates the display string representing the user name inside the account menu in the top bar.

string FSCVPORT@1.1001:GetUserDisplayName(
  ref retval string displayname)

Name

Description

displayname

The display string representing the user name.

Additional Information


FSCVPORT@1.1001:GetUserRoleGroupName Permanent link for this heading

void FSCVPORT@1.1001:GetUserRoleGroupName(
  object group,
  out string name)

Name

Description

group

name

Additional Information


FSCVPORT@1.1001:GetUserRoleInformation Permanent link for this heading

Calculates the user role information strings displayed in the top area of the portal control

void FSCVPORT@1.1001:GetUserRoleInformation(
  out string displayname,
  out string substitutionstr,
  out string positioninfostr,
  out string domainstr,
  out optional object currentposition,
  out optional object currentgroup,
  out optional object currentsubstitution,
  out optional object currentenvironment,
  out optional object currentdomain)

Name

Description

displayname

name of the user

substitutionstr

user substitution string

positioninfostr

user position string containing position and group of the user

domainstr

name of the current domain (displayed only if domains are defined at user)

currentposition

the position of the current role of the current user

currentgroup

the group of the current role of the current user

currentsubstitution

the substitution user of the current role of the current user

currentenvironment

the current environment of the current user

currentdomain

the current domain

Additional Information


FSCVPORT@1.1001:GetUserRoleSymbol Permanent link for this heading

void FSCVPORT@1.1001:GetUserRoleSymbol(
  UserRoleList[] userrole,
  ref boolean usepersimage,
  out string location)

Name

Description

userrole

usepersimage

location

Additional Information


FSCVPORT@1.1001:GetUsrEnvPortal Permanent link for this heading

Getter for usrenvportal

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

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCVPORT@1.1001:LogoFriendlyURL Permanent link for this heading

Action that resolves the content for the friendly URL "logo". The logo is determined by GetLogo.

Content FSCVPORT@1.1001:LogoFriendlyURL(
  string address,
  out retval Content logo,
  optional LogoType type)

Name

Description

address

If set the logo is returned from the object with this address. Otherwise the logo is retrieved from the current object.

logo

The logo as content. This content will be returned by the friendly URL.

type

The type of logo that should be returned.

Additional Information


FSCVPORT@1.1001:LogoPublicURL Permanent link for this heading

Action that resolves the content for the friendly URL "logo" in case of the public link page. The logo is determined by GetLogo.

Content FSCVPORT@1.1001:LogoPublicURL(
  out retval Content logo,
  optional LogoType type)

Name

Description

logo

The logo as content. This content will be returned by the friendly URL.

type

The type of logo that should be returned.

Additional Information


FSCVPORT@1.1001:PortalSettingsAddTab Permanent link for this heading

Add a pane to the portal.

void FSCVPORT@1.1001:PortalSettingsAddTab(
  integer position,
  out PortalPart[] portalpart)

Name

Description

position

portalpart

Additional Information


FSCVPORT@1.1001:PortalSettingsEdit Permanent link for this heading

Edit a portal

void FSCVPORT@1.1001:PortalSettingsEdit(
  integer operation,
  optional integer position)

Name

Description

operation

0... DEL, 1... MOVE, 2.. REFRESH

position

Defines the new position. Is only required when operation is 1 (MOVE)

Additional Information


FSCVPORT@1.1001:PortalSettingsGet Permanent link for this heading

Get a portal

void FSCVPORT@1.1001:PortalSettingsGet(
  ref object portal,
  out PortalPart[] portalparts)

Name

Description

portal

portalparts

Additional Information


FSCVPORT@1.1001:ResetPersonalizedPortal Permanent link for this heading

Resets the personalized portal.
The personalized data (delta) will be deleted.

object FSCVPORT@1.1001:ResetPersonalizedPortal(
  out retval object theme)

Name

Description

theme

Additional Information


FSCVPORT@1.1001:SaveCurrentTool Permanent link for this heading

void FSCVPORT@1.1001:SaveCurrentTool(
  object newtool,
  object oldtool,
  boolean minimize,
  optional object currobj,
  optional integer width,
  optional object additionaltool,
  optional object additionalkey)

Name

Description

newtool

oldtool

minimize

currobj

width

additionaltool

additionalkey

Additional Information


FSCVPORT@1.1001:SetPersonalizedAttr Permanent link for this heading

Decide whether to save the changes as personalized extension, or as change to the original portal.

void FSCVPORT@1.1001:SetPersonalizedAttr(
  string name,
  object icon,
  out object theme)

Name

Description

name

icon

theme

Additional Information


FSCVPORT@1.1001:SetPortalEntryWidth Permanent link for this heading

void FSCVPORT@1.1001:SetPortalEntryWidth(
  string args)

Name

Description

args

Additional Information


FSCVPORT@1.1001:SetUserRole Permanent link for this heading

void FSCVPORT@1.1001:SetUserRole(
  ref string returnurl,
  optional UserRole[] userrole,
  optional object userdomain,
  optional object userenv,
  optional object userprofile)

Name

Description

returnurl

userrole

userdomain

userenv

userprofile

Additional Information


FSCVPORT@1.1001:UpdateMinimized Permanent link for this heading

void FSCVPORT@1.1001:UpdateMinimized(
  string args)

Name

Description

args

Additional Information


FSCVPORT@1.1001:UpdateOverlays Permanent link for this heading

void FSCVPORT@1.1001:UpdateOverlays(
  string arguments,
  out string result)

Name

Description

arguments

result

Additional Information


FSCVPORT@1.1001:UserRoleSettingsHook Permanent link for this heading

void FSCVPORT@1.1001:UserRoleSettingsHook()

Additional Information


FSCVPORT@1.1001:UserRoleSymbolHook Permanent link for this heading

void FSCVPORT@1.1001:UserRoleSymbolHook()

Additional Information