Storage_File

The following structure shows the new file system directory structure for all Program-Y files

• config - Contains various config files for running Bot in different configuration
• scripts
  • windows - Windows .cmd scripts for running Y-Bot
  • xnix - Linux and Mac OSX .sh scripts for running Y-Bot
• storage
  • categories - All AIML files, divided into subdirectories
  • conversations - (optional) Used by the file store engine to persist in conversations when enabled
  • debug - Stores errors and duplicate logs
  • licenses - Store for all license keys
  • lookups - Various lookup tables, normal, denormal, gender, person, person2 etc
  • maps - Hierarchy of all map files
  • nodes - Location for config for pattern and template nodes
  • processing - Location of pre and post-processing configuration
  • properties - Location of properties loaded into the brain
  • rdfs - Hierarchy of all RDF files
  • regex - Location of preloaded regexes which form part of the regex node
  • security - Location of all security information
  • sets - Hierarchy of all set files
  • spelling - Location of spelling Corpus files
  • twitter - Persists the latest twitter direct and tweet ids
  • variables - Persists user-related variables if full conversation is not enabled

In the example below, we have a client named 'console'. In its configuration, there should be a section called 'storage', and in this section, there should then be a subsection called 'entities'. For each entity type, we specify the storage engine as 'file'

console:
  storage:
      entities:
          categories: file
          errors: file
          duplicates: file
          learnf: file
          conversations:   file

          maps: file
          sets: file
          rdf: file

          denormal: file
          normal: file
          gender: file
          person: file
          person2: file
          regex_templates: file

          properties: file
          variables: file

          twitter: file

          spelling_corpus: file
          license_keys: file

          template_nodes: file
          pattern_nodes: file

          binaries: file
          braintree: file

          preprocessors: file
          postprocessors: file

          usergroups: file

In the same 'storage' section we then specify the storage engine 'file'. The name MUST match the same name as the entity storage type as above. For each entity type you specify the specific config in the 'config' subsection as follows

      stores:

          file:
              type:   file
              config:
                categories_storage:
                  dirs: ./storage/categories
                  subdirs: true
                  extension: .aiml
                errors_storage:
                  file: ./storage/debug/errors.txt
                duplicates_storage:
                  file: ./storage/debug/duplicates.txt
                learnf_storage:
                  dirs: ./storage/categories/learnf

                conversation_storage:
                  dirs: ./storage/conversations

                sets_storage:
                  dirs: ./storage/sets
                  extension: txt
                maps_storage:
                  dirs: ./storage/maps
                  extension: txt
                rdf_storage:
                  dirs: ./storage/rdfs
                  subdirs: true
                  extension: txt

                denormal_storage:
                  file: ./storage/lookups/denormal.txt
                normal_storage:
                  file: ./storage/lookups/normal.txt
                gender_storage:
                  file: ./storage/lookups/gender.txt
                person_storage:
                  file: ./storage/lookups/person.txt
                person2_storage:
                  file: ./storage/lookups/person2.txt
                regex_storage:
                  file: ./storage/lookups/regex.txt

                properties_storage:
                  file: ./storage/properties/properties.txt
                defaults_storage:
                  file: ./storage/properties/defaults.txt
                variables_storage:
                  dirs: ./storage/variables

                twitter_storage:
                  dirs: ./storage/twitter

                spelling_storage:
                  file: ./storage/spelling/corpus.txt

                license_storage:
                  file: ./storage/licenses/license.keys

                pattern_nodes_storage:
                  file: ./storage/nodes/pattern_nodes.conf
                template_nodes_storage:
                  file: ./storage/nodes/template_nodes.conf

                binaries_storage:
                  file: ./storage/braintree/braintree.bin
                braintree_storage:
                  file: ./storage/braintree/braintree.xml

                preprocessors_storage:
                  file: ./storage/processing/preprocessors.conf
                postprocessors_storage:
                  file: ./storage/processing/postprocessors.conf

                usergroups_storage:
                  file: ./storage/security/usergroups.yaml

Each entry is configured for either single or multiple files as follows

Single File

For a single file, the only attribute is 'file' which is a path to the file containing the data to load

                usergroups_storage:
                    file: ./storage/security/usergroups.yaml

Multiple Files

For multiple files, there are 3 attributes

• dirs - List of directories to load all files from
• subdirs - Whether to scan all sub directories for files
• extension - Extension of the file types to load

                categories_storage:
                  dirs: ./storage/categories
                  subdirs: true
                  extension: .aiml