Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/docs/User-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,6 @@ The landing page for a user is the Job Status page:

![Landing Page](img/mpf_landing.png "Landing Page")

Logging in starts a user session. By default, after 30 minutes of inactivity the user will automatically be logged out of the system. Within one minute of logging out the user will be prompted to extend or end their session. Note that the timeout period can be configured by any admin user with the admin role.

A given user can only be logged into the OpenMPF from one machine using one browser at a time. If the same user attempts to log in from another machine, or another browser on the same machine, then the first user session will be terminated immediately and redirected back to the login page. This feature ensures that the user will be able to immediately log in again if the user accidentally closes the browser window or shuts down their machine without properly logging out first.

A user may have multiple browser tabs or windows open for the same session, for example, to view the Jobs Status page and Logs page at the same time. It is not recommended that two users login using the same browser at the same time in different tabs or windows. Technically, the second user to login will take precedence, but the first user session will not appear to be terminated. Instead the first user will appear to share recent jobs and other information with the second user. Also, when one of the users logs out in this scenario, they will both be logged out.

## Logging out

To log out a user can click the down arrow associated with the user icon at the top right hand corner of the page and then select "Logout":
Expand Down
10 changes: 2 additions & 8 deletions docs/docs/Workflow-Manager-Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ The table below lists the controllers:
| AdminPropertySettingsController | Allows access and modification of system properties |
| AdminStatisticsController | Generates job statistics |
| AtmosphereController | Uses Atmosphere to manage server-side push |
| BootoutController | Handles bootouts when a second session is opened by the same user |
| HomeController | Manages index page and version information |
| JobController | Manages job creation and interaction |
| LoginController | Manages login/logout and authentication |
Expand All @@ -63,7 +62,6 @@ The table below lists the controllers:
| PipelineController | Handles the creation and deletion of actions, tasks, and pipelines |
| ServerMediaController | Enables selection and deselection of files at a directory level |
| SystemMessageController | Manages system level messages, such as notifying users that a server restart is needed |
| TimeoutController | Manages session timeouts |

The following sections describe some of the controllers in more detail.

Expand Down Expand Up @@ -144,18 +142,14 @@ Once the job is completed, this route converts the aggregated track and detectio

## Detection Response Route

The **Detection Response Route** is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server.

## Task Response Aggregation Route <small><i>(Not Shown)</i></small>

The **Task Response Aggregation Route** is one of the exit points for the Detection Response Route. It waits until all of the sub-job responses have been retrieved for the current stage (task) of the pipeline, then it invokes the Job Router Route to see if any additional processing needs to be done.
The **Detection Response Route** is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server. Then, it invokes the Job Router Route to see if any additional processing needs to be done.

## Markup Response Route <small><i>(Not Shown)</i></small>

Markup files are copies of the initial media with any detections visually highlighted in the frame. The **Markup Response Route** optionally uploads the markup files generated by the Markup component to an object storage server and persists the locations of these markup files in the SQL database.

## Other Routes <small><i>(Not Shown)</i></small>

Additionally, there is a **Detection Cancellation Route** for cancelling detection requests sent to components, and a **Markup Cancellation Route** for cancelling requests sent to the Markup component.
Additionally, there is a **Detection Cancellation Route** for cancelling detection requests sent to components, and a **Markup Cancellation Route** for cancelling requests sent to the Markup component.

Also, there is a **DLQ Route** for handling messages that appear in the ActiveMQ Dead Letter Queue (DLQ), which usually indicates a component failure or inability to deliver a message. In these cases, the job is terminated with an error condition.
3 changes: 0 additions & 3 deletions docs/site/User-Guide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -270,9 +270,6 @@ <h2 id="logging-in">Logging In</h2>
<p><img alt="Login Page" src="../img/mpf_login.png" title="Login Page" /></p>
<p>The landing page for a user is the Job Status page:</p>
<p><img alt="Landing Page" src="../img/mpf_landing.png" title="Landing Page" /></p>
<p>Logging in starts a user session. By default, after 30 minutes of inactivity the user will automatically be logged out of the system. Within one minute of logging out the user will be prompted to extend or end their session. Note that the timeout period can be configured by any admin user with the admin role.</p>
<p>A given user can only be logged into the OpenMPF from one machine using one browser at a time. If the same user attempts to log in from another machine, or another browser on the same machine, then the first user session will be terminated immediately and redirected back to the login page. This feature ensures that the user will be able to immediately log in again if the user accidentally closes the browser window or shuts down their machine without properly logging out first.</p>
<p>A user may have multiple browser tabs or windows open for the same session, for example, to view the Jobs Status page and Logs page at the same time. It is not recommended that two users login using the same browser at the same time in different tabs or windows. Technically, the second user to login will take precedence, but the first user session will not appear to be terminated. Instead the first user will appear to share recent jobs and other information with the second user. Also, when one of the users logs out in this scenario, they will both be logged out.</p>
<h2 id="logging-out">Logging out</h2>
<p>To log out a user can click the down arrow associated with the user icon at the top right hand corner of the page and then select "Logout":</p>
<p><img alt="Logout Button" src="../img/mpf_show_logout.png" title="Logout Button" /></p>
Expand Down
16 changes: 2 additions & 14 deletions docs/site/Workflow-Manager-Architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,6 @@

