Kontakt

Ansicht
Dokumentation

SO_FOLDER_READ_API1 - SAPoffice: Lesen des Inhalts einer Mappe für Externe (RFC)

SO_FOLDER_READ_API1 - SAPoffice: Lesen des Inhalts einer Mappe für Externe (RFC)

General Data in Customer Master   TXBHW - Original Tax Base Amount in Local Currency  
Diese Dokumentation steht unter dem Copyright der SAP AG.
SAP E-Book

Funktionalität

Dieser Funktionsbaustein liefert alle Informationen zu einer Mappe.
Dazu gehören:

  • die Eigenschaften der Mappe (z.B. Name, Beschreibung, Ersteller, Erstellungsdatum, Besitzer, Mappenbereich)
  • der Inhalt der Mappe

Importparameter

FOLDER_ID
Objekt-ID der zu lesenden Mappe.

Exportparameter

FOLDER_DATA
Diese Struktur enthält die Eigenschaften der gelesenen Mappe.
  • OBJECT_ID
Objekt-ID der Mappe.
  • OBJ_NAME
Name der Mappe.
  • OBJ_DESCR
Titel (kurze Beschreibung) der Mappe.
  • OBJ_LANGU
Sprache der Mappe.
  • OBJ_SORT
Sortierfeld der Mappe. Nach diesem Begriff kann in der Attributsuche gesucht werden.
  • CREATOR_ID
SAPoffice-ID des Erstellers der Mappe.
  • CREAT_NAME
SAPoffice-Name des Erstellers der Mappe. Der SAPoffice-Name ist mandantenweit eindeutig.
  • CREAT_FNAM
Vollständiger Name des Ersteller der Mappe aus der Adreßverwaltung.
  • CREAT_DATE
Erstellungsdatum der Mappe.
  • CREAT_TIME
Erstellungszeit der Mappe.
  • CHANGER_ID
SAPoffice-ID des letzten Änderers der Mappe.
  • CHANG_NAME
SAPoffice-Name des letzten Änderers der Mappe. Der SAPoffice-Name ist mandantenweit eindeutig.
  • CHANG_FNAM
Vollständiger Name des letzten Änderers der Mappe aus der Adreßverwaltung.
  • CHANG_DATE
Datum der letzten Änderung.
  • CHANG_TIME
Uhrzeit der letzten Änderung.
  • OWNER_ID
SAPoffice-ID des Besitzers der Mappe.
  • OWNER_NAM
SAPoffice-Name des Besitzers der Mappe. Der SAPoffice-Name ist mandantenweit eindeutig.
  • OWNER_FNAM
Vollständiger Name des Besitzers der Mappe aus der Adreßverwaltung.
  • LAST_ACCESS
Erstellungs-/Änderungsdatum der Mappe. Enthält den neueren der beiden Werte.
  • OBJ_EXPDAT
Dieses Feld wird nicht verwendet.
  • SENSITIVTY
Sensitivität der Mappe.
Eine persönliche Mappe kann folgende Sensitivität besitzen:
  • 'O' : Standard, normale Sensitivität

  • 'F' : Funktional, Angabe möglich, jedoch kein Unterschied zu Standard

  • 'P' : Vertraulich, für Vertreter nicht sichtbar

Bei allgemeinen Mappen ist nur die Sensitivität 'O' zulässig.
  • OBJ_PRIO
Dieses Feld wird nicht verwendet.
  • NO_CHANGE
Dieses Feld wird nicht verwendet.
  • FOLREGION
Mappenbereich.
Es sind folgende Werte möglich:
  • 'P' : private Ablage

  • 'Q' : allgemeine Ablage

  • FOLSECTION
Mappenkategorie.
Es sind folgende Werte möglich:
  • 'P' : private Mappe

  • 'M' : Mandantenmappe

  • 'G' : Gruppenmappe

  • PARENTFOL
Objekt-ID der Eltermappe.
  • NO_ENTRIES
Anzahl der Tochtermappen.
  • NO_DOC
Anzahl der Dokumente in der Mappe.

Tabellenparameter

