28
© Content and Code Ltd www.contentandcode.com Installation and User Manual Version 1.0.0.5

Important Notice WebPart

Embed Size (px)

DESCRIPTION

Important Notice WebPART

Citation preview

Page 1: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com

Installation and User Manual Version 1.0.0.5

Page 2: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 2 of 28

Contents

1 Introduction ................................................................................................................................ 3

2 Installation Requirements ............................................................................................................ 4

2.1 Recommended Hardware.................................................................................................. 4

2.2 Software Requirements ..................................................................................................... 4

2.3 Permissions ....................................................................................................................... 4

3 Install Important Notice ............................................................................................................... 5

3.1 Deploy the Solution ........................................................................................................... 5

4 License Activation ........................................................................................................................ 9

4.1 Offline Activation .............................................................................................................. 9

5 Configure Important Notice ....................................................................................................... 13

5.1 Activate the Site Collection Feature ................................................................................. 13

5.2 Add a user to the Manage Notices group......................................................................... 15

5.3 Manage Important Notices.............................................................................................. 18

5.3.1 Settings ............................................................................................................... 19

5.3.2 Create a New Notice ........................................................................................... 21

5.3.3 Important Notice Dialog Window ........................................................................ 24

5.3.4 View Report ........................................................................................................ 25

6 Uninstall Important Notice ........................................................................................................ 26

6.1 Deactivate the Feature .................................................................................................... 26

6.2 Uninstall the Solution ...................................................................................................... 26

Page 3: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 3 of 28

1 Introduction

Quickly distribute key business information and monitor acceptance with Important Notice for

SharePoint 2007 – the perfect way to ensure your people receive and understand business critical

information.

With Important Notice you can distribute key business information to relevant staff then track who

has read and accepted each notice, all through a familiar SharePoint interface. For this reason,

Important Notice is the perfect tool for distributing notifications of new company policies, changes

to working practises, financial results and other business critical announcements essential for

meeting compliance standards. Alternatively, Important Notice can be used as an entry point to

another system or content that has sensitive information and/or mandatory terms and conditions.

Important Notice comes with fully automated reporting capabilities and useful functionality such as

linking one or more documents to a notice, the ability to publish the notice on a specific page or site,

and deciding the steps an employee is required to take in order to accept a notice.

Page 4: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 4 of 28

2 Installation Requirements

Before proceeding with the Important Notice installation, please ensure the following requirements

are met.

2.1 Recommended Hardware

Performance of Important Notice may vary depending on the available resources.

Web front-end servers and Application servers

o Minimum Dual 2.8 GHz Pentium 4 CPU

o Minimum 2Gb RAM

Database servers

o Minimum Dual 2.8 GHz Pentium 4 CPU

o Minimum 2Gb RAM

2.2 Software Requirements

The following software MUST be installed on the server farm before proceeding with the installation.

Microsoft Office SharePoint Server 2007 (Standard or Enterprise) or Windows SharePoint

Servers 3.0

Microsoft Internet Information Services (IIS) 6.0 or later

Internet Explorer version 5.5 with Service Pack 2 or later

.NET 3.5 Service Pack 1 or ASP.NET

2.3 Permissions

The following permissions are required to complete all the steps outlined in this installation manual.

Member of the local administrators group on the server where the setup wizard is run.

Required to complete the installation and to add users to the Notice Manager group.

Farm Administrator with rights to add solutions and manage solutions deployment.

Required during installation and to upload/manage license keys in License Manager in order

to activate a product licenses.

A site collection administrator on the site collection where the product will be installed.

Required to activate the Site Collection Feature.

Page 5: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 5 of 28

3 Install Important Notice

This section outlines the procedure for installing Important Notice to a single Microsoft Office

SharePoint Server 2007 or Windows SharePoint Services 3.0 farm.

3.1 Deploy the Solution

Follow these steps to install and deploy Important Notice to one or more web applications.

1. Open CCImportantNoticeInstaller.exe

2. Click Next

