Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

extractWordbeeProperties

Optional, default is false.

If true then the system includes Wordbee specific properties in the TMX file. These properties are saved as <descripGrp> nodes:

Code Block
<descripGrp>
    <descrip type="Status">1</descrip>
</descripGrp>


Term entry level:

  • x-wb-context
  • x-wb-cfs{custom field id} : For example "x-wb-cfs10"

Text level properties in "tuv" node:

  • x-wb-status
  • x-wb-bookmark
  • x-wb-locked
  • x-wb-editor
  • x-wb-cft{custom field id} : For example "x-wb-cft10"


Optional, bool
extractComments

Optional, default is false. Set to true if you want to include comments attached to the texts.

These are saved as notes inside <tig>:

Code Block
<tig>
	<termid="6386438-en-GB">kkkk</term>
	<auxInfo>
		<note id="529">This is a comment [23/11/2018 08:30:17,187,0]</note>
	</auxInfo>


The note includes the date, the user identifier and the numeric category of the comment.

Optional, bool


TBX version 3 specific options


extractCreationData

Optional, default is 0.

Available options:

  • 0: Don't export transacGrp creation data
  • 1: Export using Wordbee data
  • 2: Export using TBX fields fetched on import

If not "0" then the system includes "creation" data from "Wordbee fields" if set to "1", or from "Originally imported data" if set to "2". These properties are saved as <transacGrp> nodes:

Code Block
<transacGrp>
  <transac type="transactionType">creation</transac>
  <transacNote type="responsibility" target="511">Rageh Aly</transacNote>
  <date>2021-03-08</date>
</transacGrp>


Optional, int
extractModificationData

Optional, default is 0.

Available options:

  • 0: Don't export transacGrp modification data
  • 1: Export using Wordbee data
  • 2: Export using TBX fields fetched on import

If not "0" then the system includes "creation" data from "Wordbee fields" if set to "1", or from "Originally imported data" if set to "2". These properties are saved as <transacGrp> nodes:

Code Block
<transacGrp>
  <transac type="transactionType">modification</transac>
  <transacNote type="responsibility" target="511">Rageh Aly</transacNote>
  <date>2021-03-08</date>
</transacGrp>


Optional, int

RESULTS

This API method is an "asynchronous" operation. It either immediately returns the result or instead an operation ID which you need to periodically poll until the operation has finished.

...