docs/factory/json-reference/index.html - gerrit/www.eclipse.org/che - Git at Google



 <!-- jQuery Eclipse IP approval https://dev.eclipse.org/ipzilla/show_bug.cgi?id=10801 -->
 <script type="text/javascript" charset="utf8" src="../../../docs/assets/scripts/jquery-1.8.1.min.js"></script>

 <script type="text/javascript" charset="utf8">
   $(document).ready(function(){
     var images = document.getElementsByTagName('img');
     for (var i = 0; i < images.length; i++) {
       var image = images[i];
       var parentElement = image.parentElement;
       var a = document.createElement('a');
       if (! image.getAttribute('src').includes("logo-codenvy.svg") && ! image.getAttribute('src').includes("codenvy-contribute.svg") ){
           a.href = image.getAttribute('src');
           a.target = "_blank";
           a.appendChild(image);
           parentElement.appendChild(a);
       }
     }
   });
 </script>
 <!DOCTYPE HTML>
 <html lang="en-US">
 <head>
   <title>Factory - JSON Reference -

       Docs
      - Eclipse Che</title>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <meta name="generator" content="Jekyll v3.5.1">
   <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
   <link rel="stylesheet" href="../../../docs/assets/css/screen.css">
   <link rel="icon" type="image/x-icon" href="../../../docs/assets/imgs/favicon.ico">
   <!--[if lt IE 9]>
   <script src="/js/html5shiv.min.js"></script>
   <script src="/js/respond.min.js"></script>
   <![endif]-->
 </head>


 <body class="wrap">


 <header>
   <nav class="mobile-nav show-on-mobiles">
     <ul>

   <li class="current">
     <a href="../../../docs/index.html">Docs</a>
   </li>
   <li class="">
     <a href="../../../docs/tutorials/multi-machine/index.html">Tutorials</a>
   </li>
   <li class="">
     <a href="../../../docs/openshift/config/index.html">OpenShift</a>
   </li>
   <li>
     <a href="https://github.com/eclipse/che-docs/tree/master/src/main">GitHub</a>
   </li>
 </ul>

   </nav>
   <div class="grid">
     <div class="unit one-third center-on-mobiles">
         <a href="https://eclipse.org/che/">
           <span class="sr-only">Eclipse Che</span>
           <img src="../../../docs/assets/imgs/logo-eclipseche.svg" alt="Eclipse Che Logo"  width="249" height="115">
         </a>
     </div>
     <nav class="main-nav unit two-thirds hide-on-mobiles">
       <ul>

   <li class="current">
     <a href="../../../docs/index.html">Docs</a>
   </li>
   <li class="">
     <a href="../../../docs/tutorials/multi-machine/index.html">Tutorials</a>
   </li>
   <li class="">
     <a href="../../../docs/openshift/config/index.html">OpenShift</a>
   </li>
   <li>
     <a href="https://github.com/eclipse/che-docs/tree/master/src/main">GitHub</a>
   </li>
 </ul>

     </nav>
   </div>
 </header>


     <section class="docs">
     <div class="grid">

       <div class="docs-nav-mobile unit whole show-on-mobiles">
   <select onchange="if (this.value) window.location.href=this.value">
     <option value="">Navigate the docs…</option>


     <optgroup label="SETUP">


 <ul>


     <option value="../../../docs/index.html">Introduction</option>


     <option value="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</option>


     <option value="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</option>


     <option value="../../../docs/setup/configuration/index.html">Configuration</option>


     <option value="../../../docs/setup/managing/index.html">Managing</option>


     <option value="../../../docs/setup/cli/index.html">CLI Reference</option>


     <option value="../../../docs/setup/glossary/index.html">Glossary</option>


     <option value="../../../docs/setup/docker/index.html">Docker Installation</option>


     <option value="../../../docs/setup/openshift/index.html">OpenShift Installation</option>


     <option value="../../../docs/setup/selenium/index.html">How to run selenium tests</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</a></li>


     <li class=""><a href="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</a></li>


     <li class=""><a href="../../../docs/setup/configuration/index.html">Configuration</a></li>


     <li class=""><a href="../../../docs/setup/managing/index.html">Managing</a></li>


     <li class=""><a href="../../../docs/setup/cli/index.html">CLI Reference</a></li>


     <li class=""><a href="../../../docs/setup/glossary/index.html">Glossary</a></li>


     <li class=""><a href="../../../docs/setup/docker/index.html">Docker Installation</a></li>


     <li class=""><a href="../../../docs/setup/openshift/index.html">OpenShift Installation</a></li>


     <li class=""><a href="../../../docs/setup/selenium/index.html">How to run selenium tests</a></li>


 </ul>


     </optgroup>


     <optgroup label="WORKSPACE ADMINISTRATION">


 <ul>


     <option value="../../../docs/devops/intro/index.html">Introduction</option>


     <option value="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</option>


     <option value="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</option>


     <option value="../../../docs/devops/project-samples/index.html">Project Samples</option>


     <option value="../../../docs/devops/runtime-machines/index.html">Runtime Machines</option>


     <option value="../../../docs/devops/volume-mounts/index.html">Volume Mounts</option>


     <option value="../../../docs/devops/ws-agents/index.html">Workspace Agents</option>


     <option value="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</option>


     <option value="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</option>


     <option value="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/devops/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</a></li>


     <li class=""><a href="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</a></li>


     <li class=""><a href="../../../docs/devops/project-samples/index.html">Project Samples</a></li>


     <li class=""><a href="../../../docs/devops/runtime-machines/index.html">Runtime Machines</a></li>


     <li class=""><a href="../../../docs/devops/volume-mounts/index.html">Volume Mounts</a></li>


     <li class=""><a href="../../../docs/devops/ws-agents/index.html">Workspace Agents</a></li>


     <li class=""><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</a></li>


     <li class=""><a href="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</a></li>


 </ul>


     </optgroup>


     <optgroup label="USER GUIDE">


 <ul>


     <option value="../../../docs/ide/projects/index.html">Projects</option>


     <option value="../../../docs/ide/import-a-project/index.html">Import</option>


     <option value="../../../docs/ide/ssh/index.html">SSH</option>


     <option value="../../../docs/ide/sync/index.html">Local IDE Sync</option>


     <option value="../../../docs/ide/editor-settings/index.html">Editor</option>


     <option value="../../../docs/ide/intellisense/index.html">Intellisense</option>


     <option value="../../../docs/ide/commands/index.html">Commands</option>


     <option value="../../../docs/ide/git-svn/index.html">Git and SVN</option>


     <option value="../../../docs/ide/previews/index.html">Previews</option>


     <option value="../../../docs/ide/build/index.html">Build</option>


     <option value="../../../docs/ide/run/index.html">Run</option>


     <option value="../../../docs/ide/sharing/index.html">Share</option>


     <option value="../../../docs/ide/debug/index.html">Debug</option>


     <option value="../../../docs/ide/docker/index.html">Docker</option>


     <option value="../../../docs/ide/electron/index.html">Install Che Desktop Client</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/ide/projects/index.html">Projects</a></li>


     <li class=""><a href="../../../docs/ide/import-a-project/index.html">Import</a></li>


     <li class=""><a href="../../../docs/ide/ssh/index.html">SSH</a></li>


     <li class=""><a href="../../../docs/ide/sync/index.html">Local IDE Sync</a></li>


     <li class=""><a href="../../../docs/ide/editor-settings/index.html">Editor</a></li>


     <li class=""><a href="../../../docs/ide/intellisense/index.html">Intellisense</a></li>


     <li class=""><a href="../../../docs/ide/commands/index.html">Commands</a></li>


     <li class=""><a href="../../../docs/ide/git-svn/index.html">Git and SVN</a></li>


     <li class=""><a href="../../../docs/ide/previews/index.html">Previews</a></li>


     <li class=""><a href="../../../docs/ide/build/index.html">Build</a></li>


     <li class=""><a href="../../../docs/ide/run/index.html">Run</a></li>


     <li class=""><a href="../../../docs/ide/sharing/index.html">Share</a></li>


     <li class=""><a href="../../../docs/ide/debug/index.html">Debug</a></li>


     <li class=""><a href="../../../docs/ide/docker/index.html">Docker</a></li>


     <li class=""><a href="../../../docs/ide/electron/index.html">Install Che Desktop Client</a></li>


 </ul>


     </optgroup>


     <optgroup label="PORTABLE WORKSPACES">


 <ul>


     <option value="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</option>


     <option value="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</option>


     <option value="../../../docs/chedir/installation/index.html">Chedir - Installation</option>


     <option value="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</option>


     <option value="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</option>


     <option value="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</option>


     <option value="../../../docs/chedir/ssh/index.html">Chedir - SSH</option>


     <option value="../../../docs/chedir/factories/index.html">Chedir - Factories</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-getting-started/</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-creating/</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-json-reference/</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</a></li>


     <li class=""><a href="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</a></li>


     <li class=""><a href="../../../docs/chedir/installation/index.html">Chedir - Installation</a></li>


     <li class=""><a href="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</a></li>


     <li class=""><a href="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</a></li>


     <li class=""><a href="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</a></li>


     <li class=""><a href="../../../docs/chedir/ssh/index.html">Chedir - SSH</a></li>


     <li class=""><a href="../../../docs/chedir/factories/index.html">Chedir - Factories</a></li>


     <li class=""><a href="../../../docs/factory/getting-started/index.html">Factory - Getting Started</a></li>


     <li class=""><a href="../../../docs/factory/creating/index.html">Factory - Creating</a></li>


     <li class="current"><a href="../../../docs/factory/json-reference/index.html">Factory - JSON Reference</a></li>


 </ul>


     </optgroup>


     <optgroup label="DEVELOPER GUIDE - REST API">


 <ul>


     <option value="../../../docs/assemblies/intro/index.html">Introduction</option>


     <option value="../../../docs/assemblies/archetype/index.html">Archetype</option>


     <option value="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</option>


     <option value="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</option>


     <option value="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</option>


     <option value="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</option>


     <option value="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</option>


     <option value="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</option>


     <option value="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</option>


     <option value="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</option>


     <option value="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</option>


     <option value="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</option>


     <option value="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</option>


     <option value="../../../docs/assemblies/sdk-services/index.html">SDK Services</option>


     <option value="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</option>


     <option value="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</option>


     <option value="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</option>


     <option value="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</option>


     <option value="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/assemblies/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/assemblies/archetype/index.html">Archetype</a></li>


     <li class=""><a href="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-services/index.html">SDK Services</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</a></li>


 </ul>


     </optgroup>


   </select>
 </div>


       <div class="unit four-fifths">
         <article>
           <div class="improve right hide-on-mobiles">
             <a href="https://github.com/codenvy/che-docs/blob/master/src/main/_docs/factory-portable-workspaces/factory-json-reference.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
             <!--<a href="https://github.com/eclipse/che/blob/master/docs/_docs/factory-portable-workspaces/factory-json-reference.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>-->
           </div>
           <div class="doc-title">
             <h1>Factory - JSON Reference</h1>
             <div class="doc-title-border">
             </div>
           </div>

 <p>A Factory configuration is a JSON snippet either stored within Che or as a <code class="highlighter-rouge">.factory.json</code> file. You can create Factories within the IDE using our URL syntax, within the dashboard, or on the command line with the API and CLI.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">factory</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"v"</span><span class="w">         </span><span class="p">:</span><span class="w"> </span><span class="mf">4.0</span><span class="p">,</span><span class="w">   </span><span class="err">//</span><span class="w"> </span><span class="err">Version</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">configuration</span><span class="w"> </span><span class="err">format</span><span class="w">
   </span><span class="nt">"workspace"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">Identical</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">workspace</span><span class="p">:{}</span><span class="w"> </span><span class="err">object</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">Eclipse</span><span class="w"> </span><span class="err">Che</span><span class="w">
   </span><span class="s2">"policies"</span><span class="w">  </span><span class="err">:</span><span class="w"> </span><span class="p">{},</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">(Optional)</span><span class="w"> </span><span class="err">Restrictions</span><span class="w"> </span><span class="err">that</span><span class="w"> </span><span class="err">limit</span><span class="w"> </span><span class="err">behaviors</span><span class="w">
   </span><span class="nt">"ide"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">(Optional)</span><span class="w"> </span><span class="err">Trigger</span><span class="w"> </span><span class="err">IDE</span><span class="w"> </span><span class="err">UI</span><span class="w"> </span><span class="err">actions</span><span class="w"> </span><span class="err">tied</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">workspace</span><span class="w"> </span><span class="err">events</span><span class="w">
   </span><span class="nt">"creator"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">    </span><span class="err">//</span><span class="w"> </span><span class="err">(Optional)</span><span class="w"> </span><span class="err">Identifying</span><span class="w"> </span><span class="err">information</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">author</span><span class="w">
 </span><span class="err">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>The <code class="highlighter-rouge">factory.workspace</code> is identical to the <code class="highlighter-rouge">workspace:{}</code> object for Eclipse Che and contains the structure of the workspace. Learn more about <a href="../../../docs/devops/workspaces-data-model/index.html">the workspace JSON object</a>.</p>

 <p>You can export Che workspaces and then reuse the workspace definition within a Factory. Che workspaces are composed of:</p>
 <ul>
   <li>0..n projects</li>
   <li>0..n environments which contain machines to run the code</li>
   <li>0..n commands to execute against the code and machines</li>
   <li>a type</li>
 </ul>

 <p>The <code class="highlighter-rouge">factory.policies</code>, <code class="highlighter-rouge">factory.ide</code> and <code class="highlighter-rouge">factory.creator</code> objects are unique to Factories. They provide meta information to the automation engine that alter the presentation of the Factory URL or the behavior of the provisioning.</p>

 <h2 id="gotchas">Gotchas</h2>
 <p>A few rules to remember when creating Factories:</p>
 <ul>
   <li>The linux distro you use needs to support rsync’s <code class="highlighter-rouge">--usermap</code> parameter, some older distros (like Debian Wheezy don’t).</li>
   <li>Any users created in your Dockerfile must have no password set for the SSH keys.</li>
 </ul>

 <h2 id="mixins">Mixins</h2>
 <p>A mixin adds additional behaviors to a project as a set of new project type attributes.  Mixins are reusable across any project type. You define the mixins to add to a project by specifying an array of strings, with each string containing the identifier for the mixin.  For example, <code class="highlighter-rouge">"mixins" : [ "pullrequest" ]</code>.</p>

 <table>
   <thead>
     <tr>
       <th>Mixin ID</th>
       <th>Description</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <td><code class="highlighter-rouge">pullrequest</code></td>
       <td>Enables pull request workflow where Che handles local &amp; remote branching, forking, and pull request issuance. Pull requests generated from within Che have another Factory placed into the comments of pull requests that a PR reviewer can consume. Adds contribution panel to the IDE. If this mixin is set, then it uses attribute values for <code class="highlighter-rouge">project.attributes.local_branch</code> and <code class="highlighter-rouge">project.attributes.contribute_to_branch</code>. <br /><br /> The <code class="highlighter-rouge">pullrequest</code> mixin requires additional configuration from the <code class="highlighter-rouge">attributes</code> object of the project.  If present, Che will use the project attributes as defined in the Factory. If not provided, Che will set defaults for the attributes. <br /><br /> Learn more about other mixins, on [<code class="highlighter-rouge">project : {}</code> object for Eclipse Che]/docs/assemblies/sdk-rest-apis/index.html</td>
     </tr>
   </tbody>
 </table>

 <h2 id="pull-request-mixin-attributes">Pull Request Mixin Attributes</h2>
 <p>Project attributes alter the behavior of the IDE or workspace.</p>

 <p>Different Eclipse Che and Codenvy plug-ins can add their own attributes to affect the behavior for the system.  Attribute configuration is always optional and if not provided within a Factory definition, the system will set itself.</p>

 <table>
   <thead>
     <tr>
       <th>Attribute</th>
       <th>Description</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <td><code class="highlighter-rouge">local_branch</code></td>
       <td>Used in conjunction with the <code class="highlighter-rouge">pullrequest</code> mixin. If provided, the local branch for the project is set with this value. If not provided, then the local branch is set with the value of <code class="highlighter-rouge">project.source.parameters.branch</code> (the name of the branch from the remote).  If <code class="highlighter-rouge">local_branch</code> and <code class="highlighter-rouge">project.source.parameters.branch</code> are both not provided, then the local branch is set to the name of the checked out branch.</td>
     </tr>
     <tr>
       <td><code class="highlighter-rouge">contribute_to_branch</code></td>
       <td>Name of the branch that a pull request will be contributed to. Default is the value of <code class="highlighter-rouge">project.source.parameters.branch</code>, which is the name of the branch this project was cloned from.</td>
     </tr>
   </tbody>
 </table>

 <p><br />
 Here is a snippet that demonstrates full configuration of the contribution mixin.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">factory.workspace.project</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"mixins"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"pullrequest"</span><span class="w"> </span><span class="p">],</span><span class="w">

   </span><span class="nt">"attributes"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"local_branch"</span><span class="w">         </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"timing"</span><span class="w"> </span><span class="p">],</span><span class="w">
     </span><span class="nt">"contribute_to_branch"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"master"</span><span class="w"> </span><span class="p">]</span><span class="w">
   </span><span class="p">},</span><span class="w">

   </span><span class="nt">"source"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"type"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="s2">"git"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"location"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.com/codenvy/che.git"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"parameters"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="nt">"keepVcs"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"true"</span><span class="w">
     </span><span class="p">}</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h2 id="policies">Policies</h2>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">factory.policies</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"referer"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">               </span><span class="err">//</span><span class="w"> </span><span class="err">Works</span><span class="w"> </span><span class="err">only</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">clients</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">referer</span><span class="w">
   </span><span class="nt">"since"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="err">EPOCHTIME</span><span class="p">,</span><span class="w">            </span><span class="err">//</span><span class="w"> </span><span class="err">Factory</span><span class="w"> </span><span class="err">works</span><span class="w"> </span><span class="err">only</span><span class="w"> </span><span class="err">after</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">date</span><span class="w">
   </span><span class="nt">"until"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="err">EPOCHTIME</span><span class="p">,</span><span class="w">            </span><span class="err">//</span><span class="w"> </span><span class="err">Factory</span><span class="w"> </span><span class="err">works</span><span class="w"> </span><span class="err">only</span><span class="w"> </span><span class="err">before</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">date</span><span class="w">
   </span><span class="nt">"create"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">perClick</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="err">perUser</span><span class="p">]</span><span class="w">  </span><span class="err">//</span><span class="w"> </span><span class="err">Create</span><span class="w"> </span><span class="err">one</span><span class="w"> </span><span class="err">workpace</span><span class="w"> </span><span class="err">per</span><span class="w"> </span><span class="err">click</span><span class="p">,</span><span class="w"> </span><span class="err">user</span><span class="w"> </span><span class="err">or</span><span class="w"> </span><span class="err">account</span><span class="w">
 </span><span class="err">}</span><span class="w">
 </span></code></pre>
 </div>

 <h3 id="limitations">Limitations</h3>
 <p>You can use <code class="highlighter-rouge">since : EPOCHTIME</code>, <code class="highlighter-rouge">until : EPOCHTIME</code> and <code class="highlighter-rouge">referer</code> as a way to prevent the Factory from executing under certain conditions.  <code class="highlighter-rouge">since</code> and <code class="highlighter-rouge">until</code> represent a valid time window that will allow the Factory to activate. The <code class="highlighter-rouge">referer</code> will check the hostname of the acceptor and only allow the Factory to execute if there is a match.</p>

 <h3 id="multiplicity">Multiplicity</h3>
 <p>If <code class="highlighter-rouge">create : perClick</code> is used, then every click of the Factory URL will generate a new workspace, each with its own identifier, name and resources.  If <code class="highlighter-rouge">create : perUser</code> is used, then only one workspace will be generated for each unique user that clicks on the Factory URL. If the workspace has previously been generated, we will reopen the existing workspace.</p>

 <h2 id="ide-customization">IDE Customization</h2>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">factory.ide.</span><span class="p">{</span><span class="err">event</span><span class="p">}</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">          </span><span class="err">//</span><span class="w"> </span><span class="err">event</span><span class="w"> </span><span class="err">=</span><span class="w"> </span><span class="err">onAppLoaded,</span><span class="w"> </span><span class="err">onProjectsLoaded,</span><span class="w"> </span><span class="err">onAppClosed</span><span class="w">
   </span><span class="nt">"actions"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[{}]</span><span class="w">               </span><span class="err">//</span><span class="w"> </span><span class="err">List</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">IDE</span><span class="w"> </span><span class="err">actions</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">execute</span><span class="w"> </span><span class="err">when</span><span class="w"> </span><span class="err">event</span><span class="w"> </span><span class="err">triggered</span><span class="w">
 </span><span class="p">}</span><span class="w">

 </span><span class="err">factory.ide.</span><span class="p">{</span><span class="err">event</span><span class="p">}</span><span class="err">.actions</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">[{</span><span class="w">
   </span><span class="nt">"id"</span><span class="w">         </span><span class="p">:</span><span class="w"> </span><span class="err">String</span><span class="p">,</span><span class="w">         </span><span class="err">//</span><span class="w"> </span><span class="err">Action</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">IDE</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">perform</span><span class="w"> </span><span class="err">when</span><span class="w"> </span><span class="err">event</span><span class="w"> </span><span class="err">triggered</span><span class="w">
   </span><span class="err">properties</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">                </span><span class="err">//</span><span class="w"> </span><span class="err">Properties</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">customize</span><span class="w"> </span><span class="err">action</span><span class="w"> </span><span class="err">behavior</span><span class="w">
 </span><span class="p">}]</span><span class="w">
 </span></code></pre>
 </div>
 <p>You can instruct the Factory to invoke a series of IDE actions based upon events in the lifecycle of the workspace.</p>

 <dl>
   <dt><code class="highlighter-rouge">onAppLoaded</code></dt>
   <dd>Triggered when the IDE is loaded.</dd>
   <dt><code class="highlighter-rouge">onProjectsLoaded</code></dt>
   <dd>Triggered when the workspace and all projects have been activated/imported.</dd>
   <dt><code class="highlighter-rouge">onAppClosed</code></dt>
   <dd>Triggered when the IDE is closed.</dd>
 </dl>

 <p>This is an example that associates a variety of actions with all of the events.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"ide"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"onProjectsLoaded"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">                </span><span class="err">//</span><span class="w"> </span><span class="err">Actions</span><span class="w"> </span><span class="err">triggered</span><span class="w"> </span><span class="err">when</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">is</span><span class="w"> </span><span class="err">opened</span><span class="w">
     </span><span class="nt">"actions"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">[{</span><span class="w">
       </span><span class="nt">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"openFile"</span><span class="p">,</span><span class="w">                </span><span class="err">//</span><span class="w"> </span><span class="err">Opens</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">file</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">editor.</span><span class="w"> </span><span class="err">Can</span><span class="w"> </span><span class="err">add</span><span class="w"> </span><span class="err">multiple</span><span class="w">
       </span><span class="nt">"properties"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">                  </span><span class="err">//</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">file</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">open</span><span class="w"> </span><span class="err">(include</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">name)</span><span class="w">
         </span><span class="nt">"file"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"/my-project/pom.xml"</span><span class="w">
       </span><span class="p">}</span><span class="w">
     </span><span class="p">},</span><span class="w">
     </span><span class="p">{</span><span class="w">
       </span><span class="nt">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"runCommand"</span><span class="p">,</span><span class="w">              </span><span class="err">//</span><span class="w"> </span><span class="err">Launch</span><span class="w"> </span><span class="err">command</span><span class="w"> </span><span class="err">after</span><span class="w"> </span><span class="err">IDE</span><span class="w"> </span><span class="err">opens</span><span class="w">
       </span><span class="nt">"properties"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
         </span><span class="nt">"name"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"MCI"</span><span class="w">                  </span><span class="err">//</span><span class="w"> </span><span class="err">Command</span><span class="w"> </span><span class="err">name</span><span class="w">
       </span><span class="p">}</span><span class="w">
     </span><span class="p">}</span><span class="w">
   </span><span class="p">]},</span><span class="w">
   </span><span class="nt">"onAppLoaded"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
      </span><span class="nt">"actions"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
         </span><span class="p">{</span><span class="w">
            </span><span class="nt">"properties:{
               "</span><span class="err">greetingTitle</span><span class="nt">": "</span><span class="err">Getting</span><span class="w"> </span><span class="err">Started</span><span class="nt">",			// Title of a Welcome tab
               "</span><span class="err">greetingContentUrl</span><span class="nt">": "</span><span class="err">http</span><span class="p">:</span><span class="err">//example.com/README.html</span><span class="s2">"	// HTML to be loaded into a tab
            },
            "</span><span class="err">id</span><span class="s2">": "</span><span class="err">openWelcomePage</span><span class="s2">"
         }
      ]
   },
   "</span><span class="err">onAppClosed</span><span class="s2">" : {                     // Actions to be triggered when IDE is closed
     "</span><span class="err">actions</span><span class="s2">" : [{
       "</span><span class="err">id</span><span class="s2">" : "</span><span class="err">warnOnClose"</span><span class="w">              </span><span class="err">//</span><span class="w"> </span><span class="err">Show</span><span class="w"> </span><span class="err">warning</span><span class="w"> </span><span class="err">when</span><span class="w"> </span><span class="err">closing</span><span class="w"> </span><span class="err">browser</span><span class="w"> </span><span class="err">tab</span><span class="w">
     </span><span class="p">}]</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>
 <p>Each event type has a set of actions that can be triggered. There is no ordering of actions executed when you provide a list; Che will asynchronously invoke multiple actions if appropriate. Some actions can be configured in how they perform and will have an associated <code class="highlighter-rouge">properties : {}</code> object.</p>

 <h6 id="onprojectsloaded-event">onProjectsLoaded Event</h6>

 <table>
   <thead>
     <tr>
       <th>Action</th>
       <th>Properties?</th>
       <th>Description</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <td><code class="highlighter-rouge">runCommand</code></td>
       <td>Yes</td>
       <td>Specify the name of the command to invoke after the IDE is loaded. Specify the commands in the <code class="highlighter-rouge">factory.workspace.commands : []</code> array.</td>
     </tr>
     <tr>
       <td><code class="highlighter-rouge">openFile</code></td>
       <td>Yes</td>
       <td>Open project files as a tab in the editor.</td>
     </tr>
   </tbody>
 </table>

 <h6 id="onapploaded-event">onAppLoaded Event</h6>

 <table>
   <thead>
     <tr>
       <th>Action</th>
       <th>Properties?</th>
       <th>Description</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <td><code class="highlighter-rouge">openWelcomePage</code></td>
       <td>Yes</td>
       <td>Customize the content of the welcome panel when the workspace is loaded. Note that browsers block http resources that are loaded into https pages.</td>
     </tr>
   </tbody>
 </table>

 <h6 id="onappclosed-event">onAppClosed Event</h6>

 <table>
   <thead>
     <tr>
       <th>Action</th>
       <th>Properties?</th>
       <th>Description</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <td><code class="highlighter-rouge">warnOnClose</code></td>
       <td>No</td>
       <td>Opens a warning popup when the user closes the browser tab with a project that has uncommitted changes. Requires <code class="highlighter-rouge">project.parameters.keepVcs</code> to be <code class="highlighter-rouge">true</code>.</td>
     </tr>
   </tbody>
 </table>

 <h4 id="action-open-file">Action: Open File</h4>
 <p>This action will open a file as a tab in the editor. You can provide this action multiple times to have multiple files open. The file property is a relative reference to a file in the project’s source tree. The <code class="highlighter-rouge">file</code> parameter is the relative path within the workspace to the file that should be opened by the editor. The <code class="highlighter-rouge">line</code> parameter is optional and can be used to move the editor cursor to a specific line when the file is opened. Note that projects are located in the workspaces <code class="highlighter-rouge">/projects</code> folder.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
   </span><span class="nt">"id"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"openFile"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"properties"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
       </span><span class="nt">"file"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"/my-project/pom.xml"</span><span class="p">,</span><span class="w">
       </span><span class="nt">"line"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">"50"</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h4 id="action-find-and-replace">Action: Find and Replace</h4>
 <p>If you create a project from a factory, you can have Che perform a find / replace on values in the imported source code after it is imported into the project tree. This essentially lets you parameterize your source code. Find and replace can be run as a <strong>Run Command</strong> during <code class="highlighter-rouge">onProjectsLoaded</code> event. You can use <code class="highlighter-rouge">sed</code>, <code class="highlighter-rouge">awk</code> or any other tools that are available in your workspace environment.</p>

 <p>Define a command for your workspace in <code class="highlighter-rouge">factory.workspace.workspaceConfig.commands</code>:</p>

 <div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
   </span><span class="nt">"commandLine"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sed -i 's/***/userId984hfy6/g' /projects/console-java-simple/README.md"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"replace"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
     </span><span class="nt">"goal"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Common"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="w">
   </span><span class="p">},</span><span class="w">
   </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"custom"</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>In this example, we have created a named command <code class="highlighter-rouge">replace</code> which replaces <code class="highlighter-rouge">***</code> with a string in project’s README.md.</p>

 <p>Then register this command to the execution list linked to <code class="highlighter-rouge">onProjectsLoaded</code> event. In this example, <code class="highlighter-rouge">replace</code> command is executed after project is imported into a workspace:</p>

 <div class="highlighter-rouge"><pre class="highlight"><code>"ide": {
     "onProjectsLoaded": {
       "actions": [
         {
           "properties": {
             "name": "replace"
           },
           "id": "runCommand"
         }
       ]
     }
   }
 </code></pre>
 </div>

 <p>Use <a href="https://www.gnu.org/software/sed/manual/html_node/Regular-Expressions.html">regular expressions</a> in sed, both in find/replace and file/file types patterns.</p>

 <h2 id="creator">Creator</h2>
 <p>This object has meta information that you can embed within the Factory. These attributes do not affect the automation behavior or the behavior of the generated workspace.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">factory.creator</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"name"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">                </span><span class="err">//</span><span class="w"> </span><span class="err">Name</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">author</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">configuration</span><span class="w"> </span><span class="err">file</span><span class="w">
   </span><span class="nt">"email"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">                </span><span class="err">//</span><span class="w"> </span><span class="err">Email</span><span class="w"> </span><span class="err">address</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">author</span><span class="w">
   </span><span class="nt">"created"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="err">EPOCHTIME</span><span class="p">,</span><span class="w">             </span><span class="err">//</span><span class="w"> </span><span class="err">Set</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">system</span><span class="w">
   </span><span class="nt">"userId"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="w">                 </span><span class="err">//</span><span class="w"> </span><span class="err">Set</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">system</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>Eclipse Che does not provide user management capabilities, the <code class="highlighter-rouge">factory.creator</code> is always bound to a simulated <code class="highlighter-rouge">Che</code> user.</p>


         </article>
       </div>

       <div class="unit one-fifth hide-on-mobiles">
   <aside>


     <h4>SETUP</h4>


 <ul>


     <li class=""><a href="../../../docs/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</a></li>


     <li class=""><a href="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</a></li>


     <li class=""><a href="../../../docs/setup/configuration/index.html">Configuration</a></li>


     <li class=""><a href="../../../docs/setup/managing/index.html">Managing</a></li>


     <li class=""><a href="../../../docs/setup/cli/index.html">CLI Reference</a></li>


     <li class=""><a href="../../../docs/setup/glossary/index.html">Glossary</a></li>


     <li class=""><a href="../../../docs/setup/docker/index.html">Docker Installation</a></li>


     <li class=""><a href="../../../docs/setup/openshift/index.html">OpenShift Installation</a></li>


     <li class=""><a href="../../../docs/setup/selenium/index.html">How to run selenium tests</a></li>


 </ul>


     <h4>WORKSPACE ADMINISTRATION</h4>


 <ul>


     <li class=""><a href="../../../docs/devops/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</a></li>


     <li class=""><a href="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</a></li>


     <li class=""><a href="../../../docs/devops/project-samples/index.html">Project Samples</a></li>


     <li class=""><a href="../../../docs/devops/runtime-machines/index.html">Runtime Machines</a></li>


     <li class=""><a href="../../../docs/devops/volume-mounts/index.html">Volume Mounts</a></li>


     <li class=""><a href="../../../docs/devops/ws-agents/index.html">Workspace Agents</a></li>


     <li class=""><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</a></li>


     <li class=""><a href="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</a></li>


 </ul>


     <h4>USER GUIDE</h4>


 <ul>


     <li class=""><a href="../../../docs/ide/projects/index.html">Projects</a></li>


     <li class=""><a href="../../../docs/ide/import-a-project/index.html">Import</a></li>


     <li class=""><a href="../../../docs/ide/ssh/index.html">SSH</a></li>


     <li class=""><a href="../../../docs/ide/sync/index.html">Local IDE Sync</a></li>


     <li class=""><a href="../../../docs/ide/editor-settings/index.html">Editor</a></li>


     <li class=""><a href="../../../docs/ide/intellisense/index.html">Intellisense</a></li>


     <li class=""><a href="../../../docs/ide/commands/index.html">Commands</a></li>


     <li class=""><a href="../../../docs/ide/git-svn/index.html">Git and SVN</a></li>


     <li class=""><a href="../../../docs/ide/previews/index.html">Previews</a></li>


     <li class=""><a href="../../../docs/ide/build/index.html">Build</a></li>


     <li class=""><a href="../../../docs/ide/run/index.html">Run</a></li>


     <li class=""><a href="../../../docs/ide/sharing/index.html">Share</a></li>


     <li class=""><a href="../../../docs/ide/debug/index.html">Debug</a></li>


     <li class=""><a href="../../../docs/ide/docker/index.html">Docker</a></li>


     <li class=""><a href="../../../docs/ide/electron/index.html">Install Che Desktop Client</a></li>


 </ul>


     <h4>PORTABLE WORKSPACES</h4>


 <ul>


     <li class=""><a href="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</a></li>


     <li class=""><a href="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</a></li>


     <li class=""><a href="../../../docs/chedir/installation/index.html">Chedir - Installation</a></li>


     <li class=""><a href="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</a></li>


     <li class=""><a href="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</a></li>


     <li class=""><a href="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</a></li>


     <li class=""><a href="../../../docs/chedir/ssh/index.html">Chedir - SSH</a></li>


     <li class=""><a href="../../../docs/chedir/factories/index.html">Chedir - Factories</a></li>


     <li class=""><a href="../../../docs/factory/getting-started/index.html">Factory - Getting Started</a></li>


     <li class=""><a href="../../../docs/factory/creating/index.html">Factory - Creating</a></li>


     <li class="current"><a href="../../../docs/factory/json-reference/index.html">Factory - JSON Reference</a></li>


 </ul>


     <h4>DEVELOPER GUIDE - REST API</h4>


 <ul>


     <li class=""><a href="../../../docs/assemblies/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/assemblies/archetype/index.html">Archetype</a></li>


     <li class=""><a href="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-services/index.html">SDK Services</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</a></li>


 </ul>


   </aside>
 </div>


       <div class="clear"></div>

     </div>
   </section>


   <script>
   var anchorForId = function (id) {
     var anchor = document.createElement("a");
     anchor.className = "header-link";
     anchor.href      = "#" + id;
     anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
     anchor.title = "Permalink";
     return anchor;
   };

   var linkifyAnchors = function (level, containingElement) {
     var headers = containingElement.getElementsByTagName("h" + level);
     for (var h = 0; h < headers.length; h++) {
       var header = headers[h];

       if (typeof header.id !== "undefined" && header.id !== "") {
         header.appendChild(anchorForId(header.id));
       }
     }
   };

   document.onreadystatechange = function () {
     if (this.readyState === "complete") {
       var contentBlock = document.getElementsByClassName("artik")[0] || document.getElementsByClassName("openshift")[0] || document.getElementsByClassName("tutorials")[0] || document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
       if (!contentBlock) {
         return;
       }
       for (var level = 1; level <= 6; level++) {
         linkifyAnchors(level, contentBlock);
       }
     }
   };
 </script>


 </body>
 </html>