Category Code Import/Export Utility

This utility is used to import or export codes from a single category. The data file format supports handling of translated descriptions. For information about the import file format, refer to File Format.

When exporting, all the codes from the selected category will be exported. There is no way to export only a specific subset of the codes within a category. A link for the export file is available in the Result view of the utility after the export has occurred.

When importing codes, the order of the codes in the import file is retained as the sort order of the codes internally. The system automatically calculates and assigns a sequence number to each code that is created.

Note: If a 12000 – level HTML error is returned while running interactively: the IE Client has timed out, but the import will likely run to completion. Do not click RETRY. If a “thread was being aborted” error occurs: the import was terminated, and the Web Configuration setting: <httpRuntime executionTimeout="20000" …/> needs to be increased before running again.

In some cases, the data file or database being used to import codes may contain nulls. Maintenance of categories allows the category to be saved without displaying an error if the subcategory, group, subgroup, section, or subsection fields contain a NULL value. NULL values are saved to these fields during the category import process.

Note: The Category Code Full Text Search must be set up by your administrator before the Category Code Text Search functionality can be used.

In addition, if the Emplifi Agent account that connects to the database has privileges that allow dropping and creating of indexes, the full text index will be dropped and recreated to increase the utility’s processing speed, otherwise the index will stay in use during processing.

It is best practice to schedule the utility to create the data during off hours, as it will (if permitted) drop the index while the utility is creating the appropriate text. While the index is dropped, any other categories that already have their text search defined will return an error to the agent when trying to use text search. Once the utility has finished updating the text, the index is recreated, and all categories defined to text search will function properly.

Searchable words may be added to a code manually in Code Maintenance on the Text Search tab or by exporting the category using the Category Code Import/Export Utility, manually editing as desired, and then importing using the same utility. Automated addition to the list is possible using the Category Code Text Search Utility.

Note: Custom category code importers/exporters may need updated to support the new column.

To access the Category Code Import/Export Utility:

  • From the Application Function Bar, select Utilities  Configuration Utilities Category Codes Import/Export.

The following options are available for this utility:

Field Description

Process

Choose from one of the following three options:

  • Export Codes: This option will allow you to export all the codes from the selected category.
  • Import Codes: This option will allow you to import codes from a text file into the selected category.
  • Delete Codes: Use this option to completely remove all codes from the category. This is typically only done during an initial implementation. (Note that removing the codes from a category will not change any case data that already contains the deleted values.)

Category

Select the name of the category from which you will be importing or exporting. The internal category name (for example, "B05" or "C01") is auto filled into the right of the field.

Category Code Export Sort Order

When exporting codes, you have two options on how to sort the data in the export file:

  • Alphabetically: The data in the export file will be sorted in alphabetical order by the code names.
  • Sequential: The data in the export file will be sorted based on the sequence numbers assigned to each code. If more than one code has the same sequence number within a given folder, the sort order is undefined.

File Name

Import Process:

