Aras Innovator Platform

Administration Configurable Options

The following steps walk through the configuration of CMF for a custom Business Object ItemType. For additional detail on configuring properties, please refer to the property definition tables in each section.

The Business Object ItemType is an ItemType that will be linked to the Content Modeling Framework ItemType. The Business Object ItemType for the following example is called “MyProcessPlan”. This ItemType does not require special configuration for use with CMF.

  1. In the Navigation Pane select Administration ItemTypes in the TOC. The following menu appears:
  2. Click Create New ItemType. The following screen appears:
  3. Enter a name and labels.
    1. Name: MyProcessPlan
    2. Singular Label: My Process Plan
    3. Plural Label: My Process Plans
    4. In the Properties tab, click

      to add a new Property.

    5. Name: name
    6. Label: Name
    7. Data Type: String
    8. Length: 32
  4. Set access and permissions in the TOC Access tab, the Can Add tab, and the Permissions tab.
  5. Click

    and

    to save and unclaim the MyProcessPlan ItemType. It should look like Figure 3:

The CMF ItemType creates a link between the Business Object ItemType and the Content Type, allowing administrators to configure custom views.

Note
All CMF ItemType forms must have an OnFormPopulated event with the core method cmf_ShowContentType.

  1. Navigate to Administration ItemTypesCreate New ItemType in the TOC.
  2. Enter a name and labels.
    1. Name: MyPQD
    2. Singular Label: My PQD
    3. Plural Label: My PQDs
  3. In the Properties tab, add a new Property
    1. Name: name
    2. Label: Name
    3. Data Type: String
    4. Length: 32
    5. Set access and permissions in the TOC Access tab, the Can Add tab, and the Permissions tab by clicking the Add icon

      .

  4. Click Save and Done. It should look like Figure 4.
  5. Select the Views tab and double-click the MyPQD form.
  6. Lock the form, go to the Form Event tab, and click Add Methods

    . The Method Search dialog appears:

  7. Search for cmf_ShowContentType, select it and click OK.
  8. Double click the blank box in the Event column. Click the Down arrow to select the OnFormPopulated method.
  9. Click

    to Save the MyPQD form. Click

    to unclaim it.

  1. Navigate to Administration RelationshipTypes in the TOC. The following menu appears:
  2. Click Create New RelationshipType. The following window appears:
  3. Enter a name and label.
    1. Name: MyPQDRel
    2. Label: MyPQDRel
  4. Set the Source ItemType to the CMF ItemType: MyPQD.
  5. Click

    and

    to save and unclaim the item.

  6. It should look like Figure 9:

The Content Type item links the Business Object ItemType to the CMF ItemType and is used to configure the custom grid and tree on the CMF items.

  1. Navigate to Administration Content Modeling Content Types in the TOC. The following menu appears:
  2. Click Create New Content Type. The following screen appears:
  3. Enter My PQD in the Name field.
  4. Set the Linked ItemType to the CMF ItemType. In this instance, that is MyPQD.
  5. It should now look like Figure 12.
  6. Right-click the Elements tab on the Content Type tree and select Add Element Type.
  7. Enter MyElement1 in the Name field for the Element Type.
  8. It should now look like Figure 13.

Content Type Elements

  1. Right-click the Element (MyElement1) in the tree and select Add Property Type
  2. For this example, create the following Property:
    1. Data Type: Text
    2. Name: MyTextProp
    3. Click

      to save the property.

  3. Create another Property:
    1. Data Type: String
    2. Name: MyStringProp
    3. Data Length: 32
  4. Refer to Table 2 for a complete list of the properties of the Element Properties.
  5. Document Conventions

    Property

    Description

    DataTypeDataType of the Element’s property
    NameElement’s name, a string, 30
    My Data LengthThe maximum character length, only used for strings
    Default PermissionA default Permission Item set for new Elements of this type, optional.
  6. Save Content Type.
  7. It should look like Figure 14.
  8. Note
    If there is a need to create several elements without parent (parallel structures of elements), each of those parallel structures should be organized into different views to be displayed in CMF editor. Otherwise, the CMF editor will show nothing.

  9. Right-click the MyElement1 item again and select Add Element Binding.
  10. For this example, set the following properties:
    1. Referenced Type: MyProcessPlan (Business Object ItemType)
    2. Tracking Mode: Show Differences
    3. Resolution Mode: Current
    4. New Element Mode: Pick or Create
  11. Refer to Table 3 for a complete list of the Element Binding items.
  12. Document Conventions

    Property

    Description

    Referenced TypeThe Business Object ItemType that will be bound to the Element Type
    Tracking ModeShow Differences: Show differences between Elements of this type and the referenced Business Object Ignore Differences: Ignore differences between Elements of this type and the referenced Business Object Hard Show Differences: Overrides Content Type Life Cycle-specific tracking mode Hard Ignore Differences: Overrides Content Type Life Cycle-specific tracking mode
    PropertyDescription
    Resolution ModeIdentifies which generation of bound item to access to perform value comparison. Current: use the current version of the item As Saved: use bound_item_id as is, do not use the current version of the item Hard Current: Overrides the LifeCycle resolution mode Hard As Saved: Overrides the LifeCycle resolution mode
    New Element ModeDefine how new elements may be added. Pick or Create Pick Only Create Only
    Reference Is RequiredUser cannot create an unbounded Element. All Elements of this type must have a reference to a Business Object.
    Structure Mapping Method (SMM)The SMM returns the table data, allowing users to see conflicts between structures. The SMM is executed based on the Element Type. If a structure contains two different Element Types with SMM, both methods will run. This method is called when: An Element is added (New, Pick, Create) An Element is deleted A Reference is released On Pick/Replace of an Element
    On Create ReferenceOptional. This method is called when a user attempts to create a reference on a Business Object. If no method is set, the default implementation will execute.
    On After PickA method called after a user picks some business object from the context menu.
    On Apply BindingOptional. The method will be called when the Element is picked. The method should link the selected Business Object to hierarchy of the main Business Object. This method also will be called when an Element exists but is not in the hierarchy of Business Object and the user wants to include the Element into the hierarchy of the Business Object.
  13. Add a new item to the Property Bindings tab.
  14. Configure the following properties:
    1. Referenced Property: name
    2. Document Element: MyStringProp
  15. Save the Content Type.
  16. It should look like Figure 15.
  17. Currently, the Binding Types intersection is supported for the following Data Types:

    • String
    • Text
    • Integer
    • Date
    • Boolean
    • Image

