VCF Operations Management Pack Localization Tools

Overview

The VCF Operations Management Pack Localization Tools provide a streamlined, automated solution for internationalizing VMware Cloud Foundation (VCF) Operations Management Packs. Designed specifically for our partners, these utilities eliminate the manual overhead of tracking and updating localizable strings across complex XML and JSON definitions.

By automatically extracting strings, injecting necessary runtime fields, and managing .properties files, these tools ensure your dashboards, views, and reports are perfectly localized and ready for global deployment.

Key Benefits

• Accelerated Development: Automates the tedious process of finding and extracting localizable strings from complex dashboard and report definitions.
• Guaranteed Consistency: Intelligently groups related localization keys and ensures that all required properties are present across all supported languages.
• Error Prevention: Includes built-in verification modes and automated backup generation to safely manage your codebase without accidental data loss.
• Out-of-the-Box Multi-Locale Support: Automatically generates and maintains properties files for English (Base), Spanish (es), French (fr), and Japanese (ja).

Included Tools

1. Dashboard Localization Tool (dashboard_localization_tool.py)

Designed to handle VCF Operations dashboard definitions, this tool parses your dashboard.json files to extract localizable content such as dashboard names, widget titles, metric labels, and heatmap configurations.

• Smart JSON Injection: Automatically injects required labelOrig and labelLocalized fields into Scoreboard, Sparkline, and Metric Chart widgets to ensure proper runtime localization support.
• Comprehensive Extraction: Captures text from complex widget configurations, including additional columns and nested metric labels.

2. View and Report Localization Tool (view_and_reports_localization_tool.py)

Focused on report and view definitions, this tool parses content.xml files to extract ViewDef and ReportDef elements.

• Automated XML Tagging: Identifies missing or empty localizationKey attributes in your XML properties (like displayName, Title, and Description) and automatically populates them with formatted camelCase keys.
• Safe XML Processing: Modifies XML structures reliably while perfectly preserving original XML declarations and formatting.

Core Features

• Automated Properties Management: Automatically creates resources.properties (or content.properties) and locale-specific files from scratch if they don't exist, or seamlessly updates existing files without overwriting current translations.
• Smart Key Grouping: Instead of simply appending new keys to the bottom of a file, the tools intelligently insert new keys near related existing keys (sharing the same prefix), keeping your properties files clean and organized.
• Verification Mode (--verify-only): Run a comprehensive audit of your files to find missing entries, orphaned keys, and XML/JSON localization issues without making any changes to your code.
• Built-in Backups (--backup): Automatically generates timestamped backup files before applying any modifications, ensuring you can always revert if needed.