Here you’ll find some screenshots of the TreeGrid in action.

Screen Designer:

Form Designer:

Organisation:

Proposal:

• Add a copy of the SimpleSwatTreeGrid, e.g. YourTreeGrid to your screen
• Add as primary DSO the DSO of your head of the TreeGrid (also known as the root node) to your screen
• Connect YourTreeGrid and the DSO via data-link
• Fill the following attributes of the TreeGrid:
• EntityName = eStruct
• ResourceName: Fill in the name of the resource as file structure, starting with the folder below src/backend of the Progress Class, which defines this TreeGrid
• e.g. ResourceName = customer.offer.struct.OfferStructEntity )
• To add tree entries and maintain the TreeGrid you need a SimpleSwatRibbon in your screen

ℹ️ To be faster we recommend to use the Template Tree Window (simple)

• In the YourTreeGrid you have to add the fields, which you want to display there. Therefore go to the tab instances and add them there. Please have in mind, that in the Tree only fields from your StructEntity will be displayed. How to add there individual columns, please see.

• Every TreeGrid can have different types of records, e.g. group-, text- or item-positions. You configure the types via the content types (see chapter below): Name, icon and colour, related DB-table, and the screen which should be shown in the right panel, when selecting a child of the TreeGrid
• Configuration:
• In the menu structure GenericStructTreeRibbon there is a dropdown included to add new records of specific types to the TreeGrid which you can use.
• To add new options to the DropDown, use the typeRange attribute of the SimpleSwatTreeGrid.
• Here you can specify all Content Types you want to display, e.g. if you would like to display the Content Types pos.ofr.position and pos.ofr.text just use pos.ofr. as the value of typeRange. Keep in mind, that all content types will be shown, which starting with the string pos.ofr.

When choosing a node from the treegrid, you can display the details on the right side of the tree (e.g. in a form). Therefore you have to design own frames (like windows) and connect them to your node type. For each type you can display a different frame. The design of a frame will be done in the same way as a window, so you can add DSOs, Grids and Forms to the frame. Keep in mind to set the foreignKey attribute of the PrimaryDSO of the frame with the foreign keys of the root and the nodes

Define the corresponding frame for each node type:

• In the Content types desktop you can define the corresponding frame by copying the name of the frame in the column Verschiedenes or Misc

Special fields for the frame

• You also have to add (or create them new) some special fields to the entity, which is included in the primaryDSO of your frame
• akStructParentHdl, akStructTypeHdl, akStructRelationType , refHdl

To make the TreeGrid working, you need to add the following backend logic. In the following chapters we are using yourTree as an example/placeholder for the Tree you’re creating

BLOCK-LEVEL ON ERROR UNDO, THROW.
CLASS yourTree.YourTreeEventHandler
  INHERITS Akioma.Swat.OERA.Dynamic.BaseServerEventHandler: 
  { yourTree/yourTree.i &ACCESS="PRIVATE" }
  CONSTRUCTOR YourTreeEventHandler():
    SUPER(DATASET dsData:HANDLE).
    THIS-OBJECT:RegisterHandler(1, NEW Akioma.Swat.OERA.Dynamic.Strategy.Struct.StructOwnerHandler("pos.own.yourtree")).
  END CONSTRUCTOR.
END CLASS.

&SCOPED-DEFINE ACCESS {&ACCESS}
&SCOPED-DEFINE REFERENCE-ONLY {&REFERENCE-ONLY}
&SCOPED-DEFINE SUFFIX {&SUFFIX}
&GLOBAL-DEFINE DATASET-NAME dsStruct
{ yourTree/Struct/eStruct.i } 
DEFINE {&ACCESS} DATASET dsStruct{&SUFFIX} {&REFERENCE-ONLY} FOR eStruct{&SUFFIX}.

DEFINE {&ACCESS} TEMP-TABLE eStruct{&SUFFIX} NO-UNDO {&REFERENCE-ONLY} &IF DEFINED (NO-BEFORE) EQ 0 &THEN BEFORE-TABLE eStructBefore{&SUFFIX} &ENDIF
  {Akioma/Swat/Struct/base-struct-standard-fields.i}
  INDEX iScan AS PRIMARY UNIQUE ParentHdl SeqNum.

