Self Help Online Studio - Description of an Excel Metadata File
Description of the Excel metadata file
Metadata, also known as attributes, are properties in a Self Help project that are applicable to all of the project procedures.
You can perform a mass update using an Excel file.
Characteristics of the Excel file
- File in CSV format
- Name of the file: <Project ID>_metadata.csv
- The file contains:
- For each procedure, one row for each writing language used in the Self Help project.
- One column for each procedure metadata (general and specific properties). Translated values are displayed in each writing language.
Caution
- You must not modify the Locale, ID, ScenarioId and Path columns because they are required for identifying procedures. If you do so, the Excel file will no longer be valid. These are indicated in red in the description of the Excel file.
- You must not add any rows to the Excel file. You must not delete any rows from the file. You must not modify the header row.
NonLocatedMetadata_Caution
- For non-translated metadata, the cell value in the last row of the procedure will be taken into account.
example The file contains two rows for a procedure written in English and in French
- The dialogFriendly metadata is not translatable.
- The true value found in the last row is taken into account instead of the false value found in the first row.
EndNonLocatedMetadata_Caution
Description of the Excel file
Note: Columns whose background color is red must not be modified.
Column | Metadata | Description | |
---|---|---|---|
A | Locale | Writing language
example English US: en_US; French: fr_FR Note: If the Self Help project is not translated, the value for the language will be value. |
|
B | Name | Title of the procedure, in a string of characters | |
C | Description | Description of the procedure, in a string of characters | |
D | Status | Status of the procedure in the content validation workflow
List of values authorized:
|
|
E | Alias | Alias attributed to the procedure
Note:
|
|
J | ProcedureCategoryDescription | Description of the procedure category, in a translated string of characters | |
K | ProcedureSubCategory | Sub-category of the procedure, in a translated string of characters | |
L | agentFlag | Method for running the procedure. ![]() List of values authorized:
|
|
M | dialogFriendly | Used to indicate if the procedure should open in the virtual agent's conversation panel (value true) or in a side pane (another value or false by default). ![]() |
|
N | ProcedureViewable | Used to indicate if the procedure should be indexed by the search engine (value true) or not (another value or false by default). | |
O | ProcedureMetaDescription | HTML meta tags associated with the procedure, in a translated string of characters | |
P | ProcedureSubCategoryDescription | Description of the procedure sub-category, in a translated string of characters | |
Q | ProcedureCategory | Category of the procedure, in a translated string of characters | |
R | tags | List of keywords associated with the procedure displayed in a tag cloud. When you click one of the keywords, this will return one or more Self Help help procedures, in a translated string of characters. ![]() Note: Tags must be separated using the semi-colon (;) |
|
S | intentAlt | List of alternative ways of asking a given question that will open the same virtual agent procedure, in a translated string of characters. ![]() example (user questions) What is software X? / What is software X used for? / What can I do with software X? Note: Questions must be separated using the dot (.), exclamation mark (!) or question mark (?). |
|
Other columns | List of all specific metadata associated with the Self Help project |