<li><a class="toctree-l4" href="#detection-response-route">Detection Response Route</a></li>

<li><a class="toctree-l4" href="#task-response-aggregation-route-not-shown">Task Response Aggregation Route (Not Shown)</a></li>

<li><a class="toctree-l4" href="#markup-response-route-not-shown">Markup Response Route (Not Shown)</a></li>

<li><a class="toctree-l4" href="#other-routes-not-shown">Other Routes (Not Shown)</a></li>
Expand Down Expand Up @@ -327,10 +325,6 @@ <h2 id="basic-controllers">Basic Controllers</h2>
<td>Uses Atmosphere to manage server-side push</td>
</tr>
<tr>
<td>BootoutController</td>
<td>Handles bootouts when a second session is opened by the same user</td>
</tr>
<tr>
<td>HomeController</td>
<td>Manages index page and version information</td>
</tr>
Expand Down Expand Up @@ -366,10 +360,6 @@ <h2 id="basic-controllers">Basic Controllers</h2>
<td>SystemMessageController</td>
<td>Manages system level messages, such as notifying users that a server restart is needed</td>
</tr>
<tr>
<td>TimeoutController</td>
<td>Manages session timeouts</td>
</tr>
</tbody>
</table>
<p>The following sections describe some of the controllers in more detail.</p>
Expand Down Expand Up @@ -419,13 +409,11 @@ <h2 id="job-router-route">Job Router Route</h2>
<p>This route may be invoked multiple times as future routes redirect back to the Job Router so that the job can be processed by the next component in the pipeline.</p>
<p>Once the job is completed, this route converts the aggregated track and detection data in Redis into a JSON output format. It then clears out all data in Redis for the job, updates the final job status in the SQL database, optionally uploads the JSON output object to an object storage server, and optionally makes a callback to the endpoint listed in the job request.</p>
<h2 id="detection-response-route">Detection Response Route</h2>
<p>The <strong>Detection Response Route</strong> is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server.</p>
<h2 id="task-response-aggregation-route-not-shown">Task Response Aggregation Route <small><i>(Not Shown)</i></small></h2>
<p>The <strong>Task Response Aggregation Route</strong> is one of the exit points for the Detection Response Route. It waits until all of the sub-job responses have been retrieved for the current stage (task) of the pipeline, then it invokes the Job Router Route to see if any additional processing needs to be done.</p>
<p>The <strong>Detection Response Route</strong> is the re-entry point to the WFM. It unmarshals the protobuf responses from components and converts them into the Track and Detection objects used within the WFM. It then optionally performs each of the following actions: track merging, detection padding, detecting moving objects, and artifact extraction. It stores the track and detection data in the Redis database and optionally uploads artifacts to an object storage server. Then, it invokes the Job Router Route to see if any additional processing needs to be done.</p>
<h2 id="markup-response-route-not-shown">Markup Response Route <small><i>(Not Shown)</i></small></h2>
<p>Markup files are copies of the initial media with any detections visually highlighted in the frame. The <strong>Markup Response Route</strong> optionally uploads the markup files generated by the Markup component to an object storage server and persists the locations of these markup files in the SQL database.</p>
<h2 id="other-routes-not-shown">Other Routes <small><i>(Not Shown)</i></small></h2>
<p>Additionally, there is a <strong>Detection Cancellation Route</strong> for cancelling detection requests sent to components, and a <strong>Markup Cancellation Route</strong> for cancelling requests sent to the Markup component. </p>
<p>Additionally, there is a <strong>Detection Cancellation Route</strong> for cancelling detection requests sent to components, and a <strong>Markup Cancellation Route</strong> for cancelling requests sent to the Markup component.</p>
<p>Also, there is a <strong>DLQ Route</strong> for handling messages that appear in the ActiveMQ Dead Letter Queue (DLQ), which usually indicates a component failure or inability to deliver a message. In these cases, the job is terminated with an error condition.</p>

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -380,5 +380,5 @@ <h1 id="overview">Overview</h1>

<!--
MkDocs version : 0.17.5
Build Date UTC : 2023-05-10 01:08:58
Build Date UTC : 2023-06-07 18:27:13
-->
17 changes: 6 additions & 11 deletions docs/site/search/search_index.json

Large diffs are not rendered by default.

50 changes: 25 additions & 25 deletions docs/site/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,127 +2,127 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Release-Notes/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/License-And-Distribution/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Acknowledgements/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Install-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Admin-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/User-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Media-Segmentation-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Feed-Forward-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Derivative-Media-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Object-Storage-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Markup-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/TiesDb-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/REST-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Component-API-Overview/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Component-Descriptor-Reference/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/CPP-Batch-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Python-Batch-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Java-Batch-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/GPU-Support-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Contributor-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Development-Environment-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Node-Guide/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/Workflow-Manager-Architecture/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>/CPP-Streaming-Component-API/index.html</loc>
<lastmod>2023-05-10</lastmod>
<lastmod>2023-06-07</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>