Microsoft Office

From AlfrescoWiki

Jump to: navigation, search

Contents

[edit] Microsoft Office 2003 Add-ins

New to Alfresco v2.1 are Add-Ins for Microsoft Word, Excel and PowerPoint 2003.

[edit] Compatibility with Microsoft Office 2007 and Windows Vista

Although the Alfresco Add-Ins have been designed with Microsoft Office 2003 in mind, they are compatible with Microsoft Office 2007, with the following caveats:

  • Before installing the Add-Ins, ensure the .NET Programmability Support option has been installed for each of the Office applications you are installing the add-ins for. Normally these will be Word, Excel and PowerPoint.
    • The options can be found by running the Office Setup program and expanding the list of available options for each application.
    • You may need your original Office 2007 install media in order to add these essential components.

[edit] An Important Note about Windows Vista

  • You are likely to be running Office 2007 on Windows Vista. Unfortunately, Microsoft have rewritten the WebDAV parts of Vista which means you will experience READ ONLY access to the Alfresco Repository over WebDAV. This is a known problem with Vista and effects many applications, including Microsoft's own SharePoint Server. There is no known workaround at the time of writing, despite the ones suggested in the linked article.
  • CIFS access is unaffected and works as it does with Windows XP. Therfore, you will have to use CIFS to obtain read/write access to Alfresco using Windows Vista.

[edit] Installation

Note: the following example is for the Office 3-in-1 installer which installs all three add-ins. Individual installers are provided should you only wish to add Alfresco to one of the three Office applications.

  • Unzip the zip file containing the setup files. You should have:
    • readme.rtf
    • setup.exe
    • AlfrescoOffice2003Setup.msi
    • Office2003PIA/o2003pia.msi
  • Ensure none of the Microsoft Office applications are running. Note you may have to also close down Outlook if you use Word as the e-mail editor.
  • Run setup.exe
    • You may need to have local administrative priviledges in order to install the Add-In. This is due to some system files (e.g. .NET 2.0 framework) which need updating.
  • If required, the setup program will download components it needs from the Microsoft web site. The required two components are the .NET 2.0 framework located at http://go.microsoft.com/fwlink/?LinkId=37283 and the Visual Studio 2005 Tools for Office Second Edition runtime located at http://go.microsoft.com/fwlink/?LinkId=79951
  • Once setup is complete and has exited, run the Office application (e.g. Word)

[edit] Configuration

The Add-Ins use a common configuration and present the configuration screen when none is found.

You can return to the configuration screen at any time via the link at the bottom of the Add-In window. It is recommended that all configuration boxes are filled-in for the best user experience.

[edit] Web Client URL

(Mandatory) Enter the URL to the Alfresco Web Client. This will usually take the form:

http://server:8080/alfresco/

[edit] WebDAV URL

(Mandatory) This is usually the Web Client URL appended with webdav/, e.g.

http://server:8080/alfresco/webdav/

The Add-In will try to auto-complete this value when you start typing.

[edit] CIFS Server

(Optional - unless using Windows Vista (see above)) Alfresco recommend using the CIFS interface to access your documents. As before, the Add-In will attempt to help by auto-completing this value, but check with your Alfresco administrator for the correct address. e.g.

\\server_a\alfresco\
or
\\servera\alfresco\
(v2.1 Enterprise and later)

[edit] Authentication

The Add-In will always try to automatically log you in to Alfresco in order to present your checked-out documents, your assigned tasks, etc. If you are using the CIFS interface, authentication is automatic in most cases. However, sometimes the Add-In needs to present your Alfresco username and password in order to be correctly authenticated. It is recommeneded that you enter and save your Alfresco credentials. All values are stored in the Windows registry and your password is encrypted against casual hacking attempts.

Configuration panel
Configuration panel

[edit] An important note about CIFS

If you intend to use the CIFS interface to save documents via the add-in, it is very important that you are authenticated automatically. Limitations in the Microsoft Office APIs mean that an error is shown instead of an authentication dialog box if the Alfresco CIFS interface rejects your connection attempt. If you are not in an enterprise environment where it might not be possible to configure automatic authentication, mapping a network drive to the Alfresco CIFS interface should accomplish the same task.

[edit] Usage

All examples given below are for the Word 2003 application. Usage with Excel and PowerPoint is very similar.

The Add-In starts when Word starts and displays automatically. You can toggle the panel on and off using the Alfresco toolbar button that will have been added to the toolbar within the Word application:

Image:Word2003_ToolbarButton.png

The main interface of the Add-In consists of five tabs:

Image:Word2003_AddInTabs.png

  1. My Alfresco
  2. Browse Spaces
  3. Search
  4. Document Details
  5. Workflow

Some tabs contain expandable panels, indicated by the Image:Word2003_arrow_up.gif icon. Click the icon to expand the panel and again to restore it.

[edit] My Alfresco


The My Alfresco tab is split into three sections:

[edit] My Checked Out Documents

Shows all the documents and files you currently have checked out (aka Working Copies). Each file has up to three actions available:

  • Image:Word2003_checkin.gif Check In: Check-in the working copy
  • Image:Word2003_new_workflow.gif Start new workflow: Takes you to the Workflow tab to start workflow on the selected document
  • Image:Word2003_makepdf.gif Convert to PDF: Converts the document to Adobe PDF format

Additionally, clicking the filename itself will either open the document in Word (.doc files) or load the content via a new web browser window.

[edit] My Tasks

