Object Class Records Management Structure Element (RECORDSOM@1.1001:ERMSObject)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:CompoundObject > FSCFOLIO@1.1001:BusinessObject > RECORDSOM@1.1001:ERMSObject

Base class for Electronic Records Management System objects.

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: true
Default Task Pane (Selection Dependent): COODESK@1.1:TaskPaneObject
Action for Moving Objects: COODESK@1.1:DragIntoMove
Abstract: true
ACL Object: COOSYSTEM@1.1:DefaultGlobalACL
Default Task Pane: COODESK@1.1:MainTaskPaneObject
Symbol: COODESK@1.1:SymbolBusinessObject
Transfer: false
Commonly usable: true
Base Class: FSCFOLIO@1.1001:BusinessObject
Action for Linking Objects: COODESK@1.1:DragIntoLink
Display Mode: DISP_LINES
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Default Main Menu: COODESK@1.1:MenuRootFolder

Properties

ReferenceName
COOSYSTEM@1.1:mlnameMultilingual Name
RECORDSBUCEXT@1.1001:refcontractContract
RECORDSBUCEXT@1.1001:refforeignorganisationCustomer
RECORDSBUCEXT@1.1001:refinvoiceInvoice
RECORDSBUCEXT@1.1001:refownorganisationOwn Organization
RECORDSBUCEXT@1.1001:refprojectProject
RECORDSBUCEXT@1.1001:refsupplierSupplier
RECORDSOM@1.1001:accrestrictionsTime-Constrained Access Restrictions
RECORDSOM@1.1001:activeActive
RECORDSOM@1.1001:allowedcaptureclassesAllowed Object Classes for Contents of Captured Records
RECORDSOM@1.1001:checkedoutphysicallyatChecked out Physically on/at
RECORDSOM@1.1001:closedatClosed on/at
RECORDSOM@1.1001:containsContains
RECORDSOM@1.1001:containschangedatContains Changed at
RECORDSOM@1.1001:currentlocationCurrent Location
RECORDSOM@1.1001:custodianCustodian
RECORDSOM@1.1001:descriptionDescription
RECORDSOM@1.1001:formatFormat for Fully-Qualified Classification Code
RECORDSOM@1.1001:homelocationHome Location
RECORDSOM@1.1001:maxnumberHighest Number
RECORDSOM@1.1001:parentclassificationschemeParent Classification Scheme
RECORDSOM@1.1001:physicalPhysical
RECORDSOM@1.1001:physicalformatPhysical Format
RECORDSOM@1.1001:restrictedatRestricted at
RECORDSOM@1.1001:structuredcodeStructured Code

Actions

