diff --git a/docs/source/csat_pro_user_guide.md b/docs/source/csat_pro_user_guide.md index 6f1896c..c47b26a 100644 --- a/docs/source/csat_pro_user_guide.md +++ b/docs/source/csat_pro_user_guide.md @@ -187,7 +187,7 @@ The Import Assessment page lets the user enter the same information as described A detailed log indicating import successes and warnings will be generated and displayed following the import process. This import log also will be available in the assessment’s Event Log. ### System Admin Pages ### -System Admins have several pages available to them that users with a Basic system profile do not. Note: System Admins navigating from System Admin specific pages such as User Management and Organization Management pages will remain on the System Admin track of pages, which differs from the Organization track of pages. However, if a System Admin also has organization roles, they can navigate through the standard Organization track of pages via the Organization Info pages accessible from the My Organizations and My Assessments sections of their Home Page. +System Admins have several pages available to them that users with a Basic system profile do not. Note: System Admins navigating from System Admin specific pages such as User Management and Organization Management pages will remain on the System Admin track of pages, which differs from the Organization track of pages. However, if a System Admin also has organization roles, they can navigate through the standard Organization track of pages via the Organization Info pages accessible from the My Organizations and My Assessments sections of their Home Page. System Admin pages are generally identified with a gear icon near the title to help differentiate between similar System Admin and Org Admin pages, and to remind admins to use caution when performing actions with elevated privileges. ####System Integrations Page#### This page is available by selecting “System Integrations” from the gear icon on the top menu. The Industry Average Service is the only system integration that is currently available. Information on the Industry Average Service can be viewed by clicking on the blue question mark icon. System Admins can choose to opt in with the “Opt In” button if their instance is currently opted out, or they can choose to opt out with the “Opt Out” button if their instance is currently opted in. @@ -231,6 +231,31 @@ This page is available by selecting “Org Management” from the gear icon on t System Admins can either enter the appropriate search criteria (organization name, industry, website, and org level) to narrow their search, or they can leave these fields empty to search for all organizations. The resulting list will display the organization name, industry, website, parent organization, number of sub-organizations, number of users, and number of open assessments for the organizations/sub-organizations that met the search criteria. System Admins can use the “Edit Organization” icon in the Action column to change the organization’s information. +####Manage Organization Page#### +This page is available by selecting the “Edit Organization” icon from the Action column of an organization’s row on the Organization Management page. The Manage Organization page is the System Admin equivalent of the Organization Info page, offering many of the same actions and displaying much of the same information for an individual organization/sub-organization. + +#####Organization Section##### +The Organization section displays the Name, Website, and Industry of the current organization. Depending on the user's role in the organization, the following buttons can be found in this section: + +- Edit - The Edit button allows the organization’s Name, Website, and/or Industry to be updated. +- Delete - The Delete button will remove the organization, as well as all the organization’s sub-organizations and assessments (so use with caution). +- View Organization Chart - This button will display the top-level organization along with its sub-organizations in a hierarchical chart. In this chart, the currently selected organization is highlighted in green, while the other organizations are in blue. For each organization/sub-organization, the organization’s name and industry are displayed, as well the number of direct and total sub-organizations that are under that organization, and an organization logo (if uploaded). Each parent organization has a circle at the bottom with a “-” or “+” symbol that will enable the sub-organizations under that organization to be displayed or hidden. Users can drag to move around, as well as zoom in or out on the chart using the scroll wheel of the mouse. Clicking on any of the organization blocks in the System Admin Organization Chart will take the user to the Manage Organization page for that organization. +- Upload Logo/Delete Logo – The Upload Logo button will prompt the user to browse to an image file (of type jpeg, jpg, bmp, or png; and under 500KB in size). Once uploaded, the Upload Logo button will be replaced with the Delete Logo button. The Delete Logo button will prompt for confirmation and then delete that organization’s logo file, reverting the button back to the Upload Logo button. Uploaded organization logos will display in that organization’s Organization Info page, on the first slide of Board Level Slides exports for its assessments, and on its block in the Organization Chart. +- Change Parent Organization – The Change Parent Organization button will allow the System Admin to reorganize organization trees by moving the selected organization/sub-organization, along with all of its sub-organizations. There are options to choose from: + - Make this organization the top-level organization of a new organization tree – The selected organization and its sub-organizations will be moved out of its current organization tree, and a new organization tree is created with the selected organization at the top of the new tree. + - Move this organization within its existing organization tree – The selected organization and its sub-organizations will be moved to a different part of the organization’s current tree. A different organization/sub-organization within the current tree will be selected as the destination for the move. In the drop-down list containing organizations/sub-organizations for the destination location, you can click on the bullet beside the organization/sub-organization name to expand/collapse that organization’s list of sub-organizations (if that organization has sub-organizations). + - Move this organization to a different, existing organization tree – The selected organization and its sub-organizations will be moved to a different, already existing organization tree. A destination organization/sub-organization from a different tree will be selected. In the drop-down list containing organizations/sub-organizations for the destination location, you can click on the bullet beside the organization/sub-organization name to expand/collapse that organization’s list of sub-organizations (if that organization has sub-organizations). Use caution with this option as it can expose the moved organizations/sub-organizations and all their data (assessments, etc.) to users in the destination tree. + +#####Sub-organizations Section##### +The Sub-organizations Section displays the Organization Name and Industry for sub-organizations of the current organization. There is a “Create Sub-organization” button that will create a new sub-organization under the current organization. The sub-organizations in this list are clickable and will take the user to the Manage Organization page of that sub-organization. + +#####Active Users Section##### +The Active Users section displays a list of the users that have Organization Roles in the organizations. The icons under the action section allow the System Admin to change a user’s organizational role or remove the user from the organization (deleting the user’s organization role for the organization). Note that there is an “Include Sub-organizations” checkbox in the pop-up window for these actions; if this checkbox is selected, the same action will be performed for that user in the sub-organizations of the current organization as well. System Admins also have an “Add Users” button in this section that allows the System Admin to create new users in CSAT Pro, or assign an organizational role for this organization to existing users that don’t currently have a role in this organization. System Admins creating new users through a Manage Organization page's Add Users workflow will select an Organization Role for that organization on the Create User page. Users who do not have a role in any organization/sub-organization in the organization tree will require a System Admin to add those users to an organization in the organization tree; as such, role removal actions that will result in a user being removed from an organization tree entirely will present a warning to proceed or cancel the action. + +#####Assessments Section##### +The Assessments section displays a list of the assessments that exist in this organization. The following information is displayed for each assessment in the list - Assessment Name, Assessment Template, Start Date, Due Date for open assessments (or Closed Date for closed assessments), Organization, and Action icons for any actions that the current user is permitted for the particular assessment (action icons can let you view the assessment’s dashboard, edit the assessment’s name/dates, view a list of tasks to complete, view a list of tasks pending for validation, or delete an assessment). There is an Open tab and a Closed tab that allow the user to toggle between open and closed assessments. System Admins have buttons to start a new assessment under this organization: “Start New Assessment” (to start a new blank assessment) and “Import Assessment” (to import an assessment from a previously exported Hosted CSAT or CSAT Pro spreadsheet). + + ### Creating a New User ### Users in CSAT Pro can be created in two ways. System Admins can create users with the “Create User” button on the User Management page. Organization Admins can create new users by selecting the “Add Users” button on the Organization Info page for an organization that they administer, and then selecting “Create User” on the resulting page. In both cases, the following information needs to be entered on the Create User page: