From 73d720e0d7a7217a53021e5e237d6a59882e1eea Mon Sep 17 00:00:00 2001 From: "tanyel.tuncer" Date: Tue, 1 Jun 2021 15:35:38 +0200 Subject: [PATCH 1/4] added web grid documentation --- support/WebGrid/intro.md | 48 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 support/WebGrid/intro.md diff --git a/support/WebGrid/intro.md b/support/WebGrid/intro.md new file mode 100644 index 0000000..ca8fd89 --- /dev/null +++ b/support/WebGrid/intro.md @@ -0,0 +1,48 @@ +# WebGrid + + The Plugin Simplic.WebGrid offers the possiblity to display grids in a browser +Follow these steps + +## 1.Create URL to display a grid in a browser + +The structure of such a url looks like this +``` +:/api/v1-0/webgrid/show?grid=&&api_key=&user_name= +``` +For example we look at the **Document Grid** +``` +http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=SuperUser +``` +### Conditions +We can place simple sql conditions +These operations are supported +|url-code| sql-operator | +|--|--| +| like | like | +|eq|=| +| neq | != | +| gt | > | +| gte | >= | +| sm | < | +| sme | <= | + +**Example** +In this Example we looking for all documents where the update user name is 'superuser' +``` +¶m_updateusername_eq=superuser +``` + +``` +http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample¶m_updateusername_eq=superuser&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=SuperUser +``` + +You can add more conditions afterwards + +## 2.Enable grid for the web grid +Only Grids that contain this statement in the sql statement will be shown +``` +-- enable-web-grid + ``` + + + From 5f125c6f3a9bb7c30eeb5df763c19445eb9c501d Mon Sep 17 00:00:00 2001 From: "tanyel.tuncer" Date: Thu, 3 Jun 2021 16:33:51 +0200 Subject: [PATCH 2/4] Fixed structure, fixed spelling --- support/{ => Misc}/WebGrid/intro.md | 11 ++++++----- support/Misc/intro.md | 3 +++ 2 files changed, 9 insertions(+), 5 deletions(-) rename support/{ => Misc}/WebGrid/intro.md (74%) create mode 100644 support/Misc/intro.md diff --git a/support/WebGrid/intro.md b/support/Misc/WebGrid/intro.md similarity index 74% rename from support/WebGrid/intro.md rename to support/Misc/WebGrid/intro.md index ca8fd89..3b027c6 100644 --- a/support/WebGrid/intro.md +++ b/support/Misc/WebGrid/intro.md @@ -1,6 +1,6 @@ # WebGrid - The Plugin Simplic.WebGrid offers the possiblity to display grids in a browser + The plugin Simplic.WebGrid offers the possiblity to display grids in a browser Follow these steps ## 1.Create URL to display a grid in a browser @@ -11,7 +11,7 @@ The structure of such a url looks like this ``` For example we look at the **Document Grid** ``` -http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=SuperUser +http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=DemoUser ``` ### Conditions We can place simple sql conditions @@ -27,13 +27,13 @@ These operations are supported | sme | <= | **Example** -In this Example we looking for all documents where the update user name is 'superuser' +In this example we are looking for all documents where the update user name is 'superuser' ``` ¶m_updateusername_eq=superuser ``` ``` -http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample¶m_updateusername_eq=superuser&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=SuperUser +http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample¶m_updateusername_eq=demouser&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=SuperUser ``` You can add more conditions afterwards @@ -43,6 +43,7 @@ Only Grids that contain this statement in the sql statement will be shown ``` -- enable-web-grid ``` + ## 3.Dependencies - + This plugin has a dependencie to SAC diff --git a/support/Misc/intro.md b/support/Misc/intro.md new file mode 100644 index 0000000..1d24661 --- /dev/null +++ b/support/Misc/intro.md @@ -0,0 +1,3 @@ +# Misc + +Contains small plugins \ No newline at end of file From b8afc18b47b48eb63171eab463ccdfe4bf6b3dc8 Mon Sep 17 00:00:00 2001 From: "tanyel.tuncer" Date: Thu, 3 Jun 2021 16:36:32 +0200 Subject: [PATCH 3/4] changed demokey --- support/Misc/WebGrid/intro.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/support/Misc/WebGrid/intro.md b/support/Misc/WebGrid/intro.md index 3b027c6..ee01f0d 100644 --- a/support/Misc/WebGrid/intro.md +++ b/support/Misc/WebGrid/intro.md @@ -11,7 +11,7 @@ The structure of such a url looks like this ``` For example we look at the **Document Grid** ``` -http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=DemoUser +http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample&api_key=demokey&user_name=DemoUser ``` ### Conditions We can place simple sql conditions @@ -33,7 +33,7 @@ In this example we are looking for all documents where the update user name is ' ``` ``` -http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample¶m_updateusername_eq=demouser&api_key=~ssk-b3c905c6716d4d28b6751645642acdc5&user_name=SuperUser +http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample¶m_updateusername_eq=demouser&api_key=demokey&user_name=SuperUser ``` You can add more conditions afterwards From e0af944333139b0c6de78240612893e3bdbae102 Mon Sep 17 00:00:00 2001 From: "tanyel.tuncer" Date: Wed, 30 Jun 2021 16:39:17 +0200 Subject: [PATCH 4/4] fixed the intro markdown for the wewbgrid --- support/Misc/WebGrid/intro.md | 58 +++++++++++++++++++++++++++++------ 1 file changed, 48 insertions(+), 10 deletions(-) diff --git a/support/Misc/WebGrid/intro.md b/support/Misc/WebGrid/intro.md index ee01f0d..be90249 100644 --- a/support/Misc/WebGrid/intro.md +++ b/support/Misc/WebGrid/intro.md @@ -1,19 +1,37 @@ # WebGrid - The plugin Simplic.WebGrid offers the possiblity to display grids in a browser -Follow these steps + The plugin Simplic.WebGrid offers the possiblity to display grids from the Simplic Studio in any internet browser + +To achieve this you need to follow these steps below ## 1.Create URL to display a grid in a browser -The structure of such a url looks like this +First open the browser of your choice, for example **Google Chrome** + +Now we need a URL and the structure looks like this ``` :/api/v1-0/webgrid/show?grid=&&api_key=&user_name= ``` -For example we look at the **Document Grid** +**Explanation for each placeholder** + +|Placeholder| Explanation | Example| +|--|--|--| +| ip-adress-web-api | The ip adress of the host/webapi | 192.168.99.181 +|port| The port of the host/webapi| 48080 +|grid-name|The name of the grid that should be displayed| IB_WebGrid_Sample +|conditions|Sql-like conditions to aggregate the data|param_barcode_eq=7744 +|api-key| The api key that is assigned to the user|demokey +|user-name|The name of the user| DemoUser + + + +So we get the following url + + ``` http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample&api_key=demokey&user_name=DemoUser ``` -### Conditions +### **Conditions** We can place simple sql conditions These operations are supported |url-code| sql-operator | @@ -26,6 +44,7 @@ These operations are supported | sm | < | | sme | <= | + **Example** In this example we are looking for all documents where the update user name is 'superuser' ``` @@ -33,17 +52,36 @@ In this example we are looking for all documents where the update user name is ' ``` ``` -http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample¶m_updateusername_eq=demouser&api_key=demokey&user_name=SuperUser +http://192.168.99.181:48080/api/v1-0/webgrid/show?grid=IB_WebGrid_Sample¶m_updateusername_eq=superuser&api_key=demokey&user_name=SuperUser ``` -You can add more conditions afterwards +You can add more conditions afterwards the first conditions -## 2.Enable grid for the web grid +## 2.Configurate a grid for the web grid Only Grids that contain this statement in the sql statement will be shown ``` -- enable-web-grid ``` - ## 3.Dependencies +For example +``` +-- enable-web-grid + +SELECT top 100 * FROM IT_Document +WHERE 1 = 1 +[WhereCondition] +Order By CreateDateTime +``` + +The [WhereCondition] is important for the **conditions** because that tag gets replaced by the conditions + + +**Grid Columns** - This plugin has a dependencie to SAC +It is very important to have the **BlobGuid** as a non active column in the grid. This column is responsible to display the document/data + + + + + ## 3.Dependencies + This plugin has a dependency to SAC