Skip to content

Commit 9d28007

Browse files
authored
Documentation for model help -model_sample argument (#625)
* JIRA WDT-320 Added documentation for model help -model_sample argument * JIRA WDT-320 Corrections from review
1 parent e5afa34 commit 9d28007

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

site/model_help.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,3 +101,40 @@ Path: resources:/JDBCSystemResource
101101
JDBCXAParams
102102
SubDeployment (multiple)
103103
```
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.
109+
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
116+
resources:
117+
JDBCSystemResource:
118+
'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+
128+
JdbcResource:
129+
# see /JDBCSystemResource/JdbcResource
130+
131+
SubDeployment:
132+
'SubDeployment-1':
133+
# see /JDBCSystemResource/SubDeployment
134+
```
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)