Class COOSYSTEM@1.1:Object

This abstract class is the base class for all objects. All other classes are derived from Object. It defines the general properties and methods that each object has.

Class Hierarchy

Object

Direct Subclasses

AdministrationObject, AuditLog, BackgroundActivities, BackLink, BaseNumeratorObject, BasicObject, Bin, CachedContents, CachedLicense, ComponentObject, CompoundObject, ContentObject, HashTable, HistoryArchive, HistoryArchiveInformation, HistoryCache, InstanceElement, Language, Paper, Printer, ProcessInstance, ProductLicense, ProgressObject, QuerySettingsContainer, Relation, ReplaceInputDialog, SoftwareComponent, SoftwareProduct, SWCLicense, UserEvents, UserTimers

Properties

Type	Property	Name
float	averagescore	Average Score
date	boclosedat	Closed on/at
Object	bostate	Processing State
User	bostatechangedby	Last State Change by
Object[]	canceleddocuments	Canceled Objects
Object[]	categories	Template Categories
boolean	issignable	PDF Content is signable
string[]	lastsignature	Last Signature
SignatureType	lastsigned	Last Signature Type
date	lastsignedat	Last Signature on/at
User	lastsignedby	Last Signature by
string	lastsignedremark	Remark of Last Signature
Object	lastsignedsignaturefolder	Signature Folder of Last Signature
AccessControlList	objaclobj	ACL Object
Object	objaclref	Referenced Object
date	objactreleasedat	Current Release Version Date
date	objactverschanged	Last Version Change on/at
date	objactverscreated	Version Started on/at
integer	objactversnr	Version Number
string(64)	objaddress	Address
AppConfigurationRoom	objappconfigurationroom	App Configuration
AppRoomInbox	objapproominbox	Inbox
ObjectAspect	objaspect	Object Aspect
string[]	objavailablefieldsbyfiles	Available Fields (File)
string[]	objavailablefieldsbyobjcategory	Available Fields (Category)
string[]	objavailablefieldsbyobject	Available Fields (Current Document)
string[]	objavailablefieldsbyprimaryrelated	Available Fields (Contained in)
boolean	objcanceled	Canceled
date	objcanceledat	Canceled on/at
User	objcanceledby	Canceled by
Object[]	objcanceledfiles	Canceled Files
CompoundObject	objcancelsource	Container
Object	objcategory	Category
date	objchangedat	System Change Timestamp
User	objchangedby	Last Change by
ObjectClass	objclass	Object Class
date	objclosedat	Closed on/at Local Time
User	objclosedby	Closed by
date	objcreatedat	Created on/at
User	objcreatedby	Created by
Room	objcustomizingcontext	Customizing Context
boolean	objdeleted	Deleted
DisplayEffect	objdisplayeffect	Highlighting Color
DocState	objdocstate	Document State
Domain	objdomain	Domain
string	objexternalkey	External ID
Object	objfile	File
CompoundObject	objfilecancelsource	Container
boolean	objfinalform	Final Form
FontEffect	objfonteffect	Font Effect
date	objindexedat	Object Last Indexed (UTC)
boolean	objisprecaptured	Pre-Captured
boolean	objistemplate	Is Template
Language	objlanguage	Template Language
SignatureFolder	objlastsignaturefolder	Last Signature Folder
SignatureFolderState	objlastsignaturefolderstate	State of Last Signature Folder
Object[]	objlocation	Location
Object[]	objlocationlist	Shared Usage
Object[]	objlocationroot	Own Location
ObjectLockInfo	objlock	Lock
boolean	objlockedpermanent	Locked Permanently
MBCategorizationData	objmbcategorization	Mindbreeze Categorization
string[]	objmbjsonannotations	PDF Annotations (InstantJSON)
string	objmbviewcategorization	Mindbreeze Categorization (JSON)
Symbol	objmicon	Symbol
date	objmodifiedat	Last Change on/at
string	objname	Name
User	objowner	Owner
Group	objowngroup	Group
Object	objprimaryrelated	Origin
date	objrealactverscreated	Version Really Created on/at
User	objrealchangedby	Really Changed by
date	objrealcreatedat	Really Created on/at
User	objrealcreatedby	Really Created by
boolean	objrecorded	Recorded
date	objrecordedat	Recorded Set on/at
Object	objregistrationtarget	Target
Object[]	objrelated	Contained in
date	objreleasedat	Release Version Date
Object	objreplacement	Replaced by
Notification[]	objresubmissions	Follow-Ups
date	objretentiondate	Retention Period
ContentObject[]	objscanqueue	Scan Queue
date	objsecchangedat	Security Change Timestamp
SecurityLevel	objseclevel	Security Level
SignatureFolder[]	objsignaturefolders	Signature Folders
Object	objsource	Source Object
string	objsubject	Subject
Tag[]	objtags	Tags
Room	objteamroom	Teamroom
Object	objtemplate	Template
boolean	objtemplaterevisionrequired	Template Revision Required
date	objtemplaterevisionrequiredat	Template Revision Required Since
User	objtemplaterevisionrequiredby	Template Revision Required Requested By
Term[]	objterms	Terms
Object[]	objuseablefiles	Files
Object[]	objuseableprimaryrelated	Contained in
ObjectClass[]	objuseableself	Current Document
date	objuserchangedat	System Change Timestamp of Last User Change
date	objvalidfrom	Valid From
date	objvalidto	Valid Until
ObjectVersionList[]	objversions	Object Versions
integer	objversmaxage	Days After Which Older Versions Are Automatically Deleted
integer	objversmaxnr	Maximum Number of Versions Kept
boolean	objversnopurge	No Automatic Deleting of Versions
Content	pdfcontent	PDF Content (Screen Quality)
Content	pdfcontentcached	PDF Content (Cache)
Content	pdfcontentocr	PDF Content (OCR)
Content	pdfcontentprint	PDF Content (Print Quality)
PDFMetadata	pdfmetadata	PDF Metadata
Content	pdfphonecontent	PDF Content (Optimized for Smartphones)
RatingsType[]	ratings	Ratings
SignatureAuthorization[]	signatureauthorizations	Digital Signatures
SignatureList[]	signatures	Signatures
SignatureManualList[]	signaturesmanual	Manual Signatures
TemplateVisibilityType	templatevisibility	Additional Restrictions
integer	totalratings	Number of Ratings
float	userscore	Score
integer	viewcount	View Count
Group[]	workflowgroups	Groups Participating in Workflow
Group[]	workflowgroupsdone	Groups Having Participated in Workflow
Group[]	workflowgroupsdoneextaccess	Groups Having Participated in Workflow (Extended Access)
Group[]	workflowgroupsextaccess	Groups Participating in Workflow (Extended Access)
User[]	workflowroleusers	Users Participating by Role in Workflow
User[]	workflowroleusersdone	Users Having Participated in Workflow by Role
User[]	workflowroleusersdoneextaccess	Users Having Participated in Workflow by Role (Extended Access)
User[]	workflowroleusersextaccess	Users Participating by Role in Workflow (Extended Access)
User[]	workflowusers	Users Participating in Workflow
User[]	workflowusersdone	Users Having Participated in Workflow
User[]	workflowusersdoneextaccess	Users Having Participated in Workflow (Extended Access)
User[]	workflowusersextaccess	Users Participating in Workflow (Extended Access)
User[]	workflowuserssubstitutes	Substitutes of Users Participating in Workflow
User[]	workflowuserssubstitutesdone	Substitutes of Users Having Participated in Workflow
User[]	workflowuserssubstitutesdoneextaccess	Substitutes of Users Having Participated in Workflow (Extended Access)
User[]	workflowuserssubstitutesextaccess	Substitutes of Users Participating in Workflow (Extended Access)

Actions

Return Type	Signature
boolean	AllowChangeProcessState( out retval boolean statechangeable)
boolean	AllowNavigateDraftRelease( out retval boolean allownavigate, optional object template)
void	AppendDoc( ref optional content doc1, optional content doc2, optional string doc2id, optional PageNumberingDefinition pagenumbering, out optional integer mergestartpage, out optional integer mergedpages)
void	AppendDocArray( out content pdf, content[] pdflist, string[] filenames, optional BookmarkType bookmarktype, optional boolean insertevenpage)
void	AppendDocArrayLegacy( out content pdf, content[] pdflist, string[] filenames, optional BookmarkType bookmarktype, optional boolean insertevenpage)
void	AttrProcessParticipantSet( AttributeDefinition attrdef, ref optional any value, any oldvalue)
content	Base64Decode( content incont, out retval content outcont)
string	Base64Encode( content incont, out retval string base64string, optional boolean usemaxlinelength)
boolean	CanBeUsedForSubProcessesOnly( out retval boolean subprocessesonly)
boolean	CanChangeProcessState( ProcessInstance procinst, ref retval boolean statechangeable)
boolean	CanReleaseTemplate( out retval boolean canrelease)
boolean	CanReplaceDocument( out retval boolean canreplace)
boolean	CheckLicense( optional string instance, optional boolean disableerrorapps, optional object context, optional boolean silentmode, out retval boolean haslicense)
boolean	CheckLicenseCached( optional string instance, optional boolean disableerrorapps, optional object context, optional boolean silentmode, out retval boolean haslicense)
void	CloseObject( optional boolean createfinalformcontent, optional boolean setstateclosed)
void	CollectMailData( ref dictionary gatheredinfos)
Content	ConvertContentToFinalForm( optional object context, optional string format, out retval Content contentfinalform)
integer	ConvertDateToWorkDays( datetime startdate, datetime enddate, out retval integer workdays)
datetime	ConvertTimeSpanWorkDaysToDate( datetime startdate, integer timespanworkdays, out retval datetime enddate)
datetime	ConvertWorkDaysToDate( datetime startdate, integer workdays, out retval datetime enddate)
content	CreatePlainFromHTML( content html, ref retval content plaintext)
string	CreatePlainFromHTMLString( string[] html, out retval string plain)
Notification	CreateResubmission( optional User[] recipient, optional datetime resubmissiondate, optional string[] resubmissiontext, out retval Notification notification, optional boolean skipdeadlines, optional ResubmissionNotificationType notificationtype, optional boolean personal, optional object[] attachments, optional object period, optional NotificationTemplate notificationtemplate, optional object notificationsource, optional WorkFlowDiagram bpmndiagram, optional boolean recalcdate, optional ComponentObject basedateattr, optional boolean periodsubtract, optional boolean repeatedly, optional DeadlineReiteration deadlinereiteration, optional object category)
User	CreateUser( string email, optional string firstname, optional string surname, optional string middleinitial, optional Country country, optional Language language, out retval User user, optional string externalkey, optional Group organization, optional boolean sendinvitationmail)
void	DelegateToChangedParticipant( AttributeDefinition attrdef, object value, optional object[] oldvalue, optional boolean setresponsible)
Content	Dict2Zip( dictionary dict, out retval Content zip, optional boolean nocompress)
void	DoCancelFileObject( object parent, object view, optional boolean issublevel)
boolean	EnableRegistrationUC( AttributeDefinition exprattrdef, optional IncomingComponentCategory checkcat, out retval boolean enable)
string	Escape( ref retval string str, optional string quote)
string	EscapeHTML( ref retval string str, optional boolean isattribute)
string	EscapeXML( ref retval string str)
void	EvaluateGenericNameBuild( optional boolean force)
datetime	EvaluateTimeInterval( ref retval datetime dateval, object timeinterval, optional any unused, optional boolean subtract)
string	FileNameEncode( string source, out retval string replaced)
string	FindQRCode( optional Content checkcontent, optional QRCodeSearchOptions searchoptions, out retval string qrcode)
string	Format( any value, optional string pattern, optional string symbols, out retval string result)
void	GenerateDocument( optional object inputobj, optional string desttype, optional BookmarkType bookmarktype, ref optional dictionary globalscope, ref optional any destcont, ref optional boolean handleerrors, optional dictionary additionaldata, optional object attrdef)
ReportResult	GenerateReportResult( Report report, optional ReportInfo[] reportinfo, optional Language language, optional Locale locale, out retval ReportResult reportresult)
void	GenerateWorkbook( ref content excel, Workbook workbook, optional boolean evaluateall, optional boolean considernamedranges)
Room[]	GetAllOrphanTeamRooms( out retval Room[] orphanrooms)
Room[]	GetAllReferencedTeamRooms( out retval Room[] referencedrooms)
Room[]	GetAllSubOrdinatedTeamRooms( out retval Room[] subordinatedrooms)
AttributeDefinition	GetAttributeDefinitionByReference( string reference, optional boolean visibleonly, out retval AttributeDefinition attributedefinition)
AttributeDefinition	GetAttributeDefinitionByReferenceOrName( string name, optional boolean visibleonly, out retval AttributeDefinition attributedefinition)
string	GetCellValueFromExcel( content excel, string sheetname, integer column, integer row, optional boolean evaluateall, out retval string cellval)
string	GetCellValueFromWorkbook( Workbook workbook, string sheetname, integer column, integer row, out retval string cellval)
object[]	GetChildren( out retval object[] objlist, optional boolean includebacklinks, optional object[] attrdefs)
object[]	GetChildrenCached( out retval object[] objlist, optional boolean includebacklinks, optional object[] attrdefs)
AppConfigurationRoom	GetContextConfiguration( optional boolean recursive, optional ObjectClass configclass, out retval AppConfigurationRoom configuration, out optional AppConfigurationRoom[] additionalconfigs, optional ObjectAspect configaspect)
AppDashboard	GetContextDashboard( optional ObjectClass dashboardclass, optional ObjectClass configclass, out retval AppDashboard dashboard)
object[]	GetCurrentActivityInstances( out retval object[] actinsts, optional ActivityInstanceState[] actinststates, optional object[] users, optional boolean anyuser)
object	GetCurrentView( optional integer unused1, optional integer unused2, out retval object view, out optional object context, out optional DisplayMode displaymode)
WorkFlowEventType[]	GetDefaultNotificationTypes( boolean pushnotifications, boolean skipconfig, out retval WorkFlowEventType[] notificationtypes)
string	GetDefaultStr( AttributeAggregateDef attrdef, out retval string str)
void	GetDocInfo( content pdf, out optional integer pagecount, out optional boolean encrypted, out optional boolean parseable, out optional boolean dynamicxfa)
void	GetDocMetadata( content pdf, out dictionary metadata, out dictionary additionalProperties)
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
object	GetDraftTemplateCached( out retval object drafttemplate, optional boolean includeself)
string	GetFieldName( string reference, out retval string name)
any[]	GetFieldValue( string reference, out retval any[] value)
string	GetFileExtFromMIMEType( string mimetype, out retval string fileext)
IncomingComponentCategory	GetIncomingCategory( optional integer dynkey, optional boolean checkroom, out retval IncomingComponentCategory incat)
Content	GetLogo( out retval Content logo, optional LogoType type, out object source)
MBInSpireService	GetMBInSpireService( out retval MBInSpireService svc, optional object context)
string	GetMIMETypeFromFileExt( string fileext, out retval string mimetype, out boolean mimetypefound)
string	GetNamedRangeFromExcel( content excel, string name, optional boolean evaluateall, out retval string refersto)
string	GetNamedRangeFromWorkbook( Workbook workbook, string name, out retval string refersto)
InstanceElement[]	GetNextActivityInstances( optional boolean skipconditions, optional boolean includecontrolelements, out retval InstanceElement[] nextactinst)
object[]	GetNextInstanceElements( out retval object[] nextactinsts, optional boolean no_condition, optional boolean no_case, optional boolean no_repeat, optional boolean no_subprocess, optional boolean no_wait, optional boolean no_end)
NotificationEntryList[]	GetNotificationSettings( out retval NotificationEntryList[] notificationentries)
object	GetObjectFile( optional boolean includeself, out retval object objfile)
object	GetObjectFileCached( optional boolean includeself, out retval object objfile)
Room	GetObjectRoom( out retval Room room, optional boolean includeself)
Room	GetObjectRoomCached( out retval Room room, optional boolean includeself)
content	GetOverviewWithQRCode( out retval content pdfcont)
object	GetParent( out retval object parent, out optional object parentattrdef, optional object context)
User[]	GetParticipantListUsersGroups( optional WorkFlowParticipant part, out retval User[] users, out Group[] groups, out User[] roleusers)
dictionary[]	GetPDFContentQRValues( optional integer pagefrom, optional integer pageto, out retval dictionary[] codes)
void	GetPDFInfo( Content document, ref optional dictionary properties)
string	GetPublicLink( out retval string paurl, optional ContentFormat contentformat)
PushNotificationEntryList[]	GetPushNotificationSettings( out retval PushNotificationEntryList[] pushnotificationentries)
integer	GetRandomNumber( optional integer max, out retval integer number)
string	GetRandomString( optional integer length, out retval string string)
object	GetReleasedTemplate( optional boolean checkreleased, out retval object releasedtemplate)
object	GetReleasedTemplateCached( optional boolean checkreleased, out retval object releasedtemplate)
Notification[]	GetResubmissions( boolean includedepending, out retval Notification[] resubmissions, out Notification[] dependingresubmissions)
object	GetSearchSelectionContainer( out retval object searchselcontainer)
SelectionContext	GetSearchSelectionContext( out retval SelectionContext searchselcontext)
object[]	GetSelected( optional integer unused1, optional integer unused2, out retval object[] selobjects, out optional object view, out optional integer[] selindexes, out optional object actioncontext, out optional boolean selcolumn, out optional object selcontainer)
SelectionContext	GetSelectionContext( out object container, out object view, out object[] selectedobjects, out retval SelectionContext selectioncontext)
string	GetSizeStr( integer kbs, out retval string result)
object[]	GetTeamFilter( optional AttributeObjectDef attrdef, optional boolean expandorgelements, optional RoomRole[] roles, out retval object[] result)
User[]	GetTeamMembersSecured( optional boolean expandorgelements, optional RoomRole[] roles, out retval User[] members, out optional object[] groups)
string	GetText( content pdf, out retval string text)
object[]	GetUsableActivityDefinitions( out retval object[] actdefs, optional object[] excludeactdefs, optional object[] prevelements)
object[]	GetUsableProcessDefinitions( out retval object[] procdefs, optional object[] excludeprocdefs, optional boolean enablesub, optional object[] prevelements)
boolean	HasField( string reference, out retval boolean result)
boolean	HasNameBuild( out retval boolean hasnamebuild, out boolean isfixed)
boolean	HasPDFRestrictions( content pdf, out retval boolean hasRestrictions)
boolean	HasRoomChangeAccess( User user, out retval boolean haschangeaccess)
boolean	HasRoomChangeAllocationAccess( User user, out retval boolean haschangeallocationaccess)
boolean	HasRoomChildChangeAccess( optional User user, out retval boolean haschildchangeaccess)
boolean	HasRoomCustomAssignmentAccess( User user, out retval boolean hasaccess, optional object context)
boolean	HasRoomDeleteAccess( optional User user, out retval boolean hasdeleteaccess)
boolean	HasRoomFullControl( User user, out retval boolean hasfullcontrol)
boolean	HasRoomReadAccess( User user, out retval boolean hasreadaccess)
void	HexColor2RGB( string hexcolor, out integer red, out integer green, out integer blue)
string	HexDecode( string encoded, out retval string decoded)
string	HexEncode( string source, out retval string encoded)
void	InitializeWorkFlow( object[] procdefs, optional boolean addinstances, optional object[] additionalobjects, optional datetime submitdeadline, optional boolean expandsub, optional WorkFlowParticipantMapping[] partmapping, optional dictionary processparams, optional string procinstcommonid)
object	InstantiateTemplateObject( optional boolean skipinvalidtextmodules, out object[] invalidtextmodules, out retval object object)
boolean	IsActivityCompleted( out retval boolean iscompleted)
boolean	IsCategoryAllowed( object category, out retval boolean allowed)
boolean	IsChild( object child, out retval boolean ischild)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
boolean	IsDraftTemplateTestable( out retval boolean istestable)
boolean	IsEmptyCSVLine( string line, string nullrep, out retval boolean result)
boolean	IsPdfContentSigned( out retval boolean issigned)
boolean	IsTemplateReleaseable( out retval boolean isreleaseable, out boolean requirereleasedversion)
boolean	IsTemplateReleaseableCached( out retval boolean isreleaseable, out boolean requirereleasedversion)
boolean	IsTemplateReleased( out retval boolean isreleased, out optional object releasedtemplate)
boolean	IsTemplateReleasedCached( out retval boolean isreleased, out optional object releasedtemplate)
boolean	IsTemplateRevisionRequired( optional boolean ignoremodification, out retval boolean isreworkrequired, out datetime revisionrequiredat, out User revisionrequiredby)
boolean	IsWorkFlowServiceUser( out retval boolean isserviceuser, out Group[] servicegroups)
any	JSON2Value( string json, out retval any value, optional boolean allowinvalidutf8, out optional boolean accurate)
any	JSONContent2Value( content jsoncont, out retval any value, optional boolean allowinvalidutf8)
void	LogHistoryEvent( any type, optional object event, optional LanguageStringList[] description, optional datetime timestamp, optional object user, optional object group, optional object position, optional object substuser, optional DocState docstate, optional string[] args, optional boolean nolocktimeout)
string	MakeCSVLine( string[] cells, string nullrep, out retval string str)
datetime	MakeDateTime( string str, optional boolean noerror, out retval datetime result)
string	MakeFileName( ref retval string name)
integer	MakeInteger( string str, optional boolean noerror, out retval integer result)
void	MergeDocument( ref content docx, content[] documents, optional boolean resolvefieldsandsdts, optional boolean pagebreak)
void	MergePowerPoint( ref content pptx, content master, Slide[] slides)
void	MoveToWastebasket( object source, object view)
object	ObjectCopy( ref optional object placement, out retval object object, optional string address, optional boolean virtualobject)
void	ObjectFinalFormSet()
void	ObjectFinalFormSetClose()
void	ObjectFinalFormUnset()
integer	ObjectFixVersion( boolean autofixed, string versdesc, out retval integer newversnr, optional boolean fixcontents, optional boolean converttofinalform, optional string finalformat, optional boolean noautopurge, optional datetime verschangedat, optional datetime verssavedat, optional User versby)
void	ObjectLock( optional boolean recursive, optional boolean automaticunlock, optional integer timeout, optional boolean manualrefresh, optional string locktoken, optional integer lockttlsecs)
void	ObjectLockPermanent( optional boolean automaticunlock)
void	ObjectReleaseVersion( datetime versdate)
void	ObjectUnlock( optional boolean manualrefresh, optional string locktoken)
void	ObjectUnlockPermanent()
NamedRangeRefersToValue[]	ParseNamedRangeRefersTo( string refersto, out retval NamedRangeRefersToValue[] referstovals)
void	PatchFieldsAndSdts( ref content docx, optional WordPatchOptions wordpatchoptions)
ProcessInstance	PrescribeObject( optional integer handle, optional integer index, ref optional WorkFlowPrescriptionList[] prescription, optional boolean prescrparallel, optional object prescrback, optional string remark, optional boolean remarkdefined, optional datetime receivedat, optional datetime startedat, optional datetime completedat, ref optional WorkFlowPrescriptionBlockList[] prescrblocks, optional boolean notcomplete, optional object[] additionalobjects, optional object[] concernedobjects, optional string processname, optional WorkFlowDiagram processdiagram, optional boolean delayedprocessstart, optional string adhocprocesskey, out retval ProcessInstance procinst, optional WorkFlowParticipantMapping[] partmapping, optional boolean expandsubprocesses, optional dictionary processparams, optional string procinstcommonid)
string	Print( ref retval string string)
string	PrintEx( ref retval string string, string[] arguments)
string	QPEncode( string string, out retval string qpstring)
void	RaiseError( ErrorMessage error)
void	RaiseError( ErrorMessage errormessage, optional string str1, optional string str2, optional string str3, optional string str4, optional string str5)
void	ReCalculateNotifications()
string[]	RegexCapture( string source, string pattern, optional string flags, out retval string[] result)
dictionary[]	RegexCaptureEx( string source, string pattern, optional string flags, out retval dictionary[] result)
boolean	RegexMatch( string source, string pattern, optional string flags, out retval boolean result)
string	RegexReplace( string source, string pattern, optional string flags, string replacement, out retval string result)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)
void	RemovePDFRestrictions( ref content pdf)
void	ReopenObject( optional boolean clearfinalformcontent, optional boolean removestateclosed)
void	ResolveAllAlternateContents( ref content docx)
void	ResolveFieldsAndSdts( ref content docx, optional boolean resolvefields, optional boolean resolvesdts, optional string[] customfieldinstructions)
void	RevokeReleasedTemplate( optional dictionary additionalsettings)
string	RGB2HexColor( integer red, integer green, integer blue, ref retval string hexcolor)
any	Round( ref retval any number, optional integer fractions)
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)
void	SetContentParsing( ref optional content[] contents, optional boolean on)
void	SetDocMetadata( ref content pdf, dictionary metadata)
void	SetDocState( DocState state, optional boolean inherited, optional boolean skippropagation)
void	SetFieldValue( string reference, any[] value)
void	SetSelectionContext( optional object container, optional object view, optional object[] selectedobjects, optional SelectionContext selectioncontext)
any	Sort( ref retval any valuelist, optional boolean ascending, optional object[] attrpath, optional boolean nullismax, out optional integer[] mapping, optional boolean stringcomparenatural)
void	SplitPDF( content pdf, out content[] pages)
void	SplitPowerPoint( ref content pptx, out content master, out Slide[] slides)
ProcessInstance	StartProcessDiagram( WorkFlowDiagram diagram, optional boolean silent, out retval ProcessInstance procinst, optional WorkFlowParticipantMapping[] partmapping, optional boolean expandsub, optional dictionary processparams, optional boolean considereroomcontext, optional string procinstcommonid)
string	StringReplace( ref retval string value, string[] patternlist, string replacement)
void	ThrowWarning( integer errornumber)
string[]	Tokenize( string str, optional string separator, out retval string[] tokens)
string[]	TokenizeCSVFile( string str, string nullrep, out retval string[] lines)
string[]	TokenizeCSVLine( string str, string nullrep, out retval string[] cells)
void	Trace( string text, optional any value)
void	TraceValue( optional any value)
OCRStatus	TranslateOCRStatus( string status, out retval OCRStatus ocrstatus)
string	UnEscape( ref retval string str, optional string quote)
string	UnEscapeHTML( ref retval string str)
string	UnEscapeXML( ref retval string str)
void	UpdateDocument( ref content docx, SearchReplaceToken[] searchreplacetokens, TableData[] tabledata, PictureData[] picturedata)
void	UpdateProcessParticipant( AttributeDefinition attrdef, WorkFlowMetaParticipant[] requestedmetaparticipants)
string	URLDecode( string encodedurl, out retval string url)
string	URLEncode( string url, out retval string encodedurl, optional integer targetcharset)
string	Value2JSON( any value, out retval string json, optional boolean fullrefs, optional JSONStructFormat[] formats)
content	Value2JSONContent( any value, out retval content jsoncont, out optional string json, optional boolean fullrefs, optional JSONStructFormat[] formats)
string	Value2XML( any value, out retval string xml, optional boolean enrich, optional boolean fullrefs, optional boolean omitsurroundingnode)
any	XML2Value( any xml, out retval any value, optional boolean keepnamespaceprefixes, optional boolean version2)
dictionary	Zip2Dict( Content zip, out retval dictionary dict)

