Object Class Basic Object (COOSYSTEM@1.1:BasicObject)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:BasicObject

This abstract class is the base class for objects which have neither the base class COOSYSTEM@1.1:CompoundObject nor the base class COOSYSTEM@1.1:ContentObject.

Additional Information

Usable as Base Class: true
Abstract: true
Commonly usable: true
Base Class: COOSYSTEM@1.1:Object
Compound: false
ACL Object: COOSYSTEM@1.1:DefaultGlobalACL
Secured: SECURED_READWRITE

Actions

ReferenceName
COOATTREDIT@1.1:UseRestricedAccessForm
COODESK@1.1:ArchiveObjectComplete
COODESK@1.1:ArchiveObjectContentVersions
COODESK@1.1:ArchiveObjectContents
COODESK@1.1:ArchiveObjectVersion
COODESK@1.1:ArchiveObjectVersionCopy
COODESK@1.1:GetMenuEditCut
COODESK@1.1:IsReadableOnWorkplace
COODESK@1.1:IsTimeTravelAllowed
COODESK@1.1:LoadObjectFromArchive
COODESK@1.1:ReleaseObjectVersion
COODESK@1.1:RestoreObjectFromArchive
COODESK@1.1:UnloadObjectFromArchive
COOMAPI@1.1:AttrEMailAddressesGetDisp
COOMAPI@1.1:GetMailSplitConfiguration
COOSYSTEM@1.1:AttrChildrenDestructor
COOSYSTEM@1.1:AttrObjUseablePrimaryRelatedFilter
COOSYSTEM@1.1:IsDateValid
COOSYSTEM@1.1:LocalObjectsGetQueryConstraints
COOSYSTEM@1.1:ObjectArchive
COOSYSTEM@1.1:ObjectArchiveVersion
COOSYSTEM@1.1:ObjectLoadFromArchive
COOSYSTEM@1.1:ObjectLoadVersionFromArchive
COOSYSTEM@1.1:ObjectReleaseVersion
COOSYSTEM@1.1:ObjectRestoreFromArchive
COOTC@1.1001:AttrObjIsTemplateCtor
COOTC@1.1001:AttrObjIsTemplateSet
COOTC@1.1001:AttrTemplatesSet
COOTC@1.1001:CheckAdditionalTemplateRestrictions
COOTC@1.1001:FilterNonCommonCategories
COOTC@1.1001:InitializeWithCategoryHook
COOTC@1.1001:IsCategoryMandatory
COOWASTEBASKET@1.1:GetRestoreACL
COOWF@1.1:CanChangeProcessState
COOWF@1.1:CheckAdditionalParticipantRestrictions
COOWF@1.1:CheckParticipantAffiliation
COOWF@1.1:CheckParticipantRules
COOWF@1.1:DelegateActivityHook
COOWF@1.1:DisplayActionsInWorkflowTaskPane
COOWF@1.1:GetInitialResponsible
COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations
COOWF@1.1:GetParticipantParentAttribute
COOWF@1.1:GetPrescriptionHeadLine
COOWF@1.1:GetUsableOrgElements
COOWF@1.1:HasAdditionalParticipantRestrictions
COOWF@1.1:IsEditableWFAttribute
COOWF@1.1:LockWorkFlowObjects
COOWF@1.1:LogWorkFlowHistory
FSCCONFIG@1.1001:EvaluateGenericNameBuild
FSCFOLIO@1.1001:AddRemark
FSCFOLIO@1.1001:AdjustSecurityContext
FSCFOLIO@1.1001:AttrBORemarksGetDisp
FSCFOLIO@1.1001:AttrBOViewRemarksCacheGet
FSCFOLIO@1.1001:AttrBOViewRemarksGet
FSCFOLIO@1.1001:AttrReferenceSet
FSCFOLIO@1.1001:CanAddRemark
FSCFOLIO@1.1001:DeleteDuplicate
FSCFOLIO@1.1001:GetAlternativeWatchedNotificationObj
FSCFOLIO@1.1001:GetObjectFile
FSCFOLIO@1.1001:GetReplaceForm
FSCFOLIO@1.1001:GetSendBackgroundFrom
FSCFOLIO@1.1001:IsHistoryAvailable
FSCFOLIO@1.1001:IsObjectFileUCEnabled
FSCFOLIO@1.1001:QueueConsistencyCheck
FSCFOLIO@1.1001:RegisterObject
FSCFOLIO@1.1001:SendBackgroundSecure
FSCFOLIO@1.1001:UnshareRegisteredObject
FSCFOLIOCLOUD@1.1001:UseRestricedAccessFormPostWrapper
FSCFOLIOGUI@1.1001:AddToFavorites
FSCMINDBREEZE@1.1001:FindObjectByExternalKey
FSCMINDBREEZE@1.1001:GetMBInSpireService
FSCNOTIFICATION@1.1001:ShouldUpdateCatResubmissions
FSCORGMGMT@1.1001:GetMasterGroup
FSCPORTAL@1.1001:InitializeFromDictionary
FSCSCHEDULE@1.1001:AttrSuspendedDeadlinesDestructor
FSCSCHEDULE@1.1001:AttrSuspendedDeadlinesSet
FSCSCHEDULE@1.1001:FilterStandardRetentionDateTimeDefs
FSCSCHEDULE@1.1001:FinalizeCommitSchedulePostWrapper
FSCSCHEDULE@1.1001:GetSuspDeadlinesContainerLocations
FSCSCHEDULE@1.1001:IsDeadlineContextActive
FSCSCHEDULE@1.1001:RefreshAttributeMonitoring
FSCSCHEDULE@1.1001:ShouldUpdateDeadlines
FSCTEAMROOM@1.1001:AddToTeamRoomTemplates
FSCTEAMROOM@1.1001:ApplyTeamRoom
FSCTEAMROOM@1.1001:CheckDownloadPolicy
FSCTEAMROOM@1.1001:CheckInboxRoomContext
FSCTEAMROOM@1.1001:DisableUnshareWarningTeamRoom
FSCTEAMROOM@1.1001:IsTeamRoomChild
FSCTEAMROOM@1.1001:RemoveFromTeamRoomTemplates
FSCTEAMROOM@1.1001:ShowCreatePublicLinkMenu
FSCTEAMROOM@1.1001:ToolsAddToTeamRoomTemplates
FSCTEAMROOM@1.1001:ToolsRemoveFromTeamRoomTemplates
FSCTEMPLATEMGMT@1.1001:AddToTemplateCollection
FSCTEMPLATEMGMT@1.1001:GetPageTemplateVisibilitySettings
FSCTERM@1.1001:CreateSimpleTermHook
FSCUSERFORMS@1.1001:ApplicableCategoriesGetPostWrapper
FSCUSERFORMS@1.1001:FilterCategoriesPreWrapper
FSCUSERFORMS@1.1001:GetNameBuildPreWrapper
FSCUSERFORMS@1.1001:ObjectConstructorPostWrapper
FSCUSERFORMS@1.1001:ObjectFinalizeCommitPreWrapper
FSCVENV@1.1001:AddRecentlyUsed
FSCVENV@1.1001:CanCutObject
FSCVENV@1.1001:GetActiveMailPortalPart
FSCVENV@1.1001:GetAdditionalTaskTarget
FSCVENV@1.1001:InitializeTemplateCreatedObject
FSCVENVUI@1.1001:GetBGImageSuggestions
FSCVPORT@1.1001:CreatePortalEntry
FSCWATERMARKS@1.1001:AttrWatermarkContentGet
FSCWATERMARKS@1.1001:AttrWatermarkContentGetVersion

