• Introduction
  • Web Service API
  • Callback service
Show / Hide Table of Contents
  • Overview
  • Concepts
    • API functionality
    • Web Service technology
    • Security
    • Accessing the services
    • Error reporting
    • Synchronous and asynchronous API
    • Testing
  • Translation memory API
    • Overview
    • ITMService
    • Lookup, concordance
    • Import, export
    • API
      • ConcordanceRequest
      • GenericFault
      • HeavyResourceInfo
      • HeavyResourceUpdateInfo
      • InlineTagStrictness
      • InvalidSessionIdFault
      • ITMService
      • LookupSegmentRequest
      • NoLicenseFault
      • RequestXmlFormatFault
      • ResourceInfo
      • ResourceListFilter
      • ResourceUpdateInfo
      • TMFault
      • TMInfo
      • TMListFilter
      • TMOptimizationPreference
      • TMUpdateInfo
      • TmxImportResult
      • UnauthorizedAccessFault
      • UnexpectedFault
  • Term bases API
    • Overview
    • ITBService
    • Import, export
      • CSV
      • TBX
      • MultiTerm
    • API
      • CreateQTermTBFromTBXSettings
      • CreateQTermTBFromTBXTaskResult
      • CSVImportResult
      • CSVImportSettings
      • GenericFault
      • HeavyResourceInfo
      • HeavyResourceUpdateInfo
      • ITasksService
      • ITBService
      • QTermTBImportSettings
      • ResourceInfo
      • ResourceListFilter
      • ResourceUpdateInfo
      • TaskDoesNotExistFault
      • TaskInfo
      • TaskNotFinishedFault
      • TaskResult
      • TaskStatus
      • TBCaseSensitivity
      • TBCloneInfo
      • TBFilter
      • TBFilterLangMode
      • TBInfo
      • TBMatching
      • TBNewTermDefaultForLanguage
      • TBUpdateInfo
      • TBXExportOptions
      • TBXExportTaskResult
      • TBXImportIntoExistingSettings
      • TBXImportResults
      • TBXImportSettings
      • TBXImportTaskResult
      • UnexpectedFault
  • LiveDocs API
    • Overview
    • ILiveDocsService
    • Alignment
    • API
      • AlignmentOptions
      • AlignmentResultInfo
      • CorpusIndexingOptions
      • CorpusIndexingSchedule
      • CorpusInfo
      • CorpusListFilter
      • CorpusUpdateInfo
      • DocumentForAlignment
      • GenericFault
      • HeavyResourceInfo
      • HeavyResourceUpdateInfo
      • ILiveDocsService
      • ImportBinaryFileIntoLiveDocsOptions
      • ImportFileIntoLiveDocsOptions
      • ImportFileIntoLiveDocsResultInfo
      • ImportLiveDocsXliffFileIntoLiveDocsOptions
      • ImportMonoOrBilingualFileIntoLiveDocsOptions
      • ResourceInfo
      • ResourceListFilter
      • ResourceUpdateInfo
      • ResultInfo
      • ResultStatus
      • UnexpectedFault
  • Light resources API
    • Overview
    • IResourceService
    • API
      • ExpectedFault
      • FilterConfigResourceInfo
      • FilterNames
      • GenericFault
      • IResourceService
      • LightResourceInfo
      • LightResourceInfoWithLang
      • LightResourceListFilter
      • PathRuleResourceInfo
      • PathRuleType
      • ProjectTemplateResourceInfo
      • ResourceInfo
      • ResourceType
      • ResourceUpdateInfo
      • UnexpectedFault
  • Server project API
    • Overview
    • User assignment
    • Omniscien Technologies services
    • IServerProjectService
    • API
      • AddProjectLanguageFault
      • AddProjectLanguageTBHandlingBehavior
      • AnalysisAsCSVResult
      • AnalysisAsCSVResultForLang
      • AnalysisOptions
      • AnalysisReportCounts
      • AnalysisReportForDocument
      • AnalysisReportInfo
      • AnalysisReportItem
      • AnalysisResultForLang
      • AnalysisResultInfo
      • AsiaOnlineBeginTranslationResultInfo
      • AsiaOnlineDomainCombination
      • AsiaOnlineGetDomainCombinationsResultInfo
      • AsiaOnlineGetLanguagePairCodeResultInfo
      • AsiaOnlineGetProjectIdsResultInfo
      • AsiaOnlineTranslateOptions
      • AsiaOnlineTranslationResultInfo
      • AsiaOnlineTranslationStatus
      • AssignmentChangeHistoryItemInfo
      • AutomatedActionStartedHistoryItemInfo
      • AutomatedActionStartedHistoryItemInfo.AutomatedActionTypes
      • BilingualDocFormat
      • CannotStartOperationFault
      • ConfirmAndUpdateDocError
      • ConfirmAndUpdateOptions
      • ConfirmAndUpdateResultInfo
      • ConfirmAndUpdateSegmentStatuses
      • ConfirmAndUpdateTaskResult
      • ConfirmAndUpdateTMBehaviors
      • ConfirmAndUpdateUserNameBehaviors
      • CreateDeliveryResult
      • CustomPreTranslateParameter
      • DeadlineChangeHistoryItemInfo
      • DeliverDocumentFault
      • DeliverDocumentRequest
      • DocDeliveryResult
      • DocDeliveryResultInfo
      • DocumentBilingualImportHistoryItemInfo
      • DocumentDeliverHistoryItemInfo
      • DocumentExportOptions
      • DocumentHistoryItemInfo
      • DocumentHistoryItemType
      • DocumentHistoryRequest
      • DocumentImportHistoryItemInfo
      • DocumentReturnHistoryItemInfo
      • DocumentRowsLockedHistoryItemInfo
      • DocumentRowsLockedHistoryItemInfo.LockModes
      • DocumentSlicingHistoryItemInfo
      • DocumentSnapshotCreatedHistoryItemInfo
      • DocumentStatus
      • DocumentXTranslationHistoryItemInfo
      • ExpectedFinalStateAfterXTranslate
      • ExpectedSourceStateBeforeXTranslate
      • FileResultInfo
      • FirstAcceptAcceptHistoryItemInfo
      • FirstAcceptAssignHistoryItemInfo
      • FirstAcceptDeclineHistoryItemInfo
      • FirstAcceptFailedHistoryItemInfo
      • FirstAcceptStatus
      • FirstAcceptUserDecision
      • GenericFault
      • GroupSourcingAssignHistoryItemInfo
      • GroupSourcingDocumentDeliverHistoryItemInfo
      • ImportImageLocalizationPackResultInfo
      • ImportTranslationDocumentOptions
      • IServerProjectService
      • ListServerProjectTranslationDocument2Options
      • ListServerProjectTranslationDocumentSliceOptions
      • ListTranslationDocumentAssignmentsOptions
      • NewRevisionScenarioOptions
      • PackageContentDocument
      • PackageContentInfo
      • PackageCreationNotAllowedFault
      • PackageDeliveryOptions
      • PackageDeliveryResult
      • PackageDeliveryResultInfo
      • PackageInfo
      • PostTransAnalysisReportForDocument
      • PostTransAnalysisReportForUser
      • PostTransAnalysisReportItem
      • PostTranslationAnalysisAsCSVResult
      • PostTranslationAnalysisAsCSVResultForLang
      • PostTranslationAnalysisOptions
      • PostTranslationAnalysisReportInfo
      • PostTranslationAnalysisResultInfo
      • PostTranslationAnalysisTaskResult
      • PostTranslationReportCounts
      • PostTranslationResultForLang
      • PreparePackageResultInfo
      • PretranslateCopySourceToTargetBehavior
      • PretranslateCopySourceToTargetConditions
      • PretranslateExpectedFinalTranslationState
      • PretranslateLookupBehavior
      • PretranslateOptions
      • PreTranslateProblem
      • PretranslateStateToConfirmAndLock
      • PreTranslateTaskResult
      • PreviewCreation
      • ProjectLaunchedHistoryItemInfo
      • QAReport
      • QAReportForDocument
      • QAReportTypes
      • ReconsolidateDocumentFault
      • ReimportDocumentOptions
      • RenameProjectFault
      • ResultInfo
      • ResultStatus
      • RtfBilingualExportOptions
      • RunQAGetReportOptions
      • RunQATaskResult
      • ServerProjectAddLanguageInfo
      • ServerProjectCommunicationSettings
      • ServerProjectConfidentialitySettings
      • ServerProjectCorporaAssignments
      • ServerProjectCreateInfo
      • ServerProjectDesktopDocsCreateInfo
      • ServerProjectInfo
      • ServerProjectListFilter
      • ServerProjectNotificationSettings
      • ServerProjectResourceAssignment
      • ServerProjectResourceAssignmentDetails
      • ServerProjectResourceAssignmentForResourceType
      • ServerProjectResourcesInPackages
      • ServerProjectRoles
      • ServerProjectStatus
      • ServerProjectTBAssignments
      • ServerProjectTBsForTargetLang
      • ServerProjectTMAssignmentDetails
      • ServerProjectTMAssignmentsForTargetLang
      • ServerProjectTranslationDocBasicInfo
      • ServerProjectTranslationDocInfo
      • ServerProjectTranslationDocInfo2
      • ServerProjectTranslationDocSliceInfo
      • ServerProjectTranslationDocumentsDifferentLanguageTranslations
      • ServerProjectTranslationDocumentsFromSameSourceFile
      • ServerProjectTranslationDocumentUserAssignments
      • ServerProjectTranslationDocumentWorkflowStatusChange
      • ServerProjectUpdateInfo
      • ServerProjectUserInfo
      • ServerProjectUserInfoHeader
      • SetDocumentWorkflowStatusFault
      • SetTranslationDocumentAssignmentsOptions
      • SliceDocumentFault
      • SliceDocumentRequest
      • SlicingMeasurementUnit
      • StatisticsAlgorithm
      • StatisticsOptions
      • StatisticsResultForLang
      • StatisticsResultFormat
      • StatisticsResultInfo
      • StatisticsTaskResult
      • SubvendorAssignDeadlineChangeHistoryItemInfo
      • SubvendorAssignHistoryItemInfo
      • TemplateBasedProjectCreateInfo
      • TemplateBasedProjectCreationFault
      • TemplateBasedProjectCreationInvalidMetaFault
      • TemplateBasedProjectCreationResultInfo
      • TranslationDocExportResultInfo
      • TranslationDocImportResultInfo
      • TranslationDocumentAssigneeInfo
      • TranslationDocumentAssignmentFault
      • TranslationDocumentAssignmentInfo
      • TranslationDocumentAssignmentResultInfo
      • TranslationDocumentAssignments
      • TranslationDocumentAssignmentType
      • TranslationDocumentDetailedAssignmentInfo
      • TranslationDocumentDetailedAssignments
      • TranslationDocumentDetailedFirstAcceptAssignmentInfo
      • TranslationDocumentDetailedGroupSourcingAssignmentInfo
      • TranslationDocumentDetailedRoleAssignmentInfo
      • TranslationDocumentDetailedSingleUserAssignmentInfo
      • TranslationDocumentDetailedSubvendorAssignmentInfo
      • TranslationDocumentFirstAcceptAssignmentInfo
      • TranslationDocumentFirstAcceptUserInfo
      • TranslationDocumentGroupSourcingAssignmentInfo
      • TranslationDocumentGroupSourcingUserInfo
      • TranslationDocumentNoUserAssignmentInfo
      • TranslationDocumentRoleAssignmentInfo
      • TranslationDocumentRoleAssignmentResultInfo
      • TranslationDocumentSingleUserAssignmentInfo
      • TranslationDocumentSubvendorAssignmentInfo
      • TranslationDocumentUserRoleAssignment
      • TranslationDocumentUserRoleAssignmentDetails
      • TwoColumnRtfBilingualExportOptions
      • UnexpectedFault
      • UpdateWithTableRtfOptions
      • UserInfoHeader
      • WorkflowStatus
      • WorkflowStatusChangeHistoryItemInfo
      • WorkingTMsDeletedHistoryItemInfo
      • WrapUpProjectFault
      • XliffBilingualExportOptions
      • XTranslateDocInfo
      • XTranslateDocumentResult
      • XTranslateOptions
      • XTranslateResultInfo
      • XTranslateScenario
      • XTranslateTaskResult
  • Security API
    • Overview
    • Users, groups, permissions
    • Session management
    • ISecurityService
    • API
      • GenericFault
      • GroupInfo
      • ISecurityService
      • ObjectPermission
      • UnexpectedFault
      • UserInfo
      • UserPackageWorkflowType
  • File upload/download API
    • Overview
    • IFileManagerService
    • API
      • GenericFault
      • IFileManagerService
      • UnexpectedFault
  • License (ELM) API
    • Overview
    • IELMService
    • API
      • ELMAssignment
      • ELMAssignmentType
      • ELMFault
      • ELMPermission
      • ELMPoolInfo
      • ELMProduct
      • ELMProjectPermission
      • GenericFault
      • IELMService
      • UnexpectedFault
  • Tasks API
    • Overview
    • ITasksService
    • API
      • GenericFault
      • ITasksService
      • TaskDoesNotExistFault
      • TaskInfo
      • TaskNotFinishedFault
      • TaskResult
      • TaskStatus
      • UnexpectedFault
  • Changelog

