Skip to content

Commit

Permalink
Correct previous commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Martijn Dirkse committed Oct 25, 2024
1 parent f3fff5a commit aed74af
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/source/advancedDevelopment/database/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ How the database is accessed

To understand the attribute ``datasourceName="jdbc/${instance.name.lc}"``, you first have to understand property ``instance.name.lc``, see subsection :ref:`propertiesFramework`. Each instance of the Frank!Framework must define a property ``instance.name``. The Frank!Framework automatically calculates property ``instance.name.lc`` by taking the value of ``instance.name`` and replacing uppercase letters with lowercase letters. For example, if ``instance.name`` is ``MyApp``, then ``instance.name.lc`` becomes ``myapp``. In this case, the shown attribute is equivalent to ``datasourceName="jdbc/myapp"``.

Your deployed configuration thus uses a database that is referenced by the name ``jdbc/myapp`` (or ``jdbc/otherapp`` if ``instance.name`` would be ``OtherApp``). The name ``jdbc/myapp`` is a Java Naming and Directory Interface (JNDI) name. JNDI names allow you as a developer to reference a database without defining the database name, the database user and the password. You do not have to include sensitive information in your Frank config and it can easily be deployed on different environments that each may have their own database. It is up to the system administrator to link each JNDI name in your Frank config to a concrete database, a concrete database user, a concrete password etc. You can see an example in subsection :ref:`deploymentTomcatDatabaseMigrate`.
Your deployed configuration thus uses a database that is referenced by the name ``jdbc/myapp`` (or ``jdbc/otherapp`` if ``instance.name`` would be ``OtherApp``). The name ``jdbc/myapp`` is a Java Naming and Directory Interface (JNDI) name. JNDI names allow you as a developer to reference a database without defining the database name, the database user and the password. You do not have to include sensitive information in your Frank config and it can easily be deployed on different environments that each may have their own database. It is up to the system administrator to link each JNDI name in your Frank config to a concrete database, a concrete database user, a concrete password etc. You can see an example in subsection :ref:`advancedDevelopmentDockerDevelBasics`, the shown contents of file ``resources.yml``.

This knowledge allows you to use multiple databases. If you have a second database then give it a JNDI name, say ``jdbc/alternative``. The senders and listeners that access the database all have an attribute ``datasourceName``. Set this attribute within your Frank config, ``datasourceName="jdbc/alternative"``, every time you want to access your second database. It is up to the system administrator to link this JNDI name to her own database.

.. WARNING::

The Frank!Runner (see section :ref:`deploymentTomcat4Frank`) does not support multiple databases. This tool automates deploying the Frank!Framework and it automatically creates a database for your Frank. You cannot use this project to connect to an existing database or to use multiple databases.
The Frank!Runner does not support multiple databases. This tool automates deploying the Frank!Framework and it automatically creates a database for your Frank. You cannot use this project to connect to an existing database or to use multiple databases.

If you are using an Apache Tomcat application server, then the Frank!Framework expects that there is a database with JNDI name ``jdbc/${instance.name.lc}`` with ``${instance.name.lc}`` a property reference as explained. The expected database name depends on property ``instance.name``.

Expand Down
2 changes: 2 additions & 0 deletions docs/source/advancedDevelopment/dockerDevel/basics.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _advancedDevelopmentDockerDevelBasics:

The basics
==========

Expand Down
2 changes: 1 addition & 1 deletion docs/source/troubleshooting/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Authorization to turn on Ladybug

**Question:** Which role do you need at least to turn on Ladybug?

**Answer:** IbisDataAdmin, IbisAdmin or IbisTester. See also :ref:`deploymentSecurity`.
**Answer:** IbisDataAdmin, IbisAdmin or IbisTester. See also :ref:`deploymentOverviewSecurityRoles`.

Flow diagram images
-------------------
Expand Down

0 comments on commit aed74af

Please sign in to comment.