Jump to content

Module: Import Pages from CSV file


ryan

Recommended Posts

In our use case we needed to import thousands of CSV entries automatically per cronjob.

So we ended up with a little shell script using the CSV package by the League of Extraordinary Packages and custom logic to import the CSV entries as pages.

This wasn't that difficult thanks to the Composer integration of ProcessWire. ;)

Regards, Andreas

  • Like 3
Link to comment
Share on other sites

  • 1 year later...

Hi Guys,

In short: I would like to base the template and parent of the imported pages to be based on values in the csv

Great work on the module Ryan, it's a very useful extension to Processwire indeed! 🙂 
I was wondering if it would be possible to set multiple templates for the pages that are created, maybe based on a .csv field value?

I'm using Padloper for variation products which ends up looking like this:

- Parent Product Page       ( needs productprarent template )
     - Variation child page   ( needs variation template )
     - Variation child page
     - Variation child page

so In my cvs file I guess I would use something like this?

Type          template               title              color               price            image
Parent       productparent      T-Shirt                                5   
Child         variation                T-Shirt         Blue                                     templates/img/blue.jpg
Child         variation                T-Shirt         Red                                      templates/img/red.jpg
Child         variation                T-Shirt         Green                                  templates/img/green.jpg   

This way I could create a parent of all sets of children, if values aren't filled there the system uses the price of the parent.
I was thinking of something in de lines of:

 

if($CsvLine->type == "Child") {
    $page->parent = $parent($CsvLine->title);
}


if takes makes any sense :')

Do you think something like this could be done?

Thanks in advance! 🙂
Bram

 

  • Like 1
Link to comment
Share on other sites

  • 1 month later...
  • 1 month later...
On 4/15/2019 at 1:25 PM, bramwolf said:

Hi Guys,


In short: I would like to base the template and parent of the imported pages to be based on values in the csv

Great work on the module Ryan, it's a very useful extension to Processwire indeed! 🙂 
I was wondering if it would be possible to set multiple templates for the pages that are created, maybe based on a .csv field value?

I'm using Padloper for variation products which ends up looking like this:

- Parent Product Page       ( needs productprarent template )
     - Variation child page   ( needs variation template )
     - Variation child page
     - Variation child page

so In my cvs file I guess I would use something like this?

Type          template               title              color               price            image
Parent       productparent      T-Shirt                                5   
Child         variation                T-Shirt         Blue                                     templates/img/blue.jpg
Child         variation                T-Shirt         Red                                      templates/img/red.jpg
Child         variation                T-Shirt         Green                                  templates/img/green.jpg   

This way I could create a parent of all sets of children, if values aren't filled there the system uses the price of the parent.
I was thinking of something in de lines of:

 


if($CsvLine->type == "Child") {
    $page->parent = $parent($CsvLine->title);
}


if takes makes any sense :')

Do you think something like this could be done?

Thanks in advance! 🙂
Bram

 

Hi Bram, 

Did you find a solution for it? I'm looking also for an option to import products in the same way.

Link to comment
Share on other sites

  • 3 months later...

Is it possible to import users with this module?

When I try I get the error

Unable to import page because it has no required 'title' field or it is blank.

If I add a title column to the CSV it doesn't show on the next page. I simply get a 'title' select field to map it like the other field but no title field shows in the in the dropdown.

Link to comment
Share on other sites

@Guy Incognito

did you do everything renobird wrote in his post on page #4 of this thread?
In particular "... In order for title to show as a connection option during your import, you need to add the title field to the user template file. ..."
http://processwire.com/talk/topic/383-module-import-pages-from-csv-file/?p=10160

For me the import works, I just edited ~200 users.

  • Like 2
  • Thanks 1
Link to comment
Share on other sites

9 hours ago, Ralf said:

@Guy Incognito

did you do everything renobird wrote in his post on page #4 of this thread?
In particular "... In order for title to show as a connection option during your import, you need to add the title field to the user template file. ..."
http://processwire.com/talk/topic/383-module-import-pages-from-csv-file/?p=10160

For me the import works, I just edited ~200 users.

