Skip to content

Commit

Permalink
Adding project export, auto gen projects, and activity log, updating …
Browse files Browse the repository at this point in the history
…screenshots
  • Loading branch information
theManikJindal committed Jun 3, 2024
1 parent 1fce7b2 commit 191e281
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 43 deletions.
175 changes: 132 additions & 43 deletions src/pages/guides/projects/index.md
Original file line number Diff line number Diff line change
@@ -1,84 +1,144 @@
# Projects Overview

All development work in Adobe Developer Console is done as part of a project. The concept of a project corresponds to an application you are building. To use APIs and services in the application, you can simply add those APIs and services to the Project. The project may include one or multiple products, and a combination of APIs, events, runtime, and plugins.
All development work in Adobe Developer Console is done as part of a Project. The concept of a Project corresponds to an application you are building. To use any APIs and services in your application, you must add them to the Project. The Project may include one or multiple products, and a combination of APIs, I/O Events, I/O Runtime, and Plugins.

+ [Projects Overview](#projects-overview)
+ [Projects in an enterprise organization vs personal developer organization](#projects-in-an-enterprise-organization-vs-personal-developer-organization)
+ [View all Projects](#view-all-projects)
+ [Export all Projects details](#export-all-projects-details)
+ [Read Only Projects](#read-only-projects)
+ [Auto-Generated Projects](#auto-generated-projects)
+ [Create a New Project](#create-a-new-project)
+ [Empty Projects](#empty-projects)
+ [Templated Projects](#templated-projects)
+ [View and manage a Project](#view-and-manage-a-project)
+ [View a Project's Activity Log](#view-a-projects-activity-log)
+ [Last service activity in a Project](#last-service-activity-in-a-project)
+ [Project approval](#project-approval)
+ [Beta users](#beta-users)
+ [Delete a Project](#delete-a-project)
+ [Find deleted Projects](#find-deleted-projects)


## Projects in an enterprise organization vs personal developer organization

Projects are a common framework within enterprise and personal developer organizations. Projects created under an enterprise organization are owned by the organization and are visible to other organization members. In contrast, projects belonging to a developer organization are visible only to you.
Projects are a common framework within enterprise and personal developer organizations. Projects created under an enterprise organization are owned by the organization and are visible to other organization members. In contrast, Projects belonging to a developer organization are visible only to you.

If you are a developer or a system administrator on multiple organizations, you can view the projects that are owned by those organizations. The projects you see on the Developer Console depends on the organization you have currently selected in the [org switcher](../getting-started.md#switching-between-your-organizations). Use the org switcher to view the organizations to which you belong to and easily switch between them.
If you are a developer or a system administrator on multiple organizations, you can view the Projects that are owned by those organizations. The Projects you see on the Developer Console depends on the organization you have currently selected in the [org switcher](../getting-started.md#switching-between-your-organizations). Use the org switcher to view the organizations to which you belong to and easily switch between them.

<InlineAlert slots="text"/>

**Note:** To create projects for enterprise organizations, you must have a system administrator or developer role. For information on managing developers in the admin console, see the documentation on [managing developers](https://helpx.adobe.com/enterprise/using/manage-developers.html).

## Create a New Project
To create Projects for enterprise organizations, you must have a system administrator or developer role. For information on managing developers in the admin console, see the documentation on [managing developers](https://helpx.adobe.com/enterprise/using/manage-developers.html).

### Empty Projects

Think of an empty project as an open canvas or "blank slate" into which you can add events, runtime, plugins, APIs, and more to create custom applications.
## View all Projects

To get started, follow the steps provided in the guide for [creating an empty project](projects-empty.md).
The [list of Projects](https://developer.adobe.com/console/projects/) page provides an overview of your organization's Projects. If you are part of an enterprise organization, the list of Projects will include all Projects in the organization (and not just the ones you created).

### Templated Projects

To streamline the creation of projects, Adobe Developer Console provides templates that you can use to get started quickly.
![All Projects screen (card view)](../../images/projects-card-view.png)

**Note:** Templated projects are currently only available for enterprise organizations.
On the page, you can view the Projects as cards or rows in a table. You can view the following details about a Project at a glance here
+ Project title
+ Services and workspaces added to the Project
+ Who last modified the Project and when
+ Project's last service activity
+ If the Project requires your attention
+ If the Project is Read-only or Auto-Generated

To get started, follow the steps provided in the guide for [creating a templated project](projects-template.md).
Furthermore, you can sort the Projects based on created date, last modified date, and last service activity date. Sorting the Projects by last service activity will show your active Projects first.

## View All Projects
![All Projects screen (list view)](../../images/projects-list-view.png)

The **Projects** screen provides an overview of your organization's projects. Suppose you are part of an enterprise organization. In that case, this includes all projects that you have access to and not just projects that you have created.
### Filter Projects

On the Projects screen, each project is shown as a card. A project card mentions the title of the project, its last modified date, and the number of workspaces it has, where applicable.
You can filter down the list of Projects to find your Projects quickly. You can filter the list of Projects using the following filters:

![All Projects screen (card view)](../../images/projects-card-view.png)
1. By Text: You can filter Projects by ID, title, description, workspace, IMS client ID, technical account ID, event registration id, plugin id, or Runtime namespace.
2. By who created or modified the Project
3. By what a Project Contains (APIs, Event Providers, and Plugins)
4. By whether a Project requires your attention

You can use the sort functionality to change the order in which projects are displayed or select the list view to see your projects in a list rather than shown as cards.

### Export all Projects details

![All Projects screen (list view)](../../images/projects-list-view.png)
All the details available on the list of Projects page can be exported as a CSV file. To do so,
1. Go to the list of Projects page
2. Click the Actions overflow menu (three dots) and select Export CSV

You can also begin working on a new project from the Projects screen by selecting **Create New Project**.
![Export all Projects details](../../images/projects-export-activity-log.png)

### Read Only view
### Read Only Projects

As a member of an enterprise organization, you may not have access to all of the services licensed by your organization. For this reason, you may see a *Read Only* tag on certain projects or workspaces within a templated project.
As a member of an enterprise organization, you may not have access to all of the services licensed by your organization. For this reason, you may see a *Read Only* tag on certain Projects or workspaces within a templated Project.

Although, Projects or workspaces marked as *Read Only* are still visible to you, but certain actions, such as downloading, editing, copying client secrets, or initiating the approval workflow, will be greyed out and inaccessible.

If you believe you are seeing a *Read Only* tag in error, or want access to certain services and product profiles, please work with your organization's administrators for access.

## Delete a Project

Deleting a project is **permanent** and will remove all entites contained within the project - APIs and services, credentials, and workspaces. You can delete a project by visiting the project overview page.
### Auto-Generated Projects

While most projects can be deleted, sometimes a project is related to an application you have published and, therefore, cannot be deleted.
Sometimes Adobe products automatically create Projects in your organization so you don't have to. In such cases, the Projects are marked Auto-Generated Projects.

1. If a project contains an API that was submitted for approval (status: In Review or Approved), then the project cannot be deleted.
2. If an App Builder project has been submitted for approval (status: Pending or Published), then that project cannot be deleted. However, you can always revoke a published app and then delete the project.
These Projects are shown to you for transparency, but cannot be modified or deleted by any user in the organization (even the system administrator). The Adobe product that created the Project automatically manages the Project and owns its lifecycle.

<InlineAlert slots="text"/>

Projects containing plugins cannot be deleted yet.
Auto-generated Projects containing Service Account (JWT) credentials will be migrated by Adobe and customers don't have to migrate such Projects.


## Create a New Project

### Empty Projects

Think of an empty Project as an open canvas or "blank slate" into which you can add events, runtime, plugins, APIs, and more to create custom applications.

To get started, follow the steps provided in the guide for [creating an empty Project](projects-empty.md).

### Templated Projects

To streamline the creation of Projects, Adobe Developer Console provides templates that you can use to get started quickly.

**Note:** Templated Projects are currently only available for enterprise organizations.

To get started, follow the steps provided in the guide for [creating a templated Project](projects-template.md).


## View a Project's Activity Log
## View and manage a Project

Any user in your organization who has access to the Developer Console and has access to the set of product profiles used in a project can view, edit, and delete that project.
Once you select a Project on the list of Projects page, you will land on the Project overview page. This page shows you details about the Project.

However, all modifications to a project on the Developer Console are captured in the project's activity log. The activity log serves as a record of "who did what and when?", enabling an organization to track changes made to a project.
+ Project title and description
+ Services and workspaces added to the Project
+ Who last modified the Project and when
+ Who created the Project and when
+ Project's last service activity
+ Email alerts status
+ If the Project requires your attention
+ If the Project is Read-only or Auto-Generated

Changes made to a project are retained as activity logs for **1 year**. You can also export the activity log records as a CSV file, if you wish to store them for longer.
On the left nav, you can access more information about the Project.
+ The insights page shows API and service activity recorded by Adobe.
+ The activity log page contains a log of modifications done to the Project.
+ The credential overview, API overview, event registration overview, Runtime overview, and workspace overview pages.
+ And, the Project Approval and Beta users pages, when applicable.


### View a Project's Activity Log

Any user in your organization who has access to the Developer Console and has access to the set of product profiles used in a Project can view, edit, and delete that Project.

However, all modifications to a Project on the Developer Console are captured in the Project's activity log. The activity log serves as a record of "who did what and when?", enabling an organization to track changes made to a Project.

Changes made to a Project are retained as activity logs for **1 year**. You can also export the activity log records as a CSV file, if you wish to store them for longer.

![Project Activity Log](../../images/project-activity-log.png)

<InlineAlert slots="text"/>

Note: Project Activity logs are currently only available to enterprise and teams organizations.
Note: Activity logs are currently unavailable in personal developer organizations.


## Last service activity in a Project
### Last service activity in a Project

At a glance, the last service activity date informs you when Adobe last recorded activity from your integration or application. This information helps ascertain whether the integration or application using this Project has been active.

Expand All @@ -93,21 +153,50 @@ Currently, we do not yet track service activity when

<InlineAlert slots="text"/>

The Developer Console only records the date of the service activity. Furthermore, the tracked information is approximate and only serves to inform you about which of your projects were in use and when. Historical data for service activity before April 15, 2024 is unavailable.
The Developer Console only records the date of the service activity. Furthermore, the tracked information is approximate and only serves to inform you about which of your Projects were in use and when. Historical data for service activity before April 15, 2024 is unavailable.


## Project approval
### Project approval

Once you have completed development on your project, your application is ready for approval. There are four different approval processes within Adobe Developer Console, depending on the type of application that you have built.
Once you have completed development on your Project and your application is ready for approval. There are four different approval processes within Adobe Developer Console, depending on the type of application that you have built.

1. Self-service push to production for OAuth credential
2. Approval process for OAuth credentials
3. Approval process for App Builder applications
4. Review process to publish plugins

To read more about the approval process, visit the [project approvals](approval.md) documentation.
To read more about the approval process, visit the [Project approvals](approval.md) documentation.


### Beta users

When building a Project containing OAuth credentials, Console enables you to select and manage a group of beta users, giving them access to your integration while it is still `In Development`. To learn more, read the [beta users overview](beta-users.md).


## Delete a Project

## Beta users
Deleting a Project is **permanent** and will remove all entites contained within the Project - APIs and services, credentials, and workspaces. You can delete a Project by visiting the Project overview page.

While most Projects can be deleted, sometimes a Project is related to an application you have published and, therefore, cannot be deleted.

1. If a Project contains an API that was submitted for approval (status: In Review or Approved), then the Project cannot be deleted.
2. If an App Builder Project has been submitted for approval (status: Pending or Published), then that Project cannot be deleted. However, you can always revoke a published app and then delete the Project.

<InlineAlert slots="text"/>

Projects containing plugins cannot be deleted yet.


### Find deleted Projects

Once you delete a Project, you will be unable to access its Activity Log. However, you can view who deleted a Project and when on the Activity log shown on the [list of Projects](https://developer.adobe.com/console/projects/) page.

To navigate to the Projects Activity Log,
1. Go to the list of Projects page
2. Click the Actions overflow menu (three dots) and select Activity Log

<InlineAlert slots="text"/>

When building a project containing OAuth credentials, Console enables you to select and manage a group of beta users, giving them access to your integration while it is still `In Development`. To learn more, read the [beta users overview](beta-users.md).
Note: Activity logs are currently unavailable in personal developer organizations.


![View Projects Activity Log](../../images/projects-export-activity-log.png)
Binary file modified src/pages/images/projects-card-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/pages/images/projects-list-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 191e281

Please sign in to comment.