FOLDER_CONTENT
Diese Tabelle enthält die Eigenschaften der in der Mappe vorkommenden Dokumente inklusiv weiterer Mappen und Verteilerlisten. Jede Zeile steht für einen Eintrag.
  • DOC_ID
ID des Mappeneintrags des Dokuments. Sie beinhaltet die Verbindung zwischen dem Dokument und der Mappe, in der es vorkommt.
  • OBJECT_ID
Objekt-ID des Dokuments.
  • OBJ_TYPE
Typ des Dokuments.
  • OBJ_NAME
Name des Dokuments
  • OBJ_DESCR
Titel (kurze Beschreibung) des Dokuments.
  • OBJ_LANGU
Sprache des Dokuments.
  • OBJ_SORT
Sortierfeld des Dokuments. Nach diesem Begriff kann in der Attributsuche gesucht werden.
  • CREATOR_ID
SAPoffice-ID des Erstellers des Dokuments.
  • CREAT_NAME
SAPoffice-Name des Erstellers des Dokuments. Der SAPoffice-Name ist mandantenweit eindeutig.
  • CREAT_FNAM
Vollständiger Name des Erstellers des Dokuments aus der Adreßverwaltung.
  • CREAT_DATE
Erstellungsdatum des Dokuments.
  • CREAT_TIME
Erstellungszeit des Dokuments.
  • CHANGE_ID
SAPoffice-ID des letzten Änderers des Dokuments.
  • CHANG_NAME
SAPoffice-Name des letzten Änderers des Dokuments. Der SAPoffice-Name ist mandantenweit eindeutig.
  • CHANG_FNAM
Vollständiger Name des letzten Änderers des Dokuments aus der Adreßverwaltung.
  • CHANG_DATE
Datum der letzten Änderung.
  • CHANG_TIME
Uhrzeit der letzten Änderung.
  • OWNER_ID
SAPoffice-ID des Besitzers des Dokuments.
  • OWNER_NAM
SAPoffice-Name des Besitzers des Dokuments. Der SAPoffice-Name ist mandantenweit eindeutig.
  • OWNER_FNAM
Vollständiger Name des Besitzers des Dokuments aus der Adreßverwaltung.
  • LAST_ACCES
Erstellungs-/Änderungsdatum des Dokuments. Enthält den neueren der beiden Werte.
  • OBJ_EXPDAT
Verfallsdatum des Dokuments. Das Dokument selbst kann nicht verfallen, bei jedem neuen Mappeneintrag des Dokuments wird jedoch dieses Datum als Vorlage für das Verfallsdatum des Eintrags (Feld EXPIRY_DAT) verwendet.
  • SENSITIVTY
Sensitivität des Dokuments.
Ein persönliches Dokument kann folgende Sensitivität besitzen:
  • 'O' : Standard, normale Sensitivität

  • 'F' : Funktional, kann funktional weitergeleitet werden

  • 'P' : Vertraulich, für Vertreter nicht sichtbar

Bei Dokumenten in der allgemeinen Ablage ist nur die Sensitivität 'O' zulässig.
  • OBJ_PRIO
Empfängerpriorität. Das Dokument selbst besitzt keine Priorität, bei jedem neuen Mappeneintrag des Dokuments wird jedoch dieser Wert als Vorlage für die Empfängerpriorität des Eintrags (Feld PRIORITY) verwendet.
  • NO_CHANGE
Wenn dieses Flag gesetzt ('X') ist, kann das Dokument über allgemeine Mappeneinträge nur vom Autor geändert werden. Bei persönlichen Mappeneinträgen ermöglicht es dem Autor, Änderungen auch nach dem Versenden noch durchzuführen.
  • PRIORITY
Empfängerpriorität des Mappeneintrags. Dieser Wert gibt die dem Eintrag vom Besitzer zugeordnete Wichtigkeit nach dem Empfangen wieder.
  • HISTORY
Wenn dieses Flag gesetzt ('X') ist, existiert zu dem Dokument eine Briefwechselgeschichte.
  • RESUB