ReferenceName
COODESK@1.1:AllowedTemplatesGet
COODESK@1.1:GetDropTargets
COODESK@1.1:RenameObject
COODESK@1.1:UnshareObject
COOSYSTEM@1.1:AllowedClassesGet
COOSYSTEM@1.1:AllowedClassesHas
COOSYSTEM@1.1:AllowedObjectsFilter
COOSYSTEM@1.1:AttrObjLitigationHoldSet
COOSYSTEM@1.1:AttrObjNameGet
COOSYSTEM@1.1:AttrObjNameGetVersion
COOSYSTEM@1.1:AttrObjNameSet
COOSYSTEM@1.1:AttrObjSecPropSet
FSCFOLIOCLOUDREC@1.1001:AssignRetentionScheduleWizardAssign retention/disposition schedule
FSCFOLIOCLOUDREC@1.1001:CreateClassWizardCreate class
FSCFOLIOCLOUDREC@1.1001:CreateFileWizardCreate file
FSCFOLIOCLOUDREC@1.1001:CreateSubFileWizardCreate sub-file
FSCFOLIOCLOUDREC@1.1001:IsValidRelocationTargetWrapperDetermine if object is a valid relocation target
FSCFOLIOCLOUDREC@1.1001:RemoveRetentionScheduleWizardRemove retention/disposition schedule
FSCSCHEDULE@1.1001:SetRDObjectsSet Retention/Disposition Objects
FSCTEAMROOM@1.1001:IsTeamRoomChild
FSCVENV@1.1001:FinalizeImport
RECORDSBUC@1.1001:AddToMRUListAdd to quick capture list
RECORDSBUC@1.1001:AttrContainsSetWrapperSet "Contains" list
RECORDSBUC@1.1001:CaptureCapture
RECORDSBUC@1.1001:CaptureByDragCapture by drag and drop
RECORDSBUC@1.1001:CheckAllowedCapturerCheck Allowed Capturer
RECORDSBUC@1.1001:CloseERMSObjectClose object
RECORDSBUC@1.1001:CreateERMSObjectCreate ERMS Object
RECORDSBUC@1.1001:GetRecordsDeleteAction
RECORDSBUC@1.1001:IsValidCaptureTargetDetermine if object is a valid capture target
RECORDSBUC@1.1001:IsValidRelocationTargetDetermine if object is a valid relocation target
RECORDSBUC@1.1001:ObjectDeleteWrapperEnforce deletion rules
RECORDSBUC@1.1001:OpenERMSObjectReopen object
RECORDSBUC@1.1001:PasteFromClipboardExPaste objects from clipboard
RECORDSBUC@1.1001:SelectClassificationSchemeSelect Classification Scheme
RECORDSBUC@1.1001:UnshareObjectExRemove Object
RECORDSBUCEXT@1.1001:InitializeWrapperInitialize business context of ERMS object
RECORDSDD@1.1001:CloseERMSObjectInWFClose
RECORDSDD@1.1001:ProlongRetentionProlong Retention
RECORDSOM@1.1001:AttrAccRestrictionsSetSet time-constrained access restrictions
RECORDSOM@1.1001:AttrContainsChildrenCopyCopy children of "Contains" property
RECORDSOM@1.1001:AttrContainsSetSet "Contains" property
RECORDSOM@1.1001:AttrRefersToSetSet "Refers to" property
RECORDSOM@1.1001:CheckAllowedChildrenCheck allowed children
RECORDSOM@1.1001:GetAllowedChildClassesSettingsGet child class settings
RECORDSOM@1.1001:GetContainsObjectsGet "Contains" objects
RECORDSOM@1.1001:GetTopLevelObjectGet top-level object
RECORDSOM@1.1001:ProcessAccessRestrictionsProcess access restrictions

Properties

COOSYSTEM@1.1:mlname (Multilingual Name)

Stores the multilingual name of the object. It stores one name for each supported language.

Additional Information

Changeable in Installed Component: true
Action to Get Display String of Property: COOSYSTEM@1.1:AttrGetDisp
Action Called Before Property Is Saved: COOSYSTEM@1.1:AttrObjNameBuildSet
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:LanguageStringList
Secured: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

RECORDSBUCEXT@1.1001:refcontract (Contract)

Referenced contract

Additional Information

Private: true
Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: FSCFOLIOCONTRACT@1.1001:Contract
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

RECORDSBUCEXT@1.1001:refforeignorganisation (Customer)

Referenced organization

Additional Information

Private: true
Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: FSCFOLIO@1.1001:Organisation
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

RECORDSBUCEXT@1.1001:refinvoice (Invoice)

Referenced invoice

Additional Information

Private: true
Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: FSCINVOICE@1.1001:IncomingInvoice
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

RECORDSBUCEXT@1.1001:refownorganisation (Own Organization)

Referenced own organization

Additional Information

Private: true
Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: FSCFOLIO@1.1001:Organisation
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

RECORDSBUCEXT@1.1001:refproject (Project)

Referenced project

Additional Information

Private: true
Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: FSCFOLIO@1.1001:Project
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

RECORDSBUCEXT@1.1001:refsupplier (Supplier)

Referenced supplier

Additional Information

Private: true
Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: FSCFOLIO@1.1001:Organisation
Search for Allowed Classes Only: true
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

RECORDSOM@1.1001:accrestrictions (Time-Constrained Access Restrictions)

Time-constrained access restrictions can be used to define users/groups who get access to an ERMS object during a specified timeframe

Additional Information

