IBM App Connect Enterprise

https://www.ibm.com/docs/en/app-connect/13.0.x
Admin
IBM App Connect Enterprise is an integration platform designed to connect diverse applications and...
Tokens:6,931,941
Snippets:50,369
Trust Score:10
Update:6 days ago
Show doc for...
Tokens:
Raw
### Start secure agent (Windows) example

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=cpnfacd-connecting-private-network-from-app-connect-designer-in-operator-1110-later-1

Example command to start the secure agent on Windows with specific paths.

```bash
secureagent -c C:\appconnect_pnc -l C:\appconnect_pnc
```

--------------------------------

### Sample Install Plan Output

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=iaco-from-openshift-cli

Example output from the oc get installplans command, showing an Install Plan with APPROVED set to false.

```text
NAME            CSV                                  APPROVAL   APPROVED
install-bl7pf   ibm-appconnect.v12.21.0              Manual     false
```

--------------------------------

### Start secure agent (Linux) example

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=cpnfacd-connecting-private-network-from-app-connect-designer-in-operator-1110-later-1

Example command to start the secure agent on Linux with specific paths.

```bash
./secureagent -c /appconnect_pnc -l /appconnect_pnc
```

--------------------------------

### mqsistart integration server example

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=command-mqsistart-windows-linux-aix-platforms

Example command shown in the usage notes for the mqsistart command. It attempts to start an integration server named intServer under integration node INODE. The example is used to illustrate a failure condition: starting an integration server fails if its parent integration node is stopped.

```console
mqsistart INODE -e intServer
```

--------------------------------

### Example InstallPlan check command

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=mt-troubleshooting-installation-issues-kubernetes

Example command using the namespace ace-fiona and install plan name install-lhrj8.

```bash
kubectl get installPlan -n ace-fiona install-lhrj8 -o yaml
```

--------------------------------

### mqsistart command examples

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=command-mqsistart-windows-linux-aix-platforms

Command examples for starting integration nodes and servers, including options for specifying integration servers, applications, and message flows. Use from the command line on Windows, Linux, and AIX. Requires proper permissions and the integration node's name.

```shell
mqsistart INODE
```

```shell
mqsistart INODE -e intServer
```

```shell
mqsistart INODE --all-integration-servers
```

```shell
mqsistart INODE -e intServer -k testApp
```

```shell
mqsistart INODE -e intServer -k testApp -f testFlow
```

```shell
mqsistart --admin-host localhost --admin-port 7600 --application testApp
```

```shell
mqsistart --admin-host localhost --admin-port 7600 --application testApp --flow testFlow
```

--------------------------------

### InstallPlan output example

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=mt-troubleshooting-installation-issues-kubernetes

Example output of an InstallPlan resource when troubleshooting installation issues on Kubernetes. Shows the expected structure and fields.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: InstallPlan
metadata:
  creationTimestamp: 2021-04-30T17:08:21Z
  generateName: install-
  generation: 1
  labels:
    operators.coreos.com/ibm-appconnect.ace-fiona: ""
  managedFields:
  - apiVersion: operators.coreos.com/v1alpha1
    fieldsType: FieldsV1
    fieldsV1:
...
  name: install-lhrj8
  namespace: ace-fiona
  ownerReferences:
  - apiVersion: operators.coreos.com/v1alpha1
    blockOwnerDeletion: false
    controller: false
    kind: Subscription
    name: ibm-appconnect
    uid: 72b3e2ec-3133-420c-8d77-900fe0d31e80
  resourceVersion: "27531181"
  selfLink: /apis/operators.coreos.com/v1alpha1/namespaces/ace-fiona/installplans/install-lhrj8
  uid: f9eba56d-a4fb-4e33-ac50-1291062992e0
spec:
  approval: Automatic
  approved: true
  clusterServiceVersionNames:
  - couchdb-operator.v1.4.3
  - ibm-appconnect.v1.4.0
  generation: 1
