Skip to content

Commit ff1c649

Browse files
authored
add install AOP guide (#18)
# Description Adding AOP install guide documentation. Fixes # (issue) No code fixes. ## Type of change Documentation.
2 parents c1e88ee + dce5702 commit ff1c649

6 files changed

+105
-0
lines changed
102 KB
Loading

doc/images/AOP_downloads.png

131 KB
Loading

doc/images/AOP_info.png

445 KB
Loading

doc/images/AOP_login.png

26.9 KB
Loading

doc/images/AOP_reports.png

134 KB
Loading

doc/install_aop_guide.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Guide to APEX Office Print (AOP) enabling within APEX-SERT
2+
3+
The following document describes steps to enable AOP functionality within an Open-Source release of APEX-SERT.
4+
APEX-SERT Open-Source version contains a number of Compliance reports developed specifically for AOP.
5+
These ship with the product but have been disabled, pending installation of the AOP framework database objects, excluded from the distribution due to the Open-Source licensing implications.
6+
7+
When installation of the AOP framework database objects is completed, user needs to configure access to available AOP server instance and subsequently enable AOP reports within the APEX-SERT installation.
8+
9+
## AOP installation steps
10+
11+
AOP information can be found at United Codes [Apex Office Print](https://www.apexofficeprint.com/).
12+
13+
<img src="./images/AOP_info.png" alt="AOP info" width=50% height=50% style=" border-right: #000000 2px outset; border-bottom: #000000 2px outset; border-left: #000000 4px outset; border-top: #000000 2px outset;">
14+
15+
<br>
16+
17+
Source AOP database objects from United Codes [AOP Login](https://www.apexofficeprint.com/ords/uc/r/aop_portal/login_desktop/).<br>
18+
You must create an account and login before you can download installation files.
19+
20+
<img src="./images/AOP_login.png" alt="AOP login" width=25% height=25% style=" border-right: #000000 2px outset; border-bottom: #000000 2px outset; border-left: #000000 4px outset; border-top: #000000 2px outset;">
21+
22+
<br>
23+
24+
Download and install AOP distribution [AOP Downloads](https://www.apexofficeprint.com/ords/r/uc/aop_portal/downloads/).
25+
26+
<img src="./images/AOP_downloads.png" alt="AOP downloads" width=50% height=50% style=" border-right: #000000 2px outset; border-bottom: #000000 2px outset; border-left: #000000 4px outset; border-top: #000000 2px outset;">
27+
28+
<br>
29+
30+
AOP objects must be installed into the SERT_CORE database schema.
31+
Ensure that, at the end of this process, all AOP object successfully compile.
32+
33+
At a minimum, these AOP database objects must be created:
34+
35+
### Tables
36+
37+
AOP_CONFIG<br>
38+
AOP_DOWNSUBSCR_TEMPLATE<br>
39+
AOP_DOWNSUBSCR_TEMPLATE_APP<br>
40+
AOP_DOWNSUBSCR<br>
41+
AOP_DOWNSUBSCR_ITEM<br>
42+
AOP_DOWNSUBSCR_LOG<br>
43+
AOP_DOWNSUBSCR_OUTPUT<br>
44+
AOP_DOWNSUBSCR_MESSAGE<br>
45+
46+
### Triggers
47+
48+
aop_config_biu<br>
49+
aop_downsubscr_template_biu<br>
50+
aop_downsubscr_template_app_bi<br>
51+
aop_downsubscr_biu<br>
52+
aop_downsubscr_item_biu<br>
53+
aop_downsubscr_log_biu<br>
54+
aop_downsubscr_output_biu<br>
55+
aop_downsubscr_message_biu<br>
56+
57+
### Views
58+
59+
OUTPUTTO_COLLECTION
60+
61+
### Packages
62+
63+
aop_api22_pkg<br>
64+
aop_convert22_pkg<br>
65+
aop_modal_api_pkg<br>
66+
aop_modal_pkg<br>
67+
aop_plsql22_pkg<br>
68+
69+
### Procedures
70+
71+
aop_outputto_email
72+
73+
Within APEX-SERT installer locate and execute these scripts:<br>
74+
@product/aop/grants/aop_setup.sql
75+
76+
## AOP server configuration steps
77+
78+
Before running AOP reports, you need to ensure that you have access to an AOP server.
79+
80+
Using your AOP server URL, update APEX-SERT integrated preference system table using this command:
81+
82+
```sql
83+
update sert_core.prefs
84+
set pref_value = 'YOUR AOP SERVER URL'
85+
where pref_key = 'AOP_URL';
86+
87+
commit;
88+
```
89+
90+
## AOP reports enable
91+
92+
In APEX-SERT Shared Components, locate the AOP build option and set it to Include.
93+
94+
<img src="./images/AOP_build_option_enable.png" alt="AOP downloads" width=50% height=50% style=" border-right: #000000 2px outset; border-bottom: #000000 2px outset; border-left: #000000 4px outset; border-top: #000000 2px outset;">
95+
96+
## AOP reports run
97+
98+
AOP reports are available from the AOP Compliance Reports via the Reports button in the Evaluation Details Dashboard.
99+
These can be accessed after application evaluation completes successfully.
100+
101+
<img src="./images/AOP_reports.png" alt="AOP reports" width=50% height=50% style=" border-right: #000000 2px outset; border-bottom: #000000 2px outset; border-left: #000000 4px outset; border-top: #000000 2px outset;">
102+
103+
Finally note that APEX-SERT AOP reports output is distributed via password protected PDF files.
104+
After report output is downloaded, its corresponding password is displayed on a page.<br>
105+
In addition, it is delivered to your APEX username defined email address, provided you successfully configured Email server in your APEX workspace Instance Settings.

0 commit comments

Comments
 (0)