The Sedona Tools are used to provision a single Sedona Framework device.
Common Sedona provisioning tasks include the following:
Make kit selection changes
This procedure describes how to make kit selection changes (add/remove kits or change kit version levels) to kits deployed on a Sedona Device.
Access the Sedona Tools under a Sedona Device:
For a Fox connection to a station with a networked device
When provisioning a networked device through the JACE station, expand the Sedona Network, right-click the device and select
menu where you can access the provisioning tools.For a Sox session connection (either direct or Sox-tunneled)
When provisioning a device through a Sox session connection (either direct or Sox-tunneled), double-click the Sedona Tools container to access the provisioning tools.
Select the
to launch the Kit Manager wizard. After analyzing the kits currently installed on the device, the Kit Manager view is displayed.In the Kits table, make selections as needed to add or remove kits, and to change kit versions.
Add a kit by clicking on the kit’s unchecked check box.
Remove an installed kit by clicking on the kit’s checked check box to clear it.
Change a kit version by clicking on the kit’s Action value, as shown in Figure 15.
The
drop-down list options can be one or more of the following:[current version]
[newer version]
[older version]
The newer/older kit version levels shown in the drop-down menu reflect what is available in the Sedona environment. They are stored in the
SEDONAHOME
/kits
directory
Check the Verifier table for kit dependency errors resulting from the your selections.
If a selected kit requires the presence of an uninstalled kit in order to run on the device, the missing dependency will be
listed in the Verifier table. Also, if a kit dependency error occurs as a result of your selections, the Kit Manager will
NOT automatically select a missing kit. If the missing kit is not present in Workbench, you can obtain it from the vendor.
If desired, click the check box to Rebuild kits.scode.
The option to “Rebuild kits.scode” is selected automatically whenever you change kit selections and/or change kit versions
since the schema will need to be updated.
If desired, click the check box to Copy manifests to device.
Functioning as a manifest server is an optional feature that must be supported by the device in order for the option to display
in the view. If you do not see the option, then it is not supported by the device.
Click the
button. The tasks to be performed are listed in the upper portion of the view.Click the
button to execute the tasks. As each task is completed, the status (Success or Failed) is displayed to the right of the task. Also, a log can be viewed in the pane. On successful completion you are prompted to restart the device.Restarting the device will disconnect your connection. To re-open your Sox connection, double-click the dimmed Sedona node
in the Nav tree, and enter the log-in credentials.
For more information, refer to About The Kit Manager.
Get the app from a device
This procedure describes how to use the Get operation to copy the app from a Sedona Device which saves the .sax file to the app database in the Sedona environment you are using.
Access the Sedona Tools under a Sedona Device:
For a Fox connection to a station with a networked device
When provisioning a networked device through the JACE station, expand the Sedona Network, right-click the device and select
menu where you can access the provisioning tools.For a Sox session connection (either direct or Sox-tunneled)
When provisioning a device through a Sox session connection (either direct or Sox-tunneled), double-click the Sedona Tools container to access the provisioning tools.
Select the
to launch the Get/Put Application wizard.Click the Get option. This populates the configuration area of the dialog box with a save location and default app filename, and the selected option to include kit checksums in the file, as shown in Figure 16.
The Save in location for the app is the /apps
folder in the dedicated file space for the connected device in the Sedona environment you are using.
The “
Save in
” location is determined automatically by the software and it differs slightly depending on whether you are provisioning through
the Workbench via a Sox session connection or via a Fox connection to a networked device on the JACE station. For details,
refer to About The Application Manager .The Save in
location can be modified only when making a Sox session connection (either direct Sox or Sox-tunneled). In this case, you
can click the Directory icon to launch a Directory Chooser and browse to select an alternate save location. If you are provisioning
through a Fox connection to a networked device on the JACE station, the Save in location cannot be modified.
With either connection method described above, you can use the Directory view to manage files in the /apps
folder. Click the blue triangle icon positioned at the far right side of the Get dialog box to open the Directory view. The
Directory view allows you to do the following:
Copy app files into the /apps
folder using the drag-and-drop method
Right-click in the Directory view to display other file management options, as shown in Figure 17:
Create New folders and move app files for further organization
Cut, Copy, Paste, and Duplicate app files
Copy From another location
Move app files among folders
Rename app files
Delete app files
Use the default application file name or modify it as needed. By default the App name of app-deviceName-applicationName-YYYYMMDD-HHHHSS.sax
is used, where YYYY is year, MM is month, DD is day, HHHH is hours, SS is seconds. You can change the app filename as needed.
Use the default selection to Save kit checksums in sax file or deselect it as needed.
If checksums are saved, then the sax file will only run with those exact versions of kits. If checksums are not saved, the
sax file can be installed onto a device with the required kits without regard to their checksum. It is a safer practice, though
more restrictive, to save the checksums in the app. However, if you are regularly making changes to the kits, for example
during development, then you may want to uncheck this option..
Click the
button. The tasks to be performed will be listed in the upper portion of the screen.Click the Figure 18.
button to execute the tasks. As each task is completed, the status (Success or Failed) is displayed to the right of the task. Also, a log can be viewed in the pane. On completion you are notified that provisioning has finished, as shown inClick the
button to exit the Get/Put Application wizard.Put an application on a device
This procedure describes how to use the Put operation to copy an app from the app database in the Sedona environment to a Sedona Device.
Access the Sedona Tools under a Sedona Device:
For a Fox connection to a station with a networked device
When provisioning a networked device through the JACE station, expand the Sedona Network, right-click the device and select
menu where you can access the provisioning tools.For a Sox session connection (either direct or Sox-tunneled)
When provisioning a device through a Sox session connection (either direct or Sox-tunneled), double-click the Sedona Tools container to access the provisioning tools.
Select the
to launch the Get/Put Application wizard.Select the Put option. This populates the configuration area of the dialog box with the App Database source location, and the Sedona Apps table listing the applications stored there. You are prompted to select an app to be copied to a Sedona device, as shown in Figure 19.
On the JACE-2 series platform only, the “maxHeap” license feature is required in order to compile scode. The Put function
will fail without this feature. For more details on this, refer to the Troubleshooting section, Provisioning fails when compiling scode on JACE-2 series platform .
The App Database source location is determined automatically by the software and it differs slightly depending on whether you are provisioning
through the Workbench via a Sox session connection or via a Fox connection to a networked device on the JACE station. For
details, refer to About The Application Manager .The source location can be modified only when making a Sox session connection (either direct Sox or Sox-tunneled). In this case, you
can click the Directory icon to launch a Directory Chooser and browse to select an alternate source location. If you are provisioning
through a Fox connection to a networked device on the JACE station, the source location cannot be modified.
With either connection method described above, you can always transfer files to the souce location and manage files there
by displaying a Directory view of the /apps
folder. Click the blue triangle icon positioned at the far right side of the Put dialog box to open the Directory view. The
Directory view allows you to manage files in the /apps
folder and copy apps from another location as described below:
Copy app files into the Directory view using the drag-and-drop method
Right-click in the Directory view to display other file management options, as shown in Figure 20:
Create New folders and move app files for further organization
Cut, Copy, Paste, and Duplicate app files
Copy app files from another location using the
optionDelete app files
Rename app files
In the Sedona Apps table, select the application file name to be copied to the device.
Click the
button. This launches the Kit Manager which ensures that the appropriate kits are deployed on the device in order to support the app.In the Kit Manager view, you can change the version level of any installed kit by clicking on the individual Action value to reveal the Figure 21.
drop-down list, as shown inActions in the drop-down list are based on the version levels available in the local Workbench. Possible actions are:
Downgrade to (earlier version)
Keep at (current version)
Upgrade to (newer version)
Figure 21. Kit Manager with Action drop-down list showing two available version levels for the sys kit
Click the
button. The tasks to be performed will be listed in the upper portion of the screen.Click the Figure 22.
button to execute the tasks. As each task is completed, the status (Success or Failed) is displayed to the right of the task. Also, a log can be viewed in the pane. On completion you are notified that provisioning has finished, as shown in
After the Put operation completes successfully, you must restart the device.
Restarting the device will disconnect your connection. To re-open your Sox connection, double-click the Sedona node in the
Nav tree, and enter the log-in credentials.
Create a backup
This procedure describes how to create a zip file backup of the selected items on a Sedona Device and saves the zip file to the Sedona environment.
Access the Sedona Tools under a Sedona Device:
For a Fox connection to a station with a networked device
When provisioning a networked device through the JACE station, expand the Sedona Network, right-click the device and select
menu where you can access the provisioning tools.For a Sox session connection (either direct or Sox-tunneled)
When provisioning a device through a Sox session connection (either direct or Sox-tunneled), double-click the Sedona Tools container to access the provisioning tools.
Select the Backup option is selected and a default backup filename, backupYYYYMMDD.zip
, is used. Where YYYY is year, MM is month, DD is day, as shown in Figure 23. You can modify the backup filename as needed.
The save location is determined by the software and differs slightly depending on the method used to connect to the device.
For more information, refer to About the Backup and Restore operations
Click configuration check boxes to select the device components to be backed-up to the local Sedona environment, and use the default backup file name or you can modify it as needed.
The first configuration option, “Backup Sedona VM”, is device-specific. If not supported by your device, selecting it will
cause the backup operation to fail. Refer to your device documentation for information on creating a backup of the virtual
machine.
Click the
button. The tasks to be performed will be listed in the upper portion of the screen.Click the Figure 24.
button to execute the tasks. As each task is completed, the status (Success or Failed) is displayed to the right of the task. Also, a log can be viewed in the pane. On completion you are notified that provisioning has finished, as shown inClick the
button to exit the Backup/Restore Wizard.Restore a backup
This procedure describes how to restore a zip file backup by installing the contents of the selected zip file to a Sedona Device.
Access the Sedona Tools under a Sedona Device:
For a Fox connection to a station with a networked device
When provisioning a networked device through the JACE station, expand the Sedona Network, right-click the device and select
menu where you can access the provisioning tools.For a Sox session connection (either direct or Sox-tunneled)
When provisioning a device through a Sox session connection (either direct or Sox-tunneled), double-click the Sedona Tools container to access the provisioning tools.
Select the
to launch the Backup/Restore wizard.Click the Restore option.
In the Device Backups table, select a backup file to install on the device, as shown in Figure 25.
Click the check box to Restore Sedona dependencies (kits, manifests, pars) if you want to restore those. They will be installed, overwriting the kits, manifests, and pars on the device.
Click the
button. The tasks to be performed will be listed in the upper portion of the dialog box.Click the
button to execute the tasks.As each task is completed, the status (Success or Failed) is displayed to the right of the task. Also, a log can be viewed in the pane. When the restore operation finishes, you are prompted to restart the device to complete provisioning, as shown in Figure 26.
Click the
button to exit and restart the device.Restarting the device disconnects your connection. To re-open your Sox connection, double-click the dimmed Sedona node in
the Nav tree, and enter the log-in credentials.
Copyright © 2000-2014 Tridium Inc. All rights reserved.