From f82c3622d3dbd2a69acf17a616b77ffa7cf65aae Mon Sep 17 00:00:00 2001
From: C Beach <cbeach@unicon.net>
Date: Mon, 6 Aug 2018 10:43:49 -0500
Subject: [PATCH] Added a README and an example properties file

---
 openequella-toolbox/README.md        | 12 ++++++++
 openequella-toolbox/blank.properties | 41 ++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+)
 create mode 100644 openequella-toolbox/README.md
 create mode 100644 openequella-toolbox/blank.properties

diff --git a/openequella-toolbox/README.md b/openequella-toolbox/README.md
new file mode 100644
index 0000000..464c91d
--- /dev/null
+++ b/openequella-toolbox/README.md
@@ -0,0 +1,12 @@
+# openEQUELLA Toolbox
+Proof-of-concept for a suite of scripts to interface with openEQUELLA in Java.
+
+## Main functions
+### Migrate to Kaltura
+Search openEQUELLA for items with a given criteria.  For each item found, download the appropriate video, upload into Kaltura, and then re-version the openEQUELLA item, replacing the video file and other attachments with the single Kaltura attachment.
+
+### Export Items
+Search openEQUELLA for items with a given criteria.  For each item found, export the metadata in a given format.
+
+# License
+Apache v2
diff --git a/openequella-toolbox/blank.properties b/openequella-toolbox/blank.properties
new file mode 100644
index 0000000..a32d071
--- /dev/null
+++ b/openequella-toolbox/blank.properties
@@ -0,0 +1,41 @@
+### Toolbox function
+#
+# MigrateToKaltura, ExportItems
+toolbox.function=
+
+oeq.url=
+oeq.oauth.client.id=
+oeq.oauth.client.secret=
+oeq.search.api.requested.length=10
+oeq.search.api=/api/search/?collections=csv-of-collection-uuids&order=name&reverse=false&info=all&showall=false&status=LIVE
+
+// Use \\ for Windows, / for Mac and Linux
+general.os.slash=/
+general.download.folder=/my/temp/folder/for/openequella-migration-downloads
+
+// Need to be an integer.  
+// Controls how often the script will give a file download update (higher is less frequent).
+general.download.chatter=400
+
+### Needed for MigrateToKaltura
+
+migrate-to-kaltura.kal.partner.id=
+migrate-to-kaltura.kal.admin.secret=
+migrate-to-kaltura.kal.categories=
+migrate-to-kaltura.oeq.kal.id=
+migrate-to-kaltura.kal.user.id=
+migrate-to-kaltura.kal.service.url=
+migrate-to-kaltura.general.max.items.to.migrate=3
+migrate-to-kaltura.oeq.search.attachment.description=My Videos
+migrate-to-kaltura.oeq.search.kal.tags.xpath=/xml/my/path/to/tags/text()
+
+### Needed for ExportItems
+export.items.output=/my/export/file.csv
+
+# Format:  YYYY-MM-DD
+export.items.filter.dateCreated=2013-01-01
+
+# CSV of metadata paths
+# Keywords:  UUID, Version, attachment_names, name, description
+# The rest of the columns are assumed to be xpaths.  The script will automatically add prefix 'xml/' and add a suffix of '/text()'
+export.items.columnFormat=my/metadata/title,UUID,Version,attachment_names,my/metadata/data1,my/metadata/data2,my/metadata/data3