Amazon Q Embedding Developer Business service service

Lintho tse hlokahalang

• Ak'haonte ea AWS e nang le QuickSight Q e lumelletsoeng
• Bonyane Sehlooho se le seng se thehiloe ka QuickSight Q (le id ea sehlooho seo)
• Ntlafatso ea moralo oa QuickSight e kenelletseng ka ak'haonte ea AWS
  • Workshop bakeng sa sena: https://learnquicksight.workshop.aws/en/session-embedding.html
  • Netefatsa hore u lumella lethathamo la sebaka sa hau leqepheng la Laola QuickSight

Ho Ikhethela (li)hlooho tseo u lokelang ho li bontša

Ho kenyelletsa QuickSight Q ho ts'ehetsa maemo a mabeli a fapaneng a ts'ebeliso mabapi le lihlooho. Ea pele ke ha ho tlameha ho hlakisoa sehlooho se le seng, 'me taba eo ke eona feela e ka botsoang khahlanong le eona ka sebaka sa ho batla. Ea bobeli ke boiphihlelo bo tloaelehileng ka har'a sesebelisoa sa QuickSight, moo mosebelisi a nang le lethathamo la lihlooho mme a ka sebelisa dropdown bareng ea ho batla ho khetha sehlooho seo a ka ratang ho botsisisa khahlanong le sona. Pele o tsoela pele, etsa bonnete ba hore oa tseba hore na nyeoe ea hau ea ts'ebeliso e hloka sehlooho se le seng, kapa lethathamo la lihlooho ho boiphihlelo bo kentsoeng.

Sebaka sa ho lumella

Ho latela litataiso tse kenyelletsoang tsa QuickSight, u tla hlokomela hore u hloka ho fana ka tumello sebakeng sa kopo ea hau leqepheng la `Laola QuickSight'. Ka tlwaelo, sena ke sona feela seo o hlokang ho se etsa, empa tabeng ya Q hape re tla hloka ho eketsa domain name ya QuickSight lenaneng la ditumello. Sena se bonahala se makatsa, empa kaha tlas'a hood Q e boetse e sebelisa iframe, re hloka, bonyane hajoale, ho fana ka lenane la tumello "se tšoanang". Sebaka sa QuickSight seo u hlokang ho fana ka tumello se itšetlehile ka sebaka seo u se sebelisang. Bakeng sa mohlalaample, embedding sebelisa `us-ea bochabela-1' sebaka, rona URL lethathamo la tumello e tla ba:

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

The URL e ne e tla tšoana le libakeng tse ling, 'me karolo e fapaneng ea sebaka (us-bochabela-1) e fetotsoe.

Ho hlahisa lenaneo le lecha URL

Ntlha ea pele, karolo ea moralo oa embedding e hlahisang seboka URL ka GetSessionEmbedURL API e hloka ho fetoloa hanyane. Ho kenyeletsoa ha seshene sa QuickSight Q ho tšehetsoa 'nakong ea ho kena' e fapaneng ho feta boiphihlelo bo tloaelehileng bo kentsoeng. Litokomane tsa API ena li ka ba e fumanehang mona. Paramethara ea ho kena bakeng sa mohala ona oa API e tla hloka ho fetoloa - sebaka se secha sa ho kena se ipapisitse le taba ea tšebeliso ea sehlooho. Bakeng sa sehlooho se le seng:

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

Ho hlahisa lihlooho tsohle ho khetho, re tla siea sehloohoId:

entry-point = /q/search

Sena se lokela ho hlahisa se netefalitsoeng ka nako e le 'ngoe URL e tla fana ka leqephe le nang le bara ea ho batla ea QuickSight Q feela.

Ho sebelisa JS SDK ho Embed

Le le URL, re ka sebelisa SDK e fanoeng ea QuickSight Embedding Javascript ho emella sebaka sa ho batla sa Q ts'ebelisong. Ntlha ea pele, etsa bonnete ba hore u na le kopi ea SDK ho tsoa ho sehlopha sa QuickSight - hlokomela kaha sena ke peleview 'me ha e so lokolloe, SDK e tla ba mofuta o fapaneng ho feta o fumanehang phatlalatsa SDK ho github. Re tla batla ho sebelisa mokhoa oa EmbedSession ho tsoa ho SDK ka nako e hlahisitsoeng URL. Likhetho tse amehang bakeng sa ts'ebetso ea embedSession ke (e fumaneha hape ho mefuta.js ho 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

