Repository export

The repository export feature helps the administrator to export the whole or part of the OpenKM repository to the file system. The output result will be the same folders and files structure that are set into 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 documents versions are exported.

Export

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

Understanding output format

Case metadata and history are not checked

The result will be a folder structure with documents and mails into.  Although a document has several versions only will be exported the actual version.

Case only metadata is checked

The result will be a folder structure with documents and mails into. Although a document has several versions only will be exported the actual version.

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

Example of .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}
}

Caution

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

Case 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 )

Case metadata and history are checked

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

For each folder, document or mail will be created a .okm file. For example for a file named “Administration.html” will be created in the same path a file named “Administration.html.okm”. The .okm file contains all the metadata information associated to the node in a JSON format.

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

• Administration.html ( size = 0 bytes )
• Administration.html.okm ( metadata associated to the document )
• Administration.html#v1.0# ( contents of version 1.0 )
• Administration.html#v1.0#.okm ( metadata associated to version 1.0 )
• Administration.html#v1.1# ( contents of version 1.1 )
• Administration.html#v1.1#.okm ( metadata associated to version 1.1 )