You are here

Home » API reference » Lingotek Translation 3.8.x

lingotek.schema.yml in Lingotek Translation 3.8.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.5.x config/schema/lingotek.schema.yml
  10. 3.6.x config/schema/lingotek.schema.yml
  11. 3.7.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.           deprecated: "This option is unused since lingotek:3.8.0. Will be removed in lingotek:4.0.0"

  55.         content_cloud_import_format:

  56.           type: string

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

  58.         content_cloud_import_status:

  59.           type: integer

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

  61.         split_download_all:

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

  63.           type: boolean

  64.         contrib:

  65.           label: 'Contributed modules integrations settings'

  66.           type: mapping

  67.           mapping:

  68.             paragraphs:

  69.               label: 'Paragraphs module integration settings'

  70.               type: mapping

  71.               mapping:

  72.                 enable_bulk_management:

  73.                   type: boolean

  74.                   label: 'Enable bulk management for paragraphs'

  75.     intelligence:

  76.       type: mapping

  77.       label: 'Lingotek Intelligence settings'

  78.       mapping:

  79.         use_author:

  80.           type: boolean

  81.           label: 'Permission to Include Author'

  82.         default_author_email:

  83.           type: string

  84.           label: 'Default Author Email'

  85.         use_author_email:

  86.           type: boolean

  87.           label: 'Active'

  88.         use_contact_email_for_author:

  89.           type: boolean

  90.           label: 'Same as Contact Email'

  91.         business_unit:

  92.           type: string

  93.           label: 'Business Unit'

  94.         use_business_unit:

  95.           type: boolean

  96.           label: 'Active'

  97.         business_division:

  98.           type: string

  99.           label: 'Business Division'

  100.         use_business_division:

  101.           type: boolean

  102.           label: 'Active'

  103.         campaign_id:

  104.           type: string

  105.           label: 'Campaign Id'

  106.         use_campaign_id:

  107.           type: boolean

  108.           label: 'Active'

  109.         campaign_rating:

  110.           type: integer

  111.           label: 'Campaign Rating'

  112.         use_campaign_rating:

  113.           type: boolean

  114.           label: 'Active'

  115.         channel:

  116.           type: string

  117.           label: 'Channel'

  118.         use_channel:

  119.           type: boolean

  120.           label: 'Active'

  121.         contact_name:

  122.           type: string

  123.           label: 'Contact Name'

  124.         use_contact_name:

  125.           type: boolean

  126.           label: 'Active'

  127.         contact_email:

  128.           type: string

  129.           label: 'Contact Email'

  130.         use_contact_email:

  131.           type: boolean

  132.           label: 'Active'

  133.         content_description:

  134.           type: string

  135.           label: 'Content Description'

  136.         use_content_description:

  137.           type: boolean

  138.           label: 'Active'

  139.         external_style_id:

  140.           type: string

  141.           label: 'External Style ID'

  142.         use_external_style_id:

  143.           type: boolean

  144.           label: 'Active'

  145.         purchase_order:

  146.           type: string

  147.           label: 'Purchase Order'

  148.         use_purchase_order:

  149.           type: boolean

  150.           label: 'Active'

  151.         region:

  152.           type: string

  153.           label: 'Region'

  154.         use_region:

  155.           type: boolean

  156.           label: 'Active'

  157.         use_base_domain:

  158.           type: boolean

  159.           label: 'Active'

  160.         use_reference_url:

  161.           type: boolean

  162.           label: 'Active'

  163.     account:

  164.       type: mapping

  165.       label: 'Account'

  166.       mapping:

  167.         use_production:

  168.           type: boolean

  169.           label: 'Use production'

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

  171.         sandbox_host:

  172.           type: string

  173.           label: 'Sandbox Host'

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

  175.         host:

  176.           type: string

  177.           label: 'Lingotek Host'

  178.         authorize_path:

  179.           type: string

  180.         default_client_id:

  181.           type: string

  182.         plan_type:

  183.           type: string

  184.         resources:

  185.           type: mapping

  186.           label: 'Resources'

  187.           mapping:

  188.             community:

  189.               type: sequence

  190.               sequence:

  191.                 type: string

  192.             project:

  193.               type: sequence

  194.               sequence:

  195.                 type: string

  196.             workflow:

  197.               type: sequence

  198.               sequence:

  199.                 type: string

  200.             vault:

  201.               type: sequence

  202.               sequence:

  203.                 type: string

  204.             filter:

  205.               type: sequence

  206.               sequence:

  207.                 type: string

  208.         access_token:

  209.           type: string

  210.         login_id:

  211.           type: string

  212.         callback_url:

  213.           type: string

  214.     translate:

  215.       type: mapping

  216.       label: 'Translate'

  217.       mapping:

  218.         entity:

  219.             type: sequence

  220.             sequence:

  221.               type: sequence

  222.               sequence:

  223.                 type: ignore

  224.         config:

  225.             type: sequence

  226.             sequence:

  227.               type: sequence

  228.               sequence:

  229.                 type: ignore

  230.         interface:

  231.             type: sequence

  232.             sequence:

  233.               type: sequence

  234.               sequence:

  235.                 type: ignore

  236.     field:

  237.       type: string

  238.     profile:

  239.       type: sequence

  240.       label: 'Profiles'

  241.       sequence:

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

  243. 

  244. lingotek.profile.*:

  245.   type: config_entity

  246.   label: 'Lingotek Profile'

  247.   mapping:

  248.     id:

  249.       type: string

  250.       label: 'ID'

  251.     label:

  252.       type: label

  253.       label: 'Label'

  254.     weight:

  255.       type: integer

  256.       label: 'Weight'

  257.     locked:

  258.       type: boolean

  259.       label: 'Locked'

  260.     auto_upload:

  261.       type: boolean

  262.       label: 'Automatic Upload'

  263.     auto_request:

  264.       type: boolean

  265.       label: 'Automatic request of translations'

  266.     auto_download:

  267.       type: boolean

  268.       label: 'Automatic Download'

  269.     auto_download_worker:

  270.       type: boolean

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

  272.     vault:

  273.       type: string

  274.       label: 'TM Vault'

  275.     project:

  276.       type: string

  277.       label: 'TM Project'

  278.     workflow:

  279.       type: string

  280.       label: 'TM Workflow'

  281.     append_type_to_title:

  282.       type: string

  283.       label: 'Append Content Type To Title'

  284.     intelligence_metadata:

  285.       type: mapping

  286.       mapping:

  287.         override:

  288.           type: boolean

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

  290.         use_author:

  291.           type: boolean

  292.           label: 'Permission to Include Author'

  293.         default_author_email:

  294.           type: string

  295.           label: 'Default Author Email'

  296.         use_author_email:

  297.           type: boolean

  298.           label: 'Active'

  299.         use_contact_email_for_author:

  300.           type: boolean

  301.           label: 'Same as Contact Email'

  302.         business_unit:

  303.           type: string

  304.           label: 'Business Unit'

  305.         use_business_unit:

  306.           type: boolean

  307.           label: 'Active'

  308.         business_division:

  309.           type: string

  310.           label: 'Business Division'

  311.         use_business_division:

  312.           type: boolean

  313.           label: 'Active'

  314.         campaign_id:

  315.           type: string

  316.           label: 'Campaign Id'

  317.         use_campaign_id:

  318.           type: boolean

  319.           label: 'Active'

  320.         campaign_rating:

  321.           type: integer

  322.           label: 'Campaign Rating'

  323.         use_campaign_rating:

  324.           type: boolean

  325.           label: 'Active'

  326.         channel:

  327.           type: string

  328.           label: 'Channel'

  329.         use_channel:

  330.           type: boolean

  331.           label: 'Active'

  332.         contact_name:

  333.           type: string

  334.           label: 'Contact Name'

  335.         use_contact_name:

  336.           type: boolean

  337.           label: 'Active'

  338.         contact_email:

  339.           type: string

  340.           label: 'Contact Email'

  341.         use_contact_email:

  342.           type: boolean

  343.           label: 'Active'

  344.         content_description:

  345.           type: string

  346.           label: 'Content Description'

  347.         use_content_description:

  348.           type: boolean

  349.           label: 'Active'

  350.         external_style_id:

  351.           type: string

  352.           label: 'External Style ID'

  353.         use_external_style_id:

  354.           type: boolean

  355.           label: 'Active'

  356.         purchase_order:

  357.           type: string

  358.           label: 'Purchase Order'

  359.         use_purchase_order:

  360.           type: boolean

  361.           label: 'Active'

  362.         region:

  363.           type: string

  364.           label: 'Region'

  365.         use_region:

  366.           type: boolean

  367.           label: 'Active'

  368.         use_base_domain:

  369.           type: boolean

  370.           label: 'Active'

  371.         use_reference_url:

  372.           type: boolean

  373.           label: 'Active'

  374.     filter:

  375.       type: string

  376.       label: 'TM Filter'

  377.     subfilter:

  378.       type: string

  379.       label: 'TM Subfilter'

  380.     language_overrides:

  381.       type: sequence

  382.       label: 'Target language settings overrides'

  383.       sequence:

  384.         type: mapping

  385.         mapping:

  386.           overrides:

  387.             type: string

  388.           custom:

  389.             type: mapping

  390.             mapping:

  391.               workflow:

  392.                 type: string

  393.                 label: 'TM Workflow'

  394.               vault:

  395.                 type: string

  396.                 label: 'TM Vault'

  397.               auto_request:

  398.                 type: boolean

  399.                 label: 'Automatic request of translation'

  400.               auto_download:

  401.                 type: boolean

  402.                 label: 'Automatic Download'

  403. 

  404. lingotek.lingotek_config_metadata.*:

  405.   type: config_entity

  406.   label: 'Lingotek Config Metadata'

  407.   mapping:

  408.     config_name:

  409.       type: string

  410.       label: 'Config name'

  411.     document_id:

  412.       type: string

  413.       label: 'Lingotek document id'

  414.     source_status:

  415.       type: sequence

  416.       sequence:

  417.         type: string

  418.     target_status:

  419.       type: sequence

  420.       sequence:

  421.         type: string

  422.     profile:

  423.       type: string

  424.       label: 'Lingotek profile'

  425.     hash:

  426.       type: string

  427.       label: 'Lingotek hash'

  428.     job_id:

  429.       type: string

  430.       label: 'Lingotek Job ID'

  431.     updated_timestamp:

  432.       type: timestamp

  433.       label: 'Updated date'

  434.     uploaded_timestamp:

  435.       type: timestamp

  436.       label: 'Initial upload'

  437. 

  438. language.entity.*.third_party.lingotek:

  439.   type: mapping

  440.   label: 'Lingotek locale mapping'

  441.   mapping:

  442.     disabled:

  443.       type: boolean

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

  445.     locale:

  446.       type: string

  447.       label: 'Lingotek locale code'