-
Notifications
You must be signed in to change notification settings - Fork 0
added web grid documentation #102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NexQueek
wants to merge
4
commits into
master
Choose a base branch
from
e_webgrid
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
# WebGrid | ||
|
||
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 | ||
|
||
First open the browser of your choice, for example **Google Chrome** | ||
|
||
Now we need a URL and the structure looks like this | ||
``` | ||
<ip-adress-web-api>:<port>/api/v1-0/webgrid/show?grid=<grid-name>&<conditions[optional]>&api_key=<api-key>&user_name=<user-name> | ||
``` | ||
**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** | ||
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 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=demokey&user_name=SuperUser | ||
``` | ||
|
||
You can add more conditions afterwards the first conditions | ||
|
||
## 2.Configurate a grid for the web grid | ||
Only Grids that contain this statement in the sql statement will be shown | ||
``` | ||
-- enable-web-grid | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Explain why and how (security reason, ...) |
||
``` | ||
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** | ||
|
||
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Misc | ||
|
||
Contains small plugins |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Better use localhost here