Exploring the ServiceNow IDE
Summarize
Summary of Exploring the ServiceNow IDE
The ServiceNow IDE is a web-based integrated development environment built on Visual Studio Code technology, designed specifically for creating scoped applications on the ServiceNow AI Platform. It enables developers to build and manage applications using familiar tools and industry-standard practices while supporting source code development and metadata management.
Show less
Key Features
- Visual Studio Code Experience: Offers features like type safety, IntelliSense, dependency enforcement, code search, and Git source control integration, enhancing developer productivity.
- ServiceNow Fluent: Allows defining application metadata in source code, facilitating a code-centric approach to application development.
- Real-Time Metadata Visualization: Embedded ServiceNow AI Platform interfaces within the IDE provide side-by-side visual representation of application metadata changes.
- JavaScript Modules and Third-Party Libraries: Supports organizing and reusing code within scoped applications, enabling modular and maintainable development.
- Now Assist for Code: Features code autocomplete capabilities to generate script suggestions, accelerating coding tasks.
- Build and Packaging: Uses the ServiceNow SDK application packaging service to compile source code into application metadata, streamlining the build process.
- Source Control Workflow: Integrates with Git providers using OAuth 2.0 or personal access tokens, enabling repository creation, branch management, and collaborative development.
Development Workflow
The typical workflow involves configuring Git credentials, creating or converting scoped applications, initializing local and remote Git repositories, defining metadata in code, synchronizing metadata changes, building applications, and collaborating via Git branches. Developers can seamlessly view changes in other ServiceNow interfaces without leaving the IDE.
Benefits for ServiceNow Customers
- Efficient Development: Rapidly build scoped applications using a familiar, modern IDE tailored to the ServiceNow platform.
- Improved Collaboration: Source control integration and workspace organization facilitate teamwork among developers and administrators.
- Enhanced Code Management: Modular JavaScript coding and third-party library support enable reusable and maintainable application components.
- Integrated Build Process: Automated packaging and real-time metadata synchronization simplify application deployment and testing.
Learn about developing scoped applications in source code in the ServiceNow IDE.
ServiceNow IDE overview
The ServiceNow IDE is an implementation of Visual Studio Code for the Web on the ServiceNow AI Platform. With the ServiceNow IDE, you can get started building scoped applications quickly using familiar tools and industry-standard development practices. The ServiceNow IDE has many of the same features as Visual Studio Code, including type safety, IntelliSense, dependency enforcement, code search, and source control integration.
In the ServiceNow IDE, you can create scoped applications in source code using ServiceNow Fluent to define application metadata [sys_metadata]. To see a side-by-side visual representation of your changes in real time, you can open the application metadata in other ServiceNow AI Platform user interfaces embedded within the ServiceNow IDE.
Optionally, you can create JavaScript modules and use third-party libraries to organize and reuse code within scoped applications. With Now Assist for Code, you can use the Code autocomplete skill to generate code suggestions for scripts in an application in the ServiceNow IDE. For more information, see Generate code with autocomplete.
In the background, this functionality is enabled by the ServiceNow SDK application packaging service, which builds applications in the ServiceNow IDE.
ServiceNow IDE workflow
The following infographic shows the workflow for developers to get started developing applications with the ServiceNow IDE.
- Depending on the authentication method, an administrator or developer configures the credentials needed to connect to their Git provider.
- To use OAuth 2.0 authentication, an administrator configures an OAuth 2.0 application registry in their Git provider and on the instance.
- To use basic authentication, a developer generates a personal access token from their Git provider.
- From their Git provider, a developer creates a dedicated Git repository for an application.
- From the ServiceNow IDE, the developer configures their Git credentials.
- The developer creates a ServiceNow IDE workspace to organize applications.
- The developer creates a scoped application or converts an existing scoped application from the ServiceNow IDE.
- The developer initializes a local Git repository for the application and pushes it to the remote repository they created to manage the application in source control.
- The developer can define application metadata in source code using ServiceNow Fluent, create custom JavaScript modules, or use third-party libraries.
- When metadata changes are detected, the developer synchronizes the application to download and transform changes to metadata from other interfaces into source code.
- After saving their changes, they build the application, which compiles the source code and transforms it into application metadata.
- When the build is complete, the developer can view their changes reflected in other embedded ServiceNow AI Platform user interfaces without leaving the ServiceNow IDE.
- The developer stages, commits, and pushes their changes to the Git repository.
- From the ServiceNow IDE, other developers can clone the repository, create branches, and begin collaborating on the application.
Other users can modify the application metadata at the same time as developers modify the source code. Developers can reuse module code in other modules or scripts within the application.
ServiceNow IDE benefits
| Benefit | Feature | Users |
|---|---|---|
| Develop applications in an IDE based on Visual Studio Code on the ServiceNow AI Platform | ServiceNow IDE user interface | Developers |
| Write source code to define the metadata that makes up ServiceNow applications | ServiceNow Fluent Define application metadata in code with ServiceNow Fluent in the ServiceNow IDE |
Developers |
| Organize and reuse code within scoped applications with custom JavaScript modules and third-party JavaScript utilities | JavaScript modules and third-party libraries Create and use JavaScript modules in applications in the ServiceNow IDE Use third-party libraries in applications in the ServiceNow IDE |
Developers |
| Collaborate on applications with users of different skill sets | Build and install an application in the ServiceNow IDE | Developers |
| Integrate source control with your Git provider of choice | Integrating source control with the ServiceNow IDE | Developers, Administrators |