You are here

Home » API reference » Lingotek Translation 3.1.x

lingotek.schema.yml in Lingotek Translation 3.1.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.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 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: string

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

  170.           type: string

  171.           label: 'Sandbox Host'

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

  173.         host:

  174.           type: string

  175.           label: 'Lingotek Host'

  176.         authorize_path:

  177.           type: string

  178.         default_client_id:

  179.           type: string

  180.         plan_type:

  181.           type: string

  182.         resources:

  183.           type: mapping

  184.           label: 'Resources'

  185.           mapping:

  186.             community:

  187.               type: sequence

  188.               sequence:

  189.                 type: string

  190.             project:

  191.               type: sequence

  192.               sequence:

  193.                 type: string

  194.             workflow:

  195.               type: sequence

  196.               sequence:

  197.                 type: string

  198.             vault:

  199.               type: sequence

  200.               sequence:

  201.                 type: string

  202.             filter:

  203.               type: sequence

  204.               sequence:

  205.                 type: string

  206.         access_token:

  207.           type: string

  208.         login_id:

  209.           type: string

  210.         callback_url:

  211.           type: string

  212.     translate:

  213.       type: mapping

  214.       label: 'Translate'

  215.       mapping:

  216.         entity:

  217.             type: sequence

  218.             sequence:

  219.               type: sequence

  220.               sequence:

  221.                 type: ignore

  222.         config:

  223.             type: sequence

  224.             sequence:

  225.               type: sequence

  226.               sequence:

  227.                 type: ignore

  228.         interface:

  229.             type: sequence

  230.             sequence:

  231.               type: sequence

  232.               sequence:

  233.                 type: ignore

  234.     field:

  235.       type: string

  236.     profile:

  237.       type: sequence

  238.       label: 'Profiles'

  239.       sequence:

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

  241. 

  242. lingotek.profile.*:

  243.   type: config_entity

  244.   label: 'Lingotek Profile'

  245.   mapping:

  246.     id:

  247.       type: string

  248.       label: 'ID'

  249.     label:

  250.       type: label

  251.       label: 'Label'

  252.     weight:

  253.       type: integer

  254.       label: 'Weight'

  255.     locked:

  256.       type: boolean

  257.       label: 'Locked'

  258.     auto_upload:

  259.       type: boolean

  260.       label: 'Automatic Upload'

  261.     auto_request:

  262.       type: boolean

  263.       label: 'Automatic request of translations'

  264.     auto_download:

  265.       type: boolean

  266.       label: 'Automatic Download'

  267.     auto_download_worker:

  268.       type: boolean

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

  270.     vault:

  271.       type: string

  272.       label: 'TM Vault'

  273.     project:

  274.       type: string

  275.       label: 'TM Project'

  276.     workflow:

  277.       type: string

  278.       label: 'TM Workflow'

  279.     append_type_to_title:

  280.       type: string

  281.       label: 'Append Content Type To Title'

  282.     intelligence_metadata:

  283.       type: mapping

  284.       mapping:

  285.         override:

  286.           type: boolean

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

  288.         use_author:

  289.           type: boolean

  290.           label: 'Permission to Include Author'

  291.         default_author_email:

  292.           type: string

  293.           label: 'Default Author Email'

  294.         use_author_email:

  295.           type: boolean

  296.           label: 'Active'

  297.         use_contact_email_for_author:

  298.           type: boolean

  299.           label: 'Same as Contact Email'

  300.         business_unit:

  301.           type: string

  302.           label: 'Business Unit'

  303.         use_business_unit:

  304.           type: boolean

  305.           label: 'Active'

  306.         business_division:

  307.           type: string

  308.           label: 'Business Division'

  309.         use_business_division:

  310.           type: boolean

  311.           label: 'Active'

  312.         campaign_id:

  313.           type: string

  314.           label: 'Campaign Id'

  315.         use_campaign_id:

  316.           type: boolean

  317.           label: 'Active'

  318.         campaign_rating:

  319.           type: integer

  320.           label: 'Campaign Rating'

  321.         use_campaign_rating:

  322.           type: boolean

  323.           label: 'Active'

  324.         channel:

  325.           type: string

  326.           label: 'Channel'

  327.         use_channel:

  328.           type: boolean

  329.           label: 'Active'

  330.         contact_name:

  331.           type: string

  332.           label: 'Contact Name'

  333.         use_contact_name:

  334.           type: boolean

  335.           label: 'Active'

  336.         contact_email:

  337.           type: string

  338.           label: 'Contact Email'

  339.         use_contact_email:

  340.           type: boolean

  341.           label: 'Active'

  342.         content_description:

  343.           type: string

  344.           label: 'Content Description'

  345.         use_content_description:

  346.           type: boolean

  347.           label: 'Active'

  348.         external_style_id:

  349.           type: string

  350.           label: 'External Style ID'

  351.         use_external_style_id:

  352.           type: boolean

  353.           label: 'Active'

  354.         purchase_order:

  355.           type: string

  356.           label: 'Purchase Order'

  357.         use_purchase_order:

  358.           type: boolean

  359.           label: 'Active'

  360.         region:

  361.           type: string

  362.           label: 'Region'

  363.         use_region:

  364.           type: boolean

  365.           label: 'Active'

  366.         use_base_domain:

  367.           type: boolean

  368.           label: 'Active'

  369.         use_reference_url:

  370.           type: boolean

  371.           label: 'Active'

  372.     filter:

  373.       type: string

  374.       label: 'TM Filter'

  375.     subfilter:

  376.       type: string

  377.       label: 'TM Subfilter'

  378.     language_overrides:

  379.       type: sequence

  380.       label: 'Target language settings overrides'

  381.       sequence:

  382.         type: mapping

  383.         mapping:

  384.           overrides:

  385.             type: string

  386.           custom:

  387.             type: mapping

  388.             mapping:

  389.               workflow:

  390.                 type: string

  391.                 label: 'TM Workflow'

  392.               vault:

  393.                 type: string

  394.                 label: 'TM Vault'

  395.               auto_request:

  396.                 type: boolean

  397.                 label: 'Automatic request of translation'

  398.               auto_download:

  399.                 type: boolean

  400.                 label: 'Automatic Download'

  401. 

  402. lingotek.lingotek_config_metadata.*:

  403.   type: config_entity

  404.   label: 'Lingotek Config Metadata'

  405.   mapping:

  406.     config_name:

  407.       type: string

  408.       label: 'Config name'

  409.     document_id:

  410.       type: string

  411.       label: 'Lingotek document id'

  412.     source_status:

  413.       type: sequence

  414.       sequence:

  415.         type: string

  416.     target_status:

  417.       type: sequence

  418.       sequence:

  419.         type: string

  420.     profile:

  421.       type: string

  422.       label: 'Lingotek profile'

  423.     hash:

  424.       type: string

  425.       label: 'Lingotek hash'

  426.     job_id:

  427.       type: string

  428.       label: 'Lingotek Job ID'

  429. 

  430. language.entity.*.third_party.lingotek:

  431.   type: mapping

  432.   label: 'Lingotek locale mapping'

  433.   mapping:

  434.     disabled:

  435.       type: boolean

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

  437.     locale:

  438.       type: string

  439.       label: 'Lingotek locale code'