Class ServerProjectCreateInfo

Encapsulates information required to create a server project with Live Docs.

Inheritance
Object
ServerProjectCreateInfo
ServerProjectDesktopDocsCreateInfo
Syntax
public class ServerProjectCreateInfo

Fields

AllowOverlappingWorkflow

Indicates whether overlapping workflow phases are allowed or not. It should be false if the AllowPackageCreation property is true.

Declaration
public bool AllowOverlappingWorkflow
Type
Boolean

AllowPackageCreation

Indicates whether the package creation is allowed or not.

Declaration
public bool AllowPackageCreation
Type
Boolean

Client

The client attribute of the project. Can be null.

Declaration
public string Client
Type
String

CreatorUser

The guid of the user creating the project. This user is automatically assigned to the project with ProjectManager role right after project creation. This ensures the there is a valid user assigned that has the permission to manipulate the projet from the memoQ Client. This has to be the guid of a valid, existing user.

Declaration
public Guid CreatorUser
Type
Guid

CustomMetas

The default values of custom fields that server saves to the primary translation memory when you confirm segments during translation. Each line has three or more columns, separated by tabs:

metaName   metaType   value   [value2...valueN]

Possible metaType values:

  • FreeText
  • Number
  • DateTime
  • PickListSingle
  • PickListMultiple
