Page: Set Up Event Imports

Modified on 05/15/2017 06:58 AM by Administrator — Categorized as: Help

Event Imports are the tool for transferring event data into your calendar from other event-maintaining systems, including 3.x versions of Active Data Calendar.

Top

Event Imports

Event Publisher allows for you to add events from other calendars using its import feature. The import feature supports adding events from other Active Data Products, iCal (.ics) files, or via specific XML and CSV formats.

The event import are allows you to:

Top

Creating new event imports

Follow the instructions below if you would like to add content to your calendar from a file (One-Time Import) or from a data source on the web (Persistent Import).

Event imports can be configured in one of two ways.

Top

Create one-time event import

One-time event imports are useful for adding up to 1000 events at a time into the calendar. Follow the steps below to create a One-time Import.

  1. If you have not done so already, click add new import.
  2. Select the One Time Import radio option
  3. Provide a Name for the One-Time Import. This name should quickly identify the import when viewing the list of imports added to the site.
  4. Click the Browse button and locate the event data file to import. Click OK.
  5. Select the appropriate file type option (the file type you are importing)
  6. Choose if all events should be imported using a specific category, or if the file contains the category information.
  7. Choose the event status to be used, this controls if events will require review and approval.

Top

Import Options

Creating a One-time Import allows for you to specify the following options when importing your events:


Top

Import File Type

Event Publisher supports a variety of specific import formats. You will need to specify what type of file you are importing into the calendar.

Select the appropriate file type from the Select Import File Type list:

Top

Event Default Category

When working with most import file types a category will be supplied for each event.

This functionality allows for providing a default category in two ways:

Top

Event Status

When working with most imports an event status will be supplied for each event. If this value is not provided, the application will default to requiring an administrator to review each event. Choose from the following options.

Choose an option from the Event Status list:
Click Submit to start the import, or click Cancel to return to the Event Imports page without executing the import.

Top

Create persistent event import

Persistent event imports are repeating import jobs that run periodically, on dates and at times that you specify. To set up and run a persistent import

  1. Click Add New Import.
  2. Select the Persistent Import option.
  3. Enter a name for the persistent job into the Import Name box. Once saved, the import appears under this name in the list on the Set Up Event Imports page.
  4. Enter into the Import URL box the location from which the import job retrieves its input file.
  5. Enter polling dates and times:
  6. Enter into the Polling Interval box an interval in minutes, which will elapse from the end of one run of import job, until the start of the next run of the same import job.
  7. Select the Active option to make this persistent import run on your specified schedule. Deselecting this option leaves this import in the list, but it does not run until this option is selected again.
  8. Select the appropriate transform file from the list
  9. Choose if all events should be imported using a specific category, or if the file contains the category information.
  10. Choose the event status to be used, this controls if events will require review and approval.

Top

Import File Types

Event Publisher supports a variety of specific import formats. You will need to specify what type of file you are importing into the calendar.

Event Default Category

When working with most import file types a category will be supplied for each event.

This functionality allows for providing a default category in two ways:

Top

Event Status

When working with most imports an event status will be supplied for each event. If this value is not provided, the application will default to requiring an administrator to review each event. Choose from the following options.

Choose an option from the Event Status list:

Top

Import File Types

Event Publisher supports a variety of specific import formats. You will need to specify what type of file you are importing into the calendar.


Top

Calendar 3.X XML

Transform Calendar 3x XML: When working with this transform, you must generate your file from the administrative area in Active Data Calendar 3.X.


Top

CSV / Excel Import (Comma Separated Value)

Event Publisher CSV: When working with this transform, the csv that is provided to the import must be a comma separated value (.csv) file with the columns formatted accordingly. The required format for the comma separated value (.csv) file is as follows:


Top

Sample Import File

You can download a sample import file here: Click to download the Sample Import

Additionally, the file has unique requirements for acceptable values for each column, which have been identified below:

Top

Event Publisher XML

Event Publisher XML: This format is best used when you create a persistent import of data into Event Publisher from an existing application. When working with this transform, you must use the following node structure in the file:



    <events>
      <event>
        <id/>
        <name/>
        <summary/>
        <description/>
        <keywords/>
        <local-start-date-time/>
        <local-end-date-time/>
        <highlighted/>
        <private/>
        <hide-end/>
        <status/>
        <external-id/>
        <external-series-id/>
        <route/>
        <contact/>
        <name/>
        <phone/>
        <extension/>
        <email/>
        <last-modified-on/>
        <last-modified-by/>
        <categories>
          <category>
            <name/>
            <global/>
          </category>
        </categories>
        <locations>
          <location>
            <name/>
            <address1/>
            <address2/>
            <city/>
            <state/>
            <zipcode/>
            <latitude/>
            <longitude/>
            <country/>
            <county/>
            <phone/>
            <global/>
          </location>
        </locations>
        <images>
          <image>
            <ul/>
            <id/>
            <name/>
            <data/>
          </image>
        </images>
        <attachments>
          <attachment>
            <id/>
            <name/>
            <data/>
          </attachment>
        </attachments>
        <custom-data/>
      </event>
    </events>
  


