Adding a configuration bucket
A bucket is an XTM Connect – Git configuration container. It defines which new or updated files are taken for translation, from the repository, and when. It also defines when translated files are going to be returned, and where to.
Tip
You can create as many buckets as you want.
Log in to your XTM Cloud instance.
Note
When using XTM Cloud for the first time, you need to activate XTM Cloud on your computer.
In XTM Cloud, on the top navigation bar, select the XTM Connect tab.
In the XTM Connect tab screen, select the Buckets tab.
If you have more XTM Connect products configured on your XTM Cloud instance, in the Buckets tab screen, select Git.
On the right-hand side of the screen, select the Add bucket button.
Result: The Add bucket form is displayed.
In the Add bucket form, select suitable values for the following parameters:
Table 2. Add bucket form parametersParameter
Description
Mandatory/
Optional
Type
Valid values
General information section
Customer
Customer for whom you are creating the configuration bucket.
Mandatory
Dropdown
Predefined list of customers available in your XTM Cloud instance.
To learn how to create a new customer or edit an existing customer, go to the XTM Cloud documentation page, select the relevant version of XTM Cloud that you use and then search for the Customers section.
Bucket name
The unique name of your XTM Connect – Git configuration bucket.
Mandatory
Text field
Alphanumeric
Bucket name cannot contain any of the following symbols: ` ! @ # $ % ^ & * ( ) _ + - = [ ] ; ' : " \|, . & l t ; ' ; / ? ~
Description
Use this parameter to add further information about the configuration bucket.
Optional
Text field
Alphanumeric
Repository section
Source repository
A repository from which files are taken for translation.
Mandatory
Dropdown
Predefined list of repositories that has been configured by XTM Support during the installation of XTM Connect – Git.
The selected Source repository is automatically inserted in the Target repository field.
Target repository
A repository to which translated files are returned.
The target repository can be different from the source repository.
Mandatory
Dropdown
If you have selected the Source repository, the same value is automatically inserted in the Target repository field, but you can select a different value from the dropdown.
Predefined list of repositories that has been configured by XTM Support during the installation of XTM Connect – Git.
Branch section
Source branch
A branch in the repository from which files are taken for translation.
Mandatory
Dropdown
Predefined list of branches existing in the selected repository.
The selected Source branch is automatically inserted in the Target branch field.
Target branch
A branch in the repository to which files for translation are returned.
The target branch can be different from the source branch.
Mandatory
Dropdown
If you have selected the Source branch, the same value is automatically inserted in the Target branch field, but you can select a different value from the dropdown.
Predefined list of branches existing in the selected repository.
Project creation section
Create project
Use this parameter to set the repository bucket either for an automatic or a manual project creation.
Mandatory
Radio buttons
Valid values:
Automatically.
(default)
When you select it, the Frequency parameter is displayed.
Repository files are synchronized automatically at the specified times or frequency to create translation tasks based on any new content.
Manually.
Repository files have to be synchronized manually from the context menu for the relevant configuration bucket.
Frequency
This parameter is displayed if you have selected the Automatically option for the Create Project parameter.
Use this parameter to set the frequency at which the projects are automatically created for new or updated files in the selected repository or branch.
Mandatory if you have selected the Automatically option for the Create Project parameter.
Radio buttons
Valid values:
At intervals.
(default)
When you select it, the Repeat every parameter is displayed.
At set times.
When you select it, the Date parameter is displayed.
Repeat every
This parameter is displayed if you have selected the At intervals option for the Frequency parameter.
Use this parameter to specify the intervals at which projects are automatically created for new or updated files in the selected repository or branch.
Mandatory if you selected the At intervals option for the Frequency parameter.
Text field and dropdown
Valid values for the text field:
Numeric
Valid values for the dropdown:
Minutes.
Hours.
Days.
Weeks.
The minimal value is 1 minute, but we recommend no less than 5 minutes. The maximum entry is 999 weeks.
Date
This parameter is displayed if you have selected the At set times option for the Frequency parameter.
Use this parameter to set specific calendar day(s) and time(s) at which projects are automatically created for new or updated files in the selected repository or branch.
Mandatory if you have selected the At set times option for the Frequency parameter.
Multiselect
Valid values for days:
MON (Monday).
TUE (Tuesday).
WED (Wednesday).
THU (Thursday).
FRI (Friday).
SAT (Saturday).
SUN (Sunday).
To select a time of project creation for a specific day, select
Add.You can select multiple times for each selected calendar day.
Template
Use this parameter to specify which of the project templates defined in XTM Cloud is used for creating projects in this configuration bucket.
In the project template you can, for example, define workflow steps, assign Linguists to these steps and set an automatic workflow start.
Mandatory
Dropdown
Predefined list of project templates available in your XTM Cloud instance.
To learn how to define a new project template, go to the XTM Cloud documentation page, select the relevant version of XTM Cloud that you use and then search for the Project templates section.
Source language
Use this parameter to specify the source language of the new or updated files in the selected repository or branch.
Mandatory
Dropdown
The list of available languages depends on the customer specific settings.
To learn how to create a new customer or edit an existing customer, go to the XTM Cloud documentation page, select the relevant version of XTM Cloud that you use and then search for the Customers section.
Pre-processing
Use this parameter to select the pre-processing step for projects created based on this configuration bucket.
For more information about pre-processing, go to the XTM Cloud documentation page, select the relevant version of XTM Cloud that you use and then search for the Create a project: Translation topic.
Optional
Checkbox
Valid values:
Cleared (default)
Selected
When you select it, the New source language parameter is displayed.
New source language
This parameter is displayed if you selected the Pre-processing checkbox.
Mandatory if you selected the Pre-processing checkbox.
Dropdown
The list of available languages depends on the customer specific settings.
To learn how to create a new customer or edit an existing customer, go to the XTM Cloud documentation page, select the relevant version of XTM Cloud that you use and then search for the Customers section.
Target languages
Use this parameter to specify the target language(s) for the new or updated files from the selected repository or branch which need to be translated.
Mandatory
Multiple selection
The list of available languages depends on the customer specific settings.
To learn how to create a new customer or edit an existing customer, go to the XTM Cloud documentation page, select the relevant version of XTM Cloud that you use and then search for the Customers section.
Project name
Use this parameter to define a prefix that is to be added to the project name so that it is easily distinguishable from other projects in XTM Cloud.
Mandatory
Text field
Alphanumeric
Project name cannot contain any of the following symbols: ` ! @ # $ % ^ & * ( ) _ + - = [ ] ; ' : " \|, . & l t ; ' ; / ? ~
Continuous project
Use this parameter to create a configuration bucket that is to be used for continuous projects.
You can use continuous projects to update the files within an existing, active project, instead of creating a new project every time a file within your repository is updated with new content.
If the project set as a continuous project has been deactivated, XTM Connect – Git will try to reactivate the archived project.
Optional
Checkbox
Valid values:
Cleared (default)
Selected
Files section
Include files
Use this parameter to specify whether to import files from the entire branch or from a specific path within that branch.
Mandatory
Radio buttons
Valid values:
Whole branch.
Specific path.
When you select this option, the Path parameter is displayed.
Path
This parameter is displayed if you have selected the Specific path option for the Include files parameter.
Use it to specify the path(s) within a branch from which XTM Connect – Git should take files for translation.
Mandatory if you have selected the Specific path option for the Include files parameter.
Text field
Alphanumeric
To add a new path, select the plus icon
.To remove a path, select the minus icon
.File extension
Use this parameter to specify if all or only selected file types are imported for translation.
Mandatory
Radio buttons
Valid values:
All extensions.
Specify extensions.
When you select it, the Extensions parameter is displayed.
XML with key extraction.
This option is only displayed, if it has first been enabled by XTM Support. To request support, visit our Support Portal.
If you select this options, you will be able to select specific segments from the translated file and create a new project based on them.
Extensions
This parameter is displayed if you have selected the Specify extensions option for the File extension parameter.
Use this parameter to specify which file types from the branch or from a specific path within that branch are taken for translation.
Mandatory if you have selected the Specify extensions option for the File extension parameter.
Text field
Alphanumeric
File types separated by comma.
Example 1. File extensions:.docx,.pdf,.htmlRegular expression for file name
You can use multiple regular expressions (regexes) to specify the names of the files that are imported for translation.
XTM Connect – Git looks for file names that include the entire regular expression.
If you define multiple regular expressions, each of them is treated separately. This means a file name must match at least one of the regexes, not all of them.
Optional
Text field
Alphanumeric
To add a new regular expression, select the plus icon
.To remove a regular expression, select the minus icon
.Target mapping
Use this parameter to set target mapping.
Optional
Checkbox
Valid values:
Cleared (default)
Selected
Target mapping type
Use this parameter to specify which target mapping type is used in the configuration bucket.
Mandatory
Radio buttons
Valid values:
Target path mapping.
(default)
When you select it, two additional text fields are displayed.
Target language mapping.
When you select it, three additional text fields are displayed.
Target path mapping
Use this parameter to specify:
source path(s) from which the files should be imported AND
target path(s) to which they should be returned.
Mandatory if you have selected the Target path mapping option for the Target mapping type parameter.
Text fields
Alphanumeric
Enter:
source path in the Choose source path field.
target path in the Choose target path field.
To add an additional target path mapping, select the plus icon
.To remove a target path mapping, select the minus icon
.Target language mapping
Use this parameter to specify, for particular target language(s):
source path(s) from which the files should be imported AND
target path(s) to which they should be returned.
Mandatory if you have selected the Target language mapping option for the Target mapping type parameter.
Text fields and dropdown
Enter alphanumeric values for the text fields:
source path in the Choose source path field.
To add an additional source path for language mapping, select the plus icon
to the right of the target language dropdown.To remove a source path for language mapping, select the minus icon
to the right of the target language dropdown.target path in the Choose target path field.
To add an additional target path for language mapping, select the plus icon
to the right of the target language dropdown.To remove a target path for language mapping, select the minus icon
to the right of the target language dropdown.
From the dropdown, select target language which you want to map. The target languages list displays only languages selected in the Target languages parameter for the relevant configuration bucket.
Target files naming convention
Use this parameter to select a method for returning the translated files to your repository.
Mandatory
Dropdown
Valid values:
Add suffix with language code.
When you select this option, the Suffix pattern section is displayed.
Custom naming convention.
When you select this option, the Custom naming conventions for target files section is displayed. Use it to set file naming rule(s).
Return target files to language folder.
When you select this option, a new folder with the target language code in the folder name is created and the files are returned to this folder.
Return target files with unchanged names.
When you select this option, translated files are returned to the target folder with unchanged file names.
Suffix pattern section
Define a pattern for the suffix added to the file name
This parameter is displayed if you have selected the Add suffix with language code option for the Target files naming convention parameter.
Use it to specify the pattern for the suffix added to the target file name.
Mandatory if you have selected the Add suffix with language code option for the Target files naming convention parameter.
Multiple selection
Use one or more of these components to define the suffix pattern:
Alphanumeric characters
.File name cannot contain any of the following symbols: < > : " / \ |? *
LANGUAGE CODE (uppercase).
language code (lowercase).
REGIONAL CODE (uppercase).
regional code (lowercase).
Note
If you have selected either the REGIONAL CODE (uppercase) or the regional code (lowercase) component for your suffix pattern, but the relevant target language does not have regional code, this component is omitted in the relevant target file name suffix.
You can use each component multiple times.
The components that you have selected is displayed in the Rename to field, at the bottom of this section. To delete one of the suffix components, select the close icon
to the right of the relevant component. To delete all selected components, select Clear all to the right of the Suffix pattern section.Example 2. Suffix patternsAdding pattern
_language code (lowercase)to a pdf target file would generate a target file:example_en.pdfAdding pattern
_language code (lowercase)_REGIONAL CODE (uppercase)to a pdf target file would generate a target file:example_en_US.pdfCustom naming conventions for target files section
Language
This parameter is displayed if you have selected the Custom naming convention option for the Target files naming convention parameter.
Use it to specify if the target naming rule should refer to all or only selected target language(s).
Mandatory if you selected the Custom naming convention option for the Target files naming convention parameter.
Multiple selection
Valid values:
All languages (default).
Predefined list of target languages selected for the relevant bucket. Select one or more of the target languages, by selecting or clearing the relevant checkboxes.
Apply to specific file extensions
This parameter is displayed if you have selected the Custom naming convention option for the Target files naming convention parameter.
Use it to apply your custom file name to specific file type(s).
Optional
Checkbox
Valid values:
Cleared (default)
Selected
When you select the Apply to specific file extensions checkbox, the mandatory File extension text field is displayed.
File extension
This parameter is displayed if you have selected the Custom naming convention option for the Target files naming convention parameter and the Apply to specific file extensions checkbox.
Use it to specify the file type(s) for which your custom name applies.
This setting does not overwrite the options selected for the entire bucket. If you have selected
.docand.htmlas file extensions taken for translation in the relevant bucket and you add additional extensions in this parameter, these additional file types are NOT considered.Mandatory if you selected the Apply to specific file extensions checkbox.
Text field
Alphanumeric
File types separated by a comma.
Example 3. File extensions:.docx,.pdf,.htmlApply to specific source files
This parameter is displayed if you have selected the Custom naming convention option for the Target files naming convention parameter.
Use it to apply your custom target file name to specific source file name(s).
Optional
Checkbox
Valid values:
Cleared (default)
Selected
When you select the Apply to specific file extensions checkbox, the mandatory Source file names matching the following regex pattern text field is displayed.
Source file names matching the following regex pattern
This parameter is displayed if you have selected the Custom naming convention option for the Target files naming convention parameter and the Apply to specific source files checkbox.
Use it to specify the source file name(s) for which your custom target file naming rule applies. To do so, use a regular expression. Your rule will be applied for all files whose names are the same as or contain the defined pattern.
Mandatory if you have selected the Apply to specific source files checkbox.
Text field
Alphanumeric characters used in regular expressions.
Regex must match the entire file name. You can use wildcard characters used in regular expressions, for example:
*,?,#.Target file name pattern (regex)
This parameter is displayed if you have selected the Custom naming convention option for the Target files naming convention parameter.
Use it to create customized target file name patterns by using the available components.
Mandatory if you selected the Custom naming convention option for the Target files naming convention parameter.
Multiple selection
Select one or more of these components to specify the file name pattern:
Partial source file name
.When you select this component, a text field is displayed. In this field, enter the relevant regular expression to identify the required part of the source file name. If the specified phrase is not found in the source file name, this component will not be included in the target file name.
LANGUAGE CODE (uppercase).
language code (lowercase).
REGIONAL CODE (uppercase).
regional code (lowercase).
Note
If you have selected either the REGIONAL CODE (uppercase) or the regional code (lowercase) component for your suffix pattern, but the relevant target language does not have regional code, this component is omitted in the relevant target file name suffix.
Alphanumeric characters
.When you select this component, a text field is displayed. In this field, enter the relevant alphanumeric characters. File name cannot contain any of the following symbols: < > : " / \|? *
Source file name.
When you select this component, the whole source file name is added to the customized target file name.
Source file extension.
The source file extension is added at the end of your custom target file name, even if you do not select this component.
Example 4. Usage of the Source file extension optionIf your source file is called
example.pdfand you add the[Source file extension]patters, your target file name will be:examplepdf.pdf, because the original extension is always added at the end of the target file.
You can use each component multiple times.
The components that you selected are displayed in the Rename to field, below the Target file name pattern (regex) parameter. To delete one of the target file name components, select the close icon
to the right of the relevant component. To delete all selected components, select the Clear all button to the right of the Target file name pattern (regex) section.If any target files have the same name:
This parameter is displayed if you have selected the Custom naming convention option for the Target files naming convention parameter.
Your custom file naming rules are likely to apply to multiple files. We therefore recommend that you use custom naming patterns to avoid duplicate target file names. Also use this parameter to specify what should happen if two or more target files have the same name.
Mandatory
Radio buttons
Select one of the valid values:
overwrite file names.
When you select this option, any repeated file(s) are replaced by the newest translated file with this name. So, there only remains one file with the relevant name.
add suffix with underscore and number.
When you select this option, a suffix consisting of an underscore and a number is added to any repeated file name(s).
Example 5. File namesfile_1, file_2, file_3
If you have selected the Custom naming convention option for the Target files naming convention parameter and set all the relevant Custom naming conventions for target files section parameters, to add a new target file naming rule, select the Add rule button. You can add multiple target file naming rules.
Result: Your new custom naming rule(s) is added to the Target naming rules table with the next available sequential number.
Note
The sequence of the rules in the list indicates the priority of each rule. The highest position in the list indicates the highest priority.
Example 6. Rule priorityIf a particular file fulfills the requirements of the 1st rule on the list, this rule applies and no other rule is checked.
If a particular file does not fulfill the requirements of the 1st rule on the list, the subsequent rule(s) are checked.
If a particular file does not fulfill the requirements of any of the rules from the list, the files are returned to the repository with unchanged names. The result is the same as if you had selected the Return target files with unchanged names option for the Target files naming convention parameter.
To change the position of a particular rule in the list, hover over the relevant rule, Then, use the table icon
, located to the left of the relevant rule to drag and drop it to the correct place.In the Target naming rules table you see:
the Rule column with the ordinal number of the rule in the list, which also indicates its priority. To change the position of a particular rule in the list, use the table icon
, located to the left of the relevant rule.the Language column. – It displays target language(s) to which the relevant rule applies.
the Filename extension column. – It displays file extension(s) for which the relevant rule applies. This setting has been specified in the Custom naming conventions for target files section, in the File extension parameter. When this column is empty, the relevant rule is applicable for all file extensions specified for the relevant configuration bucket in the Files section in the File extensions parameter.
the Source files matching column. – It displays regex entered in the Source file names matching the following regex pattern parameter, which specifies source file name(s) to which the relevant rule applies.
the Target name pattern column. – It displays target name pattern defined in the Target file name pattern (regex) parameter.
the edit icon
. – Use it to edit the relevant rule. Make your changes in the Update rule popup. To confirm them, in the popup, select the Update rule button. To cancel your changes, select the Cancel button.the delete icon
. – Use it to permanently delete the relevant rule. To confirm the permanent deletion, in the Remove popup, select the Remove rule button. To cancel the rule deletion, select the Cancel button.
To finalize, select:
Add bucket button at the bottom of the screen to create a new bucket based on the selected criteria.
Cancel button at the bottom of the screen to cancel configuration bucket creation. In the Confirm popup, select:
Confirm to cancel the adding of a new configuration bucket.
Cancel to continue with bucket creation.
the close icon
in the top right-hand corner of the Add bucket form to cancel configuration bucket creation. In the Confirm popup, select:Confirm to cancel the adding of a new configuration bucket.
Cancel to continue with bucket creation.