Properties

Average Score (FSCTERM@1.1001:averagescore)

unsigned float FSCTERM@1.1001:averagescore readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeRead

Closed on/at (FSCFOLIO@1.1001:boclosedat)

Stores the time the object was closed.

Explanation:
In this field the time at which the object was closed is displayed.

date FSCFOLIO@1.1001:boclosedat local readonly

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState

Processing State (FSCFOLIO@1.1001:bostate)

Defines the processing state of the object
FSCFOLIO@1.1001 provides following state component objects:

StateAccepted, StateApproved, StateCalculating, StateCanceled, StateClosed,
StateDeclined, StateDiscarded, StateDone, StateFailed, StateForApproval, StateFulfilled,
StateIgnored, StateInProgress, StateNotReleased, StateNotRelevant, StatePlanning,
StatePreparation, StateReceived, StateRejected, StateReleased, StateReplaced, StateTentative,
StateToVerify, StateUnfulfilled

Note: StateCanceled is set to the object if the document state was set to DS_CANCELLED
StateClosed is set to the object if the document state was set to DS_CLOSED

Explanation:
In each Category different States can be defined that are available for business objects of this type.
Note: In each State different Template Categories can be defined that are available to business objects of this state.

Object FSCFOLIO@1.1001:bostate

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState
Object Classes Allowed: State, ComponentState

Last State Change by (FSCFOLIO@1.1001:bostatechangedby)

Stores the user who changed the processing state.

User FSCFOLIO@1.1001:bostatechangedby readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState
Object Classes Allowed: User

Canceled Objects (FSCFOLIO@1.1001:canceleddocuments)

Is used in context of files to store canceled documents.
A canceled document is always stored in this list of its parent business object or file.

Object[] FSCFOLIO@1.1001:canceleddocuments readonly

Additional Information

Access Types for Changing Property: AccTypeReadComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: Object
Property for Back Link: objcancelsource

Template Categories (COOTC@1.1001:categories)

Stores the template categories to organize templates.

Explanation:
In the create dialog, the template is displayed under the specified template categories.

unique Object[] COOTC@1.1001:categories readonly volatile

Additional Information

Object Classes Allowed: TemplateCategory, ComponentTemplateCategory

PDF Content is signable (FSCPDFGEN@1.1001:issignable)

Indicates whether the PDF content can be signed. Only unencrypted PDF contents can be signed.

boolean FSCPDFGEN@1.1001:issignable readonly

Last Signature (COOSIGNATURE@1.1:lastsignature)

Contains the last signature.

string[] COOSIGNATURE@1.1:lastsignature readonly volatile

Last Signature Type (COOSIGNATURE@1.1:lastsigned)

Contains the signature type of the last signature
FSCCRYPT@1.1001 provides following signature types:
SIGN_DENY_DIGITAL, SIGN_DENY_DIGITAL_CLOSE, SIGN_DIGITAL, SIGN_DIGITAL_CLOSE
COOSIGNATURE@1.1 provides following signature types:
SIGN_INITIAL, SIGN_SIGN, SIGN_VIEWED
FSCFOLIO@1.1001 provides following signature types:

SIGN_APPROVE_CONTENT, SIGN_APPROVE_DISPATCH, SIGN_CANCEL, SIGN_CLOSE, SIGN_DENYCLOSURE,
SIGN_EDIT, SIGN_LEND, SIGN_TAKEBACK

FSCFOLIOWF@1.1001 provides following signature types:

SIGN_APPROVE, SIGN_DENYAPPROVAL, SIGN_DENYRELEASE, SIGN_DENYREVIEW, SIGN_DISCARDREVIEW,
SIGN_FORWARD, SIGN_NOTIFICATION, SIGN_RELEASE, SIGN_REVIEWPASSED

SignatureType COOSIGNATURE@1.1:lastsigned readonly

Last Signature on/at (COOSIGNATURE@1.1:lastsignedat)

Contains the time stamp of the last signature

date COOSIGNATURE@1.1:lastsignedat readonly

Last Signature by (COOSIGNATURE@1.1:lastsignedby)

Contains the user who performed the last signature

User COOSIGNATURE@1.1:lastsignedby readonly

Remark of Last Signature (COOSIGNATURE@1.1:lastsignedremark)

Contains the remark of the last signature

string COOSIGNATURE@1.1:lastsignedremark readonly

Signature Folder of Last Signature (COOSIGNATURE@1.1:lastsignedsignaturefolder)

This property stores the signature folder context of the last performed signature. If the last signature was not performed in context of a signature folder the property will have no value.

Object COOSIGNATURE@1.1:lastsignedsignaturefolder readonly

ACL Object (COOSYSTEM@1.1:objaclobj)

Defines the ACL on which the access check for the object is based on.

Explanation:
In this field the ACL object (ACL) is selected by which the object is protected.

AccessControlList COOSYSTEM@1.1:objaclobj

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Referenced Object (COOSYSTEM@1.1:objaclref)

Defines that the access check result of the referenced object is used for the access check of the object. objaclobj must not be set.

Explanation:
This field contains the superordinate object. If the ACL object of the referenced object is changed, the ACL object of the subordinate object is changed too.

Object COOSYSTEM@1.1:objaclref

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Current Release Version Date (COOSYSTEM@1.1:objactreleasedat)

Defines the date and time of the version of the object that was released using ObjectReleaseVersion. Its value is set by the kernel and must not be changed.

Explanation:
Always shows date and time of the current released version.

date COOSYSTEM@1.1:objactreleasedat local readonly

Last Version Change on/at (COOSYSTEM@1.1:objactverschanged)

Defines the date and time of the last changes of the version with the exception of noteless changes. If not set, objchangedat represents the desired date and time. Its value is set by the kernel and must not be changed.

date COOSYSTEM@1.1:objactverschanged local readonly

Version Started on/at (COOSYSTEM@1.1:objactverscreated)

Defines the date and time the object version was created. Its value is set by the kernel. However, for the purpose of migrations, a custom value can be set at creation time. In that case, the kernel value is stored in objrealactverscreated and versrealcreatedat. This property initializes objcreatedat at object creation time and verscreatedat at version creation time.

Explanation:
Shows the starting time of the currently viewed version. When creating an object the first version is started. If a version is saved, this is also the time when a new version is started.

date COOSYSTEM@1.1:objactverscreated local not null readonly

Version Number (COOSYSTEM@1.1:objactversnr)

Defines the current version number of the object. Its value is set by the kernel and must not be changed. The initial value is 1.

Explanation:
A sequential number starting with 1 is assigned to each version. The Version Number shows the number of the currently viewed version.

unsigned integer COOSYSTEM@1.1:objactversnr not null readonly

Address (COOSYSTEM@1.1:objaddress)

Defines the address of the object. This property is set by the kernel and must not be changed.

Explanation:
In this field the ID of an object is displayed.

string(64) COOSYSTEM@1.1:objaddress readonly

App Configuration (FSCTEAMROOM@1.1001:objappconfigurationroom)

Calculates the app configuration room an object is belongs to.
The value of this property is calculated by use of GetAppConfiguration

AppConfigurationRoom FSCTEAMROOM@1.1001:objappconfigurationroom readonly volatile invisible

Inbox (FSCTEAMROOM@1.1001:objapproominbox)

Stores the app room inbox of an app room a object is assigned to.

Explanation:
The object is stored in the defined inbox.

AppRoomInbox FSCTEAMROOM@1.1001:objapproominbox readonly

Additional Information

Object Classes Allowed: AppRoomInbox
Property for Back Link: arichildren

Object Aspect (COOSYSTEM@1.1:objaspect)

Defines the aspect of the object. The object aspect defines additional properties and methods of the object. Its value can only be changed using ObjectChangeAspect, if implemented by the object class.

ObjectAspect COOSYSTEM@1.1:objaspect readonly

Available Fields (File) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyfiles)

Calculates the available fields supplied by the file of the object.

Explanation:
Shows the fields that are available based on the definition in the Files field in the Word document. This creates an intersection of all available fields of the object classes and an intersection of all available fields of the categories. This ensures that the properties actually exist in each object class category combination.

string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyfiles readonly volatile

Available Fields (Category) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobjcategory)

Calculates the available fields supplied by the category of the object.

Explanation:
Shows the fields that are available in the Word document based on the category.

string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobjcategory readonly volatile

Available Fields (Current Document) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobject)

Calculates the available fields supplied by the object.

Explanation:
Shows the fields that are available in the Word document based on the definition in the "Current Document" field.

string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobject readonly volatile

Available Fields (Contained in) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyprimaryrelated)

Calculates the available fields supplied by the primary related of the object.

Explanation:
Shows the fields that are available in the Word document based on the definition in the Contained in field. This creates an intersection of all available fields of the object classes and an intersection of all available fields of the categories. This ensures that the properties actually exist in each object class category combination.

string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyprimaryrelated readonly volatile

Canceled (COOSYSTEM@1.1:objcanceled)

Stores if the object is canceled

boolean COOSYSTEM@1.1:objcanceled readonly

Canceled on/at (FSCFOLIO@1.1001:objcanceledat)

Stores the time the object was canceled.

date FSCFOLIO@1.1001:objcanceledat local readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState

Canceled by (FSCFOLIO@1.1001:objcanceledby)

Stores the user who canceled the object.

User FSCFOLIO@1.1001:objcanceledby readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState
Object Classes Allowed: User

Canceled Files (FSCFOLIO@1.1001:objcanceledfiles)

Stores the canceled files.

Object[] FSCFOLIO@1.1001:objcanceledfiles readonly

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: Object
Property for Back Link: objfilecancelsource

Container (FSCFOLIO@1.1001:objcancelsource)

Is set for a canceled object and is automatically linked with the property canceleddocuments.

CompoundObject FSCFOLIO@1.1001:objcancelsource readonly invisible

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel, AccTypeChangeDocState
Access Types for Reading Property: AccTypeRead
Property for Back Link: canceleddocuments

Category (COOTC@1.1001:objcategory)

Category of object.

Explanation:
Defines the category of the object.

Object COOTC@1.1001:objcategory

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Object Classes Allowed: TemplateCategory, ComponentTemplateCategory
Object Classes Not Allowed: SystemTemplateCategory

System Change Timestamp (COOSYSTEM@1.1:objchangedat)

Date and time of the most recent change of the object. Its value is set by the kernel and must not be changed.

Explanation:
In this field the date on which the object has been changed by system the last time, is displayed.

date COOSYSTEM@1.1:objchangedat local readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.

Last Change by (COOSYSTEM@1.1:objchangedby)

Defines user who changed the object last with the exception of noteless changes. Its value is set by the kernel. However, for the purpose of migrations, a custom value can be set. In that case, the kernel value is stored in objrealchangedby and versrealchangedby. This property initializes verschangedby (after commit) and versby (before commit) at version creation time.

Explanation:
In this field the User is displayed who has changed the object the last time.

User COOSYSTEM@1.1:objchangedby readonly

Object Class (COOSYSTEM@1.1:objclass)

Defines the class of the object. The object class defines the properties and the methods of the object. Its value is set by the kernel and can only be changed using ObjectChangeClass, if implemented by the object class.

Explanation:
This field contains the Object Class which is assigned to the object. The object is an instance of this object class.

ObjectClass COOSYSTEM@1.1:objclass not null readonly

Closed on/at Local Time (FSCFOLIO@1.1001:objclosedat)

Stores the local time the object was closed. This property is obsolete use boclosedat instead.

date FSCFOLIO@1.1001:objclosedat readonly

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState

Closed by (FSCFOLIO@1.1001:objclosedby)

Stores the user who closed the object.

User FSCFOLIO@1.1001:objclosedby readonly

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeDocState
Object Classes Allowed: User

Created on/at (COOSYSTEM@1.1:objcreatedat)

Defines the date and time the object was created. Its value is set by the kernel and must not be changed. However, for the purpose of migrations, a custom value can be set at creation time. In that case, the kernel value is stored in objrealcreatedat. This property initializes objactverscreated.

Explanation:
This field contains the creation date of the object.

date COOSYSTEM@1.1:objcreatedat local not null readonly

Created by (COOSYSTEM@1.1:objcreatedby)

Defines user who created the object. Its value is set by the kernel and must not be changed. However, for the purpose of migrations, a custom value can be set at creation time. In that case, the kernel value is stored in objrealcreatedby. This property initializes objchangedby at creation time.

Explanation:
This field contains the User who created the object.

User COOSYSTEM@1.1:objcreatedby not null readonly

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeSecRel

Customizing Context (FSCTEAMROOM@1.1001:objcustomizingcontext)

Room the which is the customizing context for the current object

Room FSCTEAMROOM@1.1001:objcustomizingcontext readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Object Classes Allowed: Room

Deleted (COOSYSTEM@1.1:objdeleted)

Stores if the object is deleted into the wastebasket.

Explanation:
This field indicates, whether the object has been deleted (placed in the wastebasket).

boolean COOSYSTEM@1.1:objdeleted readonly

Highlighting Color (COODESK@1.1:objdisplayeffect)

Defines the highlighting color used to display the object in user interface. This allows to display the object highlighted.

Explanation:
In this field it can be specified, how the object should be displayed ("Regular", "Highlighted", "Red", "Blue" etc.).

DisplayEffect COODESK@1.1:objdisplayeffect

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeSecRel

Document State (FSCFOLIO@1.1001:objdocstate)

The document state represents the life cycle of an object.
With state DS_EDIT the life cycle is initiated.
To distinguish between different processing states in while the object has the document state DS_EDIT the property bostate can be used.
The life cycle of an object ends when the object is closed or cancelled.
Document state can be inherited to child objects. If the document state of an object was inherited the property FSCFOLIO@1.1001:docstateinherited is set to true.

Access permissions to the object can also be affected by the document state and the processing state when access definitions are used.

Explanation:
The current processing state ("In Process", "Suspended", "Closed", "Canceled") of the business document is displayed in this field.

DocState FSCFOLIO@1.1001:objdocstate readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeDocState

Domain (COOSYSTEM@1.1:objdomain)

Defines the domain in which the object is stored.

Explanation:
This field contains the Domain the object belongs to.
Note: The domain is set when creating the object and cannot be changed anymore.

Domain COOSYSTEM@1.1:objdomain readonly

External ID (COOSYSTEM@1.1:objexternalkey)

Defines an external unique identifier that represents the object.

Explanation:
Use this field as identification for importing from external systems. This ID should be unique in the corresponding context.

string COOSYSTEM@1.1:objexternalkey

File (FSCFOLIO@1.1001:objfile)

Stores the file of the object.
Objects assigned to a file follow a life cycle.
The life cycle of the object is represented by the document state of the object stored in objdocstate.
Additionally to the document state the object can have a processing state stored in the property bostate.

Explanation:
Defines the reference to a superordinate file.

Object FSCFOLIO@1.1001:objfile readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel

Container (FSCFOLIO@1.1001:objfilecancelsource)

Is set for a canceled file and is automatically linked with the property objcanceledfiles.

CompoundObject FSCFOLIO@1.1001:objfilecancelsource readonly invisible

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel, AccTypeChangeDocState
Access Types for Reading Property: AccTypeRead
Property for Back Link: objcanceledfiles

Final Form (COOSYSTEM@1.1:objfinalform)

Defines whether the object is in final form. If the value is true, only actions with an access type which is allowed for final form objects can be used for this object. The initial value is false. This property has the access types AccTypeReadSec and AccTypeChangeSec assigned.

Explanation:
In this field it is specified, whether the object was finalized. Finalized objects have passed all editing steps. The state is frozen and only certain restrictive actions are possible.

