def setUp(self):
url = 'ws://localhost:4848/app'
self.conn = EngineCommunicator(url)
self.ega = EngineGlobalApi(self.conn)
self.eaa = EngineAppApi(self.conn)
self.egoa = EngineGenericObjectApi(self.conn)
self.efa = EngineFieldApi(self.conn)
self.struct = Structs()
self.app = self.ega.create_app("TestApp")["qAppId"]
opened_app = self.ega.open_doc(self.app)
self.app_handle = self.ega.get_handle(opened_app['qReturn'])
with open('./test/test_data/ctrl00_script.qvs') as f:
script = f.read()
self.eaa.set_script(self.app_handle, script)
self.eaa.do_reload_ex(self.app_handle)
nx_page_initial = Structs.nx_page(0, 0, 26, 1)
self.lb_def = Structs.list_object_def("$", "",
["Alpha"],
None,
None,
[nx_page_initial])
self.lb_param = {"qInfo": {"qId": "SLB01", "qType": "ListObject"},
"qListObjectDef": self.lb_def}
self.lb_sobject = self.eaa.create_session_object(self.app_handle,
self.lb_param)
self.lb_handle = self.ega.get_handle(self.lb_sobject["qReturn"])
self.egoa.get_layout(self.lb_handle)
self.lb_field = self.eaa.get_field(self.app_handle, "Alpha")
self.fld_handle = self.ega.get_handle(self.lb_field["qReturn"])
def getDataFrame(connection, appHandle, measures, dimensions, selections={}):
engineGlobalApi = EngineGlobalApi(connection)
# Define Dimensions of hypercube
hc_inline_dim = Structs.nx_inline_dimension_def(dimensions)
# Set sorting of Dimension by Measure
hc_mes_sort = Structs.nx_sort_by()
# Define Measure of hypercube
hc_inline_mes = Structs.nx_inline_measure_def(measures)
# Build hypercube from above definition
hc_dim = Structs.nx_hypercube_dimensions(hc_inline_dim)
hc_mes = Structs.nx_hypercube_measure(hc_mes_sort, hc_inline_mes)
width = len(measures) + len(dimensions)
height = int(math.floor(10000 / width))
nx_page = Structs.nx_page(0, 0, height, width)
hc_def = Structs.hypercube_def("$", hc_dim, hc_mes, [nx_page])
engineAppApi = EngineAppApi(connection)
hc_response = engineAppApi.create_object(appHandle, "CH01", "Chart",
"qHyperCubeDef", hc_def) # NOQA
hc_handle = engineGlobalApi.get_handle(hc_response)
engineGenericObjectApi = EngineGenericObjectApi(connection)
engineFieldApi = EngineFieldApi(connection)
for field in selections.keys():
fieldHandle = engineGlobalApi.get_handle(
engineAppApi.get_field(appHandle, field)) # NOQA
values = []
for selectedValue in selections[field]:
values.append({'qText': selectedValue})
engineFieldApi.select_values(fieldHandle, values)
i = 0
while i % height == 0:
nx_page = Structs.nx_page(i, 0, height, width)
hc_data = engineGenericObjectApi.get_hypercube_data(
hc_handle, "/qHyperCubeDef", [nx_page]) # NOQA
elems = hc_data["qDataPages"][0]['qMatrix']
df = pd.DataFrame()
for elem in elems:
j = 0
for dim in dimensions:
df.set_value(i, dim, elem[j]["qText"])
j += 1
for meas in measures:
df.set_value(i, meas, elem[j]["qNum"])
j += 1
i += 1
return df
def setUp(self):
url = 'ws://localhost:4848/app'
self.conn = EngineCommunicator(url)
self.ega = EngineGlobalApi(self.conn)
self.eaa = EngineAppApi(self.conn)
self.egoa = EngineGenericObjectApi(self.conn)
self.efa = EngineFieldApi(self.conn)
self.struct = Structs()
self.app = self.ega.create_app("TestApp")['qAppId']
opened_app = self.ega.open_doc(self.app)
self.app_handle = self.ega.get_handle(opened_app['qReturn'])
class TestFieldApi(unittest.TestCase):
def setUp(self):
url = 'ws://localhost:4848/app'
self.conn = EngineCommunicator(url)
self.ega = EngineGlobalApi(self.conn)
self.eaa = EngineAppApi(self.conn)
self.egoa = EngineGenericObjectApi(self.conn)
self.efa = EngineFieldApi(self.conn)
self.struct = Structs()
self.app = self.ega.create_app("TestApp")["qAppId"]
opened_app = self.ega.open_doc(self.app)
self.app_handle = self.ega.get_handle(opened_app['qReturn'])
with open('./test/test_data/ctrl00_script.qvs') as f:
script = f.read()
self.eaa.set_script(self.app_handle, script)
self.eaa.do_reload_ex(self.app_handle)
nx_page_initial = Structs.nx_page(0, 0, 26, 1)
self.lb_def = Structs.list_object_def("$", "",
["Alpha"],
None,
None,
[nx_page_initial])
self.lb_param = {"qInfo": {"qId": "SLB01", "qType": "ListObject"},
"qListObjectDef": self.lb_def}
self.lb_sobject = self.eaa.create_session_object(self.app_handle,
self.lb_param)
self.lb_handle = self.ega.get_handle(self.lb_sobject["qReturn"])
self.egoa.get_layout(self.lb_handle)
self.lb_field = self.eaa.get_field(self.app_handle, "Alpha")
self.fld_handle = self.ega.get_handle(self.lb_field["qReturn"])
def test_select_values(self):
values_to_select = [{'qText': 'A'}, {'qText': 'B'}, {'qText': 'C'}]
sel_res = self.efa.select_values(self.fld_handle, values_to_select)
self.assertTrue(sel_res["qReturn"] is True,
"Failed to perform selection")
val_mtrx = self.egoa.get_layout(self.lb_handle)["qLayout"]["qListObject"]["qDataPages"][0]["qMatrix"] # NOQA
self.assertEqual(val_mtrx[0][0]["qState"],
"S",
"Failed to select first value")
self.assertEqual(val_mtrx[4][0]["qState"],
"X",
"Failed to exclude fifth value")
self.eaa.clear_all(self.app_handle)
val_mtrx = self.egoa.get_layout(self.lb_handle)["qLayout"]["qListObject"]["qDataPages"][0]["qMatrix"] # NOQA
self.assertEqual(val_mtrx[0][0]["qState"],
"O",
"Failed to clear selection")
self.assertEqual(val_mtrx[4][0]["qState"],
"O",
"Failed to clear selection")
def tearDown(self):
self.ega.delete_app(self.app)
self.conn.close_qvengine_connection(self.conn)
import pyqlikengine.engine_app_api
import pyqlikengine.engine_generic_object_api
import pyqlikengine.engine_field_api
import pyqlikengine.structs
host = "sense.cloudera.qlik.com"
proxyPrefix = "jwt"
userDirectory = "SENSE.CLOUDERA.QLIK.COM"
userId = "qlikservice"
privateKey = "./private.key"
conn = SecureEngineCommunicator(host, proxyPrefix, userDirectory, userId, privateKey)
efa = pyqlikengine.engine_field_api.EngineFieldApi(conn)
Structs = pyqlikengine.structs.Structs()
egoa = pyqlikengine.engine_generic_object_api.EngineGenericObjectApi(conn)
ega = EngineGlobalApi(conn)
eaa = EngineAppApi(conn)
conn.ws.recv()
apps = ega.get_doc_list()
### List Apps available (identify the App GUID to open)
for app in apps:
print(app['qTitle'])
### Connect to desired app
opened_app = ega.open_doc('2aee2dca-baa6-4010-820a-2f4cea439356') ##Executive Dashboard
app_handle = ega.get_handle(opened_app)
### Define Dimensions of hypercube
hc_inline_dim = Structs.nx_inline_dimension_def(["Customer","Order Number"])
class TestAppApi(unittest.TestCase):
# Constructor to prepare everything before running the tests.
def setUp(self):
url = 'ws://localhost:4848/app'
self.conn = EngineCommunicator(url)
self.ega = EngineGlobalApi(self.conn)
self.eaa = EngineAppApi(self.conn)
self.egoa = EngineGenericObjectApi(self.conn)
self.efa = EngineFieldApi(self.conn)
self.struct = Structs()
self.app = self.ega.create_app("TestApp")['qAppId']
opened_app = self.ega.open_doc(self.app)
self.app_handle = self.ega.get_handle(opened_app['qReturn'])
def test_add_alternate_state(self):
response = self.eaa.add_alternate_state(self.app_handle, "MyState")
self.assertEqual(response, {}, "Failed to add alternate state")
def test_create_hypercube_object(self):
with open('./test/test_data/ctrl00_script.qvs') as f:
script = f.read()
self.eaa.set_script(self.app_handle, script)
self.eaa.do_reload_ex(self.app_handle)
# Create the inline dimension structures
hc_inline_dim1 = Structs.nx_inline_dimension_def(["Alpha"])
hc_inline_dim2 = Structs.nx_inline_dimension_def(["Num"])
# Create a sort structure
hc_mes_sort = Structs.nx_sort_by()
# Create the measure structures
hc_inline_mes1 = Structs.nx_inline_measure_def("=Sum(Num)")
hc_inline_mes2 = Structs.nx_inline_measure_def("=Avg(Num)")
# Create hypercube dimensions from the inline dimension structures
hc_dim1 = Structs.nx_hypercube_dimensions(hc_inline_dim1)
hc_dim2 = Structs.nx_hypercube_dimensions(hc_inline_dim2)
# Create hypercube measures from the inline measure structures
hc_mes1 = Structs.nx_hypercube_measure(hc_mes_sort, hc_inline_mes1)
hc_mes2 = Structs.nx_hypercube_measure(hc_mes_sort, hc_inline_mes2)
# Create the paging model/structure (26 rows and 4 columns)
nx_page = Structs.nx_page(0, 0, 26, 4)
# Create a hypercube definition with arrays of
# hc dims, measures and nxpages
hc_def = Structs.hypercube_def("$", [hc_dim1, hc_dim2],
[hc_mes1, hc_mes2], [nx_page])
# Create a Chart object with the hypercube definitions as parameter
hc_response = self.eaa.create_object(self.app_handle, "CH01", "Chart",
"qHyperCubeDef", hc_def)
# Get the handle to the chart object (this may be different
# in my local repo. I have made some changes to thisfor
# future versions)
hc_handle = self.ega.get_handle(hc_response['qReturn'])
# Validate the chart object by calling get_layout
self.egoa.get_layout(hc_handle)
# Call the get_hypercube_data to get the resulting json object,
# using the handle and nx page as paramters
hc_data = self.egoa.get_hypercube_data(hc_handle, "/qHyperCubeDef",
[nx_page])
self.assertTrue(type(hc_data is {}),
"Unexpected type of hypercube data")
first_element_number = hc_data["qDataPages"][0]["qMatrix"][0][0][
"qElemNumber"] # NOQA
first_element_text = hc_data["qDataPages"][0]["qMatrix"][0][0][
"qText"] # NOQA
self.assertTrue(first_element_number == 0,
"Incorrect value in first element number")
self.assertTrue(first_element_text == 'A',
"Incorrect value in first element text")
def tearDown(self):
self.ega.delete_app(self.app)
self.conn.close_qvengine_connection(self.conn)
from pyqlikengine.engine_communicator import EngineCommunicator from pyqlikengine.engine_global_api import EngineGlobalApi from pyqlikengine.engine_app_api import EngineAppApi from pyqlikengine.engine_communicator import SecureEngineCommunicator host = "cloudera.qlik.com" proxyPrefix = "jupyter" userDirectory = "CLOUDERA" userId = "user_1" privateKey = "./private.key" conn = SecureEngineCommunicator(host, proxyPrefix, userDirectory, userId, privateKey) ega = EngineGlobalApi(conn) eaa = EngineAppApi(conn) conn.ws.recv() import pyqlikengine.engine_communicator import pyqlikengine.engine_global_api import pyqlikengine.engine_app_api import pyqlikengine.engine_generic_object_api import pyqlikengine.engine_field_api import pyqlikengine.structs conn = SecureEngineCommunicator(host, proxyPrefix, userDirectory, userId, privateKey) efa = pyqlikengine.engine_field_api.EngineFieldApi(conn) Structs = pyqlikengine.structs.Structs() egoa = pyqlikengine.engine_generic_object_api.EngineGenericObjectApi(conn) ega = EngineGlobalApi(conn) eaa = EngineAppApi(conn) conn.ws.recv() apps = ega.get_doc_list()