[PDI-20078] - Metadata generated from "Automatic Documentation Output…

…" step for a transformation/job will contain all the unwanted connections available in the repository (pentaho#9279)
abryant-hv · Apr 18, 2024 · 3880e41 · 3880e41
1 parent e3e3794
commit 3880e41
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/core/src/main/java/org/pentaho/di/core/Const.java b/core/src/main/java/org/pentaho/di/core/Const.java
@@ -1657,6 +1657,11 @@ public static String getShimDriverDeploymentLocation() {
    */
   public static final String COMPATIBILITY_SHOW_WARNINGS_EXECUTE_EVERY_INPUT_ROW = "COMPATIBILITY_SHOW_WARNINGS_EXECUTE_EVERY_INPUT_ROW";
 
+  /**
+   Value to Configure if we want to export only the used connections to the XML file
+   */
+  public static final String STRING_ONLY_USED_DB_TO_XML = "STRING_ONLY_USED_DB_TO_XML";
+
   /**
    * rounds double f to any number of places after decimal point Does arithmetic using BigDecimal class to avoid integer
    * overflow while rounding

diff --git a/engine/src/main/java/org/pentaho/di/trans/TransMeta.java b/engine/src/main/java/org/pentaho/di/trans/TransMeta.java
@@ -2566,7 +2566,10 @@ public String getXML( boolean includeSteps, boolean includeDatabase, boolean inc
     if ( includeDatabase ) {
       for ( int i = 0; i < nrDatabases(); i++ ) {
         DatabaseMeta dbMeta = getDatabase( i );
-        if ( props != null && props.areOnlyUsedConnectionsSavedToXML() ) {
+        //PDI-20078 - If props == null, it means transformation is running on the slave server. For the
+        // method areOnlyUsedConnectionsSavedToXMLInServer to return false, the "STRING_ONLY_USED_DB_TO_XML"
+        // needs to have "N" in the server startup script file
+        if ( props != null && props.areOnlyUsedConnectionsSavedToXML() || props == null && areOnlyUsedConnectionsSavedToXMLInServer() ) {
           if ( isDatabaseConnectionUsed( dbMeta ) ) {
             retval.append( dbMeta.getXML() );
           }
@@ -2621,6 +2624,11 @@ public String getXML( boolean includeSteps, boolean includeDatabase, boolean inc
     return XMLFormatter.format( retval.toString() );
   }
 
+  public boolean areOnlyUsedConnectionsSavedToXMLInServer() {
+    String show = System.getProperty( Const.STRING_ONLY_USED_DB_TO_XML, "Y" );
+    return "Y".equalsIgnoreCase( show ); // Default: save only used connections
+  }
+
   /**
    * Parses a file containing the XML that describes the transformation. No default connections are loaded since no
    * repository is available at this time. Since the filename is set, internal variables are being set that relate to

diff --git a/engine/src/main/resources/kettle-variables.xml b/engine/src/main/resources/kettle-variables.xml
@@ -663,5 +663,4 @@
     <variable>COMPATIBILITY_SHOW_WARNINGS_EXECUTE_EVERY_INPUT_ROW</variable>
     <default-value>Y</default-value>
   </kettle-variable>
-
 </kettle-variables>