BLOCK-LEVEL ON ERROR UNDO, THROW.
CLASS yourTree.Struct.Nodes.TreeNodeEventHandler
  INHERITS Akioma.Swat.OERA.Dynamic.BaseServerEventHandler:
  CONSTRUCTOR TreeNodeEventHandler():
    THIS-OBJECT:RegisterHandler(1, NEW Akioma.Swat.OERA.Dynamic.Strategy.Struct.StructNodeHandler()).
  END CONSTRUCTOR.
END CLASS.

Within your treeGrid-Object (document, organisation etc.) you have to create a new Struct root-node each time you create a new object.

For the root-node you need a content type pos.own.YourObjectRootContentType (starting with pos.own is mandatory)

For the addStruct-Method the following parameters are available:

• Hdl of the parent or previous node
• Type of the node (this is the SelfHdl of the content type you want to add)
• Relation of newly created node as integer, possible values:
• stRelNextSibling -> 1
• stRelFirstChild -> 3
• stRelRootNode -> 4
• Optional: The Hdl of the data you want to connect to the created node

The Struct business entities have the following overridable events:

These are the properties of Akioma.Swat.Struct.OperationStructRecordsParameter:

These are the properties of Akioma.Swat.OERA.GetDragAndDropDialogParameter:

These are the properties of Akioma.Swat.Struct.SetStructFlagParameter:

  {Consultingwerk/JsonSerializableProperty.i  StructHdl CHARACTER}.  
  {Consultingwerk/JsonSerializableProperty.i  Flag CHARACTER}.

Implement a function, which creates one TreeNode directly (can be included in the Ribbon instead of the dropdown):

export default function createNodeByType(eventSource: akioma.swat.Ribbon, cType: string, iRelation: number): void {
  const oTreeGrid = eventSource.getLink('USER1:TARGET');
  oTreeGrid.controller.storeConnector.tree.typeOfAdd = cType;
  oTreeGrid.controller.storeConnector.createNewNode(eventSource, iRelation);
}

‣

Example how to include the function

• As nodeType you have to hand over the selfHdl of the nodeType.
• How-to: You can use e.g. the Developer Tools of the Chrome Browser, open the content types desktop and there you will find the selfHdl of each nodeType

If you want to display more columns in your Tree you have to add the necessary fields to your StructEntity. There are two options to do this:

1. Implement this directly in the structEntity.cls in the AfterFetch event with your individual logic. With this approach it’s also possible to calculate some fields
2. Map the fields from some application entity to the StructEntity. In this context you can also add additional fields to the StructEntity
1. To add new fields, e.g. CustomField1, to the StructEntity you have to add them into src/backend/yourTree/Struct/eStruct.i, see example
Copy

DEFINE {&ACCESS} TEMP-TABLE eStruct{&SUFFIX} NO-UNDO {&REFERENCE-ONLY} &IF DEFINED (NO-BEFORE) EQ 0 &THEN BEFORE-TABLE eStructBefore{&SUFFIX} &ENDIF
  {Akioma/Swat/Struct/base-struct-standard-fields.i}
	FIELD CustomField1 AS CHARACTER
  FIELD CustomField2 AS INTEGER
  INDEX iScan AS PRIMARY UNIQUE ParentHdl SeqNum.

2. To map the fields, add these mappings from your source entity to the StructEntity in the StructDataAccess see here: TreeGrid - StructDataAccess
3. After mapping these, add also a field in the B1 UI to YourTreeGrid. Therefore add it in the tab Instances and please use the same name as you defined in the eStruct.i file

Please see here: Events: Subscribing to Backend-Events

To check in your OpenEdge code the position in your grid, you can use the following functionalities of the StructHelper class:

• Get a chain: Owner,Root,node1,node2,....,<parent of chNode> Akioma.Swat.Struct.StructHelper:reqChainToRoot(INPUT pcNodeHdl AS CHARACTER)
• Receives an Owner-Hdl and sets the QueryPrepare to the top of that tree, that is the one record that has this owner and has no parent. Akioma.Swat.Struct.StructHelper:reqFirstOfOwner(INPUT pcOwnerHdl AS CHARACTER)
• Returns the the SelfHdl of next sibling of a given record Akioma.Swat.Struct.StructHelper:reqStructHdlAfter(INPUT pcHdl AS CHARACTER)
• Returns the SelfHdl of the previous sibling of a given record Akioma.Swat.Struct.StructHelper:reqStructHdlBefore(INPUT pcHdl AS CHARACTER)
• Returns the SelfHdl of the child record of a given record Akioma.Swat.Struct.StructHelper:reqStructHdlChild(INPUT pcHdl AS CHARACTER)