|
1 | | -intro-to-graph-nav |
| 1 | +# Introduction to Graph Navigation |
| 2 | + |
| 3 | +Graph Navigation is a platform service introduced in Aras Innovator 11.0 SP15 that allows users to quickly visualize and navigate data structures via a node-edge graph. This community project contains several samples to demonstrate how to configure and style Graph Views. |
| 4 | + |
| 5 | +For more detail on Graph Navigation in Aras Innovator, check out these resources: |
| 6 | +* Blog Post: [Getting Started with Graph Navigation](https://community.aras.com/b/english/posts/getting-started-with-graph-navigation) |
| 7 | +* Blog Post: [Customizing Aras Graph Navigation Views](https://community.aras.com/b/english/posts/customizing-aras-graph-navigation-views) |
| 8 | +* Coming Soon: Demo Series webinar recording |
| 9 | +* Coming Soon: View Card Editor community project |
| 10 | + |
| 11 | +## History |
| 12 | + |
| 13 | +Release | Notes |
| 14 | +--------|-------- |
| 15 | +[v1.0.0](https://github.com/ArasLabs/intro-to-graph-nav/releases/tag/v1.0.0) | First release. |
| 16 | + |
| 17 | +#### Supported Aras Versions |
| 18 | + |
| 19 | +Project | Aras |
| 20 | +--------|------ |
| 21 | +[v1.0.0](https://github.com/ArasLabs/intro-to-graph-nav/releases/tag/v1.0.0) | 11.0 SP15 |
| 22 | + |
| 23 | +## Installation |
| 24 | + |
| 25 | +#### Important! |
| 26 | +**Always back up your code tree and database before applying an import package or code tree patch!** |
| 27 | + |
| 28 | +### Pre-requisites |
| 29 | + |
| 30 | +1. Aras Innovator installed |
| 31 | +2. Aras Package Import Utility |
| 32 | +3. aras.labs.graph_nav.examples package |
| 33 | + |
| 34 | +### Install Steps |
| 35 | + |
| 36 | +1. Backup your database and store the BAK file in a safe place. |
| 37 | +2. Open up the Aras Package Import tool. |
| 38 | +3. Enter your login credentials and click **Login** |
| 39 | + * _Note: You must login as root for the package import to succeed!_ |
| 40 | +4. Enter the package name in the TargetRelease field. |
| 41 | + * Optional: Enter a description in the Description field. |
| 42 | +5. Enter the path to your local `..\intro-to-graph-nav\Import\imports.mf` file in the Manifest File field. |
| 43 | +6. Select the following in the Available for Import field. |
| 44 | + * **aras.labs.graph_nav.examples** |
| 45 | +7. Select Type = **Merge** and Mode = **Thorough Mode**. |
| 46 | +8. Click **Import** in the top left corner. |
| 47 | +9. Close the Aras Package Import tool. |
| 48 | + |
| 49 | +You are now ready to login to Aras and check out the included Graph Navigation examples. |
| 50 | + |
| 51 | +## Usage |
| 52 | + |
| 53 | +### Example 1: Default Ad Hoc Graph |
| 54 | +The built-in `gn_ShowGraphView` action automatically exposes the default Ad Hoc graph view. To add this "Show Graph" action to an ItemType, follow the steps below: |
| 55 | + |
| 56 | +1. Navigate to **Administration > ItemTypes** in the TOC. |
| 57 | +2. Search for the Part ItemType and open it for editing. |
| 58 | +3. Select the **Actions** tab and click the **Add New** button to pick a related Action. |
| 59 | +4. Search for the **gn_ShowGraphView** Action and double click to add it to the Part ItemType's actions. |
| 60 | +5. Save and close the Part ItemType. |
| 61 | + |
| 62 | +Now we'll be able to view Parts and their related data using Aras Innovator's default graph settings. |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +1. Navigate to **Design > Parts** in the TOC. |
| 67 | +2. Search for the Part you want to view in a graph view and open it. |
| 68 | +3. Select **Actions > Show Graph** from the main menu. |
| 69 | + * You can also run the action from the main grid context menu. |
| 70 | + |
| 71 | +A graph view should open in a new tab, with the context item at the center. From here you can use the graph viewer to expand and collapse the data structure. |
| 72 | + |
| 73 | +### Example 2: Sample Ad Hoc Graph |
| 74 | +This project includes an example of a custom Ad Hoc graph view for Parts. Once you've added the `gn_ShowGraphView` action to the Part ItemType in Example 1, we can also view this graph. |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | +1. Navigate to **Design > Parts** in the TOC. |
| 79 | +2. Search for the Part you want to view in a graph view and open it. |
| 80 | +3. Select **Actions > Show Graph** from the main menu. |
| 81 | +4. When the graph opens, select the Ad Hoc Graph view from the view selector in the toolbar. |
| 82 | + |
| 83 | +### Example 3: Sample Query-Based Graph |
| 84 | +This project includes an example of a Query-Based graph view for Part BOM structures. The import package also includes a custom action to open the graph view directly from the context item instead of opening the default graph first (like Example 2). |
| 85 | + |
| 86 | + |
| 87 | + |
| 88 | +1. Navigate to **Design > Parts** in the TOC. |
| 89 | +2. Search for the Part you want to view in a graph view and open it. |
| 90 | +3. Select **Actions > Show My Query Graph** from the main menu. |
| 91 | + |
| 92 | +## Contributing |
| 93 | + |
| 94 | +1. Fork it! |
| 95 | +2. Create your feature branch: `git checkout -b my-new-feature` |
| 96 | +3. Commit your changes: `git commit -am 'Add some feature'` |
| 97 | +4. Push to the branch: `git push origin my-new-feature` |
| 98 | +5. Submit a pull request |
| 99 | + |
| 100 | +For more information on contributing to this project, another Aras Labs project, or any Aras Community project, shoot us an email at araslabs@aras.com. |
| 101 | + |
| 102 | +## Credits |
| 103 | + |
| 104 | +Created by Eli Donahue for Aras Labs. @EliJDonahue |
| 105 | + |
| 106 | +Other Contributors: |
| 107 | +- Eugene Linkov, Aras Corporation |
| 108 | + |
| 109 | +## License |
| 110 | + |
| 111 | +Aras Labs projects are published to Github under the MIT license. See the [LICENSE file](./LICENSE.md) for license rights and limitations. |
0 commit comments