TEIIDDES-2816 updated user guide to reflect new features and

enhancements
Teiid-Designer · Mar 30, 2016 · 032624e · 032624e
1 parent 68edaa3
commit 032624e
Show file tree

Hide file tree

Showing 26 changed files with 202 additions and 229 deletions.
diff --git a/...r_User_Guide/en-US/images/screencaps/convert-functions-to-procedures-action.png b/...r_User_Guide/en-US/images/screencaps/convert-functions-to-procedures-action.png
diff --git a/...r_User_Guide/en-US/images/screencaps/convert-functions-to-procedures-dialog.png b/...r_User_Guide/en-US/images/screencaps/convert-functions-to-procedures-dialog.png
diff --git a/...ser_Guide/en-US/images/screencaps/converted-functions-to-procedures-diagram.png b/...ser_Guide/en-US/images/screencaps/converted-functions-to-procedures-diagram.png
diff --git a/...gner_User_Guide/en-US/images/screencaps/custom-preview-data-preview-sql-tab.png b/...gner_User_Guide/en-US/images/screencaps/custom-preview-data-preview-sql-tab.png
diff --git a/...r_User_Guide/en-US/images/screencaps/custom-preview-data-preview-vdbxml-tab.png b/...r_User_Guide/en-US/images/screencaps/custom-preview-data-preview-vdbxml-tab.png
diff --git a/...er_Guide/en-US/images/screencaps/data-source-definition-options-jdbc-import.png b/...er_Guide/en-US/images/screencaps/data-source-definition-options-jdbc-import.png
diff --git a/...er_Guide/en-US/images/screencaps/data-source-definition-options-ldap-import.png b/...er_Guide/en-US/images/screencaps/data-source-definition-options-ldap-import.png
diff --git a/...Guide/en-US/images/screencaps/data-source-definition-options-page-flat-file.png b/...Guide/en-US/images/screencaps/data-source-definition-options-page-flat-file.png
diff --git a/...Guide/en-US/images/screencaps/data-source-definition-options-ws-rest-import.png b/...Guide/en-US/images/screencaps/data-source-definition-options-ws-rest-import.png
diff --git a/...Guide/en-US/images/screencaps/data-source-definition-options-ws-soap-import.png b/...Guide/en-US/images/screencaps/data-source-definition-options-ws-soap-import.png
diff --git a/...r_User_Guide/en-US/images/screencaps/edit-texttable-function-options-dialog.png b/...r_User_Guide/en-US/images/screencaps/edit-texttable-function-options-dialog.png
diff --git a/.../guides/Teiid_Designer_User_Guide/en-US/images/screencaps/import-vdb-dialog.png b/.../guides/Teiid_Designer_User_Guide/en-US/images/screencaps/import-vdb-dialog.png
diff --git a/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-2.png b/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-2.png
diff --git a/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-3.png b/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-3.png
diff --git a/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-4.png b/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-4.png
diff --git a/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-5.png b/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-5.png
diff --git a/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-6.png b/...id_Designer_User_Guide/en-US/images/screencaps/import-wsdl-to-source-page-6.png
diff --git a/.../en-US/images/screencaps/import-wsdl-to-source-procedure-dependency-diagram.png b/.../en-US/images/screencaps/import-wsdl-to-source-procedure-dependency-diagram.png
diff --git a/...s/Teiid_Designer_User_Guide/en-US/images/screencaps/show-import-vdbs-dialog.png b/...s/Teiid_Designer_User_Guide/en-US/images/screencaps/show-import-vdbs-dialog.png
diff --git a/...d_Designer_User_Guide/en-US/images/screencaps/teiid-designer-import-options.png b/...d_Designer_User_Guide/en-US/images/screencaps/teiid-designer-import-options.png
diff --git a/documentation/guides/Teiid_Designer_User_Guide/en-US/importers.xml b/documentation/guides/Teiid_Designer_User_Guide/en-US/importers.xml
diff --git a/documentation/guides/Teiid_Designer_User_Guide/en-US/intro.xml b/documentation/guides/Teiid_Designer_User_Guide/en-US/intro.xml
@@ -590,6 +590,10 @@
 	   		  updated based on how the VDB is configured. Since VDB's are just databases once they are deployed, they 
 	   		  can be used as sources to other view model transformations. This allows creating and deploying re-usable 
 	   		  or common VDB's in multiple layers depending on your business needs. </para>
+	   		  <para>Starting in Teiid Designer 9.0, support was added for converting between archive (ZIP) VDBs and simple 
+	   		  Dynamic VDB XML files. Dynamic VDBs provide users to define their source and view metadata via 
+	   		  Teiid DDL statements. This capability allows some users to maintain a simpler version of their VDBs 
+	   		  in a source control system.  (See the <xref linkend="vdb-dynamic-import-export"/> section for more details) </para>
 
 		    <section id="vdb-content-and-structure">
     			<title>VDB Content and Structure</title>

