Ramco Model Explorer

The Ramco Model Explorer is an IDE for RVW platform modeling and database work, offering features like RIDS Authentication, GIT integration, and SQL Server access. It provides intuitive data visualization and streamlines workflows by enabling easy Git repository commits. VS Code enhances coding with integrated tools, collaborative features, and a robust ecosystem. The extension aids RVW platform modeling and database development, offering a tree view for service entities and easy Git repository commits. Together, these tools provide secure, efficient, collaborative, and customizable development tools, focusing on enhanced data visualization and version contro and it also comes with integration of dependency-viewer that enables comprehensive backend application object dependency graph, offering insights into dependencies at both the service and method levels

Features

• RIDS Authentication
• Data can be view Tree Structure
• Edit stored procedures
• Dependency Viewer
• Path Finder
• Application SQL Server
• GIT Repository

Requirements

• Visual Studio Code Editor
• Visual Studio Code extension - SQL Server (mssql) v1.20.1 or above

Installation

1. Launch VSCode.
2. Open the Extensions sidebar (Ctrl+Shift+X or Cmd+Shift+X).
3. Search for "Ramco Model Explorer".
4. Click "Install".

Usage

• To install the "Ramco Model Explorer" extension, navigate to Extensions from the Activity Bar (press Ctrl+Shift+X or Cmd+Shift+X), search for "Ramco Model Explorer," and click "Install."

• After installation, locate the Ramco Model Explorer extension icon in the Activity Bar. Upon installation completion, click the Manage button and choose the Extension Settings option.

• If the model explorer icon is not visible, click the "..." (Additional Views) option and select "Model Explorer."

• Access Settings with Ctrl + ,, and find the extensions folder within the vscode Tab.

• Creating a New Environment: Provide a descriptive name for a platform model. Select the newly created environment and configure properties such as Platform Model URL, SQL Server Name, SQL Server DB Name, SQL Server Username, and SQL Server Password.

• Activating the model explorer prompts authentication credentials.

• Click "Authenticate" to open the platform application's login page. Click "Open" to proceed.

• Enter your platform application username and password on the login page.

• Upon successful login, a dialog window appears requesting permission to open links in the associated app. Click "Open Visual Studio Code" to continue.

• After redirection to Visual Studio Code, the sidebar displays the data you requried.

Keyboard Shortcuts

• Ctrl+Shift+X or Cmd+Shift+X to open for extension
• Ctrl+Shift+P or Cmd+Shift+P to open search bar for extension
• Ctrl+~ or Cmd+~ to open the terminal
• Ctrl+, or Cmd+, to opem extension settings

Extension Settings

The ModelExplorer extension offers configurable settings to tailor its functionality to your needs. Modify these settings through the extension's interface.

• Environment Selection: Choose the environment.

• API Endpoint: Provide the API Endpoint for authenticating and interacting with the platform model through the extension.

• Default Object Source: Define the default object source—SQL [Only option available now] or GIT [Will be implemented in later releases] —for retrieving object-related information.

• Application - SQL Server Name: Provide Application SQL server name.

• Application - SQL Database Name: Provide SQL database name.

• Application - SQL User Name: Provide SQL user name.

• Application - SQL Password: Provide SQL password.

Known Issues

Contributing

Release Notes

Version 1.1.22 (2023-08-31)

• Initial Release: This version marks the official launch of the Ramco Model Explorer extension, offering a range of features and functionalities.

• RIDS Authentication: Introduces multi-factor authentication, combining a password with a physical token for enhanced security.

• Application SQL Server: Utilizes SQL Server as a robust backend database for efficient data storage and management.

• TreeView Data Representation: Introduces a TreeView structure for intuitive data representation, simplifying navigation through data hierarchies.

License

• This project is licensed under the MIT License.

Acknowledgments

Support

• For any technical assistance, guidance, or queries related to the Ramco Model Explorer and its development, please reach out to Platform support team.