You are here

Home » API reference » Lingotek Translation 3.5.x

lingotek.schema.yml in Lingotek Translation 3.5.x

Same filename and directory in other branches
  1. 8 config/schema/lingotek.schema.yml
  2. 8.2 config/schema/lingotek.schema.yml
  3. 4.0.x config/schema/lingotek.schema.yml
  4. 3.0.x config/schema/lingotek.schema.yml
  5. 3.1.x config/schema/lingotek.schema.yml
  6. 3.2.x config/schema/lingotek.schema.yml
  7. 3.3.x config/schema/lingotek.schema.yml
  8. 3.4.x config/schema/lingotek.schema.yml
  9. 3.6.x config/schema/lingotek.schema.yml
  10. 3.7.x config/schema/lingotek.schema.yml
  11. 3.8.x config/schema/lingotek.schema.yml
config/schema/lingotek.schema.yml

File

config/schema/lingotek.schema.yml
View source 
  1. lingotek.settings:

  2.   type: config_object

  3.   label: 'Lingotek settings'

  4.   mapping:

  5.     default:

  6.       type: mapping

  7.       label: 'Default'

  8.       mapping:

  9.         community:

  10.           type: string

  11.         project:

  12.           type: string

  13.         workflow:

  14.           type: string

  15.         vault:

  16.           type: string

  17.         filter:

  18.           type: string

  19.         subfilter:

  20.           type: string

  21.     preference:

  22.       type: mapping

  23.       label: 'Preference'

  24.       mapping:

  25.         advanced_parsing:

  26.           type: boolean

  27.         advanced_taxonomy_terms:

  28.           type: boolean

  29.         always_show_translate_tabs:

  30.           type: boolean

  31.         delete_tms_documents_upon_disassociation:

  32.           type: boolean

  33.           deprecated: "This option is unused since lingotek:8.x-2.14. Will be removed in lingotek:4.0.0"

  34.         show_language_labels:

  35.           type: boolean

  36.         allow_local_editing:

  37.           type: boolean

  38.         language_specific_profiles:

  39.           type: boolean

  40.         target_download_status:

  41.           label: 'Published status for content translation downloads'

  42.           type: string

  43.         append_type_to_title:

  44.           label: 'Global setting to set whether to append content type to title in TMS'

  45.           type: boolean

  46.         enable_content_cloud:

  47.           type: boolean

  48.           deprecated: "This option is unused since lingotek:8.x-2.21. Will be removed in lingotek:4.0.0"

  49.         enable_download_source:

  50.           type: boolean

  51.         enable_download_interim:

  52.           label: 'Allow to download interim translations (translations that are pending some phases)'

  53.           type: boolean

  54.         content_cloud_import_format:

  55.           type: string

  56.           deprecated: "This option is unused since lingotek:8.x-2.21. Will be removed in lingotek:4.0.0"

  57.         content_cloud_import_status:

  58.           type: integer

  59.           deprecated: "This option is unused since lingotek:8.x-2.21. Will be removed in lingotek:4.0.0"

  60.         split_download_all:

  61.           label: 'Use a different batch per locale when downloading all translations'

  62.           type: boolean

  63.         contrib:

  64.           label: 'Contributed modules integrations settings'

  65.           type: mapping

  66.           mapping:

  67.             paragraphs:

  68.               label: 'Paragraphs module integration settings'

  69.               type: mapping

  70.               mapping:

  71.                 enable_bulk_management:

  72.                   type: boolean

  73.                   label: 'Enable bulk management for paragraphs'

  74.     intelligence:

  75.       type: mapping

  76.       label: 'Lingotek Intelligence settings'

  77.       mapping:

  78.         use_author:

  79.           type: boolean

  80.           label: 'Permission to Include Author'

  81.         default_author_email:

  82.           type: string

  83.           label: 'Default Author Email'

  84.         use_author_email:

  85.           type: boolean

  86.           label: 'Active'

  87.         use_contact_email_for_author:

  88.           type: boolean

  89.           label: 'Same as Contact Email'

  90.         business_unit:

  91.           type: string

  92.           label: 'Business Unit'

  93.         use_business_unit:

  94.           type: boolean

  95.           label: 'Active'

  96.         business_division:

  97.           type: string

  98.           label: 'Business Division'

  99.         use_business_division:

  100.           type: boolean

  101.           label: 'Active'

  102.         campaign_id:

  103.           type: string

  104.           label: 'Campaign Id'

  105.         use_campaign_id:

  106.           type: boolean

  107.           label: 'Active'

  108.         campaign_rating:

  109.           type: integer

  110.           label: 'Campaign Rating'

  111.         use_campaign_rating:

  112.           type: boolean

  113.           label: 'Active'

  114.         channel:

  115.           type: string

  116.           label: 'Channel'

  117.         use_channel:

  118.           type: boolean

  119.           label: 'Active'

  120.         contact_name:

  121.           type: string

  122.           label: 'Contact Name'

  123.         use_contact_name:

  124.           type: boolean

  125.           label: 'Active'

  126.         contact_email:

  127.           type: string

  128.           label: 'Contact Email'

  129.         use_contact_email:

  130.           type: boolean

  131.           label: 'Active'

  132.         content_description:

  133.           type: string

  134.           label: 'Content Description'

  135.         use_content_description:

  136.           type: boolean

  137.           label: 'Active'

  138.         external_style_id:

  139.           type: string

  140.           label: 'External Style ID'

  141.         use_external_style_id:

  142.           type: boolean

  143.           label: 'Active'

  144.         purchase_order:

  145.           type: string

  146.           label: 'Purchase Order'

  147.         use_purchase_order:

  148.           type: boolean

  149.           label: 'Active'

  150.         region:

  151.           type: string

  152.           label: 'Region'

  153.         use_region:

  154.           type: boolean

  155.           label: 'Active'

  156.         use_base_domain:

  157.           type: boolean

  158.           label: 'Active'

  159.         use_reference_url:

  160.           type: boolean

  161.           label: 'Active'

  162.     account:

  163.       type: mapping

  164.       label: 'Account'

  165.       mapping:

  166.         use_production:

  167.           type: boolean

  168.           label: 'Use production'

  169.           deprecated: "account.use_production lingotek setting is unused since lingotek:3.5.0. Will be removed in lingotek:4.0.0"

  170.         sandbox_host:

  171.           type: string

  172.           label: 'Sandbox Host'

  173.           deprecated: "account.sandbox_host property lingotek setting is unused since lingotek:8.x-2.6. Will be removed in lingotek:4.0.0"

  174.         host:

  175.           type: string

  176.           label: 'Lingotek Host'

  177.         authorize_path:

  178.           type: string

  179.         default_client_id:

  180.           type: string

  181.         plan_type:

  182.           type: string

  183.         resources:

  184.           type: mapping

  185.           label: 'Resources'

  186.           mapping:

  187.             community:

  188.               type: sequence

  189.               sequence:

  190.                 type: string

  191.             project:

  192.               type: sequence

  193.               sequence:

  194.                 type: string

  195.             workflow:

  196.               type: sequence

  197.               sequence:

  198.                 type: string

  199.             vault:

  200.               type: sequence

  201.               sequence:

  202.                 type: string

  203.             filter:

  204.               type: sequence

  205.               sequence:

  206.                 type: string

  207.         access_token:

  208.           type: string

  209.         login_id:

  210.           type: string

  211.         callback_url:

  212.           type: string

  213.     translate:

  214.       type: mapping

  215.       label: 'Translate'

  216.       mapping:

  217.         entity:

  218.             type: sequence

  219.             sequence:

  220.               type: sequence

  221.               sequence:

  222.                 type: ignore

  223.         config:

  224.             type: sequence

  225.             sequence:

  226.               type: sequence

  227.               sequence:

  228.                 type: ignore

  229.         interface:

  230.             type: sequence

  231.             sequence:

  232.               type: sequence

  233.               sequence:

  234.                 type: ignore

  235.     field:

  236.       type: string

  237.     profile:

  238.       type: sequence

  239.       label: 'Profiles'

  240.       sequence:

  241.         type: lingotek.profile.[%key]

  242. 

  243. lingotek.profile.*:

  244.   type: config_entity

  245.   label: 'Lingotek Profile'

  246.   mapping:

  247.     id:

  248.       type: string

  249.       label: 'ID'

  250.     label:

  251.       type: label

  252.       label: 'Label'

  253.     weight:

  254.       type: integer

  255.       label: 'Weight'

  256.     locked:

  257.       type: boolean

  258.       label: 'Locked'

  259.     auto_upload:

  260.       type: boolean

  261.       label: 'Automatic Upload'

  262.     auto_request:

  263.       type: boolean

  264.       label: 'Automatic request of translations'

  265.     auto_download:

  266.       type: boolean

  267.       label: 'Automatic Download'

  268.     auto_download_worker:

  269.       type: boolean

  270.       label: 'Automatic Download using a Worker Queue'

  271.     vault:

  272.       type: string

  273.       label: 'TM Vault'

  274.     project:

  275.       type: string

  276.       label: 'TM Project'

  277.     workflow:

  278.       type: string

  279.       label: 'TM Workflow'

  280.     append_type_to_title:

  281.       type: string

  282.       label: 'Append Content Type To Title'

  283.     intelligence_metadata:

  284.       type: mapping

  285.       mapping:

  286.         override:

  287.           type: boolean

  288.           label: 'Flag indicating if there active Intelligence Metadata overrides in this profile'

  289.         use_author:

  290.           type: boolean

  291.           label: 'Permission to Include Author'

  292.         default_author_email:

  293.           type: string

  294.           label: 'Default Author Email'

  295.         use_author_email:

  296.           type: boolean

  297.           label: 'Active'

  298.         use_contact_email_for_author:

  299.           type: boolean

  300.           label: 'Same as Contact Email'

  301.         business_unit:

  302.           type: string

  303.           label: 'Business Unit'

  304.         use_business_unit:

  305.           type: boolean

  306.           label: 'Active'

  307.         business_division:

  308.           type: string

  309.           label: 'Business Division'

  310.         use_business_division:

  311.           type: boolean

  312.           label: 'Active'

  313.         campaign_id:

  314.           type: string

  315.           label: 'Campaign Id'

  316.         use_campaign_id:

  317.           type: boolean

  318.           label: 'Active'

  319.         campaign_rating:

  320.           type: integer

  321.           label: 'Campaign Rating'

  322.         use_campaign_rating:

  323.           type: boolean

  324.           label: 'Active'

  325.         channel:

  326.           type: string

  327.           label: 'Channel'

  328.         use_channel:

  329.           type: boolean

  330.           label: 'Active'

  331.         contact_name:

  332.           type: string

  333.           label: 'Contact Name'

  334.         use_contact_name:

  335.           type: boolean

  336.           label: 'Active'

  337.         contact_email:

  338.           type: string

  339.           label: 'Contact Email'

  340.         use_contact_email:

  341.           type: boolean

  342.           label: 'Active'

  343.         content_description:

  344.           type: string

  345.           label: 'Content Description'

  346.         use_content_description:

  347.           type: boolean

  348.           label: 'Active'

  349.         external_style_id:

  350.           type: string

  351.           label: 'External Style ID'

  352.         use_external_style_id:

  353.           type: boolean

  354.           label: 'Active'

  355.         purchase_order:

  356.           type: string

  357.           label: 'Purchase Order'

  358.         use_purchase_order:

  359.           type: boolean

  360.           label: 'Active'

  361.         region:

  362.           type: string

  363.           label: 'Region'

  364.         use_region:

  365.           type: boolean

  366.           label: 'Active'

  367.         use_base_domain:

  368.           type: boolean

  369.           label: 'Active'

  370.         use_reference_url:

  371.           type: boolean

  372.           label: 'Active'

  373.     filter:

  374.       type: string

  375.       label: 'TM Filter'

  376.     subfilter:

  377.       type: string

  378.       label: 'TM Subfilter'

  379.     language_overrides:

  380.       type: sequence

  381.       label: 'Target language settings overrides'

  382.       sequence:

  383.         type: mapping

  384.         mapping:

  385.           overrides:

  386.             type: string

  387.           custom:

  388.             type: mapping

  389.             mapping:

  390.               workflow:

  391.                 type: string

  392.                 label: 'TM Workflow'

  393.               vault:

  394.                 type: string

  395.                 label: 'TM Vault'

  396.               auto_request:

  397.                 type: boolean

  398.                 label: 'Automatic request of translation'

  399.               auto_download:

  400.                 type: boolean

  401.                 label: 'Automatic Download'

  402. 

  403. lingotek.lingotek_config_metadata.*:

  404.   type: config_entity

  405.   label: 'Lingotek Config Metadata'

  406.   mapping:

  407.     config_name:

  408.       type: string

  409.       label: 'Config name'

  410.     document_id:

  411.       type: string

  412.       label: 'Lingotek document id'

  413.     source_status:

  414.       type: sequence

  415.       sequence:

  416.         type: string

  417.     target_status:

  418.       type: sequence

  419.       sequence:

  420.         type: string

  421.     profile:

  422.       type: string

  423.       label: 'Lingotek profile'

  424.     hash:

  425.       type: string

  426.       label: 'Lingotek hash'

  427.     job_id:

  428.       type: string

  429.       label: 'Lingotek Job ID'

  430.     updated_timestamp:

  431.       type: timestamp

  432.       label: 'Updated date'

  433.     uploaded_timestamp:

  434.       type: timestamp

  435.       label: 'Initial upload'

  436. 

  437. language.entity.*.third_party.lingotek:

  438.   type: mapping

  439.   label: 'Lingotek locale mapping'

  440.   mapping:

  441.     disabled:

  442.       type: boolean

  443.       label: 'Flag for disabling a locale from the Lingotek interface'

  444.     locale:

  445.       type: string

  446.       label: 'Lingotek locale code'