Jump to: navigation, search

Difference between revisions of "DocumentProxy"

(→‎DocumentMetaProxy)
(→‎BatchDocumentProxyCreator)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{Attention|This page is under construction.}}
 
−
 
 
== Basics ==
 
== Basics ==
 
A Document Proxy object contains the logic of a basic [[Proxy]] object combined with the capability to handle file documents from an interface.  
 
A Document Proxy object contains the logic of a basic [[Proxy]] object combined with the capability to handle file documents from an interface.  
 
One Document Proxy object can handle both import and export of the same Ubik FileDocument instance via one interface.
 
One Document Proxy object can handle both import and export of the same Ubik FileDocument instance via one interface.
−
{{Hint|A Document Proxy object '''MUST HAVE''' PX_DOCUMENT or a derivative of it defined as its [[MetaClass]]!}}
+
{{Hint|A Document Proxies are instances of PX_DOCUMENT or a derivative of it!}}
−
The TargetType for DocumentMetaProxy has to be a FileDocument MetaClass.
+
The TargetType for DocumentMetaProxy should be a FileDocument MetaClass.
  
−
== DocumentMetaProxy ==
+
[[Category:Document|DocumentProxy]]
 +
[[Category:Interfacing|DocumentProxy]]
 +
 
 +
== DocumentMetaProxy Setup ==
 
UBIK provides a DocumentMetaProxy called '''PX_DOCUMENT''' (UID: 58c1a444-3867-41e7-84a2-bd655fb04755) that is derived from PROXYROOT.
 
UBIK provides a DocumentMetaProxy called '''PX_DOCUMENT''' (UID: 58c1a444-3867-41e7-84a2-bd655fb04755) that is derived from PROXYROOT.
 
The TargetType of DocumentMetaProxies needs to be set to a FileDocumentMetaClass (e.g. a MetaClass derived from FILEDOCUMENT).
 
The TargetType of DocumentMetaProxies needs to be set to a FileDocumentMetaClass (e.g. a MetaClass derived from FILEDOCUMENT).
 
The following methods need to be overridden for the InterfaceAdministration MetaClasses that are related to DocumentMetaProxies via their SYSREL_INTERFACE_ADMIN_METAPROXY relation:
 
The following methods need to be overridden for the InterfaceAdministration MetaClasses that are related to DocumentMetaProxies via their SYSREL_INTERFACE_ADMIN_METAPROXY relation:
 
* GetExternalDataReader()
 
* GetExternalDataReader()
−
Here it is necessary to return an object of a class that implements the abstract class ''DocumentReadFromExternalExecutionBase''.
 
−
 
 
<source lang="csharp">
 
<source lang="csharp">
−
namespace UBIK.Interface
+
protected override UBIK.Interface.IInterfaceExecutor GetExternalDataReader()
 
{
 
{
−
    public struct FileDetails
+
return new UBIK.Interface.FileDocumentReadFromExternalExecutor(this.Environment);
−
    {
+
−
        public string FileName;
+
−
        public string FullPath;
+
−
        public string ContentType;
+
−
        public DateTime CreationTime;
+
−
    }
+
−
 
+
−
    public abstract class DocumentReadFromExternalExecutionBase : InterfaceExecutionBase
+
−
    {
+
−
...
+
−
        public abstract Stream GetFilestream(DocumentProxy proxy);
+
−
 
+
−
        public abstract bool TryGetFileDetails(DocumentProxy proxy, out FileDetails details);
+
−
    }
+
 
}
 
}
 
</source>
 
</source>
  
 
* GetExternalDataWriter()
 
* GetExternalDataWriter()
 +
<source lang="csharp">
 +
protected override UBIK.Interface.IInterfaceExecutor GetExternalDataWriter()
 +
{
 +
return new UBIK.Interface.FileDocumentWriteToExternalExecutor(this.Environment);
 +
}
 +
</source>
  
 +
[[Category:Document|DocumentProxy]]
 +
[[Category:Interfacing|DocumentProxy]]
  
 
== Properties ==
 
== Properties ==
Line 46: Line 39:
 
! Property!! Description
 
! Property!! Description
 
|-
 
|-
−
| Key|| External primary key. Can be the file path to the external document or a byte stream.  
+
| Key|| The '''file path''' to the external document (ubik needs to have access to it). External primary key.  
 