Likhang tse peli tse hlokahalang mona ke url le setshelo. Re tla sebelisa URL e hlahisoang ke getSessionEmbedURL Mohala oa API, 'me bakeng sa setshelo sena se ipapisitse le ts'ebeliso ea hau. U tla batla bonyane e bonolo joalo ka `setshelo' sa iframe e kentsoeng; fana ka sets'oants'o sena id 'me u fane ka id ho likhang tsa SDK. Seboka sa kamehla se kenyang li-callbacks, errorCallback le loadCallback etsa kamoo lebitso le ka u eletsang kateng - haeba u
hloka boitšoaro bo tloahelehileng ha leqephe le kentsoeng le laela, kapa le kopana le phoso, hlakisa mohopolo oo ho li-callback tsena. Ha u sebelisa mokhoa o kentsoeng oa Q ka SDK, iframe e tla ba bolelele bo tsitsitseng (bophahamo ba sebaka sa ho batla ka boeona) le bophara ba 100% ba setshelo sa motsoali oa HTML. Sena se bolela hore sebaka sa ho batla se tla ba bophara feela joaloka setshelo; u tla batla ho etsa bonnete ba hore sebaka sa ho batla se na le bonyane 600px ea bophara (ebang e fetoletsoe ho tsoa ho view-bophara/ka peresentetage kapa ka kotloloho). Bakeng sa setaele sa iframe, parameter ea className le eona e ka hlalosoa ka boikhethelo.

BOHLOKOA:
Ntho ea bohlokoa ka ho fetisisa mona ke ho etsa bonnete ba hore kapa karolo eo o e fetisang joalo ka karolo ea html ea sets'oants'o e na le setaele sa `boemo: absolute'. Sena ke sona se lumellang sebaka sa ho batla ho hola joalo ka sekoaelo ho fapana le ho theola likahare tsa sesebelisoa sa hau tlase.

Liphetoho tsa ho Kenya QuickSight Q

Ho na le liphapang tse 'maloa tsa bohlokoa lipakeng tsa seshene/dashboard e kenyellelitsoeng le ho kengoa bareng ea ho batla ea Q (leha hajoale ho kenyelletsoa ha Q ho sebelisa feela ho kenya seshene). Ka dashboard le seshene tse kenngoeng, foreime ka kakaretso e lekana le boholo bo le bong, e thibela ho fetola boholo bo itseng ho ipapisitsoe le boholo ba dashboard kapa leqephe la tlhahlobo. Ka Q, qalong foreimi e kentsoeng leqepheng la hau e batla e le nyane (re batla feela hore ho bonts'e sebaka sa sebele sa ho batla). Ha sebaka sa ho batla se ntse se sebelisoa, foreimi ena e hloka ho hola (ho bonts'a likarolo tse ling tse theohang joalo ka sephetho sa pono, litlhahiso, joalo-joalo). Ho holisa foreimi ena ntle le ho fetola likahare tsa kopo ea hau, re e beha e le sekoahelo holim'a leqephe le teng, joalo ka mokhoa oo sebaka sa ho batla se sebetsang ka har'a sesebelisoa sa QuickSight kajeno - bona linepe tse ka tlase.

Re na le hanyane mabapi le hore na ho kenya Q ho sebetsa joang kelellong, ha re shebeng liparamente tse khethehileng tsa SDK tsa QuickSight Q. Taba ea pele, re tla hloka isQEmbedded hore e beoe joalo ka 'nete. maxHeightForQ ke khang ea boikhethelo e hlalosang kholo ka ho fetisisa eo foreimi ea Q e ka bang teng leqepheng la hau; joalo ka ha ho boletsoe pejana, re tla hloka iframe le setshelo sa eona ho hola ho feta litaba tsa leqephe. Re ka sebelisa mantsoe a maxHeightForQ ho netefatsa hore foreime/setshelo ha se fete boholo ba leqephe la hau mme se etse hore moqolo o hlahe kapa boitšoaro bo bong bo sa batleheng. Haeba e sa beoa, foreimi ea Q e tla fetohela ho 100vh.

Liparamente tse peli tsa ho qetela tsa Q ke li-callback tse etsahalang ha foreimi e kentsoeng e fetoha. Boitšoaro bo sa feleng ke ho theha karolo e ka morao, 'me u sebelise sena ho fana ka chebahalo e lefifi eo re e bonang litšoantšong tse kaholimo ho sesebelisoa sa QuickSight. Ena ke 'ntle ho lebokose' ts'ebetso eo re batlang ho fana ka eona ho etsa hore Q e be bonolo kamoo ho ka khonehang - leha ho le joalo, rea tseba hore sena se ke ke sa sebetsa ts'ebelisong e 'ngoe le e 'ngoe eo Q e hlokang ho kengoa ho eona. Haeba u hloka ho etsa joalo. hlakola boits'oaro bona, ngola feela mabaka ho onQBarOpenCallback le onQBarCloseCallback. Sena se tla thibela sebopeho sa kamehla ho hlaha hape.

Likhetho tsa Setaele sa QuickSight Q

Ho na le likhetho tse 'maloa tsa setaele/cosmetic tseo re ka li sebelisang ho hlophisa ponahalo ea sebaka sa ho batla sa Q.

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

Haeba u batla ho tima letšoao la `Q' (ka letsohong le letšehali la sebaka sa ho batla, sebelisa parameter ea qBarIconDisabled. Ka mokhoa o ts'oanang, ho tima lebitso la sehlooho, haeba u hlahisa sehlooho se le seng feela ka mokhoa o kenyelelitsoeng, sebelisa qBarTopicNameDisabled. Ela hloko hore litlhophiso tsena tsa litlolo li fumaneha feela molemong oa ha u kenyelletsa sehlooho se le seng.
Haeba u batla ho beha sehlooho sa Q bar e kentsoeng ho etsa hore ponahalo e lumellane le ts'ebeliso ea hau, u ka etsa joalo ka ho theha sehlooho se secha ho QuickSight le ho fetisetsa themeId ho SDK (ex.ample ka tlase).

Examples

E latelang examples e tla nka hore ho na le sets'oants'o se teng ka har'a DOM se nang le id `q-bar-container'.

E Kenyelletsoa ka Mokhoa o Tloaelehileng oa Backdrop (ka tsela ea q/batla)

Ha re nke hore setshelo se na le bokaholimo ba 75px, kahoo re tla ikarabella bakeng sa seo re sebelisa parameter ea maxHeightForQ, e le hore iframe e se ke ea hola ho feta leqephe le lumellang, ho theha sebaka sa moqolo kapa boitšoaro bo bong bo sa batleheng.
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);
}