boolean COOSYSTEM@1.1:objfinalform readonly

Additional Information

Access Types for Changing Property: AccTypeChangeSec, AccTypeChange
Access Types for Reading Property: AccTypeReadSec, AccTypeRead

Font Effect (COODESK@1.1:objfonteffect)

Defines the font effect used to display the object in user interface. This allows to display the name of the object normal, italic, or bold.

Explanation:
In this field the font type can be specified. For example the entries "Regular", "Bold", "Italic" and "Bold Italic" are available.

FontEffect COODESK@1.1:objfonteffect

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeSecRel

Object Last Indexed (UTC) (COOSYSTEM@1.1:objindexedat)

Date and time of the most recent indexing of the object. Its value is set by the kernel and must not be changed.

date COOSYSTEM@1.1:objindexedat readonly invisible

Pre-Captured (FSCFOLIO@1.1001:objisprecaptured)

Stores if the object is pre captured.

boolean FSCFOLIO@1.1001:objisprecaptured readonly invisible

Is Template (COOTC@1.1001:objistemplate)

Defines if the current object is marked as template.

Explanation:
In this field it is defined, if this object should be available as template.

boolean COOTC@1.1001:objistemplate

Template Language (COOTC@1.1001:objlanguage)

Stores the language of the template to filter the best matching template.

Explanation:
Defines the template language.

Language COOTC@1.1001:objlanguage

Additional Information

Object Classes Allowed: Language

Last Signature Folder (FSCFOLIO@1.1001:objlastsignaturefolder)

Stores the newest signature folder.

SignatureFolder FSCFOLIO@1.1001:objlastsignaturefolder readonly

Additional Information

Object Classes Allowed: SignatureFolder

State of Last Signature Folder (FSCFOLIO@1.1001:objlastsignaturefolderstate)

Stores the state of the newest signature folder.

SignatureFolderState FSCFOLIO@1.1001:objlastsignaturefolderstate readonly

Location (COOSYSTEM@1.1:objlocation)

Obsolete since 24.6.0.

Object[] COOSYSTEM@1.1:objlocation readonly invisible

Shared Usage (COOSYSTEM@1.1:objlocationlist)

Obsolete since 24.6.0.

Object[] COOSYSTEM@1.1:objlocationlist readonly invisible

Own Location (COOSYSTEM@1.1:objlocationroot)

Obsolete since 24.6.0.

Object[] COOSYSTEM@1.1:objlocationroot readonly invisible

Lock (COOSYSTEM@1.1:objlock)

Defines the locking information of the object including the user who locked the object and the date and time when the object was locked. Its value is set by the kernel and must not be changed.

Explanation:
This field contains information about the lock of the object.

ObjectLockInfo COOSYSTEM@1.1:objlock readonly volatile

Locked Permanently (COOSYSTEM@1.1:objlockedpermanent)

Defines whether the object is permanently locked. Its value is set by the kernel and must no be changed.

boolean COOSYSTEM@1.1:objlockedpermanent readonly invisible

Mindbreeze Categorization (FSCMINDBREEZE@1.1001:objmbcategorization)

MBCategorizationData FSCMINDBREEZE@1.1001:objmbcategorization readonly

PDF Annotations (InstantJSON) (FSCMINDBREEZE@1.1001:objmbjsonannotations)

string[] FSCMINDBREEZE@1.1001:objmbjsonannotations readonly

Mindbreeze Categorization (JSON) (FSCMINDBREEZE@1.1001:objmbviewcategorization)

string FSCMINDBREEZE@1.1001:objmbviewcategorization readonly volatile

Symbol (COODESK@1.1:objmicon)

Defines the small icon assigned to the object. This symbol represents the object in the icon view with small icons, in the list view and in the detailed view. If this property is defined, the specified small icon is used instead of the one assigned to the object class of the object.

Explanation:
In this field a Mini Icon (Bitmap) for the object can be selected.

Symbol COODESK@1.1:objmicon

Additional Information

Object Classes Allowed: Symbol
Object Classes Not Allowed: UISymbol

Last Change on/at (COOSYSTEM@1.1:objmodifiedat)

Date and time of the most recent change of the object with the exception of noteless changes. Its value is set by the kernel. However, a custom value can be set.

Explanation:
This field contains the date, the object has been changed the last time.

date COOSYSTEM@1.1:objmodifiedat local readonly

Name (COOSYSTEM@1.1:objname)

Defines the name of the object.

Explanation:
In this field the name or label is specified.

string COOSYSTEM@1.1:objname

Owner (COOSYSTEM@1.1:objowner)

Defines the user who owns the object. The ACL of an object can grant special access rights to the object owner. This property has the access types AccTypeReadSec and AccTypeChangeSec assigned.

Explanation:
Defines a user as owner.

User COOSYSTEM@1.1:objowner not null

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Group (COOSYSTEM@1.1:objowngroup)

Defines the group that owns the object. The ACL of an object can grant special access rights to the group that owns the object. This property has the access types AccTypeReadSec and AccTypeChangeSec assigned.

Explanation:
This field contains the Group of the object.

Group COOSYSTEM@1.1:objowngroup

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Origin (COOSYSTEM@1.1:objprimaryrelated)

The primary object which has a direct relationship to an object.

Explanation:
Displays the original storage location. If the object is removed from it, the next storage location in which the object is contained becomes the origin.

Object COOSYSTEM@1.1:objprimaryrelated readonly(ui) volatile

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeSecRel

Version Really Created on/at (COOSYSTEM@1.1:objrealactverscreated)

Defines the kernel value of objactverscreated in case a custom value was set. Its value is set by the kernel and must not be changed.

Explanation:
If the creation date of the current version was changed programmatically when the object was created, the actual creation date of the current version is specified in this field.

date COOSYSTEM@1.1:objrealactverscreated local readonly

Really Changed by (COOSYSTEM@1.1:objrealchangedby)

Defines the kernel value of objchangedby in case a custom value was set. Its value is set by the kernel and must not be changed.

User COOSYSTEM@1.1:objrealchangedby readonly

Really Created on/at (COOSYSTEM@1.1:objrealcreatedat)

Defines the kernel value of objcreatedat in case a custom value was set. Its value is set by the kernel and must not be changed.

Explanation:
If the creation date was changed programmatically when the object was created, the actual creation date is specified in this field.

date COOSYSTEM@1.1:objrealcreatedat local readonly

Really Created by (COOSYSTEM@1.1:objrealcreatedby)

Defines the kernel value of objcreatedby in case a custom value was set. Its value is set by the kernel and must not be changed.

Explanation:
If the creater was changed programmatically when the object was created, the user who actually created the object is specified in this field.

User COOSYSTEM@1.1:objrealcreatedby readonly

Recorded (FSCFOLIO@1.1001:objrecorded)

Stores if the object is recorded.

Explanation:
This field defines whether or not a business document has been recorded.
Note:

A business document can be set recorded manually or when performing certain work steps.
If a business document gets recorded, a (recorded) version is stored.
If a business document is recorded this setting cannot be changed anymore (once recorded - always recorded).

boolean FSCFOLIO@1.1001:objrecorded readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeDocState

Recorded Set on/at (FSCFOLIO@1.1001:objrecordedat)

Stores the time stamp the object was marked as recorded.

Explanation:
The date and time at which the business document has been set to "recorded" is displayed in this field.
Note:

A business document can be set recorded manually or when performing certain work steps.
If a business document gets recorded, a (recorded) version is stored.
If a business document is recorded this setting cannot be changed anymore (once recorded - always recorded).

date FSCFOLIO@1.1001:objrecordedat local readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeDocState

Target (FSCFOLIO@1.1001:objregistrationtarget)

Target for standard registration. This attribute must not be used directly since it can be configured by an incoming category.

Object FSCFOLIO@1.1001:objregistrationtarget

Additional Information

Object Classes Allowed: Folder, Room, ContainerWithUserForm

Contained in (COOSYSTEM@1.1:objrelated)

A unique list of objects which have a direct relationship to an object.

Explanation:
In this field the parents of this object are displayed.

unique Object[] COOSYSTEM@1.1:objrelated readonly(ui)

Release Version Date (COOSYSTEM@1.1:objreleasedat)

Defines the date and time of the version of the object that is released. Its value is set by the kernel and must not be changed.

Explanation:
Shows date and time of the version that has been released for users with read access.

date COOSYSTEM@1.1:objreleasedat local readonly

Replaced by (COOSYSTEM@1.1:objreplacement)

If the object was replaced by another object with ObjectReplace, this property contains the object before it was replaced.

Object COOSYSTEM@1.1:objreplacement readonly

Follow-Ups (FSCNOTIFICATION@1.1001:objresubmissions)

Stores the follow-ups for the object.

unique Notification[] FSCNOTIFICATION@1.1001:objresubmissions readonly

Additional Information

Access Types for Reading Property: AccTypeRead
Property for Back Link: notificationattachments

Retention Period (COOSYSTEM@1.1:objretentiondate)

Defines the date until which the object must be retained (exclusive). During that time period, the object cannot be deleted.

Explanation:
In this field a date can be specified, to which the object must not be deleted.
Note: The date can be set to a later date but not to an earlier date.

date COOSYSTEM@1.1:objretentiondate

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeSecRel

Scan Queue (FSCFOLIO@1.1001:objscanqueue)

Stores the scan queue for the pre captured object to upload the content to the object.

unique ContentObject[] FSCFOLIO@1.1001:objscanqueue readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeReadComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship

Security Change Timestamp (COOSYSTEM@1.1:objsecchangedat)

Date and time of the most recent change of the object security. Its value is set by the kernel and must not be changed.

Explanation:
Shows the date and time of the last security changes of the object.

date COOSYSTEM@1.1:objsecchangedat local readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.

Security Level (COOSYSTEM@1.1:objseclevel)

Defines the security level of the object. The security clearance of the current user must include the object security level or a superordinated security level to satisfy the required security level.

SecurityLevel COOSYSTEM@1.1:objseclevel

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Access Types for Reading Property: AccTypeReadSec

Signature Folders (FSCFOLIO@1.1001:objsignaturefolders)

All signature folders created for this object is stored here.

unique SignatureFolder[] FSCFOLIO@1.1001:objsignaturefolders readonly

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Object Classes Allowed: SignatureFolder
Property for Back Link: sfaffectedobject

Source Object (COOSYSTEM@1.1:objsource)

If the object is a copy of another object created by ObjectCopy, this property contains the source this object is copied from.

Object COOSYSTEM@1.1:objsource readonly

Subject (COOSYSTEM@1.1:objsubject)

Defines the subject of the object like comments, key words or other statements on the object.

Explanation:
A free text can be entered in this field.

string COOSYSTEM@1.1:objsubject

Tags (FSCTERM@1.1001:objtags)

Stores a list of tags.

unique Tag[] FSCTERM@1.1001:objtags

Teamroom (FSCTEAMROOM@1.1001:objteamroom)

Room the object is assigned to

Room FSCTEAMROOM@1.1001:objteamroom readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSec
Object Classes Allowed: Room

Template (COOTC@1.1001:objtemplate)

Stores the template from which the object was instantiated.

Explanation:
In this field the template is shown.

Object COOTC@1.1001:objtemplate readonly

Template Revision Required (COOTC@1.1001:objtemplaterevisionrequired)

This property stores if the template has be reworked to be released again.

boolean COOTC@1.1001:objtemplaterevisionrequired readonly invisible

Template Revision Required Since (COOTC@1.1001:objtemplaterevisionrequiredat)

This property stores the timestamp when the rework of the template was requested

date COOTC@1.1001:objtemplaterevisionrequiredat readonly invisible

Template Revision Required Requested By (COOTC@1.1001:objtemplaterevisionrequiredby)

This property stores the user who requested the rework of the template

User COOTC@1.1001:objtemplaterevisionrequiredby readonly invisible

Additional Information

Object Classes Allowed: User

Terms (FSCTERM@1.1001:objterms)

Terms.

Explanation:
In this field Terms can be selected. When performing a search or research it can be searched for objects to which certain Terms (keywords) are assigned.

unique Term[] FSCTERM@1.1001:objterms

Additional Information

Object Classes Allowed: Term

Files (FSCFOLIO@1.1001:objuseablefiles)

Defines the usage restrictions of templates and text modules.

Explanation:
Defines the type of files in which the current object can be used. You can do this using either the object class or the category of the file. If object classes and categories are specified together, the file must have a defined object class and a defined category.

unique Object[] FSCFOLIO@1.1001:objuseablefiles

Additional Information

Object Classes Allowed: ObjectClass, TemplateCategory, ComponentTemplateCategory

Contained in (COOSYSTEM@1.1:objuseableprimaryrelated)

The classes and categories of the objects which have a direct relationship to an object, used for template management.

Explanation:
Defines the folder types in which the current object can be used. This can either be done using the object class or the category of the folder. If object classes and categories are specified together, the folder must have a defined object class and a defined category.

unique Object[] COOSYSTEM@1.1:objuseableprimaryrelated

Additional Information

Object Classes Allowed: ObjectClass, TemplateCategory, ComponentTemplateCategory

Current Document (COOSYSTEM@1.1:objuseableself)

The classes which have a direct relationship to an object, used for template management.

Explanation:
Defines the categories and object classes of documents in which the current object can be used.

unique ObjectClass[] COOSYSTEM@1.1:objuseableself

Additional Information

Object Classes Allowed: ObjectClass, TemplateCategory, ComponentTemplateCategory

System Change Timestamp of Last User Change (COOSYSTEM@1.1:objuserchangedat)

Date and time of the most recent change of the object with the exception of noteless changes. Its value is based on objactverschanged and, if not set, objchangedat. Its value is set by the kernel and must not be changed.

date COOSYSTEM@1.1:objuserchangedat local readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.

Valid From (COOSYSTEM@1.1:objvalidfrom)

Defines the date since when the file is valid.

Explanation:
This field contains the date, the object is valid from.

date COOSYSTEM@1.1:objvalidfrom

Valid Until (COOSYSTEM@1.1:objvalidto)

Object is valid till this date.

Explanation:
This field contains the date, the object is valid to.

date COOSYSTEM@1.1:objvalidto

Object Versions (COOSYSTEM@1.1:objversions)

Stores the information of the versions of the object like the number of the version, the user who created it, the date and time the version was created, etc. Its value is set by the kernel and must not be changed.

Explanation:
Shows all created versions.
Note: The current version is not in the list, thus the list is empty as long as no additional version has been created.

unique ObjectVersionList[] COOSYSTEM@1.1:objversions readonly

Days After Which Older Versions Are Automatically Deleted (COOSYSTEM@1.1:objversmaxage)

Defines the days after which older versions are deleted automatically.

Explanation:
Determines the number of days, after which versions should be automatically deleted.

unsigned integer COOSYSTEM@1.1:objversmaxage

Additional Information

Access Types for Changing Property: AccTypeDelete

Maximum Number of Versions Kept (COOSYSTEM@1.1:objversmaxnr)

Defines the maximum number of versions kept.

Explanation:
Determines how many versions should be kept at maximum. When exceeding the limit the oldest versions are deleted.

unsigned integer COOSYSTEM@1.1:objversmaxnr

Additional Information

Access Types for Changing Property: AccTypeDelete

No Automatic Deleting of Versions (COOSYSTEM@1.1:objversnopurge)

Stores whether or not the versions of the object are deleted automatically. If the value is true, the versions are not destroyed automatically.

Explanation:
Determines whether the automatic deleting of versions of this object is prevented.

boolean COOSYSTEM@1.1:objversnopurge

Additional Information

Access Types for Changing Property: AccTypeDelete

PDF Content (Screen Quality) (FSCPDFGEN@1.1001:pdfcontent)

The PDF content of the object optimized for screen.

Content FSCPDFGEN@1.1001:pdfcontent readonly(inst) invisible lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeReadContent
Access Types for Reading Property: AccTypeReadContent

PDF Content (Cache) (FSCPDFGEN@1.1001:pdfcontentcached)

Content FSCPDFGEN@1.1001:pdfcontentcached readonly(ui) invisible

Additional Information

Access Types for Changing Property: AccTypeReadContent
Access Types for Reading Property: AccTypeReadContent

PDF Content (OCR) (FSCPDFGEN@1.1001:pdfcontentocr)

Content FSCPDFGEN@1.1001:pdfcontentocr readonly(ui) invisible

Additional Information

Access Types for Changing Property: AccTypeReadContent
Access Types for Reading Property: AccTypeReadContent

PDF Content (Print Quality) (FSCPDFGEN@1.1001:pdfcontentprint)

The PDF content of the object optimized for print. The PDF document is generated normally meaning that the quality of the PDF is typically better than the PDF retrieved by the property pdfcontent.

Content FSCPDFGEN@1.1001:pdfcontentprint readonly(inst) invisible lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeReadContent
Access Types for Reading Property: AccTypeReadContent

PDF Metadata (FSCPDFGEN@1.1001:pdfmetadata)

PDFMetadata FSCPDFGEN@1.1001:pdfmetadata readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.

PDF Content (Optimized for Smartphones) (FSCPDFGEN@1.1001:pdfphonecontent)

Content FSCPDFGEN@1.1001:pdfphonecontent readonly(inst) invisible lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeReadContent
Access Types for Reading Property: AccTypeReadContent

Ratings (FSCTERM@1.1001:ratings)

RatingsType[] FSCTERM@1.1001:ratings readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeRead

Digital Signatures (COOSIGNATURE@1.1:signatureauthorizations)

Contains the list of digital signatures.

SignatureAuthorization[] COOSIGNATURE@1.1:signatureauthorizations readonly

Signatures (COOSIGNATURE@1.1:signatures)

Contains the list of signatures: who signed when how (and in which role).

Explanation:
This field contains all electronic signatures attached to a subfile. The "Simple/Advanced View" button allows switching between simple and advanced view.

SignatureList[] COOSIGNATURE@1.1:signatures readonly

Manual Signatures (COOSIGNATURE@1.1:signaturesmanual)

Contains the list of manual signatures.

Explanation:
This field contains all signatures which are not electronically attached to the subfile. These can be attached in the course of a Media transition. The "Simple/Advanced View" button allows to switch between simple and advanced view.

SignatureManualList[] COOSIGNATURE@1.1:signaturesmanual readonly

Additional Restrictions (COOTC@1.1001:templatevisibility)

Stores additional restrictions for template creation.

TemplateVisibilityType COOTC@1.1001:templatevisibility readonly

Number of Ratings (FSCTERM@1.1001:totalratings)

unsigned integer FSCTERM@1.1001:totalratings readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeRead

Score (FSCTERM@1.1001:userscore)

unsigned float FSCTERM@1.1001:userscore

Additional Information

Access Types for Changing Property: AccTypeRead

View Count (FSCTERM@1.1001:viewcount)

unsigned integer FSCTERM@1.1001:viewcount readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeRead

Groups Participating in Workflow (COOWF@1.1:workflowgroups)

This property is used to store the groups, that have or had this object in their worklist as the object assigned to a process instance. It can be used in dynamic access control lists to allow groups access.
Whenever a user changes the state of an activity instance to started, the action ModifyAttribute is called to add the current group of the user to this property. The software component workflow is a trusted component, so the current group can be added to this property, even when he has not the access rights to do that in the normal way.

Explanation:
In this field the participated Group is added when starting an activity.

unique Group[] COOWF@1.1:workflowgroups readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: Group

Groups Having Participated in Workflow (COOWF@1.1:workflowgroupsdone)

This property is used to store the groups, that had this object in their worklist as the object assigned to a process instance. It can be used in dynamic access control lists to allow groups access.
The current group is moved into this property after completion of an activity. This feature can by activated in the workflow configuration with the configuration setting domainremoveworkfloworgs.

Explanation:
This field contains the Group of the user having completed the activity when finalizing an activity (depending on the configuration).

unique Group[] COOWF@1.1:workflowgroupsdone readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: Group

Groups Having Participated in Workflow (Extended Access) (COOWF@1.1:workflowgroupsdoneextaccess)

unique Group[] COOWF@1.1:workflowgroupsdoneextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: Group

Groups Participating in Workflow (Extended Access) (COOWF@1.1:workflowgroupsextaccess)

unique Group[] COOWF@1.1:workflowgroupsextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: Group

Users Participating by Role in Workflow (COOWF@1.1:workflowroleusers)

This property is used to store the users, that have or had this object in their worklist as the object assigned to a process instance. The user is added to this property if the user gets the activity assigned by a role without a specified user in the participant of the activity. It can be used in dynamic access control lists to allow users access.
Whenever a user changes the state of an activity instance to started, the action ModifyAttribute is called to remove other users from this property if they no longer have the activity in the worklist property. The software component workflow is a trusted component, so the current user can be added to this property, even when he has not the access rights to do that in the normal way.

unique User[] COOWF@1.1:workflowroleusers readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Users Having Participated in Workflow by Role (COOWF@1.1:workflowroleusersdone)

This property is used to store the users, that had this object in their worklist as the object assigned to a process instance. The user is added to this property if the user got the activity assigned by a role without a specified user in the participant of the activity. It can be used in dynamic access control lists to allow users access.
The current user is moved into this property after completion of an activity. This feature can by activated in the workflow configuration with the configuration setting domainremoveworkfloworgs.

unique User[] COOWF@1.1:workflowroleusersdone readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Users Having Participated in Workflow by Role (Extended Access) (COOWF@1.1:workflowroleusersdoneextaccess)