Actions

COOATTREDIT@1.1:UseRestricedAccessForm

Action to check if a restricted form should be displayed instead of the normal form
ParameterTypeIn/OutOptionalDescription
userestricedformCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:ArchiveObjectComplete

Moves the object to the archive.
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
checkedCOOSYSTEM@1.1:BOOLEANin/out If this parameter is false, the user is asked whether or not to archive the object.
cancelledCOOSYSTEM@1.1:BOOLEANout true, if the user cancelled the archiving process.
countCOOSYSTEM@1.1:INTEGERin The number of objects to be archived.

Additional Information

Symbol: COODESK@1.1:SymbolArchive
Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:ArchiveObjectContentVersions

Archive contents and versions of object
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
checkedCOOSYSTEM@1.1:BOOLEANin/out
cancelledCOOSYSTEM@1.1:BOOLEANout
countCOOSYSTEM@1.1:INTEGERin

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:ArchiveObjectContents

Moves the contents of the object to the archive.
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
checkedCOOSYSTEM@1.1:BOOLEANin/out If this parameter is false, the user is asked whether or not to archive the contents of the object.
cancelledCOOSYSTEM@1.1:BOOLEANout true, if the user cancelled the archiving process.
countCOOSYSTEM@1.1:INTEGERin The number of contents to be archived.

Additional Information

Symbol: COODESK@1.1:SymbolArchiveContents
Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:ArchiveObjectVersion

Moves a version of the object to the archive.

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:ArchiveObjectVersionCopy

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:GetMenuEditCut

Additional Information

Prototype: COODESK@1.1:MenuGetActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:IsReadableOnWorkplace

Action for checking whether an object can be downloaded and read on workplace.
ParameterTypeIn/OutOptionalDescription
silentCOOSYSTEM@1.1:BOOLEANintrue if true no error will be raised
isreadableCOOSYSTEM@1.1:BOOLEANretval is true if the object can be downloaded and read at the workplace
contextspecificCOOSYSTEM@1.1:BOOLEANintrue if true, the context will be checked (like in FSCDIGITALASSETMGMT@1.1001)
userCOOSYSTEM@1.1:OBJECTintrue the user to check

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:IsTimeTravelAllowed

Checks whether "Time Travel" is allowed for the current user.
By default the user must have read access for property COOSYSTEM@1.1:objversions for objects of class COOSYSTEM@1.1:ContentObject, COOSYSTEM@1.1:BasicObject and COOSYSTEM@1.1:CompoundObject.
For all other objects (especially administration objects) the user must have COOSYSTEM@1.1:AccTypeChange.
ParameterTypeIn/OutOptionalDescription
allowedCOOSYSTEM@1.1:BOOLEANretval Returns true, if time travel is possible

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:LoadObjectFromArchive

Loads the object from the archive to Fabasoft Components.

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:ReleaseObjectVersion

Releases a version of the object.
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
changedatCOOSYSTEM@1.1:DATETIMEintrue The date of the last change of the version.

Additional Information

Symbol: COODESK@1.1:SymbolTickNext
Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeRelease
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:RestoreObjectFromArchive

Restores the object from the archive in Fabasoft Components.

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:UnloadObjectFromArchive

Unloads the object from Fabasoft Components to the archive.

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOMAPI@1.1:AttrEMailAddressesGetDisp

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetDispPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOMAPI@1.1:GetMailSplitConfiguration

ParameterTypeIn/OutOptionalDescription
configsCOOMAPI@1.1:MailSplitConfigretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AttrChildrenDestructor

Deletes the objects stored in a property. This action is called by the kernel, when an object is deleted.

Additional Information

