Jump to content
ryan

Module: Import Pages from CSV file

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

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

How can I give permission to import pages from csv? I have an 'administrator' role that can add, create and edit pages but 'Import Pages From CSV' doesn't show up under 'Setup'.

PW 3.0.98

Share this post


Link to post
Share on other sites
20 hours ago, BFD Calendar said:

How can I give permission to import pages from csv? I have an 'administrator' role that can add, create and edit pages but 'Import Pages From CSV' doesn't show up under 'Setup'.

PW 3.0.98

more info here :

 

  • Like 2

Share this post


Link to post
Share on other sites
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.

Share this post


Link to post
Share on other sites

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.

Share this post


Link to post
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

Share this post


Link to post
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.

Share this post


Link to post
Share on other sites

Thanks @Ralf - can confirm this solved the title issue.

Still had some issues with importing multiple page refs which I worked round with a quick custom JSON import script, but good to know can use this import going forward.

Share this post


Link to post
Share on other sites

It seems that the "Skip it" and "Modify the existing page" features don't work anymore.

Is someone having the same issue? 

Working on the newest .dev version: PW 3.0.144

Share this post


Link to post
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. 

Share this post


Link to post
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. 

Share this post


Link to post
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

Share this post


Link to post
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

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

Same here, I ended up rolling back to an earlier version of PW to import pages. I hope it can be updated; it's a really useful module.

  • Like 2

Share this post


Link to post
Share on other sites

@ryan released a new version (1.0.8) of this module a few days ago. Thank you!

It works perfectly fine as previous versions did - even with the most recent DEV version of ProcessWire.

There are also some new features included. Grab your copy now from the modules directory or via the upgrade module.

Have fun and stay safe!

  • Like 4

Share this post


Link to post
Share on other sites
Posted (edited)

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

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
Share on other sites

Thanks! perfect timing.. 

are there any limits so? Gotta import like 100k rows. Do I need to split them in smaller chunks? Or can the module handle even larger files? Appreciated!

Share this post


Link to post
Share on other sites

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

Share this post


Link to post
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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...