Wenn dieses Feld nicht initial (ungleich ' ') ist, handelt es sich bei dem Mappeneintrag um ein wiedervorgelegtes Dokument.
  • RESUB_DATE
Datum der Wiedervorlage.
  • SENDER_ID
Wenn das Dokument intern versendet wurde, enthält dieses Feld die SAPoffice-ID des Senders, wenn es von extern empfangen wurde, ist die Adreß-ID des Absenders eingetragen.
  • SEND_NAM
Wenn das Dokument intern versendet wurde, enthält dieses Feld den SAPoffice-Namen des Senders, wenn es von extern empfangen wurde, ist der Name der Adreß-ID des Absenders eingetragen.
  • SEND_FNAM
Wenn das Dokument intern versendet wurde, enthält dieses Feld den vollständigen Namen des Senders aus der Adreßverwaltung. Bei extern empfangenen Dokumenten wird eine möglichst genaue Beschreibung der Adresse des Absenders eingefügt.
  • SEND_DATE
Datum des Sendevorgangs.
  • SEND_TIME
Uhrzeit des Sendevorgangs.
  • FORWARD_ID
SAPoffice-ID des Weiterleitenden des Dokuments.
  • FORW_NAM
SAPoffice-Name des Weiterleitenden des Dokuments. der SAPoffice-Name ist mandantenweit eindeutig.
  • FORW_FNAM
Vollständiger Name der Weiterleitenden des Dokuments aus der Adreßverwaltung.
  • FORW_DATE
Datum des Weiterleitens.
  • FORW_TIME
Uhrzeit des Weiterleitens.
  • REC_ID
Wenn das Dokument intern versendet wurde, enthält dieses Feld die SAPoffice-ID des Empfängers, wenn es extern versendet wurde, ist die Adreß-ID des Empfängers eingetragen.
  • REC_NAM
Wenn das Dokument intern versendet wurde, enthält dieses Feld den SAPoffice-Names des Empfängers, wenn es extern versendet wurde, ist der Name der Adreß-ID des Empfängers eingetragen.
  • REC_FNAM
Wenn das Dokument intern versendet wurde, enthält dieses Feld den vollständigen Namen des Empfängers aus der Adreßverwaltung. Bei extern versendeten Dokumenten wird eine möglichst genaue Beschreibung der Adresse des Empfängers eingefügt.
  • REC_DATE
Empfangsdatum des Dokuments.
  • REC_TIME
Empfangszeit des Dokuments.
  • EXPRESS
Wenn dieses Flag gesetzt ('X') ist, wurde das Dokument mit dem Attribut 'Expreß' empfangen.
  • COPY
Wenn dieses Flag gesetzt ('X') ist, wurde das Dokument mit dem Attribut 'Kopie' empfangen.
  • BLIND_COPY
Wenn dieses Flag gesetzt ('X') ist, wurde das Dokument mit dem Attribut 'geheime Kopie' empfangen. Als Folge davon kann es weder ausgedruckt noch weitergeleitet werden.
  • NO_FORWARD
Wenn dieses Flag gesetzt ('X') ist, kann das Dokument vom Empfänger nicht weitergeleitet werden.
  • NO_PRINT
Wenn dieses Flag gesetzt ('X') ist, kann das Dokument vom Empfänger nicht ausgedruckt werden.
  • TO_ANSWER
Wenn dieses Flag gesetzt ('X') ist, muß der Empfänger auf das Dokument antworten, bevor er den zugehörenden Mappeneintrag aus seinem Eingang entfernen kann.
  • TO_DO_EXPL
Wenn dieses Flag gesetzt ('X') ist, muß der Empfänger das Dokument erledigen, bevor er den zugehörenden Mappeneintrag aus seinem Eingang entfernen kann.
  • TO_DO_GRP
Wenn dieses Feld einen Wert zwischen '1' und '9' besitzt, muß ein Benutzer der durch diese Zahl verbundenen Empfängergruppe das Dokument erledigen, bevor der zugehörende Mappeneintrag aus einem der betroffenen Eingängen entfernt werden kann. Wenn der Wert '0' eingetragen ist, ist kein Erledigen erforderlich.
  • C_TO_DO
