Actions of Integration for Portals (FSCPORTAL@1.1001)

ReferenceName
FSCPORTAL@1.1001:AttrCfgAuthPortalListGet
FSCPORTAL@1.1001:CreateObject
FSCPORTAL@1.1001:FinalizeCommit
FSCPORTAL@1.1001:GetInboxList
FSCPORTAL@1.1001:GetObjectByID
FSCPORTAL@1.1001:Initialize
FSCPORTAL@1.1001:InitializeFromDictionary
FSCPORTAL@1.1001:IsAuthorizedPortal
FSCPORTAL@1.1001:PrepareCreatedObject
FSCPORTAL@1.1001:ValidateAccount

FSCPORTAL@1.1001:AttrCfgAuthPortalListGet

Additional Information

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


[top]

FSCPORTAL@1.1001:CreateObject

Friendly URL for creating an object based on HTML form data. The created object will be stored in the "form inbox" identified by the form data with name "inbox" in the object pointer property returned by FSCPORTAL@1.1001:GetInboxList.

Note: This method commits the current transaction. The following form data has to be provided in the HTTP POST request:
  • inbox: The identifier of an object that provides an object pointer property for multiple values by FSCPORTAL@1.1001:GetInboxList. The user (in general identified by the FSCCONFIG@1.1001:EvaluateExpression with context FSCPORTAL@1.1001:FormPoster) must have set access for the property returned by FSCPORTAL@1.1001:GetInboxList of the object identified by inbox.
    Classes that implement FSCPORTAL@1.1001:GetInboxList are:
    FSCPORTAL@1.1001:FormInbox using FSCPORTAL@1.1001:inboxobjs as object pointer property
    FSCTEAMROOM@1.1001:InboxRoom using FSCTEAMROOM@1.1001:ibrchildren as object pointer property
  • objectclass: Fully-qualified reference of the object class of which an object should be instantiated. The created object will be initialized by calling FSCPORTAL@1.1001:InitializeFromDictionary. Before, FSCPORTAL@1.1001:PrepareCreatedObject is invoked on the form inbox object.
  • objecttemplate: The address of a template object that will be copied. The new object will be initialized by calling FSCPORTAL@1.1001:InitializeFromDictionary. Before, FSCPORTAL@1.1001:PrepareCreatedObject is invoked on the form inbox object.
  • redirect: Redirect URL to be invoked after successful creation and initialization of the new object(s). This must be an absolute URL including protocol and host. For security reason the host of this URL must match the referrer (HTTP header "Referer" or "Origin") of the page containing the form. The URL must not be a relative URL.
  • errorredirect: Redirect URL to be invoked when a failure occurs (e.g. during creation or initialization of the new object).
    Error code and error message will be passed in URL parameters errorcode and error
    For security reason the host of this URL must match the referrer (HTTP header "Referer" or "Origin") of the page containing the form. The URL must not be a relative URL.
  • redirecttype: Defines how the redirect should be executed.
    Valid values are "302", "303", "307", all other values will be ignored. By default the redirect is executed on the client by script or meta tag http-equiv="REFRESH". If this form field is set the redirect is initiated on the server by responding with the appropriate http status code and the URL in the http header "Location".
ParameterTypeIn/OutOptionalDescription
resultCOOSYSTEM@1.1:STRINGout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:FinalizeCommit

ParameterTypeIn/OutOptionalDescription
attrlistCOOSYSTEM@1.1:OBJECTLISTin

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:GetInboxList

Returns the object pointer property where to store the objects created in FSCPORTAL@1.1001:CreateObject. The method must provide an object list property to act as form inbox. FSCPORTAL@1.1001:FormInbox will use FSCPORTAL@1.1001:inboxobjs as object list property. The InboxRoom will use FSCTEAMROOM@1.1001:ibrchildren as object list property for the new objects.
ParameterTypeIn/OutOptionalDescription
inboxlistCOOSYSTEM@1.1:OBJECTretval

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:GetObjectByID

