2022 June Release

Actions of FSCVENV@1.1001 Permanent link for this heading

Return Type

Signature

void

AddLocalObjects(
  string selobjects)

boolean

AddProgressInfo(
  optional string proginfo,
  out retval boolean continueoperation)

void

AddRecentlyUsed(
  object context,
  optional object[] additionalobjects)

void

AppendSecRead(
  object[] objlist,
  dictionary userlist)

void

ApplyTemplateCreatedObjectPlaceholders()

void

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

void

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

void

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

void

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

void

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

void

CalcEnterObjectNavigation(
  ref object displayobject,
  optional object parent,
  optional object view,
  ref optional object previousobject,
  ref optional object nextobject,
  optional boolean forwarddirection,
  ref optional integer index,
  out integer elementcount,
  optional string[] objlassfilter)

void

CalcSelectedObjects(
  ref object[] allselectedobjects,
  object[] currentobjectsonpage,
  object[] selectedobjects)

string

CalcTimeInterval(
  string arguments,
  out retval string result)

boolean

CanAddToRecentlyUsed(
  object context,
  out retval boolean canadd)

boolean

CanCutObject(
  object container,
  out retval boolean cancut,
  AttributeDefinition view)

boolean

CheckDispatcherChange(
  out retval boolean forcechange)

void

CheckFormSecurity(
  object form)

void

CheckIfDragAllowed(
  string arguments,
  out dictionary xmldictionary)

boolean

CheckImportContainer(
  object venv_object,
  object venv_view,
  out retval boolean venv_shareexternal,
  out string venv_overwritecallbackaction,
  out string venv_mailsplitcallbackaction,
  out string venv_resolvecontactcallbackaction,
  out boolean venv_mailsplitcallbackactionshowdialog,
  out string venv_mailsplitcallbackactionallowedoptions)

boolean

CheckObjectLock(
  out retval boolean islocked,
  out string errormessage,
  out boolean haslocktoken)

void

CheckQuery(
  object venv_searchclass,
  ref string query,
  optional object[] domains,
  optional integer objectlimit,
  optional integer timelimit,
  optional boolean usederivedclasses)

void

CheckSRColumns(
  dictionary sys_state,
  optional string sys_query)

void

CheckUserAccess(
  ref object[] objlist,
  ref dictionary userlist,
  AccessType acctype)

void

CheckVersionUE(
  object parent,
  object attributedefinition,
  ref optional boolean isinversion)

void

ChooseDownloadFormat(
  ContentObject[] objects,
  out ContentFormat format)

void

CommonEditCompare(
  dictionary oldvalues,
  dictionary newvalues,
  object[] attributes,
  out object[] changedattributes)

boolean

CommonEditConfirmHook(
  object[] objects,
  dictionary commonvalue,
  object[] attributes,
  CommonEditListSetMode commoneditsetmode,
  ref retval boolean editcommonconfirmed)

void

CommonEditGet(
  object[] objects,
  out dictionary commonvalue,
  out object commonbaseclass,
  out object[] commonattributes,
  optional object[] templateattributes,
  optional boolean extendedcommoneditenabled,
  out optional object[] listdecisionattrdefs)

void

CommonEditGetAttributes(
  object object,
  object[] attributes,
  out dictionary values)

void

CommonEditLock(
  ref object[] objects,
  out string[] errorstrings)

void

CommonEditSet(
  object[] objects,
  dictionary commonvalue,
  object[] attributes,
  CommonEditListSetMode commoneditsetmode)

void

CompareChangedFields(
  ref FieldCompare[] fields)

void

CompareChangedFieldsErrors(
  ref FieldError[] problems)

void

ConcludeButtonImport()

void

ConcludeUserContentsObject(
  string venv_importid)

void

ConfirmAggregatedList(
  AggregatedListData venv_aggrlistdata)

void

ControlLaunchedCreate()

void

ControlLaunchedSearch(
  boolean search_classdefined)

void

ControlLaunchedSearchCascaded(
  boolean search_classdefined,
  boolean parentisquery)

void

CopyObject(
  object venv_view,
  object venv_parent,
  ref optional object newobject,
  ref optional object coostore,
  optional Field[] branchattribute,
  optional integer[] branchindex)

void

CopyObjectHook()

void

CopySRViewToClipboard(
  optional integer unused1,
  optional integer unused2)

void

CopyToClipboard(
  string arguments,
  out string result)

void

CopyToClipboardHook(
  object[] objectlist)

void

CopyView(
  object venv_object,
  object venv_view,
  DisplayViewList[] venv_dispview,
  out string venv_columnhtml,
  out string venv_columnplain,
  optional object[] objectlist)

void

CopyViewExtended(
  object venv_object,
  object venv_view,
  DisplayViewList[] venv_dispview,
  out string venv_columnhtml,
  optional object[] objectlist)

void

CorrectPropertyDefinition(
  object attribute,
  optional Field[] branchattr,
  optional integer[] branchindices)

void

CorrectQuery(
  ref string querystring)

void

CorrectSelectionList(
  ref object[] allselectedobjects,
  object[] currentselectedobjects,
  object[] previousselectedobjects)

void

CreateContentFromFile(
  string filename,
  out content content,
  optional boolean removeonrelease)

void

CreateHoliday(
  optional integer unused1,
  optional integer unused2)

void

CreateObject(
  object view,
  object parent,
  ref optional object objcreated,
  ref optional object store,
  optional Field[] branchattribute,
  optional integer[] branchindex)

void

CreateObjectHook(
  object venv_objclass,
  out object venv_object,
  object venv_domain,
  dictionary venv_initvalues,
  object[] venv_attrdefs)

void

CreateTimeInterval(
  optional integer unused1,
  optional integer unused2)

void

CreateUserContentsObject(
  string importid,
  content content,
  optional object[] importobjects)

void

CustomDownload()

void

CustomEditorSessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

void

CustomEditorURLSrcGet(
  out string urlsrc,
  optional string customaction,
  out optional string xdschemaid)

void

DelAmpersandFromString(
  ref string string,
  optional string replacepattern)

void

DeleteIfIsGhost(
  ref object parent,
  object view,
  ref object[] selobjects,
  ref integer[] selindices,
  optional Field[] branchattr,
  optional integer[] branchindices,
  optional boolean checkselection)

void

DelVersionUE(
  object parent,
  object view,
  optional boolean usereleaseversion)

void

DoImportWithoutPlugin(
  string venv_importid,
  object venv_parent,
  object venv_view,
  boolean venv_donotshare,
  string filename,
  Field[] sys_branchattr,
  integer[] sys_branchindex,
  ref object venv_importobj)

void

DumpToXMLCab(
  object xmlmapping,
  out content content,
  optional dictionary globalscope)

void

DumpToXMLCont(
  object xmlmapping,
  out content content)

void

DuplicateObjectHook(
  object created_object,
  object source_object,
  object venv_parent,
  object venv_view,
  object[] venv_values)

void

EditMailContent()

void

EditObjectAttributesHook()

void

EditSettings(
  optional integer unused1,
  optional integer unused2)

void

EditUserCommonSubst()

boolean

EnableExtendedCommonEdit(
  out retval boolean enable)

void

ExpandQuery(
  object[] selobjects,
  string old_query,
  string sys_branchquerypath,
  out string sys_query)

void

ExploreAppViewHook(
  object venv_object,
  object venv_parent,
  optional integer venv_index,
  object venv_view,
  ref object venv_action,
  optional object venv_currselobjs,
  ref object venv_openview)

void

ExploreData()

void

ExploreFill(
  ref dictionary dictionary,
  string todo,
  optional integer[] path_to_the_node,
  optional object[] possible_attributes,
  optional object seltreeinfo,
  optional object seltreetargetobj,
  optional boolean checkismultiple,
  optional boolean displayallobjcets,
  optional boolean searchmode,
  optional object dispobjclass,
  optional dictionary seltreeinfodict)

void

ExploreMailContent()

void

ExploreMailData()

void

ExploreObjectHook(
  object venv_object,
  object venv_parent,
  optional integer venv_index,
  object venv_view,
  ref object venv_action,
  optional object venv_currselobjs)

void

ExploreSingleNode(
  out dictionary[] nodedictionaries)

void

FillEvents(
  out InfoList[] events,
  boolean iswelcomescreen,
  object[] prerequfailed)

void

FillEventsCallback(
  ref InfoList[] events,
  boolean iswelcomescreen,
  ref object[] prerequfailed)

void

FillInstantiateList(
  object view,
  object[] createableclasses,
  object[] categories,
  object[] templateswithoutcat,
  out InstantiateList[] instantiatelist,
  out object[] mostrecent,
  out object[] favorites,
  optional boolean filtertemplateclasses,
  optional object[] collectionsources,
  optional boolean ignoretemplates)

void

FillPrerequisites(
  out InfoList prerequisites,
  object[] prerequfailed,
  optional object[] prerequfailedopt,
  optional object[] prerequpassed)

void

FillSettingsOverview(
  out InfoList[] infolist,
  object[] prerequfailed,
  object[] prerequfailedopt)

void

FillUserRoles(
  ref optional UserRoleList[] userrole)

void

FillVersions(
  out ObjectVersionList[] versions,
  optional boolean includearchivedversions,
  optional boolean excluderemains,
  optional boolean includecurrentversion,
  optional boolean excludecurrentusedversion)

void

FilterDisplayViews(
  object[] venv_displayviews_in,
  boolean venv_forload_in,
  out object[] venv_displayviews_out)

dictionary[]

FilterMindbreezeSearchResultDicts(
  ref retval dictionary[] searchresults)

boolean

FinalizeImport(
  object venv_parent,
  object venv_view,
  object[] venv_importobjects,
  optional boolean venv_donotshare,
  optional Field[] branchattr,
  optional integer[] branchindex,
  out retval boolean handleshareexternal,
  optional boolean venv_importok,
  ref optional object venv_navigateto,
  optional dictionary venv_importdescription)

void

FinalizePrinterImport(
  object[] importobjects,
  object parent,
  object view)

void

FixObjectVersion(
  optional integer handle,
  optional integer index,
  optional string desctext,
  out optional integer versnr,
  optional boolean autofixed)

string

FormatBytes(
  float bytes,
  out retval string result)

void

GenAdditionalFilenames(
  ref string[] additionalfilenames)

void

GenerateMailSubject(
  object[] selobjects,
  ref optional string subjectstring)

void

GenerateOnlineHelpUrl(
  string rel_url_path,
  optional object language,
  ref optional string onlinehelpurl)

void

GenerateQueryFromObjname(
  string objectname,
  out string query,
  optional integer maxnumofhits)

void

GenerateQueryHead(
  object venv_searchclass,
  ref string query,
  optional object[] domains,
  optional integer objectlimit,
  optional integer timelimit,
  optional boolean usederivedclasses,
  optional boolean createnewquery,
  optional object queryscope,
  optional object[] obsolete,
  optional dictionary state)

void

GenOLEClassId(
  ref string[] oleclassid)

void

GenOptionString(
  ref string[] options,
  optional string extension,
  optional object venv_action)

void

GenStringFromArray(
  object[] selobjects,
  optional object[] attrpath,
  ref optional string outstring)

string

GenStringFromStringList(
  string[] selstrings,
  out retval string outstring,
  optional string separator)

string[]

GenStringListFromString(
  string instring,
  out retval string[] outstrings,
  optional string separator)

string

GenURLParams(
  out retval string urlparams,
  dictionary args)

AttributeDefinition[]

GetAbstractAttributes(
  out retval AttributeDefinition[] abstractattributes)

void

GetAccountInfo(
  out string quotahtml,
  out string loginhtml,
  out string serviceloginhtml,
  boolean iswelcomescreen)

void

GetActionsHtml(
  out string html,
  out string backgroundimage)

void

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

void

GetActiveMailPortalPart(
  out object portalpart)

object

GetAdditionalTaskTarget(
  out retval object target,
  optional boolean checktaskpane,
  optional AdditionalTaskDisplayMode displaymode)

string

GetAdditionalTaskTargetMenuCaption(
  out retval string caption,
  out optional Symbol symbol,
  out optional boolean nosubmenus)

void

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

void

GetAllSearchClasses(
  out object[] localclasses)

void

GetAvailableClasses(
  object venv_object,
  object venv_view,
  out object[] availableclasses,
  out boolean classesfound,
  out boolean issingle,
  optional boolean noabstract,
  optional boolean create,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean controlstartedsearch,
  optional boolean venv_isexplore)

void

GetAvailableColumnsXMLHTTP(
  string arguments,
  out string menureference)

void

GetAvailableSearchClasses(
  object venv_object,
  object venv_view,
  out object[] availableclasses,
  out boolean classesfound,
  out boolean issingle,
  optional boolean noabstract,
  optional boolean create,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean controlstartedsearch,
  optional boolean venv_isexplore,
  out boolean usederived)

string

GetAxURL(
  optional dictionary parameters,
  out retval string axurl)

void

GetBackgroundMenuHeadHtml(
  out string headhtml,
  out string footerhtml,
  integer menucount,
  object attrdef)

void

GetBasicPrerequisiteHtml(
  out string html)

Content

GetBlurredImageForString(
  string string,
  out retval Content content,
  optional string bgcolor,
  optional string fontcolor,
  optional string linecolor,
  optional integer linewidth)

void

GetBrandingDescription(
  object attrdef,
  out string title,
  out string[] description)

Breadcrumb[]

GetBreadCrumb(
  out retval Breadcrumb[] breadcrumb,
  optional AttributeDefinition view,
  optional object context)

boolean

GetCancelProgress(
  out retval boolean canceled)

void

GetCategoryTree(
  object[] venv_treevalues,
  string venv_catpropertyexpr,
  string venv_catstructpropertyexpr,
  optional string venv_objclusterexpr,
  out dictionary venv_tree,
  optional string venv_objclusterexpr2,
  optional integer venv_openplanes)

void

GetColumnLoadStates(
  object venv_view,
  out boolean venv_me_obj,
  out boolean venv_me_objclass,
  out boolean venv_all_obj,
  out boolean venv_all_objclass,
  string identpath,
  string settingskey,
  dictionary state,
  optional boolean modereset,
  optional Field[] branchattr,
  optional integer[] branchindex,
  out optional boolean isaggrpath)

DisplayColumnList[]

GetColumns(
  object attrdef,
  object targetobject,
  string selection,
  ref InstantiateList[] availablecolumns,
  out retval DisplayColumnList[] currentcolumns,
  optional integer depth,
  optional string keyword)

void

GetColumnSaveStates(
  object venv_view,
  out boolean venv_me_obj,
  out boolean venv_me_objclass,
  out boolean venv_all_obj,
  out boolean venv_all_objclass,
  out boolean venv_template,
  optional Field[] branchattr,
  optional integer[] branchindex,
  out boolean isaggrpath)

void

GetContentData(
  string davpath,
  out string venv_contextension,
  out string venv_contoleclassid,
  out integer venv_contsize,
  out datetime venv_contchanged,
  optional object[] venv_objectlist,
  out optional string venv_fallbackoverviewcontext)

void

GetContentNames(
  string arguments,
  out string attachments)

void

GetContentsInfo(
  object venv_object,
  object venv_view,
  out boolean noinfo,
  out string extension)

void

GetContentToBeSent(
  string argument,
  out content content)

object

GetContextObjOrError(
  optional string venv_contextinfo,
  out optional string errortext,
  out retval object venv_context,
  string srcobjadress,
  string elementname)

void

GetCreateDomains(
  object view,
  out object coostdom,
  out object[] clientdomains)

string

GetCurrentLocationTitle(
  out retval string title)

string

GetDashboardWidgetSubMenuXMLHTTP(
  string arguments,
  out retval string result)

void

GetDDAction(
  object targetclass,
  ref object targetattrdef,
  ref integer dropflags,
  ref optional object dropaction,
  optional boolean invalidattrdef,
  optional object[] dragobjects,
  optional object dragparent)

void

GetDisplayViews(
  object view,
  boolean checksetaccess,
  out object[] displayviews)

string

GetDownloadURL(
  out retval string url)

void

GetEmptyListDescription(
  object attrdef,
  out string title,
  out string[] description,
  optional boolean islean,
  optional boolean isfilterbasedempty)

void

GetEnterObjectStatus(
  out boolean venv_closeenterobject,
  object venv_parent,
  object venv_object,
  object venv_view,
  out boolean venv_navigatetonext)

void

GetFileName(
  object[] attrdefs,
  integer[] indices,
  out string filename)

void

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

void

GetFormFromSearchForm(
  object venv_object,
  optional object venv_searchclass,
  object[] venv_actions,
  out object venv_form)

void

GetFoundObjectsBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

void

GetFTSQueryConstraints(
  optional object attrdef,
  optional object[] domains,
  optional object[] stores,
  out string queryconstraints,
  out string aclrestrictions,
  optional object[] categoryclasslist)

string[]

GetHeader(
  out retval string[] header)

dictionary

GetHeaderLayout(
  LogoType logotype,
  out retval dictionary headerlayout)

object[]