Access Types for Reading Property: COOSYSTEM@1.1:AccTypeReadSecRel
Changeable in Installed Component: true
Action Called Before Property Is Saved: RECORDSOM@1.1001:AttrAccRestrictionsSet
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: RECORDSOM@1.1001:AccessRestrictions
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeSecRel
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Visible: true


[top]

RECORDSOM@1.1001:active (Active)

Not used yet, but required by MoReq 2 (M019 Use.status.active)

Additional Information

Initialization Value: true
Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:allowedcaptureclasses (Allowed Object Classes for Contents of Captured Records)

allowedcaptureclasses defines the object classes that can be captured into a record referenced in the contains property of an ERMS object.

Additional Information

Changeable in Installed Component: true
Multiple Values (Overrides Type): true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECTLISTUNIQ
Possible Object Class: COOSYSTEM@1.1:ObjectClass
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: false
Visible: true


[top]

RECORDSOM@1.1001:checkedoutphysicallyat (Checked out Physically on/at)

Indicates if a physical ERMSObject is checked out and when.

Additional Information

Changeable in Installed Component: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:DATETIME
Disable Conversion: true
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeSec
Changeable: true
Use Date Only: false
Must Be Defined: false
Visible: true


[top]

RECORDSOM@1.1001:closedat (Closed on/at)

Date/time when the ERMSObject was closed. Can be used as a trigger. (closedat == null) is often used to test whether an ERMSObject is closed.

Additional Information

Changeable in Installed Component: true
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:DATETIME
Disable Conversion: true
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeSec
Changeable: true
Must Be Defined: false
Use Date Only: false
Visible: true


[top]

RECORDSOM@1.1001:contains (Contains)

List for classified ERMSObjects. Adding a ContentObject wraps it into a Record and attaches the Record (see ObjectPrepareAttach and CreateRecordsCapture). For business rules for sharing and unsharing see ObjectAttachAllowed and ObjectUnshareAllowed.

Additional Information

Action to Copy Property From Object: RECORDSOM@1.1001:AttrContainsChildrenCopy
Visible: true
Access Types for Reading Property: COOSYSTEM@1.1:AccTypeReadComp
Action Called Before Property of Version Is Saved: COOSYSTEM@1.1:AttrChildrenFixManualVersion
Search for Allowed Classes Only: true
Possible Object Class: COOSYSTEM@1.1:Object
Action for Copying Objects: COOTC@1.1001:DragIntoCopy
Action Called Before Property Is Saved: RECORDSOM@1.1001:AttrContainsSet
Changeable: true
Action for Linking Objects: COOTC@1.1001:DragIntoLink
Action Called to Restore Property of Version: COOSYSTEM@1.1:AttrRestVersionFromActVersion
Describes Child Relationship: true
Action for Moving Objects: COOTC@1.1001:DragIntoMove
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Access Types for Changing Property: COOSYSTEM@1.1:AccTypeChangeComp
Type: COOSYSTEM@1.1:OBJECTLISTUNIQ
Describes Hierarchical Relationship: true
Destructor Action: COOSYSTEM@1.1:AttrChildrenDestructor
Mapped Property: RECORDSOM@1.1001:refersto
Changeable in Installed Component: true
Must Be Defined: false


[top]

RECORDSOM@1.1001:containschangedat (Contains Changed at)

Date/time when contains was last changed. Can be used as a trigger.

Additional Information

Changeable in Installed Component: true
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:DATETIME
Disable Conversion: true
Changeable: true
Use Date Only: false
Must Be Defined: false
Visible: true


[top]

RECORDSOM@1.1001:currentlocation (Current Location)

The current physical location of a physical entity. (M086)

Additional Information

Type: COOSYSTEM@1.1:STRING
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 254
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:custodian (Custodian)

The person who is responsible for a physical entity. (M123)

Additional Information

Search for Allowed Classes Only: true
Type: COOSYSTEM@1.1:OBJECT
Changeable: true
Visible: true
Must Be Defined: false
Possible Object Class: COOSYSTEM@1.1:User
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:description (Description)

Plain text description

Additional Information

Type: COOSYSTEM@1.1:STRINGLIST
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 254
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:format (Format for Fully-Qualified Classification Code)

