Differences

This shows you the differences between two versions of the page.

--- documentation:software:atlas:setup [2016/08/19 15:08] – frank_defalco
+++ documentation:software:atlas:setup [2019/05/30 20:47] (current) – anthonysena
@@ Line 1: / Line 1: @@
-===== ATLAS Setup =====
+~~NOTOC~~
+===== IMPORTANT NOTE =====
+All ATLAS documentation has moved to [[https://github.com/OHDSI/ATLAS/wiki|GitHub]]. Please disregard the content below as it is legacy and kept for posterity.
+===== ATLAS Setup (LEGACY) =====
 The following sections detail the process for setting up Atlas and its dependencies.
@@ Line 6: / Line 12: @@
 === WebAPI ===
-The first prerequisite for ATLAS is to [[documentation:software:webapi:setup|Install the OHDSI WebAPI]] and configure the appropriate sources. The following figure provides an example topology to show the different elements involved in the WebAPI architecture and a visual representation of the [[documentation:software:webapi:source_configuration|source configuration]].
+The first prerequisite for ATLAS is to [[documentation:software:webapi:webapi_installation_guide|Install the OHDSI WebAPI]] and [[documentation:software:webapi:source_configuration|configure the appropriate sources]].
-**Note:** The example above does not represent a physical architecture. The WebAPI configuration allows you to physically and logically segregate these data sources based on the requirements of your environment.
 === ACHILLES ===
-To use the [[documentation:software:atlas:data-sources|Data Sources]] feature within ATLAS you must first [[documentation:software:achilles|setup and execute ACHILLES]] in your environment. Once you have successfully generated summary statistics and have exported your data to JSON format, you are ready to configure ATLAS to use this information.
+To use the [[documentation:software:atlas:data-sources|Data Sources]] feature within ATLAS you must first [[documentation:software:achilles|setup and execute ACHILLES]] in your environment. Once you have successfully generated summary statistics, you are ready to configure ATLAS to use this information.
-==== ATLAS Installation ====
+**Please note**: If you utilized Achilles prior to v1.4, please refer to the article [[documentation:software:atlas:achilles_v_1_5|Achilles v1.5.0 Dependencies For WebAPI/Atlas]] as Atlas/WebAPI v2.2.0 will require some additions to the Achilles output.
+==== ATLAS Installation (V2.2.0 and later) ====
 Begin by downloading the latest release of [[https://github.com/OHDSI/Atlas/releases/latest|ATLAS from GitHub]].
@@ Line 21: / Line 26: @@
   http://<your_webserver>/atlas
-Under the Atlas root folder, edit the file /js/config.js to configure the following properties:
+Under the Atlas root folder, create the file /js/config-local.js to configure the application. **Please note: the file /js/config-local.js is __not__ included in the Atlas repository. This is by design so that you may have environment-specific configuration. ** Config-local.js will override the settings found in /js/config.js as shown here:
 <code javascript>
 define([], function () {
-  var config = {};
+	var configLocal = {};
-  config.services = [{
-    name: '<YOUR ENVIRONMENT NAME>',
+	configLocal.api = {
-    url: 'http://your_webserver/WebAPI/'
+		name: 'My Organization Name',
-  }];
+		url: 'https://webapi.server.com/WebAPI/'
+	};
-  config.webAPIRoot = config.services[0].url;
+	return configLocal;
-  config.dataSourcesLocation = '/achilles/data/datasources.json';
-  config.dataSourcesRoot = '/achilles/data';
-  return config;
 });
 </code>
-config.services: Edit this array to provide a name for your environment and the URL for the WebAPI that was set up in WebAPI section.
+In the example above, the /js/config-local.js overrides the corresponding ".api" property found in /js/config.js and allows for custom configuration for your environment. The same pattern can be used to override the other settings in /js/config.js.
-config.dataSourcesLocation & config.dataSourcesRoot: If you have set up your CDM statistics (Achilles), these properties should be set to the URL where your CDM statistics resides. In the configuration below, we are using a relative path since we assume you have hosted your CDM statistics on the same web server as ATLAS but under a different directory.
-You should now be able to navigate to ATLAS from your web browser.
+Once this is complete, you should now be able to navigate to ATLAS from your web browser.
   http://<your_webserver>/atlas
+==== ATLAS Installation Archive ====
+[[documentation:software:atlas:archive:atlas_setup_v1_x|ARCHIVE: ATLAS Setup (v2.1 or earlier)]]