status:
  bundleLookups:
  - catalogSourceRef:
      name: ibm-appconnect-catalog
      namespace: olm
    identifier: ibm-appconnect.v1.4.0
    path: ibmcom/appconnect-operator-bundle-k8s@sha256:0182ea715e390c9cac6dd666f72f2134c716af776018c344944b7618dede0344
    properties: '{"properties":[{"type":"olm.gvk","value":{"group":"appconnect.ibm.com","kind":"Configuration","version":"v1beta1"}},{"type":"olm.gvk","value":
{"group":"appconnect.ibm.com","kind":"Dashboard","version":"v1beta1"}},{"type":"olm.gvk","value":{"group":"appconnect.ibm.com","kind":"DesignerAuthoring",
"version":"v1beta1"}},{"type":"olm.gvk","value":{"group":"appconnect.ibm.com","kind":"IntegrationFlow","version":"v1beta1"}},{"type":"olm.gvk",
"value":{"group":"appconnect.ibm.com","kind":"IntegrationServer","version":"v1beta1"}},{"type":"olm.gvk","value":{"group":"appconnect.ibm.com","kind":"SwitchServer",
"version":"v1beta1"}},{"type":"olm.package","value":{"packageName":"ibm-appconnect","version":"1.4.0"}}]}'
    replaces: ibm-appconnect.v1.3.2
  - catalogSourceRef:
      name: operatorhubio-catalog
      namespace: olm
    identifier: couchdb-operator.v1.4.3
    path: quay.io/operatorhubio/couchdb-operator:v1.4.3
    properties: '{"properties":[{"type":"olm.gvk","value":{"group":"couchdb.databases.cloud.ibm.com","kind":"Backup","version":"v1"}},{"type":"olm.gvk",
"value":{"group":"couchdb.databases.cloud.ibm.com","kind":"Bucket","version":"v1"}},{"type":"olm.gvk","value":{"group":"couchdb.databases.cloud.ibm.com",
"kind":"CouchDBCluster","version":"v1"}},{"type":"olm.gvk","value":{"group":"couchdb.databases.cloud.ibm.com","kind":"Formation","version":"v1"}},
{"type":"olm.gvk","value":{"group":"couchdb.databases.cloud.ibm.com","kind":"FormationLock","version":"v1"}},{"type":"olm.gvk","value":
{"group":"couchdb.databases.cloud.ibm.com","kind":"Recipe","version":"v1"}},{"type":"olm.gvk","value":{"group":"couchdb.databases.cloud.ibm.com",
"kind":"RecipeTemplate","version":"v1"}},{"type":"olm.package","value":{"packageName":"couchdb-operator","version":"1.4.3"}}]}'
    replaces: couchdb-operator.v1.4.2
