Knowledge Base. Release Notes Version 2.0

Transcription

1 Knowledge Base Release Notes Version 2.0

2 Application Data Structure Name Type Purpose KB_Users Table Primary table for registered users KB_Articles Table Primary table for articles KB_Comments Table Primary table for comments KB_LU_Categories Table Lookup table for categories of articles KB_LU_Roles Table Primary table for roles of users KB_LU_Statuses Table Primary table for statuses of articles KB_Active_Authors View Filtered list of active authors who can login to the author s area KB_Active_Editors View Filtered list of active editors who can login to the editor s area KB_Active_Users View Filtered list of active users who can login to the user s area KB_All_Users View List of all users with role titles KB_All_Articles View List of all articles with status titles, author s usernames and s KB_Article_Comments View List of all comments with article titles, author s usernames and s KB_Manage_Articles View Filtered by status not In Progress list of articles KB_Approved_Articles View Filtered list of Published articles

3 Roles Application Roles and Permissions Data Entities Articles Comments Users Other Users Search & view articles Add comments; View comments of another users. Authors Editors Search & view articles; Add new article; Manage his own articles: - Search; - Edit and update; - Remove; - Make internal notes to admin. Search & view articles; Add new article; Manage his own articles: - Search; - Edit and update; - Remove; - Make internal notes to author Moderate all articles; Edit and delete all articles; Manage articles categories: - Add new category; - Edit; - Remove; View Reports Add comments; View comments of another users. View & delete comments of all users Update his personal profile data (Name, , Password) Update his personal profile data (Name, , Password) Update his personal profile data (Name, , Password); Manage users data: - Search users; - Edit users data; - Add new users; - Change privileges; - Make the user account disabled. Password Reset Password Reset Password Reset

4 Notes DataPage KB User/ Login Redirection KB User/ Password Recovery KB Author/ Add New Article, KB Author/ Edit Article Details KB Editor/ Process Pending Articles KB Admin/ Add New Article KB Editor/ Process Pending Articles KB Editor/ Process Pending Articles Notes JavaScript is used in the DataPage to redirect users to the index.html page after authentication. DataPage generates a notification to send password reset link. The From address is app parameter < _From>. JavaScript is used in the Footer block of those DataPages to change status of the article by changing of Status_ID field value when the form was submitted. JavaScript is used in the Footer block to fill parameters for notification. DataPages generate a notification with article update fields. Parameters which used in body may be modified by editing the DataPage. There are: [@EditRecordTitle] - Article title [@cbparamvirtual4] - Article id [@cbparamvirtual1] - New status [@cbtimestamp*] - Change date [@cbparamvirtual2] Author of changes

5 Deployment Structure Folder Page Purpose DataPage Name index.html User/Author/Editor login User / Login Redirection pwd_reset.html Password reset User/ Password Recovery user index.html View list of all approved articles User/ View All Approved Articles user searcharticle.html Search articles User/ Search All Articles user details.html View article details. Add and view comments User/ View Article Details; Add Article Comment; View Comment History user profile.html User s personal data User/ View Profile user changepwd.html Password update User/ Update Password author index.html View list of all approved articles User/ View All Approved Articles author searcharticle.html Search articles User/ Search All Articles author addarticle.html Add new article Author/ Add New Article author manage.html View and manage list of own articles Author/ Manage My Articles author details.html View article details. Add and view comments User/ View Article Details; Add Article Comment; View Comment History author edetails.html Edit own article Author/ Edit Article Details; View Comment History

6 Deployment Structure (continued) Folder Page Purpose DataPage Name author profile.html Author s personal data User/ View Profile author changepwd.html Password update User/ Update Password editor index.html View and manage pending articles Editor/ Manage Pending Articles editor searcharticle.html Search articles Editor/ Search Articles editor addarticle.html Add new article Editor/ Add New Article editor process.html Publish, reject or edit article Editor/ Process Pending Articles; View Comment History editor details.html View and edit articles and comments Editor/ Edit Article Details; View Comment History editor top5art.html Chart of top 5 most viewed articles Editor/ Chart - Top 5 Articles editor top5auth.html Chart of top 5 authors by number of published articles Editor/ Chart - Top 5 Authors editor artcatg.html Chart - articles by categories Editor/ Articles by Categories editor artstatus.html Chart articles by statuses Editor/ Articles by Status editor adduser.html Add new user Editor/ Add New User editor mngusers.html Manage users data Editor/ Manage Users

7 Deployment Structure (continued) Folder Page Purpose DataPage Name editor profile.html Editor s personal data User/ View Profile editor changepwd.html Password update User/ Update Password editor editcategory.html Manage articles categories Editor/ Edit Categories editor myarticles.html View and manage list of own articles Editor/ Manage My Articles editor myartdetails.html Edit own article Editor/ Edit My Article Details; View Comment History

8 Checklist for Going Live Unzip the provided Deployment ZIP file. Upload the expanded files to your web server. If you are using the provided HTML pages for your site, edit the following areas of the pages: Change the page title located between tags <title> Change the page description located in tag <meta name="description /> Find the tag <div id="cb-footer"> and change the information between the tags <p></p> or remove this information. If your web server does not allow web pages to be uploaded, use the Deployment Strucutre in this guide to create a similar site architecture and deploy the listed DataPages on each page. In your Caspio account, go to the apps s Overview screen and on the right sidebar click on Manage in the App Parameters area. Edit the value any of the app parameters that should be updated. You must update _From parameter it is used in password recovery s. Go to the app s Tables screen and open the KB_Users table. Delete the sample records and add your own name, , passwords, etc. You will use this information to login.

9 Checklist for Going Live (continued) The app comes with sample data in KB_Articles and KB_Comments tables. Feel free to use them while you are preparing for your rollout, but make sure to delete all sample data when ready to go live. You can import your own data using Caspio s import feature, or add records one by one using the application. Also you can update data in KB_LU_Categories, KB_LU_Roles and KB_LU_Statuses tables to further customize your app. In your Caspio account go to Authentication screen and edit authentication objects KB - Common and remove the sample login information from the Footer.