SAP Function RSOD_DOC_META_CHANGE - Document API: Create Document for Meta Object

Parameter Reference Type Length Default Optional Text
I_COPY_URL_CONTENT RS_BOOL C 1 X = 'X' Document read and copied. ' ' Link to URL (not yet functional)
I_DATA_MODEL_TEXT RSOD_DATA_MODEL_TEXT C 1 X Text in Data Model (Indicator)
I_DESCRIPTION SDOK_DESCR C 64 Short Description
I_IS_DEFAULT RSODISDEFAULT C 1 X Online Documentation
I_LANGU LANGU C 1 SY-LANGU X Language Key
I_NAME SKWF_URLP C 40 X Name
I_OBJNM SOBJ_NAME C 40 Object Name in Object Directory
I_OVERWRITE_MODE RSOD_OVERWRITE_MODE C 1 0: New LOIO, 1: New PHIO, 2: Replace PHIO, 3: Delete LOIO
I_S_CONTENT_INFO RSOD_S_CONTENT_INFO u 418 X API Documents: Content Info
I_TLOGO RSTLOGO C 4 BW: Object Type (TLOGO)
I_URL SAEURI C 4096 X URL
I_WITH_CONTENT RS_BOOL C 1 X = 'X' Contents provided (I_T_FILE_CONTENT_ASCII / I_T_FILE_CONTENT_BINARY)
I_WITH_URL RS_BOOL C 1 X = 'X' Document specified using URL

Parameter Reference Type Length Text
E_NAME SDOK_PROPV C 64 Attribute Value
E_S_RETURN BAPIRET2 u 548 Return Parameter

Parameter Reference Length Optional Text
I_T_FILE_CONTENT_ASCII SDOKCNTASC 1022 X Text Document Contents
I_T_FILE_CONTENT_BINARY SDOKCNTBIN 1022 X Binary Document Contents

Functionality
You can use this module to create or change a document for a BW metaobject.

Specific parameters (selection) for documents for meta objects
The meta object must be specified consistently in terms of its type(I_TLOGO) and its technical name (I_OBJNM).
You can also use the parameter I_IS_DEFAULT to specify whether thedocument is to be used for the online documentation of the meta object.

Description of document
You can use the parameter I_DESCRIPTION to transfer a textualdescription of the document. This description is used in lists and inlinks to the document.

