Class COOSYSTEM@1.1:ContentObject

Class Hierarchy

This abstract class is the base class for objects with multimedia contents (e.g. documents, spreadsheets, images, sound recordings, video sequences. etc.). The classes derived from ContentObject must have the object class ContentObjectClass.

Additional Information

Commonly usable

Properties

Type	Property	Name
Addressee[]	addressee	Addressees
Object[]	assignedreferences	Assigned References
integer	boremarkamount	Amount of Remarks
content	boremarks	Remarks
string	boshortform	Short Form
content	boviewremarks	Remarks
Content	content	File
Document	contentdoc	Document
integer	contentnumber	Number
ContentObject	contenttranslationof	Translation of
ContentObject[]	contenttranslationsobjects	Translations
string	documentnumber	Document Number
integer	documentyear	Year
Object[]	linkedtextmodules	Text Modules
ActivityInstance[]	objabortedpastactivities	Completed Activities of Aborted and Suspended Processes
ActivityInstance[]	objactivepastactivities	Completed Activities
ActivityInstance[]	objallactiveactivities	All Activities of Running or Completed Processes
ActivityInstance[]	objallactivities	All Activities of All Processes
ActivityInstance[]	objcurrentactivities	Current Activities in the Worklist of the Current User
ActivityInstance[]	objfutureactivities	Planned Activities
ActivityInstance[]	objpastactivities	All Completed Activities
PersonnelFileFolder	objpersfilefolder	Personnel File Folder
ActivityInstance[]	objrunningactivities	Current Activities
User[]	objrunningactivitiesusers	Users With Current Activities
ProcessInstance[]	objsuspendedproclist	Suspended Processes
ProcessInstance[]	objterminatedproclist	Terminated Processes
OCRInformation	ocrinformation	OCR Status
BusinessObject	record	Record
Object[]	references	References
Outgoing	replytoincoming	Reply
ProcessInstance[]	workflow	Processes

Actions

Return Type	Signature
boolean	CanChangeProcessState( ProcessInstance procinst, ref retval boolean statechangeable)
void	CloseDocumentSecured()
Content	ConvertContentToFinalForm( optional object context, optional string format, out retval Content contentfinalform)
void	DoCancelFileObject( object parent, object view, optional boolean issublevel)
boolean	EnableRegistrationUC( AttributeDefinition exprattrdef, optional IncomingComponentCategory checkcat, out retval boolean enable)
void	EvaluateGenericNameBuild( optional boolean force)
ApplicantFile	GetApplicantFile( out retval ApplicantFile applicantfile)
BusinessCase	GetBusinessCase( out retval BusinessCase businesscase)
PersonnelFileShelf	GetFileShelf( out retval PersonnelFileShelf shelf)
IncomingComponentCategory	GetIncomingCategory( optional integer dynkey, optional boolean checkroom, out retval IncomingComponentCategory incat)
MBInSpireService	GetMBInSpireService( out retval MBInSpireService svc, optional object context)
object	GetObjectFile( optional boolean includeself, out retval object objfile)
PersonnelFile	GetPersonnelFile( out retval PersonnelFile personnelfile)
PersonnelFileDocument	GetPersonnelFileDocument( out retval PersonnelFileDocument document)
PersonnelFileFolder	GetPersonnelFileFolder( out retval PersonnelFileFolder folder)
object	GetReleasedTemplate( optional boolean checkreleased, out retval object releasedtemplate)
boolean	IsDraftTemplateTestable( out retval boolean istestable)
boolean	IsTemplateReleaseable( out retval boolean isreleaseable, out boolean requirereleasedversion)
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)
void	ObjectReleaseVersion( datetime versdate)
void	RequestOCR( optional content sourcecontent, optional string ocrlanguage, optional boolean noautoupdate)
OCRInformation	RetrieveOCRStatus( string taskid, out retval OCRInformation ocrinformation)
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)
content	UpdateOCRStatus( optional boolean returncontent, out optional retval content targetcontent)

Properties

Addressees (FSCFOLIO@1.1001:addressee)

Addressee[] FSCFOLIO@1.1001:addressee

Assigned References (FSCFOLIO@1.1001:assignedreferences)

unique Object[] FSCFOLIO@1.1001:assignedreferences readonly(ui) invisible

Additional Information

Access Types for Changing Property: AccTypeRead
Describes Child Relationship
Object Classes Allowed: ContentObject, URLObject
Property for Back Link: referencedby

Amount of Remarks (FSCFOLIO@1.1001:boremarkamount)

unsigned integer FSCFOLIO@1.1001:boremarkamount readonly invisible

Additional Information

Access Types for Changing Property: AccTypeRead

Remarks (FSCFOLIO@1.1001:boremarks)

content FSCFOLIO@1.1001:boremarks readonly

Additional Information

Access Types for Changing Property: AccTypeRead

Short Form (FSCFOLIO@1.1001:boshortform)

string FSCFOLIO@1.1001:boshortform not null

Remarks (FSCFOLIO@1.1001:boviewremarks)

content FSCFOLIO@1.1001:boviewremarks readonly volatile

