Getting Application ID

Application IDs are environment-specific and must be retrieved using IECTL (Industrial Edge Control Tool).

NOTICE

• Application IDs may differ across environments, for example development, integration, ecosytem production and production.
• Use the correct application ID for each target environment.
• The same steps apply to all environments. Only the application IDs change.

Prerequisites

• Download and install IECTL from Industrial Edge Hub.
• Configure IECTL with your credentials.

For more information about downloading and installing IECTL, see Download IECTL.

Option 1: Get Application ID from IEHub

1. Configure IECTL for IEHub.

iectl config add iehub --name <config-name> --url <iehub-url> --user <username> --password-stdin

For more information, see IECTL Configuration.

1. List applications.

iectl iehub library list

Or search by product name:

iectl iehub library list --product-name "YourAppName"

1. Locate the application in the response and note the gemsId.

Sample response:

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "tenantId": "your-tenant-id",
  "tenantName": "your-tenant-name",
  "name": "Flow Creator",
  "iconUrl": "https://<iehub-domain>/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/ICON",
  "documentationUrl": "https://docs.industrial-operations-x.siemens.cloud/access?ft:title=Flow%20Creator",
  "type": "APPLICATION",
  "subTypes": null,
  "status": "IN_MARKETPLACE",
  "architecture": "x86-64",
  "gemsId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "skipEcosystemReview": true,
  "defaultApp": true,
  "spec": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "downloadable": true,
  "monitorable": true,
  "latestVersion": {
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "version": "1.19.4-2"
  },
  "linkedProductId": ""
}

For complete command details and options, see IECTL IEHub Library List.

Option 2: Get Application ID from IEM

1. Configure IECTL Instance for your IEM

iectl config add iem --name <config-name> --url <iem-url> --user <username> --password-stdin

For more information, see IECTL Configuration.

1. Configure Certificate Validation

   If your IEM instance uses self-signed TLS/SSL certificates, skip certificate verification:

export EDGE_SKIP_TLS=1

For more information, see IECTL Environment Variables.

1. List applications.

iectl iem device list-apps

For more information, see IECTL IEM Device List Apps.

Sample response:

iectl iem device list-apps

{
  "data": [
    {
      "applicationId": "0153b1b8a1d1414890e4828c0dc1d115",
      "icon": "https://localhost:443/pp/PortalCache/app/0153b1b8a1d1414890e4828c0dc1d115/appicon.png",
      "title": "Cloud Connector",
      "deviceId": "5ff06dbdb9fc4d4596655384b44befd6",
      "deviceName": "iedevice",
      "verionId": "qIveoDpqAaue26EKkuXIDIZmMEWu7Hkz",
      "versionNumber": "1.17.1-2",
      "status": "LIVE"
    },
    {
      "applicationId": "d0e61067a4ad41aa9381b6c38774ec72",
      "icon": "https://localhost:443/pp/PortalCache/app/d0e61067a4ad41aa9381b6c38774ec72/appicon.png",
      "title": "Databus",
      "deviceId": "5ff06dbdb9fc4d4596655384b44befd6",
      "deviceName": "iedevice",
      "verionId": "X6V9GebfLdSJFyIIFrHG5928g5iPGtqm",
      "versionNumber": "3.3.0-1",
      "status": "LIVE"
    },
    {
      "applicationId": "ad70b6b02b62412d92007fafa294c7da",
      "icon": "https://localhost:443/pp/PortalCache/app/ad70b6b02b62412d92007fafa294c7da/appicon.png",
      "title": "Data Flow Monitoring",
      "deviceId": "5ff06dbdb9fc4d4596655384b44befd6",
      "deviceName": "iedevice",
      "verionId": "pIafCJgvrbBYaUuaVvsuA4QV5i1NIUwB",
      "versionNumber": "3.0.14-1",
      "status": "LIVE"
    },
    {
      "applicationId": "1dbf9af1b4114390a3b63712551e674b",
      "icon": "https://localhost:443/pp/PortalCache/app/1dbf9af1b4114390a3b63712551e674b/appicon.png",
      "title": "Flow Creator",
      "deviceId": "5ff06dbdb9fc4d4596655384b44befd6",
      "deviceName": "iedevice",
      "verionId": "dnD5xYe2LYi1Pj1FnC1zrimM4dmShrhV",
      "versionNumber": "1.19.3-3",
      "status": "LIVE"
    },
    {
      "applicationId": "ASFKaAwSyJ1jk2FeyuumhEFUf3aFad2L",
      "icon": "https://localhost:443/pp/PortalCache/app/ASFKaAwSyJ1jk2FeyuumhEFUf3aFad2L/appicon.png",
      "title": "Grafana App",
      "deviceId": "5ff06dbdb9fc4d4596655384b44befd6",
      "deviceName": "iedevice",
      "verionId": "RCfNgZ6iI2qspmh1fImKbxatYzxbJJZ2",
      "versionNumber": "0.0.12",
      "status": "LIVE"
    },
    {
      "applicationId": "67RBBVNKFE8KTmDppFKxbsMz23nyPu10",
      "icon": "https://localhost:443/pp/PortalCache/app/67RBBVNKFE8KTmDppFKxbsMz23nyPu10/appicon.png",
      "title": "testApp",
      "deviceId": "137b39b195b14c288485a63c966aea11",
      "deviceName": "XpCbp-iem_user",
      "verionId": "whWYi0F4uoXWHeClZPBdGATZbvCcD0l9",
      "versionNumber": "0.0.1",
      "status": "LIVE"
    }
  ]
}

1. Identify your application ID.

Locate your application in the output list and note the corresponding application ID for your specific environment.