Collections

A Collection is a group of Sources (or Extractors) that adheres to a particular Schema.
A Schema represents column names within an Extractor. You cannot create a Collection
without a Schema. That noted, you must first create a Schema before you can save all
required entries on the Collections page.

Add a Collection

collections new

To add a Collection:

  1. From the left navigation pane, click Collections.

  2. From the top right of the Collections page, click the Add a Collection icon
    or plus (+) symbol.

  3. From the New Collection page, enter content in the Name field.

    The name you enter will autofill the Slug/ID field. You can associate Slug/IDs
    with many DOC platform objects, which serve as self-defined identifiers. Slug/IDs
    can be useful as you reference APIs or create variable names. You cannot change Slug/IDs.
    That noted, ensure they are meaningful.

  4. To enter content in the Schema field, click the drop-down arrow and select from the list.

    Schemas represent Extractor column names, and you can share them across Organizations.
    At this point, you have created at least one Schema. It is important to note that when you
    initially create a Schema, it is in a Draft state. You cannot push data to the customer
    unless the Schema is in a Published state. Once published, you cannot make breaking
    changes to the Schema. Adding columns is not a breaking change; however, changing the
    column type (from text to number, for example) represents a breaking change.

  5. Enter Parameters.

    Parameters help you further group or distinguish Sources and dictate behavior. Locale and
    Domain are the default Parameters. If you have an Extractor that performs ebay.com searches,
    for example, ebay.com-uk and ebay.com-fr, might represent locales. Domain is the website;
    in this case, ebay.com. Parameters are extremely powerful and have numerous downstream uses.
    Using Parameters, you can tag Sources and establish key/value pairs. You also can use Parameters
    as filters. You can add the stage Parameter and associate it with the dev environment. You can add
    Parameters at this Collection level. For each Parameter you add here, you can provide a value
    for the Parameter on the related Sources page. For example, Locale=en_us, Domain=ebay.com,
    Stage=dev.

  6. To share helpful Collection information with team members, enter text in the README section.

    This section, which supports the markdown syntax, allows you to provide additional Collection
    context and insight.

  7. To store content, click Save. To disregard, click Cancel.

collections defined

Returning to the Collections page allows you to view a table which contains defined
Collections. The table displays the Name, Created On, and Assignee columns.

You can filter and sort the entries in the Collections table as needed; in addition, you can use
the Search feature or scrollbar to locate existing Collections.

Edit a Collection

collections edit

To edit a Collection:

  1. From the left navigation pane, click Collections.

  2. From the Collections page, use the Search feature or scrollbar to locate the Collection
    you want to modify.

  3. Click to select this entry.

    On this initial Edit page, you can modify the Assignee, Schema, and Parameters fields.

    Projects can be locked, restricting write and edit operations under each subsequent DOC layer
    (such as Collections, Sources, and Snapshots.) You will not have Project access unless you are an
    ORG_ADMIN, OPS, or assigned to work on a specific layer of this Project. If your role is
    ORG MEMBER and you are attempting to edit a Collection, for example, you cannot make changes
    unless this Collection is assigned to you.

    You can click the value in the Schemas field, which launches you to the Schemas page
    to make edits.

    To make Parameter changes, you must click the Edit Parameters or pencil-like icon next to this field. To save Parameter updates, click the red checkmark (Save). To disregard, click
    the black X (Cancel).

    The View Readme Version History watch-like icon is located near the top center of the page.
    Upon selection, you can view the Preview Version, Published, Updated by, and Actions columns.
    You can click the content in the Preview Version column to view README file information.
    The README file provides additional Collection context and insight.

  4. From the top right of this page, click the Edit this Collection or pencil-like icon
    to make additional modifications.

You cannot delete Collections.