Page 6: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 6 of 28

3. The setup will perform a system check to ensure the server meets the installation

requirements. If one of the checks fails, simple abort the installation and then resolve the

issue before running the setup again.

Important: When installing to a SharePoint farm running on Windows Server 2008 with User

Account Control (UAC) enabled, the installation permissions must be elevated using

the Right-click > Run as administrator option (see below).

Failure to do so will result in a System Check error for the Windows SharePoint Service

Timer service check.

4. Click Next

Page 7: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 7 of 28

5. If you are installing Important Notice for the first time you will be prompted with the EULA

acceptance window. Read and then agree to the terms of the licensing agreement by

selecting I accept the terms in the License Agreement.

6. Click Next

7. Select the web application where you intend to deploy Important Notice

8. Click Next

Page 8: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 8 of 28

Note: If you need to install 1OrgChart to more than one web application, repeat the steps

in section 3.1– Deploy the Solution for each web application.

9. When the installation is complete, click Next

10. Click Close to complete the installation

Page 9: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 9 of 28

4 License Activation

4.1 Offline Activation

Important: An offline license key is ONLY required when a product needs to be activated on a server that does not have internet connectivity e.g. when the SharePoint environment is behind a firewall that prevents internet access. If the product has already been activated please skip this section and proceed to Section 6 – Configure 1OrgChart

To activate the license key offline you will need to generate a Unique Activation Number (UAN) and

send this to Content and Code. The UAN is used by Content and Code to create a matching Offline

License Key which can be used to activate the product on the same server farm.

To generate and send a Unique Activation Number:

1. In SharePoint Central Administration click the Operations tab

2. Below the Content and Code Administration section click Manager Product Licenses

Page 10: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 10 of 28

3. Click 1OrgChart

4. Click Generate activation number

Page 11: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 11 of 28

5. Click Generate

6. Copy the Unique Activation Number and send it to [email protected]

Important: Once Content and Code have received your Unique Activation Number they will send

you a new product key that can be used to activate the product offline.

Page 12: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 12 of 28

7. Click Upload license key

8. Click Upload

9. If the license key matches the server where the UAN was generated, the license file will

activate the product automatically and take you to the Product License Manger page

(below).

Note: A tick is displayed next to each product on the Product License Manger page that has been activated. The Product License Manger page also includes details of the product, including the edition, version and expiration date (if a trial license is installed).

Page 13: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 13 of 28

5 Configure Important Notice

5.1 Activate the Site Collection Feature

1. Follow these steps to activate the Important Notice site collection feature

2. Go to Site Actions > Site Settings > Modify All Site Settings

Page 14: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 14 of 28

3. Under Site Collection Administration, click Site Collection Features

4. Locate Important Notice Administration

5. Click Activate

Congratulations!

Important Notice is now available and ready to use. Important Notice is now installed and available

within Site Settings > Site Administration > Manage Important Notices

Page 15: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 15 of 28

5.2 Add a user to the Manage Notices group

For a user to create and manage a new notice, the user will need to be a member of the Manage

Notice group. To add a user to the manage notice group, follow these steps.

1. Click Site Actions > Site Settings > Modify All Site Settings

2. Under the section Users and Permissions select People and Groups

3. In the left navigation titled Groups, select More

Page 16: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 16 of 28

4. Click the Important Notice Managers group

5. Click New > Add Users

6. Enter the account name of the user(s) you wish to have permissions to Create and Modify

their own notices.

Page 17: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 17 of 28

7. In the Give Permissions section, select Add users to a SharePoint group

8. Ensure the Important Notice Managers group is selected

9. Click OK

Page 18: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 18 of 28

5.3 Manage Important Notices

The Manage Important Notices page is used to create, modify, delete and track your notices. To

manage important notices, follow these steps.

1. Click Site Actions > Site Settings > Modify All Site Settings

2. In the section Site Administration click Manage Important Notices

Page 19: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 19 of 28

5.3.1 Settings

