[teiid-commits] teiid SVN: r1944 - trunk/documentation/admin-guide/src/main/docbook/en-US/content.

Author: shawkins Date: 2010-03-09 10:46:05 -0500 (Tue, 09 Mar 2010) New Revision: 1944 Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-a.xml trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-b.xml trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-c.xml trunk/documentation/admin-guide/src/main/docbook/en-US/content/connection-management.xml trunk/documentation/admin-guide/src/main/docbook/en-US/content/getting-started.xml trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml trunk/documentation/admin-guide/src/main/docbook/en-US/content/working-with-scripts.xml trunk/documentation/admin-guide/src/main/docbook/en-US/content/writing-tests.xml Log: TEIID-698 updating adminshell doc Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-a.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-a.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-a.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -35,8 +35,8 @@ <answer> <para>At command prompt type</para> <programlisting><![CDATA[ -mmadmin $ debug= true; // to turn it ON -mmadmin $ debug= false; // to turn it OFF +admin $ debug= true; // to turn it ON +admin $ debug= false; // to turn it OFF ]]></programlisting> </answer> </qandaentry> Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-b.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-b.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-b.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -1,6 +1,6 @@ <appendix id="assertion_list"> <title>Assert Commands Available</title> - <para>The following are the list of assert commands available in the MMAdmin to be used with the scripts. + <para>The following are the list of assert commands available in the Admin Shell to be used with the scripts. </para> <sect1> <title>Assertions for SQL results</title> Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-c.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-c.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/appendix-c.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -1,7 +1,7 @@ <appendix id="jdbc_commands"> <title>JDBC Commands</title> <para>The following are the list of commands available in the JDBC module, these will aid in executing SQL - commands in the MMAdmin shell. These commands can be used in your program once after the initial connection is + commands in the Admin Shell. These commands can be used in your program once after the initial connection is made</para> <programlisting><![CDATA[ /** Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/connection-management.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/connection-management.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/connection-management.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -4,7 +4,7 @@ <title>Connection Management</title> <sect1> <title>Default Connection Properties</title> - <para>The file "connection.properties" in the installation directory of the MMAdmin defines the default + <para>The file "connection.properties" in the installation directory of the AdminShell defines the default connection properties with which user can connect to Teiid system. The following  properties can be defined using this file</para> <programlisting><![CDATA[ @@ -30,7 +30,7 @@ <title>Handling Multiple Connections</title> <para>Using MMAdmin, user can actively manage more than one connection to a single or multiple Teiid systems. For example, two separate connections can be maintained, one to the development server and one to - the integration server at the same time. This is possible because MMAdmin supports a feature called named + the integration server at the same time. This is possible because Admin Shell supports a feature called named connections. </para> <para>Every time a connection is made, it assigns a unique name to that connection and manages the context  of the connection under that name.  Unless, user makes another connection all the commands executed Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/getting-started.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/getting-started.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/getting-started.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -5,7 +5,7 @@ <para> To learn the basics of BeanShell (<ulink url="http://beanshell.org/">http://beanshell.org</ulink>) take a look at their documents and tutorials on their website A copy of the BeanShell document is also can - be found in the MMAdmin installation directory. Learn how basic scripts can be written and get familiar with + be found in the Admin Shell installation directory. Learn how basic scripts can be written and get familiar with some commonly used commands. </para> <para>Note: BeanShell documentation provided is of version 1.3, which is taken as is from their website, @@ -18,8 +18,8 @@ </para> <para>You can learn about the Teiid administrative API either using “help()” command or find JavaDoc for in the installation directory.</para> - <para>MMAdmin is a specialized version of BeanShell with lots of pre-built libraries and scripts - designed to be  used with the Teiid system. MMAdmin works in two different modes: interactive or script + <para>Admin Shell is a specialized version of BeanShell with lots of pre-built libraries and scripts + designed to be  used with the Teiid system. Admin Shell works in two different modes: interactive or script run mode.</para> <para>In interactive mode, user can invoke the tool and connect to a live Teiid system and issue any ad-hoc commands to control the system or issue a SQL query against connected virtual database and view the @@ -31,7 +31,7 @@ <sect1> <title>Essential rules to follow in using MMAdmin</title> - <para>To use MMAdmin successfully, there are some syntactical rules you should keep in mind.</para> + <para>To use Admin Shell successfully, there are some syntactical rules you should keep in mind.</para> <orderedlist> <listitem> <para>All the commands end with semi-colon [;]. Commands without any input parameters end with open @@ -81,13 +81,13 @@ script finishes the tool will exit automatically, however you still have to disconnect from Teiid system in the script.</para> <para>Note: If SSL is turned on the Teiid server, you would need to supply the correct certificates - for connection. Edit the command file used to execute the MMAdmin and make sure correct trust store is + for connection. Edit the command file used to execute the Admin Shell and make sure correct trust store is defined in the path.</para> </sect1> <sect1> <title>Basic commands to get started</title> - <para>The list below contains some common commands used in MMAdmin. The best way to learn scripting in the - MMAdmin is to read the scripts in "samples" directory in the MMAdmin kit's installation directory, and + <para>The list below contains some common commands used in Admin Shell. The best way to learn scripting in the + Admin Shell is to read the scripts in "samples" directory in the Admin Shell kit's installation directory, and experiment your own scripts using a developer instance of Teiid System.</para> <programlisting><![CDATA[ print("xxx"); // print something to console @@ -117,12 +117,12 @@ that none of the BeanShell commands or custom commands will be shown in this list. Documentation is only source for reviewing those commands presently.</para> <programlisting><![CDATA[ - mmadmin $ help(); + admin $ help(); ]]></programlisting> <para>To get a specific definition about a command and it's required input parameters , use the below form of help. The example shown will show detailed JavaDoc description about "addVDB" method.</para> <programlisting><![CDATA[ -mmadmin $ help("addVDB"); +admin $ help("addVDB"); /** * Import a {@link VDB} file. * <br>A VDB file with internal definitions. This is the default VDB export configuration @@ -139,7 +139,7 @@ <para>If not sure about exact command, and to narrow the list available commands, help can be used in the following form, note the “*” at the end</para> <programlisting><![CDATA[ -mmadmin $   help(“get*”); +admin $   help(“get*”); ]]></programlisting> <para>This will list all the commands available that begin with “get”, for example “getconnectorBindings, getVDBs” etc.</para> Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -5,10 +5,10 @@ <sect1> <title>Introduction to MMAdmin</title> <para> - MMAdmin is a script based programing environment that enables user to access, monitor and control Teiid + Admin Shell is a script based programming environment that enables user to access, monitor and control Teiid Server and MMQuery environments. This tool is built using programming language called BeanShell ( <ulink url="http://beanshell.org/">http://beanshell.org</ulink> - ). MMAdmin can be used in ad-hoc scripting, or to run pre-defined scripts. It is not a graphical tool; it's a + ). Admin Shell can be used in ad-hoc scripting, or to run pre-defined scripts. It is not a graphical tool; it's a command line driven environment. </para> <orderedlist> @@ -41,21 +41,16 @@ </listitem> </orderedlist> <sect2> - <title>Where can you find MMAdmin?</title> - Where can you find MMAdmin - <para>MMAdmin is bundled with the Teiid under “tools” package. Download and unzip this - file to any directory using WinZip or tar command. Once you have unzipped the file, in root directory - you will find “mmadmin” executable script to invoke the tool.</para> - <para>Windows: Double click or execute "mmadmin.cmd"</para> - <para>*nix: Execute the "mmadmin" script</para> - <para>to invoke MMAdmin. This will initialize the shell and present you with a prompt:</para> + <title>Where can you find Admin Shell?</title> + <para>Admin Shell is available under the “tools” package. Download and unzip this + file to any directory. Once you have unzipped the file, in root directory + you will find “adminshell” executable script to invoke the tool.</para> + <para>Windows: Double click or execute "adminshell.cmd"</para> + <para>*nix: Execute the "adminshell.sh" script</para> + <para>to invoke Admin Shell. This will initialize the shell and present you with a prompt:</para> <programlisting><![CDATA[ - mmadmin $ + admin $ ]]></programlisting> - <para>Note:  JDBC client API jar files are required on the same machine in order to successfully invoke - MMAdmin. Usually these jar files are found in “Server” or “Console” installation directories under “client” - directory.</para> - <para /> </sect2> </sect1> </chapter> \ No newline at end of file Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/working-with-scripts.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/working-with-scripts.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/working-with-scripts.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -5,7 +5,7 @@ <sect1> <title>How to write your own scripts</title> <para>Open up a text editor, and enter all the commands in a editor and save the file “.bsh” extension and - place it in the distribution where MMAdmin tool can access it. Take  a look at the “samples” directory for + place it in the distribution where Admin Shell tool can access it. Take  a look at the “samples” directory for example scripts. For example:</para> <programlisting><![CDATA[ // foo.bsh @@ -33,7 +33,7 @@ <para>To execute a script file "foo.bsh" in a directory "some/directory" in interactive mode, execute as following</para> <programlisting><![CDATA[ -mmadmin $ source ("some/directory/foo.bsh"); +admin $ source ("some/directory/foo.bsh"); ]]></programlisting> <para>"foo.bsh" is read into current context of the shell as if you typed in the whole document. If your script only contained method calls, you can explicitly invoke the call to execute.</para> @@ -43,15 +43,15 @@ <para>To execute a script file "foo.bsh" in a directory "some/directory" in non-interactive mode, execute as following command at the command prompt</para> <programlisting><![CDATA[ -mmadmin.sh some/directory/foo.bsh +admin.sh some/directory/foo.bsh ]]></programlisting> <para>Note that, in the script mode it is NOT possible to pass in the command line parameters as</para> <programlisting><![CDATA[ -mmadmin.sh some/directory/foo.bsh One Two +admin.sh some/directory/foo.bsh One Two ]]></programlisting> <para>The parameters can be passed in as Java system properties. For example</para> <programlisting><![CDATA[ -mmadmin.sh some/directory/foo.bsh input1=One input2=Two +admin.sh some/directory/foo.bsh input1=One input2=Two ]]></programlisting> <para>Inside the script file, you can access these properties using Java system property semantics</para> <programlisting><![CDATA[ @@ -68,9 +68,9 @@ using “startRecording” and “stopRecording” commands. For example,</para> <para /> <programlisting><![CDATA[ -mmadmin $ startRecording (“directory/filename.bsh”); -mmadmin $ <commands..> -mmadmin $ stopRecording() +admin $ startRecording (“directory/filename.bsh”); +admin $ <commands..> +admin $ stopRecording() ]]></programlisting> <para>in this case all the commands executed after the “startRecording” and before the “stopRecording” are captured in the “directory/filename.bsh” file. This gives the user an option to capture only certain portions Modified: trunk/documentation/admin-guide/src/main/docbook/en-US/content/writing-tests.xml =================================================================== --- trunk/documentation/admin-guide/src/main/docbook/en-US/content/writing-tests.xml 2010-03-09 14:31:12 UTC (rev 1943) +++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/writing-tests.xml 2010-03-09 15:46:05 UTC (rev 1944) @@ -11,7 +11,7 @@ <para>start a method name which begins with "testxxxx()"</para> </listitem> <listitem> - <para>use method body to write actual test. Method body can contain any MMAdmin based script using Admin + <para>use method body to write actual test. Method body can contain any Admin Shell based script using Admin API and JDBC commands</para> </listitem> <listitem>