Ho Kenyelletsoa ka Boitšoaro ba Bokooa ba Bokooa (ka tsela ea q/batla)

Bakeng sa exampre tla nka hore setshelo se kaholimo ho leqephe kahoo se ka hola ho fihla ho 100% ntle le taba; re ke ke ra hloka maxHeightForQ. Re tla sebelisa onQBarOpenCallback le onQBarCloseCallback e le lits'ebetso tsa no-op ho thibela sebopeho sa kamehla ho hlaha.

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);
}

Ho Kenyelletsoa ka Boitšoaro bo Tloaelehileng ba Backdrop (ka tsela ea q/batla)

Re tla boela re nke hore setshelo se kaholimo ho leqephe kahoo se ka hola ho fihla ho 100% ntle le taba; re ke ke ra hloka maxHeightForQ. Re tla sebelisa onQBarOpenCallback le onQBarCloseCallback e le li-callback tse laolang likarolo tse ling tsa morao-rao (customBackdropComponent) ts'ebelisong ea rona eo re ka ratang ho e sebelisa sebakeng sa ea kamehla. Hlokomela hore mehala ea hau ea morao-rao e ka ba thata ho feta, mohlalaample ke molemong oa ho nolofatsa feela.

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);
}

E Kenyelletsoa ka Boitšoaro bo Felletseng ba Backdrop (ka tsela ea q/search/topicId)

Re tla boela re nke hore setshelo se na le karolo e ka holimo ea 75px, kahoo re tla ikarabella bakeng sa seo re sebelisa parameter ea maxHeightForQ, e le hore iframe e se ke ea eketseha ho feta leqephe le lumellang, ho theha sebaka sa moqolo kapa boitšoaro bo bong bo sa batleheng. Kaha re sebelisa sebaka sa ho batla se kenyelelitsoeng se nang le sehlooho se le seng, re ka sebelisa qBarIconDisabled le qBarTopicNameDisabled customizations. ExampLe tla re fa sebaka sa ho batla se se nang letšoao kapa lebitso la sehlooho, se ikemiselitseng ho botsa hore na ho fetisoa sehlooho sefe.

mosebetsi embedQSession(embedUrl) {
var containerDiv = document.getElementById("q-bar-container");
containerDiv.innerHTML = “”;
var params = {
url: kopaUrl,
setshelo: containerDiv,
isQEmbedded: 'nete,
maxHeightForQ: "calc(100vh - 75px)",
qBarIconDisabled: bohata,
qBarTopicNameDisabled: bohata,
};
QuickSightEmbedding.embedSession(params);
}

Ho Emahanya le Theme Id

Theha theme e ncha ka har'a QuickSight haeba u se na eona. Bula tlhahlobo, kapa u thehe e ncha. Khetha Lihlooho ka ho le letšehali.
Ebe u khetha e 'ngoe ea sehlooho seo u se ratang, ebe u tobetsa "Save as". Haeba u se u ntse u e-na le tema, u ka tlola mohato oa ho theha theme.

E tla u isa leqepheng la mohlophisi oa sehlooho, e fane ka lebitso, fetola 'mala kamoo u ratang kateng ebe u e boloka ka holimo ka ho le letona.

Kaha joale u na le sehlooho, u hloka ho fumana id ea sehlooho seo ebe u se fetisetsa ho SDK. Khetha "Edita" ho sehlooho seo u se entseng.

