You are here

Home » API reference » Lingotek Translation 4.0.x

lingotek.schema.yml in Lingotek Translation 4.0.x

Same filename and directory in other branches
  1. 8 config/schema/lingotek.schema.yml
  2. 8.2 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.account:

  2.   type: config_object

  3.   label: 'Lingotek Account Settings'

  4.   mapping:

  5.     host:

  6.       type: string

  7.       label: 'Lingotek Host'

  8.     authorize_path:

  9.       type: string

  10.     default_client_id:

  11.       type: string

  12.     plan_type:

  13.       type: string

  14.     resources:

  15.       type: mapping

  16.       label: 'Resources'

  17.       mapping:

  18.         community:

  19.           type: sequence

  20.           sequence:

  21.             type: string

  22.         project:

  23.           type: sequence

  24.           sequence:

  25.             type: string

  26.         workflow:

  27.           type: sequence

  28.           sequence:

  29.             type: string

  30.         vault:

  31.           type: sequence

  32.           sequence:

  33.             type: string

  34.         filter:

  35.           type: sequence

  36.           sequence:

  37.             type: string

  38.     default:

  39.       type: mapping

  40.       label: 'Default'

  41.       mapping:

  42.         community:

  43.           type: string

  44.         project:

  45.           type: string

  46.         workflow:

  47.           type: string

  48.         vault:

  49.           type: string

  50.         filter:

  51.           type: string

  52.         subfilter:

  53.           type: string

  54.     access_token:

  55.       type: string

  56.     login_id:

  57.       type: string

  58.     callback_url:

  59.       type: string

  60. 

  61. lingotek.settings:

  62.   type: config_object

  63.   label: 'Lingotek settings'

  64.   mapping:

  65.     default:

  66.       type: mapping

  67.       label: 'Default'

  68.       deprecated: "Defaults are stored in lingotek.account config object since lingotek:4.0.0. Will be removed from schema in lingotek:5.0.0"

  69.       mapping:

  70.         community:

  71.           type: string

  72.         project:

  73.           type: string

  74.         workflow:

  75.           type: string

  76.         vault:

  77.           type: string

  78.         filter:

  79.           type: string

  80.         subfilter:

  81.           type: string

  82.     preference:

  83.       type: mapping

  84.       label: 'Preference'

  85.       mapping:

  86.         advanced_parsing:

  87.           type: boolean

  88.         advanced_taxonomy_terms:

  89.           type: boolean

  90.         always_show_translate_tabs:

  91.           type: boolean

  92.         delete_tms_documents_upon_disassociation:

  93.           type: boolean

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

  95.         show_language_labels:

  96.           type: boolean

  97.         allow_local_editing:

  98.           type: boolean

  99.         language_specific_profiles:

  100.           type: boolean

  101.         target_download_status:

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

  103.           type: string

  104.         append_type_to_title:

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

  106.           type: boolean

  107.         enable_content_cloud:

  108.           type: boolean

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

  110.         enable_download_source:

  111.           type: boolean

  112.         enable_download_interim:

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

  114.           type: boolean

  115.           deprecated: "This option is unused since lingotek:3.8.0. Will be removed in lingotek:4.0.0"

  116.         content_cloud_import_format:

  117.           type: string

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

  119.         content_cloud_import_status:

  120.           type: integer

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

  122.         split_download_all:

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

  124.           type: boolean

  125.         contrib:

  126.           label: 'Contributed modules integrations settings'

  127.           type: mapping

  128.           mapping:

  129.             paragraphs:

  130.               label: 'Paragraphs module integration settings'

  131.               type: mapping

  132.               mapping:

  133.                 enable_bulk_management:

  134.                   type: boolean

  135.                   label: 'Enable bulk management for paragraphs'

  136.     intelligence:

  137.       type: mapping

  138.       label: 'Lingotek Intelligence settings'

  139.       mapping:

  140.         use_author:

  141.           type: boolean

  142.           label: 'Permission to Include Author'

  143.         default_author_email:

  144.           type: string

  145.           label: 'Default Author Email'

  146.         use_author_email:

  147.           type: boolean

  148.           label: 'Active'

  149.         use_contact_email_for_author:

  150.           type: boolean

  151.           label: 'Same as Contact Email'

  152.         business_unit:

  153.           type: string

  154.           label: 'Business Unit'

  155.         use_business_unit:

  156.           type: boolean

  157.           label: 'Active'

  158.         business_division:

  159.           type: string

  160.           label: 'Business Division'

  161.         use_business_division:

  162.           type: boolean

  163.           label: 'Active'

  164.         campaign_id:

  165.           type: string

  166.           label: 'Campaign Id'

  167.         use_campaign_id:

  168.           type: boolean

  169.           label: 'Active'

  170.         campaign_rating:

  171.           type: integer

  172.           label: 'Campaign Rating'

  173.         use_campaign_rating:

  174.           type: boolean

  175.           label: 'Active'

  176.         channel:

  177.           type: string

  178.           label: 'Channel'

  179.         use_channel:

  180.           type: boolean

  181.           label: 'Active'

  182.         contact_name:

  183.           type: string

  184.           label: 'Contact Name'

  185.         use_contact_name:

  186.           type: boolean

  187.           label: 'Active'

  188.         contact_email:

  189.           type: string

  190.           label: 'Contact Email'

  191.         use_contact_email:

  192.           type: boolean

  193.           label: 'Active'

  194.         content_description:

  195.           type: string

  196.           label: 'Content Description'

  197.         use_content_description:

  198.           type: boolean

  199.           label: 'Active'

  200.         external_style_id:

  201.           type: string

  202.           label: 'External Style ID'

  203.         use_external_style_id:

  204.           type: boolean

  205.           label: 'Active'

  206.         purchase_order:

  207.           type: string

  208.           label: 'Purchase Order'

  209.         use_purchase_order:

  210.           type: boolean

  211.           label: 'Active'

  212.         region:

  213.           type: string

  214.           label: 'Region'

  215.         use_region:

  216.           type: boolean

  217.           label: 'Active'

  218.         use_base_domain:

  219.           type: boolean

  220.           label: 'Active'

  221.         use_reference_url:

  222.           type: boolean

  223.           label: 'Active'

  224.     account:

  225.       type: mapping

  226.       label: 'Account'

  227.       deprecated: "Account settings are stored in lingotek.account config object since lingotek:4.0.0. Will be removed from schema in lingotek:5.0.0"

  228.       mapping:

  229.         use_production:

  230.           type: boolean

  231.           label: 'Use production'

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

  233.         sandbox_host:

  234.           type: string

  235.           label: 'Sandbox Host'

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

  237.         host:

  238.           type: string

  239.           label: 'Lingotek Host'

  240.         authorize_path:

  241.           type: string

  242.         default_client_id:

  243.           type: string

  244.         plan_type:

  245.           type: string

  246.         resources:

  247.           type: mapping

  248.           label: 'Resources'

  249.           mapping:

  250.             community:

  251.               type: sequence

  252.               sequence:

  253.                 type: string

  254.             project:

  255.               type: sequence

  256.               sequence:

  257.                 type: string

  258.             workflow:

  259.               type: sequence

  260.               sequence:

  261.                 type: string

  262.             vault:

  263.               type: sequence

  264.               sequence:

  265.                 type: string

  266.             filter:

  267.               type: sequence

  268.               sequence:

  269.                 type: string

  270.         access_token:

  271.           type: string

  272.         login_id:

  273.           type: string

  274.         callback_url:

  275.           type: string

  276.     translate:

  277.       type: mapping

  278.       label: 'Translate'

  279.       mapping:

  280.         entity:

  281.             type: sequence

  282.             sequence:

  283.               type: sequence

  284.               sequence:

  285.                 type: ignore

  286.         config:

  287.             type: sequence

  288.             sequence:

  289.               type: sequence

  290.               sequence:

  291.                 type: ignore

  292.         interface:

  293.             type: sequence

  294.             sequence:

  295.               type: sequence

  296.               sequence:

  297.                 type: ignore

  298.     field:

  299.       type: string

  300.     profile:

  301.       type: sequence

  302.       label: 'Profiles'

  303.       sequence:

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

  305. 

  306. lingotek.profile.*:

  307.   type: config_entity

  308.   label: 'Lingotek Profile'

  309.   mapping:

  310.     id:

  311.       type: string

  312.       label: 'ID'

  313.     label:

  314.       type: label

  315.       label: 'Label'

  316.     weight:

  317.       type: integer

  318.       label: 'Weight'

  319.     locked:

  320.       type: boolean

  321.       label: 'Locked'

  322.     auto_upload:

  323.       type: boolean

  324.       label: 'Automatic Upload'

  325.     auto_request:

  326.       type: boolean

  327.       label: 'Automatic request of translations'

  328.     auto_download:

  329.       type: boolean

  330.       label: 'Automatic Download'

  331.     auto_download_worker:

  332.       type: boolean

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

  334.     vault:

  335.       type: string

  336.       label: 'TM Vault'

  337.     project:

  338.       type: string

  339.       label: 'TM Project'

  340.     workflow:

  341.       type: string

  342.       label: 'TM Workflow'

  343.     append_type_to_title:

  344.       type: string

  345.       label: 'Append Content Type To Title'

  346.     intelligence_metadata:

  347.       type: mapping

  348.       mapping:

  349.         override:

  350.           type: boolean

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

  352.         use_author:

  353.           type: boolean

  354.           label: 'Permission to Include Author'

  355.         default_author_email:

  356.           type: string

  357.           label: 'Default Author Email'

  358.         use_author_email:

  359.           type: boolean

  360.           label: 'Active'

  361.         use_contact_email_for_author:

  362.           type: boolean

  363.           label: 'Same as Contact Email'

  364.         business_unit:

  365.           type: string

  366.           label: 'Business Unit'

  367.         use_business_unit:

  368.           type: boolean

  369.           label: 'Active'

  370.         business_division:

  371.           type: string

  372.           label: 'Business Division'

  373.         use_business_division:

  374.           type: boolean

  375.           label: 'Active'

  376.         campaign_id:

  377.           type: string

  378.           label: 'Campaign Id'

  379.         use_campaign_id:

  380.           type: boolean

  381.           label: 'Active'

  382.         campaign_rating:

  383.           type: integer

  384.           label: 'Campaign Rating'

  385.         use_campaign_rating:

  386.           type: boolean

  387.           label: 'Active'

  388.         channel:

  389.           type: string

  390.           label: 'Channel'

  391.         use_channel:

  392.           type: boolean

  393.           label: 'Active'

  394.         contact_name:

  395.           type: string

  396.           label: 'Contact Name'

  397.         use_contact_name:

  398.           type: boolean

  399.           label: 'Active'

  400.         contact_email:

  401.           type: string

  402.           label: 'Contact Email'

  403.         use_contact_email:

  404.           type: boolean

  405.           label: 'Active'

  406.         content_description:

  407.           type: string

  408.           label: 'Content Description'

  409.         use_content_description:

  410.           type: boolean

  411.           label: 'Active'

  412.         external_style_id:

  413.           type: string

  414.           label: 'External Style ID'

  415.         use_external_style_id:

  416.           type: boolean

  417.           label: 'Active'

  418.         purchase_order:

  419.           type: string

  420.           label: 'Purchase Order'

  421.         use_purchase_order:

  422.           type: boolean

  423.           label: 'Active'

  424.         region:

  425.           type: string

  426.           label: 'Region'

  427.         use_region:

  428.           type: boolean

  429.           label: 'Active'

  430.         use_base_domain:

  431.           type: boolean

  432.           label: 'Active'

  433.         use_reference_url:

  434.           type: boolean

  435.           label: 'Active'

  436.     filter:

  437.       type: string

  438.       label: 'TM Filter'

  439.     subfilter:

  440.       type: string

  441.       label: 'TM Subfilter'

  442.     language_overrides:

  443.       type: sequence

  444.       label: 'Target language settings overrides'

  445.       sequence:

  446.         type: mapping

  447.         mapping:

  448.           overrides:

  449.             type: string

  450.           custom:

  451.             type: mapping

  452.             mapping:

  453.               workflow:

  454.                 type: string

  455.                 label: 'TM Workflow'

  456.               vault:

  457.                 type: string

  458.                 label: 'TM Vault'

  459.               auto_request:

  460.                 type: boolean

  461.                 label: 'Automatic request of translation'

  462.               auto_download:

  463.                 type: boolean

  464.                 label: 'Automatic Download'

  465. 

  466. lingotek.lingotek_config_metadata.*:

  467.   type: config_entity

  468.   label: 'Lingotek Config Metadata'

  469.   mapping:

  470.     config_name:

  471.       type: string

  472.       label: 'Config name'

  473.     document_id:

  474.       type: string

  475.       label: 'Lingotek document id'

  476.     source_status:

  477.       type: sequence

  478.       sequence:

  479.         type: string

  480.     target_status:

  481.       type: sequence

  482.       sequence:

  483.         type: string

  484.     profile:

  485.       type: string

  486.       label: 'Lingotek profile'

  487.     hash:

  488.       type: string

  489.       label: 'Lingotek hash'

  490.     job_id:

  491.       type: string

  492.       label: 'Lingotek Job ID'

  493.     updated_timestamp:

  494.       type: timestamp

  495.       label: 'Updated date'

  496.     uploaded_timestamp:

  497.       type: timestamp

  498.       label: 'Initial upload'

  499. 

  500. language.entity.*.third_party.lingotek:

  501.   type: mapping

  502.   label: 'Lingotek locale mapping'

  503.   mapping:

  504.     disabled:

  505.       type: boolean

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

  507.     locale:

  508.       type: string

  509.       label: 'Lingotek locale code'