ProjectGeneralData

Description

The ProjectGeneralData type holds the name and other information about a project in SBM. The ProjectGeneralData type parameters are listed below.

Parameters

Name	Type	Description
project	ProjectIdentifier	Specifies the project that is created.
parentProject	ProjectIdentifier	Specifies the new project's parent project.
workflow	WorkflowIdentifier	Specifies the new project's parent workflow.
useParentProjectWorkflow	boolean	Determines if the project uses the parent project's workflow. Default is true if parent is not Base Project. Default is false if parent is Base Project.
projectSequence	integer	Indicates the sequence of the project in the order of siblings.
allowSubmit	boolean	Indicates whether or not the project allows items to be submitted.
useParentSequenceNumbers	boolean	Determines if items submitted to the new project are numbered in sequence with items in the parent project. False means the new project will number its items independently of items in the parent project. Default is true.
lastItemSequenceNumber	integer	The next item submitted to the new project will be numbered one greater than this number. 0 means the first item will be numbered 1. Default is 0. Ignored if useParentSequenceNumbers is true.
zeroToFill	integer	Zero-fill item numbers within the project to a certain number of digits. For example, 5 would fill to five digits: 00001. Default is 5. Ignored if useParentSequenceNumbers is true.
allowAnonymousSubmit	boolean	Indicates whether or not the project allows items to be submitted anonymously.
altName	string	Alternate project name to display to users who do not have view privileges on the project. Default is same as projectName.
description	string	The description of the project. Derived from the TS_DESCRIPTION column in TS_PROJECTS.

Usage

The ProjectGeneralData type holds information that completely describes a project that you create using CreateProject. For more information, see CreateProject.

XML

The following XML snippet shows the ProjectGeneralData type in the return element of the CreateProject response.

<ae:return>
   <ae:project xsi:type="ae:ProjectIdentifier">
      <ae:displayName/>
      <ae:id>0</ae:id>
      <ae:uuid/>
      <ae:fullyQualifiedName/>
      <ae:internalName/>
   </ae:project>
   <ae:parentProject xsi:type="ae:ProjectIdentifier">
      <ae:displayName>Base Project</ae:displayName>
      <ae:id>1</ae:id>
      <ae:uuid>ROOTPROJECT</ae:uuid>
      <ae:fullyQualifiedName>Base Project</ae:fullyQualifiedName>
      <ae:internalName>BASE_PROJECT</ae:internalName>
   </ae:parentProject>
   <ae:workflow xsi:type="ae:WorkflowIdentifier">
      <ae:displayName>Base Workflow</ae:displayName>
      <ae:id>1</ae:id>
      <ae:uuid>BASEWORKFLOW</ae:uuid>
   </ae:workflow>
   <ae:useParentProjectWorkflow>true</ae:useParentProjectWorkflow>
   <ae:projectSequence>2001</ae:projectSequence>
   <ae:allowSubmit>true</ae:allowSubmit>
   <ae:useParentSequenceNumbers>true</ae:useParentSequenceNumbers>
   <ae:lastItemSequenceNumber>0</ae:lastItemSequenceNumber>
   <ae:zeroFillTo>5</ae:zeroFillTo>
   <ae:allowAnonymousSubmit>false</ae:allowAnonymousSubmit>
   <ae:altName>New Project</ae:altName>
   <ae:description/>
</ae:return>