Repository export

The repository export feature helps the administrator export the whole or part of the OpenKM repository to the file system. The output will be the same folder and file structure as set in the application.

Field	Description
Repository path	The repository path to export. Common values: /okm:root /okm:templates /okm:personal /okm:mail
Filesystem path	Server destination path. Linux example: /mnt/export Windows example: c:/export
Metadata	When enabled, metadata values are exported.
History	When enabled, all document versions are exported.

Export

Set the repository path.
Check the repository export options.
Click the Export button.

Understanding output format

When metadata and history are not checked

The result will be a folder structure containing documents and mails. Although a document may have several versions, only the current version will be exported.

When only metadata is checked

The result will be a folder structure containing documents and mails. Although a document may have several versions, only the current version will be exported.

For each folder, document, or mail, an .okm file will be created. For example, for a file named "Administration.html", a file named "Administration.html.okm" will be created in the same path. The .okm files contain all the metadata information associated with the node in JSON format.

Example of an .okm file:

{"uuid":"8299d059-7894-468b-ba48-3f3b59ebc37c",
 "author":"okmAdmin",
 "name":"redacted_481.pdf",
 "path":"/okm:root/redacted_481.pdf",
 "created":{"year":2015,
			"month":6,
			"dayOfMonth":1,
			"hourOfDay":17,
			"minute":18,
			"second":0},
			"lastModified":{"year":2015,
							"month":6,
							"dayOfMonth":2,
							"hourOfDay":10,
							"minute":47,
							"second":39},
			"language":"en",
			"keywords":[],
			"categories":[],
			"subscriptors":[],
			"notes":[{"user":"system",
					  "date":{"year":2015,
							  "month":6,
							  "dayOfMonth":2,
							  "hourOfDay":10,
							  "minute":47,
							  "second":40},
					  "text":"New version 1.1 by okmAdmin: Signed",
					  "path":"7d11d393-df46-49a1-8f29-ae6d0ea4a093"}],
			"propertyGroups":[],
			"version":{"author":"okmAdmin",
					   "name":"1.1",
					   "created":{"year":2015,
								  "month":6,
								  "dayOfMonth":2,
								  "hourOfDay":10,
								  "minute":47,
								  "second":39},
					   "size":139215,
					   "mimeType":"application/pdf",
					   "comment":"Signed"},
 "grantedUsers":{"okmAdmin":15},
 "grantedRoles":{"ROLE_USER":15}
}

Keep in mind that the JSON output format can change if the main objects (folder, document, mail, or record) have fields added, removed, or modified.

When only history is checked

The result will be a folder structure with documents and mails. All document versions will be saved.

Example of output for a document with version 1.0 and 1.1:

Administration.html ( size = 0 bytes )
Administration.html#v1.0# ( contents of version 1.0 )
Administration.html#v1.1# ( contents of version 1.1 )

When metadata and history are checked