Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

You can use APIs to view the status of various sections of System Console without visiting Adeptia Connect.

Use any REST client with the following information as an input to process your request.

Component

Information type

REST URL

Refer to the URLs described later in this section for various sections of System Console. Replace <ipaddress/domain>:<port> with the relevant values in the URL.

IP Address, Domain, and Port address should be of the computer where Adeptia Connect is hosted.

Method TypeGETAuthorization TypeBasic HeaderAuthorizationUser ID & PasswordAdministrator or Group Administrator User ID and Password for Base 64 encoding.

APIs

Click the relevant section to find API and expected response format.

ExpandtitleLicense

You can use APIs to view the status of various sections of System Console without visiting Adeptia Connect.

Use any REST client with the following information as an input to process your request.

Component

Information type

REST URL

Refer to the URLs described later in this section for various sections of System Console. Replace <ipaddress/domain>:<port> with the relevant values in the URL.

IP Address, Domain, and Port address should be of the computer where Adeptia Connect is hosted.

Method TypeGET
Authorization TypeBasic 
HeaderAuthorization
User ID & PasswordAdministrator or Group Administrator User ID and Password for Base 64 encoding.

APIs

Click the relevant section to find API and expected response format.

Expand
titleAiMap Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-aiMap

Response

{
"ac-aiMap": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "4.1.1"
}]
}



Expand
titleAPI Gateway Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-aPI-publisher-gateway

Response

{
"ac-aPI-publisher-gateway": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "4.1.1"
}]
}



Expand
titleArchival And Cleanup Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-archival-and-cleanup

Response

{
"ac-archival-and-cleanup": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 2
}, {
"name": "Image Tag",
"value": "242b94a"
}]
}



Expand
titleAutoscaler Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-autoscaler

Response

{
"ac-autoscaler": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "b7c488c"
}]
}



Expand
titleEvent (Scheduler) Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-event
Response

{
"ac-event": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "b428f9a"
}, {
"color": "#00cc00",
"name": "Scheduler Status",
"value": "Running"
}, {
"name": "Thread Count",
"value": "50"
}, {
"name": "Thread Priority",
"value": "5"
}, {
"name": "Misfire Threshold",
"value": "60000 miliseconds"
}, {
"name": "Total Active Events",
"value": "24"
}, {
"name": "Misfired Events in Last 24 Hours",
"value": "0"
}]
}



Expand
titleLicense Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-license

Response

{
"ac-license": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "ce8a05b"
}, {
"color": "#00cc00",
"name": "Expiry Date",
"value": "Valid till Sep 23, 2022"
}, {
"name": "Product Version",
"value": "4.1"
}, {
"name": "Details",
"value": "link"
}]
}



Expand
titleListener Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-listener
Response

{
"ac-listener": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "06cfb09"
}]
}



Expand
titlePortal Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-portal
Response

{
"ac-portal": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "6f884086"
}]
}



Expand
titleREST API Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-rEST-aPI-publisher
Response

{
"ac-rEST-aPI-publisher": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "5835eb4"
}]
}



Expand
titleRuntime (Process Execution) Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-runtime
Response

{
"ac-runtime": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 2
}, {
"name": "Image Tag",
"value": "a3b8764"
}, {
"display-type": "table",
"name": "Deployment Information",
"value": [{
"Deployment Name": "test-deployment",
"Running Pod Count": 1
}]
}, {
"color": "#00cc00",
"name": "RabbitMQ Status",
"value": "Running"
}, {
"name": "Concurrent Process Flow Execution Limit (Shared Queue)",
"value": 5
}, {
"name": "Running Process Flows",
"value": "0"
}, {
"name": "Waiting Process Flows",
"value": "0"
}, {
"name": "Queued Process Flows",
"value": "0"
}, {
"name": "Total Active Process Flow",
"value": 88
}, {
"name": "Logging Level",
"warning-message": "In production, the Logging Level should be set as ERROR for better performance.",
"value": "ERROR: 86, \tINFO: 2, \tDEBUG: 0"
}, {
"name": "Activity Logging Retention",
"warning-message": "In production, the Activity Logging Retention field should be set as NO LOGGING for better performance.",
"value": "NO LOGGING: 4, \tDELETE ON SUCCESS: 8, \tDONT DELETE: 76"
}, {
"name": "Repository Retention",
"warning-message": "In production, the Repository File Retention field should be set as DELETE for better performance.",
"value": "DELETE: 1, \tDELETE ON SUCCESS: 4, \tDONT DELETE: 71"
}, {
"name": "JDO Cache",
"value": "Enabled"
}]
}



