= V2 Configuration =

  [[V2Master]]

  <<TableOfContents>>

= Introduction =

= Configuration Overview =

 1. [[#Application_Settings|Application Settings]] - Defines the application's URL, project code and name, hostname of email server

 1. [[#Folder_Structure|Folder Structure]] - Folder structure when all documents and tasks are filed. Basis for access privileges

 1. [[#Project_Structures|Project Structures]]
    1. [[#Object_Types|Object Types]] - Document, Revision, Task, Transmittal, Team Member
    1. [[#Classification_Fields|Classification Fields]]
    1. [[#Classification_Schemes|Classification Schemes]]
    1. [[#File_Types|File Types]]

 1. [[#User_Configuration|User Configuration]]
    1. [[#Organisational_Chart|Organisational Chart]]
    1. [[#Users|Users]]
    1. [[#Access_Privileges|Access Privileges]]

 1. [[#Main_Data_Elements|Main Data Elements]]
    1. [[#Documents_and_Revisions|Documents and Revisions]]
    1. [[#Tasks|Tasks]]
    1. [[#Transmittals|Transmittals]]

 1. [[#Secondary_Data_Elements|Secondary Data Elements]]
    1. [[#Notes|Notes]]
    1. [[#Files|Files]]
    1. [[#Dossiers|Dossiers]]

 1. [[#Object_Links|Object Links]]


= Configuration Files =

 1. Text-based (CSV) configuration files can be loaded into a V2 system. See: [[V2MigrationTools]]
 1. Text file properties:
    1. Tab or comma separated records.
    1. One record per line
       1. Multi-line field values, e.g. for ''Description'' fields, are possible by surrounded the field by double quotes
 1. The order of the lines in the file, defines the database order of the records in the system (to the extent that the thing be defined has a natural order or the modelhas an explicit sort order)

== Files for Tree Structures ==

 1. Applicable only for the models ''Folder'', ''Organisational Chart'' and ''Classification Fields''
 1. The CSV file has no header
 1. Default field separator is TAB:
 1. The tree structure is defined by using leading tabs
 1. The fields right of the leading tabs are ''code'', ''name'', ''description'' respectively

== Files for Non-Tree Models ==

 1. Default field separator is comma.
 1. The header of the file is used as field reference.
 1. The header can be any lines, but the lines before the hedaer will be ignored
 1. The order of the fields are free
 1. All necessary columns can be added for classifications
  * If a classification is not in the appropriate object type, the field should be simple empty
  * Use multiple columns if multiple values are allowed for a classification, with different header names, e.g. LOC1, LOC2, etc.

= Application Settings =

  1. Application settings are defined in Ruby code as a YAML file
  1. File name: ''config/settings.local.yaml''
  1. The configuration file for each V2 application stance is saved in the v2deploy git repository
  1. Installed automatically as part of the deployment procedure
  1. See V2ApplicationSettings for a complete list of application settings
  1. Application settings for system configuration
     1. System code (short name)
     1. System name (long name)

= Folder Structure =

 1. Requires:
    1. ''no dependencies''
 1. Tree structure
 1. Fields
    1. Code
    1. Name
    1. Description

 Example: [[attachment:2014.08.04.HydroDemo.FoldersWBS.txt]]

= Project Structures =

== Classification Fields ==

 1. Requires:
    1. ''no dependencies''
 1. Classification fields are tree structured
 1. Fields
    1. Code
    1. Name
    1. Description

 Example: [[attachment:2014.08.04.HydroDemo.Classification.txt]]

== Classification Schemes ==

 1. Requires:
    1. ''no dependencies''
 1. Fields
    1. Name
    1. Description

 Example: [[attachment:2014.08.04.HydroDemo.ClassificationSchemes.csv]]

== Classification Schemes - Classification Lists ==

 1. Requires:
    1. ''Classification Fields''
    1. ''Classification Schemes''
 1. Fields
    1. Classification Scheme Code
    1. Name
    1. Description
    1. Block
       1. ''Identification'' Block (marked as "top" block)
       1. ''Classification'' Block (marked as "classifiaction" block)
       1. ''Properties'' Block (marked as "data" block)
    1. Value Required - ''true'' or empty
    1. Multiple Values Allowed - ''true'' or empty
    1. Display on List - ''true'' or empty
    1. Display on Detail - ''true'' or empty
    1. Code in Selects - ''true'' or empty
    1. Classification List - Use the ''code'' of the classification list

 Example: [[attachment:2014.08.04.HydroDemo.ClassificationSchemesClasses.csv]]

== Object Types ==

 1. Requires:
    1. ''classification schemes''
 1. Fields
    1. Resource Type
       1. Document
       1. Revision
       1. Task
       1. Transmittal
       1. Team Member
    1. Code
    1. Name
    1. Classification scheme - Use the ''name'' of the classification scheme
    1. Description

 Example:  [[attachment:2014.08.04.HydroDemo.ObjectTypes.csv]]

== File Types ==

 1. Requires:
    1. ''no dependencies''
 1. Access via: ''Project --> System Settings --> File Types Table''
    1. Users with admin can edit this
 1. Fields
    1. Name
    1. Description
    1. Resource Type - One of: ''Revision'' or ''Note''
    1. Parent Resource Type - One of: ''Revision'', ''Task'' or ''Team Member''

= User Configuration =

== Organisational Chart ==

 1. Requires:
    1. ''no dependencies''
 1. Tree structure
 1. Fields
    1. Code
    1. Name
    1. Description

 Example: [[attachment:2014.08.04.HydroDemo.Organisation.txt]]

== Users ==

 1. Requires:
    1. ''Organisational Chart''
 Example:  [[attachment:TeamMemberImport.xlsx]]
 <<BR>>
 Note: Global privilege is defined in TeamMemberImport.xlsx all additional privileges in PriviligesImport.xlsx.

== Access Privileges ==

 1. Requires
    1. ''Folder Structure''
    1. ''Users''
 Example: [[attachment:PrivilegesImport.xlsx]]
 <<BR>>
 Note: Global privilege is defined in TeamMemberImport.xlsx all additional privileges in PriviligesImport.xlsx.

= Main Data Elements =

'''''To be Completed'''''

== Documents and Revisions ==

 1. Requires:
    1. ''Object Types''
    1. ''Classification Schemes''

=== Example ===

 See the example: [[attachment:DocumentRevisionImport.xlsx]]
 <<BR>>
 Some notes:
 1. Use the save document values for all revisions of the same document if you have more revisions

 
== Tasks ==

 1. Requires:
    1. ''Object Types''
    1. ''Classification Schemes''

== Transmittals ==


= Secondary Data Elements =

'''''To be Completed'''''

== Notes ==

== Files ==

== Dossiers ==


= Object Links =