This determines how the classification code is formatted (fqseparator, minimumlength, startingvalue, incrementsteps, prefix, postfix). When an ERMSObject is created, format is inherited from the ERMSObject's parent.

Additional Information

Type: RECORDSOM@1.1001:FormatType
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:homelocation (Home Location)

The home location (i. e. the usual storage location) of a physical entity. (M122)

Additional Information

Type: COOSYSTEM@1.1:STRING
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 254
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:maxnumber (Highest Number)

The next free number that can be used as a classification code for a new child object. Is used in com.fabasoft.editions.recordsom.Object.SetClassificationCode() and RECORSDSOM@1.1001:FormatClassCode.

Additional Information

Changeable in Installed Component: true
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:INTEGER
Maximum Length: 10
Changeable: true
Action to Copy Property From Object: COOSYSTEM@1.1:NoOperation
Must Be Defined: false
Sign: true
Visible: true


[top]

RECORDSOM@1.1001:parentclassificationscheme (Parent Classification Scheme)

A shortcut to the classification scheme. Is used to get the default access definitions.

Additional Information

Changeable in Installed Component: true
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:OBJECT
Possible Object Class: RECORDSOM@1.1001:ERMSClassificationScheme
Search for Allowed Classes Only: true
Changeable: true
Must Be Defined: true
Visible: true


[top]

RECORDSOM@1.1001:physical (Physical)

Indicates if the ERMSObject is a physical object (see MoReq 2 requirements chapter 10.1).

Additional Information

Initialization Value: false
Type: COOSYSTEM@1.1:BOOLEAN
Changeable: true
Visible: true
Must Be Defined: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:physicalformat (Physical Format)

The format of the physical entity. (M092) This could be a book, a CD-ROM etc.

Additional Information

Type: COOSYSTEM@1.1:STRING
Changeable: true
Visible: true
Must Be Defined: false
Maximum Length: 254
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

RECORDSOM@1.1001:restrictedat (Restricted at)

Date/time when access to the object has been restricted to certain users/groups/positions. If "null", access is currently not restricted.

Additional Information

Changeable in Installed Component: true
Changeable in User Interface: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:DATETIME
Disable Conversion: true
Changeable: true
Use Date Only: false
Must Be Defined: false
Visible: true


[top]

RECORDSOM@1.1001:structuredcode (Structured Code)

Like the fully qualified classification code, but with titles instead of classification codes.

Additional Information

Changeable in Installed Component: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Type: COOSYSTEM@1.1:STRING
Action to Search Object Property: COOSYSTEM@1.1:AttrSearchNotPossible
Action Called After Property Is Read: RECORDSOM@1.1001:AttrStructuredCodeGet
Maximum Length: 254
Changeable: false
Must Be Defined: false
Visible: true


[top]

Actions

COODESK@1.1:AllowedTemplatesGet

Compute templates allowed for property.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTinfalse the property
modeCOOSYSTEM@1.1:CheckAllowedModeinfalse the CheckAllowedMode
allowedtemplatesCOOSYSTEM@1.1:OBJECTLISToutfalse the templates which are allowed for the supplied categories
categoriesCOOSYSTEM@1.1:OBJECTLISTintrue the all templates found in the collection sources will be filtered by the supplied categories
collectionsourcesCOOSYSTEM@1.1:OBJECTLISTintrue
needcategoriezedtemplatesCOOSYSTEM@1.1:BOOLEANintrue defines if categorized templates should be calculated
categorizedtemplatesCOOSYSTEM@1.1:DICTIONARYoutfalse the templates are structured by template categories

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:GetDropTargets

This action determines the possible drop targets. The desk form of the explore tree is used to identify possible drop targets.
ParameterTypeIn/OutOptionalDescription
droptargetsCOOSYSTEM@1.1:OBJECTLISToutfalse The list of the possible drop targets and is used as input parameter for the COODESK@1.1:GetValidDropTarget action.
dragobjectCOOSYSTEM@1.1:OBJECTLISTintrue Objects to be dropped.
fileinfoCOOSYSTEM@1.1:DICTIONARYLISTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COODESK@1.1:RenameObject

