Skip to content

Commit 9812d22

Browse files
authored
Revise documents to show model sample output (#675)
* JIRA WDT-435 - Revise documents to show model sample output * JIRA WDT-435 - Add note about deprecated argument
1 parent 13b5a67 commit 9812d22

File tree

1 file changed

+44
-64
lines changed

1 file changed

+44
-64
lines changed

site/model_help.md

Lines changed: 44 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,59 @@ The Model Help Tool provides information about the folders and attributes that a
44

55
**NOTE:** The Model Help Tool is new in WebLogic Deploy Tooling 1.8.
66

7+
**NOTE:** The `-model_sample` argument is deprecated starting with WebLogic Deploy Tooling 1.9.2, when model sample became the default output format.
8+
79
Here is a simple example using the Model Help Tool:
810
```yaml
911
<wls-deploy-home>/bin/modelHelp.sh -oracle_home /tmp/oracle resources:/JDBCSystemResource
1012
```
1113
This will result in the following output:
1214
```yaml
13-
Path: resources:/JDBCSystemResource
14-
15-
Valid Attributes:
16-
CompatibilityName string
17-
DeploymentOrder integer
18-
DeploymentPrincipalName string
19-
DescriptorFileName string
20-
ModuleType string
21-
Notes string
22-
SourcePath string
23-
Target delimited_string
24-
25-
Valid Folders:
26-
JdbcResource
27-
SubDeployment (multiple)
15+
Attributes and sub-folders for resources:/JDBCSystemResource
16+
17+
resources:
18+
JDBCSystemResource:
19+
'JDBC-1':
20+
CompatibilityName: # string
21+
DeploymentOrder: # integer
22+
DeploymentPrincipalName: # string
23+
DescriptorFileName: # string
24+
ModuleType: # string
25+
Notes: # string
26+
SourcePath: # string
27+
Target: # delimited_string
28+
29+
JdbcResource:
30+
# see /JDBCSystemResource/JdbcResource
31+
32+
SubDeployment:
33+
'SubDeployment-1':
34+
# see /JDBCSystemResource/SubDeployment
35+
```
36+
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.
37+
38+
Folders that support multiple instances, such as `JDBCSystemResource` in this example, are shown with a derived name, such as `'JDBC-1'`.
39+
40+
Each sub-folder includes a comment with a model path that can be used to display additional information about that sub-folder. For example, to determine the attributes and sub-folders for `'SubDeployment-1'`, the Model Help Tool could be re-invoked with the model path from the comment:
41+
```yaml
42+
<wls-deploy-home>/bin/modelHelp.sh -oracle_home /tmp/oracle -model_sample /JDBCSystemResource/SubDeployment
2843
```
29-
This result lists the attributes and folders available for the `JDBCSystemResource` folder in the `resources` section of the model. You can use this information to construct this model section:
44+
You can use the information above to construct this model section:
3045
```yaml
3146
resources:
3247
JDBCSystemResource:
3348
CompatibilityName: 'myName'
3449
DeploymentOrder: 5
3550
Target: 'ms1,ms2'
36-
JdbcSystemResource:
51+
'JDBC-1':
3752
# JdbcSystemResource attributes and folders
3853
SubDeployment:
3954
deployment1:
4055
# SubDeployment attributes and folders
4156
deployment2:
4257
# SubDeployment attributes and folders
4358
```
44-
The `(multiple)` notation on the `SubDeployment` folder indicates that it should have one or more named sub-folders containing its attributes and sub-folders.
59+
If you are copying elements from the sample model to create a full domain model, you should exclude any attributes or sub-folders that you do not intend to declare or override.
4560

4661
### Path Patterns
4762
There are a number of ways to specify model location in the path argument. Here are some examples:
@@ -73,68 +88,33 @@ There are several command-line options that you can use to control the output te
7388
When the top sections are listed using the path ```top```, any output options are ignored.
7489

7590
#### ```-attributes_only```
76-
This option will list only the attributes for the specified path. If there are no attributes, then the section heading will appear with an empty list.
91+
This option will list only the attributes for the specified path.
7792

7893
#### ```-folders_only```
79-
This option will list only the immediate sub-folders for the specified path. If there are no sub-folders, then the section heading will appear with an empty list.
94+
This option will list only the immediate sub-folders for the specified path.
8095

8196
#### ```-recursive```
82-
This option will recursively list all the sub-folders within the specified path. No attributes are listed. If there are no sub-folders, then the section heading will appear with an empty list.
97+
This option will recursively list all the sub-folders within the specified path. No attributes are listed.
8398

8499
Here is an example using the `-recursive` option:
85100
```yaml
86101
<wls-deploy-home>/bin/modelHelp.sh -oracle_home /tmp/oracle -recursive resources:/JDBCSystemResource
87102
```
88103
The output is:
89104
```yaml
90-
Filtering output to recursively display the sub-folders of the specified model section or path
91-
92-
Path: resources:/JDBCSystemResource
93-
94-
Valid Folders:
95-
JdbcResource
96-
JDBCConnectionPoolParams
97-
JDBCDataSourceParams
98-
JDBCDriverParams
99-
Properties (multiple)
100-
JDBCOracleParams
101-
JDBCXAParams
102-
SubDeployment (multiple)
103-
```
104-
105-
### Model Sample Output
106-
You can use the `-model_sample` argument to output a model sample for the specified model path. Depending on the output options specified, this argument will create a sample with the available attributes and sub-folders for the specified path.
107-
108-
If you are copying elements from the sample model to create a full domain model, you should exclude any attributes or sub-folders that you do not intend to declare or override.
105+
Recursive sub-folders only for resources:/JDBCSystemResource
109106

110-
Here is an example using the `-model_sample` argument:
111-
```yaml
112-
<wls-deploy-home>/bin/modelHelp.sh -oracle_home /tmp/oracle -model_sample resources:/JDBCSystemResource
113-
```
114-
The output is:
115-
```yaml
116107
resources:
117108
JDBCSystemResource:
118109
'JDBC-1':
119-
CompatibilityName: # string
120-
DeploymentOrder: # integer
121-
DeploymentPrincipalName: # string
122-
DescriptorFileName: # string
123-
ModuleType: # string
124-
Notes: # string
125-
SourcePath: # string
126-
Target: # delimited_string
127-
128110
JdbcResource:
129-
# see /JDBCSystemResource/JdbcResource
130-
111+
JDBCConnectionPoolParams:
112+
JDBCDataSourceParams:
113+
JDBCDriverParams:
114+
Properties:
115+
'Properties-1':
116+
JDBCOracleParams:
117+
JDBCXAParams:
131118
SubDeployment:
132119
'SubDeployment-1':
133-
# see /JDBCSystemResource/SubDeployment
134120
```
135-
This output shows the eight attributes and two sub-folders available for the model path. Each attribute includes a comment describing the type of the value to be added.
136-
137-
Each sub-folder includes a comment with a model path that can be used to display additional information about that sub-folder. For example, to determine the attributes and sub-folders for `'SubDeployment-1'`, the Model Help Tool could be re-invoked with the model path from the comment:
138-
```yaml
139-
<wls-deploy-home>/bin/modelHelp.sh -oracle_home /tmp/oracle -model_sample /JDBCSystemResource/SubDeployment
140-
```

0 commit comments

Comments
 (0)