What is the purpose of digi.instance.id in application.properties, and can I set values other than the default "ABC" or "IDE"?

[Eddie-Las]

Hi everyone,

I was looking through the application.properties file for digiRunner and noticed a parameter called digi.instance.id.
It seems to have default values like "ABC" or "IDE".

Could someone please explain what the purpose of digi.instance.id is?
Also, can I configure it to be something other than these default values, and if so, how?

Thanks for advance!

[TPIsoftwareOSPO]

Hi Eddie-Las,
Good eye 👀 — digi.instance.id is one of those small parameters that becomes very important once you’re running more than one digiRunner node. Let me break it down:

🔹 What it’s for

• It’s basically the identifier of a digiRunner instance (node).
• It shows up in the Node List inside the Online Console, so you can quickly tell which node is which.
• It’s especially useful when debugging logs in a multi-node setup, since each log line includes the instance ID.

🔹 Can you change it?
Yes, absolutely.
The default value like "IDE" is just a placeholder.
You can set it to any meaningful name that fits your environment, for example:

• dgR-Slave01-28080
• dgR-Node-Taipei
• dgR-Gateway-East

Anything that helps you or your team identify the node at a glance works well.

🔹 How to configure it
There are a few supported ways to configure this parameter, following a priority order:

• application.properties → lowest priority
• application-XXX.properties (profile-specific) → medium
• Startup command / container arguments → highest priority (recommended)

👉 Example with Docker:

docker run -d \
      -Ddigi.instance.id=dgR-Slave01-28080 \
      tpisoftwareopensource/digirunner-open-source

🔹 How to confirm it worked

1. Enable the Online Console in Admin Console (TSMP_ONLINE_CONSOLE = true)

2. Go to System Configs → Online Console → Node List

3. You’ll see your node with the custom digi.instance.id

💡 Tip
Giving each node a meaningful instance ID is a good habit, especially in cluster or multi-node environments.
It makes operations and troubleshooting much easier later on.