2022 June Release

Actions (A-S) of COOSYSTEM@1.1:User Permanent link for this heading

Return Type

Signature

void

Abort()

void

AbortRoot()

void

AcceptGroupMembership(
  string fsc_arg1,
  string fsc_arg2,
  string fsc_arg3)

void

AcceptNewEMailAddress(
  string fsc_arg1,
  string fsc_arg2,
  string fsc_arg3,
  boolean fsc_register)

boolean

AccountCanBeDeleted(
  boolean silent,
  out retval boolean canbedeleted)

void

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

Group[]

AddAsOrgMember(
  Group organization,
  optional boolean sendinvitationmail,
  out retval Group[] addedto)

object[]

AddAssignedRoomsToWidgets(
  ref retval object[] widgets)

string

AddColumn(
  string jsoninput,
  out retval string resultjson)

object[]

AddFavoritesObjectToWidgets(
  ref retval object[] widgets)

void

AddJavaScript(
  object javascript,
  dictionary parameters)

void

AddJSAPIError(
  ref JSAPIError[] errors,
  any error,
  optional string key)

void

AddLocalObjects(
  object[] objects)

void

AddNewEMailAddress()

string

AddNextColumn(
  string jsoninput,
  out retval string resultjson)

object[]

AddNotificationsToWidgets(
  ref retval object[] widgets)

void

AddObjectRemark(
  object obj,
  optional string textremark,
  optional string event,
  optional datetime timestamp,
  optional AttachmentType[] attachments)

void

AddObjectsToFavorites(
  object[] addobjs)

object[]

AddOrganizationToWidgets(
  ref retval object[] widgets)

object[]

AddPortalSearchToWidgets(
  ref retval object[] widgets)

void

AddRecentlyUsed(
  object context,
  optional object[] additionalobjects)

void

AddRemark(
  optional any remark,
  optional string event,
  optional datetime _date,
  optional object[] references,
  optional boolean suppresshistory)

dictionary[]

AddSavedSearchQueries(
  dictionary[] savedsearches,
  out retval dictionary[] result,
  out JSAPIError[] errors)

void

AddSearchUser(
  AttributeDefinition attrdef,
  User user)

object[]

AddStandardRoomsToWidgets(
  ref retval object[] widgets)

object[]

AddSynchronizedFolderToWidgets(
  ref retval object[] widgets)

void

AddUserAsExternalMember(
  optional integer unused1,
  optional integer unused2)

object[]

AddUserHistoryToWidgets(
  ref retval object[] widgets)

object[]

AddWorkListToWidgets(
  ref retval object[] widgets)

void

AdjustSecurityContext(
  object[] attrlist)

object[]

AdminObjectSearch(
  string query,
  out retval object[] hits)

interface

AdminObjectSearchAsync(
  string query,
  out retval interface searchresult)

void

AdminSearchExecute(
  string query,
  object action)

void

AllowedACLsGet(
  out object[] acls,
  out boolean allowadditional)

void

ArchiveDocFile(
  ref string docid,
  string docfile,
  optional string contrep,
  optional boolean archiveimmediate,
  ref optional object object)

void

ArchiveDocument(
  ref string docid,
  optional string contrep,
  optional boolean archiveimmediate,
  ref optional object object)

void

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

void

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

string

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

void

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

void

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

void

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

void

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

object

AttrGetUDMasterGroup(
  out retval object mastergroup)

void

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

void

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

object[]

AttrObjCategoryFilterCommon(
  ref retval object[] categories,
  optional AttributeDefinition attrdef,
  optional object context)

void

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

void

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

void

AttrObjNameGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

void

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

void

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

void

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

void

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

void

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

void

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

any

AttrUserSettingsConstructor(
  AttributeDefinition attrdef,
  out retval any value)

void

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

void

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

void

AuthorizeTransfer(
  content request,
  out content response)

string

BackupStateTransaction(
  out retval string transcationbackup)

string

BKUUseId(
  integer digitalidtype,
  out retval string authurl)

void

CacheRegistrationTarget(
  IncomingComponentCategory regcat,
  object regobj,
  object regtargetobj)

void

CalcMainAddress(
  optional boolean forcecalc)

UserSessionInfo[]

CalcSessionInfos(
  optional boolean interactive,
  optional Group[] masterorgs,
  out retval UserSessionInfo[] sessioninfos)

WorkGroup[]

CalcUserWorkGroups(
  out retval WorkGroup[] workgroups)

boolean

CanBeAnonymized(
  Group targetorganization,
  boolean silent,
  optional boolean requirescheduledanonymization,
  optional boolean checkmembershipexclusions,
  out retval boolean canbeanonymized)

boolean

CanExecuteMigrateUser(
  out retval boolean allowed)

boolean

CanLicenseAsTrial(
  object app,
  out retval boolean trialok,
  optional string instance)

boolean

CanManageCategories(
  object context,
  optional boolean silent,
  out retval boolean canmanage)

boolean

CanManageRoles(
  Group orgcontext,
  optional User user,
  optional boolean checkastargetuser,
  out retval boolean canmanage)

boolean

CanManageUser(
  User user,
  optional boolean donotcheckrole,
  out retval boolean canmanage,
  out Group[] managingorgs,
  optional boolean personalinformations,
  optional AttributeDefinition[] policies)

boolean

CanManageWorkFlowDiagrams(
  object context,
  optional boolean silent,
  out retval boolean canmanage)

boolean

CanShowOrgMembershipInfos(
  optional Group cloudorganization,
  optional object context,
  optional AttributeDefinition attrdef,
  optional boolean updatevalues,
  out retval boolean allowed)

boolean

CanUseMobilePIN(
  out retval boolean canuse)

boolean

CanUsePushNotifications(
  optional object obj,
  out retval boolean canuse)

boolean

CanUseSearchAudit(
  object context,
  optional boolean silent,
  out retval boolean canuse)

boolean

CanUseTwoFactor(
  out retval boolean canuse)

boolean

CanViewPersonalDataOverview(
  out retval boolean canview)

void

ChangeMembership(
  optional integer unused1,
  optional integer unused2)

string

ChangeView(
  string jsoninput,
  out retval string resultjson)

boolean

CheckActive(
  out retval boolean active,
  optional boolean checkapplicense,
  optional object context)

boolean

CheckAdminRole(
  object[] objs,
  out retval boolean valid,
  optional boolean checkallroles)

void

CheckAuthentication()

void

CheckAuthenticationMethodsWarnings(
  AttributeDefinition attrdef,
  Group group,
  boolean separatetx,
  optional AuthenticationMethod[] disabledautenticationmethods,
  optional AuthenticationMethod[] possibleautenticationmethods)

void

CheckDeletedAuditAccess(
  optional object objowngroup,
  optional object objteamroom)

void

CheckDeletedAuditAccessPreWrapper(
  ref optional object objowngroup,
  ref optional object objteamroom)

boolean

CheckEmailDomain(
  Group organization,
  optional string useremaildomain,
  optional string[] orgmaildomains,
  out retval boolean domainok)

boolean

CheckEMailFormat(
  out retval boolean plaintext)

object[]

CheckExistingUser(
  optional string firstname,
  optional string surname,
  optional string[] emails,
  boolean lognameonly,
  out retval object[] usersbyemail,
  out object[] usersbyname,
  optional boolean preferactive,
  optional boolean requireactive,
  optional boolean requirereadaccess,
  optional string externalkey,
  out object[] usersbyexternalkey,
  optional AttributeDefinition[] additionallognameattrdefs)

void

CheckInterests()

void

CheckInterestsDomain()

void

CheckLoggedInUser(
  string targetuseremail)

string

CheckMobilePhoneNumber(
  string phone,
  out retval string correct)

boolean

CheckNotificationAppLicense(
  boolean silentmode,
  optional object targetobject,
  out retval boolean haslicense)

boolean

CheckPushNotificationPolicy(
  out retval boolean allowsend)

void

CheckResubmission()

void

CheckServiceToken(
  string token,
  out object scope,
  out string comment,
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

void

CheckUnusedRooms(
  string fsc_arg)

void

CheckUserQuota(
  out integer contentquota,
  out integer contentquotalimit,
  optional integer addcontentquota,
  out integer objectquota,
  out integer objectquotalimit,
  optional integer addobjectquota)

boolean

CheckWorkFlowAppLicense(
  optional boolean disableerrorapps,
  optional boolean silentmode,
  out retval boolean haslicense)

void

CheckWorkList()

void

Cleanup(
  ref optional dictionary localscope)

void

CleanupState(
  string statetoken)

void

CloseWindowApp()

void

CloudGetContactConflictDetail(
  out string name,
  out string email,
  out string tel,
  out string orgtext,
  out string thumbnailurl)

void

CloudOrgShop(
  object arg1,
  string arg2,
  optional string arg3,
  optional integer arg4,
  optional string arg5,
  optional string arg6,
  optional string arg7,
  optional string arg8)

void

CloudShop(
  object arg1,
  string arg2,
  integer arg3,
  string arg4,
  integer arg5,
  integer arg6,
  string arg7,
  string arg8,
  string arg9,
  string arg10,
  string arg11)

void

CMISFilterRepositories(
  ref RepositoryFilterType[] repositories)

object[]

CollectCommonStartedInstances(
  object[] sourceobjects,
  ref optional integer dynkey,
  optional AttributeObjectDef view,
  out retval object[] targetobjects)

void

Commit()

void

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

void

ConfigureATTask(
  ATConfiguredTask automatedtasksettings)

void

CoverageInfoFlush()

string

CreateChangeSubscription(
  out retval string subscription)

Group

CreateInitialPurchaseOrganization(
  boolean isshop,
  string orgname,
  optional string vatid,
  optional BillingAddress billingaddr,
  optional BillingAddress recipientdata,
  out retval Group organization,
  out boolean vatidverified,
  optional Country regaddrcountry,
  out ContractingPartner contractingpartner,
  optional boolean istrial)

MailboxInfo

CreateMailbox(
  CreateUserData initdata,
  optional string sessionid,
  out retval MailboxInfo newmailbox)

content

CreateMultipartResponse(
  optional content[] conts,
  optional dictionary[] conthdrs,
  string boundary,
  out retval content response)

void

CreateObject(
  out string result)

Bill

CreateOffer(
  User purchaser,
  object recipient,
  BillingAddress recipientdata,
  BillingAddress billingaddr,
  VATSettings vatsettings,
  string vatid,
  PaymentElement[] elements,
  ContractingPartner contractingpartner,
  float discountrate,
  string affiliatemarketingid,
  boolean postponepdfgeneration,
  out retval Bill tempbill,
  optional CurrencySymbol paymentcurrency,
  optional string ordernumber)

Subscription

CreateSubscription(
  datetime licensedfrom,
  SubscriptionInterval interval,
  PaymentElement[] newpurchasedelements,
  object benefitrecipient,
  BillingAddress recipientdata,
  object paymentowner,
  BillingAddress billingaddress,
  string customerid,
  string transactionid,
  out retval Subscription subscr,
  optional dictionary paymentinfos)

Group

CreateTestGroup(
  CreateGroupData initdata,
  optional string sessionid,
  ref retval Group newobject)

User

CreateTestUser(
  CreateUserData initdata,
  optional string sessionid,
  ref retval User newobject)

User

CreateTransferUser(
  string email,
  optional string firstname,
  optional string surname,
  optional string middleinitial,
  optional Country country,
  optional Language language,
  out retval User user)

void

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

void

DelAmpersandFromString(
  ref string string,
  optional string replacepattern)

void

DeleteAuditLogUserObj(
  optional object owngroup)

void

DeleteAuditLogUserRef(
  optional object owngroup)

void

DeleteChangeSubscription(
  object subscription)

void

DeleteCloudAccount(
  optional integer unused1,
  optional integer unused2)

AppPackage

DetermineCurrentlyLicensedEdition(
  optional object context,
  out retval AppPackage edition,
  out AccountRegistrationType accounttype,
  out optional AppPackage[] additionaleditions)

dictionary

DeterminePurchaserInformation(
  out retval dictionary information)

void

DiagramEditorHandler(
  content request,
  out content response)

string

DisplayContextCloudOrganizationName(
  boolean usefallback,
  out retval string name)

boolean

DoUnshareChildrenOnPressDel(
  out retval boolean dounshare)

boolean

EncryptionEnabled(
  out retval boolean result)

string

EvaluateFURL(
  content body,
  out retval string result,
  optional string execuser)

string

EvaluateUnitTestFURL(
  UnitTest test,
  optional string format,
  out retval string webpage)

User[]

ExpandGroupMembers(
  AdministrationObject[] targetobjs,
  out retval User[] members,
  optional boolean omitchildgroups)

content

ExportRoomProgressInfoContFURL(
  RoomProgressInfo proginfo,
  out retval content cont)

void

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

void

FilterDataImportExpr(
  DataImportComponentObject datimpobj,
  AttributeDefinition attrdef,
  ref dictionary params)

HistoryEventType[]

FilterNotificationEventTypes(
  ref retval HistoryEventType[] eventtypes)

void

FilterObjectsForUser(
  ref object[] objects,
  object[] userattrpath,
  object[] positionattrpath,
  object[] groupattrpath,
  object[] orgunittypeattrpath,
  object[] grouppositionattrpath,
  optional boolean currentroleonly)

boolean

FilterRegistrationTarget(
  IncomingComponentCategory regcat,
  CompoundObject regtargetobj,
  object regobj,
  out retval boolean valid)

void

FinalizeCommit(
  object[] attrlist)

object[]

FindDomains(
  out retval object[] domains)

void

FindMailbox(
  string emailaddress,
  out object mailbox)

object

FindOrgElementByExternalKey(
  string externalkey,
  ObjectClass class,
  optional Group owngroup,
  out retval object element)

void

FinishInitialOrganizationPurchase(
  out integer error,
  ref User user,
  string email,
  string surname,
  optional string firstname,
  string captchachallenge,
  string captcharesponse,
  optional Country usercountry,
  optional Language language,
  optional TeamRoom[] teamrooms,
  optional object context,
  optional string returnurl,
  optional boolean skipcaptcha,
  optional TeamRoom[] teamroomtemplates,
  optional string usercampaigncode,
  optional App[] autolicensedapps,
  optional string password,
  optional dictionary additionalinfo,
  optional string phone,
  optional string organization,
  optional string jobtitle,
  optional DomainConnection location,
  optional object logocontext)

string

FormatBytes(
  float bytes,
  out retval string result)

void

FormatContent(
  out content outcont)

string

FormatCurrency(
  User targetuser,
  currency curr,
  optional boolean appendsymbol,
  optional Language targetlang,
  out retval string formatted,
  optional boolean skipfreetext,
  optional boolean roundthreedigits,
  optional boolean forcedisplaythreedigits)

InfoDetailsList[]

FormatHistoryBlock(
  NotificationDisplayType displaytype,
  History[] events,
  out retval InfoDetailsList[] blocks)

content[]

GenerateIDPTranslations(
  out retval content[] contents,
  out string[] langcodes,
  Language[] forlangs)

content[]

GenerateMSTeamsTranslations(
  out retval content[] strcontents,
  out content[] jsoncontents,
  out string[] langcodes,
  Language[] forlangs)

integer

GeneratePin(
  string phone,
  out retval integer pin)

content[]

GenerateTranslations(
  string platform,
  string project,
  out retval content[] contents,
  out string[] langcodes,
  Language[] forlangs)

void

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

AccountRegistrationType

GetAccountRegistrationType(
  object context,
  out retval AccountRegistrationType accounttype,
  optional boolean skipapplicensecheck,
  optional RoomRole currentrole,
  out optional AppPackage edition,
  out optional AppPackage[] additionaleditions)

Activity[]

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

Activity[]

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

Activity[]

GetActivityEstimationPostWrapper(
  object[] objects,
  ref retval Activity[] activities,
  optional boolean quickcheck)

Activity[]

GetActivityPostWrapper(
  object[] objects,
  ref retval Activity[] activities)

void

GetAdditionalConfigValues(
  out string[] keys,
  out string[] values)

content[]

GetAdditionalPersonnalDataContents(
  out retval content[] additionalcontents,
  out optional string[] filenames)

PrescriptionTemplate[]

GetAdditionalPrescriptionTemplatesHook(
  object[] wfobjects,
  ref retval PrescriptionTemplate[] templates)

WorkFlowDiagram[]

GetAdditionalWorkFlowDiagramsHook(
  object[] wfobjects,
  ref retval WorkFlowDiagram[] diagrams,
  optional boolean requiredraftversion)

object

GetAddressBook(
  UserEnvironment userenv,
  string targetaddr,
  boolean cancreate,
  out retval object addrbook)

void

GetAllLanguages(
  out Content result,
  optional string query)

User[]

GetAllOrganizationManagers(
  Group organization,
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

void

GetAllowedClasses(
  out object[] allowed,
  out object[] notallowed)

content

GetAllWorkflowDiagramObjects(
  out retval content jsoncontent)

AppPackage

GetAssignedEdition(
  out retval AppPackage assignededition)

AssignedRooms

GetAssignedRooms(
  out retval AssignedRooms assignedrooms,
  boolean createnonexisting)

AppConfigurationRoom[]

GetAvailableAppConfigurations(
  ref retval AppConfigurationRoom[] appconfigurations,
  out AppConfigurationRoom assignedconfiguration,
  optional ObjectClass targetclass)

ContentObject[]

GetAvailablePDFSignContentsHook(
  out retval ContentObject[] signcontents)

ContentObject[]

GetAvailablePDFStampContentsHook(
  out retval ContentObject[] signcontents)

object[]

GetAvailableSignatureAuthorizations(
  boolean usefallback,
  out retval object[] authorizations)

object[]

GetAvailableStamps(
  out retval object[] stamps)

VisualSignature[]

GetAvailableVisualSignatures(
  out retval VisualSignature[] availablesignatures)

string

GetBaseURL(
  out retval string baseurl)

content

GetBpmn2BpdModel(
  DiagramObject diagramobject,
  out retval content bpdmodel)

Content

GetBrandingFallbackLogo(
  ref string logoname,
  out retval Content logo)

string

GetBrandingLogoURLPostWrapper(
  integer logotype,
  optional object context,
  ref retval string url,
  optional object selfservicebranding,
  optional Language userlang,
  ref string logohref,
  ref string logoaltname)

Group[]

GetCertificateAuthGroups(
  out retval Group[] groups)

any

GetChangedObjects(
  ref datetime refdate,
  ref optional retval any objects,
  optional boolean system)

dictionary

GetChangedObjects(
  ref datetime refdate,
  ref optional string[] objects,
  optional boolean system,
  optional string subscription,
  optional integer version,
  optional string[] attrlist,
  out retval dictionary response)

object

GetCommunicationLanguage(
  out retval object commlanguage,
  optional Language fallbacklang)

any[]

GetConfigurationProperty(
  AttributeDefinition attrdef,
  out retval any[] value,
  optional AttributeBoolDef overrideattrdef)

Group

GetContextCloudOrganization(
  out retval Group cloudorganization)

object

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

Room

GetContextRoom(
  out retval Room room,
  optional object object,
  out optional object view,
  optional object[] selobjects,
  out optional object selcontainer,
  out object context)

object[]

GetCurrentUserActivities(
  out retval object[] actinsts)

void

GetCurrentUserTopLevelOU(
  out optional object ou)

integer

GetDateTimeDistance(
  datetime fromdate,
  datetime todate,
  ModifyDateTimeOperand operand,
  out retval integer distance)

Addressee

GetDefaultAddressee(
  out retval Addressee addressee,
  optional object topic)

Country

GetDefaultAddresseeCountry(
  out retval Country country,
  optional object topic)

string

GetDefaultOrgname(
  out retval string orgname)

void

GetDeleteAction(
  object container,
  object[] selobjects,
  integer lastresult,
  out string caption,
  out string question,
  out boolean enhanced,
  ref object delaction,
  optional boolean shiftkeypressed,
  ref optional object deltarget,
  ref optional object delapplication)

void

GetDeleteAction(
  object container,
  object[] selobjects,
  integer lastresult,
  out string caption,
  out string question,
  out boolean enhanced,
  ref object delaction,
  optional boolean shiftkeypressed,
  ref optional object deltarget,
  ref optional object delapplication)

Content

GetDiagramImage(
  string contobj,
  object attrdef,
  out retval Content cachedcont,
  boolean readdirect,
  DiagramType diagtypemodel,
  DiagramType diagtypepresentation,
  integer width,
  integer height,
  integer usefallback,
  integer allowscaledown)

void

GetDocFile(
  string docid,
  string docfile,
  optional string contrep)

void

GetDocument(
  string docid,
  optional string contrep,
  optional boolean opencontainer,
  out optional object contentobj,
  out optional object containerobj)

DomainInfo

GetDomainInfo(
  out retval DomainInfo info)

void

GetEditionLogoContext(
  out object logocontainer,
  out object bgimagecontainer)

string

GetEMailAddress(
  optional boolean silent,
  out retval string emailaddress)

object[]

GetExpiringApps(
  out retval object[] apps,
  optional integer expireindays,
  optional datetime expirebefore)

UserFeature[]

GetExtendedUserFeatures(
  out retval UserFeature[] userfeatures)

object[]

GetFavorites(
  out retval object[] favorites)

string

GetFieldMenuRPC(
  string argumentsinjson,
  out retval string resultjson)

object

GetFileTarget(
  object object,
  Action context,
  out retval object target)

void

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

void

GetFTSQueryContext(
  out string[] context)

UserAppList[]

GetGroupPackages(
  object group,
  optional object context,
  out retval UserAppList[] licensedapps,
  optional boolean usecache)

string

GetHighchartsJSON(
  AttributeDefinition attrdef,
  any value,
  out retval string json)

object

GetHomeObject(
  out retval object home)

integer

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

string

GetInaccessibleObjectsFURL(
  string mailaddresses,
  string mailattachments,
  out retval string objects)

object[]

GetInheritedWorkFlowSettings(
  out retval object[] prescriptiontemplates,
  out WorkFlowDiagram[] diagrams)

void

GetInstance(
  out interface instance,
  interface worker)

JSONStructFormat[]

GetJSONFormat(
  ref retval JSONStructFormat[] formats)

object

GetLanguage(
  string langstring,
  out retval object language)

Language

GetLanguageFromCountrycode(
  string countrycode,
  out retval Language lang)

void

GetLanguageStrings(
  out Content result,
  optional object language,
  optional string query,
  optional string format)

object[]

GetLicenseContextGroups(
  optional object context,
  optional boolean fullapps,
  out retval object[] groups)

Locale

GetLocaleFromCountryCode(
  string countrycode,
  out retval Locale locale)

string

GetLoginEMailAddress(
  out retval string logemail,
  optional string[] lognames,
  optional boolean checkaccess)

SecurityLevel

GetLoginSecurityLevel(
  out retval SecurityLevel loginlevel)

Group

GetMasterGroup(
  out retval Group group,
  optional boolean considerversion)

MindbreezeFacetProp[]

GetMindbreezeFacetProps(
  object obj,
  out retval MindbreezeFacetProp[] result)

JSAPIMindbreezeFacetValues[]

GetMindbreezeFacetPropValues(
  object obj,
  JSAPIMindbreezeFacet[] facets,
  out retval JSAPIMindbreezeFacetValues[] result,
  out JSAPIError[] errors)

MindbreezeFacetPropValues

GetMindbreezeFacetPropValues(
  object obj,
  AttributeDefinition[] attributes,
  out retval MindbreezeFacetPropValues result)

dictionary

GetMindbreezeQueryConstraints(
  object obj,
  out retval dictionary queryconstraints)

dictionary

GetMindbreezeQueryConstraintsImpl(
  object currobj,
  object constraintobj,
  string currsessionid,
  out retval dictionary queryconstraints)

string

GetMLContent(
  optional LanguageContentList[] list,
  out retval string text)

string[]

GetMobilePinTypes(
  out retval string[] mobilepintypes)

MobileTaskPaneMenu[]

GetMobileTaskPaneMenus(
  object containerobject,
  optional AttributeDefinition containerview,
  optional object selectedobject,
  optional Breadcrumb[] breadcrumb,
  out retval MobileTaskPaneMenu[] result,
  out any[] exceptions)

MobileTaskPaneMenu[]

GetMobileTaskPaneMenus(
  object containerobject,
  optional AttributeDefinition containerview,
  optional object selectedobject,
  optional Breadcrumb[] breadcrumb,
  out retval MobileTaskPaneMenu[] result,
  out JSAPIError[] errors)

string

GetMotokyJsonResult(
  integer result,
  object message,
  out retval string json)

integer

GetMotokyPairing(
  string devicetoken,
  string devicekey,
  string phone,
  string username,
  string transactionid,
  out string message,
  out retval integer responsecode)

string

GetMotokyTransactionId(
  out retval string tid)

dictionary

GetNativeClientConfigurationWS(
  optional object targetobj,
  out retval dictionary result)

UserEvents

GetNotificationEventSettings(
  out retval UserEvents events,
  out NotificationSettings[] settings,
  out datetime settingssavedat)

EventTriggerList[]

GetNotificationSettingsFromUser(
  optional boolean usefallback,
  out UserEnvironment userenv,
  out retval EventTriggerList[] notificationsettings,
  out EventTriggerList[] pushnotificationsettings)

string

GetOAuthToken(
  StockConnection conn,
  out retval string token)

History[]

GetObjectHistory(
  object obj,
  out retval History[] history)

content

GetObjectRemarks(
  object obj,
  out retval content remarks)

UseCase

GetObjFileUseCase(
  object object,
  object menu,
  optional boolean includefile,
  out retval UseCase fileusecase)

TreeExpressionData[]

GetOpenFromToolExpressionData(
  ref retval TreeExpressionData[] treedata)

void

GetOptionsMenu(
  string arguments,
  out string menuref)

string

GetOrderNumberSettings(
  Group context,
  out retval string ordernumber,
  out boolean reuseordernumber,
  out boolean ordernumberrequired)

TeamRoom[]

GetOwningTeamrooms(
  optional boolean gettransferred,
  out retval TeamRoom[] result)

dictionary

GetPageTemplateVisibilitySettings(
  string title,
  object context,
  out retval dictionary tpsettings)

Room

GetParentRoom(
  out retval Room parentroom)

content

GetPersonalDataOverview(
  out retval content pdfcont)

DocumentDefinition

GetPersonalDataOverviewDefinition(
  out retval DocumentDefinition docdef)

PortalButton[]

GetPortalButtons(
  out retval PortalButton[] buttons)

object

GetPortalTheme(
  out retval object theme)

object[]

GetPossibleHolidayTables(
  out retval object[] holidaytables)

object[]

GetPossibleSearchForms(
  object context,
  optional AttributeDefinition attrdef,
  ref retval object[] searchforms)

boolean

GetPrescriptionEditorMode(
  out retval boolean isexprtmode,
  out boolean enforcededitormode)

void

GetPriceCalculation(
  string lang,
  string locationid,
  string products,
  out JSAPIProduct[] productlist,
  out JSAPICalculation calculation,
  out JSAPIPaymentMethod[] paymentmethods,
  ref JSAPIError[] errors,
  string countryid,
  out string agreement)

ExtOrganization

GetPrimaryExternalOrganization(
  out retval ExtOrganization primaryextorg,
  out ExtOrganization[] additionalextorgs,
  optional ExtOrganization[] excludedextorgs,
  optional boolean nofallback)

Group

GetPrimaryGroup(
  out retval Group primarygroup,
  out Group[] additionalgroups,
  out boolean enforceprimarygroup,
  optional boolean createroom,
  out boolean preselectprimarygroup,
  optional boolean includemastergroups)

OrganizationalPosition

GetPrimaryPosition(
  Group organization,
  out retval OrganizationalPosition primaryposition)

string

GetPublicAccessBaseUrl(
  out retval string publicaccessbaseurl)

void

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

void

GetPublicPageNotFound(
  out string html)

User

GetRealUser(
  out retval User user)

object[]

GetRegistrationCategories(
  IncomingComponentCategory regcat,
  object regobj,
  optional object[] defaultcategories,
  out retval object[] categories)

CompoundObject

GetRegistrationDefaultTarget(
  IncomingComponentCategory regcat,
  object regobj,
  ref retval CompoundObject defaulttarget)

dictionary

GetRegistrationTargetLists(
  IncomingComponentCategory regcat,
  object regobj,
  out retval dictionary dictlists)

object[]

GetRegistrationTargetRoots(
  IncomingComponentCategory regcat,
  object regobj,
  out retval object[] roots)

object[]

GetRequestedApps(
  out retval object[] apps,
  optional object object,
  optional object view,
  optional object[] selobjects)

Notification[]

GetResubmissions(
  boolean includedepending,
  out retval Notification[] resubmissions,
  out Notification[] dependingresubmissions)

Subscription[]

GetRevokeTerminateSubscriptions(
  boolean revoke,
  out retval Subscription[] subscriptions,
  optional boolean nousersubs)

void

GetRoleMenu(
  out string menuref)

User

GetRoomOwner(
  out retval User user)

RoomProgressInfo

GetRoomProgressInfo(
  optional object contextobj,
  out retval RoomProgressInfo progress)

ObjectInfo[]

GetSearchFolderResults(
  GenericStoredQBOL searchfolder,
  optional boolean refresh,
  optional boolean keysonly,
  out retval ObjectInfo[] response)

string

GetSelfServiceURL(
  SelfServiceURLType urltype,
  optional object trigger,
  optional object context,
  optional dictionary dict,
  ref retval string url)

string

GetSelfServiceURLPreWrapper(
  SelfServiceURLType urltype,
  optional object trigger,
  optional object context,
  ref optional dictionary dict,
  ref retval string url)

string

GetSendBackgroundFrom(
  out retval string from,
  boolean usedefaultsender,
  optional Language userlang)

string

GetServiceToken(
  optional string comment,
  object scope,
  optional ServiceTokenExpiration expiration,
  out retval string token)

ServiceTokenExpiration

GetServiceTokenExpiration(
  out retval ServiceTokenExpiration expiration)

string[]

GetSessions(
  out retval string[] sessions,
  out boolean hasglobalcoverage)

string

GetShopURL(
  string product,
  SubscriptionInterval interval,
  optional boolean forotheruser,
  optional string benefitrecipient,
  optional string quantity,
  optional boolean trial,
  optional string instance,
  optional string aborturl,
  optional string confirmurl,
  optional boolean fororganization,
  ref retval string url,
  optional boolean usedistributionbundle)

Room[]

GetStandardTeamrooms(
  out retval Room[] standardrooms)

StorageApp

GetStorageApp(
  integer storage,
  out retval StorageApp app)

datetime

GetStoredTimes(
  Action key,
  out retval datetime from,
  out datetime to)

object[]

GetSubscribedNotificationObjects(
  optional object[] objectstocheck,
  out retval object[] subscribedobjs,
  optional object sourceobject,
  optional boolean includealternative)

object[]

GetSubstitutedGroups(
  out retval object[] substgroups)

void

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

integer[]

GetSupportedAnnotationAPIVersions(
  out retval integer[] versions)

SynchronizedFolder

GetSynchronizedFolder(
  out retval SynchronizedFolder syncfolder)

TestSession

GetTestSession(
  optional string sessionid,
  out retval TestSession session)

AppConfigurationRoom[]

GetTextModuleConfigurations(
  object context,
  Language lang,
  out retval AppConfigurationRoom[] configs)

object

GetTheme(
  out retval object theme)

any[]

GetThreadActionParameter(
  Action action,
  integer parameteridx,
  out boolean hasaction,
  out retval any[] value)

Group

GetTransferGroups(
  out retval Group primarygroup,
  out Group[] additionalgroups)

TransmissionLog

GetTransmissionLog(
  dictionary params,
  out retval TransmissionLog log)

Subscription[]

GetTrialSubscriptions(
  optional object[] products,
  optional object paymentowner,
  out retval Subscription[] subscriptions)

UnitTestSuite[]

GetUnitTestSuites(
  string[] refs,
  out retval UnitTestSuite[] suites)

User

GetUserByEMail(
  string email,
  out retval User user)

AppDashboard

GetUserDashboardByApp(
  App targetapp,
  out retval AppDashboard dashboard,
  out optional AppDashboard[] alldashbaords)

UserData

GetUserData(
  out retval UserData userdata,
  optional boolean includewebservices,
  optional boolean includefriendlyurls)

string

GetUserDisplayName(
  ref retval string displayname)

string

GetUserDisplayNameWrapper(
  ref retval string displayname)

UserEvents

GetUserEvents(
  out retval UserEvents userevents)

Locale

GetUserLocale(
  out retval Locale locale,
  optional Language fallbacklang)

string

GetUserLogEMailAddress(
  out retval string logemail,
  optional string[] lognames,
  optional boolean checkaccess)

void

GetUserNotificationSettings(
  boolean unused,
  boolean mailnotification,
  boolean rssnotification,
  out optional object[] unused2,
  out optional object[] mailnotificationobjs,
  out optional object[] rssnotificationobjs,
  optional boolean activitynotification,
  out optional object[] activitynotificationobjs,
  optional boolean islocked,
  optional boolean usesettingsparams,
  optional NotificationSettings[] settings,
  optional datetime settingssavedat,
  optional boolean usecache)

string

GetUserReportEMailAddress(
  out retval string email,
  optional boolean nofallback)

UserRoleData

GetUserRoleData(
  out retval UserRoleData result)

void

GetUserRoleGroupName(
  object group,
  out string name)

void

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

void

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

string

GetUserRoleSymbolWrapper(
  UserRoleList[] userrole,
  boolean usepersimage,
  out retval string location)

object[]

GetUserSecurityClearance(
  out retval object[] securitylevel)

UserSubstitution

GetUserSubstitution(
  optional boolean create,
  out retval UserSubstitution usersubs)

string

GetVatId(
  optional Group context,
  out retval string vatid,
  out string companyname,
  out boolean vatidverified)

VATSettings

GetVATSettings(
  Country custcountry,
  out retval VATSettings vatsettings,
  datetime periodfrom,
  optional datetime periodto,
  optional SubscriptionInterval interval)

object[]

GetWidgets(
  optional ObjectClass widgetclass,
  out retval object[] widgets)

Group[]

GetWorkFlowPreferenceGroupLocations(
  out retval Group[] groups)

object

GetWorkList(
  ref retval object worklist,
  optional boolean sametx,
  optional boolean nocreate)

boolean

GrantAppLicense(
  object[] servicepackages,
  out retval boolean successfulactivation)

void

GroupAppsChanged(
  object group)

void

GroupLoginSessionSettingsGet(
  out GroupLoginSessionSettings grouploginsessionsettings)

void

GroupNativeClientSettingsGet(
  out GroupNativeClientSettings groupnativeclientsettings)

void

HandlePublicLinks(
  string fsc_arg1,
  optional string fsc_arg2,
  optional string fsc_arg3)

boolean

HasLicensed(
  App app,
  optional boolean trial,
  optional string instance,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

boolean

HasSecurityLevels(
  out retval boolean available,
  optional SecurityLevel seclevel,
  out SecurityLevel[] alllevels)

boolean

HasThreadActions(
  Action[] actionlist,
  out retval boolean result,
  out optional Action action)

boolean

HasValidEdition(
  out retval boolean result,
  out AppPackage edition,
  optional object context,
  optional boolean isedit,
  optional boolean isread,
  optional boolean isdefault)

boolean

HasWorkOnSubstTabSet(
  out retval boolean workonsubsttab)

content

HttpGet(
  string url,
  out retval content response,
  optional boolean nocert)

void

HttpHandler(
  content incont,
  out string outcont,
  string mail,
  string calendar,
  string filename)

void

HttpHandler(
  content incont,
  out string outcont,
  string target,
  string filename)

content

HttpPost(
  string url,
  content data,
  out retval content response,
  optional boolean nocert)

string

IDPRedirectToHomelocation(
  string svc,
  string localsvc,
  out retval string body)

void

IgnoreAppConfiguration(
  App app)

void

InitContactQuotaLimit()

void

InitialiseVCardContentSet(
  AttributeDefinition attrdef,
  ref optional any[] value,
  any[] oldvalue)

void

InitializeCreatedUser(
  ref object venv_object,
  object venv_parent,
  integer venv_index,
  object venv_view,
  object venv_action,
  optional Field[] sys_branchattr,
  optional integer[] sys_branchindex,
  ref boolean donotsharecreatedobj)

void

InitialOrganizationPurchase(
  string mail,
  optional string firstname,
  optional string surname,
  string jobtitle,
  string phone,
  DomainConnection location,
  string lang,
  Language requestlang,
  string password,
  string orgname,
  optional string paymentmethod,
  optional string vatid,
  optional string interval,
  optional string companyname,
  Address address,
  UserAppList[] products,
  SelfServiceBranding ctx,
  string returnurl,
  TeamRoom[] teamrooms,
  object[] templateteamrooms,
  string campaigncode,
  object[] autolicensedapps,
  out User registeruser,
  out boolean failed,
  ref JSAPIError[] errors,
  out string mpayurl,
  ref Group organization,
  out Subscription subscription,
  out Bill bill,
  optional string ordernumber,
  optional dictionary additionalinfos)

void

InitTestUser(
  string sessionid)

User

IsAttendeeUser(
  Attendee attendee,
  out retval User founduser)

boolean

IsCollaborator(
  Room target,
  out retval boolean iscollaborator,
  optional boolean showerror)

boolean

IsComplianceManager(
  Group targetorganzation,
  out retval boolean iscompliancemgr)

boolean

IsDeadlineContextActive(
  out retval boolean isactive)

boolean

IsDocModeVisible(
  out retval boolean isvisible)

boolean

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

boolean

IsEncryptionEnabled(
  out retval boolean enabled)

boolean

IsExtendedPrice(
  currency curr,
  boolean round,
  out retval boolean isextended)

boolean

IsGroupServiceUser(
  Group group,
  out retval boolean isprivileged)

boolean

IsHomeLocation(
  out retval boolean ishome)

boolean

IsInspector(
  object target,
  boolean includemembership,
  out retval boolean isinspector)

boolean

IsNotificationEnabled(
  optional HistoryEventType event,
  optional NotificationSettingsType type,
  ref optional object[] checkobjs,
  out retval boolean enabled)

void

IsObjectAllowed()

boolean

IsPolicyRestricted(
  AttributeDefinition policyattrdef,
  optional Group scope,
  out retval boolean restricted)

boolean

IsPrivilegedUser(
  optional boolean sysadmin,
  optional boolean approver,
  optional boolean support,
  optional boolean paymentuser,
  out retval boolean isprivileged)

boolean

IsRealUserActive(
  out retval boolean isactive)

boolean

IsReleaseLocationRestrictedToObjectGroup(
  out retval boolean isrestricted)

boolean

IsReseller(
  optional dictionary purchaserinformation,
  out retval boolean reseller,
  out Group resellerorganisation,
  out optional float discountrate,
  out Group resellingorganization)

boolean

IsServiceTokenAccessEnabled(
  out retval boolean state,
  out optional boolean visible)

boolean

IsSubstituteForParticipant(
  ActivityInstance actinst,
  WorkFlowParticipant part,
  out retval boolean issubstitute,
  out User substitutionfor)

boolean

IsTeamroomTransferToGroupNecessary(
  out retval boolean transfernecessary,
  out Group[] availablegroups,
  out TeamRoom[] owningteamrooms,
  out boolean noprivateteamrooms)

boolean

IsTransferPossibleHook(
  TransferDirection transferdirection,
  optional Group transferusergroup,
  optional string transferrootkey,
  out retval boolean transferpossible,
  out optional string customerror)

boolean

IsUpdateMode(
  out retval boolean active)

boolean

IsValidScrumNotificationRecipient(
  out retval boolean isvalid,
  optional object context)

boolean

IsWFSubstitutionActive(
  out retval boolean isactive,
  out User[] substitutes)

boolean

IsWidget(
  object object,
  out retval boolean iswidget)

boolean

IsWorkFlowServiceUser(
  out retval boolean isserviceuser,
  out Group[] servicegroups)

boolean

IsWorkflowSettingsVisible(
  out retval boolean isvisible,
  optional boolean justlicensecheck)

Address

JSON2Address(
  string json,
  out retval Address address)

UserAppList[]

JSON2Products(
  string json,
  optional boolean ignorehiddenapps,
  out retval UserAppList[] products,
  out optional object primaryproduct,
  out optional boolean istrial)

string

JWTAuthCreateToken(
  WebServiceDefinition scope,
  out retval string token)

WebServiceDefinition

JWTAuthValidateToken(
  string token,
  out retval WebServiceDefinition scope)

void

KeepAliveState(
  string statetoken)

void

KernelCleanup()

void

KernelRefresh()

void

KernelStartup()

void

LoadCompContents(
  object component,
  CompContentType conttype,
  ref optional boolean test)

void

LoggedIn()

void

Login()

void

LoginCallback()

void

LoginLocationAdded()

void

Logout()

void

LogoutCallback()

void

MailArchiveFriendlyURL()

Breadcrumb[]

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

string

MapMIMEType2FileExt(
  string mimetype,
  out retval string fileext)

void

MigrateSpecificWorkGroups(
  Group organization,
  string[] workgroups)

void

MigrateWorkGroups(
  Group organization,
  optional string emaildomainfilter)

datetime

ModifyDateTime(
  ref retval datetime value,
  ModifyDateTimeOperand operand,
  ModifyDateTimeOperator operator,
  integer modifyvalue)

void

ModifyTeamRoomAccess(
  string fsc_arg1,
  optional string fsc_arg2,
  string fsc_arg3,
  string fsc_arg4,
  string fsc_arg5)

string

MoveColumn(
  string jsoninput,
  out retval string resultjson)

string

OAuthAuthorize(
  object client,
  object[] scope,
  out retval string code,
  out boolean trusted,
  ref optional string redirecturi,
  optional AuthMeth authmeth,
  optional string ipaddress)

void

OAuthCheckToken(
  string token,
  out object[] scope,
  out AuthMeth authmeth)

void

OAuthConfirm(
  object client,
  string code,
  optional boolean usesecclearance)

OAuthTokenExpiration

OAuthGetTokenExpiration(
  object client,
  out retval OAuthTokenExpiration expiration)

void

ObjectConstructor(
  optional object sourceobj)

object

ObjectCopy(
  ref optional object placement,
  out retval object object,
  optional string address,
  optional boolean virtualobject)

object

ObjectCopyPostWrapper(
  ref object coostdom,
  out retval object object,
  optional string address,
  optional boolean virtualobject)

void

ObjectDeleteCloudWrapper()

boolean

ObjectExtendAccess(
  object accesstype,
  optional object attrdef,
  out retval boolean allowaccess)

void

ObjectFinalizeCommit(
  object[] attrlist)

void

ObjectPrepareCommit(
  boolean internalchange)

void

ObjectPrepareCommitPreWrapper(
  ref boolean internalchange)

void

ObjectRestoreVersion()

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

OpenDocument(
  string docid,
  optional string contrep,
  optional boolean opencontainer)

void

PairedDeviceConfirmAccess(
  PairedDevice paireddevice,
  optional content devicecert)

object[]

PairedDeviceGetCACertificates(
  out retval object[] cacertificates)

void

PairingDigitalIdApp(
  out string diddigitalid,
  out string didusersurname,
  out string diduserfirstname,
  out string didusertitle,
  out string diduserdayofbirth,
  ref optional DigitalIdType didauthtype)

void

ParseContactContent(
  optional content vcard)

void

ParseFilepath(
  string filepath,
  out string filename,
  out string fileext,
  out string directory,
  out string separator)

void

PersistCoverage()

void

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

void

Prepare(
  string directory)

void

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

void

ProcessRequest(
  interface context)

boolean

ProcessStatisticsEnabled(
  out retval boolean enabled,
  optional Group targetgroup)

void

ProcessWebDAVRequest(
  interface context,
  integer loginrc,
  string loginmsg)

content

ProtoBufURL(
  content request,
  out retval content response)

void

PublishCategory(
  boolean release,
  ComponentTemplateCategory category,
  object template)

void

PurchaseDistributionBundle(
  object arg1,
  string arg2,
  string arg3,
  optional string arg4,
  optional string arg5)

object[]

QueryAuditLogByUser(
  AuditQueryType querytype,
  out retval object[] result,
  optional object owngroup)

void

ReactivateUser(
  optional integer unused1,
  optional integer unused2)

void

ReadDocument(
  string docid,
  optional string contrep,
  optional boolean opencontainer)

void

RegisterObject(
  IncomingComponentCategory regcat,
  object regobj,
  CompoundObject regtargetobj,
  AttributeObjectDef regtargetview)

void

RegisterObjectAppHook(
  IncomingComponentCategory regcat,
  object regobj,
  dictionary scopedict)

void

RegisterPushNotificationDevice(
  string token,
  optional string deviceid,
  optional string devicename,
  optional WorkStationType devicetype)

string

RemoveColumn(
  string jsoninput,
  out retval string resultjson)

void

RemoveObjectsFromFavorites(
  object removeobjs)

void

RenameObject(
  optional integer unused1,
  optional integer unused2,
  ref string name,
  boolean clear,
  string caption)

void

RenewServiceToken(
  optional integer key)

void

ReplaceNonActiveUser(
  User existinguser,
  string useremail,
  boolean showerror)

void

ReplaceObjectAppHook(
  object targetobject,
  object replacement,
  dictionary scopedict)

void

ResizeColumn(
  string jsoninput)

string

ResolveFieldRPC(
  string argumentsinjson,
  out retval string resultjson)

void

ResolveTextModules(
  ref object[] textmodules)

void

RestoreStateTransaction(
  string transcationbackup)

void

RunTests(
  string[] includedfeatures,
  optional object parent,
  optional string[] ignoredfeatures)

void

ScanDocument(
  ref string docid,
  optional string contrep,
  optional boolean archiveimmediate,
  ref optional object object)

void

ScheduleLocal(
  object[] objects,
  object action,
  optional object resource)

void

SearchObjectsCalled(
  string query,
  boolean async)

void

SelectDocFile(
  out string docfile)

void

SendBackgroundSecure(
  any[] to,
  optional any[] cc,
  optional any[] bcc,
  any subject,
  string[] body,
  optional object[] attachments,
  optional boolean usepubliclinks,
  optional ContentFormat downloadformat,
  out string[] errorlog,
  optional string replytoaddress,
  optional string headertitle,
  optional Language fallbacklanguage)

TransmissionLog

SendFolioMail(
  dictionary params,
  out retval TransmissionLog log,
  out boolean cancelpressed)

void

SendFolioMailPreparation(
  ref dictionary params)

void

SendPushNotification(
  string title,
  string[] body,
  optional object obj,
  optional string link)

string

SendSMS(
  string to,
  string message,
  out retval string responsecode,
  ref SMSProvider[] usedproviders,
  out string messageid,
  out string cost,
  out string smscount,
  optional string username)

void

ServiceStarted()

void

ServiceStopped()

void

ServiceTokenAccessPending(
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

void

ServiceTokenExpirationPending(
  ServiceTokenAccess[] tokenaccess)

void

ServiceTokenInvalid(
  optional ServiceTokenAccess tokenaccess,
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

SessionInfo[]

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

SessionInfo[]

SessionInfoListGet(
  out retval SessionInfo[] sessions)

void

SessionLoggedIn(
  SessionInfo sessioninfo)

void

SetExternalQuotaEntry(
  object source,
  integer quotakb,
  integer objquota)

void

SetImplicitRoleChange(
  object venv_object)

Language

SetRequestLanguage(
  string lang,
  out retval Language requestlang,
  out Language origlang)

Locale

SetRequestLocale(
  string locale,
  out retval Locale requestlocale)

void

SetStoredTimes(
  Action key,
  optional datetime from,
  optional datetime to)

void

SetUserClientDomain(
  object clientdomain)

void

SetUserEnvironment(
  object environment)

void

SetUserEnvironmentPostWrapper(
  object environment)

void

SetUserEnvironmentPreWrapper(
  object environment)

void

SetUserLanguage(
  optional object language)

void

SetUserLocale(
  object locale)

void

SetUserRole(
  object group,
  object position,
  optional object substuser)

void

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

void

SetUserRolePostWrapper(
  object group,
  object position,
  optional object substuser)

void

SetWidgets(
  object[] objects,
  optional boolean remove,
  optional boolean removefromroot)

void

ShowAnonymizationLinksProtocol(
  optional integer unused1,
  optional integer unused2)

boolean

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

content

ShowOverviewWithQRCodeFURL(
  string selection,
  out retval content pdfcont,
  optional OverviewErrorMode errormode)

void

ShowPersonalDataOverview(
  optional integer unused1,
  optional integer unused2)

content

ShowPersonalDataOverviewFURL(
  string emailaddress,
  out retval content pdfcont,
  optional OverviewErrorMode errormode)

void

ShowRoomUsage(
  optional integer unused1,
  optional integer unused2)

void

ShowTeamrooms(
  string fsc_arg1,
  optional string fsc_arg2,
  optional string fsc_arg3,
  optional string fsc_arg4,
  string fsc_arg5)

void

ShowUserAccountActivity(
  optional integer unused1,
  optional integer unused2)

boolean

ShowWelcomeScreen(
  ref retval boolean show)

void

Shutdown()

string

SIDUseId(
  integer digitalidtype,
  out retval string authurl)

string

StartCoverage(
  optional string[] comprefs,
  out retval string session)

void

StartTestScenario(
  optional integer unused1,
  optional integer unused2)

string

StartTestSession(
  optional TestScenario scenario,
  optional string defaultpassword,
  ref optional dictionary data,
  optional string testscope,
  optional UnitTest unittest,
  ref retval string sessionid,
  out Response response)

string

StartTestSessionFURL(
  optional TestScenario scenario,
  ref optional string sessionid,
  ref optional string testscope,
  optional string format,
  optional string defaultpassword,
  optional object context,
  out retval string webpage)

content

StockAPIDownloadAssetByID(
  StockConnection conn,
  string accesstoken,
  string stockid,
  out retval content asset,
  out optional string downloadfilename)

content

StockAPIDownloadAssetByLink(
  StockConnection conn,
  string accesstoken,
  string downloadurl,
  out retval content asset,
  out optional string downloadfilename)

string

StockAPIFetchServiceUserAccessToken(
  StockConnection conn,
  out retval string accesstoken)

dictionary

StockAPIGetContentInfo(
  StockConnection conn,
  string accesstoken,
  string stockid,
  out retval dictionary contentinfo)

dictionary

StockAPIGetContentLicense(
  StockConnection conn,
  string accesstoken,
  string stockid,
  out retval dictionary contentlicenseinfo)

dictionary

StockAPIGetLicenseHistory(
  StockConnection conn,
  string accesstoken,
  optional integer limit,
  optional integer offset,
  optional boolean allorghistory,
  out retval dictionary historydata)

dictionary

StockAPIGetProfile(
  StockConnection conn,
  string accesstoken,
  out retval dictionary profiledata)

dictionary

StockAPISearch(
  StockConnection conn,
  string accesstoken,
  optional integer limit,
  optional integer offset,
  optional SearchFilter filter,
  out retval dictionary searchresult,
  optional boolean secondtry)

void

StockPairOAuth(
  StockConnection conn)

void

StockPairOAuthFinished(
  StockConnection conn)

CoverageData

StopCoverage(
  string session,
  out retval CoverageData coverage,
  optional boolean reportuncovered)

void

StopTestSession(
  optional string sessionid,
  ref optional dictionary data)

string

StopTestSessionFURL(
  string sessionid,
  optional string format,
  out retval string webpage)

datetime

Str2DateTime(
  string str,
  out retval datetime value)

float

Str2Float(
  string str,
  out retval float value)

integer

Str2Integer(
  string str,
  out retval integer value)

boolean

SubstitutionsAreActive(
  boolean checkchangeable,
  out retval boolean active)

void

SubstitutionsEndActive()

string

SwitchColumn(
  string jsoninput,
  out retval string resultjson)

void

SwitchToUpdateModeFriendlyURL(
  boolean enable,
  optional boolean broadcast,
  out string response)

void

SwitchToUser(
  optional any addressorlogname,
  optional boolean forceabort)

void

SyncContactFolder(
  DomainConnection dc,
  boolean deleteremote)


FSCVAPP@1.1001:Abort Permanent link for this heading

void FSCVAPP@1.1001:Abort()

Additional Information


FSCVAPP@1.1001:AbortRoot Permanent link for this heading

void FSCVAPP@1.1001:AbortRoot()

Additional Information


FSCFOLIOCLOUD@1.1001:AcceptGroupMembership Permanent link for this heading

Application called from a link in a mail to confirm the membership of an organization

void FSCFOLIOCLOUD@1.1001:AcceptGroupMembership(
  string fsc_arg1,
  string fsc_arg2,
  string fsc_arg3)

Name

Description

fsc_arg1

the encrypted object address of the organization

fsc_arg2

the encrypted address of the user who confirms the membership

fsc_arg3

the encrypted address of the room to which the user was registered

Additional Information


FSCFOLIOCLOUD@1.1001:AcceptNewEMailAddress Permanent link for this heading

Application to confirm the addedd email address. The application is called from a link in the confirmation mail.

void FSCFOLIOCLOUD@1.1001:AcceptNewEMailAddress(
  string fsc_arg1,
  string fsc_arg2,
  string fsc_arg3,
  boolean fsc_register)

Name

Description

fsc_arg1

the encrypted object addess of the contact for whom the email address should be added.

fsc_arg2

the added email address in an encrypted format.

fsc_arg3

the encrypted information if the new email address should be used for login.

fsc_register

defines if the mail address is accepted during the registration use case

Additional Information


FSCFOLIOCLOUD@1.1001:AccountCanBeDeleted Permanent link for this heading

Action to check if a cloud account can be deleted

boolean FSCFOLIOCLOUD@1.1001:AccountCanBeDeleted(
  boolean silent,
  out retval boolean canbedeleted)

Name

Description

silent

not errors are raised just the result is set

canbedeleted

the result

Additional Information


FSCFOLIOWIZ@1.1001:ActivateMenuEntry Permanent link for this heading

void FSCFOLIOWIZ@1.1001:ActivateMenuEntry(
  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


FSCFOLIOCLOUD@1.1001:AddAsOrgMember Permanent link for this heading

Add a user as member or external member to a cloud organization.
Based on the user's email address, the user becomes a member or an external member.

Group[] FSCFOLIOCLOUD@1.1001:AddAsOrgMember(
  Group organization,
  optional boolean sendinvitationmail,
  out retval Group[] addedto)

Name

Description

organization

the organization

sendinvitationmail

send invitation mail

addedto

the organization or external organization where the user was added to

Additional Information


FSCTEAMROOM@1.1001:AddAssignedRoomsToWidgets Permanent link for this heading

Adds the assigned rooms to the widgests if necessary. This action is called when calculating the widgets for home

object[] FSCTEAMROOM@1.1001:AddAssignedRoomsToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Additional Information


FSCSCM@1.1001:AddColumn Permanent link for this heading

Adds a column to the usersettings dictionary

string FSCSCM@1.1001:AddColumn(
  string jsoninput,
  out retval string resultjson)

Name

Description

jsoninput

contains the column attribute definition of the added column and the definition of the feeded list needed by GetFeededListData

resultjson

the generated data from the list-ctrl of the updated list, parsed as string

Additional Information


FSCTEAMROOM@1.1001:AddFavoritesObjectToWidgets Permanent link for this heading

Adds the user favorites folder to the widgets if necessary. This action is called when calculating the widgets for home

object[] FSCTEAMROOM@1.1001:AddFavoritesObjectToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Widgets list

Additional Information


FSCVAPP@1.1001:AddJavaScript Permanent link for this heading

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

Example:
Server side code inside the application:

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

Client side code inside the JavaScriptComponentObject #MyJavascriptComonentObject:

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

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

Name

Description

javascript

The JavaScriptComponentObject which will be added to the page.

parameters

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

Additional Information


FSCOWS@1.1001:AddJSAPIError Permanent link for this heading

void FSCOWS@1.1001:AddJSAPIError(
  ref JSAPIError[] errors,
  any error,
  optional string key)

Name

Description

errors

error

key

Additional Information


FSCVAPP@1.1001:AddLocalObjects Permanent link for this heading

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

Name

Description

objects

Additional Information


FSCFOLIOCLOUD@1.1001:AddNewEMailAddress Permanent link for this heading

Application to add a new email address to a contact. Currently used in the settingsportal of Fabasoft Cloud

void FSCFOLIOCLOUD@1.1001:AddNewEMailAddress()

Additional Information


FSCSCM@1.1001:AddNextColumn Permanent link for this heading

string FSCSCM@1.1001:AddNextColumn(
  string jsoninput,
  out retval string resultjson)

Name

Description

jsoninput

resultjson

Additional Information


FSCNOTIFICATION@1.1001:AddNotificationsToWidgets Permanent link for this heading

object[] FSCNOTIFICATION@1.1001:AddNotificationsToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Additional Information


FSCOWSSTDSERVICES@1.1001:AddObjectRemark Permanent link for this heading

Adds a remark including attachments to an object Alternatively - especially for larger files - attachment can be uploaded via WebDAV PUTting a file to a URL like http(s)://urlhead/webdav/[<b>COO.x.y.a.b</b>-FSCFOLIO_1_100_boaddreferences]/<b>Screenshot.jpg</b> where
- COO.x.y.a.b is the object where the remark should be added
- Screenshot.jpg is the name and extension of the document to import

void FSCOWSSTDSERVICES@1.1001:AddObjectRemark(
  object obj,
  optional string textremark,
  optional string event,
  optional datetime timestamp,
  optional AttachmentType[] attachments)

Name

Description

obj

the object

textremark

the user entered text of the remark

event

the textual description of the remark

timestamp

the timestamp of the remark

attachments

the list of attachments assigned to the remark

Additional Information


COODESK@1.1:AddObjectsToFavorites Permanent link for this heading

Add objects to the users favorites list

void COODESK@1.1:AddObjectsToFavorites(
  object[] addobjs)

Name

Description

addobjs

List of objects

Additional Information


FSCFOLIOCLOUD@1.1001:AddOrganizationToWidgets Permanent link for this heading

Adds the organization to the widgets if necessary. This action is called when calculating the widgets for home

object[] FSCFOLIOCLOUD@1.1001:AddOrganizationToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Additional Information


FSCTEAMROOM@1.1001:AddPortalSearchToWidgets Permanent link for this heading

Adds the portal search to the widgets if necessary. This action is called when calculating the widgets for home

object[] FSCTEAMROOM@1.1001:AddPortalSearchToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Widgets list

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


FSCFOLIO@1.1001:AddRemark Permanent link for this heading

void FSCFOLIO@1.1001:AddRemark(
  optional any remark,
  optional string event,
  optional datetime _date,
  optional object[] references,
  optional boolean suppresshistory)

Name

Description

remark

event

_date

references

suppresshistory

Additional Information


FSCMOBILEAPPS@1.1001:AddSavedSearchQueries Permanent link for this heading

Adds new searches to the list of saved searches of the CtxPersonalQueries object.

dictionary[] FSCMOBILEAPPS@1.1001:AddSavedSearchQueries(
  dictionary[] savedsearches,
  out retval dictionary[] result,
  out JSAPIError[] errors)

Name

Description

savedsearches

A list of dictionaries where each dictionary contains a name and a searchinfo.

result

A list of successfully added searches. Uses the same dictionary format as the savedsearches input parameter.

errors

A list of errors. @see AddSavedSearch @see JSAPIError

Additional Information


FSCFOLIOCLOUD@1.1001:AddSearchUser Permanent link for this heading

Adds a user as search user to another user

void FSCFOLIOCLOUD@1.1001:AddSearchUser(
  AttributeDefinition attrdef,
  User user)

Name

Description

attrdef

the attribute where the user should be stored. Only "objsecread" is allowed

user

the user who will be stored

Additional Information


FSCFOLIOCLOUD@1.1001:AddStandardRoomsToWidgets Permanent link for this heading

Adds the organization folder including the standard rooms to the widgests if necessary. This action is called when calculating the widgets for home

object[] FSCFOLIOCLOUD@1.1001:AddStandardRoomsToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Additional Information


FSCCMISCLIENT@1.1001:AddSynchronizedFolderToWidgets Permanent link for this heading

Adds the SynchronizedFolder to the widgests if necessary. This action is called when calculating the widgets for home

object[] FSCCMISCLIENT@1.1001:AddSynchronizedFolderToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Additional Information


FSCFOLIOCLOUD@1.1001:AddUserAsExternalMember Permanent link for this heading

Assign a member to an external organization

void FSCFOLIOCLOUD@1.1001:AddUserAsExternalMember(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCTEAMROOM@1.1001:AddUserHistoryToWidgets Permanent link for this heading

Adds the user history to the widgests if necessary. This action is called when calculating the widgets for home

object[] FSCTEAMROOM@1.1001:AddUserHistoryToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Additional Information


FSCTEAMROOM@1.1001:AddWorkListToWidgets Permanent link for this heading

Adds the worklist to the widgests if necessary. This action is called when calculating the widgets for home

object[] FSCTEAMROOM@1.1001:AddWorkListToWidgets(
  ref retval object[] widgets)

Name

Description

widgets

Additional Information


FSCFOLIO@1.1001:AdjustSecurityContext Permanent link for this heading

void FSCFOLIO@1.1001:AdjustSecurityContext(
  object[] attrlist)

Name

Description

attrlist

Additional Information


COOSYSTEM@1.1:AdminObjectSearch Permanent link for this heading

object[] COOSYSTEM@1.1:AdminObjectSearch(
  string query,
  out retval object[] hits)

Name

Description

query

hits

Additional Information


COOSYSTEM@1.1:AdminObjectSearchAsync Permanent link for this heading

interface COOSYSTEM@1.1:AdminObjectSearchAsync(
  string query,
  out retval interface searchresult)

Name

Description

query

searchresult

Additional Information


COOSYSTEM@1.1:AdminSearchExecute Permanent link for this heading

void COOSYSTEM@1.1:AdminSearchExecute(
  string query,
  object action)

Name

Description

query

action

Additional Information


COOSYSTEM@1.1:AllowedACLsGet Permanent link for this heading

Computes the list of ACL objects that the current user in the current role (if any) is allowed to use according to the definitions in the user object and the groups, that the user belongs to, or the current role, if the user is currently working in a role.

void COOSYSTEM@1.1:AllowedACLsGet(
  out object[] acls,
  out boolean allowadditional)

Name

Description

acls

List of ACL objects. If this list is empty, the user can use any ACL object.

allowadditional

If this parameter is TRUE, the user is restricted to certain ACLs only in some of the groups. There are other groups that allow him to use any ACL. The returned list of ACLs is not binding.

Additional Information


FSCSAP@1.1:ArchiveDocFile Permanent link for this heading

This action is called to store a local document file for SAP R/3 ArchiveLink, when the client side integration with OLE calls is used. SAP R/3 is configured to let the user select a local path name of a file and calls the integrated client to store this file.

void FSCSAP@1.1:ArchiveDocFile(
  ref string docid,
  string docfile,
  optional string contrep,
  optional boolean archiveimmediate,
  ref optional object object)

Name

Description

docid

docfile

contrep

archiveimmediate

object

Additional Information


FSCSAP@1.1:ArchiveDocument Permanent link for this heading

This action is called to connect an object to SAP R/3 ArchiveLink, when the client side integration with OLE calls is used. SAP R/3 is configured to call the integrated client to let the user select an object that should be connected to SAP R/3 ArchiveLink.

void FSCSAP@1.1:ArchiveDocument(
  ref string docid,
  optional string contrep,
  optional boolean archiveimmediate,
  ref optional object object)

Name

Description

docid

contrep

archiveimmediate

object

Additional Information


COOSYSTEM@1.1:AttrActiveSet Permanent link for this heading

void COOSYSTEM@1.1:AttrActiveSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCFOLIO@1.1001:AttrAddressSet Permanent link for this heading

void FSCFOLIO@1.1001:AttrAddressSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCFOLIO@1.1001:AttrBORemarksGetDisp Permanent link for this heading

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

Name

Description

attrdef

string

value

language

attrdeflist

flags

index

Additional Information


FSCFOLIO@1.1001:AttrBOViewRemarksCacheGet Permanent link for this heading

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

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCFOLIO@1.1001:AttrBOViewRemarksGet Permanent link for this heading

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

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOSYSTEM@1.1:AttrCheckSet Permanent link for this heading

Sets the changed properties of the object and checks the consistency. This action is called by the kernel before the changed properties are stored.

void COOSYSTEM@1.1:AttrCheckSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOMAPI@1.1:AttrEmailAddressesSet Permanent link for this heading

void COOMAPI@1.1:AttrEmailAddressesSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCVAPP@1.1001:AttrGetUDMasterGroup Permanent link for this heading

Retrieves user data master group

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

Name

Description

mastergroup

user data master group

Additional Information


COOWF@1.1:AttrLoadSharingScoreGet Permanent link for this heading

This action is used as property get action for the property userloadsharingscore. It is called by the kernel, when the value of that property is read.

void COOWF@1.1:AttrLoadSharingScoreGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCFOLIO@1.1001:AttrMainAddressSet Permanent link for this heading

void FSCFOLIO@1.1001:AttrMainAddressSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOTC@1.1001:AttrObjCategoryFilterCommon Permanent link for this heading

Filter template categories allowed for an attribute of an object (check common editing)

object[] COOTC@1.1001:AttrObjCategoryFilterCommon(
  ref retval object[] categories,
  optional AttributeDefinition attrdef,
  optional object context)

Name

Description

categories

categories

attrdef

attribute definition

context

context object

Additional Information


COODESK@1.1:AttrObjMiniIconGet Permanent link for this heading

Gets the small icon of the object.

void COODESK@1.1:AttrObjMiniIconGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOSYSTEM@1.1:AttrObjNameGet Permanent link for this heading

Get action for the property objname.

void COOSYSTEM@1.1:AttrObjNameGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


COOSYSTEM@1.1:AttrObjNameGetVersion Permanent link for this heading

Get version action for the property objname.

void COOSYSTEM@1.1:AttrObjNameGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

versnr

value

volatile

volatiletx

Additional Information


FSCFOLIO@1.1001:AttrPersSalutationSet Permanent link for this heading

void FSCFOLIO@1.1001:AttrPersSalutationSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCCONNECT@1.1001:AttrSyncPriorityGet Permanent link for this heading

Define the synchronization priority for objects

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

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCFOLIO@1.1001:AttrTelephoneSet Permanent link for this heading

void FSCFOLIO@1.1001:AttrTelephoneSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:AttrUserAppsSet Permanent link for this heading

Set method for user apps to prevent unauthorized access

void FSCFOLIOCLOUDPAYMENT@1.1001:AttrUserAppsSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOSYSTEM@1.1:AttrUserOnlineGet Permanent link for this heading

void COOSYSTEM@1.1:AttrUserOnlineGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCFOLIOCLOUD@1.1001:AttrUserPolicySet Permanent link for this heading

void FSCFOLIOCLOUD@1.1001:AttrUserPolicySet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOSYSTEM@1.1:AttrUserSettingsConstructor Permanent link for this heading

Creates the user settings object.

any COOSYSTEM@1.1:AttrUserSettingsConstructor(
  AttributeDefinition attrdef,
  out retval any value)

Name

Description

attrdef

value

Additional Information


COOSYSTEM@1.1:AttrUserSurNameGet Permanent link for this heading

void COOSYSTEM@1.1:AttrUserSurNameGet(
  AttributeDefinition attrdef,
  ref any value,
  out optional boolean volatile,
  out optional boolean volatiletx)

Name

Description

attrdef

value

volatile

volatiletx

Additional Information


FSCFOLIOCLOUD@1.1001:AttrUserTeamRoomOnSecuritySet Permanent link for this heading

AttrUserTeamRoomOnSecuritySet

void FSCFOLIOCLOUD@1.1001:AttrUserTeamRoomOnSecuritySet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCTRANSFER@1.1001:AuthorizeTransfer Permanent link for this heading

Authorize Transfer. Get authentication code and retrieve access token.

void FSCTRANSFER@1.1001:AuthorizeTransfer(
  content request,
  out content response)

Name

Description

request

response

Additional Information


FSCVAPP@1.1001:BackupStateTransaction Permanent link for this heading

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

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

Name

Description

transcationbackup

the serialized transaction

Additional Information


FSCFOLIODIGITALIDAT@1.1001:BKUUseId Permanent link for this heading

string FSCFOLIODIGITALIDAT@1.1001:BKUUseId(
  integer digitalidtype,
  out retval string authurl)

Name

Description

digitalidtype

authurl

Additional Information


FSCFOLIO@1.1001:CacheRegistrationTarget Permanent link for this heading

void FSCFOLIO@1.1001:CacheRegistrationTarget(
  IncomingComponentCategory regcat,
  object regobj,
  object regtargetobj)

Name

Description

regcat

regobj

regtargetobj

Additional Information


FSCFOLIO@1.1001:CalcMainAddress Permanent link for this heading

void FSCFOLIO@1.1001:CalcMainAddress(
  optional boolean forcecalc)

Name

Description

forcecalc

Additional Information


FSCORGMGMT@1.1001:CalcSessionInfos Permanent link for this heading

UserSessionInfo[] FSCORGMGMT@1.1001:CalcSessionInfos(
  optional boolean interactive,
  optional Group[] masterorgs,
  out retval UserSessionInfo[] sessioninfos)

Name

Description

interactive

masterorgs

sessioninfos

Additional Information


FSCORGMGMT@1.1001:CalcUserWorkGroups Permanent link for this heading

Calculate all work groups of the user

WorkGroup[] FSCORGMGMT@1.1001:CalcUserWorkGroups(
  out retval WorkGroup[] workgroups)

Name

Description

workgroups

all work groups

Additional Information


FSCFOLIOCLOUD@1.1001:CanBeAnonymized Permanent link for this heading

Check if the supplied user can be annonymized in supplied organization. Note.: The user has to be excluded from the organization first an the exclusions have to be completed before the user can by anonymized

boolean FSCFOLIOCLOUD@1.1001:CanBeAnonymized(
  Group targetorganization,
  boolean silent,
  optional boolean requirescheduledanonymization,
  optional boolean checkmembershipexclusions,
  out retval boolean canbeanonymized)

Name

Description

targetorganization

the organization to check

silent

if false the prerequisits to anonymize the user will be raised as error

requirescheduledanonymization

if set to true a scheduled anonymization is required if false no anoynmization has to be scheduled

checkmembershipexclusions

canbeanonymized

the result

Additional Information


FSCLDAP@1.1001:CanExecuteMigrateUser Permanent link for this heading

boolean FSCLDAP@1.1001:CanExecuteMigrateUser(
  out retval boolean allowed)

Name

Description

allowed

Additional Information


COOATTREDIT@1.1:CanLicenseAsTrial Permanent link for this heading

Verify if a specified participant can license an item as trial

boolean COOATTREDIT@1.1:CanLicenseAsTrial(
  object app,
  out retval boolean trialok,
  optional string instance)

Name

Description

app

trialok

instance

Additional Information


COOTC@1.1001:CanManageCategories Permanent link for this heading

boolean COOTC@1.1001:CanManageCategories(
  object context,
  optional boolean silent,
  out retval boolean canmanage)

Name

Description

context

silent

canmanage

Additional Information


FSCORGMGMT@1.1001:CanManageRoles Permanent link for this heading

Helper to check if the current user can change the roles of a given user resp. can change the organizational structure

boolean FSCORGMGMT@1.1001:CanManageRoles(
  Group orgcontext,
  optional User user,
  optional boolean checkastargetuser,
  out retval boolean canmanage)

Name

Description

orgcontext

the organizational context

user

the user context

checkastargetuser

canmanage

the result

Additional Information


FSCORGMGMT@1.1001:CanManageUser Permanent link for this heading

Helper to check if the user on which the action is called is allowed to manage the user supplied as parameter

boolean FSCORGMGMT@1.1001:CanManageUser(
  User user,
  optional boolean donotcheckrole,
  out retval boolean canmanage,
  out Group[] managingorgs,
  optional boolean personalinformations,
  optional AttributeDefinition[] policies)

Name

Description

user

the user which should be managed

donotcheckrole

canmanage

the result

managingorgs

the organizations that manage the user

personalinformations

the users of the organization who can view personal informations (e.g Compliance-Managers)

policies

Additional Information


COOWF@1.1:CanManageWorkFlowDiagrams Permanent link for this heading

boolean COOWF@1.1:CanManageWorkFlowDiagrams(
  object context,
  optional boolean silent,
  out retval boolean canmanage)

Name

Description

context

silent

canmanage

Additional Information


FSCFOLIOCLOUD@1.1001:CanShowOrgMembershipInfos Permanent link for this heading

Check if detailed informations about the cloud organization membership can be displayed

boolean FSCFOLIOCLOUD@1.1001:CanShowOrgMembershipInfos(
  optional Group cloudorganization,
  optional object context,
  optional AttributeDefinition attrdef,
  optional boolean updatevalues,
  out retval boolean allowed)

Name

Description

cloudorganization

the cloudorganization

context

attrdef

the attribute definition for which the values should be shown

updatevalues

the user can update the values saved in this property

allowed

informations can be displayed

Additional Information


FSCFOLIOCLOUDAUTH@1.1001:CanUseMobilePIN Permanent link for this heading

User can login with Mobile PIN

boolean FSCFOLIOCLOUDAUTH@1.1001:CanUseMobilePIN(
  out retval boolean canuse)

Name

Description

canuse

Additional Information


FSCPUSHNOTIFICATION@1.1001:CanUsePushNotifications Permanent link for this heading

Defines whether push notifications can be used.
May be overridden by other software components.

boolean FSCPUSHNOTIFICATION@1.1001:CanUsePushNotifications(
  optional object obj,
  out retval boolean canuse)

Name

Description

obj

An optional object, which can be used for additional checks.

canuse

When true, push notifications can be used.

Additional Information


FSCTEAMROOM@1.1001:CanUseSearchAudit Permanent link for this heading

Checks if the User can use search audits

boolean FSCTEAMROOM@1.1001:CanUseSearchAudit(
  object context,
  optional boolean silent,
  out retval boolean canuse)

Name

Description

context

the context

silent

in silent mode no errors will be raised

canuse

true if the user can use search audits

Additional Information


FSCFOLIOCLOUDAUTH@1.1001:CanUseTwoFactor Permanent link for this heading

User can login with TwoFactor authentication

boolean FSCFOLIOCLOUDAUTH@1.1001:CanUseTwoFactor(
  out retval boolean canuse)

Name

Description

canuse

Additional Information


FSCFOLIOCLOUD@1.1001:CanViewPersonalDataOverview Permanent link for this heading

boolean FSCFOLIOCLOUD@1.1001:CanViewPersonalDataOverview(
  out retval boolean canview)

Name

Description

canview

Additional Information


FSCFOLIOCLOUD@1.1001:ChangeMembership Permanent link for this heading

Switch the membership of an user

void FSCFOLIOCLOUD@1.1001:ChangeMembership(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCSCM@1.1001:ChangeView Permanent link for this heading

Changes the active DisplayView of the given feeded list in the users dictionary

string FSCSCM@1.1001:ChangeView(
  string jsoninput,
  out retval string resultjson)

Name

Description

jsoninput

contains the new display setting and the definition of the feeded list needed by GetFeededListData

resultjson

the generated data from the list-ctrl of the updated list, parsed as string

Additional Information


COOWF@1.1:CheckActive Permanent link for this heading

This action checks if the current group or user is active. In case of users the action checks if the user has licensed the app AppWorkFlow. If the license is not valid the action returns with an error

boolean COOWF@1.1:CheckActive(
  out retval boolean active,
  optional boolean checkapplicense,
  optional object context)

Name

Description

active

The parameter return if the object is active. If the license check is performed and retrieves error the parameter active will remain empty.

checkapplicense

if the parameter is set the license check is performed or skipped. If the parameter is not set the workflow config is asked if the license check should be performed.

context

Additional Information


FSCORGMGMT@1.1001:CheckAdminRole Permanent link for this heading

Checks whether the current user has one the specified positions and orgunittypes in his current role

boolean FSCORGMGMT@1.1001:CheckAdminRole(
  object[] objs,
  out retval boolean valid,
  optional boolean checkallroles)

Name

Description

objs

list of positions and orgunittypes

valid

true if the current user has one the specified positions and orgunittypes in his current role

checkallroles

if set to true all available roles are checked for the current user

Additional Information


FSCCRYPT@1.1001:CheckAuthentication Permanent link for this heading

Hook for user authentication verification.

void FSCCRYPT@1.1001:CheckAuthentication()

Additional Information


FSCFOLIOCLOUD@1.1001:CheckAuthenticationMethodsWarnings Permanent link for this heading

void FSCFOLIOCLOUD@1.1001:CheckAuthenticationMethodsWarnings(
  AttributeDefinition attrdef,
  Group group,
  boolean separatetx,
  optional AuthenticationMethod[] disabledautenticationmethods,
  optional AuthenticationMethod[] possibleautenticationmethods)

Name

Description

attrdef

group

separatetx

disabledautenticationmethods

possibleautenticationmethods

Additional Information


COOSYSTEM@1.1:CheckDeletedAuditAccess Permanent link for this heading

void COOSYSTEM@1.1:CheckDeletedAuditAccess(
  optional object objowngroup,
  optional object objteamroom)

Name

Description

objowngroup

objteamroom

Additional Information


FSCFOLIOCLOUD@1.1001:CheckDeletedAuditAccessPreWrapper Permanent link for this heading

PreWrapper for CheckDeletedAuditAccess. This action is called when an audit entry for a deleted object should be exported.

void FSCFOLIOCLOUD@1.1001:CheckDeletedAuditAccessPreWrapper(
  ref optional object objowngroup,
  ref optional object objteamroom)

Name

Description

objowngroup

objteamroom

Additional Information


FSCFOLIOCLOUD@1.1001:CheckEmailDomain Permanent link for this heading

Check the email domain of user against the organization

boolean FSCFOLIOCLOUD@1.1001:CheckEmailDomain(
  Group organization,
  optional string useremaildomain,
  optional string[] orgmaildomains,
  out retval boolean domainok)

Name

Description

organization

useremaildomain

orgmaildomains

domainok

Additional Information


FSCTEAMROOM@1.1001:CheckEMailFormat Permanent link for this heading

Check if the mail should be sent in plain text format depending on the webbrowser of the user

boolean FSCTEAMROOM@1.1001:CheckEMailFormat(
  out retval boolean plaintext)

Name

Description

plaintext

the result

Additional Information


FSCTEAMROOM@1.1001:CheckExistingUser Permanent link for this heading

Checks if a user with the provided data (i.e. first name/surname and/or e-mail address) already exists

object[] FSCTEAMROOM@1.1001:CheckExistingUser(
  optional string firstname,
  optional string surname,
  optional string[] emails,
  boolean lognameonly,
  out retval object[] usersbyemail,
  out object[] usersbyname,
  optional boolean preferactive,
  optional boolean requireactive,
  optional boolean requirereadaccess,
  optional string externalkey,
  out object[] usersbyexternalkey,
  optional AttributeDefinition[] additionallognameattrdefs)

Name

Description

firstname

the entered first name

surname

the entered surname

emails

the entered e-mail address

lognameonly

check the login name only or check the login name and the e-mail address list

usersbyemail

returns a list of users found by e-mail address

usersbyname

returns a list of users found by first name and surname

preferactive

inactive users will be skipped if an active user is found

requireactive

overrides the parameter preferactive only active users are returned

requirereadaccess

the user must have read permissions on all results

externalkey

the external key of the user

usersbyexternalkey

returns a list of users found by external key

additionallognameattrdefs

additional attributes to be considered as logname attributes

Additional Information


COOEVENT@1.1:CheckInterests Permanent link for this heading

Check all objects on the watch list for changes.

void COOEVENT@1.1:CheckInterests()

Additional Information


COOEVENT@1.1:CheckInterestsDomain Permanent link for this heading

Check all objects on the watch list on other domains for changes.

void COOEVENT@1.1:CheckInterestsDomain()

Additional Information


FSCFOLIOCLOUDACCOUNT@1.1001:CheckLoggedInUser Permanent link for this heading

void FSCFOLIOCLOUDACCOUNT@1.1001:CheckLoggedInUser(
  string targetuseremail)

Name

Description

targetuseremail

Additional Information


FSCFOLIOSMS@1.1001:CheckMobilePhoneNumber Permanent link for this heading

Converts a phone number with formating symbols like spaces or brackets to the international format e.g 0043 (699) 606162 -> +43664606162

string FSCFOLIOSMS@1.1001:CheckMobilePhoneNumber(
  string phone,
  out retval string correct)

Name

Description

phone

the phone number to convert

correct

the converted phone number

Additional Information


FSCNOTIFICATION@1.1001:CheckNotificationAppLicense Permanent link for this heading

boolean FSCNOTIFICATION@1.1001:CheckNotificationAppLicense(
  boolean silentmode,
  optional object targetobject,
  out retval boolean haslicense)

Name

Description

silentmode

targetobject

haslicense

Additional Information


FSCPUSHNOTIFICATION@1.1001:CheckPushNotificationPolicy Permanent link for this heading

Defines whether the group policy allows push notifications.

boolean FSCPUSHNOTIFICATION@1.1001:CheckPushNotificationPolicy(
  out retval boolean allowsend)

Name

Description

allowsend

Defines whether sending push notifications for the object is allowed by group policy.

Additional Information


FSCNOTIFICATION@1.1001:CheckResubmission Permanent link for this heading

Check for active resubmissions

void FSCNOTIFICATION@1.1001:CheckResubmission()

Additional Information


FSCOWS@1.1001:CheckServiceToken Permanent link for this heading

void FSCOWS@1.1001:CheckServiceToken(
  string token,
  out object scope,
  out string comment,
  optional string ipaddress,
  optional string useragent,
  optional string urlpath)

Name

Description

token

scope

comment

ipaddress

useragent

urlpath

Additional Information


FSCFOLIOCLOUD@1.1001:CheckUnusedRooms Permanent link for this heading

Use case to review the rooms found in the unsed rooms report

void FSCFOLIOCLOUD@1.1001:CheckUnusedRooms(
  string fsc_arg)

Name

Description

fsc_arg

the arguments

Additional Information


COOSYSTEM@1.1:CheckUserQuota Permanent link for this heading

void COOSYSTEM@1.1:CheckUserQuota(
  out integer contentquota,
  out integer contentquotalimit,
  optional integer addcontentquota,
  out integer objectquota,
  out integer objectquotalimit,
  optional integer addobjectquota)

Name

Description

contentquota

contentquotalimit

addcontentquota

objectquota

objectquotalimit

addobjectquota

Additional Information


COOWF@1.1:CheckWorkFlowAppLicense Permanent link for this heading

Check if the app workflow is licensed for the current user

boolean COOWF@1.1:CheckWorkFlowAppLicense(
  optional boolean disableerrorapps,
  optional boolean silentmode,
  out retval boolean haslicense)

Name

Description

disableerrorapps

silentmode

haslicense

Additional Information


COOWF@1.1:CheckWorkList Permanent link for this heading

This action is used as timer action to check periodically, if new items have arrived in the work list and to notify the user, if he has configured interest in the some or all item lists of the work list. If a user logs in and this software component is installed, an entry in the list of timers for this user is created automatically, that checks periodically, if the user has configured interest on the work list, and that checks, if new items have arrived. The default period is 5 minutes, this can be changed by modifying the entry in the user timer object directly.

void COOWF@1.1:CheckWorkList()

Additional Information


FSCDUCXUNIT@1.1001:Cleanup Permanent link for this heading

Delete object in test context.

This action might be implemented or wrapped to ensure proper cleanup after a test session.

void FSCDUCXUNIT@1.1001:Cleanup(
  ref optional dictionary localscope)

Name

Description

localscope

the local scope dictionary

Additional Information


FSCVAPP@1.1001:CleanupState Permanent link for this heading

Call to delete the token on the state server

void FSCVAPP@1.1001:CleanupState(
  string statetoken)

Name

Description

statetoken

the state token

Additional Information


FSCFOLIOCLOUD@1.1001:CloseWindowApp Permanent link for this heading

Provides an application view for the close window script component object

void FSCFOLIOCLOUD@1.1001:CloseWindowApp()

Additional Information


FSCFOLIOCLOUD@1.1001:CloudGetContactConflictDetail Permanent link for this heading

Needs to be wrapped, because emailinformation must not be read by everyone - use usermaildomain instead

void FSCFOLIOCLOUD@1.1001:CloudGetContactConflictDetail(
  out string name,
  out string email,
  out string tel,
  out string orgtext,
  out string thumbnailurl)

Name

Description

name

the name

email

the emailaddress

tel

the telephone number

orgtext

the name of the organization

thumbnailurl

the url for the thumbnail of the user

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:CloudOrgShop Permanent link for this heading

Fabasoft Cloud App Store for organizations

void FSCFOLIOCLOUDPAYMENT@1.1001:CloudOrgShop(
  object arg1,
  string arg2,
  optional string arg3,
  optional integer arg4,
  optional string arg5,
  optional string arg6,
  optional string arg7,
  optional string arg8)

Name

Description

arg1

the product which will be purchased

arg2

the subscription interval

arg3

the beneficial organization

arg4

the amount of purchased items

arg5

the redirect url when aborting the purchase

arg6

the redirect url when confirming the purchase

arg7

list of app:instance pairs

arg8

the affiliate marketing id

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:CloudShop Permanent link for this heading

Fabasoft Cloud App Store

void FSCFOLIOCLOUDPAYMENT@1.1001:CloudShop(
  object arg1,
  string arg2,
  integer arg3,
  string arg4,
  integer arg5,
  integer arg6,
  string arg7,
  string arg8,
  string arg9,
  string arg10,
  string arg11)

Name

Description

arg1

the product which will be purchased

arg2

the subscription interval

arg3

the purchase for other contacts is possible

arg4

the benefit recipient, used for renewal or purchases for other contacts

arg5

the amount of purchased items

arg6

the purchase is a trial version

arg7

the key for the app instance

arg8

the redirect url when aborting the purchase

arg9

the redirect url when confirming the purchase

arg10

list of app:instance pairs

arg11

the affiliate marketing id

Additional Information


FSCCMIS@1.1001:CMISFilterRepositories Permanent link for this heading

Filter for CMIS repositories. Called on user.

void FSCCMIS@1.1001:CMISFilterRepositories(
  ref RepositoryFilterType[] repositories)

Name

Description

repositories

the repositories

Additional Information


COOWF@1.1:CollectCommonStartedInstances Permanent link for this heading

object[] COOWF@1.1:CollectCommonStartedInstances(
  object[] sourceobjects,
  ref optional integer dynkey,
  optional AttributeObjectDef view,
  out retval object[] targetobjects)

Name

Description

sourceobjects

dynkey

view

targetobjects

Additional Information


FSCVAPP@1.1001:Commit Permanent link for this heading

void FSCVAPP@1.1001:Commit()

Additional Information


FSCVAPP@1.1001:CommitRoot Permanent link for this heading

Commits all transaction scopes

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

Name

Description

keepmarkedvariables

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

keepall

keep transaction variables from all Software Components

variablestokeep

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

Additional Information


COOAT@1.1001:ConfigureATTask Permanent link for this heading

Action called during configure of the current domain to configure automated tasks

void COOAT@1.1001:ConfigureATTask(
  ATConfiguredTask automatedtasksettings)

Name

Description

automatedtasksettings

the settings to configure the

Additional Information


COOSYSTEM@1.1:CoverageInfoFlush Permanent link for this heading

void COOSYSTEM@1.1:CoverageInfoFlush()

Additional Information


FSCOWSSTDSERVICES@1.1001:CreateChangeSubscription Permanent link for this heading

Creates a new change subscription

string FSCOWSSTDSERVICES@1.1001:CreateChangeSubscription(
  out retval string subscription)

Name

Description

subscription

the created change subscription

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:CreateInitialPurchaseOrganization Permanent link for this heading

Action to create an organization by an initial purchase

Group FSCFOLIOCLOUDPAYMENT@1.1001:CreateInitialPurchaseOrganization(
  boolean isshop,
  string orgname,
  optional string vatid,
  optional BillingAddress billingaddr,
  optional BillingAddress recipientdata,
  out retval Group organization,
  out boolean vatidverified,
  optional Country regaddrcountry,
  out ContractingPartner contractingpartner,
  optional boolean istrial)

Name

Description

isshop

orgname

the name of the organization

vatid

the vatid

billingaddr

the billing address

recipientdata

organization

the created organization

vatidverified

was the vat id verified successfully

regaddrcountry

contractingpartner

istrial

check if the organization is created for trial reasons

Additional Information


FSCDUCXUNIT@1.1001:CreateMailbox Permanent link for this heading

Create a new LDAP user with initial values

MailboxInfo FSCDUCXUNIT@1.1001:CreateMailbox(
  CreateUserData initdata,
  optional string sessionid,
  out retval MailboxInfo newmailbox)

Name

Description

initdata

initial values

sessionid

current session

newmailbox

created mail box

Additional Information


FSCSAP@1.1:CreateMultipartResponse Permanent link for this heading

CreateMultipartResponse is used to create a valid multipart form data request.

content FSCSAP@1.1:CreateMultipartResponse(
  optional content[] conts,
  optional dictionary[] conthdrs,
  string boundary,
  out retval content response)

Name

Description

conts

Contents that should be embedded into the multipart request.

conthdrs

Headers for the contents which are embedded for each content.

boundary

Boundary which is used to separate all contents.

response

Response holds the merged contents and headers.

Additional Information


FSCPORTAL@1.1001:CreateObject Permanent link for this heading

Friendly URL for creating an object based on HTML form data. The created object will be stored in the "form inbox" identified by the form data with name "inbox" in the object pointer property returned by GetInboxList.

Note: This method commits the current transaction. The following form data has to be provided in the HTTP POST request:
  • inbox: The identifier of an object that provides an object pointer property for multiple values by GetInboxList. The user (in general identified by the EvaluateExpression with context FormPoster) must have set access for the property returned by GetInboxList of the object identified by inbox.
    Classes that implement GetInboxList are:
    FormInbox using inboxobjs as object pointer property
    InboxRoom using ibrchildren as object pointer property
  • objectclass: Fully-qualified reference of the object class of which an object should be instantiated. The created object will be initialized by calling InitializeFromDictionary. Before, PrepareCreatedObject is invoked on the form inbox object.
  • objecttemplate: The address of a template object that will be copied. The new object will be initialized by calling InitializeFromDictionary. Before, PrepareCreatedObject is invoked on the form inbox object.
  • redirect: Redirect URL to be invoked after successful creation and initialization of the new object(s). This must be an absolute URL including protocol and host. For security reason the host of this URL must match the referrer (HTTP header "Referer" or "Origin") of the page containing the form. The URL must not be a relative URL.
  • errorredirect: Redirect URL to be invoked when a failure occurs (e.g. during creation or initialization of the new object).
    Error code and error message will be passed in URL parameters errorcode and error
    For security reason the host of this URL must match the referrer (HTTP header "Referer" or "Origin") of the page containing the form. The URL must not be a relative URL.
  • redirecttype: Defines how the redirect should be executed.
    Valid values are "302", "303", "307", all other values will be ignored. By default the redirect is executed on the client by script or meta tag http-equiv="REFRESH". If this form field is set the redirect is initiated on the server by responding with the appropriate http status code and the URL in the http header "Location".

void FSCPORTAL@1.1001:CreateObject(
  out string result)

Name

Description

result

Additional Information


FSCFOLIOPAYMENT@1.1001:CreateOffer Permanent link for this heading

Create an offer (order form) for a purchase in the Fabasoft Cloud Shop.

Bill FSCFOLIOPAYMENT@1.1001:CreateOffer(
  User purchaser,
  object recipient,
  BillingAddress recipientdata,
  BillingAddress billingaddr,
  VATSettings vatsettings,
  string vatid,
  PaymentElement[] elements,
  ContractingPartner contractingpartner,
  float discountrate,
  string affiliatemarketingid,
  boolean postponepdfgeneration,
  out retval Bill tempbill,
  optional CurrencySymbol paymentcurrency,
  optional string ordernumber)

Name

Description

purchaser

recipient

recipientdata

billingaddr

vatsettings

vatid

elements

contractingpartner

discountrate

affiliatemarketingid

postponepdfgeneration

tempbill

paymentcurrency

ordernumber

Additional Information


FSCFOLIOPAYMENT@1.1001:CreateSubscription Permanent link for this heading

Creates a subscription for a purchase in the Fabasoft Cloud Shop

Subscription FSCFOLIOPAYMENT@1.1001:CreateSubscription(
  datetime licensedfrom,
  SubscriptionInterval interval,
  PaymentElement[] newpurchasedelements,
  object benefitrecipient,
  BillingAddress recipientdata,
  object paymentowner,
  BillingAddress billingaddress,
  string customerid,
  string transactionid,
  out retval Subscription subscr,
  optional dictionary paymentinfos)

Name

Description

licensedfrom

the date when the purchase is made

interval

the duration how long the purchased items are valid for the customer

newpurchasedelements

the newly purchased items

benefitrecipient

the user or group for whom the items are purchased

recipientdata

the data of the benefit recipient

paymentowner

billingaddress

the address of the customer (purchaser) used for bill generation

customerid

the unique id for the subscription used for payment with MPay24

transactionid

the unique id for a payment transaction with MPay24

subscr

the newly created subscription will be returned

paymentinfos

Additional Information


FSCDUCXUNIT@1.1001:CreateTestGroup Permanent link for this heading

Create a new group with initial values

Group FSCDUCXUNIT@1.1001:CreateTestGroup(
  CreateGroupData initdata,
  optional string sessionid,
  ref retval Group newobject)

Name

Description

initdata

initial values

sessionid

current session

newobject

created object

Additional Information


FSCDUCXUNIT@1.1001:CreateTestUser Permanent link for this heading

Create a new user with initial values

User FSCDUCXUNIT@1.1001:CreateTestUser(
  CreateUserData initdata,
  optional string sessionid,
  ref retval User newobject)

Name

Description

initdata

initial values

sessionid

current session

newobject

created object

Additional Information


FSCTRANSFER@1.1001:CreateTransferUser Permanent link for this heading

Creates a new contact with the specified e-mail address and returns the created contact in the user parameter. If a contact with this e-mail address exists already the existing contact is returned.

Note: To check if a new contact has been created, use the cootx.IsCreated(user) statement.

User FSCTRANSFER@1.1001:CreateTransferUser(
  string email,
  optional string firstname,
  optional string surname,
  optional string middleinitial,
  optional Country country,
  optional Language language,
  out retval User user)

Name

Description

email

the e-mail address of the new contact

firstname

the first name of the new contact

surname

the surname of the new contact

middleinitial

the middle name of the new contact

country

the country of the new contact

language

the communication language of the new contact

user

the created contact

Additional Information


FSCFOLIOWIZ@1.1001:DeactivateMenuEntry Permanent link for this heading

void FSCFOLIOWIZ@1.1001:DeactivateMenuEntry(
  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: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


COOSYSTEM@1.1:DeleteAuditLogUserObj Permanent link for this heading

Delete audit log entries with a direct reference to the specified object and owngroup. The object must match the audit log entry alobject value.

void COOSYSTEM@1.1:DeleteAuditLogUserObj(
  optional object owngroup)

Name

Description

owngroup

If not null, the value must match the audit log entry alobjowngroup.

Additional Information


COOSYSTEM@1.1:DeleteAuditLogUserRef Permanent link for this heading

Update entry details with a direct reference to the specified user and owngroup. The object must match the audit log entry aluser value. For matching entries the aluser value is updated to reference the single deleted user. For matching entries the alworkstat value is updated to null.

void COOSYSTEM@1.1:DeleteAuditLogUserRef(
  optional object owngroup)

Name

Description

owngroup

If not null, the value must match the audit log entry alobjowngroup.

Additional Information


FSCOWSSTDSERVICES@1.1001:DeleteChangeSubscription Permanent link for this heading

Deletes a change subscription

void FSCOWSSTDSERVICES@1.1001:DeleteChangeSubscription(
  object subscription)

Name

Description

subscription

the change subscription

Additional Information


FSCFOLIOCLOUD@1.1001:DeleteCloudAccount Permanent link for this heading

Menu usecase to delete a cloud account

void FSCFOLIOCLOUD@1.1001:DeleteCloudAccount(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCFOLIOCLOUD@1.1001:DetermineCurrentlyLicensedEdition Permanent link for this heading

Determines the currently licensed edition for a user

AppPackage FSCFOLIOCLOUD@1.1001:DetermineCurrentlyLicensedEdition(
  optional object context,
  out retval AppPackage edition,
  out AccountRegistrationType accounttype,
  out optional AppPackage[] additionaleditions)

Name

Description

context

the context (i.e. a teamroom) this action is called in. This is used if a wrapper needs to supply a specific edition is a teamroom context.

edition

the edition that is currently licensed for the user. An edition is only provided if the action is called on the current user

accounttype

details about the account type; only valid, if assessment type is default

additionaleditions

Additional Information


FSCFOLIOPAYMENT@1.1001:DeterminePurchaserInformation Permanent link for this heading

Using this action, informations about purchaser should be determined.

dictionary FSCFOLIOPAYMENT@1.1001:DeterminePurchaserInformation(
  out retval dictionary information)

Name

Description

information

the informations about the purchaser

Additional Information


FSCDIAGRAMEDITOR@1.1001:DiagramEditorHandler Permanent link for this heading

Handle editor requests.

void FSCDIAGRAMEDITOR@1.1001:DiagramEditorHandler(
  content request,
  out content response)

Name

Description

request

response

Additional Information


FSCFOLIOCLOUD@1.1001:DisplayContextCloudOrganizationName Permanent link for this heading

Display the name of the context organization

string FSCFOLIOCLOUD@1.1001:DisplayContextCloudOrganizationName(
  boolean usefallback,
  out retval string name)

Name

Description

usefallback

if no context organization is found use the property usercloudorganization

name

of the cloud Organization

Additional Information


FSCTEAMROOM@1.1001:DoUnshareChildrenOnPressDel Permanent link for this heading

Use the unshare usecase (instead of the delete usecase) for child objects on pressing the "DEL" key

boolean FSCTEAMROOM@1.1001:DoUnshareChildrenOnPressDel(
  out retval boolean dounshare)

Name

Description

dounshare

Do unshare

Additional Information


FSCSAFE@1.1001:EncryptionEnabled Permanent link for this heading

Use case to show encryption option on import.

boolean FSCSAFE@1.1001:EncryptionEnabled(
  out retval boolean result)

Name

Description

result

Additional Information


FSCAPPTEST@1.1001:EvaluateFURL Permanent link for this heading

Evaluate Expression supplied as Friendly URL

string FSCAPPTEST@1.1001:EvaluateFURL(
  content body,
  out retval string result,
  optional string execuser)

Name

Description

body

expression

result

the result value of the expression as JSON

execuser

optional address or login name of user who should execute the expression

Additional Information


FSCDUCXUNITEVAL@1.1001:EvaluateUnitTestFURL Permanent link for this heading

Evaluates a unit test as friendly URL.

string FSCDUCXUNITEVAL@1.1001:EvaluateUnitTestFURL(
  UnitTest test,
  optional string format,
  out retval string webpage)

Name

Description

test

the test to execute

format

the format of the response

webpage

the response of the unit test

Additional Information


FSCTEAMROOM@1.1001:ExpandGroupMembers Permanent link for this heading

User[] FSCTEAMROOM@1.1001:ExpandGroupMembers(
  AdministrationObject[] targetobjs,
  out retval User[] members,
  optional boolean omitchildgroups)

Name

Description

targetobjs

members

omitchildgroups

Additional Information


FSCTEAMROOM@1.1001:ExportRoomProgressInfoContFURL Permanent link for this heading

FURL to download the CSV content of a RoomProgressInfo. Afterwards the RoomProgressInfo will be reset

content FSCTEAMROOM@1.1001:ExportRoomProgressInfoContFURL(
  RoomProgressInfo proginfo,
  out retval content cont)

Name

Description

proginfo

the RoomProgressInfo object

cont

Additional Information


FSCVPORT@1.1001:FillUserRoleSettings Permanent link for this heading

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

Name

Description

userroles

clientdomains

userenvironments

userprofiles

substrolecnt

Additional Information


FSCORGMGMT@1.1001:FilterDataImportExpr Permanent link for this heading

This action can be called in the filter actions of a cold loader to handle the data rows

void FSCORGMGMT@1.1001:FilterDataImportExpr(
  DataImportComponentObject datimpobj,
  AttributeDefinition attrdef,
  ref dictionary params)

Name

Description

datimpobj

the cold object

attrdef

the filter attribute definition

params

the global scope of the filter

Additional Information


FSCFOLIO@1.1001:FilterNotificationEventTypes Permanent link for this heading

Filter Event Types

HistoryEventType[] FSCFOLIO@1.1001:FilterNotificationEventTypes(
  ref retval HistoryEventType[] eventtypes)

Name

Description

eventtypes

List of event types

Additional Information


COOSYSTEM@1.1:FilterObjectsForUser Permanent link for this heading

Filters the objects from the specified list that are directed to the user. The user an object is directed to can be defined by specifying a user, a position, a group, or an organizational unit type, or a combination of these. Meaningful combinations are user with group, group with position, user with organizational unit type and position with organizational unit type. The objects in the list for which the user specified with the parameters of the method matches the user the method is executed for are returned.

void COOSYSTEM@1.1:FilterObjectsForUser(
  ref object[] objects,
  object[] userattrpath,
  object[] positionattrpath,
  object[] groupattrpath,
  object[] orgunittypeattrpath,
  object[] grouppositionattrpath,
  optional boolean currentroleonly)

Name

Description

objects

The list of objects that is checked. After the execution of the action it contains the list of objects that are directed to the user.

userattrpath

The property path of the property that contains the user the object is directed to.

positionattrpath

The property path of the property that contains the position the object is directed to.

groupattrpath

The property path of the property that contains the group the object is directed to.

orgunittypeattrpath

The property path of the property that contains the organizational unit type the object is directed to.

grouppositionattrpath

For internal use only.

currentroleonly

If the value is true, only the objects that are relevant for the current role of the user, are returned. If the value is false, all objects in the list for which the user matches the user specified with this method are returned. If the value is omitted, false is used.

Additional Information


FSCFOLIO@1.1001:FilterRegistrationTarget Permanent link for this heading

boolean FSCFOLIO@1.1001:FilterRegistrationTarget(
  IncomingComponentCategory regcat,
  CompoundObject regtargetobj,
  object regobj,
  out retval boolean valid)

Name

Description

regcat

regtargetobj

regobj

valid

Additional Information


FSCPORTAL@1.1001:FinalizeCommit Permanent link for this heading

void FSCPORTAL@1.1001:FinalizeCommit(
  object[] attrlist)

Name

Description

attrlist

Additional Information


COOSYSTEM@1.1:FindDomains Permanent link for this heading

Searches the domains for which the user has access rights.

object[] COOSYSTEM@1.1:FindDomains(
  out retval object[] domains)

Name

Description

domains

The list of domains for which the user has access rights.

Additional Information


COOMAPI@1.1:FindMailbox Permanent link for this heading

void COOMAPI@1.1:FindMailbox(
  string emailaddress,
  out object mailbox)

Name

Description

emailaddress

mailbox

Additional Information


FSCORGMGMT@1.1001:FindOrgElementByExternalKey Permanent link for this heading

Action to find an organizational element based on the external key

object FSCORGMGMT@1.1001:FindOrgElementByExternalKey(
  string externalkey,
  ObjectClass class,
  optional Group owngroup,
  out retval object element)

Name

Description

externalkey

the external key

class

the target class

owngroup

the owning organization

element

the found element

Additional Information


FSCFOLIOCLOUDPAYMENT@1.1001:FinishInitialOrganizationPurchase Permanent link for this heading

void FSCFOLIOCLOUDPAYMENT@1.1001:FinishInitialOrganizationPurchase(
  out integer error,
  ref User user,
  string email,
  string surname,
  optional string firstname,
  string captchachallenge,
  string captcharesponse,
  optional Country usercountry,
  optional Language language,
  optional TeamRoom[] teamrooms,
  optional object context,
  optional string returnurl,
  optional boolean skipcaptcha,
  optional TeamRoom[] teamroomtemplates,
  optional string usercampaigncode,
  optional App[] autolicensedapps,
  optional string password,
  optional dictionary additionalinfo,
  optional string phone,
  optional string organization,
  optional string jobtitle,
  optional DomainConnection location,
  optional object logocontext)

Name

Description

error

user

email

surname

firstname

captchachallenge

captcharesponse

usercountry

language

teamrooms

context

returnurl

skipcaptcha

teamroomtemplates

usercampaigncode

autolicensedapps

password

additionalinfo

phone

organization

jobtitle

location

logocontext

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


FSCDIGITALASSET@1.1001:FormatContent Permanent link for this heading

Formats an object's content according to the given Friendly URL parameters.
The parameters are passed as URL parameters: /formatcontent?param1=A&param2=B&param3=C
The following parameters are valid
  • object: COO address
  • height: integer value
  • width: integer value
  • type: target format as extension
  • stretch: stretch the image (default:false)
  • opacity: integer value
  • download: boolean value, if true the content is provided as download (default: false)

void FSCDIGITALASSET@1.1001:FormatContent(
  out content outcont)

Name

Description

outcont

the resulting content

Additional Information


FSCFOLIOPAYMENT@1.1001:FormatCurrency Permanent link for this heading

Action to format currencies depending on the locale of the customer

string FSCFOLIOPAYMENT@1.1001:FormatCurrency(
  User targetuser,
  currency curr,
  optional boolean appendsymbol,
  optional Language targetlang,
  out retval string formatted,
  optional boolean skipfreetext,
  optional boolean roundthreedigits,
  optional boolean forcedisplaythreedigits)

Name

Description

targetuser

the customer used for locale and language detection

curr

the currency (value and symbol)

appendsymbol

defines if currency symbol appended

targetlang

formatted

the currency formated in the correct locale for the customer

skipfreetext

if set to true a free prize is displayed as number

roundthreedigits

round the result to three digits

forcedisplaythreedigits

the result is displayed with three digits

Additional Information


FSCFOLIO@1.1001:FormatHistoryBlock Permanent link for this heading

InfoDetailsList[] FSCFOLIO@1.1001:FormatHistoryBlock(
  NotificationDisplayType displaytype,
  History[] events,
  out retval InfoDetailsList[] blocks)

Name

Description

displaytype

events

blocks

Additional Information


FSCFOLIOCLOUDIDP@1.1001:GenerateIDPTranslations Permanent link for this heading

content[] FSCFOLIOCLOUDIDP@1.1001:GenerateIDPTranslations(
  out retval content[] contents,
  out string[] langcodes,
  Language[] forlangs)

Name

Description

contents

langcodes

forlangs

Additional Information


FSCMSTEAMS@1.1001:GenerateMSTeamsTranslations Permanent link for this heading

content[] FSCMSTEAMS@1.1001:GenerateMSTeamsTranslations(
  out retval content[] strcontents,
  out content[] jsoncontents,
  out string[] langcodes,
  Language[] forlangs)

Name

Description

strcontents

jsoncontents

langcodes

forlangs

Additional Information


FSCFOLIOSMS@1.1001:GeneratePin Permanent link for this heading

Generates a 5-digit PIN if debugmode is on the PIN is 12345

integer FSCFOLIOSMS@1.1001:GeneratePin(
  string phone,
  out retval integer pin)

Name

Description

phone

pin

the generated PIN

Additional Information


FSCMOBILEAPPS@1.1001:GenerateTranslations Permanent link for this heading

Will return all strings from this component in an array of contents and an according array of language codes in the requested format.
The strings can be attached by multiple projects, therefore only the part before the first "_" will be taken. Some strings need to be generated as string-array (android only). When the string reference ends with "_isarray_#", the part will be cut off and a proper string-array will be created with all the items in the ascending order like the #.
Example:
When platform = "ios":
  • StrSomething_cmis_workflow
    • becomes to (for project = "_cmis")
      • StrSomething = "The something text"
    • becomes to (for project = "_workflow")
      • StrSomething = "The something text"
  • StrSomethingAsArray_isarray_1_cmis becomes to
    nothing as it is not supported for ios.
When platform = "android":
  • StrSomething_cmis_workflow
    • becomes to (for project = "_cmis")
      • <string name="StrSomething">The something text<string>
    • becomes to (for project = "_workflow")
      • <string name="StrSomething">The something text<string>
  • StrSomethingAsArray_isarray_1_cmis_faba5
  • StrSomethingAsArray_isarray_2_cmis
  • StrSomethingAsArray_isarray_3_cmis_faba5
    • becomes to (for project = "_cmis"):
      • <string-array name="StrSomethingAsArray">
        • <item>The first text of this array.</item>
        • <item>The second text of this array.</item>
        • <item>The third text of this array.</item>
      • </string-array>
    • becomes to (for project = "_faba5"):
      • <string-array name="StrSomethingAsArray">
        • <item>The first text of this array.</item>
        • <item>The third text of this array.</item>
      • </string-array>

content[] FSCMOBILEAPPS@1.1001:GenerateTranslations(
  string platform,
  string project,
  out retval content[] contents,
  out string[] langcodes,
  Language[] forlangs)

Name

Description

platform

define for which platform the contents should be prepared -> ios or android.

project

the project defines the last part of the string reference which will actually be cut off. So the strings can be defined for each project in one single component, but the actual reference will be beautified for easier usage.

contents

the array of contents which contains all strings in the proper format for the given platform

langcodes

the array of language codes for which the contents were created.

forlangs

an array of languages can be provided. If nothing is defined, all available languages will be used.

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


FSCTEAMROOM@1.1001:GetAccountRegistrationType Permanent link for this heading

Retrieve the registration type of an user e.g member of external member

AccountRegistrationType FSCTEAMROOM@1.1001:GetAccountRegistrationType(
  object context,
  out retval AccountRegistrationType accounttype,
  optional boolean skipapplicensecheck,
  optional RoomRole currentrole,
  out optional AppPackage edition,
  out optional AppPackage[] additionaleditions)

Name

Description

context

the parent context (i.e. a teamroom) this action is called in. This is used if a wrapper needs to supply a specific edition is a teamroom context.

accounttype

the registration type of the object

skipapplicensecheck

the check for the license required by the AppConfigurationRoom is skipped type will be evaluated as if the pending invitation request was already accepted

currentrole

the room role for which the required app should be checked

edition

the edition assigned to a user

additionaleditions

Additional Information


FSCVAPP@1.1001:GetActivity Permanent link for this heading

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

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

Name

Description

objects

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

activities

The recent events @see GetActivityEstimation

Additional Information


FSCVAPP@1.1001:GetActivityEstimation Permanent link for this heading

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

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

Name

Description

objects

The object list that should be checked for recent events

activities

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

quickcheck

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

Additional Information


FSCTEAMROOM@1.1001:GetActivityEstimationPostWrapper Permanent link for this heading

Activity[] FSCTEAMROOM@1.1001:GetActivityEstimationPostWrapper(
  object[] objects,
  ref retval Activity[] activities,
  optional boolean quickcheck)

Name

Description

objects

activities

quickcheck

Additional Information


FSCTEAMROOM@1.1001:GetActivityPostWrapper Permanent link for this heading

Activity[] FSCTEAMROOM@1.1001:GetActivityPostWrapper(
  object[] objects,
  ref retval Activity[] activities)

Name

Description

objects

activities

Additional Information


FSCVENVUI@1.1001:GetAdditionalConfigValues Permanent link for this heading

Returns additional configvalues that are written to the local registry

void FSCVENVUI@1.1001:GetAdditionalConfigValues(
  out string[] keys,
  out string[] values)

Name

Description

keys

list of keys, name of string value in registry

values

list of the values to the keys, each key must have its value

Additional Information


FSCFOLIOCLOUD@1.1001:GetAdditionalPersonnalDataContents Permanent link for this heading

content[] FSCFOLIOCLOUD@1.1001:GetAdditionalPersonnalDataContents(
  out retval content[] additionalcontents,
  out optional string[] filenames)

Name

Description

additionalcontents

filenames

Additional Information


COOWF@1.1:GetAdditionalPrescriptionTemplatesHook Permanent link for this heading

Hook to get additional prescription templates

PrescriptionTemplate[] COOWF@1.1:GetAdditionalPrescriptionTemplatesHook(
  object[] wfobjects,
  ref retval PrescriptionTemplate[] templates)

Name

Description

wfobjects

workflow objects

templates

list of prescription templates

Additional Information


COOWF@1.1:GetAdditionalWorkFlowDiagramsHook Permanent link for this heading

Hook to get additional additional workflow diagrams which are currently not stored in the workflow preferences

WorkFlowDiagram[] COOWF@1.1:GetAdditionalWorkFlowDiagramsHook(
  object[] wfobjects,
  ref retval WorkFlowDiagram[] diagrams,
  optional boolean requiredraftversion)

Name

Description

wfobjects

workflow objects

diagrams

list of workflow diagrams

requiredraftversion

if set to true the draft version of the diagrams is needed

Additional Information


FSCCARDDAV@1.1001:GetAddressBook Permanent link for this heading

Get address book and add to addressbook list

object FSCCARDDAV@1.1001:GetAddressBook(
  UserEnvironment userenv,
  string targetaddr,
  boolean cancreate,
  out retval object addrbook)

Name

Description

userenv

user environment

targetaddr

cooaddress of addressbook

cancreate

cancreate decide to create a defaultaddressbook

addrbook

Additional Information


FSCAPPTEST@1.1001:GetAllLanguages Permanent link for this heading

void FSCAPPTEST@1.1001:GetAllLanguages(
  out Content result,
  optional string query)

Name

Description

result

query

Additional Information


FSCORGMGMT@1.1001:GetAllOrganizationManagers Permanent link for this heading

Get all managers of an user in the target organization

User[] FSCORGMGMT@1.1001:GetAllOrganizationManagers(
  Group organization,
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

Name

Description

organization

the target organization

positionstoskip

positions which should be skipped in calculation

orgunitstoskip

organizational units which should be skipped in calculation

allmanagers

the managers

Additional Information


FSCMINDBREEZE@1.1001:GetAllowedClasses Permanent link for this heading

void FSCMINDBREEZE@1.1001:GetAllowedClasses(
  out object[] allowed,
  out object[] notallowed)

Name

Description

allowed

notallowed

Additional Information


FSCTEAMROOM@1.1001:GetAllWorkflowDiagramObjects Permanent link for this heading

Returns all instances of COOWF@1.:WorkflowDiagram that can be read by the current user. The result content consists of a JSON string that looks like the following:
[
  {"objname":"Name","objaddress":"COO.A.B.C.D",objteamroom:"Name of associated Teamroom"},
  ...
]

content FSCTEAMROOM@1.1001:GetAllWorkflowDiagramObjects(
  out retval content jsoncontent)

Name

Description

jsoncontent

the jsoncontent

Additional Information


FSCORGMGMT@1.1001:GetAssignedEdition Permanent link for this heading

This action returns the currently assigned edtion of an user

AppPackage FSCORGMGMT@1.1001:GetAssignedEdition(
  out retval AppPackage assignededition)

Name

Description

assignededition

the assigned edition

Additional Information


FSCTEAMROOM@1.1001:GetAssignedRooms Permanent link for this heading

Retrieve the assignment room object which is used to store informations about the shared teamrooms

AssignedRooms FSCTEAMROOM@1.1001:GetAssignedRooms(
  out retval AssignedRooms assignedrooms,
  boolean createnonexisting)

Name

Description

assignedrooms

createnonexisting

Additional Information


FSCTEAMROOM@1.1001:GetAvailableAppConfigurations Permanent link for this heading

Get the AppConfigurationRooms which can be used by the AppRoom

AppConfigurationRoom[] FSCTEAMROOM@1.1001:GetAvailableAppConfigurations(
  ref retval AppConfigurationRoom[] appconfigurations,
  out AppConfigurationRoom assignedconfiguration,
  optional ObjectClass targetclass)

Name

Description

appconfigurations

the allowed AppConfigurationRooms

assignedconfiguration

the currently assigned AppConfigurationRoom

targetclass

the object class of the app configuration room

Additional Information


FSCPSPDFKIT@1.1001:GetAvailablePDFSignContentsHook Permanent link for this heading

ContentObject[] FSCPSPDFKIT@1.1001:GetAvailablePDFSignContentsHook(
  out retval ContentObject[] signcontents)

Name

Description

signcontents

Additional Information


FSCPSPDFKIT@1.1001:GetAvailablePDFStampContentsHook Permanent link for this heading

ContentObject[] FSCPSPDFKIT@1.1001:GetAvailablePDFStampContentsHook(
  out retval ContentObject[] signcontents)

Name

Description

signcontents

Additional Information


COOSIGNATURE@1.1:GetAvailableSignatureAuthorizations Permanent link for this heading

Retrieve the available signature certificates for an user

object[] COOSIGNATURE@1.1:GetAvailableSignatureAuthorizations(
  boolean usefallback,
  out retval object[] authorizations)

Name

Description

usefallback

if no certificate is allowed the user a fallback certificate is retrieved

authorizations

the result

Additional Information


COOSIGNATURE@1.1:GetAvailableStamps Permanent link for this heading

Retrieve the available stamps for an user

object[] COOSIGNATURE@1.1:GetAvailableStamps(
  out retval object[] stamps)

Name

Description

stamps

the result

Additional Information


COOSIGNATURE@1.1:GetAvailableVisualSignatures Permanent link for this heading

Retrieve the visual signatures of an user

VisualSignature[] COOSIGNATURE@1.1:GetAvailableVisualSignatures(
  out retval VisualSignature[] availablesignatures)

Name

Description

availablesignatures

the visual signatures

Additional Information


COOMAPI@1.1:GetBaseURL Permanent link for this heading

string COOMAPI@1.1:GetBaseURL(
  out retval string baseurl)

Name

Description

baseurl

Additional Information


FSCDIAGRAM@1.1001:GetBpmn2BpdModel Permanent link for this heading

Returns the BPMN2 Business Process Diagram XML content of a DiagramObject, or null if none could be found.

content FSCDIAGRAM@1.1001:GetBpmn2BpdModel(
  DiagramObject diagramobject,
  out retval content bpdmodel)

Name

Description

diagramobject

the diagramobject

bpdmodel

Additional Information


FSCVENVUI@1.1001:GetBrandingFallbackLogo Permanent link for this heading

Get a fallback logo