Abfragen von UDC-Daten

Mit Hilfe des gfUdcConnectors können Sie dynamische Daten ganz einfach über die UDC-Schnittstelle abfragen. Im Folgenden wird erklärt, wie Sie den Connector in HTML-Basic- als auch HTML-Wizard Spots integrieren. 

Einbinden der Bibliothek

Der gfUdcConnector wird innerhalb der index.html-Seite über das "Script"-Tag eingebunden, z.B.: <script src="PATH_TO_SCRIPT/gfUdcConnector.js"></script>

Instanzieren des gfUdcConnectors 

Um die Funktionen des gfUdcConnectors aufrufen zu können, muss dieser innerhalb des eigenen Codes zuvor instanziert werden:

var udc = new GFUdcConnector();

udc.getVersion();

Objekttypisierung

UDC-Datenobjekte

Um den Aufbau der Daten besser zu veranschaulichen, wurden die einzelnen Objekte typisiert. Diese werden in den folgenden Kapiteln für die Funktionserklärungen herangezogen.

UdcData

UdcData: {
   Success: boolean,
   Result: DataSource[]
};

UdcDataByKey

UdcDataByKey: {
   Success: boolean,
   Result: DataSource
};

DataSource

DataSource: {
   Categories: Category[],
   ContainerGuid: string,
   Elements: Element[],
   Key: string,
   LastModified: string,
   PluginInstanceName: string
};

Category

Category: {
   ExternalId: string,
   Id: number,
   LastModified: string,
   MediaFiles: any[]
   Name: string
};

Element

Element: {
   CategoryIds: number[],
   ElementValues: any[],
   ExternalId: string,
   Guid: string,
   Id: number,
   LastModified: string,
   MediaFileBaseUrl: string,
   MediaFileDirectory: string,
   MediaFiles: any[],
   Name: string
};

MediaFile

MediaFile: {
   Image: string 
};

Debug objects

Die Ermittlung der für die Testverbindung notwendigen Parameter wird in Einrichten einer UDC-Testverbindung ausführlich erklärt.

DebugServer

DebugServer = {
   url: string,
   locationId: number,
   spotId: number,
   sessionId: string
};

DebugClient

DebugServer = {
   ip: string,
   siid: number
};

DebugFile

DebugServer = {
   url: string
};

Verfügbare Funktionen

getData

Mit dieser Funktion lassen sich alle mit dem Spot verknüpften UDC-Daten auf einmal abrufen.

Parameter:

{callback} onSuccess: returns UdcData, result as plain text {string}
{callback} onError: returns error message {string}

Beispiel:

var udc = new GFUdcConnector();
udc.getData(function(jsonData, plainData)
{
   // data as JSON {UdcData}
   console.log(jsonData);
   // data as plain text {string}
   console.log(plainData);

}, function(message)
{
   console.error(message);
});

Erklärung:

Der Funktion getData werden zwei Callback-Funktionen übergeben. Die erste Funktion wird im Erfolgsfall mit dem UdcData-Objekt (siehe UdcData) und Daten als String aufgerufen. Die zweite Funktion wird im Fehlerfall mit der Fehlermeldung aufgerufen.

UdcData.Result ist ein Array von DataSource-Objekten, welche jenen Datenquellen entsprechen, die mit dem Spot bzw. der Spot-Instanz verknüpft worden sind. Die Anzahl beträgt 0..n Objekte, je nachdem wie viele Datenquellen dem Spot bzw. der Spot-Instanz zugeordnet wurden.

Die einzelnen Datenquellen müssen dann über die Bezeichnung der Datenquelle (Key) selbst identifiziert und entsprechend weiterverarbeitet werden. 

getDataByKey

Mit dieser Funktion lässt sich eine spezifische Datenquelle gezielt über die eindeutige Bezeichnung abfragen.

Parameter:

{string} key: unique designator

{callback} onSuccess: returns UdcDataByKey, result as plain text {string}
{callback} onError: returns error message {string}

Beispiel:

var udc = new GFUdcConnector();
udc.getDataByKey("News", function(jsonData, plainData)
{
   // data as JSON {UdcData}
   console.log(jsonData);

   // data as plain text {string}
   console.log(plainData);

}, function(message)
{
   console.error(message);
});

Erklärung:

Der Funktion getDataByKey werden neben der eindeutigen Bezeichnung der Datenquelle zwei Callback-Funktionen übergeben. Die erste Funktion wird im Erfolgsfall mit dem UdcDataByKey-Objekt (siehe UdcDataByKey) und Daten als String aufgerufen. Die zweite Funktion wird im Fehlerfall mit der Fehlermeldung aufgerufen.

UdcDataByKey.Result ist ein DataSource-Objekt, welches einer dem Spot bzw. der Spot-Instanz zugeordneten Datenquelle entspricht. Kann die Datenquelle über die eindeutige Bezeichnung nicht gefunden werden, so ist UdcDataByKey.Result undefined.

setLocalTestData

Mit dieser Funktion lässt sich ein Spot während der Entwicklung gegen unterschiedliche UDC-Webservices bzw. -Ziele testen. Die Parameter der einzelnen Verbindungstypen müssen korrekt gesetzt werden, damit die Schnittstelle fehlerfrei funktioniert.

Parameter:

{DebugServer|DebugClient|DebugFile} connection

Beispiel:

var udc = new GFUdcConnector();
var connection = {
   ip: "192.168.169.73",
   siid: 529
};
udc.setLocalTestData(connection);
// fetch some data...

Erklärung:

In Abhängigkeit von der übergebenen Verbindungsart werden die Daten von der jeweiligen Quelle abgegriffen und zur Verfügung gestellt. Dabei wird unterschieden zwischen:

• Testen gegen die Server-Webservices, Übergabe von DebugServer-Objekt

• Testen gegen die Player-Webservices, Übergabe von DebugClient-Objekt

• Testen gegen lokales File, Übergabe von DebugFile-Objekt

Weitere Details dazu finden Sie unter Einrichten einer UDC-Testverbindung.

registerLogHandler

Mit dieser Funktion lassen sich noch zusätzliche Logs seitens des gfUdcConnectors abrufen.

Parameter:

{callback} onLog: returns log messsag {string}

Beispiel:

var udc = new GFUdcConnector();
udc.registerLogHandler(function(message)
{
   console.log(message);
});

Erklärung:

Der Funktion registerLogHandler wird als Parameter eine Callback-Funktion übergeben, welche im Falle eines Log-Eintrags seitens des gfUdcConnectors aufgerufen wird. Als Parameter wird die Log-Meldung übergeben.