Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plan Import/Export docs #176

Merged
merged 6 commits into from
Jul 25, 2024
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
Binary file added docs/planning/assets/export-plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions docs/planning/plan-import-export.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import exportPlanScreenshot from './assets/export-plan.png';

# Plan Import/Export

Aerie has the ability to export plans into a JSON-based file format, and import plans from files using the same format.
This allows you to save plans you've created in Aerie for backup or archival purposes, transfer plans between different Aerie
deployments, or interface with other tools which may ingest or modify the plan file.

Aerie plan files are mainly a way to persist **activities, tags, anchors, and arguments** from a plan.
Note that the following data is not included in plan files:
- Mission models - when importing, you will need to choose an existing mission model to associate with your plan
- Views - saved separately from plans, you can use the Download View button to save your views
- Resource profiles and other simulation results
- Plan specifications for Constraints, Scheduling Goals and Conditions
- Simulation Template - you can optionally associate a template when importing

The format of these files is described by this Typescript type in the Aerie repository:

https://github.com/NASA-AMMOS/aerie-gateway/pull/97/files#diff-aadcd2e92cdf1b17122b6fc65396f3e5603e14064d730a020b231cd30134704e

Future releases of Aerie will include a JSON schema fully describing the format.

## Exporting a plan

To export an Aerie plan, first open it in Aerie, then open the "Plan Metadata" panel. Use the export button in the top
right of the panel to export a `plan.json` file.

<figure>
<img alt="Aerie UI - Export Plan from Plan Metadata panel" src={exportPlanScreenshot} />
</figure>

## Importing a plan

On the Plans page, you can select an Aerie plan file to upload when creating a new plan. This will pre-populate
the other fields from the plan file, but you will still need to select a mission model file to associate with your plan.

There is currently no validation to check that the associated mission model is the same as the one used to create the
plan originally. This allows you to test the same plans with different models, but you may experience errors during
simulation or scheduling if the activities in the plan file don't match those in the model.


1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ const sidebars = {
'planning/ui-views',
'planning/timeline-editing',
'planning/timeline-controls',
'planning/plan-import-export',
'planning/advanced-incons',
'planning/advanced-extensions',
{
Expand Down
Loading