V2 Configuration

Introduction

Configuration Overview

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

  2. Folder Structure - Folder structure when all documents and tasks are filed. Basis for access privileges

  3. Project Structures

    1. Object Types - Document, Revision, Task, Transmittal, Team Member

    2. Classification Fields

    3. Classification Schemes

    4. File Types

  4. User Configuration

    1. Organisational Chart

    2. Users

    3. Access Privileges

  5. Main Data Elements

    1. Documents and Revisions

    2. Tasks

    3. Transmittals

  6. Secondary Data Elements

    1. Notes

    2. Files

    3. Dossiers

  7. Object Links

Configuration Files

  1. Text-based (CSV) configuration files can be loaded into a V2 system. See: V2MigrationTools

  2. Text file properties:
    1. Tab or comma separated records.
    2. One record per line

      1. Multi-line field values, e.g. for Description fields, are possible by surrounded the field by double quotes

  3. 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

  2. The CSV file has no header
  3. Default field separator is TAB:
  4. The tree structure is defined by using leading tabs

  5. The fields right of the leading tabs are code, name, description respectively

Files for Non-Tree Models

  1. Default field separator is comma.
  2. The header of the file is used as field reference.
  3. The header can be any lines, but the lines before the hedaer will be ignored
  4. The order of the fields are free
  5. 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

  2. File name: config/settings.local.yaml

  3. The configuration file for each V2 application stance is saved in the v2deploy git repository
  4. Installed automatically as part of the deployment procedure

  5. See V2ApplicationSettings for a complete list of application settings

  6. Application settings for system configuration
    1. System code (short name)
    2. System name (long name)

Folder Structure

  1. Requires:

    1. no dependencies

  2. Tree structure
  3. Fields
    1. Code
    2. Name
    3. Description

    Example: 2014.08.04.HydroDemo.FoldersWBS.txt

Project Structures

Classification Fields

  1. Requires:

    1. no dependencies

  2. Classification fields are tree structured
  3. Fields
    1. Code
    2. Name
    3. Description

    Example: 2014.08.04.HydroDemo.Classification.txt

Classification Schemes

  1. Requires:

    1. no dependencies

  2. Fields
    1. Name
    2. Description

    Example: 2014.08.04.HydroDemo.ClassificationSchemes.csv

Classification Schemes - Classification Lists

  1. Requires:

    1. Classification Fields

    2. Classification Schemes

  2. Fields
    1. Classification Scheme Code
    2. Name
    3. Description
    4. Block

      1. Identification Block (marked as "top" block)

      2. Classification Block (marked as "classifiaction" block)

      3. Properties Block (marked as "data" block)

    5. Value Required - true or empty

    6. Multiple Values Allowed - true or empty

    7. Display on List - true or empty

    8. Display on Detail - true or empty

    9. Code in Selects - true or empty

    10. Classification List - Use the code of the classification list

    Example: 2014.08.04.HydroDemo.ClassificationSchemesClasses.csv

Object Types

  1. Requires:

    1. classification schemes

  2. Fields
    1. Resource Type
      1. Document
      2. Revision
      3. Task
      4. Transmittal
      5. Team Member
    2. Code
    3. Name

    4. Classification scheme - Use the name of the classification scheme

    5. Description

    Example: 2014.08.04.HydroDemo.ObjectTypes.csv

File Types

  1. Requires:

    1. no dependencies

  2. Access via: Project --> System Settings --> File Types Table

    1. Users with admin can edit this
  3. Fields
    1. Name
    2. Description

    3. Resource Type - One of: Revision or Note

    4. Parent Resource Type - One of: Revision, Task or Team Member

User Configuration

Organisational Chart

  1. Requires:

    1. no dependencies

  2. Tree structure
  3. Fields
    1. Code
    2. Name
    3. Description

    Example: 2014.08.04.HydroDemo.Organisation.txt

Users

  1. Requires:

    1. Organisational Chart

    Example: TeamMemberImport.xlsx
    Note: Global privilege is defined in TeamMemberImport.xlsx all additional privileges in PriviligesImport.xlsx.

Access Privileges

  1. Requires

    1. Folder Structure

    2. Users

    Example: PrivilegesImport.xlsx
    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

    2. Classification Schemes

Example

Tasks

  1. Requires:

    1. Object Types

    2. Classification Schemes

Transmittals

Secondary Data Elements

To be Completed

Notes

Files

Dossiers

Object Links

V2Configuration (last edited 2017-03-07 14:27:51 by TiborNagy)

Copyright 2008-2014, SoftXS GmbH, Switzerland