Insight-Funktionen

Insight-Funktionen stellen die Syntax und Beschreibungen der Klassen, Methoden, Attribute und Parameter der Anwendungsprogrammierschnittstelle für das Insight-Tool in der Data Studio-Toolsuite bereit. Die Generierung von Erkenntnissen wird im Hintergrund ausgeführt und muss auf den Abschluss geprüft werden.

Anfrageliste abrufen - Vorgehensweise

Gibt die Liste der Anforderungsnamen und deren Parameter zurück

Syntax

Insight.get_request_list(owner)

Parameter:

• Eigentümer: In diesem Feld wird der Eigentümer des Objekts angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel

In diesem Beispiel können Sie Jobs mit Insights auflisten:

adp.Insight.get_request_list()
 
// Output
 
 [
  ... 
  {
    "owner": "ADMIN",
    "request_name": "REQUEST_INSIGHT_1",
    "request_type": "TABLE_INSIGHT",
    "source_object": "SALES",
    "source_owner": "ADMIN",
    "request_metadata": "{\"targets\":[\"ACTUAL\"],\"appName\":\"INSIGHTS\"}",
    "created": "2022-10-31T08:03:26.634Z",
    "updated": "2022-10-31T08:03:26.634Z",
    "request_job_setting": "{\"EXTRACTION\":{\"selectionRule\":{\"value\":\"MAX_DIFFERENCE\"},\"fittedShareConvergence\":{\"value\":\"LAX\"},\"maxNumExtractionDims\":{\"value\":10000},\"insightValueType\":{\"value\":\"MEMBER\"},\"excludeZero\":{\"value\":\"YES\"},\"minXAxisCount\":{\"value\":2}},\"sessionId\":null,\"applicationName\":\"INSIGHTS\",\"insightTypes\":[\"FITTED_SHARE_COMPARISON\"]}",
    "max_num_insights": 20
  },
  ...
]

Insight-Liste abrufen - Vorgehensweise

Gibt die Insights-Liste zurück. Jede Insight enthält die folgenden Felder: insight_name, visualization_id, insight_column, insight_value, insight_dimension, dimension

Syntax

Insight.get_insights_list(request_name)

Parameter:

• request_name: Der Name der Anforderung.

Beispiel

In diesem Beispiel können Sie Insights auflisten:

adp.Insight.get_insights_list('REQUEST_INSIGHT_1')
 
// Output:
[
  {
    "insight_name": "INSIGHT_62",
    "visualization_id": 199,
    "insight_column": "ACTUAL",
    "insight_value": "COUNTRY.2",
    "insight_dimension": "COUNTRY",
    "dimension": "FORECST"
  },..
]

Insight-Prozedur löschen

Insight-Anforderung löschen

Syntax

Insight.drop(request_name)

Parameter:

• request_name: Der Name der Anforderung.

Beispiel

In diesem Beispiel können Sie die Anforderung löschen:

adp.Insight.drop('REQUEST_INSIGHT_1')

Insight-Prozedur generieren

Insight der Kennzahl für die Analyse-View generieren.

Syntax

Insight.generate(av_name, measure, job_owner,
                      source_owner)

Parameter:

• av_name: Der Name der Analyse-View.
• Kennzahl: Die Kennzahl.
• job_owner: In diesem Feld wird der Verantwortliche für den Job angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.
• source_owner: In diesem Feld wird der Eigentümer des Objekts angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel

In diesem Beispiel können Sie Insights für die Analyse-View generieren:

adp.Insight.generate('COSTS_AV', 'UNIT_COST')
 
// Output
 {
  "object_owner": "ADMIN",
  "request_name": "REQUEST_INSIGHT_1",
  "max_insight_count": 20,
  "source_object": "COSTS_AV",
  "source_owner": "COSTS_AV",
  "request_metadata": "{\"targets\":[\"UNIT_COST\"],\"appName\":\"INSIGHTS\"}",
  "default_job_settings": "{\"insightTypes\":[\"FITTED_SHARE_COMPARISON\"]}",
  "new_request": "true"
}

Jobstatus abrufen

Rufen Sie den Status des Jobs ab, der als Anforderungsname angegeben ist. Die Generierung von Insights ist abgeschlossen, wenn das Feld insight_job_status den Status COMPLETED aufweist.

Syntax

Insight.get_job_status(request_name, owner)

Parameter:

• request_name: Der Name der Anfrage.
• Eigentümer: In diesem Feld wird der Eigentümer des Objekts angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel

In diesem Beispiel können Sie den Jobstatus anzeigen:

adp.Insight.get_job_status('REQUEST_INSIGHT_1')
 
// Output
{
  "insight_job_status": "COMPLETED",
  "progress_msg": " ",
  "error_msg": null
}

Diagrammdetails abrufen - Vorgehensweise

Gibt das json-Dictionary der Daten zurück, die dargestellt werden können.

Die Ergebnisse bestehen aus zwei Feldern:

item enthält allgemeine Informationen aus der Insight: description, XAXIS, measure, insight_type_label, visualization_condition, source_object

Die Abfrage enthält Informationen zum Plotten und drei Listen: Labels, Istwerte und Schätzungen.

Syntax

Insight.get_graph_details(name, id, count, query_manipulation,
                          owner)

Parameter:

• Name: Der Name der Insight.
• ID: Die Visualisierungs-ID.
• count: Anzahl der angezeigten Werte
• query_manipulation: Wenn keine Option ausgewählt ist, fügen Sie der Abfrage Cursor- und Gesamtsummenfelder hinzu.
• Eigentümer: In diesem Feld wird der Eigentümer des Objekts angezeigt. Wenn dieses Feld fehlt, verwendet das Tool den aktuellen Schemaeigentümer.

Beispiel

In diesem Beispiel können Sie Daten abrufen, um das Diagramm darzustellen:

adp.Insight.get_graph_details("INSIGHT_62", 199, 5, True)
 
 Output:
{
  "items": {
    "description": "COUNTRY.2",
    "XAXIS": "FORECST",
    "measure": "ACTUAL",
    "insight_type_label": "Expected",
    "visualization_condition": "COUNTRY.2",
    "source_object": "C0"
  },
  "query": {
    "labels": [
      "01:[66.7-1590]",
      "02:[829-2350]",
      "04:[2350-3870]",
      "06:[3870-5390]",
      "07:[4630-6150]"
    ],
    "actuals": [
      2200,
      6200,
      24600,
      26600,
      14200
    ],
    "estimates": [
      2671.105013588167,
      4830.820533674098,
      7135.506976989193,
      24772.963909661587,
      22121.48462234561
    ]
  }
}