Hi @Ralf - thanks for this - completely missed Reno's note but this sounds like my exact issue and will try it out today.

Link to comment
Share on other sites

Hi all, new processwire user here. I am trying to to import a number of post with Chinese/UTF-8 titles, but the module can only import those with latin characters. Can anyone advise me how to solve it? The best is for sure to display the  UTF-8 permalink same with the title, but it's also okay just to have permalinks with numbers or random characters. Any advice for the tweak or pointing me the right direction of changing the code is appreciated. 

Link to comment
Share on other sites

Hi all , just an update regarding my question. I found out it's due to the importPageValue function. The processwire path sanitizer cannot create the appropriate path name and it leds to a failure of creating pages without an ascii character on the title.  

            $page->set($name, $value); 
            if($name == 'title') $page->name = $this->sanitizer->pageName($value, 2); // Sanitizer::translate
 

I tried appending a rand at the end of $page->name and the csv can be imported. However no matter whether I tried

$this->sanitizer->pageName(utf8decode($value), 2)

Or

$this->sanitizer->pageName($value, Sanitizer::toUTF8)

They do not work. Can anyone advise me if anything is done wrongly? 

Thanks all. 

Link to comment
Share on other sites

Welcome to the PW forums @eddietoast!

Check that you have extended page name support enabled: https://processwire.com/blog/posts/page-name-charset-utf8/

That may be all you need to get Chinese page names working, but I've noticed that people have had a few questions/problems with Chinese characters, particularly regarding the $config->pageNameWhitelist setting. 

In this issue Ryan seems to recommend setting $config->pageNameWhitelist to empty, but then in this issue an empty value for that setting seemed to cause a different problem. And the topic linked to below has some related discussion:

If you find you can't get Chinese page names working then please open an issue at Github because it sounds like this is something that might need some attention from Ryan. Or if you do get it working please make a post in the tutorials section explaining what settings you used.

An alternative might be to use my recently released Sanitizer EasySlugger to create latin page names from Chinese characters. To do that I expect you would need to edit the ImportPagesCSV module to call $sanitizer->utf8Slugger() when the pages are created. Or you might like to use the code I posted here (it's an addon action for the Admin Actions module) as a starting point for your own custom CSV import action.

P.S. Please use the code button in the forum post editor toolbar when you are including code in a post.

  • Like 1
Link to comment
Share on other sites

HI @Robin S

I tried testing Chinese characters with the white list yesterday and realised it should be the problem. I added a Chinese character in the whitelist and that character can be used for names,

$config->pageNameWhitelist = '_.abcdefghijklmnopqrstuvwxyz0123456789æåäßöüđжхцчшщюяàáâèéëêěìíïîõòóôøùúûůñçčćďĺľńňŕřšťýžабвгдеёзийклмнопрстуфыэęąśł我';

Building a white list for Chinese characters can be a problem (in terms of quantity) so I ended up using RAND() as a temporary solution. 

And thanks for recommending the slugger and I think it's very useful. I just wonder whether it supports Cantonese conversion as well? Anyway I will test further and see how it works. 

Many thanks for your reply and noted on the code formatting in the post ; ).  

 

  • Like 1
Link to comment
Share on other sites

  • 2 months later...

Short note for all those who use this module.

