Ansicht
Dokumentation

RSIWBH07 - Edit Help Links

ROGBILLS - Synchronize billing plans RFUMSV00 - Advance Return for Tax on Sales/Purchases
This documentation is copyright by SAP AG.

Purpose

This report provides various options to process help links saved in table IWREFERENC.

Depending on the system type (customer or SAP) actions such as display, create, change, or delete can be performed for one or more help links.

Prerequisites

The following authorizations are required:

To start the report:

Authorization object 'S_DOKU_AUT' with 'DOKU_MODE' = 'MAINTAIN'

To run cleanup tasks:

Authorization object 'S_IWB_ADM' with 'IWB_FCTN' = 'SUPPORT'

Features

Be aware of the following points before running the report:

The report can only be started in dialog mode. The report cannot be scheduled as a background job.

The report allows help links to be processed only for supported scenarios that are described in the section "Link Usage Type".

Non-permitted fields with empty values are either directly hidden or the parameter combination is checked after pressing "Continue".

Any changes made are put into a transport request to ensure the rest of the system landscape is delivered with the same help links.

When a help link is created, at the end of the process a results screen with the possible variants for usage of the help link is displayed.

Exception: With link usage type "standard help processor" this screen is omitted.

For mass scenarios, the "*" character is permitted in all fields except for "Date Created".

Condition: An additional character must be entered.

During the cleanup, the system checks whether links are used as KENO links in the latest versions of SE61 documents. If no usages are found, the links are marked for deletion.

In customer systems (transport type "CUSTOMER") there are the following restrictions: No selection option for:

Cleanup operations for multiple help links

'IXIASOFT' as the content management system (CMS)

The selection in the section "processing type" controls all other sections.

Location of Contents:

If 'IXIASOFT DITA CMS' is selected as the location, the info object classes are defined as 'XDP_STRUCT' for DITA maps and 'BCO_COMMON' for content objects. No F4 help is provided to select info object IDs.

If 'SAP Knowledge Warehouse' is selected as the location, F4 help is provided for the selection of structure and content object as a pair.

Selection

Section "Processing Mode"

Defines the actions to carry out and the display of further sections.

"Create"

Used to create a new help link. The ID (UUID) of this help link is recreated.

Normally, this action takes place in the development system.

"Create with existing ID"

Used to create a new help link with an existing ID (UUID).

Normally, this processing type is used in a correction system where a link with this ID does not yet exist. The request to create a help link with an existing ID can also come from the solution section of an SAP Note.

"Change"

Used to change an existing help link.

Since afterwards it cannot be identified where the info objects were created and how the links were used, the report only checks the permitted parameter combinations. Changes are rejected if they violate the rules.

"Display (in Browser)"

Used to check whether an existing link can be displayed with the current system settings.

Relevant settings come from transaction SR13, reports RSIWBH01 / RSIWBH01R, and tables SBAON_CCHK / TBAON_CCHK.

"Display"

Used to display multiple help links that meet the selection criteria.

When you double-click a link in the list, it is displayed in the browser.

By choosing "Continue" you return to the selection criteria.

"Add to Transport"

Used to display multiple help links that meet the selection criteria. Afterwards you can either add one or more links to a transport request or cancel the process.

When you double-click a link in the list, it is displayed in the browser.

"Delete"

Used to display multiple help links that meet the selection criteria. Afterwards you can either delete one or more links and put this in a transport request or cancel the process.

When you double-click a link in the list, it is displayed in the browser.

"Replace Info Object"

Used to replace the invalid part (structure or content object) of multiple help links simultaneously.

"Collect Contexts for Help Links"

Used to create a list with all enhancements that are available in SAP system help links. To do this, the 'INDUSTRY' in table IWREFERENC is evaluated.

The list contains a column with the number of entries per enhancement.

"Change Enhancement"

Used to change the enhancement part of the context (field 'INDUSTRY' in table IWREFERENC) for multiple links simultaneously.

For details of how to proceed, see the documentation (info button) on the next screen.

"Clean Up 'IWREFERENC"