...
```

--------------------------------

### Get forecast action response example

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=apps-weather-company

Example response from the Get forecast action, showing weather data for the next 14 days (Agg1 through Agg14) starting from tomorrow. The response includes metrics like Gust, PrecipAmount, RelativeHumidity, Temperature, and WindSpeed for various local day periods.

```json
{
  "point": {
 "id": null,
 "lat": 51.03,
 "lon": -1.4
  },
  "aggs": [
 {
"Date": "2022-03-02",
"Gust": {
  "LOCAL_DAY": {
 "min": 7,
 "max": 7,
 "avg": 7
  },
  "LOCAL_DAYTIME": {
 "min": 7,
 "max": 7,
 "avg": 7
  },
  "LOCAL_NIGHTTIME": {
 "min": null,
 "max": null,
 "avg": null
  },
  "LOCAL_MORNING": {
 "min": null,
 "max": null,
 "avg": null
  },
  "LOCAL_AFTERNOON": {
 "min": 7,
 "max": 7,
 "avg": 7
  },
  "LOCAL_EVENING": {
 "min": null,
 "max": null,
 "avg": null
  },
  "LOCAL_OVERNIGHT": {
 "min": null,
 "max": null,
 "avg": null
  }
},
"PrecipAmount": {
  "LOCAL_DAY": {
 "min": 0,
 "max": 0.66,
 "avg": 0.2520833333333333
  },
  "LOCAL_DAYTIME": {
 "min": 0,
 "max": 0.45,
 "avg": 0.18916666666666668
  },
  "LOCAL_NIGHTTIME": {
 "min": 0,
 "max": 0.1,
 "avg": 0.02666666666666667
  },
  "LOCAL_MORNING": {
 "min": 0.2,
 "max": 0.45,
 "avg": 0.30833333333333335
  },
  "LOCAL_AFTERNOON": {
 "min": 0,
 "max": 0.12,
 "avg": 0.07
  },
  "LOCAL_EVENING": {
 "min": 0,
 "max": 0,
 "avg": 0
  },
  "LOCAL_OVERNIGHT": {
 "min": 0,
 "max": 0.1,
 "avg": 0.05333333333333334
  }
},
"RelativeHumidity": {
  "LOCAL_DAY": {
 "min": 88,
 "max": 98,
 "avg": 93.875
  },
  "LOCAL_DAYTIME": {
 "min": 88,
 "max": 98,
 "avg": 93
  },
  "LOCAL_NIGHTTIME": {
 "min": 90,
 "max": 97,
 "avg": 93.5
  },
  "LOCAL_MORNING": {
 "min": 92,
 "max": 98,
 "avg": 96.16666666666667
  },
  "LOCAL_AFTERNOON": {
 "min": 88,
 "max": 92,
 "avg": 89.83333333333333
  },
  "LOCAL_EVENING": {
 "min": 90,
 "max": 95,
 "avg": 91.33333333333333
  },
  "LOCAL_OVERNIGHT": {
 "min": 94,
 "max": 97,
 "avg": 95.66666666666667
  }
},
"Temperature": {
  "LOCAL_DAY": {
 "min": 279,
 "max": 282,
 "avg": 280.2916666666667
  },
  "LOCAL_DAYTIME": {
 "min": 280,
 "max": 282,
 "avg": 280.75
  },
  "LOCAL_NIGHTTIME": {
 "min": 279,
 "max": 281,
 "avg": 280
  },
  "LOCAL_MORNING": {
 "min": 280,
 "max": 281,
 "avg": 280.5
  },
  "LOCAL_AFTERNOON": {
 "min": 280,
 "max": 282,
 "avg": 281
  },
  "LOCAL_EVENING": {
 "min": 279,
 "max": 280,
 "avg": 279.6666666666667
  },
  "LOCAL_OVERNIGHT": {
 "min": 280,
 "max": 281,
 "avg": 280.3333333333333
  }
},
"WindSpeed": {
  "LOCAL_DAY": {
 "min": 3,
 "max": 4,
 "avg": 3.75
  },
  "LOCAL_DAYTIME": {
 "min": 3,
 "max": 4,
 "avg": 3.9166666666666665
  },
  "LOCAL_NIGHTTIME": {
 "min": 3,
 "max": 3,
 "avg": 3
  },
  "LOCAL_MORNING": {
 "min": 4,
 "max": 4,
 "avg": 4
  },
  "LOCAL_AFTERNOON": {
 "min": 3,
 "max": 4,
 "avg": 3.8333333333333335
  },
  "LOCAL_EVENING": {
 "min": 3,
 "max": 3,
 "avg": 3
  },
  "LOCAL_OVERNIGHT": {
 "min": 3,
 "max": 3,
 "avg": 3
  }
}
 },
...
 {
"Date": "2022-03-15",
"Gust": {
  "LOCAL_DAY": {
 "min": 7,
 "max": 10,
 "avg": 8.764705882352942
  },
  "LOCAL_DAYTIME": {
 "min": 7,
 "max": 10,
 "avg": 9
  },
  "LOCAL_NIGHTTIME": {
 "min": 8,
 "max": 9,
 "avg": 8.5
  },
  "LOCAL_MORNING": {
 "min": 7,
 "max": 10,
 "avg": 8.666666666666666
  },
  "LOCAL_AFTERNOON": {
 "min": 8,
 "max": 10,
 "avg": 9.333333333333334
  },
  "LOCAL_EVENING": {
 "min": 8,
 "max": 9,
 "avg": 8.333333333333334
  },
  "LOCAL_OVERNIGHT": {
 "min": 8,
 "max": 9,
 "avg": 8.75
  }
},
"PrecipAmount": {
  "LOCAL_DAY": {
 "min": 0,
 "max": 0.28,
 "avg": 0.14916666666666667
  },
  "LOCAL_DAYTIME": {
 "min": 0,
 "max": 0.2,
 "avg": 0.16666666666666666
  },
  "LOCAL_NIGHTTIME": {
 "min": 0,
 "max": 0.28,
 "avg": 0.14833333333333334
  },
  "LOCAL_MORNING": {
 "min": 0.2,
 "max": 0.2,
 "avg": 0.20000000000000004
  },
  "LOCAL_AFTERNOON": {
 "min": 0,
 "max": 0.2,
 "avg": 0.13333333333333333
  },
  "LOCAL_EVENING": {
 "min": 0,
 "max": 0.28,
 "avg": 0.1466666666666667
  },
  "LOCAL_OVERNIGHT": {
 "min": 0.1,
 "max": 0.2,
 "avg": 0.15
  }
},
"RelativeHumidity": {
  "LOCAL_DAY": {
 "min": 74,
 "max": 88,
 "avg": 82.58333333333333
  },
  "LOCAL_DAYTIME": {
 "min": 74,
 "max": 88,
 "avg": 79.25
  },
  "LOCAL_NIGHTTIME": {
 "min": 82,
 "max": 87,
 "avg": 85.41666666666667
  },
  "LOCAL_MORNING": {
 "min": 75,
 "max": 88,
 "avg": 82.33333333333333
  },
  "LOCAL_AFTERNOON": {
 "min": 74,
 "max": 80,
 "avg": 77.5
  },
  "LOCAL_EVENING": {
 "min": 74,
 "max": 80,
 "avg": 77.5
  },
  "LOCAL_OVERNIGHT": {
 "min": 82,
 "max": 87,
 "avg": 84.5
  }
},
"Temperature": {
  "LOCAL_DAY": {
 "min": 279,
 "max": 282,
 "avg": 280.5
  },
  "LOCAL_DAYTIME": {
 "min": 280,
 "max": 282,
 "avg": 281
  },
  "LOCAL_NIGHTTIME": {
 "min": 279,
 "max": 281,
 "avg": 280
  },
  "LOCAL_MORNING": {
 "min": 280,
 "max": 281,
 "avg": 280.5
  },
  "LOCAL_AFTERNOON": {
 "min": 280,
 "max": 282,
 "avg": 281
  },
  "LOCAL_EVENING": {
 "min": 279,
 "max": 280,
 "avg": 279.5
  },
  "LOCAL_OVERNIGHT": {
 "min": 280,
 "max": 281,
 "avg": 280.5
  }
},
"WindSpeed": {
  "LOCAL_DAY": {
 "min": 3,
 "max": 4,
 "avg": 3.75
  },
  "LOCAL_DAYTIME": {
 "min": 3,
 "max": 4,
 "avg": 3.9166666666666665
  },
  "LOCAL_NIGHTTIME": {
 "min": 3,
 "max": 3,
 "avg": 3
  },
  "LOCAL_MORNING": {
 "min": 4,
 "max": 4,
 "avg": 4
  },
  "LOCAL_AFTERNOON": {
 "min": 3,
 "max": 4,
 "avg": 3.8333333333333335
  },
  "LOCAL_EVENING": {
 "min": 3,
 "max": 3,
 "avg": 3
  },
  "LOCAL_OVERNIGHT": {
 "min": 3,
 "max": 3,
 "avg": 3
  }
}
 }
  ]
}
```

--------------------------------

### Configure database setup scripts in login profile

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=problems-resolving-when-using-databases

Add statements to the login profile of the user running the integration node to run database setup scripts at the start of every session. The server_name is defined in the sqlhosts file, typically the machine name, and the location of sqlhosts is set during installation.

```text
where server_name is defined in the file sqlhosts (the required value is typically the machine name), and the location of the file sqlhosts is set up as part of the installation process.
To configure your system to run this setup at the start of every session, add these statements to the login profile of the user that is going to run the integration node.
For more information, see Running database setup scripts before starting an integration node.
```

--------------------------------

### Example output listing deployable files and keywords

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=commands-mqsireadbar-command

Example response showing the list of deployable files and their defined keywords. The first line is the BAR file name, followed by each BAR entry with its timestamp and keyword/value pairs.

```plaintext
C:\test.bar
     BAR Entry: simpleflow.cmf (07/10/07 10:43:44)
          Author = Matt
          VERSION = v1.1
          Information = This flow simply removes messages from IN.Q

