User Manual V7.0 1
Total Page:16
File Type:pdf, Size:1020Kb
Table of Contents Table of Contents 1 User Manual v7.0 7 Introduction 8 What is KBPublisher? 9 KBPublisher Uses 12 Public Area (front-end) 13 Admin Area (Back-End); Common Actions 16 Searching Knowledgebase 19 User privileges 20 User roles 21 Category types 22 Ask Question and Quick Response 24 Subscriptions 26 Article history 27 Export articles 28 Custom Fields 29 Mobile View 30 Automations 33 Workflows 34 Drafts 35 Installation 36 System Requirements 37 Installing KBPublisher 38 Installing KBPublisher manually 40 Upgrading KBPublisher 42 Installing ionCube loader 44 Setting Up Folder Permissions in Internet Information Services (IIS) 45 Setting up scheduled tasks 46 Enable searching in files 48 Enable Exporting to PDF 50 Enable searching spell suggest 52 Setup tests 53 Getting started 55 Summary 56 Add a Category 57 Add a glossary item 58 Add a user 59 Final steps 60 Add an Article 61 Single Sign On 62 SAML Authentication 63 Using SAML SSO Authentication 64 Setting up SAML SSO Authentication 65 Configuring OneLogin as an Identity Provider 67 LDAP Authentication 68 Using LDAP Authentication 69 User Manual v7.0 1 Setting up LDAP Authentication 70 Remote Authentication 71 Using Remote Authentication 72 Using Active Directory for Remote Authentication 74 Different ways for Remote Authentication 75 Remote Authentication scenarios 77 Using Auto Authentication 78 Social Sites Authentication 79 Setting up Social Site Authentication 80 Using Social Sites Login 81 Importing 82 Import users 83 Import articles 85 Import glossary 87 Add a Local File 89 Automatically Add Local Files 91 Exporting 93 Enable Exporting to PDF 94 The Export to PDF and HTML Screens Explained 96 Export Articles to PDF or HTML 99 Export Articles to CVS, Excel or XML 100 Generate file from export template 101 Export Articles from the Public Area 102 Export articles to PDF in demo mode 103 News 104 The News Input Screen Explained 105 Add News Item 106 Edit news item 107 Delete news item 108 Bulk update news items 109 Subscribe to news 110 Unsubscribe from news 111 Remove scheduling 112 Articles 113 Articles 114 The Article Input Screen Explained 115 Add an Article 118 Update an article 119 Delete an Article 120 Add a Picture to an Article 121 Assign category to article 123 Link to another article (related articles) 125 Attach a file to an article (attachment and embedded link) 126 Article history 127 The article history screen explained 128 Autosave 129 Articles being edited by another user 130 Remove scheduling 131 User Manual v7.0 2 Add an article as a result of user feedback 132 Bulk Update Articles 133 Import articles 134 Private Articles 136 Subscribe to an article 138 Unsubscribe from an article 140 Add new status 141 Add new article type 142 Featured Articles 143 Adding Code Snippets 145 Drafts 148 Drafts 149 Manage Drafts 150 Approve or Reject a Draft 151 Categories 153 What are categories? 154 Category types 155 Add a Category 157 The Category Input Screen Explained 158 Article Templates 159 What are article templates? 160 Using templates in articles 161 Add an Article Template 163 Article types as templates 164 Glossary 165 Glossary explained 166 Add a glossary item 167 Import glossary 168 Comments 170 Article comments 171 Rating Comments 172 Bulk update comments, rating comments and feedback 173 Files 174 What are files and how do they work? 175 Add a File 176 Bulk update files 177 Add a Local File 178 Automatically Add Local Files 180 Add New File Category 182 Private Files 183 Assign category to a file 185 Delete a file 187 Enable searching in files 188 Remove scheduling 190 Subscribe to a file 191 Unsubscribe from a file 192 Feedback 193 User feedback 194 User Manual v7.0 3 Ask Question and Quick Response 195 Reply to feedback from a user 197 Add an article as a result of user feedback 198 Add New Feedback Subject 199 Article comments 200 The article comments screen explained 201 Rating Comments 202 The rating comments screen explained 203 Users 204 The User input screen explained 205 Add a user 207 Delete user 208 Bulk update users 209 Import users 210 Companies 212 Generating API Keys 213 User Activities 214 Privileges 215 User privileges 216 Create new user privilege 217 Set default user privileges 218 The Privilege Screen Explained 219 Roles 221 User roles 222 Create new user role 223 Set Default User Roles 224 My Account 225 How do I change my password? 226 How do I change my screen width? 227 How do I display more articles on a page? 228 Change the order articles and files are displayed in 229 Subscriptions 230 Subscribe to an article 231 Unsubscribe from an article 233 Subscribe to a file 234 Unsubscribe from a file 235 Subscribe to news 236 Unsubscribe from news 237 Reports 238 The Usage Report Explained 239 The Views Report Explained 240 The User Activity Report Explained 242 Export Reports 244 Statistics 245 RSS 246 Turn RSS feeds on or off 247 Change RSS feed from single feed to separate category feeds 248 Subscribe to RSS feed 249 User Manual v7.0 4 Tools 250 Tags, Labels 251 What are Tags? 252 Tagging Content 253 Bulk Add or Update Tags 254 Managing Tags 255 Tags in Public Area 256 Custom fields 257 Custom Fields 258 The Custom Fields Tab Explained 259 Add a new custom field 261 Add a new custom field range 262 Update values in a custom field range 263 To see where a custom field is used 264 Search in custom fields 265 Bulk add or update custom fields 267 Lists 269 The Lists Tab Explained 270 Automations 271 Automations 272 Manage Automations 273 Creating or editing an automation (automated task) 274 Incoming email automation (automated task) 275 Incoming email - Stop Evaluating Tasks 276 Workflows 277 Workflows 278 Manage Workflows 279 Creating or editing a workflow 280 Workflow examples 281 Settings 283 The Admin Tab Explained 284 The Public Area Tab Explained 286 The Email Tab Explained 290 The Export tab explained 291 The License tab explained 292 How to enable Sphinx Search 293 Search engine friendly URLs 294 Look and feel 295 Customizing Public Area 296 Customising page layouts 297 Customizing article display options 298 Change KBPublisher Look and Feel (design integration) 300 [v4.5 and below] Change KBPublisher Look and Feel 301 User settings 302 User defaults 303 Set default user privileges 304 Set Default User Roles 305 Force users to log on 306 User Manual v7.0 5 Allow Users to Register 307 Allow users to rate articles 308 Allow Users to Post Comments 309 Email settings 310 Letter Templates 311 Set Who Receives Emails 313 Change text in emails 314 Logs 315 Track search queries 316 Track emails 317 Track user logins 318 Track scheduled tasks 319 Changes for release 7.0 320 Setting up Social Site Authentication 321 Using Social Sites Login 322 Customising page layouts 323 Incoming email - Stop Evaluating Tasks 324 User Manual v7.0 6 User Manual v7.0 User manual for KBPublisher v7.0 User Manual v7.0 7 Introduction User Manual v7.0 8 What is KBPublisher? KBPublisher is a knowledge base which allows you to share information with employees, customers and partners. A fully featured knowledge base that combines powerful WYSIWYG editing with easy to use functionality Unique design and workflow enables you to create and approve articles and files before they are made available to other users The separate File feature means that your existing documentation can be easily inserted Can be integrated into your company intranet or internet Repeatable, reusable content through templates, file attachments and categories KBPublisher is highly customizable Full control of users, what they can do, and what they can see Can be configured to work in almost any language Import facility allows you to import users and articles from your old system in bulk Remote authentication allows you to integrate your current user authentication system with KB Publisher. An area to post announcements Subscription facility allows users to be notified of changes Version history that allows you to keep track of changes to articles Export facility allows you to export articles or whole knowledgebase to PDF or HTML Reports that provide statistics on users and articles Public area Where site visitors, staff read articles, view files, supply/request feedback User Manual v7.0 9 KBPublisher navigation gives you quick access to: Articles - read articles in the knowledgebase Files - view attached files News - read announcements Feedback - ability to contact administrator Glossary - a glossary of terms Comments - users can add comments to articles Ratings - users can rate content RSS feeds Email notifications - users can be notified when an item is changed Administration area Where staff create, edit and publish articles, upload files, moderate the knowledgebase and manage users User Manual v7.0 10 Where those who prepare and approve the content: Create articles Have them approved and published (or publish them direct) Schedule them to go live at on a specified date See history of changes to articles and revert back to earlier versions if required Upload files Automatically add any file uploaded to you server to the knowledgebase Moderate feedback Manage comments Bulk import articles from other sources Manage categories Manage users Import users Generate statistical reports Access log files Export articles as PDF or HTML files User Manual v7.0 11 KBPublisher Uses Attach it to your company web site or use it standalone in order to: Share information with customers and partners Provide support for products Answer a list of frequently asked questions Create a user manual, technical reference or APIs for your software Use it with your intranet or standalone in order to: Share information with employees or other team members Set up and use policies and procedures Use it as a support help desk Manage project documents and other content Provide training materials Share other company information The three different category types allow you to display the knowledgebase in a standard knowledgebase format, as FAQs on a page, or as a table of contents for a book or online help.