Amazon Q Embedding Developer Pisinisi auaunaga atamai

Mataupu lalafi
1 Mea e mana'omia muamua
2 Fuaina o Autu e Fa'aalia
3 Fa'ataga Lisi Vaega
4 Fausia le sauniga fou URL
5 Fa'aaogā le JS SDK e Fa'amau
6 QuickSight Q Embedding Suiga
7 QuickSight Q Faiga Filifiliga
8 Examples
9 Vaega Autu
10 Fa'afitauli
11 SDK Revision Change Log
12 Pepa / Punaoa
12.1 Fa'asinomaga
13 Fa'amatalaga Fa'atatau

Mea e mana'omia muamua

  • AWS account ma QuickSight Q ua mafai
  • Le itiiti ifo ma le tasi le Autu ua faʻatulagaina ma QuickSight Q (ma le autu autu o le id)
  • QuickSight session embedding framework setup with AWS account

Fuaina o Autu e Fa'aalia

O le QuickSight Q embedding e lagolagoina ni fa'aoga eseese e lua e uiga i autu. Muamua o le taimi e tasi e tatau ona faʻamaonia, ma naʻo lena autu e mafai ona fesiligia e ala ile pa suʻesuʻe. O le lona lua o le masani masani i totonu o le QuickSight application, lea o loʻo i ai i le tagata faʻaoga se lisi o autu ma mafai ona faʻaogaina se pa'ū i lalo i le pa suʻesuʻe e filifili ai le autu latou te manaʻo e fesiligia. A'o le'i fa'agasolo, ia mautinoa e te iloa pe mana'omia e lau fa'aoga se autu se tasi, po'o se lisi o autu i totonu o le poto masani.

Fa'ataga Lisi Vaega

E tusa ai ma taʻiala faʻapipiʻi QuickSight, e te matauina e te manaʻomia le faʻatagaina o le lisi o lau tusi talosaga ile itulau `Manage QuickSight'. E masani lava, pau lava le mea e te manaʻomia e fai, ae i le tulaga o Q e manaʻomia foʻi ona faʻaopoopo le QuickSight domain i le lisi faʻatagaina. E foliga ese lenei mea, ae talu ai i lalo o le pulou Q o loʻo faʻaaogaina foi se iframe, matou te manaʻomia, a itiiti mai mo le taimi nei, e faʻatagaina le lisi 'tutusa' vaega. Ole vaega ole QuickSight e te mana'omia e fa'atagaina lisi e fa'alagolago ile itulagi o lo'o e fa'aogaina. Mo example, fa'apipi'i fa'aaoga le `us-sasa'e-1′ region, our URL e fa'atagaina le lisi o le:

https://us-east-1.quicksight.aws.amazon.com

O le URL o le a tutusa mo isi itulagi, ma le vaega faʻaitulagi taʻitasi (us-sasaʻe-1) suia.

Fausia le sauniga fou URL

Muamua o le vaega o le faʻapipiʻi faʻavae e faʻatupuina ai le vasega URL e ala i le getSessionEmbedURL API e tatau ona fai sina suiga. O le QuickSight Q session embedding e lagolagoina i se isi 'entry point' nai lo le masani fa'amafanafana fa'apipi'i. O fa'amaumauga mo lenei API e mafai maua iinei. E mana'omia ona sui le fa'ailoga fa'ailoga mo lenei vala'au API - o le fa'ailoga fou e fa'alagolago ile autu(s) fa'aoga mataupu. Mo le mataupu autu e tasi:

entry-point = /q/search/<topicId>

Ina ia faʻaalia autu uma i le tagata filifilia, matou te aveese le topicId:

entry-point = /q/search

E tatau ona fa'atupuina le fa'amaoni tasi le taimi URL e maua ai se itulau e na'o le QuickSight Q search bar.

Fa'aaogā le JS SDK e Fa'amau

Faatasi ai ma le URL, e mafai ona matou faʻaogaina le QuickSight Embedding Javascript SDK e faʻapipiʻi ai le Q search bar i le talosaga. Muamua, ia mautinoa e iai sau kopi ole SDK mai le 'au QuickSight - maitau talu ai o lenei mea o se mua'iview fa'aaliga ma e le'i fa'amatu'uina atu, o le SDK o le a ese le fa'aaliga nai lo le avanoa lautele SDK ile github. Matou te mananaʻo e faʻaoga le auala EmbedSession mai le SDK faʻatasi ai ma le faʻatulagaina o sauniga URL. O filifiliga talafeagai mo le embedSession galuega (e maua foi i le type.js i le SDK):