Anzahl der Empfänger, die das Dokument erledigen müssen.
  • C_IN_PROC
Anzahl der Empfänger, die das Dokument in Bearbeitung genommen haben.
  • C_DONE
Anzahl der Empfänger, die das Dokument erledigt haben.
  • C_EXPRESS
Anzahl der Empfänger, die das Dokument mit dem Attribut 'Expreß' erhalten haben.
  • C_COPY
Anzahl der Empfänger, die das Dokument mit dem Attribut 'Kopie' erhalten haben.
  • C_BLIND_CP
Anzahl der Empfänger, die das Dokument mit dem Attribut 'geheime Kopie' erhalten haben.
  • C_TO_REPLY
Anzahl der Empfänger, die auf das Dokument antworten müssen.
  • C_ANSWERED
Anzahl der Empfänger, die auf das Dokument geantwortet haben.
  • C_READ
Anzahl der Empfänger, die das Dokument gelesen haben.
  • C_RECEIVER
Anzahl der Personen, die das Dokument für alle Empfänger sichtbar erhalten haben. Um die komplette Anzahl der Empfänger zu erhalten, muß zu diesem Wert die Anzahl der geheimen Kopien in C_BLIND_CP addiert werden.
  • PROC_TYPE
Wenn dieses Feld nicht initial (ungleich ' ') ist, kann das Dokument verarbeitet werden.
Es sind folgende Werte möglich:
  • 'D' : Dialogbaustein

  • 'F' : Funktionsbaustein

  • 'R' : Report

  • 'S' : Report mit Übergabe von Werten ins globale Memory

  • 'T' : Transaktion

  • 'U' : Transaktion mit Übergabe von Werten ins globale Memory

  • PROC_NAME
Verarbeitungselement. Es ist entsprechend der Angabe im Feld PROC_TYPE der Name des Dialogbausteins, Funktionsbausteins, Reports oder der Transaktion angegeben.
  • PROC_SYST
Name des Systems, in dem das Dokument verarbeitet werden soll. Wenn kein System oder der Wert '*' angegeben ist, dann ist eine Verarbeitung in jedem System möglich.
  • PROC_CLINT
Mandant, in dem das Dokument verarbeitet werden soll. Wenn kein Mandant oder der Wert '*' angegeben ist, dann ist eine Verarbeitung in jedem Mandanten möglich.
  • SKIP_SCREN
Wenn dieses Flag gesetzt ('X') ist, wird bei der Verarbeitung das erste Dynpro übersprungen.
  • TO_DO_OUT
Wenn dieses Flag gesetzt ('X') ist, kann das Dokument nicht von der SAPoffice-Oberfläche aus erledigt werden. Eine Bearbeitung muß außerhalb von SAPoffice über den API-Funktionsbaustein SO_DOCUMENT_SET_STATUS_API1 erfolgen.
  • FREE_DEL
Wenn dieses Flag gesetzt ('X') ist, kann das Dokument über die API auch in fremden Mappen gelöscht werden.
  • READ
Wenn es sich bei dem Mappeneintrag um ein empfangenes Dokument handelt und dieses Flag gesetzt ('X') ist, wurde er bereits gelesen.
  • READ_DATE
Datum, an dem das Dokument gelesen wurde.
  • READ_TIME
Uhrzeit, zu der das Dokument gelesen wurde.
  • TO_DO_STAT
Status des Mappeneintrags bezüglich Erledigung.
Es sind folgende Werte möglich:
  • 'TAAC' : noch zu erledigen

  • 'INPR' : in Bearbeitung

  • 'ACCO' : erledigt

  • STILL_TODO
Wenn dieses Flag gesetzt ('X') ist, muß der Mappeneintrag noch erledigt werden.
  • REPLY_SENT
Wenn dieses Flag gesetzt ('X') ist, wurde auf den Mappeneintrag bereits geantwortet.
  • RESUB_READ
Wenn dieses Flag gesetzt ('X') ist, handelt es sich bei dem Mappeneintrag um ein bereits gelesenes wiedervorgelegtes Dokument.
  • EXPIRY_DAT