The following example demonstrates how to use the CustomMetas field if you have three meta fields: one free text, one number and one single picklist. The string <tab> marks a tabulator character.
FirstMeta<tab>FreeText<tab>The value of the first meta
SecondMeta<tab>Number<tab>12
ThirdMeta<tab>PickListSingle<tab>Value 1<tab>Value 2<tab>Value 3
Declaration
public string CustomMetas
Type
String

Deadline

The deadline of the project.

Declaration
public DateTime Deadline
Type
DateTime

Description

The description of the project. Can be null.

Declaration
public string Description
Type
String

Domain

The domain attribute of the project. Can be null.

Declaration
public string Domain
Type
String

DownloadPreview2

Creates preview when documents are imported. Includes the preview of the documents when a user checks out the project or downloads the project as a package. Without the preview information no preview is available while translating.

Declaration
public bool DownloadPreview2
Type
Boolean

DownloadSkeleton2

Includes the skeleton files (required for exporting documents) when a user checks out the project or downloads the project as a package. Without the files export is not possible. Project managers always recieve these files.

Declaration
public bool DownloadSkeleton2
Type
Boolean

EnableCommunication

If true, online communication (chat) is enabled for the project. No forum will be created/assigner to the project even if true.

Declaration
public bool EnableCommunication
Type
Boolean

