Importing/Exporting Data in AdBase

Transcription

1 Importing/Exporting Data in AdBase

2 Purpose of Presentation Provide an Overview of AdBase Utilities Which Allow:! Importing of Order Data or! Exporting of Order Data To or From the AdBase Core Database iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 2

3 Purpose of Presentation (cont d)! The Imports/Exports presented here do not need to be used with an API or a sophisticated system integration.! These are a way of sending files between systems.! They are standard XML formats containing ad information which you or your vendor can further transform to make them usable.! They also offer a way to import or export images and text associated with these ads iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 3

4 Reasons for Importing Orders! Allow orders to be entered on another system and then sent to AdBase.! Transfer orders from a Legacy System iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 4

5 Reasons for Importing Orders (cont d) Examples of Orders Being Entered from Another Source: Preprint Orders Internet Orders Third-Party Self-Service Order Entry site. External Contact Manager System These are specialized systems which contain either not available in AdBase, or in which the company has decided to use another vendor iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 5

6 Reasons for Importing Orders (cont d) Example of Transferring Orders from a Legacy System: Re@rement of a non-adbase order entry system system, and replacing it with AdBase system. The AdBase system could be either a brand-new one, or it could be one which is already opera@onal. It is possible to import historical or currently-running orders from a legacy system into AdBase, using the Import u@li@es iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 6

7 Import Tools Covered Here! XML Importer XMLImporter.exe! EPS Importer EPSImporter.exe! Graphics Importer GraphicsImporter.exe All are in \mactive\bin directory All have manuals you can download from Newscycle support site iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 7

8 XML Importer Utility! This is the major tool for importing orders for other sources.! It is used in conjunction with AdBase integrations with Google and Salesforce (and others), but it can also be used without it.! Can run multiple instances of it, each with its own configuration settings.! One instance can run per machine. Use multiple machines to run additional instances.! Configuration settings can be stored in a scenario file so that particular settings are loaded every time the application runs iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 8

9 XML Importer Utility (cont d)! Allows order creation similar to that available through AdBooker.! Reads data from an XML file instead of using the input entered through AdBooker iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 9

10 XML Importer Utility (cont d)! Can also be configured to: Include an ad content file to accompany the order (such as an.rtf or an.eps). Create a new customer if needed along with the order. Update an existing order. Kill an order. Apply prepayment to an order iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 10

11 XML Importer How it Works Drop XML File formamed according to the importer into an Input folder, plus EPS file if applicable. XML Importer will pick up the files from the Input folder and amempt to process them. Uses a System Translate to translate the values in some of the tags in the XML. If successful, the XML and associated the EPS file (if any) will be dropped into a Recovery folder. Whether successful or not, a response XML file will be dropped into an Output folder. You write your own applica@on to drop files into the Input folder, and to monitor the Output and Recovery folders iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 11

12 XML Importer Example XML Input File. Format follows structure of AdBooker, and is documented in the manual iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 12

13 XML Importer Options Setup Tab Setup tab contains many to configure it to meet the specific needs for your import. Details are in the manual iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 13

14 Order XML Import Order Defaults Tab 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 14

15 Order XML Import Customer Data Tab This screen determines whether or not a new customer can be created along with the order. If the op@on not checked, then customer must already exist prior to the order is imported iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 15

16 Order XML Import File Management Tab 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 16

17 Order XML Import Automatic Execution 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 17

18 XML Importer Import Scenarios 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 18

19 XML Importer Using Import Scenario D:\ndapps\mactive\bin\AdbaseXMLImporter.exe -U adbase_mstr -P xxx -s T:\Imports \BURT\AIS\BURT.ais 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 19

20 XML Importer Output folder Contains Response Files iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 20

21 XML Importer Successful Response 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 21

22 XML Importer Error Response 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 22

23 Error Handling Possible Reasons for XMLs Erroring Out:! Invalid XML format (the XML format contains multiple sections, and tags must be included in the correct section).! Some tags require setup in the System Translate in order for the data to be recognized.! Customer is locked (this happens if the option to create new customers is turned on) This is not a complete list iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 23

24 XML Importer Example XML File 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 24

25 XML Importer Another Example This example contains tags for adding a new customer, plus a tag for ad content iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 25