File (COOSYSTEM@1.1:content)

Defines the multimedia content of the object and information like the size of the content or the date of the last change.

Content COOSYSTEM@1.1:content

Additional Information

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

Document (FSCFOLIO@1.1001:contentdoc)

Document FSCFOLIO@1.1001:contentdoc

Additional Information

Object Classes Allowed: Document

Number (FSCFOLIO@1.1001:contentnumber)

integer FSCFOLIO@1.1001:contentnumber readonly(ui) invisible

Translation of (COOTC@1.1001:contenttranslationof)

The current document is a translation for this object

ContentObject COOTC@1.1001:contenttranslationof readonly

Additional Information

Property for Back Link: contenttranslationsobjects

Translations (COOTC@1.1001:contenttranslationsobjects)

List of translation objects for the current document

unique ContentObject[] COOTC@1.1001:contenttranslationsobjects readonly

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship
Property for Back Link: contenttranslationof

Document Number (FSCFOLIO@1.1001:documentnumber)

string FSCFOLIO@1.1001:documentnumber readonly(ui)

Year (FSCFOLIO@1.1001:documentyear)

unsigned integer FSCFOLIO@1.1001:documentyear

Text Modules (COOTC@1.1001:linkedtextmodules)

List of text modules that have been inserted in the document as placeholders.

unique Object[] COOTC@1.1001:linkedtextmodules readonly

Completed Activities of Aborted and Suspended Processes (COOWF@1.1:objabortedpastactivities)

Contains all completed activities of aborted or suspended (PROCINST_TERMINATED, PROCINST_SUSPENDED) processes.

ActivityInstance[] COOWF@1.1:objabortedpastactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

Completed Activities (COOWF@1.1:objactivepastactivities)

Contains completed activities of active/completed processes.

ActivityInstance[] COOWF@1.1:objactivepastactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

All Activities of Running or Completed Processes (COOWF@1.1:objallactiveactivities)

Contains all activities of all active and completed (PROCINST_INPROGRESS, PROCINST_COMPLETED) processes.

ActivityInstance[] COOWF@1.1:objallactiveactivities readonly volatile invisible

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

All Activities of All Processes (COOWF@1.1:objallactivities)

Contains all activities of all processes (Also from aborted or suspended processes).

ActivityInstance[] COOWF@1.1:objallactivities readonly volatile invisible

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

Current Activities in the Worklist of the Current User (COOWF@1.1:objcurrentactivities)

Contains all current activities in the worklist of the current user.

ActivityInstance[] COOWF@1.1:objcurrentactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

Planned Activities (COOWF@1.1:objfutureactivities)

Contains all future activities.

ActivityInstance[] COOWF@1.1:objfutureactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

All Completed Activities (COOWF@1.1:objpastactivities)

Contains completed activities of all processes (also activities from aborted or suspended processes).

ActivityInstance[] COOWF@1.1:objpastactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

Personnel File Folder (FSCPERSONNELFILE@1.1001:objpersfilefolder)

PersonnelFileFolder FSCPERSONNELFILE@1.1001:objpersfilefolder readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeComp, AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadComp
Object Classes Allowed: PersonnelFileFolder

Current Activities (COOWF@1.1:objrunningactivities)

Contains all running activities.

ActivityInstance[] COOWF@1.1:objrunningactivities readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

Users With Current Activities (COOWF@1.1:objrunningactivitiesusers)

Contains all participants of the current activities.

User[] COOWF@1.1:objrunningactivitiesusers readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: User

Suspended Processes (COOWF@1.1:objsuspendedproclist)

Contains all suspended processes.

ProcessInstance[] COOWF@1.1:objsuspendedproclist readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

Terminated Processes (COOWF@1.1:objterminatedproclist)

Contains all terminated processes.

ProcessInstance[] COOWF@1.1:objterminatedproclist readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadWorkFlow
Object Classes Allowed: ActivityInstance

OCR Status (FSCABBYY@1.1001:ocrinformation)

unique OCRInformation FSCABBYY@1.1001:ocrinformation readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeRead

Record (FSCFOLIO@1.1001:record)

BusinessObject FSCFOLIO@1.1001:record

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Object Classes Allowed: Record, Case

References (FSCFOLIO@1.1001:references)

unique Object[] FSCFOLIO@1.1001:references

Additional Information

Access Types for Changing Property: AccTypeRead
Object Classes Allowed: BasicObject, CompoundObject, ContentObject, URLObject, Folder

Reply (FSCFOLIO@1.1001:replytoincoming)

Outgoing FSCFOLIO@1.1001:replytoincoming readonly(ui)

Processes (COOWF@1.1:workflow)

This property is defined by software component Workflow, but not added to any object class by default. This property must be added to an object class to allow the user to assign a process definition, to initialize and modify process instances of an object of this class.

ProcessInstance[] COOWF@1.1:workflow readonly

Additional Information

Access Types for Changing Property: AccTypeChangeWorkFlow
Access Types for Reading Property: AccTypeReadWorkFlow

Actions

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

FSCPERSONNELFILE@1.1001:CloseDocumentSecured

