Difference between revisions of "DocumentProxy"
(→DocumentBatchProxyCreator) |
|||
| Line 39: | Line 39: | ||
The DocumentBatchProxyCreator class provides the possibility to create multiple Document Proxies with the import status set to QuedForReadFromExternal. | The DocumentBatchProxyCreator 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 DocumentBatchProxyCreator to create Document Proxies for all documents in a folder. The import status will be set to QuedForReadFromExternal for all of them.'' | ||
| Line 60: | Line 61: | ||
creator.ImportBatchOfDocuments("put path to folder here", myMetaProxy, "*mySearchPattern*", SearchOption.AllDirectories); | creator.ImportBatchOfDocuments("put path to folder here", myMetaProxy, "*mySearchPattern*", SearchOption.AllDirectories); | ||
</source> | </source> | ||
| − | |||
Revision as of 12:34, 24 June 2024
 | This page is under construction. |
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.
 | A Document Proxy object MUST HAVE PX_DOCUMENT or a derivative of it defined as its MetaClass! |
The TargetType for DocumentMetaProxy has to be a FileDocument MetaClass.
Properties
Besides the properties known from the basic Proxy, a DocumentProxy provides the following properties: ProxyMetaProperties:
| Property | Description |
|---|---|
| Key | External primary key. Can be the file path to the external document or a byte stream. |
| 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 |- |}
DocumentBatchProxyCreator
The DocumentBatchProxyCreator 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.
MetaProxy myMetaProxy = obj.Environment.UBIKDataFactory().ContentObject(new Guid("put UID of your MetaProxy here")) as MetaProxy;
// Creating a DocumentBatchProxyCreator instance
UBIK.Interface.DocumentBatchProxyCreator creator = new UBIK.Interface.DocumentBatchProxyCreator();
// calling ImportBatchOfDocuments() without filtering options
// Parameter 1: the path to the folder that contains the documents.
// Parameter 2: the MataProxy
creator.ImportBatchOfDocuments("put path to folder here", myMetaProxy);
// calling ImportBatchOfDocuments() 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);
See also
- MetaProxy
- ProxyMetaProperty
- DocumentProxy
- Configure Proxies