Expand
titleSOAP API Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-sOAP-aPI-publisher
Response

{
"ac-sOAP-aPI-publisher": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "e9f5851"
}]
}



Expand
titleWebapp Gateway Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-webapp-gateway
Response

{
"ac-webapp-gateway": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "4.1.1"
}]
}



Expand
titleWebrunner Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=ac-webrunner
Response

{
"ac-webrunner": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "3064abe"
}]
}



Expand
titleArchive Log Database Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=archive-log-database
Response

{

"archive-log-database": [8]-0:  
{
"name": "Separate from Log Database"
"value": "No"
}
-1:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-2:  
{
"name": "Type"
"value": "MySQL"
}
-3:  
{
"name": "Process Flow Logs"
"value": "1018 Records"
}
-4:  
{
"name": "B2B Logs"
"value": "0 Records"
}
-5:  
{
"name": "Archival Log Cleanup Status"
"value": " "
}
-6:  
{
"name": "Archival Log Cleanup Execution Time"
"value": " "
}
-7:  
{
"name": "Next Scheduled Execution Time of Archival Log Cleanup "
"value": "12/28/2017 03:00:00"
}
}



Expand
titleBackend Database Status


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=backend-database
Response

{

"backend-database": [2]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
}



Expand
titleLog Database Status


Response
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=licenseResponselog-database
Response
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=scheduler

{

"log-database": 
[10]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}
-2:  
{
"licensename":   {"Process Flow Logs"
"colorvalue": "#00cc00"713305 Records"
}
-3:  
{
"name": "StatusEvent Logs"
"value": "Valid till Dec 8, 2022 "102468 Records"
}  
-4:  
{
"name": "

Product Version

System Logs"
"value": "

4.0

36066 Records"
}  
-5:  
{
"name": "

Details

Audit Trail"
"value": "

link

5156 Records"
}}

Expand
titleScheduler Status
scheduler6]-0:  
{
"color[#00cc00"
Running1Thread Count502Thread Priority5"
}
-3:  
{

-6:  
{
"

name": 

"B2B Logs"
"value": "

0 Records"
}
-7:  
{
"name": "Log Cleanup Status"
"value": "

 "
}
-

8:  
{
"name": "

Log Cleanup Execution Time"
"value": "

 "
}
-

9:  
{
"name": "

Next Scheduled Execution Time of Log Cleanup"
"value": "

12/28/2017 03:00:00"
}
}



Expand
titleStatus of All Sections of System Console


 Misfire Threshold 60000 miliseconds
-4:  
 "Total Active Events" "40"
-5:  
 "Misfired Events in Last 24 Hours"
"warning-message": "63 events have misfired. This may lead to loss of data while processing. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to know how to handle misfired events."
"value": "63"
"threshold-crossed": true
}
}
APIhttps://<ipaddress/domain>:<port>/diagnostics?component=all
Response

{
"ac-aiMap": [{
"color": "#00cc00",
"name":

"

Status",
"value":

"

Running"
}

, {
"name":

"Number of Pods Running",
"value":

1
}

, {
"name":

Expand
titleBackend Database Status
APIhttps:/<ipaddress/domain>:<port>/rest/diagnostics?component=backend-database
Response

{

"backend-database": [2]-0:  
"Image Tag",
"value": "4.1.1"
}],
"ac-aPI-publisher-gateway": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "4.1.1"
}],
"ac-archival-and-cleanup": [{
"color":   "#00cc00",
"name":   "AvailableStatus",
"value":   "YesRunning"
}
-1:  
, {
"name":   "TypeNumber of Pods Running",
"value":  "MySQL"
}
}

