Creating a Project
  • 19 Aug 2024
  • 4 Minutes to read
  • Dark
    Light

Creating a Project

  • Dark
    Light

Article summary

Overview

Projects serve as organized spaces where developers and teams can build and manage applications. They offer a structured framework that promotes efficiency, collaboration, and scalability in creating and managing applications.

Within a Project, various components such as Designer Folders, Folders, Flows, Forms, Rules, Reports, and Dashboards are utilized to define the application's logic and present data effectively. Moreover, developers can fine-tune the application's behavior and extend functionalities by configuring project-specific settings, including project Dependencies, enabling Modules, establishing project constants, and integrating SDK Extensions.


Create a Project

  1. Navigate to the Projects from the Sidebar. Click on the Create Project or '+' icon.

  2. A dialog box named "New Project" will appear, and input essential details for the Project:

    1. Project Name: Enter a name representing the Project's purpose or functionality.

    2. Detailed Description: Provide a comprehensive description outlining the Project's objectives, functionalities, or other relevant details.

    3. Project Icon: Choose or upload an icon that symbolizes or represents the Project visually.

    4. Initial Folder Name: This field auto-populates with the Project's name, serving as the default name for the initial Designer Folder within the Project. Modify this name to reflect the Designer Folder's content or purpose.

  3. Select CREATE.  An indicator screen will appear.

    As soon as the Project is created, the Project Info Dashboard opens.


Project Info Dashboard and Folder Structure

The Project Info Dashboard serves as a central hub for developers, facilitating swift access to critical project information and management of the development lifecycle. This dashboard enhances project visibility, allowing easy navigation to essential elements while monitoring various aspects of project progression.

After creating a project, the Info Dashboard will display an overview of project details and functionalities. Along with Info, users see the following list of folders within the project folder tree.

Folder Name

Description

 Info

The Info dashboard shows a complete overview of the Project on a higher level. It includes several other dashboards, such as project Health, project Dependencies, Project History, and project Integrations.

 Public

Previously known as the Portal, the Public folder will hold all items for End Users to view and interact with. Developers with administration permissions on the project will control access to projects and the 'public' folder.

Catalog

Previously known as Workflow catalog. A location for end users to run project-specific processes.

Public Folders

This will include all the folders accessible to the end users.

 Manage

Project settings allow developers to manage project activities, including monitoring project health, integrations, jobs, and events.

Activity

Allows monitoring and tracking of entity and user activity within the Project, ensuring a comprehensive understanding of interactions to enhance project management.

Health

Allows monitoring user interactions, optimizing data structures, and maintaining a detailed project history.

Integration

Manage settings and monitor database integrations, external services, OAuth, and scripting within the platform.

Configuration

Features different configuration methods within the platform, including Variables, Data, Templates, and User Favorites.

Jobs & Events

Manage Scheduled Jobs and Message Queues.

Security

Manage user data in the Project, including Assignment Roles, Groups, Named Sessions, and Permissions.

Default Designer Folder

This is the default designer folder where users start building the Project. This folder includes five other designer folders to let users manage their designer entities accordingly.

Folder Actions on Projects

Once a Project is created, users have various actions to perform on the Project.

Action Name

Description

  Back

Takes you back to the Projects hub folder to view all Projects in the system.

Add Folder

This action allows the creation of Designer Folders within the Project.

Add to Favorites

Pins the selected Project to the Sidebar.

  More Actions

This icon will open the Action Menu with the following actions for the Project.

MANAGE

Open in New Tab

It opens the folder view of the project in another tab.

Permissions

Manage Permissions

This allows you to control and manage the access permissions of users who can use, view, edit, administrate, etc., the Project.

More

Delete

Soft deletes the entire Project.

Make this My Home Page

Mark this as the user's home page. If a user logs in, they will be landed on this Project.

Manage Tags

Allows you to add a Tag to the Project.

Get Project ID

Retrieves the ID of the Project

Add as Favorite

Pins the Project to the Sidebar.

Entity

Opens scheduled Data form.

Entity [User Defined]

This will list all unique defined entities across all projects.

Setup

This allows access to Manage Assignment Roles.

Case

This will list all cases across all projects.

PAGES

More

Add Alias

Creates an Alias for a Folder

Add Page

Allows to add a Page to the header

DEPLOYMENT

Designer Repository

All Available Repository Actions

Please review the repository documentation for all the repo actions.

Import/Export

Create Project Folder Documentation

This action downloads an HTML document called ProjectReport that contains useful information about the Project. It includes details like the number of each Designer Element in the folder, a preview of those elements as they would appear in the Designer, step input/output data, and more.

Import

This allows you to import entities within the Project. It will only accept .decobj (decisions object) and .zip files.

Export Project

Exports the entire Project as a .zip file.

See Next:

Info Dashboard: Learn shows the high-level view of the Project.

Feature Changes

Description

Version

Release Date

Developer Task

An indicator screen appears after the Create Project button has been pressed to let users know the Project is being created.

9.1

July 9, 2024

[DT-041481]


Was this article helpful?

What's Next