DocumentProxy - Revision history

LMA: /* BatchDocumentProxyCreator */

2024-06-24T15:56:50Z

‎BatchDocumentProxyCreator

LMA: /* DocumentMetaProxy Set-UP */

2024-06-24T15:55:32Z

‎DocumentMetaProxy Set-UP

LMA: /* Basics */

2024-06-24T15:47:08Z

‎Basics

LMA: /* Basics */

2024-06-24T15:44:23Z

‎Basics

LMA at 14:59, 24 June 2024

2024-06-24T14:59:55Z

LMA at 14:58, 24 June 2024

2024-06-24T14:58:25Z

LMA: /* Properties */

2024-06-24T14:55:18Z

‎Properties

LMA: /* DocumentMetaProxy */

2024-06-24T14:53:41Z

‎DocumentMetaProxy

LMA: /* DocumentBatchProxyCreator */

2024-06-24T14:42:32Z

‎DocumentBatchProxyCreator

LMA: /* DocumentMetaProxy */

2024-06-24T13:54:07Z

‎DocumentMetaProxy

@@ Line 97: / Line 97: @@
 //Define string for search pattern
-string searchPattern = "*pdf*";
+string searchPattern = "*.pdf";
 // calling CreateProxies() with filtering options
@@ Line 107: / Line 107: @@
 </source>
 ==See also==

@@ Line 8: / Line 8: @@
 [[Category:Interfacing|DocumentProxy]]
-== DocumentMetaProxy Set-UP ==
+== 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).
@@ Line 28: / Line 28: @@
 </source>
 == Properties ==

@@ Line 3: / Line 3: @@
 One Document Proxy object can handle both import and export of the same Ubik FileDocument instance via one interface.
 {{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.
 [[Category:Document|DocumentProxy]]

@@ Line 2: / Line 2: @@
 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.
-{{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.
 == DocumentMetaProxy Set-UP ==

@@ Line 1: / Line 1: @@
 == Basics ==
 A Document Proxy object contains the logic of a basic [[Proxy]] object combined with the capability to handle file documents from an interface.
@@ Line 7: / Line 5: @@
 The TargetType for DocumentMetaProxy has to be a FileDocument MetaClass.
-== DocumentMetaProxy ==
+== DocumentMetaProxy Set-UP ==
 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).

@@ Line 109: / Line 109: @@
 * [[ProxyMetaProperty]]
 * [[Proxy]]
 * [[HowTo:Configure_Proxies]]

@@ Line 36: / Line 36: @@
 ! 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).

@@ Line 12: / Line 12: @@
 The following methods need to be overridden for the InterfaceAdministration MetaClasses that are related to DocumentMetaProxies via their SYSREL_INTERFACE_ADMIN_METAPROXY relation:
 * GetExternalDataReader()
 <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>
 * GetExternalDataWriter()
 <source lang="csharp">
+protected override UBIK.Interface.IInterfaceExecutor GetExternalDataWriter()
 </source>

@@ Line 74: / Line 74: @@
-== 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:
-'''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">
@@ Line 84: / Line 84: @@
 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
 // Parameter 1: the path to the folder that contains the documents.
 // Parameter 2: the MataProxy
-creator.ImportBatchOfDocuments("put path to folder here", myMetaProxy);
+creator.CreateProxies(folderPath, myMetaProxy);
-// calling ImportBatchOfDocuments() with filtering options
+// 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.ImportBatchOfDocuments("put path to folder here", myMetaProxy, "*mySearchPattern*", SearchOption.AllDirectories);
+creator.CreateProxies(folderPath, myMetaProxy, searchPattern, SearchOption.AllDirectories);
 </source>

← Older revision		Revision as of 13:54, 24 June 2024
Line 36:		Line 36:

	* GetExternalDataWriter()		* GetExternalDataWriter()
		+	Here it is necessary to return an object of a class that implements the abstract class ''DocumentReadFromExternalExecutionBase''.
		+
		+	<source lang="csharp">
		+
		+	</source>