Difference between revisions of "Academic Effect"

Revision as of 14:31, 22 July 2015

1 Terms
2 Roles
3 Account Data Structure and Onboarding
- 3.1 How To Create a new Account
4 User Data Structure
- 4.1 How To Create a User
5 Authentication and Security
6 Applications
7 Dashboard
8 Document
9 Effect
10 Execute
11 Reflect
12 Report
13 Structure (settings)
14 Developement Patterns
15 Data Structure
16 Remote Handler API
17 Public API (future)

Terms

Applications: A group of features gathered into a single installable unit. Formally called Workspaces.

Projects: A project is an group of tasks created in an application by and for a single user. It can be shared with other users.

Roles: A group of rights that can be assigned to a user as a unit. For example the Administrator role might have rights to all editing features.

Rights: An individual privilege assigned to roles. For example, the Administrator role might have the right to edit users.

Project Owner: A right granted to the user who creates a project. The Project Owner can view and edit the project.

Project Author: A right granted to a user that allows them to view and edit the project.

Project Reviewer: A right granted to a user that allows them to view a project.

Affirm: Breaks the standards out into projects and complete data entry for each standard, in preparation for the accrediting body to review.

Align: (define this application)

Document: (define this application)

Effect: Used to implement effective evaluation theory. Often. Academic and Performance assessment.

Intent: Group can get together to formulate a strategic plan. Create a high level strategic plan.

Reflect: Post Mortem analysis. Analyze past performance.

Verify: Enter facility and show they are qualified to teach

Structure: The settings for individuals and organizations.

Effect Report

Standards

Collections: a way to group standards

Official Standards: a standard added and maintained within the system

Public Standards: A local standard that was published for everyone.

Local Standards: A standard added by an organizaiton.

Roles

User: An individual who has authentication access to the Academic Effect application framework.

Basic User: This is typically a customer with access to applications associated to the user's Institution. Access to Structure Profile and Structure Templates.

Verify Manager: This is typically a basic user granted special privileges in the Verify Application in Structure and Verify to mark the Verified checkbox (more detail).

Verify Facilitator: This is typically a basic user granted special privileges in the Verify Application to add data for degrees, but cannot verify it.

PC Admin: (Consider renaming Account Admin) This is typically the customer's administrator. They are a basic user with the following additional rights

Super User: This is typically Academic Effect support personnel. Legacy Rights - Can flit from account/subdomain to account/subdomain and see all. The only thing they cannot see fully are documents. (Future Rights - A basic user of a support/test organization, full administration site access with edit access to all site content, plus access to the Impersonation Tool which lets a user authenticate as other users temporarily to duplicate support issues.)

Account Data Structure and Onboarding

Accounts (organizations): The organization record is the primary repository for account information

How To Create a new Account

Use the Account Creation tool from the admin site to setup a new Account
- log in as a Super User
- Go to /admin > Manage Addons > Performance Cloud Account Creation > click on Account Creation Tool
- Fill out and submit this form
- (tbd) the Account's PC Admin will receive an email inviting them to create a password and finish onboarding through the Structure section
- (tdb) If Weave Support needs access to the Account, they should login using the Impersonation Tool for the account's PC Admin

User Data Structure

Users: A user is a Contensive people record.

Organization (Institution): is a Contensive Organization, found under Manage Users > Organizations.

How To Create a User

Create a basic user for the correct organization.
- log in as a PC Admin for the organization with which the user is needed.
- go to Structure > Manage Users > Click the Add button at the bottom.
If the user needs to be a PC Admin or Super User, go the the backend of the site and upgrade them
- Go to /admin
- Navigator > Manage Users > click on People
- search for the user
- click Edit to modify the user's record
- Check the appropriate permission (right) on the Permissions tab

Authentication and Security

There are three methods of authentication: Native, LDAP (future), and CAS (future)

Applications

An application in Academic Effect is a group of common features installed as a unit to an organization. An installed application is run when a user in that organization clicks button in the header with the applications name. Applications are installed by editing the organization and checked the appropriate checkbox in the Workspaces tab. (formally called Workspaces)

