What is a Program Element?
Program Elements are user-created NLPs to perform a specific task.
Why do we need a Program Element?
FireFlink provides an extensive number of NLPs. But, at times, the user might need an extra NLP to perform some tasks. In such a case, the user needs to create the NLP’s as per their need. FireFlink provides you the option to create your own NLP’s.
Create Program Element
In this section, we will cover the basics of Program Element creation. Here, we will be explaining how to create a Program Element.
- To create a Program Element, “Eclipse Plugin” should be configuredin the Eclipse IDE
- Familiarity with programming languages to create Program Elements.
Login >> Repository >> Program Elements
Steps to create a Program Element
- Once you log into FireFlink, you will be directed to the project searchable dropdown. From the dropdown select the project you had previously created or the project which is allocated to you. In the left navigation menu, click on the “Repository” menu and click on the “Program Elements” tab and click on the action overflow icon as shown below.
- Once you click on the action overflow you will be populated with some suggestions, select “Eclipse Plugin” as shown below
- Once you click on “Eclipse Plugin”,it will automatically be downloaded on the local machine. Once the downloaded process is completed extract the plugin.
- Now after you extract the “Eclipse Plugin” , launch the Eclipse IDE and click on the “Help” icon as shown below.
- Now click on “Install new software” as shown
- Click on “Add” as shown
- Once after you click on “Add” a pop up window will appear wherein you have to click on “Local”
- Upon clicking “Local” choose the extracted Eclipse plugin path from the local storage and click on “Select Folder”
- After clicking on “Select Folder”, enter a desired name and click on “Add” as shown
- Upon clicking “Add” select the checkbox named “Fireflink” and click on “Next” and click on “Finish” until the plugin has been completely installed.
Steps to import a project from FireFlink
Once you have completed the installation process you have to import the project from “FireFlink” to create a Program Element and you have to perform “Push” operation on the program element that has been created, and the Program Element that has been pushed will be reflected on “FireFlink”.
- After the installation process click on “New” and click on “Other”
- Upon clicking on “Other” a pop up window will appear wherein you have to select “Import FireFlink Project” and click on “Next” button as shown below
- Upon clicking the “Next” button a pop up window will appear asking for login credentials. Enter the username and password in the respective text fields and click on “Next” button
- Once you click on the “Next” button you will be directed to the license dropdown wherein you have to select a license and select a project for which the Program Element needs to be pushed.
- Upon clicking “Finish” the selected project will be imported from “FireFlink” to the Eclipse IDE and will be displayed as shown below
- There is a default template within the project which can be further edited based on the user’s need or the user can create a separate package within the Eclipse IDE using the default template as a reference, the default template is as shown
- Once the program element has been created, user can now push the -to the platform by the following ways
i) Right click on the project that has been imported.
ii) Upon right clicking on the project, select “FireFlink” and click on “Push”
- The program element that has been pushed will now be displayed under the “Program Elements” section as shown below
Table details which are under the program elements tab:
- Modified by: This column by default displays the username who has created the program element. If the column is modified, the column then displays the username who has recently modified the program element.
1. When the user hovers the mouse on the root package under this column, it displays “Edit” & “More” menu icons.
2. When the user hovers the mouse on the program elements under this column, it displays Impact List, Edit & More menu icons.
Edit & Details of Program Elements:
When you hover the mouse on Package under the Action column, it will display Edit & More menu icons, as shown below.
1. Edit Program Element
To edit the program element, click on the “Edit” icon under the action column as shown below.
Edit the required information on fields and click on the “Update” button. You can see the Edited successfully banner message.
- You can only edit the text fields such as “NLP Description”, “Class Name”, “Pass message” and “Fail message”.
- You cannot edit the Root Package.
- You cannot edit any part of the program element once it has been pushed to the “Program Elements” section
2. Details of Program Element
To view the details of the program element, click on the “More” menu icon under the actions column. It will display “Details” & “History” options, as shown below.
Click on the details option. A “Details” popup displays, as shown below.
Attributes of details popup:
In the package details popup, all the attribute values are non-editable.
- Name: This attribute displays the name of the program element which is given while creating the program element. If you have updated the program element name, it displays the updated program element name.
For the root package, the display name is Root Package.
- Description: This attribute displays the description which is given while creating the package. It displays a one-line description when hovered with a mouse; this display has a complete description in the tooltip.
While creating the package, if the description is not given, it will display as “–”.
For the Root package, it will display the description as “–”.
- Project Name: This attribute displays the project name under which the project package is created.
- Path: This attribute displays the path of the package.
Ex: The login package contains the home package. In the home package, the popup displays the path as login/home.
For the root package, the display path is “Root Package”.
- Created by: This attribute displays the username who has created the package. For the root package, the display is- Created by N/A.
- Created On: This attribute displays the Date & Time on which the package was created. For the root package, the display is- Created On N/A.
- Modified by: This attribute displays the username who recently modified the package. For the root package, the display is- Modified N/A.
- Modified On: This attribute displays the Date & Time on which the package was recently modified.