SO_NEW_DOCUMENT_SEND_API1

내역

    SAPoffice: Send new document

  Functionality

    This function module enables you to send a new document, which has not
    yet been created, internally and externally. During the send process the
    document is created, along with the attributes and content that are to
    be transferred.

    Import parameters

    DOCUMENT_TYPE
        Default = 'RAW'.
        Document class. All classes are possible except for folders ('FOL')
        and distributions lists ('DLI').

    PUT_IN_OUTBOX
        Default = ' '.
        If this flag is activated ('X'), the newly created document is also
        placed in the outbox of the active user when it is sent.

    DOCUMENT_DATA
        This structure must contain the attributes of the document to be
        sent.

    o   OBJ_NAME
        Name of document.

    o   OBJ_DESCR
        Title (short description) of document.

    o   OBJ_LANGU
        Language of document.

    o   OBJ_SORT
        Sort field of document. You can search for this term using attribute
        search.

    o   OBJ_EXPDAT
        Expiry date of document. The document itself cannot expire, but each
        time the document is entered in a folder, this date is used as the
        default for the expiry date of the entry (field EXPIRY_DAT).

    o   SENSITIVTY
        Document sensitivity.
        A private document can have the following levels of sensitivity:
    -   'O' : Standard, normal sensitivity

    -   'F' : Functional, can be forwarded functionally

    -   'P' : Confidential, not visible to substitutes
    For documents in shared folders, only sensitivity level 'O' is
    permitted.

o   OBJ_PRIO
    Recipient priority. The document itself does not have a priority
    level, but each time the document is entered in a folder, this value
    is used as the default for recipient priority for the entry (field
    PRIORITY).

o   NO_CHANGE
    If this flag is activated ('X'), documents in shared folders can
    only be changed by the author. The author can change documents in
    private folders after they have been sent.

o   PRIORITY
    Recipient priority for the folder entry. This value gives the
    priority, which was assigned to the document by the owner, after
    receipt.

o   EXPIRY_DAT
    Expiry date of the folder entry. When the expiry date has been
    reached or passed, the entry is placed in private trash and can be
    retrieved from there if needed, up until the next time the trash is
    emptied. A new folder entry is initially given the expiry date of
    the document from field OBJ_EXPDT.

o   PROC_TYPE
    If this field does not contain the default value (default is ' '),
    the document can be processed.
    The following entries are permitted:

    -   'D' : Dialog module

    -   'F' : Function module

    -   'R' : Report

    -   'S' : Report with transfer of values to global memory

    -   'T' : Transaction

    -   'U' : Transaction with transfer of values to global memory

o   PROC_NAME
    Processing element. You must enter the name of the dialog module,
    function module, report or transaction in accordance with the entry
    in the field PROC_TYPE.
o   PROC_SYST
    Name of sytem in which the document is to be processed. If no system
    is specified or '*' is entered, processing is possible in all
    systems.

o   PROC_CLINT
    Client in which the document is to be processed. If no client is
    specified or '*' is entered, processing is possible in all clients.

o   SKIP_SCREN
    If this flag is activated ('X'), the first screen is skipped during
    processing.

o   TO_DO_OUT
    If this flag is activated ('X'), the document cannot be processed
    from the SAPoffice interface. You must use the API function module
    SO_DOCUMENT_SET_STATUS_API1.

o   FREE_DEL
    If this flag is activated ('X'), you can delete the document from
    external folders using the API.

o   DOC_SIZE
    Size of the document in bytes. For PC documents, the size of the
    relevant file should be entered, for RAW  and SCR documents the size
    is the "length of the last line" + "number of other lines multiplied
    by 255".

Export parameters

NEW_OBJECT_ID
    Object ID of the document created during the send process.

SENT_TO_ALL
    If this flag is activated ('X'), the document was sent to all
    specified recipients or, in the case of external forwarding, the
    corresponding send requests were delivered to the subsystem. If
    sending or delivery failed in one or more cases, the flag is not
    activated.

Table parameters

OBJECT_HEADER
    This table must contain the document class-relevant data. For
    example, SAPscript documents store information here about forms and
    styles, Excel list viewer documents store, amongst other things, the
    number of rows and columns and PC documents store their original
    file names.

o   LINE
    Requires class-relevant document information line by line.

OBJECT_CONTENT
    This table must contain the actual content of the document.
o   LINE
    Requires the content of the document line by line.

OBJECT_PARA
    This table is used only by documents that are to be processed. It
    must contain the SET/GET parameter that is transferred to the
    processing element.

o   NAME
    Name of the SET/GET parameter. Only the first three characters are
    used.

o   OPTION
    This field is not used.

o   LOW
    Requires the value of the parameter in NAME.

o   HIGH
    This field is not used.

OBJECT_PARB
    This table is only used by documents to which a particular
    processing type is assigned. The meaning of the table depends on the
    processing type. If the processing element is a report, or
    transaction with transfer of values to the global memory, the table
    content is interpreted as the quantity of parameters with the
    relevant values and exported to the memory ID taken from the first
    row. If the processing element is a function module or a dialog
    module, the table is transferred to this as table parameter MSGDIAL.

o   NAME
    If the processing element is a report or a transaction with transfer
    of values to the global memory, the field of the first row of the
    table must contain the name of the memory ID used for the export.
    The fields of the other rows accommodate the parameter names. If the
    processing element is a function module or a dialog module, the
    fields must contain values corresponding to the use of the module.

