Appboard/2.5/builder/system administration/import export: Difference between revisions

imported>Jason.nicholls
 
imported>Jason.nicholls
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
[[Category:AppBoard 2.5]]
[[Category:AppBoard 2.5]]


The Import/Export utility on the [[appboard/2.5/builder/system_administration|System Administration]] page allows users to import and export [[appboard/2.5/builder/stacks_and_boards|stacks]], diagrams (see [[appboard/2.5/builder/widgets/diagrammer|Diagrammer Widget]]), [[appboard/2.5/builder/themes|themes]], and [[appboard/2.5/builder/system_administration/session_variables|session variables]].  When exporting a stack, all boards and widgets within the stack get exported, as do all associated data collections and actions.
The Import/Export utility on the [[appboard/2.5/builder/system_administration|System Administration]] page allows users to import and export [[appboard/2.5/builder/stacks_and_boards|stacks]], diagrams (see [[appboard/2.5/builder/widgets/diagrammer|Diagrammer Widget]]), [[appboard/2.5/builder/system_administration/themes|themes]], and [[appboard/2.5/builder/system_administration/session_variables|session variables]].  When exporting a stack, all boards and widgets within the stack get exported, as do all associated data collections and actions.


The following documentation outlines how to export and import content in AppBoard.
The following documentation outlines how to export and import content in AppBoard.
Line 16: Line 16:
#In the '''Export Content''' dialog that appears, there will be a list of checkboxes for all configured stacks, themes, diagrams, and session variables.  Note that if any of these custom items were not configured, they would not be included in the list (e.g. if there are stacks, custom themes, and diagrams, but no session variables were created, ''Session Variables'' will not be included in the list).
#In the '''Export Content''' dialog that appears, there will be a list of checkboxes for all configured stacks, themes, diagrams, and session variables.  Note that if any of these custom items were not configured, they would not be included in the list (e.g. if there are stacks, custom themes, and diagrams, but no session variables were created, ''Session Variables'' will not be included in the list).
#Select which content to export.  Selections can either be at the folder level (which selects all content in the folder) or at the item level.
#Select which content to export.  Selections can either be at the folder level (which selects all content in the folder) or at the item level.
#*For any stack that is selected, all associated data collections and actions will be exported as well.
#*For any stack that is selected all associated boards, widgets, actions, data collections, data sources, and associated data sources will be included.
#*If a stack that is selected for export has widgets with actions that involve other stacks, but those other stacks are not selected for export, upon importing, those actions will still be configured but will not behave as before since the other stacks were not included in the import/export process.
#*If a stack that is selected for export has widgets with actions that involve other stacks, but those other stacks are not selected for export, upon importing, those actions will still be configured but will not behave as before since the other stacks were not included in the import/export process.
#*If a stack has a widget that uses a diagram, to include that diagram in the export process it must be explicitly selected in the '''Export Content''' dialog.  
#*If a stack has a widget that uses a diagram, to include that diagram in the export process it must be explicitly selected in the '''Export Content''' dialog.  
#When ready, click '''OK'''.
#When ready, click '''OK'''.
#After the message "Export Successfully Generated" appears, click '''Save As''' and select a location in which to save the .axp (Appoard eXPort) file.
#After the message "Export Successfully Generated" appears, click '''Save As''' and select a location in which to save the <tt>.axp</tt> (Appoard eXPort) file.


== Importing Content ==
== Importing Content ==
Line 38: Line 38:
#When ready, click '''Import'''.
#When ready, click '''Import'''.
#After the "Import Successful" message appears, click '''Finish'''.  The web browser will automatically refresh the page.
#After the "Import Successful" message appears, click '''Finish'''.  The web browser will automatically refresh the page.
{{Note|If importing Data Sources or Data Collections these will '''overwrite''' existing ones on the importing system if they exist.}}


== Viewing Import Logs ==
== Viewing Import Logs ==

Latest revision as of 07:39, 27 January 2015


The Import/Export utility on the System Administration page allows users to import and export stacks, diagrams (see Diagrammer Widget), themes, and session variables. When exporting a stack, all boards and widgets within the stack get exported, as do all associated data collections and actions.

The following documentation outlines how to export and import content in AppBoard.


Exporting Content

To export content, do the following:

  1. Click System Administration under Builder Modes.
  2. Click the Import/Export icon.
  3. At the top-right of the screen, click the Export button.
  4. In the Export Content dialog that appears, there will be a list of checkboxes for all configured stacks, themes, diagrams, and session variables. Note that if any of these custom items were not configured, they would not be included in the list (e.g. if there are stacks, custom themes, and diagrams, but no session variables were created, Session Variables will not be included in the list).
  5. Select which content to export. Selections can either be at the folder level (which selects all content in the folder) or at the item level.
    • For any stack that is selected all associated boards, widgets, actions, data collections, data sources, and associated data sources will be included.
    • If a stack that is selected for export has widgets with actions that involve other stacks, but those other stacks are not selected for export, upon importing, those actions will still be configured but will not behave as before since the other stacks were not included in the import/export process.
    • If a stack has a widget that uses a diagram, to include that diagram in the export process it must be explicitly selected in the Export Content dialog.
  6. When ready, click OK.
  7. After the message "Export Successfully Generated" appears, click Save As and select a location in which to save the .axp (Appoard eXPort) file.

Importing Content

To import content, do the following:

  1. Click System Administration under Builder Modes.
  2. Click the Import/Export icon.
  3. At the top-right of the screen, click the Import button.
  4. In the file chooser window that appears, select the desired .axp (Appboard eXPort) file.
  5. After choosing the .axp file for import, the Import Content dialog will appear.
  6. In the Import Content dialog, there is a dropdown list with different options for how this import will handle Data Collections and Data Sources:
    • Include both modified Data Collections and Data Sources
    • Include only modified Data Collections (ignore modified Data Sources)
    • Don't include modified Data Collections or Data Sources
  7. Additionally, there will be a list of stacks, themes, diagrams, and/or session variables that were detected in the .axp file. Expanding the folders will show the content available for import as well as its status (i.e. new, existing, or changed). Use the checkboxes to select which content to import.
  8. When ready, click Import.
  9. After the "Import Successful" message appears, click Finish. The web browser will automatically refresh the page.
Template-note.png
If importing Data Sources or Data Collections these will overwrite existing ones on the importing system if they exist.

Viewing Import Logs

To see what content was imported in previous import procedures, there is an Import Log. To view this, do the following:

  1. Click System Administration under Builder Modes.
  2. Click the Import/Export icon.
  3. In the Import Log panel, select an import to view its details.
  4. In the Log Details panel, expand the folders to see the content that was imported.