Changes the name of the object to the specified name.
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
nameCOOSYSTEM@1.1:STRINGin/outfalse The new object name.
clearCOOSYSTEM@1.1:BOOLEANinfalse If it is true, the name is deleted.
captionCOOSYSTEM@1.1:STRINGinfalse

Additional Information

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


[top]

COODESK@1.1:UnshareObject

Removes the reference to the object from the parent object.
ParameterTypeIn/OutOptionalDescription
unused1COOSYSTEM@1.1:INTEGERintrue
unused2COOSYSTEM@1.1:INTEGERintrue
viewCOOSYSTEM@1.1:OBJECTinfalse The relation (property definition) from which the object reference is removed.
sourceCOOSYSTEM@1.1:OBJECTinfalse The source object from which the object reference is removed.

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AllowedClassesGet

Computes allowed and not allowed object classes for a property. This action can be called directly on a property if parameter attrdef is not specified. Otherwise it computes object classes property attrdef of the object. Parameter mode specifies which object classes should be computed.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTintrue
modeCOOSYSTEM@1.1:CheckAllowedModeinfalse
allowedclassesCOOSYSTEM@1.1:OBJECTLISToutfalse
notallowedclassesCOOSYSTEM@1.1:OBJECTLISToutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AllowedClassesHas

ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTinfalse
modeCOOSYSTEM@1.1:CheckAllowedModeinfalse
checkaccessCOOSYSTEM@1.1:BOOLEANinfalse
checkabstractCOOSYSTEM@1.1:BOOLEANinfalse
hasallowedCOOSYSTEM@1.1:BOOLEANoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AllowedObjectsFilter

Filters objects for a property. This action can be called directly on a property if parameter attrdef is not specified. Otherwise it filters objects for property attrdef of the object. Parameter mode specifies the allowed classes. If parameter test is specified and true, parameter classes is not modified when it contains an object of an illegal class. Instead, test contains false on return.
ParameterTypeIn/OutOptionalDescription
attrdefCOOSYSTEM@1.1:OBJECTinfalse
modeCOOSYSTEM@1.1:CheckAllowedModeinfalse
objectsCOOSYSTEM@1.1:OBJECTLISTin/outfalse
testCOOSYSTEM@1.1:BOOLEANin/outtrue
checkvalidCOOSYSTEM@1.1:BOOLEANintrue
validatCOOSYSTEM@1.1:DATETIMEintrue
filterCOOSYSTEM@1.1:STRINGintrue
filterattrdefCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:AttrObjLitigationHoldSet

Additional Information

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


[top]

COOSYSTEM@1.1:AttrObjNameGet

Get action for the property COOSYSTEM@1.1:objname.

Additional Information

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


[top]

COOSYSTEM@1.1:AttrObjNameGetVersion

Get version action for the property COOSYSTEM@1.1:objname.

Additional Information

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


[top]

COOSYSTEM@1.1:AttrObjNameSet

Set action for the property COOSYSTEM@1.1:objname.

Additional Information

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


[top]

COOSYSTEM@1.1:AttrObjSecPropSet

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
Must Be Executed: true
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCFOLIOCLOUDREC@1.1001:AssignRetentionScheduleWizard (Assign retention/disposition schedule)

Assign retention schedule to ERMS object

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChangeSecRel
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOCLOUDREC@1.1001:CreateClassWizard (Create class)

Create class in classification scheme

Additional Information

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


[top]

FSCFOLIOCLOUDREC@1.1001:CreateFileWizard (Create file)

Create file in classification scheme

Additional Information

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


[top]

FSCFOLIOCLOUDREC@1.1001:CreateSubFileWizard (Create sub-file)

Create sub-file in classification scheme

Additional Information

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


[top]

FSCFOLIOCLOUDREC@1.1001:IsValidRelocationTargetWrapper (Determine if object is a valid relocation target)

Determine if the current object is a valid relocation target for the objects passed in relocationobjs
ParameterTypeIn/OutOptionalDescription
relocationobjsCOOSYSTEM@1.1:OBJECTLISTinfalse

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCFOLIOCLOUDREC@1.1001:RemoveRetentionScheduleWizard (Remove retention/disposition schedule)