Top

XML Fields

The following list outlines the details for each XML node available.



Top

Importing Custom Fields

When using the Event Publisher XML import you can import data to existing custom fields or define custom fields that need to be added to a calendar site.


You can define new custom fields by using the "variables" node. This node needs to be added below the "events" node and before the first "event" node.
The following types of fields can be added:
The following sample import defines custom fields to be added, and supplies data for custom fields for events.
<events>
    <variables>
        <custom-fields>
            <field textmode="SingleLine" type="Text" identity="id2ab3700e9cfd4d7dae9bdcb2f6bf875c" name="Custom SingleLine Text Field"/>
            <field textmode="MultiLine" type="Text" identity="id2ab3700e9cfd4d7dae9bdcb2f6bf875c" name="Custom MultiLine Text Field"/>
            <field type="YesNo" identity="id3d035f0174404f0eb075d1bcf1512516" name="Custom YesNo Field"/>
            <field type="MultipleChoice" identity="id84c55ab3695d40fb981baab23423e6d0" name="Custom Single Choice Field" selectionmode="Single">
                <option>One</option>
                <option>Two</option>
                <option>Three</option>
            </field>
            <field type="MultipleChoice" identity="idd93506761ac74694843b13681cf24a0a" name="Custom Multiple Choice Field" selectionmode="Multiple">
                <option>Red</option>
                <option>Green</option>
                <option>Blue</option>
            </field>
        </custom-fields>
    </variables>
    <event>
        <localstartdatetime>20150326T07:00:00</localstartdatetime>
        <localenddatetime>20150326T08:00:00</localenddatetime>
        <name>Green event and custom text</name>
        <summary>Event to test custom event fields</summary>
        <description>Event to test custom event fields</description>
        <route>eventtotestcustomeventfields</route>
        <customdata>
            <id2ab3700e9cfd4d7dae9bdcb2f6bf875c>Custom field text</id2ab3700e9cfd4d7dae9bdcb2f6bf875c>
            <idd93506761ac74694843b13681cf24a0a>Green</idd93506761ac74694843b13681cf24a0a>
        </customdata>
    </event>
</events>
    

Top

Defining Variables

The "variables" node is used to define custom fields.



The following structure should be used to define variables:
<events>
    <variables>
        <custom-fields>
            <field \>
        </custom-fields>
    </variables>
    <event \>
</events>

Top

Fields

When defining a custom field the "field type" attribute or "text-mode" attribute must be supplied.



These attributes determine if the custom field is a text field, mutliple choice field, or yes / no field.
The following definitions are accepted.
    <field text-mode="SingleLine" type="" identity="" name="" max-length="100"/>
    <field text-mode="MultiLine" type="" identity="" name="" max-length="100"/>
    <field type="YesNo" identity="" name=""/>
    <field type="MultipleChoice" identity="" name="" selection-mode="">
    <field type="MultipleChoice" identity="" name="" selection-mode="">

Top

Identities

When defining a custom field the "identity" of a custom field must be supplied. This is a GUID that will uniquely identify the custom field in the calendar site.



This field supports up to 34 alphanumeric characters, with no spaces or special characters.
    <field text-mode="" type="" identity="id2ab3700e9cfd4d7dae9bdcb2f6bf875c" name=""/>

Top

Name

When defining a custom field the "name" attribute is required. This will display on the event details view, and create an event screen.


Top

Defining Text Fields

The following example displays the format and content required to define a text field.

<variables>
    <custom-fields>
        <field text-mode="SingleLine" type="Text" identity="id2ab3700e9cfd4d7dae9bdcb2f6bf875c" name="Custom SingleLine Text Field" max-length="100"/>
        <field text-mode="MultiLine" type="Text" identity="id2ab3700e9cfd4d7dae9bdcb2f6bf875c" name="Custom MultiLine Text Field" max-length="100"/>
    </custom-fields>
</variables>

Single vs. Multi Line Text Fields
Maximum Length
Top

Defining Multiple Choice Fields

The following example displays the format and content required to define a multiple choice field.

  
<field type="MultipleChoice" identity="id84c55ab3695d40fb981baab23423e6d0" name="Custom Single Choice Field" selection-mode="Single">
    <option>One</option>
    <option>Two</option>
    <option>Three</option>