Affirm

Align

Effect

Dashboard

The dashboard is a default application that lists all the user's projects, and all the applications installed for the user's account.

Document

Data Structures

Documents: Documents are records in the Documents content, in the Performance Cloud Collection
Folders: Folders are records in the Document Folders content, in the Performance Cloud Collection
Institutional Documents ; (tbd)

Permissions

Owner: (tbd)
Author: (tbd)
Reviewer: (tbd)

Collections

Institutional: (tbd)
My Collection: (tbd)
Shared with Me: (tbd)

Document Sharing

Sharing Collections, Folders and Files: (tbd)
Receiving Shared Collections, Folders and Files: (tbd)

Effect

Execute

Reflect

Report

Structure (settings)

Think

Verify

Developement Patterns

Html/CSS

html and css are developed in the PerformanceCloud GitHub project.

Server Code

Server Code is developed in the Weave gitHub Project

Deployment

html/css/js
- Start GitHub/PerformanceCloud and checkout the latest commit of the current sprint
- copy all files except /Archive to /inetpub/performacnecloud/files/processor
- run Manage Addons > Performance Cloud Template Processor > click on Template Processor
- proof each change to verify it deployed
- if all is OK, merge the sprint branch into master and create a new sprint branch.
Server Code
- deployment of server code is with addon collections files.
- upload each collection file to the production site whose modification date is after the last production push
- proof each change to verify it deployed
- merge the github branch into the master
- create a new branch for the next sprint

Data Structure

Academic Ranks

Accreditation Chapter Shelf

Accreditation Chapters

Accreditation Shelf

Accreditations

Additional Websites

Analysis Questions

Annual Special Report

Application Alerts

Argument Statuses

Assessment Approval Statuses

Assessment Comments

Assessment Document Rules

Assessment Goal Comments

Assessment Goals

Assessment Objective Comments

Assessment Objective General Education Rules

Assessment Objective Institutional Priority Rules

Assessment Objective Meta Data

Assessment Objective Meta Data Achievement Statuses

Assessment Objective Meta Data Approval Statuses

Assessment Objective Standard Rules

Assessment Objective Strategic Plan Rules

Assessment Objectives

Assessments

Authentication Methods

Campuses

Career Information

CIP Codes

Cited Document Index

Common Passwords

Compliance Levels

Contract Lengths

Countries

Course Rules

Courses

Credential Headers

Degree Institutions

Degree Rules

Degree Types

Degrees

Departments

Divisions

Document Access Rules

Document Bookmarks

Document Citation Coauthors

Document Citation Editors

Document Entity Rules

Document Folder Access Rules

Document Folder Rules

Document Folders

Document Makes

Document Source Material Types

Document Sources

Document Statuses

Document Types

Documentation Types

Documents

Domains

Employee Types

Employment Statuses

Entities

Ethnicities

Faculty

Faculty Course Rules

Faculty Statuses

Facutly Degrees

Folder Permissions

Genders

General Education Elements

Institutional Priorities

Institutional Roles

Intervals

Measure Source Evidence

Measure Source Evidence Rules

Measure Source Evidence Types

Members

Narrative Statuses

Objective General Education Element Rules

Objective Institutional Priority Rules

Objective Standard Rules

Objective Strategic Plan Rules

Organization Campuses

Organization Document Source Material Types

Organization Document Sources

Organization Document Statuses

Organization Institutional Roles

Organization Research Types

Organizations

Password Policies

People

Permissions

Prefixes

Projects

Research Types

Role Rules

Roles

Salaries

Standard Shelf

Standards

Standards Comments

Standards Contributors

Standards Document Rules

States

Strategic Plans

Suffixes

System Status

Tenure Statuses

Titles

Units

User Tasks

Users Guide

Workspace Organization Rules

Workspaces

Remote Handler API

remotes/addTask/

remotes/deleteTask/

remotes/formDataAddDocument/

remotes/formDataAddTask/

