|
@@ -42,15 +42,18 @@
|
|
|
<para></para>
|
|
|
</legalnotice>
|
|
|
|
|
|
- <xi:include href="common/Version.xml" xpointer="xpointer(//*[@id='FooterInfo'])"
|
|
|
+ <xi:include href="common/Version.xml"
|
|
|
+ xpointer="xpointer(//*[@id='FooterInfo'])"
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
|
|
|
|
- <xi:include href="common/Version.xml" xpointer="xpointer(//*[@id='DateVer'])"
|
|
|
+ <xi:include href="common/Version.xml"
|
|
|
+ xpointer="xpointer(//*[@id='DateVer'])"
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
|
|
|
|
<corpname>HPCC Systems<superscript>®</superscript></corpname>
|
|
|
|
|
|
- <xi:include href="common/Version.xml" xpointer="xpointer(//*[@id='Copyright'])"
|
|
|
+ <xi:include href="common/Version.xml"
|
|
|
+ xpointer="xpointer(//*[@id='Copyright'])"
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
|
|
|
|
<mediaobject role="logo">
|
|
@@ -63,20 +66,442 @@
|
|
|
<chapter id="ECLWatch_Intro">
|
|
|
<title>Introducing ECL Watch</title>
|
|
|
|
|
|
- <sect1 id="ECLWatch_Introduction" role="nobrk">
|
|
|
- <title>Introduction</title>
|
|
|
+ <para>ECL Watch is a service that runs on the Enterprise Services Platform
|
|
|
+ (ESP), a middleware component on the HPCC Platform.</para>
|
|
|
+
|
|
|
+ <para>ECL Watch provides an interface to the HPCC system and allows you to
|
|
|
+ view information and interrogate nodes to confirm all expected processes
|
|
|
+ are running. It is a plugin that is useful for Systems Administrators to
|
|
|
+ check processes, examine topology, and view logs. It is useful to ECL
|
|
|
+ Programmers to monitor the status of jobs and files, and other pertinent
|
|
|
+ information. This provides a simple view into the system and a means to
|
|
|
+ perform Workunit and data files maintenance.</para>
|
|
|
+
|
|
|
+ <para>The ECL Watch interface is a browser based set of pages where you
|
|
|
+ can access and interface with the HPCC System. To Run <emphasis
|
|
|
+ role="bold">ECL Watch</emphasis> using you browser, go to the node on your
|
|
|
+ system running <emphasis role="bold">ESP/ECL Watch</emphasis> on port
|
|
|
+ 8010. For example, http://nnn.nnn.nnn.nnn:8010, where nnn.nnn.nnn.nnn is
|
|
|
+ your ESP/ECL Watch node's IP address. This will launch ECL Watch.</para>
|
|
|
+
|
|
|
+ <para>ECL Watch is organized by categories based on several system
|
|
|
+ functions. These functions or actions are accessible through the links
|
|
|
+ along the top of the main home page. However there are several ECL Watch
|
|
|
+ items with common functionality universally across pages of ECL
|
|
|
+ Watch.</para>
|
|
|
+
|
|
|
+ <sect1 id="Common_Elements">
|
|
|
+ <title>Common Elements</title>
|
|
|
+
|
|
|
+ <para>There are common elements that are useful anywhere within ECL
|
|
|
+ Watch.</para>
|
|
|
+
|
|
|
+ <sect2 id="OpenInNewPage">
|
|
|
+ <title>Open in New Page</title>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">Open in New Page</emphasis> link
|
|
|
+ allows you to open a new window directly to the item which you are
|
|
|
+ viewing. <figure>
|
|
|
+ <title>Open in New Page</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWA500.jpg" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+
|
|
|
+ <para>Opening a new page of the current view is useful in several
|
|
|
+ ways:</para>
|
|
|
+
|
|
|
+ <itemizedlist>
|
|
|
+ <listitem>
|
|
|
+ <para><emphasis role="bold">Open in New Page</emphasis> is a
|
|
|
+ shareable link. Right-click on <emphasis role="bold">Open in New
|
|
|
+ Page</emphasis> and select <emphasis>Copy link address</emphasis>
|
|
|
+ from the context menu. You can now save, share, or send that link
|
|
|
+ and the recipient can open a window directly to the (new)
|
|
|
+ page.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>New pages maintain filter states. If you have set a filter
|
|
|
+ and share that link, the new page has the same filter set.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>The new page is live. (If that page has auto-refresh
|
|
|
+ enabled) The recipient doesn't need to reset the page or refresh
|
|
|
+ to see current state.</para>
|
|
|
+ </listitem>
|
|
|
+ </itemizedlist>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="ListWidgets">
|
|
|
+ <title>List widgets</title>
|
|
|
+
|
|
|
+ <para><figure>
|
|
|
+ <title>List Widgets</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWA-Comm.jpg" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+
|
|
|
+ <para>ECL Watch commonly displays items in the forms of a list. Lists
|
|
|
+ of workunits, lists of logical files, lists of Roxie queries, etc. The
|
|
|
+ following elements in ECL Watch work on any list widget:</para>
|
|
|
+
|
|
|
+ <para><itemizedlist>
|
|
|
+ <listitem>
|
|
|
+ <para>Download as CSV (Workunits, DFU Workunits, Logical files,
|
|
|
+ and Roxie queries)</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Column check box. Select all rows by selecting the check
|
|
|
+ box at top (Use Shift+Click to select a range)</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Sort by column header. Click on the column header to sort
|
|
|
+ that column according to that column's contents.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Resize Column Widths by dragging the borders.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Filters that allow you to set criteria for the items to
|
|
|
+ display in the list.</para>
|
|
|
+ </listitem>
|
|
|
+ </itemizedlist></para>
|
|
|
+
|
|
|
+ <sect3>
|
|
|
+ <title>List Filters</title>
|
|
|
+
|
|
|
+ <para>Filter options on a list allow you to use specified criteria
|
|
|
+ to set what you display in the list. Press the <emphasis
|
|
|
+ role="bold">Filter</emphasis> action button to display the filter
|
|
|
+ options. When you specify any Filter options, the Filter action
|
|
|
+ button changes and then displays <emphasis role="bold">Filter
|
|
|
+ Set</emphasis> and the filter indicator image lights up. When you
|
|
|
+ then copy an <emphasis role="bold">Open in New Page</emphasis> link
|
|
|
+ with the filter set, the filter condition persists. Filter
|
|
|
+ conditions limit the results displayed until you clear the
|
|
|
+ filter.</para>
|
|
|
+ </sect3>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="ECLWA_BannerItems">
|
|
|
+ <title>Banner Items</title>
|
|
|
+
|
|
|
+ <para>The banner area of ECL Watch appears at the top of all pages.
|
|
|
+ </para>
|
|
|
+
|
|
|
+ <sect3 id="ECLWAtchHomeButton">
|
|
|
+ <title>Home Button</title>
|
|
|
+
|
|
|
+ <para>The HPCC Systems home button is also the main Activity menu
|
|
|
+ link. More than just a decoration the home ECL Watch button actually
|
|
|
+ opens up the Activity page, discussed in more detail in the ensuing
|
|
|
+ chapter.</para>
|
|
|
+
|
|
|
+ <para>The icons to the left of the home button are links to
|
|
|
+ different areas of ECL Watch. Each of the link areas are discussed
|
|
|
+ in subsequent chapters.</para>
|
|
|
+ </sect3>
|
|
|
+
|
|
|
+ <sect3 id="MonitorIndicatorLight">
|
|
|
+ <title>Monitor indicator light</title>
|
|
|
+
|
|
|
+ <para>The Monitor indicator light is used to provide an at a glance
|
|
|
+ snapshot of your overall system health. If you have monitoring and
|
|
|
+ reporting configured (see <emphasis>HPCC Monitoring and
|
|
|
+ Reporting</emphasis>) then this light will display a color based on
|
|
|
+ the the overall (configurable) system health. The light is black if
|
|
|
+ there is no monitoring or reporting configured for your
|
|
|
+ system.</para>
|
|
|
+ </sect3>
|
|
|
+
|
|
|
+ <sect3 id="DownloadAsCSV">
|
|
|
+ <title>Download as CSV</title>
|
|
|
+
|
|
|
+ <para>With most lists in ECL Watch you have the ability to download
|
|
|
+ selected rows as a CSV formatted file. You can then open the CSV
|
|
|
+ file in any spreadsheet application which supports CSV
|
|
|
+ format.</para>
|
|
|
+ </sect3>
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2 id="ECLWatch_GlobalSearch">
|
|
|
+ <title>Global Search</title>
|
|
|
+
|
|
|
+ <para>The global search box can be found on the navigation bar at the
|
|
|
+ top of the ECL Watch page.<figure>
|
|
|
+ <title>Global Search box</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWA008.jpg" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+
|
|
|
+ <para>You can search ECL Workunits, DFU Workunits, Logical Files, and
|
|
|
+ Queries using the global search box. The global search box also
|
|
|
+ supports using wildcards. To limit or filter your search results you
|
|
|
+ can use keywords as displayed in the empty search box.</para>
|
|
|
+
|
|
|
+ <para><variablelist>
|
|
|
+ <varlistentry>
|
|
|
+ <term>file:</term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Preface the search string with
|
|
|
+ <emphasis>file:</emphasis> to search Logical Files.</para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+
|
|
|
+ <varlistentry>
|
|
|
+ <term>wuid:</term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Preface the search string with
|
|
|
+ <emphasis>wuid:</emphasis> to search only Workunit ids.</para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+
|
|
|
+ <varlistentry>
|
|
|
+ <term>ecl:</term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Preface the search string with <emphasis>ecl:</emphasis>
|
|
|
+ to search only the ECL workunits.</para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+
|
|
|
+ <varlistentry>
|
|
|
+ <term>dfu:</term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Preface the search string with <emphasis>dfu:</emphasis>
|
|
|
+ to search only DFU workunits.</para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+
|
|
|
+ <varlistentry>
|
|
|
+ <term>query:</term>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Preface the search string with
|
|
|
+ <emphasis>query:</emphasis> to search only published
|
|
|
+ queries.</para>
|
|
|
+ </listitem>
|
|
|
+ </varlistentry>
|
|
|
+ </variablelist>Examples of using the global search:</para>
|
|
|
+
|
|
|
+ <para>Enter <emphasis>W201510*</emphasis> into the search box, and it
|
|
|
+ will return all of the workunits from October 2015.</para>
|
|
|
+
|
|
|
+ <para>Enter <emphasis>file:keys</emphasis> into the search box, and it
|
|
|
+ will return all of the logical files that contain "keys". <figure>
|
|
|
+ <title>Global Search Example</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWA015.jpg" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+
|
|
|
+ <!-- Enter <i>ecl:output</i> into the global search box and it will return all of the workunits that contain "output" in the ECL page of ECL Watch-->
|
|
|
+ </sect2>
|
|
|
+
|
|
|
+ <sect2>
|
|
|
+ <title>Advanced Menu</title>
|
|
|
+
|
|
|
+ <para>There is a section at the top right on the navigation bar with
|
|
|
+ some useful information and features. This section shows you who you
|
|
|
+ are logged in as (if your system has authentication enabled). The
|
|
|
+ Advanced menu is located on the right hand side of the navigation bar.
|
|
|
+ There are several items that you can access from the advanced
|
|
|
+ menu.</para>
|
|
|
+
|
|
|
+ <para><figure>
|
|
|
+ <title>Advanced menu</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWA007b.jpg" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+
|
|
|
+ <para>There may be a number displayed on the menu link. A number
|
|
|
+ displayed next to it indicates how many errors and warnings have been
|
|
|
+ generated during your session. Click on the advanced menu to display a
|
|
|
+ list of features.</para>
|
|
|
+
|
|
|
+ <sect3 id="ECLWatch_AdvancedMenuAccess">
|
|
|
+ <title>Access the Advanced menu</title>
|
|
|
+
|
|
|
+ <para>You access the advanced menu items from the advanced menu link
|
|
|
+ at the top right corner of ECL Watch.<!--Removed some content stashed in GitStash : ECLWA-1115.xml others culled stored in git-br H8872-NewestECLfor50 **--></para>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">Set Banner</emphasis> link allows
|
|
|
+ you to set a custom banner message at the top of your browser window
|
|
|
+ when you open ECL Watch. You can use this feature to send messages
|
|
|
+ to users.</para>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">Error/Warning(s)</emphasis> link
|
|
|
+ displays a tab showing you Errors, Warnings, and Information
|
|
|
+ messages. You can filter this page by checking the boxes at the
|
|
|
+ bottom of the tab. A copy facility is also provided.</para>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">Transition Guide</emphasis> link
|
|
|
+ opens a new browser tab to the page where you can find more
|
|
|
+ information about transitioning from using the previous version of
|
|
|
+ HPCC and ECL Watch.</para>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">Additional Resources</emphasis> link
|
|
|
+ opens submenu with links to the HPCC
|
|
|
+ Systems<superscript>®</superscript> <emphasis
|
|
|
+ role="bold">Downloads</emphasis> page, where you can browse and
|
|
|
+ download additional HPCC resources. It also has links to <emphasis
|
|
|
+ role="bold">Issue Reporting</emphasis>, <emphasis
|
|
|
+ role="bold">Forums</emphasis>, and the HPCC <emphasis
|
|
|
+ role="bold">Red Book</emphasis>.</para>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">Configuration</emphasis> link opens
|
|
|
+ for viewing the XML version of the configuration file in use on your
|
|
|
+ system.</para>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">About</emphasis> link opens a dialog
|
|
|
+ to display some information about the version of the HPCC platform
|
|
|
+ and graph controls installed on your server.</para>
|
|
|
+ </sect3>
|
|
|
+
|
|
|
+ <sect3 id="ECLWatch_AdvancedMenuLoggedInAs" role="nobrk">
|
|
|
+ <title>Logged In As</title>
|
|
|
+
|
|
|
+ <para>The <emphasis role="bold">Logged In As:</emphasis> link at the
|
|
|
+ top of the ECL Watch page displays information about the current
|
|
|
+ user on a cluster configured for authentication. <figure>
|
|
|
+ <title>Logged In As</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWMyAccount.jpg" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+
|
|
|
+ <para><orderedlist>
|
|
|
+ <listitem>
|
|
|
+ <para>Click on the <emphasis role="bold"><emphasis
|
|
|
+ role="bold">LOGGED IN AS:</emphasis></emphasis> link.</para>
|
|
|
+
|
|
|
+ <para>The User Details window opens. The default window opens
|
|
|
+ on the Summary tab.</para>
|
|
|
+
|
|
|
+ <para><figure>
|
|
|
+ <title>User Details window</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWA474.jpg" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>From The User Details page Summary tab, you can Confirm
|
|
|
+ the User Name that you are logged in as.</para>
|
|
|
+
|
|
|
+ <para>You can change your password.</para>
|
|
|
+
|
|
|
+ <para>Note that Administrator rights are needed to manage
|
|
|
+ users and permissions.</para>
|
|
|
+
|
|
|
+ <para>Ensure you are using an account with Administrator
|
|
|
+ rights if you intend to manage users or permissions.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Verify the password expiration date, or if password is
|
|
|
+ set to expire.</para>
|
|
|
+ </listitem>
|
|
|
+ </orderedlist></para>
|
|
|
+
|
|
|
+ <sect4 id="ECLWatch_AdvancedMenuChangePassword" role="nobrk">
|
|
|
+ <title>Change Password</title>
|
|
|
|
|
|
- <para>ECL Watch is a service that runs on the Enterprise Services
|
|
|
- Platform (ESP), a middleware component on the HPCC Platform.</para>
|
|
|
+ <para>If authentication is enabled on your HPCC system, you can
|
|
|
+ change your password, right from the User Details window.
|
|
|
+ <orderedlist>
|
|
|
+ <listitem>
|
|
|
+ <para>Click on the <emphasis role="bold"><emphasis
|
|
|
+ role="bold">LOGGED IN AS:</emphasis></emphasis> link.</para>
|
|
|
|
|
|
- <para>ECL Watch provides an interface to the HPCC system and allows you
|
|
|
- to view information and interrogate nodes to confirm all expected
|
|
|
- processes are running. It is a plugin that is useful for Systems
|
|
|
- Administrators to check processes, examine topology, and view logs. It
|
|
|
- is useful to ECL Programmers to monitor the status of jobs and files,
|
|
|
- and other pertinent information. This provides a simple view into the
|
|
|
- system and a means to perform Workunit and data files
|
|
|
- maintenance.</para>
|
|
|
+ <para>The User Details window opens. The default window
|
|
|
+ opens on the Summary tab. There are fields on the Summary
|
|
|
+ tab where you can change your password.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Enter your desired new password.</para>
|
|
|
+
|
|
|
+ <para>Make sure it meets whatever criteria your system may
|
|
|
+ have for passwords.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Confirm your new password.</para>
|
|
|
+
|
|
|
+ <para>Make sure that it matches the password you entered in
|
|
|
+ the previous field.</para>
|
|
|
+ </listitem>
|
|
|
+
|
|
|
+ <listitem>
|
|
|
+ <para>Press the Save button. It is in the upper left portion
|
|
|
+ of the window.</para>
|
|
|
+ </listitem>
|
|
|
+ </orderedlist></para>
|
|
|
+ </sect4>
|
|
|
+
|
|
|
+ <sect4 id="ECLWatch_AdvancedMenuPermissionGroups">
|
|
|
+ <title>Permission groups</title>
|
|
|
+
|
|
|
+ <para>The second tab on the User Details window labelled Member
|
|
|
+ Of, displays a list of groups. The groups your account belongs to,
|
|
|
+ are indicated with a checkmark.</para>
|
|
|
+
|
|
|
+ <para>You must be an administrator to modify any of group
|
|
|
+ settings.</para>
|
|
|
+ </sect4>
|
|
|
+
|
|
|
+ <sect4 id="ECLWatch_AdvancedMenuUserPermissions">
|
|
|
+ <title>User Permissions tab</title>
|
|
|
+
|
|
|
+ <para>The third tab on the User Details window labelled <emphasis
|
|
|
+ role="bold">User Permissions</emphasis>, displays a list of
|
|
|
+ permission settings. Note that Administrator rights are needed to
|
|
|
+ manage users and permissions. Ensure you are using an account with
|
|
|
+ Administrator rights if you intend to manage users or
|
|
|
+ permissions.</para>
|
|
|
+
|
|
|
+ <para>This is where you can access the user permissions area. A
|
|
|
+ more detailed description of the user permissions settings is
|
|
|
+ covered in the <link linkend="User_Permissions_Chapter">User
|
|
|
+ Permissions</link> section.</para>
|
|
|
+ </sect4>
|
|
|
+ </sect3>
|
|
|
+ </sect2>
|
|
|
</sect1>
|
|
|
</chapter>
|
|
|
|
|
@@ -567,98 +992,6 @@
|
|
|
<xi:include href="ECLScheduler/ECLSched-Mods/ECLSchedComp.xml"
|
|
|
xpointer="xpointer(//*[@id='ECLSched_Interface'])"
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
|
-
|
|
|
- <sect1>
|
|
|
- <title>Search Results</title>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">Search Results</emphasis> tab displays
|
|
|
- when you perform a search. The search capabilities of ECL Watch are a
|
|
|
- very powerful tool.</para>
|
|
|
-
|
|
|
- <sect2 id="ECLWatch_GlobalSearch">
|
|
|
- <title>Global Search</title>
|
|
|
-
|
|
|
- <para>The global search box can be found on the navigation bar at the
|
|
|
- top of the ECL Watch page.<figure>
|
|
|
- <title>Global Search box</title>
|
|
|
-
|
|
|
- <mediaobject>
|
|
|
- <imageobject>
|
|
|
- <imagedata fileref="images/ECLWA008.jpg" />
|
|
|
- </imageobject>
|
|
|
- </mediaobject>
|
|
|
- </figure></para>
|
|
|
-
|
|
|
- <para>You can search ECL Workunits, DFU Workuntis, Logical Files, and
|
|
|
- Queries using the global search box. The global search box also
|
|
|
- supports wild cards. To limit or filter your search results you can
|
|
|
- use keywords as displayed in the empty search box.</para>
|
|
|
-
|
|
|
- <para><variablelist>
|
|
|
- <varlistentry>
|
|
|
- <term>file:</term>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Preface the search string with
|
|
|
- <emphasis>file:</emphasis> to search Logical Files.</para>
|
|
|
- </listitem>
|
|
|
- </varlistentry>
|
|
|
-
|
|
|
- <varlistentry>
|
|
|
- <term>wuid:</term>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Preface the search string with
|
|
|
- <emphasis>wuid:</emphasis> to search only Workunit ids.</para>
|
|
|
- </listitem>
|
|
|
- </varlistentry>
|
|
|
-
|
|
|
- <varlistentry>
|
|
|
- <term>ecl:</term>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Preface the search string with <emphasis>ecl:</emphasis>
|
|
|
- to search only the ECL workunits.</para>
|
|
|
- </listitem>
|
|
|
- </varlistentry>
|
|
|
-
|
|
|
- <varlistentry>
|
|
|
- <term>dfu:</term>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Preface the search string with <emphasis>dfu:</emphasis>
|
|
|
- to search only DFU workunits.</para>
|
|
|
- </listitem>
|
|
|
- </varlistentry>
|
|
|
-
|
|
|
- <varlistentry>
|
|
|
- <term>query:</term>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Preface the search string with
|
|
|
- <emphasis>query:</emphasis> to search only published
|
|
|
- queries.</para>
|
|
|
- </listitem>
|
|
|
- </varlistentry>
|
|
|
- </variablelist>Examples of using the global search:</para>
|
|
|
-
|
|
|
- <para>Enter <emphasis>W201510*</emphasis> into the search box, and it
|
|
|
- will return all of the workunits from October 2015.</para>
|
|
|
-
|
|
|
- <para>Enter <emphasis>file:keys</emphasis> into the search box, and it
|
|
|
- will return all of the logical files that contain "keys". <figure>
|
|
|
- <title>Global Search Example</title>
|
|
|
-
|
|
|
- <mediaobject>
|
|
|
- <imageobject>
|
|
|
- <imagedata fileref="images/ECLWA015.jpg" />
|
|
|
- </imageobject>
|
|
|
- </mediaobject>
|
|
|
- </figure></para>
|
|
|
-
|
|
|
- <!-- Enter <i>ecl:output</i> into the global search box and it will return all of the workunits that contain "output" in the ECL page of ECL Watch-->
|
|
|
- </sect2>
|
|
|
- </sect1>
|
|
|
</chapter>
|
|
|
|
|
|
<chapter id="ECLWatch_ECLWorkunits">
|
|
@@ -773,7 +1106,8 @@
|
|
|
xpointer="xpointer(//*[@id='Desprays'])"
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
|
|
|
|
- <xi:include href="HPCCDataHandling/DH-Mods/DH-Mod1.xml" xpointer="xpointer(//*[@id='Copy'])"
|
|
|
+ <xi:include href="HPCCDataHandling/DH-Mods/DH-Mod1.xml"
|
|
|
+ xpointer="xpointer(//*[@id='Copy'])"
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
|
|
|
|
<xi:include href="HPCCDataHandling/DH-Mods/DH-Mod1.xml"
|
|
@@ -1028,7 +1362,7 @@
|
|
|
</mediaobject>
|
|
|
</figure></para>
|
|
|
|
|
|
- <sect2 id="TopologyTargets">
|
|
|
+ <sect2 id="TopologyTargets" role="brk">
|
|
|
<title>Targets</title>
|
|
|
|
|
|
<para>The <emphasis role="bold">Targets</emphasis> Action button
|
|
@@ -1052,7 +1386,7 @@
|
|
|
the selected component.</para>
|
|
|
</sect2>
|
|
|
|
|
|
- <sect2 id="TopologyServices">
|
|
|
+ <sect2 id="TopologyServices" role="brk">
|
|
|
<title>Services</title>
|
|
|
|
|
|
<para>Press the <emphasis role="bold">Services</emphasis> Action
|
|
@@ -1078,7 +1412,7 @@
|
|
|
selected component.</para>
|
|
|
</sect2>
|
|
|
|
|
|
- <sect2 id="ECLWatch_Operations_TopologyMachines">
|
|
|
+ <sect2 id="ECLWatch_Operations_TopologyMachines" role="brk">
|
|
|
<title>Machines</title>
|
|
|
|
|
|
<para>Press the <emphasis role="bold">Machines</emphasis> Action
|
|
@@ -1100,6 +1434,22 @@
|
|
|
services on each node. Select the component to view the Summary,
|
|
|
Configuration, or Logs tabs for that selected component.</para>
|
|
|
</sect2>
|
|
|
+
|
|
|
+ <sect2 role="brk">
|
|
|
+ <title>Roxie File Copy Status</title>
|
|
|
+
|
|
|
+ <para>In the Topology section for Roxie clusters, the <emphasis
|
|
|
+ role="bold">Roxie Files Copy Status</emphasis> tab shows the number of
|
|
|
+ files a cluster has left to copy.<figure>
|
|
|
+ <title>File Copy Status</title>
|
|
|
+
|
|
|
+ <mediaobject>
|
|
|
+ <imageobject>
|
|
|
+ <imagedata fileref="images/ECLWA467.jpg" vendor="ECLWatchSS" />
|
|
|
+ </imageobject>
|
|
|
+ </mediaobject>
|
|
|
+ </figure></para>
|
|
|
+ </sect2>
|
|
|
</sect1>
|
|
|
|
|
|
<sect1 id="ECLWatch_Operations_DiskUsage">
|
|
@@ -1457,178 +1807,6 @@
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude" />
|
|
|
</chapter>
|
|
|
|
|
|
- <chapter id="Account_Info">
|
|
|
- <title>Advanced Menu</title>
|
|
|
-
|
|
|
- <para>There is a section at the top right on the navigation bar with some
|
|
|
- useful information and features. This section shows you who you are logged
|
|
|
- in as (if your system has authentication enabled). The Advanced menu is
|
|
|
- located on the right hand side of the navigation bar. There are several
|
|
|
- items that you can access from the advanced menu.</para>
|
|
|
-
|
|
|
- <para><figure>
|
|
|
- <title>Advanced menu</title>
|
|
|
-
|
|
|
- <mediaobject>
|
|
|
- <imageobject>
|
|
|
- <imagedata fileref="images/ECLWA007b.jpg" />
|
|
|
- </imageobject>
|
|
|
- </mediaobject>
|
|
|
- </figure></para>
|
|
|
-
|
|
|
- <para>There may be a number displayed on the menu link. A number displayed
|
|
|
- next to it indicates how many errors and warnings have been generated
|
|
|
- during your session. Click on the advanced menu to display a list of
|
|
|
- features.</para>
|
|
|
-
|
|
|
- <sect1 id="ECLWatch_AdvancedMenuAccess">
|
|
|
- <title>Access the Advanced menu</title>
|
|
|
-
|
|
|
- <para>You access the advanced menu items from the advanced menu link at
|
|
|
- the top right corner of ECL Watch.<!--Removed some content stashed in GitStash : ECLWA-1115.xml others culled stored in git-br H8872-NewestECLfor50 **--></para>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">Set Banner</emphasis> link allows you to
|
|
|
- set a custom banner message at the top of your browser window when you
|
|
|
- open ECL Watch. You can use this feature to send messages to
|
|
|
- users.</para>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">Error/Warning(s)</emphasis> link
|
|
|
- displays a tab showing you Errors, Warnings, and Information messages.
|
|
|
- You can filter this page by checking the boxes at the bottom of the tab.
|
|
|
- A copy facility is also provided.</para>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">Open Legacy ECL Watch</emphasis> link
|
|
|
- opens a tab to the previous version of ECL Watch. The legacy version of
|
|
|
- ECL Watch is deprecated; this link is only available for a limited time
|
|
|
- to help in the transition.</para>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">Additional Resources</emphasis> link
|
|
|
- opens a tab to the HPCC Systems<superscript>®</superscript> download
|
|
|
- page, where you can browse and download additional HPCC resources:
|
|
|
- documentation, white papers, training videos, wiki pages, the red book
|
|
|
- and other HPCC related source code.</para>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">Release Notes</emphasis> link opens a
|
|
|
- tab with the relevant release notes for the version of HPCC that you are
|
|
|
- using. Read the release notes for more information specific to the
|
|
|
- release you are working on.</para>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">Configuration</emphasis> link opens for
|
|
|
- viewing the xml version of the configuration file in use on your
|
|
|
- system.</para>
|
|
|
-
|
|
|
- <para>The <emphasis role="bold">About</emphasis> link opens a dialog to
|
|
|
- display some information about the version of the HPCC platform and
|
|
|
- graph controls installed on your server.</para>
|
|
|
- </sect1>
|
|
|
-
|
|
|
- <sect1 id="ECLWatch_AdvancedMenuUserDetails" role="nobrk">
|
|
|
- <title>User Details</title>
|
|
|
-
|
|
|
- <para>The LOGGED IN AS link shows information about the current user on
|
|
|
- a cluster configured for authentication.</para>
|
|
|
-
|
|
|
- <para><orderedlist>
|
|
|
- <listitem>
|
|
|
- <para>Click on the <emphasis role="bold"><emphasis
|
|
|
- role="bold">LOGGED IN AS:</emphasis></emphasis> link.</para>
|
|
|
-
|
|
|
- <para>The User Details window opens. The default window opens on
|
|
|
- the Summary tab.</para>
|
|
|
-
|
|
|
- <para><figure>
|
|
|
- <title>User Details window</title>
|
|
|
-
|
|
|
- <mediaobject>
|
|
|
- <imageobject>
|
|
|
- <imagedata fileref="images/ECLWA474.jpg" />
|
|
|
- </imageobject>
|
|
|
- </mediaobject>
|
|
|
- </figure></para>
|
|
|
- </listitem>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>From The User Details page Summary tab, you can Confirm the
|
|
|
- User Name that you are logged in as.</para>
|
|
|
-
|
|
|
- <para>You can change your password.</para>
|
|
|
-
|
|
|
- <para>Note that Administrator rights are needed to manage users
|
|
|
- and permissions.</para>
|
|
|
-
|
|
|
- <para>Ensure you are using an account with Administrator rights if
|
|
|
- you intend to manage users or permissions.</para>
|
|
|
- </listitem>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Verify the password expiration date, or if password is set
|
|
|
- to expire.</para>
|
|
|
- </listitem>
|
|
|
- </orderedlist></para>
|
|
|
-
|
|
|
- <sect2 id="ECLWatch_AdvancedMenuChangePassword" role="nobrk">
|
|
|
- <title>Change Password</title>
|
|
|
-
|
|
|
- <para>If authentication is enabled on your HPCC system, you can change
|
|
|
- your password, right from the User Details window. <!--***? is this still valid : don't see where this is in new ECLWatch ***--><orderedlist>
|
|
|
- <listitem>
|
|
|
- <para>Click on the <emphasis role="bold"><emphasis
|
|
|
- role="bold">LOGGED IN AS:</emphasis></emphasis> link.</para>
|
|
|
-
|
|
|
- <para>The User Details window opens. The default window opens on
|
|
|
- the Summary tab. There are fields on the Summary tab where you
|
|
|
- can change your password.</para>
|
|
|
- </listitem>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Enter your desired new password.</para>
|
|
|
-
|
|
|
- <para>Make sure it meets whatever criteria your system may have
|
|
|
- for passwords.</para>
|
|
|
- </listitem>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Confirm your new password.</para>
|
|
|
-
|
|
|
- <para>Make sure that it matches the password you entered in the
|
|
|
- previous field.</para>
|
|
|
- </listitem>
|
|
|
-
|
|
|
- <listitem>
|
|
|
- <para>Press the Save button. It is in the upper left portion of
|
|
|
- the window.</para>
|
|
|
- </listitem>
|
|
|
- </orderedlist></para>
|
|
|
- </sect2>
|
|
|
-
|
|
|
- <sect2 id="ECLWatch_AdvancedMenuPermissionGroups">
|
|
|
- <title>Permission groups</title>
|
|
|
-
|
|
|
- <para>The second tab on the User Details window labelled Member Of,
|
|
|
- displays a list of groups. The groups your account belongs to, are
|
|
|
- indicated with a checkmark.</para>
|
|
|
-
|
|
|
- <para>You must be an administrator to modify any of group
|
|
|
- settings.</para>
|
|
|
- </sect2>
|
|
|
-
|
|
|
- <sect2 id="ECLWatch_AdvancedMenuUserPermissions">
|
|
|
- <title>User Permissions tab</title>
|
|
|
-
|
|
|
- <para>The third tab on the User Details window labelled <emphasis
|
|
|
- role="bold">User Permissions</emphasis>, displays a list of permission
|
|
|
- settings. Note that Administrator rights are needed to manage users
|
|
|
- and permissions. Ensure you are using an account with Administrator
|
|
|
- rights if you intend to manage users or permissions.</para>
|
|
|
-
|
|
|
- <para>This is where you can access the user permissions area. A more
|
|
|
- detailed description of the user permissions settings is covered in
|
|
|
- the <link linkend="User_Permissions_Chapter">User Permissions</link>
|
|
|
- section.</para>
|
|
|
- </sect2>
|
|
|
- </sect1>
|
|
|
- </chapter>
|
|
|
-
|
|
|
<chapter id="Resources">
|
|
|
<title>Resources</title>
|
|
|
|