The OIPA Config Guard is a specialized VS Code extension designed to seamlessly integrate Oracle Insurance Policy Administration (OIPA) configurations with your local Git repository. It acts as an active workspace guard, ensuring code synchronization, preventing conflicting edits through file locking, and automating deployment directly to the OIPA server.
🚀 Key Features
Real-time File Locking: Automatically locks files that belong to another user or package. If you attempt to edit a locked file (or if you are offline/logged out), the extension intercepts the change and instantly undoes your edits, preventing broken configurations.
Smart Synchronization (Sync): Pulls the latest configuration changes from the OIPA database directly into your local Git workspace without overriding your uncommitted work.
One-Click Deployments: Safely push your local OIPA configurations to the server. The extension runs background Git fetching to drastically reduce network waiting times, safely handles your uncommitted stashes, and manages your commits for you.
Visual File Status: Automatically decorates your VS Code file explorer.
🔒 Lock Icon (Red): The file is currently locked by another user or you are offline/unauthenticated.
M Badge (Orange): The file has been modified locally and is pending deployment.
Auto-Assignment Workflows: Prompts you to add a file to a new or existing Configuration Package whenever you edit an unassigned file.
🛠 Prerequisites
To use this extension successfully, you must meet the following requirements:
Git: Git must be installed and available in your system's PATH.
Workspace Setup: Your VS Code workspace folder must contain the words oipa-in-vscode. The extension detects specific environments (e.g., modal-office-oipa-in-vscode) to route requests to the correct OIPA server IP and port.
OIPA Server Access: You must be on the internal network or VPN able to access the configured OIPA environment servers.
📖 How to Use
1. Login
When you open an OIPA workspace, look at the bottom-left of your VS Code Status Bar.
Click $(person) Login and enter your OIPA credentials.
Once authenticated, the status bar will turn green showing OIPA (Online).
2. Syncing Latest Code
Before starting work, it's best practice to pull the latest configurations.
Click the $(sync) Sync button in the Status Bar.
The extension will securely stash your local modifications, fetch the latest code from the main branch, automatically perform a rebase, and pop your stash back into place.
3. Editing Files
Open any .xml or config file in the workspace.
If the file is locked by someone else, VS Code will display a 🔒 badge next to it. Attempting to type in this file will trigger an automatic Undo and show an error notification indicating who owns the lock.
If you edit an unlocked, unassigned file, the extension will immediately prompt you to assign it to an IvsConfigPackage.
4. Deploying
When you are ready to send your changes back to the OIPA server:
Click the $(cloud-upload) Deploy button in the Status Bar.
Enter a deployment commit message when prompted.
The extension will rapidly synchronize with the server, handle your commits, push your code to Git, and trigger the remote save endpoints on the OIPA server.
Note: To preserve workspace stability, this extension automatically hides the default VS Code Git branch and sync buttons. All Git interactions for OIPA configurations should be handled exclusively via the provided Sync and Deploy buttons.