Secured action to close a document.

void FSCPERSONNELFILE@1.1001:CloseDocumentSecured()

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

FSCFOLIO@1.1001:DoCancelFileObject

Action used to cancel a file object or a file itself

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

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

FSCFOLIO@1.1001:EnableRegistrationUC

Action to check if the registration usecase is enabled

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

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

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

FSCPERSONNELFILE@1.1001:GetApplicantFile

Retrieve the applicant file for the current object

ApplicantFile FSCPERSONNELFILE@1.1001:GetApplicantFile(
out retval ApplicantFile applicantfile)

Name	Description
applicantfile	the applicant file

FSCPERSONNELFILE@1.1001:GetBusinessCase

Retrieve the business case for the current object

BusinessCase FSCPERSONNELFILE@1.1001:GetBusinessCase(
out retval BusinessCase businesscase)

Name	Description
businesscase	the business case the objects is assigned to

FSCPERSONNELFILE@1.1001:GetFileShelf

Retrieve the personnel file shelf for the current object

PersonnelFileShelf FSCPERSONNELFILE@1.1001:GetFileShelf(
out retval PersonnelFileShelf shelf)

Name	Description
shelf	the personnel file shelf of the current object

FSCFOLIO@1.1001:GetIncomingCategory

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

Name	Description
dynkey
checkroom
incat

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

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

FSCPERSONNELFILE@1.1001:GetPersonnelFile

Calculate parent personnel file for any object in file

PersonnelFile FSCPERSONNELFILE@1.1001:GetPersonnelFile(
out retval PersonnelFile personnelfile)

Name	Description
personnelfile	the personnelfile

FSCPERSONNELFILE@1.1001:GetPersonnelFileDocument

Retrieve the personnel file document for the current object

PersonnelFileDocument FSCPERSONNELFILE@1.1001:GetPersonnelFileDocument(
out retval PersonnelFileDocument document)

Name	Description
document	the personnel file document the objects is assigned to

FSCPERSONNELFILE@1.1001:GetPersonnelFileFolder

Retrieve the personnel file folder for the current object

PersonnelFileFolder FSCPERSONNELFILE@1.1001:GetPersonnelFileFolder(
out retval PersonnelFileFolder folder)

Name	Description
folder	the Personnel File Folder the object is assigned to

COOTC@1.1001:GetReleasedTemplate

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

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

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

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

COOTC@1.1001:IsTemplateReleaseable

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

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

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

FSCFOLIO@1.1001:LogHistoryEvent

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

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)

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.

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.

FSCABBYY@1.1001:RequestOCR

Sends an OCR request to ABBYY Cloud OCR.

void FSCABBYY@1.1001:RequestOCR(
  optional content sourcecontent,
  optional string ocrlanguage,
  optional boolean noautoupdate)

Name	Description
sourcecontent	Content to be submitted. If no content is provided, the object's main content is submitted instead.
ocrlanguage	OCR language (see https://www.ocrsdk.com/documentation/specifications/recognition-languages)
noautoupdate	If `true`, no task should be automatically scheduled to update the OCR status

FSCABBYY@1.1001:RetrieveOCRStatus

Retrieves the current OCR status for an OCR task.

OCRInformation FSCABBYY@1.1001:RetrieveOCRStatus(
string taskid,
out retval OCRInformation ocrinformation)

Name	Description
taskid	Task id of the OCR task
ocrinformation	OCR status information retrieved from ABBYY Cloud OCR

FSCFOLIO@1.1001:SendBackgroundSecure

Sends an e-mail via SMTP to the given users. The body can be defined as plain text only. The mail will be sent as HTML. Sender is defined by the SMTP-Configuration.

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

Name	Description
to	List of objects (users, contacts) or a list of strings to which an e-mail should be sent.
cc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in CC
bcc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in BCC.
subject	A subject is essential for an e-mail to be able to be sent. A subject can be either a plain string or a string object. If a string object is passed as subject, the used language is based on the user communication language. If there is no subject passed, the name or address from the first attachment will be used instead.
body	The text for the e-mail. Can contain: STRING, STRINGLIST.
attachments	A list of attachment objects for which MX urls or public links are inserted into the e-mail.
usepubliclinks	Generate public links instead of MX urls.
downloadformat	Use this download format in case of public links.
errorlog	Error log containing send errors.
replytoaddress	Use this replyto e-mail address.
headertitle
fallbacklanguage	The fallback language is used when the email recipients are specified only by an email address, or when no communication language can be determined for an email recipient object.

FSCABBYY@1.1001:UpdateOCRStatus

Updates the OCR status information of an object and stores the result of the OCR task in the object's content or final form content.

content FSCABBYY@1.1001:UpdateOCRStatus(
optional boolean returncontent,
out optional retval content targetcontent)

Name	Description
returncontent	If `true`, the OCR result should be returned in `targetcontent`. If not specified or `false`, the OCR result is stored in the object's main content (content, if the object is a PDF object and the content is changeable) or in the object's final form content (contentfinalform, for other objects).
targetcontent	Content that contains the OCR result.