Shows all tasks currently assigned to you, displayed in ascending Due Date order - overdue tasks will be at the top of the list, followed by tasks due today, and so on. Clicking a task will display the task details on the Workflow tab (see below)

[edit] Actions

Other actions available here will vary depending on the current state of the Add-In. Always available will be:

  • Image:Word2003_create_space.gif Create Collaboration Space: Takes you to the Browse Spaces tab with the Create Space panel displayed.
  • Image:Word2003_AlfrescoLogo16.gif Launch Alfresco: Launches the Alfresco Web Client in a new web browser window. Note: the Add-In uses Internet Explorer to render the user interface. When an external link is launched in a new browser window, it will use Internet Explorer even if you currently have a different default browser set in Windows (e.g. Firefox).
My Alfresco tab
My Alfresco tab

[edit] Browse Spaces


The Browse Spaces tab is also split into three sections:

[edit] Current Space Navigator

The navigator shows the current space near the top of the panel. If you are not at the top-level Company Home space, there will also be an Image:Word2003_go_up.gif Up icon to navigate to parent spaces.

Below the Current Space area are the subspaces contained within the current space. Clicking these will navigate into that space and make it the current one.

At the top of the subspaces panel is a Image:Word2003_create_space.gif Create New Space... item. Clicking this will drop down a form which allows you create new spaces.

Image:Word2003_CreateSpace.png

[edit] Documents and Files

Displays a complete list of all documents and files within the current space. Each file has certain actions available depending on the file type and the status of the file:

  • Image:Word2003_checkin.gif Check In: Check-in the working copy
  • Image:Word2003_checkout.gif Check Out: Check-out the document or file into the current space
  • Image:Word2003_lock.gif Locked: Neither check-in nor check-out is available
  • Image:Word2003_new_workflow.gif Start new workflow: Takes you to the Workflow tab to start workflow on the selected document
  • Image:Word2003_makepdf.gif Convert to PDF: Converts the document to Adobe PDF format
  • Image:Word2003_delete.gif Delete: Deletes the document or file

Additionally, clicking the filename itself will either open the document in Word (.doc files) or load the content via a new web browser window.

[edit] Actions

  • Image:Word2003_save_to_alfresco.gif Save to Alfresco: Saves the current document to the current space. If the document has not been given a filename yet, a popup panel will prompt you for one.
Browse Spaces tab
Browse Spaces tab

[edit] Search


You can search for spaces and files using the simple search panel.

The maximum number of results is chosen with the drop-down box. If more results were found in the repository than are being displayed, a message similar to Showing first 5 of 13 total items found is shown. If all results are being displayed, the message will be of the form Showing all 13 items found.

  • Clicking a space in the results list will display that space in the Browse Spaces tab
  • Clicking a Word document will open the document in Microsoft Word
  • Clicking any other type of file will launch that file with a new web browser window
Search tab
Search tab

[edit] Document Details


The Document Details tab has three main sections:

[edit] Current Document Details

If the document you are currently working on is recognised as being stored in the Alfresco repository, the Document Details tab will be populated.

  • A Image:Word2003_lock.gif icon indicates that the document is currently locked - i.e. cannot be checked in or out. This usually indicates you should be editing the Working Copy instead.

[edit] Version History

If the document has a version history, this will be shown in the middle panel.

  • You can apply the versionable aspect to any document by clicking the Image:Word2003_make_versionable.gif Make Versionable icon

[edit] Actions

Certain Document Actions will be available depending on the current document:

  • Image:Word2003_checkin.gif Check In: Check-in the working copy
  • Image:Word2003_checkout.gif Check Out: Check-out the document or file into the current space
  • Image:Word2003_new_workflow.gif Start Workflow: Takes you to the Workflow tab to start workflow on the current document
  • Image:Word2003_makepdf.gif Transform to PDF: Converts the current document to Adobe PDF format
  • Image:Word2003_document_details.gif Open Full Details: Opens a new web browser window showing the details dialog in the Alfresco Web Client UI.
Document Details tab
Document Details tab

[edit] Workflow


This panel works in two modes, depending on whether you are viewing an existing task, or starting a new workflow on an existing document. In each mode a list of tasks assigned to you appears at the top of the panel, displayed in ascending Due Date order - overdue tasks will be at the top of the list, followed by tasks due today, and so on. Clicking a task will display the task details view in the bottom panel.

[edit] Task Detail view

Shows the task's Status, Priority, Start Date, Type and Complete percentage, as well as a list of resources associated with the task.

  • Clicking on a document in the list of resources will open that document, either in a new web browser window or the Word Application

Task Actions appear under the resource list and are dependant on the type of task and current state of that task.

  • For example, a Review & Approve task will have "Reject" and "Approve" actions buttons available.

[edit] Start New Workflow view

When the Image:Word2003_new_workflow.gifStart Workflow action is run against a document, the bottom panel changes to the start workflow view:

Image:Word2003_StartWorkflow.png

  • Workflow type can be "Review & Approve" or "Adhoc Task" only
  • Assign to is the Alfresco user who you want to assign the new workflow to. An autocomplete drop-down will help you fill the box after you type the first two characters of the user's name:

Image:Word2003_StartWorkflow-pick_user.png

  • Due on is an optional date by which the task is due. Clicking in the empty field will display a date picker drop-down:

Image:Word2003_StartWorkflow-pick_date.png

  • Description is how the task will appear in the My Tasks panels
  • Finally, Submit the form to start the new workflow
Workflow tab
Workflow tab