GetInstantiateValues(
  InstantiateList[] instantiatelist,
  string selection,
  out retval object[] values)

string

GetLinkInfo(
  out retval string linkcontent)

void

GetListEntriesString(
  integer rowcount,
  integer totalrowcount,
  out string entriesstring)

ListView

GetListView(
  object attrdef,
  out retval ListView listview)

void

GetLocalObjects(
  string arguments,
  out dictionary xmldictionary)

void

GetMailBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

void

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

string

GetMenuXMLHTTP(
  string arguments,
  out retval string menureference)

string

GetModifiedErrorText(
  object errorobj,
  out retval string errortext,
  string parameter1,
  optional string parameter2,
  optional string parameter3,
  optional string parameter4,
  optional string parameter5)

void

GetMostRecentClasses(
  object venv_object,
  object venv_view,
  out object[] localclasses,
  out boolean localsdefined,
  out boolean issingle,
  optional boolean create,
  optional object[] definedclasses)

string

GetMxURL(
  out retval string mxurl)

Content

GetObjectImageFallback(
  string name,
  out retval Content image,
  optional integer page)

object[]

GetObjectsFromString(
  string instring,
  out retval object[] objects,
  optional string separator,
  optional string prefix)

void

GetObjectSymbolFriendlyUrl(
  optional string objaddr,
  string name,
  out Content image)

Action

GetOpenOnlineAction(
  out retval Action openaction)

void

GetPdfContent(
  string address,
  string extension,
  out content pdfcontent,
  string argument,
  optional string format)

PortalButton[]

GetPortalButtons(
  out retval PortalButton[] buttons)

object

GetPreferredList(
  out retval object preferredlist,
  out boolean ignoredashboardinbreadcrumb)

void

GetPrerequisiteOverlay(
  out Symbol symbol,
  out string script,
  out boolean update)

void

GetPreviewCheckPropertyHook(
  ref object venv_checkproperty)

void

GetPropertyPathFromString(
  string venv_importbranchattr,
  string venv_importbranchindex,
  out Field[] venv_importattr,
  out integer[] venv_importindex)

boolean

GetQueryData(
  string query,
  out object[] domains,
  out integer objlimit,
  out integer timelimit,
  out retval boolean usederivedclasses)

string

GetQuotaShopUrl(
  out retval string shopurl)

string

GetReadEditMLNamePrefix(
  out retval string mlname)

object

GetRedirectData(
  out retval object redirectobject,
  out optional object redirectview,
  StartPage redirectto)

void

GetReducedSearchForm(
  object venv_searchclass,
  out object venv_reducedsearchform)

void

GetResearchFoundObjectsBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

void

GetResearchMaskBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

void

GetResearchNoObjectsBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

dictionary

GetTaskPaneMenuStructList(
  object targetobject,
  object taskparent,
  optional AttributeDefinition taskview,
  optional object appcontext,
  optional TaskPane taskpane,
  optional object[] taskobjects,
  optional boolean isedit,
  optional boolean isexplore,
  optional boolean issearch,
  optional boolean iscreate,
  optional boolean isdraganddrop,
  optional boolean isctxmenu,
  optional datetime pointintime,
  optional string dropflags,
  out retval dictionary taskpanedata)

string

GetTC(
  out retval string tc)

void

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

content[]

GetUserContents(
  string venv_importid,
  out retval content[] cont,
  optional boolean clear,
  out optional object[] importobjects)

void

GetUserFormTemplateCategories(
  out object[] userformcategories,
  object view)

void

GetUsersByEMails(
  out dictionary userlist,
  ref optional string[] emaillist)

object[]

GetValuesFromPath(
  Field[] branchattr,
  integer[] sys_branchindex,
  out retval object[] values)

string

GetViewAsString(
  out retval string branchtext,
  boolean onlineisavailable)

void

GetViewContData(
  out string branchoperator,
  ref boolean useimagecontrol,
  out boolean enableannotation)

void

GetXeditorData(
  string customaction,
  ref XeditorData xeditordata,
  optional AttributeDefinition contentattrdef,
  optional string viewmode,
  optional integer autosaveinterval,
  optional object ribbonsite,
  optional boolean israwxmleditorenabled,
  optional boolean isxmlsidepanelenabled)

void

HandleNewSearchForm(
  string sys_query,
  string name,
  out object createdsearchform,
  boolean editraw)

boolean

HasVisibleCreateItems(
  object view,
  object[] createableclasses,
  object[] categories,
  object[] templates_withoutcat,
  out retval boolean hasvisibleitems,
  optional object[] collectionsources)

void

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

boolean

HideTaskPane(
  out retval boolean hide)

void

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

void

ImportCheckViewDataRPC(
  string arguments,
  out dictionary xmldictionary)

void

ImportObjectReadOnly(
  optional integer unused1,
  optional integer unused2,
  optional object view,
  optional string filename,
  optional boolean removefile,
  optional boolean noinsert,
  out optional object newobject,
  ref optional object coostore,
  ref optional object objclass,
  ref optional object[] classlist,
  ref optional object[] classtrees,
  optional ConfirmOp confirmop,
  optional string confirmprompt,
  optional dictionary confirmparams,
  out optional integer confirmresult)

void

ImportWithoutPluginPrepareHook(
  object venv_object,
  object venv_parent,
  object venv_view)

void

InitCreatedObject(
  object[] attrdefs,
  dictionary values)

void

InitializeCreatedObject(
  ref object venv_object,
  optional object venv_parent,
  optional integer venv_index,
  optional object venv_view,
  optional object venv_action)

void

InitializeCreatedObjectDoDefault(
  ref object venv_object,
  optional object venv_parent,
  optional integer venv_index,
  optional object venv_view,
  optional object venv_action)

void

InitializeCreatedObjectRole()

void

InitializeProgressObject()

void

InitializeSearchSelectClassesCallback(
  dictionary state)

void

InitializeTemplateCreatedObject(
  ref object venv_object,
  optional object venv_parent,
  optional integer venv_index,
  optional object venv_view,
  optional object venv_action)

boolean

IsContentModificationAllowed(
  out retval boolean allowed)

boolean

IsEditable(
  out retval boolean iseditable)

boolean

IsEditableAttribute(
  AttributeDefinition attrdef,
  optional Action[] actioncontext,
  out retval boolean iseditable)

void

IsEqualQuery(
  string sys_query,
  string save_query,
  out boolean equal)

boolean

IsFieldsIntegrationEnabled(
  out retval boolean allowed)

boolean

IsObjNameChangeableUIPreWrapper(
  ref dictionary scope,
  out retval boolean ischangeable)

boolean

IsOpenOnlineEnabled(
  out retval boolean useonline)

void

LoadDisplayColumnListWeb(
  object venv_view,
  ref optional dictionary venv_usersettings,
  optional string identkey,
  optional object filter,
  out DisplayColumnList[] dispcollist,
  optional string identpath,
  optional integer columnsource,
  optional object columntemplate)

void

LoadQuery(
  content querycontent,
  out string querystring,
  out object searchclass,
  optional boolean ignorequeryhead,
  out optional object templatecategory)

void

LoggedIn()

void

MapExploreObjects(
  object venv_object,
  object venv_parent,
  integer venv_index,
  object venv_view,
  object venv_action,
  optional object venv_openview)

void

MapOpenObjectInplace(
  object sys_object,
  object sys_action,
  object sys_view,
  object[] sys_selobjects,
  integer[] sys_selindices,
  optional integer sys_dynkey,
  optional boolean sys_isexplore,
  optional object sys_dashboardview,
  optional boolean sys_isdashboard,
  optional object sys_openview,
  optional object sys_dashboardobject)

void

MergeUniqueObjectArrays(
  ref object[] list1,
  object[] list2)

void

