Factory Parameter Reference

Factories can be created by constructing a non-encoded URL, using our REST API to create an encoded Factory, or by using our CLI. All techniques use the same parameter names and types. If parameters are entered incorrectly, they will be ignored.

Current Version: 1.2

NameValueTypeDescription
v1.2MandatoryVersion for Codenvy Factory API.
VCS Attributes
vcsSTRINGMandatoryVersion Control System used. Currently, "git" is the only available value for VCS. Subversion shipping in Q214.
vcsurlURLMandatoryLocation of source code in a Version Control System. Can be either source from a Codenvy workspace or external code repository sources.

Example: http%3A%2F%2Fcodenvy.com
%2Fgit%2F16%2F81%2F89%2F
workspacepyk15s4hwbfabmg6%
2FHelloSpringMVC
vcsbranchSTRINGOptionalBranch used to clone project source files. The checkout precedence is "vcsbranch" then "commitid". If neither are provided, then a checkout from "master".

Example: test-branch
commitidSTRINGOptionalLatest commit ID of code repository. The checkout precedence is "vcsbranch" then "commitid". If neither are provided, then a checkout from "master".

Example: ba47069d81ad51155aad288dc1dd938f38028e0a
vcsinfoBOOLEANOptionalIf true, the IDE will have the VCS menu pre-populated with the VCS configuration and history from the source project. We will pick up remotes and branches, simplifying the effort to push back to the source repository.
git.configremoteoriginfetchSTRINGOptionalAllows getting ref-specs of remote repository changes. This is used in situations where you want to grab code that is part of a patch set as part of gerrit vs. a normal branch.

Example: changes/41/1841/1
Post-Loading
actionENUM

Accepted Values:
openproject
OptionalThis value indicates actions to be performed after a temporary workspace has been created.
openfileSTRINGOptionalFile name and path to a file that is contained within the project space of the temporary workspace to be opened after a temporary workspace is created.

Example: pom.xml
src/main/java/myclass.java
Project Attributes
projectattributes.pname STRINGOptionalThe text name of the Project as you want it to appear in the IDE after the workspace is loaded. If you are using this property as a non-encoded parameter, then you must use the dot notation, "projectattributes.pname=". However, if this is part of an encoded Factory supplied by JSON, then this property is an embedded JSON object. You can see an example at our GitHub factory repository.

Example: "projectattributes": {
"pname":"SpringDemo",
"ptype":"Spring"
}
projectattributes.ptypeENUM

Accepted Values:
PHP
War
Servlet/JSP
Jar
JavaScript
Python
Rails
Spring
Maven+Multi-Module
Nodejs
Android
OptionalThe project type of the loaded project. This project type gives Codenvy instructions on what kind of builder system to use with the project, and also instructions on the type of image that needs to be created to host the project after it is executed.
styleENUM

Accepted Values:
"Advanced with Counter"
"Advanced"
"Dark"
"Vertical,Dark"
"Horizontal,Dark"
"White"
"Vertical,White"
"Horizontal,White"
Optional
Encoded only
This applies a Codenvy styling to an icon that you load or will auto generate a new Codenvy counter icon. For an explanation of the different values and what they produce, visit Factory Icon Design
descriptionSTRINGOptional
Encoded only
Project description. Provided for query systems and other programs that want to dynamically collect Factory information. Can be any text.
contactmailSTRINGOptionalAuthor's email provided as meta information.
authorSTRINGOptionalAuthor's name provided as meta information.
createdTIME_IN_EPOCHOptional
Encoded only
Creation time of a Factory, set by the server (in milliseconds, from Unix epoch, no timezone).

Example: 1388705917
useridSTRINGOptional
Encoded only
Automatically set by a server.

Example: user54ghty654
affiliateidSTRINGOptionalAffiliate ID provided by Codenvy.

Example: affiliate12345678
orgidSTRINGOptional
Tracked Factories Only
Organisation ID provided by Codenvy for Tracked Factory accounts. orgid is used to track Factory activity across a group of Factories. A valid orgid is required for any parameter labeled "Tracked Factories Only".

Example: organisation1234567
variablesJSONOptional
Tracked Factories Only
This variable is used to configure a paramaeterized factory. The JSON object can specify which files should be searched, which parameters to find, and what values to replace them with. This all happens post-load of a Factory. For complete examples and specification see Parameterized Factories
welcomeJSONOptional
Tracked Factories Only
Encoded Only
When creating a Factory, users can specify custom HTML that will be loaded in the Welcome pane that appears on the right of the IDE in a temporary workspace. Different welcome screens can be created if the user in the temporary workspace is anonymous or Codenvy authenticated. Resources include customer Title, Icon and Content of a Welcome Screen.

Example:
"welcome":{
"authenticated": {
"title": "Greeting title for authenticated users",
"iconurl": "http://example.com/icon.png",
"contenturl": "http://example.com/Custom.html"
},
"nonauthenticated": {
"title": "Greeting title for nonauthenticated users",
"iconurl": "http://example.com/icon_1.png",
"contenturl": "http://example.com/custom_1.html"
}
Policies
restriction.refererhostnameSTRINGOptional
Tracked Factories only
Restriction imposed by a Factory owner, so that only referrers from a particular host can use a Factory.

Example: stackoverflow.com
In this case, a Factory will be valid only for users who clicked on a Factory button published on this site.
restriction.validsinceTIME_IN_EPOCHOptional
Tracked Factories only
Specify the time in which this Factory will be activated. If a Factory is clicked by a user before this date, the user will be given a graceful error and prevented from accessing the Factory.

Example: 1388705917
restriction.validuntilTIME_IN_EPOCHOptional
Tracked Factories only
Specify the time in which this Factory will be deactivated. If a Factory is clicked by a user after this date, the user will be given a graceful error and prevented from accessing the Factory.

Example: 1388705917

Older Versions:
Factory 1.1
Factory 1.0