diff --git a/documentation/guides/Teiid_Designer_User_Guide/en-US/managing-vdbs.xml b/documentation/guides/Teiid_Designer_User_Guide/en-US/managing-vdbs.xml
@@ -236,7 +236,8 @@
 			Instead, an &lt;import-vdb&gt; element (described above) reference is added in it's place.
 		</para>
 		<para>If VDB imports exist for a VDB, the <emphasis role="bold">Show Import VDBs</emphasis> button will be 
-			enabled and allow viewing the names of the imported VDBs as shown below.
+			enabled and allow viewing the names of the imported VDBs as shown below. Note that the dialog now supports editing of the version number for 
+			each referenced VDB.
 		</para>
 		<mediaobject>
 			<imageobject>

diff --git a/documentation/guides/Teiid_Designer_User_Guide/en-US/master.xml b/documentation/guides/Teiid_Designer_User_Guide/en-US/master.xml
@@ -20,15 +20,9 @@
 <book>
   <bookinfo>
     <title>Teiid Designer User Guide</title>
-<<<<<<< HEAD
-    <releaseinfo>9.2.1
-    </releaseinfo>
-    <productnumber>9.2.1
-=======
     <releaseinfo>10.0.0
     </releaseinfo>
     <productnumber>10.0.0
->>>>>>> 7be7b96... Eclipse MARS version upgrade
     </productnumber>
     <issuenum>1</issuenum>
     <mediaobject>

diff --git a/documentation/guides/Teiid_Designer_User_Guide/en-US/server-management.xml b/documentation/guides/Teiid_Designer_User_Guide/en-US/server-management.xml
@@ -76,7 +76,7 @@
                         <para>Teiid Server 8.0, 8.1, 8.2 and 8.3 versions installed on JBoss Server 7;</para>
                     </listitem>
                     <listitem>
-                        <para>Teiid Server 8.4 thru 8.7 installed on JBoss Server 7.1.1, 7.2 and EAP 6.1.</para>
+                        <para>Teiid Server 8.4 thru 8.12.4 installed on JBoss Server 7.1.1, 7.2 and EAP 6.1 or greater.</para>
                     </listitem>
                 </itemizedlist>
                 This allows multiple client runtime support from within a single installation of Teiid Designer. However, in order

diff --git a/documentation/guides/Teiid_Designer_User_Guide/en-US/user-defined-functions.xml b/documentation/guides/Teiid_Designer_User_Guide/en-US/user-defined-functions.xml
@@ -132,5 +132,52 @@
             </figure>
 	    </para>
     </section>
+        <section id="legacy-user-defined-functions-section">
+	    <title>Using legacy UDF models</title>
+	    <para>
+			Function models have been deprecated and tooling support to create or edit them will be removed in Teiid Designer 11.0.
+			In 10.0, we've added a feature to convert the functions in your legacy function models into User Defined Functions (virtual procedures)
+			in a target view model.
+			<para>To convert your function model:
+	    	<itemizedlist>
+				<listitem>
+					<para><emphasis role="bold">Step 1</emphasis> - In the
+					<emphasis role="bold">Model Explorer</emphasis> select your function model and select the
+					<emphasis role="bold">Modeling &gt; Convert Legacy Functions to Virtual Procedures</emphasis> action.
+					</para>
+					<figure>
+						<title>Convert Legacy Functions to Virtual Procedures Action</title>
+						<mediaobject><imageobject>
+						<imagedata fileref="images/screencaps/convert-functions-to-procedures-action.png"/>
+						</imageobject></mediaobject>
+					</figure>
+			    </listitem>
+			  	<listitem>
+			    	<para><emphasis role="bold">Step 2</emphasis> - In the dialog, check the functions you wish to convert and
+			    	select the target virtual model and click <emphasis role="bold">OK&gt;</emphasis>.
+			    	</para>
+			    	<figure>
+						<title>Convert Legacy Functions Dialog</title>
+						<mediaobject>
+							<imageobject>
+								<imagedata fileref="images/screencaps/convert-functions-to-procedures-dialog.png"/>
+							</imageobject>
+						</mediaobject>
+					</figure>
+			    </listitem>
+		    </itemizedlist>
+	    </para>
+			<para>The selected scalar functions are now defined as virtual model User Defined Functions and available to use in
+			your transformations</para>
+			<figure>
+                <title>Converted Functions Diagram</title>
+                <mediaobject>
+                    <imageobject>
+                        <imagedata fileref="images/screencaps/converted-functions-to-procedures-diagram.png" />
+                    </imageobject>
+                </mediaobject>
+            </figure>
+	    </para>
+    </section>
 </chapter>