Prototype: COOSYSTEM@1.1:AttrDestructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AttrObjUseablePrimaryRelatedFilter

Filter the allowed values of attribute COOSYSTEM@1.1:objuseableprimaryrelated
ParameterTypeIn/OutOptionalDescription
valuesCOOSYSTEM@1.1:OBJECTLISTretval in/out values
attrdefCOOSYSTEM@1.1:OBJECTintrue attribute definition

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:IsDateValid

Check if the date is valid
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin the attribute definition
valueCOOSYSTEM@1.1:DATETIMEin the value to check
scopeCOOSYSTEM@1.1:DICTIONARYin VAPP scope dictionary
isvalidCOOSYSTEM@1.1:BOOLEANretval is valid

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:LocalObjectsGetQueryConstraints

Hook called by "COOSYSTEM@1.1:LocalObjectsGet" to refine the local objects query by adding additional query constraints.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin Attribute definition.
allowedclasseslistCOOSYSTEM@1.1:OBJECTLISTin List of allowed object classes for attribute.
notallowedclasseslistCOOSYSTEM@1.1:OBJECTLISTin List of not allowed object classes for attribute.
constraintsCOOSYSTEM@1.1:STRINGretval Query constraints.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectArchive

Archives the object. The parameter complete determines whether the complete object is archived or only the content properties of the object are archived. If the complete object is archived, all properties are stored in the archive and most properties are deleted from the Fabasoft Components database. Only a few properties are kept, such that the object can be displayed on the desk with the most important properties. Also all object versions, that are not yet archived, are archived completely, if the complete object is archived. The actions for archiving properties assigned to the object properties in property COOSYSTEM@1.1:attractarch are called with the value of the flag complete as parameter.
ParameterTypeIn/OutOptionalDescription
archstCOOSYSTEM@1.1:OBJECTin/out The archive store, where the object is archived. If the parameter is empty, the archive store, where the object has to be stored, is selected depending on the configured archive stores in the objects MMC Store and returned as output parameter.
completeCOOSYSTEM@1.1:BOOLEANin true means that the complete object is archived.
converttofinalformCOOSYSTEM@1.1:BOOLEANintrue
finalformatCOOSYSTEM@1.1:STRINGintrue
archiveversionsCOOSYSTEM@1.1:BOOLEANintrue
retentiondateCOOSYSTEM@1.1:DATETIMEintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectArchiveVersion

Archives a version of the object. The current object must be a version object in this action. Object versions can only be archived completely, it is not possible to archive only the contents of a version. All properties of the version are stored in the archive. The properties and contents of the version are removed completely from the Fabasoft Components database and MMC data area. The actions for archiving properties assigned to the object properties in property COOSYSTEM@1.1:attractarch are called on the version of the object with the parameter complete set to true.
ParameterTypeIn/OutOptionalDescription
archstCOOSYSTEM@1.1:OBJECTin/out The archive store, where the object is archived. If the parameter is empty, the archive store, where the object has to be stored, is selected depending on the configured archive stores in the objects MMC Store and returned as output parameter.
remainsCOOSYSTEM@1.1:BOOLEANintrue
retentiondateCOOSYSTEM@1.1:DATETIMEintrue

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectLoadFromArchive

Loads the properties of the object from the archive to the kernel cache. The current object must be a completely archived object in this action. The properties that are loaded from the archive exist only in the kernel cache until the kernel unloads them from the cache, or until COOSYSTEM@1.1:ObjectRefresh with the parameter set to true is called. It is not necessary to load objects, that have only archived contents. Archived contents are loaded automatically, when the content is needed. The actions for restoring archived properties assigned to the object properties in property COOSYSTEM@1.1:attractrestarch are called with parameter persistent set to false.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectLoadVersionFromArchive

Loads the properties of a version of the object from the archive to the kernel cache. The desired version of the object must be completely archived. If the current version of the object is also completely archived, it must be loaded, before a version of that object can be loaded. The properties that are loaded from the archive exist only in the kernel cache until the kernel unloads them from the cache, or until COOSYSTEM@1.1:ObjectRefresh with the parameter set to true is called on the current version of the object. It is not necessary to load object versions, that have only archived contents. Archived contents for versions are loaded automatically, when the content is needed.
ParameterTypeIn/OutOptionalDescription
versdateCOOSYSTEM@1.1:DATETIMEin The date of the version of the object, for which the properties should be loaded.
objectCOOSYSTEM@1.1:OBJECTout The loaded version object.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRead
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:ObjectReleaseVersion

Releases the specified version of the object. This version is automatically visible to all users who are not allowed to change the object.
ParameterTypeIn/OutOptionalDescription
versdateCOOSYSTEM@1.1:DATETIMEin The date and time of the version of the object.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeRelease
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOSYSTEM@1.1:ObjectRestoreFromArchive

Loads the properties of the object from the archive and stores them in the Fabasoft Components database and MMC data areas again. If the current object is not completely archived, only the contents are restored to the MMC data areas. If the current object is completely archived, also the properties in the Fabasoft Components database are restored. If the current object is an archived version of an object, the properties and contents of that object at that point of time are restored. In any case the current version of the object is saved, and the properties and contents are restored in a new version of the object. The actions for restoring archived properties assigned to the object properties in property COOSYSTEM@1.1:attractrestarch are called with parameter persistent set to true.

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeArchive
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:AttrObjIsTemplateCtor

Initialize property "Is Template"

Additional Information

Prototype: COOSYSTEM@1.1:AttrConstructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:AttrObjIsTemplateSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:AttrTemplatesSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:CheckAdditionalTemplateRestrictions