remotes/getControlPanel/

remotes/getDegreeList/

remotes/getDepartmentList/

remotes/getEmploymentStatusList/

remotes/getIntervalList/

remotes/getPageLoad/

remotes/getPermissionList/

remotes/getPrefixList/

remotes/getSuffixList/

remotes/getTaskList/

remotes/getTenureList/

remotes/getTitleList/

remotes/loginUser/

remotes/logoutUser/

remotes/saveInterval/

remotes/saveUser/

remotes/saveUserSettings/

remotes/uploadFile/

remotes/addFaculty/

remotes/getCourseDetails/

remotes/getFacultyAddForm/

remotes/getFacultyEditForm/

remotes/getFacultyList/

remotes/saveFacultyDetails/

remotes/verifyFaculty/

remotes/deleteDocument/

remotes/getDocumentList/

remotes/quickDocumentSave/

remotes/deleteStandard/---deleteme-duplicate

remotes/deleteStandardContributor/

remotes/deleteStandardDocumentConnection/

remotes/getAffirmDashboard/

remotes/getStandardDetails/

remotes/saveStandardComment/

remotes/saveStandardNarrative/

remotes/saveStandardStatus/

remotes/sendAffirmMessage/

remotes/toggleCommentInclude/

remotes/addAssessmentComment/

remotes/addAssessmentGoal/

remotes/addAssessmentObjective/

remotes/addAssessmentObjectiveComment/

remotes/addAssessmentObjectiveMeta/

remotes/deleteAssessment/

remotes/deleteAssessmentDocumentConnection/

remotes/getAssessmentDetails/

remotes/getEffectProjectList/

remotes/saveAssessmentInformation/

remotes/saveAssessmentMission/

remotes/addAssessmentGoalComment/

remotes/deleteAssessmentGoal/

remotes/deleteAssessmentObjective/

remotes/deleteAssessmentObjectiveMeta/

remotes/getAssessmentGoal/

remotes/getAssessmentObjective/

remotes/getAssessmentObjectiveMeta/

remotes/saveAssessmentFinding/

remotes/saveAssessmentGoal/

remotes/saveAssessmentGoalStatus/

remotes/saveAssessmentMeasure/

remotes/saveAssessmentObjective/

remotes/saveAssessmentTarget/

remotes/setGoalSort/

remotes/setObjectiveMetaSort/

remotes/setObjectiveSort/

remotes/loadDocumentDetails/

remotes/saveDocumentDetails/

remotes/getAccreditations/

remotes/getDataList/

remotes/getGeneralEducationElements/

remotes/getInstitutionalPriorities/

remotes/getMeasureSourceList/

remotes/getMeasureSourceListAcademicDirect/

remotes/getMeasureSourceListAcademicIndirect/

remotes/getMeasureSourceListAdministrative/

remotes/getStrategicPlans/

remotes/uploadFileDebug/

remotes/getFolderPermissions/

remotes/deleteAssessmentDocumentConnection/

remotes/deleteDocumentFolder/

remotes/getDocument/

remotes/getDocumentBookmarks/

remotes/getFolders/

remotes/saveDocumentFolder/

remotes/setDocumentFolder/

remotes/getAttachments/

remotes/getDocumentDetails/

remotes/loadDocumentApp/

remotes/changePassword/

remotes/loadLogin/

remotes/resetPassword/

remotes/sendLoginCredentials/

remotes/sendUserRequest/

remotes/validatePassword/

remotes/validateUsername/

remotes/generateAPIAccessKey/

remotes/getAccountDetails/

remotes/getAccountUsers/

remotes/getAnalysisQuestionList/

remotes/getCIPCodeList/

remotes/getCoursesList/

remotes/getDegreeList/

remotes/getGeneralEducationList/

remotes/getMyProfile/

remotes/getPasswordPolicy/

remotes/getStrategicPlanList/

remotes/setAccountDetails/

remotes/setMyProfile/

remotes/setPasswordPolicy/

remotes/filterDocuments/