Verfallsdatum des Mappeneintrags. Wenn das Verfallsdatum erreicht ist oder überschritten wird, wird der Eintrag in den persönlichen Papierkorb gestellt und kann von dort vor der nächsten Entleerung bei Bedarf zurückgeholt werden. Ein neuer Mappeneintrag wird anfänglich mit dem Verfallsdatum des Dokuments aus dem Feld OBJ_EXPDAT versorgt.
  • DOC_SIZE
Größe des Dokuments in Byte.

Ausnahmen

FOLDER_NOT_EXIST
Die angegebene Mappe existiert nicht. Wahrscheinlich wurde entweder eine falsche ID übergeben oder die betroffenen Mappe mittlerweile gelöscht.
OPERATION_NO_AUTHORIZATION
Die angegebene Mappe durfte nicht gelesen werden. Dies kann z.B. daran liegen, daß es sich um die persönliche Mappe eines anderen Benutzers oder eine Mappe der allgemeinen Ablage, für die der aktive Benutzer keine Zugriffsberechtigung besitzt, handelt. Auf Mappen im allgemeinen Papierkorb darf nur der SAPoffice-Administrator zugreifen.
X_ERROR
Es ist ein interner Fehler oder eine Datenbankinkonsistenz aufgetreten.

Beispiel

Lesen des Eingangs des aktiven Benutzers mit anschließendem Auflisten der darin enthaltenen Dokumente. Zum Erhalten der ID des Eingangs wird der Funktionsbaustein SO_USER_READ_API1 verwendet.

DATA: FOL_CONT LIKE SOFOLENTI1 OCCURS 10 WITH HEADER LINE.
DATA: USER_DATA LIKE SOUDATAI1.
CALL FUNCTION 'SO_USER_READ_API1'
EXPORTING
PREPARE_FOR_FOLDER_ACCESS = 'X'
IMPORTING
USER_DATA = USER_DATA
EXCEPTIONS
OTHERS = 1.
IF SY-SUBRC <> 0.
WRITE: / 'Der Eingang konnte nicht gelesen werden !'.
EXIT.
ENDIF.
CALL FUNCTION 'SO_FOLDER_READ_API1'
EXPORTING
FOLDER_ID = USER_DATA-INBOXFOL
TABLES
FOLDER_CONTENT = FOL_CONT
EXCEPTIONS
FOLDER_NOT_EXIST = 1
OPERATION_NO_AUTHORIZATION = 2
OTHERS = 99.
CASE SY-SUBRC.
WHEN 0.
WRITE: 'Im Eingang sind folgende Dokumente:'.
LOOP AT FOL_CONT.
WRITE: / FOL_CONT-OBJ_NAME, FOL_CONT-OBJ_DESCR.
ENDLOOP.
WHEN 1.
WRITE: / 'Die Eingangsmappe des Benutzers', sy-uname,
'existiert nicht !'.
WHEN 2.
WRITE: / 'Keine Berechtigung zum Lesen des Eingangs !'.
ENDCASE.

Hinweise

Zum Lesen von Dokumenten oder Verteilerlisten müssen die Funktionsbausteine SO_DOCUMENT_READ_API1 bzw. SO_DLI_READ_API1 verwendet werden.

Um eine Mappenhierarchie ausgehend von einer bestimmten Mappe zu erhalten, kann der Funktionsbaustein SO_FOLDER_HIERARCHY_READ_API1 verwendet werden.

Weiterführende Informationen

Informationen zum Aufruf des Funktionsbausteins SO_USER_READ_API1 finden sich in der Dokumentation dieses Funktionsbausteins.





Parameter

FOLDER_CONTENT
FOLDER_DATA
FOLDER_ID

Ausnahmen

FOLDER_NOT_EXIST
OPERATION_NO_AUTHORIZATION
X_ERROR

Funktionsgruppe

SOI1

CL_GUI_FRONTEND_SERVICES - Frontend Services   CL_GUI_FRONTEND_SERVICES - Frontend Services  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 23993 Date: 20240523 Time: 084549     sap01-206 ( 209 ms )