```

--------------------------------

### Example mqsisetdbparms command

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=17-configuring-kerberos-java

Example command using TESTNODE, MYREALM.EXAMPLE.COM, and default as the realm and server name.

```bash
mqsisetdbparms TESTNODE -n kerberos::MYREALM.EXAMPLE.COM::default 
-u myuser -p mypassword
```

--------------------------------

### Example oc get pods output

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=mt-troubleshooting-errors-in-app-connect-dashboard

Example output of oc get pods showing the Dashboard pod name and status.

```text
NAME                                                        READY   STATUS      RESTARTS   AGE
...
feedee-dashbd-dash-6f8d5bcb74-869xp                         2/2     Running     3          4d5h
...

```

--------------------------------

### Sample output of listing configurations

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=dtiir-scenario-1-deploying-toolkit-integration-from-red-hat-openshift-cli-2

Example output showing the configuration object and its age.

```bash
NAME                                          AGE
github-barauth                                7m48s
```

--------------------------------

### Publish command example for match started

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=messages-publish-message

Example NameValueData for a Publish command message sent by the match simulator to indicate that a match has started.

```xml
<psc>
  <Command>Publish</Command>
  <Topic>Sport/Soccer/Event/MatchStarted</Topic>
 </psc>
```

--------------------------------

### XML timeout request message example

Source: https://www.ibm.com/docs/en/app-connect/13.0.x?topic=messages-example-xml-timeout-request-message

Use this XML message to set a timeout with an action of SET, an identifier of TenTimes, a start date of TODAY, a start time of NOW, an interval of 10, a count of 10, and flags for ignoring missed and allowing overwrite set to TRUE. The format is XML but any format supported by an installed parser can be used.

```xml
<TimeoutRequest>
  <Action>SET</Action>
  <Identifier>TenTimes</Identifier>
  <StartDate>TODAY</StartDate>
  <StartTime>NOW</StartTime>
  <Interval>10</Interval>
  <Count>10</Count>
  <IgnoreMissed>TRUE</IgnoreMissed>
  <AllowOverwrite>TRUE</AllowOverwrite>
</TimeoutRequest>
```
Tokens:
Raw