Kontakt

Ansicht
Dokumentation

SO_DOCUMENT_SET_STATUS_API1 - SAPoffice: Setzen verschiedener Stati von Extern (via RFC)

SO_DOCUMENT_SET_STATUS_API1 - SAPoffice: Setzen verschiedener Stati von Extern (via 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 ermöglicht das Setzen eines Dokumentstatus. Der angegebene Mappeneintrag kann auf 'gelesen', 'in Bearbeitung' und 'erledigt' gesetzt werden.

Es muß hier zwischen dem Dokument und seinen Mappeneinträgen unterschieden werden. Das Dokument selbst ist nur einmal auf der Datenbank vorhanden. Es dient als Vorlage für die Mappeneinträge und kann mittels seiner Objekt-ID angesprochen werden. Zu dem Dokument können eine beliebige Anzahl von Mappeneinträgen gehören. Diese besitzen den Inhalt und die Eigenschaften des Dokuments sowie einige zusätzliche, auf den Mappeneintrag bezogene Attribute. Hierunter fällt u.a. auch der aktuelle Status. Mappeneinträge entstehen beim Wiedervorlegen, Verweisen und Versenden sowie beim Anlegen eines neuen Dokuments.

Importparameter

DOCUMENT_ID
ID des Mappeneintrags des zu ändernden Dokuments. Sie beinhaltet die Verbindung zwischen dem Dokument und der Mappe, in der es liegt.
STATUS
Default = 'READ'.
Neuer Status für das Dokument.
Es sind folgende Werte zulässig:
  • 'READ' : setzt das Dokument auf 'gelesen'

  • 'INPR' : setzt das Dokument auf 'in Bearbeitung'

  • 'ACCO' : setzt das Dokument auf 'erledigt'

Der Status 'INPR' und 'ACCO' sind nur zulässig, wenn das Dokument zu erledigen (Status = 'TAAC') ist. Solbald ein Dokument erledigt wurde, kann der Status nicht mehr auf 'in Bearbeitung' zurückgesetzt werden.

Exceptions

DOCUMENT_NOT_EXIST
Der angegebene Mappeneintrag existiert nicht. Wahrscheinlich wurde entweder eine falsche ID übergeben oder der betroffene Mappeneintrag mittlerweile gelöscht.
OPERATION_NO_AUTHORIZATION
Der Mappeneintrag durfte nicht geändert werden. Dies kann daran liegen, daß sich der Mappeneintrag im persönlichen Bereich eines anderen Benutzers befindet.
PARAMETER_ERROR
Es wurde dem Funktionsbaustein eine unzulässige Kombination von Parameterwerten übergeben. Möglicherweise wurde ein nicht existierender oder nicht anwendbarer Status angegeben.
X_ERROR
Es ist ein interner Fehler oder eine Datenbankinkonsistenz aufgetreten.
ENQUEUE_ERROR
Der Mappeneintrag oder die Mappe, in der er liegt, konnte nicht gesperrt werden. Wahrscheinlich findet gerade eine Bearbeitung durch einen anderen Benutzer statt.

Beispiel

Es werden alle zu erledigenden Dokumente im Eingang des aktiven Benutzers auf 'erledigt' gesetzt. Zum Bestimmen und Lesen des Eingangs werden die Funktionsbausteine SO_USER_READ_API1 und SO_FOLDER_READ_API1 verwendet.

DATA: FOL_CONT LIKE SOFOLENTI1 OCCURS 10 WITH HEADER LINE.
DATA: USER_DATA LIKE SOUDATAI1.
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-INBOXFOL
TABLES
FOLDER_CONTENT = FOL_CONT
EXCEPTIONS
OTHERS = 1.
IF SY-SUBRC <> 0.
WRITE: / 'Der Eingang konnte nicht gelesen werden !'.
EXIT
ENDIF.
LOOP AT FOL_CONT WHERE TO_DO_STAT = 'TAAC'.
CALL FUNCTION 'SO_DOCUMENT_SET_STATUS_API1'
EXPORTING
DOCUMENT_ID = FOL_CONT-DOC_ID
STATUS = 'ACCO'
EXCEPTIONS
OTHERS = 1.
CASE SY-SUBRC.
WHEN 0.
WRITE: / 'Das Dokument', FOL_CONT-OBJ_DESCR,
'wurde auf "erledigt" gesetzt !'.
WHEN OTHERS.
WRITE: / 'Das Dokument', FOL_CONT-OBJ_DESCR,
'konnte nicht auf "erledigt" gesetzt werden !'.
ENDCASE.
ENDLOOP.

Hinweise

Weiterführende Informationen

Informationen zum Aufruf der Funktionsbausteine SO_USER_READ_API1 und SO_FOLDER_READ_API1 finden sich in der Dokumentation der entsprechenden Funktionsbausteine.





Parameter

DOCUMENT_ID
STATUS

Ausnahmen

DOCUMENT_NOT_EXIST
ENQUEUE_ERROR
OPERATION_NO_AUTHORIZATION
PARAMETER_ERROR
X_ERROR

Funktionsgruppe

SOI1

BAL_S_LOG - Application Log: Log header data   BAL_S_LOG - Application Log: Log header data  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 5811 Date: 20240523 Time: 120115     sap01-206 ( 66 ms )