Check if the template is allowed in the container due to additional restrictions e.g the file obje the object
ParameterTypeIn/OutOptionalDescription
containerCOOSYSTEM@1.1:OBJECTin the container
allowedCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:FilterNonCommonCategories

Filter categories which are not commonly usable
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin the target attribute definition
modeCOOSYSTEM@1.1:CheckAllowedModein the mode
categoriesCOOSYSTEM@1.1:OBJECTLISTretval in/out the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:InitializeWithCategoryHook

Hook action called in the uichange expression of objcatetory
ParameterTypeIn/OutOptionalDescription
categoryCOOSYSTEM@1.1:OBJECTin the selected value

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOTC@1.1001:IsCategoryMandatory

Check if the category must be defined for an object
ParameterTypeIn/OutOptionalDescription
ismandatoryCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWASTEBASKET@1.1:GetRestoreACL

On restore of an object the acl returned by this action is applied to the object
ParameterTypeIn/OutOptionalDescription
restoreaclCOOSYSTEM@1.1:OBJECTretval in/out the access control list which should be applied to the object
restoreaclrefCOOSYSTEM@1.1:OBJECTin/out the security context is evaluated on the referenced object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CanChangeProcessState

Perform additional checks on the process object if the process state can be changed
ParameterTypeIn/OutOptionalDescription
procinstCOOSYSTEM@1.1:OBJECTin the process instance
statechangeableCOOSYSTEM@1.1:BOOLEANretval in/out the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

COOWF@1.1:CheckAdditionalParticipantRestrictions

If the process has additional participant restrictions the participants will be filtered by this action
ParameterTypeIn/OutOptionalDescription
participantsCOOSYSTEM@1.1:OBJECTLISTretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckParticipantAffiliation

This action is used as hook to perform additional checks if supplied the participant is valid for the current process. The action is currently called when the integrity of the participant is checked.
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantin The participant which should be checked.
actinstCOOSYSTEM@1.1:OBJECTin The current activity of the current process.
usableparticipantCOOSYSTEM@1.1:BOOLEANretval The participant can be used and the action does not need to throw an error message
skipdisplaywithaccesspartsCOOSYSTEM@1.1:BOOLEANintrue the current activity should be displayed only for participants with access permissions
requiredaccesstypesCOOSYSTEM@1.1:OBJECTLISTintrue the access types which should be checked to execute the activity

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:CheckParticipantRules

This action is intended to do additional validation checks for a participant, when a participant is entered for example in the prescription or delegation form.

The additional rule checks will be evaluated after the roles of the participant and active users and groups have been checked. After the rule checks is performed the participant will be checked for active substitutions and access of to the object of the process.

The action is called in several actions where participant input validation is performed.
Caller Actions:
ParameterTypeIn/OutOptionalDescription
partCOOWF@1.1:WorkFlowParticipantin the participant which should be checked
processelementCOOSYSTEM@1.1:OBJECTintrue the process element for which the participant check is performed. (e.g.: ActivityInstance, ProcessInstance, ActivityDefinition, ProcessDefinition, WorkFlowDiagram)
acttypeCOOWF@1.1:ActivityTypeintrue the type of the activity

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DelegateActivityHook

Hook action called on the object of the process during COOWF@1.1:SetDelegate before the participant of the activity is changed
ParameterTypeIn/OutOptionalDescription
participantCOOWF@1.1:WorkFlowParticipantretval in/out the participant
partmansubstCOOWF@1.1:WorkFlowParticipantin/outtrue the substitute of a manual participant
activityCOOSYSTEM@1.1:OBJECTin the activity which should be delegated
processCOOSYSTEM@1.1:OBJECTin the process instance the activity is assigned to.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:DisplayActionsInWorkflowTaskPane

This action is defined as hook action to display the context menu actions in the task pane of an activity instance
ParameterTypeIn/OutOptionalDescription
displayactionsCOOSYSTEM@1.1:BOOLEANretval the context menu actions should be diplayed

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetInitialResponsible

When starting a new process instance this action is called to calculate the initial responsible of the process. The calculated responsible is stored in the property COOWF@1.1:procinstresponsible. If no valid participant is returned the current user will be used as responsible of the process. Note: The responsible of the process can be changed during the execution if an activity is delegated or the responsible is changed manually.
ParameterTypeIn/OutOptionalDescription
responsibleCOOWF@1.1:WorkFlowParticipantretval the calculated responsible of the process.
respmansubstCOOWF@1.1:WorkFlowParticipantouttrue the calculated responsible of the process for manual activities.
procinstCOOSYSTEM@1.1:OBJECTintrue the newly create process instance
processsourceCOOSYSTEM@1.1:OBJECTintrue the model from which the process flow is taken. (e.g.: a WorkFlowDiagram or ProcessDefinition)

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations

Retrieve the groups for which workflow diagrams can be released
ParameterTypeIn/OutOptionalDescription
groupsCOOSYSTEM@1.1:OBJECTLISTretval the target groups

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetParticipantParentAttribute

This action is called to retrieve the attribute definition to locate the parent object for participant
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetPrescriptionHeadLine

Get title for prescription editor
ParameterTypeIn/OutOptionalDescription
headlineCOOSYSTEM@1.1:STRINGretval the headline
labelCOOSYSTEM@1.1:STRINGout
prescrlabelCOOSYSTEM@1.1:STRINGout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:GetUsableOrgElements

