diff --git a/user-guide/images/add-adm.png b/user-guide/images/add-adm.png index 5680348..d8a7008 100644 Binary files a/user-guide/images/add-adm.png and b/user-guide/images/add-adm.png differ diff --git a/user-guide/images/adms-download.png b/user-guide/images/adms-download.png index 95473c8..d67fb25 100644 Binary files a/user-guide/images/adms-download.png and b/user-guide/images/adms-download.png differ diff --git a/user-guide/images/adms-tab.png b/user-guide/images/adms-tab.png index 1e2e743..848768f 100644 Binary files a/user-guide/images/adms-tab.png and b/user-guide/images/adms-tab.png differ diff --git a/user-guide/images/adms-table.png b/user-guide/images/adms-table.png index 28e838e..28f8619 100644 Binary files a/user-guide/images/adms-table.png and b/user-guide/images/adms-table.png differ diff --git a/user-guide/images/agent-add.png b/user-guide/images/agent-add.png index 864ef94..cfd8955 100644 Binary files a/user-guide/images/agent-add.png and b/user-guide/images/agent-add.png differ diff --git a/user-guide/images/agent-details.png b/user-guide/images/agent-details.png index a5df898..8b26e45 100644 Binary files a/user-guide/images/agent-details.png and b/user-guide/images/agent-details.png differ diff --git a/user-guide/images/agent-manage-ari-done.png b/user-guide/images/agent-manage-ari-done.png index 9f4cff0..662fd49 100644 Binary files a/user-guide/images/agent-manage-ari-done.png and b/user-guide/images/agent-manage-ari-done.png differ diff --git a/user-guide/images/agent-manage-menu.png b/user-guide/images/agent-manage-menu.png index 229c8c4..b4dca1f 100644 Binary files a/user-guide/images/agent-manage-menu.png and b/user-guide/images/agent-manage-menu.png differ diff --git a/user-guide/images/agent-manage.png b/user-guide/images/agent-manage.png index 61d81ae..9b9d8f2 100644 Binary files a/user-guide/images/agent-manage.png and b/user-guide/images/agent-manage.png differ diff --git a/user-guide/images/agent-operation.png b/user-guide/images/agent-operation.png index 095c7ad..d1d9a11 100644 Binary files a/user-guide/images/agent-operation.png and b/user-guide/images/agent-operation.png differ diff --git a/user-guide/images/agent-report-print-example.png b/user-guide/images/agent-report-print-example.png index 13626e6..cbb72fe 100644 Binary files a/user-guide/images/agent-report-print-example.png and b/user-guide/images/agent-report-print-example.png differ diff --git a/user-guide/images/agent-reports-sent.png b/user-guide/images/agent-reports-sent.png index 285f196..bf16e95 100644 Binary files a/user-guide/images/agent-reports-sent.png and b/user-guide/images/agent-reports-sent.png differ diff --git a/user-guide/images/agent-search.png b/user-guide/images/agent-search.png index 758103c..18ee3ea 100644 Binary files a/user-guide/images/agent-search.png and b/user-guide/images/agent-search.png differ diff --git a/user-guide/images/ari-build-search.png b/user-guide/images/ari-build-search.png index d7584f7..f9a58f3 100644 Binary files a/user-guide/images/ari-build-search.png and b/user-guide/images/ari-build-search.png differ diff --git a/user-guide/images/ari-builder-toggle.png b/user-guide/images/ari-builder-toggle.png index 6d39d1d..9046222 100644 Binary files a/user-guide/images/ari-builder-toggle.png and b/user-guide/images/ari-builder-toggle.png differ diff --git a/user-guide/images/ari-param-dropdown.png b/user-guide/images/ari-param-dropdown.png index 5bdd95b..cc8c8d5 100644 Binary files a/user-guide/images/ari-param-dropdown.png and b/user-guide/images/ari-param-dropdown.png differ diff --git a/user-guide/images/ari-param-in-ac-filled.png b/user-guide/images/ari-param-in-ac-filled.png index de6d6dc..02895b4 100644 Binary files a/user-guide/images/ari-param-in-ac-filled.png and b/user-guide/images/ari-param-in-ac-filled.png differ diff --git a/user-guide/images/ari-search-dropdown.png b/user-guide/images/ari-search-dropdown.png index 9ebd72d..24fc221 100644 Binary files a/user-guide/images/ari-search-dropdown.png and b/user-guide/images/ari-search-dropdown.png differ diff --git a/user-guide/images/ari-search.png b/user-guide/images/ari-search.png index 5b285ff..ad2eb84 100644 Binary files a/user-guide/images/ari-search.png and b/user-guide/images/ari-search.png differ diff --git a/user-guide/images/ari-string-transcode.png b/user-guide/images/ari-string-transcode.png index 3d0784c..e85aa32 100644 Binary files a/user-guide/images/ari-string-transcode.png and b/user-guide/images/ari-string-transcode.png differ diff --git a/user-guide/images/build-tab.png b/user-guide/images/build-tab.png index d25a87a..9a7c374 100644 Binary files a/user-guide/images/build-tab.png and b/user-guide/images/build-tab.png differ diff --git a/user-guide/images/cmd-success.png b/user-guide/images/cmd-success.png index 43eb5a0..dde3af9 100644 Binary files a/user-guide/images/cmd-success.png and b/user-guide/images/cmd-success.png differ diff --git a/user-guide/images/completed-ari-build.png b/user-guide/images/completed-ari-build.png index 6fa6365..4cc60f1 100644 Binary files a/user-guide/images/completed-ari-build.png and b/user-guide/images/completed-ari-build.png differ diff --git a/user-guide/images/gen-rpt-search.png b/user-guide/images/gen-rpt-search.png index 332a09a..aca3aa3 100644 Binary files a/user-guide/images/gen-rpt-search.png and b/user-guide/images/gen-rpt-search.png differ diff --git a/user-guide/images/managed-agent.png b/user-guide/images/managed-agent.png index 2ba60be..e2b9ca2 100644 Binary files a/user-guide/images/managed-agent.png and b/user-guide/images/managed-agent.png differ diff --git a/user-guide/images/pending-ari-build.png b/user-guide/images/pending-ari-build.png index 4071b64..c769cf5 100644 Binary files a/user-guide/images/pending-ari-build.png and b/user-guide/images/pending-ari-build.png differ diff --git a/user-guide/images/raw-cmd.png b/user-guide/images/raw-cmd.png index 2ddffaa..a0dffea 100644 Binary files a/user-guide/images/raw-cmd.png and b/user-guide/images/raw-cmd.png differ diff --git a/user-guide/images/rptt-search.png b/user-guide/images/rptt-search.png index 2f32e74..0be356e 100644 Binary files a/user-guide/images/rptt-search.png and b/user-guide/images/rptt-search.png differ diff --git a/user-guide/images/rptt-selected.png b/user-guide/images/rptt-selected.png index 93c8949..78e274b 100644 Binary files a/user-guide/images/rptt-selected.png and b/user-guide/images/rptt-selected.png differ diff --git a/user-guide/images/simple-ari-param.png b/user-guide/images/simple-ari-param.png index 2cb8ce2..2f10e6f 100644 Binary files a/user-guide/images/simple-ari-param.png and b/user-guide/images/simple-ari-param.png differ diff --git a/user-guide/images/status-tab.png b/user-guide/images/status-tab.png index c81095a..8aad988 100644 Binary files a/user-guide/images/status-tab.png and b/user-guide/images/status-tab.png differ diff --git a/user-guide/images/status.png b/user-guide/images/status.png index c4c0d8f..f96ff6a 100644 Binary files a/user-guide/images/status.png and b/user-guide/images/status.png differ diff --git a/user-guide/images/string-input.png b/user-guide/images/string-input.png index 8bd7424..fb6318b 100644 Binary files a/user-guide/images/string-input.png and b/user-guide/images/string-input.png differ diff --git a/user-guide/images/top-ribbon.png b/user-guide/images/top-ribbon.png index 16550d6..80ebdaf 100644 Binary files a/user-guide/images/top-ribbon.png and b/user-guide/images/top-ribbon.png differ diff --git a/user-guide/images/transcoded-aris.png b/user-guide/images/transcoded-aris.png index b47e091..f02aaf8 100644 Binary files a/user-guide/images/transcoded-aris.png and b/user-guide/images/transcoded-aris.png differ diff --git a/user-guide/images/transcoded-rpt-ari.png b/user-guide/images/transcoded-rpt-ari.png index abc00e2..9d24992 100644 Binary files a/user-guide/images/transcoded-rpt-ari.png and b/user-guide/images/transcoded-rpt-ari.png differ diff --git a/user-guide/manual.adoc b/user-guide/manual.adoc index 124156e..e0a760a 100644 --- a/user-guide/manual.adoc +++ b/user-guide/manual.adoc @@ -145,7 +145,7 @@ Selecting an item from a drop-down list of available options. == User Interface -The following section provides an overview of the ANMS User Interface, organized by the capabilities provided by each of the tabs - Monitor, Agents, Build, Status, ADMs - shown at the top of the ANMS display. +The following section provides an overview of the ANMS User Interface, organized by the capabilities provided by each of the tabs - Monitor, Agents, Build, Status, ADMs - shown at left side pop-out menu of the ANMS display. === User Accounts and Login/Logout @@ -153,34 +153,14 @@ The following section provides an overview of the ANMS User Interface, organized The first thing that must happen before a user can access the ANMS is to log-in with an authorized user account. The Common Access Manager (CAM) controls authentication, authorization, and auditing (AAA) functions for the ANMS (and other AMMOS tools) so any account creation or maintenance must be done in either CAM or its Active Directory user database. -After a user has successfully logged-in the current account name is displayed in the top ribbon of each ANMS page as in <>. The leftmost side of the ribbon contains the ANMS name and version identifier. -The rightmost side contains the account name and link, along with a "Logout" link. +The rightmost side contains the profile info link, along with a "Logout" link. [#fig-top-ribbon] .Top Ribbon Example image::images/top-ribbon.png[] -Selecting the user account link will show the user's profile page, as described in <>. Selecting the Logout link will immediately cause the login session to be ended and the browser will redirect back to the login page. - -[#sec-user-profile] -==== User Profile Page - -This page includes parameters associated only with a user account, rather than any particular managed Agent or ADM. These parameters include: -* Username -* Email -* First Name -* Last Name -* Membership Length - -[#fig-user-profile] -.User Profile Example -image::images/user-profile.png[] - -The Email, First Name, and Last Name fields can be edited on this page. Clicking the green `Update` button will update the user profile with these changes. - - [#sec-monitoring] === Monitoring @@ -386,17 +366,17 @@ image::images/agent-manage-toast.png[] .Select the Build Tab of the ANMS image::images/build-tab.png[] -The *Build* tab is for used for generating ARIs, translating string ARIs to CBOR, and sending those ARIs to the ANMS database and/or Agent(s). All ARIs in the ANMS database can be used to generate new string ARIs using the `ARI Builder` that can be translated using the `ARI String Input` option. To switch between building and translating ARIs, use the toggle at the center of the screen beneath the menu bar. +The *Build* tab is for used for generating ARIs, translating string ARIs to CBOR, and sending those ARIs to the ANMS database and/or Agent(s). All ARIs in the ANMS database can be used to generate new string ARIs using the `ARI Builder` that can be translated using the `ARI String Input` option. To switch between building ARIs via dropdown menus, defining ARIs with plaintext, and translating ARIs from hex (CBOR), use the toggle at the center of the screen beneath "ARI Builder". When first navigating to this tab, the ANMS compiles all known ARIs, including their parameter information, from the database. ==== ARI String Input [#fig-string-input] -.ARI String Input Toggle +.ARI Text Input Toggle image::images/string-input.png[] -The ANMS transcodes string ARIs to CBOR, which can then be sent to Agents. To perform this translation, toggle the switch at the top of the screen to select the ARI *String Input* option. +In the Text Input mode, the ANMS transcodes string ARIs to CBOR, which can then be sent to Agents. To perform this translation, toggle the switch at the top of the screen to select the ARI *Text Input* option. [#fig-ari-string-transcode] .ARI String Transcoder @@ -463,7 +443,7 @@ image::images/ari-param-in-ac.png[] For parameters that also require parameters, the system will generate additional input fields. [#fig-ari-param-in-ac-filled] -.ARI Parameter Added to an AC with its own parameter +.ARI Parameter Added to an AC concatenated in ARI text image::images/ari-param-in-ac-filled.png[] After all ARI parameters have been filled in, the system will generate the new string URI that is shown beneath the parameter fields. This string URI is sent via anms-core to the transcoder to be translated. The final result of the translation is displayed in the table at the bottom of the page, as depicted in <>. @@ -478,11 +458,6 @@ NOTE: An ARI that is currently being translated by the ANMS will be marked as "p .Translated ARI with Input String and CBOR Output image::images/completed-ari-build.png[] -To start building a new ARI simply select the 'X' clear selected button on the right hand side of the search bar. This will reset the builder screen, making it ready for the user to select a new ARI to build. - -[#fig-reset-ari-build] -.reset ari builder area -image::images/reset-ari-build.png[] The transcoded ARI table provides the following information: @@ -568,7 +543,7 @@ image::images/adms-table.png[] ==== Downloading ADMs -Selecting an ADM's name will download the associated yang file. +Clicking an ADM's download button will download the associated yang file. [#fig-adm-download] .Downloading ADM @@ -733,32 +708,13 @@ After successfully sending the control to the Agent a success popup should be di -TODO -[#fig-transcoded-rpt-ari2] -.Generate Report ARI and CBOR Representations -image::images/transcoded-rpt-ari.png[] - -Now that the control has been built, the CBOR can be sent to the desired Agent(s). Click the CBOR entry for the translated ARI and -the UI will redirect to the `Agents` tab. - -At the bottom of the page, fill in the address of the Agent (or a comma separated list if providing multiple Agents) to send the -control to. In <>, the Agent address is ipn:2.6. - -[#fig-managed-agent2] -.Manage Agent ipn:2.6 -image::images/managed-agent.png[] - -Select the `Manage` button to open the modal for Agent handling. The input box for a `Text Input` will be auto-filled -with the CBOR selected from the *Build* tab. Select the `Submit` button to send the CBOR command to the Agent. - -TODO [#fig-raw-cmd2] .Auto-filled CBOR in RAW Command Field image::images/raw-cmd.png[] After successfully sending the control to the Agent a success popup should be displayed in the upper right portion of the screen. -TODO + [#fig-cmd-success2] .Command Sent Successfully image::images/cmd-success.png[]