✅ How to Install SAP Business One
Web Client Plugin in Visual Studio Code (VS Code)
Installing the SAP Web Client plugin for Visual Studio Code
allows developers to efficiently work with SAP Business One UI components,
including Fiori tiles and UI APIs. If you are working in a Windows RDP (Remote
Desktop Protocol) server environment, follow this step-by-step guide to
install and verify the plugin properly for any user.
🔧 Prerequisites
- Visual
Studio Code installed (preferably system-wide).
- Administrative
rights to install software.
- Access
to SAP Business One SDK tools.
🚀 Step-by-Step
Installation Guide
✅ Step 1: Launch Visual Studio
Code and Install SAP Fiori Tools Extension
- Open Visual
Studio Code.
- Press Ctrl
+ Shift + X to open the Extensions panel.
- Search
for “SAP Fiori tools - Extension Pack”.
- Click Install
to add it to your VS Code environment.
This extension provides the required base to work with SAP
UI5 and Fiori elements.
✅ Step 2: Choose the User Profile
for Installation
Determine which Windows user account should have access to
the plugin (e.g., Brajesh.pawar). This is important because VS Code extensions
are installed per user, not system-wide by default.
✅ Step 3: Grant Administrative
Rights and Run the Installer
- Log in
using the intended user account (e.g., sanjay.kumar) via Remote Desktop.
- Ensure
this user has Administrator privileges temporarily.
- Open
Control Panel > User Accounts > Manage another account > Change
account type.
- Set
to Administrator if not already.
- Navigate
to the following location:
C:\Program Files (x86)\SAP\SAP Business
One\SDK\Tool\WebClientVSCodePlugins
- Locate
the file install.bat.
- Double-click
install.bat to run the installation as the current user.
🔄 Running the installer
as another user or with Run as Administrator (UAC prompt) won’t install the
plugin correctly for the active user profile.
🛠️ If install.bat Does
Not Work: Run the PowerShell Script
If the standard install.bat file does not work or opens
multiple CMD windows, follow this alternative approach:
- Navigate
to:
C:\Program Files (x86)\SAP\SAP Business
One\SDK\Tool\WebClientVSCodePlugins\script\
- Locate
the file: install.batch
- Right-click
and run it using PowerShell, but make sure you're logged in as a
user with Administrator rights.
- You
can also open PowerShell manually and run the script using:
First you need to run this script with the click on right click
powershell
.\install.batch
🛡️ This method is
necessary when the regular installer fails or triggers a recursive CMD loop.
✅ Step 4: Verify Installation in
Visual Studio Code
- After
installation, reopen Visual Studio Code.
- Press Ctrl
+ Shift + P to open the Command Palette.
- Search
for and select:
Template Wizard: Open Template Wizard - If
installation was successful, you will see:
- SAP
Business One Web Client Templates
- Tile
and UI API Options
🎉 If you see these, the
plugin has been successfully installed and is ready to use.
📌 Notes & Best
Practices
- Always
install the plugin as the same user who will use it.
- Remove
Administrator rights after installation (if required for policy).
- Avoid
using broken or recursive install.bat files from older SDK builds. Use .vsix
if available.
- Use
the Fiori tools extension as a foundation before WebClient plugin
installation.
🧩 Troubleshooting Tips
|
Issue |
Solution |
|
CMD windows open in a loop |
Don’t run faulty install.bat. Use the install.batch
PowerShell script instead |
|
Plugin not visible after install |
Make sure installation was done using the correct user |
|
Template Wizard not showing SAP options |
Reinstall plugin or check if Fiori Tools pack is installed |
✅ Conclusion
Installing the SAP Business One Web Client plugin for Visual
Studio Code is a simple but user-specific process. By following the above
steps, you ensure the correct user environment is configured with the necessary
tools to work on SAP UI-based development projects using VS Code.
0 Comments:
Post a Comment
pawarsolution