|-
 
|-
 
| File name|| The name of the external file (including its extension).
 
| File name|| The name of the external file (including its extension).
Line 69: Line 62:
  
  
−
== DocumentBatchProxyCreator ==
+
== BatchDocumentProxyCreator ==
−
The DocumentBatchProxyCreator class provides the possibility to create multiple Document Proxies with the import status set to QuedForReadFromExternal.
+
The BatchDocumentProxyCreator class provides the possibility to create multiple Document Proxies with the import status set to QuedForReadFromExternal.
 
The following two methods can be executed by e.g. using Who-Bert:
 
The following two methods can be executed by e.g. using Who-Bert:
  
−
'''Example: Asking a DocumentBatchProxyCreator to create Document Proxies for all documents in a folder. The import status will be set to QuedForReadFromExternal for all of them.'''
+
'''Example: Asking a BatchDocumentProxyCreator to create Document Proxies for all documents in a folder (top level only) without filters.'''
  
 
<source lang="csharp">
 
<source lang="csharp">
Line 79: Line 72:
 
MetaProxy myMetaProxy = obj.Environment.UBIKDataFactory().ContentObject(new Guid("put UID of your MetaProxy here")) as MetaProxy;
 
MetaProxy myMetaProxy = obj.Environment.UBIKDataFactory().ContentObject(new Guid("put UID of your MetaProxy here")) as MetaProxy;
  
−
// Creating a DocumentBatchProxyCreator instance
+
// Creating a BatchDocumentProxyCreator instance
−
UBIK.Interface.DocumentBatchProxyCreator creator = new UBIK.Interface.DocumentBatchProxyCreator();
+
UBIK.Interface.BatchDocumentProxyCreator creator = new UBIK.Interface.BatchDocumentProxyCreator();
  
−
// calling ImportBatchOfDocuments() without filtering options
+
// Defining string for folder path
 +
string folderPath = @"C:\Documents";
 +
 
 +
// calling CreateProxies() without filtering options
 
// Parameter 1: the path to the folder that contains the documents.  
 
// Parameter 1: the path to the folder that contains the documents.  
 
// Parameter 2: the MataProxy
 
// Parameter 2: the MataProxy
−
creator.ImportBatchOfDocuments("put path to folder here", myMetaProxy);
+
creator.CreateProxies(folderPath, myMetaProxy);
 +
</source>
 +
 
 +
'''Example: Asking a BatchDocumentProxyCreator to create Document Proxies for all documents in a folder (top and sub levels) with filters.'''
 +
 
 +
<source lang="csharp">
 +
// Getting your required MetaProxy
 +
MetaProxy myMetaProxy = obj.Environment.UBIKDataFactory().ContentObject(new Guid("put UID of your MetaProxy here")) as MetaProxy;
 +
 
 +
// Creating a BatchDocumentProxyCreator instance
 +
UBIK.Interface.BatchDocumentProxyCreator creator = new UBIK.Interface.BatchDocumentProxyCreator();
 +
 
 +
// Defining string for folder path
 +
string folderPath = @"C:\Documents";
 +
 
 +
//Define string for search pattern
 +
string searchPattern = "*.pdf";
  
−
// calling ImportBatchOfDocuments() with filtering options
+
// calling CreateProxies() with filtering options
 
// Parameter 1: string of the path to the folder that contains the documents.  
 
// Parameter 1: string of the path to the folder that contains the documents.  
 
// Parameter 2: the MataProxy
 
// Parameter 2: the MataProxy
 
// Parameter 3: string of the search pattern
 
// Parameter 3: string of the search pattern
 
// Parameter 4: System.IO.SearchOption
 
// Parameter 4: System.IO.SearchOption
−
creator.ImportBatchOfDocuments("put path to folder here", myMetaProxy, "*mySearchPattern*", SearchOption.AllDirectories);
+
creator.CreateProxies(folderPath, myMetaProxy, searchPattern, SearchOption.AllDirectories);
 
</source>
 
</source>
  
 +
[[Category:Document|DocumentProxy]]
 +
[[Category:Interfacing|DocumentProxy]]
  
 
==See also==
 
==See also==
Line 100: Line 114:
 
* [[ProxyMetaProperty]]
 
