How Can We Help?

Vous êtes ici:
< Back
Damaris RM
Gestion de projet scan

Why Naming Best Practices Are Important?

We all work in Teams, internal collegues and with client’s staff.

We need to share same way of organization to be sure to be understood by another person.

Naming objects same way will facilitate sharing same project.

 

Objects List

Here are all objects included in this naming policy:

  • Damaris RM
    • Tomcat instance
    • Database instance
    • Data Storage path and name
  • Damaris Vault
    • Tomcat instance
    • Database instance
    • Vault Storage path and name
  • Database
    • Username
  • SFTP
    • Username
    • Path
  • Client Code (Short name)
  • Client server URL
  • Client email address for incoming documents

 

Naming Table For Dedicated Server With One Instance

The following is the naming Best practices for usually used objects:

As pre requests, you need ClientCode and projectCode for a given new instance.

 

Damaris RM Main instance

This table sums up naming standards for the main Damaris RM instance on a given server.

Object Type Naming Comments
Damaris RM Tomcat path

/home/damaris/tomcat9

 
Damaris RM Tomcat instance

DamarisRM for main instance

 
Damaris Database User damaris  
Damaris RM Database Instance dmr_damaris_rm  
Damaris RM Storage path and name /home/damaris/damaris_data  
Damaris Vault Tomcat instance DamarisVault  
Damaris Vault database instance dmr_damaris_rm Use the same database than Damaris RM
Damaris Vault Storage path and name /home/damaris/damaris_vault  
Client Code Short Name   This code will be used as subdomain like https://code.damaris.pro
SFTP User for Clients    
SFTP Path

/home/damaris/sftp/ProjectCode

for sftp.damaris.pro server

Project code format is SOxxxx (For example SO1234)

Client Server URL ClientCode.damaris.pro  
Client email address

projectCode@damaris.pro

This is because a unique client can have several projects at the same time.

Email address example: so1097@damaris.pro

 

Damaris RM Secondary instances

This table sums up naming standards for other autonomous instances on a given server.

Object Type Naming Comments
Damaris RM Tomcat path

/home/damaris/tomcat9

 
Damaris RM Tomcat instance

dmrClientCode for Client specific instances

Specific instance naming will need URL redirection, so client will use his dedicated url descibed in section “Client Server URL” in this table.
Damaris Database User damaris  
Damaris RM Database Instance dmr_ClientCode_rm  
Damaris RM Storage path and name /home/damaris/damaris_data_ClientCode  
Damaris Vault Tomcat instance VaultClientCode  
Damaris Vault database instance dmr_ClientCode Use the same database than Damaris RM
Damaris Vault Storage path and name /home/damaris/damaris_vault_ClientCode  
Client Code Short Name   This code will be used as subdomain like https://code.damaris.pro
SFTP User for Clients projectCode  
SFTP Path

/home/damaris/sftp/projectCode

for sftp.damaris.pro server

Project code format is SOxxxx (For example SO1234)

Client Server URL ClientCode.damaris.pro  
Client email address

projectCode@damaris.pro

This is because a unique client can have several projects at the same time.

Email address example: so1097@damaris.pro

 

Damaris RM Container Naming (lxc)

This table sums up naming standards for other autonomous instances on a given server.

Object Type Naming Comments
lxc container damaris-rm-clientCode  
lxc container snapshot snap-damaris-rm-clientCode  
lxc container export file export-damaris-rm-version.tar.gz  
Resources directory /home/damaris/resources/clientCode This folder contains damaris_vault subdirectory shared with container
     
     
     
     
     
     
     
     
     

 

Naming Best Practices