# Cmdlets

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

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

All the following OData cmdlets support OData version v1, v2, v3, v4.\
They all try to perform as less server requests as possible, in order to ensure high performance when communicating over the network or the internet with your ERP system.

## Connection management

Cmdlets for connection establishment with OData services:

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

Cmdlets to read metadata of connected OData 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. |

:::{admonition} Metadata
Requests to retrieve the service `$metadata` are only performed when needed 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.
:::

:::{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>).
:::
-----

The following Cmdlets **require a successful connection** between the current application and the ERP system or [powerGateServer](<inv: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.

## Entity transfer

Cmdlets for reading, adding, updating and removing OData 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>)        | Returns a new default instance of the desired ERP entity.                 |


## Media exchange

Cmdlets for downloading, uploading and updating OData media files such as images, text files or even Autodesk file formats:

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