a!latestHealthCheck() Function

Function

a!latestHealthCheck()

Returns the start time, run status, zip file, and report for the latest Health Check run.

Returns

HealthCheckOutput

Usage considerations

Function requirements

• To use this function, Health Check must be configured within the Admin Console.

• To call this function, a user must be either a system administrator or member of the Health Check Viewers group. Only system administrators will be able to see the document ID for the zip file returned as part of the HealthCheckOutput.

• Using this function in a process model with autoscale enabled may result in degraded site or application performance. It should be used with caution and tested thoroughly before deploying it for real-world use. When the application is in production, use the Autoscaled Process Activity tab to monitor how the process performs at scale.

Examples

Function Results

You can copy and paste this example into the Expression Rule Designer to see how it works.

1
=a!latestHealthCheck()

Returns the following:

1
2
3
4
[startDateTime=04/25/2020 16:18:38 GMT+00:00,
  runStatus=COMPLETED, 
  zip=[Document:1408], 
  report=[Document:1409]]

Displaying Health Check Results in an Interface

To experiment with examples, copy and paste the expression into an interface object.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
=a!richTextDisplayField(
  value: {
    a!richTextItem(
      text: "Status: ",
      style: "STRONG"
    ), 
    a!richTextItem(
      text: a!latestHealthCheck().runStatus
    ),
    "; ",
    if(
      a!latestHealthCheck().runStatus = "COMPLETED",
      a!richTextItem(
        text: "Latest Report",
        linkStyle: "STANDALONE",
        link: a!documentDownloadLink(document: a!latestHealthCheck().report)
      ),
      a!richTextItem(
        text: "No report available",
      )
    )
  }
)

Feature compatibility

Feedback