Content Management System User Guide

Transcription

Content Management System User Guide
Content Management System
User Guide
Table Of Contents
Getting Started Checklist ................................................................................ 1
Overview: Portal Content Management System .................................................. 3
Anatomy of a Portal Page ............................................................................. 3
Overview of the Content Management System................................................. 5
Articles Overview ........................................................................................ 6
How to Display Content on the Portal ............................................................. 7
Permissions Overview .................................................................................. 8
Accessing the Portal Content Management System ..........................................10
Permission Error Types ...............................................................................11
Portal Roles Defined ...................................................................................13
Managing Articles..........................................................................................15
Articles Overview .......................................................................................15
Accessing the Portal Content Management System ..........................................16
Searching for an Article ...............................................................................17
Editing an Article with Preview .....................................................................19
Editing an Article without Preview .................................................................23
Publishing an Article to the Portal .................................................................26
Displaying a Previous Version of an Article on the Portal ..................................28
Granting / Modifying Permissions on an Article ...............................................30
Creating an Article......................................................................................32
Displaying an Article on the Portal ................................................................34
Deleting an Article ......................................................................................35
Learning about Article Properties ..................................................................36
Using the Document Library ...........................................................................39
Document Library Overview .........................................................................39
Files .........................................................................................................40
Adding a Document .................................................................................................. 40
Adding Documents in Bulk ...................................................................................... 42
Granting / Modifying Permissions on a Document .................................................. 44
Granting / Modifying Permissions on a Document .................................................. 46
Portal Roles Defined ................................................................................................. 48
Tagging an Item ........................................................................................................ 49
Locking a Document................................................................................................. 51
Unlocking a Document ............................................................................................. 52
Editing a Document .................................................................................................. 53
Uploading a New Version of a Document................................................................ 56
Deleting a Document ................................................................................................ 57
Editing Properties of a File ....................................................................................... 58
Moving a File to a New Folder ................................................................................. 59
Viewing Previous Versions of a Document.............................................................. 62
Reinstating a Previous Version of a File................................................................... 63
Folders .....................................................................................................64
iii
Collaboration Portal User Guide
Creating a Folder....................................................................................................... 64
Deleting a Folder....................................................................................................... 66
Editing Folder Properties .......................................................................................... 67
Modifying Permissions on a Folder.......................................................................... 68
Using the Image Gallery.................................................................................69
Image Gallery Overview ..............................................................................69
Adding an Image to the Image Gallery ..........................................................70
Tagging an Item ........................................................................................72
Viewing Stored Images as a Slideshow ..........................................................74
Folders .....................................................................................................75
Creating a Folder....................................................................................................... 75
Deleting a Folder....................................................................................................... 77
Editing Folder Properties .......................................................................................... 78
Moving a Folder........................................................................................................ 79
Using the WYSIWYG Editor .............................................................................81
Using the WYSIWYG Editor ..........................................................................81
Toggle Edit Controls ......................................................................................89
Glossary ......................................................................................................91
Index ..........................................................................................................93
iv
GETTING STARTED CHECKLIST
The following checklist is designed to help get you started using Covisint's Content
Management system.
All tasks described in this help selection are role-based. If you are not able to
perform a task, contact your system administrator to have the proper role(s)
assigned to your profile. Tasks listed below are in the order in which they most
commonly are performed.
TASK:
Identify the Document Library, Image
Gallery, and Journal Portlet
Review permission requirements on
Documents, Articles, and Portlets.
REVIEW THE TOPIC ENTITLED:
Accessing the Portal Content Management
System
Permissions Overview
Permission Error Types
It is highly recommended that you
review the Permissions Overview
section before beginning work in the
Content Management System.
Identify the process of adding content
to the portal
Articles Overview
Editing Portal Content
Creating New Content
Displaying Content on the Portal
Create hyperlinks to documents on
your portal page
Upload new versions of existing
documents
Create hyperlink to existing document
Uploading a new version of a document
1
OVERVIEW: PORTAL CONTENT MANAGEMENT SYSTEM
Anatomy of a Portal Page
The following is the anatomy of a portal page. A portal page is made up of one or
many portlets. Within the portlet is content, called an article. Within the article
could be links to documents stored in the document library. Images that are stored
in the image gallery could be displayed in an article.
This example uses a page from the Covisint Support portal. While your page may
look different, the structure of your page will be the same.
Using this example, there is a page on the Covisint portal called the "Home" page
. On this page is a portlet called "What's New?". By default, pages and portlets are
managed by your Portal Content Administrator.
Within the portlet is content, referred to as an article called "Attention Auto Portal
Customers". This article contains a link to a document called "print the
overview". This document is stored in the document library. The article also
displays an image of a video camera. The image is stored in the Image Gallery. By
default, articles and the documents and images within them, are managed by
Content Managers.
To summarize, files that are stored in the document library and images stored
in the image gallery are made available to portal users when Content Managers
publish the content to the portal. Content, referred to as an article, is published
to a portal page inside portlets.
3
Collaboration Portal User Guide
The permission to view any of these items is configurable, as each may have a
different degree of specificity.
It is highly recommended that you review the section entitled Permissions Overview
before beginning to work in the Content Management System.
4
Overview: Portal Content Management System
Overview of the Content Management System
Covisint's Portal provides Content Management System functionality in two major
areas: document management (repositories for documents and images) and
publishing. Document management is provided through Covisint's Document
Library and Image Gallery portlets. These portlets provide intuitive management
of your organization's files and images.
Content that is stored in the document library and image gallery are made
available to portal users when Content Managers publish the content to the
portal. Content is published to a portal inside portlets.
5
Collaboration Portal User Guide
Articles Overview
An Article is the name of the content held within a portlet. The following screen
shot is called the "What's New?" Portlet. Within the portlet is an article, entitled
"Attention Automotive Portal Customers". Within this article, is a link ("print the
overview") to a document that is stored in the Document Library. Review the section
entitled Anatomy of a Portal Page for further details.
The ability to view
the portlet, article,
and document is
controlled by the
permissions set on
each item.
It is imperative
that you review
the section
entitled
Permissions
Overview before
proceeding
further.
Content Managers generally manage the documents and articles, while Covisint
manage portlets and portal pages.
6
Overview: Portal Content Management System
How to Display Content on the Portal
Step
Task
1.
Create the article
2.
Add hyperlinks to documents in the article via the
Document Library
3.
Add images in the article via the Image Gallery
4.
Modify permissions on the article and documents as
appropriate
5.
Contact Covisint according to your SOP with a request
to display new article in portlet
Tasks such as adding or removing portlets or portal pages are managed by our
Covisint Content Management team. Follow your existing process to work with our
Covisint Content Management team to perform those tasks.
RESULT:
You have successfully reviewed the process for displaying content on the
portal.
7
Collaboration Portal User Guide
Permissions Overview
The permission system is a very flexible mechanism used to define the actions a
given user can perform within the general context of the portal, or within a given
portlet and its data.
The main concept behind the portal's permission system are those of actions and
resources. So, permissions in Covisint's portal are defined as actions on a given
resource. Examples of actions would be: VIEW, UPDATE, MOVE, etc. Examples of
resources (as shown below) could be: Home page, What's New portlet, Attention
Auto Portal Customers article, and the overview document. Note that these
examples may each have a different degree of specificity.
Administrators are able to apply unique permission to portal pages,
portlets, articles, and documents. Administrators usually control
permissions on a page and portlet, while giving General Users of CMS
the ability to modify permissions on articles and documents.
Permissions must be set for each item, including the:
1. page on portal
2. portlet on page
3. article in portlet
4. document in article
Unless your Administrator has changed the default settings, then:
•
8
Administrators set permissions on pages (Home page) and portlets
(What's New? portlet) (items 1, 2)
Overview: Portal Content Management System
•
Content Contributors set permissions on articles (Attention Auto Portal
Customers) and document (Print the overview) (items 3, 4)
9
Collaboration Portal User Guide
Accessing the Portal Content Management System
After logging in to your Portal, click the
Content Management Link in the menu
options, usually placed on the left side of the
screen to launch your Content Management
System (CMS).
Your Content Management page is displayed. This page generally contains the following
portlets:
•
Document
Library
•
Image Gallery
•
Web Content
Additional portlets may also be available, but these are the main portlets used within CMS.
Tasks are role-based. If you do not have access to perform some of
the tasks in this support material, you have most likely not been given
the role to do so. Check with your Content Management Administrator
for details.
10
Overview: Portal Content Management System
Permission Error Types
ERROR
ISSUE
HOW TO
RESOLVE
Portlet
permissions
allow the
user to view
the portlet.
Apply appropriate
permissions for
this user type to
the article. Learn
how >>>
Article
permissions
do not allow
the user to
view the
article within
the portlet.
Portlet
permissions
allow the
user to view
the portlet.
Apply appropriate
permissions for
this user type to
the
document. Learn
how >>>
Article
permissions
allow the
user to view
the article
within the
portlet.
Document
permissions
do not allow
the user to
view the
document.
11
Collaboration Portal User Guide
A user cannot see the article or the document
because the user cannot see the portlet on the
page
If a user type is given VIEW permission
on a document, but not on the article, portlet,
nor page upon which the document is located,
the user will be able to perform a search in
the portal search field and find the document
in the search results.
view permission on document
view permission on article
view permission on portlet
view permission on page
12
Portlet
permissions
do not allow
the user to
view the
portlet.
Contact your
Portal Content
Administrator to
modify portlet
permissions if
appropriate.
Overview: Portal Content Management System
Portal Roles Defined
The following roles are the standard, default roles applicable to your
portal. Privileges per role are applied to portal pages, portlets, articles, documents,
and images.
ROLE NAME
DEFINITION
Guest
Non-authenticated access. Users do not need to be logged in
to the portal to view/access pages, portlets, articles, images,
or documents.
Owner
The authenticated user that created the item.
User
Authenticated Access - Users must be logged into the portal
to view/access pages, portlets, articles, images, or
documents
[Portal Name]
Portal Member
Authenticated Access - Users must be logged into the portal
and have the required portal service from within CCA (the
Covisint Administration tool).
13
MANAGING ARTICLES
Articles Overview
An Article is the name of the content held within a portlet. The following screen
shot is called the "What's New?" Portlet. Within the portlet is an article, entitled
"Attention Automotive Portal Customers". Within this article, is a link ("print the
overview") to a document that is stored in the Document Library. Review the section
entitled Anatomy of a Portal Page for further details.
The ability to view
the portlet, article,
and document is
controlled by the
permissions set on
each item.
It is imperative
that you review
the section
entitled
Permissions
Overview before
proceeding
further.
Content Managers generally manage the documents and articles, while Covisint
manage portlets and portal pages.
15
Collaboration Portal User Guide
Accessing the Portal Content Management System
After logging in to your Portal, click the
Content Management Link in the menu
options, usually placed on the left side of the
screen to launch your Content Management
System (CMS).
Your Content Management page is displayed. This page generally contains the following
portlets:
•
Document Library
•
Image Gallery
•
Web Content
Additional portlets may also be available, but these are the main portlets used within CMS.
Tasks are role-based. If you do not have access to perform some of
the tasks in this support material, you have most likely not been given
the role to do so. Check with your Content Management Administrator
for details.
16
Managing Articles
Searching for an Article
1. Navigate to the Web Content portlet on your CMS page.
2. Key in some search criteria in the open text field.
3. Click Search. The search results are displayed.
As shown in the example above, there are several versions of the file ID
number 151264. The most recent 'approved' version is what is currently
displayed on the portal (version 3.6 in this example).
17
Collaboration Portal User Guide
4. Optionally, navigate to the Actions menu to perform management tasks on
this article.
RESULT:
You have successfully searched for an article.
18
Managing Articles
Editing an Article with Preview
Using Preview functionality as described in this topic is the preferred and
recommended approach to editing articles.
The CMS system enables the Content Publisher to edited articles in a ‘preview’ mode.
Content Publishers are able to modify articles in real-time on the live production
portal, or they may choose to do so in a ‘behind-the-scenes’ view, using the Preview
functionality, as described below.
1. From the Welcome menu drop down, click Preview Content. The screen
refreshes and is outlined in a thick red box to indicate preview mode.
19
Collaboration Portal User Guide
2. Navigate to the article you wish to edit.
(edit icon). The currently published version of the article is
3. Click
displayed in the built-in editor. (If you do not see the edit icon, enable the
toggle edit controls in the CMS drop down menu. Refer to the section entitled
Toggle Edit Controls for further details. If edit controls are enabled, and you
still do not see the edit icon, then you do not have permission to edit this
article).
4. Edit the article as desired. If you add a new document to this article, you
may need to modify user permissions on the document after saving your
changes.
The current/published version is that which is displayed in the built-in
editor. There may be more recent versions of the article that have
not yet been published. Use the Versions drop down menu to
validate that you are editing the intended version.
20
Managing Articles
4. Configure article properties as required. Learn more about the article
properties >>>
5. Click Save and Continue.
6. Click Return. The screen refreshes, and the Preview mode of the edited
content is displayed.
7. After previewing the content, perform one or more of the following:
21
Collaboration Portal User Guide
IF YOU WISH TO...
THEN:
Approve and publish the
content
a. Click
b. Click Approve. The screen refreshes, and
a confirmation message is displayed.
c. Proceed to step 8.
Save content as a draft
and return without
publishing the content
Proceed to step 8.
Edit the previewed
content.
Repeat steps 3 - 7
8. From the Welcome drop down menu, click Live Content.
RESULT:
You have successfully previewed an article before publishing.
22
Managing Articles
Editing an Article without Preview
Also known as Editing Portlet Content. Content Publishers are able to edit article
content without previewing, directly from the portal. Edits are published
immediately to the production portal upon clicking Approve.
The preferred and recommended approach to editing articles is by
using Preview functionality as described in the section entitled Editing
an Article with Preview.
1. Navigate to the portlet in which the article you wish to edit is displayed.
(edit icon). The currently published version of the article is
2. Click
displayed in the built-in editor. (If you do not see the edit icon, enable the
toggle edit controls in the CMS drop down menu. Refer to the section entitled
Toggle Edit Controls for further details. If edit controls are enabled, and you
still do not see the edit icon, then you do not have permission to edit this
article).
23
Collaboration Portal User Guide
3. Edit the article as desired. If you add a new document to this article, you
may need to modify user permissions on the document after saving your
changes.
The current/published version is that which is displayed in the built-in
editor. There may be more recent versions of the article that have not yet
been published. Use the Versions drop down menu to validate that you are
editing the intended version.
4. Configure article properties as required. Learn more about the article
properties >>>
You will not see the option to "approve" until you click Save and
Continue.
24
Managing Articles
5. Perform one of the following:
IF YOU WISH TO...
THEN:
Approve and publish the
content
a. Click Save and Continue.
b. Click Approve. The screen refreshes, and
a confirmation message is displayed.
c. Click Return. The new version of the
article is created and displayed on the portal.
Save content as a draft
and return without
publishing the content
a. Click Save and Continue.
b. Click Return. The draft version is saved.
RESULT:
You have successfully edited an article.
25
Collaboration Portal User Guide
Publishing an Article to the Portal
Content Publishers are able to publish edited articles that are currently displayed on
the portal. Publishing can be completed during the Edit process, as described in the
sections for Editing an Article, or can be accomplished at a later time by approving
an article with a status type of Not Approved.
The preferred and recommended approach to editing articles is by
using Preview functionality as described in the section entitled Editing
an Article with Preview.
If you wish to publish a new article to the portal, refer to the section entitled
Displaying an Article on the Portal
1. Open the article you wish to publish in the built-in editor. (Refer to the
section regarding Editing an Article for further details).
The current APPROVED version is that which is displayed in the built-in
editor.
2. From the Versions drop down menu, select the unapproved article you wish to
publish. The screen refreshes, and the selected version of the article is
displayed.
26
Managing Articles
3. Perform one of the following:
IF YOU WISH TO...
THEN:
Approve and publish the
article as displayed
a. Click Approve. The screen refreshes, and a
confirmation message is displayed.
b. Click Return. The new version of the article
is created and displayed on the portal.
Modify the article, and
then publish
Refer to the section regarding Editing an Article
for further details.
RESULT:
You have successfully published an article.
27
Collaboration Portal User Guide
Displaying a Previous Version of an Article on the Portal
Content Publishers are able to rollback article versions in order to display a previous
version of the articles on the portal.
The preferred and recommended approach to editing articles is by
using Preview functionality as described in the section entitled Editing
an Article with Preview.
1. Open the current version article in the built-in editor. (Refer to any of the
sections regarding Editing an Article for further details).
The current APPROVED version is that which is displayed in the built-in
editor.
The current/published version is that which is displayed in the built-in
editor. There may be more recent versions of the article that have not
yet been published. Use the Versions drop down menu to validate that
you are editing the intended version.
2. From the Versions drop down menu, select the previous version of the article
you wish to display on the portal. The screen refreshes, and the selected
version of the article is displayed.
3. Click Save and Continue. The previous version is saved as a new version.
28
Managing Articles
4. Click Approve. The screen refreshes, and a confirmation message is
displayed.
5. Click Return. The new version of the article is created and displayed on the
portal.
RESULT:
You have successfully displayed a previous version an article.
29
Collaboration Portal User Guide
Granting / Modifying Permissions on an Article
1. In the Web Content portlet on your CMS page, search for the article for which
you wish to grant or modify permissions.
2. Click Actions.
3. Click Permissions.
30
Managing Articles
4. Grant / Modify permissions as desired by checking the appropriate
boxes. View user role definitions >>>
5. Click Submit. The screen refreshes, and permissions are applied to the
article.
If a user type is given VIEW permission on a document, but not
on the article, portlet, nor page upon which the document is
located, the user will be able to perform a search in the portal
search field and find the document in the search results.
view permission on document
view permission on article
view permission on portlet
view permission on page
RESULT:
You have successfully modified permissions of an article.
31
Collaboration Portal User Guide
Creating an Article
The following section describes the steps required to create your own content for
display in a portlet. This can be accomplished by Creating an Article and granting
permissions.
1. Navigate to the Web Content portlet on the CMS page.
Show me how >>>
2. Click Add Web Content. The WYSIWYG editor is displayed.
3. Key in the name of the article in the open text field.
4. Key in the body of the article in the open text field using the WYSIWYG editor.
5. From the categorization drop down menu, select the article type. This is a
most important step if you wish to create a list-type portlet. Selecting a
category flags the article to display in the corresponding list portlet. Learn
more about the article properties >>>
6. Click Save and Continue.
7. Click Approve.
32
Managing Articles
8. Grant permissions on the article. Learn more about permissions >>>
If a user type is given VIEW permission on a document, but not
on the article, portlet, nor page upon which the document is
located, the user will be able to perform a search in the portal
search field and find the document in the search results.
view permission on document
view permission on article
view permission on portlet
view permission on page
9. Contact Covisint according to your standard operating procedures with a
request to have the article displayed in a portlet.
RESULT:
You have successfully created an article.
33
Collaboration Portal User Guide
Displaying an Article on the Portal
Display an article in a portlet on the portal in one of two ways:
34
•
If you wish to display a new article, create the article, and then contact
Covisint, requesting that the new article is to be displayed in the portlet.
•
If you wish to display an edited version of an existing article, complete the
steps for Editing an Article.
Managing Articles
Deleting an Article
1. Navigate to the article in the journal portlet you wish to delete.
2. Enable the checkbox of each item you wish to delete.
3. Click Delete.
4. Click OK to confirm deletion. If this article was displayed in a portlet, the
portlet will now display an error message until the portlet is removed by the
administrator, or you configure it to display a different article.
RESULT:
You have successfully deleted an article.
35
Collaboration Portal User Guide
Learning about Article Properties
Whether you are creating a new article, or editing an existing article, properties of
the article can be configured at any time. The following is a description of article
properties most often used in content publishing.
ITEM:
NAME:
DESCRIPTION
1
Save and Continue
Enables user to save changes, and
continue working on the article.
2.
Workflow
Enables user to view / reinstate previous
versions of the article. By selecting a
past version, and clicking Save and
Continue, a copy of the past version
becomes incremented with a new
version number.
Categorization
Select the category type from the drop
down menu to flag the article in the
3.
36
Managing Articles
ITEM:
4.
5.
NAME:
DESCRIPTION
system to be displayed in the
appropriate articles (List) portlet.
Select Tags
Select a tag to apply to the article so
that it is displayed as tagged. For
example, an article may be tagged
private, indicating to the system that a
user must be logged in to the system to
view the article, that the article is not
available for public viewing.
Approve
Clicking Approve is the final step in
publishing content on the portal. Once
content is final, click Approve to display
it in the portlet in which it was selected.
37
USING THE DOCUMENT LIBRARY
Document Library Overview
Covisint's Document Library is a part of the document management functionality (as
is the Image Gallery) provided by Covisint's Content Management System.
The Document Library provides a centralized repository for various document types
(e.g., .PDF, .DOC, .XLS, etc.) to be stored, and a unique URL is auto-assigned to
each of them. An organization running the Portal can protect and post internal
documentation (e.g., reimbursement forms, charitable donations policies, etc.) for
access by its employees. Alternatively, since each document has its own URL, a
portlet on your company's public website may display a list of unprotected PDF files
of quarterly newsletters and their download links. Document protection is
permission-based. Learn more about permissions >>>
The Document Library supports multiple repositories that can be set with different
access roles. Also, the documents in the repository are version-controlled, allowing
an authorized user to retrieve any particular revision that has been stored on the
system.
39
Collaboration Portal User Guide
Files
Adding a Document
1. In the Document Library, navigate to the folder in which you wish to add a
document. (This example will add a file to the 'testing' folder).
Note: You are not able to add a document to an empty Document
Library portlet. Documents must be uploaded to folders. If a
folder is not available, add a folder before proceeding with the
steps in this section.
2. Click Add Document.
40
Using the Document Library
3. Click Browse and select the file you wish to upload to the document library.
4. Optionally, key in the title, description, and select tags as desired.
5. Click Save. The screen refreshes, and the file is uploaded to the folder.
6. Click Return to Full Page.
7. Grant permissions on the document. Learn more about document
permissions >>>
RESULT:
You have successfully added a document. Next, grant permissions on the
document. (Upload file to the wrong folder? Move to the correct folder.)
41
Collaboration Portal User Guide
Adding Documents in Bulk
1. In the Document Library, navigate to the folder in which you wish to add
many documents. (This example will add files to the 'testing' folder).
You are not able to add a document to an empty Document Library
portlet. Documents must be uploaded to folders. If a folder is not
available, add a folder before proceeding with the steps in this
section.
2. Click Add Document.
3. Click Browse (you can select multiple files) and select the file(s) you wish
to upload to the document library.
42
Using the Document Library
4. Click Upload Files. The screen refreshes, and the files are uploaded to the
folder.
5. Click Return to Full Page.
6. Grant permissions on each document.
RESULT:
You have successfully added documents in bulk. Next, grant permissions on
each document. (Upload files to the wrong folder? Move to the correct
folder.)
43
Collaboration Portal User Guide
Granting / Modifying Permissions on a Document
1. Navigate to the document for which you wish to grant or modify permissions
in the Document Library.
2. Click Actions.
3. Click Permissions.
4. Grant / Modify permissions for each role as desired by checking the
appropriate boxes. View user role definitions >>>
5. Click Submit.
44
Using the Document Library
If a user type is given VIEW permission on a document, but not on the
article, portlet, nor page upon which the document is located, the user
will be able to perform a search in the portal search field and find the
document in the search results.
view permission on document
view permission on article
view permission on portlet
view permission on page
RESULT:
You have successfully modified permissions of a document. If you added
documents in bulk, you must still modify permissions on each document.
45
Collaboration Portal User Guide
Granting / Modifying Permissions on a Document
1. Navigate to the document for which you wish to grant or modify permissions
in the Document Library.
2. Click Actions.
3. Click Permissions.
4. Grant / Modify permissions for each role as desired by checking the
appropriate boxes. View user role definitions >>>
46
Using the Document Library
5. Click Submit.
If a user type is given VIEW permission on a document, but not on the
article, portlet, nor page upon which the document is located, the user
will be able to perform a search in the portal search field and find the
document in the search results.
view permission on document
view permission on article
view permission on portlet
view permission on page
RESULT:
You have successfully modified permissions of a document. If you added
documents in bulk, you must still modify permissions on each document.
47
Collaboration Portal User Guide
Portal Roles Defined
The following roles are the standard, default roles applicable to your
portal. Privileges per role are applied to portal pages, portlets, articles, documents,
and images.
ROLE NAME
DEFINITION
Guest
Non-authenticated access. Users do not need to be
logged in to the portal to view/access pages,
portlets, articles, images, or documents.
Owner
The authenticated user that created the item.
User
Authenticated Access - Users must be logged into the
portal to view/access pages, portlets, articles,
images, or documents
[Portal Name]
Portal Member
Authenticated Access - Users must be logged into the
portal and have the required portal service from
within CCA (the Covisint Administration tool).
48
Using the Document Library
Tagging an Item
Tags are a way of organizing and aggregating content. The tagging system within
the portal enables:
•
The Administrator to determine which tags are available for usage.
•
Your users to select those tags on their content.
Tags are administered by your Content Administrator and our Covisint CMS
team. Together, they create tags for your use.
In this example, a document will be tagged appropriately in order to be displayed in
a portlet called the Downloads portlet. Content in this Downloads portlet will be
pulled from the Document Library.
1. Add the file to the Document Library folder
2. Key in the title and description fields as necessary.
3. Click Select Tags.
49
Collaboration Portal User Guide
4. Enable the checkbox of each tag you wish to apply to the document.
5. Click Save in the Select Tags pop up window. The selected tags are
displayed.
6. Click Save on the File Upload screen. The screen refreshes, and the new file
is uploaded to the Document Library, and displayed in the portlet associated
to the selected tags (the Downloads Portlet in this example).
RESULT:
You have successfully applied tags to an item.
50
Using the Document Library
Locking a Document
Prevent others from editing a document by locking the file.
1. Navigate to the document you wish to lock in the Document Library.
2. Click Actions.
3. Click Edit.
4. Scroll to the bottom of the screen and click Lock.
the document is locked.
The screen refreshes and
5. Click Return to full page.
RESULT:
You have successfully locked a document.
51
Collaboration Portal User Guide
Unlocking a Document
Allow others to edit a document by unlocking the file.
1. Navigate to the document you wish to unlock in the Document Library.
2. Click Actions.
3. Click Edit.
4. Scroll to the bottom of the screen and click Unlock.
and the document is unlocked.
5. Click Return to full page.
RESULT:
You have successfully unlocked a document.
52
The screen refreshes
Using the Document Library
Editing a Document
Complete the following steps to edit a document stored in the Document
Library. The following steps for editing include locking the document to prevent
others from making changes to it while you are working on it.
Note: You are able to take a shortcut to editing a document and
bypassing the lock/unlock feature described below, by simply
uploading a new version of the document. However, the document is
not locked and therefore others are not prevented from editing at the
same time, possibly writing over your edits.
1. Lock the Document (this optional step is recommended). The "locked"
confirmation message is displayed.
53
Collaboration Portal User Guide
2. Download the file to your desktop by clicking the icon next to: Download.
3. Save the file to your desktop.
4. Edit as necessary and save the file outside of the CMS system.
5. Navigate to the locked file in the document library.
54
Using the Document Library
6. Upload the edited version of the file by clicking Actions next to the file name.
7. Click Edit.
8. Click Browse... and select the edited document you wish to upload to the
portal.
9. Scroll to the bottom of the screen and click Save. The screen refreshes and
the edited file is uploaded.
10. Unlock the document (when appropriate).
11. You may need to modify permissions on the document. Learn more about
document permissions >>>
RESULT:
You have successfully edited a document.
55
Collaboration Portal User Guide
Uploading a New Version of a Document
1.
In the Document Library., navigate to the document for which you wish to
upload a new version.
2. Click Actions.
3. Click Edit.
4. Click Browse... and select the file you wish to upload to the portal. The file
name will remain the same as the original file stored in Document Library,
and an incremental version number will be added.
5. Scroll to the bottom of the screen and click Save. The screen refreshes and
the edited file is uploaded. Permissions from the previous version are applied
to this new version.
RESULT:
You have successfully uploaded a new version of a document and an
incremental version number has been added. If necessary, view previous
versions.
56
Using the Document Library
Deleting a Document
1. Navigate to the document you wish to delete in the Document Library.
2. Click Actions.
3. Click Delete.
4. Click OK to confirm deletion. (Remember, if an article on your portal
contains a link pointing to this document, edit the article to either remove the
link or redirect it to an active document.)
RESULT:
You have successfully deleted a document.
57
Collaboration Portal User Guide
Editing Properties of a File
1. In the Document Library, navigate to the file for which you wish to edit
properties.
2. From the Actions menu, click Edit.
3. Edit the properties of the file as necessary.
4. Click Save. The screen refreshes and the file properties are updated.
RESULT:
You have successfully edited the properties of a file.
58
Using the Document Library
Moving a File to a New Folder
1. Navigate to the file you wish to move in the Document Library. This example
moves the file "testresults.txt" out of the folder called "training" and into the
"tests" folder.
2. Click Actions for the document you wish to move.
3. Click Edit. The Edit screen for the file is displayed.
59
Collaboration Portal User Guide
4. Click Select.
5. Use the navigation path to move up or down in the folder structure to locate
the new target folder.
6. Click Choose in the row of the folder you wish to select as the new target
folder (tests folder, in this example).
60
Using the Document Library
7. Click Save. The screen refreshes, and the file is moved to the new folder
location.
RESULT:
You have successfully moved a file to a new folder.
61
Collaboration Portal User Guide
Viewing Previous Versions of a Document
1. Navigate to the document you wish to view previous versions in the
Document Library.
2. Click Actions.
3. Click View.
4. Scroll down to the Version History tab at the bottom of the screen and click
on the version you wish to view.
RESULT:
You have successfully viewed previous versions of a document. If necessary,
reinstate a previous version.
62
Using the Document Library
Reinstating a Previous Version of a File
1. Navigate to the Version History screen of the file you wish to reinstate.
2. Click the download icon for the version of the file you wish to reinstate and
save it to your desktop.
3. Click on the folder name in the navigation path in which the file is
stored. The navigation path is generally located at the top of the screen, as
indicated in the screen shot. (This example uses the folder named 'training').
4. Upload the new version of the file. The previous version is stored as the
active version, and assigned a new incremental version number.
RESULT:
You have successfully reinstated a previous version.
63
Collaboration Portal User Guide
Folders
Creating a Folder
1. Navigate to the location in which you wish to add a folder in the Document
Library or Image Gallery. (This example will add a subfolder to the
Accounting folder).
2. Click Add Subfolder.
If you are adding a folder at the root level (top level) of the folder structure,
click Add Folder, then continue to step 3.
64
Using the Document Library
3. Key in the Name and Description of the folder.
4. Optionally, modify permissions on this folder. By default, new folders inherit
the permissions from the parent folder.
5. Click Save.
The screen refreshes and the new folder is created.
6. Optionally, add more folders or subfolders to further divide your items into
more specific categories by repeating steps 2 - 5.
RESULT:
You have successfully created a new folder in either the Document Library or
Image Gallery. Next, you may wish to add a document or add an image to
the folder.
65
Collaboration Portal User Guide
Deleting a Folder
1. Navigate to the folder you wish to delete in the Document Library.
2. Click Actions.
3. Click Delete.
4. Click OK to confirm deletion. The folder, and all contents within the folder,
are deleted from the system.
RESULT:
You have successfully deleted a folder.
66
Using the Document Library
Editing Folder Properties
1. Navigate to the folder you wish to edit in the Document Library.
2. Click Actions.
3. Click Edit.
4. Modify the folder name / description as desired.
permissions on a folder).
(Learn about editing
5. Click Save.
RESULT:
You have successfully edited folder properties.
67
Collaboration Portal User Guide
Modifying Permissions on a Folder
1. Navigate to the folder for which you wish to modify permissions in the
Document Library.
2. Click Actions.
3. Click Permissions.
4. Grant / Modify permissions for each role as desired by checking the
appropriate boxes. View user role definitions >>>
5. Click Save.
Folder permissions have no impact on the permissions of the
documents uploaded to the folder. If you wish to apply the
permissions of the folder to the document, you must modify document
permissions.
RESULT:
You have successfully modified permissions of a folder.
68
USING THE IMAGE GALLERY
Image Gallery Overview
Like the Document Library, the Image Gallery provides a centralized repository for
images used throughout the Portal. A unique URL is assigned to each
image. Through the Image Gallery, you are able to add and store images, reference
the image (by referencing the image's unique URL) as well as view the images of a
folder in a slideshow format.
69
Collaboration Portal User Guide
Adding an Image to the Image Gallery
Complete the following steps to add an image to the image gallery portlet.
Note: Images can only be uploaded into a folder. If necessary,
create a folder before uploading an image.
1. Navigate to and click on the folder in the Image Gallery in which you wish to
add an image. (If a folder is not available, create a new folder).
70
Using the Image Gallery
2. Click Add Image.
3. Browse and select the image to upload.
4. Key in an easily identifiable description for the image in the open text field.
5. Click Save. After saving, you are returned to the folder in which you saved
the image.
6. Optionally, click on the image for a full-size view.
RESULT:
You have successfully added an image to the image gallery.
71
Collaboration Portal User Guide
Tagging an Item
Tags are a way of organizing and aggregating content. The tagging system within
the portal enables:
•
The Administrator to determine which tags are available for usage.
•
Your users to select those tags on their content.
Tags are administered by your Content Administrator and our Covisint CMS
team. Together, they create tags for your use.
In this example, a document will be tagged appropriately in order to be displayed in
a portlet called the Downloads portlet. Content in this Downloads portlet will be
pulled from the Document Library.
1. Add the file to the Document Library folder
2. Key in the title and description fields as necessary.
3. Click Select Tags.
72
Using the Image Gallery
4. Enable the checkbox of each tag you wish to apply to the document.
5. Click Save in the Select Tags pop up window. The selected tags are
displayed.
6. Click Save on the File Upload screen. The screen refreshes, and the new file
is uploaded to the Document Library, and displayed in the portlet associated
to the selected tags (the Downloads Portlet in this example).
RESULT:
You have successfully applied tags to an item.
73
Collaboration Portal User Guide
Viewing Stored Images as a Slideshow
Users (with appropriate access rights) are able to view all images stored in a folder
in a slideshow format.
1. Navigate to the folder containing the images you wish to view in the Images
Gallery.
2. Click View Slide Show. A new window is displayed, showing a full-size
image and a set of commands. It will repeatedly scroll through the images
inside the folder chosen.
3. Optionally, view images at your own pace, by clicking Pause, Next or
Previous to change images as you wish.
4. Optionally, set the speed at which the slides are auto played. There is a
speed setting from 1 through 10, with 1 being the fastest and 10 the slowest.
5. Click Play to resume the slideshow at the chosen speed.
RESULT:
You have successfully viewed stored images as a slideshow.
74
Using the Image Gallery
Folders
Creating a Folder
1. Navigate to the location in which you wish to add a folder in the Document
Library or Image Gallery. (This example will add a subfolder to the
Accounting folder).
2. Click Add Subfolder.
If you are adding a folder at the root level (top level) of the folder structure,
click Add Folder, then continue to step 3.
75
Collaboration Portal User Guide
3. Key in the Name and Description of the folder.
4. Optionally, modify permissions on this folder. By default, new folders inherit
the permissions from the parent folder.
5. Click Save.
The screen refreshes and the new folder is created.
6. Optionally, add more folders or subfolders to further divide your items into
more specific categories by repeating steps 2 - 5.
RESULT:
You have successfully created a new folder in either the Document Library or
Image Gallery. Next, you may wish to add a document or add an image to
the folder.
76
Using the Image Gallery
Deleting a Folder
1. Navigate to the folder you wish to delete in the Document Library.
2. Click Actions.
3. Click Delete.
4. Click OK to confirm deletion. The folder, and all contents within the folder,
are deleted from the system.
RESULT:
You have successfully deleted a folder.
77
Collaboration Portal User Guide
Editing Folder Properties
1. Navigate to the folder you wish to edit in the Document Library.
2. Click Actions.
3. Click Edit.
4. Modify the folder name / description as desired.
permissions on a folder).
5. Click Save.
RESULT:
You have successfully edited folder properties.
78
(Learn about editing
Using the Image Gallery
Moving a Folder
1. Navigate to the folder you wish to move in the Document Library.
2. Click Actions.
3. Click Edit.
4. Perform one or more of the following:
If you wish
to...
move a folder
to a new
parent folder
Then...
a. Click Select.
b. Click Choose in the row of the folder you wish to select
as the new parent folder.
c. Click Save.
move the
folder to the
root level
a. Click Remove.
add a new
folder
a. Click Select.
b. Click Save.
79
Collaboration Portal User Guide
If you wish
to...
Then...
b. Click Choose in the row of the folder you wish to select
as the new parent folder.
c. Click Save.
RESULT:
You have successfully moved a folder.
80
USING THE WYSIWYG EDITOR
Using the WYSIWYG Editor
WYSIWYG, an acronym for What You See Is What You Get, is used in CMS to
describe a system in which the content displayed during editing appears very similar
to the final output when displayed on the portal page. The editor is displayed when
you create or edit an article.
81
Collaboration Portal User Guide
Generally, toolbars in the editor closely match toolbars in common word processing
applications. By hovering the mouse over an icon in the toolbar, a description of that
item is displayed. Users also have the option to click the source button and create
pages via HTML code if that is preferred.
How do I type in SOURCE code?
The WYSIWYG editor allows you to create links or present images that are stored in
the document library and image gallery. You are also able to upload new content to
these document management portlets from the editor.
82
Using the WYSIWYG Editor
If you wish to...
create a link to
an existing
document in the
Document
Library to
this journal
content
Then in the WYSIWYG Editor...
a. Highlight the word / words you wish to hyperlink in
the WYSIWYG Editor.
b. Click the hyperlink icon in the toolbar. The Link pop
up box is displayed.
c. Click Browse Server.
d. In the Resource Type drop down menu, select
Document.
e. Drill down into the folder structure to find the
document.
f.
Click on the document name. The Link pop up box is
displayed.
g. Click Target, then determine how you wish this
document to open (in a new window, in the existing
window, etc).
h. Click OK.
i.
create a link to a
document not
yet existing in
the Document
You may need to modify permissions on the
document.
a. Highlight the word / words you wish to hyperlink in
the WYSIWYG Editor.
b. Click the hyperlink icon in the toolbar. The Link pop
83
Collaboration Portal User Guide
If you wish to...
Library to
this journal
content
Then in the WYSIWYG Editor...
up box is displayed.
c. Click Browse Server.
d. In the Resource Type drop down menu, select
Document.
e. Drill down into the folder structure to the place you
wish to store the document.
f.
Click Browse...
g. Select the file you wish to upload.
h. Click Upload. The screen refreshes and the
document is listed in the folder.
i.
Click on the document name. The Link pop up box is
displayed.
j.
Click Target, then determine how you wish this
document to open (in a new window, in the existing
window, etc).
k. Click OK.
l.
insert an image
already existing
in the image
gallery to
84
You may need to modify permissions on the
document.
a. Click the Image Insert icon in the toolbar in the
WYSIWYG Editor. The Image Properties screen is
displayed.
Using the WYSIWYG Editor
If you wish to...
Then in the WYSIWYG Editor...
this journal
content
b. Click Browse Server.
c. Drill down into the folder structure to find the image.
d. Click on the image name. The Images Properties pop
up box is displayed.
e. In the alternate text field, key in the text that will
display in the event the image does not load on a
page.
f.
Click OK.
85
Collaboration Portal User Guide
If you wish to...
insert a new
image not yet
existing in the
image gallery to
this journal
content
Then in the WYSIWYG Editor...
a. Click the Image Insert icon in the toolbar in the
WYSIWYG Editor. The Image Properties screen is
displayed.
b. Click Browse Server.
c. Drill down into the folder structure to the place you
wish to store the image.
d. Click Browse...
e. Select the image you wish to upload.
86
Using the WYSIWYG Editor
If you wish to...
Then in the WYSIWYG Editor...
f.
Click Upload. The screen refreshes and the image is
listed in the folder.
g. Click on the image name. The Images Properties pop
up box is displayed.
h. In the alternate text field, key in the text that will
display in the event the image does not load on a
page.
i.
Click OK.
87
TOGGLE EDIT CONTROLS
1. Click the Welcome menu (also known as the Portal Dock Bar).
2. Enable the checkbox next to Toggle Edit Controls. The screen refreshes
and edit controls are displayed.
RESULT:
You have successfully enabled edit controls.
89
GLOSSARY
A
Article ID: The Article ID is a unique, auto-generated number used to identify a
single article. This number cannot be modified.
Articles: Used in Journal Portlets, this is where each content piece is populated with
actual text and images. The article is the actual content that uses the
template and structure.
D
Document Library: Similar to the Image Gallery, this is a centralized repository for
files used throughout the Portal. It provides a centralized repository for
various document types (e.g.,.PDF, .DOC,.XLS, etc.) to be stored and assigns
a unique URL to each of them. A company's intranet using Covisint's Portal
can then be able to post internal documentation (e.g., reimbursement forms,
charitable donations policies, etc.) for access by its employees. Alternatively,
since each document has its own URL, a portlet on your company's public
website may display a list of PDF files of quarterly newsletters and their
download links. The Document Library supports multiple repositories that can
be set with different access roles. Also,the documents in the repository are
version-controlled, allowing a user to retrieve particular revision has been
stored on the system.
I
Image Gallery: Similar to the Document Library, this is a centralized repository for
images used throughout the Portal. Each image is assigned a unique URL.
L
Locked Document: Locking a document prevents others from editing this
document. No updated version can be uploaded until the document is
unlocked.
P
Portlet: Portlets are small web applications that run in a portion of a web page. The
heart of any portal implementation is its portlets, because all of the
functionality of a portal resides in its portlets. Covisint's portal core is a
portlet container. The container's job is to manage the portal's pages and to
aggregate the set of portlets that are to appear on any particular page.
T
Tags: Tags are a way of organizing and aggregating content. The tagging system
within the portal enables: 1. The Administrator to determine which tags are
91
Collaboration Portal User Guide
available for usage. 2. Your users to select those tags on their content. 3.The
content that is tagged can be grouped or aggregated. (See Tags
Administration Portlet.)
W
Web Content Display Portlet: Allows displaying one or more contents manually
selected from the list of available portlets. If more than one content is
selected only one at a time will be shown and links will be added to allow the
user to navigate to the rest of the contents. The Journal Articles portlet and
the Journal Content portlet are used to display content created through the
Journal portlet. While the Journal portlet creates all content used in CMS, it is
the Journal Articles and Journal Content portlet that actually display content
to portal users and guests. The Journal Content portlet enables a Journal
article to be requested and displayed on the portal page. You can integrate
the power of function-rich portlets with the more static information of a
Journal article. For example, a company may have an "Investors" page on
their website. In one column you may see the Stocks portlet and in another
column a Journal Content portlet. The Stocks portlet can display the
company's ticker symbol with stock price and the Journal Content portlet can
display static content of the latest financial reports.
Web Content Portlet: An administration portlet that allows the creating, updating,
searching, and managing content. This portlet allows writers to easily edit
content displayed on web pages without having to sort through complex code.
The Journal Articles portlet and the Journal Content portlet are used to display
content created through the Journal portlet. While the Journal portlet creates
all content used in CMS, it is the Journal Articles and Journal Content portlet
that actually display content to portal users and guests.
WYSIWYG Editor: WYSIWYG, an acronym for What You See Is What You Get, is
used in computing to describe a system in which content displayed during
editing appears very similar to the final output, which might be a printed
document, web page, etc. Generally, toolbars in this type of editor very
closely match the toolbars in common word processing applications.
92
INDEX
D
Deleting a Folder .................. 82, 95
Documents
Editing a Folder .................... 82, 97
Adding a New Document .............55
P
Deleting a Document ..................69
Permissions
Editing a Document ....................70
Locking a Document ...................63
Modifying Permissions on a
Document......................... 56, 59
Unlocking a Document ................64
Modifying Permissions on a Folder 83
Uploading a New Version of a
Document ..............................65
Viewing Previous Versions of a
Document ..............................74
F
Folders
Creating a New Folder 78, 79, 92, 93
Portlets
Creating Your Own Content in a
Journal Content Portlet .............41
V
Versions
Viewing Previous Versions of a
Document...............................74
93