ModifyGenericAttributesPage(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

void

NavigationOverlayApp()

void

ObjectShare(
  object venv_view,
  ref object venv_parent,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean doreplace,
  optional boolean nolocking,
  optional object[] objectstoshare,
  optional boolean ignoreshareonduplicates,
  optional boolean issearch,
  out optional boolean isfield)

void

ObjectUnlockPermanent()

void

OpenCallback(
  dictionary localscope)

void

OpenCompoundObjectHook()

void

OpenContObjectHook()

void

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

void

PasteSRViewFromClipboard(
  optional integer unused1,
  optional integer unused2)

boolean

PreferOpenDocReadOnly(
  out retval boolean openreadonly)

void

PreparePrinterImport(
  string filename,
  ref Content content)

void

PrepareSaveAppearance(
  DisplayViewList[] dispview,
  ref dictionary sys_state,
  out dictionary savedictionary,
  string identpath,
  ref optional string sys_settingskey,
  optional boolean reset)

void

PreviewHook(
  object venv_object,
  object venv_parent,
  optional integer venv_index,
  object venv_view,
  ref object venv_action,
  object venv_ctx)

void

QuickSearch(
  object view,
  string pattern,
  object[] attrdefs,
  integer[] indices,
  out object[] hits,
  out string[] unused,
  optional CheckAllowedMode mode,
  optional string qskey)

void

ReadClipboard(
  ref optional any values,
  optional string key,
  optional object columnattrdef,
  optional string clientclipboard)

void

ReadCurrentView(
  out DisplayViewList[] dispview,
  out DisplayColumnList[] dispcolumns,
  ref string identpath,
  dictionary state,
  object attrdef,
  optional object viewcontainer,
  out optional string[] sortcolumns,
  out optional object filter,
  optional string statekey,
  optional Field[] branchattribute,
  optional integer[] branchindex)

void

ReadMailContent()

void

ReadObjectAttributesHook()

void

ReadUserEnvKey(
  SaveUserEnvKeyEnum savelocation,
  out any savevalue,
  string identpath,
  optional string settingskey,
  optional object attrdef)

void

RemoveDeleteImported(
  ref object[] venv_listobjects,
  object[] venv_objectstodelete,
  ref optional object venv_object,
  optional object venv_view,
  ref object[] venv_createdobjects)

void

ResetAppearanceSource(
  ref dictionary state,
  string identpath,
  optional string sys_settingskey,
  optional SaveUserEnvKeyEnum savinglocation)

void

ResetUserSettings(
  optional object objclass,
  optional object attrdef,
  optional boolean removedeletedobjs)

string

ResolveFieldRPCPatchVariable(
  ref retval string result,
  optional string dataref)

void

RunApplication(
  optional integer unused1,
  optional integer unused2)

void

RunSelectedApplications(
  optional integer unused1,
  optional integer unused2)

void

SaveAppearanceSource(
  ref dictionary state,
  string identpath,
  optional string sys_settingskey,
  integer columnsource,
  optional object columntemplate)

void

SaveDisplayColumns(
  DisplayViewList[] dispview,
  integer savelocation,
  object attrdef,
  optional object displayviewobj)

void

SaveDisplayViewsInUE(
  object[] venv_displayviews)

void

SaveQuery(
  string querystring,
  boolean editraw)

void

SaveUserEnvKey(
  SaveUserEnvKeyEnum savelocation,
  any savevalue,
  string identpath,
  optional string settingskey,
  optional boolean reset,
  optional object attrdef)

void

SearchCallback(
  object[] foundobjects)

void

SearchObjectsAsync(
  string query,
  optional integer chunksize,
  out object[] resultlist,
  out string error,
  optional integer currobjlimit,
  optional object view,
  optional CheckAllowedMode checkallowedmode,
  out integer usedlimit,
  out object errorobject)

void

SetAttrPathAndIndex(
  Field[] branchattribute,
  integer[] branchindex)

void

SetCancelProgress(
  boolean cancel)

void

SetImplicitRoleChange(
  object venv_object)

void

SetListInVersion(
  object parent,
  object view,
  ref object[] list)

void

SetSelection(
  object view,
  any value,
  object[] selobjects,
  dictionary state)

void

SettingsRoot(
  optional integer unused1,
  optional integer unused2)

void

SetUrlPart(
  ref string url,
  string part)

void

SetVersionUE(
  object parent,
  object view)

void

ShareObjects(
  object venv_view,
  ref object venv_parent,
  object[] objectlist,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean doreplace,
  optional boolean nolocking,
  optional boolean ignoreshareonduplicates)

void

ShareObjectsHook(
  object venv_view,
  ref object[] venv_values)

boolean

ShowCommitButton(
  optional object venv_parent,
  optional object venv_view,
  optional object venv_action,
  ref retval boolean showcommitbutton)

void

ShowEnvironmentStatus(
  optional integer unused1,
  optional integer unused2)

void

ShowUnshareWarning(
  object venv_parent,
  object venv_view,
  object[] sys_selobjects,
  out boolean warning,
  out string warningmessage)

void

SortIndices(
  integer[] indices,
  out integer[] sortorder,
  optional boolean ascending)

void

StartExplorePortal()

void

StartMailPortal()

boolean

SubstitutionsAreActive(
  boolean checkchangeable,
  out retval boolean active)

void

SubstitutionsEndActive()

string

TestCustomEditor(
  object venv_object,
  object venv_parent,
  integer venv_index,
  object venv_view,
  object venv_action,
  ref retval string venv_customaction,
  ref string venv_customurl,
  boolean venv_islocked,
  boolean venv_haslocktoken,
  string venv_customerrormessage)

string

TestOnlineOffice(
  object venv_object,
  object venv_parent,
  integer venv_index,
  object venv_view,
  object venv_action,
  ref retval string venv_wopiaction,
  ref string venv_wopiurl,
  boolean venv_islocked,
  boolean venv_haslocktoken,
  string venv_customerrormessage)

void

TransformToXML(
  string transformation,
  out content content)

string

UnEscapePattern(
  string inpattern,
  out retval string unescapedpattern)

void

UnshareObjects(
  ref object parent,
  Field[] branchattr,
  integer[] branchindex,
  integer[] selindices,
  optional object attrdef,
  ref optional any value)

boolean

UpdateProgressObject(
  optional datetime progstart,
  optional datetime progend,
  optional string progdescription,
  integer progcount,
  optional integer progmaxcount,
  optional object progobject,
  optional string progresult,
  optional string proginfo,
  out retval boolean continueoperation,
  optional object progfmtstring,
  optional object progobjfmtstring)

void

UpdateProgressObjectRPC(
  string arguments,
  out dictionary xmldictionary)

void

UploadImportCreate(
  object venv_object,
  object venv_view,
  content venv_content,
  string venv_objname,
  object[] venv_availableclasses,
  ref object[] venv_createdobjects,
  out string venv_errortext,
  out any venv_createdobject,
  any venv_maxfilesize,
  string venv_filepath)

boolean

UseOpenOnline(
  out retval boolean useonline,
  ref OpenDocumentMode opendocmode)

boolean

UseOpenOnlinePreview(
  out retval boolean useonlinepreview)

void

ViewTemplatePreview()

string

WOPISessionCloseRPC(
  string arguments,
  out retval string result)

void

WriteClipboard(
  any values,
  optional string key)


FSCVENV@1.1001:AddLocalObjects Permanent link for this heading

Add common objects

void FSCVENV@1.1001:AddLocalObjects(
  string selobjects)

Name

Description

selobjects

Additional Information


FSCVENV@1.1001:AddProgressInfo Permanent link for this heading

Update values of the progress object used to display the asynchronous progress

boolean FSCVENV@1.1001:AddProgressInfo(
  optional string proginfo,
  out retval boolean continueoperation)

Name

Description

proginfo

Additional information to be displayed below the progress bar. If this parameter is null the progress info is cleared.

continueoperation

The return value of the action, returns false if the user presses Cancel in the dialog

Additional Information


FSCVENV@1.1001:AddRecentlyUsed Permanent link for this heading

Adds the current object to the recently used list."

void FSCVENV@1.1001:AddRecentlyUsed(
  object context,
  optional object[] additionalobjects)

Name

Description

context

The context object is used to determine in which list the rectently used object should be stored. Currently StartMailPortal, Invite and SendFolioMail are valid context objects."

additionalobjects

if more than one object should be added to the recenlty used objects

Additional Information


FSCVENV@1.1001:AppendSecRead Permanent link for this heading

void FSCVENV@1.1001:AppendSecRead(
  object[] objlist,
  dictionary userlist)

Name

Description

objlist

userlist

Additional Information


FSCVENV@1.1001:ApplyTemplateCreatedObjectPlaceholders Permanent link for this heading

Apply Placeholders in Object created by a template

void FSCVENV@1.1001:ApplyTemplateCreatedObjectPlaceholders()

Additional Information


FSCVENV@1.1001:AttrDescribingPreviewsGet Permanent link for this heading

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

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCVENV@1.1001:AttrObjAbstractGet Permanent link for this heading

Getting a short textual abstract of the object

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

Name

Description

attrdef

attribute definition

value

value

volatile

volatile

volatiletx

volatiletx

Additional Information


FSCVENV@1.1001:AttrObjDescriptionGet Permanent link for this heading

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

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCVENV@1.1001:AttrObjDescriptionTextGet Permanent link for this heading

Getting the stringlist for objdescriptiontext Since objdescriptiontext is a stringlist we assume that the value delivered by the formatting configuration can contain line separators "\n".

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

Name

Description

attrdef

the attribute definition

value

the value

volatile

volatiletx

Additional Information


FSCVENV@1.1001:AttrTimeSpecSet Permanent link for this heading

Set time specification

void FSCVENV@1.1001:AttrTimeSpecSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCVENV@1.1001:CalcEnterObjectNavigation Permanent link for this heading

Calculate navigation for enter object.

void FSCVENV@1.1001:CalcEnterObjectNavigation(
  ref object displayobject,
  optional object parent,
  optional object view,
  ref optional object previousobject,
  ref optional object nextobject,
  optional boolean forwarddirection,
  ref optional integer index,
  out integer elementcount,
  optional string[] objlassfilter)

Name

Description

displayobject

parent

view

previousobject

nextobject

forwarddirection

index

elementcount

objlassfilter

Additional Information


FSCVENV@1.1001:CalcSelectedObjects Permanent link for this heading

Calculate all objects selected, including the selection in the current page.

void FSCVENV@1.1001:CalcSelectedObjects(
  ref object[] allselectedobjects,
  object[] currentobjectsonpage,
  object[] selectedobjects)

Name

Description

allselectedobjects

all selected objects

currentobjectsonpage

objects currently selected on the page

selectedobjects

new calculated list of all selected objects

Additional Information


FSCVENV@1.1001:CalcTimeInterval Permanent link for this heading

Adds a time interval to a date (xml rpc)

string FSCVENV@1.1001:CalcTimeInterval(
  string arguments,
  out retval string result)

Name

Description

arguments

result

Additional Information


FSCVENV@1.1001:CanAddToRecentlyUsed Permanent link for this heading

Check if an object should be added to the recently used objects

boolean FSCVENV@1.1001:CanAddToRecentlyUsed(
  object context,
  out retval boolean canadd)

Name

Description

context

The context object is used to determine in which list the rectently used object should be stored. Currently StartMailPortal, Invite and SendFolioMail are valid context objects."

canadd

Additional Information


FSCVENV@1.1001:CanCutObject Permanent link for this heading

Defines if an object object can be cut from the container

boolean FSCVENV@1.1001:CanCutObject(
  object container,
  out retval boolean cancut,
  AttributeDefinition view)

Name

Description

container

the container the object should be cut from

cancut

if true the object will be cut

view

the view the object should be cut from

Additional Information


FSCVENV@1.1001:CheckDispatcherChange Permanent link for this heading

Calculates, whether the application dispatcher has changed

boolean FSCVENV@1.1001:CheckDispatcherChange(
  out retval boolean forcechange)

Name

Description

forcechange

Indicates, that the dispatcher has changed

Additional Information


FSCVENV@1.1001:CheckFormSecurity Permanent link for this heading

void FSCVENV@1.1001:CheckFormSecurity(
  object form)

Name

Description

form

Additional Information


FSCVENV@1.1001:CheckIfDragAllowed Permanent link for this heading

Checks whether it is allowed to drag an object into a target object.
Depending on the result an error string is included the xml output string.

void FSCVENV@1.1001:CheckIfDragAllowed(
  string arguments,
  out dictionary xmldictionary)

Name

Description

arguments

Drag arguments:
0...tagrget object
3...target attribute definition
5...dropflag
6...dropobject

xmldictionary

Additional Information


FSCVENV@1.1001:CheckImportContainer Permanent link for this heading

boolean FSCVENV@1.1001:CheckImportContainer(
  object venv_object,
  object venv_view,
  out retval boolean venv_shareexternal,
  out string venv_overwritecallbackaction,
  out string venv_mailsplitcallbackaction,
  out string venv_resolvecontactcallbackaction,
  out boolean venv_mailsplitcallbackactionshowdialog,
  out string venv_mailsplitcallbackactionallowedoptions)

Name

Description

venv_object

venv_view

venv_shareexternal

venv_overwritecallbackaction

venv_mailsplitcallbackaction

venv_resolvecontactcallbackaction

venv_mailsplitcallbackactionshowdialog

venv_mailsplitcallbackactionallowedoptions

Additional Information


FSCVENV@1.1001:CheckObjectLock Permanent link for this heading

boolean FSCVENV@1.1001:CheckObjectLock(
  out retval boolean islocked,
  out string errormessage,
  out boolean haslocktoken)

Name

Description

islocked

errormessage

haslocktoken

Additional Information


FSCVENV@1.1001:CheckQuery Permanent link for this heading

Checks sys_query for changes in LIMIT, TIMEOUT, DOMAIN and Use Derived Classes.

void FSCVENV@1.1001:CheckQuery(
  object venv_searchclass,
  ref string query,
  optional object[] domains,
  optional integer objectlimit,
  optional integer timelimit,
  optional boolean usederivedclasses)

Name

Description

venv_searchclass

current search class

query

current query string

domains

current list of domains

objectlimit

current object limit

timelimit

current time limit

usederivedclasses

current boolean use derived classes

Additional Information


FSCVENV@1.1001:CheckSRColumns Permanent link for this heading

void FSCVENV@1.1001:CheckSRColumns(
  dictionary sys_state,
  optional string sys_query)

Name

Description

sys_state

sys_query

Additional Information


FSCVENV@1.1001:CheckUserAccess Permanent link for this heading

void FSCVENV@1.1001:CheckUserAccess(
  ref object[] objlist,
  ref dictionary userlist,
  AccessType acctype)

Name

Description

objlist

userlist

acctype

Additional Information


FSCVENV@1.1001:CheckVersionUE Permanent link for this heading

Checks whether an object is in a version or not

void FSCVENV@1.1001:CheckVersionUE(
  object parent,
  object attributedefinition,
  ref optional boolean isinversion)

Name

Description

parent

Parent object (i.e. folder)

attributedefinition

Attribute definition

isinversion

true if object is in version

Additional Information


FSCVENV@1.1001:ChooseDownloadFormat Permanent link for this heading

Choose the content format used for download.

void FSCVENV@1.1001:ChooseDownloadFormat(
  ContentObject[] objects,
  out ContentFormat format)

Name

Description

objects

format

Additional Information


FSCVENV@1.1001:CommonEditCompare Permanent link for this heading

Compare values for "Edit Common Properties"

void FSCVENV@1.1001:CommonEditCompare(
  dictionary oldvalues,
  dictionary newvalues,
  object[] attributes,
  out object[] changedattributes)

Name

Description

oldvalues

newvalues

attributes

changedattributes

attributes edited in commonvalue

Additional Information


FSCVENV@1.1001:CommonEditConfirmHook Permanent link for this heading

Confirm common edit (hook)

boolean FSCVENV@1.1001:CommonEditConfirmHook(
  object[] objects,
  dictionary commonvalue,
  object[] attributes,
  CommonEditListSetMode commoneditsetmode,
  ref retval boolean editcommonconfirmed)

Name

Description

objects

commonvalue

attributes

commoneditsetmode

editcommonconfirmed

Additional Information


FSCVENV@1.1001:CommonEditGet Permanent link for this heading

Get common base class and generate an instance from this object class (=commonvalue) for "Edit Common Properties"

void FSCVENV@1.1001:CommonEditGet(
  object[] objects,
  out dictionary commonvalue,
  out object commonbaseclass,
  out object[] commonattributes,
  optional object[] templateattributes,
  optional boolean extendedcommoneditenabled,
  out optional object[] listdecisionattrdefs)

Name

Description

objects

List of objects (selected objects).

commonvalue

Generated instance from the matching base class.

commonbaseclass

Matching base class.

commonattributes

templateattributes

extendedcommoneditenabled

listdecisionattrdefs

Additional Information


FSCVENV@1.1001:CommonEditGetAttributes Permanent link for this heading

Read temporary values for "Edit Common Properties"

void FSCVENV@1.1001:CommonEditGetAttributes(
  object object,
  object[] attributes,
  out dictionary values)

Name

Description

object

attributes

values

Additional Information


FSCVENV@1.1001:CommonEditLock Permanent link for this heading

Lock objects for "Edit Common Properties"

void FSCVENV@1.1001:CommonEditLock(
  ref object[] objects,
  out string[] errorstrings)

Name

Description

objects

List of objects to lock

errorstrings

Additional Information


FSCVENV@1.1001:CommonEditSet Permanent link for this heading

Set values for "Edit Common Properties"

void FSCVENV@1.1001:CommonEditSet(
  object[] objects,
  dictionary commonvalue,
  object[] attributes,
  CommonEditListSetMode commoneditsetmode)

Name

Description

objects

List of objects where to set the value

commonvalue

Instance of the object with the common values.

attributes

List of attributes edited in commonvalues

commoneditsetmode

Additional Information


FSCVENV@1.1001:CompareChangedFields Permanent link for this heading

Shows all changed fields of objects and allows to revert some of the changes

void FSCVENV@1.1001:CompareChangedFields(
  ref FieldCompare[] fields)

Name

Description

fields

the fields and objects that should be compared

Additional Information


FSCVENV@1.1001:CompareChangedFieldsErrors Permanent link for this heading

Shows errors that occur when CompareChangedFields is called and the fields cannot be set

void FSCVENV@1.1001:CompareChangedFieldsErrors(
  ref FieldError[] problems)

Name

Description

problems

list of all errors that occur

Additional Information


FSCVENV@1.1001:ConcludeButtonImport Permanent link for this heading

void FSCVENV@1.1001:ConcludeButtonImport()

Additional Information


FSCVENV@1.1001:ConcludeUserContentsObject Permanent link for this heading

Conclude the user content object. This action is the counterpart to the prepare user content object action. A main goal is to unlock the user content property.

void FSCVENV@1.1001:ConcludeUserContentsObject(
  string venv_importid)

Name

Description

venv_importid

Additional Information


FSCVENV@1.1001:ConfirmAggregatedList Permanent link for this heading

Generic use case to show an aggregated info list and a confirm message

void FSCVENV@1.1001:ConfirmAggregatedList(
  AggregatedListData venv_aggrlistdata)

Name

Description

venv_aggrlistdata

the parameters for the aggregated list contained in an AggregatedListData aggregate

Additional Information


FSCVENV@1.1001:ControlLaunchedCreate Permanent link for this heading

This action is called through a control.
(If the "create new object" - icon behind an object pointer selection box is pressed)

void FSCVENV@1.1001:ControlLaunchedCreate()

Additional Information


FSCVENV@1.1001:ControlLaunchedSearch Permanent link for this heading

This action is called through a control.
(If the "search object" - icon behind an object pointer selection box is pressed)

void FSCVENV@1.1001:ControlLaunchedSearch(
  boolean search_classdefined)

Name

Description

search_classdefined

true: if the object class to search for is known

Additional Information


FSCVENV@1.1001:ControlLaunchedSearchCascaded Permanent link for this heading

This action is called through a control.
If the "search object" - icon behind an object pointer selection box is pressed, and the previous action was a search (cascaded search).

void FSCVENV@1.1001:ControlLaunchedSearchCascaded(
  boolean search_classdefined,
  boolean parentisquery)

Name

Description

search_classdefined

true: if the object class to search for is known

parentisquery

true: the action done before, was also a search action (cascaded search)

Additional Information


FSCVENV@1.1001:CopyObject Permanent link for this heading

Copies the object. The created object is given back through the parameter 'newobject'. Depending on the input parameter branchattribute and branch value the created object is linked to venv_parent.

void FSCVENV@1.1001:CopyObject(
  object venv_view,
  object venv_parent,
  ref optional object newobject,
  ref optional object coostore,
  optional Field[] branchattribute,
  optional integer[] branchindex)

Name

Description

venv_view

Attribute definition of venv_parent object lists

venv_parent

Parent object

newobject

Created object

coostore

Store object for the created object

branchattribute

Attribute path to object lists attribute definition.

branchindex

Index through the branchattribute array

Additional Information


FSCVENV@1.1001:CopyObjectHook Permanent link for this heading

void FSCVENV@1.1001:CopyObjectHook()

Additional Information


FSCVENV@1.1001:CopySRViewToClipboard Permanent link for this heading

void FSCVENV@1.1001:CopySRViewToClipboard(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:CopyToClipboard Permanent link for this heading

Prepare the step-specific arguments for the current execution-action or -virtual application.

void FSCVENV@1.1001:CopyToClipboard(
  string arguments,
  out string result)

Name

Description

arguments

result

Additional Information


FSCVENV@1.1001:CopyToClipboardHook Permanent link for this heading

Hook which is called when objects are copied to the clip board

void FSCVENV@1.1001:CopyToClipboardHook(
  object[] objectlist)

Name

Description

objectlist

Additional Information


FSCVENV@1.1001:CopyView Permanent link for this heading

Generates an HTML table and a plain text string containing the property values of a list of objects. Will be used for copying the values displayed in the detail view.

void FSCVENV@1.1001:CopyView(
  object venv_object,
  object venv_view,
  DisplayViewList[] venv_dispview,
  out string venv_columnhtml,
  out string venv_columnplain,
  optional object[] objectlist)

Name

Description

venv_object

The container of the objects to copy.

venv_view

The list of the container which contains the objects. Will be used if objectlist is null.

venv_dispview

The properties (columns defined in a detail view) that should be copied.

venv_columnhtml

The result as HTML table.

venv_columnplain

The result as plain text. Values are separated by tabs.

objectlist

The list of objects that should be copied.

Additional Information


FSCVENV@1.1001:CopyViewExtended Permanent link for this heading

Generates an HTML table containing the property values of a list of objects. For each compound property and properties with multiple values a nested table will be created. For compound properties all nested attributes are tracked until the first object change. Will be used for copying the values displayed in the detail view in extended mode.

void FSCVENV@1.1001:CopyViewExtended(
  object venv_object,
  object venv_view,
  DisplayViewList[] venv_dispview,
  out string venv_columnhtml,
  optional object[] objectlist)

Name

Description

venv_object

The container of the objects to copy.

venv_view

The list of the container which contains the objects. Will be used if objectlist is null.

venv_dispview

The properties (columns defined in a detail view) that should be copied.

venv_columnhtml

The result as HTML table.

objectlist

The list of objects that should be copied.

Additional Information


FSCVENV@1.1001:CorrectPropertyDefinition Permanent link for this heading

Correct the attribute definition, depending to the property path (branchattr and branchindex)

void FSCVENV@1.1001:CorrectPropertyDefinition(
  object attribute,
  optional Field[] branchattr,
  optional integer[] branchindices)

Name

Description

attribute

branchattr

branchindices

Additional Information


FSCVENV@1.1001:CorrectQuery Permanent link for this heading

Checks whether the current query string contains a 'WHERE' at the end. If so correct this illegal query string.

void FSCVENV@1.1001:CorrectQuery(
  ref string querystring)

Name

Description

querystring

Query string

Additional Information


FSCVENV@1.1001:CorrectSelectionList Permanent link for this heading

Correct the list of objects selected at the moment depending to the current selection in the page (selection and deselection)

void FSCVENV@1.1001:CorrectSelectionList(
  ref object[] allselectedobjects,
  object[] currentselectedobjects,
  object[] previousselectedobjects)

Name

Description

allselectedobjects

All selected objects

currentselectedobjects

Objects currently selected in the page

previousselectedobjects

Objects selected previous at this page

Additional Information


FSCVENV@1.1001:CreateContentFromFile Permanent link for this heading

void FSCVENV@1.1001:CreateContentFromFile(
  string filename,
  out content content,
  optional boolean removeonrelease)

Name

Description

filename

content

removeonrelease

Additional Information


FSCVENV@1.1001:CreateHoliday Permanent link for this heading

Menu usecase for creating a holiday

void FSCVENV@1.1001:CreateHoliday(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:CreateObject Permanent link for this heading

Creates an object. The created object is given back through the parameter 'objcreated'. Depending on the input parameter branchattribute and branch value the created object is linked to venv_parent.

void FSCVENV@1.1001:CreateObject(
  object view,
  object parent,
  ref optional object objcreated,
  ref optional object store,
  optional Field[] branchattribute,
  optional integer[] branchindex)

Name

Description

view

Attribute definition of venv_parent object lists

parent

Parent object

objcreated

Created object

store

Store object for the created object

branchattribute

Attribute path to object lists attribute definition.

branchindex

Index through the branchattribute array

Additional Information


FSCVENV@1.1001:CreateObjectHook Permanent link for this heading

This action can be used as hook to handle the creation process of an object.

void FSCVENV@1.1001:CreateObjectHook(
  object venv_objclass,
  out object venv_object,
  object venv_domain,
  dictionary venv_initvalues,
  object[] venv_attrdefs)

Name

Description

venv_objclass

venv_object

venv_domain

venv_initvalues

venv_attrdefs

Additional Information


FSCVENV@1.1001:CreateTimeInterval Permanent link for this heading

Menu usecase for creating a holiday

void FSCVENV@1.1001:CreateTimeInterval(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:CreateUserContentsObject Permanent link for this heading

void FSCVENV@1.1001:CreateUserContentsObject(
  string importid,
  content content,
  optional object[] importobjects)

Name

Description

importid

content

importobjects

Additional Information


FSCVENV@1.1001:CustomDownload Permanent link for this heading

This hook is called if a single object is selected for download.

void FSCVENV@1.1001:CustomDownload()

Additional Information


FSCVENV@1.1001:CustomEditorSessionCreate Permanent link for this heading

void FSCVENV@1.1001:CustomEditorSessionCreate(
  out string access_token,
  out integer access_tokenttl,
  optional datetime access_expiresat)

Name

Description

access_token

access_tokenttl

access_expiresat

Additional Information


FSCVENV@1.1001:CustomEditorURLSrcGet Permanent link for this heading

void FSCVENV@1.1001:CustomEditorURLSrcGet(
  out string urlsrc,
  optional string customaction,
  out optional string xdschemaid)

Name

Description

urlsrc

customaction

xdschemaid

Additional Information


FSCVENV@1.1001:DelAmpersandFromString Permanent link for this heading

Deletes ampersands from the given string. (The Ampersand marks the accelerator)

void FSCVENV@1.1001:DelAmpersandFromString(
  ref string string,
  optional string replacepattern)

Name

Description

string

replacepattern

Additional Information


FSCVENV@1.1001:DeleteIfIsGhost Permanent link for this heading

Check all selected objects in a parent object. If one of the selected objects is a ghost, this object is to be deleted.

void FSCVENV@1.1001:DeleteIfIsGhost(
  ref object parent,
  object view,
  ref object[] selobjects,
  ref integer[] selindices,
  optional Field[] branchattr,
  optional integer[] branchindices,
  optional boolean checkselection)

Name

Description

parent

Parent object (i.e. a folder)

view

Attribute definition

selobjects

Selected objects

selindices

Indices of the selected objects inside the parent object

branchattr

branchindices

checkselection

Additional Information


FSCVENV@1.1001:DelVersionUE Permanent link for this heading

Deletes an entry of a version from the UserEnvironment settings dictionary. In case parameter usereleaseversion is set behavour additionally depends on UserEnvironment property: usrenvreleasevers

void FSCVENV@1.1001:DelVersionUE(
  object parent,
  object view,
  optional boolean usereleaseversion)

Name

Description

parent

Defines the parent object.

view

Defines the Attribute definition used.

usereleaseversion

If true and UserEnvironment property: usrenvreleasevers is false,
'release' entry is written to user environment dictionary.
If true and UserEnvironment property: usrenvreleasevers is true,
entry for cooobj is deleted from user environment dictionary.
If false and UserEnvironment property: usrenvreleasevers is false,
entry for cooobj is deleted from user environment dictionary.
If false and UserEnvironment property: usrenvreleasevers is true,
'current' entry for cooobj is written to user environment dictionary.
default: If undefined or null, entry for cooobj is deleted from user environment dictionary.

Additional Information


FSCVENV@1.1001:DoImportWithoutPlugin Permanent link for this heading

void FSCVENV@1.1001:DoImportWithoutPlugin(
  string venv_importid,
  object venv_parent,
  object venv_view,
  boolean venv_donotshare,
  string filename,
  Field[] sys_branchattr,
  integer[] sys_branchindex,
  ref object venv_importobj)

Name

Description

venv_importid

venv_parent

venv_view

venv_donotshare

filename

sys_branchattr

sys_branchindex

venv_importobj

Additional Information


FSCVENV@1.1001:DumpToXMLCab Permanent link for this heading

Dump object to XML file and return it as a cab content

void FSCVENV@1.1001:DumpToXMLCab(
  object xmlmapping,
  out content content,
  optional dictionary globalscope)

Name

Description

xmlmapping

content

globalscope

Additional Information


FSCVENV@1.1001:DumpToXMLCont Permanent link for this heading

Dump object to XML file and return it as content

void FSCVENV@1.1001:DumpToXMLCont(
  object xmlmapping,
  out content content)

Name

Description

xmlmapping

content

Additional Information


FSCVENV@1.1001:DuplicateObjectHook Permanent link for this heading

Hook to get the duplicated object.

void FSCVENV@1.1001:DuplicateObjectHook(
  object created_object,
  object source_object,
  object venv_parent,
  object venv_view,
  object[] venv_values)

Name

Description

created_object

source_object

venv_parent

venv_view

venv_values

Additional Information


FSCVENV@1.1001:EditMailContent Permanent link for this heading

Edit mail content.

void FSCVENV@1.1001:EditMailContent()

Additional Information


FSCVENV@1.1001:EditObjectAttributesHook Permanent link for this heading

Edit properties of object (hook)

void FSCVENV@1.1001:EditObjectAttributesHook()

Additional Information


FSCVENV@1.1001:EditSettings Permanent link for this heading

Edit User Settings (Basis Settings)

void FSCVENV@1.1001:EditSettings(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:EditUserCommonSubst Permanent link for this heading

Action used for formular mapping

void FSCVENV@1.1001:EditUserCommonSubst()

Additional Information


FSCVENV@1.1001:EnableExtendedCommonEdit Permanent link for this heading

EnableExtendedCommonEdit

boolean FSCVENV@1.1001:EnableExtendedCommonEdit(
  out retval boolean enable)

Name

Description

enable

Additional Information


FSCVENV@1.1001:ExpandQuery Permanent link for this heading

Expands a query depending on the existing query and the current branch query path, as well as the selected object.

void FSCVENV@1.1001:ExpandQuery(
  object[] selobjects,
  string old_query,
  string sys_branchquerypath,
  out string sys_query)

Name

Description

selobjects

old_query

query string (query to be modified)

sys_branchquerypath

partial query string (i.e. objcreatedby )

sys_query

query string (result)

Additional Information


FSCVENV@1.1001:ExploreAppViewHook Permanent link for this heading

This action is called every time the ExploreAppView is calculated.

void FSCVENV@1.1001:ExploreAppViewHook(
  object venv_object,
  object venv_parent,
  optional integer venv_index,
  object venv_view,
  ref object venv_action,
  optional object venv_currselobjs,
  ref object venv_openview)

Name

Description

venv_object

Current object

venv_parent

Parent object

venv_index

venv_view

Active attribute definition

venv_action

venv_currselobjs

currently selected objects

venv_openview

Additional Information


FSCVENV@1.1001:ExploreData Permanent link for this heading

void FSCVENV@1.1001:ExploreData()

Additional Information


FSCVENV@1.1001:ExploreFill Permanent link for this heading

Fill the Nodes of an explore tree.

void FSCVENV@1.1001:ExploreFill(
  ref dictionary dictionary,
  string todo,
  optional integer[] path_to_the_node,
  optional object[] possible_attributes,
  optional object seltreeinfo,
  optional object seltreetargetobj,
  optional boolean checkismultiple,
  optional boolean displayallobjcets,
  optional boolean searchmode,
  optional object dispobjclass,
  optional dictionary seltreeinfodict)

Name

Description

dictionary

dictionary is the container where all tree information is stored

todo

"todo" flag defines which task to manage "fill" ... fills the node "init" .... initializes tree "open" ... opens a node "close" ... closes a node

path_to_the_node

Integer Array which defines the path to the node selected

possible_attributes

This list defines which attributes are visible in a tree

seltreeinfo

seltreetargetobj

checkismultiple

displayallobjcets

searchmode

dispobjclass

seltreeinfodict

Additional Information


FSCVENV@1.1001:ExploreMailContent Permanent link for this heading

Explore mail content

void FSCVENV@1.1001:ExploreMailContent()

Additional Information


FSCVENV@1.1001:ExploreMailData Permanent link for this heading

Explore mail data

void FSCVENV@1.1001:ExploreMailData()

Additional Information


FSCVENV@1.1001:ExploreObjectHook Permanent link for this heading

This action is called when explore object is entered for a specific object.

void FSCVENV@1.1001:ExploreObjectHook(
  object venv_object,
  object venv_parent,
  optional integer venv_index,
  object venv_view,
  ref object venv_action,
  optional object venv_currselobjs)

Name

Description

venv_object

Current object

venv_parent

Parent object

venv_index

venv_view

Active attribute definition

venv_action

venv_currselobjs

currently selected objects

Additional Information


FSCVENV@1.1001:ExploreSingleNode Permanent link for this heading

Generates a dictionary filled with the values of a single node in an explore tree.

void FSCVENV@1.1001:ExploreSingleNode(
  out dictionary[] nodedictionaries)

Name

Description

nodedictionaries

Nodes values stored in a dictionary

Additional Information


FSCVENV@1.1001:FillEvents Permanent link for this heading

Calculates the InfoList aggregate, that is displayed in the welcome screen

void FSCVENV@1.1001:FillEvents(
  out InfoList[] events,
  boolean iswelcomescreen,
  object[] prerequfailed)

Name

Description

events

InfoList, which is displayed in the welcome screen

iswelcomescreen

Indicator, that the result is used for the welcome screen

prerequfailed

Prerequisites, which failed the tests for the web browser state

Additional Information


FSCVENV@1.1001:FillEventsCallback Permanent link for this heading

void FSCVENV@1.1001:FillEventsCallback(
  ref InfoList[] events,
  boolean iswelcomescreen,
  ref object[] prerequfailed)

Name

Description

events

iswelcomescreen

prerequfailed

Additional Information


FSCVENV@1.1001:FillInstantiateList Permanent link for this heading

void FSCVENV@1.1001:FillInstantiateList(
  object view,
  object[] createableclasses,
  object[] categories,
  object[] templateswithoutcat,
  out InstantiateList[] instantiatelist,
  out object[] mostrecent,
  out object[] favorites,
  optional boolean filtertemplateclasses,
  optional object[] collectionsources,
  optional boolean ignoretemplates)

Name

Description

view

createableclasses

categories

templateswithoutcat

instantiatelist

mostrecent

favorites

filtertemplateclasses

collectionsources

ignoretemplates

Additional Information


FSCVENV@1.1001:FillPrerequisites Permanent link for this heading

void FSCVENV@1.1001:FillPrerequisites(
  out InfoList prerequisites,
  object[] prerequfailed,
  optional object[] prerequfailedopt,
  optional object[] prerequpassed)

Name

Description

prerequisites

prerequfailed

prerequfailedopt

prerequpassed

Additional Information


FSCVENV@1.1001:FillSettingsOverview Permanent link for this heading

void FSCVENV@1.1001:FillSettingsOverview(
  out InfoList[] infolist,
  object[] prerequfailed,
  object[] prerequfailedopt)

Name

Description

infolist

prerequfailed

prerequfailedopt

Additional Information


FSCVENV@1.1001:FillUserRoles Permanent link for this heading

Fills the aggregate UserRoleList

void FSCVENV@1.1001:FillUserRoles(
  ref optional UserRoleList[] userrole)

Name

Description

userrole

Filled aggregate

Additional Information


FSCVENV@1.1001:FillVersions Permanent link for this heading

Fills the aggregate FSCVEN@1.1001:ObjectVersionList

void FSCVENV@1.1001:FillVersions(
  out ObjectVersionList[] versions,
  optional boolean includearchivedversions,
  optional boolean excluderemains,
  optional boolean includecurrentversion,
  optional boolean excludecurrentusedversion)

Name

Description

versions

Filled aggregate

includearchivedversions

excluderemains

includecurrentversion

excludecurrentusedversion

Additional Information


FSCVENV@1.1001:FilterDisplayViews Permanent link for this heading

Filter column settings

void FSCVENV@1.1001:FilterDisplayViews(
  object[] venv_displayviews_in,
  boolean venv_forload_in,
  out object[] venv_displayviews_out)

Name

Description

venv_displayviews_in

venv_forload_in

venv_displayviews_out

Additional Information


FSCVENV@1.1001:FilterMindbreezeSearchResultDicts Permanent link for this heading

This action is triggered whenever a mindbreeze search result is calculated. Thus, the data in the searchresults dict can be filtered. Note that potentially also metadata like estimationcount has to be adjusted.

dictionary[] FSCVENV@1.1001:FilterMindbreezeSearchResultDicts(
  ref retval dictionary[] searchresults)

Name

Description

searchresults

the data of the mindbreeze search result chunk

Additional Information


FSCVENV@1.1001:FinalizeImport Permanent link for this heading

Finalizes the import process. Here the imported objects can be enclosed to other objects.

boolean FSCVENV@1.1001:FinalizeImport(
  object venv_parent,
  object venv_view,
  object[] venv_importobjects,
  optional boolean venv_donotshare,
  optional Field[] branchattr,
  optional integer[] branchindex,
  out retval boolean handleshareexternal,
  optional boolean venv_importok,
  ref optional object venv_navigateto,
  optional dictionary venv_importdescription)

Name

Description

venv_parent

Container object

venv_view

Container view

venv_importobjects

The imported objects

venv_donotshare

This parameter indicates that the imported objects were not shared during the import process so far.

branchattr

Attribute path to object lists attribute definition.

branchindex

Index through the branchattribute array.

handleshareexternal

This parameter indicates that the imported objects will be shared from external code.

venv_importok

This parameter indicates that the import process has succeeded so far.

venv_navigateto

This parameter indicates that after finalizing the import FinalizeImport should navigate to this object.

venv_importdescription

This parameter is a description of the import process. It is generated by the Fabasoft Folio/Fabasoft Cloud Client. This dictionary can be used to identify the hierarchy of the imported objects. To identify a child object you have to check the unclecount attribute of the previous sibling.
Example:
Import of an e-mail (outermail.msg) with two attachments together with two pdf documents (mydocument1.pdf and mydocument2.pdf).
The e-mail outermail.msg contains two attachments.
The first attachment of outermail.msg is a picture (mypicture1.png).
The second attachment is an e-mail (innermail.msg) which contains one picture (mypicture2.png).
The mail split decision for all e-mails was "E-Mail Text and Separate Attachment".

Import structure is:
  • outermail.msg
    • mypicture1.png
    • innermail.msg
      • mypicture2.png
  • mydocument1.pdf
  • mydocument2.pdf
The import description dictionary will look like:

dictionary venv_importdescription = {
 importdescription = [
   {
     _: "Entry",
     filename: "outermail.msg",
     objaddress: "COO.1.3150.4.4458",
     unclecount: 2 // Next 2 entries are child/attachment of this mail
   },
   {
     _: "Entry",
     filename: "mypicture1.pdf",
     objaddress: "COO.1.3150.4.4459",
     unclecount: 0
   },
   {
     _: "Entry",
     filename: "innermail.msg",
     objaddress: "COO.1.3150.4. 4460",
     unclecount: 1 // Next entry is a child/attachment of this mail
   },
   {
     _: "Entry",
     filename: "mypicture2.png",
     objaddress: "COO.1.3150.4. 4461",
     unclecount: 0
   },
   {
     _: "Entry",
     filename: "mydocument1.pdf",
     objaddress: "COO.1.3150.4. 4462",
     unclecount: 0
   },
   {
     _: "Entry",
     filename: "mydocument2.pdf",
     objaddress: "COO.1.3150.4. 4463",
     unclecount: 0
   }
 ]
}

Additional Information


FSCVENV@1.1001:FinalizePrinterImport Permanent link for this heading

void FSCVENV@1.1001:FinalizePrinterImport(
  object[] importobjects,
  object parent,
  object view)

Name

Description

importobjects

parent

view

Additional Information


FSCVENV@1.1001:FixObjectVersion Permanent link for this heading

Save version of object and start a new version.

void FSCVENV@1.1001:FixObjectVersion(
  optional integer handle,
  optional integer index,
  optional string desctext,
  out optional integer versnr,
  optional boolean autofixed)

Name

Description

handle

index

desctext

versnr

autofixed

Additional Information


FSCVENV@1.1001:FormatBytes Permanent link for this heading

string FSCVENV@1.1001:FormatBytes(
  float bytes,
  out retval string result)

Name

Description

bytes

result

Additional Information


FSCVENV@1.1001:GenAdditionalFilenames Permanent link for this heading

Generate additional filenames for opening contents

void FSCVENV@1.1001:GenAdditionalFilenames(
  ref string[] additionalfilenames)

Name

Description

additionalfilenames

Additional Information


FSCVENV@1.1001:GenerateMailSubject Permanent link for this heading

Generates a mail subject containing the names of objects given through object list of "selobjects"

void FSCVENV@1.1001:GenerateMailSubject(
  object[] selobjects,
  ref optional string subjectstring)

Name

Description

selobjects

list of objects. These names are the input to generate the subject string.

subjectstring

The calculated output string

Additional Information


FSCVENV@1.1001:GenerateOnlineHelpUrl Permanent link for this heading

Create URL of online help.

void FSCVENV@1.1001:GenerateOnlineHelpUrl(
  string rel_url_path,
  optional object language,
  ref optional string onlinehelpurl)

Name

Description

rel_url_path

relative path to the help directory

language

language of the help file required (part of the path)

onlinehelpurl

URL of online help generated by the procedure

Additional Information


FSCVENV@1.1001:GenerateQueryFromObjname Permanent link for this heading

Generates a start query according to object limit and object name.

void FSCVENV@1.1001:GenerateQueryFromObjname(
  string objectname,
  out string query,
  optional integer maxnumofhits)

Name

Description

objectname

Object name

query

Query string

maxnumofhits

Object limit

Additional Information


FSCVENV@1.1001:GenerateQueryHead Permanent link for this heading

Generates query string according to the user environment search settings (LIMIT and/or TIMEOUT) and the object class.

void FSCVENV@1.1001:GenerateQueryHead(
  object venv_searchclass,
  ref string query,
  optional object[] domains,
  optional integer objectlimit,
  optional integer timelimit,
  optional boolean usederivedclasses,
  optional boolean createnewquery,
  optional object queryscope,
  optional object[] obsolete,
  optional dictionary state)

Name

Description

venv_searchclass

Object class to search for

query

Generated query string

domains

Search domains

objectlimit

Object limit

timelimit

Time limit

usederivedclasses

Boolean input saying whether to use derived classes

createnewquery

queryscope

obsolete

state

Additional Information


FSCVENV@1.1001:GenOLEClassId Permanent link for this heading

Generate OLE class string for opening contents

void FSCVENV@1.1001:GenOLEClassId(
  ref string[] oleclassid)

Name

Description

oleclassid

Additional Information


FSCVENV@1.1001:GenOptionString Permanent link for this heading

Generate option string for opening contents

void FSCVENV@1.1001:GenOptionString(
  ref string[] options,
  optional string extension,
  optional object venv_action)

Name

Description

options

extension

venv_action

Additional Information


FSCVENV@1.1001:GenStringFromArray Permanent link for this heading

void FSCVENV@1.1001:GenStringFromArray(
  object[] selobjects,
  optional object[] attrpath,
  ref optional string outstring)

Name

Description

selobjects

attrpath

outstring

Additional Information


FSCVENV@1.1001:GenStringFromStringList Permanent link for this heading

Generate a string separated by ';' out of string array. Optionally separator can be defined with the 'separator' -parameter.

string FSCVENV@1.1001:GenStringFromStringList(
  string[] selstrings,
  out retval string outstring,
  optional string separator)

Name

Description

selstrings

outstring

separator

Additional Information


FSCVENV@1.1001:GenStringListFromString Permanent link for this heading

Generate a string array out of string separated by ';'

string[] FSCVENV@1.1001:GenStringListFromString(
  string instring,
  out retval string[] outstrings,
  optional string separator)

Name

Description

instring

the instring

outstrings

the outstrings

separator

the separator

Additional Information


FSCVENV@1.1001:GenURLParams Permanent link for this heading

Prepares the commit of changes.

string FSCVENV@1.1001:GenURLParams(
  out retval string urlparams,
  dictionary args)

Name

Description

urlparams

args

Additional Information


FSCVENV@1.1001:GetAbstractAttributes Permanent link for this heading

Calculate category attributes which should be shown in the object abstract

AttributeDefinition[] FSCVENV@1.1001:GetAbstractAttributes(
  out retval AttributeDefinition[] abstractattributes)

Name

Description

abstractattributes

list of attributes

Additional Information


FSCVENV@1.1001:GetAccountInfo Permanent link for this heading

void FSCVENV@1.1001:GetAccountInfo(
  out string quotahtml,
  out string loginhtml,
  out string serviceloginhtml,
  boolean iswelcomescreen)

Name

Description

quotahtml

loginhtml

serviceloginhtml

iswelcomescreen

Additional Information


FSCVENV@1.1001:GetActionsHtml Permanent link for this heading

void FSCVENV@1.1001:GetActionsHtml(
  out string html,
  out string backgroundimage)

Name

Description

html

backgroundimage

Additional Information


FSCVENV@1.1001:GetActiveFilterMenu Permanent link for this heading

Get active filter

void FSCVENV@1.1001:GetActiveFilterMenu(
  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


FSCVENV@1.1001:GetActiveMailPortalPart Permanent link for this heading

void FSCVENV@1.1001:GetActiveMailPortalPart(
  out object portalpart)

Name

Description

portalpart

Additional Information


FSCVENV@1.1001:GetAdditionalTaskTarget Permanent link for this heading

Get an additional object for which the tasks should be added to the task pane of the current object

object FSCVENV@1.1001:GetAdditionalTaskTarget(
  out retval object target,
  optional boolean checktaskpane,
  optional AdditionalTaskDisplayMode displaymode)

Name

Description

target

the additional task target

checktaskpane

if not set the action is called to replace the displayed object with the additional task target This means the actions of the current object are displayed but the additional task target is used for the bread crumb and the pdf overview

displaymode

the display mode of the additional tasks

Additional Information


FSCVENV@1.1001:GetAdditionalTaskTargetMenuCaption Permanent link for this heading

Retrieve the caption and the symbol for the additional tasks menu group

string FSCVENV@1.1001:GetAdditionalTaskTargetMenuCaption(
  out retval string caption,
  out optional Symbol symbol,
  out optional boolean nosubmenus)

Name

Description

caption

the caption is used as the displayed name of the menu group

symbol

the symbol is used as menu symbol for the menu group

nosubmenus

Additional Information


FSCVENV@1.1001:GetAdditionalTaskTargetMenus Permanent link for this heading

Dynamic menu action used to display the tasks of the additional task target as a sub menu

void FSCVENV@1.1001:GetAdditionalTaskTargetMenus(
  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


FSCVENV@1.1001:GetAllSearchClasses Permanent link for this heading

Calculate the classes available for search depending on the parent object.

void FSCVENV@1.1001:GetAllSearchClasses(
  out object[] localclasses)

Name

Description

localclasses

List of object classes available for search

Additional Information


FSCVENV@1.1001:GetAvailableClasses Permanent link for this heading

Calculate the classes available for creation/search

void FSCVENV@1.1001:GetAvailableClasses(
  object venv_object,
  object venv_view,
  out object[] availableclasses,
  out boolean classesfound,
  out boolean issingle,
  optional boolean noabstract,
  optional boolean create,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean controlstartedsearch,
  optional boolean venv_isexplore)

Name

Description

venv_object

Current object

venv_view

Attribute definition

availableclasses

Object classes available

classesfound

True if availableclasses.count()>0

issingle

True if availableclasses.count()==1

noabstract

If this parameter equals true, abstract object classes are not used for finding the available object classes

create

If this parameter equals true, mode=CAM_CREATE If this parameter equals false, mode=CAM_SHARE If this parameter equals true, mode=0

branchattribute

branchindex

controlstartedsearch

venv_isexplore

Additional Information


FSCVENV@1.1001:GetAvailableColumnsXMLHTTP Permanent link for this heading

void FSCVENV@1.1001:GetAvailableColumnsXMLHTTP(
  string arguments,
  out string menureference)

Name

Description

arguments

menureference

Additional Information


FSCVENV@1.1001:GetAvailableSearchClasses Permanent link for this heading

Calculate the object classes available for search

void FSCVENV@1.1001:GetAvailableSearchClasses(
  object venv_object,
  object venv_view,
  out object[] availableclasses,
  out boolean classesfound,
  out boolean issingle,
  optional boolean noabstract,
  optional boolean create,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean controlstartedsearch,
  optional boolean venv_isexplore,
  out boolean usederived)

Name

Description

venv_object

venv_view

availableclasses

classesfound

issingle

noabstract

create

branchattribute

branchindex

controlstartedsearch

venv_isexplore

usederived

Additional Information


FSCVENV@1.1001:GetAxURL Permanent link for this heading

Retrieves the ax url for an application (Application).

string FSCVENV@1.1001:GetAxURL(
  optional dictionary parameters,
  out retval string axurl)

Name

Description

parameters

An optional dictionary holding key/value pairs of parameters that are used to generate the ax url. There is no check whether the dictionary entry names match the parameter names of the prototype of the application. The value of a dictionary entry is implicitly casted to a string and is url encoded by this method.

axurl

Additional Information


FSCVENV@1.1001:GetBackgroundMenuHeadHtml Permanent link for this heading

generate html displayed as header for weighted background menus in lists.

void FSCVENV@1.1001:GetBackgroundMenuHeadHtml(
  out string headhtml,
  out string footerhtml,
  integer menucount,
  object attrdef)

Name

Description

headhtml

footerhtml

menucount

attrdef

Additional Information


FSCVENV@1.1001:GetBasicPrerequisiteHtml Permanent link for this heading

void FSCVENV@1.1001:GetBasicPrerequisiteHtml(
  out string html)

Name

Description

html

Additional Information


FSCVENV@1.1001:GetBlurredImageForString Permanent link for this heading

Get Blurred Image for given String

Content FSCVENV@1.1001:GetBlurredImageForString(
  string string,
  out retval Content content,
  optional string bgcolor,
  optional string fontcolor,
  optional string linecolor,
  optional integer linewidth)

Name

Description

string

content

bgcolor

fontcolor

linecolor

linewidth

Additional Information


FSCVENV@1.1001:GetBrandingDescription Permanent link for this heading

Retrieves the description text for branding.

void FSCVENV@1.1001:GetBrandingDescription(
  object attrdef,
  out string title,
  out string[] description)

Name

Description

attrdef

title

description

Additional Information


FSCVENV@1.1001:GetBreadCrumb Permanent link for this heading

Calculates and caches the bread crumb of an object. The method itself does not calculate anything. It just caches the value in a transaction variable (TV_BREADCRUMB).
This transaction variable is also set if the bread crumb is calculated on the client.
This method may be extended by a prewrapper to provide a bread crumb even if it was not generated on the client (e.g. when starting a vApp).
The first element in the bread crumb list is the top level object (home or root). The current object must be the last element of the bread crumb.
If you want to retrieve the current bread crumb, do not check TV_BREADCRUMB directly (except when implementing a prewrapper) but call this method.
Please note that there may be up to two bread crumb entries for an object if the object has multiple lists. The first entry (with breadcrumbview == null) represents the dash board of the object. The second entry (with breadcrumbview != null) represents the appropriate object list.
If you implement a prewrapper, you should do nothing if TV_BREADCRUMB has already a value. This means you should not override the bread crumb generated on the client.

Breadcrumb[] FSCVENV@1.1001:GetBreadCrumb(
  out retval Breadcrumb[] breadcrumb,
  optional AttributeDefinition view,
  optional object context)

Name

Description

breadcrumb

A list of Breadcrumb entries.

view

An object list that is currently shown. The bread crumb element of the current object should refer to this attribute.

context

the current object is displayed in the context of this object. E.g.: The object is displayed in the context of an activity

Additional Information


FSCVENV@1.1001:GetCancelProgress Permanent link for this heading

Get the cancel state of the asynchronous operation. This indicates whether the asynchronous operation was canceled (e.g. by the user by pressing the Cancel button in the StartAsyncWithProgressApp).

boolean FSCVENV@1.1001:GetCancelProgress(
  out retval boolean canceled)

Name

Description

canceled

The cancel state of the asynchronous operation.

Additional Information


FSCVENV@1.1001:GetCategoryTree Permanent link for this heading

Get category tree

void FSCVENV@1.1001:GetCategoryTree(
  object[] venv_treevalues,
  string venv_catpropertyexpr,
  string venv_catstructpropertyexpr,
  optional string venv_objclusterexpr,
  out dictionary venv_tree,
  optional string venv_objclusterexpr2,
  optional integer venv_openplanes)

Name

Description

venv_treevalues

venv_catpropertyexpr

venv_catstructpropertyexpr

venv_objclusterexpr

venv_tree

venv_objclusterexpr2

venv_openplanes

Additional Information


FSCVENV@1.1001:GetColumnLoadStates Permanent link for this heading

Get states and templates available for loading in this object list

void FSCVENV@1.1001:GetColumnLoadStates(
  object venv_view,
  out boolean venv_me_obj,
  out boolean venv_me_objclass,
  out boolean venv_all_obj,
  out boolean venv_all_objclass,
  string identpath,
  string settingskey,
  dictionary state,
  optional boolean modereset,
  optional Field[] branchattr,
  optional integer[] branchindex,
  out optional boolean isaggrpath)

Name

Description

venv_view

venv_me_obj

venv_me_objclass

venv_all_obj

venv_all_objclass

identpath

settingskey

state

modereset

branchattr

branchindex

isaggrpath

Additional Information


FSCVENV@1.1001:GetColumns Permanent link for this heading

DisplayColumnList[] FSCVENV@1.1001:GetColumns(
  object attrdef,
  object targetobject,
  string selection,
  ref InstantiateList[] availablecolumns,
  out retval DisplayColumnList[] currentcolumns,
  optional integer depth,
  optional string keyword)

Name

Description

attrdef

targetobject

selection

availablecolumns

currentcolumns

depth

keyword

Additional Information


FSCVENV@1.1001:GetColumnSaveStates Permanent link for this heading

Get states and templates available for saving in this object list.

void FSCVENV@1.1001:GetColumnSaveStates(
  object venv_view,
  out boolean venv_me_obj,
  out boolean venv_me_objclass,
  out boolean venv_all_obj,
  out boolean venv_all_objclass,
  out boolean venv_template,
  optional Field[] branchattr,
  optional integer[] branchindex,
  out boolean isaggrpath)

Name

Description

venv_view

venv_me_obj

venv_me_objclass

venv_all_obj

venv_all_objclass

venv_template

branchattr

branchindex

isaggrpath

Additional Information


FSCVENV@1.1001:GetContentData Permanent link for this heading

Calculates content attributes (contextension, contoleclassid, contsize) out of an content objects dav path.

void FSCVENV@1.1001:GetContentData(
  string davpath,
  out string venv_contextension,
  out string venv_contoleclassid,
  out integer venv_contsize,
  out datetime venv_contchanged,
  optional object[] venv_objectlist,
  out optional string venv_fallbackoverviewcontext)

Name

Description

davpath

DAV Path

venv_contextension

venv_contoleclassid

venv_contsize

venv_contchanged

venv_objectlist

venv_fallbackoverviewcontext

Additional Information


FSCVENV@1.1001:GetContentNames Permanent link for this heading

Get names of contents to be sent

void FSCVENV@1.1001:GetContentNames(
  string arguments,
  out string attachments)

Name

Description

arguments

attachments

Additional Information


FSCVENV@1.1001:GetContentsInfo Permanent link for this heading

void FSCVENV@1.1001:GetContentsInfo(
  object venv_object,
  object venv_view,
  out boolean noinfo,
  out string extension)

Name

Description

venv_object

venv_view

noinfo

extension

Additional Information


FSCVENV@1.1001:GetContentToBeSent Permanent link for this heading

Calculate the content to be sent. (Hook for distributed contents like file,...)

void FSCVENV@1.1001:GetContentToBeSent(
  string argument,
  out content content)

Name

Description

argument

content

Additional Information


FSCVENV@1.1001:GetContextObjOrError Permanent link for this heading

Determine context object from venv_contextinfo, if context is not valid for insertion, an errortext is returned describing the reason.

object FSCVENV@1.1001:GetContextObjOrError(
  optional string venv_contextinfo,
  out optional string errortext,
  out retval object venv_context,
  string srcobjadress,
  string elementname)

Name

Description

venv_contextinfo

defines the context for insertion.

errortext

defines the error text which is returned in error case.

venv_context

defines the context object. In case of an error, venv_context is not set.

srcobjadress

defines the object address of the source document.

elementname

defines the element name of the current context.

Additional Information


FSCVENV@1.1001:GetCreateDomains Permanent link for this heading

void FSCVENV@1.1001:GetCreateDomains(
  object view,
  out object coostdom,
  out object[] clientdomains)

Name

Description

view

coostdom

clientdomains

Additional Information


FSCVENV@1.1001:GetCurrentLocationTitle Permanent link for this heading

string FSCVENV@1.1001:GetCurrentLocationTitle(
  out retval string title)

Name

Description

title

Additional Information


FSCVENV@1.1001:GetDashboardWidgetSubMenuXMLHTTP Permanent link for this heading

Receives the Submenu for Dashboard Widgets

string FSCVENV@1.1001:GetDashboardWidgetSubMenuXMLHTTP(
  string arguments,
  out retval string result)

Name

Description

arguments

the input

result

a submenu

Additional Information


FSCVENV@1.1001:GetDDAction Permanent link for this heading

Calculate the possible "dropflags" depending on the drag and drop actions at the object class.

void FSCVENV@1.1001:GetDDAction(
  object targetclass,
  ref object targetattrdef,
  ref integer dropflags,
  ref optional object dropaction,
  optional boolean invalidattrdef,
  optional object[] dragobjects,
  optional object dragparent)

Name

Description

targetclass

Object class of the target object.

targetattrdef

Attribute definition of the target object.

dropflags

Calculated drop flags. 1...copy, 2...link, 4...move

dropaction

invalidattrdef

dragobjects

dragparent

Additional Information


FSCVENV@1.1001:GetDisplayViews Permanent link for this heading

Get display views

void FSCVENV@1.1001:GetDisplayViews(
  object view,
  boolean checksetaccess,
  out object[] displayviews)

Name

Description

view

current view

checksetaccess

check set access

displayviews

the display views

Additional Information


FSCVENV@1.1001:GetDownloadURL Permanent link for this heading

Get download url

string FSCVENV@1.1001:GetDownloadURL(
  out retval string url)

Name

Description

url

Additional Information


FSCVENV@1.1001:GetEmptyListDescription Permanent link for this heading

Retrieves the description text for empty object and aggregate lists.

void FSCVENV@1.1001:GetEmptyListDescription(
  object attrdef,
  out string title,
  out string[] description,
  optional boolean islean,
  optional boolean isfilterbasedempty)

Name

Description

attrdef

title

description

islean

isfilterbasedempty

Additional Information


FSCVENV@1.1001:GetEnterObjectStatus Permanent link for this heading

void FSCVENV@1.1001:GetEnterObjectStatus(
  out boolean venv_closeenterobject,
  object venv_parent,
  object venv_object,
  object venv_view,
  out boolean venv_navigatetonext)

Name

Description

venv_closeenterobject

venv_parent

venv_object

venv_view

venv_navigatetonext

Additional Information


FSCVENV@1.1001:GetFileName Permanent link for this heading

void FSCVENV@1.1001:GetFileName(
  object[] attrdefs,
  integer[] indices,
  out string filename)

Name

Description

attrdefs

indices

filename

Additional Information


FSCVENV@1.1001:GetFilterMenu Permanent link for this heading

Calculates the menu regarding filter operations.

void FSCVENV@1.1001:GetFilterMenu(
  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


FSCVENV@1.1001:GetFormFromSearchForm Permanent link for this heading

Get form out of a search forms aggregate using GetForm().

void FSCVENV@1.1001:GetFormFromSearchForm(
  object venv_object,
  optional object venv_searchclass,
  object[] venv_actions,
  out object venv_form)

Name

Description

venv_object

venv_searchclass

venv_actions

venv_form

Additional Information


FSCVENV@1.1001:GetFoundObjectsBranches Permanent link for this heading

void FSCVENV@1.1001:GetFoundObjectsBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

Name

Description

appview

branches

parameters

Additional Information


FSCVENV@1.1001:GetFTSQueryConstraints Permanent link for this heading

void FSCVENV@1.1001:GetFTSQueryConstraints(
  optional object attrdef,
  optional object[] domains,
  optional object[] stores,
  out string queryconstraints,
  out string aclrestrictions,
  optional object[] categoryclasslist)

Name

Description

attrdef

domains

stores

queryconstraints

aclrestrictions

categoryclasslist

Additional Information


FSCVENV@1.1001:GetHeader Permanent link for this heading

Calculates the strings displayed as header above the tasks.

string[] FSCVENV@1.1001:GetHeader(
  out retval string[] header)

Name

Description

header

the header strings. The string in headers[0] is displayed as the first line. All other strings are joined and displayed as a second line.

Additional Information


FSCVENV@1.1001:GetHeaderLayout Permanent link for this heading

Retrieves the header layout (i.e. backgroundcolor)

dictionary FSCVENV@1.1001:GetHeaderLayout(
  LogoType logotype,
  out retval dictionary headerlayout)

Name

Description

logotype

headerlayout

Additional Information


FSCVENV@1.1001:GetInstantiateValues Permanent link for this heading

object[] FSCVENV@1.1001:GetInstantiateValues(
  InstantiateList[] instantiatelist,
  string selection,
  out retval object[] values)

Name

Description

instantiatelist

selection

values

Additional Information


FSCVENV@1.1001:GetLinkInfo Permanent link for this heading

Retrieve link information.

string FSCVENV@1.1001:GetLinkInfo(
  out retval string linkcontent)

Name

Description

linkcontent

Additional Information


FSCVENV@1.1001:GetListEntriesString Permanent link for this heading

Retrieves the string representing the number of rows in a list.

void FSCVENV@1.1001:GetListEntriesString(
  integer rowcount,
  integer totalrowcount,
  out string entriesstring)

Name

Description

rowcount

totalrowcount

entriesstring

Additional Information


FSCVENV@1.1001:GetListView Permanent link for this heading

ListView FSCVENV@1.1001:GetListView(
  object attrdef,
  out retval ListView listview)

Name

Description

attrdef

listview

Additional Information


FSCVENV@1.1001:GetLocalObjects Permanent link for this heading

void FSCVENV@1.1001:GetLocalObjects(
  string arguments,
  out dictionary xmldictionary)

Name

Description

arguments

xmldictionary

Additional Information


FSCVENV@1.1001:GetMailBranches Permanent link for this heading

void FSCVENV@1.1001:GetMailBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

Name

Description

appview

branches

parameters

Additional Information


FSCVENV@1.1001:GetMenuShowEnvironmentStatus Permanent link for this heading

Get State TaskPane

void FSCVENV@1.1001:GetMenuShowEnvironmentStatus(
  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


FSCVENV@1.1001:GetMenuXMLHTTP Permanent link for this heading

string FSCVENV@1.1001:GetMenuXMLHTTP(
  string arguments,
  out retval string menureference)

Name

Description

arguments

menureference

Additional Information


FSCVENV@1.1001:GetModifiedErrorText Permanent link for this heading

Generate a modified error text

string FSCVENV@1.1001:GetModifiedErrorText(
  object errorobj,
  out retval string errortext,
  string parameter1,
  optional string parameter2,
  optional string parameter3,
  optional string parameter4,
  optional string parameter5)

Name

Description

errorobj

errortext

parameter1

parameter2

parameter3

parameter4

parameter5

Additional Information


FSCVENV@1.1001:GetMostRecentClasses Permanent link for this heading

Calculate the object classes already existing in the parent object (i.e. folder).

void FSCVENV@1.1001:GetMostRecentClasses(
  object venv_object,
  object venv_view,
  out object[] localclasses,
  out boolean localsdefined,
  out boolean issingle,
  optional boolean create,
  optional object[] definedclasses)

Name

Description

venv_object

Current object

venv_view

Attribute definition

localclasses

Object classes found in the object (according to the attribute definition)

localsdefined

True if localcasses.count()>0

issingle

create

definedclasses

Additional Information


FSCVENV@1.1001:GetMxURL Permanent link for this heading

Retrieves the mx url for an object.

string FSCVENV@1.1001:GetMxURL(
  out retval string mxurl)

Name

Description

mxurl

The mx url for the object.

Additional Information


FSCVENV@1.1001:GetObjectImageFallback Permanent link for this heading

Get object image.

Content FSCVENV@1.1001:GetObjectImageFallback(
  string name,
  out retval Content image,
  optional integer page)

Name

Description

name

image

page

Additional Information


FSCVENV@1.1001:GetObjectsFromString Permanent link for this heading

Get Fabasoft Folio objects from string

object[] FSCVENV@1.1001:GetObjectsFromString(
  string instring,
  out retval object[] objects,
  optional string separator,
  optional string prefix)

Name

Description

instring

objects

separator

prefix

Additional Information


FSCVENV@1.1001:GetObjectSymbolFriendlyUrl Permanent link for this heading

void FSCVENV@1.1001:GetObjectSymbolFriendlyUrl(
  optional string objaddr,
  string name,
  out Content image)

Name

Description

objaddr

name

image

Additional Information


FSCVENV@1.1001:GetOpenOnlineAction Permanent link for this heading

Get the action which is called when an object is opened with an online tool

Action FSCVENV@1.1001:GetOpenOnlineAction(
  out retval Action openaction)

Name

Description

openaction

Additional Information


FSCVENV@1.1001:GetPdfContent Permanent link for this heading

Convert the object, represented by the address, into a PDF content.

void FSCVENV@1.1001:GetPdfContent(
  string address,
  string extension,
  out content pdfcontent,
  string argument,
  optional string format)

Name

Description

address

extension

pdfcontent

argument

format

Additional Information


FSCVENV@1.1001:GetPortalButtons Permanent link for this heading

Retrieves the portal buttons (i.e. try and buy)

PortalButton[] FSCVENV@1.1001:GetPortalButtons(
  out retval PortalButton[] buttons)

Name

Description

buttons

Additional Information


FSCVENV@1.1001:GetPreferredList Permanent link for this heading

Delivers the preferred list which is automatically opened when entering a dashboard. It is not supported to define a preferred list with this feature and dynamically hide or show lists at the same time.

object FSCVENV@1.1001:GetPreferredList(
  out retval object preferredlist,
  out boolean ignoredashboardinbreadcrumb)

Name

Description

preferredlist

the list, that is automatically opened (instead of viewing the dashboard)

ignoredashboardinbreadcrumb

indicates whether clicking the object in a breadcurmb should ignore the dashboard

Additional Information


FSCVENV@1.1001:GetPrerequisiteOverlay Permanent link for this heading

void FSCVENV@1.1001:GetPrerequisiteOverlay(
  out Symbol symbol,
  out string script,
  out boolean update)

Name

Description

symbol

script

update

Additional Information


FSCVENV@1.1001:GetPreviewCheckPropertyHook Permanent link for this heading

This action is called to get an optional property used to get the object which should be checked when calculating the object navigation

void FSCVENV@1.1001:GetPreviewCheckPropertyHook(
  ref object venv_checkproperty)

Name

Description

venv_checkproperty

The check property

Additional Information


FSCVENV@1.1001:GetPropertyPathFromString Permanent link for this heading

void FSCVENV@1.1001:GetPropertyPathFromString(
  string venv_importbranchattr,
  string venv_importbranchindex,
  out Field[] venv_importattr,
  out integer[] venv_importindex)

Name

Description

venv_importbranchattr

venv_importbranchindex

venv_importattr

venv_importindex

Additional Information


FSCVENV@1.1001:GetQueryData Permanent link for this heading

boolean FSCVENV@1.1001:GetQueryData(
  string query,
  out object[] domains,
  out integer objlimit,
  out integer timelimit,
  out retval boolean usederivedclasses)

Name

Description

query

domains

objlimit

timelimit

usederivedclasses

Additional Information


FSCVENV@1.1001:GetQuotaShopUrl Permanent link for this heading

string FSCVENV@1.1001:GetQuotaShopUrl(
  out retval string shopurl)

Name

Description

shopurl

Additional Information


FSCVENV@1.1001:GetReadEditMLNamePrefix Permanent link for this heading

string FSCVENV@1.1001:GetReadEditMLNamePrefix(
  out retval string mlname)

Name

Description

mlname

Additional Information


FSCVENV@1.1001:GetRedirectData Permanent link for this heading

Delivers the widget data to redirect to at login, according to the homelocation settings.

object FSCVENV@1.1001:GetRedirectData(
  out retval object redirectobject,
  out optional object redirectview,
  StartPage redirectto)

Name

Description

redirectobject

The object to which you want to redirect

redirectview

The view to which you want to redirect

redirectto

Setting that is stored in the user environment and defines the redirect at startup.

Additional Information


FSCVENV@1.1001:GetReducedSearchForm Permanent link for this heading

Get reduced search form.

void FSCVENV@1.1001:GetReducedSearchForm(
  object venv_searchclass,
  out object venv_reducedsearchform)

Name

Description

venv_searchclass

the venv_searchclass

venv_reducedsearchform

the venv_reducedsearchform

Additional Information


FSCVENV@1.1001:GetResearchFoundObjectsBranches Permanent link for this heading

void FSCVENV@1.1001:GetResearchFoundObjectsBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

Name

Description

appview

branches

parameters

Additional Information


FSCVENV@1.1001:GetResearchMaskBranches Permanent link for this heading

void FSCVENV@1.1001:GetResearchMaskBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

Name

Description

appview

branches

parameters

Additional Information


FSCVENV@1.1001:GetResearchNoObjectsBranches Permanent link for this heading

void FSCVENV@1.1001:GetResearchNoObjectsBranches(
  object appview,
  ref Branch[] branches,
  dictionary parameters)

Name

Description

appview

branches

parameters

Additional Information


FSCVENV@1.1001:GetTaskPaneMenuStructList Permanent link for this heading

Retrieves the TaskPane data

Example 1: TaskPane for a Folder (mychildfolder)

  taskparent = myparentfolder;
  targetobject = mychildfolder;
  taskview = #objchildren;
  appcontext = #ExploreAppView;


Example 2: TaskPane for a NoteObject (mychildnoteobj) Inside a Folder (myparentfolder)

  taskparent = myparentfolder;
  targetobject = mychildnoteobj;
  taskview = #objchildren;
  taskobjects = mychildnoteobj;
  appcontext = #PreviewAppView;

dictionary FSCVENV@1.1001:GetTaskPaneMenuStructList(
  object targetobject,
  object taskparent,
  optional AttributeDefinition taskview,
  optional object appcontext,
  optional TaskPane taskpane,
  optional object[] taskobjects,
  optional boolean isedit,
  optional boolean isexplore,
  optional boolean issearch,
  optional boolean iscreate,
  optional boolean isdraganddrop,
  optional boolean isctxmenu,
  optional datetime pointintime,
  optional string dropflags,
  out retval dictionary taskpanedata)

Name

Description

targetobject

The targetobject is used to calculate the TaskPane with the help of a GetCommand call and to evaluate the tasktarget expression.

taskparent

This parameter represents the parent object.

taskview

The attribute definition, where the child objects are located.

appcontext

The context object may influence the calculation of the TaskPane. (e.g. the applicationview or the app object used as uiscope)

taskpane

The TaskPane object (e.g. MainTaskPaneObject or TaskPaneAdditionalTasks)

taskobjects

These are the currently selected objects (current selection).

isedit

Is the taskview inside the taskparent editable?
The fallback is true.

isexplore

Is the TaskPane calcualted for an explorer view (explorer vs. attribute editor)?
The fallback is true.

issearch

Is searching allowed in the taskview inside the taskparent?
The fallback is true.

iscreate

Is creating objects allowed in the taskview inside the taskparent?
The fallback is true.

isdraganddrop

Is dragging and dropping allowed in the taskview inside the taskparent?
The fallback is true.

isctxmenu

Is opening a context menu allowed in the taskview inside the taskparent?
The fallback is true.

pointintime

The point in time is relevant for calculating the TaskPane, when the system is in time travel (mode).

dropflags

This is the string representation of the dropflags.
The fallback is "7" - which means Link, Copy and Move is allowed.
dropflags = 0;
dropflags |= DROPFLAGS_LINK; // 1
dropflags |= DROPFLAGS_COPY; // 2
dropflags |= DROPFLAGS_MOVE; // 4

taskpanedata

A dictionary containing data corresponding to MenuStructList structure.

Additional Information


FSCVENV@1.1001:GetTC Permanent link for this heading

Get the transaction context (TC).

string FSCVENV@1.1001:GetTC(
  out retval string tc)

Name

Description

tc

Additional Information


FSCVENV@1.1001:GetTreeOpenMenu Permanent link for this heading

void FSCVENV@1.1001:GetTreeOpenMenu(
  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


FSCVENV@1.1001:GetUserContents Permanent link for this heading

content[] FSCVENV@1.1001:GetUserContents(
  string venv_importid,
  out retval content[] cont,
  optional boolean clear,
  out optional object[] importobjects)

Name

Description

venv_importid

cont

clear

importobjects

Additional Information


FSCVENV@1.1001:GetUserFormTemplateCategories Permanent link for this heading

Calculate the forms, templates and categories, which are available in search.

void FSCVENV@1.1001:GetUserFormTemplateCategories(
  out object[] userformcategories,
  object view)

Name

Description

userformcategories

view

Additional Information


FSCVENV@1.1001:GetUsersByEMails Permanent link for this heading

void FSCVENV@1.1001:GetUsersByEMails(
  out dictionary userlist,
  ref optional string[] emaillist)

Name

Description

userlist

emaillist

Additional Information


FSCVENV@1.1001:GetValuesFromPath Permanent link for this heading

object[] FSCVENV@1.1001:GetValuesFromPath(
  Field[] branchattr,
  integer[] sys_branchindex,
  out retval object[] values)

Name

Description

branchattr

sys_branchindex

values

Additional Information


FSCVENV@1.1001:GetViewAsString Permanent link for this heading

string FSCVENV@1.1001:GetViewAsString(
  out retval string branchtext,
  boolean onlineisavailable)

Name

Description

branchtext

onlineisavailable

Additional Information


FSCVENV@1.1001:GetViewContData Permanent link for this heading

CTRLViewCont: Get behavior for "Show Full Screen" branch

void FSCVENV@1.1001:GetViewContData(
  out string branchoperator,
  ref boolean useimagecontrol,
  out boolean enableannotation)

Name

Description

branchoperator

useimagecontrol

enableannotation

Additional Information


FSCVENV@1.1001:GetXeditorData Permanent link for this heading

Calculates the Xeditor initialization data

void FSCVENV@1.1001:GetXeditorData(
  string customaction,
  ref XeditorData xeditordata,
  optional AttributeDefinition contentattrdef,
  optional string viewmode,
  optional integer autosaveinterval,
  optional object ribbonsite,
  optional boolean israwxmleditorenabled,
  optional boolean isxmlsidepanelenabled)

Name

Description

customaction

Defines the mode in which Xeditor should be opened.
Available modes:
view: Editing is completely prohibited, edit: Normal editing is allowed.

xeditordata

Defines an out parameter containing the calculated Xeditor initialization data.

contentattrdef

Defines an AttributeDefinition, which identifies the content of the document.

viewmode

Defines the view mode in which Xeditor gets started. Available modes:
full: All tool bars available, document: No tool bars (Document view mode).

autosaveinterval

Defines an auto save interval in milliseconds (ms), document gets saved automatically after the autosaveinterval is reached.
If set to 0 auto save gets disabled, For customaction 'view' auto save is disabled at all.

ribbonsite

Defines an RibbonControlSite object which is used to identify the relevant objects for the tool bar. if not set, no additional tool bar is shown at all.

israwxmleditorenabled

Defines either the Xeditor internal button 'XML-Editor' is available or not. If set to true, the button is available in the Xeditor tool bar under the Menu 'View', otherwise the button is not shown.

isxmlsidepanelenabled

Defines, whether the XML side panel is available or not. If set to true, the XML panel is available next to the table of contents, otherwise the panel is not shown.

Additional Information


FSCVENV@1.1001:HandleNewSearchForm Permanent link for this heading

Create a new search form

void FSCVENV@1.1001:HandleNewSearchForm(
  string sys_query,
  string name,
  out object createdsearchform,
  boolean editraw)

Name

Description

sys_query

name

createdsearchform

editraw

Additional Information


FSCVENV@1.1001:HasVisibleCreateItems Permanent link for this heading

Check the categories whether a template is available to enable the display of an proper UI

boolean FSCVENV@1.1001:HasVisibleCreateItems(
  object view,
  object[] createableclasses,
  object[] categories,
  object[] templates_withoutcat,
  out retval boolean hasvisibleitems,
  optional object[] collectionsources)

Name

Description

view

The view

createableclasses

Classes available for the create process

categories

Given categories

templates_withoutcat

Given templates without categories

hasvisibleitems

Are there items to display

collectionsources

the collection sources for filtering the categories

Additional Information


FSCVENV@1.1001:HideInCommonEdit Permanent link for this heading

void FSCVENV@1.1001:HideInCommonEdit(
  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


FSCVENV@1.1001:HideTaskPane Permanent link for this heading

Deprecated!

boolean FSCVENV@1.1001:HideTaskPane(
  out retval boolean hide)

Name

Description

hide

Additional Information


FSCVENV@1.1001:HideUnderLinux Permanent link for this heading

Hide the menu in Linux environments

void FSCVENV@1.1001:HideUnderLinux(
  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


FSCVENV@1.1001:ImportCheckViewDataRPC Permanent link for this heading

This action is called during the import, when no view is given initially

void FSCVENV@1.1001:ImportCheckViewDataRPC(
  string arguments,
  out dictionary xmldictionary)

Name

Description

arguments

xmldictionary

the retval

Additional Information


FSCVENV@1.1001:ImportObjectReadOnly Permanent link for this heading

void FSCVENV@1.1001:ImportObjectReadOnly(
  optional integer unused1,
  optional integer unused2,
  optional object view,
  optional string filename,
  optional boolean removefile,
  optional boolean noinsert,
  out optional object newobject,
  ref optional object coostore,
  ref optional object objclass,
  ref optional object[] classlist,
  ref optional object[] classtrees,
  optional ConfirmOp confirmop,
  optional string confirmprompt,
  optional dictionary confirmparams,
  out optional integer confirmresult)

Name

Description

unused1

unused2

view

filename

removefile

noinsert

newobject

coostore

objclass

classlist

classtrees

confirmop

confirmprompt

confirmparams

confirmresult

Additional Information


FSCVENV@1.1001:ImportWithoutPluginPrepareHook Permanent link for this heading

This action is called during the import without PlugIn, before the created object is persited.

void FSCVENV@1.1001:ImportWithoutPluginPrepareHook(
  object venv_object,
  object venv_parent,
  object venv_view)

Name

Description

venv_object

the created object

venv_parent

the container object

venv_view

... the attribute definition inside the container object

Additional Information


FSCVENV@1.1001:InitCreatedObject Permanent link for this heading

void FSCVENV@1.1001:InitCreatedObject(
  object[] attrdefs,
  dictionary values)

Name

Description

attrdefs

values

Additional Information


FSCVENV@1.1001:InitializeCreatedObject Permanent link for this heading

Hook for application to initialize created objects.

void FSCVENV@1.1001:InitializeCreatedObject(
  ref object venv_object,
  optional object venv_parent,
  optional integer venv_index,
  optional object venv_view,
  optional object venv_action)

Name

Description

venv_object

venv_parent

venv_index

venv_view

venv_action

Additional Information


FSCVENV@1.1001:InitializeCreatedObjectDoDefault Permanent link for this heading

Hook for application to initialize objects created via a control.

void FSCVENV@1.1001:InitializeCreatedObjectDoDefault(
  ref object venv_object,
  optional object venv_parent,
  optional integer venv_index,
  optional object venv_view,
  optional object venv_action)

Name

Description

venv_object

venv_parent

venv_index

venv_view

venv_action

Additional Information


FSCVENV@1.1001:InitializeCreatedObjectRole Permanent link for this heading

void FSCVENV@1.1001:InitializeCreatedObjectRole()

Additional Information


FSCVENV@1.1001:InitializeProgressObject Permanent link for this heading

Prepare the state information object of an asynchronous operation. This object may be used in a progress dialog (see StartAsyncWithProgressApp).
This method creates an new transaction, locks the object it is called on and tries to read the property progressobj. Therefore, this object must not be locked in another transaction. If no state information object is found in this property, the method creates a new instance of FSCVENV@1.1001:ProgresssObject and stores it in the property progressobj.

void FSCVENV@1.1001:InitializeProgressObject()

Additional Information


FSCVENV@1.1001:InitializeSearchSelectClassesCallback Permanent link for this heading

Predefined callback to change the state of the vApp before the AppView SearchSelectClassesAppView is displayed. You may register callback actions with the Callback customization point (Callback).

void FSCVENV@1.1001:InitializeSearchSelectClassesCallback(
  dictionary state)

Name

Description

state

The state of the virtual application (i.e. dictionary in local scope of the vApp).

Additional Information


FSCVENV@1.1001:InitializeTemplateCreatedObject Permanent link for this heading

Initialize Object created by a template

void FSCVENV@1.1001:InitializeTemplateCreatedObject(
  ref object venv_object,
  optional object venv_parent,
  optional integer venv_index,
  optional object venv_view,
  optional object venv_action)

Name

Description

venv_object

venv_parent

venv_index

venv_view

venv_action

Additional Information


FSCVENV@1.1001:IsContentModificationAllowed Permanent link for this heading

Returns if content modifications are allowed

boolean FSCVENV@1.1001:IsContentModificationAllowed(
  out retval boolean allowed)

Name

Description

allowed

returns true if content modifications are allowed on the object

Additional Information


FSCVENV@1.1001:IsEditable Permanent link for this heading

Used to check whether the object is editable in the property editor. E.g. edit mode will not be enabled:
  • The current object is a SoftwareProduct, SoftwareComponent, ComponentObject.
  • The current object is a version.
  • The current object is transferred to another location.
  • The object is in final form.
  • There is no property on the form (currently the form for EditObjectAttributes will be checked) that is changeable by the user (see also IsEditableAttribute).

boolean FSCVENV@1.1001:IsEditable(
  out retval boolean iseditable)

Name

Description

iseditable

true if the property editor should enable edit mode. @see IsEditableAttribute

Additional Information


FSCVENV@1.1001:IsEditableAttribute Permanent link for this heading

This method is called by IsEditable to determine whether the property editor can be used in edit mode for the current object. By default the property editor can be used in edit mode if there is a property that can be changed on the current form - even if the current user does not have the access type AccTypeChange (e.g. the property passed in attrdef uses CCOSYSTEM@1.1:AccTypeRead for changing values).
If you do not want that the property editor can be used in edit mode, although the property is changeable, you may wrap or overwrite this method and return false.
Note: This action is called for every property that would enable the edit mode of the property editor.

boolean FSCVENV@1.1001:IsEditableAttribute(
  AttributeDefinition attrdef,
  optional Action[] actioncontext,
  out retval boolean iseditable)

Name

Description

attrdef

An attribute that can be changed although the user does not have AccTypeChange.

actioncontext

The action context. Determines the form used by the property editor. Usually EditObjectAttributes.

iseditable

Return false if you want to override the default behavior, i.e. the property editor enables edit mode.

Additional Information


FSCVENV@1.1001:IsEqualQuery Permanent link for this heading

Check queries for equality

void FSCVENV@1.1001:IsEqualQuery(
  string sys_query,
  string save_query,
  out boolean equal)

Name

Description

sys_query

the sys_query

save_query

the save_query

equal

the equal

Additional Information


FSCVENV@1.1001:IsFieldsIntegrationEnabled Permanent link for this heading

Returns if the fields integration is enabled.

boolean FSCVENV@1.1001:IsFieldsIntegrationEnabled(
  out retval boolean allowed)

Name

Description

allowed

returns true if the fields integration is enabled for the object

Additional Information


FSCVENV@1.1001:IsObjNameChangeableUIPreWrapper Permanent link for this heading

boolean FSCVENV@1.1001:IsObjNameChangeableUIPreWrapper(
  ref dictionary scope,
  out retval boolean ischangeable)

Name

Description

scope

ischangeable

Additional Information


FSCVENV@1.1001:IsOpenOnlineEnabled Permanent link for this heading

Indicates whether online reading or online editing is enabled

boolean FSCVENV@1.1001:IsOpenOnlineEnabled(
  out retval boolean useonline)

Name

Description

useonline

Additional Information


FSCVENV@1.1001:LoadDisplayColumnListWeb Permanent link for this heading

Load column list to be displayed in web.

void FSCVENV@1.1001:LoadDisplayColumnListWeb(
  object venv_view,
  ref optional dictionary venv_usersettings,
  optional string identkey,
  optional object filter,
  out DisplayColumnList[] dispcollist,
  optional string identpath,
  optional integer columnsource,
  optional object columntemplate)

Name

Description

venv_view

venv_usersettings

identkey

filter

dispcollist

identpath

columnsource

columntemplate

Additional Information


FSCVENV@1.1001:LoadQuery Permanent link for this heading

Load "querystring" out of content.

void FSCVENV@1.1001:LoadQuery(
  content querycontent,
  out string querystring,
  out object searchclass,
  optional boolean ignorequeryhead,
  out optional object templatecategory)

Name

Description

querycontent

querystring

searchclass

ignorequeryhead

templatecategory

Additional Information


FSCVENV@1.1001:LoggedIn Permanent link for this heading

Portal logged in - hook

void FSCVENV@1.1001:LoggedIn()

Additional Information


FSCVENV@1.1001:MapExploreObjects Permanent link for this heading

This action is used to dispatch the open-inplace functionality to either the old implementation: ExploreObjectsApp or to the new OpenObjectInplaceApp. Do not implement this application!

void FSCVENV@1.1001:MapExploreObjects(
  object venv_object,
  object venv_parent,
  integer venv_index,
  object venv_view,
  object venv_action,
  optional object venv_openview)

Name

Description

venv_object

the object

venv_parent

the parent

venv_index

the index inside the view

venv_view

the view (attribute definition inside the parent)

venv_action

the current action

venv_openview

the attribute to be opened automatically (triggered i.e. due to a tree click)

Additional Information


FSCVENV@1.1001:MapOpenObjectInplace Permanent link for this heading

This action is used to dispatch the open-inplace functionality to either the old implementation: OpenCompoundObjectInplaceApp or to the new OpenObjectInplaceApp. Do not implement this application!

void FSCVENV@1.1001:MapOpenObjectInplace(
  object sys_object,
  object sys_action,
  object sys_view,
  object[] sys_selobjects,
  integer[] sys_selindices,
  optional integer sys_dynkey,
  optional boolean sys_isexplore,
  optional object sys_dashboardview,
  optional boolean sys_isdashboard,
  optional object sys_openview,
  optional object sys_dashboardobject)

Name

Description

sys_object

the current container

sys_action

the current action

sys_view

the current view

sys_selobjects

the selected objects

sys_selindices

the indices of the selected objects inside the view

sys_dynkey

the dynamic key used to specify dynamic menus

sys_isexplore

a indicator whether we a currently in a explorer situation (not used in OpenObjectInplaceApp implementation)

sys_dashboardview

the dashboard view (not used in OpenObjectInplaceApp implementation)

sys_isdashboard

a indicator whether we a currently in a dashboard situation (not used in OpenObjectInplaceApp implementation)

sys_openview

the attribute to be opened automatically (triggered i.e. due to a tree click)

sys_dashboardobject

the dashboard object (not used in OpenObjectInplaceApp implementation)

Additional Information


FSCVENV@1.1001:MergeUniqueObjectArrays Permanent link for this heading

Merge two object lists to one unique object list

void FSCVENV@1.1001:MergeUniqueObjectArrays(
  ref object[] list1,
  object[] list2)

Name

Description

list1

list2

Additional Information


FSCVENV@1.1001:ModifyGenericAttributesPage Permanent link for this heading

Formpage item action for creating a generic formpage that provides attributes from venv_attributes.

void FSCVENV@1.1001:ModifyGenericAttributesPage(
  object form,
  object page,
  UIVerb uiverb,
  object action,
  ref PageItemList[] formpageitems,
  object objclass,
  ref string formpagelabel,
  ref object formpageicon,
  dictionary localscope)

Name

Description

form

page

uiverb

action

formpageitems

objclass

formpagelabel

formpageicon

localscope

Additional Information


FSCVENV@1.1001:NavigationOverlayApp Permanent link for this heading

Shows the navigation overlay

void FSCVENV@1.1001:NavigationOverlayApp()

Additional Information


FSCVENV@1.1001:ObjectShare Permanent link for this heading

Add pointer (shortcut) of object to parent object list

void FSCVENV@1.1001:ObjectShare(
  object venv_view,
  ref object venv_parent,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean doreplace,
  optional boolean nolocking,
  optional object[] objectstoshare,
  optional boolean ignoreshareonduplicates,
  optional boolean issearch,
  out optional boolean isfield)

Name

Description

venv_view

venv_parent

branchattribute

branchindex

doreplace

nolocking

objectstoshare

ignoreshareonduplicates

issearch

isfield

Additional Information


FSCVENV@1.1001:ObjectUnlockPermanent Permanent link for this heading

Unlock permanently locked object

void FSCVENV@1.1001:ObjectUnlockPermanent()

Additional Information


FSCVENV@1.1001:OpenCallback Permanent link for this heading

void FSCVENV@1.1001:OpenCallback(
  dictionary localscope)

Name

Description

localscope

Additional Information


FSCVENV@1.1001:OpenCompoundObjectHook Permanent link for this heading

Open compound object (hook)

void FSCVENV@1.1001:OpenCompoundObjectHook()

Additional Information


FSCVENV@1.1001:OpenContObjectHook Permanent link for this heading

Edit content object (hook)

void FSCVENV@1.1001:OpenContObjectHook()

Additional Information


FSCVENV@1.1001:OverwriteContentCheckRights Permanent link for this heading

Dynamic menu action checks whether the access type "AccTypeChangeContent" for the selected objects or the container object itself (in case of no selection) is given.

void FSCVENV@1.1001:OverwriteContentCheckRights(
  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


FSCVENV@1.1001:PasteSRViewFromClipboard Permanent link for this heading

void FSCVENV@1.1001:PasteSRViewFromClipboard(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:PreferOpenDocReadOnly Permanent link for this heading

boolean FSCVENV@1.1001:PreferOpenDocReadOnly(
  out retval boolean openreadonly)

Name

Description

openreadonly

Additional Information


FSCVENV@1.1001:PreparePrinterImport Permanent link for this heading

void FSCVENV@1.1001:PreparePrinterImport(
  string filename,
  ref Content content)

Name

Description

filename

content

Additional Information


FSCVENV@1.1001:PrepareSaveAppearance Permanent link for this heading

Write display view list into sys_state and prepares the "savedictionary".

void FSCVENV@1.1001:PrepareSaveAppearance(
  DisplayViewList[] dispview,
  ref dictionary sys_state,
  out dictionary savedictionary,
  string identpath,
  ref optional string sys_settingskey,
  optional boolean reset)

Name

Description

dispview

sys_state

State dictionary

savedictionary

Dictionary created by the procedure (Content is "dispviews")

identpath

Identity path

sys_settingskey

sys_settingskey will be generated if this action is used to prepare view option settings in a search result list

reset

if true a reset of the entry will be prepared (empty dictionary ...)

Additional Information


FSCVENV@1.1001:PreviewHook Permanent link for this heading

void FSCVENV@1.1001:PreviewHook(
  object venv_object,
  object venv_parent,
  optional integer venv_index,
  object venv_view,
  ref object venv_action,
  object venv_ctx)

Name

Description

venv_object

venv_parent

venv_index

venv_view

venv_action

venv_ctx

Additional Information


FSCVENV@1.1001:QuickSearch Permanent link for this heading

Use the quick search mechanism to find objects

void FSCVENV@1.1001:QuickSearch(
  object view,
  string pattern,
  object[] attrdefs,
  integer[] indices,
  out object[] hits,
  out string[] unused,
  optional CheckAllowedMode mode,
  optional string qskey)

Name

Description

view

pattern

attrdefs

indices

hits

unused

mode

qskey

Additional Information


FSCVENV@1.1001:ReadClipboard Permanent link for this heading

Read Values out of the clip board dictionary in the user environment.

void FSCVENV@1.1001:ReadClipboard(
  ref optional any values,
  optional string key,
  optional object columnattrdef,
  optional string clientclipboard)

Name

Description

values

Values read from clip board dictionary in the user environment

key

columnattrdef

clientclipboard

Additional Information


FSCVENV@1.1001:ReadCurrentView Permanent link for this heading

Read the display view List (View Option) out of the state dictionary or if null generates a display view list with the single entry objname .

void FSCVENV@1.1001:ReadCurrentView(
  out DisplayViewList[] dispview,
  out DisplayColumnList[] dispcolumns,
  ref string identpath,
  dictionary state,
  object attrdef,
  optional object viewcontainer,
  out optional string[] sortcolumns,
  out optional object filter,
  optional string statekey,
  optional Field[] branchattribute,
  optional integer[] branchindex)

Name

Description

dispview

Display views out of state dictionary

dispcolumns

identpath

Identity path

state

State dictionary

attrdef

Attribute definition

viewcontainer

sortcolumns

filter

statekey

branchattribute

branchindex

Additional Information


FSCVENV@1.1001:ReadMailContent Permanent link for this heading

Read the content of a mail

void FSCVENV@1.1001:ReadMailContent()

Additional Information


FSCVENV@1.1001:ReadObjectAttributesHook Permanent link for this heading

Read properties of object (hook)

void FSCVENV@1.1001:ReadObjectAttributesHook()

Additional Information


FSCVENV@1.1001:ReadUserEnvKey Permanent link for this heading

void FSCVENV@1.1001:ReadUserEnvKey(
  SaveUserEnvKeyEnum savelocation,
  out any savevalue,
  string identpath,
  optional string settingskey,
  optional object attrdef)

Name

Description

savelocation

savevalue

identpath

settingskey

attrdef

Additional Information


FSCVENV@1.1001:RemoveDeleteImported Permanent link for this heading

void FSCVENV@1.1001:RemoveDeleteImported(
  ref object[] venv_listobjects,
  object[] venv_objectstodelete,
  ref optional object venv_object,
  optional object venv_view,
  ref object[] venv_createdobjects)

Name

Description

venv_listobjects

venv_objectstodelete

venv_object

venv_view

venv_createdobjects

Additional Information


FSCVENV@1.1001:ResetAppearanceSource Permanent link for this heading

Reset column source entry in sys_state and user environment.

void FSCVENV@1.1001:ResetAppearanceSource(
  ref dictionary state,
  string identpath,
  optional string sys_settingskey,
  optional SaveUserEnvKeyEnum savinglocation)

Name

Description

state

identpath

sys_settingskey

savinglocation

Additional Information


FSCVENV@1.1001:ResetUserSettings Permanent link for this heading

Reset the entries of the settings dictionary in the userenvironment

void FSCVENV@1.1001:ResetUserSettings(
  optional object objclass,
  optional object attrdef,
  optional boolean removedeletedobjs)

Name

Description

objclass

contains the objectclass to be removed from dictionary

attrdef

contains the attribute definition to be removed from dictionary

removedeletedobjs

defines whether only deleted objects will be removed from dictionary Examples: objclass = #Folder, attrdef = null, removedeletedobjs = null: Inside the ox-dictionary: All entries of deleted objects on first level are removed All entries representing a folder on first level are removed Inside the oc-dictionary: All entries of deleted objects on first level are removed The entry for Folder will be removed Inside the ad-dictionary: All entries of deleted objects on first level are removed The structure will be cleaned up objclass = #Folder, attrdef = #objchildren, removedeletedobjs = null: Inside the ox-dictionary: All entries of deleted objects on first level are removed In all entries representing a folder on first level and having an entry objchildren the objchildren entry will be removed Inside the oc-dictionary: All entries of deleted objects on first level are removed The entry for Folder will be removed Inside the ad-dictionary: All entries of deleted objects on first level are removed The entry for objchildren will be removed The structure will be cleaned up objclass = null, attrdef = null, removedeletedobjs = true: Inside the ox-dictionary: All entries of deleted objects on first level are removed If the node contains a column entry and inside this node deleted objects a referenced, the whole node will be deleted. Inside the oc-dictionary: All entries of deleted objects on first level are removed Inside the ad-dictionary: All entries of deleted objects on first level are removed At the end the Settings Dictionary has following structure (all other entries are removed): (dictionary) - ox[0/1]: DICTIONARY = 1 entries --- COO.1.1.1.333[0/1]: DICTIONARY = 1 entries ----- objchildren[0/1]: DICTIONARY = 1 entries ... - oc[0/1]: DICTIONARY = 1 entries --- Administration[0/1]: DICTIONARY = 1 entries ----- selfservice[0/1]: DICTIONARY = 1 entries ... - ad[0/1]: DICTIONARY = 1 entries --- admobjchildren[0/1]: DICTIONARY = 1 entries ----- selfservice[0/1]: DICTIONARY = 1 entries ...

Additional Information


FSCVENV@1.1001:ResolveFieldRPCPatchVariable Permanent link for this heading

Hook action to patch the xml value of the resolved filed

string FSCVENV@1.1001:ResolveFieldRPCPatchVariable(
  ref retval string result,
  optional string dataref)

Name

Description

result

the value which should be patched

dataref

the data referene

Additional Information


FSCVENV@1.1001:RunApplication Permanent link for this heading

Run an application

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

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:RunSelectedApplications Permanent link for this heading

void FSCVENV@1.1001:RunSelectedApplications(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:SaveAppearanceSource Permanent link for this heading

Write display view list into sys_state and prepares the "savedictionary".

void FSCVENV@1.1001:SaveAppearanceSource(
  ref dictionary state,
  string identpath,
  optional string sys_settingskey,
  integer columnsource,
  optional object columntemplate)

Name

Description

state

identpath

sys_settingskey

columnsource

columntemplate

Additional Information


FSCVENV@1.1001:SaveDisplayColumns Permanent link for this heading

Save display columns

void FSCVENV@1.1001:SaveDisplayColumns(
  DisplayViewList[] dispview,
  integer savelocation,
  object attrdef,
  optional object displayviewobj)

Name

Description

dispview

savelocation

attrdef

displayviewobj

Additional Information


FSCVENV@1.1001:SaveDisplayViewsInUE Permanent link for this heading

Save column settings in user environment.

void FSCVENV@1.1001:SaveDisplayViewsInUE(
  object[] venv_displayviews)

Name

Description

venv_displayviews

Additional Information


FSCVENV@1.1001:SaveQuery Permanent link for this heading

Save "querystring" out of content.

void FSCVENV@1.1001:SaveQuery(
  string querystring,
  boolean editraw)

Name

Description

querystring

editraw

Additional Information


FSCVENV@1.1001:SaveUserEnvKey Permanent link for this heading

Save a dictionary (i.e view option, version, ...) into the user environment entry settings.

void FSCVENV@1.1001:SaveUserEnvKey(
  SaveUserEnvKeyEnum savelocation,
  any savevalue,
  string identpath,
  optional string settingskey,
  optional boolean reset,
  optional object attrdef)

Name

Description

savelocation

Enum for the write key

savevalue

identpath

Identity path

settingskey

reset

if true the entry will be reset in the user environment (An empty dictionary will replace the former entry)

attrdef

Additional Information


FSCVENV@1.1001:SearchCallback Permanent link for this heading

Hook to get objects found.

void FSCVENV@1.1001:SearchCallback(
  object[] foundobjects)

Name

Description

foundobjects

Additional Information


FSCVENV@1.1001:SearchObjectsAsync Permanent link for this heading

Start an asynchronous search

void FSCVENV@1.1001:SearchObjectsAsync(
  string query,
  optional integer chunksize,
  out object[] resultlist,
  out string error,
  optional integer currobjlimit,
  optional object view,
  optional CheckAllowedMode checkallowedmode,
  out integer usedlimit,
  out object errorobject)

Name

Description

query

query

chunksize

size of the chunk

resultlist

found objects

error

error

currobjlimit

view

checkallowedmode

usedlimit

errorobject

Additional Information


FSCVENV@1.1001:SetAttrPathAndIndex Permanent link for this heading

Set attrpath and indices in system transaction variable 15 and 16

void FSCVENV@1.1001:SetAttrPathAndIndex(
  Field[] branchattribute,
  integer[] branchindex)

Name

Description

branchattribute

branchindex

Additional Information


FSCVENV@1.1001:SetCancelProgress Permanent link for this heading

The asynchronous operation (e.g. started by StartAsyncWithProgressApp) should cancel its execution.
This action sets the property cancelprogress of the progress object. (see progressobj and ProgressObject) as a hint for the asynchronous operation. It is not guaranteed, that the asynchronous operation will abort.
This action will be called when the user presses the Cancel button in the StartAsyncWithProgressApp.
The cancel state will not be set to true if the asynchronous operation indicated prior that it has already finished.
The cancel state should only be set to false as an initialization (although this is not required at all).
The asynchronous operation will get the cancel state as a result of FSCVEN@1.1001:UpdateProgressObject.

void FSCVENV@1.1001:SetCancelProgress(
  boolean cancel)

Name

Description

cancel

Pass true if the asynchronous operation should be canceled.

Additional Information


FSCVENV@1.1001:SetImplicitRoleChange Permanent link for this heading

This action is called to set the implicit role change (to be overridden in the cloud)

void FSCVENV@1.1001:SetImplicitRoleChange(
  object venv_object)

Name

Description

venv_object

Current object

Additional Information


FSCVENV@1.1001:SetListInVersion Permanent link for this heading

Set objects of a list in correct version

void FSCVENV@1.1001:SetListInVersion(
  object parent,
  object view,
  ref object[] list)

Name

Description

parent

view

list

Additional Information


FSCVENV@1.1001:SetSelection Permanent link for this heading

void FSCVENV@1.1001:SetSelection(
  object view,
  any value,
  object[] selobjects,
  dictionary state)

Name

Description

view

value

selobjects

state

Additional Information


FSCVENV@1.1001:SettingsRoot Permanent link for this heading

Determine Root of Portal Settings in modern UI (Starter)

void FSCVENV@1.1001:SettingsRoot(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:SetUrlPart Permanent link for this heading

Insert a URL-part into a URL (i.e. insert the string parturl gx=COO.a.xxxx behind the &ax=COO.a.yyy argument in the url).

void FSCVENV@1.1001:SetUrlPart(
  ref string url,
  string part)

Name

Description

url

URL to modify

part

Partial URL

Additional Information


FSCVENV@1.1001:SetVersionUE Permanent link for this heading

Save the date of the version of an object in the user environment dictionary.

void FSCVENV@1.1001:SetVersionUE(
  object parent,
  object view)

Name

Description

parent

Defines the parent object.

view

Defines the Attribute definition.

Additional Information


FSCVENV@1.1001:ShareObjects Permanent link for this heading

Add pointers to parents object list. If branchattr and branchindex is valid objectlist[0] will be shared to the parent object according to the branchattributes (for special search).

void FSCVENV@1.1001:ShareObjects(
  object venv_view,
  ref object venv_parent,
  object[] objectlist,
  optional Field[] branchattribute,
  optional integer[] branchindex,
  optional boolean doreplace,
  optional boolean nolocking,
  optional boolean ignoreshareonduplicates)

Name

Description

venv_view

Attribute definition

venv_parent

Parent object

objectlist

Objects to be shared

branchattribute

branchindex

Indices in the branchattr list

doreplace

nolocking

ignoreshareonduplicates

Additional Information


FSCVENV@1.1001:ShareObjectsHook Permanent link for this heading

Hook to handle the shared objects. Called once on the container.

void FSCVENV@1.1001:ShareObjectsHook(
  object venv_view,
  ref object[] venv_values)

Name

Description

venv_view

venv_values

Additional Information


FSCVENV@1.1001:ShowCommitButton Permanent link for this heading

Action called in EditObjectAttributeApp to decide if the commit button is shown

boolean FSCVENV@1.1001:ShowCommitButton(
  optional object venv_parent,
  optional object venv_view,
  optional object venv_action,
  ref retval boolean showcommitbutton)

Name

Description

venv_parent

the parent

venv_view

the current view

venv_action

the current action

showcommitbutton

the result

Additional Information


FSCVENV@1.1001:ShowEnvironmentStatus Permanent link for this heading

void FSCVENV@1.1001:ShowEnvironmentStatus(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:ShowUnshareWarning Permanent link for this heading

Checks if a warning should be displayed before removing an object. A warning will be displayed by removing (unsharing) an object from a container, in case of aclref is set to the container and the current user does not own the unshared object.

void FSCVENV@1.1001:ShowUnshareWarning(
  object venv_parent,
  object venv_view,
  object[] sys_selobjects,
  out boolean warning,
  out string warningmessage)

Name

Description

venv_parent

The container from which the object should be removed.

venv_view

The view in the container from which the object should be removed.

sys_selobjects

The objects which should be removed from the container.

warning

Shows if a warning should be displayed.

warningmessage

The text of the warning which will be displayed.

Additional Information


FSCVENV@1.1001:SortIndices Permanent link for this heading

Sort indices in defined order (if no order is defined, order = ascending)

void FSCVENV@1.1001:SortIndices(
  integer[] indices,
  out integer[] sortorder,
  optional boolean ascending)

Name

Description

indices

sortorder

ascending

Additional Information


FSCVENV@1.1001:StartExplorePortal Permanent link for this heading

void FSCVENV@1.1001:StartExplorePortal()

Additional Information


FSCVENV@1.1001:StartMailPortal Permanent link for this heading

Hook to handle the start of the mail portal

void FSCVENV@1.1001:StartMailPortal()

Additional Information


FSCVENV@1.1001:SubstitutionsAreActive Permanent link for this heading

Check for active substitution

boolean FSCVENV@1.1001:SubstitutionsAreActive(
  boolean checkchangeable,
  out retval boolean active)

Name

Description

checkchangeable

active

Additional Information


FSCVENV@1.1001:SubstitutionsEndActive Permanent link for this heading

End active substitution

void FSCVENV@1.1001:SubstitutionsEndActive()

Additional Information


FSCVENV@1.1001:TestCustomEditor Permanent link for this heading

string FSCVENV@1.1001:TestCustomEditor(
  object venv_object,
  object venv_parent,
  integer venv_index,
  object venv_view,
  object venv_action,
  ref retval string venv_customaction,
  ref string venv_customurl,
  boolean venv_islocked,
  boolean venv_haslocktoken,
  string venv_customerrormessage)

Name

Description

venv_object

venv_parent

venv_index

venv_view

venv_action

venv_customaction

venv_customurl

venv_islocked

venv_haslocktoken

venv_customerrormessage

Additional Information


FSCVENV@1.1001:TestOnlineOffice Permanent link for this heading

Test the content of the document to enable the user to decside to convert a .doc content into a.docx content

string FSCVENV@1.1001:TestOnlineOffice(
  object venv_object,
  object venv_parent,
  integer venv_index,
  object venv_view,
  object venv_action,
  ref retval string venv_wopiaction,
  ref string venv_wopiurl,
  boolean venv_islocked,
  boolean venv_haslocktoken,
  string venv_customerrormessage)

Name

Description

venv_object

venv_parent

venv_index

venv_view

venv_action

venv_wopiaction

venv_wopiurl

venv_islocked

venv_haslocktoken

venv_customerrormessage

Additional Information


FSCVENV@1.1001:TransformToXML Permanent link for this heading

Dump object to XML file

void FSCVENV@1.1001:TransformToXML(
  string transformation,
  out content content)

Name

Description

transformation

content

Additional Information


FSCVENV@1.1001:UnEscapePattern Permanent link for this heading

Unescape pattern

string FSCVENV@1.1001:UnEscapePattern(
  string inpattern,
  out retval string unescapedpattern)

Name

Description

inpattern

unescapedpattern

Additional Information


FSCVENV@1.1001:UnshareObjects Permanent link for this heading

Unshare selected object (selindices) form parent object according to branchattribute and branchindex.

void FSCVENV@1.1001:UnshareObjects(
  ref object parent,
  Field[] branchattr,
  integer[] branchindex,
  integer[] selindices,
  optional object attrdef,
  ref optional any value)

Name

Description

parent

Parent object

branchattr

Attribute path to object lists attribute definition.

branchindex

Index through the branchattribute array.

selindices

Indices, defining the objects to unshare from the list.

attrdef

value

Additional Information


FSCVENV@1.1001:UpdateProgressObject Permanent link for this heading

Set progress state information of an asynchronous operation.
This information is displayed in a progress dialog in case the asynchronous operation is started with StartAsyncWithProgressApp.
The progress state should be initialized by calling