* [[ProxyMetaProperty]]
 
* [[Proxy]]
 
* [[Proxy]]
 +
* [[ProxyScanner]]
 
* [[HowTo:Configure_Proxies]]
 
* [[HowTo:Configure_Proxies]]
 +
 +
[[Category:Document|DocumentProxy]]
 +
[[Category:Interfacing|DocumentProxy]]

Latest revision as of 15:56, 24 June 2024

Basics

A Document Proxy object contains the logic of a basic Proxy object combined with the capability to handle file documents from an interface. One Document Proxy object can handle both import and export of the same Ubik FileDocument instance via one interface.

IC Hint square.pngA Document Proxies are instances of PX_DOCUMENT or a derivative of it!

The TargetType for DocumentMetaProxy should be a FileDocument MetaClass.

DocumentMetaProxy Setup

UBIK provides a DocumentMetaProxy called PX_DOCUMENT (UID: 58c1a444-3867-41e7-84a2-bd655fb04755) that is derived from PROXYROOT. The TargetType of DocumentMetaProxies needs to be set to a FileDocumentMetaClass (e.g. a MetaClass derived from FILEDOCUMENT). The following methods need to be overridden for the InterfaceAdministration MetaClasses that are related to DocumentMetaProxies via their SYSREL_INTERFACE_ADMIN_METAPROXY relation:

  • GetExternalDataReader()
protected override UBIK.Interface.IInterfaceExecutor GetExternalDataReader()
{
        return new UBIK.Interface.FileDocumentReadFromExternalExecutor(this.Environment);
}
  • GetExternalDataWriter()
protected override UBIK.Interface.IInterfaceExecutor GetExternalDataWriter()
{
        return new UBIK.Interface.FileDocumentWriteToExternalExecutor(this.Environment);
}

Properties

Besides the properties known from the basic Proxy, a DocumentProxy provides the following properties:

ProxyMetaProperties:

Property Description
Key The file path to the external document (ubik needs to have access to it). External primary key.
File name The name of the external file (including its extension).
File path The full path of the external file.
File content type The content type (extension) of the external file.
File creation time The creation timestamp of the external file.

MetaProperties:

Property Description
Import File Hashcode The hashcode representing the content of the import file
Export File Hashcode The hashcode representing the content of the export file


BatchDocumentProxyCreator

The BatchDocumentProxyCreator class provides the possibility to create multiple Document Proxies with the import status set to QuedForReadFromExternal. The following two methods can be executed by e.g. using Who-Bert:

Example: Asking a BatchDocumentProxyCreator to create Document Proxies for all documents in a folder (top level only) without filters.

// Getting your required MetaProxy
MetaProxy myMetaProxy = obj.Environment.UBIKDataFactory().ContentObject(new Guid("put UID of your MetaProxy here")) as MetaProxy;

// Creating a BatchDocumentProxyCreator instance
UBIK.Interface.BatchDocumentProxyCreator creator = new UBIK.Interface.BatchDocumentProxyCreator();

// Defining string for folder path
string folderPath = @"C:\Documents";

// calling CreateProxies() without filtering options
// Parameter 1: the path to the folder that contains the documents.
// Parameter 2: the MataProxy
creator.CreateProxies(folderPath, myMetaProxy);

Example: Asking a BatchDocumentProxyCreator to create Document Proxies for all documents in a folder (top and sub levels) with filters.

// Getting your required MetaProxy
MetaProxy myMetaProxy = obj.Environment.UBIKDataFactory().ContentObject(new Guid("put UID of your MetaProxy here")) as MetaProxy;

// Creating a BatchDocumentProxyCreator instance
UBIK.Interface.BatchDocumentProxyCreator creator = new UBIK.Interface.BatchDocumentProxyCreator();

// Defining string for folder path
string folderPath = @"C:\Documents";

//Define string for search pattern
string searchPattern = "*.pdf";

// calling CreateProxies() with filtering options
// Parameter 1: string of the path to the folder that contains the documents.
// Parameter 2: the MataProxy
// Parameter 3: string of the search pattern
// Parameter 4: System.IO.SearchOption
creator.CreateProxies(folderPath, myMetaProxy, searchPattern, SearchOption.AllDirectories);

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=DocumentProxy&oldid=26886"