/<field>
<field type="MultipleChoice" identity="idd93506761ac74694843b13681cf24a0a" name="Custom Multiple Choice Field" selection-mode="Multiple">
    <option>Red</option>
    <option>Green</option>
    <option>Blue</option>
</field>

Selection Mode
Options
Top

Defining Yes/No Fields

The following example displays the format and content required to define a Yes/No field.

<variables>
    <custom-fields>
       <field type="YesNo" identity="id3d035f0174404f0eb075d1bcf1512516" name="Custom YesNo Field"/> 
    </custom-fields>
</variables>

Top

Adding Data for Custom Fields

When importing data into custom fields you will provide your data for each custom field using the fields Identity. The following structure is required:

<Custom Data>
    <ID>Data you wish to import goes here</id>
</Custom Data>
    

The following Sample illustrates how custom fields are defined for an event.
<event>
    <local-start-date-time>2015-03-26T07:00:00</local-start-date-time>
    <local-end-date-time>2015-03-26T08:00:00</local-end-date-time>
    <name>Green event and custom text</name>
    <summary>Event to test custom event fields</summary>
    <description>Event to test custom event fields</description>
    <route>event-to-test-custom-event-fields</route>
    <custom-data>
        <id2ab3700e9cfd4d7dae9bdcb2f6bf875c>Custom field text</id2ab3700e9cfd4d7dae9bdcb2f6bf875c>
        <idd93506761ac74694843b13681cf24a0a>Green</idd93506761ac74694843b13681cf24a0a>
    </custom-data>
</event>
    



Top

iCal Import

When importing an iCal file, commonly availble from Outlook or Google Calendar, the following attributes of the file are supported.

    BEGIN:VCALENDAR
    METHOD:PUBLISH
    VERSION:2.0
    BEGIN:VTIMEZONE
    TZID:Eastern Standard Time
    BEGIN:STANDARD
    DTSTART:16010101T020000
    TZOFFSETFROM:-0400
    TZOFFSETTO:-0500
    RRULE:FREQ=YEARLY;INTERVAL=1;BYDAY=1SU;BYMONTH=11
    END:STANDARD
    BEGIN:DAYLIGHT
    DTSTART:16010101T020000
    TZOFFSETFROM:-0500
    TZOFFSETTO:-0400
    RRULE:FREQ=YEARLY;INTERVAL=1;BYDAY=2SU;BYMONTH=3
    END:DAYLIGHT
    END:VTIMEZONE
    BEGIN:VEVENT
    DESCRIPTION:
    SUMMARY:
    DTSTART;TZID=Eastern Standard Time:20150727T150000
    DTEND;TZID=Eastern Standard Time:20150727T173000
    RECURRENCE-ID;TZID=Eastern Standard Time:20150723T000000
    END:VEVENT
    END:VEVENT
    END:VCALENDAR
  

Top

Required Fields

In order for an event to be imported using the iCal file format by Event Publisher each event must contain information in the following attributes:


If your iCal file does not import, it is likely that the file does have values specifed for each of the required fields for the event. Commonly, an event created with only a name will only contain the "Summary" attribute. Each event must have both a summary and description to be imported. Additionally, Event Publisher iCal import does not currently support the import of locations assgined to events.

Top

View Import History

View import history allows you to access detailed information about the events that are contained in a particular import. You can access the following information:


To view the history of an event import that is already in your list:
  1. Locate the import in the list, and click on the dropdown box on the right side of the row.
  2. Select "View Import History" From the dropdown menu.
  3. A table will open below the list of imports where you can view information about that import.

Top

Modify existing event import

To change the parameters in an event import that is already in your list:

  1. Locate the import in the list, and click on the dropdown box on the right side of the row.
  2. Select "Edit" From the dropdown menu.
  3. Click Submit to save your changes and return to the list of persistent imports, or click Cancel to discard any changes and return to the list of imports.

Top

Delete existing event import

To remove an event import that is already in your list:

  1. Locate the import in the list, and click on the dropdown box on the right side of the row.
  2. Select "Delete" From the dropdown menu.
  3. Click Okay to remove the import and all of its events, or click Cancel to discard any changes and return to the list of imports.

Top

Purge

This feature will force the permenant deletion of all events added by a specific import. Use this feature when a large number of events need to be removed that were previously imported. To remove all events for a specific import:

Important Note:Once initiated, a purge can not be undone, the events will be permenantly removed from the calendar.
  1. Locate the import in the list, and click on the dropdown box on the right side of the row.
  2. Select "Purge Events" From the dropdown menu.
  3. Click Ok to remove the import and all of its events, or click Cancel to discard any changes and return to the list of imports.

Top

Other available functions

Refresh: Click this icon or link on the list page to reload the list of defined persistent event imports from the calendar' database.