Get object by an ID passed in to FSCPORTAL@1.1001:CreateObject. The action will be executed on the current user (for inbox), the inbox (for objectclass and objecttemplate) or the created object (for objcategory and attachmentattrdef).
ParameterTypeIn/OutOptionalDescription
inboxCOOSYSTEM@1.1:OBJECTin The inbox where the object is/will be created.
typeCOOSYSTEM@1.1:STRINGin The type of object. The identifier of the request parameter is used. Currently it is used for inbox, objectclass, objecttemplate, objcategory and attachmentattrdef.
idCOOSYSTEM@1.1:STRINGin The id of the object, may be an address or reference, depending on type
resultCOOSYSTEM@1.1:OBJECTretval The object or null if the id does not result in a valid object for type

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:Initialize

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:InitializeFromDictionary

Initializes an object with the values provided in a dictionary.

The requestdict dictionary allows you to access the submitted form data.

This method is invoked by action FSCPORTAL@1.1001:CreateObject used for friendly URL "createobject". A default implementation exists for BasicObject, CompoundObject and ContentObject. The default implementation will set the following properties:
  • objname: The name of the object (COOSYSTEM@1.1:objname).
  • objsubject: The subject of the object (COOSYSTEM@1.1:objsubject).
  • objcategory: The category of the object (COOTC@1.1001:objcategory) identified in requestdict by its full reference or object address.
    In addition, the method checks whether there are values in requestdict that match properties defined by the category (COOTC@1.1001:categoryattributes). The properties of the category are identified in requestdict by their short reference, full reference, or object address.
  • Moreover it is possible to set scalar properties that can be changed in the property editor. These properties are identified in requestdict by their full reference or object address. You may use the short reference, too. But if two properties exist with the same short reference it is not determined which property will be set. So it is recommended to use the full reference.
  • content: The content of the object (COOSYSTEM@1.1:content). If objname is not set the name of the object will be extracted from the file name of this field.
    Note: The form data of this entry must not be multiple (see attachmentkeys below).
You may also create (multiple) content objects within a compound object:
  • attachmentattrdef: Defines the object pointer property where to store the content objects (e.g. COOSYSTEM@1.1:objchildren for a COODESK@1.1:Folder).
  • attachmentkeys: A comma separated list of entry names found in requestdict. These entries refer to files submitted in the http request. It may also be possible to define the HTML form field as multiple to submit more than one file in one request. For each submitted file an object is created in the list defined by attachmentattrdef. The object class and the object name for these objects will be retrieved from the name and extension of the file. In addition FSCPORTAL@1.1001:PrepareCreatedObject is invoked on each attached object.
You may override this action for your own class. In that case you have to check the values in requestdict and use them to initialize your objects. Please note that the method will remove the entries mentioned above from the dictionary after setting the appropriate properties.

If files were submitted with the form, the temporary file paths to access the submitted files are stored in respective dictionary entries, and the contents can be retrieved by creating a new content and invoking the CooContent::SetFile() method on it.
ParameterTypeIn/OutOptionalDescription
requestdictCOOSYSTEM@1.1:DICTIONARYin
parentCOOSYSTEM@1.1:OBJECTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:IsAuthorizedPortal

ParameterTypeIn/OutOptionalDescription
portalipaddrCOOSYSTEM@1.1:STRINGin
portalcertsubjectCOOSYSTEM@1.1:STRINGintrue
authorizedCOOSYSTEM@1.1:BOOLEANout

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:PrepareCreatedObject

Prepares a created object in an inbox. By default the teamroom of the inbox object will be assigned to the created object.
ParameterTypeIn/OutOptionalDescription
createdobjectCOOSYSTEM@1.1:OBJECTin

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

FSCPORTAL@1.1001:ValidateAccount

ParameterTypeIn/OutOptionalDescription
userlognameCOOSYSTEM@1.1:STRINGin
grouplognamesCOOSYSTEM@1.1:STRINGLISTintrue
portaluserattributekeysCOOSYSTEM@1.1:STRINGLISTintrue
portaluserattributevaluesCOOSYSTEM@1.1:STRINGLISTintrue

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]