# Commandlets

```{toctree}
:glob: true
:hidden: true

commandlets/objects
commandlets/show-bomwindow
commandlets/*
```

All Commandlets are supporting OData Version v1, v2, v3, v4.

The cmdlets try to perform as less server requests as possible, in order to ensure high performance when communicating over the network or the internet.

:::{admonition} Metadata
Requests to retrieve the service `$metadata` will be retrieved only when required and only for the required services.\
When services are not available, powerGate will try to retrieve there metadata as long as they become available! Warnings will be logged in order to inform about the downtime of the service.

After retrieving metadata once, no further metadata request is required as the server results are cached by the product.
:::

:::{admonition} Performance
:class: warning

When some of the services are permanently not available, you can speed up your process by disconnecting them.\
Please see example [Disconnect all not available services](<code_reference/commandlets/disconnect-erp:examples>).
:::
## Connection

Connection related cmdlets.

| Name                                          | Description                    |
|-----------------------------------------------|--------------------------------|
| [Connect-ERP](<commandlets/connect-erp>)        | Connects to a ERP-System.      |
| [Disconnect-ERP](<commandlets/disconnect-erp>)  | Disconnects from a ERP-System. |


## Metadata

Cmdlets to read metadata from the services.

| Name                                                  | Description                                          |
|-------------------------------------------------------|------------------------------------------------------|
| [Get-ERPServices](<commandlets/get-erpservices>)        | Returns information about the connected services     |
| [Get-ERPEntitySets](<commandlets/get-erpentitysets>)    | Returns information about the available entitySets   |
| [Get-ERPEntityTypes](<commandlets/get-erpentitytypes>)  | Returns information about the available EntityTypes. |

-----

```{note}
The following commandlets **require a successful connection** between the current application and the ERP system or [powerGateServer](<powergateserver:index>).\
For them to work properly, all the necessary ERP services (or a single CatalogService) must have been previously connected by the [](<commandlets/connect-erp>) cmdlet.
```
## Entities

Cmdlets for reading, adding, updating and removing entities.

| Name                                              | Description                                                                 |
|---------------------------------------------------|-----------------------------------------------------------------------------|
| [Get-ERPObject](<commandlets/get-erpobject>)        | Returns a specific entity from the ERP-System.                              |
| [Get-ERPObjects](<commandlets/get-erpobjects>)      | Searches for entities depending on the passed arguments.                    |
| [Update-ERPObject](<commandlets/update-erpobject>)  | Updates an existing entity on the ERP-System.                               |
| [Add-ERPObject](<commandlets/add-erpobject>)        | Creates a new entity and transfers it to a ERP-System.                      |
| [Remove-ERPObject](<commandlets/remove-erpobject>)  | Deletes a specific entity from the ERP-System.                              |
| [New-ERPObject](<commandlets/new-erpobject>)        | Create a new and empty instance of the required entity from the ERP-System. |


## Media

Cmdlets for downloading, uploading and updating media (e.g Files...).

| Name                                            | Description                                        |
|-------------------------------------------------|----------------------------------------------------|
| [Add-ERPMedia](<commandlets/add-erpmedia>)        | Uploads media (e.g Files..) to the ERP-System.     |
| [Get-ERPMedia](<commandlets/get-erpmedia>)        | Downloads media (e.g Files..) from the ERP-System. |
| [Update-ERPMedia](<commandlets/update-erpmedia>)  | Updates media on the ERP-System.                   |