Repository: incubator-griffin Updated Branches: refs/heads/master d6854bb9e -> e74814e59
Update UI docoments Update UI docoments Author: dodobel <1254288...@qq.com> Closes #231 from dodobel/button. Project: http://git-wip-us.apache.org/repos/asf/incubator-griffin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-griffin/commit/e74814e5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-griffin/tree/e74814e5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-griffin/diff/e74814e5 Branch: refs/heads/master Commit: e74814e59744d4a2995f8db8a6fd7e5fde006cac Parents: d6854bb Author: dodobel <1254288...@qq.com> Authored: Mon Mar 5 17:32:35 2018 +0800 Committer: Lionel Liu <bhlx3l...@163.com> Committed: Mon Mar 5 17:32:35 2018 +0800 ---------------------------------------------------------------------- griffin-doc/FSD.md | 64 +++++++++++++------ griffin-doc/img/fsd/image2018-1-8 12-33-2.png | Bin 108413 -> 128529 bytes griffin-doc/img/fsd/image2018-1-8 12-38-12.png | Bin 120481 -> 123654 bytes griffin-doc/img/fsd/image2018-1-8 12-44-30.png | Bin 152061 -> 169651 bytes griffin-doc/img/fsd/image2018-1-8 12-48-20.png | Bin 186633 -> 137816 bytes griffin-doc/img/fsd/image2018-1-8 12-51-13.png | Bin 160405 -> 150127 bytes griffin-doc/img/fsd/image2018-1-8 13-02-15.png | Bin 272258 -> 238736 bytes griffin-doc/img/fsd/image2018-1-8 13-07-16.png | Bin 120708 -> 128242 bytes griffin-doc/img/fsd/image2018-1-8 13-10-28.png | Bin 120358 -> 142898 bytes griffin-doc/img/fsd/image2018-1-8 13-12-10.png | Bin 143090 -> 113922 bytes griffin-doc/img/fsd/image2018-1-8 13-13-40.png | Bin 155166 -> 139110 bytes griffin-doc/img/fsd/image2018-1-8 13-15-30.png | Bin 160387 -> 133758 bytes griffin-doc/img/fsd/image2018-2-5 14-44-20.png | Bin 279001 -> 210289 bytes griffin-doc/img/fsd/image2018-2-5 14-45-10.png | Bin 111384 -> 127324 bytes griffin-doc/img/fsd/image2018-2-5 14-46-26.png | Bin 124723 -> 118602 bytes griffin-doc/img/fsd/image2018-2-5 14-50-10.png | Bin 85916 -> 72787 bytes griffin-doc/img/fsd/image2018-2-6 10-48-10.png | Bin 59232 -> 80211 bytes griffin-doc/img/fsd/image2018-2-6 10-50-10.png | Bin 144805 -> 100417 bytes griffin-doc/img/fsd/image2018-2-6 10-51-16.png | Bin 118094 -> 170904 bytes griffin-doc/img/fsd/image2018-2-6 11-1-10.png | Bin 214914 -> 213911 bytes griffin-doc/img/fsd/image2018-2-6 11-3-19.png | Bin 97741 -> 97685 bytes griffin-doc/img/userguide/ac_partition.png | Bin 186633 -> 137816 bytes griffin-doc/img/userguide/asset list.png | Bin 89272 -> 72787 bytes griffin-doc/img/userguide/confirm job.png | Bin 95586 -> 97685 bytes griffin-doc/img/userguide/confirm measure.png | Bin 147534 -> 150127 bytes griffin-doc/img/userguide/dashboard big.png | Bin 118094 -> 170904 bytes griffin-doc/img/userguide/job config.png | Bin 209684 -> 213911 bytes griffin-doc/img/userguide/mapping.png | Bin 202146 -> 169651 bytes griffin-doc/img/userguide/measure info.png | Bin 288214 -> 238736 bytes griffin-doc/img/userguide/metrics dashboard.png | Bin 144805 -> 100417 bytes griffin-doc/img/userguide/right bar.png | Bin 59232 -> 80211 bytes griffin-doc/img/userguide/source.PNG | Bin 122418 -> 128529 bytes griffin-doc/img/userguide/target.PNG | Bin 114057 -> 123654 bytes griffin-doc/ui/test-case.md | 2 +- griffin-doc/ui/user-guide.md | 6 +- 35 files changed, 48 insertions(+), 24 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/FSD.md ---------------------------------------------------------------------- diff --git a/griffin-doc/FSD.md b/griffin-doc/FSD.md index 1caffc3..11a25ae 100644 --- a/griffin-doc/FSD.md +++ b/griffin-doc/FSD.md @@ -18,7 +18,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> -#Functional Specification Document +# Functional Specification Document ## Goals @@ -53,7 +53,7 @@ So we conclude 3 data quality problems at eBay: ## Feature List -<table class="confluenceTable" border="2"><tbody><tr><th class="confluenceTh">#</th><th class="confluenceTh">Title</th><th class="confluenceTh">User Story</th><th class="confluenceTh">Importance</th><th colspan="1" class="confluenceTh">Status</th><th class="confluenceTh">Notes</th></tr><tr><td class="confluenceTd">1</td><td class="confluenceTd">User login</td><td class="confluenceTd"><p>User can login the system so that I'm able to access<br />the subsequent features.</p></td><td class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td class="confluenceTd"><ul><li>There are two login strategies you can choose</li><li>Ldap strategy: May use NT account, or a user list maintained in DB</li><li>Default strategy: You can login with any username and password</li></ul></td></tr><tr><td class="confluenceTd">2</td><td class="confluenceTd">Create measure - Accuracy</td><td class="confluenceTd"><p>User can create an accuracy measure, so that the metrics</p><p>can be ca lculated by the rule defined in the measure </p></td><td class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td class="confluenceTd"><ul><li>5 Steps in wizard:</li></ul><ol><li>Select the source dataset and fields which will be used for comparision</li><li>Select the target dataset and fields which will be used for comparision</li><li>Mapping the target fields with source, some basic functions should be <br />supported when mapping: <br /> etc.</li><li>Set partition configuration for source dataset and target dataset</li><li>Set basic configuration for your model: name, description <br />measure type, etc.</li></ol><ul><li>When submitting the form, need to confirm the form info</li><li>After submitting, model list should be displayed and the new model is <br />displayed as the 1st record.</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">3</td><td colspan="1" class="confluenceTd"><span>Create measure -Data Profiling</span></td><td colspan="1" c lass="confluenceTd"><p><span>User can create a profiling measure, so that the metrics </span></p><p><span>can be </span><span>calculated by the rule defined in the measure </span></p></td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>4 steps in wizard:</li></ul><ol><li>Select the target dataset and field which want to be checked, only one<br />field should be selected.</li><li>Define your syntax check logic which will be applied on the selected field,<br />including: <strong>Null Count,Distinct Count, Total Count, Maximum, </strong><br /><strong>Minimum, </strong><strong>Average, Enum Detection Top5 Count</strong></li><li>Set partition configuration for target dataset</li><li><span>Set basic configuration for your measure: name,description,group, </span><br /><span>etc.</span><span><br /></span></li></ol><ul><li>When submitting the form, need to confirm the form info</li><li>After submitting , measure list should be displayed and the new meaure is <br />displayed as the last record.</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">4</td><td colspan="1" class="confluenceTd"><p><span>Create Job</span></p></td><td colspan="1" class="confluenceTd"><p><span>User can create a job which schedules one measure you created </span></p></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>1 step in wizard:</li></ul><ol><li><span>Set basic information for your job: measure name, cron expression, </span><br /><span>data range, etc.</span></li></ol><ul><li>When submitting the form, need to confirm the form info</li><li>After submitting, job list should be displayed and the new job is <br />displayed as the last record.</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">5</td><td colspan="1" class="confluenceTd"><p>List jobs</p></td><td colspan="1" class="confluenc eTd"><p>User can get a list of all jobs </p><p>definition info</p><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Job information should be shown: Job Name,Previous Fire Time,Next Fire Time, Trigger State,Cron Expression, Action,Metric</li><li>Job instance information should be shown:AppID,Time,State</li><li>Jobinstance sorted by Time" desc</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">6</td><td colspan="1" class="confluenceTd">Delete a job</td><td colspan="1" class="confluenceTd">User can delete my own jobs</td><td colspan="1" class="confluenceTd">May Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Administrator should also have delete permission</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">7</td><td colspan="1" class="confluenceTd">List measures</td><td colspan="1" class="confluenceTd"><p>User can get a list of all measures which contain basic measure</p><p>definition info</p></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Information should be shown: Measure Name,Measure Type, Description, Group,Action</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">8</td><td colspan="1" class="confluenceTd">View a measure</td><td colspan="1" class="confluenceTd">User can view the details of a measure definition</td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>All the information should be displayed: measure name, description, measure type, group,<br />source,target,owner,etc.</li><li>Mapping rules and accuracy calculations formula are also displayed</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">9</td><td colspan="1" class="confluenceTd">Delete a measur e</td><td colspan="1" class="confluenceTd">User can delete my own measures</td><td colspan="1" class="confluenceTd">May Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Administrator should also have delete permission</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">10</td><td colspan="1" class="confluenceTd">DataAsset list</td><td colspan="1" class="confluenceTd">User can view all data assets</td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Information shown: table name, DB name, owner, creation time, last access time, location</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">11</td><td colspan="1" class="confluenceTd">Heatmap</td><td colspan="1" class="confluenceTd"><p>User can see the heatmap when I login, so that I'll know</p><p>the status of the metrics</p></td><td colspan="1" class="confluenceTd"><span>Must Have</sp an></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Show all metrics results displayed as green</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">12</td><td colspan="1" class="confluenceTd">Siderbar</td><td colspan="1" class="confluenceTd">The application can provide the list of all metrics</td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>List format: time, name, value.</li><li>Can be organized by Measure->metrics list</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">13</td><td colspan="1" class="confluenceTd">Show mydashboard</td><td colspan="1" class="confluenceTd"><span>The application can display the charts of all metrics</span></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>A list of charts orgnized by <span>Mea sure->metrics list</span></li><li><span>Can filter by Measure</span></li></ul></td></tr><tr><td colspan="1" class="confluenceTd">14</td><td colspan="1" class="confluenceTd">Show metric detail</td><td colspan="1" class="confluenceTd"><span>Can display the detail of the metric</span></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li><span>Show metric details</span></li></ul></td></tr><tr><td colspan="1" class="confluenceTd">15</td><td colspan="1" class="confluenceTd">Scheduler job</td><td colspan="1" class="confluenceTd"><p>The application should have the scheduler jobs to</p><p>calculate the metrics</p></td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>According to the rules defined in the models, the scheduler job has these<br />functions:</li></ul><ol><li>Know when to calculate a met ric</li><li>Call the measure engine to get metrics values</li><li>Save the metrics result</li></ol></td></tr><tr><td colspan="1" class="confluenceTd">16</td><td colspan="1" class="confluenceTd">Measure engine</td><td colspan="1" class="confluenceTd">The application can calculate the metrics values</td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>With the rule definition, the engine can calculate the metrics values</li></ul></td></tr></tbody></table> +<table class="confluenceTable" border="2"><tbody><tr><th class="confluenceTh">#</th><th class="confluenceTh">Title</th><th class="confluenceTh">User Story</th><th class="confluenceTh">Importance</th><th colspan="1" class="confluenceTh">Status</th><th class="confluenceTh">Notes</th></tr><tr><td class="confluenceTd">1</td><td class="confluenceTd">User login</td><td class="confluenceTd"><p>User can login the system so that I'm able to access<br />the subsequent features.</p></td><td class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td class="confluenceTd"><ul><li>There are two login strategies you can choose</li><li>Ldap strategy: Use LDAP non-anonymous bind for user authentication</li><li>Default strategy: You can login with any username and password</li></ul></td></tr><tr><td class="confluenceTd">2</td><td class="confluenceTd">Create measure - Accuracy</td><td class="confluenceTd"><p>User can create an accuracy measure, so that the metrics can be calculat ed by the rule defined in the measure </p></td><td class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td class="confluenceTd"><ul><li>5 Steps in wizard:</li></ul><ol><li>Select the source dataset and fields which will be used for comparision</li><li>Select the target dataset and fields which will be used for comparision</li><li>Mapping the target fields with source, some basic operator should be supported when mapping: =, !=, <,> etc.</li><li>Set partition configuration for source dataset and target dataset</li><li>Set basic configuration for your measure: name, description <br />measure type, etc.</li></ol><ul><li>When submitting the form, need to confirm the form info</li><li>After submitting, measure list should be displayed and the new measure is <br />displayed as the 1st record.</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">3</td><td colspan="1" class="confluenceTd"><span>Create measure -Data Profiling</span></td><td colspan="1" clas s="confluenceTd"><p><span>User can create a profiling measure, so that the metrics </span><span>can be </span><span>calculated by the rule defined in the measure </span></p></td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>4 steps in wizard:</li></ul><ol><li>Select the target dataset and field which want to be checked, only one field should be selected.</li><li>Define your syntax check logic which will be applied on the selected field,<br />including: <strong>Null Count,Distinct Count, Total Count, Maximum, </strong><br /><strong>Minimum, </strong><strong>Average, Enum Detection Top5 Count</strong></li><li>Set partition configuration for target dataset</li><li><span>Set basic configuration for your measure: name,description, </span><br /><span>etc.</span><span><br /></span></li></ol><ul><li>When submitting the form, need to confirm the form info</li><li>After submitting, measure list should be displayed and the new measure is <br />displayed as the 1st record.</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">4</td><td colspan="1" class="confluenceTd">List measures</td><td colspan="1" class="confluenceTd"><p>User can get a list of all measures which contain basic measure definition info</p></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Information should be shown: Measure Name,Measure Type, Description, Action</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">5</td><td colspan="1" class="confluenceTd">View a measure</td><td colspan="1" class="confluenceTd">User can view the details of a measure definition</td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>All the information should be displayed: measure name, description, measure type,<b r />source,target,owner,etc.</li><li>Mapping rules and accuracy calculations formula are also displayed</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">6</td><td colspan="1" class="confluenceTd">Delete a measure</td><td colspan="1" class="confluenceTd">User can delete my own measures</td><td colspan="1" class="confluenceTd">May Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Administrator should also have delete permission</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">7</td><td colspan="1" class="confluenceTd"><p><span>Create Job</span></p></td><td colspan="1" class="confluenceTd"><p><span>User can create a job which schedules one measure you created </span></p></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>1 step in wizard:</li></ul><ol><li><span>Set basic information for your job: measure name, cron expression, </span><span>data range, etc.</span></li></ol><ul><li>When submitting the form, need to confirm the form info</li><li>After submitting, job list should be displayed and the new job is <br />displayed as the 1st record.</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">8</td><td colspan="1" class="confluenceTd"><p>List jobs</p></td><td colspan="1" class="confluenceTd"><p>User can get a list of all jobs definition info</p><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Job information should be shown: Job Name,Previous Fire Time,Next Fire Time, Trigger State,Cron Expression, Action,Metric</li><li>Job instance information should be shown:AppID,Time,State</li><li>Jobinstance sorted by Time" desc</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">9</td><td colspan="1" class="confluenceTd">Delete a job</td><td colspan="1" class="confluenceTd">User ca n delete my own jobs</td><td colspan="1" class="confluenceTd">May Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Administrator should also have delete permission</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">10</td><td colspan="1" class="confluenceTd">DataAsset list</td><td colspan="1" class="confluenceTd">User can view all data assets</td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>Information shown: table name, DB name, owner, creation time, location</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">11</td><td colspan="1" class="confluenceTd">Heatmap</td><td colspan="1" class="confluenceTd"><p>User can see the heatmap when I login, so that I'll know</p><p>the status of the metrics</p></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class ="confluenceTd"><ul><li>Show all metrics results displayed as green</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">12</td><td colspan="1" class="confluenceTd">Siderbar</td><td colspan="1" class="confluenceTd">The application can provide the list of all metrics</td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>List format: time, name, value.</li><li>Can be organized by Measure->metrics list</li></ul></td></tr><tr><td colspan="1" class="confluenceTd">13</td><td colspan="1" class="confluenceTd">Show mydashboard</td><td colspan="1" class="confluenceTd"><span>The application can display the charts of all metrics</span></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>A list of charts orgnized by <span>Measure->metrics list</span></li><li><span>Can filter by Measure</span>< /li></ul></td></tr><tr><td colspan="1" class="confluenceTd">14</td><td colspan="1" class="confluenceTd">Show metric detail</td><td colspan="1" class="confluenceTd"><span>Can display the detail of the metric</span></td><td colspan="1" class="confluenceTd"><span>Must Have</span></td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li><span>Show metric details</span></li></ul></td></tr><tr><td colspan="1" class="confluenceTd">15</td><td colspan="1" class="confluenceTd">Scheduler job</td><td colspan="1" class="confluenceTd"><p>The application should have the scheduler jobs to</p><p>calculate the metrics</p></td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>According to the rules defined in the measures, the scheduler job has these<br />functions:</li></ul><ol><li>Know when to calculate a metric</li><li>Call the measure engine to get metrics values</li><li>Save the metrics result</li></ol></td></tr><tr><td colspan="1" class="confluenceTd">16</td><td colspan="1" class="confluenceTd">Measure engine</td><td colspan="1" class="confluenceTd">The application can calculate the metrics values</td><td colspan="1" class="confluenceTd">Must Have</td><td colspan="1" class="confluenceTd"> </td><td colspan="1" class="confluenceTd"><ul><li>With the rule definition, the engine can calculate the metrics values</li></ul></td></tr></tbody></table> ## User interaction and design @@ -62,52 +62,76 @@ So we conclude 3 data quality problems at eBay: <img src="img/fsd/image2018-1-8 12-27-53.png" > <p style="color: rgb(51,102,255);">#2 Create measure - Accuracy</p> -step 1 -> step 2 -> step 3 -> step 4 ->step 5 - confirmation +step 1 : Select the source dataset and fields which will be used for comparision <img src="img/fsd/image2018-1-8 12-33-2.png" > + +step 2 : Select the target dataset and fields which will be used for comparision + <img src="img/fsd/image2018-1-8 12-38-12.png" > + +step 3 : Mapping the target fields with source + <img src="img/fsd/image2018-1-8 12-44-30.png" > +step 4 : Set partition configuration for source dataset and target dataset + <img src="img/fsd/image2018-1-8 12-48-20.png" > + +step 5 : Set basic configuration for your measure + <img src="img/fsd/image2018-1-8 12-51-13.png" > +confirmation : + <img src="img/fsd/image2018-1-8 13-02-15.png" > <p style="color: rgb(51,102,255);">#3 Create measure - Profiling</p> -step 1 -> step 2 -> step 3 -> step 4 - confirmation +step 1 : Select the target dataset and field which want to be checked <img src="img/fsd/image2018-1-8 13-07-16.png" > + +step 2 : Define your syntax check logic which will be applied on the selected field + <img src="img/fsd/image2018-1-8 13-10-28.png" > + +step 3 : Set partition configuration for target dataset + <img src="img/fsd/image2018-1-8 13-12-10.png" > + +step 4 : Set basic configuration for your measure + <img src="img/fsd/image2018-1-8 13-13-40.png" > +confirmation : + <img src="img/fsd/image2018-1-8 13-15-30.png" > -<p style="color: rgb(51,102,255);">#4 Create job</p> +<p style="color: rgb(51,102,255);">#4 List measures</p> +<img src="img/fsd/image2018-2-5 14-45-10.png" > + +<p style="color: rgb(51,102,255);">#5 View a measure</p> +<img src="img/fsd/image2018-2-5 14-44-20.png" > + +<p style="color: rgb(51,102,255);">#6 Delete a measure</p> +<img src="img/fsd/image2018-2-5 14-46-26.png" > + +<p style="color: rgb(51,102,255);">#7 Create job</p> <img src="img/fsd/image2018-2-6 11-1-10.png" > <img src="img/fsd/image2018-2-6 11-3-19.png" > -<p style="color: rgb(51,102,255);">#5 List jobs</p> +<p style="color: rgb(51,102,255);">#8 List jobs</p> <img src="img/fsd/image2018-2-6 10-54-15.png" > <img src="img/fsd/image2018-2-6 10-57-20.png" > -<p style="color: rgb(51,102,255);">#6 Delete a job</p> +<p style="color: rgb(51,102,255);">#9 Delete a job</p> <img src="img/fsd/image2018-2-6 10-58-24.png" > -<p style="color: rgb(51,102,255);">#7 List measures</p> -<img src="img/fsd/image2018-2-5 14-45-10.png" > - -<p style="color: rgb(51,102,255);">#8 View a measure</p> -<img src="img/fsd/image2018-2-5 14-44-20.png" > - -<p style="color: rgb(51,102,255);">#9 Delete a measure</p> -<img src="img/fsd/image2018-2-5 14-46-26.png" > - <p style="color: rgb(51,102,255);">#10 DataAsset list</p> <img src="img/fsd/image2018-2-5 14-50-10.png" > @@ -115,20 +139,20 @@ step 1 -> step 2 -> step 3 -> step 4 - confirmation <img src="img/fsd/image2018-2-6 10-10-15.png" > <p style="color: rgb(51,102,255);">#12 List all metrics values</p> -<img src="img/fsd/image2018-2-6 10-48-10.png" style="height:400px;"> +<img src="img/fsd/image2018-2-6 10-48-10.png" height="500px"> <p style="color: rgb(51,102,255);">#13 Show My Dashboard</p> chart list -> Max chart display -<img src="img/fsd/image2018-2-6 10-50-10.png" > +<img src="img/fsd/image2018-2-6 10-50-10.png" height="400px" > <p style="color: rgb(51,102,255);">#14 Show metric detail</p> -<img src="img/fsd/image2018-2-6 10-51-16.png" > +<img src="img/fsd/image2018-2-6 10-51-16.png" height="400px" > <p style="color: rgb(51,102,255);">#15 Scheduler job</p> -Same UI as #4 +Same UI as #7 ## Questions Below is a list of questions to be addressed as a result of this requirements document: http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 12-33-2.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 12-33-2.png b/griffin-doc/img/fsd/image2018-1-8 12-33-2.png index d22b204..0347a07 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 12-33-2.png and b/griffin-doc/img/fsd/image2018-1-8 12-33-2.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 12-38-12.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 12-38-12.png b/griffin-doc/img/fsd/image2018-1-8 12-38-12.png index ca38e5f..e627f11 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 12-38-12.png and b/griffin-doc/img/fsd/image2018-1-8 12-38-12.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 12-44-30.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 12-44-30.png b/griffin-doc/img/fsd/image2018-1-8 12-44-30.png index 30cdd4f..db799c5 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 12-44-30.png and b/griffin-doc/img/fsd/image2018-1-8 12-44-30.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 12-48-20.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 12-48-20.png b/griffin-doc/img/fsd/image2018-1-8 12-48-20.png index f951ce8..9c621ef 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 12-48-20.png and b/griffin-doc/img/fsd/image2018-1-8 12-48-20.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 12-51-13.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 12-51-13.png b/griffin-doc/img/fsd/image2018-1-8 12-51-13.png index f5a6897..c3a8a6e 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 12-51-13.png and b/griffin-doc/img/fsd/image2018-1-8 12-51-13.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 13-02-15.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 13-02-15.png b/griffin-doc/img/fsd/image2018-1-8 13-02-15.png index 7f85b83..39ca2fa 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 13-02-15.png and b/griffin-doc/img/fsd/image2018-1-8 13-02-15.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 13-07-16.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 13-07-16.png b/griffin-doc/img/fsd/image2018-1-8 13-07-16.png index 3cc4700..b38dfe8 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 13-07-16.png and b/griffin-doc/img/fsd/image2018-1-8 13-07-16.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 13-10-28.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 13-10-28.png b/griffin-doc/img/fsd/image2018-1-8 13-10-28.png index 7b41369..4715db9 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 13-10-28.png and b/griffin-doc/img/fsd/image2018-1-8 13-10-28.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 13-12-10.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 13-12-10.png b/griffin-doc/img/fsd/image2018-1-8 13-12-10.png index 7ad1a50..1e6a4ae 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 13-12-10.png and b/griffin-doc/img/fsd/image2018-1-8 13-12-10.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 13-13-40.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 13-13-40.png b/griffin-doc/img/fsd/image2018-1-8 13-13-40.png index 35f24a7..522e2c1 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 13-13-40.png and b/griffin-doc/img/fsd/image2018-1-8 13-13-40.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-1-8 13-15-30.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-1-8 13-15-30.png b/griffin-doc/img/fsd/image2018-1-8 13-15-30.png index b27ba28..97cd6e0 100644 Binary files a/griffin-doc/img/fsd/image2018-1-8 13-15-30.png and b/griffin-doc/img/fsd/image2018-1-8 13-15-30.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-5 14-44-20.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-5 14-44-20.png b/griffin-doc/img/fsd/image2018-2-5 14-44-20.png index cf9779a..9789f4b 100644 Binary files a/griffin-doc/img/fsd/image2018-2-5 14-44-20.png and b/griffin-doc/img/fsd/image2018-2-5 14-44-20.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-5 14-45-10.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-5 14-45-10.png b/griffin-doc/img/fsd/image2018-2-5 14-45-10.png index 84a167d..c1f882a 100644 Binary files a/griffin-doc/img/fsd/image2018-2-5 14-45-10.png and b/griffin-doc/img/fsd/image2018-2-5 14-45-10.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-5 14-46-26.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-5 14-46-26.png b/griffin-doc/img/fsd/image2018-2-5 14-46-26.png index 7fed502..2077e2f 100644 Binary files a/griffin-doc/img/fsd/image2018-2-5 14-46-26.png and b/griffin-doc/img/fsd/image2018-2-5 14-46-26.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-5 14-50-10.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-5 14-50-10.png b/griffin-doc/img/fsd/image2018-2-5 14-50-10.png index 61decf7..70bba7e 100644 Binary files a/griffin-doc/img/fsd/image2018-2-5 14-50-10.png and b/griffin-doc/img/fsd/image2018-2-5 14-50-10.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-6 10-48-10.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-6 10-48-10.png b/griffin-doc/img/fsd/image2018-2-6 10-48-10.png index d17a1f6..a698e27 100644 Binary files a/griffin-doc/img/fsd/image2018-2-6 10-48-10.png and b/griffin-doc/img/fsd/image2018-2-6 10-48-10.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-6 10-50-10.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-6 10-50-10.png b/griffin-doc/img/fsd/image2018-2-6 10-50-10.png index e3152dc..36a06e1 100644 Binary files a/griffin-doc/img/fsd/image2018-2-6 10-50-10.png and b/griffin-doc/img/fsd/image2018-2-6 10-50-10.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-6 10-51-16.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-6 10-51-16.png b/griffin-doc/img/fsd/image2018-2-6 10-51-16.png index 7e10fe4..aa796b6 100644 Binary files a/griffin-doc/img/fsd/image2018-2-6 10-51-16.png and b/griffin-doc/img/fsd/image2018-2-6 10-51-16.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-6 11-1-10.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-6 11-1-10.png b/griffin-doc/img/fsd/image2018-2-6 11-1-10.png index 56be780..7d3b75c 100644 Binary files a/griffin-doc/img/fsd/image2018-2-6 11-1-10.png and b/griffin-doc/img/fsd/image2018-2-6 11-1-10.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/fsd/image2018-2-6 11-3-19.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/fsd/image2018-2-6 11-3-19.png b/griffin-doc/img/fsd/image2018-2-6 11-3-19.png index 69ad910..dd094b8 100644 Binary files a/griffin-doc/img/fsd/image2018-2-6 11-3-19.png and b/griffin-doc/img/fsd/image2018-2-6 11-3-19.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/ac_partition.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/ac_partition.png b/griffin-doc/img/userguide/ac_partition.png index f951ce8..9c621ef 100644 Binary files a/griffin-doc/img/userguide/ac_partition.png and b/griffin-doc/img/userguide/ac_partition.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/asset list.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/asset list.png b/griffin-doc/img/userguide/asset list.png index 02c258c..70bba7e 100644 Binary files a/griffin-doc/img/userguide/asset list.png and b/griffin-doc/img/userguide/asset list.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/confirm job.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/confirm job.png b/griffin-doc/img/userguide/confirm job.png index f931f2c..dd094b8 100644 Binary files a/griffin-doc/img/userguide/confirm job.png and b/griffin-doc/img/userguide/confirm job.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/confirm measure.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/confirm measure.png b/griffin-doc/img/userguide/confirm measure.png index 66be886..c3a8a6e 100644 Binary files a/griffin-doc/img/userguide/confirm measure.png and b/griffin-doc/img/userguide/confirm measure.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/dashboard big.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/dashboard big.png b/griffin-doc/img/userguide/dashboard big.png index 7e10fe4..aa796b6 100644 Binary files a/griffin-doc/img/userguide/dashboard big.png and b/griffin-doc/img/userguide/dashboard big.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/job config.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/job config.png b/griffin-doc/img/userguide/job config.png index 72a1625..7d3b75c 100644 Binary files a/griffin-doc/img/userguide/job config.png and b/griffin-doc/img/userguide/job config.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/mapping.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/mapping.png b/griffin-doc/img/userguide/mapping.png index 54aa65c..db799c5 100644 Binary files a/griffin-doc/img/userguide/mapping.png and b/griffin-doc/img/userguide/mapping.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/measure info.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/measure info.png b/griffin-doc/img/userguide/measure info.png index d69c8c1..39ca2fa 100644 Binary files a/griffin-doc/img/userguide/measure info.png and b/griffin-doc/img/userguide/measure info.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/metrics dashboard.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/metrics dashboard.png b/griffin-doc/img/userguide/metrics dashboard.png index e3152dc..36a06e1 100644 Binary files a/griffin-doc/img/userguide/metrics dashboard.png and b/griffin-doc/img/userguide/metrics dashboard.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/right bar.png ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/right bar.png b/griffin-doc/img/userguide/right bar.png index d17a1f6..a698e27 100644 Binary files a/griffin-doc/img/userguide/right bar.png and b/griffin-doc/img/userguide/right bar.png differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/source.PNG ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/source.PNG b/griffin-doc/img/userguide/source.PNG index d1c7b93..0347a07 100644 Binary files a/griffin-doc/img/userguide/source.PNG and b/griffin-doc/img/userguide/source.PNG differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/img/userguide/target.PNG ---------------------------------------------------------------------- diff --git a/griffin-doc/img/userguide/target.PNG b/griffin-doc/img/userguide/target.PNG index b6e16d9..e627f11 100644 Binary files a/griffin-doc/img/userguide/target.PNG and b/griffin-doc/img/userguide/target.PNG differ http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/ui/test-case.md ---------------------------------------------------------------------- diff --git a/griffin-doc/ui/test-case.md b/griffin-doc/ui/test-case.md index f872702..40ed3d7 100644 --- a/griffin-doc/ui/test-case.md +++ b/griffin-doc/ui/test-case.md @@ -16,7 +16,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> -#Functional Test cases +# Functional Test cases | TestCase ID | Test Page | Test Case Description | Test Case Steps | Test Data | Expected Result | Actual Result | Test Result | Jira Bug ID | http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/e74814e5/griffin-doc/ui/user-guide.md ---------------------------------------------------------------------- diff --git a/griffin-doc/ui/user-guide.md b/griffin-doc/ui/user-guide.md index 353a5e0..775d16f 100644 --- a/griffin-doc/ui/user-guide.md +++ b/griffin-doc/ui/user-guide.md @@ -155,15 +155,15 @@ After the processing work has done, here are 3 ways to show the data diagram. You can see the diagrams of metrics. - <img src="../img/userguide/metrics dashboard.png" > + <img src="../img/userguide/metrics dashboard.png" height="400px" > By clicking on the diagram, you can get the zoom-in picture of it, and know the metrics at the selected time window. - <img src="../img/userguide/dashboard big.png" > + <img src="../img/userguide/dashboard big.png" height="400px" > 3. The metrics is shown on the right side of the page. By clicking on the measure, you can get the diagram and details about the measure result. - <img src="../img/userguide/right bar.png" height="400px" > + <img src="../img/userguide/right bar.png" height="500px" > ## References ###Six core data quality dimensions
