Actions of COOSYSTEM@1.1:CompoundObject

Return Type	Signature
void	AddObjectToPortal( optional integer unused1, optional integer unused2)
void	AddObjectToPortal()
void	AddRecentlyUsed( object context, optional object[] additionalobjects)
void	AddRemark( optional any remark, optional string event, optional datetime _date, optional object[] references, optional boolean suppresshistory)
void	AddToFavorites( optional integer unused1, optional integer unused2)
void	AddToTeamRoomTemplates( optional integer unused1, optional integer unused2)
void	AddToTemplateCollection( optional integer unused1, optional integer unused2)
void	AdjustSecurityContext( object[] attrlist)
boolean	AllowInitializeDefaultRoomSecurityFrom( object securitysource, AttributeDefinition attrdef, out retval boolean allow)
void	ArchiveObjectComplete( optional integer unused1, optional integer unused2, ref boolean checked, out boolean cancelled, integer count)
void	ArchiveObjectContents( optional integer unused1, optional integer unused2, ref boolean checked, out boolean cancelled, integer count)
void	ArchiveObjectContentVersions( optional integer unused1, optional integer unused2, ref boolean checked, out boolean cancelled, integer count)
void	ArchiveObjectVersion( optional integer unused1, optional integer unused2)
void	ArchiveObjectVersionCopy( optional integer unused1, optional integer unused2)
void	AttrAnnoAllowedLayerTypesGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrAnnoAllowReadMemberPublicAnnotationsGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrAnnoPreferredLayerTypeGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
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	AttrChildrenDestructor( AttributeDefinition attrdef, any value)
string	AttrEMailAddressesGetDisp( AttributeDefinition attrdef, out retval string string, optional any value, optional Language language, optional AttributeDefinition[] attrdeflist, optional integer flags, optional integer index)
any	AttrEmailLineCtor( AttributeDefinition attrdef, out retval any value, any oldvalues)
void	AttrObjIsReleasedTemplatePublishedGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
any	AttrObjIsTemplateCtor( AttributeDefinition attrdef, out retval any value)
void	AttrObjIsTemplateSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrObjPublicAccessChildrenGet( AttributeDefinition attrdef, ref any value, out optional boolean volatile, out optional boolean volatiletx)
void	AttrObjPublicAccessChildrenGetVersion( AttributeDefinition attrdef, integer versnr, ref any value, out optional boolean volatile, out optional boolean volatiletx)
object[]	AttrObjUseablePrimaryRelatedFilter( ref retval object[] values, optional AttributeDefinition attrdef)
void	AttrPersSalutationSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrReferenceSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrTemplatesSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrUnshareNotAllowedSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
void	AttrWatermarkContentGet( AttributeDefinition attrdef, ref any[] value, ref optional boolean volatile, ref optional boolean volatiletx)
void	AttrWatermarkContentGetVersion( AttributeDefinition attrdef, integer versnr, ref any[] value, ref optional boolean volatile, ref optional boolean volatiletx)
AttributeDefinition[]	CalcImportTargetAttrDefs( optional FormPageAttributes[] formpageattributes, optional ObjectClass[] contentclasses, out retval AttributeDefinition[] validattrdefs)
boolean	CanAddRemark( AttributeDefinition attrdef, out retval boolean canaddremark)
boolean	CanChangeProcessState( ProcessInstance procinst, ref retval boolean statechangeable)
boolean	CanCutObject( object container, out retval boolean cancut, AttributeDefinition view)
boolean	CanOpenInSplitView( out retval boolean opensplit, out optional object alternativeobject, out optional object alternativeopenaction, out optional object alternaltiveoverviewtarget, optional boolean checkcategory, optional boolean issplitopenapp, optional boolean preferalternativeopenprops)
boolean	CanPrepareSignatureFolder( out retval boolean canprepare)
boolean	CanRegister( out retval boolean canregister, boolean checkworkflow)
void	ChangeGroup( Group newgroup, optional object[] children)
object[]	CheckAdditionalParticipantRestrictions( ref retval object[] participants)
boolean	CheckAdditionalTemplateRestrictions( object container, out retval boolean allowed)
boolean	CheckDownloadPolicy( optional boolean silent, optional boolean contextspecific, optional User user, optional object objecttocheck, out retval boolean isreadable)
boolean	CheckParticipantAffiliation( WorkFlowParticipant participant, object actinst, out retval boolean usableparticipant, optional boolean skipdisplaywithaccessparts, optional AccessType[] requiredaccesstypes)
void	CheckParticipantRules( WorkFlowParticipant part, optional object processelement, optional ActivityType acttype)
AttributeDefinition[]	CopyAdditionalPropsOnReleaseTemplate( out retval AttributeDefinition[] copyattrs)
void	CreatePortalEntry( out object portalentry)
Term	CreateSimpleTermHook( object venv_parent, object venv_view, string inputvalue, optional LanguageStringList[] inputvalues, out optional retval Term term)
WorkFlowParticipant	DelegateActivityHook( ref retval WorkFlowParticipant participant, ref optional WorkFlowParticipant partmansubst, ActivityInstance activity, ProcessInstance process)
PrescriptionMetaDataWho[]	DelegateActivityMultipleHook( ref retval PrescriptionMetaDataWho[] participants, ActivityInstance activity, ProcessInstance process)
void	DeleteDuplicate()
boolean	DisplayActionsInWorkflowTaskPane( out retval boolean displayactions)
void	DoCancelFileObject( object parent, object view, optional boolean issublevel)
void	DoCloseFileObject()
void	DocumentsApplyDigitalSignature( optional integer unused1, optional integer unused2)
void	DocumentsApplyDigitalSignatureClose( optional integer unused1, optional integer unused2)
void	DoRestoreFileObject( optional boolean issublevel)
boolean	EnableRegistrationUC( AttributeDefinition exprattrdef, optional IncomingComponentCategory checkcat, out retval boolean enable)
void	EvaluateGenericNameBuild( optional boolean force)
string	EvaluatePersSalutation( out retval string salutation, optional object commlanguage, optional boolean evalonly)
object[]	FilterAllowedDefaultValueCategories( ref retval object[] categories)
object[]	FilterNonCommonCategories( AttributeDefinition attrdef, CheckAllowedMode mode, ref retval object[] categories)
object[]	FilterSearchForms( ref retval object[] searchforms, optional AttributeDefinition attrdef, optional boolean usefallback)
object	FindObjectByExternalKey( string extkey, AttributeDefinition attrdef, out retval object obj)
void	GetActiveMailPortalPart( out object portalpart)
object	GetAdditionalTaskTarget( out retval object target, optional boolean checktaskpane, optional AdditionalTaskDisplayMode displaymode)
object	GetAlternativeWatchedNotificationObj( out retval object alternativeobj, optional object sourceobject, optional boolean includeroomalternative)
string[]	GetAvailableSignatureTexts( out retval string[] texts)
object[]	GetBGImageSuggestions( out retval object[] suggestions)
ObjectClass	GetDataImportDataSourceClass( out retval ObjectClass targetclass)
DisplayViewList[]	GetDefaultDispView( AttributeDefinition attrdef, optional boolean usepreferredonly, out boolean useproductsettings, out retval DisplayViewList[] dispview)
object[]	GetExpressionInfoContextObjects( AttributeExpressionDef attrdef, out retval object[] contextobjects, out optional IdentifierContext[] identifiercontext)
object	GetHolidayTableObject( out retval object holidaytable)
IncomingComponentCategory	GetIncomingCategory( optional integer dynkey, optional boolean checkroom, out retval IncomingComponentCategory incat)
WorkFlowParticipant	GetInitialResponsible( out retval WorkFlowParticipant responsible, out optional WorkFlowParticipant respmansubst, optional ProcessInstance procinst, optional object processsource)
void	GetLoadOptionsMenu( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
MailSplitConfig[]	GetMailSplitConfiguration( out retval MailSplitConfig[] configs)
Group[]	GetManageableWorkFlowPreferenceGroupLocations( out retval Group[] groups)
Group	GetMasterGroup( out retval Group group, optional boolean considerversion)
MBInSpireService	GetMBInSpireService( out retval MBInSpireService svc, optional object context)
void	GetMenuEditCut( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
void	GetMenuExportAuditLog( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
void	GetMenuFinalFormSetClose( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
void	GetMenuResetOptions( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
object	GetObjectFile( optional boolean includeself, out retval object objfile)
dictionary	GetPageTemplateVisibilitySettings( string title, object context, out retval dictionary tpsettings)
AttributeObjectDef	GetParticipantContextAttribute( out retval AttributeObjectDef attrdef)
ObjectClass[]	GetParticipantContextClass( out retval ObjectClass[] classes)
AttributeObjectDef	GetParticipantParentAttribute( out retval AttributeObjectDef attrdef)
object[]	GetPossibleHolidayTables( out retval object[] holidaytables)
MBInSpireService[]	GetPossibleMBInSpireServices( out retval MBInSpireService[] inspiresvcs)
string	GetPrescriptionHeadLine( out retval string headline, out string label, out string prescrlabel, optional boolean processmultiplecommon)
AttributeDefinition[]	GetPublicAccessChildrenAttrDefs( out retval AttributeDefinition[] attrdefs)
void	GetQuickLoadOptionsMenu( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
ObjectEditForm	GetRegistrationForm( optional IncomingComponentCategory incat, ref retval ObjectEditForm regform)
object	GetReleasedTemplate( optional boolean checkreleased, out retval object releasedtemplate)
ObjectEditForm	GetReplaceForm( ref retval ObjectEditForm replaceform)
object	GetRestoreACL( ref retval object restoreacl, ref object restoreaclref)
string	GetSendBackgroundFrom( out retval string from, boolean usedefaultsender, optional Language userlang)
object[]	GetSuspDeadlinesContainerLocations( out retval object[] locations)
object	GetTheme( out retval object theme)
void	GetTreeOpenMenu( optional integer unused1, optional integer unused2, ref MenuStructList[] menuentries, optional object menu, optional object[] selobjects, out optional boolean addchildren)
void	GetUsableOrgElements( object context, out WorkFlowMetaParticipant[] metaparticipants, out object[] users, out object[] positions, out object[] groups, out object[] orgunittypes, out optional object[] partdefs, out optional object[] partners, out optional object[] attributes, optional boolean isfilter, out optional AttributeDefinition[] restrictedpartelements)
void	GetVirusInfoText( optional object context, optional string virusdetail, optional boolean isoverview, out string text1, out string text2, out string text3, out string text4)
boolean	HasAdditionalParticipantRestrictions( out retval boolean additionalrestrictions)
boolean	HasVirus( optional content content, out string detail, out retval boolean hasvirus)
void	InitializeFromDictionary( dictionary requestdict, optional object parent)
void	InitializeTemplateCreatedObject( ref object venv_object, optional object venv_parent, optional integer venv_index, optional object venv_view, optional object venv_action)
void	InitializeWithCategoryHook( object category)
void	InstanceElementStateChangedHook( InstanceElement instelem, ProcessInstance process, ActivityInstanceState newstate, ActivityInstanceState oldstate)
boolean	IsAllowedForWebDAVOnWorkplace( out retval boolean isallowed)
boolean	IsCategoryMandatory( out retval boolean ismandatory)
boolean	IsDateValid( AttributeDefinition attrdef, datetime value, dictionary scope, out retval boolean isvalid)
boolean	IsDeadlineContextActive( out retval boolean isactive)
boolean	IsDigitalSignatureAllowed( optional boolean close, optional boolean skipusercheck, out boolean missingaccessrights, out retval boolean allowed)
boolean	IsDraftTemplateTestable( out retval boolean istestable)
boolean	IsEditableWFAttribute( AttributeDefinition attrdef, optional Action[] actioncontext, ref retval boolean iseditable)
boolean	IsEncrypted( out retval boolean encrypted)
boolean	IsHistoryAvailable( out retval boolean isavailable, optional boolean includesecured, out optional string customerrortext, out optional boolean displayrestricted)
boolean	IsObjectFileUCEnabled( optional boolean includeself, out object objfile, out retval boolean enabled)
boolean	IsObjNameChangeableUI( dictionary scope, out retval boolean ischangeable)
boolean	IsPublicAccessEnabled( out retval boolean enabled)
boolean	IsPublicAccessEnabledPostWrapper( ref retval boolean enabled)
boolean	IsReadableOnWorkplace( optional boolean silent, out retval boolean isreadable, optional boolean contextspecific, optional User user)
boolean	IsSynchronizableOnWorkplace( out retval boolean issynchronizable)
boolean	IsTemplateReleaseable( out retval boolean isreleaseable, out boolean requirereleasedversion)
boolean	IsTimeTravelAllowed( out retval boolean allowed)
boolean	KeepSecurityAttributes( out retval boolean keep)
void	LoadObjectFromArchive( optional integer unused1, optional integer unused2)
string	LocalObjectsGetQueryConstraints( object attrdef, object[] allowedclasseslist, object[] notallowedclasseslist, out retval string constraints)
void	LockWorkFlowObjects()
void	LogWorkFlowHistory( Action context, object workfowobject, optional any[] value, optional any[] oldvalue)
void	ObjectArchive( ref object archst, boolean complete, optional boolean converttofinalform, optional string finalformat, optional boolean archiveversions, optional datetime retentiondate)
void	ObjectArchiveVersion( ref object archst, optional boolean remains, optional datetime retentiondate)
void	ObjectLoadFromArchive()
void	ObjectLoadVersionFromArchive( datetime versdate, out object object)
void	ObjectReleaseVersion( datetime versdate)
void	ObjectRestoreFromArchive()
void	OpenObject( optional integer unused1, optional integer unused2)
void	ProcessStateChangedHook( ProcessInstance process, ProcessInstanceState newstate, ProcessInstanceState oldstate)
void	QueueConsistencyCheck()
void	Rate( optional integer unused1, optional integer unused2)
void	RefreshAttributeMonitoring( optional TypeLongTermDeadlines[] deadlines, optional boolean setrecalcflag)
void	RegisterLecture( optional integer unused1, optional integer unused2)
void	RegisterObject( IncomingComponentCategory regcat, object regobj, CompoundObject regtargetobj, AttributeObjectDef regtargetview)
void	ReleaseObjectVersion( optional integer unused1, optional integer unused2, optional datetime changedat)
void	RemoveFromTeamRoomTemplates( optional integer unused1, optional integer unused2)
void	RestoreObjectFromArchive( optional integer unused1, optional integer unused2)
void	SendAsPdf( optional integer unused1, optional integer unused2)
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)
boolean	ShouldUpdateCatResubmissions( out retval boolean update)
boolean	ShouldUpdateDeadlines( out retval boolean update)
boolean	ShowCreatePublicLinkMenu( out retval boolean showmenu)
void	StartMailPortal()
void	StoreCreatedDiagrams( optional DiagramObject[] createddiagrams, optional DiagramObject[] updateddiagrams, optional object venv_view)
void	ToolsAddToTeamRoomTemplates( optional integer unused1, optional integer unused2)
void	ToolsRemoveFromTeamRoomTemplates( optional integer unused1, optional integer unused2)
void	UnloadObjectFromArchive( optional integer unused1, optional integer unused2)
void	UnregisterLecture( optional integer unused1, optional integer unused2)
void	UnshareRegisteredObject( object srcroom, CompoundObject srcprimaryrelated, CompoundObject regtargetobj, AttributeObjectDef regtargetview)
boolean	UseRestrictedAccessForm( out retval boolean userestricedform)
boolean	UseVAppsOnMobileClients( out retval boolean usevappsonmobile)

FSCVENVUI@1.1001:AddObjectToPortal

add object to the favorites portal

void FSCVENVUI@1.1001:AddObjectToPortal(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCVENVUI@1.1001

FSCVPORT@1.1001:AddObjectToPortal

void FSCVPORT@1.1001:AddObjectToPortal()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVPORT@1.1001

FSCVENV@1.1001:AddRecentlyUsed

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

ACL Object: DefaultDeveloperACL
Software Component: FSCVENV@1.1001

FSCFOLIO@1.1001:AddRemark

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

ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

FSCFOLIOGUI@1.1001:AddToFavorites

Add current container to favorites

void FSCFOLIOGUI@1.1001:AddToFavorites(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCFOLIOGUI@1.1001

FSCTEAMROOM@1.1001:AddToTeamRoomTemplates

Adds selected objects to room templates

void FSCTEAMROOM@1.1001:AddToTeamRoomTemplates(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

FSCTEMPLATEMGMT@1.1001:AddToTemplateCollection

Menu to add an object to a template collection

void FSCTEMPLATEMGMT@1.1001:AddToTemplateCollection(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCTEMPLATEMGMT@1.1001

FSCFOLIO@1.1001:AdjustSecurityContext

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

Name	Description
attrlist

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

FSCTEAMROOM@1.1001:AllowInitializeDefaultRoomSecurityFrom

This action is used to define from which source the security settings should be initialized to the new room.

boolean FSCTEAMROOM@1.1001:AllowInitializeDefaultRoomSecurityFrom(
  object securitysource,
  AttributeDefinition attrdef,
  out retval boolean allow)

Name	Description
securitysource	the source object from which the security attributes will be read
attrdef	the attribute definition which should be inherited
allow	the result

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

COODESK@1.1:ArchiveObjectComplete

Moves the object to the archive.

void COODESK@1.1:ArchiveObjectComplete(
  optional integer unused1,
  optional integer unused2,
  ref boolean checked,
  out boolean cancelled,
  integer count)

Name	Description
unused1
unused2
checked	If this parameter is `false`, the user is asked whether or not to archive the object.
cancelled	`true`, if the user canceled the archiving process.
count	The number of objects to be archived.

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COODESK@1.1:ArchiveObjectContents

Moves the contents of the object to the archive.

void COODESK@1.1:ArchiveObjectContents(
  optional integer unused1,
  optional integer unused2,
  ref boolean checked,
  out boolean cancelled,
  integer count)

Name	Description
unused1
unused2
checked	If this parameter is `false`, the user is asked whether or not to archive the contents of the object.
cancelled	`true`, if the user canceled the archiving process.
count	The number of contents to be archived.

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COODESK@1.1:ArchiveObjectContentVersions

Archive contents and versions of object

void COODESK@1.1:ArchiveObjectContentVersions(
  optional integer unused1,
  optional integer unused2,
  ref boolean checked,
  out boolean cancelled,
  integer count)

Name	Description
unused1
unused2
checked
cancelled
count

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COODESK@1.1:ArchiveObjectVersion

Moves a version of the object to the archive.

void COODESK@1.1:ArchiveObjectVersion(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COODESK@1.1:ArchiveObjectVersionCopy

Usecase to archive a version copy

void COODESK@1.1:ArchiveObjectVersionCopy(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCPDFANNOTATIONS@1.1001:AttrAnnoAllowedLayerTypesGet

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

Name	Description
attrdef
value
volatile
volatiletx

Additional Information

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCPDFANNOTATIONS@1.1001

FSCPDFANNOTATIONS@1.1001:AttrAnnoAllowReadMemberPublicAnnotationsGet

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

Name	Description
attrdef
value
volatile
volatiletx

Additional Information

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCPDFANNOTATIONS@1.1001

FSCPDFANNOTATIONS@1.1001:AttrAnnoPreferredLayerTypeGet

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

Name	Description
attrdef
value
volatile
volatiletx

Additional Information

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCPDFANNOTATIONS@1.1001

FSCFOLIO@1.1001:AttrBORemarksGetDisp

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

Prototype: AttrGetDispPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:AttrBOViewRemarksCacheGet

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:AttrBOViewRemarksGet

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

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

COOSYSTEM@1.1:AttrChildrenDestructor

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

void COOSYSTEM@1.1:AttrChildrenDestructor(
AttributeDefinition attrdef,
any value)

Name	Description
attrdef
value

Additional Information

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

COOMAPI@1.1:AttrEMailAddressesGetDisp

string COOMAPI@1.1:AttrEMailAddressesGetDisp(
  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

Prototype: AttrGetDispPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOMAPI@1.1

COOMAPI@1.1:AttrEmailLineCtor

any COOMAPI@1.1:AttrEmailLineCtor(
  AttributeDefinition attrdef,
  out retval any value,
  any oldvalues)

Name	Description
attrdef
value
oldvalues

Additional Information

Prototype: AttrLineConstructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOMAPI@1.1

COOTC@1.1001:AttrObjIsReleasedTemplatePublishedGet

Get action if the released version of a template is published for use

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

Name	Description
attrdef
value
volatile
volatiletx

Additional Information

Prototype: AttrGetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COOTC@1.1001:AttrObjIsTemplateCtor

Initialize property "Is Template"

any COOTC@1.1001:AttrObjIsTemplateCtor(
AttributeDefinition attrdef,
out retval any value)

Name	Description
attrdef
value

Additional Information

Prototype: AttrConstructorPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COOTC@1.1001:AttrObjIsTemplateSet

void COOTC@1.1001:AttrObjIsTemplateSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name	Description
attrdef
value
oldvalue

Additional Information

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COOSYSTEM@1.1:AttrObjPublicAccessChildrenGet

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

Name	Description
attrdef
value
volatile
volatiletx

Additional Information

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

COOSYSTEM@1.1:AttrObjPublicAccessChildrenGetVersion

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

Name	Description
attrdef
versnr
value
volatile
volatiletx

Additional Information

Prototype: AttrGetVersionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

COOSYSTEM@1.1:AttrObjUseablePrimaryRelatedFilter

Filter the allowed values of attribute objuseableprimaryrelated

object[] COOSYSTEM@1.1:AttrObjUseablePrimaryRelatedFilter(
ref retval object[] values,
optional AttributeDefinition attrdef)

Name	Description
values	values
attrdef	attribute definition

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

FSCFOLIO@1.1001:AttrPersSalutationSet

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

Name	Description
attrdef
value
oldvalue

Additional Information

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:AttrReferenceSet

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

Name	Description
attrdef
value
oldvalue

Additional Information

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

COOTC@1.1001:AttrTemplatesSet

void COOTC@1.1001:AttrTemplatesSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name	Description
attrdef
value
oldvalue

Additional Information

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COODESK@1.1:AttrUnshareNotAllowedSet

Set action to raise an error if a user unshares an object from a list

void COODESK@1.1:AttrUnshareNotAllowedSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name	Description
attrdef
value
oldvalue

Additional Information

Prototype: AttrSetPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCWATERMARKS@1.1001:AttrWatermarkContentGet

Prevents access to content for read-only users.

void FSCWATERMARKS@1.1001:AttrWatermarkContentGet(
  AttributeDefinition attrdef,
  ref any[] value,
  ref optional boolean volatile,
  ref optional boolean volatiletx)

Name	Description
attrdef
value
volatile
volatiletx

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCWATERMARKS@1.1001

FSCWATERMARKS@1.1001:AttrWatermarkContentGetVersion

Prevents access to content for read-only users for a version.

void FSCWATERMARKS@1.1001:AttrWatermarkContentGetVersion(
  AttributeDefinition attrdef,
  integer versnr,
  ref any[] value,
  ref optional boolean volatile,
  ref optional boolean volatiletx)

Name	Description
attrdef
versnr
value
volatile
volatiletx

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCWATERMARKS@1.1001

FSCFOLIOGUI@1.1001:CalcImportTargetAttrDefs

AttributeDefinition[] FSCFOLIOGUI@1.1001:CalcImportTargetAttrDefs(
  optional FormPageAttributes[] formpageattributes,
  optional ObjectClass[] contentclasses,
  out retval AttributeDefinition[] validattrdefs)

Name	Description
formpageattributes
contentclasses
validattrdefs

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIOGUI@1.1001

FSCFOLIO@1.1001:CanAddRemark

Check if the user has the sufficient permissions to add a remark

boolean FSCFOLIO@1.1001:CanAddRemark(
AttributeDefinition attrdef,
out retval boolean canaddremark)

Name	Description
attrdef
canaddremark

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

COOWF@1.1:CanChangeProcessState

Perform additional checks on the process object if the process state can be changed

boolean COOWF@1.1:CanChangeProcessState(
ProcessInstance procinst,
ref retval boolean statechangeable)

Name	Description
procinst	the process instance
statechangeable	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCVENV@1.1001:CanCutObject

Defines if an object object can be cut from the container

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

Name	Description
container	the container the object should be cut from
cancut	if true the object will be cut
view	the view the object should be cut from

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVENV@1.1001

FSCFOLIO@1.1001:CanOpenInSplitView

This action is used to decide if an object can be opened in the split view

boolean FSCFOLIO@1.1001:CanOpenInSplitView(
  out retval boolean opensplit,
  out optional object alternativeobject,
  out optional object alternativeopenaction,
  out optional object alternaltiveoverviewtarget,
  optional boolean checkcategory,
  optional boolean issplitopenapp,
  optional boolean preferalternativeopenprops)

Name	Description
opensplit	the result
alternativeobject	if supplied an alternativeopenaction has to be supplied too
alternativeopenaction	the alternativeobject is opened with alternativeopenaction instead of the current object
alternaltiveoverviewtarget	if supplied to right pane for the pdf overview will be used from this object and the metadata view on the left pane will be used from the cooobj
checkcategory	if set to true the split application will be opened if the category of the object has category attributes
issplitopenapp
preferalternativeopenprops	if set to true the properties of the object will be preferred than opening the object as alternative action

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:CanPrepareSignatureFolder

Check if a signature folder can be created for the current object

boolean FSCFOLIO@1.1001:CanPrepareSignatureFolder(
out retval boolean canprepare)

Name	Description
canprepare

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:CanRegister

boolean FSCFOLIO@1.1001:CanRegister(
out retval boolean canregister,
boolean checkworkflow)

Name	Description
canregister
checkworkflow

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCTEAMROOM@1.1001:ChangeGroup

Changes the (assigned) group of a room

void FSCTEAMROOM@1.1001:ChangeGroup(
Group newgroup,
optional object[] children)

Name	Description
newgroup	the new group, that will be the owning group of the room
children	the depending objects of the room (cache variable)

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

COOWF@1.1:CheckAdditionalParticipantRestrictions

If the process has additional participant restrictions the participants will be filtered by this action

object[] COOWF@1.1:CheckAdditionalParticipantRestrictions(
ref retval object[] participants)

Name	Description
participants

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOTC@1.1001:CheckAdditionalTemplateRestrictions

Check if the template is allowed in the container due to additional restrictions e.g the file obje the object

boolean COOTC@1.1001:CheckAdditionalTemplateRestrictions(
object container,
out retval boolean allowed)

Name	Description
container	the container
allowed	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

FSCTEAMROOM@1.1001:CheckDownloadPolicy

Action for checking whether an object can be downloaded and read on workplace.

boolean FSCTEAMROOM@1.1001:CheckDownloadPolicy(
  optional boolean silent,
  optional boolean contextspecific,
  optional User user,
  optional object objecttocheck,
  out retval boolean isreadable)

Name	Description
silent	if true no error will be raised
contextspecific	if true, the context will be checked (like in FSCDIGITALASSETMGMT@1.1001)
user	the user to check
objecttocheck	object to be checked
isreadable	is true if the object can be downloaded and read at the workplace

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

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.

boolean COOWF@1.1:CheckParticipantAffiliation(
  WorkFlowParticipant participant,
  object actinst,
  out retval boolean usableparticipant,
  optional boolean skipdisplaywithaccessparts,
  optional AccessType[] requiredaccesstypes)

Name	Description
participant	The participant which should be checked.
actinst	The current activity of the current process.
usableparticipant	The participant can be used and the action does not need to throw an error message
skipdisplaywithaccessparts	the current activity should be displayed only for participants with access permissions
requiredaccesstypes	the access types which should be checked to execute the activity

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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:

COOWF@1.1:CheckActivityDefinition
COOWF@1.1:CheckActivityInstance
CheckBPMNProcessParticipants
CheckDelegateForm
CheckParticipant
CheckPrescriptionsForm
COOWF@1.1:CheckProcessDefinition
COOWF@1.1:CheckProcessInstance
CheckSimplePrescriptionsForm
SetStartable

void COOWF@1.1:CheckParticipantRules(
  WorkFlowParticipant part,
  optional object processelement,
  optional ActivityType acttype)

Name	Description
part	the participant which should be checked
processelement	the process element for which the participant check is performed. (e.g.: ActivityInstance, ProcessInstance, ActivityDefinition, ProcessDefinition, WorkFlowDiagram)
acttype	the type of the activity

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOTC@1.1001:CopyAdditionalPropsOnReleaseTemplate

Action to define which attributes are copied additional to the released template

AttributeDefinition[] COOTC@1.1001:CopyAdditionalPropsOnReleaseTemplate(
out retval AttributeDefinition[] copyattrs)

Name	Description
copyattrs	the attributes

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

FSCVPORT@1.1001:CreatePortalEntry

void FSCVPORT@1.1001:CreatePortalEntry(
out object portalentry)

Name	Description
portalentry

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVPORT@1.1001

FSCTERM@1.1001:CreateSimpleTermHook

Term FSCTERM@1.1001:CreateSimpleTermHook(
  object venv_parent,
  object venv_view,
  string inputvalue,
  optional LanguageStringList[] inputvalues,
  out optional retval Term term)

Name	Description
venv_parent
venv_view
inputvalue
inputvalues
term

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCTERM@1.1001

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

WorkFlowParticipant COOWF@1.1:DelegateActivityHook(
  ref retval WorkFlowParticipant participant,
  ref optional WorkFlowParticipant partmansubst,
  ActivityInstance activity,
  ProcessInstance process)

Name	Description
participant	the participant
partmansubst	the substitute of a manual participant
activity	the activity which should be delegated
process	the process instance the activity is assigned to.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:DelegateActivityMultipleHook

Hook action called on the object of the process during COOWF@1.1:SetDelegateMultiple before the participant of the activity is changed

PrescriptionMetaDataWho[] COOWF@1.1:DelegateActivityMultipleHook(
  ref retval PrescriptionMetaDataWho[] participants,
  ActivityInstance activity,
  ProcessInstance process)

Name	Description
participants	the participants who should get the activity of the current user additionally
activity	the activity which should be delegated to multiple participants
process	the process instance the activity is assigned to.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCFOLIO@1.1001:DeleteDuplicate

void FSCFOLIO@1.1001:DeleteDuplicate()

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

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

boolean COOWF@1.1:DisplayActionsInWorkflowTaskPane(
out retval boolean displayactions)

Name	Description
displayactions	the context menu actions should be diplayed

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCFOLIO@1.1001:DoCancelFileObject

Action used to cancel a file object or a file itself

void FSCFOLIO@1.1001:DoCancelFileObject(
  object parent,
  object view,
  optional boolean issublevel)

Name	Description
parent	parent object
view	current view
issublevel	is canceling document on sub level

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:DoCloseFileObject

Action used to close a file object

void FSCFOLIO@1.1001:DoCloseFileObject()

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCCRYPT@1.1001:DocumentsApplyDigitalSignature

Application to sign an object with signature SIGN_DIGITAL_SIGNATURE

void FSCCRYPT@1.1001:DocumentsApplyDigitalSignature(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Obsolete
Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCCRYPT@1.1001

FSCCRYPT@1.1001:DocumentsApplyDigitalSignatureClose

Application to sign an object with signature SIGN_DIGITAL_SIGNATURE and close the object

void FSCCRYPT@1.1001:DocumentsApplyDigitalSignatureClose(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Obsolete
Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCCRYPT@1.1001

FSCFOLIO@1.1001:DoRestoreFileObject

Restore a file object

void FSCFOLIO@1.1001:DoRestoreFileObject(
optional boolean issublevel)

Name	Description
issublevel	restore object on sub level

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:EnableRegistrationUC

Action to check if the registration usecase is enabled

boolean FSCFOLIO@1.1001:EnableRegistrationUC(
  AttributeDefinition exprattrdef,
  optional IncomingComponentCategory checkcat,
  out retval boolean enable)

Name	Description
exprattrdef	the attribute definition containing the expression: icshowreregistermenu, icshowworkflowstep or icshowreregistermenu
checkcat	the supplied incomign category
enable	the result

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCCONFIG@1.1001:EvaluateGenericNameBuild

Calculates and sets the new name of the object

void FSCCONFIG@1.1001:EvaluateGenericNameBuild(
optional boolean force)

Name	Description
force	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: DefaultDeveloperACL
Software Component: FSCCONFIG@1.1001

FSCFOLIO@1.1001:EvaluatePersSalutation

This action calculates the salutation of a contact or user and stores the result in the property perssalutation. The format of the salutation can be configured in the property salutation formatting which is located in the Folio configuration.

string FSCFOLIO@1.1001:EvaluatePersSalutation(
  out retval string salutation,
  optional object commlanguage,
  optional boolean evalonly)

Name	Description
salutation
commlanguage
evalonly

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

FSCTEAMROOM@1.1001:FilterAllowedDefaultValueCategories

Action to filter/define the allowed categories for cccategory

object[] FSCTEAMROOM@1.1001:FilterAllowedDefaultValueCategories(
ref retval object[] categories)

Name	Description
categories	the filtered categories

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

COOTC@1.1001:FilterNonCommonCategories

Filter categories which are not commonly usable

object[] COOTC@1.1001:FilterNonCommonCategories(
  AttributeDefinition attrdef,
  CheckAllowedMode mode,
  ref retval object[] categories)

Name	Description
attrdef	the target attribute definition
mode	the mode
categories	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COOQBOL@1.1:FilterSearchForms

Filter possible search forms

object[] COOQBOL@1.1:FilterSearchForms(
  ref retval object[] searchforms,
  optional AttributeDefinition attrdef,
  optional boolean usefallback)

Name	Description
searchforms	list of search forms
attrdef	attribute definition
usefallback	use fallback

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOQBOL@1.1

FSCMINDBREEZE@1.1001:FindObjectByExternalKey

object FSCMINDBREEZE@1.1001:FindObjectByExternalKey(
  string extkey,
  AttributeDefinition attrdef,
  out retval object obj)

Name	Description
extkey
attrdef
obj

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCMINDBREEZE@1.1001

FSCVENV@1.1001:GetActiveMailPortalPart

void FSCVENV@1.1001:GetActiveMailPortalPart(
out object portalpart)

Name	Description
portalpart

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVENV@1.1001

FSCVENV@1.1001:GetAdditionalTaskTarget

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

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

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

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVENV@1.1001

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

object FSCFOLIO@1.1001:GetAlternativeWatchedNotificationObj(
  out retval object alternativeobj,
  optional object sourceobject,
  optional boolean includeroomalternative)

Name	Description
alternativeobj
sourceobject	the object from which the notification settings are requested
includeroomalternative	if set the room of the current object is included

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

COOSIGNATURE@1.1:GetAvailableSignatureTexts

Retrieve the available signature texts for an object

string[] COOSIGNATURE@1.1:GetAvailableSignatureTexts(
out retval string[] texts)

Name	Description
texts	array of texts to be offered to the user when selecting signature text to place in the PDF

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSIGNATURE@1.1

FSCVENVUI@1.1001:GetBGImageSuggestions

Calculates the background image suggestions for the object

object[] FSCVENVUI@1.1001:GetBGImageSuggestions(
out retval object[] suggestions)

Name	Description
suggestions	the background image suggestions

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVENVUI@1.1001

FSCORGMGMT@1.1001:GetDataImportDataSourceClass

Retrieve the object class for the datasource

ObjectClass FSCORGMGMT@1.1001:GetDataImportDataSourceClass(
out retval ObjectClass targetclass)

Name	Description
targetclass

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCORGMGMT@1.1001

COODESK@1.1:GetDefaultDispView

Calculate the default display views for an object

DisplayViewList[] COODESK@1.1:GetDefaultDispView(
  AttributeDefinition attrdef,
  optional boolean usepreferredonly,
  out boolean useproductsettings,
  out retval DisplayViewList[] dispview)

Name	Description
attrdef	the attribute definition
usepreferredonly	use only preferred display view source
useproductsettings
dispview	the calculated DisplayViewList

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COOSYSTEM@1.1:GetExpressionInfoContextObjects

Retrieves the expression info context objects for an object that has an expression attribute.
The context can be a software component (SoftwareComponent), an object class (ObjectClass) an attribute definition (AttributeDefinition) or any object that implements ResolveExpressionInfoContextObject (e.g. ComponentTemplateCategory or TemplateCategory).
If a component object is provided as a context object, its software component is automatically added to the context objects. The first software component will be treated as the own software component, the remaining as imported software components. All software components will be used for short references.

For example, a WorkFlowDiagram might add the objects listed in wfdallowedcategories.

Used in FSCCODEEDITOR@1.1001 to retrieve the expression info context to support a full-featured expression editor.
If no context is provided, the standard expression editor is used.
Object classes and properties provided as context objects are used as possible classes and additional properties of cooobj in the expression. In the optional identifiercontext parameter context objects for other parameters of the expression (eg. ::object) may be provided. Additionally the types of these parameters may be specified

object[] COOSYSTEM@1.1:GetExpressionInfoContextObjects(
  AttributeExpressionDef attrdef,
  out retval object[] contextobjects,
  out optional IdentifierContext[] identifiercontext)

Name	Description
attrdef	the expression attribute to be used
contextobjects	list of context objects
identifiercontext	optional list of context objects for identifiers in the expression

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

COOSYSTEM@1.1:GetHolidayTableObject

Determine the holiday table object for the context of cooobj.

object COOSYSTEM@1.1:GetHolidayTableObject(
out retval object holidaytable)

Name	Description
holidaytable	the holiday table object

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

FSCFOLIO@1.1001:GetIncomingCategory

IncomingComponentCategory FSCFOLIO@1.1001:GetIncomingCategory(
  optional integer dynkey,
  optional boolean checkroom,
  out retval IncomingComponentCategory incat)

Name	Description
dynkey
checkroom
incat

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

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 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.

WorkFlowParticipant COOWF@1.1:GetInitialResponsible(
  out retval WorkFlowParticipant responsible,
  out optional WorkFlowParticipant respmansubst,
  optional ProcessInstance procinst,
  optional object processsource)

Name	Description
responsible	the calculated responsible of the process.
respmansubst	the calculated responsible of the process for manual activities.
procinst	the newly create process instance
processsource	the model from which the process flow is taken. (e.g.: a WorkFlowDiagram or ProcessDefinition)

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COODESK@1.1:GetLoadOptionsMenu

void COODESK@1.1:GetLoadOptionsMenu(
  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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COOMAPI@1.1:GetMailSplitConfiguration

MailSplitConfig[] COOMAPI@1.1:GetMailSplitConfiguration(
out retval MailSplitConfig[] configs)

Name	Description
configs

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOMAPI@1.1

COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations

Retrieve the groups for which workflow diagrams can be released

Group[] COOWF@1.1:GetManageableWorkFlowPreferenceGroupLocations(
out retval Group[] groups)

Name	Description
groups	the target groups

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCORGMGMT@1.1001:GetMasterGroup

Retrieve the owning group of an object

Group FSCORGMGMT@1.1001:GetMasterGroup(
out retval Group group,
optional boolean considerversion)

Name	Description
group	the owning group
considerversion	if the current object is in time travel, the group will returned in the same version

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCORGMGMT@1.1001

FSCMINDBREEZE@1.1001:GetMBInSpireService

Determine Mindbreeze Inspire Service

MBInSpireService FSCMINDBREEZE@1.1001:GetMBInSpireService(
out retval MBInSpireService svc,
optional object context)

Name	Description
svc	InSpire service
context	Context for service selection

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCMINDBREEZE@1.1001

COODESK@1.1:GetMenuEditCut

void COODESK@1.1:GetMenuEditCut(
  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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCVENVUI@1.1001:GetMenuExportAuditLog

void FSCVENVUI@1.1001:GetMenuExportAuditLog(
  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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCVENVUI@1.1001

COODESK@1.1:GetMenuFinalFormSetClose

void COODESK@1.1:GetMenuFinalFormSetClose(
  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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COODESK@1.1:GetMenuResetOptions

Menu get action for MenuResetOptions

void COODESK@1.1:GetMenuResetOptions(
  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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCFOLIO@1.1001:GetObjectFile

Action to retrieve the file of an object

object FSCFOLIO@1.1001:GetObjectFile(
optional boolean includeself,
out retval object objfile)

Name	Description
includeself	if the current object is a file it will return itself.
objfile	the file of an object

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCTEMPLATEMGMT@1.1001:GetPageTemplateVisibilitySettings

Calculate the visibility of the generic template page

dictionary FSCTEMPLATEMGMT@1.1001:GetPageTemplateVisibilitySettings(
  string title,
  object context,
  out retval dictionary tpsettings)

Name	Description
title
context
tpsettings

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEMPLATEMGMT@1.1001

COOWF@1.1:GetParticipantContextAttribute

This action is called to retrieve the attribute definition to locate the context object for participant

AttributeObjectDef COOWF@1.1:GetParticipantContextAttribute(
out retval AttributeObjectDef attrdef)

Name	Description
attrdef	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantContextClass

This action is called to retrieve the object classes to which the context participant can be restricted

ObjectClass[] COOWF@1.1:GetParticipantContextClass(
out retval ObjectClass[] classes)

Name	Description
classes	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:GetParticipantParentAttribute

This action is called to retrieve the attribute definition to locate the parent object for participant

AttributeObjectDef COOWF@1.1:GetParticipantParentAttribute(
out retval AttributeObjectDef attrdef)

Name	Description
attrdef	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOSYSTEM@1.1:GetPossibleHolidayTables

Get a list of possible holiday tables (used e.g. in filters)

object[] COOSYSTEM@1.1:GetPossibleHolidayTables(
out retval object[] holidaytables)

Name	Description
holidaytables	holiday tables

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

FSCMINDBREEZE@1.1001:GetPossibleMBInSpireServices

Calculate a list of possible inspire services

MBInSpireService[] FSCMINDBREEZE@1.1001:GetPossibleMBInSpireServices(
out retval MBInSpireService[] inspiresvcs)

Name	Description
inspiresvcs	list of services

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCMINDBREEZE@1.1001

COOWF@1.1:GetPrescriptionHeadLine

Get title for prescription editor

string COOWF@1.1:GetPrescriptionHeadLine(
  out retval string headline,
  out string label,
  out string prescrlabel,
  optional boolean processmultiplecommon)

Name	Description
headline	the headline
label
prescrlabel
processmultiplecommon

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCTEAMROOM@1.1001:GetPublicAccessChildrenAttrDefs

Calculate the attribute definitions used for calculating the public access children

AttributeDefinition[] FSCTEAMROOM@1.1001:GetPublicAccessChildrenAttrDefs(
out retval AttributeDefinition[] attrdefs)

Name	Description
attrdefs	attribute definitions

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

COODESK@1.1:GetQuickLoadOptionsMenu

void COODESK@1.1:GetQuickLoadOptionsMenu(
  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

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCFOLIO@1.1001:GetRegistrationForm

ObjectEditForm FSCFOLIO@1.1001:GetRegistrationForm(
optional IncomingComponentCategory incat,
ref retval ObjectEditForm regform)

Name	Description
incat
regform

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

COOTC@1.1001:GetReleasedTemplate

Gets the released version of a template. The action can be called both on the draft version and on the released version of a template.

object COOTC@1.1001:GetReleasedTemplate(
optional boolean checkreleased,
out retval object releasedtemplate)

Name	Description
checkreleased	Checks the validity of the released template. The object is valid if it is usable and if it is the released template of a design template, or if it is the design template itself in case it is an object that does not need to be released.
releasedtemplate	the released template

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

FSCFOLIO@1.1001:GetReplaceForm

ObjectEditForm FSCFOLIO@1.1001:GetReplaceForm(
ref retval ObjectEditForm replaceform)

Name	Description
replaceform

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

COOWASTEBASKET@1.1:GetRestoreACL

On restore of an object the acl returned by this action is applied to the object

object COOWASTEBASKET@1.1:GetRestoreACL(
ref retval object restoreacl,
ref object restoreaclref)

Name	Description
restoreacl	the access control list which should be applied to the object
restoreaclref	the security context is evaluated on the referenced object

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWASTEBASKET@1.1

FSCFOLIO@1.1001:GetSendBackgroundFrom

Calculate the "From" e-mail address to be used within SendBackground.

string FSCFOLIO@1.1001:GetSendBackgroundFrom(
  out retval string from,
  boolean usedefaultsender,
  optional Language userlang)

Name	Description
from	The e-mail address.
usedefaultsender	Use the configured default sender, or calculate the sender e-mail address in the context of the current user.
userlang	The language to be used to calculate the display name of the sender.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

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 objsuspdeadlinescontainer

object[] FSCSCHEDULE@1.1001:GetSuspDeadlinesContainerLocations(
out retval object[] locations)

Name	Description
locations	the target objects

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCSCHEDULE@1.1001

FSCVAPP@1.1001:GetTheme

Calculates the theme of an object.

object FSCVAPP@1.1001:GetTheme(
out retval object theme)

Name	Description
theme

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVAPP@1.1001

FSCVENV@1.1001:GetTreeOpenMenu

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

Name	Description
unused1
unused2
menuentries
menu
selobjects
addchildren

Additional Information

Prototype: MenuGetActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: FSCVENV@1.1001

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.

void COOWF@1.1:GetUsableOrgElements(
  object context,
  out WorkFlowMetaParticipant[] metaparticipants,
  out object[] users,
  out object[] positions,
  out object[] groups,
  out object[] orgunittypes,
  out optional object[] partdefs,
  out optional object[] partners,
  out optional object[] attributes,
  optional boolean isfilter,
  out optional AttributeDefinition[] restrictedpartelements)

Name	Description
context	This parameter is intended to know the context, where this action is used, but is currently not set by the caller.
metaparticipants	Returns the list of allowed values for the property `wfpmetaparticipant`, if not set, all available values are allowed.
users	Returns the list of allowed users for the property `wfpuser`, if not set, any user is allowed.
positions	Returns the list of allowed positions for the property `wfpposition`, if not set, any position is allowed.
groups	Returns the list of allowed groups for the property `wfpgroup`, if not set, any group is allowed.
orgunittypes	Returns the list of allowed organizational unit types for the property `wfporgunittype`, if not set, any organizational unit type is allowed.
partdefs	Returns the list of allowed participant definitions for the property `wfspartdefinition`, if not set, any organizational unit type is allowed.
partners	Returns the list of allowed partners for the property `wfppartner`, if not set, any organizational unit type is allowed.
attributes	Returns the list of allowed attributes for the property `wfpattribute`, if not set, any attributes is allowed.
isfilter	defines if the action is called by FilterUsableObjects and the elements are filtered against the result of this action in the participant control are returned.
restrictedpartelements	Returns the list of attributes of the workflow participant which should be restricted to the supplied values. If an attribute is marked as restricted and no value is defined the attribute will not be displayed in the participant control. Possible values are: wfpmetaparticipant to disable the meta participant in the participant control wfpuser to disable the user in the participant control wfpgroup to disable the group in the participant control wfpposition to disable the position in the participant control wfporgunittype to disable the orgunittype in the participant control wfpattribute to disable the properties in the participant control wfppartner to disable the partners in the participant controls wfspartdefinition to disable distribution lists

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCORGMGMT@1.1001:GetVirusInfoText

This action is called on the room of the object to generate the text for the virus overview

void FSCORGMGMT@1.1001:GetVirusInfoText(
  optional object context,
  optional string virusdetail,
  optional boolean isoverview,
  out string text1,
  out string text2,
  out string text3,
  out string text4)

Name	Description
context	the object containing the virus
virusdetail	the detail information about the virus
isoverview	true if the text is calculated for the PDF overview
text1	The first paragraph
text2	the second paragraph
text3	the third paragraph
text4	the fourth paragraph

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCORGMGMT@1.1001

COOWF@1.1:HasAdditionalParticipantRestrictions

Check if the process has additional restrictions to the participants

boolean COOWF@1.1:HasAdditionalParticipantRestrictions(
out retval boolean additionalrestrictions)

Name	Description
additionalrestrictions	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOSYSTEM@1.1:HasVirus

Check if the content of an object has a virus using objscaninfo

boolean COOSYSTEM@1.1:HasVirus(
  optional content content,
  out string detail,
  out retval boolean hasvirus)

Name	Description
content	the content to check, if empty content will be used
detail	the detail information about the virus
hasvirus

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

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 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 (objname).
objsubject: The subject of the object (objsubject).
objcategory: The category of the object (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 (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 (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. objchildren for a 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 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.

void FSCPORTAL@1.1001:InitializeFromDictionary(
dictionary requestdict,
optional object parent)

Name	Description
requestdict
parent

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCPORTAL@1.1001

FSCVENV@1.1001:InitializeTemplateCreatedObject

Initialize Object created by a template

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

Name	Description
venv_object
venv_parent
venv_index
venv_view
venv_action

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVENV@1.1001

COOTC@1.1001:InitializeWithCategoryHook

Hook action called in the uichange expression of objcategory

void COOTC@1.1001:InitializeWithCategoryHook(
object category)

Name	Description
category	the selected value

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COOWF@1.1:InstanceElementStateChangedHook

Hook action called on the object of the process when the state of the activity instance or wait action instance is changed.

void COOWF@1.1:InstanceElementStateChangedHook(
  InstanceElement instelem,
  ProcessInstance process,
  ActivityInstanceState newstate,
  ActivityInstanceState oldstate)

Name	Description
instelem
process	the process instance
newstate	the state of the instance element
oldstate	the old state of the instance element

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COODESK@1.1:IsAllowedForWebDAVOnWorkplace

Action for checking whether an object is allowed to be used in external WebDAV clients.

boolean COODESK@1.1:IsAllowedForWebDAVOnWorkplace(
out retval boolean isallowed)

Name	Description
isallowed	is true if the object can be used in external WebDAV clients.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COOTC@1.1001:IsCategoryMandatory

Check if the category must be defined for an object

boolean COOTC@1.1001:IsCategoryMandatory(
out retval boolean ismandatory)

Name	Description
ismandatory	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COOSYSTEM@1.1:IsDateValid

Check if the date is valid

boolean COOSYSTEM@1.1:IsDateValid(
  AttributeDefinition attrdef,
  datetime value,
  dictionary scope,
  out retval boolean isvalid)

Name	Description
attrdef	the attribute definition
value	the value to check
scope	VAPP scope dictionary
isvalid	is valid

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

FSCSCHEDULE@1.1001:IsDeadlineContextActive

Checks if the background context is active

boolean FSCSCHEDULE@1.1001:IsDeadlineContextActive(
out retval boolean isactive)

Name	Description
isactive	the deadline context is active

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCSCHEDULE@1.1001

FSCCRYPT@1.1001:IsDigitalSignatureAllowed

boolean FSCCRYPT@1.1001:IsDigitalSignatureAllowed(
  optional boolean close,
  optional boolean skipusercheck,
  out boolean missingaccessrights,
  out retval boolean allowed)

Name	Description
close
skipusercheck
missingaccessrights
allowed

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCCRYPT@1.1001

COOTC@1.1001:IsDraftTemplateTestable

Checks if the draft template can be instantiated. Which is currently only relevant for user forms until the test room feature is available

boolean COOTC@1.1001:IsDraftTemplateTestable(
out retval boolean istestable)

Name	Description
istestable	the result

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COOWF@1.1:IsEditableWFAttribute

boolean COOWF@1.1:IsEditableWFAttribute(
  AttributeDefinition attrdef,
  optional Action[] actioncontext,
  ref retval boolean iseditable)

Name	Description
attrdef
actioncontext
iseditable

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCCRYPT@1.1001:IsEncrypted

boolean FSCCRYPT@1.1001:IsEncrypted(
out retval boolean encrypted)

Name	Description
encrypted

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCCRYPT@1.1001

FSCFOLIO@1.1001:IsHistoryAvailable

This action is used to define if the history is available for the current object

boolean FSCFOLIO@1.1001:IsHistoryAvailable(
  out retval boolean isavailable,
  optional boolean includesecured,
  out optional string customerrortext,
  out optional boolean displayrestricted)

Name	Description
isavailable	the result not if the history is only available in restriced mode the value will be false
includesecured	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
customerrortext	a custom error text
displayrestricted	the parameter is set to true if the history is only available in restricted mode

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCFOLIO@1.1001

FSCFOLIO@1.1001:IsObjectFileUCEnabled

Calculates if the file usecases are enabled for object of a file. By default IsObjectFile is evaluated

boolean FSCFOLIO@1.1001:IsObjectFileUCEnabled(
  optional boolean includeself,
  out object objfile,
  out retval boolean enabled)

Name	Description
includeself	if the current object is a file it will check for itself.
objfile	the file of the object
enabled	true if the file usecases are enabled

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

COOSYSTEM@1.1:IsObjNameChangeableUI

Control the changeability of objname

boolean COOSYSTEM@1.1:IsObjNameChangeableUI(
dictionary scope,
out retval boolean ischangeable)

Name	Description
scope	VAPP scope dictionary
ischangeable	is the name changeable

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

COOSYSTEM@1.1:IsPublicAccessEnabled

Check if public access is enabled for the current object. This action is executed as anonymous user using the current version of the object.

boolean COOSYSTEM@1.1:IsPublicAccessEnabled(
out retval boolean enabled)

Name	Description
enabled	`true` if public access is enabled.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

FSCTEAMROOM@1.1001:IsPublicAccessEnabledPostWrapper

Checks if public access is allowed for the room of an object.

boolean FSCTEAMROOM@1.1001:IsPublicAccessEnabledPostWrapper(
ref retval boolean enabled)

Name	Description
enabled

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCTEAMROOM@1.1001

COODESK@1.1:IsReadableOnWorkplace

Action for checking whether an object can be downloaded and read on workplace.

boolean COODESK@1.1:IsReadableOnWorkplace(
  optional boolean silent,
  out retval boolean isreadable,
  optional boolean contextspecific,
  optional User user)

Name	Description
silent	if true no error will be raised
isreadable	is true if the object can be downloaded and read at the workplace
contextspecific	if true, the context will be checked (like in FSCDIGITALASSETMGMT@1.1001)
user	the user to check

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COODESK@1.1:IsSynchronizableOnWorkplace

Action for checking whether an object can be synchronized on workplace.

boolean COODESK@1.1:IsSynchronizableOnWorkplace(
out retval boolean issynchronizable)

Name	Description
issynchronizable	is true if the object can be synchronized on workplace

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COOTC@1.1001:IsTemplateReleaseable

Checks if a template is releaseable, and if a released template is required in a particular context. In the room environment, it is usually the case that a template, which can in principle be released, only needs to be released in certain cases. Templates in an app configuration or a template collection must always be released, while a template of the same object class in an app room does not require release.

boolean COOTC@1.1001:IsTemplateReleaseable(
out retval boolean isreleaseable,
out boolean requirereleasedversion)

Name	Description
isreleaseable	the result
requirereleasedversion	this parameter defines if released version of the template is required.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOTC@1.1001

COODESK@1.1:IsTimeTravelAllowed

Checks whether "Time Travel" is allowed for the current user.
By default the user must have read access for property objversions for objects of class ContentObject, BasicObject and CompoundObject.
For all other objects (especially administration objects) the user must have AccTypeChange.

boolean COODESK@1.1:IsTimeTravelAllowed(
out retval boolean allowed)

Name	Description
allowed	Returns true, if time travel is possible

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCTEAMROOM@1.1001:KeepSecurityAttributes

Defines if the security attributes (like objsecread) should be kept when applying the teamroom

boolean FSCTEAMROOM@1.1001:KeepSecurityAttributes(
out retval boolean keep)

Name	Description
keep	if true, the attributes will be kept

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

COODESK@1.1:LoadObjectFromArchive

Loads the object from the archive.

void COODESK@1.1:LoadObjectFromArchive(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COOSYSTEM@1.1:LocalObjectsGetQueryConstraints

Hook called by "LocalObjectsGet" to refine the local objects query by adding additional query constraints.

string COOSYSTEM@1.1:LocalObjectsGetQueryConstraints(
  object attrdef,
  object[] allowedclasseslist,
  object[] notallowedclasseslist,
  out retval string constraints)

Name	Description
attrdef	Attribute definition.
allowedclasseslist	List of allowed object classes for attribute.
notallowedclasseslist	List of not allowed object classes for attribute.
constraints	Query constraints.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

COOWF@1.1:LockWorkFlowObjects

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

void COOWF@1.1:LockWorkFlowObjects()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

COOWF@1.1:LogWorkFlowHistory

Hook action when a history modification should be logged

void COOWF@1.1:LogWorkFlowHistory(
  Action context,
  object workfowobject,
  optional any[] value,
  optional any[] oldvalue)

Name	Description
context	the action context from which the history logging is called
workfowobject	this object is the activity instance or process instance which is concerned.
value	if the logging is called from a set action this parameter contains the value parameter the caller
oldvalue	if the logging is called from a set action this parameter contains the oldvalue parameter the caller

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

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 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 attractarch are called with the value of the flag complete as parameter.

void COOSYSTEM@1.1:ObjectArchive(
  ref object archst,
  boolean complete,
  optional boolean converttofinalform,
  optional string finalformat,
  optional boolean archiveversions,
  optional datetime retentiondate)

Name	Description
archst	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.
complete	`true` means that the complete object is archived.
converttofinalform
finalformat
archiveversions
retentiondate

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

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 database and MMC data area. The actions for archiving properties assigned to the object properties in property attractarch are called on the version of the object with the parameter complete set to true.

void COOSYSTEM@1.1:ObjectArchiveVersion(
  ref object archst,
  optional boolean remains,
  optional datetime retentiondate)

Name	Description
archst	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.
remains
retentiondate

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

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 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 attractrestarch are called with parameter persistent set to false.

void COOSYSTEM@1.1:ObjectLoadFromArchive()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

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 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.

void COOSYSTEM@1.1:ObjectLoadVersionFromArchive(
datetime versdate,
out object object)

Name	Description
versdate	The date of the version of the object, for which the properties should be loaded.
object	The loaded version object.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

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.

void COOSYSTEM@1.1:ObjectReleaseVersion(
datetime versdate)

Name	Description
versdate	The date and time of the version of the object.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

COOSYSTEM@1.1:ObjectRestoreFromArchive

Loads the properties of the object from the archive and stores them in the 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 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 attractrestarch are called with parameter persistent set to true.

void COOSYSTEM@1.1:ObjectRestoreFromArchive()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOSYSTEM@1.1

COODESK@1.1:OpenObject

Opens the object.

void COODESK@1.1:OpenObject(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COOWF@1.1:ProcessStateChangedHook

Hook action called on the object of the process when the state of the process is changed

void COOWF@1.1:ProcessStateChangedHook(
  ProcessInstance process,
  ProcessInstanceState newstate,
  ProcessInstanceState oldstate)

Name	Description
process	the process instance
newstate	the state of the process instance
oldstate	the old state of the process instance

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOWF@1.1

FSCFOLIO@1.1001:QueueConsistencyCheck

Queues the consistency for the file of an object

void FSCFOLIO@1.1001:QueueConsistencyCheck()

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCCONFERENCE@1.1001:Rate

This method allows to rate a conference or a lecture

void FSCCONFERENCE@1.1001:Rate(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCCONFERENCE@1.1001

FSCSCHEDULE@1.1001:RefreshAttributeMonitoring

void FSCSCHEDULE@1.1001:RefreshAttributeMonitoring(
optional TypeLongTermDeadlines[] deadlines,
optional boolean setrecalcflag)

Name	Description
deadlines
setrecalcflag

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCSCHEDULE@1.1001

FSCCONFERENCE@1.1001:RegisterLecture

This method allows a user to register for a lecture in a conference

void FSCCONFERENCE@1.1001:RegisterLecture(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCCONFERENCE@1.1001

FSCFOLIO@1.1001:RegisterObject

void FSCFOLIO@1.1001:RegisterObject(
  IncomingComponentCategory regcat,
  object regobj,
  CompoundObject regtargetobj,
  AttributeObjectDef regtargetview)

Name	Description
regcat
regobj
regtargetobj
regtargetview

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

COODESK@1.1:ReleaseObjectVersion

Releases a version of the object.

void COODESK@1.1:ReleaseObjectVersion(
  optional integer unused1,
  optional integer unused2,
  optional datetime changedat)

Name	Description
unused1
unused2
changedat	The date of the last change of the version.

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCTEAMROOM@1.1001:RemoveFromTeamRoomTemplates

Removes selected templates from room templates

void FSCTEAMROOM@1.1001:RemoveFromTeamRoomTemplates(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

COODESK@1.1:RestoreObjectFromArchive

Restores the object from the archive.

void COODESK@1.1:RestoreObjectFromArchive(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

COOMAPI@1.1:SendAsPdf

Send a copy (in Portable Document Format) of each currently selected object.

void COOMAPI@1.1:SendAsPdf(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COOMAPI@1.1

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.

void FSCFOLIO@1.1001: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)

Name	Description
to	List of objects (users, contacts) or a list of strings to which an e-mail should be sent.
cc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in CC
bcc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in BCC.
subject	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.
body	The text for the e-mail. Can contain: STRING, STRINGLIST.
attachments	A list of attachment objects for which MX urls or public links are inserted into the e-mail.
usepubliclinks	Generate public links instead of MX urls.
downloadformat	Use this download format in case of public links.
errorlog	Error log containing send errors.
replytoaddress	Use this replyto e-mail address.
headertitle
fallbacklanguage	The fallback language is used when the email recipients are specified only by an email address, or when no communication language can be determined for an email recipient object.

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

FSCNOTIFICATION@1.1001:ShouldUpdateCatResubmissions

boolean FSCNOTIFICATION@1.1001:ShouldUpdateCatResubmissions(
out retval boolean update)

Name	Description
update

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCNOTIFICATION@1.1001

FSCSCHEDULE@1.1001:ShouldUpdateDeadlines

boolean FSCSCHEDULE@1.1001:ShouldUpdateDeadlines(
out retval boolean update)

Name	Description
update

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCSCHEDULE@1.1001

FSCTEAMROOM@1.1001:ShowCreatePublicLinkMenu

boolean FSCTEAMROOM@1.1001:ShowCreatePublicLinkMenu(
out retval boolean showmenu)

Name	Description
showmenu

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

FSCVENV@1.1001:StartMailPortal

Hook to handle the start of the mail portal

void FSCVENV@1.1001:StartMailPortal()

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVENV@1.1001

FSCDIAGRAM@1.1001:StoreCreatedDiagrams

Stores the diagrams in the same view as the current object

void FSCDIAGRAM@1.1001:StoreCreatedDiagrams(
  optional DiagramObject[] createddiagrams,
  optional DiagramObject[] updateddiagrams,
  optional object venv_view)

Name	Description
createddiagrams	the createddiagrams
updateddiagrams	the diagrams which were updated in the current transaction
venv_view	the view in which the diagram will be shared

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCDIAGRAM@1.1001

FSCTEAMROOM@1.1001:ToolsAddToTeamRoomTemplates

Adds selected objects to team room templates (tools menu)

void FSCTEAMROOM@1.1001:ToolsAddToTeamRoomTemplates(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

FSCTEAMROOM@1.1001:ToolsRemoveFromTeamRoomTemplates

Removes selected templates from room templates (tools menu)

void FSCTEAMROOM@1.1001:ToolsRemoveFromTeamRoomTemplates(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCTEAMROOM@1.1001

COODESK@1.1:UnloadObjectFromArchive

Unloads the object from the online system to the archive.

void COODESK@1.1:UnloadObjectFromArchive(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: DefaultDeveloperACL
Software Component: COODESK@1.1

FSCCONFERENCE@1.1001:UnregisterLecture

This method allows a user to register for a lecture in a conference

void FSCCONFERENCE@1.1001:UnregisterLecture(
optional integer unused1,
optional integer unused2)

Name	Description
unused1
unused2

Additional Information

Prototype: MenuActionPrototype
ACL Object: WorkFlowActionACL
Software Component: FSCCONFERENCE@1.1001

FSCFOLIO@1.1001:UnshareRegisteredObject

void FSCFOLIO@1.1001:UnshareRegisteredObject(
  object srcroom,
  CompoundObject srcprimaryrelated,
  CompoundObject regtargetobj,
  AttributeObjectDef regtargetview)

Name	Description
srcroom
srcprimaryrelated
regtargetobj
regtargetview

Additional Information

ACL Object: WorkFlowActionACL
Software Component: FSCFOLIO@1.1001

COOATTREDIT@1.1:UseRestrictedAccessForm

Action to check if a restricted form should be displayed instead of the normal form

boolean COOATTREDIT@1.1:UseRestrictedAccessForm(
out retval boolean userestricedform)

Name	Description
userestricedform

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: COOATTREDIT@1.1

FSCVAPP@1.1001:UseVAppsOnMobileClients

This method is used as interface. Will be overridden by FSCMOBILEAPPS@1.1001 with actual implementation. Actual implementation will evaluate a customization point from FSCMOBILEAPPS@1.1001 to determine if Virtual Applications should be executed on mobile clients (e.g.: Android or iOS Apps)

boolean FSCVAPP@1.1001:UseVAppsOnMobileClients(
out retval boolean usevappsonmobile)

Name	Description
usevappsonmobile	when true, the mobile client should run vApps.

Additional Information

ACL Object: DefaultDeveloperACL
Software Component: FSCVAPP@1.1001