26 A Note About Preparation and Testing! Allow plenty of time for: Reading the documentation to understand: " How Import Process works. " The XML Record Layout. Testing: " Test all different kinds of scenarios. " You will probably experience many errored XMLs before you achieve success. " Most of the time, you can debug errors yourself, but if you need help, you can open a case with Newscycle for support iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 26

27 EPS Importer Utility Purpose:! Allow the import of the following for ads built externally from AdBase. EPS files HTM files! These are for orders which already exist in AdBase.! Can be later exported for pagination, or for the web, as if it were content for natively-built AdBase orders.! This is in addition to the content import functionality already included with XML Importer (which supports EPS and RTF files) iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 27

28 EPS Importer Utility (cont d)! Although XML Importer allows EPS (and RTF) files to be imported with the order, you may want or need to import them separately from the order, depending on your workflow.! You can use it to replace EPS or HTM files which were previously imported.! This also allows you to import HTM files (for ad text for the web). Note: EPS Importer does not import RTF files iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 28

29 EPS Importer Utility (cont d) Recap of ad content for liner ads:! RTF files Used for ad content for liner orders Editable in AdBooker. Includes text plus embedded images such as photos or attention-getters. Imported through XML Importer Utility (not the EPS Importer) iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 29

30 EPS Importer Utility (cont d) Ad Content for Externally Produced Ads:! EPS files to import liner content in finished format, uneditable from AdBooker. Used for display ads. Can also be used as an alternative to importing editable liner ads. " Advantage is it bypasses the complexity of creating editable content. " Disadvantage is it s not editable, so if content changes it may need to be killed and reimported if size changes iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 30

31 EPS Importer Utility (cont d) Ad Text for Externally Produced ads:! HTM files contain ad text which can later be used in an export (contains no text formatting).! Can later be exported using the Web XML Export Utility so that the ad text can appear online iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 31

32 EPS Importer Utility (cont d) How it works:! Although it supports EPS and HTM files, you need to set up a separate instance of the EPS Importer Utility for each one.! Store the file the same name as the AdBase-assigned ad number, or the external ad number. That s how it finds the order it belongs to.! Drop file into the folder which the importer is polling.! Successfully imported files will be moved to the Success folder.! Errored files will be moved to the Error folder iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 32

33 EPS Importer (cont d) EPS Importer See manual for further details iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 33

34 EPS Importer (cont d) EPS Importer folder structures iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 34

35 Graphics Importer Utility Purpose:! Import images for use with liner ads, where the content is produced in AdBooker.! Can be photos, attention-getters, or company logos to be used in ads (typically in EPS format).! Can also store associated images for externallyproduced ads (such as JPEGS for web export).! Images are imported into Graphics Browser iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 35

36 Graphics Importer Utility (cont d) Screen. You need to define directories for the graphics. Once defined and added, then they are available you run the 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 36

37 Graphics Importer Utility (cont d) Browse to select the directories to import from and to move to auer they get imported iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 37

38 Graphics Importer Utility (cont d) Choose amribute to be assigned to each graphic imported into the photo iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 38

39 Graphics Importer Utility (cont d) Choose category the graphics will be assigned to iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 39

40 Graphics Importer Utility (cont d) Import folders, including archive folder. These are EPS files, although they do not have a.eps extension iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 40

41 Next Topic: EXPORTING ORDERS INTO ADBASE 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 41

42 Export Tools Covered Here! XML Exporter adbasexmlporter.exe! XML Distributor AdbaseXMLDistributor.exe! EPS Exporter EPSFileExport.exe! XML Web Exporter XMLWebExporter.exe All are in \mactive\bin directory Most have manuals you can download from Newscycle support site. * I couldn t find a manual for the EPS File Exporter iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 42

43 Reasons for Exporting Orders! Send to: A pagination or ad layout system. A content management system. An external data warehouse. The internet.! Send Ad Content for liner ads to a pagination system. EPS Files 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 43

44 AdBase XML Exporter Utility! Export ad data by publication date.! Configuration screen allows you to select: Products Placements Ad Types Publication Date! Uses a System Translate.! Can be run from Schedule Admin.! Can be launched with a scenario file to load in the configuration choices.! Generates XML file in a standard format and drops it into an output folder iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 44

45 AdBase XML Exporter Utility (cont d) screen for AdBase XML Exporter iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 45