Identification of the document and the overwrite mode
Optionally, you can use parameter I_NAME to specify the consistent nameof the document. The system then creates the document with this name,providing that it does not already exist. The name must be consistentfor all documents for metadata. If the name is not entered, the systemdetermines a consistent ID and uses this as the name. The name used bythe system is returned in the parameter E_NAME.
If a name is specified, the system checks whether a document with thisname already exists. If the additional properties of the document do notmatch the selection given in the module, the module terminates with anappropriate error message.
You can use the parameter I_OVERWRITE_MODE to control how the module isto react when a document with the specified properties already exists.The following values are available:

  • 0 or if_rsod_const=>mode_new_loio: The system always creates a new
    • logical, and thus physical, document. Existing documents for the moduleselection remain in place in the system. In cases where the name(I_NAME) is specified and a document having this name already exists,the module terminates with an appropriate error message in parameterE_S_RETURN.
    • 1 or if_rsod_const=>mode_new_phio: A new logical document is only
      • created when the system could not find a suitable logical document. Thesystem searches for the logical document in the following way:
      If the name (I_NAME) of the docuemnt is entered, the system onlysearches according to this name. If the system finds a document with thematching name, it then checks whether or not the document p
      roperties match the module selection. If this is not the case, themodule terminates.
      If the name is not specified, the logical document is determined fromthe module selection. If more than one document fits this selection, thesystem selects the document that was changed last.
      A new physical document is created in all cases. The existing physicaldocuments remain in place and can be displayed and if necessaryregenerated in the Data Warehousing Workbench. The most recent physicaldocument for the appropriate language is displayed by default.
      • 2 or if_rsod_const=>mode_replace_phio: Existing physical documents for
        • the chosen language are replaced. First of all, the system searches fora suitable logical document as described in 1 above.
        If the system does not find a suitable logical document, it creates onetogether with a physical document.
        If the system does find a logical document, all existing physicaldocuments for the selected language are deleted. A new physical documentis then created. As a result, there is now only one version of thedocument in the selected language.
        • 3 or if_rsod_const=>mode_delete_loio: The logical document that was
          • found is deleted togather with all physical documents. The logicaldocument is determined as described in value 1 above.

          Document content
          The following alternatives to describe the physical contents of thedocument are available:
          The document needs to be loaded from the client workstation.
          In this case, I_WITH_CONTENT must = 'X' and the complete file name mustbe in field I_S_CONTENT_INFO-FILE_NAME: For example: C:\temp\test.pdf.The I_T_FILE_CONTENT_BINARY and I_T_FILE_CONTENT_ASCII tables must beempty. The remaining fields of the I_S_CONTENT_INFO structure aredetermined from the file properties.
          The content is taken from the file information:
          In this case, I_WITH_CONTENT must ='X' and the MIMETYPE field ofparameter I_S_CONTENT_INFO must be filled with the MIME type of thedocument (for example: with text/plain, text/html, image/gif). If it isnot a text file, you also need to enter the file size in bytes in theFILE_SIZE field.
          The other FILE_NAME field is optional for this structure. It is filledwith the document name and the file name extension if none is provided.
          Depending on the MIME type, precisely one of the table parametersI_T_FILE_CONTENT_ASCII or I_T_FILE_CONTENT_BINARY must be filled withthe document content. For text documents, the parameterI_T_FILE_CONTENT_ASCII must be filled, for other formats, you need toenter the content in the parameter I_T_FILE_CONTENT_BINARY in binaryform.
          The content is specified with a URL (I_WITH_URL='X'):
          In this case, you need to add the URL in the parameter I_URL. Dependingon the content of parameter I_COPY_URL_CONTENT, the page is eithercopied or a link to the page is managed:
          I_COPY_URL_CONTENT = SPACE: Only one link to the specified page ismanaged. This variant is not maintained at the moment.
          I_COPY_URL_CONTENT = 'X': The content of the URL address is read usingthe HTTP GET method and is stored on the BW server. The disadvantage ofthis variant is that relative links in the HTML pages no longer work.
          If the HTTP connection needs a proxy (Internet instead of an intranet),the following entries must be added to table RSODADMIN:
          NAME = 'HTTP_PROXY', VALUE = ,
          NAME = 'HTTP_PROXY_USER' , VALUE = ,
          NAME = 'HTTP_PROXY_PWD', VALUE = ,
          The module checks whether the user has authorization to change thedocument.
          If errors occur, the parameter E_S_RETURN is filled with a correspondingerror message.

          Value range
          = 'X': Document is online documentation: Details

          Description
          Technical name of meta objects.

          Value range
          For query elements (TLOGO = ELEM) - that is, queries, structures,calculated and restricted key figures - the technical name (COMPID) isused instead of the GUID (COMPUID).

          Description
          Type of meta object. For example: CUBE for InfoCube or IOBJ forInfoObject.

          Value range
          The object types released for documents are those that have the flagBDSFL set in table RSTLOGOPROP (BDSFL='X'):
          AGGR: Aggregate
          CRWB: Crystal Report
          CUBE: InfoCube
          ELEM: Query Element
          IOBC: InfoObject Catalog
          IOBJ: InfoObject
          ISET: InfoSet
          ISFS: DataSource
          ISIP: InfoPackage
          ISMP: Transfer rules
          ISTD: InfoSource
          ITEM: Web item
          MPRO: MultiProvider
          ODSO: DataStore Object
          QVIW: Query View
          RAPA: Report Agent package
          RASE: Report Agent Setting
          RSPC: Process Chain
          RSPV: Process Variant
          TMPL: Web Template
          UPDR: Update Rule
          XLWB: Excel Workbook