Related Topics
Collaborative Features Custom Variables
Process Director v5.13 and higher enables Collaborative Document Markup and Collaborative Document Authoring as optionally licensed components. Installations with these components licensed can use the Custom Variables listed below.
Collaborative Document Authoring is available only on Cloud installations, so Custom Variables related to this feature aren't editable by the customer.
Collaborative Document Markup Variables #
When this flag is set to false, Process Director will disable Collaborative Document Markup. The default value for this variable is true.
Example
public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
//Disable Collaborative Document Annotation
bp.Vars.fEnableFDFAnnotations = false;
}
This variable enables you to specify which file extensions should use the Collaborative Document Markup (CDM )feature when using the EDIT link. This feature will enable you to use the Collaborative Document Markup tool for editing specific document types, while retaining the Collaborative Document Authoring (CDA) feature for editing all other document types. For instance, you may wish to specify the CDM tool for editing PowerPoint presentations, as in the example below, while still retaining the use of CDA for editing Word and Excel Documents.
Specifying the use of CDM for editing means that the only editing allowed will be adding annotations, unlike the CDA tool, which enables editing the original document content.
This variable isn't relevant for installations that aren't licensed with the Collaborative Document features.
Example
public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
// Specifies the use of CDM to mark up PowerPoint presentations
bp.Vars.FileExtensionsUseCDMForEdit = "ppt, pptx";
}
This variable enables you to specify which file extensions should use the default checkout and edit feature, rather than the Collaborative Document Authoring (CDA) feature. File extensions listed in this variable will force the default check out and edit functionality when clicking the EDIT link for attachments.
This variable isn't relevant for installations that aren't licensed with the Collaborative Document features.
Example
public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
// Forces use of the default check out feature for
// PowerPoint presentations, and not use CDA
bp.Vars.FileExtensionsUseCheckOutForEdit = "xls, xlsx";
}
This flag specifies the autosave options available for annotations created when using Collaborative Document Markup. The following settings are available:
PDFAnnotationSaveOptions.Manual
PDFAnnotationSaveOptions.EveryMinute
PDFAnnotationSaveOptions.EveryFiveMinutes
PDFAnnotationSaveOptions.EveryTenMinutes
The default value for this variable is PDFAnnotationSaveOptions.Manual
, which means that annotations must be manually saved before closing an annotated document, and the system won't perform autosaves.
Example
public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
//Autosave Collaborative Document Annotations every five minutes
bp.Vars.PDFAnnotionSaveInterval = PDFAnnotationSaveOptions.EveryFiveMinutes;
}
Annotation Toolbar Variables #
Installations that are licensed with the Collaborative Document Markup feature have access to a series of Custom Variables that can be set in the Custom Variables file. The Custom Variables in this section specify an annotation tool for which you wish to set the available properties.
The following properties are available for each Variable.
PROPERTY NAME |
DESCRIPTION |
---|---|
Position |
This numeric Double property is sets the 1-based numeric position of a tool on the annotation toolbar. If multiple buttons have been set to the same position (e.g., 5) there is no guarantee of the order in which the buttons will appear on the toolbar. To address that, if a user wants a button to display to the right of the button currently in position 5, they can set the position of the button they are moving to 5.1 (or any number from 5.1, 5.2, 5.3…). |
Visible |
This Boolean property is used to show or hide the annotation tool specified by the variable. When this property is set to false, the tool button won't be displayed in the interface. The default value for this variable is true. If the Visible property is set to false, the Position property become irrelevant, as the tool won't display. |
All of the properties must be set in the PresetSystemVars()
method of the Custom Variable file.
Available tool Variables
The following toolbar variables can be configured
- AnnotationToolbar.AnnotationCreateFreeTextTool
- AnnotationToolbar.AnnotationCreateRedactionButtonTool
- AnnotationToolbar.AnnotationCreateStickyTool
- AnnotationToolbar.AnnotationEditTool
- AnnotationToolbar.Divider1Tool
- AnnotationToolbar.Divider2Tool
- AnnotationToolbar.FreehandToolGroupButtonTool
- AnnotationToolbar.LeftPanelTool
- AnnotationToolbar.MeasurementToolGroupButtonTool
- AnnotationToolbar.MenuButtonTool
- AnnotationToolbar.MiscToolGroupButtonTool
- AnnotationToolbar.NextButtonTool
- AnnotationToolbar.PanTool
- AnnotationToolbar.PrevButtonTool
- AnnotationToolbar.PrintButtonTool
- AnnotationToolbar.SaveButtonTool
- AnnotationToolbar.SearchButtonTool
- AnnotationToolbar.ShapeToolGroupButtonTool
- AnnotationToolbar.SignatureToolButtonTool
- AnnotationToolbar.SpacerTool
- AnnotationToolbar.TextSelectTool
- AnnotationToolbar.TextToolGroupButtonTool
- AnnotationToolbar.ToolsButtonTool
- AnnotationToolbar.ViewControlsButtonTool
- AnnotationToolbar.ZoomInTool
- AnnotationToolbar.ZoomOutTool
- AnnotationToolbar.ZoomOverlayTool
Code Sample
public override void PresetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
//Hide the Pan tool in the markup UI
bp.Vars.ZoomOverlayTool.Visible = false;
//Set tool positions
bp.Vars.AnnotationToolbar.SpacerTool.Position = 5;
bp.Vars.AnnotationToolbar.ZoomInTool.Position = 5.1;
bp.Vars.AnnotationToolbar.ZoomOutTool.Position = 5.2;
}
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.