| Parameter | Reference | Type | Length | Default | Optional | Text |
|---|---|---|---|---|---|---|
| FOLDER_ID | SOOBJINFI1-OBJECT_ID | C | 17 | ID of folder to be read |
| Parameter | Reference | Type | Length | Text |
|---|---|---|---|---|
| FOLDER_DATA | SOFOLDATI1 | u | 361 | Complete attributes of read folder |
| Parameter | Reference | Length | Optional | Text |
|---|---|---|---|---|
| FOLDER_CONTENT | SOFOLENTI1 | 770 | Contents of folder |
| Exception | Text |
|---|---|
| FOLDER_NOT_EXIST | Specified folder does not exist |
| OPERATION_NO_AUTHORIZATION | No authorization to read folder |
| X_ERROR | Internal error or database inconsistency |
|
Functionality
Import parameters Export parameters Object ID of the folder. Name of the folder. Title (short description) of the folder. Language of the folder. Sort field of the folder. This term can be searched for in theattribute search. SAPoffice ID of the creator of the folder. SAPoffice name of the creator of the folder. The SAPoffice name isunique client-wide. Full name of the creator of the folder from the address management. Date folder was created. Time folder was created. SAPoffice ID of the person who last changed the folder. SAPoffice name of the person who last changed the folder. The SAPofficename is unique client-wide. Full name of the person who last changed the folder from the addressmanagement. Date of last change. Time of last change. SAPoffice ID of the owner of the folder. SAPoffice name of the owner of the folder. The SAPoffice name is uniqueclient-wide. Full name of the owner of the folder from the address management. Date folder was created/changed. Contains the latest of the two values. This field is not used. Sensitivity of the folder. A private folder can have the following sensitivity: 'O' : standard, normal sensitivity 'F' : functional, entry possible but no difference to standard 'P' : confidential, not visible to substitute Only the sensitivity 'O' is allowed for shared folders. This field is not used. This field is not used. Folder area. The following values are possible: 'P' : private folders 'Q' : shared folders Folder category. The following values are possible: 'P' : private folder 'M' : client folder 'G' : group folder Object ID of the parent folder. Number of child folders. Number of documents in the folder. Table parameters ID of the folder entry of the document. It is the connection betweenthe document and the folder in which it is located. Object ID of the document. Type of document. Name of document. Title (short description) of the document. Language of the document. Sort field of the document. This term can be searched for in theattribute search. SAPoffice ID of the creator of the document. SAPoffice name of the creator of the document. The SAPoffice name isunique client-wide. Full name of the creator of the document from the address management. Date document was created. Time document was created. SAPoffice ID of the person who last changed the document. SAPoffice name of the person who last changed the document. TheSAPoffice name is unique client-wide. Full name of the person who last changed the document from the addressmanagement. Date of last change. Time of last change. SAPoffice ID of the owner of the document. SAPoffice name of the owner of the document. The SAPoffice name isunique client-wide. Full name of the owner of the document from the address management. Date document was created/changed. Contains the latest of the twovalues. Expiration date of the document. The document itself cannot expire,however this date is used for the expiration date of the entry (fieldEXPIRY_DAT) for each new folder entry of the document. Sensitivity of the document. A private document can have the following sensitivity: 'O' : standard, normal sensitivity 'F' : functional, can be forwarded functionally 'P' : confidential, not visible to substitute Only the sensitivity 'O' is allowed for documents in the sharedfolders. Recipient priority. The document itself does not have a priority,however this value is used for the recipient priority of the entry(field PRIORITY) for each new folder entry of the document. If this flag is set ('X'), the document can only be changed by theauthor in the case of shared folder entries. In the case of privatefolder entries, it allows the author to make changes even once thedocument has been sent. Recipient priority of the folder entry. This value represents theimportance assigned to the entry by the owner after it has beenreceived. If this flag is set ('X'), the document has a correspondence history. If this field is initial (not equal to ' '), the folder entry is aresubmitted document. Date of the resubmission. If the document was sent internally, this field contains the SAPofficeID of the sender, if it was received from an external source, theaddress ID of the sender is entered. If the document was sent internally, this field contains the SAPofficename of the sender, if it was received from an external source, thename of the address ID of the sender is entered. If the document was sent internally, this field contains the full nameof the sender from the address management. An exact description of theaddress of the sender is inserted for documents received externally. Date of the send operation. Time of the send operation. SAPoffice ID of the forwarder of the document. SAPoffice name of the forwarder of the document. The SAPoffice name isunique client-wide. Full name of the forwarder of the document from the address management. Forwarding date. Forwarding time. If the document was sent internally, this field contains the SAPofficeID of the recipient, if it was sent externally, the address ID of therecipient is entered. If the document was sent internally, this field contains the SAPofficename of the recipient, if it was sent externally, the name of theaddress ID of the recipient is entered. If the document was sent internally, this field contains the full nameof the recipient from the address management. In the case of documentssent externally, an exact description of the address of the receiver isinserted. Date document was received. Time document was received. If this flag is set ('X'), the document was received with the 'express'attribute. If this flag is set ('X'), the document was received with the attribute'copy'. If this flag is set ('X'), the document was received with the attribute'blind copy'. As a result, it cannot be printed nor forwarded. If this flag is set ('X'), the document cannot be forwarded by therecipient. If this flag is set ('X'), the document cannot be printed by therecipient. If this flag is set ('X'), the recipient must reply to the documentbefore the relevant folder entry can be removed from the inbox. If this flag is set ('X'), the recipient must take action on thedocument before the relevant folder entry can be removed from theinbox. If this field has a value between '1' and '9', a user from therecipient group formed by this number must take action on the documentbefore the relevant folder entry can be removed from one of the inboxesinvolved. If the value '0' is entered, action is not required. Number of recipients who must take action on the document. Number of recipients who have accessed the document for processing. Number of recipients who have taken action on the document. Number of recipients who have received the document with the attribute'express'. Number of recipients who have received the document with the attribute'copy'. Number of recipients who have received the document with the attribute'blind copy'. Number of recipients who must reply to the document. Number of recipients who have replied to the document. Number of recipients who have viewed the document. Number of persons who have received the document visibly to allrecipients. To obtain the complete number of recipients, the number ofblind copies in C_BLIND_CP must be added to this value. If this field is not initial (not ' '), the document can be processed. The following values are possible: 'D' : dialog module 'F' : function module 'R' : report 'S' : report with value transfer to global memory 'T' : transaction 'U' : transaction with value transfer to global memory Processing element. Depending on the entry in the field PROC_TYPE, thename of the dialog module, function module, report, or transaction isspecified. Name of the system in which the document is to be processed. If nosystem is specified or the value '*', processing is possible in anysystem. Client in which the document is to be processed. If no client isspecified or the value '*', processing is possible in any client. If this flag is set ('X'), the first screen is skipped in theprocessing. If this flag is set ('X'), the document cannot be acted upon from theSAPoffice interface. Processing must be carried out outside SAPofficevia the API function module SO_DOCUMENT_SET_STATUS_API1. If this flag is set ('X'), the document can also be deleted in otherfolders via the API. If the folder entry is a received document and this flag is set ('X'),it has already been viewed. Date whe the document was read. Time when the document was read. Status of the folder entry regarding action to be taken. The following values are possible: 'TAAC' : Still ToDo 'INPR' : In process 'ACCO' : Done If this flag is set ('X'), the folder entry still needs to be actedupon. If this flag is set ('X'), the folder entry has already been repliedto. If this flag is set ('X'), the folder entry is a viewed resubmitteddocument. Expiration date of the folder entry. If the expiration has been reachedor exceeded, the entry is placed in the private trash and can beretrieved from there if necessary before the trash is next emptied. Anew folder entry is initially provided with the expiration date of thedocument from the field OBJ_EXPDAT. Size of the document in bytes. Exceptions Example Notes Further information |