unique User[] COOWF@1.1:workflowroleusersdoneextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Users Participating by Role in Workflow (Extended Access) (COOWF@1.1:workflowroleusersextaccess)

unique User[] COOWF@1.1:workflowroleusersextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Users Participating in Workflow (COOWF@1.1:workflowusers)

This property is used to store the users, that have or had this object in their worklist as the object assigned to a process instance. It can be used in dynamic access control lists to allow users access.
Whenever a user changes the state of an activity instance to started, the action ModifyAttribute is called to add the current user to this property. The software component workflow is a trusted component, so the current user can be added to this property, even when he has not the access rights to do that in the normal way.

Explanation:
In this field the participating User is added when an activity is started.

unique User[] COOWF@1.1:workflowusers readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Users Having Participated in Workflow (COOWF@1.1:workflowusersdone)

This property is used to store the users, that had this object in their worklist as the object assigned to a process instance. It can be used in dynamic access control lists to allow users access.
The current user is moved into this property after completion of an activity. This feature can by activated in the workflow configuration with the configuration setting domainremoveworkfloworgs.

Explanation:
In this field the User who has finalized the activity is added when an activity is finalized (depending on configuration).

unique User[] COOWF@1.1:workflowusersdone readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Users Having Participated in Workflow (Extended Access) (COOWF@1.1:workflowusersdoneextaccess)

unique User[] COOWF@1.1:workflowusersdoneextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Users Participating in Workflow (Extended Access) (COOWF@1.1:workflowusersextaccess)

unique User[] COOWF@1.1:workflowusersextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Substitutes of Users Participating in Workflow (COOWF@1.1:workflowuserssubstitutes)

This property is used to store substitutes of the users, that have or had this object in their worklist as the object assigned to a process instance. It can be used in dynamic access control lists to allow users access.
Whenever a user changes the state of an activity instance to started, the action ModifyAttribute is called to add the current user to this property. The software component workflow is a trusted component, so the current user can be added to this property, even when he has not the access rights to do that in the normal way.

unique User[] COOWF@1.1:workflowuserssubstitutes readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Substitutes of Users Having Participated in Workflow (COOWF@1.1:workflowuserssubstitutesdone)

This property is used to store substitutes of the users, that had this object in their worklist as the object assigned to a process instance. It can be used in dynamic access control lists to allow users access.
The current user is moved into this property after completion of an activity. This feature can by activated in the workflow configuration with the configuration setting domainremoveworkfloworgs.

unique User[] COOWF@1.1:workflowuserssubstitutesdone readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Substitutes of Users Having Participated in Workflow (Extended Access) (COOWF@1.1:workflowuserssubstitutesdoneextaccess)

unique User[] COOWF@1.1:workflowuserssubstitutesdoneextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Substitutes of Users Participating in Workflow (Extended Access) (COOWF@1.1:workflowuserssubstitutesextaccess)

unique User[] COOWF@1.1:workflowuserssubstitutesextaccess readonly lockable

Additional Information

lockable: Must be locked with ObjectLockAttribute before changing. For details see attrlockable and ObjectLockAttribute.
Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User

Actions

COOWF@1.1:AllowChangeProcessState

Check if the current user is allowed to change the state of the process

boolean COOWF@1.1:AllowChangeProcessState(
out retval boolean statechangeable)

Name	Description
statechangeable	is set to `true` if the process state is changeable

COOTC@1.1001:AllowNavigateDraftRelease

This action is used in the dynamic menu action of the template management to decide if the option to navigate from the draft to the release version and backwards should be available.

boolean COOTC@1.1001:AllowNavigateDraftRelease(
out retval boolean allownavigate,
optional object template)

Name	Description
allownavigate	the result
template	the template

FSCPDFGEN@1.1001:AppendDoc

This action is used for merging PDF documents. The optional parameters "doc2id" and "pagenumbering" can be used to embed an identifier for the appended pages and to put a page number stamp onto the resulting document, respectively.

void FSCPDFGEN@1.1001:AppendDoc(
  ref optional content doc1,
  optional content doc2,
  optional string doc2id,
  optional PageNumberingDefinition pagenumbering,
  out optional integer mergestartpage,
  out optional integer mergedpages)

Name	Description
doc1	Contains the source PDF document. On output this parameter receives the resulting PDF document.
doc2	The document to be appended.
doc2id	Embeds this identifier into each appended page. You may specify this identifier in a subsequent call to FSCPDFGEN::ClearPages in order to clear the content of these pages.
pagenumbering	Applies a page number stamp on each page of the resulting document.
mergestartpage
mergedpages

FSCPDFGEN@1.1001:AppendDocArray

Merges a list of PDF documents to one single PDF document.

void FSCPDFGEN@1.1001:AppendDocArray(
  out content pdf,
  content[] pdflist,
  string[] filenames,
  optional BookmarkType bookmarktype,
  optional boolean insertevenpage)

Name	Description
pdf	The resulting PDF document.
pdflist	A list of PDF documents.
filenames	The file names of the PDF documents used for bookmarking.
bookmarktype	Defines the kind of bookmarking for the new PDF document.
insertevenpage	If set to `true`, an empty page will be inserted when the source document has an uneven number of pages.

FSCPDFGEN@1.1001:AppendDocArrayLegacy

The Legacy AppendDocArray use case

void FSCPDFGEN@1.1001:AppendDocArrayLegacy(
  out content pdf,
  content[] pdflist,
  string[] filenames,
  optional BookmarkType bookmarktype,
  optional boolean insertevenpage)

Name	Description
pdf
pdflist
filenames
bookmarktype
insertevenpage

COOWF@1.1:AttrProcessParticipantSet

This action is intended to delegate activities of the current object using the abstract participant WFMP_OBJPROPERTY or WFMP_OBJPROPROLE to a new participant.

Only activities which are displayed in the worklist and the property of the participant is matching the parameter attrdef are touched.
The delegation is performed by calling the action SetDelegated().

If the current object is a file all objects which refer to this file by use of objfile will be searched and their activities matching the abstract participant WFMP_PARENTPROPERTY or WFMP_PARENTPROPROLE are also delegated to the new participant.
If the current object is a Teamroom all objects which refer to this Teamroom by use of objteamroom will be searched and their activities matching the abstract participant WFMP_CONTEXTPROPERTY or WFMP_CONTEXTPROPROLE are also delegated to the new participant.

void COOWF@1.1:AttrProcessParticipantSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name	Description
attrdef
value
oldvalue

Additional Information

Prototype: AttrSetPrototype

FSCEXPEXT@1.1001:Base64Decode

Decodes a base64 encoded content.

content FSCEXPEXT@1.1001:Base64Decode(
content incont,
out retval content outcont)

Name	Description
incont	the base64 encoded content
outcont	the decoded content

FSCEXPEXT@1.1001:Base64Encode

Encodes a given content in base64.

string FSCEXPEXT@1.1001:Base64Encode(
  content incont,
  out retval string base64string,
  optional boolean usemaxlinelength)

Name	Description
incont	the given content
base64string	the base64 encoded string
usemaxlinelength	use apply a length limit.

COOWF@1.1:CanBeUsedForSubProcessesOnly

Checks if the current workflow diagram is only usable as sub process

boolean COOWF@1.1:CanBeUsedForSubProcessesOnly(
out retval boolean subprocessesonly)

Name	Description
subprocessesonly	the result

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

COOTC@1.1001:CanReleaseTemplate

Check if the current user is allowed to release a template or to withdraw the release.

boolean COOTC@1.1001:CanReleaseTemplate(
out retval boolean canrelease)

Name	Description
canrelease	the result;

FSCFOLIO@1.1001:CanReplaceDocument

Action to check if the object can be replaced.

boolean FSCFOLIO@1.1001:CanReplaceDocument(
out retval boolean canreplace)

Name	Description
canreplace	the result

COOATTREDIT@1.1:CheckLicense

App::CheckLicenseCheck if the App is licensed for the current user.
A user has a valid license if an organization assigned the license to the user.

Thrown errors include

object_app_license_expired
app_not_licensed

boolean COOATTREDIT@1.1:CheckLicense(
  optional string instance,
  optional boolean disableerrorapps,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

Name	Description
instance	this parameter is used for checking legacy app instances and should not be used anymore
disableerrorapps	Just raise an error, do not call an error application
context	the context for the license check
silentmode	if set no errors will be raised
haslicense	additional to possible errors the result of the license check will be returned in this parameter

COOATTREDIT@1.1:CheckLicenseCached

App::CheckLicenseCheck if the App is licensed for the current user.
A user has a valid license if an organization assigned the license to the user.

Thrown errors include

object_app_license_expired
app_not_licensed

boolean COOATTREDIT@1.1:CheckLicenseCached(
  optional string instance,
  optional boolean disableerrorapps,
  optional object context,
  optional boolean silentmode,
  out retval boolean haslicense)

Name	Description
instance	this parameter is used for checking legacy app instances and should not be used anymore
disableerrorapps	Just raise an error, do not call an error application
context	the context for the license check
silentmode	if set no errors will be raised
haslicense	additional to possible errors the result of the license check will be returned in this parameter

FSCFOLIO@1.1001:CloseObject

This action is used to close an object, this means that objfinalform is set to true for any object. After the object was closed a new version is created.

For business relevant objects objdocstate is set to DS_CLOSED. Furthermore the properties bostate, boclosedat and objclosedby are also set.

For non business relevant objects the properties bostate, boclosedat and objclosedby can be explicitly set by use of the parameter setstateclosed.

void FSCFOLIO@1.1001:CloseObject(
optional boolean createfinalformcontent,
optional boolean setstateclosed)

Name	Description
createfinalformcontent	if set to `false`, no final form content(see `contentfinalform`) will be created for the object (default: `true`)
setstateclosed	if set to `true`, and the object is not business relevant, the properties `bostate`, `objclosedby` and `boclosedat` will also be set (default: `false`; this has no effect on business relevant objects)

FSCFOLIO@1.1001:CollectMailData

Collects data from the mail content.
Collected data:

mailreceiver the mail receiver
mailsenderex the mail sender
The contact information of the mail
GetAssociatedDocuments the associated document

void FSCFOLIO@1.1001:CollectMailData(
ref dictionary gatheredinfos)

Name	Description
gatheredinfos	the collected data.

COOSYSTEM@1.1:ConvertContentToFinalForm

Convert content into final form

Content COOSYSTEM@1.1:ConvertContentToFinalForm(
  optional object context,
  optional string format,
  out retval Content contentfinalform)

Name	Description
context	Context object
format	Format (e.g. "pdf")
contentfinalform	The result

COOWF@1.1:ConvertDateToWorkDays

Converts the distance between two dates into workdays.

integer COOWF@1.1:ConvertDateToWorkDays(
  datetime startdate,
  datetime enddate,
  out retval integer workdays)

Name	Description
startdate	the start date
enddate	the end date
workdays	the distance between the start and end date in workdays

COOWF@1.1:ConvertTimeSpanWorkDaysToDate

Converts the start date and the defined amount of timespan to the end date.

datetime COOWF@1.1:ConvertTimeSpanWorkDaysToDate(
  datetime startdate,
  integer timespanworkdays,
  out retval datetime enddate)

Name	Description
startdate	the start date
timespanworkdays	the timespanworkdays
enddate	the end date

COOWF@1.1:ConvertWorkDaysToDate

Converts the start date and the defined amount of workdays to the end date.

datetime COOWF@1.1:ConvertWorkDaysToDate(
  datetime startdate,
  integer workdays,
  out retval datetime enddate)

Name	Description
startdate	the start date
workdays	the workdays
enddate	the end date

FSCFOLIO@1.1001:CreatePlainFromHTML

Create a plain text content from the supplied html content

content FSCFOLIO@1.1001:CreatePlainFromHTML(
content html,
ref retval content plaintext)

Name	Description
html
plaintext

FSCFOLIO@1.1001:CreatePlainFromHTMLString

Create a plain text string from the supplied html text string (list)

string FSCFOLIO@1.1001:CreatePlainFromHTMLString(
string[] html,
out retval string plain)

Name	Description
html	the source string (list). Multiple entries in `html` are concatenated without separator.
plain	the generated plain text string

FSCNOTIFICATION@1.1001:CreateResubmission

Create notification programmatically

Notification FSCNOTIFICATION@1.1001:CreateResubmission(
  optional User[] recipient,
  optional datetime resubmissiondate,
  optional string[] resubmissiontext,
  out retval Notification notification,
  optional boolean skipdeadlines,
  optional ResubmissionNotificationType notificationtype,
  optional boolean personal,
  optional object[] attachments,
  optional object period,
  optional NotificationTemplate notificationtemplate,
  optional object notificationsource,
  optional WorkFlowDiagram bpmndiagram,
  optional boolean recalcdate,
  optional ComponentObject basedateattr,
  optional boolean periodsubtract,
  optional boolean repeatedly,
  optional DeadlineReiteration deadlinereiteration,
  optional object category)

Name	Description
recipient	Recipient of the notification message
resubmissiondate	Date/time of notification
resubmissiontext	Message text
notification	Created notification object is returned
skipdeadlines	Deadlines will not be initialized on create time
notificationtype	the type how the notification will be dispatched to the recipients
personal	the notification is dispatched as personnal resubmission
attachments	the objects for which the resubmission is defined.
period	the period from which the resubmission date was calculated (optional)
notificationtemplate	notification template (optional)
notificationsource	notification source (optional)
bpmndiagram	BPMN diagram (optional)
recalcdate	recalculate recalculate the date when the base date changes (optional)
basedateattr	base date attribute definition (optional)
periodsubtract	subtract time span (optional)
repeatedly	execute follow-up repeatedly (optional)
deadlinereiteration	repetition rule (optional)
category	the category will be assigned to the resubmission (optional). If no category is supplied the default category is calculated.

FSCORGMGMT@1.1001:CreateUser

Creates a new user with the specified e-mail address and returns the created user in the user parameter. If a user with this e-mail address exists already the existing user is returned.
The check for existing users is performed by calling action CheckExistingUser.
To identify a matching user the email address has to be contained in the login name or the e-mail address list.
Note: To check if a new user has been created, use the cootx.IsCreated(user) statement.
Note: In the Fabasoft Cloud: The login name is not defined for users who are not yet registered.

User FSCORGMGMT@1.1001:CreateUser(
  string email,
  optional string firstname,
  optional string surname,
  optional string middleinitial,
  optional Country country,
  optional Language language,
  out retval User user,
  optional string externalkey,
  optional Group organization,
  optional boolean sendinvitationmail)

Name	Description
email	the e-mail address of the new user
firstname	the first name of the new user
surname	the surname of the new user
middleinitial	the middle name of the new user
country	the country of the new user
language	the communication language of the new user
user	the created user
externalkey	the external key of the user
organization	the organization of which the user should become a member resp. external member (if the organization does not have an e-mail domain, the created user will become an external member)
sendinvitationmail	send invitation mail

FSCAPPTOOLS@1.1001:DelegateToChangedParticipant

Automatically delegates all current activities to a changed user when the attribute changes. This action is typically called in a set action of an attribute that is referenced in a workflow participant.

void FSCAPPTOOLS@1.1001:DelegateToChangedParticipant(
  AttributeDefinition attrdef,
  object value,
  optional object[] oldvalue,
  optional boolean setresponsible)

Name	Description
attrdef	the attribute definition of the attribute used in the workflow participant
value	the new value, either a user or a group (this parameter is checked with `COOWF@1.1001:CheckActive`)
oldvalue	the old value, either a user or a group
setresponsible	if `true`, the object in `value` is used as the new process responsible

FSCEXPEXT@1.1001:Dict2Zip

Creates a zip archive from a dictionary. The dictionary may contain other dictionaries or values of type Content. For dictionaries folders will be created in the zip archive. For entries of type Content files will be created in the zip archive. The key of an entry in the dictionary will be used as file or folder name. The resulting archive is stored in PKWARE ZIP format.

Note: contextension will not be added to the file name. Special characters in the key may be removed from or replaced by valid characters in the file or folder name.

Content FSCEXPEXT@1.1001:Dict2Zip(
  dictionary dict,
  out retval Content zip,
  optional boolean nocompress)

Name	Description
dict	the dictionary
zip	the resulting zip archive
nocompress	optimize for speed instead of size. Useful if the files in the content entries already use a compressed format (e.g. PNG, JPG, Microsoft Office, etc.)

FSCFOLIO@1.1001:DoCancelFileObject

Action used to cancel a file object or a file itself. The FCSCFOLIO@1.1001:bostate for the current object will be set to cancelled. If the current object is a business relevant object the document state objdocstate will also be changed to cancelled.
The object will be moved to the cancelled objects of the file or the room it belongs to.
It is also possible that the current ACL is changed.

The security context for objects assigned to a room can be influenced via the customization point CPGetRoomSecurity with the usecase parameter set to CtxMoveToCanceled.
If nothing can be evaluated for CtxMoveToCanceled, the customization point with the usecase parameter CtxMoveToWastebasket is evaluated.

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

FSCFOLIO@1.1001:EnableRegistrationUC

Action to check if the registration usecase is enabled.
By use of this action the menus for registering an re-registering objects can be enabled or disabled.
This action is also used to display or hide the work items to register objects by use of the activity ActDefRegisterIncomingDocument.

To display the registration menu the following conditions have to match:

the object has not been registered
CanRegister has to return true
the user needs change access to the object

To display the re-registration menu the following conditions have to match:

the object has been registered
CanRegister has to return false
the user needs change access to the object
the incoming category has to define a use case the change the registration
the object has to be registered to a file which is not canceled

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

Name	Description
exprattrdef	the attribute definition to decide which menu should be enabled or disabled (possible values are `icshowreregistermenu` and `icshowworkflowstep` for registering objects and `icshowreregistermenu` and `icshowreregisterwfstep` for re-registering objects)
checkcat	the supplied incoming category to perform the additional checks to enable/disable the menus (if no incoming category is supplied the incoming category is calculated by use of `GetIncomingCategory`)
enable	the result if the menu should be displayed

FSCEXPEXT@1.1001:Escape

Escapes the characters backslash, single quote and double quote in the given string and quote if specified. A backslash is considered as the escape character.

string FSCEXPEXT@1.1001:Escape(
ref retval string str,
optional string quote)

Name	Description
str	the string to be escaped
quote	the character to be used for quoting. Must be a single quote or a double quote.

FSCEXPEXT@1.1001:EscapeHTML

Escapes the string to be used in html tags.
If argument isattribute is set to false or not defined, foreign string parts in the string defined by the str argument are additionally patched with the corresponding language tag by the SetLanguageHTML postwrapper action.

Example Usage:

  coouser.EscapeHTML("<tag attribute=\"value\">");  Result: "&lt;tag attribute=&quot;value&quot;&gt;"

Example for the foreign string: Fabasoft
  coouser.EscapeHTML("Fabasoft&<>\"\'");            Result: "<span lang="de">Fabasoft</span>&amp;&lt;&gt;&quot;&#39;"
  coouser.EscapeHTML("Fabasoft&<>\"\'", true);      Result: "Fabasoft&amp;&lt;&gt;&quot;&#39;"
  coouser.EscapeHTML("Fabasoft&<>\"\'", false);     Result: "<span lang="de">Fabasoft</span>&amp;&lt;&gt;&quot;&#39;"

Note: To disable the foreign string patching, argument isattribute can be set to true. The escaped output will be equal.

string FSCEXPEXT@1.1001:EscapeHTML(
ref retval string str,
optional boolean isattribute)

Name	Description
str	the string to be escaped
isattribute	the result is used as HTML attribute value

FSCEXPEXT@1.1001:EscapeXML

Escapes the string to be used in xml tags

string FSCEXPEXT@1.1001:EscapeXML(
ref retval string str)

Name	Description
str	the string to be escaped

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

COOSYSTEM@1.1:EvaluateTimeInterval

Evaluates the time interval based on a specific datetime value.

datetime COOSYSTEM@1.1:EvaluateTimeInterval(
  ref retval datetime dateval,
  object timeinterval,
  optional any unused,
  optional boolean subtract)

Name	Description
dateval	The datetime value the evaluation is based on. If this parameter is not specified, then the current date time of the object will be used.
timeinterval	The time interval (`TimeInterval` or `TimeIntervalComponentObject`).
unused	Not used.
subtract	If specified and `true`, substract the time interval from `dateval`.

FSCEXPEXT@1.1001:FileNameEncode

Converts a given string to a valid file name string.

string FSCEXPEXT@1.1001:FileNameEncode(
string source,
out retval string replaced)

Name	Description
source	the given string
replaced	the valid file name

FSCFOLIO@1.1001:FindQRCode

Find QR code in given content. If no content is specified, the content in attribute pdfcontent is used

string FSCFOLIO@1.1001:FindQRCode(
  optional Content checkcontent,
  optional QRCodeSearchOptions searchoptions,
  out retval string qrcode)

Name	Description
checkcontent	the content to use
searchoptions	the search options can be used to define in which areas of the document and which pages are used to find the qr code.
qrcode	QR code

COOSYSTEM@1.1:Format

This action takes a single value (any type) as first parameter and a formatting pattern as second parameter (described below). The third parameter is used to supply custom symbols for separators or the decimal point). The result will be returned in the fourth parameter.

string COOSYSTEM@1.1:Format(
  any value,
  optional string pattern,
  optional string symbols,
  out retval string result)

