Skip to content

Commit f97e5ec

Browse files
Update Model Help Tool (#1373)
1 parent bcae87b commit f97e5ec

File tree

1 file changed

+87
-8
lines changed

1 file changed

+87
-8
lines changed

documentation/3.0/content/userguide/tools/model_help.md

Lines changed: 87 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,28 @@ Attributes and sub-folders for resources:/JDBCSystemResource
2424
resources:
2525
JDBCSystemResource:
2626
'JDBC-1':
27-
CompatibilityName: # string
28-
DeploymentOrder: # integer
29-
DeploymentPrincipalName: # string
30-
DescriptorFileName: # string
31-
ModuleType: # string
32-
Notes: # string
33-
SourcePath: # string
34-
Target: # delimited_string
27+
CompatibilityName: # string +
28+
DeploymentOrder: # integer (default=100) +
29+
DeploymentPrincipalName: # string +
30+
DescriptorFileName: # string +
31+
ModuleType: # string +
32+
Notes: # string +
33+
SourcePath: # string +
34+
Target: # delimited_string +
3535

3636
JdbcResource:
3737
# see /JDBCSystemResource/JdbcResource
3838

3939
SubDeployment:
4040
'SubDeployment-1':
4141
# see /JDBCSystemResource/SubDeployment
42+
43+
44+
This bean defines a system-level JDBC resource. It links a separate
45+
descriptor that specifies the definition.
4246
```
4347
This output shows the eight attributes and two sub-folders available for the `JDBCSystemResource` folder in the `resources` section of the model. Each attribute includes a comment describing the type of the value to be added.
48+
A plus sign (`+`) on an attribute indicates that appending the attribute to the model path will yield more information about the attribute.
4449

4550
Folders that support multiple instances, such as `JDBCSystemResource` in this example, are shown with a derived name, such as `'JDBC-1'`.
4651

@@ -88,6 +93,43 @@ If the section is not provided for a folder, then it will be derived and include
8893
/JDBCSystemResource/JdbcResource
8994
```
9095

96+
#### Per attribute help
97+
To show help for a particular attribute in a folder, simply add it to the model path.
98+
99+
For example:
100+
```yaml
101+
$ modelHelp.sh topology:/Server/Log/StdoutSeverity
102+
```
103+
The output is:
104+
```yaml
105+
Attributes and sub-folders for topology:/Server/Log/StdoutSeverity
106+
107+
topology:
108+
Server:
109+
'Server-1':
110+
Log:
111+
StdoutSeverity: # string
112+
113+
Default=Notice
114+
Legal values:
115+
'Trace'
116+
'Debug'
117+
'Info'
118+
'Warning'
119+
'Error'
120+
'Notice'
121+
'Critical'
122+
'Alert'
123+
'Emergency'
124+
'Off'
125+
126+
127+
The minimum severity of log messages going to the standard out.
128+
Messages with a lower severity than the specified value will
129+
not be published to standard out.
130+
```
131+
132+
91133
#### Output options
92134
There are several command-line options that you can use to control the output text for the model path. Use only one of these options at a time. If no output options are specified, then the attributes and immediate sub-folders for the specified path are listed.
93135

@@ -127,6 +169,42 @@ resources:
127169
'SubDeployment-1':
128170
```
129171
172+
#### Interactive option
173+
To access an interactive command line for exploring model paths using a directory style syntax, use `modelHelp.sh -interactive <starting_model_path>`.
174+
175+
For example:
176+
```yaml
177+
$ modelHelp.sh -interactive top
178+
```
179+
The output is:
180+
```yaml
181+
In interactive mode! Type 'help' for help.
182+
[top] --> help
183+
184+
Commands:
185+
186+
ls - list contents of current location
187+
top, cd, cd /, cd top - go to "top"
188+
cd x[/[...]] - relative change (go to child location x...)
189+
cd section[:/[...]] - absolute change (go to exact section and location)
190+
cd /folder[/...] - find section that contains the folder and go there
191+
cd .. - go up
192+
history - history of visited locations
193+
exit - exit
194+
195+
Sections:
196+
197+
domainInfo, topology, resources, appDeployments, kubernetes
198+
199+
Examples:
200+
201+
cd topology
202+
cd topology:/Server/Log/StdoutSeverity
203+
cd /Server/Log/StdoutSeverity
204+
205+
[top] -->
206+
```
207+
130208
### Parameter table for `model_help`
131209
| Parameter | Definition | Default |
132210
| ---- | ---- | ---- |
@@ -135,3 +213,4 @@ resources:
135213
| `-oracle_home` | Home directory of the Oracle WebLogic installation. Required if the `ORACLE_HOME` environment variable is not set. | |
136214
| `-recursive` | List only the folders for the specified model path, and recursively include the folders below that path. | |
137215
| `<model_path>` | The path to the model element to be examined. The format is `[^<section^>:][/^<folder^>]...` | |
216+
| `-interactive <starting_model_path>` | Interactive mode. | |

0 commit comments

Comments
 (0)