o   VALUE
    If the processing element is a report or a transaction with transfer
    of values to the global memory, the field for the first row of the
    table must remain empty. The fields for the other rows accommodate
    the values belonging to the parameters in NAME. If the processing
    element is a function or dialog module, the fields must contain
    values corresponding to the use of the modules.

RECEIVERS
    This table must contain the document recipients.

o   RECEIVER
    Name of recipient.
    The following entry categories are possible:
    -   SAP user name of the recipient

    -   SAPoffice name of the recipient

    -   Shared distribution list

    -   Fax number in the form of structure SADRFD

    -   Internet address in the form of structure SADRUD

    -   Remote SAP name in the form of structure SADR7D

    -   X.400 address in the form of structure SADR8D

o   ADR_TYPE
    Type of RECEIVER entry.
    The following values are permitted:

    -   'B' : SAP user name

    -   ' ' : SAPoffice name

    -   'C' : Shared distribution list

    -   'F' : Fax number

    -   'U' : Internet address

    -   'R ' : Remote SAP name

    -   'X' : X.400 address

o   REC_ID
    If the recipient is a SAPoffice user, the user ID, instead of the
    recipient name in RECEIVER, can be entered in this field.

o   REPLY_DOC
    If there is a value in this field, the document is a reply to the
    folder entry identified by the specified ID. A correspondence
    history is automatically created/continued.

o   REC_DATE
    The date on which the document is to reach the recipient. This date
    cannot be guaranteed for external recipients as it depends on
    connected products.


o   PROXY_ID
    If automatic forwarding is active in the recipient's system, this
    field contains the SAP user ID or the address ID of the external
    address to which the document was ultimately sent.

o   RETRN_CODE
    When the recipient has received the document, the function module
    enters the value '0' in this field. If the document is not
    successfully received, a value unequal to '0' is entered in the
    field.

o   EXPRESS
    If this flag is activated ('X'), the document is sent with the
    attribute 'express'. If the recipient is a SAPoffice user who is
    logged on, he or she receive a message immediately, saying that he
    or she has received an express mail.

o   COPY
    If this flag is activated ('X'), the document is sent with the
    attribute 'copy'.

o   BLIND_COPY
    If this flag is activated ('X'), the document is sent with the
    attribute 'secret copy'. If the recipient is a SAPoffice user, he or
    she can neither print nor forward the document.

o   NO_FORWARD
    If this flag is activated ('X') and the recipient is a SAPoffice
    user, he or she cannot forward the document.

o   NO_PRINT
    If this flag is activated ('X') and the recipient is a SAPoffice
    user, he or she cannot print the document.

o   TO_ANSWER
    If this flag is activated ('X') and the recipient is a SAPoffice
    user, the user must reply to the document before he or she can
    delete it from his or her inbox.

o   TO_DO_EXPL
    If this flag is activated ('X') and the recipient is a SAPoffice
    user, the user must process the document before he or she can delete
    it from his or her inbox.

o   TO_DO_GRP
    If this field contains a value between '1' and '9', a SAPoffice user
    in the recipient group indicated by this number must process the
    document before the recipients can delete it from their inboxes. If
    the value '0' is entered, the document does not need to be
    processed.

o   COM_TYPE
    Communication method used to send the document. This field is only
    relevant if the recipient is an address number, that is, if the
    document is sent externally via address management. If the field is
    empty, the standard communication type specified in address
    management is used.
    The following values are permitted:

    -   'INT' : Send via Internet
      -   'FAX' : Send as a fax

      -   'X40' : Send via X.400

      -   'RML' : Send in another SAP system

  o   LFDNR
      Current number from address management. This field is only relevant
      if the recipient is an address number, that is, if the document is
      sent via address management. If the field is empty, the default
      current number in address management is used.

  o   FAX
      This field is not used.

  o   COUNTRY
      This field is not used.

  o   SPOOL_ID
      This field is not used.

  o   NOTIF_DEL
      If this flag is activated ('X'), the sender receives confirmation
      when the recipient receives the document. He or she also receives a
      message if the document could not be delivered. This flag should
      only be activated for external sending, since internal sending is
      synchronous. Confirmation is only supported by a small number of
      mail systems, however. For example: X.400 and SAP SAP.

  o   NOTIF_READ
      If this flag is activated ('X'), the sender is notified as soon as
      the recipient has read the document. This flag should only be
      activated for external sending, since internal sending is
      synchronous. Read notification is only supported by a small number
      of mail systems, however. For example: X.400 and SAP SAP.

  o   NOTIF_NDEL
      If this flag is activated ('X'), the recipient receives a message if
      the document could not be delivered to the recipient. This flag
      should only be activated for external sending, since internal
      sending is synchronous. The message is only supported by a small
      number of mail systems, however. For example: X.400 and SAP SAP.

  o   SAP_BODY
      If this flag is activated ('X'), SAP specific data is transferred to
      the document in an external body part when sending via X.400. This
      flag should only be activated if the target system is an SAP System.

  Exceptions

  TOO_MANY_RECEIVERS
      Too many recipients were specified. The active user does not have
      authorization to send to this number of recipients.
    DOCUMENT_NOT_SENT
        The document could not be sent. It was not delivered to any of the
        specified recipients.

    DOCUMENT_TYPE_NOT_EXIST
        The document class specified does not exist or is not permitted.

    OPERATION_NO_AUTHORIZATION
        The document was not allowed to be sent because one of the required
        authorizations did not exist.

    PARAMETER_ERROR
        The combination of parameter values transferred to the function
        module was not a permitted combination.

    X_ERROR
        Am internal error or a database inconsistency has occurred.

    ENQUEUE_ERROR
        A lock required for the send process could not be set. It is
        probable that another user is processing.