updating build

USNavalResearchLaboratory · Apr 30, 2024 · 680e086 · 680e086
1 parent 5943d04
commit 680e086
Show file tree

Hide file tree

Showing 293 changed files with 40,018 additions and 0 deletions.
diff --git a/docs/_build/.DS_Store b/docs/_build/.DS_Store
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 877a467e62892ff1022262f37f485127
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/.doctrees/activating_agents.doctree b/docs/_build/html/.doctrees/activating_agents.doctree
diff --git a/docs/_build/html/.doctrees/adding_a_behavior_to_an_agent.doctree b/docs/_build/html/.doctrees/adding_a_behavior_to_an_agent.doctree
diff --git a/docs/_build/html/.doctrees/base_class_methods.doctree b/docs/_build/html/.doctrees/base_class_methods.doctree
diff --git a/docs/_build/html/.doctrees/building_an_agent_network.doctree b/docs/_build/html/.doctrees/building_an_agent_network.doctree
diff --git a/docs/_build/html/.doctrees/capturing_the_test_results.doctree b/docs/_build/html/.doctrees/capturing_the_test_results.doctree
diff --git a/docs/_build/html/.doctrees/changelog.doctree b/docs/_build/html/.doctrees/changelog.doctree
diff --git a/docs/_build/html/.doctrees/connecting_a_node_to_the_server.doctree b/docs/_build/html/.doctrees/connecting_a_node_to_the_server.doctree
diff --git a/docs/_build/html/.doctrees/contact_us.doctree b/docs/_build/html/.doctrees/contact_us.doctree
diff --git a/docs/_build/html/.doctrees/creating_a_test_case_using_robot_framework.doctree b/docs/_build/html/.doctrees/creating_a_test_case_using_robot_framework.doctree
diff --git a/docs/_build/html/.doctrees/creating_your_own_controller_application.doctree b/docs/_build/html/.doctrees/creating_your_own_controller_application.doctree
diff --git a/docs/_build/html/.doctrees/environment.pickle b/docs/_build/html/.doctrees/environment.pickle
diff --git a/docs/_build/html/.doctrees/example.doctree b/docs/_build/html/.doctrees/example.doctree
diff --git a/docs/_build/html/.doctrees/features.doctree b/docs/_build/html/.doctrees/features.doctree
diff --git a/docs/_build/html/.doctrees/help.doctree b/docs/_build/html/.doctrees/help.doctree
diff --git a/docs/_build/html/.doctrees/how_it_works.doctree b/docs/_build/html/.doctrees/how_it_works.doctree
diff --git a/docs/_build/html/.doctrees/index.doctree b/docs/_build/html/.doctrees/index.doctree
diff --git a/docs/_build/html/.doctrees/installation.doctree b/docs/_build/html/.doctrees/installation.doctree
diff --git a/docs/_build/html/.doctrees/introduction.doctree b/docs/_build/html/.doctrees/introduction.doctree
diff --git a/docs/_build/html/.doctrees/managing_behavior_files.doctree b/docs/_build/html/.doctrees/managing_behavior_files.doctree
diff --git a/docs/_build/html/.doctrees/responding_to_a_message_sent_to_an_agent.doctree b/docs/_build/html/.doctrees/responding_to_a_message_sent_to_an_agent.doctree
diff --git a/docs/_build/html/.doctrees/retrieving_information_about_your_agent_network.doctree b/docs/_build/html/.doctrees/retrieving_information_about_your_agent_network.doctree
diff --git a/docs/_build/html/.doctrees/robot_framework_background.doctree b/docs/_build/html/.doctrees/robot_framework_background.doctree
diff --git a/docs/_build/html/.doctrees/running_your_automation_test.doctree b/docs/_build/html/.doctrees/running_your_automation_test.doctree
diff --git a/docs/_build/html/.doctrees/sage3_app.doctree b/docs/_build/html/.doctrees/sage3_app.doctree
diff --git a/docs/_build/html/.doctrees/sage_app.doctree b/docs/_build/html/.doctrees/sage_app.doctree
diff --git a/docs/_build/html/.doctrees/sage_node.doctree b/docs/_build/html/.doctrees/sage_node.doctree
diff --git a/docs/_build/html/.doctrees/sage_robot_framework_keywords.doctree b/docs/_build/html/.doctrees/sage_robot_framework_keywords.doctree
diff --git a/docs/_build/html/.doctrees/sage_server.doctree b/docs/_build/html/.doctrees/sage_server.doctree
diff --git a/docs/_build/html/.doctrees/sending_messages_between_agents.doctree b/docs/_build/html/.doctrees/sending_messages_between_agents.doctree
diff --git a/docs/_build/html/.doctrees/starting_a_server_instance.doctree b/docs/_build/html/.doctrees/starting_a_server_instance.doctree
diff --git a/docs/_build/html/.doctrees/using_supplemental_files_in_your_automation.doctree b/docs/_build/html/.doctrees/using_supplemental_files_in_your_automation.doctree
diff --git a/docs/_build/html/.doctrees/writing_a_sage_behavior.doctree b/docs/_build/html/.doctrees/writing_a_sage_behavior.doctree
diff --git a/docs/_build/html/_images/SageCluster.png b/docs/_build/html/_images/SageCluster.png
diff --git a/docs/_build/html/_images/SageClusters.png b/docs/_build/html/_images/SageClusters.png
diff --git a/docs/_build/html/_images/Sage_Node.png b/docs/_build/html/_images/Sage_Node.png
diff --git a/docs/_build/html/_images/Sage_Server.png b/docs/_build/html/_images/Sage_Server.png
diff --git a/docs/_build/html/_images/active_server_1.png b/docs/_build/html/_images/active_server_1.png
diff --git a/docs/_build/html/_images/active_server_10.png b/docs/_build/html/_images/active_server_10.png
diff --git a/docs/_build/html/_images/active_server_11.png b/docs/_build/html/_images/active_server_11.png
diff --git a/docs/_build/html/_images/active_server_2.png b/docs/_build/html/_images/active_server_2.png
diff --git a/docs/_build/html/_images/active_server_3.png b/docs/_build/html/_images/active_server_3.png
diff --git a/docs/_build/html/_images/active_server_4.png b/docs/_build/html/_images/active_server_4.png
diff --git a/docs/_build/html/_images/active_server_5.png b/docs/_build/html/_images/active_server_5.png
diff --git a/docs/_build/html/_images/active_server_6.png b/docs/_build/html/_images/active_server_6.png
diff --git a/docs/_build/html/_images/active_server_7.png b/docs/_build/html/_images/active_server_7.png
diff --git a/docs/_build/html/_images/active_server_8.png b/docs/_build/html/_images/active_server_8.png
diff --git a/docs/_build/html/_images/active_server_9.png b/docs/_build/html/_images/active_server_9.png
diff --git a/docs/_build/html/_images/active_server_logger.png b/docs/_build/html/_images/active_server_logger.png
diff --git a/docs/_build/html/_images/add_behavior.png b/docs/_build/html/_images/add_behavior.png
diff --git a/docs/_build/html/_images/behavior_manager.png b/docs/_build/html/_images/behavior_manager.png
diff --git a/docs/_build/html/_images/behavior_topics.png b/docs/_build/html/_images/behavior_topics.png
diff --git a/docs/_build/html/_images/create_agent.png b/docs/_build/html/_images/create_agent.png
diff --git a/docs/_build/html/_images/create_node.png b/docs/_build/html/_images/create_node.png
diff --git a/docs/_build/html/_images/features_1.png b/docs/_build/html/_images/features_1.png
diff --git a/docs/_build/html/_images/features_2.png b/docs/_build/html/_images/features_2.png
diff --git a/docs/_build/html/_images/features_3.png b/docs/_build/html/_images/features_3.png
diff --git a/docs/_build/html/_images/features_4.png b/docs/_build/html/_images/features_4.png
diff --git a/docs/_build/html/_images/features_5.png b/docs/_build/html/_images/features_5.png
diff --git a/docs/_build/html/_images/image1.png b/docs/_build/html/_images/image1.png
diff --git a/docs/_build/html/_images/image10.png b/docs/_build/html/_images/image10.png
diff --git a/docs/_build/html/_images/image11.png b/docs/_build/html/_images/image11.png
diff --git a/docs/_build/html/_images/image12.png b/docs/_build/html/_images/image12.png
diff --git a/docs/_build/html/_images/image13.png b/docs/_build/html/_images/image13.png
diff --git a/docs/_build/html/_images/image14.png b/docs/_build/html/_images/image14.png
diff --git a/docs/_build/html/_images/image15.png b/docs/_build/html/_images/image15.png
diff --git a/docs/_build/html/_images/image16.png b/docs/_build/html/_images/image16.png
diff --git a/docs/_build/html/_images/image17.png b/docs/_build/html/_images/image17.png
diff --git a/docs/_build/html/_images/image18.png b/docs/_build/html/_images/image18.png
diff --git a/docs/_build/html/_images/image19.png b/docs/_build/html/_images/image19.png
diff --git a/docs/_build/html/_images/image2.png b/docs/_build/html/_images/image2.png
diff --git a/docs/_build/html/_images/image20.png b/docs/_build/html/_images/image20.png
diff --git a/docs/_build/html/_images/image21.png b/docs/_build/html/_images/image21.png
diff --git a/docs/_build/html/_images/image22.png b/docs/_build/html/_images/image22.png
diff --git a/docs/_build/html/_images/image23.png b/docs/_build/html/_images/image23.png
diff --git a/docs/_build/html/_images/image24.png b/docs/_build/html/_images/image24.png
diff --git a/docs/_build/html/_images/image25.png b/docs/_build/html/_images/image25.png
diff --git a/docs/_build/html/_images/image26.png b/docs/_build/html/_images/image26.png
diff --git a/docs/_build/html/_images/image27.png b/docs/_build/html/_images/image27.png
diff --git a/docs/_build/html/_images/image28.png b/docs/_build/html/_images/image28.png
diff --git a/docs/_build/html/_images/image29.png b/docs/_build/html/_images/image29.png
diff --git a/docs/_build/html/_images/image3.png b/docs/_build/html/_images/image3.png
diff --git a/docs/_build/html/_images/image30.png b/docs/_build/html/_images/image30.png
diff --git a/docs/_build/html/_images/image31.png b/docs/_build/html/_images/image31.png
diff --git a/docs/_build/html/_images/image32.png b/docs/_build/html/_images/image32.png
diff --git a/docs/_build/html/_images/image33.png b/docs/_build/html/_images/image33.png
diff --git a/docs/_build/html/_images/image34.png b/docs/_build/html/_images/image34.png
diff --git a/docs/_build/html/_images/image4.png b/docs/_build/html/_images/image4.png
diff --git a/docs/_build/html/_images/image5.png b/docs/_build/html/_images/image5.png
diff --git a/docs/_build/html/_images/image6.png b/docs/_build/html/_images/image6.png
diff --git a/docs/_build/html/_images/image7.png b/docs/_build/html/_images/image7.png
diff --git a/docs/_build/html/_images/image8.png b/docs/_build/html/_images/image8.png
diff --git a/docs/_build/html/_images/image9.png b/docs/_build/html/_images/image9.png
diff --git a/docs/_build/html/_images/introduction_1.png b/docs/_build/html/_images/introduction_1.png
diff --git a/docs/_build/html/_images/log_example.png b/docs/_build/html/_images/log_example.png
diff --git a/docs/_build/html/_images/main_window.png b/docs/_build/html/_images/main_window.png
diff --git a/docs/_build/html/_images/network_load_errors.png b/docs/_build/html/_images/network_load_errors.png
diff --git a/docs/_build/html/_images/robot_interface_1.png b/docs/_build/html/_images/robot_interface_1.png
diff --git a/docs/_build/html/_images/robot_interface_2.png b/docs/_build/html/_images/robot_interface_2.png
diff --git a/docs/_build/html/_images/sage_architecture.png b/docs/_build/html/_images/sage_architecture.png
diff --git a/docs/_build/html/_images/sage_network.png b/docs/_build/html/_images/sage_network.png
diff --git a/docs/_build/html/_images/send_message_to_node.png b/docs/_build/html/_images/send_message_to_node.png
diff --git a/docs/_build/html/_images/send_message_to_node_2.png b/docs/_build/html/_images/send_message_to_node_2.png
diff --git a/docs/_build/html/_images/server_settings.png b/docs/_build/html/_images/server_settings.png
diff --git a/docs/_build/html/_images/setup_begin.png b/docs/_build/html/_images/setup_begin.png
diff --git a/docs/_build/html/_images/setup_complete.png b/docs/_build/html/_images/setup_complete.png
diff --git a/docs/_build/html/_images/setup_filePath.png b/docs/_build/html/_images/setup_filePath.png
diff --git a/docs/_build/html/_images/setup_license.PNG b/docs/_build/html/_images/setup_license.PNG
diff --git a/docs/_build/html/_images/setup_ready.png b/docs/_build/html/_images/setup_ready.png
diff --git a/docs/_build/html/_images/visual_c_install.png b/docs/_build/html/_images/visual_c_install.png
diff --git a/docs/_build/html/_sources/activating_agents.rst.txt b/docs/_build/html/_sources/activating_agents.rst.txt
@@ -0,0 +1,32 @@
+Activating Agents
+=======================================================
+
+Remember that depending on how your Agents' Behaviors are programmed, Agents may execute code in response to being activated. 
+
+
+Agent entities can be activated in multiple ways.
+
+**Using the SAGE App** -  You can activate your existing Agents using the SAGE App. This method is a fast way to activate a large number of agents simultaneously on a single Node.
+
+	1) In the SAGE App, select the targeted Node name or single Agent name and click :mod:`Activate Agent`.
+
+**By a Controller Appliction** - You can activate agents using a Controller Application, such as Robot Framework. This method is a fast way to activate a large number of single Agents across multiple Nodes.
+
+	1) Use the :mod:`Activate Agent` keyword to activate a targeted Agent name residing on the targeted Node.
+
+		.. code-block:: bat
+		
+			Activate Agent   nodeName1    newAgentName1
+			Activate Agent   nodeName1    newAgentName2
+			Activate Agent   nodeName2    newAgentName1
+
+**Through the execution of a Behavior** - Agents have the ability to activate other agent entities. This is a dynamic way to build your agent network to be more robust. This unique SAGE capability is supported by activating agents within your SAGE Behavior code. This enables agents to activate other agents.
+
+	1) In your Behavior file, use the :mod:`setAgentActive` method to activate a targeted Agent name residing on the targeted Node. 
+	2) Set the value to *true* to activate or *false* to deactivate.
+
+		.. code-block:: bat
+			
+				setAgentActive(nodeName1, newAgentName2, true);
+				setAgentActive(nodeName1, newAgentName2, false);
+				
diff --git a/docs/_build/html/_sources/adding_a_behavior_to_an_agent.rst.txt b/docs/_build/html/_sources/adding_a_behavior_to_an_agent.rst.txt
@@ -0,0 +1,33 @@
+Adding a Behavior to an Agent
+============================================================
+
+The Server will distribute behavior files to the target Nodes by way of a file transfer. From there, a targeted Agent will be given access to the Behavior. 
+
+A Behavior contains some action expected to be fulfilled by an Agent residing on a Node instance. 
+
+Behaviors can be sent to connected Agents in a number of ways. 
+
+**Using the Behavior Manager in SAGE App** -  You can populate your existing Agents with Behaviors using the SAGE App. This is the manual way to configure your agent network with the proper Behaviors prior to executing your automation.
+
+	1) In the SAGE App, select the targeted Agent name and click :mod:`Add Behavior`.
+	2) Select the Behavior name from the list of available Behaviors and click :mod:`Ok`.
+	3) Enter the desired Behavior topic strings and click :mod:`Ok`.
+
+Assuming the Behavior file is in the proper sub-directory on the Server:
+
+**By a Controller Application** - You can add available behaviors to agents using a Controller Application, such as Robot Framework. This gives SAGE users the ability to control complex test scenarios, involving multiple nodes and agents, from a single controller entity.
+
+	1) In your robot file, use the :mod:`Add Behavior` keyword to populate a targeted Node and Agent name with the specified behavior.
+
+		.. code-block:: bat
+		
+			Add Behavior   nodeName1    newAgentName1   ExampleBehavior   ExampleBheavior.jar   Topic1   Topic2
+
+
+**Through the execution of a Behavior** - Agents have the ability configure other agent entities. This is a dynamic way to build your agent network to be more robust. This unique SAGE capability enables agents to send behaviors to other agents.
+
+	1) In your Behavior file, use the :mod:`addBehavior` method to populate a targeted Node and Agent with the specified behavior. 
+
+		.. code-block:: bat
+			
+				addBehavior("nodeName1", "newAgentName1", "ExampleBehavior", "ExampleBheavior.jar", "Topic1", "Topic2");