User portal basics — About work object history and attachments |
Many work object forms include a history button ( ) and a paper clip button ( ) at the top right. By default, these both present a combined history and attachments display in a new window.
This article describes User portal features available to application users. For a developer's perspective on work object attachments, see Understanding work object attachments.
Click the paper clip button to display the history of this work object, also called the audit trail. The header identifies the current task or assignment.
Each row contains a date and time, description, and the operator's full name. Dates and times on the history display are presented in the time zone indicated in the Time Zone field of your Operator ID data instance.
system
as the Operator ID system, on behalf of Name
.
as the Operator ID.To see additional detail in a pop-up window, hold the mouse porinter over a row.
History information is cumulative and permanent; it cannot be changed. If the work object contains incorrect information, you can overwrite or replace it with correct information.
Click Export to Excel to export the history report lines to Microsoft Excel.
Default attachment form (Basic View)
Click the paper clip button ( ) to list the existing attachments to this work object or to review, edit, or delete existing attachments.
The report shows existing attachments to the work object. Depending on your privileges, the attachment type, the work type, and other conditions, you may be allowed to view the attachment, edit the attachment (producing a new attachment; the original is preserved) or delete the attachment. These capabilities are conveyed by attachment category rules. (The standard attachment category rules do not allow editing or deletion of any attachments.)
The Basic View form allows you to enter three of the five attachment types: a text note, a file, or a URL.
To add a note attachment, click the New V button and select Add a Note
.
Enter the note. Click Apply. You can use any of these rich text edit controls:
Icon |
Result |
Make the selected text italics. |
|
Make the selected text underscored. |
|
Change the font color of the selected text. Choose a color from the palette. |
|
Set the background color of the selected area. Choose a color from the palette. |
|
Indent, increase space at the beginning of the selected lines. |
|
Outdent, reduce space at the beginning of the selected lines. |
|
Convert the selected paragraphs to an unordered list (<ul> tag). |
|
Convert the selected paragraphs to an ordered list (<ol> tag). |
The standard flow action Work-.AttachAFile provides a similar capability, without a pop-up window and without rich text editing.
To create a file attachment, click the New V button and select Add a File
.
The standard flow action Work-.AttachAFile provides a similar capability, without a pop-up window.
Choose the Edit Attachments
action Work-.EditCategorizedAttachments (when configured in a flow) to revise an existing file using workstation software such as
Microsoft Word. The system retains both the original file
and the updated file, with a higher version number.
A URL attachment links the work object to a web page or other object accessible with the HTTP protocol. To create a URL attachment, click the New V button and select Add a URL
.
Default attachment display (Advanced View)
Click the Advanced View button (at the bottom of the window) to enter any of all five attachment types. In addition to Note, File, and URL attachments, two other attachment types are available in the advanced view. Unlike the three Basic View types, these two attachment types each require that a Process Commander ActiveX control be present on the user workstation.
To add a screen shot attachment, click the New V button and select Add a Screen Shot
. Complete the pop-up window that appears:
The standard local flow action Work-.AttachAScreenShot provides a similar capability, without a pop-up window.
This feature is sometimes called screen
capture. The prScreenCapture
ActiveX control
supports this capability. The attachments are instances of
the Data-WorkAttach-ScreenShot class.
If your workstation includes a scanner, you can create and attach a TIFF image scanned from a paper document.
To add a scanned document attachment, click the New V button and select Add a Screen Shot
. Complete the pop-up window.
The standard local flow action Work-.AttachFromScanner provides a similar capability, without a pop-up window.
The PegaImgViewer
ActiveX control supports this
capability for the Image Viewer. (The prBatchScanning
ActiveX control supports this
capability for the Scan Station tool used only with Windows
2000). Attachments are instances of the Data-WorkAttach-ScanDocument class.
In releases before V5.5, screen shot attachments and scanned document attachments are available only by creating custom buttons on the harness rule. That approach remains functional but is deprecated. If you want to disallow use of these two attachment types in your application, override the Work-.HistoryandAttachments harness rule, eliminating the Advanced View button in your rule.
Customizing the history display
The standard harness rule Work-.HistoryandAttachments supports the standard display of history and attachments. You can override this rule for your applications, to change the layout, contents, or functions available. Alternatively, you can present the history section or attachments sections within a work object form.
The standard section rule Work-.HistoryListView executes a standard list view rule History-.HistoryListView.ALL. To change the columns or presentation, override this list view rule in the History-ZZZZ class, where ZZZZ is the name of a class group or work type in your application. (Do not override the section unless you are making advanced changes; it is not auto-generated.)
Customizing the attachment display
The standard harness rule Work-.HistoryandAttachments supports the standard display of history and attachments. You can override this rule for your applications, to change the layout, contents, or functions available. Alternatively, you can present the history section or attachments sections within a work object form.
The standard section rule Work-.Attachments supports the New V button to allow the user to add attachments (of three types for Basic View, or all five types for Advanced View. This section includes the standard section Work-.AttachmentListView (not auto-generated) which executes the standard list view Link-Attachment.AttachmentList.ALL. Although there is no fixed limit on the number of attachments that a work object may have, the standard list view displays a maximum of 100 attachments.
To customize the presentation, override the auto-generated sections or the list view rule. (Do not override the Work-.AttachmentListView section unless you are making advanced changes.)
attachment, attachment category, audit trail | |
About Attachment Category rules Understanding work object attachments |