When importing, the file will be uploaded to the Emplifi Agent application server. If running interactively, the file can be located on a local drive or UNC path (for example, \\servername\mydirectory\myfile.txt").that is accessible from the client machine. If executing as a scheduled favorite, then the file must be accessible from the Emplifi Agent application server.

To upload a file to the Transfer folder:

  1. Select the Upload button . The Select File to Upload window will display.
  2. Click the Select File button to browse and select a file to upload from your machine.
  3. In the Upload to Folder field, select the sub-folder that will hold the file. Then, click OK.

Note: Uploading HTML files that contain <script> tags is not permitted.

Export Process:

A fully qualified UNC path and file name can be supplied, this path must be accessible from the Emplifi Agent application server. The other option is to just enter a file name. The system will then create the file under the website.

In either case the exported data will be presented in a link on the Results view. Clicking the link will open the file based on your local settings. If the file opens in the browser, you can save the exported data or copy and paste the data into a text editor.

When exporting, the file does not need to already exist. You can enter the UNC path and preferred name and the system will create the file. However, if the file name already exists, the system will append results to any existing content in the file. Entering just the filename with no path will always overwrite the file.

Delete All Codes First

This option is only applicable when importing codes. Selecting this option will cause any existing codes in the category to be deleted prior to importing. Use with caution!

Headers in First Row

Select this check box to include descriptions for each column as the first row of the exported text file.

It’s important to set the “Headers in first row” and “Include Translations” check boxes to the same state when importing as they were set during the export. Exports made with earlier versions of the utility are not compatible.

Include Translation

Select this check box to include the translation columns in the import/export process. You must also choose the language when selecting this column.

When importing, the system will add/update the translated descriptions if the code being imported exists, if the code does not exist it will add the code and the translations.

Process Translation Select the language of the translated columns to process in the import/export process.

Max Number of Errors

Select the number of errors that the import encounters before the import is canceled. Type a number between 0 and 999999. A max value of 0 means that the import stops on the first error. The field defaults to 10.

Leave the field blank to not limit processing due to errors. A negative value is the same as leaving the field blank (no limit).
Disable Maintenance Audit Trail

Select this check box to disable the maintenance audit trail from being updated when running an import. This will help increase performance.

Results Language

Select the results language for the utility.

The import/export file is a standard text file. There should be one record per line. Each of the columns should be separated by a tab character (ASCII code 9).

The layout of the columns in the file will differ slightly depending on the number of levels in the hierarchy.

For a single-level (codes only) hierarchy, the columns are as follows:

  • Code
  • Description
  • Description2
  • Description3
  • Category Specific
  • Alert InfoCenter Code
  • Catalog InfoCenter Code
  • Active Start
  • Active End
  • Text Search

Note: When editing the text_search column, do not embed carriage returns and tabs within the text.

For a multi-level hierarchy, there are four additional columns for each folder level in the hierarchy. These columns are:

  • Folder Code
  • Folder Description 1
  • Folder Description 2
  • Folder Description 3

For example, if you had a three-level hierarchy, the column sequence would match the following:

  • Level 1 Folder Code
  • Level 1 Folder Description
  • Level 1 Folder Description2
  • Level 1 Folder Description3
  • Level 2 Folder Code
  • Level 2 Folder Description
  • Level 2 Folder Description2
  • Level 2 Folder Description3
  • Code
  • Description
  • Description2
  • Description3
  • Active (Y or N)
  • Category Specific
  • Alert InfoCenter Code
  • Catalog InfoCenter Code
  • Active Start
  • Active End
  • Text Search

If you choose to include translations, the descriptions associated with the language you selected are added into the file relative to the value being exported. If the export is exporting folder information the file will contain the language translations before exporting the next folder information. For the above example if we choose to export a language the column order would be:

  • Level 1 Folder Code
  • Level 1 Folder Description
  • Level 1 Folder Description2
  • Level 1 Folder Description3
  • Level 1 Folder Translated Description
  • Level 1 Folder Translated Description2
  • Level 1 Folder Translated Description3

 

  • Level 2 Folder Code
  • Level 2 Folder Description
  • Level 2 Folder Description2
  • Level 2 Folder Description3
  • Level 2 Folder Translated Description
  • Level 2 Folder Translated Description2
  • Level 2 Folder Translated Description3

 

  • Code
  • Description
  • Description2
  • Description3
  • Translated Description
  • Translated Description2
  • Translated Description3
  • Active (Y or N)
  • Category Specific
  • Alert InfoCenter Code
  • Catalog InfoCenter Code
  • Active Start
  • Active End
  • Text Search

Tip: A simple way to determine the correct column order if you are unsure is to simply perform an export and view the resulting file.

If the Headers in First Row check box is selected, then a header row is included in the exported file. The columns are labeled using abbreviations as follows:

The hierarchy level is indicated by an “L” followed by a number which indicates:

  • “1” - Subcategory level
  • “2”- Group
  • “3”- Subgroup
  • “4”- Section
  • “5”- Subsection
  • “0”- code level

Following the Level, is the name for the column: “Code”, “Desc1” (Description 1), “Desc2” (Description 2), and “Desc3” (Description 3)

Code level, L0, also includes these additional attributes:

  • L0 Active (Active)
  • L0 FCR
  • L0 CS (Category Specific)
  • L0 Alert IC (Alert InfoCenter)
  • L0 IC Code (InfoCenter Code)
  • L0 Active Start (Active Start Date)
  • L0 Active End (Active End Date)
  • L0 Text Search

When the export includes translations, the translated header columns include the Language ID. A column labeled “fr L1 Desc3” indicates that the column contains the French (where the Language ID is “fr”) translation of description3 (Desc3) for Subcategory hierarchy level (L1). Only the Description 1, 2, and 3 columns are translated for each hierarchy level.

 

Related Topics Link IconRelated Topics