SQL Form

<< Click to Display Table of Contents >>

Navigation:  IMS version 21.9 > IMS Admin - User Guide  >

SQL Form

** WORK IN PROGRESS **

This section is yet to be updated to the newer version of IMS

Feature location, commands, instructions, and screen shots

may not appear the same if you are using a newer version of IMS

 

The SQL form is a report form where users may input SQL.

The results of the SQL query will be directly visible in the lower part of the form.

 

 

 

The SQL form can be opened via

 

sql-openform

 

 

 

This form exists of 4 sections:

 

SQLform-main

 

 

Section 1

 

Section 1 is the search area. Existing report queries can be found using the pull down field.

 

Section 2

 

This section provides generic information about the query:

 

Name

Name of the SQL query.

TIPS:

- for your own queries, start with your user ID or name

- platfrom queies - start with platform name, for example

 MPLS_CAPACITY

- data quality reports, start with DATA_QUALITY

-

All users

INdicates if the query is avaialbe for all users (NOTE: currently not functional)

Add to tab

Tab name in case the query is used to appear as a tab page in another IMS form.

Examples:

- NODEDETAILSTAB

- LOCATIONDETAILTAB

- CIRCUITDETAILSTAB

 

For examples how to add query to a tab, read "Example Tab Queries"

TabCaption

The name of the tab (only use when query is used a tab page in an IMS form)

Username

Create user name

Tab sequence

Sequence in case multiple query tabs are used in the same IMS form (only use when query is used a tab page in an IMS form)

QueryColor

Color of the tab page. (only use when query is used a tab page in an IMS form)

SQLCheck

For queries that take a longer time to run, add a simple query that always takes a short time, this query is used when opening an IMS form.

(only use when query is used a tab page in an IMS form)

URL

 

 

 

Section 3

 

In this areas the SQL statement can be entered.

Available SQL queries can be found via the search field. Section 3 will be auto populated after a search.

 

To run a SQL query, press the left button, at the right bottom of section 3

To save a new or updated query, press the most right button at the right bottom of section 3.

 

 

Section 4

The output of the query will be placed in section 4.

This report can be exported and filtered, see grid functionality.

 

Buttons in SQL form:

 

The following buttons are present on the form:

 

sqlform-buttons

 

 

1- Create new Reporty

To create a new SQL query, press button 1. Fill in the name and press save.

 

2 - Delete SQL query

To delete an existing query. Open it, and press Delete > YES.

 

3 - Create report Job

To schedule a report to run once or periodically, use button 3.

A pop-up window will appear.

 

 

sqlform-reportJob

 

Fill in the details in the upper tab to create the report scheduled task and press save.

 

The lower part of the pop-up screen can be used to see the active reports (for the selected query only) and to change them if

needed (double click to edit).

 

The triggers tab is used to add the trigger to start the report.

A * means all.

If the query needs to run every 15 minutes, the setting must be as follows:

Minutes: 0,15,30,45

Hours *

Day of Month *

Month *

Day of week *

 

 

 

The actions tab is used to determine the output of the query, whether it should be an email or FTP.

Email and FTP have different field settings.

Press save to add the output.

For example to send the query to mail to multiple email addresses:

Mailto: name1@example.com;name2@example.com

Subject: this_is_the_email_header

Body: Please check the query and take appropriate actions

Format: Plaintext body