remotes/getCollectionEdit/

remotes/getCollectionShareEdit/

remotes/getFolderEdit/

remotes/getShareRequests/

remotes/processShareRequests/

remotes/setCollectionShare/

remotes/setDocumentShare/

remotes/getAnalysisQuestionEdit/

remotes/getAnnualSpecialReportEdit/

remotes/getAnnualSpecialReportList/

remotes/notifyActivatedUser/

remotes/saveAnalysisQuestion/

remotes/saveAnnualSpecialReport/

remotes/saveDegree/

remotes/getAlerts/

remotes/getFulIInsitutionList/

remotes/setInstitutionOverride/

remotes/getDegreeAdd/

remotes/getDegreeSearch/

remotes/getDocumentAppSettings/

remotes/savePassword/

remotes/saveUserDegree/

remotes/saveUserDegreeMeta/

remotes/setEmployeeInfo/

remotes/getUsersGuide/

remotes/verifyDocument/

remotes/verifyFile/

remotes/deleteCourse/

remotes/editCourse/

remotes/saveCourse/

remotes/filterCredentials/

remotes/getFacultyDetails/

remotes/suggestCIPCode/

remotes/deleteAccountLogo/

remotes/deleteOrganizationDocumentMaterialType/

remotes/deleteOrganizationDocumentSource/

remotes/deleteOrganizationDocumentStatus/

remotes/deleteOrganizationResearchType/

remotes/deleteProfilePicture/

remotes/getUserDegreeMeta/

remotes/saveOrganizationDocumentMaterialType/

remotes/saveOrganizationDocumentSource/

remotes/saveOrganizationDocumentStatus/

remotes/saveOrganizationDocumentType/

remotes/saveOrganizationDocumentUseCase/

remotes/saveOrganizationResearchType/

remotes/setWorkspaceAccess/

remotes/getNonIPEDDegreeAdd/

remotes/getUserQualification/

remotes/saveNonIPEDDegree/

remotes/saveUserQualification/

remotes/deleteCareerInformation/

remotes/deleteCareerInformationDocument/

remotes/deleteCredentialHeader/

remotes/saveBiography/

remotes/saveCareerInformation/

remotes/saveCredentialHeader/

remotes/downloadDocument/

remotes/getFacultyDetails/

remotes/deleteOrganizationCampus/

remotes/deleteOrganizationDepartment/

remotes/deleteOrganizationDivision/

remotes/deleteOrganizationInstitutionalRole/

remotes/getOrganizationAppSettings/

remotes/saveOrganizationCampus/

remotes/saveOrganizationDepartment/

remotes/saveOrganizationDivision/

remotes/saveOrganizationInstitutionalRole/

remotes/deleteDegreeDocument/

remotes/deleteQualificationDocument/

remotes/setOrganizationMessaging/

remotes/deleteAdditionalWebsite/

remotes/deleteCareerInfoDocument/

remotes/deleteDegreeCIP/

remotes/deleteQualificationCIP/

remotes/getCountryStates/

remotes/deleteQualification/

remotes/deleteUserDegree/

remotes/createDuplicateDocument/

remotes/duplicateDocument/

remotes/deleteGeneralEducationElement/

remotes/deleteInstitutionalPriority/

remotes/deleteReportingPeriod/

remotes/deleteStrategicInitiative/

remotes/deleteStrategicInitiativeCollection/

remotes/editGeneralEducationElement/

remotes/editImprovementsAchieved/

remotes/editInstitutionalPriority/

remotes/editReportingPeriod/

remotes/editSourceOfEvidence/

remotes/editStrategicInitiative/

remotes/editStrategicInitiativeCollection/

remotes/getGeneralEducationElementList/

remotes/getImprovementsAchieved/

remotes/getInstitutionalPrioritiesList/

remotes/getReportingPeriodList/

remotes/getSourcesOfEvidenceList/

remotes/getStrategicInitiativeCollectionList/

remotes/getStrategicInitiativeList/

remotes/saveGeneralEducationElement/

