definma-ui/src/app/documentation/documentation-database/documentation-database.component.html

<p>
The used database instance is a MongoDB instance running on the BIC, storing all application data.
The admin database management page can be accessed <a href="https://definma-db.apps.de1.bosch-iot-cloud.com/api-doc/">here</a>.
However, it is recommended to use a dedicated MongoDB application for anything apart from a quick look.
The two tested applications are <a href="https://www.mongodb.com/products/compass">MongoDB Compass</a> and
<a href="https://robomongo.org/s">Robo 3T</a> (recommended for trying queries).
</p>
<p>
To connect to the BIC instance from your local application follow the
<a href="https://inside-docupedia.bosch.com/confluence/display/BICI/MongoDB+Client+Tool+via+SSH+Tunnel">BIC guide</a>.
<br>
TL;DR:
</p>

<p>For the first time:</p>
<ul>
	<li>cf login</li>
	<li>cf enable-ssh definma-api</li>
	<li>cf create-service-key definmadb &lt;key name, can be whatever&gt;</li>
</ul>
<p>Every time:</p>
<ul>
	<li>cf ssh -L 1120:st0cvm200118.internal-mongodb.de1.bosch-iot-cloud.com:30000 definma-api</li>
	<li>
		Login into your application with localhost:1120 and use credentials and authentication database from the BIC
		(Data can be found at Home &gt; DeFinMa &gt; production &gt; definma-api &gt; Services &gt; dots on the right of definmadb &gt; View Credentials)
	</li>
</ul>

<h4>Backup Instructions</h4>

<p>
For creating a database backup, you must follow the same steps from above (except the last one).
Additionally you need the <a href="https://www.mongodb.com/try/download/database-tools">MongoDB Tools</a> installed.
Extract the ZIP file to a location on your hard drive and launch a Git Bash in that directory.
</p>

<p>To back up the database from the BIC:</p>
<pre>
./mongodump --port 1120 -d &lt;database&gt; -u &lt;username&gt; -p &lt;password&gt; --gzip -o 'C:\path\to\backup\folder'
</pre>

<p>To restore the database to the BIC:</p>
<pre>
./mongorestore --port 1120 -d &lt;database&gt; -u &lt;username&gt; -p &lt;password&gt; --gzip --drop 'C:\path\to\backup\folder'
</pre>

<p>To restore the database to your local MongoDB instance:</p>
<pre>
./mongorestore -d dfopdb --gzip --drop 'C:\path\to\backup\folder\&lt;database&gt;'
</pre>

<p>
More information can be found inside the
<a href="https://docs.mongodb.com/database-tools/">documentation</a>. <br>
The BIC service also creates an internal backup, which can be requested to restore, see
<a href="https://inside-docupedia.bosch.com/confluence/pages/viewpage.action?pageId=565402281">MongoDB FAQ</a>
</p>

<h4>Database Model</h4>

<app-img-magnifier src="assets/imgs/db_structure_latest.svg" zoom="2" [magnifierSize]="{width: 400, height: 300}"
	id="db-structure"></app-img-magnifier>

<h4>Field Reference</h4>

<rb-table class="field-reference">
	<tr><th>samples</th><th></th><th>Example</th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63c98d1c020f8cda6e06'</td>
	</tr>
	<tr>
		<td>type</td>
		<td>
			The material status of the sample, can be either <span class="name">as-delivered/raw</span> or
			<span class="name">processed</span>.
		</td>
		<td>'processed'</td>
	</tr>
	<tr>
		<td>number</td>
		<td>The sample number, generated by the server for new samples</td>
		<td>'An31'</td>
	</tr>
	<tr>
		<td>color</td>
		<td>Sample color</td>
		<td>'black'</td>
	</tr>
	<tr>
		<td>batch</td>
		<td>Batch number the sample was from</td>
		<td>'2264486614'</td>
	</tr>
	<tr>
		<td>status</td>
		<td>Status of the document, can be either <span class="name">new</span>, <span class="name">validated</span> or
			<span class="name">deleted</span>.</td>
		<td>'new'</td>
	</tr>
	<tr>
		<td>condition</td>
		<td>sample condition with <span class="name">condition_template</span> reference and all fields defined by the
			template</td>
		<td>{{'{'}}condition_template: '5f3151b5b8a886007d2de9ed', time in minutes: 30{{'}'}}</td>
	</tr>
	<tr>
		<td>material_id</td>
		<td>Reference to the sample material</td>
		<td>'5f2e63118d1c020f8cda6a0a'</td>
	</tr>
	<tr>
		<td>note_id</td>
		<td>Reference to the sample note</td>
		<td>'5f2e63c98d1c020f8cda6e08'</td>
	</tr>
	<tr>
		<td>user_id</td>
		<td>Reference to the user who created the sample</td>
		<td>'5f294dd4aa9ea5085c7d7315'</td>
	</tr>

	<tr><th>notes</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63e98d1c020f8cda70cc'</td>
	</tr>
	<tr>
		<td>comment</td>
		<td>General remarks</td>
		<td>'stabilized'</td>
	</tr>
	<tr>
		<td>sample_references</td>
		<td>Array of references to other samples, each reference containing the referenced <span class="name">sample_id
			</span> as well as a <span class="name">relation</span> field describing the relationship</td>
			<td>{{'{'}}sample_id: '5f2e63d68d1c020f8cda701c', relation: 'belongs to'{{'}'}}</td>
	</tr>
	<tr>
		<td>custom_fields</td>
		<td>Additional information as key value pairs for the sample, making it easier to process this information</td>
		<td>{{'{'}}vwz: '0 min'{{'}'}}</td>
	</tr>

	<tr><th>note_fields</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63e98d1c020f8cda70ce'</td>
	</tr>
	<tr>
		<td>name</td>
		<td>name of the <span class="name">custom_fields</span> key</td>
		<td>'test series'</td>
	</tr>
	<tr>
		<td>qty</td>
		<td>number of notes with this key</td>
		<td>24</td>
	</tr>

	<tr><th>materials</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63e98d1c020f8cda70d0'</td>
	</tr>
	<tr>
		<td>name</td>
		<td>Trade name of the material</td>
		<td>'Ultradur B4300 G6'</td>
	</tr>
	<tr>
		<td>numbers</td>
		<td>Bosch material part numbers</td>
		<td>['5515753021, '5515753404']</td>
	</tr>
	<tr>
		<td>properties</td>
		<td>material class specific properties with <span class="name">material_template</span> reference and all fields
			defined by the template</td>
		<td>{{'{'}}material_template: '5f2e89874ac96c007fb06e83', mineral: 0, glass_fiber: 30, carbon_fiber: 0{{'}'}}</td>
	</tr>
	<tr>
		<td>group_id</td>
		<td>Reference to the material group</td>
		<td>'5f2e631191c5d68f8a0708c4'</td>
	</tr>
	<tr>
		<td>supplier_id</td>
		<td>Reference to the material supplier</td>
		<td>'5f2e631191c5d68f8a0708c7'</td>
	</tr>
	<tr>
		<td>status</td>
		<td>Status of the document, can be either <span class="name">new</span>, <span class="name">validated</span> or
			<span class="name">deleted</span>.</td>
		<td>'new'</td>
	</tr>

	<tr><th>material_groups</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e631291c5d68f8a0708f9'</td>
	</tr>
	<tr>
		<td>name</td>
		<td>The chemical material type</td>
		<td>'PA66'</td>
	</tr>

	<tr><th>material_supplier</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e631991c5d68f8a0709c3'</td>
	</tr>
	<tr>
		<td>name</td>
		<td>The material supplier</td>
		<td>'BASF'</td>
	</tr>

	<tr><th>measurements</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f294d25aa9ea5085c7d7305'</td>
	</tr>
	<tr>
		<td>sample_id</td>
		<td>Reference to the sample this measurement belongs to</td>
		<td>'5f2e63c98d1c020f8cda6e06'</td>
	</tr>
	<tr>
		<td>measurement_template</td>
		<td>Reference to the Template defining the structure of the measurement values</td>
		<td>'5f294d25aa9ea5085c7d7305'</td>
	</tr>
	<tr>
		<td>values</td>
		<td>Measurement values in defined format</td>
		<td>{{'{'}}vn: 100.4{{'}'}}</td>
	</tr>
	<tr>
		<td>status</td>
		<td>Status of the document, can be either <span class="name">new</span>, <span class="name">validated</span> or
			<span class="name">deleted</span>.</td>
		<td>'new'</td>
	</tr>

	<tr><th>&lt;collection&gt;_templates</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63ee8d1c020f8cda7128'</td>
	</tr>
	<tr>
		<td>name</td>
		<td>Display name of the template</td>
		<td>'spectrum'</td>
	</tr>
	<tr>
		<td>version</td>
		<td>Version number of the template</td>
		<td>2</td>
	</tr>
	<tr>
		<td>first_id</td>
		<td>Reference to the first instance of this template with <span class="name">version</span> number 1</td>
		<td>'5f2e89bb4ac96c007fb06e86'</td>
	</tr>
	<tr>
		<td>parameters</td>
		<td>Specified parameters of this template. The <span class="name">name</span> property is used as the key in the
			document using this template, the range can have the following properties: <span class="name">min</span> specifies
			the minimum numeric value, <span class="name">max</span> specifies the maximum numeric value, <span class="name">
				values</span> specifies an array of allowed values of this parameter and <span class="name">type: 'array'</span>
			specifies that this parameter must be an array</td>
		<td></td>
	</tr>

	<tr><th>users</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63cc8d1c020f8cda6e6a'</td>
	</tr>
	<tr>
		<td>name</td>
		<td>The username</td>
		<td>'admin'</td>
	</tr>
	<tr>
		<td>email</td>
		<td>The user's email address used for password reset</td>
		<td>'test@bosch.com'</td>
	</tr>
	<tr>
		<td>location</td>
		<td>The abbreviation of the Bosch site of the user</td>
		<td>'Rng'</td>
	</tr>
	<tr>
		<td>level</td>
		<td>The permission level, can be either <span class="name">read</span>, <span class="name">write</span>,
			<span class="name">dev</span> or <span class="name">admin</span>. The exact level permissions can be found at the
			<a routerLink="/documentation">general documentation</a></td>
		<td></td>
	</tr>
	<tr>
		<td>devices</td>
		<td>Array of all spectrum measurement devices the user has access to</td>
		<td>['Rng01', 'Rng02']</td>
	</tr>
	<tr>
		<td>pass</td>
		<td>The user's password in hashed form using bcrypt</td>
		<td>'$2a$10$m8DqvZR3plZEv8EPwPo7Luvyrm/ZQDiPzfBh6bpU/1XFWOGONkJyG'</td>
	</tr>
	<tr>
		<td>key</td>
		<td>The API key, generated when the user is created</td>
		<td>'5f294dd4aa9ea5085c7d7314'</td>
	</tr>
	<tr>
		<td>models</td>
		<td>
			Reference to the prediction models the user should have access to. Ignored for <span class="name">dev</span> and
			<span class="name">admin</span> as they automatically have access to all models.
		</td>
		<td>['5f466fb1e566810dd8b3e919', '5f294d8aaa9ea5085c7d730b']</td>
	</tr>
	<tr>
		<td>status</td>
		<td>Status of the document, can be either <span class="name">new</span>, <span class="name">validated</span> or
			<span class="name">deleted</span>.</td>
		<td>'new'</td>
	</tr>

	<tr><th>models</th><th></th><th></th></tr>
	<tr>
		<td>group</td>
		<td>group the model belongs to</td>
		<td>'VN'</td>
	</tr>
	<tr>
		<td>models</td>
		<td>models of the group with _id, name and url to the Python endpoint</td>
		<td>{{'{'}}_id: '5f466fb1e566810dd8b3e919', name: POM, url: 'http://localhost:9099/test'{{'}'}}</td>
	</tr>

	<tr><th>model_files</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f294d47aa9ea5085c7d7308'</td>
	</tr>
	<tr>
		<td>name</td>
		<td>The name of the model</td>
		<td>'humidity-1'</td>
	</tr>
	<tr>
		<td>data</td>
		<td>The Python model data in binary format</td>
		<td>&lt;binary data&gt;</td>
	</tr>

	<tr><th>changelogs</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63cc8d1c020f8cda6e6e'</td>
	</tr>
	<tr>
		<td>action</td>
		<td>The URL which invoked the database write access</td>
		<td>'POST /material/new'</td>
	</tr>
	<tr>
		<td>collection_name</td>
		<td>Collection that was written to</td>
		<td>'material_groups'</td>
	</tr>
	<tr>
		<td>conditions</td>
		<td>Condition arguments used when accessing the database</td>
		<td>{{'{'}}id: '5f2e63118d1c020f8cda6a0a'{{'}'}}</td>
	</tr>
	<tr>
		<td>data</td>
		<td>data which was written to the database</td>
		<td>{{'{'}}name: 'PBT'{{'}'}}</td>
	</tr>
	<tr>
		<td>user_id</td>
		<td>The user that executed this command</td>
		<td>'5f2e63118d1c020f8cda6a09'</td>
	</tr>

	<tr><th>help</th><th></th><th></th></tr>
	<tr>
		<td>_id</td>
		<td>Automatically generated unique id</td>
		<td>'5f2e63d28d1c020f8cda6f86'</td>
	</tr>
	<tr>
		<td>key</td>
		<td>The key used to find the required help text</td>
		<td>'/documentation/database'</td>
	</tr>
	<tr>
		<td>level</td>
		<td>The minimum level required to read this help</td>
		<td>'write'</td>
	</tr>
	<tr>
		<td>text</td>
		<td>The actual help text</td>
		<td>'This page documents the database.'</td>
	</tr>
</rb-table>