Content Type Element Identity Inheritance

Content Type Elements inherit the managed_by_id, owned_by_id, and team_id properties from the parent Content Type instance item. The Element’s created_by_id and modified_by_id properties are not inherited.

For this sample case, this means that any MyElement1 items will be created with the managed_by_id, owned_by_id, and team_id values from the parent MyPQD item.

Warning
It is important to consider identity inheritance when defining custom permissions on Content Type Elements. Permissions including the Creator system identity on Content Type Elements will use the creator of each Element item, not the creator of the parent Content Type instance item, when validating user permissions.

Content Type View

  1. Right-click the Views node in the Content Type tree and select Add View.
  2. Click OK to confirm a tabular view.
  3. Enter a name for the Tabular View.
  4. It should look like Figure 9.
  5. Expand the Tabular View sub-tree
  6. Right-click the Columns node and select Add Column.
  7. Enter the following values in the new Tabular View Column
    1. Mapped Property: MyStringProp
    2. Header Title: My String
    3. Initial Width: 100
  8. Add another Column to the Columns node.
    1. Mapped Property: MyTextProp
    2. Header Title: My Text
    3. Initial Width: 200
  9. It should look like Figure 17.
  10. Right-click the Element Nodes node on the Tabular View sub-tree and select Add Element Type Configuration.
  11. Enter the following properties for the Element Node:
    1. Label: MyElement1 Label
    2. Element Type: MyElement1
    3. Icon: Choose an image
  12. It should look like Figure 18.
  13. Right-click the Additional Header Rows node and select Add Additional Header Row.
  14. Add a new Group relationship with the following properties:
    1. Label: My Group Label
    2. Start: 1
    3. End: 2
  15. It should look like Figure 19.
  16. Save, Unclaim, & Close the Content Type.

Use the following procedure to confirm the configuration of the Business Object ItemType and the linked Content Type.

  1. Create an instance of the Business Object.
    1. Click My Process Plans in the TOC. The following menu appears:
    2. Click Create New MyProcessPlan and create a new My Process Plan item with the name “Plan 1”.
    3. Click Done.
  2. Create an instance of the CMF Object.
    1. Navigate to My PQDs in the TOC.
    2. Create a new My PQD item.
    3. Set name as “PQD 1”.
    4. Save PQD 1.
  3. In the CMF Item, click the Show Editor icon in the sidebar.
  4. Add an unbounded element to the Content ItemType:
    1. Right-click the root element tab in the tree and select Insert MyElement1 Label New.
    2. Enter values for My String and My Text.
  5. Add a bound element from reference:
    1. Right-click the root element tab in the tree and select Insert MyElement1 Label From Reference Select.
    2. Run a search in the Search Dialog, select “Plan 1”, and return the selected object (click the green checkmark).

The tree and grid should appear configured as in Figure 21:

Warning
When creating and exporting packages that include CMF Content Types, it is important to keep in mind that there may be RelationshipTypes that are automatically created during the CMF process. These RelationshipTypes should not be added or exported. Doing so will cause import errors.

To see an example of these RelationshipTypes, create the following:

  1. Create a new ItemType called “Desk.”
  2. Create a new Content Type item:
    1. Name = “Desk_CMF”.
    2. Linked Item Type = “Desk”.
  3. Add an Element to Desk_CMF called Desk_Element1.
  4. Add a Property to the Desk_Element1 called Desk_Prop1.
  5. Save and close the Desk_CMF Content Type.
  6. Open the Desk ItemType and go to the RelationshipType tab.

There should be 2 items that were automatically created in the CMF process.

Note
These RelationshipType items should not be added to Package Definitions for exporting. When exporting the CMF, it is necessary to include the cmf_BaseView item for the CMF to load properly. Navigate to the cmf_BaseView ItemType and expose it in the TOC by giving it the correct TOC Access settings. Find the cmf_BaseView item associated with your CMF ItemType and add it to the package definition.

When importing the Content Type item, these RelationshipType items will be created automatically by default.