Apex. Добавялем возможность экспорта... CSV, XML

Продолжаем серию статей, демонстрирующую на примерах процесс создания приложений в Oracle Application Express, и сегодня будем развивать приложение, созданное ранее.
Одним из наиболее часто встречающихся требований для приложений является возможность вывода информации в различные форматы электронных документов. В этом примере постараемся добавить возможность экспорта данных в CSV и XML форматы.

Сначала попытаемся экспортировать данные в CSV. Есть несколько вариантов реализации, например:

• использование стандартной опции "Enable CSV output"
  
• использование типа отчета "export: CSV"

Сначала, воспользуемся стандартной опцией. Для этого необходимо зайти в определение страницы:


После чего - в описание отчета:


и изменить следующие настройки в разделе "Report Export":

Назначение этих настроек следующее:

• "Enable CSV output" - задает непосредственную возможность экспорта в CSV
  
• "Separator" - задает разделитель значений колонок. Если не задавать значения, то будет использоваться либо запятая, либо точка с запятой в зависимости от текущих NLS настроек.
• "Enclosed By" - символ, обозначающий начало и конец значения колонки. Если не задан, то используются двойные кавычки.
• "Link Label" - текст для ссылки, которая будет вызывать диалог для сохранения CSV файла.
• "Filename" - задает имя для экспортируемого файла. Если не задается, то используется имя региона отчета.
  

После чего, запустив приложение, можно будет заметить появление нового элемента в отчете "Типы объектов" - "Экспорт в CSV":



Теперь же, попробуем реализовать экспорт данных отчета через настройку "Report Template" секции "Layout and Pagination" описания отчета. Для того, чтобы отчет экспортировался в CSV, необходимо просто выставить "Report Template" = "export: CSV".

Особенность этой реализации заключается в том, что при запуске такого отчета будет сразу запускаться механизм формирования CSV файла. То есть, при попытке открытия страницы, где располагается такой отчет, сразу появится диалоговое окно в предложением сохранить файл. Для пользователя это будет не всегда удобно, так как ему не всегда необходим экспортированный отчет, а порой достаточно простого вывода отчета в HTML.

Соответственно, чтобы позволять пользователю по желанию экспортировать отчеты, необходимо вынести такой отчет на отдельную страницу и позволять пользователю ее вызывать. Для этого, создаем новую страницу в приложении:



Выбираем следующие свойства новой страницы:

• "page type" = "Blank Page"
• "name" = "MainReportExport"
• "title" = "MainReportExport"
• "Breadcrumb" = "- do not use breadcrumbs on page -"
• "Use Tabs" = "No"

Сразу переходим к редактированию страницы, и добавляем в нее новый регион:



Выбираем следующие свойства региона:

• "Region Type" = "Report"
• "Report Implementation" = "SQL Report"
• "Title" = "Object_Types"
• "Region Template" = "Reports region"
• "Display Point" = "Page Template Body (3. items above region content)"
• "Source":

Select Object_Type, Count(*)
From User_Objects
Group By Object_Type

• "Report Template" = "export: CSV"
  

Теперь приложение состоит из двух основных форм "Main", "MainReportExport":

Осталось только добавить на первую страницу ("Main") средство перехода на только что созданную страницу. Для этого переходим в описание исходной страницы и добавляем в нее кнопку:

• "region for the button" = "Типы объектов (1) 11"
• "position" = "Create a button in a region position"
• "button name" = "EXPORT2CSV"
• "label" = "Экспртировать в CSV"
• "position" = "Bottom of Region"
• "alignment" = "left"
• "branch to page(when button pressed)" = "2" (выбираем из списка созданную ранее страницу)

Результат:

Теперь при нажатии кнопки будет так же формироваться отчет в CSV.

Аналогичным же образом реализуется экспорт и в XML. Необходимо добавить на страницу "MainReportExport" еще один регион, аналогичный тому, который уже был добавлен ранее, за исключением опции "Report Template", которую необходимо будет задать в "export: XML":


Таким образом, мы имеем на одной странице два экспортируемых отчета и нам необходимо иметь возможность запускать какой-то один из них. Для этого добавляем на страницу "MainReportExport" невидимый элемент, задавая который при переходе, мы будем в состоянии регулировать запуск того или иного отчета, расположенного на странице. Задаем элементу следующие параметры:

• "Item type" = "Hidden"
• "Item name" = "P2_EXP_TYPE"

Корректируем регион экспорта в CSV - "Object_Types" в секции "Conditional Display":

• "Condition Type" = "Value of Item in Expression 1 = Expression 2"
• "Expression 1" = "P2_EXP_TYPE"
• "Expression 2" = "CSV"

Корректируем регион экспорта в XML - "Object_Types_Xml" в секции "Conditional Display":

• "Condition Type" = "Value of Item in Expression 1 = Expression 2"
• "Expression 1" = "P2_EXP_TYPE"
• "Expression 2" = "XML"

Осталось только реализовать заполнение поля P2_EXP_TYPE. Для этого в странице "Main" редактируем описание имеющейся кнопки:


Изменяем следующие свойства:


То есть, при переходе по этой кнопке в страницу отчетов будет отрабатывать CSV отчет. Для XML добавляем еще одну кнопку:

• "region for the button" = "Типы объектов (1) 11"
• "position" = "Create a button in a region position"
• "button name" = "EXPORT2XML"
• "label" = "Экспртировать в XML"
• "position" = "Bottom of Region"
• "alignment" = "left"
• "branch to page(when button pressed)" = "2"
  

После чего в описании новой кнопки выставляем следующие свойства:


То есть, при переходе через эту кнопку будет отрабатывать экспорт отчета в XML. Главная страница, при этом, примет следующий вид:



Вот, собственно и все. Проверить приложение в работе можно на apex.oracle.com.