Logging Interface Access

Thank you all for your advice.

Although I initially lacked some information, ultimately, I would like to calculate usage rates for each application from the log data. Therefore, I prefer to save the logs as records rather than text files. Additionally, since I need to calculate usage rates by organization, user information is also necessary.

Hence, I believe the approach Mike has already implemented is the closest to what I need.

I implemented the Web API as shown below. While it returns an image file as the response, it seems that neither a!startProcess, a!writeToDataStoreEntity, nor a!writeRecords functions are executing.

I implemented it using the GET method to return the image file. Is there anything else I should do?

a!localVariables(

  local!codea: 200,
  local!codeb: 200,
  local!codec: 200,

  local!a: a!writeToDataStoreEntity(
    dataStoreEntity: cons!XLOG_EVENT,
    valueToStore: 'type!{urn:com:appian:types:XLOG}XLOG_RT_EVENT'(
      timestamp: now(),
      appName: "Application Name",
      functionName: "Function Name",
      user: tostring(loggedInUser())
    ),
    onSuccess: a!save(local!codea, 201),
    onError: a!save(local!codea, 202)
  ),

  local!b: a!writeRecords(
    records: 'recordType!{}XLOG rtEvent'(
      'recordType!{}XLOG rtEvent.fields.{}timestamp': now(),
      'recordType!{}XLOG rtEvent.fields.{}appName': "Application Name RT",
      'recordType!{}XLOG rtEvent.fields.{}functionName': "Function Name RT",
      'recordType!{}XLOG rtEvent.fields.{}user': tostring(loggedInUser())
    ),
    onSuccess: a!save(local!codeb, 201),
    onError: a!save(local!codeb, 202)
  ),

  local!c: a!startProcess(
    processModel: cons!XLOG_pmTest,
    onSuccess: a!save(local!codec, 201),
    onError: a!save(local!codec, 202)
  ),

  local!d: a!richTextDisplayField(
    value: "code: " & local!codea & " " & local!codeb& " " & local!codec
  ),

  a!httpResponse(
    statusCode: local!codec,
    headers: {
      a!httpHeader(name: "Content-Type", value: "image/png"),
      a!httpHeader(name: "Cache-Control", value: "no-store, no-cache, must-revalidate, max-age=0"),
      a!httpHeader(name: "Pragma", value: "no-cache")
    },
    body: cons!XLOG_PNG
  )
)

NOTE:In this sample code, these local variables are only for debbuging.

You web API structure as per this sample code doesnt seem right! the smart servcies should not be related to a local variable. 

Please check the documentation for steps/considerations. In you use case you can create a web API that has a!startProcess() in it. Whatever you are trying to accomplish in a!writeRecord() and a!writeToDataStoreEntity() should be moved inside the process. 

The https Response configuration would also come within the onSuccess or onError of a!startProcess() configuration.

Dear Harsha,

Thank you for your advice.

I reviewed the documentation again, modified my code and confirmed that a!startProcess() and a!writeRecord can be executed.

However, as mentioned in my initial post,
(1) Create a Web API on Appian that returns an image as the response and simultaneously saves a log.
(2) Place an image on the target interface and set the endpoint of the Web API created in (1) as the image source.
(3) As a result, when the interface is opened, the Web API in (1) is called, and the log is recorded.

Since we intend to implement this behavior, the Web API must be implemented with the GET method.

As a result, we encountered the error:
"Smart Services cannot be executed in Web APIs that have a method of 'GET'."

and cannot proceed further.

Is there any way to work around this?

Hi Keizo,

It is not a hard requirement to write records from a Process Model. For APIs that are intended to be called frequently, it is better in practice to call a!writeRecords() from the API object itself to remove the overhead and latency of starting a process.

Keep in mind that, if enabled in the record types, you can write multiple related records at once if they are sync'ed records and have a relationship defined. For me, this has worked for 99% of my use cases. For the other 1%, I did something like the following: 

a!writeRecords(
    records: {Record A and its embedded related records}
    onSuccess: a!writeRecords(
        records: {Record not related to record A}
        onSuccess: a!httpResponse()
        onError: a!httpResponse()
    ),
    onError: a!httpResponse()
)

Thanks Jesse.

I understood that. But the error "Smart Services cannot be executed in Web APIs that have a method of 'GET'." is still remaining...

Thanks Jesse.

I understood that. But the error "Smart Services cannot be executed in Web APIs that have a method of 'GET'." is still remaining...