Skip to content

Commit 2ca6c37

Browse files
authored
Update old documentation terminology (#227)
1 parent 9fbc82d commit 2ca6c37

File tree

4 files changed

+34
-32
lines changed

4 files changed

+34
-32
lines changed

DOCUMENTATION.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Content CLI as a tool for managing content in the EMS
1+
# Content CLI as a tool for managing content in the Celonis Platform
22

33
- [Content CLI Core Features](#content-cli-core-features)
44
- [Using profiles](#using-profiles)
55
- [Pull command](#pull-command)
66
- [Push command](#push-command)
77
- [Using content-cli inside Studio](#using-content-cli-inside-studio)
88
- [Pull/Push packages from/to Studio](#pullpush-packages-fromto-studio)
9-
- [Pull package for EMS Store](#pull-package-for-ems-store)
9+
- [Pull package for Celonis Marketplace](#pull-package-for-celonis-marketplace)
1010
- [Pull/Push individual assets from/to Studio](#pullpush-individual-assets-fromto-studio)
1111
- [Overwrite Package In Studio](#overwrite-package-in-studio)
1212
- [Batch Export packages from Studio](#export-multiple-packages-at-once-from-studio)
@@ -27,19 +27,19 @@
2727

2828
Content CLI has three core functionalities:
2929

30-
**Profile:** The CLI connects to the EMS environments through profiles.
30+
**Profile:** The CLI connects to the Celonis Platform through profiles.
3131
For each of the commands you can specify which profile you want to use.
3232
This makes it powerful in the sense that you can pull something from
33-
let's say team1.cluser1 and push it directly to team2.cluster2 easily.
33+
let's say team1.cluster1 and push it directly to team2.cluster2 easily.
3434
You can create a profile using the following command:
3535

3636
```
3737
content-cli profile create
3838
```
3939

40-
**Pull:** This feature allows you to download content from the EMS to
41-
your local machine.Let's take Studio package as an example. These
42-
can be exported in the EMS as ZIP files that contain all package assets.
40+
**Pull:** This feature allows you to download content from the Celonis Platform to
41+
your local machine.Let's take a Studio package as an example. These
42+
can be exported in the Celonis Platform as ZIP files that contain all package assets.
4343
By using the following command using the package key and profile you
4444
have created, you will pull the ZIP file.
4545

@@ -48,7 +48,7 @@ content-cli pull package -p team1.cluster1 --key my-package
4848
```
4949

5050
**Push:** This feature allows you to push a content file to a team
51-
in the EMS. To continue the last example, you can use the following
51+
in the Celonis Platform. To continue the last example, you can use the following
5252
command to push he previously pulled package in another team.
5353

5454
```
@@ -67,7 +67,7 @@ content-cli pull package -h
6767
### Using profiles
6868

6969
As mentioned above, **Content CLI** allows creating profiles for
70-
different environments. A profile consists of a name, URL to your EMS
70+
different environments. A profile consists of a name, URL to your Celonis Platform
7171
team and an API token. Each of the above mentioned commands include
7272
***--profile*** flag which allows you selecting a profile by its name.
7373

@@ -90,23 +90,25 @@ OAuth supports with two grant types: Device Code & Client Credentials.
9090

9191
With Device Code, creating the profile will trigger an authorization flow
9292
(using the OAuth 2.0 Device code). You will be prompted to follow an authorization
93-
link where you must authorize the **Content CLI** to be able to access the EMS environment
93+
link where you must authorize the **Content CLI** to be able to access the Celonis Platform environment
9494
on your behalf.
9595

9696
With Client Credentials, you need to provide the credentials (Client ID, Client Secret) configured for your OAuth client.
97-
You can create and configure an OAuth clients in the `Admin & Settings` section of your EMS account, under `Applications`.
98-
The OAuth client needs to have the following scopes configured: studio, integration.data-pools, action-engine.projects.
97+
You can create and configure an OAuth clients in the `Admin & Settings` section of your Celonis account, under `Applications`.
98+
The OAuth client needs to have scopes configured based on the area of commands they're using, e.g.:
99+
- For Studio commands: studio,
100+
- Data Pipeline/Data Pool commands: integration.data-pools,
99101
After creating an OAuth client, you should assign it the permissions necessary for the respective commands. More
100102
information on registering OAuth clients can be found [here](https://docs.celonis.com/en/registering-oauth-client.html).
101103

102104
##### API Token
103105

104106
You can choose between two different options when asked for an API token.
105107
The first option is to use an API key, which identifies the user that created
106-
the key. You can generate an API key in the `Edit Profile` section of your EMS
108+
the key. You can generate an API key in the `Edit Profile` section of your Celonis
107109
user account, under `API-Keys`. The second options is to use an Application Key,
108110
which is treated as a new user with separate configurable permissions. You can
109-
generate an Application key in the `Team Settings` section of your EMS account,
111+
generate an Application key in the `Team Settings` section of your Celonis account,
110112
under `Applications`. After creating an Application, you can assign it different
111113
permissions based on how much power you want to give to the key owner.
112114

@@ -126,7 +128,7 @@ which of your commands is set to default.
126128

127129
### Pull command
128130

129-
By using ***content-cli pull***, you can pull content from an EMS team.
131+
By using ***content-cli pull***, you can pull content from a Celonis Platform team.
130132
The CLI pulls that content to the current directory from where you are
131133
using the CLI.
132134

@@ -155,19 +157,19 @@ to specify to which workspace it should be pushed and so on.
155157
### Push command
156158

157159
In the opposite to the pull command, with ***content-cli push*** you can
158-
push content to the EMS. Similarly to the pull command, with the
160+
push content to the Celonis Platform. Similarly to the pull command, with the
159161
***--help*** functionality you can see all the possible entities which
160162
you can push.
161163

162164
```
163165
content-cli push --help
164166
```
165167

166-
#### Push .CTP files to the EMS
168+
#### Push .CTP files to the Celonis Platform
167169

168170
_This functionality supports .CTP files generated on a cpm4 instance version 4.6+._
169171

170-
By using ***content-cli push ctp***, you can push **.CTP** files from your local machine to the EMS, like the following examples:
172+
By using ***content-cli push ctp***, you can push **.CTP** files from your local machine to the Celonis Platform, like the following examples:
171173

172174
```
173175
// Push the analysis extracted from the .CTP file
@@ -220,10 +222,10 @@ of your package, like the following example:
220222
content-cli pull package -p my-profile-name --key ap-operational-app --draft
221223
```
222224

223-
#### Pull package for EMS Store
225+
#### Pull package for Celonis Marketplace
224226

225227
You can use the ***--store*** option to pull the package including the
226-
store metadata you need to upload the package to the EMS Store, like the
228+
store metadata you need to upload the package to the Celonis Marketplace, like the
227229
following example:
228230

229231
```
@@ -237,7 +239,7 @@ content-cli pull package -p my-profile-name --key ap-operational-app --store
237239
### Pull/Push individual assets from/to Studio
238240

239241
The pull/push asset commands work the same way as for other content in
240-
the EMS. By using content-cli pull asset, you can pull individual assets
242+
the Celonis Platform. By using content-cli pull asset, you can pull individual assets
241243
from Studio to your local machine, and an example of it would be:
242244

243245
```

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Content CLI
22

3-
Content CLI is a tool to help manage content in Celonis EMS. It provides various commands to help extract
4-
content like analyses, packages, assets and others from your Celonis EMS team to your local machine, which
3+
Content CLI is a tool to help manage content in Celonis Platform. It provides various commands to help extract
4+
content like analyses, packages, assets and others from your Celonis Platform team to your local machine, which
55
you can then push to other teams. This process can be easily achieved by creating profiles for your different
66
teams and execute commands in a profile's context.
77

@@ -39,16 +39,16 @@ as part of our pycelonis examples library [here](https://github.com/celonis/pyce
3939

4040
Content CLI has three core functionalities:
4141

42-
**Profile:** The CLI connects to the EMS environments through profiles. For each of the commands you can specify
42+
**Profile:** The CLI connects to the Celonis Platform environments through profiles. For each of the commands you can specify
4343
which profile you want to use. This makes it powerful in the sense that you can pull something from let's say
4444
team1.cluser1 and push it directly to team2.cluster2 easily. You can create a profile using the following command:
4545

4646
```
4747
content-cli profile create
4848
```
4949

50-
**Pull:** This feature allows you to download content from the EMS to your local machine. Let's take Studio package
51-
as an example. These can be exported in the EMS as ZIP files that contain all package assets. By using the following
50+
**Pull:** This feature allows you to download content from the Celonis Platform to your local machine. Let's take Studio package
51+
as an example. These can be exported in the Celonis Platform as ZIP files that contain all package assets. By using the following
5252
command using the package key and profile you have created, you will pull the ZIP file.
5353

5454
```
@@ -59,7 +59,7 @@ Example, if you want to pull a package with key "interesting-package" from your
5959
content-cli pull package -p my-dev-profile --key interesting-package
6060
```
6161

62-
**Push:** This feature allows you to push a content file to a team in the EMS. To continue the last example,
62+
**Push:** This feature allows you to push a content file to a team in the Celonis Platform. To continue the last example,
6363
you can use the following command to push he previously pulled package in another team.
6464

6565
```
@@ -84,7 +84,7 @@ content-cli pull package -h
8484

8585
## Building and Using the Project locally
8686

87-
This tool is tightly connected with the Celonis EMS and all capabilities require to have access to a Celonis EMS Team.
87+
This tool is tightly connected with the Celonis Platform and all capabilities require to have access to a Celonis Platform Team.
8888
After cloning the project, the next step is to install the project dependencies. We use `yarn` as our package manager,
8989
so running `yarn install` on the project root folder should install all the necessary dependencies. After installing
9090
the project dependencies, you can run `yarn build` to build the project artifact. To use the built artifact, you can

docs/internal-architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## **Overview**
44

5-
The Content CLI is a TypeScript based CLI that allows interaction with the Celonis EMS. Its core functionality includes extracting, pushing, and managing EMS content.
5+
The Content CLI is a TypeScript based CLI that allows interaction with the Celonis Platform. Its core functionality includes extracting, pushing, and managing Celonis Platform content.
66

77
**Key Dependencies**
88

@@ -36,7 +36,7 @@ The context object is passed to all commands and services. It includes:
3636

3737
- **Profile**: The profile which is used for each command execution as authentication.
3838
- **Logger**: The global logger, with optional debug logging.
39-
- **HttpClient**: Authenticated EMS API client.
39+
- **HttpClient**: Authenticated Celonis Platform API client.
4040

4141
This object is passed into command callbacks, ensuring that state and services are shared cleanly:
4242
```
@@ -63,7 +63,7 @@ To manage profiles, use the content-cli profile command group. This allows you t
6363

6464
## **API communication**
6565

66-
The **HttpClient** class is a centralized client for interacting with the EMS API. It handles:
66+
The **HttpClient** class is a centralized client for interacting with the Celonis Platform API. It handles:
6767

6868
- **Auth**: Authenticates by sending the token in the provided profile.
6969
- **URL building**: Prefixing all API paths with the correct base (e.g. realm), inferred from the profile

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@celonis/content-cli",
33
"version": "1.0.0",
4-
"description": "CLI Tool to help manage content in Celonis EMS",
4+
"description": "CLI Tool to help manage content in Celonis Platform",
55
"main": "content-cli.js",
66
"bin": {
77
"content-cli": "./dist/content-cli.js"

0 commit comments

Comments
 (0)