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 MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory (pending approval) Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • 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 (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
×
×
  • Create New...