Remove retention schedule from ERMS object

Additional Information

Prototype: COODESK@1.1:MenuActionPrototype
Access Types: COOSYSTEM@1.1:AccTypeChangeSecRel
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCSCHEDULE@1.1001:SetRDObjects (Set Retention/Disposition Objects)

Set the retention/disposition object list

Additional Information

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


[top]

FSCTEAMROOM@1.1001:IsTeamRoomChild

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

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

FSCVENV@1.1001:FinalizeImport

Finalizes the import process. Here the imported objects can be enclosed to other objects.
ParameterTypeIn/OutOptionalDescription
venv_parentCOOSYSTEM@1.1:OBJECTinfalse Container object
venv_viewCOOSYSTEM@1.1:OBJECTinfalse Container view
venv_importobjectsCOOSYSTEM@1.1:OBJECTLISTinfalse The imported objects
venv_donotshareCOOSYSTEM@1.1:BOOLEANintrue This parameter indicates that the imported objects were not shared during the import process so far.
branchattrFSCVIEW@1.1001:Fieldintrue Attribute path to object lists attribute definition.
branchindexCOOSYSTEM@1.1:INTEGERLISTintrue Index through the branchattribute array.
handleshareexternalCOOSYSTEM@1.1:BOOLEANoutfalse This parameter indicates that the imported objects will be shared from external code.
venv_importokCOOSYSTEM@1.1:BOOLEANintrue This parameter indicates that the import process has succeeded so far.
venv_navigatetoCOOSYSTEM@1.1:OBJECTin/outtrue This parameter indicates that after finalizing the import FinalizeImport should navigate to this object.
venv_importdescriptionCOOSYSTEM@1.1:DICTIONARYintrue This parameter is a description of the import process. It is generated by the Fabasoft Folio/Fabasoft Cloud Client. This dictionary can be used to identify the hierarchy of the imported objects. To identify a child object you have to check the unclecount attribute of the previous sibling.
Example:
Import of an e-mail (outermail.msg) with two attachments together with two pdf documents (mydocument1.pdf and mydocument2.pdf).
The e-mail outermail.msg contains two attachments.
The first attachment of outermail.msg is a picture (mypicture1.png).
The second attachment is an e-mail (innermail.msg) which contains one picture (mypicture2.png).
The mail split decision for all e-mails was "E-Mail Text and Separate Attachment".

Import structure is:
  • outermail.msg
    • mypicture1.png
    • innermail.msg
      • mypicture2.png
  • mydocument1.pdf
  • mydocument2.pdf
