Description
This method creates a project in Unifier either based on a template or an existing project. This method is enhanced to have additional options to support copying of modules and address information from template or project.
Support
This method can only support creation of project.
Installation: ASP and Self host
Level | Yes or No |
|---|---|
Company Level | Yes |
Project Level | Not Applicable |
Prototype
public XMLObject createProject(String shortname, String authcode, String copyFromProject, String projectXML);
Parameters
Parameter | Description |
|---|---|
Shortname | identifier of the company, company’s short name |
Authcode | authentication key for the company, in text string |
copyFromProject | this can be another project number or a template number. |
projectXML | content of the project that needs to be created. |
projectXML Elements
Tag Name | Required | Description | Valid values |
|---|---|---|---|
<project_info> | Yes | Base tag for new project data. Only one project can be created at a time. |
|
<projectnumber> | Yes | Project number of the new project that is getting created. If this project number already exists you will get an error. | User defined number. |
<projectname> | Yes | Project name of the new project that is getting created. If this project name already exists you will get an error. | User defined name. |
<constructiontype> | No | Type of construction (New Construction or Retrofit/Remodel). | New Construction: 1 Retrofit/Remodel: 0 |
<status> | No | Status of the Project (Active, Inactive, On-Hold) | Active: 1 Inactive: 0 On-Hold: 2 |
<typeofproject> | No | Type of Project. Values are based on the user dataset for "Project Type" data definition |
|
<projectsite> | No | Project site. Values are based on the user dataset for "Project Site" data definition |
|
<startdate> | No | Start Date of the project. |
|
<plannedcompletion> | No | Planned Completion date |
|
<revisedcompletion> | No | Revised Completion date |
|
<designcomplete> | No | Design % complete |
|
<constrcomplete> | No | Construction % complete |
|
<notes> | No | Notes |
|
<schedulestatus> | No | Schedule status of the project | On Schedule and on Budget: 0 Potential impact on schedule or both: 1 Impact to schedule or Budget or both: 2 |
<projectphase> | No | Project phase information. Values are based on the user dataset for "Project Phase" data definition |
|
<description> | No | Description of the project |
|
<location> | No | Base tag for project location information | This is a new tag added for this enhancement. This tag is optional. If this tag is not provided then Primavera Unifier will create Project by copying "Project Address" information from template. |
<address> | No | Base tag for address information | This tag can be repeated to provide multiple address types |
<address1> | Yes | Address 1 field of the project | Is child element of <address> element. This element is required if address tag is provided |
<address2> | No | Address 2 field of the project | Is child element of <address> element |
<city> | Yes | City field of the project | Is child element of <address> element. This element is required if address tag is provided |
<state> | Yes | State field of the project | Is child element of <address> element. This element is required if address tag is provided |
<country> | Yes | Country field of the project | Is the child element of <address> element. This element is required if the address tag is provided. The value comes from the Return Values > Country. The User must send in Label as a valid value |
<phone> | No | Phone field of the project | Is child element of <address> element |
<fax> | No | Fax filed of the project | Is child element of <address> element |
<addresstype> | Yes | Type of address | Is child element of <address> element Following are the valid values for this element
|
<options> | No | Base tag for options. | This is a new tag added for this enhancement. This tag is optional. If this tag is not provided then Primavera Unifier will create Project by copying user / groups from another project or template. |
<copyModules> | No | Option to either copy modules or not. | This tag can only go as a child element under <options> tag. This tag is identify either to create a new project by copying all modules including user / group or just creates a new project by copying user / group from another project or template. Only valid values are Yes / No. Yes means copy all modules including user / groups. No means copy only user / groups. If tag is not provided or value is empty then default behavior will be to create project by copying user / groups. |
<projectCurrency> | No | Option to specify the project currency | A new child element of <projectCurrency> will be available within the existing <options> tag. Valid values for this tag are the code for the currency rather than the names. For example, USD is valid, United States Dollars is not. If the code is not a valid code then the web service will fail. If the tag is provided and the value is empty then template code will be selected. |
Note: If you do not provide values for elements that are not required then the values from template will be used to create new project.
Return Value
See Return Values. Message will contain new Project number and name that is created within Unifier.
Sample Method
createProject ("acme", "acme_authcode", "Proj-001", "<XML Content>")
Additional Information
If a new project is created by copying from a Template or another existing Project then users and groups will be copied by default along with permissions.
Address information provided through XML tags is of type Project Address, Billing, Shipping and Billing and Shipping.
For a list of valid country names, see Currency.
If a company is configured to have auto numbering for projects then any information send through integration for projectnumber tag will be ignored and system will provide a number automatically based on sequence.
This service can be used create Project (Standard).