url: url of the session or dashboard to embed container: parent html element or query selector string errorCallback: callback when error occurs loadCallback: callback when visualization data load complete className: optional className to be given to iframe element isQEmbedded: embeddable object is Q search bar flag maxHeightForQ: height for Q to resize to when it expands onQBarOpenCallback: optional callback for Q search bar open onQBarCloseCallback: optional callback for Q search bar close

O finauga manaomia e lua iinei o url ma pusa. O le a matou faʻaaogaina le URL faia mai le getSessionEmbedURL API valaau, ma mo le atigipusa e faʻalagolago i lau talosaga. E te mana'o i se mea faigofie e fai ma `coniteina' mo le iframe fa'apipi'i; tu'u i le pusa lenei se id ma pasi i le id i le SDK finauga. Ole taimi fa'aletonu e fa'apipi'i callbacks, errorCallback ma loadCallback faia e pei ona ta'u mai e le igoa - pe a e
mana'omia amioga fa'ale-aganu'u pe a utaina le itulau fa'apipi'i, pe fa'afeiloa'i se mea sese, fa'ailoa mai le fa'atatau i nei toe fo'i. Pe a faʻaogaina le Q faʻapipiʻi faʻatasi ma le SDK, o le iframe o le a tumau maualuga (le maualuga o le pa suʻesuʻe lava ia) ma le 100% lautele o le matua HTML container. O lona uiga o le pa su'esu'e o le a na'o le lautele e pei o le container; e te mana'o e fa'amautinoa o le pa su'esu'e e le itiiti ifo i le 600px le lautele (pe fa'aliliu mai view-lautele/pasenetage pe tofia sa'o). Mo le fa'avasegaina o le iframe, e mafai fo'i ona fa'atonu le fa'ailoga className.

TAUA:
O se valaau autu iinei o le mautinoa o le po'o le vaega o lo'o e pasia e pei o le atigipusa html elemene o lo'o i ai se sitaili o le `tulaga: atoatoa'. O le mea lea e mafai ai ona faʻalautele le pa suʻesuʻe e pei o se faʻapipiʻi nai lo le suia o mea o loʻo i totonu o lau app i lalo.

QuickSight Q Embedding Suiga

E i ai nai eseesega taua i le va o le sauniga / dashboard embedding ma le Q search bar embedding (e ui o le taimi nei o Q embedding e faʻaaogaina le faʻaogaina o sauniga). Faatasi ai ma le dashboard ma le fa'apipi'iina o le vasega, o le fa'avaa e masani lava e tasi le lapo'a, e fa'asa'o ai nisi suiga e fa'atatau i le lapo'a o se dashboard po'o se pepa au'ili'ili. Faatasi ai ma le Q, o le taimi muamua o le faʻavaa faʻapipiʻi i luga o lau itulau e laʻititi (naʻo matou manaʻo e faʻaalia le pa suʻesuʻe moni). A fa'aoga le pa su'esu'e, e mana'omia ona fa'alautele le fa'avaa (e fa'aalia ai elemene fa'aopoopo e pa'u i lalo e pei o le fa'aaliga vaaia, fautuaga, ma isi). Ina ia faʻalautele lenei faʻavaa e aunoa ma le fesuiaʻiina o mea o loʻo i totonu o lau talosaga, matou te setiina e fai ma faʻapipiʻi i luga o le itulau o loʻo iai, e tutusa ma le faʻaogaina o le pa suʻesuʻe i le QuickSight application i aso nei - vaʻai faʻamalama i lalo.

