Ansicht
Dokumentation

SO_DOCUMENT_MOVE_API1 - SAPoffice: Ablegen eines Dokumentes in eine andere Mappe von Extern (RFC)

TXBHW - Original Tax Base Amount in Local Currency   rdisp/max_wprun_time - Maximum work process run time  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Funktionalität

Dieser Funktionsbaustein ermöglicht das Ablegen von zu Dokumenten oder Verteilerlisten gehörenden Mappeneinträgen in eine andere Mappe. Es wird dabei der alte Mappeneintrag gelöscht und ein neuer Eintrag mit den ursprünglichen Eigenschaften in der Zielmappe erzeugt.

Importparameter

OLD_DOCUMENT_ID

ID des abzulegenden Mappeneintrags. Sie beinhaltet die Verbindung zwischen dem Dokument bzw. der Verteilerliste und der Mappe, in der es liegt.

NEW_FOLDER_ID

Objekt-ID der Mappe, in die der Mappeneintrag abgelegt werden soll.

Exportparameter

NEW_DOCUMENT_ID

ID des neuen Mappeneintrags. Sie beinhaltet die Verbindung zwischen dem Dokument bzw. der Verteilerliste und der Mappe, in der es liegt.

Ausnahmen

NEW_FOLDER_NOT_EXIST

Die angegebene Zielmappe existiert nicht. Wahrscheinlich wurde eine falsche ID übergeben oder die betroffene Mappe mittlerweile gelöscht.

DOCUMENT_NOT_EXIST

Der angegebene Mappeneintrag existiert nicht. Wahrscheinlich wurde eine falsche ID übergeben oder der betroffene Mappeneintrag mittlerweile gelöscht.

DOCUMENT_ALREADY_IN_FOLDER

Das Dokument konnte nicht abgelegt werden, da sich in der Zielmappe bereits ein zum Dokument gehörender Mappeneintrag befindet.

OPERATION_NO_AUTHORIZATION

Der Mappeneintrag durfte nicht abgelegt werden. Dies kann daran liegen, daß versucht wurde, das Dokument aus oder in die persönliche Mappe eines anderen Benutzers abzulegen. Möglicherweise wurde auch ein Bereich der allgemeinen Ablage angesprochen, für die der aktive Benutzer nicht die benötigten Berechtigungen besitzt.

PARAMETER_ERROR

Es wurde dem Funktionsbaustein eine unzulässige Kombination von Parameterwerten übergeben. Wahrscheinlich wurde versucht, den Mappeneintrag in eine ungültige Mappe abzulegen. Hierunter fallen der Eingang, die Mappe für Wiedervorlagen, der persönliche sowie allgemeine Papierkorb und die Wurzelmappe der allgemeinen Ablage. Das Ablegen zwischen dem persönlichen Bereich eines Benutzers und der allgemeinen Ablage ist in beiden Richtungen nicht möglich.

ENQUEUE_ERROR

Eine für den Ablegevorgang benötigte Sperre konnte nicht gesetzt werden. Wahrscheinlich findet gerade eine Bearbeitung durch einen anderen Benutzer statt.

Beispiel

Ablegen der Dokumente im Ausgang des aktiven Benutzers in eine neu erzeugte Mappe in der persönlichen Ablage. Zum Erhalten der ID des Ausgangs und der persönlichen Ablage wird der Funktionsbaustein SO_USER_READ_API1 verwendet, der Inhalt des Ausgangs wird über den Funktionsbaustein SO_FOLDER_READ_API1 ermittelt. Zum Anlegen der Zielmappe wird der Funktionsbaustein SO_FOLDER_INSERT_API1 verwendet.

DATA: FOL_CONT LIKE SOFOLENTI1 OCCURS 20 WITH HEADER LINE.

DATA: USER_DATA LIKE SOUDATAI1.

DATA: FOL_CHNG LIKE SOFOLCHGI1.

DATA: NEW_FOLDER_ID LIKE SOFOLDATI1-OBJECT_ID.

CALL FUNCTION 'SO_USER_READ_API1'

IMPORTING

USER_DATA = USER_DATA

EXCEPTIONS

OTHERS = 1.

IF SY-SUBRC <> 0.

WRITE: / 'Die Benutzerdaten konnten nicht gelesen werden !'.

EXIT.

ENDIF.

CALL FUNCTION 'SO_FOLDER_READ_API1'

EXPORTING

FOLDER_ID = USER_DATA-OUTBOXFOL

TABLES

FOLDER_CONTENT = FOL_CONT

EXCEPTIONS

OTHERS = 1.

IF SY-SUBRC <> 0.

WRITE: / 'Der Ausgang konnte nicht gelesen werden !'.

EXIT.

ENDIF.

FOL_CHNG-OBJ_NAME = 'ABLAGE'.

FOL_CHNG-OBJ_DESCR = 'Abgelegte Dokumente aus dem Ausgang'.

FOL_CHNG-LANGU = SY-LANGU.

FOL_CHNG-SENSITIVTY = 'O'.

CALL FUNCTION 'SO_FOLDER_INSERT_API1'

EXPORTING

PARENT_FOLDER_ID = USER_DATA-PRIVATFOL

FOLDER_INSERT_DATA = FOL_CHNG

IMPORTING

FOLDER_ID = NEW_FOLDER_ID

EXCEPTIONS

OTHERS = 1.

IF SY-SUBRC <> 0.

WRITE: / 'Die neue Mappe konnte nicht angelegt werden !'.

EXIT.

ENDIF.

LOOP AT FOL_CONT.

CALL FUNCTION 'SO_DOCUMENT_MOVE_API1'

EXPORTING

OLD_DOCUMENT_ID = FOL_CONT-DOC_ID

NEW_FOLDER_ID = NEW_FOLDER_ID

EXCEPTIONS

OTHERS = 1.

IF SY-SUBRC <> 0.

WRITE: / 'Fehler beim Ablegen von Dokument', FOL_CONT-OBJ_DESCR.

CONTINUE.

ENDIF.

WRITE: / 'Dokument', FOL_CONT-OBJ_DESCR, 'wurde abgelegt.'.

ENDLOOP.

Hinweise

Zum Ablegen von Mappen muß der Funktionsbaustein SO_FOLDER_MOVE_API1 verwendet werden.

Um Dokumente zwischen der allgemeinen Ablage und dem persönlichen Bereich eines Benutzers abzulegen, muß auf die Funktionsbausteine SO_DOCUMENT_READ_API1, SO_DOCUMENT_INSERT_API1 und SO_DOCUMENT_DELETE_API1 zurückgegriffen werden.

Weiterführende Informationen

Hinweise zum Aufruf der Funktionsbausteine SO_USER_READ_API1, SO_FOLDER_READ_API1 und SO_FOLDER_INSERT_API1 finden sich in der Dokumentation der entsprechenden Funktionsbausteine.

Parameter

NEW_DOCUMENT_ID
NEW_FOLDER_ID
OLD_DOCUMENT_ID

Ausnahmen

DOCUMENT_ALREADY_IN_FOLDER
DOCUMENT_NOT_EXIST
ENQUEUE_ERROR
NEW_FOLDER_NOT_EXIST
OPERATION_NO_AUTHORIZATION
PARAMETER_ERROR
X_ERROR

Funktionsgruppe

SOI1

Fill RESBD Structure from EBP Component Structure   CL_GUI_FRONTEND_SERVICES - Frontend Services  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 7100 Date: 20240523 Time: 110832     sap01-206 ( 92 ms )