From bae185d24c00fe150eee967019856c274c9307b3 Mon Sep 17 00:00:00 2001 From: Keith Date: Tue, 11 Jun 2024 13:50:08 -0500 Subject: [PATCH] updating create analysis docs --- docs/FInCatchAnalysis_WarningsErrors.html | 231 ++- docs/FinCatchAccess_0.html | 223 ++- docs/FinCatchAnalysis_0.html | 243 +++- docs/FinCatchAnalysis_0_BaseObject.html | 255 +++- docs/FinCatchAnalysis_0_ExampleScript.html | 233 ++- docs/FinCatchAnalysis_1_Methods.html | 243 +++- docs/FinCatchAnalysis_1_Objects.html | 243 +++- docs/FinCatchAnalysis_2_HelperFunctions.html | 317 +++- docs/FinCatchAnalysis_3_CreateAnalysis.html | 300 +++- docs/FinCatchAnalysis_DataObject.html | 273 +++- docs/FinCatchDE_0_Deployment.html | 245 +++- docs/FinCatch_Architecture.html | 227 ++- docs/FinCatch_CreateUser.html | 708 +++++++++ docs/FinCatch_DataDesign.html | 223 ++- docs/FinCatch_SamplingRestrictions.html | 223 ++- docs/index.html | 221 ++- docs/intro.html | 223 ++- docs/references.html | 219 ++- docs/search.json | 455 ++++-- docs/site_libs/bootstrap/bootstrap-icons.css | 148 +- docs/site_libs/bootstrap/bootstrap-icons.woff | Bin 164168 -> 176200 bytes docs/site_libs/bootstrap/bootstrap.min.css | 12 +- docs/site_libs/bootstrap/bootstrap.min.js | 6 +- docs/site_libs/quarto-html/anchor.min.js | 6 +- docs/site_libs/quarto-html/popper.min.js | 4 +- docs/site_libs/quarto-html/quarto.js | 69 +- docs/site_libs/quarto-nav/quarto-nav.js | 27 +- .../quarto-search/autocomplete.umd.js | 4 +- docs/site_libs/quarto-search/quarto-search.js | 226 ++- index.aux | 203 +++ index.log | 1286 +++++++++++++++++ docs/FinCatchDocumentation.pdf => index.pdf | Bin 227614 -> 220602 bytes index.tex | 1284 ++++++++++++++++ index.toc | 0 34 files changed, 7747 insertions(+), 833 deletions(-) create mode 100644 docs/FinCatch_CreateUser.html create mode 100644 index.aux create mode 100644 index.log rename docs/FinCatchDocumentation.pdf => index.pdf (71%) create mode 100644 index.tex create mode 100644 index.toc diff --git a/docs/FInCatchAnalysis_WarningsErrors.html b/docs/FInCatchAnalysis_WarningsErrors.html index ae2471b..e7e0da1 100644 --- a/docs/FInCatchAnalysis_WarningsErrors.html +++ b/docs/FInCatchAnalysis_WarningsErrors.html @@ -2,12 +2,12 @@ - + -FinCatch Documentation - 8  Warnings and Errors +FinCatch Documentation - 9  Warnings and Errors + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+ +
+ + +
+ + + +
+ +
+
+

5  FinCatch Users

+
+ + + +
+ + + + +
+ + + +
+ + +
+

5.1 Auth0 User Authentication

+

FinCatch uses the Auth0 (https://www.auth0.com) for authentication and authorization. At-will, user-requested new user creation is not supported. New users can be created by a tenant admin with Auth0. Users will be sent an email to verify their address and future FinCatch usage is not possible until the verification is complete. Users should also be assigned the appropiate authorization roles.

+
+
+

5.2 FinCatch User

+

In addition to Auth0 user authentication, FinCatch website, FinCatchAG, and FinCatchRA users will also need a profile in the FinCatch system. This profile is meant to decouple FinCatch from the Auth0 system in case a new authentication service needs to be implemented. Upon the first login to the FinCatch website, a new Auth0 user with a verified email will be redirected to a page to create their profile. After creation of their profile, a FinCatch DataAdmin will need to log in and “Activate” their profile.

+
+
+

5.3 How to Create A New User

+

1) FinCatch administrator logs into Auth0 and creates new user. The appropiate roles (DataAdmin, DataWorker, DataSupervisor) should be added to the new user. The new user will need to be supplied their password.

+

2) New user will receive an email with instructions on how to verify their email address. The must complete the verification process.

+

3) New user should log into https://FinCatch.outdoornebraska.gov using the password supplied by the FinCatch administrator.

+

4) Upon logging in, the new user will be redirected to a page to complete their FinCatch profile.

+

5) A FinCatch administrator must login and activate the new user’s profile.

+ + +
+ +
+ + +
+ + + + + \ No newline at end of file diff --git a/docs/FinCatch_DataDesign.html b/docs/FinCatch_DataDesign.html index b5b41b7..62cfaee 100644 --- a/docs/FinCatch_DataDesign.html +++ b/docs/FinCatch_DataDesign.html @@ -2,7 +2,7 @@ - + @@ -47,7 +47,13 @@ "collapse-after": 3, "panel-placement": "start", "type": "textbox", - "limit": 20, + "limit": 50, + "keyboard-shortcut": [ + "f", + "/", + "s" + ], + "show-item-context": false, "language": { "search-no-results-text": "No results", "search-matching-documents-text": "matching documents", @@ -56,8 +62,10 @@ "search-more-match-text": "more match in this document", "search-more-matches-text": "more matches in this document", "search-clear-button-title": "Clear", + "search-text-placeholder": "", "search-detached-cancel-button-title": "Cancel", - "search-submit-button-title": "Submit" + "search-submit-button-title": "Submit", + "search-label": "Search" } } @@ -70,13 +78,13 @@