SAP® system administrators can use ARIS Online Guide to make help on company-specific executables available for users of SAP systems alongside the standard F1 help. For example, ARIS Online Guide gives you access to documents that were created during customizing or later to explain complex processes. You can provide ARIS Online Guide via ARIS. Using ARIS Publisher is no longer recommended.
If you plan to use ARIS Online Guide, you must publish your database as published content in ARIS (see ARIS online help page Publish database as ARIS (ARIS Online Guide).
Providing ARIS Online Guide via ARIS Publisher is no longer recommended.
From ARIS 10.0.13.0 on ARIS Publisher and IT Inventory are no longer delivered. This means that you can no longer install or update ARIS Publisher Server. You can still use your current ARIS Publisher installation, but since this component is no longer supported, no more features will be developed. We strongly recommend using the published content instead of ARIS Publisher in the future. As of October 2023, neither ARIS Publisher, IT Inventory, nor HTML export functionality will be available.
To publish your database as a publisher export nevertheless, ARIS Publisher Server must be configured.
An executable version of the SAP GUI and an approved Web browser must be installed.
Once you have executed the client setup and made the created HTML documents available in the SAP system, your SAP system administrator must implement the executables /n/IDS/AOG_ADMIN, /n/IDS/AOG_USER, and ZEXTHLP in the SAP system and adapt the Web server.
To do so, please adjust the following:
.
A transport request is executed to import the required function modules. The current transport request is contained in the ARIS installation package (..\Add-ons\extension_pack_SAP\ABAP\ARIS Online Guide).
Procedure
Copy the file K<number>.<SAP system SID> from the ARIS installation package to the directory \sapmnt\trans\cofiles.
Copy the file R<number>.<SAP system SID> from the ARIS installation package to the directory \sapmnt\trans\data. The directory sapmnt normally corresponds to the directory \usr\sap. If you cannot find the cofiles and data directories under the specified paths, you can determine the correct path using the DIR_TRANS variable. To do this, log on to the relevant SAP system, and run transaction AL11.
To transfer the transport request to the SAP system using the command line program TP.EXE, enter the following commands in the specified sequence:
TP addtobuffer <SAP system SID>K<number> [target system SID]
TP import <SAP system SID>K<number> [client on target system]
You can also execute the transport request using the transaction STMS.
Procedure
Log on to the relevant SAP system as a system administrator.
Execute transaction STMS. This takes you to the Transport Management System.
Click Import overview.
Double-click the relevant SAP system. This takes you to the import queue.
In the menu, select Extras > Other requests > Add. The Add transport request to import queue dialog opens.
Enter <SAP system SID>K<number> and confirm. You return to the import overview.
Select the transport request.
In the menu, select Request > Import. The Import request dialog opens.
Activate the Options tab and check Ignore invalid component version.
Enter the relevant target client and confirm via F8 or Start import.
Then assign each of the transactions /n/IDS/AOG_ADMIN, /n/IDS/AOG_USER, and ZEXTHLP a new or existing authorization object.
If you create any new authorization objects, you must include them in suitable authorization profiles.
.
After you have imported the required function modules, you must modify the SAP standard function HELP_START in program LSHL2U01.
This will provide the F1 help call of ARIS Online Guide. To do this, you need a developer key and possibly an object key. You can obtain these keys via OSS.
Procedure
If required, log in to the relevant SAP system.
Execute executable SE37.
DATA: l_error_msg LIKE iwerrormsg. " DHB
DATA: l_action LIKE sy-xcode. " *17i
DATA: exit_flg.
DATA: save_help_info_call LIKE help_infos-call.
DATA: ihelpinfo TYPE help_info.
DATA: lv_help_mode TYPE char1.
DATA: lv_window_name TYPE sydatar.
DATA: a_msgv1 LIKE help_infos-msgv1,
a_msgv2 LIKE help_infos-msgv2,
a_msgv3 LIKE help_infos-msgv3,
a_msgv4 LIKE help_infos-msgv4.
* help center
DATA: l_flag_hc_called TYPE as4flag. "note 1135202
*------- CALL MODIFICATION ARIS Online Guide
DATA: loaded TYPE c,
bothhelp TYPE c.
IF help_infos-call CN 'TMV' AND help_infos-call CO 'D' AND help_infos-object IS
NOT INITIAL.
CALL FUNCTION '/IDS/START_ARIS_ONLINE_GUIDE'
EXPORTING
i_program = help_infos-program
IMPORTING
e_help_loaded = loaded
e_both_help = bothhelp.
IF bothhelp NE 'X' AND loaded = 'X'.
EXIT.
ENDIF.
ENDIF.
***************** end of insertion***************
*} INSERT
---Additional code. ---
The F1 help call of ARIS Online Guide is available.
After you have imported support packages into the SAP system, this modification may be missing in some cases. The F1 help call of ARIS Online Guide is no longer available then. In this case, modify LSHL2U01 again.
.
Once you have /n/IDS/AOG_ADMIN and /n/IDS/AOG_USER to specify various settings for the ARIS Online Guide in the SAP® system.
and , you can use the executablesA transport request is executed to import the required function modules. The current transport request is contained in the ARIS installation package (..\Add-ons\extension_pack_SAP\ABAP\ARIS Online Guide).
Procedure
Copy the file K<number>.<SAP system SID> from the ARIS installation package to the directory \sapmnt\trans\cofiles.
Copy the file R<number>.<SAP system SID> from the ARIS installation package to the directory \sapmnt\trans\data. The directory sapmnt normally corresponds to the directory \usr\sap. If you cannot find the cofiles and data directories under the specified paths, you can determine the correct path using the DIR_TRANS variable. To do this, log on to the relevant SAP system, and run transaction AL11.
To transfer the transport request to the SAP system using the command line program TP.EXE, enter the following commands in the specified sequence:
TP addtobuffer <SAP system SID>K<number> [target system SID]
TP import <SAP system SID>K<number> [client on target system]
You can also execute the transport request using the transaction STMS.
Procedure
Log on to the relevant SAP system as a system administrator.
Execute transaction STMS. This takes you to the Transport Management System.
Click Import overview.
Double-click the relevant SAP system. This takes you to the import queue.
In the menu, select Extras > Other requests > Add. The Add transport request to import queue dialog opens.
Enter <SAP system SID>K<number> and confirm. You return to the import overview.
Select the transport request.
In the menu, select Request > Import. The Import request dialog opens.
Activate the Options tab and check Ignore invalid component version.
Enter the relevant target client and confirm via F8 or Start import.
Then assign each of the transactions /n/IDS/AOG_ADMIN, /n/IDS/AOG_USER, and ZEXTHLP a new or existing authorization object.
If you create any new authorization objects, you must include them in suitable authorization profiles.
After you have imported the required function modules, you must modify the SAP standard function HELP_START in program LSHL2U01.
This will provide the F1 help call of ARIS Online Guide. To do this, you need a developer key and possibly an object key. You can obtain these keys via OSS.
Procedure
If required, log in to the relevant SAP system.
Execute executable SE37.
DATA: l_error_msg LIKE iwerrormsg. " DHB
DATA: l_action LIKE sy-xcode. " *17i
DATA: exit_flg.
DATA: save_help_info_call LIKE help_infos-call.
DATA: ihelpinfo TYPE help_info.
DATA: lv_help_mode TYPE char1.
DATA: lv_window_name TYPE sydatar.
DATA: a_msgv1 LIKE help_infos-msgv1,
a_msgv2 LIKE help_infos-msgv2,
a_msgv3 LIKE help_infos-msgv3,
a_msgv4 LIKE help_infos-msgv4.
* help center
DATA: l_flag_hc_called TYPE as4flag. "note 1135202
*------- CALL MODIFICATION ARIS Online Guide
DATA: loaded TYPE c,
bothhelp TYPE c.
IF help_infos-call CN 'TMV' AND help_infos-call CO 'D' AND help_infos-object IS
NOT INITIAL.
CALL FUNCTION '/IDS/START_ARIS_ONLINE_GUIDE'
EXPORTING
i_program = help_infos-program
IMPORTING
e_help_loaded = loaded
e_both_help = bothhelp.
IF bothhelp NE 'X' AND loaded = 'X'.
EXIT.
ENDIF.
ENDIF.
***************** end of insertion***************
*} INSERT
---Additional code. ---
The F1 help call of ARIS Online Guide is available.
After you have imported support packages into the SAP system, this modification may be missing in some cases. The F1 help call of ARIS Online Guide is no longer available then. In this case, modify LSHL2U01 again.