remotes/saveImprovementsAchieved/

remotes/saveInstitutionalPriority/

remotes/saveReportingPeriod/

remotes/saveSourceOfEvidence/

remotes/saveStrategicInitiative/

remotes/saveStrategicInitiativeCollection/

remotes/sortCareerInformation/

remotes/sortCredentialHeaders/

remotes/deleteStandard/

remotes/deleteStandardsCollection/

remotes/duplicateStandardsCollection/

remotes/editStandard/

remotes/editStandardsCollection/

remotes/getStandardList/

remotes/getStandardsCollectionList/

remotes/saveStandard/

remotes/saveStandardsCollection/

remotes/duplicateProjectTemplate/

remotes/duplicateStrategicInitiativeCollection/

remotes/editProjectTemplate/

remotes/getProjectTemplateList/

remotes/setProjectTemplateShare/

remotes/sendCommand/

remotes/addProjectTemplate/

remotes/saveProjectTemplate/

remotes/saveTemplateEditors/

remotes/editEffectProject/

remotes/deleteProjectAttachment/

remotes/deleteProjectComment/

remotes/deleteRelatedProject/

remotes/deleteSupportedInitiative/

remotes/getGeneralEducationElementsSupportedInitiativeList/

remotes/getInstitutionalPrioritiesSupportedInitiativeList/

remotes/getStandardsSupportedInitiativeList/

remotes/getStrategicInitiativesSupportedInitiativeList/

remotes/getSupportedInitiativeList/

remotes/saveProjectAttachment/

remotes/saveProjectComment/

remotes/saveRelatedProject/

remotes/saveSupportedInitiative/

remotes/deleteEffectProject/

remotes/deleteEffectProjectGoal/

remotes/deleteEffectProjectObjective/

remotes/deleteEffectProjectObjectiveMeasure/

remotes/deleteEffectProjectTarget/

remotes/editAffirmProject/

remotes/editEffectProjectTarget/

remotes/getEffectProjectsByReportingPeriod/

remotes/parseEffectProjectData/

remotes/saveEffectProject/

remotes/saveEffectProjectTarget/

remotes/deleteThinkProject/

remotes/deleteThinkProjectSubTopic/

remotes/deleteThinkProjectSubTopicElement/

remotes/deleteThinkProjectSWOT/

remotes/deleteThinkProjectTopic/

remotes/editThinkProject/

remotes/getThinkProjectList/

remotes/parseThinkProject/

remotes/saveThinkProject/

remotes/editReflectProject/

remotes/getReflectProjectList/

remotes/parseReflectProject/

remotes/saveReflectProject/

remotes/duplicateExecuteProject/

remotes/editExecuteProject/

remotes/getExecuteProjectList/

remotes/saveExecuteProject/

remotes/saveExecuteProjectTask/

remotes/duplicateAffirmProject/

remotes/duplicateAffirmProject/

remotes/getAffirmProjectList/

remotes/initializeAffirmProject/

remotes/saveAffirmProject/

remotes/deleteReflectProject/

remotes/deleteReflectProjectSection/

remotes/deleteReflectProjectSubTopic/

remotes/deleteReflectProjectSubTopicElement/

remotes/deleteReflectProjectSWOT/

remotes/deleteReflectProjectTopic/

remotes/deleteProjectTopicAttachment/

remotes/saveProjectTopicAttachment/

remotes/deleteProjectAccess/

remotes/editRelatedProject/

remotes/getAssignedColleagues/

remotes/getNonAssignedColleagues/

remotes/getNonRelatedProjects/

remotes/getRelatedProjects/

remotes/saveProjectAccess/

remotes/setProjectShare/

remotes/getAlignProjectList/

remotes/getProjectList/

remotes/getFacultyRosterReportReport/

remotes/getFolder/

remotes/getReportingPeriods/

remotes/getReport/

remotes/getReportList/

remotes/getReportStatus/

remotes/saveReport/

remotes/triggerReportProcessing/

remotes/updateSIProjectReference/