This action is called by the workflow participant control on the first object attached to the current process instance (or on the current object, if not used in a process instance) to retrieve the organizational elements, that should be made available for selection in the user interface. This action is intended to be wrapped or overwritten and is not implemented by the software component Workflow itself.
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin This parameter is intended to know the context, where this action is used, but is currently not set by the caller.
metaparticipantsCOOWF@1.1:WorkFlowMetaParticipantout Returns the list of allowed values for the property COOWF@1.1:wfpmetaparticipant, if not set, all available values are allowed.
usersCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed users for the property COOWF@1.1:wfpuser, if not set, any user is allowed.
positionsCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed positions for the property COOWF@1.1:wfpposition, if not set, any position is allowed.
groupsCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed groups for the property COOWF@1.1:wfpgroup, if not set, any group is allowed.
orgunittypesCOOSYSTEM@1.1:OBJECTLISTout Returns the list of allowed organizational unit types for the property COOWF@1.1:wfporgunittype, if not set, any organizational unit type is allowed.
partdefsCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of allowed participant definitions for the property COOWF@1.1:wfspartdefinition, if not set, any organizational unit type is allowed.
partnersCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of allowed partners for the property COOWF@1.1:wfppartner, if not set, any organizational unit type is allowed.
attributesCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of allowed attributes for the property COOWF@1.1:wfpattribute, if not set, any attributes is allowed.
isfilterCOOSYSTEM@1.1:BOOLEANintrue defines if the action is called by COOWF@1.1:FilterUsableObjects and the elements are filtered against the result of this action in the participant control are returned.
restrictedpartelementsCOOSYSTEM@1.1:OBJECTLISTouttrue Returns the list of attributes of the workflow participant which should be restricted to the supplied values. If a attribute is marked as restricted and no value is defined the attribute will not be displayed in the participant control. Possible values are:

COOWF@1.1:wfpmetaparticipant to disable the meta participant in the participant control

COOWF@1.1:wfpuser to disable the user in the participant control

COOWF@1.1:wfpgroup to disable the group in the participant control

COOWF@1.1:wfpposition to disable the position in the participant control

COOWF@1.1:wfporgunittype to disable the orgunittype in the participant control

COOWF@1.1:wfpattribute to disable the properties in the participant control

COOWF@1.1:wfppartner to disable the partners in the participant controls

COOWF@1.1:wfspartdefinition to disable distribution lists

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:HasAdditionalParticipantRestrictions

Check if the process has additional restrictions to the participants
ParameterTypeIn/OutOptionalDescription
additionalrestrictionsCOOSYSTEM@1.1:BOOLEANretval the result

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:IsEditableWFAttribute

ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
actioncontextCOOSYSTEM@1.1:OBJECTLISTintrue
iseditableCOOSYSTEM@1.1:BOOLEANretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:LockWorkFlowObjects

This hook action is called to lock the activities of the process.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOWF@1.1:LogWorkFlowHistory

Hook action when a history modification should be logged
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin the action context from which the history logging is called
workfowobjectCOOSYSTEM@1.1:OBJECTin this object is the activity instance or process instance which is concerned.
valueintrue if the logging is called from a set action this parameter contains the value parameter the caller
oldvalueintrue if the logging is called from a set action this parameter contains the oldvalue parameter the caller

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCCONFIG@1.1001:EvaluateGenericNameBuild

Calculates and sets the new name of the object
ParameterTypeIn/OutOptionalDescription
forceCOOSYSTEM@1.1:BOOLEANintrue when null or false, the name is only generated if any of the defining properties of the namebuild are modified in this transaction

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

FSCFOLIO@1.1001:AddRemark

ParameterTypeIn/OutOptionalDescription
remarkintrue
eventCOOSYSTEM@1.1:STRINGintrue
_dateCOOSYSTEM@1.1:DATETIMEintrue
referencesCOOSYSTEM@1.1:OBJECTLISTUNIQintrue
suppresshistoryCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIO@1.1001:AdjustSecurityContext

ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTin

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Disable Wrapper Actions: true


[top]

FSCFOLIO@1.1001:AttrBORemarksGetDisp

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetDispPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIO@1.1001:AttrBOViewRemarksCacheGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIO@1.1001:AttrBOViewRemarksGet

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIO@1.1001:AttrReferenceSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIO@1.1001:CanAddRemark

Check if the user has the sufficient permissions to add a remark
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
canaddremarkCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIO@1.1001:DeleteDuplicate

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIO@1.1001:GetAlternativeWatchedNotificationObj

If the current object is not watched for history notification an alternative object can be returned by this action. E.g. If the current room is not watched maybe the dashboard of the room is watched
ParameterTypeIn/OutOptionalDescription
alternativeobjCOOSYSTEM@1.1:OBJECTretval
sourceobjectCOOSYSTEM@1.1:OBJECTintrue the object from which the notification settings are requested
includeroomalternativeCOOSYSTEM@1.1:BOOLEANintrue if set the room of the current object is included

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIO@1.1001:GetObjectFile

Action to retrieve the file of an object
ParameterTypeIn/OutOptionalDescription
includeselfCOOSYSTEM@1.1:BOOLEANintrue if the current object is a file it will return itself.
objfileCOOSYSTEM@1.1:OBJECTretval the file of an object

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Secured: SECURED_READWRITE


[top]

FSCFOLIO@1.1001:GetReplaceForm

ParameterTypeIn/OutOptionalDescription
replaceformCOOSYSTEM@1.1:OBJECTretval in/out

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIO@1.1001:GetSendBackgroundFrom

Calculate the "From" e-mail address to be used within SendBackground.
ParameterTypeIn/OutOptionalDescription
fromCOOSYSTEM@1.1:STRINGretval The e-mail address.
usedefaultsenderCOOSYSTEM@1.1:BOOLEANin Use the configured default sender, or calculate the sender e-mail address in the context of the current user.
userlangCOOSYSTEM@1.1:OBJECTintrue The language to be used to calculate the display name of the sender.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIO@1.1001:IsHistoryAvailable

