Overview of Transcripts
You can obtain a reviewable transcript for an interview, without having to use any data mapping. The transcript saves all the interview questions asked and answers given during the interview.
To obtain an interview transcript, you can either:
-
Use an existing connection (B2C Service, Oracle Fusion, Oracle Integration, connector framework or generic provider) and attach the transcript when the interview is submitted. For more information, see Save an Interview Transcript to a Connected Application.
-
Use an interview extension connection with the Interview.fetch() method set to TRANSCRIPT. For more information, see Get a Transcript of an Interview Session.
The transcript also includes custom properties defined for screens and controls.
Explain this further
When generating a transcript using the 12.2.40 (or later) format version, custom properties will be included in the transcript. This can be useful when you want the custom property to be available to another application, for example, to:
-
restyle a heading in the transcript to match the styling used in the Intelligent Advisor interview. For instance, the interview designer may add a custom property to a screen control in order to apply styling to that control when viewed by an interview user. See Example 16 where the headings are displayed in green when the heading label has a specific custom property. By having the same custom property present in the transcript, any downstream application rendering the transcript has the information needed to also restyle that heading (that is, to also display the heading in green to the agent reviewing the transcript).
-
indicate that the transcript, or part of the transcript, needs special handling. For instance, an interview designer could add the custom property "Hide" or "Sensitive" to a conditionally visible input collecting sensitive information. The connected application could hide the value of inputs where that custom property is set to true when displaying the transcript to an agent, or use the presence of that custom property in a generated transcript as an indicator sensitive information has been collected and to save the transcript to a different location altogether.
An example of what a transcript looks like is provided below. The transcript itself is in the form of JSON in the format specified later in this topic.
Transcript example
An example interview transcript is given below:
{
"timestamp": "2025-08-07T01:30:11Z",
"deployment": "StudentBenefits",
"formatVersion": "12.2.40",
"contextSessionValues": {
"student_eligible": true
},
"screens": [
{
"screen": "Eligibility for Student Aid",
"controls": [
{
"type": "label",
"text": "Hi Lisa Smith"
},
{
"type": "label",
"text": "There are many grants, scholarships, loans and work-study programs available to help students throughout their university studies. "
},
{
"type": "label",
"text": "This interview will help you determine whether any of these resources may be appropriate for you.",
"customProperties": {
"customLabelStyle": "notification-label-style"
}
}
],
"customProperties": {
"type": "sensitive"
}
},
{
"screen": "Basic Information",
"controls": [
{
"type": "input",
"text": "Name:",
"inputType": "text",
"entity": "global",
"instanceId": "global",
"attribute": "student_name",
"inputValue": "Lisa Smith",
"displayValue": "Lisa Smith",
"customProperties": {
"collectsName": "true",
"maxLength": "500"
}
},
{
"type": "input",
"text": "",
"inputType": "text",
"entity": "global",
"instanceId": "global",
"attribute": "student_gender",
"inputValue": "Female",
"displayValue": "Female"
},
{
"type": "input",
"text": "Citizenship/immigration status:",
"inputType": "text",
"entity": "global",
"instanceId": "global",
"attribute": "a8174e3b-2247-48da-93a4-93585c890993",
"inputValue": "Citizen",
"displayValue": "Citizen"
},
{
"type": "input",
"text": "Do you have a Social Security Number?",
"inputType": "boolean",
"entity": "global",
"instanceId": "global",
"attribute": "8f5f4ccf-4289-4e98-8be9-9e762ceac363",
"inputValue": true,
"displayValue": "Yes"
},
{
"type": "input",
"text": "Enrolment status:",
"inputType": "text",
"entity": "global",
"instanceId": "global",
"attribute": "6a573152-98ad-4cb4-a3c4-2d45337ac1d6",
"inputValue": "Enrolled",
"displayValue": "Enrolled"
}
]
},
{
"screen": "Family",
"controls": [
{
"type": "input",
"text": "How many people are in your family?",
"inputType": "number",
"entity": "global",
"instanceId": "global",
"attribute": "51a9ff94-8ba5-4033-ba38-e8296a6e53cd",
"inputValue": 5,
"displayValue": "5"
},
{
"type": "input",
"text": "What is your annual family income?",
"inputType": "number",
"entity": "global",
"instanceId": "global",
"attribute": "bfcccc0b-f027-42de-a1be-cf67dbe5950b",
"inputValue": 30000,
"displayValue": "30,000"
}
]
},
{
"screen": "Satisfactory Academic Progress",
"controls": [
{
"type": "input",
"text": "Have you maintained satisfactory academic progress in college or career school?",
"inputType": "boolean",
"entity": "global",
"instanceId": "global",
"attribute": "6d334774-ca3c-4f92-9772-b95053312b24",
"inputValue": true,
"displayValue": "Yes"
},
{
"type": "label",
"text": "Note: Satisfactory academic progress is a school's standards for satisfactory academic progress toward a degree or certificate offered by that institution. Check with your school to find out its standards."
}
]
},
{
"screen": "Previous Education",
"controls": [
{
"type": "input",
"text": "Do you have a high school diploma?",
"inputType": "boolean",
"entity": "global",
"instanceId": "global",
"attribute": "47c750a0-19ec-4de3-ab38-6fed67baecae",
"inputValue": true,
"displayValue": "Yes"
},
{
"type": "input",
"text": "Do you have a General Educational Development (GED) certificate?",
"inputType": "boolean",
"entity": "global",
"instanceId": "global",
"attribute": "85f8b646-9240-40b1-82ff-2ce0c39e1626",
"inputValue": false,
"displayValue": "No"
},
{
"type": "input",
"text": "Have you completed a high school education in a state-approved home school setting?",
"inputType": "boolean",
"entity": "global",
"instanceId": "global",
"attribute": "61be1a16-c702-4378-952a-e74a7a607501",
"inputValue": false,
"displayValue": "No"
}
]
},
{
"screen": "Declarations",
"controls": [
{
"type": "label",
"text": "Great. Just a couple of final checks. Can you confirm:"
},
{
"type": "input",
"text": "- that you are not in default on a federal student loan?",
"inputType": "boolean",
"entity": "global",
"instanceId": "global",
"attribute": "0fc01453-b08b-4c15-89be-b017f15c6b55",
"inputValue": true,
"displayValue": "Yes"
},
{
"type": "input",
"text": "- that you will use the federal student aid for educational purposes only?",
"inputType": "boolean",
"entity": "global",
"instanceId": "global",
"attribute": "4e8cc3a7-9a71-4496-ab61-e8f6932431ec",
"inputValue": true,
"displayValue": "Yes"
}
]
},
{
"screen": "Congratulations you are Eligible for Student Aid",
"controls": [
{
"type": "label",
"text": "Different Types of Student Aid"
},
{
"type": "label",
"text": "Grants and Scholarships"
},
{
"type": "label",
"text": "Grants and scholarships are financial aid which does not have to be repaid (unless you withdraw from school). Grants are generally needs-based, whereas scholarships are generally merit-based. For more information, visit the <a href=\"http://studentaid.ed.gov/types/grants-scholarships\" target=\"_blank\">Grants and Scholarships</a> website."
},
{
"type": "label",
"text": "Loans"
},
{
"type": "label",
"text": "Loans are where you borrow money for your education. Loans must be repaid, with interest. For more information, visit the <a href=\"http://studentaid.ed.gov/types/loans\" target=\"_blank\">Loans</a> website."
},
{
"type": "label",
"text": "Work-Study Program"
},
{
"type": "label",
"text": "Under the Work-Study Program, you can work part-time to earn money for your education. This program is administered by the schools participating in the program. "
},
{
"type": "label",
"text": "Other Financial Assistance for Education"
},
{
"type": "label",
"text": "Tax Benefits for Education"
},
{
"type": "label",
"text": "Aside from general student aid, there are also various other avenues for financial assistance. For example, there are tax credits, deductions and savings plans which can help taxpayers with expenses associated with higher education. For more information, see the <a href=\"http://www.irs.gov/uac/Tax-Benefits-for-Education:-Information-Center\" target=\"_blank\">IRS Tax Benefits for Education Information Center</a>."
},
{
"type": "label",
"text": "Student Aid for Military Families"
},
{
"type": "label",
"text": "There are also financial aid programs for individuals serving in the military, as well as their spouses and children."
},
{
"type": "label",
"text": "New Label"
}
]
}
]
}
Session transcript format
The session transcript will include all visited screens whose screen state evaluates to either relevant or show. This generally aligns with the set of visited screens shown in the navigation bar.
For each screen in the transcript, it will list every visible label, input, relationship, entity collect, upload, signature and explanation control. The transcript will also contain custom properties and their values for any screen or control in the interview (if using the 12.2.40 format). Containers are not written out, instead the visible controls on the screen are presented as a single flat list.
The format of the transcript is explained in the following tables.
| Property | Description |
|---|---|
| screen | The screen's current title |
| controls | An array of currently visible label, input, relationship, entity collect, upload, signature and explanation controls on this screen. See Tables 3 to 9 below for the properties of each control type. |
| customProperties (12.2.40) | The custom properties for the screen and their values as key-value pairs |
| Property | Description |
|---|---|
| type | The type of property (label) |
| text | The label's current text |
| customProperties (12.2.40) | The custom properties for the label and their values as key-value pairs |
| Property | Description |
|---|---|
| type | The type of property (input) |
| text | The input control's current text |
| inputType | The attribute's data type (boolean, number, date, datetime, timeofday or text) |
| entity | The entity to which the attribute belongs |
| instanceId | The name of entity instance on which the value is set |
| attribute | The name of the attribute being collected |
| inputValue | The current value of the attribute in the session. A NULL value represents unknown. An empty object represents uncertain. |
| displayValue (12.2.30) |
The input control's current value as displayed on the screen. It is determined as follows:
|
| customProperties (12.2.40) | The custom properties for the input and their values as key-value pairs |
| Property | Description |
|---|---|
| type | The type of property (entity-collect) |
| entity | The entity to which the relationship belongs |
| instanceId | The name of entity instance on which the value is set |
| relationship | The name of the relationship being collected |
| targetEntity | The target entity of this relationship |
| inputValue | An array of instanceIds representing the target instances of this relationship or NULL if the relationship is unknown. |
| customProperties (12.2.40) | The custom properties for the entity collect and their values as key-value pairs |
| Property | Description |
|---|---|
| type | The type of property (relationship) |
| text | The relationship control's current text |
| entity | The entity to which the relationship belongs |
| instanceId | The name of entity instance on which the value is set |
| relationship | The name of the relationship being collected |
| targetEntity | The target entity of this relationship |
| inputValue | An array of instanceIds representing the target instances of this relationship or NULL if the relationship is unknown |
| displayValue (12.2.30) | The array of display values for each selected target entity instance, or NULL if the control's current value is unknown. The display value for an instance is the caption you would see for that instance in the relationship collect control. For example, "displayValue": ["Blue Volkswagen", "Red Morris Minor", "Silver Honda"] |
| customProperties (12.2.40) | The custom properties for the relationship and their values as key-value pairs |
| Property | Description |
|---|---|
| type | The type of property (upload) |
| text | The upload control's current text |
| entity | The entity to which the upload group belongs |
| instanceId | The name of entity instance on which the value is set |
| uploadName | The name of the upload group being collected |
| inputValue | An array of the names of files currently set for this upload group or NULL if the upload group's value is unknown |
| customProperties (12.2.40) | The custom properties for the upload and their values as key-value pairs |
| Property | Description |
|---|---|
| type | The type of property (signature) |
| text | The signature control's current text |
| entity | The entity to which the signature belongs |
| instanceId | The name of entity instance on which the value is set |
| inputValue | An array of the signature file currently set for this upload group or NULL signature is unknown |
| customProperties (12.2.40) | The custom properties for the signature and their values as key-value pairs |
| Property | Description |
|---|---|
| type | The type of property (explanation) |
| text | The explanation control's current text |
| inputType | The attribute's data type (boolean, number, date, datetime, timeofday or text) |
| entity | The entity to which the attribute belongs |
| instanceId | The name of entity instance on which the value is set |
| attribute | The name of the attribute for which the explanation is generated |
| inputValue | The current value of the attribute in the session. A NULL value represents unknown. An empty object represents uncertain. |
| decisionReport | The attribute's explanation. The format is the same as the Batch Assess REST API response. |
| customProperties (12.2.40) | The custom properties for the explanation and their values as key-value pairs |