The import description dictionary will look like:
 dictionary venv_importdescription = { importdescription = [ { _: "Entry", filename: "outermail.msg", objaddress: "COO.1.3150.4.4458", unclecount: 2 // Next 2 entries are child/attachment of this mail }, { _: "Entry", filename: "mypicture1.pdf", objaddress: "COO.1.3150.4.4459", unclecount: 0 }, { _: "Entry", filename: "innermail.msg", objaddress: "COO.1.3150.4. 4460", unclecount: 1 // Next entry is a child/attachment of this mail }, { _: "Entry", filename: "mypicture2.png", objaddress: "COO.1.3150.4. 4461", unclecount: 0 }, { _: "Entry", filename: "mydocument1.pdf", objaddress: "COO.1.3150.4. 4462", unclecount: 0 }, { _: "Entry", filename: "mydocument2.pdf", objaddress: "COO.1.3150.4. 4463", unclecount: 0 } ] } 

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:AddToMRUList (Add to quick capture list)

Add a captured object to the MRU list

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:AttrContainsSetWrapper (Set "Contains" list)

Additional Information

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


[top]

RECORDSBUC@1.1001:Capture (Capture)

Capture an object
ParameterTypeIn/OutOptionalDescription
capturetargetCOOSYSTEM@1.1:OBJECTinfalse the parent
createrecordCOOSYSTEM@1.1:BOOLEANinfalse
recordedobjCOOSYSTEM@1.1:OBJECToutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:CaptureByDrag (Capture by drag and drop)

Wizard for capturing an object by drag and drop

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:CheckAllowedCapturer (Check Allowed Capturer)

Determine if user is allowed to capture an object

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:CloseERMSObject (Close object)

Close an ERMS object and its children
ParameterTypeIn/OutOptionalDescription
descriptionCOOSYSTEM@1.1:STRINGinfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:CreateERMSObject (Create ERMS Object)

Wizard for capturing an ERMS object
ParameterTypeIn/OutOptionalDescription
target_objectCOOSYSTEM@1.1:OBJECTinfalse
target_attrdefCOOSYSTEM@1.1:OBJECTinfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:GetRecordsDeleteAction

Post wrapper of FSCTEAMROOM@1.1001:GetDeleteAction to cancel a document when ObjectDelete is called
ParameterTypeIn/OutOptionalDescription
_containerCOOSYSTEM@1.1:OBJECTin/outfalse
selobjectsCOOSYSTEM@1.1:OBJECTLISTin/outfalse the selobjects
lastresultCOOSYSTEM@1.1:INTEGERin/outfalse the lastresult
captionCOOSYSTEM@1.1:STRINGin/outfalse the caption
questionCOOSYSTEM@1.1:STRINGin/outfalse the question
enhancedCOOSYSTEM@1.1:BOOLEANin/outfalse the enhanced
delactionCOOSYSTEM@1.1:OBJECTin/outfalse the delaction
shiftkeypressedCOOSYSTEM@1.1:BOOLEANin/outtrue the shiftkeypressed
deltargetCOOSYSTEM@1.1:OBJECTin/outfalse the deltarget
delapplicationCOOSYSTEM@1.1:OBJECTin/outfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

RECORDSBUC@1.1001:IsValidCaptureTarget (Determine if object is a valid capture target)

Determine if the current object is a valid capture target for the objects passed in capturedobjs
ParameterTypeIn/OutOptionalDescription
capturedobjsCOOSYSTEM@1.1:OBJECTLISTinfalse
validCOOSYSTEM@1.1:BOOLEANoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:IsValidRelocationTarget (Determine if object is a valid relocation target)

Determine if the current object is a valid relocation target for the objects passed in relocationobjs
ParameterTypeIn/OutOptionalDescription
relocationobjsCOOSYSTEM@1.1:OBJECTLISTinfalse
validCOOSYSTEM@1.1:BOOLEANoutfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:ObjectDeleteWrapper (Enforce deletion rules)

Delete object wrapper to prohibit deleting the contents of a record

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

RECORDSBUC@1.1001:OpenERMSObject (Reopen object)

Reopen a closed ERMS object and its children
ParameterTypeIn/OutOptionalDescription
descriptionCOOSYSTEM@1.1:STRINGinfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:PasteFromClipboardEx (Paste objects from clipboard)

Do not allow pasting duplicates into ERMS objects
ParameterTypeIn/OutOptionalDescription
sys_objectCOOSYSTEM@1.1:OBJECTinfalse
sys_actionCOOSYSTEM@1.1:OBJECTinfalse
sys_viewCOOSYSTEM@1.1:OBJECTinfalse
sys_selobjectsCOOSYSTEM@1.1:OBJECTLISTinfalse
sys_selindicesinfalse
sys_dynkeyinfalse
sys_branchattrinfalse
sys_branchindexinfalse

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:SelectClassificationScheme (Select Classification Scheme)

Select classification scheme
ParameterTypeIn/OutOptionalDescription
selectedschemeCOOSYSTEM@1.1:OBJECToutfalse
schemelistCOOSYSTEM@1.1:OBJECTLISTin/outtrue
targetfolderCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUC@1.1001:UnshareObjectEx (Remove Object)

Prohibit unsharing an object from within a classification scheme. Separate usecase is required in order to fix a DUCX parameter problem.
ParameterTypeIn/OutOptionalDescription
venv_objectCOOSYSTEM@1.1:OBJECTinfalse
venv_viewCOOSYSTEM@1.1:OBJECTinfalse
venv_parentCOOSYSTEM@1.1:OBJECTinfalse
venv_indexCOOSYSTEM@1.1:INTEGERinfalse
venv_actionCOOSYSTEM@1.1:OBJECTinfalse
sys_branchattrintrue
sys_branchindexintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

RECORDSBUCEXT@1.1001:InitializeWrapper (Initialize business context of ERMS object)

Initialize the business context of an ERMS object
ParameterTypeIn/OutOptionalDescription
target_objectCOOSYSTEM@1.1:OBJECTintrue the target object
target_attrdefCOOSYSTEM@1.1:OBJECTintrue the target property
templateCOOSYSTEM@1.1:OBJECTintrue the template
param_objectsCOOSYSTEM@1.1:OBJECTLISTintrue the parameter objects

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Private: true


[top]

RECORDSDD@1.1001:CloseERMSObjectInWF (Close)

Close ERMSObject

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSDD@1.1001:ProlongRetention (Prolong Retention)

Select a retention schedule

Additional Information

Access Types: COOSYSTEM@1.1:AccTypeChange
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:AttrAccRestrictionsSet (Set time-constrained access restrictions)

Set action can be overridden with project-specific implementations

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:AttrContainsChildrenCopy (Copy children of "Contains" property)

Copy children of an ERMS object

Additional Information

Prototype: COOSYSTEM@1.1:AttrCopyPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:AttrContainsSet (Set "Contains" property)

Set RECORDSOM@1.1001:contains property and check if it contains valid objects

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:AttrRefersToSet (Set "Refers to" property)

Initialize an object when it is attached to an ERMS object

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:CheckAllowedChildren (Check allowed children)

Check if children are allowed in object list. If object classes instead of ordinary objects are passed in the children parameter, check whether these object classes are allowed in attrdef.
ParameterTypeIn/OutOptionalDescription
childrenCOOSYSTEM@1.1:OBJECTLISTinfalse the objects or object classes to check
allowedCOOSYSTEM@1.1:BOOLEANoutfalse
throwerrorCOOSYSTEM@1.1:BOOLEANintrue
attrdefCOOSYSTEM@1.1:OBJECTintrue the attribute definition
modeCOOSYSTEM@1.1:CheckAllowedModeintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:GetAllowedChildClassesSettings (Get child class settings)

Returns the child class settings from the parent class or classification scheme
ParameterTypeIn/OutOptionalDescription
settingsCOOSYSTEM@1.1:OBJECToutfalse

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:GetContainsObjects (Get "Contains" objects)

Retrieves objects within the property RECORDSOM@15.1001:contains and returns "null" if no such property is present.

This way an easy and unified way of retrieving objects within contains is provided that is independent of the current object class.
ParameterTypeIn/OutOptionalDescription
containsobjsCOOSYSTEM@1.1:OBJECTLISToutfalse Objects within contains, and depending on recursive also subordinate objects. Returns "null" if target object does not have the property contains.
recursiveCOOSYSTEM@1.1:BOOLEANinfalse If "true" also subordinate objects are traversed and included by using COOSYSTEM@1.1:GetAttributeRecursiveand. Objects within the property contains are retrieved down to the level including Record, but excluding MetadataStub. Thus no components like content objects that may be part of a record are included.

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:GetTopLevelObject (Get top-level object)

Returns the nearest object with a object class topobjclass by walking up the hierarchy through the attribute attrdef starting with the current object. If called on an object with the object class Class and topobjclass being Class, it returns the object itself.
ParameterTypeIn/OutOptionalDescription
toplevelobjectCOOSYSTEM@1.1:OBJECToutfalse Resulting top level object with an object class topobjclass that is superordinate to the current object.
topobjclassCOOSYSTEM@1.1:OBJECTintrue Object class to search for. If "null", the top object of the whole hierarchy is returned.
attrdefCOOSYSTEM@1.1:OBJECTintrue Attribute used to walk up the hierarchy. If "null", the attribute RECORDSOM@1.1001:refersto is used.

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:ProcessAccessRestrictions (Process access restrictions)

Process time constrained access restrictions

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]