To configure the general settings within Important Notice, follow these steps:

1. On the Manage Important Notices page, select Settings

2. Fill in and edit the information you wish to change

Option Description

Dialog Title Specify the title that will be displayed to users in the Important Notice dialog window

Acceptance Checkbox

Specify the text that will be displayed next to the Acceptance Criteria checkbox in the Important Notice dialog window

Notice Dialog Item Limit

In the Important Notice dialog window, display items in batches of the specified size

Remind me later Decide whether the Remind Me Later button will be available for users. The Remind Me Later button enables users to dismiss a notice and be reminded again in the future

Style Specify the location of the Cascaded Style Sheet (CSS) used for the style of the Important Notice dialog box

Summary Item Limit

On the Manage Important Notice page, display items in batches of the specified size

Summary Email Report

Enable a summary report for all important notices and define how frequently Users/Groups will receive the report

Page 20: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 20 of 28

Page 21: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 21 of 28

5.3.2 Create a New Notice

To create a new notice, follow these steps:

1. On the Manage Important Notices screen, click New Notice

2. Select and Fill in the information to configure your notice

Page 22: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 22 of 28

Option Description

Title Type a title for this notice. Make the name descriptive, such as “New Travel Policy”, so that site visitors will know what to expect when they see this notice

Body Type the details of your notice. The body text will be displayed to the users

If the notice is regarding one of more documents that must be read, please use the References option later in this forum.

Scope Select the location where the notice will be displayed in the current site location.

Audience Select the users and groups that will receive the notice

Attach References

Add one or more documents, list items, pages or other URLS to this notice (e.g. a policy document)

Publish Date Select a date and time when the notice will be published and ready to display to users.

Expiry Date Select a date and time that the important notice will expire and no longer be displayed to users.

Page 23: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 23 of 28

Option Description

Frequency Select how often the notice will be displayed to users.

Acceptance Criteria

Select what a user must do in order to accept that they have read and understand a notice.

Report Enable a summary report for this notice and define how frequently you want to receive the report.

3. Click OK

Congratulations! You have now created your first important notice.

Page 24: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 24 of 28

5.3.3 Important Notice Dialog Window

When a user visits a page where an important notice has been published, the Important Notice

Dialog Window will be display on the page.

Item Description

1 Pagination to navigate between pages when there are more items

2 The notice title. Click on the title to display the notice description/summary for that item.

3 The notice description.

4 The date that notice will expire (i.e. not be displayed to the user if they haven’t already accepted it).

5 The attached reference for the notice. Click on the link to open the document(s) and/or item(s).

6 Confirmation box requires the user to select before accepting

7 Accept button

Page 25: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 25 of 28

Item Description

8 List of active notices

9 Remind me later button allows the user to read the notice at a more convenient time. Notices will be displayed again according to the frequency set when creating the notice.

5.3.4 View Report

To view the report of your notice follow these steps:

1. Once a notice is created, you will automatically be returned to the Manage Important

Notices page where your notice(s) will be available to view and modify.

2. Select the notice you wish to view followed by Show Report

Page 26: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 26 of 28

6 Uninstall Important Notice

6.1 Deactivate the Feature

1. Open the top level site in your site collection

2. Go to Site Actions > Site Settings > Modify All Site Settings

3. Below the section Site Collection Administration, click Site Collection Features

4. For the Notice Administration feature, click Deactivate

5. When prompted with a warning, click Deactivate this feature

6.2 Uninstall the Solution

To completely uninstall Important Notice from your farm, log onto the server from which you

installed Important Notice and locate your installation file and follow these steps.

Page 27: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 27 of 28

1. Run CCImportantNoticeInstalled.exe

2. Click Next

3. Once the system check is complete, click Next

4. Select Uninstall

5. Click Next

Page 28: Important Notice WebPart

© Content and Code Ltd www.contentandcode.com Page 28 of 28

6. Once the uninstall is complete, click Next

7. The details of the uninstall procedure will be displayed

8. Click Close