{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"}},"macroMetadata":{"macroId":{"value":"96d1a9a03c3decf77386b0418b746197"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"55fba8bc-36f1-4d9d-8003-04dd975439ac"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Introduction ","type":"text"}]},{"type":"paragraph","content":[{"text":"The VidiCore Admin Tool is an application that facilitates the management of entity data in VidiCore systems. The application visually expresses all VidiCore API endpoints within a consistent user experience, while also granting users a means to view lists or entities, forms that allow entry of any possible value within the schema, and actions to create/update/remove entities.","type":"text"}]},{"type":"paragraph","content":[{"text":"The key features of the application are centered on granting the user the ability to view and edit API endpoint data and entities, such as configuration parameters, user data et cetera, in a consistent user interface. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1366,"id":"7a4218dd-fd21-474c-a13f-20c4ed1e63ae","collection":"contentId-2249949244","type":"file","height":905}},{"type":"caption","content":[{"text":"The VidiCore Admin Tool","type":"text"}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"At its core, the Vidicore Admin Tool is a lightweight application requiring minimal configuration. The only prerequisite is a live instance of VidiCore.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Using the Application ","type":"text"}]},{"type":"paragraph","content":[{"text":"For this guide, we assume that you have a VidiCore instance running. This can be running either inside VidiNet or as a standalone local instance.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"VidiCore Version Compatibility","type":"text"}]},{"type":"paragraph","content":[{"text":"Your VidiCore system needs to be version 4.17 or later in order to use this theme application.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Accessing the Application","type":"text"}]},{"type":"paragraph","content":[{"text":"The VidiCore Admin Tool runs as a serverless one-page application. The latest compiled version can be found here: ","type":"text"},{"text":"https://vidispine.github.io/admin-tool","type":"text","marks":[{"type":"link","attrs":{"href":"https://vidispine.github.io/admin-tool"}}]},{"text":" . This version can be run towards any VidiCore system.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If you want to pull and run the Admin Tool as a Docker container, there are images readily available on Dockerhub: ","type":"text"},{"text":"https://hub.docker.com/repository/docker/vidispine/admin-tool","type":"text","marks":[{"type":"link","attrs":{"href":"https://hub.docker.com/repository/docker/vidispine/admin-tool"}}]},{"text":" ","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Prerequisite: Add CORS Configuration to VidiCore ","type":"text"}]},{"type":"paragraph","content":[{"text":"In order to use the Github-hosted application towards your VidiCore system, the following ","type":"text"},{"text":"CORS ","type":"text","marks":[{"type":"link","attrs":{"href":"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS"}}]},{"text":"configuration must be added in VidiCore. This can be done in the console of your choice or via Postman. ","type":"text"},{"type":"hardBreak"},{"text":"PUT /API/configuration/cors","type":"text","marks":[{"type":"code"}]}]},{"type":"codeBlock","content":[{"text":"\n \n \n https://vidispine.github.io/admin-tool\n \n \n https://vidispine.github.io/admin-tool\n OPTIONS,GET,HEAD,POST,PUT,DELETE\n accept,content-type,authorization,index,size,runas\n 600\n \n","type":"text"}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Erroneous or missing CORS configuration will render an error in the application login screen","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Defining the VidiCore API Endpoint ","type":"text"}]},{"type":"paragraph","content":[{"text":"Enter the API endpoint URI of your VidiCore system in the application’s login screen. Log in to the application using the username and password of a user account in your VidiCore system.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":933,"id":"f7dbbb32-c432-47de-ba40-3aa70fc57da7","collection":"contentId-2249949244","type":"file","height":502}}]},{"type":"paragraph","content":[{"text":"Directing the application towards a VidiCore API endpoint in the login screen","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Accessing the Source Code ","type":"text"}]},{"type":"paragraph","content":[{"text":"The VidiCore Admin Tool source code can be found on GitHub: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://github.com/vidispine/admin-tool"}},{"text":" ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Access Denied or no GitHub account?","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"Create an account here ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://github.com/join"}},{"text":" and then send your GitHub username to ","type":"text"},{"text":"info@vidispine.com","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:info@vidispine.com"}}]},{"text":" with a request to obtain access to the Theme for VidiCore from the Vidispine Repository.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"With access to the repository in GitHub you will be able to modify and run the application locally. Remember to adjust your CORS settings for the application to run correctly.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Using the Application ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"The Main View","type":"text"}]},{"type":"paragraph","content":[{"text":"Immediately after the login the content pane is completely empty. Use the function menu in the top left to display a categorized sorting of API endpoints available in this application. You can also use the search-window to find the API endpoint you want to work with. ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1389,"id":"b3ffe18e-28f9-4bff-b959-d8224b815541","collection":"contentId-2249949244","type":"file","height":364}},{"type":"caption","content":[{"text":"The Main View","type":"text"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1386,"id":"15fba337-24d5-4821-961c-11009c46f7cf","collection":"contentId-2249949244","type":"file","height":486}},{"type":"caption","content":[{"text":"API endpoint menu","type":"text"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1366,"id":"d2abcc9d-1af1-41e4-8106-e39699355169","collection":"contentId-2249949244","type":"file","height":661}},{"type":"caption","content":[{"text":"API endpoint search function","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"View and Edit Endpoint Entities","type":"text"}]},{"type":"paragraph","content":[{"text":"Endpoint data can be edited by toggling the EDIT button. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Note: all changes will be saved to your VidiCore instance regardless if the data entered is technically correct or not. ","type":"text"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1372,"id":"59c952ec-0186-4cd4-a3b9-b7bc70e56b76","collection":"contentId-2249949244","type":"file","height":892}},{"type":"caption","content":[{"text":"Example usage: Create new user","type":"text"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1371,"id":"f4df94aa-7562-41ac-8178-c7f85e7fcb53","collection":"contentId-2249949244","type":"file","height":908}},{"type":"caption","content":[{"text":"Example usage: Working with Item metadata","type":"text"}]}]},{"type":"mediaSingle","attrs":{"layout":"center"},"content":[{"type":"media","attrs":{"width":1376,"id":"6bcbd688-2d7e-489d-a106-d64a1e380955","collection":"contentId-2249949244","type":"file","height":750}},{"type":"caption","content":[{"text":"Example usage: working with configuration properties","type":"text"}]}]},{"type":"paragraph"}],"version":1}