This action is used to define if the history is available for the current object
ParameterTypeIn/OutOptionalDescription
isavailableCOOSYSTEM@1.1:BOOLEANretval the result not if the history is only available in restriced mode the value will be false
includesecuredCOOSYSTEM@1.1:BOOLEANintrue the parameter defines if the current object even should be included if it is secured with a security level and the current user is not logged in with this security level
customerrortextCOOSYSTEM@1.1:STRINGouttrue a custom error text
displayrestrictedCOOSYSTEM@1.1:BOOLEANouttrue the parameter is set to true if the history is only available in restricted mode

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIO@1.1001:IsObjectFileUCEnabled

Calculates if the file usecases are enabled for object of a file. By default FSCTEAMROOM@1.1001:IsObjectFile is evaluated
ParameterTypeIn/OutOptionalDescription
includeselfCOOSYSTEM@1.1:BOOLEANintrue if the current object is a file it will check for itself.
objfileCOOSYSTEM@1.1:OBJECTout the file of the object
enabledCOOSYSTEM@1.1:BOOLEANretval true if the file usecases are enabled

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIO@1.1001:QueueConsistencyCheck

Queues the consistency for the file of an object

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIO@1.1001:RegisterObject

ParameterTypeIn/OutOptionalDescription
regcatCOOSYSTEM@1.1:OBJECTin
regobjCOOSYSTEM@1.1:OBJECTin
regtargetobjCOOSYSTEM@1.1:OBJECTin
regtargetviewCOOSYSTEM@1.1:OBJECTin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIO@1.1001:SendBackgroundSecure

Sends an e-mail via SMTP to the given users. The body can be defined as plain text only. The mail will be sent as HTML. Sender is defined by the SMTP-Configuration.
ParameterTypeIn/OutOptionalDescription
toin List of objects (users, contacts) or a list of strings to which an e-mail should be sent.
ccintrue List of objects (users, contacts) or a list of strings to which an e-mail should be sent in CC
bccintrue List of objects (users, contacts) or a list of strings to which an e-mail should be sent in BCC.
subjectin A subject is essential for an e-mail to be able to be sent. A subject can be either a plain string or a string object. If a string object is passed as subject, the used language is based on the user communication language. If there is no subject passed, the name or address from the first attachment will be used instead.
bodyCOOSYSTEM@1.1:STRINGLISTin The text for the e-mail. Can contain: STRING, STRINGLIST.
attachmentsCOOSYSTEM@1.1:OBJECTLISTintrue A list of attachment objects for which MX urls or public links are inserted into the e-mail.
usepubliclinksCOOSYSTEM@1.1:BOOLEANintrue Generate public links instead of MX urls.
downloadformatCOOSYSTEM@1.1:OBJECTintrue Use this download format in case of public links.
errorlogCOOSYSTEM@1.1:STRINGLISTout Error log containing send errors.
replytoaddressCOOSYSTEM@1.1:STRINGintrue Use this replyto e-mail address.
headertitleCOOSYSTEM@1.1:STRINGintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Secured: SECURED_READWRITE


[top]

FSCFOLIO@1.1001:UnshareRegisteredObject

ParameterTypeIn/OutOptionalDescription
srcroomCOOSYSTEM@1.1:OBJECTin
srcprimaryrelatedCOOSYSTEM@1.1:OBJECTin
regtargetobjCOOSYSTEM@1.1:OBJECTin
regtargetviewCOOSYSTEM@1.1:OBJECTin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOCLOUD@1.1001:UseRestricedAccessFormPostWrapper

ParameterTypeIn/OutOptionalDescription
userestricedformCOOSYSTEM@1.1:BOOLEANretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCFOLIOGUI@1.1001:AddToFavorites

Add current container to favorites

Additional Information

Symbol: COODESK@1.1:SymbolAddToFavorites
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCMINDBREEZE@1.1001:FindObjectByExternalKey

ParameterTypeIn/OutOptionalDescription
extkeyCOOSYSTEM@1.1:STRINGin
attrdefCOOSYSTEM@1.1:OBJECTin
objCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCMINDBREEZE@1.1001:GetMBInSpireService

Determine Mindbreeze Inspire Service
ParameterTypeIn/OutOptionalDescription
svcCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Secured: SECURED_READWRITE


[top]

FSCNOTIFICATION@1.1001:ShouldUpdateCatResubmissions

ParameterTypeIn/OutOptionalDescription
updateCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCORGMGMT@1.1001:GetMasterGroup

Retrieve the owning group of an object
ParameterTypeIn/OutOptionalDescription
groupCOOSYSTEM@1.1:OBJECTretval the owning group
considerversionCOOSYSTEM@1.1:BOOLEANintrue if the current object is in time travel, the group will returned in the same version

Additional Information

Wrapper Actions After Call: FSCORGMGMT@1.1001:GetMasterGroupPostWrapper
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCPORTAL@1.1001:InitializeFromDictionary

Initializes an object with the values provided in a dictionary.

The requestdict dictionary allows you to access the submitted form data.