Name	Description
value	The value to format.
pattern	If specified, the pattern used for formatting. Number formatting `.` placeholder for decimal point `,` placeholder for grouping symbol `#` placeholder for significant digit `0` placeholder for digit (zero if no significant digit applies) `?` placeholder for digit (space if no significant digit applies) `+` placeholder for positive sign `-` placeholder for negative sign Currency formatting `$` placeholder for currency (e.g. 'USD', 'GBP' or 'EUR' depending on the value if a currency symbol is available, otherwise '$', '£' or '€' depending on the locale) Date/time formatting (standard) Note: If only `t`, `d`, `T`, `D`, `dt`, `dT`, `Dt`, or `DT` are used as formatting string, the standard date/time formatting is applied as described below. `d` and `t` have a different meaning in custom date/time formatting. `d` short date pattern (e.g. "3/20/2010" for en-US) `D` long date pattern (e.g. "Saturday, March 20, 2010" for en-US) `t` short time pattern (e.g. "9:03 AM" for en-US) `T` long time pattern (e.g. "9:03:23 AM" for en-US) `dt` short date and short time pattern separated by a blank `dT` short date and long time pattern separated by a blank `Dt` long date and short time pattern separated by a blank `DT` long date and long time pattern separated by a blank Date/time formatting (custom) `d` placeholder for day `m` placeholder for month `y` placeholder for year `h` placeholder for hour `n` placeholder for minute `s` placeholder for second `t` placeholder for time mark (am/pm) `/` placeholder for date separator `:` placeholder for time separator `q` placeholder for quarter in year (1-4) `w` placeholder for week in year (1-52) `v` placeholder for week in year year (e.g. 2011 for the January 1st, 2012), see `y`) `k` short date pattern (e.g. "3/20/2010" for en-US) `K` long date pattern (e.g. "Saturday, March 20, 2010" for en-US) `u` short time pattern (e.g. "9:03 AM" for en-US) `U` long time pattern (e.g. "9:03:23 AM" for en-US) one letter, lower case (`d`, `m`, `y`, `h`, `n`, `s`) numeric representation of date/time component two letters, lower case (`dd`, `mm`, `yy`, `hh`, `nn`, `ss`) numeric representation of date/time component, always two digits three letters, lower case (`ddd,` `mmm`) symbolic representation, lower case, abbreviated (like "mon" or "jan") four letters, lower case (`dddd`, `mmmm`) symbolic representation, lower case (like "monday" or "january") three letters, upper case (`DDD`, `MMM`) symbolic representation, upper case, abbreviated (like "MON" or "JAN") four letters, upper case (`DDDD`, `MMMM`) symbolic representation, upper case (like "MONDAY" or "JANUARY") three letters, first upper case, others lower case (`Ddd`, `Mmm`) symbolic representation, case according to locale, abbreviated (like "Mon" or "Jan") four letters, first upper case, others lower case (`Dddd`, `Mmmm`) symbolic representation, case according to locale (like "Monday" or "January") Spaces, "(" and ")" in a pattern are simply copied into the result, (in date time patterns also "," and "."), other literal text must be quoted by single quotes, e.g. the pattern 'it was at' Ddd, d. mm. yyyy evaluates the date Feb. 1st, 2004 to the string "it was at Fri, 1. 02. 2004". If omitted, a default format will be applied.
symbols	This parameter can be used to override the locale-specific placeholders. Multiple overrides can be supplied without separator. The replacement delimiter `'` cannot be escaped. A multi-character replacement is permitted. Syntax: `[`placeholder`]'`replacement`'` The following placeholders can be overridden: `+` placeholder for positive sign `-` placeholder for negative sign `,` placeholder for grouping symbol `.` placeholder for decimal point `$` placeholder for currency symbol `/` placeholder for date separator `:` placeholder for time separator Example: Use space as grouping symbol `[,]' '`.
result	The formatted value.

FSCPDFGEN@1.1001:GenerateDocument

This action is used for generating PDF documents via DocumentDefiniton objects.

void FSCPDFGEN@1.1001:GenerateDocument(
  optional object inputobj,
  optional string desttype,
  optional BookmarkType bookmarktype,
  ref optional dictionary globalscope,
  ref optional any destcont,
  ref optional boolean handleerrors,
  optional dictionary additionaldata,
  optional object attrdef)

Name	Description
inputobj	A DocumentDefinition object that is used to generate the document.
desttype	"pdf", "pdfnative" and "pdfanative" are allowed. Default "pdf" is used.
bookmarktype	Defines which table of contents should be generated.
globalscope	Dictionary containing global transaction scope.
destcont	The generated PDF document.
handleerrors	If set to `true`, errors while generating will be inserted into the generated document.
additionaldata	Dictionary containing additional data which is used for generating a document.
attrdef	The content attribute definition where the generated document should be saved.

FSCREPORTING@1.1001:GenerateReportResult

Generates a specific report result based on the report report for the object this action is called on. The report result is created, filled with the report data and committed. The current object must not be locked when calling this action, since a new transaction is used.

ReportResult FSCREPORTING@1.1001:GenerateReportResult(
  Report report,
  optional ReportInfo[] reportinfo,
  optional Language language,
  optional Locale locale,
  out retval ReportResult reportresult)

Name	Description
report	report to use
reportinfo	optional report info for BIRT reports
language	optional language to be used when generating the report
locale	optional locale to be used when generating the report
reportresult	report result

FSCPOI@1.1001:GenerateWorkbook

Modifies or creates a Microsoft Excel content which is defined by Workbook. Note: Fields will not be updated automatically when processing the content

void FSCPOI@1.1001:GenerateWorkbook(
  ref content excel,
  Workbook workbook,
  optional boolean evaluateall,
  optional boolean considernamedranges)

Name	Description
excel	The modified or created Microsoft Excel content
workbook	The structure and values of the workbook
evaluateall	Ensures that all cells are evaluated
considernamedranges	If `true`, the named ranges of the workbook will be saved in the Excel content Support for formula functions is limited. Supported functions are: ABS, ACOS, ACOSH, ADDRESS, AND, AREAS, ASIN, ASINH, ATAN, ATAN2, ATANH, AVEDEV, AVERAGE, CEILING, CHAR, CHOOSE, CLEAN, CODE, COLUMN, COLUMNS, COMBIN, CONCATENATE, COS, COSH, COUNT, COUNTA, COUNTBLANK, COUNTIF, DATE, DAY, DAYS360, DEGREES, DEVSQ, DGET, DMAX, DMIN, DOLLAR, DSUM, ERROR.TYPE, EVEN, EXACT, EXP, FACT, FALSE, FIND, FIXED, FLOOR, FREQUENCY, FV, GEOMEAN, HLOOKUP, HOUR, HYPERLINK, IF, INDEX, INDIRECT, INT, INTERCEPT, IPMT, IRR, ISBLANK, ISERR, ISERROR, ISLOGICAL, ISNA, ISNONTEXT, ISNUMBER, ISREF, ISTEXT, LARGE, LEFT, LEN, LN, LOG, LOG10, LOOKUP, LOWER, MATCH, MAX, MAXA, MDETERM, MEDIAN, MID, MIN, MINA, MINUTE, MINVERSE, MIRR, MMULT, MOD, MODE, MONTH, NA, NOT, NOW, NPER, NPV, ODD, OFFSET, OR, PERCENTILE, PI, PMT, POISSON, POWER, PPMT, PRODUCT, PROPER, PV, RADIANS, RAND, RANK, RATE, REPLACE, REPT, RIGHT, ROMAN, ROUND, ROUNDDOWN, ROUNDUP, ROW, ROWS, SEARCH, SECOND, SIGN, SIN, SINH, SLOPE, SMALL, SQRT, STDEV, SUBSTITUTE, SUBTOTAL, SUM, SUMIF, SUMPRODUCT, SUMSQ, SUMX2MY2, SUMX2PY2, SUMXMY2, T, TAN, TANH, TEXT, TIME, TODAY, TRANSPOSE, TREND, TRIM, TRUE, TRUNC, UPPER, VALUE, VAR, VARP, VLOOKUP, WEEKDAY, YEAR

FSCTEAMROOM@1.1001:GetAllOrphanTeamRooms

Calculates all orphan Teamrooms of the current room when room hierarchy is supported.

Room[] FSCTEAMROOM@1.1001:GetAllOrphanTeamRooms(
out retval Room[] orphanrooms)

Name	Description
orphanrooms	the orphan Teamrooms

FSCTEAMROOM@1.1001:GetAllReferencedTeamRooms

Calculates all referenced Teamrooms of the current room when room hierarchy is supported.

Room[] FSCTEAMROOM@1.1001:GetAllReferencedTeamRooms(
out retval Room[] referencedrooms)

Name	Description
referencedrooms	the referenced Teamrooms

FSCTEAMROOM@1.1001:GetAllSubOrdinatedTeamRooms

Calculates all subordinate Teamrooms of the current room when room hierarchy is supported.

Room[] FSCTEAMROOM@1.1001:GetAllSubOrdinatedTeamRooms(
out retval Room[] subordinatedrooms)

Name	Description
subordinatedrooms	the subordinate Teamrooms

FSCAPPTOOLS@1.1001:GetAttributeDefinitionByReference

Retrieves the AttributeDefinition identified by reference.
cooobj must have this attribute.
Category attributes are preferred over object attributes.

AttributeDefinition FSCAPPTOOLS@1.1001:GetAttributeDefinitionByReference(
  string reference,
  optional boolean visibleonly,
  out retval AttributeDefinition attributedefinition)

Name	Description
reference	the full or short reference of the attribute (if the short reference is not unique `null` is returned)
visibleonly	if not called with a full reference that exactly identifies an attribute only consider attributes that have `attrvisible != false`
attributedefinition	the `AttributeDefinition` identified by `reference`

FSCAPPTOOLS@1.1001:GetAttributeDefinitionByReferenceOrName

Retrieves the AttributeDefinition identified by name.
cooobj must have this attribute.
Category attributes are preferred over object attributes.

AttributeDefinition FSCAPPTOOLS@1.1001:GetAttributeDefinitionByReferenceOrName(
  string name,
  optional boolean visibleonly,
  out retval AttributeDefinition attributedefinition)

Name	Description
name	the full or short reference of the attribute or the name (if the short reference or name is not unique `null` is returned)
visibleonly	if not called with a full reference that exactly identifies an attribute only consider attributes that have `attrvisible != false`
attributedefinition	the `AttributeDefinition` identified by `reference`

FSCPOI@1.1001:GetCellValueFromExcel

Returns the value of a specified cell from Microsoft Excel content

string FSCPOI@1.1001:GetCellValueFromExcel(
  content excel,
  string sheetname,
  integer column,
  integer row,
  optional boolean evaluateall,
  out retval string cellval)

Name	Description
excel	The Microsoft Excel content
sheetname	The name of the sheet containing the cell
column	The column-index of the cell. The starting column-index is zero, meaning that index 0 corresponds to column A, index 1 to column B, and so on.
row	The row-index of the cell. The starting row-index is zero, meaning that index 0 corresponds to row 1, index 1 to row 2, and so on.
evaluateall	If true, all cells will be evaluated
cellval	The cell value

FSCPOI@1.1001:GetCellValueFromWorkbook

Returns the value of a specified cell from Workbook

string FSCPOI@1.1001:GetCellValueFromWorkbook(
  Workbook workbook,
  string sheetname,
  integer column,
  integer row,
  out retval string cellval)

Name	Description
workbook	The structure and values of the workbook
sheetname	The name of the sheet containing the cell
column	The column-index of the cell. The starting column-index is zero, meaning that index 0 corresponds to column A, index 1 to column B, and so on.
row	The row-index of the cell. The starting row-index is zero, meaning that index 0 corresponds to row 1, index 1 to row 2, and so on.
cellval	The cell value

FSCFOLIO@1.1001:GetChildren

Get the children of an object which are stored in attributes marked with attrischild = TRUE. The action does not read the children in a recursive way. To retrieve the children in a recursive way the action GetChildrenEx can be used.
Note: If the object has an attribute definition with object class AttributeObjectMappingDef the children of registered folders are also included.

object[] FSCFOLIO@1.1001:GetChildren(
  out retval object[] objlist,
  optional boolean includebacklinks,
  optional object[] attrdefs)

Name	Description
objlist	the result
includebacklinks	if set the backlink objects themselves are included instead of the mapped values of attributes of type `AttributeBackLinkDef`
attrdefs	if set only the children from the specified attributes are returned

FSCFOLIO@1.1001:GetChildrenCached

object[] FSCFOLIO@1.1001:GetChildrenCached(
  out retval object[] objlist,
  optional boolean includebacklinks,
  optional object[] attrdefs)

Name	Description
objlist	the result
includebacklinks	if set the backlink objects themselves are included instead of the mapped values of attributes of type `AttributeBackLinkDef`
attrdefs	if set only the children from the specified attributes are returned

FSCTEAMROOM@1.1001:GetContextConfiguration

Gets the configuration for an object taking into account context-specific information.

If no configuration is found, the object contained in transaction variable TV_CONTEXTOBJECT is used.

AppConfigurationRoom FSCTEAMROOM@1.1001:GetContextConfiguration(
  optional boolean recursive,
  optional ObjectClass configclass,
  out retval AppConfigurationRoom configuration,
  out optional AppConfigurationRoom[] additionalconfigs,
  optional ObjectAspect configaspect)

Name	Description
recursive	true if the action is called recursively
configclass	the objectclass of the configuration
configuration	the app configuration room of the current context
additionalconfigs	in context of an global app dashboard (see: `CPUseGlobalAppDashboard`) the parameter configuration returns the first app configuration room stored in `dbconfig`. All other values of `dbconfig` are returned with parameter additionalconfigs.
configaspect	if defined the configuration must have the supplied aspect assigned. This parameter is only considered when an object class is supplied. So the requested configuration has to match the supplied class and the supplied aspect. If the required configuration just needs to match the object aspect the aspect has to be supplied with parameter configclass

FSCTEAMROOM@1.1001:GetContextDashboard

Get the app dashboard for an object taking into account context-specific information.

AppDashboard FSCTEAMROOM@1.1001:GetContextDashboard(
  optional ObjectClass dashboardclass,
  optional ObjectClass configclass,
  out retval AppDashboard dashboard)

Name	Description
dashboardclass	app dashboard object class
configclass	app configuration object class
dashboard	the dashboard

COOWF@1.1:GetCurrentActivityInstances

Calculates and returns all activity instances of the object which are currently located in the work list of the current user

object[] COOWF@1.1:GetCurrentActivityInstances(
  out retval object[] actinsts,
  optional ActivityInstanceState[] actinststates,
  optional object[] users,
  optional boolean anyuser)

Name	Description
actinsts	the activity instances currently located in the work list
actinststates	the activity instances will be filtered by the supplied states. If no states have been supplied on activity instances having states `ACTINST_STARTABLE` or `ACTINST_STARTED` will be returned.
users	the users
anyuser	the anyuser

COODESK@1.1:GetCurrentView

Returns the currently selected relation of the object.

object COODESK@1.1:GetCurrentView(
  optional integer unused1,
  optional integer unused2,
  out retval object view,
  out optional object context,
  out optional DisplayMode displaymode)

Name	Description
unused1
unused2
view	The currently selected relation of the object.
context	The context action of the container.
displaymode	The used display mode.

COOWF@1.1:GetDefaultNotificationTypes

Get the default notification types for workflow notifications. This notification types are used will be initialized in user environments

WorkFlowEventType[] COOWF@1.1:GetDefaultNotificationTypes(
  boolean pushnotifications,
  boolean skipconfig,
  out retval WorkFlowEventType[] notificationtypes)

Name	Description
pushnotifications	the default settings for push notifications are returned
skipconfig	the default values are returned without checking the workflow configuration settings.
notificationtypes	the result

FSCEXPEXT@1.1001:GetDefaultStr

Retrieves the string in the default language

string FSCEXPEXT@1.1001:GetDefaultStr(
AttributeAggregateDef attrdef,
out retval string str)

Name	Description
attrdef	the attribute definition containing the multi language string
str	the resulting string

FSCPDFGEN@1.1001:GetDocInfo

Retrieves information from a PDF document

void FSCPDFGEN@1.1001:GetDocInfo(
  content pdf,
  out optional integer pagecount,
  out optional boolean encrypted,
  out optional boolean parseable,
  out optional boolean dynamicxfa)

Name	Description
pdf	The PDF content which should be analyzed.
pagecount	Number of pages of the PDF content.
encrypted	Parameter indicating whether the PDF is encrypted or not.
parseable	Parameter indicating whether the PDF is parseable by Apache PDFBox or not.
dynamicxfa

FSCPDFGEN@1.1001:GetDocMetadata

Retrieves all information from PDF metadata (title, author, subject, ...)

void FSCPDFGEN@1.1001:GetDocMetadata(
  content pdf,
  out dictionary metadata,
  out dictionary additionalProperties)

Name	Description
pdf	The PDF content which should be analyzed.
metadata	Key/Value dictionary from all metadata entries in the document information dictionary (title, author, subject, ...)
additionalProperties	dictionary for additional selected properties that do not belong to the document information dictionary (DisplayDocTitle)

COOTC@1.1001:GetDraftTemplate

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

