Amazon Q Embedding Developer Service Intelligence Business
Шартҳои пешакӣ
- Ҳисоби AWS бо QuickSight Q фаъол аст
- Ҳадди ақал як Мавзӯе, ки бо QuickSight Q насб карда шудааст (ва ID-и мавзӯи он мавзӯъ)
- Танзими чаҳорчӯбаи воридкунии сессияи QuickSight бо ҳисоби AWS
- Семинар барои ин: https://learnquicksight.workshop.aws/en/session-embedding.html
- Боварӣ ҳосил кунед, ки рӯйхати домени худро дар саҳифаи Идоракунии QuickSight иҷозат диҳед
Муайян кардани мавзӯъ(ҳо) барои намоиш
Ҷойгиркунии QuickSight Q ду ҳолати гуногуни истифодаи мавзӯъҳоро дастгирӣ мекунад. Якум ин аст, ки вақте як мавзӯъ бояд муайян карда шавад ва танҳо он мавзӯъро тавассути сатри ҷустуҷӯ дархост кардан мумкин аст. Дуюм ин таҷрибаи стандартӣ дар доираи барномаи QuickSight мебошад, ки дар он корбар рӯйхати мавзӯъҳо дорад ва метавонад дар сатри ҷустуҷӯ барои интихоби мавзӯъе, ки мехоҳанд бар онҳо дархост кунанд, афтандаро истифода барад. Пеш аз идома додан, боварӣ ҳосил кунед, ки оё парвандаи истифодаи шумо як мавзӯъро талаб мекунад ё рӯйхати мавзӯъҳо дар таҷрибаи дарунсохт.
Рӯйхати домени иҷозатдодашуда
Мувофиқи дастурҳои ҷобаҷокунии QuickSight, шумо хоҳед дид, ки шумо бояд дар саҳифаи 'Идоракунии QuickSight' рӯйхати домени барномаи худро иҷозат диҳед. Одатан, ин ҳама ба шумо лозим аст, аммо дар ҳолати Q мо инчунин бояд домени QuickSight-ро ба рӯйхати иҷозатдодашуда илова кунем. Ин аҷиб ба назар мерасад, аммо азбаски дар зери капот Q низ iframe-ро истифода мебарад, ба мо лозим аст, ки ҳадди аққал ҳоло ба рӯйхати домени 'ҳамон' иҷозат дода шавад. Домени QuickSight, ки ба шумо рӯйхати иҷозат додан лозим аст, аз минтақае, ки шумо истифода мебаред, вобаста аст. Барои мисолampле, бо истифода аз минтаќаи `us-шарк-1», мо URL Рӯйхати иҷозатдодашуда чунин хоҳад буд:
https://us-east-1.quicksight.aws.amazon.com
Дар URL барои дигар минтақаҳо низ ҳамин тавр хоҳад буд ва қисми дахлдори минтақавӣ (us-шарқ-1) иваз карда мешавад.
Эҷоди сессияи нав URL
Аввал қисми чаҳорчӯбаи дохилкунӣ, ки сессияро тавлид мекунад URL тавассути getSessionEmbedURL API бояд каме тағир дода шавад. Ҷойгиркунии сессияи QuickSight Q дар "нуқтаи вуруд" аз таҷрибаи дарунсохташудаи консолии стандартӣ дастгирӣ карда мешавад. Ҳуҷҷатҳо барои ин API метавонад бошад дар ин ҷо ёфт. Параметри нуқтаи вуруд барои ин занги API бояд тағир дода шавад - нуқтаи нави воридшавӣ аз ҳолати истифодаи мавзӯъ(ҳо) вобаста аст. Барои як мавзӯи ягона:
entry-point = /q/search/<topicId>
Барои нишон додани ҳама мавзӯъҳо дар селектор, мо topicId-ро сарфи назар мекунем:
entry-point = /q/search
Ин бояд тасдиқи яквақта тавлид кунад URL ки саҳифаро танҳо бо сатри ҷустуҷӯи QuickSight Q пешкаш мекунад.
Истифодаи JS SDK барои ворид кардан
Бо URL, мо метавонем QuickSight Embedding Javascript SDK-ро барои ворид кардани сатри ҷустуҷӯи Q дар барнома истифода барем. Аввалан, боварӣ ҳосил кунед, ки шумо дорои нусхаи SDK аз дастаи QuickSight - қайд кунед, зеро ин пешакӣ астview хусусият ва ҳанӯз бароварда нашудааст, SDK версияи дигар аз версияи дастраси оммавӣ хоҳад буд SDK дар github. Мо мехоҳем усули EmbedSession-ро аз SDK бо сессияи тавлидшуда истифода барем URL. Вариантҳои мувофиқ барои функсияи embedSession инҳоянд (инчунин дар type.js дар 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
Ду далели зарурӣ дар ин ҷо ҳастанд url ва контейнер. Мо истифода мебарем URL аз getSessionEmbed тавлид шудаастURL занги API, ва барои контейнер ин аз барномаи шумо вобаста аст. Шумо ҳадди аққал як чизи оддӣ мехоҳед ҳамчун "контейнер" барои iframe дохилшуда; ба ин контейнер ID диҳед ва идентификаторро дар далелҳои SDK гузаронед. Сеанси пешфарз бо ворид кардани зангҳои бозгашт, errorCallback ва loadCallback ҳамон тавре ки ном пешниҳод мекунад, иҷро мекунад - агар шумо
ҳангоми бор кардани саҳифаи дарунсохт ё бо хатогӣ дучор шудан ба рафтори фармоишӣ лозим аст, ин мантиқро дар ин зангҳои бозгашт муайян кунед. Ҳангоми истифодаи Q-и дарунсохт бо SDK, iframe баландии собит (баландии худи сатри ҷустуҷӯ) ва 100% паҳнои контейнери HTML-и волидайн хоҳад буд. Ин маънои онро дорад, ки сатри ҷустуҷӯ танҳо ба андозаи контейнер васеъ хоҳад буд; шумо мехоҳед боварӣ ҳосил кунед, ки сатри ҷустуҷӯ ҳадди аққал 600px паҳнӣ дорад (хоҳ аз тарҷума view-васеъ/фоизtagд ё бевосита таъин карда мешавад). Барои ороиши iframe, параметри className-ро низ ихтиёран метавон муайян кард.
МУҲИМ:
Дар ин ҷо як ишораи асосӣ ин аст, ки боварӣ ҳосил кунед, ки ё ҷузъе, ки шумо ҳамчун унсури html контейнер мегузаред, дорои услуби "мавқеъ: мутлақ" мебошад. Ин аст он чизе, ки имкон медиҳад, ки сатри ҷустуҷӯ ба ҷои иваз кардани мундариҷаи барномаи шумо ҳамчун қабат васеъ карда шавад.
Тағироти воридкунии QuickSight Q
Якчанд фарқиятҳои калидӣ дар байни сеанс / панели асбобҳо ва ҷобаҷогузории сатри ҷустуҷӯ мавҷуданд (гарчанде ки дар айни замон Q ҷойгиркунии сеансро истифода мебарад). Бо панели асбобҳо ва ҷобаҷогузории сессия, чаҳорчӯба умуман як андозаи ягона аст ва баъзе тағир додани андозаро дар асоси андозаи панели асбобҳо ё варақи таҳлил манъ мекунад. Бо Q, дар аввал чаҳорчӯбаи дарунсохт дар саҳифаи шумо нисбатан хурд аст (мо танҳо мехоҳем, ки сатри воқеии ҷустуҷӯ нишон дода шавад). Вақте ки сатри ҷустуҷӯ истифода мешавад, ин чаҳорчӯба бояд васеъ шавад (барои нишон додани унсурҳои иловагии афтанда ба монанди натиҷаи визуалӣ, пешниҳодҳо ва ғайра). Барои васеъ кардани ин чаҳорчӯба бидуни тағир додани мундариҷаи замимаи шумо, мо онро танҳо ҳамчун қабати болои саҳифаи мавҷуда насб кардем, ба он монанде, ки имрӯз сатри ҷустуҷӯ дар замимаи QuickSight кор мекунад - ба скриншотҳои зер нигаред.
Бо каме дар бораи чӣ гуна кор кардани Q embedding, биёед ба параметрҳои мушаххаси SDK QuickSight Q назар кунем. Аввалан, ба мо лозим аст, ки isQEmbedded ҳамчун ҳақиқӣ муқаррар карда шавад. maxHeightForQ як далели ихтиёрӣ аст, ки бузургтарин чаҳорчӯбаи Q-ро дар саҳифаи шумо муайян мекунад; Тавре ки қаблан зикр гардид, ба мо iframe ва контейнери он лозим аст, то мундариҷаи саҳифаро васеъ кунем. Мо метавонем аргументи maxHeightForQ-ро истифода барем, то боварӣ ҳосил кунем, ки чаҳорчӯба/контейнер аз баландии максималии саҳифаи шумо тағир наёбад ва боиси пайдо шудани ҳаракат ё дигар рафтори номатлуб нашавад. Агар муқаррар карда нашавад, чаҳорчӯбаи Q ба андозаи 100vh тағир меёбад.
Ду параметри махсуси Q охирин зангҳои бозгашт мебошанд, ки ҳангоми тағир додани андозаи чаҳорчӯбаи воридшуда ба амал меоянд. Рафтори пешфарз ин эҷод кардани унсури пасзамина мебошад ва онро барои додани намуди заминае, ки мо дар скриншотҳои боло аз барномаи QuickSight мебинем, истифода баред. Ин функсияи "аз қуттӣ" аст, ки мо мехоҳем барои ба қадри имкон осон кардани воридкунии Q таъмин кунем – аммо мо медонем, ки ин барои ҳар як барномае, ки Q бояд дар он ворид карда шавад, кор намекунад. Агар шумо лозим ояд, ин рафторро бекор кунед, танҳо мантиқро ба onQBarOpenCallback ва onQBarCloseCallback нависед. Ин инчунин намоиши пасзаминаи пешфарзро пешгирӣ мекунад.
Имконоти услуби QuickSight Q
Якчанд вариантҳои ороишӣ/косметикӣ мавҷуданд, ки мо метавонем онҳоро барои танзими намуди сатри ҷустуҷӯи 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
Агар шумо хоҳед, ки тасвири `Q'-ро ғайрифаъол кунед (дар тарафи чапи сатри ҷустуҷӯ, параметри qBarIconDisabled -ро истифода баред. Ба ҳамин монанд, барои ғайрифаъол кардани номи мавзӯъ, агар шумо танҳо як мавзӯи ягонаро дар реҷаи дохилшуда намоиш дода бошед, qBarTopicNameDisabled -ро истифода баред. Дар хотир доред, ки ин мутобиқсозии косметикӣ танҳо барои ҳолатҳое дастрасанд, ки шумо як мавзӯъро ворид мекунед.
Агар шумо хоҳед, ки сатри Q-и дарунсохтро мавзӯъ созед, то намуди зоҳирӣ ба замимаи шумо мувофиқ бошад, шумо метавонед ин корро тавассути сохтани мавзӯи нав дар QuickSight анҷом диҳед ва themeId-ро ба SDK (масалан) интиқол диҳед.ampдар зер).
Examples
Собиқ зеринamples тахмин мекунад, ки дар DOM контейнер мавҷуд аст, ки id `q-bar-container' аст.
Ҷойгиркунӣ бо рафтори пасзаминаи пешфарз (бо роҳи q/ҷустуҷӯ)
Биёед фарз кунем, ки контейнер дорои маржа аз 75px аст, бинобар ин мо онро бо истифода аз параметри maxHeightForQ ҳисоб мекунем, то iframe аз саҳифаи иҷозатдодашуда васеътар нашавад, сатри ҳаракат ё дигар рафтори номатлубро эҷод кунад.
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);
}
Ҷойгиркунӣ бо рафтори пасзаминаи ғайрифаъол (бо роҳи q/ҷустуҷӯ)
Барои ин собикample мо фарз мекунем, ки контейнер дар болои саҳифа ҷойгир аст, то он метавонад то 100% бидуни мушкилот васеъ шавад; мо ба maxHeightForQ ниёз нахоҳем дошт. Мо onQBarOpenCallback ва onQBarCloseCallback-ро ҳамчун функсияҳои ғайрифаъол истифода мебарем, то пайдо шудани пасзаминаи пешфарзро пешгирӣ кунем.
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);
}
Ҷойгиркунӣ бо рафтори пасзаминаи фармоишӣ (бо роҳи q/ҷустуҷӯ)
Мо боз тахмин мезанем, ки контейнер дар болои саҳифа ҷойгир аст, то он метавонад то 100% бидуни мушкилот васеъ шавад; мо ба maxHeightForQ ниёз нахоҳем дошт. Мо onQBarOpenCallback ва onQBarCloseCallbackро ҳамчун зангҳои бозпас истифода мебарем, ки баъзе ҷузъҳои дигари пасзаминаро (customBackdropComponent) дар замимаи мо идора мекунанд, ки мо мехоҳем ба ҷои пешфарз истифода барем. Аҳамият диҳед, ки зангҳои пасзаминаи шумо шояд мураккабтар бошанд, масаланample танҳо барои содда аст.
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);
}
Ҷойгиркунӣ бо рафтори пасзаминаи пешфарз (бо роҳи q/search/topicId)
Мо бори дигар тахмин мезанем, ки контейнер дорои маржа аз 75px аст, бинобар ин мо онро бо истифода аз параметри maxHeightForQ ҳисоб мекунем, то iframe аз саҳифаи иҷозатдодашуда васеътар нашавад ва сатри ҳаракат ё дигар рафтори номатлубро эҷод кунад. Азбаски мо сатри ҷустуҷӯии дарунсохтро бо як мавзӯъ истифода мебарем, мо метавонем мутобиқсозии qBarIconDisabled ва qBarTopicNameDisabled -ро истифода барем. Ин собикample ба мо як сатри ҷустуҷӯро бидуни нишона ё номи мавзӯъ медиҳад, ки барои пурсиш дар ҳар як мавзӯъи ID-и воридшуда омода аст.
функсия embedQSession (embedUrl) {
var containerDiv = document.getElementById("q-бар-контейнер");
containerDiv.innerHTML = "";
var params = {
url: ҷойгир кунедUrl,
контейнер: containerDiv,
isQEmbedded: дуруст,
maxHeightForQ: "ҳисоб (100vh - 75px)",
qBarIconDisabled: бардурӯғ,
qBarTopicNameDisabled: бардурӯғ,
};
QuickSightEmbedding.embedSession(params);
}
Ҷойгиркунӣ бо ID-и мавзӯъ
Дар дохили QuickSight мавзӯи нав эҷод кунед, агар шумо надошта бошед. Таҳлил кушоед ё таҳлили нав эҷод кунед. Мавзӯъҳоро дар тарафи чап интихоб кунед.
Ва он гоҳ яке аз мавзӯъҳои ибтидоии ба шумо маъқулро интихоб кунед ва "Захира ҳамчун" -ро клик кунед. Агар шумо аллакай мавзӯъ дошта бошед, шумо метавонед қадами эҷоди мавзӯъро гузаред.
Он шуморо ба саҳифаи муҳаррири мавзӯъ мебарад, ба он ном диҳед, рангро мувофиқи дилхоҳатон танзим кунед ва онро дар тарафи рости боло захира кунед.
Акнун, ки шумо мавзӯъ доред, шумо бояд ID-и он мавзӯъро пайдо кунед ва онро ба SDK интиқол диҳед. Дар мавзӯи эҷодкардаатон "Таҳрир" -ро интихоб кунед.
Он шуморо боз ба саҳифаи муҳаррири мавзӯъ мебарад, аммо ин дафъа шумо ID-и мавзӯъро дар он ҷо хоҳед ёфт url бар. Дар ин ҳолат "d39c0065bf69-4b3d-927b-9dd3a241f094" идентификатсияи мавзӯъест, ки ман офаридаам.
Ниҳоят, шумо ID-и мавзӯъро ҳамчун параметр ба SDK мегузоред, пас шумо дар барномаи худ сатри мавзӯӣ Q-ро хоҳед гирифт.
функсия embedQSession (embedUrl) {
var containerDiv = document.getElementById("q-бар-контейнер");
containerDiv.innerHTML = "";
var params = {
url: ҷойгир кунедUrl,
контейнер: containerDiv,
isQEmbedded: дуруст,
maxHeightForQ: "calc (100vh - 75px)",
qBarIconDisabled: бардурӯғ,
qBarTopicNameDisabled: бардурӯғ,
мавзӯъ ID: “d39c0065-bf69-4b3d-927b-9dd3a241f094”
};
QuickSightEmbedding.embedSession(params);
}
Компоненти мавзӯъ
Мо мехоҳем ба шумо нишон диҳем, ки кадом ҷузъҳои дар дохили Q bar мавзӯӣ буда метавонанд ва мо мавзӯи QuickSight Midnight-ро ҳамчун собиқ истифода хоҳем кард.ample (шумо метавонед онро дар мавзӯъҳои ибтидоӣ пайдо кунед)
Мушкилкушо
'Аз кадр кардан даст кашид*.quicksight.aws.amazon.com зеро ниёгон вайрон мекунад..' Хато
Ин хато дар он аст, ки иҷозат надодани номгӯи домени шумо дар саҳифаи идоракунии QuickSight дар барномаи QuickSight. Боварӣ ҳосил кунед, ки ба рӯйхати ҳарду домени минтақавии QuickSight иҷозат диҳед (барои us-east-1, ин аст https://us-east-1.quicksight.aws.amazon.com , барои мисолample), инчунин домени барномаи шумо.
Пас аз воридкунии бомуваффақият сатри ҷустуҷӯро дидан мумкин нест
Агар шумо тавонед бомуваффақият тавлид ва дастрасӣ ва ҷобаҷогузории истинодро дошта бошед (бе иҷозат ё дигар хатогиҳои ошкор), аммо экрани “холи” бе ягон сатри ҷустуҷӯ пайдо нашавад, чанд чизро тафтиш кардан лозим аст. Яке аз он аст, ки ҳадди аққал як мавзӯъ бо корбаре, ки шумо бо он ворид кардаед, мубодила карда шавад. Дуюм, шумо мехоҳед боварӣ ҳосил кунед, ки ҳадди аққал як мавзӯъе вуҷуд дорад, ки бомуваффақият сохта шудааст ва пас аз бунёди аввал дар ҳолати "муваффақ" аст. Роҳи осони санҷиши ин танҳо истифодаи мавзӯъ дар Q дар замимаи QuickSight мебошад; агар он муътадил кор кунад, дар реҷаи дохилӣ истифода бурдан хуб аст.
Сабаби дигари пайдо нашудани сатри ҷустуҷӯ дар он аст, ки контейнери дарунсохти iframe дар он аст, ки метавонад паҳнои кофӣ надиҳад. Тавре ки дар ҳуҷҷатҳо зикр шудааст, шумо мехоҳед боварӣ ҳосил кунед, ки сатри ҷустуҷӯ ҳадди аққал 600px паҳнӣ дода шудааст, то он муқаррарӣ кор кунад.
Панели ҷустуҷӯ васеъ мешавад, аммо мундариҷаро ба поён мекӯчонад
Сатри ҷустуҷӯ бо SDK барои васеъ кардани ҳама мундариҷаи иловагӣ дар саҳифа тарҳрезӣ шудааст. Агар ин тавр набошад, лутфан ба контейнери сатри ҷустуҷӯ боварӣ ҳосил кунед бо услуби "мавқеъ: мутлақ" тарҳрезӣ шудааст, ки ба он имкон медиҳад, ки мундариҷаи саҳифаро ба поён нагузаронад. Барои мисолampле:
<div id="q-search-container" style="position: absolute; width: 100%"></div>
Сабти тағирёбии SDK Revision
- V1 (5/15/21): SDK фармоишии ибтидоии `Q-тайёр'
- V1.1 (5/25/21)
- Баландии iframe-ро тағир диҳед, то ба баландии худи сатри ҷустуҷӯ собит шавад, корбар наметавонад дар ҳолати Q муайян кунад
- Бари iframe-ро ба 100% контейнери волидайн барои ҳолати Q муқаррар кунед. Дар хотир доред, ки паҳнои сатри ҷустуҷӯ ҳоло ҳам метавонад бо андозаи контейнери волидайн маҳдуд карда шавад.
- V1.1 (5/25/21)
Ҳуҷҷатҳо / Сарчашмаҳо
 |
Amazon Q Embedding Developer Service Intelligence Business [pdf] Дастури корбар Q Embedding Developer Service Intelligence Business, Developer Service Intelligence Business, Service Intelligence |
