Versions Compared

Version Old Version 3 New Version Current
Changes made by

Rohan Dhanwade (Deactivated)

Rohan Dhanwade (Deactivated)

Saved on

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.

ExpandtitleAiMap

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-
aiMap
portal
Response

{
"ac-

aiMap

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

4.1.1

6f884086"
}]
}



Expand
titleLicense REST API Status


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

{
"ac-rEST-aPI-

license

publisher": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name":

"Image Tag",
"value": "ce8a05b"
},

"Image Tag",
"value": "5835eb4"
}]
}



Expand
titleRuntime (Process Execution) Status


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

{
"ac-runtime": [{
"color": "#00cc00",
"name": "Expiry DateStatus",
"value": "Valid till Sep 23, 2022Running"
}, {
"name": "Product VersionNumber of Pods Running",
"value": "4.1"2
}, {
"name": "DetailsImage Tag",
"value": "linka3b8764"
}]
}

Expand
titleScheduler Status
scheduler": [6]-0:  
{
"color #00cc00 Status 
-1:  
{ Thread Count 50
-2:  
 "Thread Priority" ""
-3:  
 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>/rest/diagnostics?component=scheduler
Response

, {
"

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":

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

{

"backend-database": [2]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "Type"
"value": "MySQL"
}"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
titleLog Database SOAP API Status


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

{
"

log-database

ac-sOAP-aPI-publisher":

 

[

10]-0:  

{
"color":

 

"#00cc00",
"name":

 

"

Available

Status",
"value":

 

"

Yes

Running"
}


-1:  

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

 

"

Type

Image Tag",
"value":

 

"

MySQL

e9f5851"
}]

-2:  

}



Expand
titleWebapp Gateway Status


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

{
"

name

ac-webapp-gateway":

 "Process Flow Logs"

[{
"

value

color":

 

"

713305 Records"
}
-3:  
{

#00cc00",
"name":

 

"

Event Logs

Status",
"value":

 

"

102468 Records

Running"
}


-4:  

, {
"name":

 "System Logs"

"Number of Pods Running",
"value":

 "36066 Records"

1
}


-5:  

, {
"name":

 

"

Audit Trail

Image Tag",
"value":

 "5156 Records"
}
-6:  

"4.1.1"
}]
}



Expand
titleWebrunner Status


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

{
"

name

ac-webrunner":

 "B2B Logs"

[{
"

value

color":

 

"

0 Records"
}
-7:  
{

#00cc00",
"name":

 

"

Log Cleanup

Status",
"value":

 

"

 

Running"
}


-8:  

, {
"name":

 "Log Cleanup Execution Time"

"Number of Pods Running",
"value":

 " "

1
}


-9:  

, {
"name":

 "Next Scheduled Execution Time of Log Cleanup"

"Image Tag",
"value":

 "12/28/2017 03:00:00

"3064abe"
}]
}



Expand
titleProcess Execution Archive Log Database Status


processexecution10
"color": "#00cc00"RabbitMQ StatusRunningConcurrent Process Flow Execution Limit  (Shared Queue)5Running Process Flows0Waiting Flows0Queued Process FlowsTotal Active Process Flow36Logging Level"
"warning-message": "In production, the Logging Level should be set as ERROR for better performance.ERROR: 27, INFO: 7, DEBUG: 2Activity Logging Retentionwarning-messageIn 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"
}
-8
APIhttps://<ipaddress/domain>:<port>/rest<port>/diagnostics?component=processarchive-log-executiondatabase
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:  
{
"namecolor": "Repository Retention#00cc00"
"warning-messagename": "In production, the Repository File Retention field should be set as DELETE for better performance.Available"
"value": "DELETE: 0, DELETE ON SUCCESS: 3, DONT DELETE: 33Yes"
}
-91:  
{
"name": "JDO CacheType"
"value": "EnabledMySQL"
}
}



Expand
titleArchive Log Database Status


