Opening paragraph
Accessing Under-The-Hood
Before working with the PlanSwift API, a good understanding of PlanSwift's internal structure is recommended. To review PlanSwift's structure, the under-the-hood (U-T-H) tab needs to be enabled.
By modifying or changing anything in the back end, you may adversely affect the operation of PlanSwift. Modifications should be done in a read-only mode. If any modifications are done to the back end of PlanSwift, those modifications will be lost when PlanSwift is re-installed.
Follow these steps to enable PlanSwift's under-the-hood U-T-H tab.
- Open PlanSwift.
- Click on Settings along the top ribbon bar (see #1 on Figure 1-1 below).
- Select Interface from the options on the left (see #2 on Figure 1-1 below).
- Click on Show Under the Hood Screen. (see #3 on Figure 1-1 below).
Figure 1-1 - For the password, please contact your PlanSwift representative or send an email to devnetwork@planswift.com.. Enter the password (see number #4 of Figure 1-1) and click on Ok.
- An U-T-H (for "Under-the-Hood") now appears on the top ribbon bar (see the red arrow in Figure 1-2). Click on U-T-H.
Figure 1-2
Understanding the Under-The-Hood hierarchy
Clicking on U-T-H tab displays the Under-The-Hood (U-T-H) hierarchy. PlanSwift (1.0) is the root, or the parent object. Each of the folders beneath PlanSwift is a child of PlanSwift.
Figure 1-3