You are here

Home » API reference » Lingotek Translation 8.2

lingotek.schema.yml in Lingotek Translation 8.2

Same filename and directory in other branches
  1. 8 config/schema/lingotek.schema.yml
  2. 4.0.x config/schema/lingotek.schema.yml
  3. 3.0.x config/schema/lingotek.schema.yml
  4. 3.1.x config/schema/lingotek.schema.yml
  5. 3.2.x config/schema/lingotek.schema.yml
  6. 3.3.x config/schema/lingotek.schema.yml
  7. 3.4.x config/schema/lingotek.schema.yml
  8. 3.5.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 8.x-2.14. Will be removed in 9.x-1.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: string

  46.         enable_content_cloud:

  47.           type: boolean

  48.           deprecated: 'Removed in Lingotek 8.x-2.21'

  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: 'Removed in Lingotek 8.x-2.21'

  57.         content_cloud_import_status:

  58.           type: integer

  59.           deprecated: 'Removed in Lingotek 8.x-2.21'

  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.         sandbox_host:

  170.           type: string

  171.           label: 'Sandbox Host (deprecated)'

  172.         host:

  173.           type: string

  174.           label: 'Lingotek Host'

  175.         authorize_path:

  176.           type: string

  177.         default_client_id:

  178.           type: string

  179.         plan_type:

  180.           type: string

  181.         resources:

  182.           type: mapping

  183.           label: 'Resources'

  184.           mapping:

  185.             community:

  186.               type: sequence

  187.               sequence:

  188.                 type: string

  189.             project:

  190.               type: sequence

  191.               sequence:

  192.                 type: string

  193.             workflow:

  194.               type: sequence

  195.               sequence:

  196.                 type: string

  197.             vault:

  198.               type: sequence

  199.               sequence:

  200.                 type: string

  201.             filter:

  202.               type: sequence

  203.               sequence:

  204.                 type: string

  205.         access_token:

  206.           type: string

  207.         login_id:

  208.           type: string

  209.         callback_url:

  210.           type: string

  211.     translate:

  212.       type: mapping

  213.       label: 'Translate'

  214.       mapping:

  215.         entity:

  216.             type: sequence

  217.             sequence:

  218.               type: sequence

  219.               sequence:

  220.                 type: ignore

  221.         config:

  222.             type: sequence

  223.             sequence:

  224.               type: sequence

  225.               sequence:

  226.                 type: ignore

  227.         interface:

  228.             type: sequence

  229.             sequence:

  230.               type: sequence

  231.               sequence:

  232.                 type: ignore

  233.     field:

  234.       type: string

  235.     profile:

  236.       type: sequence

  237.       label: 'Profiles'

  238.       sequence:

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

  240. 

  241. lingotek.profile.*:

  242.   type: config_entity

  243.   label: 'Lingotek Profile'

  244.   mapping:

  245.     id:

  246.       type: string

  247.       label: 'ID'

  248.     label:

  249.       type: label

  250.       label: 'Label'

  251.     weight:

  252.       type: integer

  253.       label: 'Weight'

  254.     locked:

  255.       type: boolean

  256.       label: 'Locked'

  257.     auto_upload:

  258.       type: boolean

  259.       label: 'Automatic Upload'

  260.     auto_request:

  261.       type: boolean

  262.       label: 'Automatic request of translations'

  263.     auto_download:

  264.       type: boolean

  265.       label: 'Automatic Download'

  266.     auto_download_worker:

  267.       type: boolean

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

  269.     vault:

  270.       type: string

  271.       label: 'TM Vault'

  272.     project:

  273.       type: string

  274.       label: 'TM Project'

  275.     workflow:

  276.       type: string

  277.       label: 'TM Workflow'

  278.     append_type_to_title:

  279.       type: string

  280.       label: 'Append Content Type To Title'

  281.     intelligence_metadata:

  282.       type: mapping

  283.       mapping:

  284.         override:

  285.           type: boolean

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

  287.         use_author:

  288.           type: boolean

  289.           label: 'Permission to Include Author'

  290.         default_author_email:

  291.           type: string

  292.           label: 'Default Author Email'

  293.         use_author_email:

  294.           type: boolean

  295.           label: 'Active'

  296.         use_contact_email_for_author:

  297.           type: boolean

  298.           label: 'Same as Contact Email'

  299.         business_unit:

  300.           type: string

  301.           label: 'Business Unit'

  302.         use_business_unit:

  303.           type: boolean

  304.           label: 'Active'

  305.         business_division:

  306.           type: string

  307.           label: 'Business Division'

  308.         use_business_division:

  309.           type: boolean

  310.           label: 'Active'

  311.         campaign_id:

  312.           type: string

  313.           label: 'Campaign Id'

  314.         use_campaign_id:

  315.           type: boolean

  316.           label: 'Active'

  317.         campaign_rating:

  318.           type: integer

  319.           label: 'Campaign Rating'

  320.         use_campaign_rating:

  321.           type: boolean

  322.           label: 'Active'

  323.         channel:

  324.           type: string

  325.           label: 'Channel'

  326.         use_channel:

  327.           type: boolean

  328.           label: 'Active'

  329.         contact_name:

  330.           type: string

  331.           label: 'Contact Name'

  332.         use_contact_name:

  333.           type: boolean

  334.           label: 'Active'

  335.         contact_email:

  336.           type: string

  337.           label: 'Contact Email'

  338.         use_contact_email:

  339.           type: boolean

  340.           label: 'Active'

  341.         content_description:

  342.           type: string

  343.           label: 'Content Description'

  344.         use_content_description:

  345.           type: boolean

  346.           label: 'Active'

  347.         external_style_id:

  348.           type: string

  349.           label: 'External Style ID'

  350.         use_external_style_id:

  351.           type: boolean

  352.           label: 'Active'

  353.         purchase_order:

  354.           type: string

  355.           label: 'Purchase Order'

  356.         use_purchase_order:

  357.           type: boolean

  358.           label: 'Active'

  359.         region:

  360.           type: string

  361.           label: 'Region'

  362.         use_region:

  363.           type: boolean

  364.           label: 'Active'

  365.         use_base_domain:

  366.           type: boolean

  367.           label: 'Active'

  368.         use_reference_url:

  369.           type: boolean

  370.           label: 'Active'

  371.     filter:

  372.       type: string

  373.       label: 'TM Filter'

  374.     subfilter:

  375.       type: string

  376.       label: 'TM Subfilter'

  377.     language_overrides:

  378.       type: sequence

  379.       label: 'Target language settings overrides'

  380.       sequence:

  381.         type: mapping

  382.         mapping:

  383.           overrides:

  384.             type: string

  385.           custom:

  386.             type: mapping

  387.             mapping:

  388.               workflow:

  389.                 type: string

  390.                 label: 'TM Workflow'

  391.               auto_request:

  392.                 type: boolean

  393.                 label: 'Automatic request of translation'

  394.               auto_download:

  395.                 type: boolean

  396.                 label: 'Automatic Download'

  397. 

  398. lingotek.lingotek_config_metadata.*:

  399.   type: config_entity

  400.   label: 'Lingotek Config Metadata'

  401.   mapping:

  402.     config_name:

  403.       type: string

  404.       label: 'Config name'

  405.     document_id:

  406.       type: string

  407.       label: 'Lingotek document id'

  408.     source_status:

  409.       type: sequence

  410.       sequence:

  411.         type: string

  412.     target_status:

  413.       type: sequence

  414.       sequence:

  415.         type: string

  416.     profile:

  417.       type: string

  418.       label: 'Lingotek profile'

  419.     hash:

  420.       type: string

  421.       label: 'Lingotek hash'

  422.     job_id:

  423.       type: string

  424.       label: 'Lingotek Job ID'

  425. 

  426. language.entity.*.third_party.lingotek:

  427.   type: mapping

  428.   label: 'Lingotek locale mapping'

  429.   mapping:

  430.     disabled:

  431.       type: boolean

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

  433.     locale:

  434.       type: string

  435.       label: 'Lingotek locale code'