Name

The name of the Project. Can not be null or empty. The name can not contain characters that are invalid in file names (e.g.: ",:,/,,tab, ...).

Declaration
public string Name
Type
String

OmitHitsWithNoTargetTerm

Whether terminology hits with no target term are shown.

Declaration
public bool OmitHitsWithNoTargetTerm
Type
Boolean

PackageDeliveryOptions

The package delivery options. Null value means the default options. The value of this member is ignored if the package creation is not allowed in the project.

Declaration
public PackageDeliveryOptions PackageDeliveryOptions
Type
PackageDeliveryOptions

PackageResourceHandling

Specifies how the TMs, TBs and LiveDocs corpora are included in the packages.

Declaration
public ServerProjectResourcesInPackages PackageResourceHandling
Type
ServerProjectResourcesInPackages

PreventDeliveryOnQAError

Indicates whether QA errors should prevent document deliver or not.

Declaration
public bool PreventDeliveryOnQAError
Type
Boolean

Project

The project attribute of the project. Can be null.

Declaration
public string Project
Type
String

RecordVersionHistory

True if document versioning is enabled for the project.

Declaration
public bool RecordVersionHistory
Type
Boolean

SourceLanguageCode

The three+(two) letter code of the source language of the server project. (such as fre, eng, eng-US).

Declaration
public string SourceLanguageCode
Type
String

StrictSubLangMatching

Whether sublanguages are treated as separate languages during TB lookup.

Declaration
public bool StrictSubLangMatching
Type
Boolean

Subject

The subject attribute of the project. Can be null.

Declaration
public string Subject
Type
String

TargetLanguageCodes

The array of the three+(two) letter codes of the target languages of the server project (such as fre, eng, eng-US). Can not be null and the items have to represent valid language codes.

Declaration
public string[] TargetLanguageCodes
Type
String[]
Back to top memoQ Server API documentation