object COOTC@1.1001:GetDraftTemplate(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

COOTC@1.1001:GetDraftTemplateCached

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

object COOTC@1.1001:GetDraftTemplateCached(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

FSCUSERFORMS@1.1001:GetFieldName

Retrieves a field name

string FSCUSERFORMS@1.1001:GetFieldName(
string reference,
out retval string name)

Name	Description
reference	the (base) reference of the field
name	the name of the field in the language of the current user environment

FSCUSERFORMS@1.1001:GetFieldValue

Retrieves a field value

any[] FSCUSERFORMS@1.1001:GetFieldValue(
string reference,
out retval any[] value)

Name	Description
reference	the (base) reference of the field
value	the value

FSCEXPEXT@1.1001:GetFileExtFromMIMEType

Retrieves the file extension from a MIME type.

string FSCEXPEXT@1.1001:GetFileExtFromMIMEType(
string mimetype,
out retval string fileext)

Name	Description
mimetype	the given MIME type
fileext	the file extension

FSCFOLIO@1.1001:GetIncomingCategory

Get the possible incoming category for the current object.
At first the incoming category would be taken from property categoryregcategory of the assigned category of the object.
In case of processing the dynkey SearchLocalObjects is used as fallback to retrieve the matching incoming category.
The incoming category has to be usable for the current object to be returned. This check is done by calling action CheckIncomingCategoryAllowedClasses.
If no incoming category was found, the incoming category for generic registration could be used when allowed by CheckIncomingCategoryAllowedClasses.

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

Name	Description
dynkey	the key of the clicked menu entry generated by the dynamic menu action `GetMenuRegisterIncoming`
checkroom	if set to true `FSCTEAMROOM@1.1001:CalcDefaultRoomIncomingCategory` is used to identify the incoming category if `categoryregcategory` does not supply a valid incoming category.
incat	the result.

COODESK@1.1:GetLogo

Retrieves a logo for the current object. The type of logo is defined by LogoType.
Since the source of a logo, i.e. the object which stores the logo, may differ from the current object, GetLogo will also return this source object.
To determine the source object, GetLogo will evaluate the customization GetLogoContainer.
GetLogo will retrieve the logo image either from objlogoimage or objlogothumbimage. If there is no content available in these properties, the logo will be retrieved from the object stored in objlogoref.
If no logo content could be retrieved, the parameter logo and source will not be set.

Content COODESK@1.1:GetLogo(
  out retval Content logo,
  optional LogoType type,
  out object source)

Name	Description
logo	The logo image. Only contents of type png, svg, jpg or gif are allowed.
type	The type of logo that should be retrieved. The type will be used as key in the customization `GetLogoContainer`. The default value is `LT_CONTENT`.
source	The object that stores the logo content.

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

FSCEXPEXT@1.1001:GetMIMETypeFromFileExt

Retrieves the MIME type from a file extension.

string FSCEXPEXT@1.1001:GetMIMETypeFromFileExt(
  string fileext,
  out retval string mimetype,
  out boolean mimetypefound)

Name	Description
fileext	the file extension
mimetype	the MIME type
mimetypefound	return true, if a mimetype was found.

FSCPOI@1.1001:GetNamedRangeFromExcel

Returns the named range reference (reference to specific cells) with a given name in a specific Excel content
For details on Named Ranges in Excel, see https://support.microsoft.com/en-us/office/use-the-name-manager-in-excel-4d8c4c2b-9f7d-44e3-a3b4-9f61bd5c64e4.

string FSCPOI@1.1001:GetNamedRangeFromExcel(
  content excel,
  string name,
  optional boolean evaluateall,
  out retval string refersto)

Name	Description
excel
name	The named range name
evaluateall	If true, all cells will be evaluated
refersto	The reference to the cells

FSCPOI@1.1001:GetNamedRangeFromWorkbook

Returns the named range reference (reference to specific cells) with a given name in a specific FSCPOI@1.1001:workbook
The workbook object should contain a named range. This can be achieved using the ParseWorkbook Use Case (considernamedranges = true).
For details on Named Ranges in Excel, see https://support.microsoft.com/en-us/office/use-the-name-manager-in-excel-4d8c4c2b-9f7d-44e3-a3b4-9f61bd5c64e4.

string FSCPOI@1.1001:GetNamedRangeFromWorkbook(
  Workbook workbook,
  string name,
  out retval string refersto)

Name	Description
workbook	The workbook object
name	The named range name
refersto	The reference to the cells

COOWF@1.1:GetNextActivityInstances

Retrieve the following activity instances of an instance element.
By default control elements like condition, case and repeat elements are not included in the result.
Only the following activities of all paths of the control elements are included.

Subprocesses:
If the follower of the current instance element is a subprocess. The subprocess is not expanded and the subprocess instance is included in the result.

Gateways: To get the following activity instance of a specific gateway path the transaction variable WFVAR_GATEWAY_PATHREFERENCE is used to identify the requested gateway path by the reference and returns the activity instances of this path.
During evaluation of the gateway conditions the transaction variable WFVAR_GATEWAY_PATHREFERENCE is automatically set to the reference of the gateway path which is currently evaluated. Additionally the reference of the gateway path is included in the local scope of the condition expression of the gateway.
Note: If a gateway path does not contain any activity instance the activity instance following the end of the gateway is returned.

InstanceElement[] COOWF@1.1:GetNextActivityInstances(
  optional boolean skipconditions,
  optional boolean includecontrolelements,
  out retval InstanceElement[] nextactinst)

Name	Description
skipconditions	if defined the conditions of gateways are not evaluated and all following activities are returned
includecontrolelements	if defined the search for the next activity instance is stopped at a control element and the control element is part of the result
nextactinst	the following activity instances

COOWF@1.1:GetNextInstanceElements

Retrieve all following instance elements of all activity instances in all work lists of the current user

object[] COOWF@1.1:GetNextInstanceElements(
  out retval object[] nextactinsts,
  optional boolean no_condition,
  optional boolean no_case,
  optional boolean no_repeat,
  optional boolean no_subprocess,
  optional boolean no_wait,
  optional boolean no_end)

Name	Description
nextactinsts	the following instance elements
no_condition	defines if ConditionStartInstances will be excluded from the result
no_case	defines if CaseStartInstances and DivergingGatewayInstances will be excluded from the result
no_repeat	defines if RepeatStartInstances will be excluded from the result
no_subprocess	defines if SubProcessInstances will be excluded from the result
no_wait	defines if WaitActionInstances will be excluded from the result
no_end	defines if EndEventInstance will be excluded from the result

COOWF@1.1:GetNotificationSettings

Get the configured notification entries for an activity instance.
Notification entries can be configured on activity definition, process definition level and global by use of an notification definition.

After the available notification settings have been calculated the action ExtendNotificationSettings is called to allow to do additional customizing of the notification settings.

NotificationEntryList[] COOWF@1.1:GetNotificationSettings(
out retval NotificationEntryList[] notificationentries)

Name	Description
notificationentries	the configured notification entries

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

FSCFOLIO@1.1001:GetObjectFileCached

Action to retrieve the file of an object

object FSCFOLIO@1.1001:GetObjectFileCached(
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

FSCTEAMROOM@1.1001:GetObjectRoom

Action to retrieve the room of an object

Room FSCTEAMROOM@1.1001:GetObjectRoom(
out retval Room room,
optional boolean includeself)

Name	Description
room	the room
includeself	if the current object is a room it will return himself. By default no room will be returned for a room. This parameter has no effect for other objects.

FSCTEAMROOM@1.1001:GetObjectRoomCached

Action to retrieve the room of an object

Room FSCTEAMROOM@1.1001:GetObjectRoomCached(
out retval Room room,
optional boolean includeself)

Name	Description
room	the room
includeself	if the current object is a room it will return himself. By default no room will be returned for a room. This parameter has no effect for other objects.

FSCFOLIO@1.1001:GetOverviewWithQRCode

Create a PDF overview including a QR Code of the current object

content FSCFOLIO@1.1001:GetOverviewWithQRCode(
out retval content pdfcont)

Name	Description
pdfcont	the pdf content including a QR Code

FSCFOLIO@1.1001:GetParent

Get the current parent of the object. This action is currently only relevant for file objects.

object FSCFOLIO@1.1001:GetParent(
  out retval object parent,
  out optional object parentattrdef,
  optional object context)

Name	Description
parent	the parent
parentattrdef	the attribute definition where the parent is stored
context	the caller context can be used change the parent evaluation

COOWF@1.1:GetParticipantListUsersGroups

Resolve the list participant to users an groups

User[] COOWF@1.1:GetParticipantListUsersGroups(
  optional WorkFlowParticipant part,
  out retval User[] users,
  out Group[] groups,
  out User[] roleusers)

Name	Description
part	the participant which should be resolved. If the parameter is not set the attributes `actinstparticipant` or `procinstresponsible` is used as fallback.
users	the resolved users
groups	the resolved groups
roleusers	the resolved users by group and positions

FSCQRCODE@1.1001:GetPDFContentQRValues

GetPDFContentQRValues searches QR Codes on each page of the object's pdfcontent. In the current implementation, at most one code per page will be returned. Page numbers begin with 0 (first page). Negative numbers can be used to wrap around to the last page. (-1 is the last page, -2 is the second last page, etc.)

dictionary[] FSCQRCODE@1.1001:GetPDFContentQRValues(
  optional integer pagefrom,
  optional integer pageto,
  out retval dictionary[] codes)

Name	Description
pagefrom	is the page number of the first page to be scanned. Defaults to 0.
pageto	is the page number of the last page to be scanned. Defaults to pagefrom.
codes	contains a list of found codes. Each dictionary has a "value" containing the data from the code and a "page" containing the page number.

FSCPDFGEN@1.1001:GetPDFInfo

Retrieves the metadata of a PDF document

void FSCPDFGEN@1.1001:GetPDFInfo(
Content document,
ref optional dictionary properties)

Name	Description
document	the PDF document
properties	a dictionary containing the PDF metadata

FSCTEAMROOM@1.1001:GetPublicLink

Returns a public link for the object optionally using the specified download format

string FSCTEAMROOM@1.1001:GetPublicLink(
out retval string paurl,
optional ContentFormat contentformat)

Name	Description
paurl	the public link
contentformat	ContentFormat to use for the link

COOWF@1.1:GetPushNotificationSettings

Get the configured push notification entries for an activity instance.
Push notification entries can be configured on activity definition, process definition level and global by use of an notification definition.

After the available push notification settings have been calculated the action ExtendPushNotificationSettings is called to allow to do additional customizing of the notification settings.

PushNotificationEntryList[] COOWF@1.1:GetPushNotificationSettings(
out retval PushNotificationEntryList[] pushnotificationentries)

Name	Description
pushnotificationentries	the configured push notification entries

FSCEXPEXT@1.1001:GetRandomNumber

Generates a positive random number less than the specified maximum.

integer FSCEXPEXT@1.1001:GetRandomNumber(
optional integer max,
out retval integer number)

Name	Description
max	the exclusive upper bound. The value must be greater than zero
number	the random number

FSCEXPEXT@1.1001:GetRandomString

Generates a random string with the given length which contains only printable ASCII characters.

string FSCEXPEXT@1.1001:GetRandomString(
optional integer length,
out retval string string)

Name	Description
length	the string length. The value must be greater than zero
string	the random string

COOTC@1.1001:GetReleasedTemplate

Gets the release version of a template. The action can be called both on the draft version and on the release 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

COOTC@1.1001:GetReleasedTemplateCached

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

object COOTC@1.1001:GetReleasedTemplateCached(
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

FSCNOTIFICATION@1.1001:GetResubmissions

Retrieve resubmissions of the current object and all depending objects if requested

Notification[] FSCNOTIFICATION@1.1001:GetResubmissions(
  boolean includedepending,
  out retval Notification[] resubmissions,
  out Notification[] dependingresubmissions)

Name	Description
includedepending	the resubmissions of depending objects are included
resubmissions	the resubmissions of the current object
dependingresubmissions	the resubmissions of all depending objects

COOSEARCH@1.1:GetSearchSelectionContainer

Get the selection container used for searching objects.

object COOSEARCH@1.1:GetSearchSelectionContainer(
out retval object searchselcontainer)

Name	Description
searchselcontainer	the selection context.

COOSEARCH@1.1:GetSearchSelectionContext

Get the selection context used for searching objects.

SelectionContext COOSEARCH@1.1:GetSearchSelectionContext(
out retval SelectionContext searchselcontext)

Name	Description
searchselcontext	the selection context.

COODESK@1.1:GetSelected

Returns the list of the selected objects and the columns of the current view.

object[] COODESK@1.1:GetSelected(
  optional integer unused1,
  optional integer unused2,
  out retval object[] selobjects,
  out optional object view,
  out optional integer[] selindexes,
  out optional object actioncontext,
  out optional boolean selcolumn,
  out optional object selcontainer)

Name	Description
unused1
unused2
selobjects	The selected objects.
view	The object list that contains the selected objects.
selindexes	The list of indices from the selected objects.
actioncontext
selcolumn
selcontainer

COODESK@1.1:GetSelectionContext

Returns the current selection context (SelectionContext) which is the current container, the current list, and the currently selected objects.

SelectionContext COODESK@1.1:GetSelectionContext(
  out object container,
  out object view,
  out object[] selectedobjects,
  out retval SelectionContext selectioncontext)

Name	Description
container	The object that contains the view and optionally selected objects.
view	The current view (in general an object pointer property with multiple values of the container).
selectedobjects	The currently selected objects.
selectioncontext	The whole selection context as a structure.

FSCEXPEXT@1.1001:GetSizeStr

Formats incoming kilobytes to KB, MB and GB with one (optional) decimal place.

string FSCEXPEXT@1.1001:GetSizeStr(
integer kbs,
out retval string result)

Name	Description
kbs	the kilobytes of a file
result	the formated string

FSCTEAMROOM@1.1001:GetTeamFilter

Returns the users and organizational elements (teams, organizational units, organizations) authorized in the associated room of the object.

object[] FSCTEAMROOM@1.1001:GetTeamFilter(
  optional AttributeObjectDef attrdef,
  optional boolean expandorgelements,
  optional RoomRole[] roles,
  out retval object[] result)

Name	Description
attrdef	Attribute definition used to filter the result. The classes allowed in the attribute definition are used for filtering. If no attribute definition is specified, no filtering is performed.
expandorgelements	If set, all organizational elements will be resolved to users.
roles	If set, only users with the specified role will be returned.
result	The result

FSCTEAMROOM@1.1001:GetTeamMembersSecured

Returns the users directly authorized in the room. If the parameter expandorgelements is set to true, then the users contained in authorized organizational elements are also returned.

User[] FSCTEAMROOM@1.1001:GetTeamMembersSecured(
  optional boolean expandorgelements,
  optional RoomRole[] roles,
  out retval User[] members,
  out optional object[] groups)

Name	Description
expandorgelements	If set, all organizational elements will be resolved to users.
roles	If set, only users with the specified role will be returned. In a Teamroom or a room with user data, the roles `RoleTeamRoomFullControl`, `RoleTeamRoomChangeAccess` and `RoleTeamRoomReadAccess` can be used. In an app configuration, usually the roles `RoleAppConfigurationRoomAdmin` and `RoleAppConfigurationRoomUser` are available.
members	The team members.
groups	The authorized organizational elements

FSCPDFGEN@1.1001:GetText

Retrieves the text of a PDF document

string FSCPDFGEN@1.1001:GetText(
content pdf,
out retval string text)

Name	Description
pdf	the PDF document
text	the text content of the PDF document

COOWF@1.1:GetUsableActivityDefinitions

Gets the usable activity definitions of the current object

object[] COOWF@1.1:GetUsableActivityDefinitions(
  out retval object[] actdefs,
  optional object[] excludeactdefs,
  optional object[] prevelements)

Name	Description
actdefs	the activity definitions
excludeactdefs	this definitions will be excluded from the result
prevelements	the previous instance or definition elements in the process

COOWF@1.1:GetUsableProcessDefinitions

This action is called by the user interface, when a new process instance is to be attached to an object or a sub process is to be inserted in a process, to retrieve the process definitions, that are usable for this object.

object[] COOWF@1.1:GetUsableProcessDefinitions(
  out retval object[] procdefs,
  optional object[] excludeprocdefs,
  optional boolean enablesub,
  optional object[] prevelements)

Name	Description
procdefs	The usable process definitions.
excludeprocdefs	Process definitions specified in this parameter are never returned in `procdefs`.
enablesub	If set to `True`, process definitions usable only for sub processes are included.
prevelements	the previous instance or definition elements in the process

FSCUSERFORMS@1.1001:HasField

Checks whether a field is assigned to an object

boolean FSCUSERFORMS@1.1001:HasField(
string reference,
out retval boolean result)

Name	Description
reference	the (base) reference of the field
result	`true` if the field is assigned to the object

FSCCONFIG@1.1001:HasNameBuild

Get information about name build of an object

boolean FSCCONFIG@1.1001:HasNameBuild(
out retval boolean hasnamebuild,
out boolean isfixed)

Name	Description
hasnamebuild	true if object has a name build
isfixed

FSCPDFGEN@1.1001:HasPDFRestrictions

Checks if a PDF document has restrictive flags set

boolean FSCPDFGEN@1.1001:HasPDFRestrictions(
content pdf,
out retval boolean hasRestrictions)

Name	Description
pdf	The PDF document
hasRestrictions

FSCTEAMROOM@1.1001:HasRoomChangeAccess

Checks for change access on the room

boolean FSCTEAMROOM@1.1001:HasRoomChangeAccess(
User user,
out retval boolean haschangeaccess)

Name	Description
user	the user for whom the permission will be checked
haschangeaccess	the result

FSCTEAMROOM@1.1001:HasRoomChangeAllocationAccess

Checks for permissions to change the Teamroom assignment of an object.
The required permissions can be defined using the customization point CPChangeAllocationPermission.
If the customization point is not implemented the required permissions are evaluated by execution of the action HasRoomFullControl

boolean FSCTEAMROOM@1.1001:HasRoomChangeAllocationAccess(
User user,
out retval boolean haschangeallocationaccess)

Name	Description
user	the user for whom the permission will be checked
haschangeallocationaccess	the result

FSCTEAMROOM@1.1001:HasRoomChildChangeAccess

Checks for list change access on the room

boolean FSCTEAMROOM@1.1001:HasRoomChildChangeAccess(
optional User user,
out retval boolean haschildchangeaccess)

Name	Description
user	the user for whom the permission will be checked
haschildchangeaccess	the result

FSCTEAMROOM@1.1001:HasRoomCustomAssignmentAccess

Check if the supplied user can assign a new object to the room. This action is used to allow to assign an object to an app Room when the user does not have the sufficient access permissions returned by HasRoomFullControl, HasRoomChangeAccess and HasRoomChildChangeAccess

boolean FSCTEAMROOM@1.1001:HasRoomCustomAssignmentAccess(
  User user,
  out retval boolean hasaccess,
  optional object context)

Name	Description
user	the user for whom the permission will be checked
hasaccess	the result
context	the object which should be assigned to the room

FSCTEAMROOM@1.1001:HasRoomDeleteAccess

Checks for change access on the room or a role that is allowed to move objects to the wastebasket

boolean FSCTEAMROOM@1.1001:HasRoomDeleteAccess(
optional User user,
out retval boolean hasdeleteaccess)

Name	Description
user	the user for whom the permission will be checked
hasdeleteaccess	the result

FSCTEAMROOM@1.1001:HasRoomFullControl

Checks for full control permissions on the room

boolean FSCTEAMROOM@1.1001:HasRoomFullControl(
User user,
out retval boolean hasfullcontrol)

Name	Description
user	the user for whom the permission will be checked
hasfullcontrol	the result

FSCTEAMROOM@1.1001:HasRoomReadAccess

Checks for read access on the Room

boolean FSCTEAMROOM@1.1001:HasRoomReadAccess(
User user,
out retval boolean hasreadaccess)

Name	Description
user	the user for whom the permission will be checked
hasreadaccess	the result

FSCEXPEXT@1.1001:HexColor2RGB

Converts the color code in a hex triplet to its RGB values.

void FSCEXPEXT@1.1001:HexColor2RGB(
  string hexcolor,
  out integer red,
  out integer green,
  out integer blue)

Name	Description
hexcolor	the color code as a hex triplet (like #abcd01)
red	the red value (first byte)
green	the green value (second byte)
blue	the blue value (third byte)

FSCEXPEXT@1.1001:HexDecode

Decodes a hex encoded string.

string FSCEXPEXT@1.1001:HexDecode(
string encoded,
out retval string decoded)

Name	Description
encoded	the hex encoded string
decoded	the decoded string

FSCEXPEXT@1.1001:HexEncode

Encodes a given string in hex.

string FSCEXPEXT@1.1001:HexEncode(
string source,
out retval string encoded)

Name	Description
source	the given string
encoded	the hex encoded string

COOWF@1.1:InitializeWorkFlow

This action is called and can be called to initialize new process instances from a list of process definitions and to attach these process instances to the object. The first activities of the new process instances are set to "Startable".

void COOWF@1.1:InitializeWorkFlow(
  object[] procdefs,
  optional boolean addinstances,
  optional object[] additionalobjects,
  optional datetime submitdeadline,
  optional boolean expandsub,
  optional WorkFlowParticipantMapping[] partmapping,
  optional dictionary processparams,
  optional string procinstcommonid)

Name	Description
procdefs	The list of process definitions, that should be used as template to create process instances. If it is empty, a new process instance is created and initialized with a single activity with the current user as participant. Otherwise for each process definition a separate process instance is created.
addinstances	If set to `True`, the new process instances are added to the list of process instances of the object. Otherwise the existing processes are replaced with the new process instances.
additionalobjects	the created process instance will also be added to the property `workflow` of the supplied objects
submitdeadline	the followers of the first activities are initialized with the supplied deadline for submission
expandsub	If set to `True`, all subprocesses contained in the supplied procdefs are expanded
partmapping	the supplied mapping is used to replace the participants defined in the process definition when the activities are created.
processparams	if defined the process parameters are merged into the process parameters of the process diagram
procinstcommonid	if defined the identification is stored in property `procinstcommonid` for newly created processes. This identification is used to allow to combine commonly started process instances

FSCTEMPLATEMGMT@1.1001:InstantiateTemplateObject

Instantiates a template object and resolve linked text modules. After calling template.InstantiateTemplateObject(), the transaction must be committed before InstantiateTemplateObject() is called again for another template.

object FSCTEMPLATEMGMT@1.1001:InstantiateTemplateObject(
  optional boolean skipinvalidtextmodules,
  out object[] invalidtextmodules,
  out retval object object)

Name	Description
skipinvalidtextmodules	skip invalid text modules
invalidtextmodules	list of invalid text modules
object	the instantiated object

COOWF@1.1:IsActivityCompleted

Check if an activity instance was already completed

boolean COOWF@1.1:IsActivityCompleted(
out retval boolean iscompleted)

Name	Description
iscompleted	the result

COOTC@1.1001:IsCategoryAllowed

Checks if the supplied category is allowed for an object.

boolean COOTC@1.1001:IsCategoryAllowed(
object category,
out retval boolean allowed)

Name	Description
category	the category to test
allowed	true if the category is allowed for the object this action is called on

FSCFOLIO@1.1001:IsChild

Hook action to check if the supplied object is a valid child.

boolean FSCFOLIO@1.1001:IsChild(
object child,
out retval boolean ischild)

Name	Description
child	the object which should be checked to be a child
ischild	the result

COOTC@1.1001:IsDraftTemplate

Checks if the template is a draft which can be released.

If the release mechanism is to be used for an object class, then this action can be implemented for example with: isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();

boolean COOTC@1.1001:IsDraftTemplate(
out retval boolean isdrafttemplate)

Name	Description
isdrafttemplate	the result

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

FSCEXPEXT@1.1001:IsEmptyCSVLine

Checks whether a line in a csv file is empty.

boolean FSCEXPEXT@1.1001:IsEmptyCSVLine(
  string line,
  string nullrep,
  out retval boolean result)

Name	Description
line	the line from a csv file.
nullrep	the string representing an empty line
result	`true` if the line from a csv file is empty.

COODESK@1.1:IsPdfContentSigned

Checks if the main content of an object is a pdf with signatures

boolean COODESK@1.1:IsPdfContentSigned(
out retval boolean issigned)

Name	Description
issigned	returns `true` if the content has been signed

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 release version of the template is required

COOTC@1.1001:IsTemplateReleaseableCached

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

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

COOTC@1.1001:IsTemplateReleased

Check if a template is already released.

boolean COOTC@1.1001:IsTemplateReleased(
out retval boolean isreleased,
out optional object releasedtemplate)

Name	Description
isreleased	the result
releasedtemplate	the released template

COOTC@1.1001:IsTemplateReleasedCached

Check if a template is already released.

boolean COOTC@1.1001:IsTemplateReleasedCached(
out retval boolean isreleased,
out optional object releasedtemplate)

Name	Description
isreleased	the result
releasedtemplate	the released template

COOTC@1.1001:IsTemplateRevisionRequired

Check if the current template has to be reworked until a another release is possible.

boolean COOTC@1.1001:IsTemplateRevisionRequired(
  optional boolean ignoremodification,
  out retval boolean isreworkrequired,
  out datetime revisionrequiredat,
  out User revisionrequiredby)

Name	Description
ignoremodification	the modification date is not checked to verify if the rework is requried
isreworkrequired	the result
revisionrequiredat	the time stamp when the revision was required
revisionrequiredby	the user who requested the revision

COOWF@1.1:IsWorkFlowServiceUser

This action is used to decide if the current user is used as service user for background execution of workflow diagrams. For this user the user profile to filter activities and process definitions is not evaluated.

boolean COOWF@1.1:IsWorkFlowServiceUser(
out retval boolean isserviceuser,
out Group[] servicegroups)

Name	Description
isserviceuser	the result
servicegroups	the service groups of the user

FSCEXPEXT@1.1001:JSON2Value

Converts a JSON string to a value.

any FSCEXPEXT@1.1001:JSON2Value(
  string json,
  out retval any value,
  optional boolean allowinvalidutf8,
  out optional boolean accurate)

Name	Description
json	the JSON string
value	the created value
allowinvalidutf8	invalid utf8 is allowed
accurate	returns `true` if `value` is an exact representation of `json`, `false` if `value` differs from `json`. The applied modifications are among others flattening of nested arrays removing null values removing empty strings

FSCEXPEXT@1.1001:JSONContent2Value

Converts a JSON content to a value.

any FSCEXPEXT@1.1001:JSONContent2Value(
  content jsoncont,
  out retval any value,
  optional boolean allowinvalidutf8)

Name	Description
jsoncont	the JSON content
value	the created value
allowinvalidutf8	invalid utf8 is allowed

FSCFOLIO@1.1001:LogHistoryEvent

This action can be called to store important events in the life time of an object.

Note: In batch mode and bulk load mode will no history events be recorded.
To force recording history events in batch and bulk load mode to the transaction variable TV_BATCHMODE_LOG_HISTORY can be used.

Hint: If some history events should not be recorded in the current transaction the transaction variable TV_SUPPRESSEDEVENTCATEGORIES can be used.

void FSCFOLIO@1.1001:LogHistoryEvent(
  any type,
  optional object event,
  optional LanguageStringList[] description,
  optional datetime timestamp,
  optional object user,
  optional object group,
  optional object position,
  optional object substuser,
  optional DocState docstate,
  optional string[] args,
  optional boolean nolocktimeout)

Name	Description
type	The type of the event to be logged.
event	An object that is the main data of the event.
description	Obsolete. Multilingual string of the event, this should not be supplied any more.
timestamp	an optional timestamp when the history event occurred. If not set the coonow will be used
user	Optional. The user who initiated the event, if omitted the current user is used.
group	Optional. The group of the initiating user, if omitted the current group is used.
position	Optional. The position of the initiating user, if omitted the current position is used.
substuser	Optional. The user who substitutes the initiating user, if omitted the current substituting user is used.
docstate	Optional. The new docstate if business documents are modified.
args	Optional. Additional arguments for printing the description text of the event. These have to be expression language constants, i.e. 1,"text", 2010-01-30 12:00:00.
nolocktimeout	defines if the default lock timeout should be skipped.

FSCEXPEXT@1.1001:MakeCSVLine

Makes a line for a CSV line from a list of cell values.

string FSCEXPEXT@1.1001:MakeCSVLine(
  string[] cells,
  string nullrep,
  out retval string str)

Name	Description
cells	the list of cell values of the CSV line
nullrep	the string representing a blank cell
str	the CSV line

FSCAPPTOOLS@1.1001:MakeDateTime

Converts a string to a datetime.
An empty string results in null.
Supports special formats:

Standard ISO format (yyyy-mm-ddTHH:mm[:ss], e.g.:2019-11-14T20:16). The result will be calculated by a cast to the Fabasoft Expression type datetime if the input string contains the letter 'T'".
US English format (dd MM[M] yy[yy][ HH:mm[:ss] [AM|PM]], e.g.: 14 Nov 19 8:16 PM)
US English format (MM/dd/yy[yy][ HH:mm[:ss]], e.g.:11/14/2019 20:16:39)
German format (dd.MM.yy[yy][ HH:mm[:ss]], e.g.:14.11.2019 20:16:39)

These formats are recognized prior to calling Str2DateTime.

datetime FSCAPPTOOLS@1.1001:MakeDateTime(
  string str,
  optional boolean noerror,
  out retval datetime result)

Name	Description
str	input string
noerror	if `true`, `null` is returned on error
result	resulting `datetime`

FSCEXPEXT@1.1001:MakeFileName

Replace special characters which are not supported by all supported file systems.

/\:*?<>| will be replaced by _
" will be replaced by '

string FSCEXPEXT@1.1001:MakeFileName(
ref retval string name)

Name	Description
name	the name for which the replacement with safe characters should be made.

FSCAPPTOOLS@1.1001:MakeInteger

Converts a string to an integer (base10).
Leading zeros are skipped.
An empty string results in zero.

integer FSCAPPTOOLS@1.1001:MakeInteger(
  string str,
  optional boolean noerror,
  out retval integer result)

Name	Description
str	input string
noerror	if `true`, `null` is returned on error
result	resulting integer

FSCPOI@1.1001:MergeDocument

Merges multiple Microsoft Word documents into one document.
Note: All fonts have to be embedded in the Master Document (fonts cannot be merge) (take care of optimized/partial fonts)

void FSCPOI@1.1001:MergeDocument(
  ref content docx,
  content[] documents,
  optional boolean resolvefieldsandsdts,
  optional boolean pagebreak)

Name	Description
docx	The master Microsoft Word document
documents	The Microsoft Word documents to merge into the master
resolvefieldsandsdts	This will resolve (finalize) all fields and content controls for side documents and remove their field reference. Used for unwanted field and content control update due to insert into new document.
pagebreak	If `true`, a page break will be inserted after each document

FSCPOI@1.1001:MergePowerPoint

Merges multiple slides to a single Microsoft PowerPoint content. Note: Fields will not be updated automatically when processing the content

void FSCPOI@1.1001:MergePowerPoint(
  ref content pptx,
  content master,
  Slide[] slides)

Name	Description
pptx	The Microsoft PowerPoint content
master	The master of the Microsoft PowerPoint slide show
slides	The source slides

FSCTEAMROOM@1.1001:MoveToWastebasket

Move object <cooobj> to the Teamroom wastebasket

void FSCTEAMROOM@1.1001:MoveToWastebasket(
object source,
object view)

Name	Description
source	the container that contains the object
view	the view of the container

COOSYSTEM@1.1:ObjectCopy

Creates a new object as the copy of the object. This action called on the source object. This action sets the property objsource on the copied object.

object COOSYSTEM@1.1:ObjectCopy(
  ref optional object placement,
  out retval object object,
  optional string address,
  optional boolean virtualobject)

Name	Description
placement	If specified, the COO store or domain where the object should be copied. If not specified or an object with a different object class is specified, `COOSYTEM@1.1:ObjectPlacementGet` is called to determine the placement. On output the COO store where the object is copied.
object	The created copy of the object.
address	The object address for the new object. If this parameter is used, it overrides the specified COO store in parameter `coost` or the automatically chosen COO store, if no COO store was specified.
virtualobject	(deprecated) Copy object as virtual object, living in one kernel instance only. If this parameter is used, it overrides the specified COO store in parameter `placement`.

COOSYSTEM@1.1:ObjectFinalFormSet

Sets objfinalform.

void COOSYSTEM@1.1:ObjectFinalFormSet()

COOSYSTEM@1.1:ObjectFinalFormSetClose

Sets the change access and closes the selected objects.

void COOSYSTEM@1.1:ObjectFinalFormSetClose()

COOSYSTEM@1.1:ObjectFinalFormUnset

Clears objfinalform.

void COOSYSTEM@1.1:ObjectFinalFormUnset()

COOSYSTEM@1.1:ObjectFixVersion

Defines the current object version of the object with a short description of the version and starts a new version.

For the purpose of migrations, version metadata set by the kernel can be overridden. The implementation attemps to make migration metadata available in both, objversions as well as corresponding properties in associated versions. Kernel values are stored in corresponding backup properties.

The following properties can be overridden:

Version Property	Override Mechanism	Requirements
`verscreatedat`	`objcreatedat`	Object creation
	`objactverscreated`	Object creation
	`ObjectFixVersion` parameter verschangedat	Subsequent `ObjectFixVersion`
`versby`	`objchangedby`	`ObjectFixVersion` before commit
	`ObjectFixVersion` parameter versby
`verschangedat`	`ObjectFixVersion` parameter verschangedat
`verschangedby`	`objcreatedby`	Object creation
	`objchangedby`	`ObjectFixVersion` after commit
`verssavedat`	`ObjectFixVersion` parameter verschangedat

Limitations:

Despite date overrides, the current date and time (coonow / CooRuntime.GetCurrentDateTime) remains unaffected. Undesired values must be handled manually.
Despite user overrides, the current user (coouser / CooRuntime.GetCurrentUser) remains unaffected. Undesired values must be handled manually.

To maximize date and user correctness, disable functionality leading to undesired date and time / user values by means of FSCCOLD@1.1001 class and mapping options, configuration changes, and transaction variables.

integer COOSYSTEM@1.1:ObjectFixVersion(
  boolean autofixed,
  string versdesc,
  out retval integer newversnr,
  optional boolean fixcontents,
  optional boolean converttofinalform,
  optional string finalformat,
  optional boolean noautopurge,
  optional datetime verschangedat,
  optional datetime verssavedat,
  optional User versby)

Name	Description
autofixed	If it is `true`, the new version was started automatically. Otherwise the user started a new version.
versdesc	The version description.
newversnr	The new version number.
fixcontents	If specified and `true`, a version for the contents of the object is created.
converttofinalform	If specified and `true`, the object is converted to final form.
finalformat	If specified, the final format of the object used to convert the object to final form.
noautopurge	If specified and `true`, do not automatically purge versions of the object.
verschangedat	The value to override `verschangedat` with. The kernel value is stored in `versrealchangedat` and `objrealactverscreated`.
verssavedat	The value to override `verssavedat` with. The kernel value is stored in `versrealsavedat`. If `verschangedat` is specified and `verssavedat` is not, the value is based on `verschangedat`.
versby	The value to override `COOSYSTEM@1.1:verssby` with. The kernel value is stored in `versrealsavedby`. If not specified and `objchangedby` is set in the current transaction, the value is based on `verschangedat`. Otherwise, the value is based on the current user (`coouser` / `CooRuntime.GetCurrentUser`).

COOSYSTEM@1.1:ObjectLock

Locks an object for the current user. If parameter recursive is true, it is possible to lock a locked object in the same transaction without causing an error. If the object was locked in a different transaction or the parameter is omitted or false, an error occurs. If an object is locked several times in the same transaction, the action ObjectUnlock must be called as often as this action in order to unlock it, except if parameter automaticunlock is true. If parameter automaticunlock is true, it is not necessary to call action ObjectUnlock, in fact it is not allowed to call this action. If the transaction is committed or aborted or if the transaction object is destroyed, the object is unlocked automatically for each call of ObjectLock. If parameter manualrefresh is true, the lock is not refreshed automatically. Instead, the action ObjectLockRefresh must be called within the lockttlsecs time span (at least every 6 minutes in the default case).

The optional parameter locktoken enables a user defined lock token to be stored with the lock. If used, the locktoken is required in calls of ObjectLockRefresh and ObjectUnlock. A locktoken may be used by different users.

The optional parameter lockttlsecs specifies the automatic timeout of a lock in seconds (the default is 480 seconds or 8 minutes).

See: ObjectUnlock ObjectLockRefresh

void COOSYSTEM@1.1:ObjectLock(
  optional boolean recursive,
  optional boolean automaticunlock,
  optional integer timeout,
  optional boolean manualrefresh,
  optional string locktoken,
  optional integer lockttlsecs)

Name	Description
recursive	If it is `true` (default value), no error occurs if an object is locked for the second time in the same transaction.
automaticunlock	If it is `true` (default value), the object is unlocked automatically.
timeout	The number of milliseconds the kernel tries to lock the object (greater than 0). If this value is 0, the kernel tries exactly once to lock the object. A value smaller than 0 results in the same behavior as omitting this parameter. In this case the kernel determines the timeout.
manualrefresh	If it is `true`, the lock must be refreshed manually.
locktoken	If specified, it is stored with the lock.
lockttlsecs	If specified, this value is used instead of the default automatic timeout of a lock.

COOSYSTEM@1.1:ObjectLockPermanent

Locks an object for the current user permanently. Use this action e.g for objects you want to lock because you want to use them on a notebook and nobody else should change them. This method can be used together with the action ObjectLock. You can lock an object permanently which you locked before. You can lock an object you locked permanently before. No other user can lock an object permanently that you locked. For safety reasons every user who has the right to change the object is able to break the permanent lock of the object. In this case the action ObjectErrorLockPermanent is called.

void COOSYSTEM@1.1:ObjectLockPermanent(
optional boolean automaticunlock)

Name	Description
automaticunlock	If it is `true`, the permanent lock gets removed, in case the transaction is aborted.

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.

COOSYSTEM@1.1:ObjectUnlock

Unlocks the object. It has to be called for each call of the action Object::ObjectLock in order to unlock the object. If an object was locked several times in one transaction, this action has to be called as often as the action to lock the object. This action cannot be used for versions of objects. If it is used for an object version, an appropriate error is returned. The unlock of the object takes place, when the transaction is committed or aborted.

void COOSYSTEM@1.1:ObjectUnlock(
optional boolean manualrefresh,
optional string locktoken)

Name	Description
manualrefresh	An optional setting for automatic lock refresh (see `ObjectLock`)
locktoken	An optional locktoken (see `ObjectLock`).

COOSYSTEM@1.1:ObjectUnlockPermanent

Unlocks the permanently locked object.

void COOSYSTEM@1.1:ObjectUnlockPermanent()

FSCPOI@1.1001:ParseNamedRangeRefersTo

Parses the named range reference (to specific cells) and returns an object of NamedRangeRefersToValue
Named ranges that refer to values across sheets are not currently supported.

NamedRangeRefersToValue[] FSCPOI@1.1001:ParseNamedRangeRefersTo(
string refersto,
out retval NamedRangeRefersToValue[] referstovals)

Name	Description
refersto	The named range reference
referstovals	An array containing the parsed objects of refersto

FSCPOI@1.1001:PatchFieldsAndSdts

Patches all fields and SDTs (Structured Document Tags) in a Word document based on the specified options (wordpatchoptions).
The patching options include:
- Resolving fields: Resolves all fields in the Word document, retaining only their contents.
- Resolving SDTs: Resolves all SDTs, including text modules, in the Word document, retaining only their contents.
- Removing placeholder styles: Removes placeholder styles from fields that only have this style and applying the style defined by the Word content instead.

Note: Empty fields will be replaced with their names if the document is a template or a linked text module; otherwise, they will be resolved.

void FSCPOI@1.1001:PatchFieldsAndSdts(
ref content docx,
optional WordPatchOptions wordpatchoptions)

Name	Description
docx	The Microsoft Word document content
wordpatchoptions	A structure object of type `WordPatchOptions` that defines the options for patching fields and SDTs

COOWF@1.1:PrescribeObject

Adds following activities to the process of the current activity. If this action is called on an object, a new process is started.

ProcessInstance COOWF@1.1:PrescribeObject(
  optional integer handle,
  optional integer index,
  ref optional WorkFlowPrescriptionList[] prescription,
  optional boolean prescrparallel,
  optional object prescrback,
  optional string remark,
  optional boolean remarkdefined,
  optional datetime receivedat,
  optional datetime startedat,
  optional datetime completedat,
  ref optional WorkFlowPrescriptionBlockList[] prescrblocks,
  optional boolean notcomplete,
  optional object[] additionalobjects,
  optional object[] concernedobjects,
  optional string processname,
  optional WorkFlowDiagram processdiagram,
  optional boolean delayedprocessstart,
  optional string adhocprocesskey,
  out retval ProcessInstance procinst,
  optional WorkFlowParticipantMapping[] partmapping,
  optional boolean expandsubprocesses,
  optional dictionary processparams,
  optional string procinstcommonid)

Name	Description
handle	unused deprecated
index	unused deprecated
prescription	the prescription list contains the following activities and participants
prescrparallel	defines if following activities defined in parameter prescription will be added parallel
prescrback	this activity will be added after the inserted activity instances.
remark	the entered remark will be stored to the current activity instance.
remarkdefined	determines if a remark is supplied
receivedat	the time stamp when the current activity was received. Only important for manual activities!
startedat	the time stamp when the current activity was started Only important for manual activities!
completedat	the time stamp when the current activity was completed Only important for manual activities!
prescrblocks	the prescription blocks contains the following activities and participants
notcomplete	internal: is used for integrity checks if the current activity was already completed
additionalobjects	when creating a new process this objects will be added to `COOWF@1.1:procinstobjects`
concernedobjects	the objects which are dependent for the prescription
processname	the name of the newly created process
processdiagram	the supplied diagram initiates the process on the current object
delayedprocessstart	the process is not started immediately
adhocprocesskey	the key for the ad hoc process. This parameter is for internal reasons and should not be set.
procinst	the process instance where the ad hoc elements were inserted to
partmapping	the supplied mapping is used to replace the participants defined in the process diagram when the activities are created.
expandsubprocesses	If set to `True`, all subprocesses contained in the supplied process diagram are expanded directly when the process is started
processparams	if defined the process parameters are merged into the process parameters of the process diagram
procinstcommonid	if defined the identification is stored in property `procinstcommonid` for newly created processes. This identification is used to allow to combine commonly started process instances

Additional Information

Prototype: MenuActionPrototype

COOSYSTEM@1.1:Print

Processes a format string or prints the object to a resulting string.
If the first parameter contains a non empty format string, this is used regardless of the object of the action.
If the object is a String object, the property string is used as format string.
If the object is a ErrorMessage object, the property errtext is used as format string.
In all other cases the name of the object is used as format string.
If the string contains patterns starting with "%" these are replaced by the additional parameters of the Print() action.
The syntax for patterns is %[order$][flags][width][.precision][length]specifier

specifier description
c Character
d or i Signed decimal integer
e Scientific notation (mantise/exponent) using e character
E Scientific notation (mantise/exponent) using E character
f Decimal floating point
g Use the shorter of %e or %f
G Use the shorter of %E or %f
o Signed octal
s String of characters
u Unsigned decimal integer
x Unsigned hexadecimal integer
X Unsigned hexadecimal integer (capital letters)
% A % followed by another % character will write % to the string

order$ description
order is the number of the original argument position

flags description
- Left-justify within the given field width; Right justification is the default (see width).
+ Forces to preceed the result with a plus or minus sign (+ or -) even for positive numbers. By default, only negative numbers are preceded with a - sign.
(space) If no sign is going to be written, a blank space is inserted before the value.
# Used with o, x or X specifiers the value is preceeded with 0, 0x or 0X respectively for values different than zero. Used with e, E and f, it forces the written output to contain a decimal point even if no digits would follow. By default, if no digits follow, no decimal point is written. Used with g or G the result is the same as with e or E but trailing zeros are not removed.
0 Left-pads the number with zeroes (0) instead of spaces, where padding is specified (see width sub-specifier).

width description
(number) Minimum number of characters to be printed. If the value to be printed is shorter than this number, the result is padded with blank spaces. The value is not truncated even if the result is larger.
* The width is not specified in the format string, but as an additional integer value argument preceding the argument that has to be formatted.

.precision description
.number For integer specifiers (d, i, o, u, x, X): precision specifies the minimum number of digits to be written. If the value to be written is shorter than this number, the result is padded with leading zeros. The value is not truncated even if the result is longer. A precision of 0 means that no character is written for the value 0.
For e, E and f specifiers: this is the number of digits to be printed after the decimal point.
For g and G specifiers: This is the maximum number of significant digits to be printed.
For s: this is the maximum number of characters to be printed. By default all characters are printed until the ending null character is encountered.
For c: it has no effect.
When no precision is specified, the default is 1. If the period is specified without an explicit value for precision, 0 is assumed.
.* The precision is not specified in the format string, but as an additional integer value argument preceding the argument that has to be formatted.

length description
h The argument is interpreted as a short int or unsigned short int (only applies to integer specifiers: i, d, o, u, x and X).
l The argument is interpreted as a long int or unsigned long int for integer specifiers (i, d, o, u, x and X), and as a wide character or wide character string for specifiers c and s.
q The argument is interpreted as a long long int or unsigned long long int (only applies to integer specifiers: i, d, o, u, x and X).

string COOSYSTEM@1.1:Print(
ref retval string string)

Name	Description
string	On input this parameter specified the optional format string, on output it contains the resulting string.

COOSYSTEM@1.1:PrintEx

Uses Print() to print a format string or an object to a resulting string. Parameters for formatting are passed in a string list in the parameter arguments

string COOSYSTEM@1.1:PrintEx(
ref retval string string,
string[] arguments)

Name	Description
string	On input this parameter specified the optional format string, on output it contains the resulting string
arguments	All arguments for printing the object to a string. Each line in the string list is evaluated as an expression. The object the PrintEx() method is called on is the local scope.

FSCEXPEXT@1.1001:QPEncode

Encodes a given string in quoted printable.

string FSCEXPEXT@1.1001:QPEncode(
string string,
out retval string qpstring)

Name	Description
string	the given string
qpstring	the quoted printable encoded string

COOSYSTEM@1.1:RaiseError

Raises an error and allows formatting for error text. For formatting options see Print. This action always terminates with an error: either with a regular error that occures during method processing or with the error specified in the first parameter.

void COOSYSTEM@1.1:RaiseError(
ErrorMessage error)

Name	Description
error	Error message object. The property `errtext` is used as the format string.

FSCEXPEXT@1.1001:RaiseError

Raises an error.

void FSCEXPEXT@1.1001:RaiseError(
  ErrorMessage errormessage,
  optional string str1,
  optional string str2,
  optional string str3,
  optional string str4,
  optional string str5)

Name	Description
errormessage	the error message object
str1	optional parameter for the error message
str2	optional parameter for the error message
str3	optional parameter for the error message
str4	optional parameter for the error message
str5	optional parameter for the error message

FSCNOTIFICATION@1.1001:ReCalculateNotifications

Recalculates the follow-ups for the current object base on the category of the object.

void FSCNOTIFICATION@1.1001:ReCalculateNotifications()

FSCEXPEXT@1.1001:RegexCapture

Captures matching strings in a string using a regular expression.

string[] FSCEXPEXT@1.1001:RegexCapture(
  string source,
  string pattern,
  optional string flags,
  out retval string[] result)

Name	Description
source	input string
pattern	regex pattern
flags	regex flags. If no flag is supplied (i.e. the string is empty or not specified), the flag "g" is used as default.
result	resulting strings

FSCEXPEXT@1.1001:RegexCaptureEx

Captures matches (full match and matching groups) in a string using a regular expression.
Named capture groups are returned, whenever a named capture group exists. See the example below.

Example Numbered Capture Groups

// Use the flag "g" to enable multiple captures.
coouser.RegexCaptureEx("ID-01-ABC, ID-02-", "(ID-[0-9]*)-([A-Z]*)", "g");
// returns
[ { match : "ID-01-ABC", group1 : "ID-01", group2 : "ABC" },
  { match : "ID-02-",    group1 : "ID-02", group2 : "" }
];

Example Named Capture Groups

// Use the flag "g" to enable multiple captures and the flag "J" to enable duplicate group names.
coouser.RegexCaptureEx("ID-01-ABC, ID-02-Z", "(?<Id>ID-(?<IdSeg>[0-9]*)-(?<IdSeg>[A-Z]*))", "Jg");
// returns
[ { Id : "ID-01-ABC", IdSeg : ["01", "ABC"] },
  { Id : "ID-02-Z",   IdSeg : ["02", "Z"] },
];

dictionary[] FSCEXPEXT@1.1001:RegexCaptureEx(
  string source,
  string pattern,
  optional string flags,
  out retval dictionary[] result)

Name	Description
source	input string
pattern	regex pattern
flags	regex flags. No flags are added by default. See examples for the use of the flag "g" or "J".
result	resulting matches

FSCEXPEXT@1.1001:RegexMatch

Checks for matches in a string using a regular expression. This action does not provide the matching strings, only a boolean result. If the matching strings itself are needed, use FSCEXPREX@1.1001:RegexCapture.

boolean FSCEXPEXT@1.1001:RegexMatch(
  string source,
  string pattern,
  optional string flags,
  out retval boolean result)

Name	Description
source	input string
pattern	regex pattern
flags	regex flags. If no flag is supplied (i.e. the string is empty or not specified), the flag "g" is used as default.
result	`true` if the regex matches

FSCEXPEXT@1.1001:RegexReplace

Manipulates a string using a regular expression.

string FSCEXPEXT@1.1001:RegexReplace(
  string source,
  string pattern,
  optional string flags,
  string replacement,
  out retval string result)

Name	Description
source	input string
pattern	regex pattern
flags	regex flags. If no flag is supplied (i.e. the string is empty or not specified), the flag "g" is used as default.
replacement	replacement string
result	resulting string

COOTC@1.1001:ReleaseTemplate

Action to release a template. A released template can be instantiated.

object COOTC@1.1001:ReleaseTemplate(
  out retval object releasedtemplate,
  optional boolean keepoldrelease,
  optional dictionary additionalsettings)

Name	Description
releasedtemplate	the released template
keepoldrelease	in case of newly created released template the old release is not deleted
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to release sub templates

FSCPDFGEN@1.1001:RemovePDFRestrictions

Removes PDF document restrictions from the document to make it editable (Does not remove user passwords, only owner passwords).

void FSCPDFGEN@1.1001:RemovePDFRestrictions(
ref content pdf)

Name	Description
pdf	The PDF document

FSCFOLIO@1.1001:ReopenObject

This action is used to reopen an object, which means that objfinalform is set to false for any object. After the object was reopened a new version is created.

For business relevant objects bostate and objdocstate are set to their previous states, objclosedby and boclosedat are cleared.

For non business relevant objects the properties bostate, boclosedat and objdocstate can be explicitly cleared by use of the parameter removestateclosed.

void FSCFOLIO@1.1001:ReopenObject(
optional boolean clearfinalformcontent,
optional boolean removestateclosed)

Name	Description
clearfinalformcontent	if set to `false`, the objects current final form content stored in `contentfinalform` will not be cleared (default: `true`)
removestateclosed	if set to `true` and the object is not business relevant, the properties `bostate`, `objclosedby` and `boclosedat` will also be cleared (default: `false`; this has no effect on business relevant objects)

FSCPOI@1.1001:ResolveAllAlternateContents

Resolves all AlternateContents from the document. Replaces all mc:AlternateContent Tags with their inner w:pict Tags Note: Fields will not be updated automatically when processing the content

void FSCPOI@1.1001:ResolveAllAlternateContents(
ref content docx)

Name	Description
docx	The Microsoft Word content

FSCPOI@1.1001:ResolveFieldsAndSdts

Resolves all Fields and SDTs from the document. Empty fields will be replaced with their names if the document is a template or a linked text module; otherwise, they will be resolved.

This method is obsolete since version 24.10.0; please use PatchFieldsAndSdts instead.

void FSCPOI@1.1001:ResolveFieldsAndSdts(
  ref content docx,
  optional boolean resolvefields,
  optional boolean resolvesdts,
  optional string[] customfieldinstructions)

Name	Description
docx	The Microsoft Word content
resolvefields	Set to resolve Fields
resolvesdts	Set to resolve SDTs
customfieldinstructions	Fields which should be resolved (default will be overwritten)

COOTC@1.1001:RevokeReleasedTemplate

Marks an released template as no longer released, so the template can no longer be instantiated.

void COOTC@1.1001:RevokeReleasedTemplate(
optional dictionary additionalsettings)

Name	Description
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to withdraw release of sub templates

FSCEXPEXT@1.1001:RGB2HexColor

Converts a color code in RGB to its representation as hex triplet.

string FSCEXPEXT@1.1001:RGB2HexColor(
  integer red,
  integer green,
  integer blue,
  ref retval string hexcolor)

Name	Description
red	the red value (0 - 255)
green	the green value (0 - 255)
blue	the blue value (0 - 255)
hexcolor

FSCEXPEXT@1.1001:Round

Rounds a currency or a floating point number.

any FSCEXPEXT@1.1001:Round(
ref retval any number,
optional integer fractions)

Name	Description
number	the number (currency, float or string)
fractions	the number of fractions (zero if omitted)

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	the text will be used as header title of the email.
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.

COOSYSTEM@1.1:SetContentParsing

Sets the parsing of content properties to on or off.

void COOSYSTEM@1.1:SetContentParsing(
ref optional content[] contents,
optional boolean on)

Name	Description
contents	If specified, only set the parsing of these contents to on or off.
on	If specified and `true`, set the parsing of content properties to on. Otherwise set the parsing of content properties to off.

FSCPDFGEN@1.1001:SetDocMetadata

Sets PDF metadata (title, author, subject, ...)

New metadata, will be set from dictionary keys. Already existing metadata, will be overwritten by dictionary keys. If dictionary keys are null, metadata will be deleted.

void FSCPDFGEN@1.1001:SetDocMetadata(
ref content pdf,
dictionary metadata)

Name	Description
pdf	The PDF content which should be changed.
metadata	Key/Value dictionary with metadata entries (title, author, subject, ...)

FSCFOLIO@1.1001:SetDocState

Set the document state for the current object and propagate the document state to the depending objects

void FSCFOLIO@1.1001:SetDocState(
  DocState state,
  optional boolean inherited,
  optional boolean skippropagation)

Name	Description
state	the document state which is set to the object
inherited	the document state was explicitly applied to the object or inherited from a parent object
skippropagation	the document statate will be only changed on the current object and not be propagated to the depending objects

FSCUSERFORMS@1.1001:SetFieldValue

Sets a field value

void FSCUSERFORMS@1.1001:SetFieldValue(
string reference,
any[] value)

Name	Description
reference	the (base) reference of the field
value	the value

COODESK@1.1:SetSelectionContext

Sets the selection context which is used subsequently to determine the current container, the current list, or the currently selected objects. A SelectionContext passed in selectioncontext has precedence over the values in container, view, and selectedobjects. If no container is passed in container or selectioncontext.selcontainer, the current object will be used as container.

void COODESK@1.1:SetSelectionContext(
  optional object container,
  optional object view,
  optional object[] selectedobjects,
  optional SelectionContext selectioncontext)

Name	Description
container	The object that contains the view and optionally selected objects.
view	The current view (in general an object pointer property with multiple values of the container).
selectedobjects	The currently selected objects.
selectioncontext	The whole selection context as a structure.

COOATTREDIT@1.1:Sort

Object::Sort ("Sort List of Values") sorts the specified value list in the specified order.

any COOATTREDIT@1.1:Sort(
  ref retval any valuelist,
  optional boolean ascending,
  optional object[] attrpath,
  optional boolean nullismax,
  out optional integer[] mapping,
  optional boolean stringcomparenatural)

Name	Description
valuelist	The list of values to be sorted. After the method call it contains the sorted list of values.
ascending	Optional. `true` means ascending sort order, `false` means descending sort order. If this parameter is omitted `true` is used.
attrpath	Optional. The value list of this property is sorted.
nullismax	Optional. Null is greater than other values.
mapping	Optional. The mapping used for sorting.
stringcomparenatural	Optional. Use natural sort order (eg. "Dossier 2.3" comes before "Dossier 12.2")

FSCPDFGEN@1.1001:SplitPDF

Splits a PDF document into its pages

void FSCPDFGEN@1.1001:SplitPDF(
content pdf,
out content[] pages)

Name	Description
pdf	The PDF document.
pages	A list of PDF documents, each containing a page of the original PDF document.

FSCPOI@1.1001:SplitPowerPoint

Splits a Microsoft PowerPoint content to several slides. Note: Fields will not be updated automatically when processing the content

void FSCPOI@1.1001:SplitPowerPoint(
  ref content pptx,
  out content master,
  out Slide[] slides)

Name	Description
pptx	The Microsoft PowerPoint content
master	The master of the Microsoft PowerPoint slide show
slides	The Microsoft PowerPoint slides

COOWF@1.1:StartProcessDiagram

This action is used to start the designed process of a released workflow diagram for the current object. The supplied workflow diagram must be released and executable for the current object.

ProcessInstance COOWF@1.1:StartProcessDiagram(
  WorkFlowDiagram diagram,
  optional boolean silent,
  out retval ProcessInstance procinst,
  optional WorkFlowParticipantMapping[] partmapping,
  optional boolean expandsub,
  optional dictionary processparams,
  optional boolean considereroomcontext,
  optional string procinstcommonid)

Name	Description
diagram	the released version of the supplied diagram which fits to the current user will be initialized for the current object
silent	do not raise errors if the diagram can not be started for the current object
procinst	the created process instance
partmapping	the supplied mapping is used to replace the participants defined in the process diagram when the activities are created.
expandsub	If set to `True`, all subprocesses contained in the supplied process diagram are expanded directly when the process is started
processparams	if defined the process parameters are merged into the process parameters of the process diagram
considereroomcontext	if set the room restrictions will be considered when calculating diagrams
procinstcommonid	if defined the identification is stored in property `procinstcommonid` for newly created processes. This identification is used to allow to combine commonly started process instances

FSCEXPEXT@1.1001:StringReplace

Replaces a given string within another string.

string FSCEXPEXT@1.1001:StringReplace(
  ref retval string value,
  string[] patternlist,
  string replacement)

Name	Description
value	the given string
patternlist	the list of patterns
replacement	the string used as replacement

COODESK@1.1:ThrowWarning

Throw warning

void COODESK@1.1:ThrowWarning(
integer errornumber)

Name	Description
errornumber	Identifier for the specific error or warning

FSCEXPEXT@1.1001:Tokenize

Tokenizes the given string using separator characters. Strings enclosed in single or double quotes are kept as single tokens. A backslash is considered as the escape character.

string[] FSCEXPEXT@1.1001:Tokenize(
  string str,
  optional string separator,
  out retval string[] tokens)

Name	Description
str	the string to be tokenized
separator	the separator characters used to tokenize. If `null`, all white space characters are assumed
tokens	the list of extracted tokens

FSCEXPEXT@1.1001:TokenizeCSVFile

Tokenizes the given string representing a CSV file to the lines of the file.

string[] FSCEXPEXT@1.1001:TokenizeCSVFile(
  string str,
  string nullrep,
  out retval string[] lines)

Name	Description
str	the string representing the CSV file
nullrep	the string used in `lines` to represent an empty line from `str` (`null` cannot be an array element)
lines	the list of extracted lines of the CSV file

FSCEXPEXT@1.1001:TokenizeCSVLine

Tokenizes the given string representing a CSV line to the cell values of the line.

string[] FSCEXPEXT@1.1001:TokenizeCSVLine(
  string str,
  string nullrep,
  out retval string[] cells)

Name	Description
str	the string representing the CSV line
nullrep	the string used in `cells` to represent an empty cell from `str` (`null` cannot be an array element)
cells	the list of extracted cell values of the CSV line

FSCEXPEXT@1.1001:Trace

Custom trace for string with optional value If the call of object.GetTraceContext returns a trace context object, a trace entry is generated.

void FSCEXPEXT@1.1001:Trace(
string text,
optional any value)

Name	Description
text	get trace lines for this object
value	optional value or value list

FSCEXPEXT@1.1001:TraceValue

Traces the value.

void FSCEXPEXT@1.1001:TraceValue(
optional any value)

Name	Description
value	the value

FSCABBYY@1.1001:TranslateOCRStatus

Translates an ABBYY Cloud OCR status in string format to an OCRStatus.

OCRStatus FSCABBYY@1.1001:TranslateOCRStatus(
string status,
out retval OCRStatus ocrstatus)

Name	Description
status	ABBYY Cloud OCR status (see https://www.ocrsdk.com/documentation/specifications/task-statuses)
ocrstatus	Internal OCR status

FSCEXPEXT@1.1001:UnEscape

Unescapes the characters backslash, single quote and double quote in the given string and unquote if specified. A backslash is considered as the escape character.

string FSCEXPEXT@1.1001:UnEscape(
ref retval string str,
optional string quote)

Name	Description
str	the string to be unescaped
quote	the character to be used for unquoting. Must be a single quote or a double quote.

FSCEXPEXT@1.1001:UnEscapeHTML

Unescapes the string used in html tags

string FSCEXPEXT@1.1001:UnEscapeHTML(
ref retval string str)

Name	Description
str	the string to be unescaped

FSCEXPEXT@1.1001:UnEscapeXML

Unescapes the string used in xml tags

string FSCEXPEXT@1.1001:UnEscapeXML(
ref retval string str)

Name	Description
str	the string to be unescaped

FSCPOI@1.1001:UpdateDocument

Updates a Microsoft Word document.

void FSCPOI@1.1001:UpdateDocument(
  ref content docx,
  SearchReplaceToken[] searchreplacetokens,
  TableData[] tabledata,
  PictureData[] picturedata)

Name	Description
docx	The Microsoft Word content
searchreplacetokens	Keywords for search and replace
tabledata	Table data for update or creation
picturedata	Picture data for update

COOWF@1.1:UpdateProcessParticipant

Is used to delegate activities of the current object using the abstract participant


WFMP_OBJPROPERTY

or WFMP_OBJPROPROLE or WFMP_PARENTPROPERTY or WFMP_CONTEXTPROPERTY or WFMP_PARENTPROPROLE or


WFMP_CONTEXTPROPROLE

to a new participant.
Only activities are considered that are displayed in the worklist and where the property of the participant is matching the parameter attrdef. The delegation is performed by calling the action SetDelegated.

void COOWF@1.1:UpdateProcessParticipant(
AttributeDefinition attrdef,
WorkFlowMetaParticipant[] requestedmetaparticipants)

Name	Description
attrdef	defines the attribute definition from which the participant is read (see also `wfpattribute`)
requestedmetaparticipants	the new participants (see also `WorkFlowMetaParticipant`)

FSCEXPEXT@1.1001:URLDecode

Decodes a URL encoded string.

string FSCEXPEXT@1.1001:URLDecode(
string encodedurl,
out retval string url)

Name	Description
encodedurl	the URL encoded string
url	the decoded string

FSCEXPEXT@1.1001:URLEncode

Encodes a string URL style.

string FSCEXPEXT@1.1001:URLEncode(
  string url,
  out retval string encodedurl,
  optional integer targetcharset)

Name	Description
url	the unencoded string
encodedurl	the URL encoded string
targetcharset	optional the character set of the result (before encoding)

FSCEXPEXT@1.1001:Value2JSON

Converts a value to a JSON string. Using the parameter formats, the output can be specified in detail.

string FSCEXPEXT@1.1001:Value2JSON(
  any value,
  out retval string json,
  optional boolean fullrefs,
  optional JSONStructFormat[] formats)

Name	Description
value	any value that should be converted to a JSON value
json	the JSON string
fullrefs	if `true` full references in underscore notation are used for JSON identifiers
formats	list of formatting information for structured types (see `JSONStructFormat`). Errors on reading properties are only raised for object classes or aggregate types passed with this parameter

FSCEXPEXT@1.1001:Value2JSONContent

Converts a value to a JSON content.

content FSCEXPEXT@1.1001:Value2JSONContent(
  any value,
  out retval content jsoncont,
  out optional string json,
  optional boolean fullrefs,
  optional JSONStructFormat[] formats)

Name	Description
value	any value that should be converted to a JSON value
jsoncont	the JSON content
json	the JSON string
fullrefs	if `true` full references in underscore notation are used for JSON identifiers
formats	list of formatting information for structured types (see `JSONStructFormat`). Errors on reading properties are only raised for object classes or aggregate types passed with this parameter

FSCEXPEXT@1.1001:Value2XML

Converts a value to an XML string. The XML string contains a node "data" that contains the representation of the value.
If omitsurroundingnode is true no additional node "data" is generated.
The value is stored in XML nodes. If the value is a dictionary or an aggregate, all the members of those values are converted recursively.
It is also possible to add XML attributes to an XML node if a dictionary is converted. For each key (i.e. "key") in a dictionary the content of a key with the same name and the character "@" as prefix (i.e. "@key") is treated as a dictionary containing the XML attributes. If the key is a list then the entry for the XML attributes should be a list, too.

sample string value: coouser.Value2XML("test")
resulting XML string:

<data>
  <value>test</value>
</data>

sample dictionary value:

dictionary dict = {
  key1: "value1",
  key2: "value2"
}
coouser.Value2XML(dict)

resulting XML string:

<data>
  <key1>value1</key1>
  <key2>value2</key2>
</data>

sample object value in a dictionary:

dictionary dict = {
  user: coouser
}
coouser.Value2XML(dict)

resulting XML string:

<data>
  <user>
    <objname>...</objname>
    <objaddress>...</objaddress>
  </user>
</data>

sample XML attribute:

dictionary dict = {
  node: { key: "value" }
}
dict.SetEntry("@node", { id: "attrval" });
coouser.Value2XML(dict);

resulting XML string:

<data>
  <node id="attrval">
    <key>value</key>
  </node>
</data>

string FSCEXPEXT@1.1001:Value2XML(
  any value,
  out retval string xml,
  optional boolean enrich,
  optional boolean fullrefs,
  optional boolean omitsurroundingnode)

Name

Description

value

any value that should be converted to an XML string

xml

the XML string

enrich

if true values are enriched with the following XML attributes:

`enums`
id	the integer value of the enum value
`aggregates`
id	an internally generated unique id of the aggregate
display	the display string of the aggregate value if the attribute definition of that aggregate has a display action
`dictionaries`
id	an internally generated unique id of the dictionary
`objects`
id	the address of the object (`objaddress`)

If user-defined XML attributes are specified, the generation of the XML attributes listed above is suppressed.
If the value is a list (i.e. a list of aggregates) and the attribute definition of that value has a display action, then a single XML node with is generated with the display XML attribute containing the display value for the whole list. Each entry in the list is generated as a child XML node with the name "entry" containing the individual values of the list entries.
For enum values the text of the XML node is the value of typeenumtext in the appropriate language of the caller.
For object values the text of the XML node is the value of objname, so no child XML nodes are generated as it would be the case if enrich is not specified.

fullrefs

if true full references in underscore notation are used for names of XML nodes.

omitsurroundingnode

if true no additional node "data" is generated.

FSCEXPEXT@1.1001:XML2Value

Converts an XML content or string to a value (hierarchical dictionary containing string values).

any FSCEXPEXT@1.1001:XML2Value(
  any xml,
  out retval any value,
  optional boolean keepnamespaceprefixes,
  optional boolean version2)

Name	Description
xml	the XML as content or string
value	the dictionary
keepnamespaceprefixes	if `true` namespace prefixes are kept in dictionary identifiers
version2	use new dictionary format

FSCEXPEXT@1.1001:Zip2Dict

Creates a dictionary from a zip archive. The implementation supports 7z, Microsoft Cabinet and the PKWARE ZIP format.

Keys are constructed from directory entries
Directories are mapped to dictionaries
Files are mapped to Content with contcontent, contextension and COOSYSTEM@1.1:contchangedat

dictionary FSCEXPEXT@1.1001:Zip2Dict(
Content zip,
out retval dictionary dict)

Name	Description
zip	the zip archive
dict	the resulting dictionary, containing of sub dictionaries or entries of type `Content`