46 AdBase XML Exporter (cont d) Placement Screen iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 46

47 AdBase XML Exporter (cont d) to generate an XML for one selected order. Select Tools -> Export By Order Number to get to this 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 47

48 AdBase XML Exporter (cont d) Example Exported XML File. Follows format to match AdBooker screen. liner ads show rz format iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 48

49 XML Distributor! Export ad data automatically by last edit date (not by pub date)! Also allows export of Preprint and Internet orders.! Uses a System Translate.! Can be set up to continuously poll for new or updated ads. (autoexecute mode).! Can also be launched from the command line, using settings saved in a scenario file.! Generates XML file in a standard format and drops it into an output folder iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 49

50 XML Distributor (cont d) Main Menu 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 50

51 XML Distributor (cont d) Screen. You can configure each with its own se[ngs iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 51

52 XML Distributor (cont d) Filtering and other See manual for more on each of these 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 52

53 XML Distributor (cont d) to export preprints (unlike XML Exporter) iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 53

54 XML Distributor (cont d) to export internet orders (unlike XML Exporter) iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 54

55 XML Distributor (cont d) Configure autoexecute 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 55

56 XML Distributor (cont d) Choose Hours, or Minutes of the Hour iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 56

57 XML Distributor (cont d) Or choose minute intervals. You can restrict 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 57

58 XML Distributor (cont d) on Screen: Choose Content Output Type Choose Encoding 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 58

59 XML Distributor to run manually for: Specified orders Run date range order taker and/or seller 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 59

60 XML Distributor (cont d) Sample XML Output file. You would need to translate it to the format required by the system iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 60

61 EPS File Exporter! Exports EPS Files from Database to a designated export folder.! Can be set to run automatically, when orders are created, edited, or killed.! Can create multiple profiles iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 61

62 EPS File Exporter (cont d) Se[ngs Tab 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 62

63 EPS File Exporter (cont d) Select Tab 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 63

64 EPS File Exporter (cont d) Export Tab Also includes to run manually by run date range iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 64

65 EPS File Exporter (cont d) Output folder containing exported EPS files iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 65

66 Another Option for Pagination There is also a PGL Exporter, for sites using PGL for pagination. It outputs both data and content. See manual for details if this applies to your site iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 66

67 Web XML Exporter! Designed to provide more granular selection to export ad orders and graphics to third parties (or internal providers) to host the ads online.! Includes ad text for liner ads, or for display ads in which an HTM file was imported.! Includes fielded data.! It can be run manually, or automated on the scheduler.! Uses a System Translate.! Outputs to a standard XML format which you would need to translate to meet the vendor s requirements (unless vendor will accept the AdBase format) iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 67

68 XML Web Exporter (cont d) Preferences screen, to select which orders to export iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 68

69 XML Web Exporter (cont d) You can create preferences, so you can send different types of ads to different vendors iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 69

70 XML Web Exporter (cont d) Preference se[ngs for 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 70

71 XML Web Exporter (cont d) Se[ng both Placements and for the Preference iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 71

72 XML Web Exporter (cont d) Export by either Start/End Date or by Last Edit Date. You can also sort the output within the XML iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 72

73 XML Web Exporter (cont d) Se[ngs tab. To configure specific se[ngs for the export file which the vendor requires. See manual for more on these 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 73

74 XML Web Exporter (cont d) FTP tab to enable sending via FTP to a des@na@on folder iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 74

75 XML Web Exporter (cont d) Example output folder. It contains XML plus exported images. Embedded EPS files are converted to jpegs by the Web Exporter iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 75

76 XML Web Exporter (cont d) Example exported Web XML. Contains ad text and reference to image iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 76

77 In Summary! Your site can send orders to and from other systems using Newscycle s standard import and export utilities.! This is lower-tech way than using an API to send the information to and from other systems.! Although they don t offer the advantages of a real-time integration, they do get the job done iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 77

78 In Summary (cont d)! To use these tools: Read through the documentation before starting. Expect to have to make numerous failed attempts in your development and testing. Don t be discouraged by that. Once you achieve initial success, thoroughly test your setup and coding with many test cases iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 78

79 In Summary: GOOD LUCK! 2017 iconnectsolutions Conference NEWSCYCLE SOLUTIONS USER GROUP 79