XtrfProject | Avantus Docs

# Description

Creates a project or a quote in XTRF automatically

# Steps

Search files on a defined destination
Grabs the files
If OCR is True, sends the files for OCR
If batch is True, creates a project in XTRF with all the files including OCR
Start tasks if set
Sends a notification of the created project

# Parameters

# Workflow Paramaters

Parameter	Description	Options
batch	when false, it processes each file as a separated project	True/False
start_tasks	when true, it will automatically start the tasks	True/False
ocr_active	process files to OCR and adds output to the project	True/False
ocr_languages	language of the documents for the OCR	english
ocr_output_format	output format from the OCR	txt
download_prefix	folder where the files are storaged	required
type	either project or quote	required

# Common Parameters

Parameter	Description	Options
name_option	predefined dynamic name	DATE: adds current day
name_prefix	predefined static name	Text
files_as_reference	duplicates source files as reference	Boolean

# Project Template Parameters

Parameter	Description	Options
customer	---	required
person_responsible	project manager assigned	required
source_language	---	required
target_languages	---	multiple
service	---	required
specialization	---	required
categories	---	multiple
custom_fields	---	multiple
service	---	required
deadline	expressed in working days	required

Project Request

Json

{
  "people": {
    "responsiblePersons": {
      "projectManagerId": 76
    }
  },
  "sourceLanguageId": 71,
  "targetLanguagesIds": [165, 49],
  "categoriesIds": [30],
  "serviceId": 15,
  "specializationId": 5,
  "customerId": 480
}

# Quote Template Parameters

Parameter	Description	Options
customer	customer	required
office	customer office	optional
customer_project_number	Customer reference number	required
source_language	---	required
target_languages	---	multiple
service	---	required
specialization	---	required
custom_fields	---	multiple
workflow	---	if service not provided
deadline	---	required
notes	instructions	optional
auto_accept	accepts quote	boolean
price_profile	---	optional
person	---	optional
send_back_to	---	optional
additional_persons	---	multiple

Quote Request

Json

{
  "customerProjectNumber": "tgfc chgn",
  "workflow": { "name": "AP - DTP only" },
  "service": { "name": "Translation" },
  "specialization": { "name": "General" },
  "sourceLanguage": { "name": "Bengali" },
  "targetLanguages": [
    { "name": "Bulgarian" },
    { "name": "German (Germany)" },
    { "name": "Haitian - Creole" }
  ],
  "notes": "instructions",
  "autoAccept": true,
  "priceProfile": { "name": "KP - Pricelist" },
  "additionalPersons": [{ "id": 3346 }],
  "person": { "id": 3223 },
  "sendBackTo": { "id": 5405 },
  "office": { "name": "KP-Kaiser Permanente" }
}

# Administrative Parameters (systems only)

Parameter	Description	Options
download_prefix	---	required
download_link_url	---	required
template	---	required

← EmailParsing