In a fresh install of ProcessWire 3.0.148 this module (yes, it's only officially support until 2.7 - but still) stopped working properly.

Settings like skipping existing pages/entries will be ignored and the import into date fields is not possible at all.

Last working environment I can confirm is ProcessWire 3.0.133.

  • Like 3
Link to comment
Share on other sites

  • 1 month later...
  • 1 month later...
  • 4 weeks later...

The timing on this update saved me tons of work, thanks @ryan!

I'm using the guide to importing users from page 3 of this topic, but I am having no luck pulling the roles in. How should I format these in my csv? I tried spelling out the name of the roles as well as using the ids, with and without spaces inside the quotes. 

EDITED for solution:

within the "", each role name is spelled out on its own line, so:

"guest
login-register
team-member
download"

 

 

Edited by creativejay
solved it
Link to comment
Share on other sites

  • 1 month later...

Hello Ryan,

thank you for the updated version of the module.
Unfortunately, I have found a mistake in the module:

In the monolingual version of Processwire (3.0.148) everything works fine yet when you update the imported pages (modify the existing page) a warning appears:
Warning: count(): Parameter must be an array or an object that implements Countable in ...\site\modules\ImportPagesCSV\ImportPagesCSV.module on line 515

In the multilingual version of Processwire (3.0.148) the title field is not filled in. And the same warning appears when you update the imported pages.

Furthermore, I have prepared a multilingual import CSV with "|" and imported the data. Unfortunately, that did not work as expected.

My CSV file:
"Article Name","Price","externalID"
"Apfel A"|"Apple A",1.25,abc123
"Apfel B"|"Apple B",1.15,abc124
"Birne B"|"Pear B",1.35,abc125

Resultat:
$Page->name:
apfel-a-apple-a
apfel-b-apple-b
birne-b-pear-b

$Page->title: NULL

Could you please provide an examplary CSV structure for the multilingual version?

Kind regards
Wlad

Link to comment
Share on other sites

  • 2 weeks later...

Hi, 

I use this module to import a collection of clothes. I use the FieldTypePage in my product template for the sizes. If the size page title/name is a number the import script can't find the page and I get te following error.

FieldtypePage: Unable to locate page match for: 128

  • ProcessWire 3.0.158 dev
  • ImportPagesCSV 1.0.8
Link to comment
Share on other sites

  • 2 months later...

Hi everyone!

Was wondering if anyone been getting this error when you import? 
 

Quote

Warning: count(): Parameter must be an array or an object that implements Countable in D:\XAMPP\htdocs\d2g2\site\modules\ImportPagesCSV\ImportPagesCSV.module on line 515

Been scratching my head on this. Checked 515 and this is what I got. 

		if($page->id && count($page->get('ImportPagesCSVData'))) {

Any idea what's tripping it? 
 

Link to comment
Share on other sites

21 minutes ago, Pip said:

Hi everyone!

Was wondering if anyone been getting this error when you import? 
 

Been scratching my head on this. Checked 515 and this is what I got. 


		if($page->id && count($page->get('ImportPagesCSVData'))) {

Any idea what's tripping it? 
 

PS: Import goes in still btw. Whether if it's correct or not, I have to double check as I've added in hundreds. 😕 

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      This module lets you add some custom menu items to the main admin menu, and you can set the dropdown links dynamically in a hook if needed.
      Sidenote: the module config uses some repeatable/sortable rows for the child link settings, similar to the ProFields Table interface. The data gets saved as JSON in a hidden textarea field. Might be interesting to other module developers?
      Custom Admin Menus
      Adds up to three custom menu items with optional dropdowns to the main admin menu.
      The menu items can link to admin pages, front-end pages, or pages on external websites.
      The links can be set to open in a new browser tab, and child links in the dropdown can be given an icon.
      Requires ProcessWire v3.0.178 or newer.
      Screenshots
      Example of menu items

      Module config for the menus

      Link list shown when parent menu item is not given a URL

      Advanced
      Setting child menu items dynamically
      If needed you can set the child menu items dynamically using a hook.
      Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $colours = $event->wire()->pages->findRaw('template=colour', ['title', 'url', 'page_icon']); $children = []; foreach($colours as $colour) { // Each child item should be an array with the following keys $children[] = [ 'icon' => $colour['page_icon'], 'label' => $colour['title'], 'url' => $colour['url'], 'newtab' => false, ]; } $event->return = $children; } }); Create multiple levels of flyout menus
      It's also possible to create multiple levels of flyout submenus using a hook.

      For each level a submenu can be defined in a "children" item. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $children = [ [ 'icon' => 'adjust', 'label' => 'One', 'url' => '/one/', 'newtab' => false, ], [ 'icon' => 'anchor', 'label' => 'Two', 'url' => '/two/', 'newtab' => false, 'children' => [ [ 'icon' => 'child', 'label' => 'Red', 'url' => '/red/', 'newtab' => false, ], [ 'icon' => 'bullhorn', 'label' => 'Green', 'url' => '/green/', 'newtab' => false, 'children' => [ [ 'icon' => 'wifi', 'label' => 'Small', 'url' => '/small/', 'newtab' => true, ], [ 'icon' => 'codepen', 'label' => 'Medium', 'url' => '/medium/', 'newtab' => false, ], [ 'icon' => 'cogs', 'label' => 'Large', 'url' => '/large/', 'newtab' => false, ], ] ], [ 'icon' => 'futbol-o', 'label' => 'Blue', 'url' => '/blue/', 'newtab' => true, ], ] ], [ 'icon' => 'hand-o-left', 'label' => 'Three', 'url' => '/three/', 'newtab' => false, ], ]; $event->return = $children; } }); Showing/hiding menus according to user role
      You can determine which menu items can be seen by a role by checking the user's role in the hook.
      For example, if a user has or lacks a role you could include different child menu items in the hook return value. Or if you want to conditionally hide a custom menu altogether you can set the return value to false. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); $user = $event->wire()->user; // For custom menu number 1... if($menu_number === 1) { // ...if user does not have some particular role... if(!$user->hasRole('foo')) { // ...do not show the menu $event->return = false; } } });  
      https://github.com/Toutouwai/CustomAdminMenus
      https://processwire.com/modules/custom-admin-menus/
    • By tcnet
      This module for ProcessWire sends a notification email for each failed login attempt. Similar modules exists already in the module directory of ProcessWire. However, this module is designed to notify, even if specified user doesn't exist.
      Settings
      The settings for this module are located in the menu Modules=>Configure=>LoginFailNotifier.
      Notification email
      Specifies the email address to which the notification emails should be sent.
        Email subject
      Specifies the subject line for the notification email.
        Post variables
      Specifies the $_POST variables to be included in the notification email. Each variable must be separated by a comma. For example: login_name,login_pass
        Server variables
      Specifies the $_SERVER variables to be included in the notification email. Each variable must be separated by a comma. For example: REMOTE_ADDR,HTTP_USER_AGENT
      Link to ProcessWire module directory:
      https://processwire.com/modules/login-fail-notifier/
      Link to github.com:
      https://github.com/techcnet/LoginFailNotifier
    • By Fokke
      ProcessWire 3.x markup module for rendering meta tags in HTML document head section. Note that this module is not a full-blown SEO solution, but rather a simple tool for rendering meta tags based on module configuration. Adding custom meta tags is also supported.
      Built-in meta tags
      The following meta tags are supported out-of-the-box:
      Document title consisting of page title and site name Character set Canonical Viewport Description Keywords Hreflang tags Open Graph og:title og:site_name og:type og:url og:description og:image og:image:width og:image:height Twitter meta tags twitter:card twitter:site twitter:creator twitter:title twitter:description twitter:image Facebook meta tags fb:app_id The full documentation with configurable options can be found here: https://github.com/Fokke-/MarkupMetadata
       
      Requirements:
      ProcessWire>=3.0.0 PHP >=7.1 Installation using Composer
      composer require fokke/markup-metadata Manual installation
      Download latest version from https://github.com/Fokke-/MarkupMetadata/archive/master.zip Extract module files to site/modules/MarkupMetadata directory.
    • By m.sieber
      ITRK-Service for ProcessWire
      Module for the automated transfer of imprint, data protection declaration and terms and conditions from IT-Recht Kanzlei to your ProcessWire installation
      What is ITRK Service for ProcessWire?
      ITRK-Service for ProcessWire is a free module for ProcessWire CMS. It provides an interface to the update service of IT-Recht Kanzlei, via which the legal texts of your online presence are automatically updated. In this way, the texts remain legally secure and warning-proof in the long term. Imprint, data protection declaration, revocation and general terms and conditions are currently supported.
      You can find our documentation (in german language) here: https://www.pupit.de/itrk-service-for-processwire/dokumentation/

      Download: https://www.pupit.de/itrk-service-for-processwire/
      Github: https://github.com/pupit-de/pwItrkServiceConnector
    • By LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
×
×
  • Create New...