Funções de Insight

As funções do Insight fornecem a sintaxe e as descrições das classes, métodos, atributos e parâmetros da interface de programação do aplicativo para a ferramenta Insight no conjunto de ferramentas do Data Studio. A geração de insights é realizada em segundo plano e requer a verificação da conclusão.

Obter procedimento da lista de solicitações

Retorna a lista de nomes de solicitação e seus parâmetros

Sintaxe

Insight.get_request_list(owner)

Parâmetros:

• proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode listar jobs de insights:

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
  },
  ...
]

Obter Procedimento da Lista de Insights

Retorna a lista de insights. Cada insight tem os seguintes campos: insight_name, visualization_id, insight_column, insight_value, insight_dimension, dimension

Sintaxe

Insight.get_insights_list(request_name)

Parâmetros:

• request_name: O nome da solicitação.

Exemplo

Neste exemplo, você pode listar insights:

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"
  },..
]

Procedimento Drop Insight

Soltar solicitação de insight

Sintaxe

Insight.drop(request_name)

Parâmetros:

• request_name: O nome da solicitação.

Exemplo

Neste exemplo, você pode eliminar a solicitação:

adp.Insight.drop('REQUEST_INSIGHT_1')

Gerar Procedimento de Insight

Gere insights da medida para a exibição Analítica.

Sintaxe

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

Parâmetros:

• av_name: O nome da View Analítica.
• medida: a medida.
• job_owner: Este campo exibe o proprietário do job. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.
• source_owner: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode gerar insights para a View Analítica:

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"
}

Obter Status do Job

Obtenha o status do job especificado como Nome da Solicitação. A geração de insights é concluída quando o campo insight_job_status é CONCLUÍDO.

Sintaxe

Insight.get_job_status(request_name, owner)

Parâmetros:

• request_name: O nome da Solicitação.
• proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode exibir o status do job:

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

Obter Procedimento de Detalhes do Gráfico

Retorna o dicionário json de dados que podem ser plotados.

Os resultados consistem em dois campos:

item contém informações gerais das informações: descrição, XAXIS, medida, insight_type_label, visualization_condition, source_object

query contém informações para plotagem e tem três listas: labels, actuals e estimates

Sintaxe

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

Parâmetros:

• name: O nome do Insight.
• id: O id da visualização.
• count: número de valores exibidos
• query_manipulation: Se não for Nenhum, adicione campos de tipo de cursor e totais gerais à consulta.
• proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode obter dados para plotar o gráfico:

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
    ]
  }
}