-
Notifications
You must be signed in to change notification settings - Fork 3
2. Azure Synchronization
THESE REQUIREMENTS ARE IN A VERY EARLY DRAFT
The ultimate deliverables for our application will be a set of xml, txt, csv, and media files delivered to Azure file storage. (Note that this is Azure file storage and not an Azure storage blob.) SkillRX will store and manage its media files in its own file storage. A process within SkillRX will manage synchronization with Azure.
The Azure storage includes folders for delivery to:
- Raspberry devices (CMES-PI)
- Mini computers
- USB
As of this writing, we are not delivering files for USB. That could change.
[move storage details here, abstracted for minimal repetition] Documents are stored in a folder in the Azure file storage based on their topic's language. The path comes down to:
- "[environment-specific route]/[file share folder determined by language]/assets/[topic_id]_[filename_with_extension]"
For now, these requirements are only concerned with the "for CMES-PI" files, both current and legacy, and not the legacy USB app files.
We will generate and deliver one set of files for each language, delivered to the root storage path for the environment plus the paths and filenames specified here:
- Legacy XML for CMES-Pi: [language.file_storage_prefix]CMES-Pi/assets/XML/[language.file_storage_prefix]Server_XML.xml
- Provider XML for CMES-Pi: [language.file_storage_prefix]CMES-Pi/assets/XML/[language.file_storage_prefix][provider name].xml for every provider
- New topics for CMES-Pi: [language.file_storage_prefix]CMES-Pi/assets/XML/[language.file_storage_prefix]New_Uploads.xml
- We will not generate Top topics for CMES-Pi: [language.file_storage_prefix]CMES-Pi/assets/XML/[language.file_storage_prefix]Top_Topics.xml as these depend on collecting stats from remote devices.
These file names and locations follow the patterns described in the XML Generation application.
Filenames will have topic.id and an underscore prepended to prevent filename collisions. It is less likely but still possible for an editor to upload two files with the same name to the same topic.
When a topic is archived, we will move its related Training Materials documents to an archival folder. Stakeholders will provide details on that storage structure.
See the XML Generation application for details.
We will finish these requirements with the full structure for each file after we receive sample files from the stakeholders.
In addition to the XML and the media files, we will deliver .txt files containing tag information.
We will generate and deliver one set of files for each language, delivered to the root storage path for the environment plus the paths and filenames specified here:
- Tag file for CMES-Pi: [language.file_storage_prefix]CMES-Pi/assets/Tags/[language.file_storage_prefix]tags.txt
- Tags and title file for CMES-Pi: [language.file_storage_prefix]CMES-Pi/assets/Tags/[language.file_storage_prefix]tagsAndTitle.txt
The mini computers rely on a set of .csv files which they import to their local database. [full requirements for those files]