Skip to end of metadata
Go to start of metadata

CM Organization and Rules

Schemas

  • Schemas may have one to many fields.

  • To collect content a schema must be placed in a structure that is designated as an object or an array.

  • Any schema may be edited or deleted, the changes will affect all of the structures and content with that schema. These are the considerations for editing schemas:

    • Adding fields = No consequences or problems.

    • Removing fields = Content/data from the fields will be lost.

    • Editing field names = Equivalent to removing the field and adding a new one. Previous data/content will be lost

    • Changing field types = No end of trouble; just don’t!

Structures -  Objects

  • An object structure can contain only one schema.

  • The object’s schema structure may contain nested structures (arrays and/or objects).

  • An object structure has only one content set or data row in the database.

  • An object structure may be edited or deleted, but changes will affect containers and content associated with it.

Structures -  Arrays

  • An array structure may contain one to many schema structures.

  • An array structure is created in the following steps: 1) the structure is named and identified as an array  2) The array-schema structure is added to the array structure 3) array schema structures are added to the array structure one at a time.

  • An array’s schema structures may contain nested structures (arrays and/or objects).

  • An array/array schema structure may have one to many content sets or database rows.

  • Array and array schema structures may be edited or deleted, but changes will affect containers and content associated with them.

Containers

  • Containers hold the structures (structure hold schemas).

  • After a container is created (named and saved), the structures are added to it.

  • Any container name may be edited without consequence to the content or structures.

  • If you delete a container, all of the associated structures and content will be deleted.

Content

  • Content is input into the schema fields.

  • Every structure with a schema may have content added to it from the content form that is displayed on the Content tab.

  • Any content set may be edited or deleted.

  • Content lists (which exist only in arrays) can be searched by the key field input.

  • Content lists (which exist only in arrays) can be sorted alphabetically by the content title key field or chronologically by the last updated date.

  • Content may be imported/exported from a .csv file if the following conditions are met:

    • The content structure must be an array (object content cannot be imported).

    • The array has only one schema structure.

    • The array’s schema structure does not have nested structures.

    • The array’s schema structure does not contain the following field types: single-selects, multi-selects, file and objectID.

    • The schema structure must have at least one row of valid content added to import/export a .csv file,

  • When content is imported, the entire content list (all data rows) is removed and replaced to avoid duplicate and out of sync content (data).

Editing/Deleting Containers, Structures, and Content

  • Container name may be changed without consequence

  • A structure may be deleted from container, but the content/data will be lost

  • If you opt to remove all structures from a Container, keep in mind that an empty container will not collect content.

  • Deleting a container, deletes all of the structures and content from the container.

  • Cloning a container has no effect on the original container, but the clone must be give a unique name within the org.

  • You have two options when cloning a container:

    • Clone only the structures/schemas

    • Clone the structure/schema AND the content

 

 

Schema Field Reference 

Name

Description

Examples

Single Line Text

Short text field; a single line of text;  ~50 characters or fewer

Last Name

Book Title

Website URL

Multi Line Text

Long text field; one or more sentences; ~50-255 characters

Book Summary


Author Bio

Single Line HTML

Short text field with HTML encoding for font type, bold, italics, underline, color, URL link or any other variant. ~50 characters or fewer.

Page Heading


Stylized Tagline

Multi Line HTML

Long text field with HTML encoding for font type, bold, italics, underline, color, URL link or any other variant. More than 50 characters.

Page Description


Poem

Single Select

A list of options from which a user must select a single item.


When you select this field type, you must add the list of options.

Age range


State (in and address)

Multi Select

A list of options from which a user may select more than one option.


When you select this field type, you must add the list of options.

Genre Preferences


Degrees Earned

Date

A calendar selection or text box that requires data in a specific format: MM/DD/YYYY.

Date of Birth


Today’s Date

Time

An hour, minute, seconds field that requires data in a specific format: HH:MM:SS

Meeting Time


Time of Death

Date & Time

A field that combines the date and time formats. YYYY-MM-DD HH:MI:SS


This field type tracks an exact moment in time, regardless of time zone, so if you enter 2017-03-03 04:00:00 in Central Time, a user in Pacific Time would see it as 2017-03-03 02:00:00.

Timestamp of an event

Boolean

A field that indicates True or False and Is displayed as a check box.

Audiobook available


In stock

File

The URL of any type of file like an image or a PDF

Logo image


PDF form

Number

Numbers with up to 38 digits, positive or negative, and decimal values; used for precision.

Number of people who attended a national event


Latitude coordinates

Integer

Whole numbers between -32,768 and 32,767

Age


Number of children

Decimal

Numbers, both positive and negative that contain decimal places. Used for precision and money.

Money


Grade Point Average

Object ID

Object ID is a value that identifies and pulls in the fields and content for another structure in MaaS CM. It is also used to call that structure (schemas) content in the API.


If you have content schemas that you want be connected, you can either create child structures or you can use Object ID to connect the parent to the child.


To do this:  

1) When you create the parent schema, add a field for child ID with field type=Object ID

2) Create the child content

3) Save and open the record again.

4) Copy the item identifier from the URL

5) Open the parent content form

6) Paste the Item ID from the URL into the Child ID field.


 

NOTE: This field type should be used ONLY within the CM ecosystem. Object IDs from other modules or databases will not be validated by this system.

Author ID

In a Book Schema I would add a field for Author ID with field type=Object ID.

When I enter content into the book schema form, I would find the Author content and copy the ITEM identifier from the URL into the AuthorID field.

CM-Object ID reference.png


https://phunware.com/n/cme/content/container/.../structure/.../item/ 58e6adffa33e27ba56e1d2de

MaaS Mapping Building ID

The Identifier assigned to a building in MaaS when it is first saved.


This is a MasS Object ID.


When you select this data type, a drop down of Buildings from your venues will be displayed on the content page for selection.

CM-Building ID field type.png

MaaS Mapping POI ID

The Identifier assigned to a POI in MaaS when it is first saved.


This is a MaaS Object ID.


When you select this data type, a drop down of POIs from your venues will be displayed on the content page for selection.

CM-POI field type.png

GUID

Globally Unique Identifier. A number that is unique not only within a single system, but within all similar systems.

Books’ ISBN number


  • No labels