{"id":24171,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/item-data-xml-import-1\/"},"modified":"2025-02-14T10:21:27","modified_gmt":"2025-02-14T18:21:27","slug":"item-data-xml-import-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/","title":{"rendered":"Item Data XML Import"},"content":{"rendered":"

\n\tBatch Mode<\/h2>\n

This function is driven from the Import\/Export<\/b> tab of the Administration<\/b> menus, in the function named Item Data XML Import<\/b>. When you access this function, you will see a screen similar to the following:<\/p>\n

<\/p>\n

Batch interface to load an XML item file<\/span><\/p>\n

Only a \u201cmerge\u201d function is imported at this point in time. Future versions will support additional methods of importing item data. Use the Browse button to navigate to the XML file containing the item data to be imported. Then press the Upload XML file. Be prepared to wait until the XML data file is uploaded to the server. This may take some time, depending upon its size.<\/p>\n

Note<\/b>: To save time on a large import, you may zip the input file and upload the zipped file. ExtraView will automatically unzip the uploaded file.<\/p>\n

<\/p>\n

Results screen from a batch XML import<\/span><\/p>\n

While the file is being processed, you will see a status bar informing you of progress. Once complete, you will see a screen similar to the one above. If there are any errors in the import file, you will see these on the results screen.<\/p>\n

\n\tAPI Commands<\/h3>\n

These commands are also explained in the ExtraView CLI & API Guide.<\/p>\n

An API action named xml_insert creates a new record or records in the ExtraView database from input formatted as XML. The input can be made as part of the HTTP data stream, or can be input from a file in XML format.<\/p>\n

Syntax:<\/p>\n

http:\/\/www.myserver.com\/evj\/ExtraView<\/em>\/ev_api.action?
\n\tuser_id=username<\/em>
\n\t&password=password<\/em>
\n\t&statevar=insert_xml
\n\t&xml_file_name=filename<\/em> | &xml_string=xml_data<\/em>
\n\t&template_file=file.html<\/em> <\/span><\/p>\n

    \n
  • \n\t\tProvide either the xml_file_name<\/span> or xml_string<\/span>, but not both. You provide xml_file_name if the input is from a file that exists at the time of the execution of the command. You provide xml_string<\/span>, if the data for the insert is provided as part of the HTTP request. This string contains the XML data to be parsed.<\/li>\n
  • \n\t\ttemplate_file<\/span> is the name of the template to be used for return value string generation. Generally, this template file is stored on the server in the WEB-INF\/user_templates<\/span> directory. On normal completion of the operation, this template undergoes parameter substitution with the following variable names:
    \n\t\t <\/p>\n\n\n\n\n\n\n
    \n\t\t\t\t\t\tTag<\/td>\n\n\t\t\t\t\t\tExplanation<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\t__ID__<\/span><\/td>\n\n\t\t\t\t\t\tThe item number of the last item inserted<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\t__NUMBER_ITEMS_INSERTED__<\/span><\/td>\n\n\t\t\t\t\t\tThe number of inserted items<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\t__ITEM_TITLE__<\/span><\/td>\n\n\t\t\t\t\t\tThe title of the ITEM_ID dictionary entry<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    \n\t\tSee the section on Templates in the ExtraView CLI & API Guide, for a full explanation of how to create user templates<\/p>\n

    \t\tIf no template file is requested, the command returns a completion message to the calling program via HTTP.<\/p>\n

    \t\tOn error completion, the return string contains an error message substituted into the error.html<\/span> user template in the format:<\/p>\n

    \t\terror-message \u201cat line=xxx and column number=yyy\u201d<\/span><\/p>\n

    \t\twhere xxx<\/span> and yyy<\/span> are the values returned by the XML parser.<\/p>\n

    \t\tAs an example, the following message may be returned:<\/p>\n

    \t\t\u201cThe end-tag for element type “ITEM” must end with a ‘>’ delimiter at line=8 and column number=9\u201d<\/span>
    \n\t\t <\/li>\n

  • \n\t\tOnly one record should be inserted with the XML_STRING<\/span> in one call to the API. When the input is in a file, there is no restriction to the number of records in a single operation.<\/p>\n

    \n\t\t\tItem Data Import Errors<\/h3>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    \n\t\t\t\t\t\tError Message<\/td>\n\n\t\t\t\t\t\tExplanation<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tAmbiguous Area title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe business area title in the XML is not unique within the database. Use its name instead.<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tAmbiguous Module title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe module with the title is not unique. Use the module name in this case to avoid conflicts<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tAmbiguous Project title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe project title in the XML is not unique within the database. Use its name instead.<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tAmbiguous Repeating record title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe repeating record with the title is not unique. Use the name in this case to avoid conflicts<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tAmbiguous UDF title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe UDF with the title is not unique. Use the UDF name in this case to avoid conflicts<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tBad zip file or invalid XML tag at beginning of file<\/td>\n\n\t\t\t\t\t\tExtraView cannot read the zip file with the XML data, or the XML tag at the beginning of the file is invalid<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tCannot dereference list entry for ddname [value<\/em>]<\/td>\n\n\t\t\t\t\t\tThere is no list value corresponding to the value<\/em> for the data dictionary name<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tEnd Attachment tag outside Attachment<\/td>\n\n\t\t\t\t\t\tThe end attachment tags must be at the end of the attachment data<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tEnd item tag outside item<\/td>\n\n\t\t\t\t\t\tThe end item tags must be at the end of the item data<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tEnd module tag outside module<\/td>\n\n\t\t\t\t\t\tThe end module tags must be at the end of the module data<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tEnd name<\/em> tag outside name<\/em><\/td>\n\n\t\t\t\t\t\tThe end name tags must be at the end of the name data<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tEnd Repeating record tag outside Repeating record<\/td>\n\n\t\t\t\t\t\tThe end repeating row tags must be at the end of the repeating row data<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tEnd UDF tag outside UDF<\/td>\n\n\t\t\t\t\t\tThe end UDF tags must be at the end of the UDF data<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tIllegal NAME construct ignored<\/td>\n\n\t\t\t\t\t\tProvide valid name constructs<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tInvalid characters in the title value: [value<\/em>]<\/td>\n\n\t\t\t\t\t\tThe title value contains illegal characters<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo ddentry for dereferenced name: dd_name<\/em><\/td>\n\n\t\t\t\t\t\tThere is no data dictionary entry corresponding to dd_name<\/em><\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo Area with title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe business area with the title<\/em> does not exist in the database<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo Module with title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe module with the title does not exist<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo product name for module: name<\/em><\/td>\n\n\t\t\t\t\t\tYou must always provide the product_name field in the XML when adding modules<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo product name for release: name<\/em><\/td>\n\n\t\t\t\t\t\tYou must always provide the product_name field in the XML when adding repeating records which are dependent upon this field<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo Project with title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe project with the title<\/em> does not exist in the database<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo Repeating record with title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe repeating record with the title does not exist<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo such XML file: file_name<\/em><\/td>\n\n\t\t\t\t\t\tIndicates the input XML file does not exist<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNo UDF with title: title<\/em><\/td>\n\n\t\t\t\t\t\tThe UDF with the title does not exist in the data dictionary<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tNothing to convert from XML to DB; quitting<\/td>\n\n\t\t\t\t\t\tInput XML file appears to be empty<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tUnrecognized end element tag: name<\/em><\/td>\n\n\t\t\t\t\t\tThe end tag for the name does not match the beginning tag for the name<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tUnrecognized start element tag: tag_name<\/em><\/td>\n\n\t\t\t\t\t\tThe element tag name is not valid<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tWARNING: this source locale: [locale<\/em>] is not available in target system<\/td>\n\n\t\t\t\t\t\tThe DTD indicated that a locale is to be used that does not exist within the ExtraView installation<\/td>\n<\/tr>\n
    \n\t\t\t\t\t\tValidation exception: exception<\/em><\/td>\n\n\t\t\t\t\t\tGeneral validation exception, as given in exception<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"

    Batch Mode This function is driven from the Import\/Export tab of the Administration menus, in the function named Item Data XML Import. When you access this function, you will see a screen similar to the following: Batch interface to load an XML item file Only a \u201cmerge\u201d function is imported at this point in time….<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24165,"menu_order":5,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24171","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nItem Data XML Import - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Item Data XML Import - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Batch Mode This function is driven from the Import\/Export tab of the Administration menus, in the function named Item Data XML Import. When you access this function, you will see a screen similar to the following: Batch interface to load an XML item file Only a \u201cmerge\u201d function is imported at this point in time....\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-14T18:21:27+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/\",\"name\":\"Item Data XML Import - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-14T18:21:27+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Administration Guide\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Import \/ Export\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Item Data XML Import\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Item Data XML Import - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/","og_locale":"en_US","og_type":"article","og_title":"Item Data XML Import - Product Documentation","og_description":"Batch Mode This function is driven from the Import\/Export tab of the Administration menus, in the function named Item Data XML Import. When you access this function, you will see a screen similar to the following: Batch interface to load an XML item file Only a \u201cmerge\u201d function is imported at this point in time....","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-14T18:21:27+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/","name":"Item Data XML Import - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-14T18:21:27+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/item-data-xml-import-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Administration Guide","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/"},{"@type":"ListItem","position":4,"name":"Import \/ Export","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/import-export-1\/"},{"@type":"ListItem","position":5,"name":"Item Data XML Import"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24171","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24171"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24171\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24165"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24171"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}