Used to identify links with empty values in fields DEVCLASS, TCODE, PROGRAMM, DYNPRONR, SPEC_PRG, SPEC_TEXT, and SPEC_DYNP. Links are displayed if they are not used as KENO links.

Afterwards you can either delete one or more links and put this in a transport request or cancel the process.

Section "Link Usage Type"

Defines which parameters the link is allowed to contain.

Non-permitted fields are hidden.

Only appears if "Create" or "Create with Existing ID" are selected in section "Processing Type".

"Standard Help Processor"

Must only be used if the link is to be called in menu: Help -> Application Help (for S/4HANA: Help -> Product Assistance).

This link can also be used as a KENO link in SE61 documents. Read more about this in the next section.

"Call from SAPScript"

Must only be used if the link is to be used as a KENO link in SE61 documents that are to be displayed in the performance assistant or in dialog boxes..

If the SE61 documents are to be displayed with other viewers, check beforehand if the framework supports this link type.

Call Using Function Module 'IWB_HTML_HELP_OBJECT_SHOW'

Must be used if the link is to be accessed using function module IWB_HTML_HELP_OBJECT_SHOW. The developer has to add this function module to the source code. The parameters of the link are displayed in the results screen. If necessary, all other parameters of function module 'IWB_HTML_HELP_OBJECT_SHOW can also be used.

This link can also be used with the call using function module SIW_R3LINK_GET. Read more about this in the next section.

This link can also be used as a KENO link in SE61 documents. Read more about this in the "Call from SAPScript" section.

Call Using Function Module SIW_R3LINK_GET

Must be used if the link is to be accessed using function module SIW_R3LINK_GET. The developer has to add this function module to the source code. The parameters of the link are displayed in the results screen. If necessary, all other parameters of function module SIW_R3LINK_GET can also be used.

This link can sometimes be used with the call using function module'IWB_HTML_HELP_OBJECT_SHOW. In this case, a coding example is displayed on the results screen. Read more about this in the "Call Using Function Module IWB_HTML_HELP_OBJECT_SHOW" section.

This link can also be used as a KENO link in SE61 documents. Read more about this in the "Call from SAPScript" section.

Archive Help Link

Must only be used to document an archive object. The program name and the first four characters (AOBJ) are protected.

Check beforehand whether an SE61 document of docu class 'AO' is already assigned to the object. If not, this has priority before the link in transaction SARA. The pushbutton "Documentation" in transaction AOBJ leads only to the SE61 dockument. The help link is not relevant for this.

Help link for CDS view

Must only be used to document a CDS view.

This section is only visible if the program 'CL_VIEW_BROWSER_API===========CP' is available in the system.

This link is used with the call using function module'IWB_HTML_HELP_OBJECT_SHOW. In this case, a coding example is displayed on the results screen. Read more about this in the "Call Using Function Module IWB_HTML_HELP_OBJECT_SHOW" section.

This link can also be used as a KENO link in SE61 documents. Read more about this in the "Call from SAPScript" section.

Help link for ABAP keyword documentation

Must only be used to create a link for ABAP keyword documentation (for example, ABAP commands 'IF', SELECT').

It is not available in customer systems.

Section "Info Objects Off"

Defines the document storage (CMS / Content Management System) where documentation content is created.

Only appears if "Create" or "Create with Existing ID" was selected in section "Processing Type".

SAP Knowledge Warehouse if the area that info object classes belong to was released for application help.

Attribute 'KM_KW_HELP' at area level in transaction DMWB

IXIASOFT DITA CMS if info object classes are 'XDP_STRUCT' and 'BCO_COMMON' and the SAP internal link has to be created.

Section "Parameters"

Option to enter the values that must be included for the action in question.

Appears for all processing types in section "For Single Help Links" and "For Multiple Help Links", except for "Create".

Link ID (UUID)

Here a value must be entered that uniquely identifies a help link.

Only appears if one of the following processing types was selected: "Create with Existing ID" / "Change" / "Test (in Browser)" / "Display" / "Add to Transport" / "Delete".

"Package"

Here a value must be entered that identifies a help link using the content of field 'DEVCLASS' of table IWREFERENC.