E tla u isa leqepheng la mohlophisi oa sehlooho, empa lekhetlong lena, u tla fumana id ea sehlooho moo ho url bar. Tabeng ena "d39c0065bf69-4b3d-927b-9dd3a241f094" ke id ea sehlooho seo ke se entseng.

Qetellong, o fetisetsa id ea sehlooho e le parameter ho SDK, ebe o tla fumana theme Q bar ho app ea hau.

mosebetsi embedQSession(embedUrl) {
var containerDiv = document.getElementById("q-bar-container");
containerDiv.innerHTML = “”;
var params = {
url: kopaUrl,
setshelo: containerDiv,
isQEmbedded: 'nete,
maxHeightForQ: "calc(100vh - 75px)“,
qBarIconDisabled: bohata,
qBarTopicNameDisabled: bohata,
themeId: “d39c0065-bf69-4b3d-927b-9dd3a241f094”
};
QuickSightEmbedding.embedSession(params);
}

Themeable Component

Re batla ho u bonts'a hore na ke likarolo life tse ka hare ho Q bar tse ka hlahisoang ka sehlooho, 'me re tla nka sehlooho sa QuickSight Midnight joalo ka ex.ample (o ka e fumana ho lihlooho tse qalang)

Ho batle phoso

'O hanne ho theha *.quicksight.aws.amazon.com hobane moholo o tlola molao..' Phoso

Phoso ena e bakoa ke ho se lumelle ho etsa lethathamo la domeine ea hau leqepheng la taolo la QuickSight ho sesebelisoa sa QuickSight. Etsa bonnete ba hore u lumella lethathamo la libaka tsa sebaka sa QuickSight (bakeng sa rona-bochabela-1, sena ke https://us-east-1.quicksight.aws.amazon.com , bakeng sa mohlalaample), hammoho le sebaka sa hau sa kopo.

Ha e khone ho Bona Batla ea Batla Ka mor'a ho Kenya ka Katleho

Haeba o khona ho hlahisa ka katleho le ho fihlella le ho kenya sehokelo (ho se na tumello kapa liphoso tse ling tse hlakileng), empa fumana 'sekheo' se se nang bar e hlahang, ho na le lintho tse 'maloa tseo u lokelang ho li hlahloba. E 'ngoe ke hore bonyane ho tlameha hore ho be le sehlooho se le seng se arolelanoang le mosebelisi eo u kenang le eena. Taba ea bobeli, u tla batla ho etsa bonnete ba hore ho na le bonyane sehlooho se le seng se thehiloeng ka katleho 'me se maemong a `katleho' ka mor'a ho aha qalong. Mokhoa o bonolo oa ho leka sena ke ho sebelisa sehlooho ho Q ts'ebelisong ea QuickSight; haeba e sebetsa ka mokhoa o tloaelehileng, ho molemo ho e sebelisa ka mokhoa o kentsoeng.

Lebaka le leng leo sebaka sa ho batla se kanna sa se hlahe ke hore sets'oants'o seo iframe e kenang ho sona e kanna ea se fane ka bophara bo lekaneng. Joalokaha ho boletsoe litokomaneng, u tla batla ho etsa bonnete ba hore sebaka sa ho batla se fuoa bonyane 600px ea bophara hore e sebetse ka mokhoa o tloaelehileng.

Sebaka sa ho Batla sea Atoloha Empa se Fetola Litaba Fatše

Sebaka sa ho batla se nang le SDK se etselitsoe ho hola ho feta litaba life kapa life tse ling tse leqepheng lena. Haeba ho se joalo, ka kopo etsa bonnete ba hore sets'oants'o sa patlo e ngotsoe ka `boemo: absolute', e tla e lumella ho se suthisetse litaba tsa leqephe fatše. Bakeng sa mohlalaampLe:

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

Lenane la phetoho ea SDK

• V1(5/15/21): Tloaelo ea pele `Q-ready' SDK
  • V1.1 (5/25/21)
    • Fetola bophahamo ba iframe hore bo be bophahamo ba bareng ea ho batla ka boyona, mosebelisi a ke ke a bolela ka mokhoa oa Q
    • Beha bophara ba iframe ho 100% ea setshelo sa motsoali bakeng sa Q mode. Hlokomela hore bophara ba sebaka sa ho batla se ntse se ka fokotsoa ke boholo ba setshelo sa motsoali.

Litokomane / Lisebelisoa

Amazon Q Embedding Developer Business service service [pdf] Bukana ea Mosebelisi Q Embedding Ts'ebeletso ea bohlale ba Khoebo ea Motšehetsi, Ts'ebeletso ea bohlale ba Khoebo ea Moetsi, ts'ebeletso ea bohlale

Litšupiso

• Bukana ea Mosebelisi