Faatasi ai ma sina mea itiiti e uiga i le faʻaogaina o Q embedding i le mafaufau, seʻi o tatou tilotilo i le QuickSight Q faʻamautu SDK. Muamua, matou te manaʻomia isQEmbedded e faʻatulagaina e moni. maxHeightForQ o se finauga e filifili ai e faʻamaonia ai le tele o le Q faʻavaa e mafai ona i luga o lau itulau; e pei ona taʻua muamua, matou te manaʻomia le iframe ma o se pusa e faʻalautele ai mea o loʻo i totonu o le itulau. E mafai ona matou fa'aogaina le finauga maxHeightForQ e fa'amautinoa ai e le toe suia le fa'avaa/containing i tua atu o le maualuga maualuga o lau itulau ma fa'aalia ai se tusi taai po'o isi amioga e le mana'omia. Afai e le setiina, o le Q faʻavaa o le a toe faʻafouina i le 100vh.

O fa'amaufa'ailoga fa'apitoa Q mulimuli e lua o toe fa'afo'i lea e tupu pe a toe fa'afouina le fa'avaa fa'apipi'i. O le amio le lelei o le fatuina lea o se elemene pito i tua, ma faʻaaoga lenei mea e tuʻuina atu ai foliga pogisa pito i tua tatou te vaʻaia i luga o faʻamalama mai le QuickSight application. O le 'out of the box' galuega lea matou te manana'o e tu'uina atu ina ia fa'afaigofie ai le fa'apipi'iina o le Q - peita'i, matou te iloa e le aoga lenei mea mo talosaga uma e mana'omia e Q fa'apipi'i i totonu. Afai e te mana'omia fa'alēaogāina lenei amio, na'o le tusi o le manatu i le onQBarOpenCallback ma onQBarCloseCallback. O lenei mea o le a taofia ai le fa'ailoga fa'aletonu mai le fa'aalia.

QuickSight Q Faiga Filifiliga

O lo'o i ai ni nai sitaili/matagofie filifiliga e mafai ona tatou fa'aogaina e fa'avasega ai foliga o le Q su'esu'e pa.

qBarIconDisabled: option to hide the Q search bar
qBarTopicNameDisabled: option to hide the Q search bar topic name
themeId: option to apply Quicksight theme to Q search bar

