Jump to: navigation, search

Difference between revisions of "HowTo:Make a Document ready for Redlining"

m
 
(41 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
The [[Documents_(UBIK_Android)#Redlining|redlining]] feature creates a copy of the [[DOCUMENT|document]] and opens it for editing with any installed 3rd party application. Enabling redlining for certain document objects requires that the following criteria are met:
 
The [[Documents_(UBIK_Android)#Redlining|redlining]] feature creates a copy of the [[DOCUMENT|document]] and opens it for editing with any installed 3rd party application. Enabling redlining for certain document objects requires that the following criteria are met:
−
# A [[FILEDOCUMENT|file document]] [[MetaClass]] is prepared for Redlining
 
−
# File documents can be created as child objects of other file documents
 
−
# [[VIEWITEM|View items]] for the redlined file document exist
 
−
# [[CONTEXTSCOPE|Context scopes]] for the redlined file document exist
 
  
−
'''Part 1:''' Prepare a file document MetaClass for Redlining
+
= Studio =
−
# Set the [[SYSCLS_REDLINEDFILE]] classification on a [[MetaClass]] for [[FILEDOCUMENT|file documents]] using the {{CD}} control (the MetaClass must derive from [[FILEDOCUMENT]])
+
'''Criterion 1:''' A [[FILEDOCUMENT|file document]] [[MetaClass]] is prepared for Redlining
 +
# Set the [[SYSCLS_REDLINEDFILE]] classification on a [[MetaClass]] for [[FILEDOCUMENT|file documents]] using the {{Class_Details}} control (the MetaClass must derive from [[FILEDOCUMENT]])<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_01.png|330 px|border|alt=Redlined document|Redlined document classification]]
 +
# Check if all required MetaProperties are implemented
  
−
'''Part 2:''' Create a [[Relation]] or [[Reference]]
+
'''Criterion 2:''' File documents can be created as child objects of other file documents
−
Redlined documents are created as child objects of the original document, so we have to prepare the necessary relational pre-requisites.
+
# Create a new relation between the MetaClasse of the original file document and the redlined file document<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_02.png|700 px|border|alt=Create relation|Create relation]]
−
# Create either a new relation between the file document MetaClasses or
+
−
# add a reference property Create_a_new_Reference
+
  
−
Create either a relation between or reference
+
'''Criterion 3:''' [[:Category:Views|View items]] for the (redlined) file document exist
 +
# Create the view items for the file documents if they do not already exist (existing view items for file documents might be sufficient)
 +
# Relate the view items to the according [[View]] and test the result in the [[View Test Environment]] (redlined documents can be created as child objects of other documents)
  
−
Create the necessary relation
+
'''Criterion 4:''' [[CONTEXTSCOPE|Context scopes]] for the redlined file document exist and such file [[Documents_(UBIK_Android)#Creating_Documents|document can be created]] on the {{UBIK Client|mobile client}}
 +
# Create a context scope for the redlined file document (an existing context scope for file documents might be sufficient<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_03.png|700 px|border|alt=Create context scopes|Create context scopes]]
 +
# Enable the creation of the document on the {{UBIK Client}} and configure at least the ''Description'' property in the [[ACM]]<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_04.png|500 px|border|alt=Create context scopes|Create context scopes]]
 +
# If a thumbnail should be displayed on the mobile client configure the ''Thumbnail'' property as well
  
−
# Navigate to the [[MetaClass]] [[SYSCLS_EDITABLEDOCUMENT]] in the ''[[Class Browser]]''<br/>[[File:UI_Document_editable_01.png|330 px|border|alt=Property editable|Property editable]]
+
= Android =
−
# Open a [[RelationEditor]] for the created Document class, put the ''SYSCLS_EDITABLEDOCUMENT'' via dragging and dropping in the ''[[Relation Editor]]'' and navigate to the ''Classification''<br/>[[File:UI_Document_editable_02.png|330 px|border|alt=Property editable|Property editable]]
+
Once the configuration has been completely accomplished on the server side the '''Redline Document''' function should be available on the mobile client.
−
# Now all Instances of the created MetaClass can be set either editable or not by checking "EDIT_FILE_ALLOWED".<br/>[[File:UI_Document_editable_03.png]]
+
# Long-click a document's thumbnail [[UBIK_Client_Basics#Content_Browser|Content Browser]]
−
# To make the Document available, see the instructions on creating and editing [[View|Views]].
+
# Access the menu and choose '''Redline Document'''<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_05.png|200 px|border|alt=Redline document|Redline document]]
 +
 
 +
<headertabs />
  
 
== See also ==
 
== See also ==
−
* [[Assign a Classification to a MetaClass]]
+
* [[HowTo:Assign a Classification to a MetaClass]]
−
* [[Add a MetaProperty to a MetaClass]]
+
* [[HowTo:Add a MetaProperty to a MetaClass]]
  
−
[[Category:How-To]]
+
[[Category:Android|Make a Document ready for Redlining]]
−
[[Category:Documents]]
+
[[Category:Document|Make a Document ready for Redlining]]
−
[[Category:UBIK Client]]
+
[[Category:How-To|Make a Document ready for Redlining]]

Latest revision as of 08:36, 15 February 2016

The redlining feature creates a copy of the document and opens it for editing with any installed 3rd party application. Enabling redlining for certain document objects requires that the following criteria are met:

[edit]

Studio

Criterion 1: A file document MetaClass is prepared for Redlining

  1. Set the SYSCLS REDLINEDFILE classification on a MetaClass for file documents using the Class Details control (the MetaClass must derive from FILEDOCUMENT)
    Redlined document
  2. Check if all required MetaProperties are implemented

Criterion 2: File documents can be created as child objects of other file documents

  1. Create a new relation between the MetaClasse of the original file document and the redlined file document
    Create relation

Criterion 3: View items for the (redlined) file document exist

  1. Create the view items for the file documents if they do not already exist (existing view items for file documents might be sufficient)
  2. Relate the view items to the according View and test the result in the View Test Environment (redlined documents can be created as child objects of other documents)

Criterion 4: Context scopes for the redlined file document exist and such file document can be created on the UBIK® Client

  1. Create a context scope for the redlined file document (an existing context scope for file documents might be sufficient
    Create context scopes
  2. Enable the creation of the document on the UBIK® Client and configure at least the Description property in the ACM
    Create context scopes
  3. If a thumbnail should be displayed on the mobile client configure the Thumbnail property as well

Android

Once the configuration has been completely accomplished on the server side the Redline Document function should be available on the mobile client.

  1. Long-click a document's thumbnail Content Browser
  2. Access the menu and choose Redline Document
    Redline document

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=HowTo:Make_a_Document_ready_for_Redlining&oldid=18821"