This method is invoked by action FSCPORTAL@1.1001:CreateObject used for friendly URL "createobject". A default implementation exists for BasicObject, CompoundObject and ContentObject. The default implementation will set the following properties:
  • objname: The name of the object (COOSYSTEM@1.1:objname).
  • objsubject: The subject of the object (COOSYSTEM@1.1:objsubject).
  • objcategory: The category of the object (COOTC@1.1001:objcategory) identified in requestdict by its full reference or object address.
    In addition, the method checks whether there are values in requestdict that match properties defined by the category (COOTC@1.1001:categoryattributes). The properties of the category are identified in requestdict by their short reference, full reference, or object address.
  • Moreover it is possible to set scalar properties that can be changed in the property editor. These properties are identified in requestdict by their full reference or object address. You may use the short reference, too. But if two properties exist with the same short reference it is not determined which property will be set. So it is recommended to use the full reference.
  • content: The content of the object (COOSYSTEM@1.1:content). If objname is not set the name of the object will be extracted from the file name of this field.
    Note: The form data of this entry must not be multiple (see attachmentkeys below).
You may also create (multiple) content objects within a compound object:
  • attachmentattrdef: Defines the object pointer property where to store the content objects (e.g. COOSYSTEM@1.1:objchildren for a COODESK@1.1:Folder).
  • attachmentkeys: A comma separated list of entry names found in requestdict. These entries refer to files submitted in the http request. It may also be possible to define the HTML form field as multiple to submit more than one file in one request. For each submitted file an object is created in the list defined by attachmentattrdef. The object class and the object name for these objects will be retrieved from the name and extension of the file. In addition FSCPORTAL@1.1001:PrepareCreatedObject is invoked on each attached object.
You may override this action for your own class. In that case you have to check the values in requestdict and use them to initialize your objects. Please note that the method will remove the entries mentioned above from the dictionary after setting the appropriate properties.

If files were submitted with the form, the temporary file paths to access the submitted files are stored in respective dictionary entries, and the contents can be retrieved by creating a new content and invoking the CooContent::SetFile() method on it.
ParameterTypeIn/OutOptionalDescription
requestdictCOOSYSTEM@1.1:DICTIONARYin
parentCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCSCHEDULE@1.1001:AttrSuspendedDeadlinesDestructor

Additional Information

Prototype: COOSYSTEM@1.1:AttrDestructorPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCSCHEDULE@1.1001:AttrSuspendedDeadlinesSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCSCHEDULE@1.1001:FilterStandardRetentionDateTimeDefs

ParameterTypeIn/OutOptionalDescription
retentiondefsCOOSYSTEM@1.1:OBJECTLISTretval in/out
contextCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCSCHEDULE@1.1001:FinalizeCommitSchedulePostWrapper

ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTin

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCSCHEDULE@1.1001:GetSuspDeadlinesContainerLocations

Retrieve the object where the container for suspended deadlines should be stored at
Note: The deadline container will be stored in the property FSCSCHEDULE@1.1001:objsuspdeadlinescontainer
ParameterTypeIn/OutOptionalDescription
locationsCOOSYSTEM@1.1:OBJECTLISTretval the target objects

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCSCHEDULE@1.1001:IsDeadlineContextActive

Checks if the background context is active
ParameterTypeIn/OutOptionalDescription
isactiveCOOSYSTEM@1.1:BOOLEANretval the deadline context is active

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCSCHEDULE@1.1001:RefreshAttributeMonitoring

ParameterTypeIn/OutOptionalDescription
deadlinesFSCSCHEDULE@1.1001:TypeLongTermDeadlinesintrue
setrecalcflagCOOSYSTEM@1.1:BOOLEANintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCSCHEDULE@1.1001:ShouldUpdateDeadlines

ParameterTypeIn/OutOptionalDescription
updateCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCTEAMROOM@1.1001:AddToTeamRoomTemplates

Adds selected objects to room templates

Additional Information

Symbol: COODESK@1.1:SymbolAddToFavorites
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEAMROOM@1.1001:ApplyTeamRoom

Pre wrapper of COOSYSTEM@1.1:ObjectFinalizeCommit to perform checks and actions before committing an object
ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTin/out The list of properties changed in the current transaction

Additional Information

Wrapper Actions After Call: FSCTEAMROOM@1.1001:ApplyTeamRoomPostWrapper
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCTEAMROOM@1.1001:CheckDownloadPolicy

Action for checking whether an object can be downloaded and read on workplace.
ParameterTypeIn/OutOptionalDescription
silentCOOSYSTEM@1.1:BOOLEANintrue if true no error will be raised
contextspecificCOOSYSTEM@1.1:BOOLEANintrue if true, the context will be checked (like in FSCDIGITALASSETMGMT@1.1001)
userCOOSYSTEM@1.1:OBJECTintrue the user to check
objecttocheckCOOSYSTEM@1.1:OBJECTintrue object to be checked
isreadableCOOSYSTEM@1.1:BOOLEANretval is true if the object can be downloaded and read at the workplace

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEAMROOM@1.1001:CheckInboxRoomContext

Checks and applies the rules, if the object was shared in an inbox room context
ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTin

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCTEAMROOM@1.1001:DisableUnshareWarningTeamRoom

ParameterTypeIn/OutOptionalDescription
disableCOOSYSTEM@1.1:BOOLEANretval in/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCTEAMROOM@1.1001:IsTeamRoomChild

This action is used to define if a room can be applied to the current object. By default object derived from Basic-, Compound- and ContentObject are valid.
ParameterTypeIn/OutOptionalDescription
isvalidchildCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEAMROOM@1.1001:RemoveFromTeamRoomTemplates

Removes selected templates from room templates

Additional Information

Symbol: COODESK@1.1:SymbolRemoveFromFavorites
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEAMROOM@1.1001:ShowCreatePublicLinkMenu

ParameterTypeIn/OutOptionalDescription
showmenuCOOSYSTEM@1.1:BOOLEANretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEAMROOM@1.1001:ToolsAddToTeamRoomTemplates

Adds selected objects to team room templates (tools menu)

Additional Information

