Newer Version Available

This content describes an older version of this product. View Latest

Compliance Control Log Value Input

Input representation of the compliance control logs.
JSON example
1[
2  {
3  "controlVersionApiName": "LicenseCheckControl_V1",  // change to controlVersionAPIName
4  "isCompliant": true, // required
5  "inContextOf": "001xx0000ABCDE", // required, its a valid salesforce record
6  "status": "SUCCESS", // required ( Static enum )
7  "evaluationTime": "2022-10-31T09:00:00.594Z", // optional
8  "businessContextAndEvidence": { // optional
9  "clientId": "001Z9000002G3ygIAC",
10  "advisorId": "005xx0000000000001",
11  "productId": "00Pxx0000000000001",
12  "acceptableRisk": "true",
13  "productRisk": "85"
14  },
15  "complianceMessage": "Agent has an active license.", //optional
16  "transactionKey": "txn1234567890abcde", // optional , Customer generated
17  "errorId": "123", // optional
18  "errorMessage": "", // optional
19  "businessOperationsProcessApiName": "0022..." // optional
20  }
21]
Properties
Name Type Description Required or Optional Available Version
businessContext​AndEvidence Map<String,​ ComplianceLogging​BusinessContext​EvidenceValueInput> JSON object with name-value pairs that store information on the business context and evidence used in the evaluation.

The maximum size for name is 100 characters and maximum size for value is 1024 characters.

Optional 64.0
businessOperations​ProcessApiName String API name of the business operations process. Optional 64.0
compliance​Message String Reason for a control failure or passed compliance. For example, the interest rate exceeds the maximum rate for veterans.

Maximum length is 1024 characters.

Optional 64.0
controlVersion​ApiName String API name of the control version. Required 64.0
errorId String Error related to an evaluation compliance check. Optional 64.0
errorMessage String Message for an error that occurs during an evaluation compliance check. Optional 64.0
evaluationTime String Time when the compliance check is done. If no value is specified, the current time is used. Optional 64.0
inContextOf String Reference ID (context) for which the control or procedure is used. Required 64.0
isCompliant Boolean Indicates whether the control has passed the compliance check. Required 64.0
status String Specifies the status of the evaluation check. Required 64.0
transactionKey String Transaction key to identify the log message. Optional 64.0