# Components in a Folder

It can be very useful to work with components which are located in a specific folder, only. For example an API, where an API component (web-service) and two processes implementing the API end-points are located in the same folder.

```url
/#Examples/95 - Documentation Examples/#APIServices/GPR - GoodPractices
```

<figure><img src="https://856602315-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJ5pAMZk3evA8VCVuQL%2Fuploads%2Fgit-blob-e7ba6f135baf1a12ae299c8686a52450ace34b4d%2Fimage.png?alt=media" alt=""><figcaption><p>A Web-Service and its implementation in a single folder.</p></figcaption></figure>

### Create documentation

Create documentation for all *deployable* components in the specified folder, and write the output to *GoodPractices.*

```batch
.\bc comp doc /deployableOnly /f "*GPR - GoodPractices*" /o GoodPractices
```

You will find the rendered documentation in the specified output folder *GoodPractices/Doc:*

<figure><img src="https://856602315-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJ5pAMZk3evA8VCVuQL%2Fuploads%2Fgit-blob-c5c771a6552357ad7be1c03d27650789fc23de03%2Fimage.png?alt=media" alt=""><figcaption><p>A nice documentation for all processes found in <code>GPR - GoodPractices</code> folder.</p></figcaption></figure>

The documentation is interactive (see [documentation-links](https://boomi.markusschmidt.pro/boomi-console/help-text/documentation-links "mention")).

<figure><img src="https://856602315-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJ5pAMZk3evA8VCVuQL%2Fuploads%2Fgit-blob-dbfc56fea1588992c93c75156c572e63bdc651aa%2FinteractiveLink.gif?alt=media" alt=""><figcaption><p>From documentation to Runtime using interactive links</p></figcaption></figure>

### Get deployment overview

Get all deployed components which are located in the specified folder and render the *deployedPackage.csv* to see which version was deployed to which environment.

Write the output to *GoodPractices.*

```batch
.\bc deploy get /f "*GPR - GoodPractices*" /t deployedPackages.csv /o GoodPractices
```

Depending on the CSV Viewer you chose (VS Code Extension: *Excel Viewer* or *Rainbow CSV*), you will probably get something like this:

<figure><img src="https://856602315-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJ5pAMZk3evA8VCVuQL%2Fuploads%2Fgit-blob-91e88d2b0729d93a79275ead25e498304be5b5a9%2Fimage.png?alt=media" alt=""><figcaption><p>The <em>deployedPackages.csv</em> shows components deployed to any environment incl. their deployment details.</p></figcaption></figure>

## Arguments explained

* `/f *{folderName}*`\
  The folder-name with wild-cards as the component source. The wildcarded name is used to lookup the folder full path.
* `/o`\
  The directory where all outputs will be written to, relative to the workspace directory!\
  It is recommended to use `out\{folderName}`
* `/t compList.CSV`\
  A predefined template to render the component output.

  <figure><img src="https://856602315-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJ5pAMZk3evA8VCVuQL%2Fuploads%2Fgit-blob-54f6130bfdcbe22c8e52660abed687553639c47c%2Fimage%20(7)%20(1)%20(1)%20(1).png?alt=media" alt=""><figcaption><p><code>compList.csv</code></p></figcaption></figure>

## Observations

{% hint style="danger" %}
**Unspecified fault message**

On one Boomi Account I got *Unspecified fault message* when querying folders from API and so far there is no explanation for that.
{% endhint %}