Expand
titleLog Database Status
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=log-database
Response

{

"log-database": 
[10]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"1
}, {
"name": "Image Tag",
"value": "242b94a"
}],
"ac-autoscaler": [{
"color": "#00cc00",
"name": "Status",
"value":   "MySQLRunning"
}
-2:  
, {
"name":  "Process Flow Logs""Number of Pods Running",
"value":  "713305 Records"1
}
-3:  
, {
"name":   "Event LogsImage Tag",
"value":   "102468 Recordsb7c488c"
}],
"ac-4event":  
{[{
"color": "#00cc00",
"name":   "System LogsStatus",
"value":   "36066 RecordsRunning"
}
-5:  
, {
"name":  "Audit Trail""Number of Pods Running",
"value":  "5156 Records"1
}
-6:  
, {
"name":   "B2B LogsImage Tag",
"value":   "0 Recordsb428f9a"
}
-7:  
{
, {
"color": "#00cc00",
"name":   "Log Cleanup Scheduler Status",
"value":   " Running"
}
-8:  
, {
"name":  "Log Cleanup Execution Time""Thread Count",
"value":   " 50"
}
-9:  
, {
"name":  "Next Scheduled Execution Time of Log Cleanup""Thread Priority",
"value":  "12/28/2017 03:00:00"
}
}

Expand
titleProcess Execution Status
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=process-execution
Response

{

"process-execution": [10]-0:  
{
"color": "#00cc00""5"
}, {
"name": "Misfire Threshold",
"value": "60000 miliseconds"
}, {
"name": "Total Active Events",
"value": "24"
}, {
"name":  "RabbitMQ Status""Misfired Events in Last 24 Hours",
"value":   "Running0"
}],
"ac-1license":  
{[{
"color": "#00cc00",
"name":  "Concurrent Process Flow Execution Limit  (Shared Queue)""Status",
"value":  5"Running"
}
-2:  
, {
"name":  "Running Process Flows""Number of Pods Running",
"value":  "0"2
}
-3:  
, {
"name":   "Waiting Process FlowsImage Tag",
"value":   "0ce8a05b"
}
-4:  
{
, {
"color": "#00cc00",
"name":   "Queued Process FlowsExpiry Date",
"value":  "0"Valid till Sep 23, 2022"
}
-5:  
, {
"name":  "Total Active Process Flow""Product Version",
"value":  36"4.1"
}
-6:  
, {
"name":  "Logging Level"
"warning-message": "In production, the Logging Level should be set as ERROR for better performance.""Details",
"value":  "ERROR: 27, INFO: 7, DEBUG: 2"link"
}],
"ac-7listener":  
[{
"namecolor":   "Activity Logging Retention#00cc00",
"warning-messagename":  "Status"In production, the Activity Logging Retention field should be set as NO LOGGING for better performance."
"value":  "NO LOGGING: 0, DELETE ON SUCCESS: 25, DONT DELETE: 11"Running"
}
-8:  
, {
"name":  "Repository Retention"
"warning-message": "In production, the Repository File Retention field should be set as DELETE for better performance.""Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value":  "DELETE: 0, DELETE ON SUCCESS: 3, DONT DELETE: 33"06cfb09"
}],
"ac-9portal":  
{[{
"color": "#00cc00",
"name":   "JDO CacheStatus",
"value":   "EnabledRunning"
}
}

Expand
titleArchive Log Database Status
archive-log-database": [8]-0:  
 "Separate from Log Database" No-1:  
  Available Yes
-2:  
 Type "MySQL"
-3:  
 Process Flow Logs 1018 Records4  
{
"name": "B2B Logs"
"value": "0 Records"
}
-5:  
{ Archival Log Cleanup   
-6:  
 "Archival Log Cleanup Execution Time" " "
-7:  
 "Next Scheduled Execution Time of Archival Log Cleanup " "12/28/2017 03:00:00
}
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=archive-log-database
Response

, {
"

name": "Number of Pods Running",
"value": 2
}, {
"name":

"Image Tag",
"value":

"

6f884086"
}],

"ac-rEST-aPI-publisher": [{
"color":

"#00cc00",
"name":

"

Status",
"value":

"

Running"
}

, {
"name":

"

Number of Pods Running",
"value":

1
}

, {
"name":

"

Image Tag",
"value":

"

5835eb4"
}],
"ac-

runtime":

[{
"color": "#00cc00",
"name":

"

Status",
"value":

"

Running"
}

, {
"name":

"Number of Pods Running",
"value":

2
}

, {
"name":

"Image Tag",
"value":

"a3b8764"
}

Expand
titleStatus of All Sections of System Console
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=all
Response

{

"license":   , {
"display-type": "table",
"name": "Deployment Information",
"value": [{
"Deployment Name": "test-deployment",
"Running Pod Count": 1
}]
}, {
"color": "#00cc00",
"name": "RabbitMQ Status",
"value": "Valid till Dec 8, 2022Running"
}  , {
"name": "

Product Version"

Concurrent Process Flow Execution Limit (Shared Queue)",
"value":

"4.0"

5
}  , {
"name": "

Details

Running Process Flows",
"value": "

link

0"
}-"backend-database": [2]-0:  
{
"color": "#00cc00", {
"name":   "AvailableWaiting Process Flows",
"value":   "Yes0"
}
-1:  
, {
"name":   "TypeQueued Process Flows",
"value":   "MySQL0"
}, {
- "scheduler": [6]-0:  
name": "Total Active Process Flow",
"value": 88
}, {
"colorname":   "#00cc00Logging Level",
"namewarning-message":  "Status""In production, the Logging Level should be set as ERROR for better performance.",
"value":  "Running"ERROR: 86, \tINFO: 2, \tDEBUG: 0"
}
-1:  
{
"name": "Thread Count", {
"name": "Activity Logging Retention",
"warning-message": "In production, the Activity Logging Retention field should be set as NO LOGGING for better performance.",
"value":  "50"NO LOGGING: 4, \tDELETE ON SUCCESS: 8, \tDONT DELETE: 76"
}
-2:  
, {
"name":   "Thread PriorityRepository Retention",
"value": "5"
}
-3:  
{
"name": "Misfire Threshold"warning-message": "In production, the Repository File Retention field should be set as DELETE for better performance.",
"value":  "60000 miliseconds"DELETE: 1, \tDELETE ON SUCCESS: 4, \tDONT DELETE: 71"
}
-4:  
, {
"name":   "Total Active EventsJDO Cache",
"value":   "38Enabled"
}],
-5:  
{ "ac-sOAP-aPI-publisher": [{
"color": "#00cc00",
"name":  "Misfired Events in Last 24 Hours"
"warning-message": "64 events have misfired. This may lead to loss of data while processing. <a href="https://docs.adeptia.com/display/AS/Troubleshooting" target="_blank">Click here</a> to know how to handle misfired events."
"value": "64"
"threshold-crossed": true
}
-"process-execution": [10]-0:  
"Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "e9f5851"
}],
"ac-webapp-gateway": [{
"color":   "#00cc00",
"name":   "RabbitMQ Status",
"value":   "Running"
}
-1:  
, {
"name":  "Concurrent Process Flow Execution Limit""Number of Pods Running",
"value":  51
}
-2:  
, {
"name":   "Running Process FlowsImage Tag",
"value":   "04.1.1"
}
-3:  
{
"name": "Waiting Process Flows"
"value": "0"
}
-4:  
{],
"ac-webrunner": [{
"color": "#00cc00",
"name":   "Queued Process FlowsStatus",
"value":   "0Running"
}
-5:  
, {
"name":  "Total Active Process Flow""Number of Pods Running",
"value":  361
}
-6:  
, {
"name":   "Logging LevelImage Tag",
"warning-messagevalue":  "In production, the Logging Level should be set as ERROR for better performance."
"value": "ERROR: 27, INFO: 7, DEBUG: 2"
}
-7:  
{
"name": "Activity Logging Retention"
"warning-message": "In production, the Activity Logging Retention field should be set as NO LOGGING for better performance.""3064abe"
}],
"archive-log-database": [{
"name": "Separate from Log Database",
"value": "No"
}, {
"color": "#00cc00",
"name": "Available",
"value":  "NO LOGGING: 0, DELETE ON SUCCESS: 25, DONT DELETE: 11"Yes"
}
-8:  
, {
"name":   "Repository RetentionType",
"warning-messagevalue":  "In production, the Repository File Retention field should be set as DELETE for better performance.""Oracle"
}, {
"name": "Process Flow Logs",
"value":  "DELETE: 0, DELETE ON SUCCESS: 3, DONT DELETE: 33"12693 Records"
}
-9:  
, {
"name":   "JDO CacheB2B Logs",
"value":   "Enabled154 Records"
}
-"log-database":[10]-0:  
{
"color": "#00cc00", {
"name": "SAP Logs",
"value": "0 Records"
}, {
"error-message": "Click here to troubleshoot.",
"name":   "AvailableArchival Log Cleanup Status",
"value":   "YesError"
}, {
"display-1:  
{type": "table",
"name":   "TypeMetadata",
"value": "MySQL"
}
-2:  
: []
}, {
"name":  "Process Flow Logs""Archival Log Cleanup Execution Time",
"value":  "713312 Records"08/09/2022 07:52:41"
}
-3:  
, {
"name":  "Event Logs""Last Successful Execution Time of Archival Log Cleanup",
"value":  "102478 Records"08/09/2022 07:46:51"
}
-4:  
, {
"name":  "System Logs""Next Scheduled Execution Time of Archival Log Cleanup ",
"value":  "36082 Records"08/10/2022 03:00:00"
}],
"backend-5database":  
{[{
"color": "#00cc00",
"name":   "Audit TrailAvailable",
"value":   "5165 RecordsYes"
}
-6:  
, {
"name":   "B2B LogsType",
"value":   "0 RecordsOracle"
}],
"log-7database":  
{[{
"color": "#00cc00",
"name":   "Log Cleanup StatusAvailable",
"value":   " Yes"
}
-8:  
, {
"name":   "Log Cleanup Execution TimeType",
"value":   " Oracle"
}
-9:  
, {
"name":  "Next Scheduled Execution Time of Log Cleanup""Process Flow Logs",
"value":  "12/28/2017 03:00:00"
}
-"archive-log-database": [8]-0:  
"1591 Records"
}, {
"name": "Event Logs",
"value": "1585 Records"
}, {
"name":  "Separate from Log Database""System Logs",
"value":   "No1462 Records"
}
-1:  
{
"color": "#00cc00", {
"name": "Audit Trail",
"value": "111 Records"
}, {
"name":   "AvailableB2B Logs",
"value":   "Yes60 Records"
}
-2:  
, {
"name":   "TypeSAP Logs",
"value":   "MySQL0 Records"
}, {
"error-3:  
{message": "Click here to troubleshoot.",
"name":  "Process Flow Logs""Log Cleanup Status",
"value":   "1018 RecordsError"
}, {
"display-4:  
{
type": "table",
"name":   "B2B LogsMetadata",
"value":  "0 Records"[]
}
-5:  
, {
"name":   "Archival Log Cleanup StatusExecution Time",
"value":  " "08/09/2022 07:48:23"
}
-6:  
, {
"name":   "Archival Last Successful Execution Time of Log Cleanup Execution Time",
"value":  " "07/13/2022 03:35:16"
}
-7:  
, {
"name":   "Next Scheduled Execution Time of Archival Log Cleanup Cleanup",
"value":   "1208/2810/2017 2022 03:00:00"
}
}
}
}]
}