Dummy data¶

The dummy:* commands fill an Omeka S installation with generated items and item sets, so you can try out a theme, a module or the search on a realistic amount of content. A JSON config file decides which properties each resource gets and how their values are generated (with Faker); without one, every resource gets a title and a description.

Create items¶

dummy:create-items creates one item, or the number you give with --number (-n):

omeka-s-cli dummy:create-items --number 10

Created 10 items.

Without a config file, each item gets a dcterms:title of 2 to 5 words and a dcterms:description of 5 to 15 words, all lorem ipsum. The resources are created one at a time through the Omeka S API; for more than 100 the command reports its progress every 100.

Create item sets¶

dummy:create-item-sets works the same way, with the same default title and description:

omeka-s-cli dummy:create-item-sets -n 5

Use a config file¶

Pass a config file (a path or a URL) with --config (-c) to choose the properties and values:

{
    "o:is_public": { "generator": "boolean" },
    "o:resource_class": { "generator": "resource_class", "values": ["dctype:Text", "dctype:StillImage"] },
    "dcterms:title": [{ "generator": "literal", "mode": "words", "min": 2, "max": 6 }],
    "dcterms:creator": [{ "generator": "literal", "mode": "name", "locale": "nl_BE" }],
    "dcterms:date": [{ "generator": "literal", "mode": "date", "min": 1850, "max": 1950, "format": "Y-m-d" }],
    "dcterms:subject": [
        { "generator": "literal", "mode": "values", "values": ["Architecture", "Industry", "Agriculture"] },
        { "generator": "literal", "mode": "values", "values": ["Ghent", "Bruges", "Antwerp"] }
    ],
    "dcterms:rights": [{ "generator": "uri", "values": [
        { "id": "https://creativecommons.org/publicdomain/zero/1.0/", "label": "CC0 1.0" }
    ] }]
}

omeka-s-cli dummy:create-items -n 10 --config items.json

Each item in this example gets a title, a Flemish-sounding creator name, a date between 1850 and 1950, two subjects (one from each list), a CC0 rights statement, a random resource class and a random visibility. The properties must exist in the installation, so import their vocabulary first (see vocabularies).

An item set config has the same format, except that it may not contain o:item_set:

{
    "o:is_public": false,
    "dcterms:title": [{ "generator": "literal", "mode": "words", "min": 1, "max": 3 }],
    "dcterms:identifier": [{ "generator": "literal", "mode": "uuid" }]
}

omeka-s-cli dummy:create-item-sets -n 5 --config item-sets.json

"o:is_public": false has no generator: a value like that is passed to Omeka S as is, so every item set in this example is private.

Add items to item sets¶

The item_set generator puts each item in a random selection of the existing item sets, and the resource generator links to existing resources. Create the item sets first:

{
    "o:item_set": { "generator": "item_set", "min": 1, "max": 2 },
    "dcterms:title": [{ "generator": "literal", "mode": "words", "min": 2, "max": 5 }],
    "dcterms:relation": [{ "generator": "resource", "resourceType": "items" }]
}

omeka-s-cli dummy:create-items -n 10 --config populate-item-sets.json

Each item lands in one or two item sets, and its dcterms:relation points to a random existing item. The command fails if there are fewer item sets than min. Both generators choose from the resources that exist when the command starts, so items never link to items created in the same run.

Config file reference¶

The config file is a JSON object. Each key is either a property term (dcterms:title) or an Omeka S field of the resource (o:is_public, o:resource_class, o:item_set).

• A property takes a list of generator configs. Each one adds one value, so a list of two generators gives the property two values. Generated values are always public.
• An o: field takes a single generator config.
• Every generator config is an object with a generator key and the options of that generator.
• An o: field without a generator key is passed to Omeka S unchanged, for example "o:is_public": false or "o:resource_template": {"o:id": 1}. For a property, this does not work: to give every resource the same value, use the literal generator in values mode with a single value.

literal¶

mode selects what to generate (default words). Every mode accepts locale, a Faker locale such as nl_BE or fr_FR (default en_US), which affects names, addresses and the like.

uri¶

Without values, it generates https://example.com/<slug> with the words of the slug as label.

resource¶

The command fails if no resource of that type exists.

item_set¶

resource_class¶

Reference¶

All commands also accept the global options.

dummy:create-items¶

Create dummy items

omeka-s-cli dummy:create-items [options]

dummy:create-item-sets¶

Create dummy item sets

omeka-s-cli dummy:create-item-sets [options]