Class Hierarchy
Object
. It defines the
general properties and methods that each object has.
Type |
Property |
Name |
Average Score |
||
Processing State |
||
Canceled Objects |
||
Template Categories |
||
PDF Content is signable |
||
Last Signature |
||
Last Signature Type |
||
Last Signature on/at |
||
Last Signature by |
||
Remark of Last Signature |
||
Signature Folder of Last Signature |
||
ACL Object |
||
Referenced Object |
||
Current Released Version Date |
||
Last Version Change on/at |
||
Version Started on/at |
||
Version Number |
||
Address |
||
App Configuration |
||
Inbox |
||
Available Fields (File) |
||
Available Fields (Category) |
||
Available Fields (Current Document) |
||
Available Fields (Contained in) |
||
Canceled |
||
Canceled Files |
||
Container |
||
Category |
||
System Change Timestamp |
||
Last Change by |
||
Object Class |
||
Closed on/at |
||
Closed by |
||
Created on/at |
||
Created by |
||
Customizing Context |
||
Deleted |
||
Highlighting Color |
||
Document State |
||
Domain |
||
External ID |
||
File |
||
Container |
||
Final Form |
||
Font Effect |
||
Object Last Indexed (UTC) |
||
Vorerfasst |
||
Is Template |
||
Template Language |
||
Last Signature Folder |
||
State of Last Signature Folder |
||
Location |
||
Shared Usage |
||
Own Location |
||
Lock |
||
Locked Permanently |
||
Mindbreeze Categorization |
||
PDF Annotations (InstantJSON) |
||
Mindbreeze Categorization (JSON) |
||
Symbol |
||
Last Change on/at |
||
Name |
||
Owner |
||
Group |
||
Origin |
||
Version Really Created on/at |
||
Really Created on/at |
||
Really Created by |
||
Recorded |
||
Recorded Set on/at |
||
Target |
||
Contained in |
||
Released Version Date |
||
Replaced by |
||
Follow-Ups |
||
Retention Period |
||
Object Last Scanned for Viruses (UTC) |
||
Scan Queue |
||
Security Change Timestamp |
||
Security Level |
||
Signature Folders |
||
Source Object |
||
Subject |
||
Teamroom |
||
Template |
||
Template Revision Required |
||
Template Revision Required Since |
||
Template Revision Required Requested By |
||
Terms |
||
Files |
||
Contained in |
||
Current Document |
||
System Change Timestamp of Last User Change |
||
Valid From |
||
Valid Until |
||
Object Versions |
||
Days After Which Older Versions Are Automatically Deleted |
||
Maximum Number of Versions Kept |
||
No Automatic Deleting of Versions |
||
PDF Content (Screen Quality) |
||
PDF Content (Cache) |
||
PDF Content (OCR) |
||
PDF Content (Print Quality) |
||
PDF Metadata |
||
PDF Content (Optimized for Smartphones) |
||
Direct Supervisor |
||
Assigned User |
||
Supervisors |
||
Ratings |
||
Digital Signatures |
||
Signatures |
||
Manual Signatures |
||
Additional Restrictions |
||
Number of Ratings |
||
Score |
||
View Count |
||
Groups Participating in Workflow |
||
Groups Having Participated in Workflow |
||
Users Participating by Role in Workflow |
||
Users Having Participated in Workflow by Role |
||
Users Participating in Workflow |
||
Users Having Participated in Workflow |
||
Substitutes of Users Participating in Workflow |
||
Substitutes of Users Having Participated in Workflow |
Return Type |
Signature |
AllowChangeProcessState( |
|
AllowNavigateDraftRelease( |
|
AppendDoc( |
|
AppendDocArray( |
|
AttrProcessParticipantSet( |
|
Base64Decode( |
|
Base64Encode( |
|
CanBeUsedForSubProcessesOnly( |
|
CanChangeProcessState( |
|
CanReleaseTemplate( |
|
CanReplaceDocument( |
|
CheckLicense( |
|
CollectMailData( |
|
ConvertContentToFinalForm( |
|
ConvertDateToWorkDays( |
|
ConvertWorkDaysToDate( |
|
CreatePlainFromHTML( |
|
CreatePlainFromHTMLString( |
|
CreateResubmission( |
|
CreateUser( |
|
DelegateToChangedParticipant( |
|
Dict2Zip( |
|
DoCancelFileObject( |
|
EnableRegistrationUC( |
|
EscapeHTML( |
|
EvaluateGenericNameBuild( |
|
EvaluateTimeInterval( |
|
FileNameEncode( |
|
FindQRCode( |
|
Format( |
|
GenerateDocument( |
|
GenerateWorkbook( |
|
GetApplicantFile( |
|
GetAttributeDefinitionByReference( |
|
GetAttributeDefinitionByReferenceOrName( |
|
GetBusinessCase( |
|
GetChildren( |
|
GetContextConfiguration( |
|
GetContextDashboard( |
|
GetCurrentActivityInstances( |
|
GetCurrentView( |
|
GetDefaultNotificationTypes( |
|
GetDefaultStr( |
|
GetDocInfo( |
|
GetDocMetadata( |
|
GetDraftTemplate( |
|
GetFieldName( |
|
GetFieldValue( |
|
GetFileExtFromMIMEType( |
|
GetFileShelf( |
|
GetIncomingCategory( |
|
GetJobAdvertisement( |
|
GetJobApplications( |
|
GetLogo( |
|
GetMBInSpireService( |
|
GetMIMETypeFromFileExt( |
|
GetNextActivityInstances( |
|
GetNextInstanceElements( |
|
GetNotificationSettings( |
|
GetObjectFile( |
|
GetObjectRoom( |
|
GetOverviewWithQRCode( |
|
GetParent( |
|
GetParticipantListUsersGroups( |
|
GetPDFContentQRValues( |
|
GetPDFInfo( |
|
GetPersonnelFile( |
|
GetPersonnelFileByPersnum( |
|
GetPersonnelFileBySocialSecId( |
|
GetPersonnelFileDocument( |
|
GetPersonnelFileFolder( |
|
GetPersonnelFileShelfById( |
|
GetPublicLink( |
|
GetPushNotificationSettings( |
|
GetRandomNumber( |
|
GetRandomString( |
|
GetReleasedTemplate( |
|
GetResubmissions( |
|
GetSelected( |
|
GetSelectionContext( |
|
GetSizeStr( |
|
GetTeamFilter( |
|
GetTeamMembersSecured( |
|
GetUsableActivityDefinitions( |
|
GetUsableProcessDefinitions( |
|
HasNameBuild( |
|
HasPDFRestrictions( |
|
HasRoomChangeAccess( |
|
HasRoomChangeAllocationAccess( |
|
HasRoomChildChangeAccess( |
|
HasRoomCustomAssignmentAccess( |
|
HasRoomDeleteAccess( |
|
HasRoomFullControl( |
|
HasRoomReadAccess( |
|
HexColor2RGB( |
|
InitializeWorkFlow( |
|
InstantiateTemplateObject( |
|
IsActivityCompleted( |
|
IsCanceled( |
|
IsCategoryAllowed( |
|
IsDraftTemplate( |
|
IsDraftTemplateTestable( |
|
IsEmptyCSVLine( |
|
IsInProgress( |
|
IsReplaced( |
|
IsTemplateReleaseable( |
|
IsTemplateReleased( |
|
IsTemplateRevisionRequired( |
|
IsWorkFlowServiceUser( |
|
JSON2Value( |
|
LogHistoryEvent( |
|
MakeCSVLine( |
|
MakeDateTime( |
|
MakeInteger( |
|
MergeDocument( |
|
MergeObjects( |
|
MergePowerPoint( |
|
MoveToWastebasket( |
|
ObjectCopy( |
|
ObjectFixVersion( |
|
ObjectLock( |
|
ObjectReleaseVersion( |
|
ObjectUnlock( |
|
PrescribeObject( |
|
RaiseError( |
|
RaiseError( |
|
RegexCapture( |
|
RegexCaptureEx( |
|
RegexMatch( |
|
RegexReplace( |
|
ReleaseTemplate( |
|
RemovePDFRestrictions( |
|
ResolveFieldsAndSdts( |
|
RevokeReleasedTemplate( |
|
RGB2HexColor( |
|
SendBackgroundSecure( |
|
SetContentParsing( |
|
SetDocMetadata( |
|
SetDocState( |
|
SetFieldValue( |
|
SetSelectionContext( |
|
Sort( |
|
SplitPowerPoint( |
|
StartProcessDiagram( |
|
StringReplace( |
|
ThrowWarning( |
|
Tokenize( |
|
TokenizeCSVFile( |
|
TokenizeCSVLine( |
|
TraceValue( |
|
TranslateOCRStatus( |
|
UnEscapeHTML( |
|
UnEscapeXML( |
|
UpdateDocument( |
|
URLEncode( |
|
Value2JSON( |
|
Value2XML( |
|
XML2Value( |
|
Zip2Dict( |
Average Score (FSCTERM@1.1001:averagescore)
unsigned float FSCTERM@1.1001:averagescore readonly(ui)
Additional Information
Processing State (FSCFOLIO@1.1001:bostate)
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
Object FSCFOLIO@1.1001:bostate
Additional Information
Canceled Objects (FSCFOLIO@1.1001:canceleddocuments)
Object[] FSCFOLIO@1.1001:canceleddocuments readonly
Additional Information
Template Categories (COOTC@1.1001:categories)
unique Object[] COOTC@1.1001:categories readonly volatile
Additional Information
PDF Content is signable (FSCPDFGEN@1.1001:issignable)
boolean FSCPDFGEN@1.1001:issignable readonly
Last Signature (COOSIGNATURE@1.1:lastsignature)
string[] COOSIGNATURE@1.1:lastsignature readonly volatile
Last Signature Type (COOSIGNATURE@1.1:lastsigned)
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)
date COOSIGNATURE@1.1:lastsignedat readonly
Last Signature by (COOSIGNATURE@1.1:lastsignedby)
User COOSIGNATURE@1.1:lastsignedby readonly
Remark of Last Signature (COOSIGNATURE@1.1:lastsignedremark)
string COOSIGNATURE@1.1:lastsignedremark readonly
Signature Folder of Last Signature (COOSIGNATURE@1.1:lastsignedsignaturefolder)
Object COOSIGNATURE@1.1:lastsignedsignaturefolder readonly
ACL Object (COOSYSTEM@1.1:objaclobj)
AccessControlList COOSYSTEM@1.1:objaclobj
Additional Information
Referenced Object (COOSYSTEM@1.1:objaclref)
Object COOSYSTEM@1.1:objaclref
Additional Information
Current Released Version Date (COOSYSTEM@1.1:objactreleasedat)
date COOSYSTEM@1.1:objactreleasedat local readonly
Last Version Change on/at (COOSYSTEM@1.1:objactverschanged)
date COOSYSTEM@1.1:objactverschanged local readonly
Version Started on/at (COOSYSTEM@1.1:objactverscreated)
date COOSYSTEM@1.1:objactverscreated local not null readonly
Version Number (COOSYSTEM@1.1:objactversnr)
unsigned integer COOSYSTEM@1.1:objactversnr not null readonly
Address (COOSYSTEM@1.1:objaddress)
string(64) COOSYSTEM@1.1:objaddress readonly
App Configuration (FSCTEAMROOM@1.1001:objappconfigurationroom)
AppConfigurationRoom FSCTEAMROOM@1.1001:objappconfigurationroom readonly volatile invisible
Inbox (FSCTEAMROOM@1.1001:objapproominbox)
AppRoomInbox FSCTEAMROOM@1.1001:objapproominbox readonly
Additional Information
Available Fields (File) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyfiles)
string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyfiles readonly volatile
Available Fields (Category) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobjcategory)
string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobjcategory readonly volatile
Available Fields (Current Document) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobject)
string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyobject readonly volatile
Available Fields (Contained in) (FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyprimaryrelated)
string[] FSCTEMPLATEMGMT@1.1001:objavailablefieldsbyprimaryrelated readonly volatile
Canceled (COOSYSTEM@1.1:objcanceled)
boolean COOSYSTEM@1.1:objcanceled readonly
Canceled Files (FSCFOLIO@1.1001:objcanceledfiles)
Object[] FSCFOLIO@1.1001:objcanceledfiles readonly
Additional Information
Container (FSCFOLIO@1.1001:objcancelsource)
CompoundObject FSCFOLIO@1.1001:objcancelsource readonly invisible
Additional Information
Category (COOTC@1.1001:objcategory)
Object COOTC@1.1001:objcategory
Additional Information
System Change Timestamp (COOSYSTEM@1.1:objchangedat)
date COOSYSTEM@1.1:objchangedat local readonly
Last Change by (COOSYSTEM@1.1:objchangedby)
User COOSYSTEM@1.1:objchangedby readonly
Object Class (COOSYSTEM@1.1:objclass)
ObjectClass COOSYSTEM@1.1:objclass not null readonly
Closed on/at (FSCFOLIO@1.1001:objclosedat)
date FSCFOLIO@1.1001:objclosedat readonly
Closed by (FSCFOLIO@1.1001:objclosedby)
User FSCFOLIO@1.1001:objclosedby readonly
Additional Information
Created on/at (COOSYSTEM@1.1:objcreatedat)
date COOSYSTEM@1.1:objcreatedat local not null readonly
Created by (COOSYSTEM@1.1:objcreatedby)
User COOSYSTEM@1.1:objcreatedby not null readonly
Additional Information
Customizing Context (FSCTEAMROOM@1.1001:objcustomizingcontext)
Room FSCTEAMROOM@1.1001:objcustomizingcontext readonly(ui)
Additional Information
Deleted (COOSYSTEM@1.1:objdeleted)
boolean COOSYSTEM@1.1:objdeleted readonly
Highlighting Color (COODESK@1.1:objdisplayeffect)
DisplayEffect COODESK@1.1:objdisplayeffect
Additional Information
Document State (FSCFOLIO@1.1001:objdocstate)
DocState FSCFOLIO@1.1001:objdocstate readonly(ui)
Additional Information
Domain (COOSYSTEM@1.1:objdomain)
Domain COOSYSTEM@1.1:objdomain readonly
External ID (COOSYSTEM@1.1:objexternalkey)
string COOSYSTEM@1.1:objexternalkey
File (FSCFOLIO@1.1001:objfile)
Object FSCFOLIO@1.1001:objfile readonly(ui)
Additional Information
Container (FSCFOLIO@1.1001:objfilecancelsource)
CompoundObject FSCFOLIO@1.1001:objfilecancelsource readonly invisible
Additional Information
Final Form (COOSYSTEM@1.1:objfinalform)
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.boolean COOSYSTEM@1.1:objfinalform readonly
Additional Information
Font Effect (COODESK@1.1:objfonteffect)
FontEffect COODESK@1.1:objfonteffect
Additional Information
Object Last Indexed (UTC) (COOSYSTEM@1.1:objindexedat)
date COOSYSTEM@1.1:objindexedat readonly invisible
Vorerfasst (FSCFOLIO@1.1001:objisprecaptured)
boolean FSCFOLIO@1.1001:objisprecaptured readonly invisible
Is Template (COOTC@1.1001:objistemplate)
boolean COOTC@1.1001:objistemplate
Template Language (COOTC@1.1001:objlanguage)
Language COOTC@1.1001:objlanguage
Additional Information
Last Signature Folder (FSCFOLIO@1.1001:objlastsignaturefolder)
SignatureFolder FSCFOLIO@1.1001:objlastsignaturefolder readonly
Additional Information
State of Last Signature Folder (FSCFOLIO@1.1001:objlastsignaturefolderstate)
SignatureFolderState FSCFOLIO@1.1001:objlastsignaturefolderstate readonly
Location (COOSYSTEM@1.1:objlocation)
Object[] COOSYSTEM@1.1:objlocation readonly invisible
Shared Usage (COOSYSTEM@1.1:objlocationlist)
Object[] COOSYSTEM@1.1:objlocationlist readonly invisible
Own Location (COOSYSTEM@1.1:objlocationroot)
Object[] COOSYSTEM@1.1:objlocationroot readonly invisible
ObjectLockInfo COOSYSTEM@1.1:objlock readonly volatile
Locked Permanently (COOSYSTEM@1.1:objlockedpermanent)
boolean COOSYSTEM@1.1:objlockedpermanent readonly invisible
Mindbreeze Categorization (FSCMINDBREEZE@1.1001:objmbcategorization)
unique 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
Additional Information
Last Change on/at (COOSYSTEM@1.1:objmodifiedat)
date COOSYSTEM@1.1:objmodifiedat local readonly
string COOSYSTEM@1.1:objname
Owner (COOSYSTEM@1.1:objowner)
AccTypeReadSec
and AccTypeChangeSec
assigned.User COOSYSTEM@1.1:objowner not null
Additional Information
Group (COOSYSTEM@1.1:objowngroup)
AccTypeReadSec
and
AccTypeChangeSec
assigned.Group COOSYSTEM@1.1:objowngroup
Additional Information
Origin (COOSYSTEM@1.1:objprimaryrelated)
Object COOSYSTEM@1.1:objprimaryrelated readonly(ui) volatile
Additional Information
Version Really Created on/at (COOSYSTEM@1.1:objrealactverscreated)
objactverscreated
) to specify the original creation date
and time of the current version of an object when that object is migrated from
another system. Since it is normally not allowed to modify the creation date and
time of the current version of an object, the system tracks that change and
backs up the previous value of objactverscreated
in
objrealactverscreated
.date COOSYSTEM@1.1:objrealactverscreated local readonly
Really Created on/at (COOSYSTEM@1.1:objrealcreatedat)
objcreatedat
) to specify the
original creation date and time of an object when that object is migrated from
another system. Since it is normally not allowed to modify the creation date and
time of an object, the system tracks that change and backs up the previous value
of objcreatedat
in objrealcreatedat
.date COOSYSTEM@1.1:objrealcreatedat local readonly
Really Created by (COOSYSTEM@1.1:objrealcreatedby)
objcreatedby
) to specify the original creator of an
object when that object is migrated from another system. Since it is normally
not allowed to modify the creator of an object, the system tracks that change
and backs up the previous value of objcreatedby
in
objrealcreatedby
.User COOSYSTEM@1.1:objrealcreatedby readonly
Recorded (FSCFOLIO@1.1001:objrecorded)
boolean FSCFOLIO@1.1001:objrecorded readonly(ui)
Additional Information
Recorded Set on/at (FSCFOLIO@1.1001:objrecordedat)
date FSCFOLIO@1.1001:objrecordedat local readonly(ui)
Additional Information
Target (FSCFOLIO@1.1001:objregistrationtarget)
Object FSCFOLIO@1.1001:objregistrationtarget
Additional Information
Contained in (COOSYSTEM@1.1:objrelated)
unique Object[] COOSYSTEM@1.1:objrelated readonly(ui)
Released Version Date (COOSYSTEM@1.1:objreleasedat)
date COOSYSTEM@1.1:objreleasedat local readonly
Replaced by (COOSYSTEM@1.1:objreplacement)
Object COOSYSTEM@1.1:objreplacement readonly
Follow-Ups (FSCNOTIFICATION@1.1001:objresubmissions)
unique Notification[] FSCNOTIFICATION@1.1001:objresubmissions readonly
Additional Information
Retention Period (COOSYSTEM@1.1:objretentiondate)
date COOSYSTEM@1.1:objretentiondate
Additional Information
Object Last Scanned for Viruses (UTC) (COOSYSTEM@1.1:objscannedat)
date COOSYSTEM@1.1:objscannedat readonly invisible
Scan Queue (FSCFOLIO@1.1001:objscanqueue)
unique ContentObject[] FSCFOLIO@1.1001:objscanqueue readonly(ui)
Additional Information
Security Change Timestamp (COOSYSTEM@1.1:objsecchangedat)
date COOSYSTEM@1.1:objsecchangedat local readonly
Security Level (COOSYSTEM@1.1:objseclevel)
SecurityLevel COOSYSTEM@1.1:objseclevel
Additional Information
Signature Folders (FSCFOLIO@1.1001:objsignaturefolders)
unique SignatureFolder[] FSCFOLIO@1.1001:objsignaturefolders readonly
Additional Information
Source Object (COOSYSTEM@1.1:objsource)
Object COOSYSTEM@1.1:objsource readonly
Subject (COOSYSTEM@1.1:objsubject)
string COOSYSTEM@1.1:objsubject
Teamroom (FSCTEAMROOM@1.1001:objteamroom)
Room FSCTEAMROOM@1.1001:objteamroom readonly(ui)
Additional Information
Template (COOTC@1.1001:objtemplate)
Object COOTC@1.1001:objtemplate readonly
Template Revision Required (COOTC@1.1001:objtemplaterevisionrequired)
boolean COOTC@1.1001:objtemplaterevisionrequired readonly invisible
Template Revision Required Since (COOTC@1.1001:objtemplaterevisionrequiredat)
date COOTC@1.1001:objtemplaterevisionrequiredat readonly invisible
Template Revision Required Requested By (COOTC@1.1001:objtemplaterevisionrequiredby)
User COOTC@1.1001:objtemplaterevisionrequiredby readonly invisible
Additional Information
Terms (FSCTERM@1.1001:objterms)
unique Term[] FSCTERM@1.1001:objterms
Additional Information
Files (FSCFOLIO@1.1001:objuseablefiles)
unique Object[] FSCFOLIO@1.1001:objuseablefiles
Additional Information
Contained in (COOSYSTEM@1.1:objuseableprimaryrelated)
unique Object[] COOSYSTEM@1.1:objuseableprimaryrelated
Additional Information
Current Document (COOSYSTEM@1.1:objuseableself)
unique ObjectClass[] COOSYSTEM@1.1:objuseableself
Additional Information
System Change Timestamp of Last User Change (COOSYSTEM@1.1:objuserchangedat)
date COOSYSTEM@1.1:objuserchangedat local readonly
Valid From (COOSYSTEM@1.1:objvalidfrom)
date COOSYSTEM@1.1:objvalidfrom
Valid Until (COOSYSTEM@1.1:objvalidto)
date COOSYSTEM@1.1:objvalidto
Object Versions (COOSYSTEM@1.1:objversions)
unique ObjectVersionList[] COOSYSTEM@1.1:objversions readonly
Days After Which Older Versions Are Automatically Deleted (COOSYSTEM@1.1:objversmaxage)
unsigned integer COOSYSTEM@1.1:objversmaxage
Additional Information
Maximum Number of Versions Kept (COOSYSTEM@1.1:objversmaxnr)
unsigned integer COOSYSTEM@1.1:objversmaxnr
Additional Information
No Automatic Deleting of Versions (COOSYSTEM@1.1:objversnopurge)
true
, the versions are not destroyed automatically.boolean COOSYSTEM@1.1:objversnopurge
Additional Information
PDF Content (Screen Quality) (FSCPDFGEN@1.1001:pdfcontent)
Content FSCPDFGEN@1.1001:pdfcontent readonly(inst) invisible
Additional Information
PDF Content (Cache) (FSCPDFGEN@1.1001:pdfcontentcached)
Content FSCPDFGEN@1.1001:pdfcontentcached readonly(ui) invisible
Additional Information
PDF Content (OCR) (FSCPDFGEN@1.1001:pdfcontentocr)
Content FSCPDFGEN@1.1001:pdfcontentocr readonly(ui) invisible
Additional Information
PDF Content (Print Quality) (FSCPDFGEN@1.1001:pdfcontentprint)
Content FSCPDFGEN@1.1001:pdfcontentprint readonly(inst) invisible
Additional Information
PDF Metadata (FSCPDFGEN@1.1001:pdfmetadata)
unique PDFMetadata FSCPDFGEN@1.1001:pdfmetadata readonly
PDF Content (Optimized for Smartphones) (FSCPDFGEN@1.1001:pdfphonecontent)
Content FSCPDFGEN@1.1001:pdfphonecontent readonly(inst) invisible
Additional Information
Direct Supervisor (FSCPERSONNELFILE@1.1001:pfdirectsupervisor)
User FSCPERSONNELFILE@1.1001:pfdirectsupervisor readonly
Additional Information
Assigned User (FSCPERSONNELFILE@1.1001:pfemployee)
User FSCPERSONNELFILE@1.1001:pfemployee readonly
Additional Information
Supervisors (FSCPERSONNELFILE@1.1001:pfsupervisor)
unique AdministrationObject[] FSCPERSONNELFILE@1.1001:pfsupervisor readonly
Additional Information
Ratings (FSCTERM@1.1001:ratings)
unique RatingsType[] FSCTERM@1.1001:ratings readonly(ui)
Additional Information
Digital Signatures (COOSIGNATURE@1.1:signatureauthorizations)
SignatureAuthorization[] COOSIGNATURE@1.1:signatureauthorizations readonly
Signatures (COOSIGNATURE@1.1:signatures)
SignatureList[] COOSIGNATURE@1.1:signatures readonly
Manual Signatures (COOSIGNATURE@1.1:signaturesmanual)
SignatureManualList[] COOSIGNATURE@1.1:signaturesmanual readonly
Additional Restrictions (COOTC@1.1001:templatevisibility)
unique TemplateVisibilityType COOTC@1.1001:templatevisibility readonly
Number of Ratings (FSCTERM@1.1001:totalratings)
unsigned integer FSCTERM@1.1001:totalratings readonly(ui)
Additional Information
Score (FSCTERM@1.1001:userscore)
unsigned float FSCTERM@1.1001:userscore
Additional Information
View Count (FSCTERM@1.1001:viewcount)
unsigned integer FSCTERM@1.1001:viewcount readonly(ui)
Additional Information
Groups Participating in Workflow (COOWF@1.1:workflowgroups)
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.unique Group[] COOWF@1.1:workflowgroups readonly
Additional Information
Groups Having Participated in Workflow (COOWF@1.1:workflowgroupsdone)
domainremoveworkfloworgs
.unique Group[] COOWF@1.1:workflowgroupsdone readonly
Additional Information
Users Participating by Role in Workflow (COOWF@1.1:workflowroleusers)
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
Additional Information
Users Having Participated in Workflow by Role (COOWF@1.1:workflowroleusersdone)
domainremoveworkfloworgs
.unique User[] COOWF@1.1:workflowroleusersdone readonly
Additional Information
Users Participating in Workflow (COOWF@1.1:workflowusers)
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:workflowusers readonly
Additional Information
Users Having Participated in Workflow (COOWF@1.1:workflowusersdone)
domainremoveworkfloworgs
.unique User[] COOWF@1.1:workflowusersdone readonly
Additional Information
Substitutes of Users Participating in Workflow (COOWF@1.1:workflowuserssubstitutes)
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
Additional Information
Substitutes of Users Having Participated in Workflow (COOWF@1.1:workflowuserssubstitutesdone)
domainremoveworkfloworgs
.unique User[] COOWF@1.1:workflowuserssubstitutesdone readonly
Additional Information
COOWF@1.1:AllowChangeProcessState
boolean
COOWF@1.1:AllowChangeProcessState(
out retval boolean
statechangeable)
Name |
Description |
statechangeable |
COOTC@1.1001:AllowNavigateDraftRelease
boolean
COOTC@1.1001:AllowNavigateDraftRelease(
out retval boolean
allownavigate,
optional object
template)
Name |
Description |
allownavigate |
the result
|
template |
void
FSCPDFGEN@1.1001:AppendDoc(
ref optional content
doc1,
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
void
FSCPDFGEN@1.1001:AppendDocArray(
out content
pdf,
content[]
pdflist,
string[]
filenames,
optional BookmarkType
bookmarktype,
optional boolean
insertevenpage)
Name |
Description |
|
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. |
COOWF@1.1:AttrProcessParticipantSet
void
COOWF@1.1:AttrProcessParticipantSet(
AttributeDefinition
attrdef,
ref optional any
value,
any
oldvalue)
Name |
Description |
attrdef |
|
value |
|
oldvalue |
Additional Information
content
FSCEXPEXT@1.1001:Base64Decode(
content
incont,
out retval content
outcont)
Name |
Description |
incont |
the base64 encoded content
|
outcont |
the decoded content
|
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 |
COOWF@1.1:CanBeUsedForSubProcessesOnly
boolean
COOWF@1.1:CanBeUsedForSubProcessesOnly(
out retval boolean
subprocessesonly)
Name |
Description |
subprocessesonly |
the result
|
COOWF@1.1:CanChangeProcessState
boolean
COOWF@1.1:CanChangeProcessState(
ProcessInstance
procinst,
ref retval boolean
statechangeable)
Name |
Description |
procinst |
the process instance
|
statechangeable |
the result
|
COOTC@1.1001:CanReleaseTemplate
boolean
COOTC@1.1001:CanReleaseTemplate(
out retval boolean
canrelease)
Name |
Description |
canrelease |
the result;
|
FSCFOLIO@1.1001:CanReplaceDocument
boolean
FSCFOLIO@1.1001:CanReplaceDocument(
out retval boolean
canreplace)
Name |
Description |
canreplace |
boolean
COOATTREDIT@1.1:CheckLicense(
optional string
instance,
optional boolean
disableerrorapps,
optional object
context,
optional boolean
silentmode,
out retval boolean
haslicense)
Name |
Description |
instance |
Instance to be checked.
|
disableerrorapps |
Just raise an error, do not set 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:CollectMailData
void
FSCFOLIO@1.1001:CollectMailData(
ref dictionary
gatheredinfos)
Name |
Description |
gatheredinfos |
COOSYSTEM@1.1:ConvertContentToFinalForm
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
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:ConvertWorkDaysToDate
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
content
FSCFOLIO@1.1001:CreatePlainFromHTML(
content
html,
out retval content
plain)
Name |
Description |
html |
the source content
|
plain |
the generated plain text content
|
FSCFOLIO@1.1001:CreatePlainFromHTMLString
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
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)
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)
|
user
parameter. If a contact with this e-mail address exists already the existing contact is returned.cootx.IsCreated(user)
statement.
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 |
|
the e-mail address of the new contact
|
firstname |
the first name of the new contact
|
surname |
the surname of the new contact
|
middleinitial |
the middle name of the new contact
|
country |
the country of the new contact
|
language |
the communication language of the new contact
|
user |
the created contact
|
externalkey |
the external key of the user
|
organization |
the organization of which the user should become a member resp. external member
|
sendinvitationmail |
send invitation mail
|
FSCAPPTOOLS@1.1001:DelegateToChangedParticipant
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 new value, either a user or a group
|
setresponsible |
If true, the object in value is used as the new process responsible.
|
Content
FSCEXPEXT@1.1001:Dict2Zip(
dictionary
dict,
out retval Content
zip)
Name |
Description |
dict |
the dictionary
|
zip |
the resulting zip file
|
FSCFOLIO@1.1001:DoCancelFileObject
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
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
|
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.
|
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
|
string
FSCEXPEXT@1.1001:EscapeXML(
ref retval string
str)
Name |
Description |
str |
the string to be escaped
|
FSCCONFIG@1.1001:EvaluateGenericNameBuild
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
datetime
COOSYSTEM@1.1:EvaluateTimeInterval(
ref retval datetime
dateval,
object
timeinterval,
optional any
unused,
optional boolean
subtract)
Name |
Description |
dateval |
|
timeinterval |
|
unused |
|
subtract |
FSCEXPEXT@1.1001:FileNameEncode
string
FSCEXPEXT@1.1001:FileNameEncode(
string
source,
out retval string
replaced)
Name |
Description |
source |
the given string
|
replaced |
the valid file name
|
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
|
string
COOSYSTEM@1.1:Format(
any
value,
optional string
pattern,
optional string
symbols,
out retval string
result)
Name |
Description |
value |
|
pattern |
pattern for formatting
Number formatting . placeholder for decimal point, placeholder for grouping symbol# placeholder for significant digit0 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 signDate/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 blankdT short date and long time pattern separated by a blankDt long date and short time pattern separated by a blankDT long date and long time pattern separated by a blankDate/time formatting (custom) d placeholder for daym placeholder for monthy placeholder for yearh placeholder for hourn placeholder for minutes placeholder for secondt placeholder for time mark (am/pm)/ placeholder for date separator: placeholder for time separatorq 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 |
|
result |
FSCPDFGEN@1.1001:GenerateDocument
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.
|
FSCPOI@1.1001:GenerateWorkbook
void
FSCPOI@1.1001:GenerateWorkbook(
ref content
excel,
Workbook
workbook,
optional boolean
evaluateall)
Name |
Description |
excel |
The modified or created Microsoft Excel content
|
workbook |
This structure and values of the workbook
|
evaluateall |
Ensures that all cells are evaluated
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
|
FSCPERSONNELFILE@1.1001:GetApplicantFile
ApplicantFile
FSCPERSONNELFILE@1.1001:GetApplicantFile(
out retval ApplicantFile
applicantfile)
Name |
Description |
applicantfile |
the applicant file
|
FSCAPPTOOLS@1.1001:GetAttributeDefinitionByReference
AttributeDefinition
identified by reference
.cooobj
must have this attribute.
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
AttributeDefinition
identified by name
.cooobj
must have this attribute.
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 . |
FSCPERSONNELFILE@1.1001:GetBusinessCase
BusinessCase
FSCPERSONNELFILE@1.1001:GetBusinessCase(
out retval BusinessCase
businesscase)
Name |
Description |
businesscase |
the business case the objects is assigned to
|
object[]
FSCFOLIO@1.1001:GetChildren(
out retval object[]
objlist,
optional boolean
includebacklinks)
Name |
Description |
objlist |
the result
|
includebacklinks |
if set the backlink objects themselves are included instead of the mapped values of
attributes of type AttributeBackLinkDef
|
FSCTEAMROOM@1.1001:GetContextConfiguration
TV_CONTEXTOBJECT
is used.
AppConfigurationRoom
FSCTEAMROOM@1.1001:GetContextConfiguration(
optional boolean
recursive,
optional ObjectClass
configclass,
out retval AppConfigurationRoom
configuration)
Name |
Description |
recursive |
true if the action is called recursively
|
configclass |
the objectclass of the configuration
|
configuration |
the contract configuration room
|
FSCTEAMROOM@1.1001:GetContextDashboard
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
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
|
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
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
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
|
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 |
|
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
void
FSCPDFGEN@1.1001:GetDocMetadata(
content
pdf,
out dictionary
metadata,
out dictionary
additionalProperties)
Name |
Description |
|
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)
|
object
COOTC@1.1001:GetDraftTemplate(
out retval object
drafttemplate)
Name |
Description |
drafttemplate |
the draft template
|
FSCUSERFORMS@1.1001:GetFieldName
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
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
string
FSCEXPEXT@1.1001:GetFileExtFromMIMEType(
string
mimetype,
out retval string
fileext)
Name |
Description |
mimetype |
the given MIME type
|
fileext |
the file extension
|
FSCPERSONNELFILE@1.1001:GetFileShelf
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 |
FSCPERSONNELFILE@1.1001:GetJobAdvertisement
JobAdvertisement
FSCPERSONNELFILE@1.1001:GetJobAdvertisement(
out retval JobAdvertisement
jobadvertisement)
Name |
Description |
jobadvertisement |
FSCPERSONNELFILE@1.1001:GetJobApplications
JobApplication[]
FSCPERSONNELFILE@1.1001:GetJobApplications(
optional JobApplicationState
state,
out retval JobApplication[]
jobapplications)
Name |
Description |
state |
the state of the job application
|
jobapplications |
the job applications
|
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
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
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 |
COOWF@1.1:GetNextActivityInstances
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
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
NotificationEntryList[]
COOWF@1.1:GetNotificationSettings(
out retval NotificationEntryList[]
notificationentries)
Name |
Description |
notificationentries |
the configured notification entries
|
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
|
FSCTEAMROOM@1.1001:GetObjectRoom
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.
|
FSCFOLIO@1.1001:GetOverviewWithQRCode
content
FSCFOLIO@1.1001:GetOverviewWithQRCode(
out retval content
pdfcont)
Name |
Description |
pdfcont |
the pdf content including a QR Code
|
object
FSCFOLIO@1.1001:GetParent(
out retval object
parent,
out optional object
parentattrdef)
Name |
Description |
parent |
|
parentattrdef |
COOWF@1.1:GetParticipantListUsersGroups
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
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.
|
void
FSCPDFGEN@1.1001:GetPDFInfo(
Content
document,
ref optional dictionary
properties)
Name |
Description |
document |
the PDF document
|
properties |
a dictionary containing the PDF metadata
|
FSCPERSONNELFILE@1.1001:GetPersonnelFile
PersonnelFile
FSCPERSONNELFILE@1.1001:GetPersonnelFile(
out retval PersonnelFile
personnelfile)
Name |
Description |
personnelfile |
the personnelfile
|
FSCPERSONNELFILE@1.1001:GetPersonnelFileByPersnum
PersonnelFile[]
FSCPERSONNELFILE@1.1001:GetPersonnelFileByPersnum(
string
shelfid,
string
persnum,
out retval PersonnelFile[]
personnelfiles,
optional boolean
enforceunique,
optional boolean
globalsearch,
optional boolean
excludecanceled,
optional boolean
silent)
Name |
Description |
shelfid |
|
persnum |
|
personnelfiles |
|
enforceunique |
|
globalsearch |
|
excludecanceled |
|
silent |
FSCPERSONNELFILE@1.1001:GetPersonnelFileBySocialSecId
PersonnelFile[]
FSCPERSONNELFILE@1.1001:GetPersonnelFileBySocialSecId(
string
shelfid,
string
socialsecid,
out retval PersonnelFile[]
personnelfiles,
optional boolean
silent,
optional boolean
excludecanceled)
Name |
Description |
shelfid |
the shelfid
|
socialsecid |
the socialsecid
|
personnelfiles |
|
silent |
if true, no error will be raised
|
excludecanceled |
canceled personnel files are excluded from the search result
|
FSCPERSONNELFILE@1.1001:GetPersonnelFileDocument
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
PersonnelFileFolder
FSCPERSONNELFILE@1.1001:GetPersonnelFileFolder(
out retval PersonnelFileFolder
folder)
Name |
Description |
folder |
the Personnel File Folder the object is assigned to
|
FSCPERSONNELFILE@1.1001:GetPersonnelFileShelfById
PersonnelFileShelf
FSCPERSONNELFILE@1.1001:GetPersonnelFileShelfById(
string
shelfid,
out retval PersonnelFileShelf
shelf)
Name |
Description |
shelfid |
COO-Address of the file shelf or external key
|
shelf |
the file shelf object
|
FSCTEAMROOM@1.1001:GetPublicLink
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
PushNotificationEntryList[]
COOWF@1.1:GetPushNotificationSettings(
out retval PushNotificationEntryList[]
pushnotificationentries)
Name |
Description |
pushnotificationentries |
the configured push notification entries
|
FSCEXPEXT@1.1001:GetRandomNumber
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
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
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
|
FSCNOTIFICATION@1.1001:GetResubmissions
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
|
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
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.
@see SetSelectionContext
@see GetSelected
|
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
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
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
|
string
FSCPDFGEN@1.1001:GetText(
content
pdf,
out retval string
text)
Name |
Description |
|
the PDF document
|
text |
the text content of the PDF document
|
COOWF@1.1:GetUsableActivityDefinitions
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
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
|
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 |
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
boolean
FSCPDFGEN@1.1001:HasPDFRestrictions(
content
pdf,
out retval boolean
hasRestrictions)
Name |
Description |
|
The PDF document
|
hasRestrictions |
FSCTEAMROOM@1.1001:HasRoomChangeAccess
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
boolean
FSCTEAMROOM@1.1001:HasRoomChangeAllocationAccess(
User
user,
out retval boolean
haschangeallocationaccess)
Name |
Description |
user |
|
haschangeallocationaccess |
FSCTEAMROOM@1.1001:HasRoomChildChangeAccess
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
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
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
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
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
|
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)
|
string
FSCEXPEXT@1.1001:HexDecode(
string
encoded,
out retval string
decoded)
Name |
Description |
encoded |
the hex encoded string
|
decoded |
the decoded string
|
string
FSCEXPEXT@1.1001:HexEncode(
string
source,
out retval string
encoded)
Name |
Description |
source |
the given string
|
encoded |
the hex encoded string
|
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 |
|
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
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
|
boolean
COOWF@1.1:IsActivityCompleted(
out retval boolean
iscompleted)
Name |
Description |
iscompleted |
the result
|
FSCPERSONNELFILE@1.1001:IsCanceled
boolean
FSCPERSONNELFILE@1.1001:IsCanceled(
out retval boolean
iscanceled)
Name |
Description |
iscanceled |
the result
|
COOTC@1.1001:IsCategoryAllowed
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
|
boolean
FSCFOLIO@1.1001:IsChild(
object
child,
out retval boolean
ischild)
Name |
Description |
child |
|
ischild |
FSCPERSONNELFILE@1.1001:IsClosed
boolean
FSCPERSONNELFILE@1.1001:IsClosed(
out retval boolean
isclosed)
Name |
Description |
isclosed |
the result
|
isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();
boolean
COOTC@1.1001:IsDraftTemplate(
out retval boolean
isdrafttemplate)
Name |
Description |
isdrafttemplate |
the result
|
COOTC@1.1001:IsDraftTemplateTestable
boolean
COOTC@1.1001:IsDraftTemplateTestable(
out retval boolean
istestable)
Name |
Description |
istestable |
the result
|
FSCEXPEXT@1.1001:IsEmptyCSVLine
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 a blank cell
|
result |
true if the line from a csv file is empty. |
FSCPERSONNELFILE@1.1001:IsInProgress
boolean
FSCPERSONNELFILE@1.1001:IsInProgress(
out retval boolean
isinprogress)
Name |
Description |
isinprogress |
the result
|
FSCPERSONNELFILE@1.1001:IsReplaced
boolean
FSCPERSONNELFILE@1.1001:IsReplaced(
out retval boolean
isreplaced)
Name |
Description |
isreplaced |
the result
|
COOTC@1.1001:IsTemplateReleaseable
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.
|
COOTC@1.1001:IsTemplateReleased
boolean
COOTC@1.1001:IsTemplateReleased(
out retval boolean
isreleased,
out optional object
releasedtemplate)
Name |
Description |
isreleased |
the result
|
releasedtemplate |
COOTC@1.1001:IsTemplateRevisionRequired
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
boolean
COOWF@1.1:IsWorkFlowServiceUser(
out retval boolean
isserviceuser,
out Group[]
servicegroups)
Name |
Description |
isserviceuser |
the result
|
servicegroups |
the service groups of the user
|
any
FSCEXPEXT@1.1001:JSON2Value(
string
json,
out retval any
value,
optional boolean
allowinvalidutf8)
Name |
Description |
json |
the JSON string
|
value |
the created value
|
allowinvalidutf8 |
invalid utf8 is allowed
|
FSCFOLIO@1.1001:LogHistoryEvent
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.
|
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
datetime
.datetime
if the input string contains the letter 'T'".
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
|
FSCAPPTOOLS@1.1001:MakeInteger
integer
(base10).
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
|
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 |
If
true , all fields and SDTs from side documents will be resolved |
pagebreak |
If
true , a page break will be inserted after each document |
void
FSCPDFGEN@1.1001:MergeObjects(
out content
pdf,
PDFObject[]
pdfobjects,
string[]
filenames,
optional BookmarkType
bookmarktype,
optional boolean
insertevenpage,
out PDFSignatureArea[]
mergedsignatureareas)
Name |
Description |
|
The resulting PDF document.
|
pdfobjects |
A list of PDFObjects.
|
filenames |
The file names of the PDFObjects 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. |
mergedsignatureareas |
The resulting new signature areas of the given PDFObjects.
|
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
void
FSCTEAMROOM@1.1001:MoveToWastebasket(
object
source,
object
view)
Name |
Description |
source |
the container that contains the object
|
view |
the view of the container
|
object
COOSYSTEM@1.1:ObjectCopy(
ref optional object
placement,
out retval object
object,
optional string
address,
optional boolean
virtualobject)
Name |
Description |
placement |
|
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.
@see ObjectCreate |
virtualobject |
COOSYSTEM@1.1:ObjectFinalFormSet
void COOSYSTEM@1.1:ObjectFinalFormSet()
COOSYSTEM@1.1:ObjectFinalFormSetClose
void COOSYSTEM@1.1:ObjectFinalFormSetClose()
COOSYSTEM@1.1:ObjectFinalFormUnset
void COOSYSTEM@1.1:ObjectFinalFormUnset()
COOSYSTEM@1.1:ObjectFixVersion
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)
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 |
|
converttofinalform |
|
finalformat |
|
noautopurge |
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).
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.
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 , no error occurs if an object is locked for the second time in the same transaction. |
automaticunlock |
If it is
true , 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:ObjectReleaseVersion
void
COOSYSTEM@1.1:ObjectReleaseVersion(
datetime
versdate)
Name |
Description |
versdate |
The date and time of the version of the object.
|
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 ). |
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
%[order$][flags][width][.precision][length]specifier
specifier
descriptionc
Characterd
or i
Signed decimal integere
Scientific notation (mantise/exponent) using e characterE
Scientific notation (mantise/exponent) using E characterf
Decimal floating pointg
Use the shorter of %e or %fG
Use the shorter of %E or %fo
Signed octals
String of charactersu
Unsigned decimal integerx
Unsigned hexadecimal integerX
Unsigned hexadecimal integer (capital letters)%
A % followed by another % character will write % to the stringorder$
descriptionorder
is the number of the original argument positionflags
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..*
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
descriptionh
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
|
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.
|
string
FSCEXPEXT@1.1001:QPEncode(
string
string,
out retval string
qpstring)
Name |
Description |
string |
the given string
|
qpstring |
the quoted printable encoded string
|
void
COOSYSTEM@1.1:RaiseError(
ErrorMessage
error)
Name |
Description |
error |
Error message object. The property errtext is used as the format string
|
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
void FSCNOTIFICATION@1.1001:ReCalculateNotifications()
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
coouser.RegexCaptureEx("ID-01-ABC, ID-02-", "(ID-[0-9]*)-([A-Z]*)", "g");
will return the following value
[
{ match : "ID-01-ABC", group1 : "ID-01", group2 : "ABC" },
{ match : "ID-02-", group1 : "ID-02", group2 : "" }
]
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.
|
result |
resulting matches
|
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 |
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
|
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
void
FSCPDFGEN@1.1001:RemovePDFRestrictions(
ref content
pdf)
Name |
Description |
|
The PDF document
|
FSCPOI@1.1001:ResolveFieldsAndSdts
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
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
|
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 |
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
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.
|
COOSYSTEM@1.1:SetContentParsing
void
COOSYSTEM@1.1:SetContentParsing(
ref optional content[]
contents,
optional boolean
on)
Name |
Description |
contents |
|
on |
FSCPDFGEN@1.1001:SetDocMetadata
void
FSCPDFGEN@1.1001:SetDocMetadata(
ref content
pdf,
dictionary
metadata)
Name |
Description |
|
The PDF content which should be changed.
|
metadata |
Key/Value dictionary with metadata entries (title, author, subject, ...)
|
void
FSCFOLIO@1.1001:SetDocState(
DocState
state,
optional boolean
inherited)
Name |
Description |
state |
|
inherited |
FSCUSERFORMS@1.1001:SetFieldValue
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
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.
@see GetSelectionContext
@see GetSelected
|
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)
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 |
void
FSCPDFGEN@1.1001:SplitPDF(
content
pdf,
out content[]
pages)
Name |
Description |
|
The PDF document.
|
pages |
A list of PDF documents, each containing a page of the original PDF document.
|
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
|
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
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
|
void
COODESK@1.1:ThrowWarning(
integer
errornumber)
Name |
Description |
errornumber |
Identifier for the specific error or warning
|
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
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 representing a blank line
|
lines |
the list of extracted lines of the CSV file
|
FSCEXPEXT@1.1001:TokenizeCSVLine
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 representing a blank cell
|
cells |
the list of extracted cell values of the CSV line
|
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
|
void
FSCEXPEXT@1.1001:TraceValue(
optional any
value)
Name |
Description |
value |
the value
|
FSCABBYY@1.1001:TranslateOCRStatus
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
|
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.
|
string
FSCEXPEXT@1.1001:UnEscapeHTML(
ref retval string
str)
Name |
Description |
str |
the string to be unescaped
|
string
FSCEXPEXT@1.1001:UnEscapeXML(
ref retval string
str)
Name |
Description |
str |
the string to be unescaped
|
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
|
string
FSCEXPEXT@1.1001:URLDecode(
string
encodedurl,
out retval string
url)
Name |
Description |
encodedurl |
the URL encoded string
|
url |
the decoded string
|
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)
|
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)
|
omitsurroundingnode
is true
no additional node "data" is generated.
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:
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. |
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
|
dictionary
FSCEXPEXT@1.1001:Zip2Dict(
Content
zip,
out retval dictionary
dict)
Name |
Description |
zip |
the zip file
|
dict |
the resulting dictionary
|