Search

You use a JSON file to define the table structure, and then you upload the file using the Add-In Manager. The following code will add a table called 'Package$Table' into the Data Dictionary.

Below is a sample table structure for our "Hello World" example. This file is included in the attached sample source code as well. 

{
"reportTablePackages": [{
	"name": "Package",
	"tables": [{
		"name": "Table",
		"label": "Table",
		"description": "EMPLOYEE TABLE",
		"columns": [{
				"name": "EMP_DISPLAY_NAME",
				"label": "EMPLOYEE DISPLAY NAME",
				"description": "EMPLOYEE DISPLAY NAME",
				"dataType": 3,
				"canDisplay": true,
				"canFilter": true,
				"canEdit": false,
				"isKey": true,
				"isNullable": true
			},
			{
				"name": "EMP_NAME",
				"label": "EMPLOYEE NAME",
				"description": "EMPLOYEE NAME",
				"dataType": 3,
				"canDisplay": true,
				"canFilter": true,
				"canEdit": false,
				"isKey": true,
				"isNullable": true
			}]
		}]
	}]
}

In order to define the table parameters for your specific data, please reference the following table. 

1. From within the .NET console navigate to the Add-In manager
2. Create a new analytics BUI Extension
3. Upload the attached source code (attached to this answer)
4. Ensure that the name of the extensions is 'DATASUPPLIERAPP' as that is the name defined in the init.js file. 

5. Your configuration at this point should look like this:

   

6. Give the Extension the proper profile permissions

7. Save and close the Add-In Manager

8. Logout and log back into the Agent Desktop ( **Don't skip this step** )

Now that we have uploaded the BUI extension that included our table definition, we should  a new entry in our data dictionary. In this step we will build our virtual report based off of this definition. 

1. Open the Reports Explorer
2. Create a new Blank Report

3. You can see that your virtual table is listed in the Data Dictionary section as 'Table (Package$Table) ' 

   

4. Create a report based on that report

   

5. Add any filters if necessary
6. Now you can add this report into the BUI anywhere you can add any other report (quick search, navigation set, workspace etc. ) 

Note: Since you have not yet provided any data for this virtual table this report will not show any rows. In order to supply data for the external report you need to proceed to step 4. 

For this step we will use the addTableDataRequestListener call back function to supply data to the report we just created. Below is an example javascript code that creates and populates the report from external sources. The code is heavily commented for clarity. You will select this file as the main file for our example. 

ORACLE_SERVICE_CLOUD.extension_loader.load('DATASUPPLIERAPP')
.then(function(IExtensionProvider)
    {
    IExtensionProvider.registerAnalyticsExtension(function(IAnalyticsContext)
        {
        IAnalyticsContext.addTableDataRequestListener('Package$Table', sampleDataSupplier);
        });
    });

function sampleDataSupplier(reportObject)
{
    // Create an object for returning data.
    var reportData = reportObject.createReportData();
    // Create the first row.
    var reportRow1 = reportObject.createReportDataRow();
    // Create the second row.
    var reportRow2 = reportObject.createReportDataRow();
    // Create a column and set the data.
    var row1Col1 = reportObject.createReportDataCell();
    row1Col1.setData('row 1 col1 data');
    var row1Col2 = reportObject.createReportDataCell();
    row1Col2.setData('row 1 col2 data');
    var row2Col1 = reportObject.createReportDataCell();
    row2Col1.setData('row 2 col1 data');
    var row2Col2 = reportObject.createReportDataCell();
    row2Col2.setData('row 2 col2 data');
    // Create record information for the first row.
    var row1recordInfo = reportObject.createReportRecordInfo();
    row1recordInfo.setRecordType('Contact');
    row1recordInfo.setRecordId(52);
    // Create record information for the second row.
    var row2recordInfo = reportObject.createReportRecordInfo();
    row2recordInfo.setRecordType('Contact');
    row2recordInfo.setRecordId(53);
    // Associate the first row with columns.
    reportRow1.getCells().push(row1Col1);
    reportRow1.getCells().push(row1Col2);
    // Associate the second row with columns.
    reportRow2.getCells().push(row2Col1);
    reportRow2.getCells().push(row2Col2);
    // Associate the first row with getRecordInfo.
    reportRow1.getRecordInfoList().push(row1recordInfo);
    // Associate the second row with getRecordInfo.
    reportRow2.getRecordInfoList().push(row2recordInfo);
    // Associate rows with the data to be returned.
    reportData.getRows().push(reportRow1);
    reportData.getRows().push(reportRow2);
    return reportData;
}

1. Create a new standard incident workspace
2. Add a report control to any tab
3. Select the virtual table report that we created in steps 1-3. 

4. Set the following Report Behavior configurations:

   

5. Assign this workspace to the profile you are using. 

6. Log into BUI and open a new incident. 

7. Open the tab you added the report to. In Chrome Developer tools notice the message "sampleDataSupplier function called!!" printed to the console. The report should also be populated with the dummy data we created in step 3.