{

"archive-log-database": [8]-0Separate from Log DatabaseNo1color#00cc00"AvailableYes2TypeMySQL3Process Flow Logs1018 45Archival 6Archival 7 Archival Cleanup 
APIhttps://<ipaddress/domain>:<port>/rest/diagnostics?component=archive-log-database
Response

{

"log-database

Response

": 
[10]-0:  
{
"color": "#00cc00"
"name": "Available"
"value": "Yes"
}
-1:  
{
"name": "

Type"
"value": "

MySQL"
}
-

2:  
{
"name": "Process Flow Logs"
"

value": "

713305 Records"
}
-3:  
{
"name": "

Event Logs"
"value": "

102468 Records"
}
-

4:  
{
"name": "

System Logs"
"value": "

36066 Records"
}
-

5:  
{
"name": "

Audit Trail"
"value": "

5156 Records"
}
-

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


APIhttps://<ipaddress/domain>:<port>/diagnostics?component=all
Response

{
"ac-aiMap": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "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": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "242b94a"
}],
"ac-autoscaler": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "b7c488c"
}],
"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"
}],
"ac-license": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 2
}, {
"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"
}],
"ac-listener": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "06cfb09"
}],
"ac-portal": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"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"
}, {
"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"
}],
"ac-sOAP-aPI-publisher": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "e9f5851"
}],
"ac-webapp-gateway": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "4.1.1"
}],
"ac-webrunner": [{
"color": "#00cc00",
"name": "Status",
"value": "Running"
}, {
"name": "Number of Pods Running",
"value": 1
}, {
"name": "Image Tag",
"value": "3064abe"
}],
"archive-log-database": [{
"name": "Separate from Log Database",
"value": "No"
}, {
"color": "#00cc00",
"name": "Available",
"value": "Yes"
}, {
"name": "Type",
"value": "Oracle"
}, {
"name": "Process Flow Logs",
"value": "12693 Records"
}, {
"name": "B2B Logs",
"value": "154 Records"
}, {
"name": "SAP Logs",
"value": "0 Records"
}, {
"error-message": "Click here to troubleshoot.",
"name": "Archival Log Cleanup Status",
"value": "Error"
}, {
"display-type": "table",
"name": "Metadata",
"value": []
}, {
"name": "Archival Log Cleanup Execution Time",
"value": "08/09/2022 07:52:41"
}, {
"name": "Last Successful Execution Time of Archival Log Cleanup",
"value": "08/09/2022 07:46:51"
}, {
"name": "Next Scheduled Execution Time of Archival Log Cleanup ",
"value": "08/10/2022 03:00:00"
}],
"backend-database": [{
"color": "#00cc00",
"name": "Available",
"value": "Yes"
}, {
"name": "Type",
"value": "Oracle"
}],
"log-database": [{
"color": "#00cc00",
"name": "Available",
"value": "Yes"
}, {
"name": "Type",
"value": "Oracle"
}, {
"name": "Process Flow Logs",
"value": "1591 Records"
}, {
"name": "Event Logs",
"value": "1585 Records"
}, {
"name": "System Logs",
"value": "1462 Records"
}, {
"name": "Audit Trail",
"value": "111 Records"
}, {
"name": "B2B Logs",
"value": "60 Records"
}, {
"name": "SAP Logs",
"value": "0 Records"
}, {
"error-message": "Click here to troubleshoot.",
"name": "Log Cleanup Status",
"value": "Error"
}, {
"display-type": "table",
"name": "Metadata",
"value": []
}, {
"name": "Log Cleanup Execution Time",
"value": "08/09/2022 07:48:23"
}, {
"name": "Last Successful Execution Time of Log Cleanup",
"value": "07/13/2022 03:35:16"
}, {
"name": "Next Scheduled Execution Time of Log Cleanup",
"value": "08/10/2022 03:00:00"
}]
}




Panel
borderStylesolid
titleYou may be interested in...
What is new
Best practices
Training guides
/wiki/spaces/AC41/pages/15991686
Adeptia Connect APIs
Adeptia security report