"# bitemporal-demo Bitemporal + MarkLogic
To clone the project when you have git installed: git clone https://github.com/marklogic/bitemp-explorer.git If not, you can download the project as ZIP file.
INSTALL INSTRUCTIONS
- Install MarkLogic 8: https://developer.marklogic.com/products and start the server
- Navigate to http://localhost:8000/qconsole
- On the right bar click the down arrow and choose "import workspace"
- Import files in folder "WorkSpace-JS" or "WorkSpace-XQuery" depending on your language preference: Javascript or XQuery
- Download and install node.js 0.10.29: https://nodejs.org/dist/v0.10.29/
- Go to command line/terminal, cd under this repo directory, do "npm install"
- Check to see that there is no ERR
- Configure connection in env.js or create a local-env.js, if needed. local-env.js takes the same form as env.js, but does not get committed.
- Deploy three REST extensions by running - "node deploy.js" -in your shell.
- Run app with "node app.js"
- go to http://localhost:3000/ to see a blank graph with title
- go back to Query console and go from workspace 1 to 5, start from tab 1.
APP INSTRUCTIONS
- Go through the workspaces.
- It is recommended to go through at least the first two workspaces and create one or two temporal collections before trying the features of the demo.
- On the home page, choose a temporal collection from the dropdown menu. Click the 'Search' button to get a list of all the documents within that temoral collection. Click one of the blue links to redirect you to the view page.
- The graph on the view page is a visual representation of bitemporal, with 2 axes representing system and valid times of a temporal document.
- The view page dropdown menu will drop down the properties of your documents being displayed in the graph. You can select and view new properties.
- Click boxes (that represent physical documents) in the graph to edit, view, and delete certain documents. Edit will create a new physical document. View to see the contents of a document. The delete button will cut off a system end time to the current real time, or a time that you specify.
- Click the 'Home' link in the upper lefthand corner to go back to the home page.
- Back on the home page, you can also choose a system time operator and/or a valid time operator from the dropdown menus and drag the blue bars on the graph to select your ranges. Click the 'Search' button to display the documents specified by the temporal collection and the operators/time ranges.
- To run another query, click the 'Reset' button and repeat the steps above.
- Click the 'Create a Document' button to create a new logical document with its first physical document.
- If a lot is new or confusing, look for highlighted words on the page for hovering over. A definition will pop up to help you cement your knowledge of bitemporal.
Guide to Workspaces:
MLW1-configure&basics.xml - set up temporal axis/collection, basic intro to MarkLogic
MLW2-Ingestion&Query.xml - temporal insert/update/delete examples and exercises, work together with node app on port 3000
MLW3-BitemporalTradeStore.xml - more complex data set (a trade store) exercises
MW4-Semantics.xml - intro to how bitemporal and semantics work together
MLW5-BitemporalLSQT.xml - special use case, proceed when done with 1 to 3
MLW6-IngestYourOwn - some helper code to ingest your own data
Documentation - Temporal Developer's Guide http://docs.marklogic.com/guide/temporal