Folio Menu

Inside the Folio Menu, the user is able to:

• Launch the Folio 

• Use Mobile Query

• Look over all the Files in the Database

• Snapshots

• Trash

• Back-up

• Restore

• Debug

Open

Folio Tools

Mobile Query

Selecting on the mobile Query will launch a pop-up prompt called Run Folio

1. The user will input a query into the query textbox

2. To run a query, the user will select on the Next button to launch the Confirmation prompt

3. Clicking the Run button will run the query

Open

4. If the query is successful, the results will be displayed on the right side, below the named divider.

• In the results window there are the following options:

  1. New Query: allows a new query to be run

  2. Edit Query: will open a prompt with the input function, so it can be edited. Very useful for running the same function with different parameters.

Edit Query

1. Clicking on one of the query results will reveal further details.

2. The user can edit the dis, markers, and property tags.

Adding Tags

1. The user can add tags to by selecting on the Add Tags option

2. Once selected the user will be prompted with a pop-up called Add Tags form

• The user can name a tag and specify the type

Files

Selecting on the Files option will display a submenu that lists all the files in the project database.

The user has the following tools:

• Backup

• Restore

• Upload File

Backup

The Backup tool lets the user save files for future use.

1. Clicking the  Backup button will open the Folio Download Prompt

2. The user can filter the files to be downloaded

• Further down the FileType can be select along with the FileName

• The user can tick the options to Preserve IDs or Select All Files

3. Select the Backup button once the options have been selected, this will launch a form where a user can select the Include Refs option

4. By selecting the Backup button will complete the process

5. A success prompt will be displayed after the Backup is completed.

6. There is the user can click to finish the backup or Download to the device.

Restore

The Restore option allows the user to restore a file into the Folio database.

1. Clicking on the Restore option will display the Folio Upload prompt

2. The Choose File button will allow the user to import the file

3. After the file is selected the name will be displayed on the right side of the button

• Below, the user can tick the Upload As Text and Overwrite Existing Records

4. Clicking Upload button will complete the process

Upload

The Upload option allows the user to upload a file into the Folio database.

1. Clicking on the

Upload option will launch the Upload File prompt

1. By clicking the

Choose File button a user can choose the location from where the file is imported

1. Clicking Upload will complete the action

Folio Files

The application displays the file under the Folio Files divider, these are grouped in folders by category

• To access the file options, go to the respective folder or All Files and select on it.

Additionally, the user can select on any entry in the folder which will extend a drawer containing the following options:

• View Edit

• Backup

• Overwrite

• Delete

Batch Delete

The Batch Delete option can be used to delete multiple files from that folder.

1. Select on the Batch Delete option

2. Select any files suitable to be deleted

3. By selecting the Delete button will complete the process

View Edit

This will display the file properties under the divider

Selecting the Options button will extend another drawer containing these options :

• Tag

• Backup

• Delete

Tags

This will open an Add Tag form allowing the user to input the name, type and default value of the tag.

Backup

Clicking it will download the file to the user's device.

Delete

This opens the delete prompt. Clicking the delete option will complete the process.

Overwrite

This opens the Overwrite prompt, the user will is able to upload a file from the device to replace the one from the database.

1. Clicking the Overwrite button will complete the process. T

• The user will have to clear the cache afterward to see the change.

Backup

Clicking this option will download the file in a zip archive on the device

Delete

This opens the delete prompt. Clicking the Delete button will finish the process.

Snapshots

This menu lists and allows the user to create Snapshots. These function as recover points for the database.

Make Snapshot

1. Select on the App Launcher icon on the top left

2. Select the Folio tile under Advanced Aps

• This will open a drawer with the following options: Close, Launch, Menu

3. Select the Menu option to open more settings

4. Click on the Snapshots option

5. Click on Make Snapshot, this recovers points for the database.

6. When clicked will start the snapshot creation process.

7. When the animation is complete, the new snapshot will populate the Folio Snapshots list located on the right menu

8. Click on the Snapshot to open the extended drawer for the following options: restore, backup, or delete

Upload Snapshot

This will allow the user to upload an external Snapshot.

1. Selecting on Upload Snapshot will launch the Upload Snapshot prompt

2. Here the Choose File button will allow the user to import the file

3. After the file is selected the filename will be displayed on the right side of the button

• An optional Display Name can be also inputted in the Optional Snapshot Dis text bar.

4. Clicking Upload will complete the process and the snapshot will be listed in the menu.

Snapshot Extended Drawer

The Snapshots are marked with the snapshot creation date and time and the size in MB on the right side.

Clicking a Snapshot will extend a drawer with the following options:

Restore

Will allow restoring the project to the Snapshot state and will prompt the user to restart so the Snapshot will function correctly. The "Enable Password Protected Snapshots" can be found in the Host → Settings.

Non-password protected snapshot scenario:

• The user will be prompted with the below popup where the user can restore a non-password protected snapshot without a password.

• Enable Restart will try and restart the FIN service (only applicable on Windows and running as a Service). Else the user will have to restart the FIN service manually.

If the user tries to restore a snapshot that is password protected, they will be prompted with the below popup that will require a password.

• If any password is entered and user tries to restore it, they'll get a message that it is not password protected and cannot restore it.

Password protected snapshot scenario:

• The user will be prompted with the below popup where the user can restore a password protected snapshot with a password.

• Enable Restart will try and restart the FIN service (only applicable on Windows and running as a Service). Else the user will have to restart the FIN service manually.

If the user tries to restore a snapshot that is non-password protected, they will be prompted with the below popup that won't require a password. If the user tries to restore it, they'll get an error message that it is password protected and cannot restore it.

Backup

Will download the Snapshot to the desired location of the users choice.

Delete

Deletes the selected Snapshot.

Trash

The trash menu displays all the deleted files.  The Empty Trash option will delete the files permanently.

Backup

This option helps download the database.

1. Clicking the option will open the Folio Download prompt

• The user can choose the format under which the database will be downloaded (zip, trio, zinc, JSON,CSV)

• The user can choose to preserve IDs or select All

2. Clicking Backup will launch the Folio Download prompt

• The user can choose to include Refs

3. Clicking Backup will launch the Success prompt. T

• The user can click OK, to complete the action, or Download to save the file to the device

Restore

This allows the user to restore the folio database from an external source.

1. Clicking the option will launch the Folio Upload prompt

2. Choose File button will allow the user to import the file

3. After the file is selected the filename will be displayed on the right side of the button

4. Below, the user can choose to upload the file as text and overwrite the existing records by ticking the respective options

5. Once the Upload button has been selected, the Finished prompt is displayed

6. Clicking OK will complete the action.

Debug

This menu presents useful statistics for the user, that can be used in the debug process.

Summary

This presents details regarding the queries ran on the project

Tag Index

Presents the tag index of the current project

Clicking on one of the index entries will show further details regarding it.

Query Times

Displays the list of Queries and the last time when they were ran

Clicking one of the entries will display a form with further details regarding that query

Watches

Displays a list with all the watches running on the project. Clicking one of the entries will display a form with further details regarding that watch.