Symbol: COODESK@1.1:SymbolAddToFavorites
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEAMROOM@1.1001:ToolsRemoveFromTeamRoomTemplates

Removes selected templates from room templates (tools menu)

Additional Information

Symbol: COODESK@1.1:SymbolRemoveFromFavorites
Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEMPLATEMGMT@1.1001:AddToTemplateCollection

Menu to add an object to a template collection

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCTEMPLATEMGMT@1.1001:GetPageTemplateVisibilitySettings

ParameterTypeIn/OutOptionalDescription
titleCOOSYSTEM@1.1:STRINGin
contextCOOSYSTEM@1.1:OBJECTin
tpsettingsCOOSYSTEM@1.1:DICTIONARYretval

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

FSCTERM@1.1001:CreateSimpleTermHook

ParameterTypeIn/OutOptionalDescription
venv_parentCOOSYSTEM@1.1:OBJECTin
venv_viewCOOSYSTEM@1.1:OBJECTin
inputvalueCOOSYSTEM@1.1:STRINGin
inputvaluesCOOSYSTEM@1.1:LanguageStringListintrue
termCOOSYSTEM@1.1:OBJECTretval true

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCUSERFORMS@1.1001:ApplicableCategoriesGetPostWrapper

Tells the creation dialog the applicable categories to use.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
modeCOOSYSTEM@1.1:CheckAllowedModein
applicablecategoriesCOOSYSTEM@1.1:OBJECTLISTretval in/out
othertemplatesCOOSYSTEM@1.1:BOOLEANin/out
allowemptyCOOSYSTEM@1.1:BOOLEANintrue
collectionsourcesCOOSYSTEM@1.1:OBJECTLISTin/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCUSERFORMS@1.1001:FilterCategoriesPreWrapper

Adds the released categories in case if the parameter "usefallback" is set.
ParameterTypeIn/OutOptionalDescription
categoriesCOOSYSTEM@1.1:OBJECTLISTretval in/out
attrdefCOOSYSTEM@1.1:OBJECTin/outtrue
skipclassfilterCOOSYSTEM@1.1:BOOLEANin/outtrue
usefallbackCOOSYSTEM@1.1:BOOLEANin/outtrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCUSERFORMS@1.1001:GetNameBuildPreWrapper

Retrieves the name build configuration if defined in the category.
ParameterTypeIn/OutOptionalDescription
objclassCOOSYSTEM@1.1:OBJECTin/out
formatFSCCONFIG@1.1001:NameBuildretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCUSERFORMS@1.1001:ObjectConstructorPostWrapper

Adds the default category.
ParameterTypeIn/OutOptionalDescription
sourceobjCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCUSERFORMS@1.1001:ObjectFinalizeCommitPreWrapper

Ensures numerator is set. Ensures name build if category has changed.
ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTin/out

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

FSCVENV@1.1001:AddRecentlyUsed

Adds the current object to the recently used list."
ParameterTypeIn/OutOptionalDescription
contextCOOSYSTEM@1.1:OBJECTin The context object is used to determine in which list the rectently used object should be stored. Currently FSCVENV@1.1001:StartMailPortal, FSCTEAMROOM@1.1001:Invite and FSCTEAMROOM@1.1001:SendFolioMail are valid context objects."
additionalobjectsCOOSYSTEM@1.1:OBJECTLISTintrue if more than one object should be added to the recenlty used objects

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCVENV@1.1001:CanCutObject

Defines if an object object can be cut from the container
ParameterTypeIn/OutOptionalDescription
containerCOOSYSTEM@1.1:OBJECTin the container the object should be cut from
cancutCOOSYSTEM@1.1:BOOLEANretval if true the object will be cut
viewCOOSYSTEM@1.1:OBJECTin the view the object should be cut from

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCVENV@1.1001:GetActiveMailPortalPart

ParameterTypeIn/OutOptionalDescription
portalpartCOOSYSTEM@1.1:OBJECTout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCVENV@1.1001:GetAdditionalTaskTarget

Get an additional object for which the tasks should be added to the task pane of the current object
ParameterTypeIn/OutOptionalDescription
targetCOOSYSTEM@1.1:OBJECTretval the additional task target
checktaskpaneCOOSYSTEM@1.1:BOOLEANintrue if not set the action is called to replace the displayed object with the additional task target This means the actions of the current object are displayed but the additional task target is used for the bread crumb and the pdf overview
displaymodeFSCVENV@1.1001:AdditionalTaskDisplayModeintrue the display mode of the additional tasks

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Call Directly on Object: true


[top]

FSCVENV@1.1001:InitializeTemplateCreatedObject

Initialize Object created by a template

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCVENVUI@1.1001:GetBGImageSuggestions

Calculates the background image suggestions for the object
ParameterTypeIn/OutOptionalDescription
suggestionsCOOSYSTEM@1.1:OBJECTLISTretval the background image suggestions

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCVPORT@1.1001:CreatePortalEntry

ParameterTypeIn/OutOptionalDescription
portalentryCOOSYSTEM@1.1:OBJECTout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCWATERMARKS@1.1001:AttrWatermarkContentGet

Prevents access to content for read-only users.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
valuein/out
volatileCOOSYSTEM@1.1:BOOLEANin/outtrue
volatiletxCOOSYSTEM@1.1:BOOLEANin/outtrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCWATERMARKS@1.1001:AttrWatermarkContentGetVersion

Prevents access to content for read-only users for a version.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTin
versnrCOOSYSTEM@1.1:INTEGERin
valuein/out
volatileCOOSYSTEM@1.1:BOOLEANin/outtrue
volatiletxCOOSYSTEM@1.1:BOOLEANin/outtrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]