DocuShare User Guide en New Version
DocuShare User Guide en New Version
Xerox® DocuShare®
User Guide
©2022 Xerox Corporation. All rights reserved. Xerox® and DocuShare® are trademarks of Xerox Corporation
in the United States and/or other countries. BR29692
Other company trademarks are also acknowledged.
Publication Date: July 2022
This document supports DocuShare release 7.6
Table of Contents
1. Introduction ..................................................................................................................................................6
DocuShare product editions ................................................................................................................................................... 6
2. Getting started .............................................................................................................................................8
Overview ........................................................................................................................................................................................ 8
Accessing DocuShare ................................................................................................................................................................ 8
Navigating DocuShare.............................................................................................................................................................. 9
Logging in and out .................................................................................................................................................................. 10
How to get help ........................................................................................................................................................................ 11
3. Managing accounts ................................................................................................................................ 12
About accounts ........................................................................................................................................................................ 12
User accounts............................................................................................................................................................................ 12
Creating a user account ................................................................................................................................................... 12
Viewing user account properties ................................................................................................................................... 13
Changing your user account properties ..................................................................................................................... 13
Changing your password ................................................................................................................................................. 13
Changing your username ................................................................................................................................................ 14
Viewing your usage quotas ............................................................................................................................................ 14
Changing your domain .................................................................................................................................................... 15
Selecting a theme .............................................................................................................................................................. 15
Viewing your activity history .......................................................................................................................................... 15
Deleting a user account ................................................................................................................................................... 16
Group accounts ........................................................................................................................................................................ 16
Creating a group ................................................................................................................................................................. 16
Viewing group properties ................................................................................................................................................ 17
Changing group properties ............................................................................................................................................. 17
Viewing the usage quotas for a group ....................................................................................................................... 17
Changing the members of a group ............................................................................................................................. 18
Changing the owner of a group .................................................................................................................................... 18
Changing the domain of a group ................................................................................................................................. 19
Sending mail to group members .................................................................................................................................. 19
Viewing the change history ............................................................................................................................................ 20
Deleting a group ................................................................................................................................................................. 20
Finding and listing site accounts ........................................................................................................................................ 20
4. Adding and managing content .......................................................................................................... 22
About DocuShare objects ..................................................................................................................................................... 22
Object permissions .................................................................................................................................................................. 23
Adding objects .......................................................................................................................................................................... 24
Selecting the objects that appear in the Add menu .............................................................................................. 24
DocuShare documentation describes all product features and add-ons. Refer to the below table to see
which features and add-ons are available for your use.
Product Comparison
Access Permissions • • • •
Expanded Permission Set • • • •
Full Text and Property Indexing and • • • •
Search
Notifications • • • •
Change History / Activity History • • • •
Document Routing and Approval • • • •
Side-by-Side Document Content • • • •
and Property Viewer
Product Add-ons
Overview
The DocuShare family of products allow you to manage electronic content using a web browser easily and
efficiently. Using DocuShare, you can create, organize, and share content, collaborate with other users on
projects, search for and retrieve content, and automate work processes.
Accessing DocuShare
You access DocuShare by entering the URL of your DocuShare site in a web browser window. Depending on
how your site is set up, you may be required to log in or you see the DocuShare home page. From the site
home page, you can log in, as well as access the content and features on your site.
Although your Administrator can customize your site home page and different browsers may not display
site elements the same, your home page should look like the example displayed below.
Navigating DocuShare
DocuShare navigation features make it easy to find what you need.
Breadcrumbs—Provide a path from the home page to your current location or list the last few pages you
visited. You can click any link in the breadcrumbs to go to the page.
Location: Home \ Initial Top Level Collection D \ My Collection Listing
Note: The Retain login for future checkbox only appears if your Administrator has configured
your site to allow users to do this.
5. Click Login.
Your username appears on the navigation bar, indicating that you are logged in.
About accounts
DocuShare provides two types of accounts: individual user accounts and group accounts. Your
Administrator determines who can create each type of account on your site. For example, your site might
allow a guest (someone who can view public content) to create a user account but require an Administrator
to create group accounts.
When a user account is created, either by you or an Administrator, it is assigned a user level. The user level
controls the level of access to site content and functions. One of the following user levels is specified when
creating a user account:
• Read-Only—Allows the user to view content and manage personal content on My DocuShare.
• DocuShare—Allows the user to access all DocuShare content management functions.
• CPX—Allows the user to access all DocuShare CPX content and process management functions.
After the user account is created, the user level assigned to the account is indicated by the superscript
letters appearing after the username: read-only, DS, or CPX.
Note: If your site uses the LDAP (Lightweight Directory Access Protocol) feature to manage user
accounts, an Administrator creates an account for you. To find out how your site is configured, see
your DocuShare Administrator.
User accounts
To add and edit content, you must have a DocuShare user account.
Note: If your Administrator created custom properties, they also display on the page. See your
Administrator for information about custom properties.
5. Click Apply.
The View Properties page for the user account appears.
If DocuShare was unable to create a new account, a message page appears describing the problem.
Note: If your site uses the LDAP feature, you cannot change your password. Your Administrator
must change your password on the LDAP server.
Note: If your site uses the LDAP feature, you cannot change your username. Your Administrator
must change your username on the LDAP server.
Note: Documents include email attachments and documents attached to discussion topics and wiki
pages.
Note: When Not set (default to highest group setting) is used, DocuShare checks the quotas
assigned to all the groups you are a member of and uses the highest. If none of the groups
have quotas set, then your quotas default to unlimited.
3. To view your current usage, click the Show Quota Usage button.
Should you exceed your usage quotas, you receive an error message when you try to add another
document to your site. Contact your Administrator should this occur.
Selecting a theme
Themes let you personalize the look of your DocuShare site. Four predefined themes are provided; each
changes the color scheme used on site pages.
To select a theme:
1. On the navigation bar, click your username.
2. On the View Properties page, click the Themes link.
3. Select a theme.
Note: If you choose to not use a theme, the default theme is used.
4. Click Apply.
Your Administrator determines whether the activity history feature is enabled on your site.
Group accounts
A group consists of any number of DocuShare users, groups, or both. When your site includes groups, you
can more easily manage access to objects by assigning permissions to the group instead of to each user.
Creating a group
The DocuShare Administrator can choose to allow logged-in users to create group accounts or to have
group account creation under administrative control. If after logging into DocuShare, you do not see the
Add Group link on the Users and Groups Registry page, then an Administrator needs to create a group for
you.
To create a group:
1. On the page footer, click Users & Groups.
2. Click the Add Group link.
3. In the Title field, enter a name for the group. The name can contain spaces and punctuation marks
and can be identical to another group name.
4. In the Domain field, select the name of a domain. The menu lists internal domains only.
5. In the Spam Control field, select either No Restriction, Registered Users Only or Group Members
Only.
6. Enter any optional information. Click a field name for a description of each property.
Note: If your Administrator created custom properties, they also display on the page. See your
Administrator for information about custom properties.
7. Click Apply.
The Pick Members for Group page appears.
8. In the Show field, select the type of account you want to display in the Possible Users/Groups field.
9. Do one of the following:
– To find a specific account, enter part of the user’s first name, last name, or username or the
group’s title in the Search field. Click the Go button.
Note: Documents include email attachments and documents attached to discussion topics and wiki
pages.
Note: Any quotas set for a user take precedence over the quotas set for a group the user is a
member of.
Note: Changing the group’s domain does not change a group member’s domain, if one is used.
Deleting a group
You can delete a group if you are the logged-in owner of the group.
To delete a group:
1. Locate and select the group that you want to delete. To search for a group, see Finding and listing
site accounts.
2. On the View Properties page, click the Delete Group link.
The Confirm Delete page appears.
3. Click Delete to remove the group from your site.
When displaying the list of accounts as a CPX user, the User and Group List page enables you to see which
users are logged into DocuShare. The user icon next to the user’s name indicates whether or not the user is
logged in; the icon is grayed when the user is not logged in.
DocuShare identifies each object on your site with a unique handle (for example, Document-37 and
Calendar-102). The type and number of objects on your site are dependent on your organization’s needs.
DocuShare icons
Wiki—A collaborative web site. Weblog—A simple web site for frequent
postings.
Object permissions
Every DocuShare object has an access list, which identifies the users and groups who have permissions to
the object and the type of permission each account has. The type of permission controls what a user can do
with the object.
Depending on how your Administrator set up your site, either three or six permissions are available for use.
In addition, you can control who can see an object in a search results list. The table below provides a
description of each permission.
Permissions
Reader allows the user or group to read the Read Properties allows the user or group to view
content of the object and view its associated the object’s properties and permissions.
properties and permissions.
Writer allows the user or group to change the Read Content allows the user or group to read the
object’s properties and add new objects, including content of the object.
new versions of documents.
Manager allows the user or group to delete the Read History allows the user or group to view the
object and change the object’s permissions and object’s change history.
owner.
Task Permissions details the type of permission required for each object task.
To add an object:
1. Navigate to and open the container to which you want to add an object.
2. From the Add menu, select the type of object that you want to add.
The Add page appears.
3. In the Title field, enter a name for the object. The name should be short, but descriptive, and can
contain spaces and punctuation marks.
4. Enter any additional required information as well as optional information. Click a field name for a
description of each property.
Note: If your Administrator created custom properties, they also display on the page. See your
Administrator for information about custom properties.
5. Click Apply.
The object is added to the container.
For more information on adding documents, see Adding a document. For more information on
adding discussions, weblogs, and wikis, see Using social computing features.
Note: If your Administrator created custom properties, they also display on the page. See your
Administrator for information about custom properties.
5. Click Apply.
View a Document
To view document in the Multiselect View:
Select the document to display in a side-by-side view. Note that more than one file can be selected at a
time.
From the Edit Selected … menu, select Multiselect View.
While loading the feature, the message: Loading, Please wait…is displayed.
The top of the window displays Previous and Next document controls, as well as Selected Document
number of total selected if multiple documents are chosen.
The right frame displays a top banner containing the name of the file, the ‘current page’/’total page count’
indicator, a rotate control, a download control, and a print control. Below the banner, the current page is
displayed. Controls on the image include maximize (frame icon), enlarge (+), and reduce (-). A scroll bar also
allows the user to scroll the length of the document.
If a document or an object cannot be displayed in the document viewer, the right frame displays with a
message: No Preview Available.
Note: Do not click any checkboxes if you want all the objects in the report.
Note: You can click the checkbox to the left of the Type column heading to select all the
objects. If there are multiple search pages, select Show All from the Show menu first.
Depending on how your Administrator set up your site and if you are a CPX user, colored key icons may
appear next to objects indicating who can access the objects. You can click the key icon next to an object to
display its Permissions page.
Permission icons
Yellow key—Indicates that the object can be accessed by one or more groups.
Note: When you change the access list and permissions of an object, the change occurs in the
background. A link to your background jobs appears under the navigation bar; you can click the link
to check the status of and delete background jobs.
Note: You can also use the Copy, Cut, and Paste commands from the Edit Selected menu to change
the location of a collection. See Using Copy, Cut, and Paste to change the location of an object.
Note: Make sure at least one container appears in the Selected Locations field. Otherwise, the
object becomes orphaned, which means it does not appear in any container.
Note: When using the Cut command, the object title is faint until you Paste it to another
container.
Note: To paste a workspace, open the workspace in which you want to paste the object and
then click Content Map.
• Invoking the Template Paste tool inserts a copy of the template in the chosen/current collection. New
objects are created, unlike DocuShare copy/paste.
• Permissions on all newly created objects can be copied from the template – no inheritance, if set in Copy
Paste Template Configuration Administration page.
• Properties on all newly created objects are copied from the template, if set in the Copy Paste Template
Configuration Administration page.
• Modification of templates have no impact on existing copies.
• Only copying of Collections, Documents, URL, Calendar, Subscription, MailMessage and SaveQuery is
supported by this version of Copy Paste Template Tool.
• Only the last version of Document is copied.
• If a Standard object is selected to be copied in configuring the content rule or in the Copy Paste
Template Configuration Administration page, only standard object is copied. To copy custom object,
one needs to specifically select that custom object.
• The template cannot be copied in the same hierarchy as the source.
• Even when Collection is not selected for the object to be copied, the source collection is copied, if ‘Include
Source Collection while copying’ is selected.
Copy Template can also be invoked as a Content Rule. See New Content Rules for DocuShare.
Note: When using the Change Location command, if an object appears in more than one collection,
only the current collection is listed in the Selected Locations field.
If your site uses the site-wide trashcan only, then objects you delete go to it. To restore an object from the
site-wide trashcan, you need to contact your Administrator. If trashcans are not used on your site, deleted
objects are expunged immediately.
To delete an object:
1. Locate the object that you want to delete.
2. Do one of the following:
– Click the checkbox that appears next to the object’s title. From the Edit Selected menu, select
Delete.
– From the object’s More Actions menu, select Delete.
The Confirm Delete page appears.
Note: If a minus sign appears in the checkbox that precedes the object, then you do not have
manage permission to the object and cannot delete it.
3. If you are deleting a collection, select one of the following from the For collections, delete menu:
– Collection and Contents to delete the collection and all the objects in it.
– Collection Only to delete the collection, but not its contents.
Note: If you delete a collection, but not its contents, and the objects are not located in another
collection, they become orphaned. You are unable to access orphaned objects from a collection.
Your Administrator can relocate orphaned objects in a collection so you can access them again.
About documents
Using DocuShare, you can store, access, and manage documents created in a variety of popular formats.
You add documents to DocuShare by uploading documents from your computer or a network drive or by
scanning paper documents. With the documents stored on DocuShare, users connected to the network can
use their browser to search for, view, edit, and download a document.
For document management, DocuShare supports version control and document locking. By default,
DocuShare saves four versions of a document; you can change the number of versions DocuShare saves on
a per-document basis. In addition, you can change a document’s preferred version, which is the version that
opens when users view, edit, and route the document. By default, a document’s preferred version is its latest
version.
Adding a document
You add a document to a collection or workspace to make it available to others for viewing or collaborative
work. There are several ways to add documents.
Note: With either method, you can add several files at once. Use the Ctrl key and drag and drop the
group of files to either rectangle.
DestinationCollection=<<Collection Handle>>
<<Collection Handle>> is the collection handle or destination collection into which the document is
uploaded. Collection handles are Case Sensitive, so please enter them in the format displayed below. It can
be custom collection handle too. This is a required parameter.
Ex: - DestinationCollection=Collection-10 or DestinationCollection=Collection-11234
{PreFilled Property1}=<<Value1>>
{PreFilled Property1} is the property name of the document object property which the user would like
prefilled. These document properties are specified in curly brackets {}.
<<Value1>> is the user entered value which displays as pre-filled on the form when the page gets loaded.
Object property names are case sensitive so please enter them in the exact format as they were created.
Ex: - {ClientName}=Verizon Wireless or {ClientNo}=VZ344342
DSQUERY_FOR=Prop Name 1:Prop Label 1, Prop Name 2:Prop Label 2, Prop Name3, Prop Name 4, Prop
Name 5: Prop Label 5
DSQUERY_FOR is a list with either document property label and property value pairs or just property names
or both, that the user is prompted to enter while uploading the document into DocuShare. The label to be
displayed on the form can be specified as comma separated property name with the label on the form like
Prop Name1:Prop Label1. If labels to be displayed are not given in the URL, it is retrieved from the
DocuShare APIs and the same property label is displayed on the form. The same property label is displayed
on the form. Different properties on the form are comma separated. Object property names are case
sensitive, so it is important to ensure they are entered in the exact format as they were created.
(PreFilled Property1)=<<Value1>>
(PreFilled Property1) is the property name of the property on the collection object in round ‘()‘ brackets.
<<Value1>> is its value to be used while creating the collection. Object property names are case sensitive, so
it is important to ensure that they are entered in the exact format as they were created.
Ex: - (ClientName)=Verizon Wireless or (ClientNo)=VZ344342
Optional Properties
The optional properties that should be set while creating the collection. These collection properties are
specified in round brackets ().
Example 2:
http://<<HOSTNAME>>:8080/docushare/jsp/ DocumentUploader
/add_document.jsp?DestinationCollection=Collection-10&DSClassname=Document&{ClientName}=Verizon
Wireless&{ClientNo}=VZ344342&DSQUERY_FOR=VendorNo:VendorNo,VendorAddress:VendorAddress,Invo
iceNo:InvoiceNo,CheckAmount:CheckAmount
In this example, Document Upload Page is displayed in the Upload Documents window with property label
ClientName with value Verizon Wireless, and ClientNo with value VZ344342. The remaining properties in
the window stay empty.
Document Properties
The document properties page displays all the properties that were entered on the upload page as well as
the filename chosen.
Your browser controls how a document is displayed. By design, browsers can handle several types of
documents and files, such as HTML, GIF, and JPEG. However, different browsers behave differently. For
some documents, such as Microsoft Word and Excel, your browser may launch a helper application
(viewer) to run or display the document either outside or within the browser window. To play some
multimedia files, the browser uses a plug-in, which opens the file within the browser window.
Your browser is preconfigured to use specific helper applications and plug-ins. Generally, if you try to open a
document or file that your browser does not recognize, it displays a window that guides you in finding the
application to use for that type of file.
To view a document:
1. Locate the document that you want to view.
2. Click the document’s title. At this point, depending on your browser:
– The document opens.
– A window displays allowing you to view the document.
– A window displays allowing you to download the document. Once it has downloaded, you need
to open it.
3. To return to the container page after opening the document, do one of the following:
– If the document opened in a separate window, select Exit from the File menu.
– If the document opened within the browser window, click the browser’s Back button.
Note: If you click the X in the top-right corner of the browser or select Close from the File menu, your
browser closes, and you lose your connection to the DocuShare site.
Note: The HTML conversion feature cannot convert documents that contain encrypted information.
Note: The PDF conversion feature cannot convert documents that contain encrypted information.
You must have Adobe® Reader® installed on your computer.
Editing a document
DocuShare supports the complete development cycle of a document, allowing users to collaborate on a
project. Document check out and locking ensures that only one user at a time edits a document. Version
control maintains a user-specified number of document versions.
To edit a document and create a new version, you must be either the logged-in owner of the document or a
logged-in user with the appropriate permission to it. In addition, the DocuShare Administrator must have
set the Add Versions property to Allowed.
Note: If a DocuShare desktop client is installed on your computer and you enabled the Handle
checkout from web browser (or Internet Explorer) property, the DocuShare Checkin Wizard displays
To edit a document:
1. Locate the document that you want to edit.
2. Click the document’s Check Out icon.
A window appears allowing you to open or download the document.
3. Edit the document.
4. Do one of the following:
– If the document opened in the browser, click the Back button. Click Yes to save your edits.
– If the document opened in its native editor, select Save As from the File menu.
5. In the Save As window, save the document to a location on your local drive.
Do not change the name of the document.
6. On the container page, click the document’s Upload a New Version icon.
The Add Version page appears.
7. Click the Browse button.
8. Navigate to the location on your local drive in which you saved the edited document, select it, and
click Open.
The path to the document appears in the Filename field.
9. In the Title field, you can change the version title. By default, the new version is assigned the original
document title.
10. Optionally, enter any comments in the Version Comments field.
11. If you locked the document, choose whether you want to unlock the document after adding the new
version in the Unlock Document field.
12. When a document version other than the latest is the preferred version, you can click Yes in the Make
This The Preferred Version field to set this version as the preferred one. Otherwise, click No to not
change the preferred version.
13. Click Apply.
By default, DocuShare saves four versions of a document. You can change the default setting by changing
the document's Max Versions property.
DocuShare always saves the preferred version, regardless of the number of Max Versions specified.
To lock a document:
1. Locate the document that you want to lock.
2. From the document’s More Actions menu, select Lock.
A Lock icon appears next to the document icon. Users can view the document, but they cannot edit it.
Note: Display Document Viewer should be enabled in the Site Configuration page so that View
Document & Properties icon displays the Document Viewer page instead of the Side-by-Side viewer
page
To run a search:
1. Click the Search tab.
2. Enter the text you want to search for in the Search Document box.
3. Optionally, click one of the following:
– Match Exact Word of Phrase—Find content with the exact word or phrase.
– Match Case—Find content that matches the letter case you entered.
– Whole Word—Find content that includes the search text.
– Begins With—Find content that begins with the search text.
Annotate content
The annotation feature allows you to collaborate and provide comments on documents. You can markup
documents using three different types of annotations: drawing, text, and image.
The annotations you add are placed on a layer. If another user annotates the same document, that user’s
annotations are placed on a different layer. This lets you review all the annotations and merge the ones you
want.
Add annotations
The Annotate tab provides the various annotation types that you can use. Using these tools, you can add a
variety of shapes, highlight text, create links to websites, add images, and more.
To add annotations:
1. Click the Annotate tab.
2. On the toolbar, choose from the following annotation types:
– Arrow—Draw an arrow.
– Line—Draw a line.
– Rectangle—Draw a rectangle.
– Ellipse—Draw an ellipse.
– Freehand—Draw a freehand line.
– Polyline—Draw a line consisting of one or more line segments.
– Text—Add text.
– Highlight—Highlight text.
– Strikethrough—Strikethrough text.
– Text Hyperlink—Add a hyperlink. The follow the steps in Add text hyperlink annotations.
– Stamp—Add a stamp.
– Image Stamp—Add an image stamp.
The Annotation Options window displays in the upper-right corner of the viewer.
Redact content
If you work with sensitive content, the document viewer provides redaction features. More than simply
hiding content visually, once the redactions are “burned in” the content is securely removed from the
resulting document.
The Redact tab provides three different ways to redact content. You can draw redactions of any size you
need, create redactions from selected text, or add redactions to an entire page or range of pages.
The redactions you make are placed on a layer. If another user redacts the same document, that user’s
redactions are placed on a different layer. This lets you review all the redactions and merge the ones you
want.
Note: The document is saved as a new version of the document. However, the preferred version is
not changed.
Exporting documents
Your Administrator can set up locations on external servers to which you can export documents. You can
export a single document or several documents at a time.
Note: This is only a CPX feature. A non-CPX user that has Admin privileges will not see the feature.
Note: When a site has 0 CPX license seats, the feature is still visible, and can be configured. But since
there are no CPX users, the feature is not seen in the Edit Selected menu and cannot be used.
To export a document:
1. Locate the document that you want to export.
2. Click the checkbox that appears next to the document’s title.
3. From the Edit Selected menu, select Export Document.
The Confirm Export Document page appears.
4. In the Location field, select the external location for the document.
5. Click the Confirm button.
Scanning documents
You can add documents to your DocuShare site by scanning them. DocuShare provides two methods for
scanning documents:
• You can use a scan cover sheet to scan documents to specific locations and as new document versions.
At a multifunction device, you scan a cover sheet with a document to convert it to PDF format and add
the digital document to DocuShare as specified in the cover sheet.
Note: The scan cover sheet feature has been optimized for use with Xerox ® Multifunction Devices.
Therefore, the feature does not support all non-Xerox multifunction devices and software. In
addition, DocuShare currently supports image-only file formats when scanning (TIFF, non-
searchable PDF, etc.). Searchable PDF file formats are not supported for use with scan cover
sheets.
• You can scan documents to a temporary scan collection that your Administrator sets up on your site.
Using a WorkCentre with the Scan to File feature, you scan a document to convert it to TIFF format and
add the digital document to the temporary scan collection. You then save the scanned document to a
permanent collection on your site.
Your Administrator determines which method you can use for scanning documents. Therefore, check with
your Administrator to find out how your site is set up.
A scan cover sheet includes a DataGlyph, which encodes machine-readable information about the scan
location and the cover sheet owner. You place the cover sheet on top of a document and scan both to add
the resulting PDF document to DocuShare.
If you have access to a multifunction device that supports Scan to File, you can scan a cover sheet with a
document to add a PDF version of the document to DocuShare.
Note: Since the user interface for multifunction devices can vary, the following procedure provides
general steps for scanning a document to DocuShare.
To scan a document:
1. Put the cover sheet on top of a document and place the pages in the document feeder.
2. Display the scan to file screen.
3. Follow any instructions specific to the type of device.
4. Press the Start button.
The device scans the document and then adds it to DocuShare as specified in the cover sheet.
When you no longer want a cover sheet to be used to scan a document, you can delete it. Deleting the
cover sheet invalidates any printed copies of it. You might want to delete a cover sheet if you misplace it
and do not want anyone else to use the cover sheet.
Before you begin, check with your Administrator to find out which templates are available for your use and
whether a password is required.
Note: Depending on which WorkCentre model you use, the steps for scanning a document can vary.
DocuShare does not support scanning color images on a WorkCentre Pro 40 using JPEG compression
(JPEG-in-TIFF).
To scan a document:
1. Place a document on the document glass or in the document feeder.
2. Press the Features button.
3. On the touch screen, press the Scan tab.
4. Press Scan to File.
5. Select the scan template.
6. If the template requires a password, do the following:
a. Press Added Features.
b. Press Filing Setups.
c. Press Login Name/Password.
d. Press Password.
e. Type your password and press Save.
f. Press Save.
7. If the template allows you to specify property values, enter values for the ones you want.
8. Press the Start button.
The WorkCentre scans the document and then sends it to the temporary scan collection on your DocuShare
site. The document is stored in this collection for a designated time period. You can check the time period
by clicking WorkCentre Scan Repository on the DocuShare home page. To keep the document, you need
to save it to a permanent collection.
Note: Your Administrator may have given you access to a collection named Temporary Scan
Repository. Alternatively, you can open this collection to move or delete your scanned document.
About notifications
A notification allows you to receive an email message when a change occurs to an object. You can add a
notification for any object on your site. For example, you can add a notification for a document to have
DocuShare email you when a new version of the document is uploaded. You might want to add a
notification for a collection to know when new content is added to the collection.
To use notifications, your Administrator must enable and set up the feature. In addition, your user account
properties must include an email address.
You can add a notification for any of the following changes to an object:
• Any change—Any change to the object.
• Something added—A new object is added to a container.
• New document version added—A new version of a document is added.
• Something deleted—An object is deleted from a container.
• Properties edited—The properties of the object are changed.
• Permissions edited—The permissions of the object are changed.
• Change in ownership—The owner of the object is changed.
• Location edited—The location of the object is changed.
• Document locked or checked out—The document is locked or checked out.
• Document unlocked—The document is unlocked after being locked, but a new version of it was not
added.
Note: DocuShare offers feeds to site collections and other types of containers. If you are using a
browser with built-in feed support or you have a feed reader installed on your computer, you can
add a feed to a DocuShare container. This enables you to view updated content in the container,
provided you have the necessary permissions, without having to go to the DocuShare site in your
browser.
Adding a notification
You can quickly add a simple notification to have DocuShare email you when new content is added to an
object, or you can choose advanced options to customize the notification.
To add a notification:
1. Locate the object for which you want to add a notification.
2. Do one of the following:
– From the More Actions menu, click the object’s Notifications icon.
Note: If you are an Administrator, additional fields appear enabling you to have a script run
when an event of interest occurs. Before entering information in the fields, you must create a
script and place it in the extension folder of your DocuShare directory. In the Script field, enter
the name of the script that you want to run when the event of interest occurs. In the Script
Data field, enter any string values that you want to pass to the script when it is called.
6. Click Apply.
Note: If you are receiving too many email messages from notifications, you can choose to not
receive messages for one or more types of events for all your notifications. Click your username on
the navigation bar and use the Suppress Notification Messages menu on the Edit page to turn off
the events you want.
Viewing notifications
You can easily view the notifications added for an object as well as the notifications you own for site
objects.
Deleting a notification
Depending on how your site is set up, a deleted notification can go to either your personal trashcan on My
DocuShare or the site-wide trashcan. Contact your Administrator to find out which trashcans are used on
your site. If you have a personal trashcan, you can restore an object from it if your Administrator has not
expunged the object from the site-wide trashcan. See Using personal home page for more information.
To delete a notification:
1. Locate the object with the notification you want to delete.
2. Do one of the following:
– From the More Actions menu, click the object’s Notifications icon.
– Click the object’s Properties icon. Then click the Notifications link.
The object’s current notifications display.
3. From the More Actions menu that appears to the right of the notification you want to delete, select
Delete This Notification.
The Confirm Delete page appears.
4. Click Delete.
Email Format of
Template File Section Definition
Section
[subscription.obj.props] Object properties other than the default Plain Text & HTML
set of object properties.
[subscription.parent.props] Container properties other than the Plain Text & HTML
default set of container properties.
The lines following a section heading apply to that section. Each line can contain a comment, preceded
with a pound character (#), or hard coded text, named parameters, and HTML tags without leading/trailing
whitespace characters.
The format of each named parameter that you can include in the lines is as follows:
Parameter Format
The Subscription Service provides a default set of object and parent container properties. For a property
other than one of the default properties listed below, define it in either the [subscription.obj.props] or the
[subscription.parent.props] section.
Object properties
classname, handle, handle_url, props_view_url, title, description, summary, keywords, create_date,
modified_date, entry.title
Subscription properties
subscription.handle, subscription.handle_url, subscription.title
Site properties
icon, domain, sitename, server_url, event_time
Note: {event.message.subject} can be changed to some hard-coded text. However, appending the
value to {event.message.subject} is not supported. The site Administrator must enable Update Email
Template in the administration page to load keys each time.
[subscription.obj.props]
#object properties : eq. <property_name>,...
invoice_amount
[subscription.mail.header]
# Comment 1 for header section
Line 1 text for header section
Line 2 text for header section
[subscription.mail.body]
# Comment 2 for body
[subscription.mail.body.html]
#message body section in html form
<br><TABLE CELLPADDING=4><TR VALIGN="TOP">
<TD ALIGN="CENTER"><img src="{icon} "><br></TD>
<TD><A HREF="{handle_url} ">{title}</A>
<font color='blue'><br>{label.invoice_amount} {invoice_amount}</font>
<br>{summary}
<br>{description}
<br><I>Appears In: </I> <A HREF="{parent.handle_url}">{parent.title}</A>
<br></TD>
<TD><A HREF="{owner.handle_url}">{owner.username}</A></TD>
[subscription.mail.footer]
# Comment 3 for footer section
Line 3 text for footer section
Line 4 text for footer section
[subscription.obj.props]
#object properties : e.g. <property_name>,<property_name>,etc.
[subscription.parent.props]
#parent container properties : e.g. <property_name>,<property_name>,etc.
#---- in plain Text -----------------------------------------
[subscription.mail.subject]
#subject section
{event.message.subject}
[subscription.mail.header]
#header section in plain text form
{event.message.header}
[subscription.mail.body]
#message body section in plain text form
URL:{handle_url}
{label.title} : {title}
{label.summary} : {summary}
{label.description} : {description}
{label.abstract} : {abstract}
{label.summary} : {revision_comments}
{label.handle} : {handle}
{label.create_date} : {create_date}
Owner : {owner.username}
[subscription.misc]
#appendix after footer section
#---- in HTML -----------------------------------------
[subscription.mail.header.html]
#header section in html form
<p>{event.message.header.html}
[subscription.mail.body.html]
#message body section in html form
<br><TABLE CELLPADDING=4><TR VALIGN="TOP">
<TD ALIGN="CENTER"><img src="{icon} "><br></TD>
<TD><A HREF="{handle_url} ">{title}</A>
<br>{summary}
<br>{description}
<br><I>Appears In: </I> <A
HREF="{parent.handle_url}">{parent.title}</A>
<br></TD>
<TD><A HREF="{owner.handle_url}">{owner.username}</A></TD>
<TD>{create_date}</TD>
<TD><A HREF="{parent.handle_url}">Props</A></TD>
</TR></TABLE><br>
[subscription.mail.footer.html]
#footer section in html form
#<br><P>{event.message.footer.html}
<br><P>This notification was generated by <A
HREF="{subscription.handle_url}">{subscription.handle}</A>.<BR>
10. Once you are done customizing the template, click Apply to save your changes.
About workspaces
A workspace provides a shared area for project and team collaboration. From a single page within
DocuShare you and other workspace members can gather and manage shared content, access
collaboration tools to facilitate your work, and communicate with each other.
A workspace consists of four distinct areas called portlets; each portlet has a different use.
• Content portlet—The area in which you add and manage shared content.
• Shortcuts portlet—Displays frequently used objects.
• Calendar portlet—Shows a combination of the calendars in the content portlet.
• Membership portlet—Lists the users who are members of the workspace membership group.
You can close a portlet and reopen it by clicking the small triangle next to the portlet title.
Adding a workspace
You can add a workspace to another workspace, or you add a workspace to My DocuShare. To guide you in
creating a workspace, DocuShare provides templates and a wizard.
When adding a workspace, a membership group is created automatically and initially includes you as its
member. You can add members to the group after the workspace is added. The members are listed in the
membership portlet on the workspace home page.
Note: If you are a Site Administrator or a Content Administrator, an [add] link appears on the home
page. This allows you to add a workspace to your site home page.
To add a workspace:
1. To add a workspace to another workspace, do one of the following and then go to step 3:
– On the DocuShare home page, click See More under Workspaces. Search for the workspace to
which you want to add a workspace. Open the workspace and select Workspace from the Add
menu.
– Go to My DocuShare. In the workspaces portlet, search for the workspace to which you want to
add a workspace. Open the workspace and select Workspace from the Add menu.
– Navigate to and open the workspace to which you want to add a workspace. In the content
portlet, select Workspace from the Add menu.
2. To add a workspace to My DocuShare, do one of the following:
– On the DocuShare home page, click See More under Workspaces. Then click Add a Workspace.
In addition to listing the group members, the membership portlet enables you to see which users are logged
into DocuShare. The user icon next to the user’s name in the portlet indicates whether or not the user is
logged in; the icon is grayed when the user is not logged in.
Like other DocuShare objects, a workspace has an access list, which you can use to give users and groups
access to the workspace. However, any users and groups that you add to the access list are not listed in the
membership portlet.
Note: The membership portlet lists users only. Therefore, individual group members are listed and
not the group titles.
Managing shortcuts
To conveniently access frequently used objects from a workspace, you can add shortcuts to them. Any
object you add as a shortcut is a link to the original object, not a copy. If the original object is deleted, it no
longer appears as a shortcut.
Using calendars
The calendars portlet displays all the calendars from the content portlet. This allows you and other
workspace members to quickly access individual calendars as well as to view the events from all calendars.
Adding a discussion
To facilitate an online exchange of ideas, DocuShare supports threaded discussions. You can add a
container, called a discussion, in which users add topics for other users to read and reply to. As users reply to
a topic, their responses are sequentially linked, or threaded, to the original topic. Users can read or reply to
any of the topics or replies in a thread as well as attach a document to a topic or reply.
To add a discussion:
1. Navigate to and open the container to which you want to add a discussion.
2. From the Add menu, select Discussion.
The Add Discussion page appears.
3. In the Title field, enter a name for the discussion. The name should be short, but descriptive, and can
contain spaces and punctuation marks.
4. In the Topics Expire In field, select the length of time to retain topics and their message threads in
the discussion after they are added.
When a topic becomes older than the duration you select, it no longer appears in the discussion. You
can view and delete expired topics on the discussion’s View Expired page.
5. Enter any optional information. Click a field name for a description of each property.
Note: If your Administrator created custom properties, they also display on the page. See your
Administrator for information about custom properties.
To add a topic:
1. Open the discussion to which you want to add a topic.
2. Click the Add Topic button.
Note: If your Administrator created a custom topic, it appears in the Add menu.
To add a reply:
1. Navigate to and open the discussion.
2. Locate the topic or reply to which you want to reply.
3. Click the Reply button.
4. Enter a title and description.
5. If you want to include the previous message and the name of the user who added it, click Quote Post.
6. Click Submit.
7. If you want to attach a document to the reply, do the following:
a. Click the Attach button.
The Add Document page appears.
b. Enter the complete path and filename of the document in the Filename field or click the Browse
button to navigate to and select the document.
Adding a weblog
A weblog is a simple web site on which you post entries about a specific topic on a regular basis. Entries are
displayed in reverse chronological order and include the name of the user who posted the entry.
When adding a weblog, you can choose to have it moderated. A moderated weblog requires a user with
manage permission to the weblog to approve its entries before they are posted for all users to read.
You can add a weblog to a collection or workspace. By default, when you add a weblog, you are the only
user who can post entries to it (Initial Permissions is set to Same as container except write restricted to
owner). If you want other users and groups to add entries to the weblog, either change the Initial
Permissions setting when adding the object or change the object’s permissions after adding it.
To add a weblog:
1. Navigate to and open the container to which you want to add a weblog.
2. From the Add menu, select Weblog.
The Add Weblog page appears.
3. In the Title field, enter a name for the weblog. The name should be short, but descriptive, and can
contain spaces and punctuation marks.
4. Change any of the default property values and enter any optional information. Click a field name for a
description of each property.
5. Click Apply.
The weblog is added to the container.
Note: When you create a weblog using a custom theme, that theme is used to display weblog pages.
Any theme you select on your User Properties page has no effect on the weblog pages. When you
create a weblog using a default or clean theme, the theme you select on your User Properties page
is used to display weblog pages.
To post an entry:
1. Locate and open the weblog to which you want to post an entry.
2. Click the Add Entry link.
The Add Weblog Entry page appears.
3. In the Title field, enter a name for the entry. The name should be short, but descriptive, and can
contain spaces and punctuation marks.
4. In the Description field, enter the body of the entry.
5. Enter any optional information. Click a field name for a description of each property.
Note: If your Administrator created custom properties, they also display on the page. See your
Administrator for information about custom properties.
6. Click Apply.
The entry appears in the weblog and includes the date the entry was posted and your username. If
the weblog is moderated, Approval Pending precedes your username. Users cannot read the entry
until a user with manage permission to the weblog approves it.
To edit an entry:
1. Locate and open the weblog that contains the entry you want to edit.
2. Click the Edit icon next to the entry.
3. Make the changes you want.
4. Click Apply.
If you are a user with manage permission to a weblog that is moderated, you must approve an entry before
it is posted for all users to read.
To approve an entry:
1. Do one of the following:
– Locate and open the weblog that contains the entry you need to approve. Click the check mark
next to the entry.
– On the navigation bar, click My Tasks. From the Show menu, select Tasks Assigned to Me. Click
the weblog entry title.
– On the navigation bar, click My DocuShare. The tasks assigned to you display under Tasks. Click
the weblog entry title.
A For Your Approval window appears.
2. Click the title of the entry to review the text.
3. Click the Approved button.
To add a comment:
1. Locate and open the weblog entry to which you want to add a comment.
2. Click the Add a Comment link.
3. In the Title field, enter a comment title.
4. In the Description field, enter the comment text.
5. Click Apply.
Viewing comments
To view comments:
1. Locate and open the weblog.
The weblog entries display. A Comments link appears for an entry that includes comments.
2. Click a Comments link.
The comments display in reverse chronological order and include the name of the user who posted the
comment.
If you are the user who added the comment or the user who added the entry, you can delete the comment.
To delete a comment:
1. Locate and open the weblog entry that includes the comment you want to delete.
2. Click the comment title.
3. From the More Actions menu, select Delete.
The Confirm Delete page appears.
4. Click Delete to remove the comment.
Adding a wiki
A wiki allows users to publish content quickly and easily on the web. Using a web browser and either the
built-in WYSIWYG (What You See Is What You Get) editor or simple wiki syntax, you can add and link web
pages and edit content instantly. Wikis are well-suited for any type of project that requires collaborative
writing.
By default, you use the WYSIWYG editor to create wiki content. Your user account property Text
Composition Format specifies whether to use the WYSIWYG editor (Rich Text) or wiki syntax (Plain Text).
Should you want to use wiki syntax, change the Text Composition Format property or, after adding the
wiki, deselect the wysiwyg checkbox on the Add WikiPage. Once you have selected the editing method, you
should continue to use it after adding the page.
To get started, you first add a wiki to a collection or workspace and then add content to it.
To add a wiki:
1. Navigate to and open the container to which you want to add a wiki.
2. From the Add menu, select Wiki.
The Add Wiki page appears.
3. In the Title field, enter a name for the wiki. The name can contain spaces and punctuation marks.
4. Enter any optional information. Click a field name for a description of each property. To add interwiki
links, see Using interwiki links.
Note: If your Administrator created custom properties, they also display on the page. See your
Administrator for information about custom properties.
5. Click Apply.
The wiki is added to the container.
Note: When you create a wiki using a custom theme, that theme is used to display wiki pages. Any
theme you select on your User Properties page has no effect on the wiki pages. When you create a
wiki using a default or clean theme, the theme you select on your User Properties page is used to
display wiki pages.
By default, each wiki page includes a WYSIWYG editor for easy formatting of content. Alternatively, you
can use the wiki syntax provided in a sidebar on a wiki page. However, when editing a wiki page, you should
use the same method you used to create the page.
After adding the wiki, your first step is to add content to the home page.
Note: When using wiki syntax, HTML tags are used on the page. When you want to include
angle brackets on the page, either use the WYSIWYG editor or type <text> to have the angle
brackets and text appear. Similarly, to have the ampersand character (&) appear, type &.
3. Click Apply.
The wiki home page appears with your content.
You can add any number of web pages to the wiki. You first add the link to the page and then enter content
on the page.
Note: To list the pages linked to a wiki page, view the wiki page, and click Backlinks. The linked
pages are listed on the Search Results page.
Inserting images
On a wiki page you can insert an image that is located on an external URL or on the same DocuShare server.
Attaching documents
On a wiki page you can add a link to a document that you upload to DocuShare.
Routing documents
During a document’s development cycle, you often need to solicit feedback from others, receive approval of
the document’s content, or simply share the information in the document. DocuShare enables you to
automate the routing of documents to users and request a specific action after the users receive the
documents.
On a form called a Routing Slip, you indicate the users to whom the document should be sent, the type of
action you want the users to take, and a message describing the document task. You then submit the
Routing Slip; DocuShare notifies the specified users of the document task. While a task is in progress, you
can monitor its status.
When creating a routing task, you can define a single routing step or several sequential steps. A single
routing step consists of one type of action, such as sending a document to users for approval. A multi-step
routing task enables you to automate a document process. For example, you can create a routing task to
send a document to a group of users for their review and comment before sending the revised document
for approval.
To route a document:
1. Do one of the following:
– To route a single document, locate the document that you want to route and select Route from
the More Actions menu. The Route command does not appear if the document is locked.
– To route a single document version, go to the document’s Version History page, locate the
document version that you want to route and click its Route icon. The Route icon does not
appear if the document is locked.
– To route several documents, locate the documents and click the checkbox next to each
document. From the Edit Selected menu, select Route. On the Confirmation page, click Confirm.
– To route a document after adding it to DocuShare, select Document from the Add menu.
Enter the required information and click Publish and then route the document before clicking
Apply.
Note: If you chose Route the document and publish it later in step 1, you must publish the
document for it to appear in DocuShare.
Status Description
Approved The single-step task or one step of a multi-step task is complete, and
the recipients approved the documents.
Disapproved The single-step task or one step of a multi-step task is complete, and
the recipients did not approve the documents.
Reviewed The single-step task or one step of a multi-step task is complete, and
the recipients reviewed the documents.
Acknowledged The single-step task or one step of a multi-step task is complete, and
the recipients acknowledged receiving the documents.
Delivered The single-step task or one step of a multi-step task is complete, and
the recipients received the documents for their information.
Started The task is pending. It is currently being routed to all recipients at the
same time for approval, review, or acknowledgment.
Step #: Username The task is pending and is on a specific step of a multi-step task. It is
currently being routed to all recipients in order; the user whose name
is displayed has received the document but has not taken any action.
Overdue For a single-step task or one step of a multi-step task that is overdue,
the word Overdue appears after the task’s description.
Terminated The task is stopped because it cannot continue. This can occur when
Cancel Task is set for Then Escalate or when a document or user is
deleted from your site.
3. To view more information about the task, click the task’s description.
A Report on Routing window appears, which displays the status of each user assigned the task.
4. Do one of the following:
– To view an individual recipient’s comments, click the user’s name.
– To view all recipient comments, click Show all User Comments. If you want, you can save the
comments to a text file.
Close the window after viewing the comments.
If you chose to be notified of a task’s progress, completion, or overdue status on the Routing Slip, you can
view the notifications in the Routing Tasks window.
Report type
Type Description
Termination The task is stopped because it cannot continue. This can occur when a
document or user is deleted from your site.
If you routed a document for review, you could save a document that a recipient changed as a new version
of your routed document. In the For Your Review window, the word New appears after the title of a
document that a recipient changed.
If you routed a document for review and selected Return to initiator after review, you can change the
preferred version to a document that a recipient uploaded or to a new document that you upload.
Note: To receive an email message when a new task is assigned to you, your user account property
Routing Task Notification must be set to Email, and your email address must appear in the Email
Address field.
Note: If the document version sent to you is not the latest version, a Latest published version
link is included. You can click the link to view the latest version of the document.
Reviewing a document
1. In the For Your Review window, click the document’s title.
The document opens in its native editor or a window appears allowing you to download the
document.
Note: If the document version sent to you is not the latest version, a Latest published version
link is included. You can click the link to view the latest version of the document.
Note: If the document version sent to you is not the latest version, a Latest published version
link is included. You can click the link to view the latest version of the document.
Note: If the document version sent to you is not the latest version, a Latest published version
link is included. You can click the link to view the latest version of the document.
In addition, you can view the deleted routing tasks of a specific document. See Viewing the routing tasks
of a document.
Workflow Reporting
Workflow Reporting searches DocuShare workflows which meet certain filtering criteria. The criteria that
can be specified include the collections where the route document is located, workflow title, route status
and date range.
The asterisk(*)
The asterisk represents any number of unknown
characters.
For example, if cheese* is entered as the search
term, the search might return these items:
cheese
cheesecake
cheesedip
If *cheese is entered as the search term, the search
might return these items:
stringcheese
swisscheese
sliced.cheese
Date Range Combo Box All, On or After, On or Allow searching by Date Range.
Before
Search Workflow Button Selectable When search button is selected, it starts searching
and displays the workflow which meet the search
criteria in the Essar Steel Workflow Search Results
Page.
You can have an action run when any of the events described in the Events table below occur.
Events
Document locked or checked out The document is locked or checked out for editing.
Lifecycle management A policy event occurs. For more information on creating content
rules for lifecycle management events, see the guide Xerox
Lifecycle Manager for DocuShare.
Location edited The location of an object is changed, using either the Locations
page or copy/cut and paste.
Something added A new object is added to a container, using either the Add menu
or copy/cut and paste.
Note: Your Administrator sets the maximum number of objects DocuShare examines to
determine if the event occurred. The default is 30,000 objects.
7. On the Content Property Conditions page, refine the event trigger by specifying property conditions.
Then click Next.
8. On the Action Performed page, select the action to run when the event occurs and click Next.
The Action Settings page appears. The options on the page vary depending on the action you selected
in the previous step. Click an option name for a description of its usage.
9. Enter the appropriate information and click Next.
10. On the Completion Settings page, you can choose to set a property value on the object when the
content rule completes. In addition, you can append the property value to any existing property
values. Then click Done.
The View Properties page for the content rule appears and provides a summary of the content rule.
You can easily copy a content rule to another object of the same type. For example, you can copy a content
rule that a user created for a collection to use for one of your collections. This eliminates the need to
manually replicate a content rule.
According to the path string above, if an object triggers the content rule with property values:
invoice_type: Software
vendor: Xerox
create_date: 01/01/2015
modified_date: 01/01/2016
The user only needs to define date property name and date format. The user must use a comma
“,” to split the parameters, for example, $(create_date,format,MMM-dd-yyyy).
MMM-dd-yyyy Jan-30-2015
MM/dd/yy 01/30/15
dd-MMM-yy 30-Jan-15
Content Rule
When creating the Content Rule, select the Inherit Property values to children action.
On the next page, under Action Settings, specify the options for the action.
Collection from which the Use the Filter by dialog box to filter the objects of interest that is typed, such as
Inheritance cannot happen. Collection 12. Select Go to initiate the Filter. Select SHOW ALL to display all
locations. The collection can be searched by either entering the collection
handle or the collection title (full or the substring), to search in ‘Filter by’ box. If
there’s a specific collection under this collection (where content rule is setup),
which should not support inheritance of property, then that collection can be
selected in select box, ‘Collection from which inheritance cannot happen’ and
inheritance of property does not occur in that collection hierarchy.
Inherit under the whole tree If ‘Inherit under the whole tree’ check box is checked and the content rule
triggers and if a hierarchy is moved, the property value is inherited for each leaf
(document or collection, depending upon is collection/document properties are
selected in the Inherit Property List), in that hierarchy.
Note: This should NOT be confused with the Event Triggers | Event applies to:
menu on ‘page 2’ of the content rule setup. This menu indicates that the event
can be applied to “This container and all levels of contents”. This means that if
the object is added to any level in the hierarchy then the content rule should get
triggered.
Whereas, with Inherit under the whole tree, once the content rule triggers,
should the whole tree from that object be inheriting the property value or not,
gets configured by checking this check box ‘Inherit under the whole tree’.
Overwrite the previous values If checked, overwrites any previous value of the property that is inheriting the
value from its parent. If unchecked, only empty values inherit its parent value
and non-empty values does not change for the object
Level UP, to look for the value to In the Level UP, to look for the value to inherit dialog box, type the value to
inherit inherit (such as root). In this case, we can specify, till which level in the parents
should the user go up and look for a non-empty value. If we should be looking
for a non-empty value till the last root(Home Collection), then write ‘root’ which
setting up this value. Or else, we can specify 1,2,3 and so on….
If the value of ‘Level UP, to look for the value to inherit’ is specified 1, then while
inheriting a value of property for the document test.pdf for a non-empty value
only for the collection Oct/19/2019. If the value of the property for
Oct/19/2019 is empty the property is not inherited to the document test.pdf.
Whereas, if the value of ‘Level UP, to look for the value to inherit’ is ‘root’ then
this tool iterates to all parents one-by-one until it finds a non-empty value or it
reaches HOME. ‘root’ is its default value.
Values to NOT inherit Enter any values to NOT inherit in the dialog box (such as
RandompropertyValue). If there are some specific values that should not be
inherited, they can be specified here. More than one property value can be
comma separated. The Full property Name can be specified in ‘Full Source
Property Names for above values’. Enter the Full Source Property Names for the
above values into the dialog box (such as Collection.summary).
Inherit Property Options Under the Inherit Property Options, the Inherit property list can be constructed
of the format:
For example:
More than one property can be inherited by selecting the link + Inherit more
properties?
Each row can be deleted by selecting the minus sign at the end of each row.
The final page of the content rule configuration indicates the action performed (“Inherit property values to
children”), the action settings which include Collection from which the Inheritance cannot happen,
Overwrite the previous values, inherit under the whole tree (Boolean: true or false), Level UP to look for the
value to inherit (such as root), values to NOT inherit (such as RandompropertyValue), Full Source Property
Names for the above values (such as Collection.summary), and the Inherit property list (such as
Collection.bg_image>Document.author, Collection.description>Document description,
Collection.description>Collection.description,
About searches
DocuShare search features enable the user to quickly find objects on the site. Simple word searches can be
performed by having DocuShare find the objects that contain the text specified. Several search terms can
also be combined to find specific objects, such as all documents authored by one user that contain the word
DocuShare in their titles. When searching for objects, the scope of a search can be defined.
When an object is added to a container, DocuShare stores the object’s properties (also called metadata) in
a database. If the Administrator has enabled content indexing, the content of document is also stored.
When content indexing has been enabled, document content can also be searched.
In addition, DocuShare uses a process called stemming to find objects that contain variations of the word
specified. For example, a search for the word mouse finds the word mice.
DocuShare provides another type of search called quick search. If the site is set up to use this search, refer
to the DocuShare Quick Search Supplement on the Help Desk.
Note: If a user is a guest and they click Recent on the navigation bar, DocuShare lists the content
that has been added or changed during the past 24 hours. If you are a logged-in user and you click
Recent on the navigation bar, DocuShare lists the content that has been added or changed since
you last clicked Recent.
Note: You can combine search words using the logical operators AND, NOT, and OR. Type the
operator in uppercase letters and type a plus sign (+) before and after the operator instead of a
space (for example, fruits+AND+vegetables; fruits+AND+vegetables+NOT+produce).
2. If you are running the search from a page other than the site home page, select a search scope from
the In menu.
3. Click Search.
DocuShare displays the search results. For documents, DocuShare either provides a snippet of the
document content with the search term highlighted or displays the document’s abstract if the search
term is not found in the content. You can click the Show/Hide Details link to control this display. You
can also review the search criteria by clicking Query Details.
Search options
When running a simple search, you can specify several options to narrow the search and to control how the
search results are displayed.
Note: For information on how to use wildcard and non-alphanumeric characters in a search
term, see Using reserved characters in a search.
3. If you are running the search from a page other than the site home page, select a search scope from
the Search Within menu.
Note: To search for notifications and content rules, the search scope must be set to the entire
site.
4. In the Maximum Results field, select the maximum number of objects to display in the search results
list. DocuShare orders the results by displaying the most relevant objects first.
5. In the Sort Results field, select the order in which to display the search results.
6. Under Limit Search to Date Range, enter the date range to use when searching for objects. Create a
date range by selecting options from the menus and entering a date.
You can click + add date range to create a second date range.
7. Under Find Results Using Relative Date, create a search relative to today’s date by doing one of the
following:
– To create a relative search without a start or end date, select a date property, select an operator,
enter the number of days, and then select Days Ago or Days from Now. You can click + add
range and create another search term.
– To create a search with start and end dates, select a date property, select an operator, enter the
number of days, and then select Days Ago or Days from Now. Then click + add range and
create another search term and enter 0 in the days field.
Note: When you save a search query that uses a relative date and then run the search later, the
query uses the date on which the search is run.
Note: This field appears if an object has a numeric property that is searchable.
9. Under Find Results Using Menu Values, select the menu and value to use when searching for
objects.
You can click + add search term to create a second search term.
10. Under Object Types to Search, do one of the following:
– To search all the objects on the site, click Search all object types.
– To search specific objects only, click Limit search to selected object types and select the objects
to search from the list.
11. If you are searching for documents, under Document Types to Search, do one of the following:
– To search all types of documents, click Search all document types.
– To search specific types of documents, click Limit search to selected document types and
select the types of documents to search from the list. Each document type is specified by its
MIME type.
12. Click the Search button.
DocuShare displays the search results. For documents, DocuShare either provides a snippet of the
document content with the search term highlighted or displays the document’s abstract if the search
term is not found in the content. You can click the Show/Hide Details link to control this display.
And Searches for objects that contain all the search terms.
For example: Search for objects where “Title contains Training And
Summary contains Basic Product.”
The search would return only objects that have the word “Training” in
the Title, and the phrase “Basic Product” in the Summary.
And Not Searches for objects that contain one search term and not the
other.
For example: Search objects where “Title contains Technology And
Not Title contains Marketing.”
The search would return only those objects where Technology was in
the Title, but not return objects if Marketing were also in the Title.
To find objects that include a wildcard character, tilde (~), or double quotation mark (“), use the equals
operator, precede the character with one backslash (\), and select the specific property name.
Example: To search for a document named “ReadFirst enter:
equals \“ReadFirst In Title.
To find objects that include other non-alphanumeric characters, such as a parenthesis or an equal sign (=),
use the equals operator and select the specific property name.
Example: To search for (650) 123-4567, enter:
equals (650) 123-4567 In (User) Phone
Application Connector
The Application Connector is a URL based search. It searches for all Documents, custom Documents,
Collections, and custom Collections for given property in URL in DocuShare.
As an example, the following Application Connector URL searches for all the Documents, custom
Documents, Collections, and custom Collections where summary equals ‘HR’ or First Name contains deep.
The following Application Connector URL searches for all Documents, Collections, custom Documents, and
custom Collections, where the Batch Number is 123.
http://<<HOSTNAME>>:8080/docushare/jsp/DocumentConnector/Search.jsp?objectType=all&batchNumbe
r=123
If the search criteria match multiple Documents or Collections, the DocuShare search page displays all the
results.
If the user is not logged in to DocuShare and clicks on the Application Connector URL. The URL then
redirects to the DocuShare login page.
Login to DocuShare displays the search result.
See the Application Connector Implementation Guide for more details.
About My DocuShare
My DocuShare provides a single location from which you can conveniently manage personal content as well
as access the content on your site. A link to My DocuShare appears on the site home page and on the
navigation bar, as a tab and as the house icon next to your username.
My DocuShare consists of areas called portlets; each portlet has a different use. You can open and close a
portlet by clicking the small triangle next to the portlet title.
• Personal Collection—A collection for private content.
• Workspaces—The workspaces you have access to and own.
• Site Home—The top-level collections on your site.
• Favorite Calendars Combined—A combination of the calendars in your Favorites.
• Personal Trashcan—Your deleted objects.
• Favorites—Links to your frequently used objects.
• My Groups—The groups of which you are a member.
• Tasks—The routing tasks assigned to you.
Managing favorites
To conveniently access frequently used objects from a single location, you can add them to your favorites.
Any object you add as a favorite is a link to the original object, not a copy. If the original object is deleted, it
no longer appears in your favorites.
Note: Another way to add an object to your favorites is by clicking the object’s Add to Favorites
icon. The icon is the outline of a star. Once you have made an object a favorite, the star turns yellow.
Note: You can remove an object from your favorites by clicking the object’s Add to Favorites icon.
The icon turns from yellow star to the outline of a star.
Once you have removed the object from your favorites, the object still appears in its original locations.
Note: Your Administrator can choose to set up your site to not use personal collections.
There are other ways to add objects to your personal collection: see Changing the location of objects and
Adding documents using drag and drop.
Note: You can delete your personal collection and, optionally, its contents. However, the next time
you access My DocuShare your personal collection appears.
Note: Your Administrator can choose to set up your site to not use personal trashcans.
Note: If the location is a collection or workspace and it was deleted, then the object is restored to
your personal collection. If the location is a non-collection type of container (such as a calendar or a
discussion) and it was deleted, then the object becomes an orphaned object; your Administrator can
relocate an orphaned object.
In addition, clicking the Tasks heading displays the My Tasks window. You can view both the tasks assigned
to you and the tasks you assigned, and your routing task history in this window. For more information on
document routing, see Automating work processes.
All Objects
Add object •
object •
new location •
Delete object •
Document
Edit document •
Lock document •
Unlock document*
Export a document •
Route a document •
Content Rule
Notification
Weblog
Wiki
Workspace
* Not controlled by permissions; user who locked the document and content Administrators can unlock the
document.
Note: In both Windows and OS X, you must append the DocuShare server's URL with /webdav.
When you are prompted to log in, use your DocuShare username and password.
calendars, 24
A
changing access list, 29
access list changing its location, 32
changing, 29 changing owner, 30
viewing viewing properties
access list, 29 changing properties
accounts, See group account, user account, 12 viewing properties
Add to Favorites (Edit Selected menu), 34 changing properties
adding objects viewing properties
discussions changing properties, 26
adding to a container, 73 adding document to
group accounts adding to collection
creating documents, 37
group account, 16 viewing change history
user accounts change, viewing; change history, viewing for
creating objects
user account, 12 viewing change history
And Not operator, using in searches, 111 editing multiple objects in
And operator, using in searches, 111 editing multiple in collection, 34
annotations Zip and Download (Edit Selected menu)
add zip and download
types, 48 zip and download, 35
merge, 50 list view, collection; images view, collection; email
Application Connector, 7, 113 view, collection
list view
C images view
email view
calendar
changing views, 25
changing access list, 29
comments
changing its location, 32
deleting from weblog entry, 78
changing owner, 30
viewing for weblog entry, 77
month view, calendar; week view, calendar; day
content rule
view, calendar
creating
day view
content rules, 98
month view
changing
week view
content rule
changing views, 25
about disabled content rules, 99
Change Location (Edit Selected menu), 34
about
Change Owner (Edit Selected menu), 34
event triggers, 97
changing location of object, 32
deleting
using copy, cut, and paste; Copy (Edit Selected
content rule
menu); Cut (Edit Selected menu), 33
restoring after deleting, 100
collection
Content Rule
adding
Copy Template, 104
collections
Content Rules
adding to a container