@@ Line 181: / Line 181: @@
 ====Creating and Viewing Effect Projects====
 Users can also create new Effect projects by clicking the plus sign on the page. They then have the option of duplicating an existing project or creating a new one. To duplicate a project, the user will click on the DUPLICATE button, select the project to duplicate from the drop down menu, select the reporting period from a drop down menu and then type in the new Project Name. Then the user can enter all relevant information and click SAVE. At this point the new project will appear in the list of Effect projects. To create a new project, users will click on the CREATE NEW button, select the template from the drop down to use, choose the reporting period from the drop down, and type in the project name. Then the user can enter all relevant information and click SAVE. This project will now appear in the project list on the Effect page. <br />
+====Project Fields Available to Edit====
+; Status : The status of the project; choices include Nothing Entered, Draft, Final and In Review
+; Project Title : The title field provides a place for users to type in a unique name for the project.
+; Reporting Period : Users can choose available reporting periods from a drop down menu.
+; Related Projects : Users can click the + sign to add projects related to this Affirm project. To add the project, click the check box next to any related project and click ADD SELECTED. The selected projects will then be listed under Related Projects and are accessible by clicking on the symbol next to the project name.
+; Attachments : Users can upload any documents related to this Affirm project by selecting the folder and document and then clicking ATTACH TO PROJECT for any files already uploaded to Academic Effect. To Upload files from a drive, users will click the BROWSE button, select the file and select a folder for saving the document. The user then clicks START UPLOAD to complete the upload process. Next, select the document and click ATTACH TO PROJECT.
+; Project Collaborators : If users want colleagues to have access to the project, they will click the INVITE COLLABORATORS button, select the user, specify whether they are an author or reviewer and click ADD SELECTED. The names of all collaborators will be displayed in the Project Collaborators section. If they want to remove collaborators, they will also click the INVITE COLLABORATORS button and then select REMOVE. They will see a list of all current collaborators. To remove one, select that one and click REMOVE SELECTED.
+; Comments : Users can post comments by typing in the comments field and clicking POST.
+:: '''NOTE: Available fields will vary based on the selected template; new templates can be created to accommodate unique requirements.'''
+Once all changes are made, the user will click SAVE to save the updated project. <br />
 </blockquote>
 ==Dashboard==
 The dashboard is a default application that lists all the user's projects, and all the applications installed for the user's account.

Difference between revisions of "Academic Effect"

Revision as of 14:31, 22 July 2015

Contents

Terms

Roles

Account Data Structure and Onboarding

How To Create a new Account

User Data Structure

How To Create a User

Authentication and Security

Applications

Affirm

Getting Started

Creating and Viewing New Self Studies

Project Fields Available to Edit

Align

Effect

Getting Started

Creating and Viewing Effect Projects

Project Fields Available to Edit

Dashboard

Document

Data Structures

Permissions

Collections

Document Sharing

Effect

Execute

Reflect

Report

Structure (settings)

My Profile

Account Information

Application Settings

Manage Users

Messaging

Password Policies

Reporting Periods

Templates

Reflective Prompts

Courses

General Education

Institutional Priorities

Improvements Achieved

Organization Settings

Sources of Evidence

Standards

Strategic Initiatives

Think

Verify

Developement Patterns

Html/CSS

Server Code

Deployment

Data Structure

Academic Ranks

Accreditation Chapter Shelf

Accreditation Chapters

Accreditation Shelf

Accreditations

Additional Websites

Analysis Questions

Annual Special Report

Application Alerts

Argument Statuses

Assessment Approval Statuses

Assessment Comments

Assessment Document Rules

Assessment Goal Comments

Assessment Goals

Assessment Objective Comments

Assessment Objective General Education Rules

Assessment Objective Institutional Priority Rules

Assessment Objective Meta Data

Assessment Objective Meta Data Achievement Statuses

Assessment Objective Meta Data Approval Statuses

Assessment Objective Standard Rules

Assessment Objective Strategic Plan Rules

Assessment Objectives

Assessments