Afai e te manaʻo e faʻamalo le 'Q' icon (i le itu agavale o le pa suʻesuʻe, faʻaoga le qBarIconDisabled parakalafa. E faʻapea foʻi, e tape le igoa autu, pe afai o loʻo e faʻaalia se autu e tasi i totonu o le faʻaogaina, faʻaoga le qBarTopicNameDisabled parakalafa. Manatua o nei teuteuga fa'alelei e na'o le avanoa pe a e fa'apipi'iina se autu e tasi.
Afai e te manaʻo e faʻaulu le Q bar faʻapipiʻi ina ia faʻafetaui foliga ma lau talosaga, e mafai ona e faia e ala i le fatuina o se autu fou i le QuickSight ma pasi le themeId i le SDK (exampi lalo).

Examples

O le exampO le a manatu o loʻo i ai se atigipusa o loʻo i ai i le DOM ma le id `q-bar-container'.

Fa'apipi'i ma Amioga Fa'ata'oto Fa'ata'atia (ma le q/su'esu'e ala)

Fa'apea o le atigipusa ei ai le pito i luga o le 75px, o lea o le a tatou faʻamauina mo lena faʻaaogaina o le maxHeightForQ parakalafa, ina ia le faʻalauteleina le iframe nai lo le itulau e mafai, fatuina o se paʻu taʻavale poʻo isi amioga e le manaʻomia.
function embedQSession(embedUrl) {
var containerDiv = document.getElementById("q-bar-container");
containerDiv.innerHTML = "";
var params = {
url: embedUrl, container: containerDiv,
isQEmbedded: true,
maxHeightForQ: "calc(100vh - 75px)",
};
 QuickSightEmbedding.embedSession(params);
}

Fa'apipi'i ma Amioga Fa'ama'i Fa'aletonu (ma le q/su'esu'e ala)

Mo lenei example a tatou manatu o le atigipusa o loʻo i le pito i luga o le itulau ina ia mafai ona faʻalauteleina i le 100% e aunoa ma se faʻalavelave; matou te le manaʻomia le maxHeightForQ. O le a matou fa'aogaina le onQBarOpenCallback ma le onQBarCloseCallback e fai ma galuega e leai se fa'aoga e taofia ai le fa'aalia o le fa'atagata fa'aletonu.

function embedQSession(embedUrl) { var containerDiv = document.getElementById("q-bar-container"); containerDiv.innerHTML = "";
var params = {
url: embedUrl, container: containerDiv,
isQEmbedded: true,
onQBarOpenCallback: () => {},
onQBarCloseCallback: () => {},
};
QuickSightEmbedding.embedSession(params);
}

Fa'apipi'i i le Fa'asinomaga Fa'aa'oa'oga (ma le q/su'esu'e ala)

Matou te toe fa'apea o le atigipusa o lo'o i le pito i luga o le itulau ina ia mafai ona fa'alautele i le 100% e aunoa ma se fa'alavelave; matou te le manaʻomia le maxHeightForQ. Matou te fa'aogaina le onQBarOpenCallback ma le onQBarCloseCallback e fai ma toe fo'i e fa'aogaina ai se isi vaega pito i tua (customBackdropComponent) i la matou talosaga matou te mana'o e fa'aoga e suitulaga i le fa'aletonu. Manatua o lou tua i tua atonu e sili atu ona lavelave, lenei example na o le faigofie.

function onQBarOpen() {
customBackdropComponent.style.height = "100%";
}
function onQBarClose() {
customBackdropComponent.style.height = 0;
}
function embedQSession(embedUrl) {
var containerDiv = document.getElementById("q-bar-container");
containerDiv.innerHTML = "";
var params = {
url: embedUrl,
container: containerDiv,
isQEmbedded: true,
onQBarOpenCallback: () => {},
onQBarCloseCallback: () => {},
};
QuickSightEmbedding.embedSession(params);
}

Fa'apipi'i ma Amioga Fa'aigoa Fa'ata'atia (ma le q/search/topicId ala)

Matou te toe manatu o le atigipusa ei ai le pito i luga o le 75px, o lea o le a matou faʻaogaina le faʻaaogaina o le maxHeightForQ parakalafa, ina ia le faʻalauteleina le iframe nai lo le itulau e mafai, fatuina o se paʻu taʻavale poʻo isi amioga e le manaʻomia. Talu ai o lo'o matou fa'aogaina le pa su'esu'e fa'apipi'i ma se autu e tasi, e mafai ona matou fa'aogaina le qBarIconDisabled ma le qBarTopicNameDisabled customizations. O lenei exampo le a tu'uina mai ia i matou se pa su'esu'e e leai se fa'ailoga po'o se igoa autu, fa'atulaga e sauni e fa'afesili po'o fea le autuId e pasia i totonu.

galuega embedQSession(fa'aofiUrl) {
var containerDiv = document.getElementById(“q-bar-container”);
containerDiv.innerHTML = “”;
var params = {
url: fa'apipi'iUrl,
pusa: containerDiv,
isQEmbedded: moni,
maxHeightForQ: “calc(100vh – 75px)",
qBarIconDisabled: sese,
qBarTopicNameDisabled: sese,
};
QuickSightEmbedding.embedSession(params);
}

Fa'apipi'i ma le Id Autu

Fausia se autu fou ile QuickSight pe a leai sau autu. Tatala se au'ili'iliga, pe fai se mea fou. Filifili Autu ile agavale.
Ona filifili lea o se tasi o le autu autu e te manaʻo ai ona kiliki lea "Save as". Afai ua uma ona iai sau autu, e mafai ona e faamisi le laasaga o le fatuina o autu.

O le a ave oe i le itulau faatonu autu, tuʻu i ai se igoa, fetuutuunai le lanu e te manaʻo ai ona faʻasaoina lea i le pito i luga taumatau.

O lea la ua iai sau autu, e tatau ona e su'e le id o lena autu ma pasi i le SDK. Filifili le "Edit" i luga o le autu na e fatuina.

O le a toe ave oe i le itulau faatonu autu, ae o le taimi lenei, o le ae maua ai le autu autu iina i le url pa. I lenei tulaga "d39c0065bf69-4b3d-927b-9dd3a241f094" o le id o se autu na ou fatuina.

I le mea mulimuli, e te pasi le autu id e fai ma parakalafa i le SDK, ona e mauaina lea o le Q bar i lau app.

galuega embedQSession(fa'aofiUrl) {
var containerDiv = document.getElementById(“q-bar-container”);
containerDiv.innerHTML = “”;
var params = {
url: fa'apipi'iUrl,
pusa: containerDiv,
isQEmbedded: moni,
maxHeightForQ: “calc(100vh – 75px)“,
qBarIconDisabled: sese,
qBarTopicNameDisabled: sese,
autuId: “d39c0065-bf69-4b3d-927b-9dd3a241f094”
};
QuickSightEmbedding.embedSession(params);
}

Vaega Autu

Matou te fia faʻaali atu ia te oe po o fea vaega i totonu o le Q bar e mafai ona faʻatulagaina, ma o le a matou faʻaaogaina le autu o le QuickSight Midnight e avea o se ex.ample (e mafai ona e mauaina i autu amata)

Fa'afitauli

'Musu e fa'avaa *.quicksight.aws.amazon.com aua ua soli e se tuaa..’ Sese

O lenei mea sese e mafua ona o le le faatagaina o le lisiina o lau vaega i le pulega QuickSight admin itulau i le QuickSight application. Ia mautinoa e faʻataga le lisi o le itulagi QuickSight faʻaitulagi (mo matou-sasaʻe-1, o le https://us-east-1.quicksight.aws.amazon.com , mo example), faʻapea foʻi ma le vaega o lau talosaga.

Le Mafai ona Va'ai Pae Su'esu'e Ina ua Fa'ato'a Manuia

Afai e mafai ona e fa'atupuina lelei ma maua ma fa'apipi'i so'otaga (e aunoa ma se fa'atagaga po'o isi mea sese), ae maua se 'avanoa' lau e leai se pa su'esu'e e fa'aalia, e i ai nai mea e siaki. O le tasi e tatau ona i ai a itiiti ifo ma le tasi le autu e faʻasoa i le tagata faʻaoga o loʻo e faʻapipiʻiina. Lona lua, e te mana'o e fa'amautinoa o lo'o i ai a itiiti ifo ma le tasi le autu o lo'o faia ma le manuia ma i se tulaga 'manuia' pe a uma ona fausia. O se auala faigofie e suʻe ai lenei mea o le naʻo le faʻaaogaina o le autu i le Q i le QuickSight application; afai e galue masani, e lelei le faʻaogaina i totonu o le faʻaogaina.

O le isi mafua'aga e ono le aliali mai ai le pa su'esu'e ona o le atigipusa o lo'o i totonu o le iframe atonu e le lava le lautele. E pei ona ta'ua i totonu o fa'amaumauga, e te mana'o e fa'amautinoa o lo'o tu'uina atu le pa su'esu'e ia le itiiti ifo i le 600px o le lautele e fa'atino masani ai.

Ua Faalautele le Pa Su'esu'e Ae Su'i Mea i lalo

O le pa su'esu'e ma le SDK na mamanuina e fa'alautele i luga o so'o se mea fa'aopoopo i luga o le itulau. Afai e le o le tulaga lea, faamolemole ia mautinoa le pusa su'esu'e o lo'o fa'ailogaina i se 'tulaga: fa'ato'a', lea o le a fa'ataga ai e aua ne'i suia mea o lo'o i totonu o le itulau i lalo. Mo exampLe:

<div id="q-search-container" style="position: absolute; width: 100%"></div>

SDK Revision Change Log

  • V1(5/15/21): Aganu'u muamua `Q-sauni' SDK
    • V1.1 (5/25/21)
      • Suia le maualuga o le iframe e faʻapipiʻi i le maualuga o le pa suʻesuʻe lava ia, e le mafai e le tagata faʻaoga ona faʻamaonia ile Q mode
      • Seti le lautele ole iframe ile 100% ole koneteina matua mo Q mode. Manatua o le lautele o le pa suʻesuʻe e mafai lava ona faʻatapulaʻaina i le tele o le pusa matua.

Pepa / Punaoa

Amazon Q Embedding Developer Pisinisi auaunaga atamai [pdf] Taiala mo Tagata Fa'aoga
Q Embedding Developer Pisinisi au'aunaga fa'ata'ita'i, Auaunaga fa'ata'ita'i Pisinisi, auaunaga fa'apitoa

Fa'asinomaga

Fa'amatalaga Fa'atatau

Tuu se faamatalaga

E le fa'asalalauina lau tuatusi imeli. Fa'ailogaina fanua mana'omia *