AventX for Oracle EBS

Resource Guide
AventX Oracle Connector
AventX for Oracle eAM
AventX Print Xpress
AventX Mobile for eAM

Version 20.4.00

11505 Allecingie Parkway

Richmond, VA 23235

phone: 804.897.1600
fax: 804.891.1638

[email protected]
www.strsoftware.com
 AventX for Oracle EBS Resource Guide

Copyright (c) 2021

by STR Software

All Rights Reserved.

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or
translated into any language or computer language, in any form or by any means, electronic, mechanical,
magnetic, optical, chemical, manual, or otherwise without the prior written consent of

STR Software

11505 Allecingie Parkway

Richmond, Virginia 23235

Phone: (804) 897-1600

Email: [email protected]

STR Software reserves the right to revise this publication and to make changes from time to time in the
content hereof and the programs described, without any obligation of STR Software to notify any person of
such revision or change. The information contained in this document is considered to be confidential and
proprietary information to STR Software. This document may not be reproduced or transmitted in any form
or by any means, electronic or mechanical, for any purpose, without STR Software’s prior written permission.
This document is not warranted to be error free, nor subject to any other warranties or conditions. AventX is
a registered trademark of STR Software, Richmond, VA. Other names may be trademarks of their respective
owners.

Table of Contents - Oracle EBS Considerations

Page 2 of 944
Proprietary to STR Software
Table of Contents
Table of Contents...................................................................................................... 3
Introduction.............................................................................................................. 6
Requirements ........................................................................................................... 7
Oracle EBS Considerations .................................................................................................................. 7
AventX Delivery Status Web Client Access Considerations ................................................................ 9
AventX Queue and WebManager Requirements ............................................................................. 10
AventX Translation Server Requirements ......................................................................................... 10
Building the AventX Server ..................................................................................... 11
Supported Operating Systems .......................................................................................................... 11
Minimum Server Requirements ........................................................................................................ 11
Scaling the Server .............................................................................................................................. 11
SSH Trust Considerations .................................................................................................................. 12
Virtualization Considerations ............................................................................................................ 12
Alternative Supported Architectures ................................................................................................ 13
Unsupported Architecture(s) ............................................................................................................ 20
Operating System Considerations ..................................................................................................... 21
Printing Considerations ..................................................................................................................... 24
Installing the Software ............................................................................................ 24
Pre-installation Steps (All EBS Versions) ........................................................................................... 24
Installing AventX with Oracle EBS R12.2.x ........................................................................................ 31
Installing AventX with Oracle EBS R12.1.x or Earlier Versions.......................................................... 35
Executing the AventX Installation Script ........................................................................................... 35
Post-installation Steps ....................................................................................................................... 52
Upgrading the Software .......................................................................................... 53
Known or Common Upgrade Issues .................................................................................................. 53
Pre-Upgrade Steps ............................................................................................................................ 55
Oracle EBS R12.2.x ............................................................................................................................ 59
Table of Contents - Oracle EBS Considerations
Page 3 of 944
Proprietary to STR Software
 Oracle EBS Non-R12.2.x .................................................................................................................... 65
Post-Upgrade Steps ........................................................................................................................... 74
Configuring Software Modules................................................................................ 90
AventX for Oracle EBS ....................................................................................................................... 90
AventX for Oracle eAM ................................................................................................................... 397
Modules........................................................................................................................................... 508
AventX Digital Print Module ............................................................................................................ 508
AventX Print Xpress ......................................................................................................................... 543
System Administration ......................................................................................... 590
Product Versions ............................................................................................................................. 590
Forms and Field Descriptions .......................................................................................................... 593
AventX Delivery Status Web Client ................................................................................................. 802
License Keys..................................................................................................................................... 806
Monitoring the Software ................................................................................................................. 808
Troubleshooting .............................................................................................................................. 815
Stopping and Starting ...................................................................................................................... 829
Oracle Database and Database Server Maintenance Considerations ............................................ 831
Data Cleanup ................................................................................................................................... 832
Oracle Attachments ........................................................................................................................ 833
Exporting and Importing Data ......................................................................................................... 851
Cloning ............................................................................................................................................. 856
Multiple Oracle EBS Instances with one AventX Instance .............................................................. 872
Failover and High Availability Options ............................................................................................ 876
Performance Tuning for High Volumes ........................................................................................... 885
Uninstalling the Software ................................................................................................................ 893
File System Configuration Files ....................................................................................................... 894
Organization Configuration Algorithm ............................................................................................ 906
Converting PDF to PostScript for Printing ....................................................................................... 908
Appendix A: Miscellaneous ................................................................................... 909
Table of Contents - Oracle EBS Considerations
Page 4 of 944
Proprietary to STR Software
 Modifying CUSTOM.pll ......................................................................... Error! Bookmark not defined.
Appendix B: Release Notes ................................................................................... 914
Version 20.4.00 (December 31st, 2020) .......................................................................................... 914
Version 14.4.00 (December 31st, 2019) .......................................................................................... 915
Version 14.3.00 (September 30th, 2019) ......................................................................................... 915
Version 14.2.00 (July 12, 2019) ....................................................................................................... 916
Version 14.1.00 (April 19, 2019) ..................................................................................................... 917
Version 13.4.00 (December 24th, 2018) .......................................................................................... 918
Version 13.2.00 (July 9th, 2018) ....................................................................................................... 920
Version 12.3.00 (September 1, 2017) ............................................................................................. 922
Version 12.2.00 (July 10th, 2017) ..................................................................................................... 923
Version 12.1.00 (February 8th, 2017) .............................................................................................. 924
Version 12.0.01 (January 1st, 2017) ................................................................................................. 924
Version 12.0.00 (December 30th, 2016) .......................................................................................... 925
Version 11.7.00 (October 25th, 2016).............................................................................................. 927
Version 11.6.00 (September 9th, 2016) ........................................................................................... 928
Version 11.5.00 (June 13th, 2016) ................................................................................................... 929
Version 11.4.00 (June 10th, 2016) ................................................................................................... 930
Version 11.3.00 (April 11th, 2016) ................................................................................................... 932
Version 11.2.00 (February 29th, 2016) ............................................................................................ 934
Version 11.1.00 (February 8th, 2016) .............................................................................................. 935
Version 11.0.00 (December 17th, 2015) .......................................................................................... 937
Version 10.0.00 (Released April 14th, 2015).................................................................................... 939

Table of Contents - Oracle EBS Considerations

Page 5 of 944
Proprietary to STR Software
Introduction
This a comprehensive guide for the AventX for Oracle EBS software. Throughout this guide the software will
be referred to as AventX; unless required otherwise.

The AventX for Oracle EBS software is comprised of several modules.

1. AventX Oracle Connector – Provides advanced email, fax, standard printing, archiving, and other
document delivery functionality.
2. AventX for Oracle eAM – Provides the ability to print work orders with attachments from Oracle
Enterprise Asset Management.
3. AventX Print Xpress – Provide the ability to quickly view and print report output.
The installation of the AventX for Oracle EBS Software will lay the foundation for installing all components
listed above. There is a separate document for installing and upgrading the AventX for Oracle EBS software.
Please start with the “AventX for Oracle EBS Installation and Upgrade Guide” to begin the process of installing
the software. Come back to this document to finish the setup and configuration of the module(s) required to
meet your business needs.

• AventX Oracle Connector - The AventX Oracle Connector software is an advanced document delivery
solution for all Oracle EBS modules. The following diagram represents the AventX Oracle Connector.
• AventX for Oracle eAM - The AventX for Oracle eAM software provides maintenance staff working in
Oracle Enterprise Asset Management the ability to automatically print work orders and their
attachments.
• AventX Print Xpress - The AventX Print Xpress software is an advanced printing solution for all Oracle EBS
modules that allows for printing to local client and networked printers.

Introduction - Oracle EBS Considerations

Page 6 of 944
Proprietary to STR Software
Requirements
Oracle EBS Considerations
The following table provides a version compatibility chart for the AventX for Oracle EBS and Oracle EBS
application and database versions.

AventX for Oracle EBS

Oracle EBS Versions Oracle Database Versions
Version

10.x 11.5.10, R12.0, R12.1.x, R12.2.x (up to RUP4) 10g, 11g, 12c
11.x 11.5.10, R12.0, R12.1.x, R12.2.x (up to RUP4) 10g, 11g, 12c
12.x 11.5.10, R12.0, R12.1.x, R12.2.x (up to R12.2.6) 10g, 11g, 12c
13.x 11.5.10, R12.0, R12.1.x, R12.2.x (up to R12.2.6) 10g, 11g, 12c
14.x or higher 11.5.10, R12.0, R12.1.x, R12.2.x (up to R12.2.9) 10g, 11g, 12c, 19c

Oracle EBS R12.2.x Considerations

AventX Oracle Connector v10.0.00 or higher is required for Oracle EBS R12.2+ implementations and the
AventX software should be installed on a remote AventX Host. If this is not possible, AventX must be installed
under a unique user account on the non-editioned file system of the Concurrent Manager tier.

AventX CANNOT be installed under the editioned file system and is NOT supported under this configuration.
The software must be installed in an online patching cycle. It does not matter whether or not this is timed
with an existing site patching cycle or a unique cycle is run to install the software. The software must be
installed against a patch edition of the database and file system. STR Software strongly suggests that whoever
performs the installation fully understands the implications of Online Patching. For more information on
Online Patching consult Oracle Support document Doc ID 1583902.1. Upgrades must also be applied in an
online patching cycle.

Requirements - Oracle EBS Considerations

Page 7 of 944
Proprietary to STR Software
Oracle Database Considerations
By default, the USER_DATA tablespace is used for the AventX Oracle Connector tables for Oracle version 11i9;
for Oracle version 11i10, R12, and R12.1, it is APPS_TS_TX_DATA. This value can be overridden during the
intial installation.
For Oracle version R12.2+ the tablespace as specified during the creation of the CUSTOM_TOP user for the
AventX product will be used.
Size requirements for the tablespace are 10 MB for empty tables, plus an additional 3-10K per document.

During the installation process, AventX installs a new, separate schema with tables, views, and synonyms.
There is one package that will be compiled as apps and added to the apps schema. This package,
XXSTR_AOOC_WOUI_CP, is a copy of the seeded EAM_WOREP_PUB package. It is used for advanced work
order printing within AventX Attachment Xpress for eAM.

Password Considerations
Logins as APPS and SYSTEM to Oracle EBS databases are required for the initial installation and subsequent
upgrades. These passwords are not permanently stored in AventX.

• The person responsible for installing AventX Oracle Connector should know the APPS and SYSTEM Oracle
database passwords before beginning the installation.
• The APPS login is needed for the granting of select permissions on tables used by AventX Oracle
Connector. Additionally, synonyms for AventX Oracle Connector tables, view, and packages are created.
• The SYSTEM login is needed for the creation of a new database user and to grant permissions for that
user.

Oracle Forms Considerations

• Forms must be compiled on the application server (access to frmbld/frmcmp_batch for R12 installations
or f60desm/f60gen for 11i10 installations), installed in the proper directory (e.g.
$XXAVENTX_TOP/forms/US), and registered.
• AventX Form names cannot be changed from their original names.

Oracle Report and BI Publisher Considerations

The AventX software supports the following Oracle Report format types: Text, PDF, HTML (BIP Excel). BI
Publisher v5.0 or greater with patch 3435480 is required for output in PDF format.

Requirements - Oracle EBS Considerations

Page 8 of 944
Proprietary to STR Software
Attachment Extraction Considerations
• When specifying an attachment, the user can select “file” or “web page” as the data type. For “web
page” data type attachments the user can enter a UNC (Universal Naming Convention) path for CIFS
extraction (e.g. \\<domain>\<share>\<filename>), valid URL (Universal Resource Locator) path for
CIFS extraction (e.g. file://<domain>/<share>/<filename>), or HTTP NTLM URL for HTTP or HTTPS
extraction (e.g. http(s)://<domain>/<path>/<filename>).
• For HTTPS extraction, the HTTPS server must have been secured using a valid root certificate from a
certificate authority and signed with a public key. Attachments stored on HTTPS servers with self-
signed certificates will NOT be extracted.
• For “web page” data type attachments for CIFS extraction a valid Windows Active Directory domain
login and nonexpiring password are required.
• For “web page” data type attachments for HTTP extraction a valid domain login and nonexpiring
password are required for domains where HTTP authentication is required.
• The AventX configuration requires the credentials of a non-expiring Network User with read access to
the specified resources for extracting Web Page attachments.

Database Access Considerations

AventX connects to the Oracle database to perform install and upgrade operations. Therefore, the Oracle
Client (Full or Instant) with sqlplus must be available from the AventX host (both 32- and 64-bit versions of
the client are supported), and the $TNS_ADMIN environment variable must be properly defined for the user
that owns AventX.

AventX Web Client Access Considerations

The AventX Web Client requires Oracle EBS credentials for successful authorization. It is highly
recommended that AventX be configured to run in SSL mode using an SSL certificate from a trusted
authority to avoid passing user credentials unencrypted over your network. See Appendix A Securing AventX
with SSL over HTTPS for more information.

Requirements - AventX Web Client Access Considerations

Page 9 of 944
Proprietary to STR Software
AventX Queue and WebManager Requirements
The following table provides information on the requirements for integrating other products with the AventX
Oracle Connector. The primary purpose of this information is to ensure all necessary components are
properly upgraded in conjunction with the AventX Oracle Connector to satisfy any dependencies.

Requirement Specifications

AventX UNIX / WebManager Version 13.0.00 or higher

AventX Translation Server Requirements

AXTS 5.3.1.0 and 5.3.0.0 to 3.5.0.0 to
4.0.0.0
AXOC newer 5.3.0.4 3.6.0.1

14.1.0 or higher Yes Yes Yes Yes

10.0.00 to
No Yes Yes Yes
13.4.00
AventX Attachment Xpress Required Version of AventX Translation Release Date
for Oracle eAM Version Server Software
Version 9.x.xx Version 3.2.03 – 3.3.01 09/05/2014
Version 10.x.xx Version 3.3.01 – 5.3.0.4 06/01/2015
Version 11.x.xx Version 3.3.01 – 5.3.0.4 06/01/2015
Version 12.x.xx Version 3.5.00 – 5.3.0.4 04/08/2017
Version 14.1.xx or higher Version 5.1.00+ 03/29/2019

Requirements - AventX Queue and WebManager Requirements

Page 10 of 944
Proprietary to STR Software
Building the AventX Server
The AventX software should be deployed on a virtual or physical server with the following server
specifications.

Supported Operating Systems

• Oracle Enterprise Linux (OEL) version 6, 7, 8
• Red Hat Enterprise Linux (RHEL) version 6, 7, 8
• CentOS 6, 7, 8
• Solaris 10, 11
• AIX 7

Minimum Server Requirements

The following represents the minimum server specifications for a standard implementation of the software
under the following software configuration and product use.

• 2 AventX Translation Server threads

• 500 documents per day product use

Server Specifications

• 4 CPU’s
• 8GB RAM
• Disk Space = Operating System Requirements + 20GB for AventX Application
Higher volumes may require an adjustment to this recommendation. Please consult with STR Software on the
server specifications that may be needed for a particular project.

Scaling the Server

The AventX product provides many ways of configuring the software for higher volume implementations. It
is best to consult STR Software Technical Support if the product use is great than what is outlined in the
“Minimum Server Specifications” section of this document.

Scaling Considerations
• Document Conversion
o Whether documents need to be converted to PDF format prior to being delivered.
• Disk Space – There are several factors that will impact disk space requirements.
o Document Storage Timeframes
o Logging Levels (Debug mode can use a lot of disk space)

Building the AventX Server - Supported Operating Systems

Page 11 of 944
Proprietary to STR Software
SSH Trust Considerations
For installations of AventX on a remote server, in order to transfer concurrent request output from the CM
tier to the AventX server via sFTP, a one-way SSH trust must be set up from the applmgr user (or equivalent)
on the CM tier to the user who owns AventX on the remote server. This trust is not a requirement when using
FTP to transfer output.

Virtualization Considerations
STR Software allows customers to run the AventX application in a virtual environment. STR Software uses
virtualization technology internally for our test and production systems. STR Software also has many
customers successfully running the AventX software in production virtual environments.

If a customer desires to run AventX in a virtual environment, then STR Software highly recommends the
virtual machine running AventX be deployed on an iSCSI (Internet Small Computer System Interface) or Fibre
Channel datastore, thereby avoiding deployment using NFS (Network File System) technology.

The AventX product suite utilizes a third party database which relies on operating system file locking. Since
there are known issues with NFS and file locking, deploying a virtual machine on NFS could result in data
integrity issues. This recommendation is based upon consistent observation of poor performance of the
AventX product due to the high level of disk I/O transactions, often resulting in an unstable environment.

STR Software's technical support will assist customers running AventX software in virtual environments. STR
Software will provide technical and development support for issues that either are known to occur on the
native operating system or can be demonstrated not to be the result of running on a virtualized operating
system.

If the problem is not a known AventX issue, then STR Software support will refer the customer to the
virtualization software vendor. STR Software is happy to resume troubleshooting and provide bug fixes when
the customer can demonstrate the issue occurs when running on a non-virtualized operating system.

Building the AventX Server - SSH Trust Considerations

Page 12 of 944
Proprietary to STR Software
Alternative Supported Architectures
The following is the production and non-production environment architecture deployed by most companies.
In this example, a small AventX script on each CM (Concurrent Manager) tier(s) transfers the report output to
a remote AventX file system via FTP or sFTP. There is one production server that only services the needs of
production and one non-production server that services the needs of multiple non-production environments.

Building the AventX Server - Alternative Supported Architectures

Page 13 of 944
Proprietary to STR Software
The following benefits are available if AventX is deployed on a standalone Linux server as compared to
installing the software on a concurrent manager tier(s).
1. Easier and less expensive to support
By installing AventX on a remote server, support teams do not require “applmgr” level access to the file
system to configure the software, obtain log files, troubleshoot problems, etc. The software can be owned by
a user that allows for non-DBA resources to support the AventX application. This saves time and money by
not requiring expensive resources to support the AventX application.

2. Cloning Oracle EBS environments is a lot easier and requires less time
There are fewer post-clone configuration steps required when AventX is running on a remote server.

3. Fewer AventX non-production instances to manage

With the appropriate type of license, one instance of the software can service many non-production
instances as indicated by the previous diagram. This helps reduce the amount of time required to configure,
upgrade, and maintain the AventX software.

4. Less software to install

Some companies run Oracle on SUN, which sometimes lacks all of the third party tools installed that are
required to use AventX. Customers who can deploy AventX on Linux (Oracle Linux or Red Hat Linux) benefit
because 3rd party products such as Ghostscript are normally already installed.

5. Backup Procedures are Better

AventX can be deployed on a virtual machine using a virtual machine adminiastrative suite like VMWare. All
of the technologies available for backing up the virtual machine, performing live migrations, and taking
snapshots are available to system administrators.

6. Better Failover Options

AventX, when running on a remote server and with the required licensing, has failover options that will
automatically start sending Concurrent Manager tier report output to a second instance of AventX if the
concurrent manager can not communicate with the primary AventX instance. Additional licensing may be
required.

Concurrent Manager Tier Architecture

For customers that do not wish to stand up an additional machine (virtual or physical), AventX for Oracle EBS
may be deployed on the Oracle EBS CM (concurrent manager) tier(s). The following types of concurrent
manager architectures are supported:

1. Single or multiple concurrent managers

2. Shared $APPL_TOP or $COMMON_TOP
3. Real Application Clusters (RAC)
As mentioned earlier, the AventX software can be deployed on the following types of file systems when
deploying AventX on a concurrent manager tier(s):

1. Local disk on the concurrent manager tier(s).

2. Shared file system on a SAN (Storage Area Network) where the remote storage acts as a local disk,
e.g. Fibre Channel on the concurrent manager tier(s).

Building the AventX Server - Alternative Supported Architectures

Page 14 of 944
Proprietary to STR Software
This section includes other software deployment options for the AventX software if installing on a remote /
standalone server is not possible. It is only an introduction to these concepts and does not represent an
exhaustive list of deployment options available in the software. Environments vary from site to site and
unique needs can be typically handled using flexible features of the software.

The following represent some of the unique technology considerations for implementing AventX on a
concurrent manager tier. These considerations are in addition to or a replacement of the consideration and
requirements listed for non-concurrent manager tier implemenentations.

• Unix user has to be a member of the same group as the "applmgr" account.
• More AventX non-production instances to manage. Installing AventX on the CM tier(s) normally
results in more AventX instances running on the network. This is because there is typically a one-to-
one ratio of an AventX instance with each instance of Oracle EBS.
• More software to install. Some companies run Oracle on SUN, which sometimes lack all of the third
party tools installed that are required to use AventX. Customers who deploy AventX on these non-
Linux (Oracle Linux or Red Hat Linux) concurrent manager tier servers sometimes have to install 3rd
party products such as Ghostscript.
• Does not require the installation of the Oracle client. Most implementations of AventX on the CM
tier source the UNIX user who owns the AventX software, e.g. “aventx” with the same environment
variables as the “applmgr” user. This means the “aventx” user aleady has access to the Full Oracle
Client because it is required by “applmgr” on the CM tier.
• Printers do not need to be configured. AventX on the concurrent manager tier does not require the
installation of network printers on Oracle EBS Concurrent Manager tier. The software uses printers
already defined in the concurrent manager’s operating system.
• It may be more difficult to support after moving into production. The CM tier is typically locked
down from user access. If AventX is installed on the CM tier then this means that only a few people
within your organization can access the AventX file system, especially if the AventX software is owned
by a user like “applmgr”. Support teams who do not have access to the “applmgr” passwords have to
call expensive resources like a UNIX administrator or a DBA who have this level of access. This causes
delays in resolving support issues and distracts these valuable resources from other responsibilities.
• Oracle EBS cloning is more difficult and time consuming. There are more post-clone configuration
steps required when AventX is running on a concurrent manager tier.
• Local disk installation has limitations. Installing on a shared file system is limited to Storage Area
Network (SAN) technology. If SAN is not available then installation of the software must be on a
disk that is local to the concurrent manager tier. Unique instances of the software *may* be
required on each concurrent manager tier if SAN technology is not utilized and multiple concurrent
managers are deployed.
Multiple Concurrent Manager Tiers, Single AventX on Tier 1

In this example concurrent manager tier 1 (CM1) runs the AventX processes a local disk or SAN attached
storage disk. Output from CM2 and CM3 are transferred to CM1 via NFS, FTP or sFTP. This results in one (1)
AventX implementation.

Building the AventX Server - Alternative Supported Architectures

Page 15 of 944
Proprietary to STR Software
Building the AventX Server - Alternative Supported Architectures
Page 16 of 944
Proprietary to STR Software
The following diagram shows the same architecture as described above. The only difference is the local disk is
a SAN attached disk.

Building the AventX Server - Alternative Supported Architectures

Page 17 of 944
Proprietary to STR Software
Distributed File system on a SAN

CM1, CM2, and CM3 have individual SAN disks that are connected via fibre channel for each CM tier. The
AventX processes are started individually from each CM tier. AventX transfers request output from the CM to
the $FCHOME/oa/database/../dropoff directory via “cp”. This results in multiple AventX implementations,
which is good for failover and load balancing because if CM1 goes down then CM2 and CM3 will continue to
process documents. The amount of work required to upgrade, configure, and manage each individual
instance increases because this example implements multiple AventX instances.

Building the AventX Server - Alternative Supported Architectures

Page 18 of 944
Proprietary to STR Software
Separate AventX Installations on Multiple CMs on Local Disk

In this example, AventX is deployed on the local disk on each concurrent manager. CM1, CM2, CM3 all have
separate AventX implementations. This results in multiple AventX implementations, which is good for failover
and load balancing because if CM1 goes down then CM2 and CM3 will continue to process documents. The
amount of work required to upgrade, configure, and manage each individual instance increases because this
example implements multiple AventX instances.

Building the AventX Server - Alternative Supported Architectures

Page 19 of 944
Proprietary to STR Software
Unsupported Architecture(s)
The following examples are not supported by the AventX application.

Shared File System on NAS

In this example, all CM tiers are mounted to a NAS file system via NFS.

NAS
CM1
NFS /vol1/aventx/prod/oa/../dropoff

CM2

CM3

Distributed File System on NAS

In this example, each concurrent manager tiers (CM1, CM2, and CM3) have individual NFS mount points to
individual directories on a NAS.

NAS
CM1
NFS /aventx/cm1/oa/../dropoff

CM2 NFS /aventx/cm2/oa/../dropoff

NFS /aventx/cm3/oa/../dropoff
CM3

Building the AventX Server - Unsupported Architecture(s)

Page 20 of 944
Proprietary to STR Software
Operating System Considerations
A Unix user is required to own AventX for Oracle EBS. STR Software’s standard is to name this user “aventx”.
This user must meet the following requirements:

• Unix user has Oracle environment variables in place to access Oracle databases (e.g., $TNS_ADMIN).
• Unix user must have access to sqlplus during the installation of the product for the creation of a new
user, tables, views, etc.
• User must be able to run sqlplus and connect to the correct database.
The software requires 32-bit compat-libstdc++-296-2.96 library to be installed, including at a minimum:

glibc.i686
libstdc++.i686
Though not required, STR Software recommends installing the telnet client and nslookup utility for
troubleshooting purposes. STR Software also recommends increasing the allowed file handle limits to a
minimum value of 10240 or 102400.

AIX Considerations
Customers running AventX for Oracle EBS on AIX should ensure that tcp_nodelayack is disabled. This feature
can cause a significant slowdown when using certain features of the product.
To verify if this setting is enabled (it is by default) the following command can be used to query the setting:
no -a | grep tcp_nodelayack
A value of 0 means that TCP acknowledgements are delayed and likely is the cause of performance issues
with transferring data files. To modify this parameter, the following command must be executed as root:
no -p -o tcp_nodelayack=1

Building the AventX Server - Operating System Considerations

Page 21 of 944
Proprietary to STR Software
File System Considerations
This section defines software deployment options for the AventX Oracle Connector software, hereafter also
referred to as “AventX”. This is simply an introduction to these concepts and does not represent an
exhaustive list of available deployment options. Environments vary from site to site, and unique needs can
typically be handled using flexible features within the AventX software.

The AventX software may be installed on the following types of file systems:

• Local disk on the application tier(s) (e.g. for Oracle EBS implementations with AventX Oracle
Connector on the concurrent manager tier).
• Local disk on a standalone, physical, or virtual server.
• Mounted file system to a Storage Area Network (SAN) from application tier or standalone server
where the remote storage acts as a local disk, e.g. Fibre Channel.
The AventX software may not be installed on an NFS mounted file system. See “Unsupported Architectures”
for more information on this topic.

Java Considerations
AventX for Oracle EBS requires Java 8 (64 bits Recommended) or greater which may not be available for
certain operating systems. Therefore, it is important to determine if your operating system is supported so
that this requirement can be met. See the following table for details regarding supported Java versions.
Latest JAVA Version
OS Latest AventX UNIX Versions Supported
Supported
AIX 7 Java 8 Current version and below
Red Hat Enterprise Linux 6 Java 8 (6.6+) Current version and below
Red Hat Enterprise Linux 7 Java 8 (7.1+) Current version and below
Red Hat Enterprise Linux 8 Java 8 (7.1+) Current version and below
Oracle Enterpise Linux 6 Java 8 (6.x) Current version and below
Oracle Enterprise Linux 7 Java 8 (7.x) Current version and below
Oracle Enterprise Linux 8 Java 8 Current version and below
Solaris 10 / SunOS 5.10 Java 8 (Update 9+) Current version and below
Solaris 11 / SunOS 5.11 Java 8 (Update 9+) Current version and below
If your operating system does not support Java 8, then STR Software strongly recommends migrating AventX
for Oracle EBS to a “remote server” architecture using Oracle Enterprise Linux or Red Hat Enterprise Linux.

Cloud Hosting Considerations

AventX servers hosted by a cloud hosting service, such as Oracle Managed Cloud Services (OMCS), may have
network traffic to/from the AventX server blocked by default. To enable proper functioning of AventX on a
cloud-hosted server, the following TCP ports must be opened:

• The database connection port to the Oracle database server(s). By default, this is port 1521.
• Port 25 to the SMTP relay used to send AventX emails.
• Port 139 and 445 to any CIFS shares containing Oracle attachments to be extracted by AventX.
• Port 80 to any servers with Oracle attachments referenced by HTTP to be extracted by AventX.
Building the AventX Server - Operating System Considerations
Page 22 of 944
Proprietary to STR Software
 • Port 443 to any servers with Oracle attachments referenced by HTTPS to be extracted by AventX.
• If printing attachments or archiving combined PDFs with AventX, the AventX Translation Server
(AXTS) port must be open between the AventX server and the Windows server(s) hosting AXTS. By
default, this is port 3190.
Additionally, the AventXPS port (by default, this is 6055) should be open to traffic from all PCs on your
network, as well as the Oracle APPS tier(s). This is necessary to enable a variety of administrative and
troubleshooting features.

AventX must meet the following requirements to successfully extract DFS Attachments:

• AventX must have read access to the attachments stored via DFS.
• AventX host must have network access to all DFS nodes.

Building the AventX Server - Operating System Considerations

Page 23 of 944
Proprietary to STR Software
Printing Considerations
AventX prints from the server where AventX is installed. Therefore, any printer that is used by the software
needs to be defined in the operating system where AventX is installed. The AventX server will not use printers
defined on the concurrent manager tier when AventX runs on a remote server. Normally this is not an issue
because the Linux operating system typically has the ability to import printer definitions and configuration if
using CUPS (Common UNIX Printing System).

Installing the Software

Pre-installation Steps (All EBS Versions)
The following is a basic outline of the pre-installation tasks.

Determine where AventX will be installed

STR Software provides a detailed document that provides information on the various ways the AventX
software can be deployed. The “AventX for Oracle EBS Implementation Requirements Guide” provides this
information along with the pros and cons of the available options. To summarize, there are two locations
where the software can be deployed.

1. On a remote server (suggested by STR Software)

2. On the Oracle EBS Concurrent Manager server (not recommended for R12.2.x)
The AventX for Oracle EBS software may not be installed on any file system that is mounted using NFS
(Network File System) technology. The installation of this software must exist on the locally attached disk
drive, locally attached drive on a SAN, or in a virtual environment.

The instructions outlined in this document were created for a “remote server” implementation. Installation
instructions may vary slightly if installing the software on the concurrent manager tier.

Obtain license Keys

Call STR Software at 804-897-1600, option 3. Please be prepared to provide the engineer with the following
information. Execute the following SQL queries against the Oracle database that AventX will integrate with:

select host_name from v$instance;

select name from v$database;

Next, provide the output of the following UNIX command:

$ uname -a

Create the “aventx” operating system user

It is required that a separate account (e.g. aventx) be assigned the ownership of the AventX software. The
installation account must be a member of the same group as the “applmgr” account, have the proper OA

Installing the Software - Printing Considerations

Page 24 of 944
Proprietary to STR Software
environment variables defined (e.g. the login profile executes APPSORA.env) as well as access to the Oracle
tools (e.g. sqlplus, tnsnames.ora, etc.). Refer to the proper Oracle documentation on setting up the OA
environment variables for further information.

Install the Oracle Client

The Oracle client must be accessible as the “aventx” operating system user. Running the command “tnsping”
followed immediately by the SID should return OK.

Create $CUSTOM_TOP
It is recommended to create a CUSTOM_TOP for the AventX software. The following provides information on
how to create a custom top if these instructions are needed.

Oracle EBS < R12.2.x

This may be considered optional. However, most companies prefer to install the AventX software into a
CUSTOM_TOP.

On the Unix host as "applmgr" user: edit the appropriate ENV file to add the base path reference for your
custom application. For example, in the VIS world, edit the $APPL_TOP/VIS_<hostname>.env file.
If you are planning on putting the files related to a custom application in $APPL_TOP/<new directory>, the
following entry would be added to $APPL_TOP/VIS_<hostname>.env:

XXAVENTX_TOP="$APPL_TOP/xxaventx/12.0.0"
export XXAVENTX_TOP

Oracle standards require all custom applications to be sub-trees of $APPL_TOP. Oracle suggests having short
directory name.
Our example uses "xxaventx".
The "12.0.0" will be replaced by the appropriate string for the Oracle version. Simply follow the trees created
by the installation (that already exist) as an example.

For Oracle EBS R12 environments, you must also edit the default.env file found under
$INST_TOP/ora/10.1.2/forms/server directory. (per Metalink Note 553014.1)
Simply add an entry, like this:

XXAVENTX_TOP=$APPL_TOP/xxaventx/12.0.0
Login to UNIX server with 'applmgr' user access
Go to $INST_TOP/ora/10.1.2/forms/server directory.
Ensure that your CUSTOM_TOP's are registered in the default.env file.

Installing the Software - Pre-installation Steps (All EBS Versions)

Page 25 of 944
Proprietary to STR Software
This means , we should create an entry for environment variable CUSTOM_TOP (which contains physical path
to your custom directory) like below in default.env file present under location.

$INST_TOP/ora/10.1.2/forms/server directory.

For Example:

APPL_TOP=/home/applmgr/PROD/apps/apps_st/appl
CUSTOM_TOP=/home/applmgr/PROD/apps/apps_st/custom

Restart the middle tier services.

Retest the issue.
On the Unix host as "applmgr" user: create the directory tree necessary for the custom application. You only
need the sub-trees for those items your custom application has. For AventX for Oracle EBS, it's just form files,
so we only need to add the forms directory. For our example:
cd $APPL_TOP

mkdir -p xxaventx/12.0.0/forms/US
chmod -R 775 xxaventx

You will place the AventX form files in the $XXAVENTX_TOP/forms/US directory after they have been
compiled (step 7 of setup.sh). Remember to specify the different (custom) directory; otherwise, your files will
go to $FND_TOP/forms/US.
In Oracle EBS: APPLICATION->REGISTER to define the custom application. Follow the simple rules for the four
entries. The following screen shot can be used as a guide.

Installing the Software - Pre-installation Steps (All EBS Versions)

Page 26 of 944
Proprietary to STR Software
Remember to make sure that the value you specify for "BASE_PATH" " what you defined in your ENV file
(XXAVENTX in our example; Do NOT include the $ in Basepath in the Oracle form). If the wrong path is
specified, then Oracle will not find the forms and an error will not be displayed when the form is accessed.
After saving those changes, you MUST restart the APPS processes so they will read the ENV changes and
implement them. It is NOT necessary to restart the DB.

It is always a good idea to run the System Administrator Report called "Prints Environment Variables" to test
to see if Oracle is aware of the XXAVENTX_TOP environment variable. Use the following parameters and
make sure they return the correct values.

FND_TOP
XXAVENTX_TOP
PATH
Continue with the AventX forms registration steps as outlined on the product documentation. Make sure to
specify your custom application and not "Application Object Library" (which is shown in the example in the
documentation) to point to your custom application path.

Oracle EBS > R12.2.x

AventX must be installed in a Custom Top for an R12.2+ environment. This involves creation of a custom
application (custom top and schema) for the AventX software. STR Software’s standard is to name this
schema XXAVENTX with custom top XXAVENTX_TOP. In R12.2+ adsplice MUST be run to register the custom
application. Performing manual steps to create the custom application, as one would do prior to R12.2+, is
not sufficient.

Installing the Software - Pre-installation Steps (All EBS Versions)

Page 27 of 944
Proprietary to STR Software
To create a custom application in R12.2+ follow the Oracle Support Document ID 1577707.1. A summary of
the steps contained within this document can be found below: These steps should be performed by the
applmgr (or equivalent) user.

1. Download patch: 3636980 “Support Diagnostics (IZU) patch for AD Splice” from Oracle Support.
2. Unzip the patch in an appropriate location.
3. Manually copy the three .txt files from the 3636980\izu\admin directory to a temporary location.
4. Rename izuprod.txt to <module>prod.txt where <module> is the custom application
abbreviation (example xxaventx).
5. Rename izuterr.txt to <module>terr.txt where <module> is the custom application
abbreviation (example xxaventx).
6. Edit newprods.txt
Change all references from "izu" to <module> as used above. Change all references from “IZU” to
<MODULE> as above (keep case sensitivity)

Modify other values as appropriate.

7. Edit <module>prod.txt.

Change all references from "izu" to <module> and all references from "IZU" to <MODULE>.

Change all references for prodid 278 to be your own unique product ID. Oracle recommends a number above
50,000. The following SQL may be used to ensure it is not in use:

SQL>select decode(count ,0, 'Selected number is Available', 'Selected number already in use') Status,
&&enter_custom_applID selected_number

from

select count(*) as count from

select 'x' from fnd_oracle_userid

where oracle_id=&& enter_custom_applID

union

select 'x' from fnd_application

where application_id=&& enter_custom_applID

Installing the Software - Pre-installation Steps (All EBS Versions)
Page 28 of 944
Proprietary to STR Software
)

);

8. Edit <module>terr.txt

Change all references from "izu" to <module> and all references from "IZU" to <MODULE>.

Change the text "Oracle_Support_Diagnostic_Tools" to be "AventX_for_Oracle_EBS"

9. Copy the three text files <module>prod.txt, <module>terr.txt, and newprods.txt to the
$APPL_TOP/admin directory.

10. Change directory $APPL_TOP/admin and run adsplice. The adsplice utility must be run from this
directory.

11. Follow the on screen prompts.

Installing the Software - Pre-installation Steps (All EBS Versions)

Page 29 of 944
Proprietary to STR Software
12. autoconfig will be run automatically by the adsplice tool. Depending on your architecture the
adsplice utility may need to be run multiple times.

If there are multiple application tiers and $APPL_TOP is not shared, adsplice must be run on each
application tier.

If there are multiple application tiers and a shared APPL_TOP, autoconfig must be run on each application
tier.

Recording ADSPLICE action for product: xxaventx

Do you wish to regenerate your environment file [Yes] ?

Checking if AutoConfig is enabled....

Running AutoConfig on : All products ...

The log file is located at:

/oraapps/d01/oracle/VIS/fs1/EBSapps/appl/admin/VIS/log/autoconfig_1.log

Please check the log file for more details about the run of AutoConfig.

If you added new products, use FNDCPASS to change their default passwords.

AD Splicer is complete.

13. Verify the creation of the Custom Application using the following queries; the <PRODUCT ID> is the
numeric ID created in previous steps.

SQL>select * from fnd_application where application_short_name = '<MODULE>';

SQL>select * from fnd_product_installations where APPLICATION_ID = <PRODUCT ID>;

SQL>select * from dba_users where username = '<MODULE>';

14. Log out and back in as the applmgr user and run the following:

$ env | grep <MODULE>

$ ls $<MODULE>_TOP

15. After adsplice is run, the password for xxaventx must be changed. This is required by Oracle EBS.

(Conditional) - Install and Configure the AventX UNIX Software

The AventX UNIX software is required to integrate fax and email delivery with the AventX Oracle Connector
software. This software is NOT required if deploying the AventX for Oracle EBS software for use with the

Installing the Software - Pre-installation Steps (All EBS Versions)

Page 30 of 944
Proprietary to STR Software
AventX Print Xpress and/or AventX Attachment Xpress for EAM modules. Download the AventX UNIX
software and follow the instructions for performing the base installation of the software if required.

Installing AventX with Oracle EBS R12.2.x

This section includes instructions for installing AventX in an Oracle EBS R12.2+ environment. If you are
installing AventX in an R12.1.x, R12.0.x, or 11i10 EBS environment, do not use this set of instructions. Other
instructions are provided in this document for those Oracle EBS versions.

Online Patching Considerations

In order to install AventX in an R12.2+ environment, special steps must be taken to comply with Online
Patching, a new feature in R12.2. STR Software has followed the standards presented by Oracle. Details on
these standard may be found in the "Developing and Deploying Customizations in Oracle E-Business Suite
Release 12.2 (Doc ID 1577661.1)” found on Oracle Support. For answers to questions specific to the following
steps, consult the aforementioned Oracle Support Document.

The following requirements must be met before installing the AventX for Oracle EBS in an R12.2+
environment:

• AventX for Oracle EBS should be installed on a separate AventX Host.

If this is not possible, AventX for Oracle EBS must be installed under a new, unique user account on the
Concurrent Manager tier. AventX for Oracle EBS CANNOT be installed under the editioned file system and
is not supported under this configuration.
• The software must be installed during an online patching cycle.
Whether or not this is timed with an existing site patching cycle, or a unique cycle is run to install AventX
does not matter. However, the software, primarily steps of the AventX setup.sh script, must be installed
against a patch edition of the database and file system. It is critical to fully understand the implications of
Online Patching and STR Software strongly suggests that whoever performs the installation fully
understand Online Patching. For more information on Online Patching, consult Oracle Support document
Doc ID 1583902.1.
• The R12.2+ installation cannot be installed over an existing AventX installation.
As such, any existing schema from a prior installation must be removed and ALL references to that
schema MUST be removed from the apps schema.
If upgrading Oracle EBS from pre-R12.2 to R12.2+, the existing schema must be removed before
upgrading to R12.2+ by running the $FCHOME/oa/ins/remove.sh script. If the existing schema is not
removed, the AventX installation cannot be completed without errors.

Installing the Software - Installing AventX with Oracle EBS R12.2.x

Page 31 of 944
Proprietary to STR Software
Set up the prepare phase on the application tier as the applmgr user
AventX must be installed in an online patching cycle. To enter an Online Patching Cycle the adop
phase=prepare command is used. The changing stages of a patch cycle have system-wide implications and
before issuing these commands it is important to fully understand Online Patching and the adop command.
Additionally, it is necessary to understand the current state of the system where applying these commands
and if anything should prevent or delay the execution of these steps. Once ready to perform the installation,
source the run environment file:

$ source <installdir>/EBSapps.env run

Enter the “prepare” phase.

Depending on environment, the adop command may require additional parameters and may need to be run
on more than one system:

$ adop phase=prepare

You should NOT proceed to the next step until the adop phase=prepare command has completed
successfully. You may wish to use the following command to determine the current phase.

$ adop -validate

Run the AventX setup.sh to install AventX

AventX uses a setup script called “setup.sh” to install the software. Run the AventX setup.sh script after
performing the “pre-installation” steps. Information on how to run this script is available in Appendix A of this
document.

Update the custom synchronization driver

If it exists in your version of EBS R12.2+, the custom synchronization driver file needs to be updated to ensure
that the adop utility synchronizes the newly created custom top between the run file system and the patch
file system the next time a patch cycle is entered.

1. Edit the file: $APPL_TOP_NE/ad/custom/adop_sync.drv

2. Between the #Begin Customization and #End Customization lines, add the line being sure to update the
“xxaventx” directory to match the <module> used when running adsplice:

rsync -pr %s_current_base%/EBSapps/appl/xxaventx/ %s_other_base%/EBSapps/appl/xxaventx/

3. Save the file and exit.

Installing the Software - Installing AventX with Oracle EBS R12.2.x

Page 32 of 944
Proprietary to STR Software
(Conditional) - Extract the AventX Controllers
If using the AventX Attachment Xpress for eAM or the AventX Print Xpress software module, as the applmgr
or equivalent user, copy the $FCHOME/oa/ins/xxstrJavaControllers.tar from the AventX sever to the Oracle
Applications tier(s). Log onto the Oracle Applications tier and change directory and extract the file in the
$JAVA_TOP directory:

$ cd $JAVA_TOP

$ tar –xvf xxstrJavaControllers.tar

The following folders will be created:

For R12.2.x Implementations, the controller extraction steps need to be performed as part of a PATCH CYCLE.
In addition, the execution of Oracle’s adcgnjar utility is required to generate and sign a file called
customall.jar that contains all custom Java code and extensions. This utility does not require any parameters
on the command line, but will require the password for the APPS user at a prompt.

$ adcgnjar

This step will create a customall.jar file in the $JAVA_TOP directory. Next, complete the steps necessary for
finishing a patch cycle.

Installing the Software - Installing AventX with Oracle EBS R12.2.x

Page 33 of 944
Proprietary to STR Software
Finish the Patching Cycle
Once all of the installation steps have been completed successfully, then it is time to complete the patching
cycle so that the software can be configured and tested. In order to do this, the remaining adop steps must
be completed to merge the changes to the “patch” edition into the “run” edition:

1. Source the patch environment as the applmgr user.

$ source <install_dir>/EBSapps.env patch

2. Kick off the “finalize” phase:

$ adop phase=finalize

3. Once the finalize phase is completed, as the applmgr user, verify the environment is set to patch:
$ echo $FILE_EDITION

If the command returns “run”, source the patch environment:

$ source <install_dir>/EBSapps.env patch

4. Initiate the “cutover” phase:

$ adop phase=cutover

5. Now that the cutover is complete, clean up the run environment to ensure that everything is ready for
the next prepare/patch cycle. As the applmgr user, source the run environment:

$ source <install_dir>/EBSapps.env run

6. Kick off the “clean up” phase:

$ adop phase=cleanup

7. Kick off the “file system clone” phase:

$ adop phase=fs_clone

After the Patching Cycle is complete, you may begin configuring the AventX software as described in the
AventX for Oracle EBS Resource Guide.

Installing the Software - Installing AventX with Oracle EBS R12.2.x

Page 34 of 944
Proprietary to STR Software
Installing AventX with Oracle EBS R12.1.x or Earlier Versions
This section includes instructions for installing AventX in an Oracle EBS R12.13, R12, or 11i10 environment. If
you are installing AventX in an R12.2 or higher environment, do not use this set of instructions. You will need
to use the R12.2+ specific installation instructions.

Executing the AventX Installation Script

AventX uses a setup script called “setup.sh” to install the software. Run the AventX setup.sh script after
performing the “pre-installation” steps. Information on how to run this script is available in Appendix A of this
document. The script performs the following functions:

▪ Creates the .fcoa_cfg_<SID> (configuration) file. All references to <SID> are the name assigned to the
Oracle EBS instance being installed and must be resolvable per tnsnames.ora.
▪ Sets appropriate permissions for the AventX file system
▪ Creates the Oracle database user (default is “xxaventx") to own the tables in the specific Oracle EBS
instance. For R12.2+ implementations, this user will have been created beforehand via adsplice.
▪ Creates the necessary tables, views, grants and synonyms used by AventX in the specific Oracle EBS
instance.
▪ Creates tar archives for the Concurrent Manager host(s) and Forms tier host(s). These archives will be
used to build and install the necessary scripts/forms/libraries on the respective hosts.
As you complete each step, setup.sh will keep track of tasks performed and will post a status message next to
each step in the menu as it completes. Status messages are as follows:

Status Explanation

OK Indicates that this step completed successfully without warnings or errors.

WN Indicates that this step completed with one or more warnings. You should exit setup.sh and
check $FCHOME/oa/database/<SID>/log/setup.log for the warning messages.

ER Indicates that this step completed with one or more errors. You must exit setup.sh and check
$FCHOME/oa/database/<SID>/log/setup.log for the error messages. Any errors must be
corrected prior to continuing installation.

The setup.sh script must be run by a user and login account with the following properties:

▪ The login account has access to sqlplus.

▪ The user has access to the APPS, SYS (only for 11.5.9 EBS) and SYSTEM Oracle database users/passwords.
▪ The login account has Oracle environment variables in place to perform the functions listed above.
▪ The login account has a defined environment variable $FCHOME corresponding to the AventX install
path. If not already defined, setup.sh will attempt to automatically set it in $HOME/.bash_profile or
$HOME/.profile (depending on your default shell). If FCHOME does not get set automatically as expected
you may manually add the following lines to either $HOME/.bash_profile or $HOME/.profile:
Installing the Software - Installing AventX with Oracle EBS R12.1.x or Earlier Versions
Page 35 of 944
Proprietary to STR Software
FCHOME=<path to AventX install directory>
export FCHOME

For non-R12.2.x implementations, it is recommended that the script be run by the login account that owns
AventX (usually “aventx”).

For R12.2+ implementations, setup.sh is intended to be run against an EBS instance that does not have a
prior installation of AventX for Oracle EBS. This is necessary due to an issue with the Oracle code that is
responsible for editioning tables for online patching. Essentially, if a synonym already exists in the apps
schema when calling ad_zd_table.upgrade, the process fails and does not return an error and the object is
not appropriately editioned.

For 12.2.x implementations, it is important NOT to run this script as the applmgr user, because the applmgr
user is an editioned user! All steps of setup.sh should be executed in the “run” environment as the user that
owns the AventX software. For remote AventX host implementations, care should be taken to ensure
connecting to the “run” edition of the database. The installation scripts are responsible for switching to and
installing in the patch editions when appropriate. If installing on the Concurrent Manager tier, the run
environment may be sourced with the following command:

$ source <install_directory>/EBSapps.env run

The “setup.sh” script is a menu-driven script, which allows you to perform one or more of these tasks at any
given time. For a new installation, all steps must be performed. Not all steps have to be performed during a
single execution of the script. However, it is best to perform the steps in sequential order. In addition, it is
important to understand that there may be certain “manual” tasks to be performed before making a
particular menu selection, so pay close attention to the steps outlined in this chapter. For example, before
building libraries and forms, it is highly recommended to make backup copies of files, etc.

During the execution of setup.sh, a log is created in $FCHOME/oa/database/<SID> /log/setup.log, which

records all activity performed by the script. The setup.log file is appended to each time setup.sh is executed.
Should you run into any problems, you can consult this log for any error messages that may have been
encountered during the execution of the script.

Extract the AventX software and run the setup script

Log in to the UNIX host as the account that will own the AventX installation (e.g. aventx). Change to the
directory where the AventX will be installed (e.g., /home/aventx). This can be any directory, as proper
ownership and permissions will be assigned during the installation.

Copy the appropriate software archive file (using a utility such as FTP) to this directory. The file is named
oa.standard.xxxx.tar.gz or oa.<customer>.xxxx.tar.gz (if your build has custom functionality), where xxxx is
the version number.

Once you have placed the file on the UNIX host, enter the following command to unzip and then extract the
files from the archive. Note: your OS may not support the -z option to the tar command, in which case you
must first unzip the file using the gunzip (or equivalent) command and then extract it using the tar command:

$ tar –zxvf <filename> (where <filename> is the name of the software archive file)
Installing the Software - Executing the AventX Installation Script
Page 36 of 944
Proprietary to STR Software
Next, use the following commands:

$ cd $FCHOME/oa/ins

$ ./setup.sh

Upon executing setup.sh, you will be prompted to update an existing or create a new AventX
configuration within an EBS instance.

After creating or picking the Oracle EBS instance to configure, you must verify that the installation is not on
an NFS mounted file system.

You will then be given the option to provide passwords for the APPS and SYSTEM database users, which are
then validated. These users are needed in many of the setup.sh steps. Providing the passwords here for these
users reduces the chances for typos, resulting in a faster and smoother installation. The passwords are not
stored in any file or database, only in memory; they are used when necessary for the setup.sh steps. If you do
not wish to enter the passwords here, you can hit <Enter> when prompted to skip this step. If you do not
enter the passwords here, you will be prompted, as necessary, during each step of setup.sh.

Next, you will be provided with a main menu screen:

The main menu screen provides you with a number of options, as described in detail later in this chapter. A
brief explanation of each menu option is provided below.

1. Create the .fcoa_cfg file – The script prompts for information, such as the Oracle version and document
delivery system, to properly define the values for the AventX configuration file (.fcoa_cfg_<SID>).
When complete, this step will also place the edited file into the <installation directory = $FCHOME>
where it must reside. If you do not choose this selection, you may modify .fcoa_cfg_<SID> at a later time
using your favorite text editor and then manually place the file in the installation directory.

2. Prepare scripts for execution – This sets the proper permissions on AventX scripts and files.

Installing the Software - Executing the AventX Installation Script

Page 37 of 944
Proprietary to STR Software
3. Create the database user in Oracle – This runs sqlplus and connects to the specified Oracle EBS instance
as the SYSTEM user to define the database user and to give appropriate access permissions. For R12.2+
implementations, this user will have been created beforehand via adsplice.

4. Create the tables – For Oracle EBS version 11.5.9, this runs sqlplus and connects to the specified Oracle
EBS instance as the cORACLE_LOGIN, SYS, and APPS users to create the tables, columns, and other
structures in the database that are required for the AventX, and to give appropriate access to the tables.

For Oracle EBS versions 11.5.10 and greater this runs sqlplus and connects as the cORACLE_LOGIN and
APPS users to create the tables, columns, and other structures in the database that are required for
AventX, and to give appropriate access to tables.

5. Create the views – This runs sqlplus and connects to the specified Oracle EBS instance as the
cORACLE_LOGIN user to create the views needed by AventX. (See Chapter 36, “Configuration Settings”)

6. Create aliases for the tables and views – This runs sqlplus and connects to the specified Oracle EBS
instance as the APPS user to grant select permissions on tables used by AventX. It also connects as the
cORACLE_LOGIN user (e.g. XXAVENTX) to create synonyms for the AventX tables.

7. Prepare Concurrent Manager and forms scripts – This creates two tar archives; one containing the
necessary files for the Concurrent Manager host and one containing the necessary files for building the
AventX forms for the Forms tier. Instructions for implementing these two archives are provided in the
setup.sh text.

You may exit setup.sh at any time by typing x from the main menu screen.

The remainder of this chapter focuses on each of the above selections in detail. Each main menu selection
must be executed in proper order for successful installation of AventX.

Installing the Software - Executing the AventX Installation Script

Page 38 of 944
Proprietary to STR Software
Create the .fcoa_cfg file
After selecting option # 1 from the menu, AventX prompts you for information on the configuration at your
site, and updates the .fcoa_cfg_<SID> file accordingly. The prompts you receive will vary depending on your
responses. AventX uses the $FCHOME/.fcoa_cfg_<SID> file to save important configuration settings. If
upgrading, the prompts will be pre-populated with the current values from the .fcoa_cfg_<SID> file. You may
change any of the values except the Oracle database credentials (e.g. xxaventx/xxaventx).

By default, the cFAXMGR_TABLESPACE parameter is set to USER_DATA for Oracle 11i version 11.5.9. If using
version 11.5.10 or R12, this parameter defaults to APPS_TS_TX_DATA. Of course, you may specify any valid
table space name here that you would like to make available for use by the cORACLE_LOGIN user.

Any error messages are displayed on the screen. In addition, during the execution of setup.sh, a log is created
in $FCHOME/oa/database/<SID> log/setup.log, which records all activity performed by the script. The
setup.log file is appended to each time setup.sh is executed. Should you run into any problems, you can
consult this log for any error messages that may have been encountered during the execution of the script.

Upon successful completion, you will see the following:

Step 1 completed without detectable errors or warnings.

[Press Enter to continue]

Upon completion of this step, the edited file is automatically placed as $FCHOME/.fcoa_cfg_<SID> where it
must reside for proper operation of AventX.

Regardless of which method is chosen to edit .fcoa_cfg_<SID>, make sure that you have reviewed and made
any necessary changes to .fcoa_cfg_<SID> before making any other selections from the setup.sh main menu
screen.

Installing the Software - Executing the AventX Installation Script

Page 39 of 944
Proprietary to STR Software
Prepare scripts for execution
After making this selection from the main menu of setup.sh, AventX will set the proper permissions on the
following types of files used by AventX:

• Log files and the directories which hold these files are given read, write and execute permissions
• Shell scripts are given read and execute permissions
• awk scripts are given read permissions
• Report files are given read permissions
• SQL scripts are given read permissions
Commencing with version 8.1.00, global/world permissions have been removed from all permanent and
temporary files created by AventX.
Upon making the selection from the main menu, you should see similar information displayed on your
screen, as shown in below:

********************************************

* AventX(tm) for Oracle EBS

* Setup and Initialization - <SID>

* Version x.x.xx

* Begin Step 2

********************************************

Setting file permissions...

----------------------------------------------------------------------------

Step 2 completed without detectable errors or warnings.

[Press Enter to continue]

Create the database user in Oracle

Making this selection from the main menu of setup.sh for a new installation AventX will create the AventX
user defined in step 1 (hereafter referred to as cORACLE_LOGIN) and give that user the proper permissions
needed to access the necessary tables. This user is the owner of the AventX tables, and is assigned unlimited
table space in the area specified in the cFAXMGR_TABLESPACE parameter of the .fcoa_cfg_<SID> file.

The default database user is “xxaventx.”

Installing the Software - Executing the AventX Installation Script

Page 40 of 944
Proprietary to STR Software
For R12.2+ implementations, during execution of step 1 of setup.sh, you should have changed this value to be
the Custom Top user that you created during the preparation steps, for example, xxaventx. Ensure that the
proper database user has been set by viewing the cORACLE_LOGIN environment variable in the
.fcoa_cfg_<SID> file prior to running this step in setup.sh. For the remainder of this document, the user will
be noted as cORACLE_LOGIN.

The cORACLE_LOGIN user is granted connect, create table, create sequence, and create synonym
permissions. This step must be executed before attempting to create the AventX tables and views.

Upon making the selection from the main menu, you should see similar information displayed on your
screen.

You have chosen to set up the database user for

the connector. If you have performed this step

previously, you don't need to repeat it on the

same Oracle database. If you do run this a second

time, you will receive error messages because the

user already exists, but the result is harmless.

The actual script performing this task is in file

<installation directory>/oa/ins/fcstep1.sql.

To set up the connector database user, you need

to access the database as SYSTEM.

Continue?([Yes],No)

The selection will now run sqlplus with the $FCHOME/oa/ins/fcstep1.sql file as its input to create the
cORACLE_LOGIN user. This step requires login to the OA database as SYSTEM. Note any error messages that
are displayed on the screen. These will also be written to the setup.log file. Upon successful completion, you
will see the following:

----------------------------------------------------------------------

Step 3 completed without detectable errors or warnings.

[Press Enter to continue]

Installing the Software - Executing the AventX Installation Script

Page 41 of 944
Proprietary to STR Software
Create the connector tables
AventX uses a set of tables in the Oracle database that are configured and owned by the cORACLE_LOGIN
user. The tables are set up in the table space as specified by the cFAXMGR_TABLESPACE parameter in the
.fcoa_cfg_<SID> file, and contain the necessary information for successful delivery of documents to their
destination(s)AventX.

Making this selection from the main menu of setup.sh AventX will create several tables needed by the
AventX. A brief description of these tables is as follows:

The script does not populate the tables with all of the data required for the AventX to function properly.
This is accomplished using the AventX Configuration form. Information on how to configure the AventX for
Oracle EBS can be found in the “Configuration Guide”

Upon making the selection from the main menu, you should see similar information displayed on your screen
as show below.

The setup program will now execute a series

of SQL commands that will install the necessary

tables and schema, selection grants, and

synonyms for the connector. The actual

script being executed is in the file

<installation directory>/oa/ins/fcstep2.sql.

For this step, you need to access the database as the connector database user to create tables, APPS to grant
select on Oracle tables, and SYS to grant selection on v$database and v$instance.

Continue?([Yes],No)

The selection will now run sqlplus with the $FCHOME/oa/ins/fcstep2.sql file as its input to create the AventX
tables. This step requires login to the OA database as cORACLE_LOGIN, APPS, and SYS (Note: SYS is used only
if running Oracle EBS version 11.5.9). Note any error messages that are displayed on the screen. These will
also be written to the $FCHOME/oa/database/<SID>/log/setup.log file. Upon successful completion, you will
see the following:

--------------------------------------------------------------------------

Step 4 completed without detectable errors or warnings.

[Press Enter to continue]

Installing the Software - Executing the AventX Installation Script

Page 42 of 944
Proprietary to STR Software
Create the connector views
AventX uses views to retrieve destination and document information from Oracle tables based on a number
of different criteria. Making this selection from the main menu of setup.sh will create the views of the tables
needed by AventX. The script connects as cORACLE_LOGIN to create the views. Upon making the selection
from the main menu, you should see similar information displayed on your screen, as shown below:

Connecting as <cORACLE_LOGIN> as found in .fcoa_cfg (<cORACLE_LOGIN>/<password>).

The selection will now execute the $FCHOME/oa/ins/mkview.sh script to create the AventX views. The script
will automatically log in to the database as cORACLE_LOGIN. You will also have two additional prompts to
type <Enter> to continue. Note any error messages that are displayed on the screen. These will also be
written to the $FCHOME/oa/database/<SID>/log/setup.log file. Upon successful completion, you will see the
following:

--------------------------------------------------------------------------

Step 5 completed without detectable errors or warnings.

[Press Enter to continue]

Create aliases for the tables and views

After making this selection from the main menu of setup.sh, AventX will create the synonyms for tables used
by cORACLE_LOGIN. The script connects as APPS to create the synonyms, and also grants select permissions
on all other tables used by cORACLE_LOGIN. The tables used by AventX may differ based upon your
company’s document delivery types and requirements.

Upon making the selection from the main menu, you should see similar information displayed on your
screen, as shown below:

The setup program will now execute a series

of SQL commands to grant access to the tables, views,

and stored procedures used by the connector.

The actual script performing this task is in file

<installation directory>/oa/ins/fcstep3.sql.

For this step, you need to access the database as APPS to create synonyms for connector database user’s
tables, views, and packages.

Continue?([Yes],No)

The selection will now run sqlplus with the $FCHOME/oa/ins/fcstep3.sql file as its input to create the
synonyms and grants for the AventX tables, views and stored procedures. This step requires login to the OA
Installing the Software - Executing the AventX Installation Script
Page 43 of 944
Proprietary to STR Software
database as APPS and cORACLE_LOGIN. Note any error messages that are displayed on the screen. These will
also be written to the $FCHOME/oa/database/<SID>/log/setup.log file. Upon successful completion, you will
see the following:

--------------------------------------------------------------------------Step 6 completed without detectable errors or

warnings.

[Press Enter to continue]

Prepare Concurrent Manager and forms scripts

After executing this step and pressing <Enter>, proceeding through the prompts, two archive files will have
been created in the $FCHOME/oa directory:

• oa.cmhost.<SID>.tar (where <SID> is the defined name of the Oracle EBS instance being configured
for AventX for Oracle EBS)
• oa.formhost.tar
The first archive contains the files which need to be implemented on the Oracle concurrent manager(s). The
second archive contains the files which need to be implemented on the Oracle forms tier(s). Instructions are
provided in the text of this step for what to do with each of these archive files. Instructions for these steps
are displayed on the screen.

Installing the Software - Executing the AventX Installation Script

Page 44 of 944
Proprietary to STR Software
Set up AventX on the Oracle EBS Concurrent Manager Tier(s)
For EBS R12.2 implementations, this step must be executed against the PATCH file system.

1. Execute the following command:

$ source <install_dir>/EBSapps.env patch

The following steps can be executed for all Oracle EBS versions.

2. Transfer the file oa.cmhost.<SID>.tar to the Oracle concurrent manager host.

Installing the Software - Executing the AventX Installation Script

Page 45 of 944
Proprietary to STR Software
The extracted files must be owned by a UNIX account to which the concurrent manager has access (e.g.,
“applmgr”).

If running setup.sh as part of an upgrade, this file should be extracted into the file system, available to the
concurrent manager, where the previous version of AventX for Oracle EBS was installed (replacing those files
with these updated files). The existing directory can be determined from an Oracle EBS print driver argument
string that is used for AventX for Oracle EBS. This directory is the $FCHOME for the concurrent manager
portion of AventX for Oracle EBS.

If running setup.sh as part of a fresh installation on Oracle EBS R12.2+, this file must be extracted within the
custom top created for AventX (e.g. XXAVENTX_TOP). This directory will serve as $FCHOME for the
concurrent manager portion of AventX for Oracle EBS.

3. Extract the archive into the desired directory:

$ tar -xvf oa.cmhost.<SID>.tar

4. Execute ./oa/ins/setup_cm.sh and perform step 1, “Prepare the scripts for execution”. This step sets the
proper ownership and permissions on the files extracted from the archive.

$ cd oa/ins

$ ./setup_cm.sh

The following image shows the information from the script.

Installing the Software - Executing the AventX Installation Script

Page 46 of 944
Proprietary to STR Software
(Conditional) - Modifying CUSTOM.pll
AventX relies on the use of CUSTOM.pll to enable certain user functionality. The following user features
require the insertion of AventX logic into CUSTOM.pll:

▪ Enable “Zoom” functionality for the AventX Delivery Status forms from the “View Request” Oracle form
▪ To pop the AventX Interactive Delivery form when selecting the “AventX Interactive Printer” from the
“Submit Request” Oracle form
▪ To use the Interactive Work Order Submission Printing form
$AU_TOP/resource/CUSTOM.pll must be edited with new logic and compiled with the AventX FCOA.pll library
attached.

Before executing setup_forms.sh, you will need to perform these preparatory steps, as described below:

First, consult with your Oracle Application Developer or DBA to determine if there are existing modifications
to CUSTOM.pll. If your existing $AU_TOP/resource/CUSTOM.pll file does not contain customized code, you
may skip this step and proceed with executing the next one.

Perform the following sequence if CUSTOM.pll has been previously modified:

1. Log on as applmgr.
2. Transfer the file $FCHOME/oa/oa.formhost.tar from the AventX installation to the Oracle forms tier
host(s). This file can be extracted into any file system location with adequate space, as this is just a
staging area from which to compile the AventX for Oracle EBS forms. This installation directory will be the
$FCHOME for the forms tier portion of AventX for Oracle EBS.
3. Extract the archive into the desired directory:
$ tar -xvf oa.formhost.tar

4. Create a temporary environment variable for FCHOME using this command at the shell ($) prompt:
$ export FCHOME=<installation directory>

where <installation directory> is where you have installed the AventX on the forms tier (oa.formhost.tar). For
example, the $XXAVENTX_TOP directory.

5. Copy the system CUSTOM.pll file using the following commands at the UNIX shell prompt: For OA
versions 11i and R12:
$ cp $AU_TOP/resource/CUSTOM.pll $FCHOME/oa/fcii/forms

$ cd $FCHOME/oa/fcii/forms

6. Modify the CUSTOM.pll file (as copied into $FCHOME/oa/forms or $FCHOME/oa/forms/11i) to enable
Zoom capability for the AventX Delivery Status form and the AventX Interactive Delivery form.
In $FCHOME/oa/forms is a file, custom.txt, which provides the changes necessary to be incorporated in the
CUSTOM.pll file.

Installing the Software - Executing the AventX Installation Script

Page 47 of 944
Proprietary to STR Software
Use the OA Forms Designer (f60desm or equivalent) to simply copy and paste these changes (from the
custom.txt file) into this CUSTOM.pll file.

You must also attach the FCOA.pll library to CUSTOM.pll.

See KB Article # 16321 for more information on “How to Modify CUSTOM.pll”

After completing the preparatory steps described above, you are now ready to build the AventX forms and
library files on the Oracle forms tier host.

Set up AventX on the Oracle EBS Forms Tiers

For EBS R12.2 implementations, this step must be executed against the PATCH file system and sourced
properly:

$ source <install_dir>/EBSapps.env patch

If you haven’t already, transfer the file oa.formhost.tar from the AventX installation to the Oracle forms tier
host(s). This file can be extracted into any file system location with adequate space, as this is just a staging
area from which to compile the AventX for Oracle EBS forms. This installation directory will be the $FCHOME
for the forms tier portion of AventX for Oracle EBS.

Extract the archive into the desired directory:

$ tar -xvf oa.formhost.tar

Execute ./oa/ins/setup_forms.sh, enter the apps password when prompted, and perform Step 1 “Prepare
connector scripts for execution”. This step sets the proper ownership and permissions on the files extracted
from the archive.

STR Software has created seven custom forms for AventX. Before using AventX, these forms (and their
associated library files) must be recompiled and copied to the proper directories on the Oracle EBS forms tier.

Within setup_forms.sh, select step 2, “Build connector libraries and forms”. This should be executed by the
UNIX account that owns the file system (e.g., applmgr). This step compiles the libraries and forms and
prompts for a directory to place them on the Oracle EBS forms tier.

Installing the Software - Executing the AventX Installation Script

Page 48 of 944
Proprietary to STR Software
Upon making the selection from the main menu, you should see similar information on your screen as shown
below:

Upon pressing <Enter> to continue, this step checks for the existence of CUSTOM.pll in the proper AventX
directory and supplies the following prompt if it is not found:

If upgrading the AventX software, then select “No” from this menu prompt, as no changes to CUSTOM.pll are
necessary for upgrades of AventX for Oracle EBS.

During execution of this step, there will be a lot of information displayed on your screen. Since this
information can scroll by quickly, you should check the ./oa/log/setup.log file for any errors you may have
encountered before proceeding. When the libraries and forms have been compiled, you will be prompted as
follows:

Copy files into Applications directories?([Yes],No)

These files must be placed in their destination directories for successful operation of AventX.

If your selection is “No”, you will need to manually move the following files into their proper destination
directories on the Oracle forms tier host(s) and ensure proper ownership and permissions on them (typical
ownership is the “applmgr” user with 640 permissions). The form files are located at:

• oa/forms/FCOA*.fm*

The FCOA library files are located at:

• oa/forms/FCOA*.pl*

If you select “Yes”, the script will prompt for a directory in which to place the form files. The script will copy
only the custom form files and the FCOA library files. The script will prompt for a directory in which to place

Installing the Software - Executing the AventX Installation Script

Page 49 of 944
Proprietary to STR Software
the form files. AventX supports forms in a $CUSTOM_TOP environment. For upgrades, the previous versions
of the form files should exist in the directory in which you will be copying the new versions. You will be
notified of each form file that exists and prompted to overwrite it.

If you are running multiple forms tiers and your $FND_TOP/forms/US or $CUSTOM_TOP/forms/US directory
is NOT shared, then you will need to copy all of the FCOA*.fm* files to ALL forms tiers.

After copying the forms files, the script will prompt for placement of the FCOA* library files. The default path
will be displayed. You can specify a different path to be used, if desired.

After copying the FCOA* library files, the str_delivery_icon.gif and str_doc_status_check_icon.gif files (used
for Stand Alone Interactive Delivery and Stand Alone Delivery Status) are copied to
$OA_JAVA/oracle/apps/media. Upon successful completion, you will see the following:

Step 2 completed without detectable errors or warnings.

[Press Enter to continue]

If you ran step 10 above, “Modifying CUSTOM.pll”, be sure to back up $AU_TOP/resource/CUSTOM.pll and
copy oa/forms/CUSTOM.pll in its place.

Once you have ensured that this step was successful, exit setup_forms.sh.

Add toolbar images to FNDAOL.jar

For EBS R12.2 implementations, this step must be executed against the PATCH file system.

AventX shipped with two image files str_delivery_icon.gif and str_doc_status_icon.gif to be used as toolbar
icons for AventX Standalone Interactive Delivery and AventX Delivery Status. These images need to be added
to FNDAOL.jar file to be signed by your Oracle EBS certificate to prevent a Java security pop up from
displaying.

1. Backup the file: $FND_TOP/java/make/fndjar.dep

2. Edit the file above
3. Looks for section below:
fndaol.jar :

# code

oracle/apps/fnd/flow

oracle/apps/fnd/flex

oracle/apps/fnd/formsClient

oracle/apps/fnd/ui

# images -- need to list explicitly to avoid non-AOL images

Installing the Software - Executing the AventX Installation Script

Page 50 of 944
Proprietary to STR Software
4. Below the last line above, add two lines below:
oracle/apps/media/str_delivery_icon

oracle/apps/media/str_doc_status_check_icon

5. Save the change

6. Regenerate Product JAR using adadmin CLI utility.
$ adadmin > 1. Generate Applications Files menu > 4. Generate product JAR files

7. After the JAR is regenerated, confirm images are present in fndaol.jar

$ unzip -l $OA_JAVA/oracle/apps/fnd/jar/fndaol.jar | grep str_delivery_icon

$ unzip -l $OA_JAVA/oracle/apps/fnd/jar/fndaol.jar | grep str_doc_status_check_icon

Once you have confirmed that both files are present in fndaol.jar, proceed with any post-installation steps, as
well as configuring AventX for Oracle EBS.

Installing the Software - Executing the AventX Installation Script

Page 51 of 944
Proprietary to STR Software
Post-installation Steps

(Conditional) - Install the AventX Controllers

If using the AventX Print Xpress or the AventX Attachment Xpress for eAM module, then you must install the
AventX custom controllers and bounce Oracle Applications. Perform the following steps as the UNIX account
that owns the files/directories in $JAVA_TOP (typically “applmgr”). If running Oracle EBS R12.2+, these steps
must be performed during the prepare phase of a patching cycle, and against the PATCH file edition:

1. Copy $FCHOME/oa/ins/xxstrJavaControllers.tar from the AventX host into the Oracle Applications
$JAVA_TOP.

$ cd $JAVA_TOP

$ tar –xvf xxstrJavaControllers.tar

(Conditional – if running Oracle EBS R12.2+) $ adcgnjar

2. Bounce Oracle Applications.

(Recommended) - Configure AventX to start automatically

In order to have the AventXPS process start when the server boots up, you must meet the following
qualifications. The approach for implementing this feature differs depending on operating system version.
These steps are specific to Linux. Other operating systems may require a different syntax or approach.

Linux < v7.x (init.d)

Copy $FCHOME/oa/aventx_for_oracle_ebs into /etc/init.d as root.

chown root:root /etc/init.d/aventx_for_oracle_ebs

chmod 755 /etc/init.d/aventx_for_oracle_ebs

Add the script to init.d (chkconfig --add aventx_for_oracle_ebs) and verify the configuration change took
place.
chkconfig --list | grep aventx

Linux v7+ (systemd)

Copy $FCHOME/oa/[email protected] into /etc/systemd/system as root

chown root:root /etc/systemd/system/[email protected]

chmod 755 /etc/system/system/[email protected]

For each instance of AventX Oracle Connector, run this command and replace ‘INSTANCE’ with the Instance
name as configured in AventX:
systemctl enable [email protected]

Installing the Software - Post-installation Steps

Page 52 of 944
Proprietary to STR Software
Verify the change was enabled.
systemctl list-unit-files --type=service | grep “aventx”

(Conditional) – Configure Available Java Heap Memory for AventXPS Process

The AventXPS process requires a substantial amount of heap memory to process large batch of documents.
Sometimes, the default system predefined heap memory size may be insufficient.

Refer to this table for recommended heap memory settings:

System available memory Recommended Java Heap

4GB -Xms 512m -Xmx 1536m

8GB -Xms512m -Xmx 3072m

Note: Xms: Minimum heap, Xmx: Maxium heap, m: MB

To configure heap memory, navigate to $FCHOME/oa on the AventX Host. Open and modify aventxoc to add
the selected heap configuration to the JAVA_PROPERTIES variable.
$ cd $FCHOME/oa

$ vi aventxoc

In example, if we want to let AventXPS to set aside 512MB, and allow AventXPS to use as much as 3GB, then
we would set JAVA_PROPERTIES variable as follows:
JAVA_PROPERTIES="-Xms512m -Xmx3072m -Dmail.smtp.timeout=30000 -Dmail.smtp.connectiontimeout=30000
-Dmail.smtps.timeout=30000 -Dmail.smtps.connectiontimeout=30000"

Upgrading the Software

This section provides information on how to upgrade AventX under three situations.

1. Upgrading Oracle EBS versions with AventX

2. Upgrading Oracle EBS versions without upgrading AventX
3. Upgrade AventX without upgrading Oracle EBS

Known or Common Upgrade Issues

The following provides a summary of some of the known issues that STR Software has encountered when
assisting customers with their 11i to R12 migrations:

• When upgrading from 11i to R12.2.x, customers do not perform the AventX preparation and execution
steps prior to and after upgrading Oracle EBS to R12.2.x. Not performing these steps will cause significant
time and resource effort to “clean up” the Oracle EBS environment.

Upgrading the Software - Known or Common Upgrade Issues

Page 53 of 944
Proprietary to STR Software
• When upgrading from 11i to R12, customers have found that Purchase Order Approval workflow
changes may be required for customers sending purchase orders via email through AventX.

• When upgrading from 11i to R12, customers have found that SRAs work very differently in R12 when
migrating to Advanced Collections.

• When upgrading from 11i to R12, Oracle has changed the location of customer table data. Modification
to queries may be required.

• When upgrading from 11i to R12, customers have reported they need to re-add the AventX Menu
(FND_NAVAVENTX4.0) into FND_NAVSITE4.0. This sometimes disappears when Oracle EBS is upgraded.

• When upgrading from 11i to R12, customers need to recreate and test all custom grants for views/tables
referenced in AventX Document Configuration queries. Dropping the AventX database user causes these
grants to be lost and running setup.sh will not recreate these grants.

Upgrading the Software - Known or Common Upgrade Issues

Page 54 of 944
Proprietary to STR Software
Pre-Upgrade Steps
These upgrade preparation steps should be performed regardless of the Oracle EBS version.

(Conditional) - Obtain New License Keys

Obtain a new AventX for Oracle EBS license key. A new license key is required for all customers upgrading
from and to the following versions:

• Any version below 10 to any version 10+.

Determine if any other software upgrades are required

This can be done by reviewing the AventX for Oracle EBS Implementation Requirements Guide. You will want
to verify whether upgrades to the AventX UNIX, AventX WebManager and FAXCOM server software (if
applicable) are required. Consult each product’s documentation for their specific upgrade procedures.

Download your software and any patches

Download software and all appropriate patches per the patch application instructions. Engage STR Software
Technical Support to obtain the software and available patches.

Make sure you have the right permissions and passwords to perform upgrade

Ensure you have proper security access to the AventX file system. You will need the following to perform the
upgrade:

▪ You must be able to log in to the UNIX host where AventX for Oracle EBS resides as the user that owns
the current AventX for Oracle EBS software. If this login account is not applmgr or equivalent then it must
be a member of the same group as the applmgr account.

▪ You must be able to login to the UNIX host for the concurrent manager where the portion of AventX for
Oracle EBS resides as the applmgr user (or equivalent).

▪ You must be able to login to the UNIX host for the forms tier where the portion of AventX for Oracle EBS
(forms compilation) resides as the applmgr user (or equivalent).

▪ Database access as the APPS, SYSTEM, and SYS (only required for Oracle EBS versions less than 11i10)
users.

Upgrading the Software - Pre-Upgrade Steps

Page 55 of 944
Proprietary to STR Software
Determine which test cases need to be run

It is important to have the correct access to either run test cases yourself or to have someone available in
your company that has the access and knows how to run the test cases. Consider the following questions
when creating your list of test cases:

▪ What documents am I currently using in production? (a query to determine this would be “select distinct
fax_doctype from fax_status;”)

▪ Will I have access, i.e. Oracle user names, passwords, and responsibilities to run these reports? For
example, will you have access to support a purchase order report from workflow or to print an invoice?

▪ What document numbers should I use for testing?

Verify Java and mail relay settings

Java version requirements are important to AventX. Determine the highest version of Java installed on the
AventX server. To determine your version of Java, log in to the UNIX host as the account that owns AventX for
Oracle EBS and execute the following command:

$ java -version

If your Java version is not supported by AventX, then you must upgrade it before proceeding. Each operating
system may incorporate additional requirements or patches before applying the appropriate version of Java.
Please refer to AventX for Oracle EBS Implementation Requirements Guide for Java support matrix.

Gather the mail server name and the email address that you wish to use for receiving email alerts from
AventX for Oracle EBS. Email alerts can be generated when a concurrent manager report fails in AventX and
when errors occur posting status messages back into the Oracle database. These are configured within the
General Config tab of the AventX Configuration form.

A common way of obtaining your mail server name is to view /etc/mail/sendmail.cf. Search for the smart
relay host. For example:
#"Smart" relay host (may be null) DSmail.strsoftware.com.

Determine how files will be transferred to the AventX remote server

Determine the method to be used to transfer the report output (data) file et.al. from the concurrent manager
host to the AventX host. As of AventX for Oracle EBS version 6.5.00, the recommended configuration has all
AventX software (i.e., AventX UNIX and AventX for Oracle EBS) on its own UNIX host, with partial AventX for
Oracle EBS software on the host of the concurrent manager. If you are not using this configuration, it is
strongly recommended you migrate to it. Contact STR Software Technical Services for assistance with this
migration.

Regardless of your previous configuration, you have (3) options for transfer of the files to the AventX host:

▪ ftp (FTP to AventX host)

▪ sftp (secure FTP to AventX host)

Upgrading the Software - Pre-Upgrade Steps

Page 56 of 944
Proprietary to STR Software
▪ cp (AventX products installed on CM host)

If the AventX software is installed on a remote host (the recommended configuration), you will need to
provide the following:

▪ For FTP transfer – password of the login account that owns AventX for Oracle EBS to properly establish
the transfer connection from the host where the concurrent manager is running to the AventX host. You
will be prompted for this information during the upgrade.
▪ For sFTP transfer – nothing; the upgrade assumes that the proper trust relationship has already been
established between the host(s) where the concurrent manager is running and the AventX host. For more
information on UNIX trust relationships, please refer to KB Article # 16332.
The proper services (for FTP or sFTP) must be running on the concurrent manager host.

Back up the AventX Schema and File System

Back up the AventX for Oracle EBS schema. The default schema is typically “faxmgr”, or “xxaventx” on newer
versions. If you are unsure of the name, check the value of cORACLE_LOGIN in the following location:
$FCHOME/.fcoa_cfg (for AventX for Oracle EBS versions <6.5.00)

$FCHOME/.fcoa_cfg_<SID> (for AventX for Oracle EBS versions 6.5.00+)

Schema backup procedures are not provided by STR Software as they can be different between Oracle
database versions.

Backup the contents of the $FCHOME/oa directory on the UNIX host where AventX for Oracle EBS is installed.
$ cd $FCHOME

$ tar –cvf oa_backup.tar oa .fcoa_cfg*

Verify the user you are logged in as has the correct environment sourced

You can ensure you are about to upgrade the correct environment by running the following operating system
commands:
$ echo $ORACLE_HOME

$ echo $TWO_TASK

$ echo $FCHOME

Access to sqlplus is also required to perform the upgrade. Run the following test to make sure sqlplus is in the
user’s path:
$ sqlplus

It is important to know whether the AventX for Oracle EBS forms are registered to a custom application, i.e.,
a CUSTOM_TOP. Use this KB Article for information on how to determine if the AventX forms are registered
to a CUSTOM_TOP or if they are registered to the default FND_TOP.

Upgrading the Software - Pre-Upgrade Steps

Page 57 of 944
Proprietary to STR Software
Stop submitting requests to the concurrent manager

Notify all users to cease submitting documents to AventX for the duration of the upgrade period.

Stop the AventX processes

Use the following commands to stop the AventX UNIX processes:

$ cd $FCHOME/cfg/scripts

$ ./startup.sh stopall

To stop AventX Oracle Connector, execute the following command:

$FCHOME/oa/aventxoc stop

Reset the AventX menu status

Reset the setup script menu statuses by removing the following files:
$ rm $FCHOME/oa/log/*.status

$ rm $FCHOME/oa/database/<SID>/log/*.status

Upgrading the Software - Pre-Upgrade Steps

Page 58 of 944
Proprietary to STR Software
Oracle EBS R12.2.x
At a high level, the steps below summarize the process of upgrading Oracle EBS to R12.2.x and/or AventX:

• Upgrade AventX (CONDITIONAL).

• Export the existing AventX Schema from a non-R12.2.x instance.
• Drop the AventX user and schema before upgrading Oracle EBS to R12.2.x.
• Upgrade Oracle EBS to R12.2.x.
• Create the AventX application in Oracle EBS.
• Perform a fresh installation of the AventX.
• Import the AventX schema into the R12.2.x instance.
• Manually update the Oracle EBS version in the AventX schema
• Verify AventX functionality.
Upgrade AventX (CONDITIONAL)
Certain versions of AventX are required to work with Oracle EBS R12.2.x. Verify your AventX software version
is compatible with Oracle EBS R12.2.x and plan for an upgrade is required. STR Software recommends
upgrading AventX before your Oracle EBS upgrade, if your timeline allows it.

Export the AventX Schema from a non-R12.2+ instance

Export the AventX schema from the AventX for Oracle EBS instance on your pre-R12.2+ Oracle EBS instance
using the Export Config button on the AventX Configuration form (System Administrator → Install → AventX
→ Configuration or AventX Administrator → Configuration):

Upgrading the Software - Oracle EBS R12.2.x

Page 59 of 944
Proprietary to STR Software
Select the appropriate instance from the list of values before clicking Export Config.

Drop the AventX user and schema before upgrading Oracle EBS to R12.2.x
The (fresh) AventX for Oracle EBS installation on R12.2+ is not intended to be installed over an existing
AventX for Oracle EBS installation. As such, if upgrading Oracle EBS from pre-R12.2 to R12.2+, any existing
AventX for Oracle EBS schema from a prior installation (e.g. faxmgr or xxaventx) must be removed and ALL
references to that schema MUST be removed from the apps schema. This can be done after upgrading
AventX and exporting the configuration, by running $FCHOME/oa/ins/remove.sh BEFORE upgrading
Oracle EBS.

Upgrade to Oracle EBS R12.2.x

Perform the upgrade to Oracle EBS R12.2.x following Oracle’s best practices.

Create the AventX Application

AventX must be installed in a Custom Top for an R12.2+ environment. This involves creation of a custom
application (custom top and schema) for the AventX software. STR Software’s standard is to name this
schema XXAVENTX with custom top XXAVENTX_TOP. For R12.2+, adsplice must be run to register the custom
application. Performing manual steps to create the custom application as one would do prior to R12.2+ is not
sufficient.

To create a custom application in R12.2+, follow the Oracle Support Document ID 1577707.1.

Upgrading the Software - Oracle EBS R12.2.x

Page 60 of 944
Proprietary to STR Software
A summary of the steps contained within this document can be found below these instructions are provided
as is and the most recent documentation from Oracle should be consulted. These steps should be performed
by the applmgr (or equivalent) user:

1. Download patch: 3636980 “Support Diagnostics (IZU) patch for AD Splice” from Oracle Support.

2. Unzip the patch in an appropriate location.

3. Manually copy the three *.txt files from the 3636980/izu/admin directory to a temporary location.

4. Rename izuprod.txt to <module>prod.txt where <module> is the custom application abbreviation

(xxaventx).

5. Rename izuterr.txt to <module>terr.txt where <module> is the custom application abbreviation

(xxaventx).

6. Edit newprods.txt:

a. Change all references from “izu” to “<module>” as used above. Change all references from
“IZU” to “<MODULE>” as above (keep case sensitivity).

b. Modify other values as appropriate for your Oracle EBS instance.

7. Edit <module>prod.txt:

a. Change all references from “izu” to “<module>” and all references from “IZU” to
“<MODULE>”.

b. Change all references for prodid 278 to be your own unique product ID. Oracle recommends
a number above 50,000. The following SQL may be used to ensure the value you wish to use
is not already in use:
SQL> select decode(count ,0, 'Selected number is Available', 'Selected number already in use')
Status, &&enter_custom_applID selected_number

from

select count(*) as count from

select 'x' from fnd_oracle_userid

where oracle_id=&& enter_custom_applID

union

select 'x' from fnd_application

where application_id=&& enter_custom_applID

Upgrading the Software - Oracle EBS R12.2.x

Page 61 of 944
Proprietary to STR Software
)

);

8. Edit <module>terr.txt:

a. Change all references from “izu” to “<module>” and all references from “IZU” to
“<MODULE>”.

b. Change the text “Oracle_Support_Diagnostic_Tools” to be “AventX”.

9. Copy the three text files <module>prod.txt, <module>terr.txt, and newprods.txt to the
$APPL_TOP/admin directory.

10. Drop the pre-existing AventX schema using the “cascade” option.

11. Ensure the APPS schema does not have any synonyms referencing the pre-existing AventX schema. If
so, they should be dropped. You can use the following SQL query to assist in making this
determination (this should be run as the APPS database user):
SQL> select * from dba_synonyms

where owner= 'APPS'

and TABLE_OWNER = '<pre-existing AventX schema name>';

12. Change directories to $APPL_TOP/admin and run adsplice. adsplice must be run from this directory.

13. Follow the on screen prompts:

autoconfig will be run automatically by the adsplice tool. Depending on your architecture, the
adsplice utility may need to be run multiple times.

a. If there are multiple application tiers and $APPL_TOP is not shared, adsplice must be run on
each application tier.

b. If there are multiple application tiers and a shared APPL_TOP, autoconfig must be run on
each application tier.

14. Verify the creation of the Custom Application using the following queries:
SQL> select * from fnd_application where application_short_name = '<MODULE>';

SQL> select * from fnd_product_installations where APPLICATION_ID = <PRODUCT ID>;

SQL> select * from dba_users where username = '<MODULE>';

15. Log out and back in as the applmgr user and run the following:
$ env | grep <MODULE>

$ ls $<MODULE>_TOP

Upgrading the Software - Oracle EBS R12.2.x

Page 62 of 944
Proprietary to STR Software
Perform a Fresh Installation of AventX
It is strongly recommended that AventX (meaning the AventX UNIX and AventX for Oracle EBS products) be
installed on a remote AventX host. If this is not possible, AventX UNIX must be installed under a new, unique
user account on the Concurrent Manager tier. AventX UNIX cannot be installed under the editioned file
system and is not supported under this configuration.

Setup the Prepare Phase

AventX must be installed in an online patching cycle. To enter an Online Patching Cycle, the adop “prepare”
command is used. Changing stages of a patch cycle has system-wide implications, and before issuing these
commands, it is important to fully understand Online Patching and the adop command. Additionally, it is
necessary to understand the current state of the system where applying these commands and if anything
should prevent or delay the execution of these steps.

1. Once ready to perform the installation, source the run environment file:
$ source <installdir>/EBSapps.env run

2. Next, enter the “prepare” phase. Depending on your environment, the adop command may require
additional parameters and may need to be run on more than one system:
$ adop phase=prepare

Install AventX

The setup.sh script is intended to be run against an EBS instance that does not have a prior installation of
AventX for Oracle EBS. Note that this is necessary due to an issue with the Oracle code that is responsible for
editioning tables for online patching. Essentially, if a synonym already exists in the apps schema when calling
ad_zd_table.upgrade, the process fails and does not return an error and the object is not appropriately
editioned. Follow the instructions for running setup.sh as a fresh installation earlier in this document.

Import the AventX Schema into the R12.2+ instance

Import the AventX schema data that was exported in the step above into the AventX for Oracle EBS instance
in the Oracle EBS R12.2+. Recall that the version of AventX for Oracle EBS must be the same across instances
for the import to succeed. Use the Import Config button on the AventX Configuration form (System
Administrator → Install → AventX → Configuration or AventX Administrator → Configuration):

Upgrading the Software - Oracle EBS R12.2.x

Page 63 of 944
Proprietary to STR Software
Select the appropriate instance from the list of values before clicking Export Config.

Manually update the Oracle EBS version in the AventX schema

When performing an upgrade of Oracle EBS, the AventX for Oracle EBS software does not change the Oracle
EBS version in the AventX schema. After the fresh installation of AventX for Oracle EBS, this table column
value was correct. However, the import of the AventX schema to reinstate all document definitions and
configuration has overwritten the table column value with the “old” Oracle EBS version. You must manually
update the Oracle EBS version by executing the following SQL update statement against the AventX
schema on the target server:
UPDATE FAX_SETUP

SET VALUE='K'

WHERE FEATURE='ORACLE_IMPLEMENTATION';

Verify AventX Functionality

Perform user acceptance testing to verify that AventX is working as expecting for the configured document
types. It’s recommended that you manually validate any custom doc options queries, destination queries,
acknowledgement queries, attachment queries, archive queries, sender queries, and command queries
through the AventX Document Configuration form.

Upgrading the Software - Oracle EBS R12.2.x

Page 64 of 944
Proprietary to STR Software
Oracle EBS Non-R12.2.x

Options for Upgrading Oracle EBS and AventX

There are several methods available for migrating customers from Oracle EBS 11i to non-R12.2.x EBS
versions. Pick the method that works best for you. Here are some definitions that we will use throughout this
section:

• source server = The server running the older version of Oracle EBS, e.g. 11i.
• target server = The server running the newer version of Oracle EBS, e.g. R12.1.3.
Method # 1 - Upgrade Oracle and Reconfigure AventX

This method requires that on your existing Oracle EBS instance on the source server, you are running a
version of AventX that supports the version of Oracle EBS you are upgrading to. This procedure will provide
only for an upgrade to the Oracle EBS version, leaving the version of AventX for Oracle EBS unchanged. If you
are not on an AventX version that properly supports your target version of R12 and the Oracle database (see
table above), please consider one of the other methods for accomplishing your objectives.

The AventX table structure is different depending upon the version of the EBS software. Therefore, in this
method the AventX tables and synonyms need to be dropped and recreated, and the configuration
information needs to be imported afterwards. Do not drop the tables manually; a script is provided that will
take care of this for you. The following steps should help you accomplish your goals:

1. Clone the Oracle EBS instance from the source server to the target server.

2. Export the AventX schema on the target server as a part of your backup plan using the Export Schema
button on the Tools tab of the AventX Configuration form.

3. Drop the existing AventX for Oracle EBS database schema on the target server by running the
$FCHOME/oa/ins/remove.sh script.

4. Re-install AventX on the target server, configuring it to integrate with the upgraded version of Oracle
EBS. Run the $FCHOME/oa/ins/setup.sh script and ensure you execute all steps.

5. Import the schema data that was exported in step # 2. Use the Import Schema button on the Tools
tab of the AventX Configuration form.

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 65 of 944
Proprietary to STR Software
 6. Manually update the Oracle EBS version in the AventX FAX_SETUP table.

After the fresh installation of AventX for Oracle EBS, the value for the EBS version in that AventX
schema was correct. However, the import of the AventX schema to reinstate all definitions and
configuration has overwritten that value with the “old” Oracle EBS version. You must manually
update the Oracle EBS version by executing the following update statement against the AventX
schema on the target server.

The valid, possible values are as follows:

I = R12

J = R12.1+

The example below provides SQL to update the version to a value of ‘J’, indicating an R12.1+ Oracle
EBS instance. Make sure to use the correct letter in your UPDATE statement.
UPDATE FAX_SETUP

SET VALUE='J'

WHERE FEATURE='ORACLE_IMPLEMENTATION';

Method # 2 - Clone Oracle EBS to another server, upgrade Oracle EBS and upgrade AventX

This method assumes that on your existing instance of Oracle EBS on the source server you are NOT running a
version of AventX that supports the Oracle EBS R12+ application and database to which you are migrating.
This procedure will provide for an upgrade to the Oracle EBS version as well as the version of AventX for
Oracle EBS. If you are on an AventX version that properly supports your version of R12 and the database (see
table above), then please use option #1 to accomplish your objective.

Most customers migrate to Oracle EBS R12 by cloning Oracle EBS 11i to another server and then upgrading to
R12. If your company is using this method, then use one of the following options to migrate AventX into EBS
R12:

Option #1: Upgrade AventX for Oracle EBS on source server and then follow the instructions for
Method #1 above.

Option #2: Follow the instructions for Method #1 and then upgrade AventX for Oracle EBS on the
target server via the upgrade instructions earlier in this chapter.

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 66 of 944
Proprietary to STR Software
Method # 3 – Fresh installation of Oracle EBS R12, migrate the Oracle EBS data, perform a fresh AventX
installation

This method is not as common as it requires more work; however, some customers are using it. Use the
following steps if you are performing a fresh installation of Oracle EBS R12 and importing the AventX for
Oracle EBS data from the existing Oracle EBS/AventX instance:

1. Copy the AventX file system from the source server to the target server.

a. Create the UNIX user to own the AventX instance on the target server.
b. Stop AventX UNIX on the source server:
$ fcmgr –admin –c stop

c. Check to make sure the AventX processes are stopped:

$ ps –ef | grep fc

d. Create an archive of the $FCHOME from the AventX source server:

$ cd $FCHOME
$ tar –cvf aventx_refresh.tar * .fcoa_cfg* .pid

e. Restart AventX UNIX on the source server:

$ fcmgr –admin –c start

f. Copy the archive to your AventX target server file system and extract it in $FCHOME:
$ cd $FCHOME
$ tar –xvf aventx_refresh.tar

2. Download the latest AventX for Oracle EBS software to the target server and overlay it on the existing
AventX for Oracle EBS file system:

a. Back up the AventX for Oracle EBS file system on the target server:
$ cd $FCHOME
$ tar –cvf oa_backup.tar oa

b. Extract the latest AventX for Oracle EBS software on the target server:
$ cd $FCHOME
$ gunzip oa.standard.xxxx.tar.gz
$ tar –xvf oa.standard.xxxx.tar

3. Upgrade the AventX UNIX software on the target server to the latest version. Instructions for upgrading
are provided in the AventX UNIX Resource Guide.

4. Perform a fresh installation of the AventX for Oracle EBS on the target server according to the
instructions in the first chapter of this guide.

5. Migrate the AventX schema data from the Oracle EBS source server to the target server using the
Export/Import Config buttons on the Tools tab of the AventX Configuration form.

After performing the data migration, you must update the Oracle EBS version in the FAX_SETUP table.
You can manually update the Oracle EBS version by executing the following update statement against the
AventX schema on the target server. Make sure you use the correct value in your UPDATE statement.
Valid values are as follows:
Upgrading the Software - Oracle EBS Non-R12.2.x
Page 67 of 944
Proprietary to STR Software
 I = R12

J = R12.1+

The example below provides SQL to update the version to a value of ‘J’, indicating an R12.1+ system. Make
sure to use the correct value in your UPDATE statement.
UPDATE FAX_SETUP

SET VALUE='J'

WHERE FEATURE='ORACLE_IMPLEMENTATION';

In the following screenshot, the value of ‘I’ indicates that the Oracle EBS version is R12”

Execution
Unzip and Extract the AventX software
Upload all of the AventX software to the AventX host as the account that owns AventX and place the files in
the $FCHOME directory. The archive is named oa.standard.xxxx.tar.gz (or oa.<customer>.xxxx.tar.gz, if you
have custom functionality) where the xxxx is the version number. Unzip and extract the software from the
archive:

FTP the software to the AventX server into the $FCHOME directory.

$ cd $FCHOME

$ gunzip oa.*.tar.gz

$ tar –xvf oa.*.tar

Run the AventX “setup.sh” upgrade script

AventX is upgraded on the AventX host using a script named setup.sh. To execute the script, log in to the
AventX host as the proper user (e.g., aventx) and execute the following from the shell prompt:

$ cd $FCHOME/oa/ins (Use the full path to $FCHOME if the variable has been unset above.)

$ ./setup.sh

Upon executing setup.sh, you will be prompted to define which Oracle EBS instance you wish to upgrade.

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 68 of 944
Proprietary to STR Software
After specifying the Oracle EBS instance to upgrade, you will be asked a few questions about the AventX
environment and passwords. The APPS and SYSTEM database users are needed in many of the setup.sh
steps. Providing the passwords here for these users reduces the chances for typos, resulting in a faster and
smoother installation. The passwords are not stored in any file or database, only in memory; however, they
are used when necessary for the setup.sh steps. If you do not wish to enter the passwords here, you can hit
<Enter> when prompted to skip this step. If you do not enter the passwords here, you will be prompted, as
necessary, during each step of setup.sh.

Next, you will be provided with a main menu screen, as shown below:

The main menu screen provides you with a number of options, described in detail in this chapter. Each main
menu selection must be executed in proper order for successful upgrade of AventX.

Setup the AventX configuration file

Select option # 1 from the menu and ensure all questions are answered properly. The prompts will be pre-
populated with the current values from the .fcoa_cfg_<SID> file. You may change any of the values except the
Oracle database credentials (e.g. xxaventx/xxaventx).

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 69 of 944
Proprietary to STR Software
Prepare connector scripts for execution
Select Option # 2 from the menu. Making this selection from the main menu of setup.sh AventX will set the
proper permissions on the following types of files used by AventX:

• Log files and the directories which hold these files are given read, write and execute permissions.

• Shell scripts are given read and execute permissions.

• awk scripts are given read permissions.

• Report files are given read permissions.

• SQL scripts are given read permissions.

In versions 8.1.00+, global/world permissions have been removed from all permanent and temporary files
created by AventX.

Upon selecting “2” from the main menu, you should see similar information displayed on your screen as
shown below:

Use AventX to create the connector database user in Oracle

Select Option # 3 and a prompt to upgrade will appear. You must specify “Yes”. For upgrades, the Oracle
database user and tables already exist. Therefore, the existing AventX table data is preserved, the tables are
altered, and the table data is re-loaded with any necessary modifications to duplicate current functionality in
the newer version.

Select “3” from the main menu and hit enter. You will be prompted with the following:

Would you like to upgrade from an existing installation? (Yes,[No])

Type in “Yes” and then <Enter>. The script will automatically determine the version you are upgrading from
and prompt:

Automatically detected installed version <version>. Is this correct? ([Yes],No)

Please make sure the version indicated is correct before answering the prompt. Type <Enter> to select the
default value of “Yes”. If you specify “No”, step 3 will be skipped and you will be returned to the Main Menu.

Once you specify “Yes” (you will have one last chance to exit before the upgrade), the upgrade will be
automatically performed. Each action will be echoed to the terminal as well as written to the log files
$FCHOME/oa/database/<SID>/log, upgrade.output.audit.log, and upgrade.script.audit.log.

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 70 of 944
Proprietary to STR Software
If you encounter any errors during this step, exit the setup.sh script and contact STR Software technical
support immediately. Forcing the script to continue or attempting to correct the problem on your own may
result in an improper upgrade, requiring installation either from the backup or performing a fresh installation
of the new version.

Upon successful completion you will see the following:

Skip Option # 4
For upgrades, the portion of step 4 that is necessary for the upgrade is performed as part of step 3. The Main
Menu status for step 4 will automatically be updated when step 3 completes successfully. Continue with step
5.

Create the aventx views

AventX uses views to retrieve destination and document information from Oracle tables based on a number
of different criteria. Making this selection from the main menu of setup.sh will update the views of the tables
needed by AventX. The script connects using the cORACLE_LOGIN credentials in .fcoa_cfg_<SID> to update
the views.

Upon selecting “5” from the main menu, you should see similar information displayed on your screen, as
shown below:

The selection will now execute the $FCHOME/oa/ins/mkview.sh script to update the views. You will also have
two additional prompts to type <Enter> to continue. Note any error messages that are displayed on the
screen. These will also be written to the setup.log file. Upon successful completion you will see the following:

Step 5 completed without detectable errors or warnings.

[Press Enter to continue]

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 71 of 944
Proprietary to STR Software
Create aliases for the tables and views
Making this selection from the main menu of setup.sh AventX will update the synonyms for tables used by
AventX. The script connects as APPS to update the synonyms, and also grants select permissions on all other
tables used by AventX. The tables used by AventX may differ based upon your company’s document delivery
types and requirements.

Upon selecting “6” from the main menu, you should see similar information displayed on your screen, as
shown below:

The selection will now run sqlplus with the $FCHOME/oa/ins/fcstep3.sql file as its input to update the
synonyms and grants for the AventX tables, views, and stored procedures. Note any error messages that are
displayed on the screen. These will also be written to the setup.log file. Upon successful completion you will
see the following:

Step 6 completed without detectable errors or warnings.

[Press Enter to continue]

Create the AventX concurrent manager and forms tier scripts

Follow the instructions as outlined for this step in the “Running the AventX setup.sh script” Appendix A of this
document.

Configure AventX on the Oracle Concurrent Manager tier(s)

Follow the instructions as outlined for this step in the “Running the AventX setup.sh script” Appendix A of this
document.

Configure AventX on the Oracle Forms tier(s)

Follow the instructions as outlined for this step in the “Running the AventX setup.sh script” Appendix A of this
document.

Apply any applicable patches

Make sure to apply any applicable patches prior to testing the software. Contact STR Software Technical
Support to determine if there are any patches available for the AventX version being upgraded.

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 72 of 944
Proprietary to STR Software
Perform post-upgrade configuration
Follow the steps listed in the “Post-Upgrade Configuration” section of this documentation.

Back up any user submissions made during the upgrade

Navigate to the directory $FCHOME/oa/database/<SID>/dropoff, where <SID> is the name of your Oracle EBS
instance. If files are present with timestamps corresponding to your upgrade, we recommend backing up
these files:

$ mkdir copy

$ chmod 770 copy

$ cp * copy

It is possible for submissions to fail if post-upgrade configuration steps were not properly completed. Backing
up these files before starting AventX allows them to be copied in again if the submissions fail after starting up
AventX. This is possible especially when upgrading from pre-AventX for Oracle EBS 10 to AventX for Oracle
EBS 10+.

Start the software

Use the following commands to start the AventX processes:

$ cd $FCHOME/oa

$ ./aventxoc start

If you are still using AventX UNIX:

$ cd $FCHOME/cfg/scripts

$ ./startup.sh startall

Upgrading the Software - Oracle EBS Non-R12.2.x

Page 73 of 944
Proprietary to STR Software
Post-Upgrade Steps
The following are some of the post upgrade steps that should be performed. Some of these steps are only
applicable to certain AventX modules

All AventX Modules

The following are tasks, features, and configuration settings that STR Software recommends all customers
have in place to make full use of the AventX for Oracle EBS software. If upgrading from a version prior to
10.0.00, many of these configuration settings must be migrated from .fcoa_cfg or .fcoa_cfg_<SID> to the
AventX Configuration (System Administrator → Install → AventX → Configuration or AventX Administrator →
Configuration) or AventX Document Configuration (System Administrator → Install → AventX → Document
Configuration or AventX Administrator → Document Configuration) forms.

(Conditional) - Apply license key in Configuration Form

If upgrading from an AventX for Oracle EBS version prior to 10.0.00, you must migrate the license key from
$FCHOME/.fcoa_cfg or .fcoa_cfg_<SID> to the AventX Configuration (System Administrator → Install →
AventX → Configuration or AventX Administrator → Configuration). The existing license key is
cLICENSE_STRING within .fcoa_cfg or .fcoa_cfg_<SID> (use the license key from STR Software if it was
necessary to obtain one for your new version). Apply the license key on the License Keys tab as shown below,
and select Check for Valid Key to validate the license:

Upgrading the Software - Post-Upgrade Steps

Page 74 of 944
Proprietary to STR Software
(Conditional) - Perform Post Upgrade Cleanup

Run the following SQL statement as the appropriate user (i.e. xxaventx) to update preexisting rows in the
FAX_STATUS table to correctly reflect the new default HTTP port number of 6055:
update fax_status set FAX_AXD_HTTP_PORT = '6055' where FAX_AXD_HTTP_PORT = 'XXXX';

where XXXX is the port number prior to upgrading (default = 6056).

Older versions (pre version 10.0.00) of the software contains files and folders that are no longer used. These
files and folders can be cleaned up because they are no longer used:
$ rm -rf $FCHOME/oa/fcoastat/scripts

$ rm $FCHOME/tmp/*fcoastat*

$ rm –rf $FCHOME/oa/util/fcconclient

$ rm –rf $FCHOME/oa/database/*/fcconclient

$ rm –rf $FCHOME/oa/share

$ rm –rf $FCHOME/oa/fcdmi

$ rm –rf $FCHOME/oa/fcpoa

$ rm –rf $FCHOME/oa/fcai

$ rm –rf $FCHOME/oa/fcdi/scripts

$ rm –rf $FCHOME/oa/extproc

$ rm –rf $FCHOME/oa/axoc_submit.sh

$ rm –rf $FCHOME/oa/ins/webmgr.sh

$ rm –rf $FCHOME/oa/ins/license.sh

$ rm –rf $FCHOME/oa/ins/xxstr*.tar (except xxstrJavaControllers.tar and

xxstrJSP.tar)

Upgrading the Software - Post-Upgrade Steps

Page 75 of 944
Proprietary to STR Software
(Recommended) - Configure Administrator Email Alerts

STR Software recommends migrating the value of cERROR_MAIL_ADDRESS from $FCHOME/.fcoa_cfg_<SID>

into the field for error.mail.address in the AventX Configuration form under the General Config tab.

This is an administrator email address you would like to be alerted in the event of a processing error in
AventX for Oracle EBS.

You can also specify whether to append a log file to these error e-mails. STR Software recommends migrating
the value of cERROR_MAIL_APPEND_LOGFILE within $FCHOME/.fcoa_cfg_<SID> into the field for
error.mail.append.log as shown above. Valid values are “Yes” or “No”.

In the event the AventX administrator only wants to receive severe or fatal error events notification, set
error.mail.verbose to “No”. This will disable all general processing error notifications that would otherwise
be sent to the email address defined in error.mail.address field. This value defaults to “Yes”.

Upgrading the Software - Post-Upgrade Steps

Page 76 of 944
Proprietary to STR Software
(Recommended) - Configure other variables

STR Software recommends configuring the max.docs variable on the General Config tab of the AventX
Configuration Form. This environment variable determines the maximum number of documents that AventX
may process for a single concurrent request, and prevents users from accidentally submitting requests that
contain too many documents.

This value was previously set via the iDEFAULT_MAXDOCS variable within .fcoa_cfg_<SID>. A value of “0”
indicates that no limit should be enforced on the number of documents per request.

Upgrading the Software - Post-Upgrade Steps

Page 77 of 944
Proprietary to STR Software
This variable can also be set at a per document level under the AventX Document Configuration form (this
will override the global max.docs value):

This is the equivalent of the i<doctype>_MAXDOCS variable previously found in .fcoa_cfg_<SID>:

(Conditional) – Update any Add Document recipient queries with a Union

If there is a Union the query must take into account the new fields of Printer and EBS User.

(Recommended AventX for Oracle eAM Customers) – Enable the AventX Delivery Status Web Client

Upgrading the Software - Post-Upgrade Steps

Page 78 of 944
Proprietary to STR Software
(Recommended) - Enable AventX for Oracle EBS to Start Automatically upon Startup

The following instructions can be used to configure AventX for Oracle EBS to automatically after the AventX
server is rebooted.

Linux < v7.x (init.d)

Copy $FCHOME/oa/aventx_for_oracle_ebs into /etc/init.d as root.

$ chown root:root /etc/init.d/aventx_for_oracle_ebs

$ chmod 755 /etc/init.d/aventx_for_oracle_ebs

Add the script to init.d (chkconfig --add aventx_for_oracle_ebs) and verify the configuration change took
place:
$ chkconfig --list | grep aventx

Linux v7+ (systemd)

Copy $FCHOME/oa/[email protected] into /etc/systemd/system as root

$ chown root:root /etc/systemd/system/[email protected]

$ chmod 755 /etc/system/system/[email protected]

For each instance of AventX Oracle Connector, run this command and replace ‘INSTANCE’ with the Instance
name as configured in AventX:
$ systemctl enable [email protected]

Verify the change was enabled:

$ systemctl list-unit-files --type=service | grep “aventx”

(Recommended) – Enable AventX Web Client

See Section Registering AventX Web Client for more information.

AventX Oracle Connector Module

(Conditional) - Verify accuracy of CUSTOMER and SUPPLIER contact data

If the AventX Oracle Connector software is being used with the AventX seeded CUSTOMER and SUPPLIER
recipient queries then an evaluation of those queries should be performed as they may have changed during
the upgrade. If using any of the seeded destination queries VENDOR, VENDOR CONTACT, or CUSTOMER,
ensure that all of the data requirements have been met. There are changes from Oracle EBS version to
version, as well as potential changes within AventX for Oracle EBS. Failure to meet the specific requirements
will result in these destination queries not returning expected/desired results. You can verify whether these
queries changed by viewing the “Seeded Queries and Data Entry Requirements” in the AventX for Oracle EBS
Resource Guide.

Upgrading the Software - Post-Upgrade Steps

Page 79 of 944
Proprietary to STR Software
Upgrading the Software - Post-Upgrade Steps
Page 80 of 944
Proprietary to STR Software
(Conditional) - Verify AventX directory scanning configuration

If upgrading from version 9.x or earlier, then it is required to remove the following information from the
$FCHOME/cfg/scripts/dirscan.cfg file:

<scan>

Path $FCHOME/oa/database/<SID>/scan

Pattern *.PCL

Execute $FCHOME/oa/fcdi/scripts/submit.sh <SID>

</scan>

<scan>

Path $FCHOME/oa/database/<SID>/scan

Pattern *.PDF

Execute $FCHOME/oa/fcdi/scripts/submit.sh <SID>

</scan>

<scan>

Path $FCHOME/oa/database/<SID>/scan

Pattern *.PS

Execute $FCHOME/oa/fcdi/scripts/submit.sh <SID>

</scan>

<scan>

Path $FCHOME/oa/database/<SID>/scan

Pattern *.TXT

Execute $FCHOME/oa/fcdi/scripts/submit.sh <SID>

</scan>

<scan>

Path $FCHOME/oa/database/<SID>/scan
Upgrading the Software - Post-Upgrade Steps
Page 81 of 944
Proprietary to STR Software
 Pattern *.HTML

Execute $FCHOME/oa/fcdi/scripts/submit.sh <SID>

</scan>

<scan>

Path $FCHOME/oa/database/<SID>/dropoff

Pattern *.scan

Workers 2

Sort FIFO

Execute $FCHOME/oa/axoc_submit.sh <SID>

</scan>

Upgrading the Software - Post-Upgrade Steps

Page 82 of 944
Proprietary to STR Software
AventX Attachment Xpress for eAM Module
(Conditional) - Update the AventX Controllers

If using the AventX Print Xpress or the AventX Attachment Xpress for eAM module, then you must replace the
AventX custom controllers and bounce Oracle Applications. Perform the following steps as the UNIX account
that owns the files/directories in $JAVA_TOP (typically “applmgr”). If running Oracle EBS R12.2+, these steps
must be performed during the prepare phase of a patching cycle, and against the PATCH file edition:

3. Copy $FCHOME/oa/ins/xxstrJavaControllers.tar from the AventX host into the Oracle Applications
$JAVA_TOP.

$ cd $JAVA_TOP

$ tar –xvf xxstrJavaControllers.tar

(Conditional – if running Oracle EBS R12.2+) $ adcgnjar

4. Bounce Oracle Applications.

(Conditional) - Remove AventX UNIX (Fax and Email) Software

Do not perform this step if faxing and emailing documents through AventX from Oracle EBS.

If upgrading from version 9.x or earlier AND the AventX Attachment Xpress for eAM software is the only
software module being used, i.e. not using the AventX Oracle Connector to fax, email, print and archive
documents, then it is permissible to remove the AventX UNIX file system objects entirely, as this product is no
longer required in conjunction with AventX Attachment Xpress.

Stop the AventX UNIX software.

$ fcmgr –admin –c stop

Ensure the processes are no longer running

$ fcmgr –admin –c listconfig

The execution status should be “Inactive.”

Remove the following files and folders that are no longer required. DO NOT remove $FCHOME/oa or
$FCHOME/.fcoa_cfg_*, as these are required for AventX Attachment Xpress.

aventx.*.*.tar

axapi.xml*

backup

bin
Upgrading the Software - Post-Upgrade Steps
Page 83 of 944
Proprietary to STR Software
cfg

chklice

config

convert*

dat

db.fc*

dbfilelist

demo

fax

fifo

filelist

files.fc*

gunzip

install

java

LICENSE*

logs

permit.tst

README

rpt

setup

tmp

web

Edit $HOME/.profile or $HOME/.bash_profile and remove the following lines:

Upgrading the Software - Post-Upgrade Steps

Page 84 of 944
Proprietary to STR Software
Execute the following command to unset the FCHOME environment variable:

$ unset FCHOME

An undefined value for the $FCHOME environment variable will allow setup.sh to automatically set it in
$HOME/.bash_profile or $HOME/.profile (depending on your default shell). If FCHOME is not set
automatically as expected, you may manually add this line to either $HOME/.bash_profile or $HOME/.profile:

$ export FCHOME=<path to AventX install>

(Conditional) - Migrate fcconclient configuration file information to the Configuration Form

If submitting Work Orders with attachments and upgrading from a version prior to 10.0.00, you must migrate
the configuration settings within $FCHOME/oa/database/<SID>/fcconclient/cfg/ fcconclient.<SID>.conf to the
AventX Configuration form. The fcconclient feature is no longer used in version 10.0.00+ of AventX for Oracle
EBS. Any custom entries in fcconclient.<SID>.conf must be manually migrated to the Attachment Printing
Config and Translation Servers tabs of the AventX Configuration form.

Upgrading the Software - Post-Upgrade Steps

Page 85 of 944
Proprietary to STR Software
In the Translation Server Hostname field, enter the name of the machine where AventX Translation Server is
installed. For additional details, contact STR Software support.

Upgrading the Software - Post-Upgrade Steps

Page 86 of 944
Proprietary to STR Software
(Conditional) - Update the Work Order Report Parameters

For customers upgrading from a version prior to 9.1.00 who are using AventX for Oracle EBS or AventX
Attachment Printer for processing of the Work Order document type:

The upgrade introduces a change to the “Job ID Report Parameter” setting for processing of Work Order
documents. This setting is located on the Work Order Specific UI canvas for the Work Order document type
via the AventX Document Configuration form:

This change was implemented for E3135, causing the value of this parameter to be incremented by +2.
Therefore, the following values are now required for this parameter:

• For Oracle versions R12 and R12.1.3 (early releases), the value should now be 23.
• For Oracle R12.1.3 versions (later releases), the value should now be 24.
• For Oracle version R12.2+, the value should now be 25.

(Conditional) - Update Seeded Work Order Queries

If using the AventX Attachment Xpress for eAM module and upgrading from a version prior to 9.2.00, then
you must manually update the seeded attachment query(s) to support the new “restrict attachments”
feature. In Oracle EBS, access the AventX Document Configuration form (as either the System Administrator
or AventX Administrator responsibilities), look up the Work Order document type, and click Find/Add:

Navigate to the “Attachment Query” tab.

Select the “Maintenance Work Orders/Maintenance Work Order Attachment Query” and select Edit Query.
Upgrading the Software - Post-Upgrade Steps
Page 87 of 944
Proprietary to STR Software
Change the “FROM” clause to:

wip_entities wip

Change the “WHERE” clause to:

wip.wip_entity_name = :UID1 and ((wip.organization_id = (select fnd.argument10

from fnd_concurrent_requests fnd where fnd.request_id = :REQUESTID)) or
(wip.organization_id = :UID2))

For cases where you may have also entered queries for Operation and Asset attachments, you should change
the “FROM” and “WHERE” clauses:

For Operation Queries:

FROM clause: apps.wip_operations wo, wip_entities we

WHERE clause: we.wip_entity_name = :UID1 and ((we.organization_id = (select
fnd.argument10 from fnd_concurrent_requests fnd where fnd.request_id =
:REQUESTID)) or (we.organization_id = :UID2)) and we.wip_entity_id =
wo.wip_entity_id

For Asset Queries:

FROM clause: apps.eam_work_orders_v wip

WHERE clause: wip.wip_entity_name = :UID1 and ((wip.organization_id =
(select fnd.argument10 from fnd_concurrent_requests fnd where
fnd.request_id = :REQUESTID)) or (wip.organization_id = :UID2))

Select Validate to test each of the queries, then OK save your changes.

Upgrading the Software - Post-Upgrade Steps

Page 88 of 944
Proprietary to STR Software
(Recommended) - Configure dynamic page stamping

Customers who are using the AventX software to print attachments along with the Oracle concurrent request
output should consider configuring dynamic page stamping by passing additional information in the AventX
Document Configuration form:

Upgrading the Software - Post-Upgrade Steps

Page 89 of 944
Proprietary to STR Software
Configuring Software Modules
AventX for Oracle EBS

AventX Introduction
The AventX for Oracle EBS software (also referred to as the AventX Oracle Connector software) provides the
ability to delivery any document from virtually any place within Oracle EBS. It offers two primary methods of
delivering documents. Other methods are discussed throughout this section. These methods may be specific
to certain modules of Oracle EBS, i.e. Purchasing, Receivables, etc. These module specific sections are noted
throughout this section in the table of contents.

• Automatic Delivery (Batch – Multiple Documents within a Single Request)

• Interactive Delivery (Single – One Document within a Single Request)

User Experience
Interactive Delivery

AventX Interactive Delivery provides a standard document delivery interface for the users inside of Oracle
EBS. It looks like the following:

Users will benefit from the following key features when using the AventX Interactive Delivery submission
method.

• Users can change the default SUBJECT

Configuring Software Modules - AventX for Oracle EBS

Page 90 of 944
Proprietary to STR Software
• Users can enter in information they would like to include in the email message body
• Select a message template that will apply dynamic text to an email or fax cover page
• Add additional destinations from an Oracle EBS address book
• Send documents to unlimited email address, fax numbers or print destinations
• Add a terms and conditions file or other types of attachments
• Receive a delivery confirmation report to five different email addresses
• And more…
There are two ways users can submit documents using the AventX Interactive technique.

1. From the Oracle Submit Request form

2. From an Oracle Menu using the AventX icon
Submitting from Oracle Submit Request

Whether you're using Automatic, Interactive, or Print Delivery, the first step, referred to as "document
submission", is very similar to your present process for printing documents. Users will follow these basic
steps.

1. Log into Oracle EBS

2. Select a Responsibility that can run the desired report
3. Select “Submit Request”
4. Fill in the report parameters
5. Select “Options”
6. Select the AventX printer
7. Submit to the Concurrent Manager for processing
8. Concurrent Manager then hands off the document to AventX for delivery
Let’s follow an example all the way through.

Configuring Software Modules - AventX for Oracle EBS

Page 91 of 944
Proprietary to STR Software
Run the report and fill in the report parameters

After logging into Oracle EBS, choose to run a report. On the Submit a New Request form you can select
either the Single Request or Request Set and click OK to go to the Submit Request form. Select a report and
enter the parameters as you normally would to print the report.

Configuring Software Modules - AventX for Oracle EBS

Page 92 of 944
Proprietary to STR Software
This example is a single report that contains several Purchase Orders (PO #5382-5384).

However, do not press Enter or click the Submit button. Instead, click the Options... button to go to the Upon
Completion... form.

Configuring Software Modules - AventX for Oracle EBS

Page 93 of 944
Proprietary to STR Software
Select the AventX Style

Click in the “Style” field and select the appropriate style name from the pick list. If you have questions
concerning the correct print style to select, see your Oracle EBS administrator.

Configuring Software Modules - AventX for Oracle EBS

Page 94 of 944
Proprietary to STR Software
Select the AventX Interactive Printer

Next, you will select the AventX Interactive Printer. The AventX Interactive printer is used when submitting a
single report (sometimes referred to as "one-off") and the user desires to specify/modify destination
information prior to submission.

Selecting this printer will automatically trigger the AventX Interactive Delivery form to open. If the AventX
Interactive Delivery form does not open and populate destinations automatically, you do not want to type
<Enter> or click the OK button at this point. The necessary address information has yet to be “defined”. If
you type <Enter> or click the OK button, your report will not be delivered to the desired destination, but will
result in a FATAL error, which will be posted to the AventX Delivery Status form (discussed later).

If destination information already exists for this request, as will be the case for a copy request that previously
used Interactive Delivery, you will have the choice to either open the form with the existing destination
information or have the software query Oracle for the destination information.

Configuring Software Modules - AventX for Oracle EBS

Page 95 of 944
Proprietary to STR Software
Description of Fields

Subject Field

By default, this parameter contains the document type and document number (e.g. PO number) when the
report consists of a single document. This value can be manually defined by typing in the desired string. This
value is important when the delivery destination is an email address as it is the data for the SUBJECT field of
the email.

Options Section

Terms and Conditions, Hold, and XML Archive Connection Check Boxes

The Options section allows you to include Terms and Conditions with your document, allows you to place the
document on hold in the document delivery system’s queue for review before being delivered, and allows a
copy of the document to be deposited into a directory for archiving by a third-party archiving solution.
Default values may have been pre-set by your document delivery system administrator, but can be
overridden by checking / un-checking the appropriate box. Profile options can be used to allow/disallow
these options to be changed on the AventX Interactive Delivery form. If disallowed, the option will have its
configured default value, but be grayed out and inaccessible for change.
Destinations Tab

The tabs control the parameters entered to specify information regarding Destinations of the document,
Acknowledgement email addresses, Message Template selection and remarks, and Attachment selection.
Depending on the selection, different fields on the form are displayed to allow you to enter the appropriate
information.
Pick List From

Configuring Software Modules - AventX for Oracle EBS

Page 96 of 944
Proprietary to STR Software
The following values are available when clicking on this field.

• Customers by Company
• Customers by Name
• Employees
• Users
• Vendors
• Vendor Contacts

You may wish to send your document to more than one destination. For example, you may need to send a
Purchase Order to the vendor, and also have a copy delivered to your company headquarters at a different
location. The AventX Interactive Delivery form allows you to specify an unlimited number of destinations.
By default, the destination information for Secure Email , Destination, Name, Company and Printer is
populated based on the configuration for the document (via the AventX Document Configuration and AventX
Connector Configuration forms).

AventX Oracle Connector provides the option of secure email delivery for email destinations. Destinations
enabled for secure email delivery will have the Secure Email box (denoted by the column on the form)
checked. You may freely change this value by checking or un-checking the box next to the email destination.
However, please take caution if you uncheck the box. If it is checked by default when the form is originally
invoked, then your system administrator has setup this destination to receive secure email. “Reversing” this
decision may not be a wise choice, as the destination obviously is expecting a secure email transmission.

The Printer field is available for change only if the destination is “PRINT ONLY”. The pick list for the Printer
field is for all configured printers in Oracle EBS.

Configuring Software Modules - AventX for Oracle EBS

Page 97 of 944
Proprietary to STR Software
These parameters can also be populated from other Oracle tables, based on your version of Oracle EBS, and
AventX Connector configuration settings. (See your system administrator for details). Simply select the
desired source from the pull-down list, click in the desired Destination field and type CTRL-L for the Oracle
EBS pick list. You can focus the pick list by entering any portion of the search string. Select your desired
addressee and type <Enter> or click the OK button. See the figure below.

Acknowledgements Tab

The AventX software can be configured to send an email with information on whether a document was sent
successfully or unsuccessfully. Most companies configure this feature for only unsuccessful, or failed
deliveries. This is a nice feature for users because quickly tells you about any errors in delivering the
document. Email addresses can automatically be populated by the AventX configuration or you can type in
Configuring Software Modules - AventX for Oracle EBS
Page 98 of 944
Proprietary to STR Software
an email address manually. You may wish to add or delete the entries as displayed in the list. You can
configure up to 5 different people to receive an acknowledgement from your document delivery system once
the document has been delivered. This is accomplished by manually entering each email address and name
in the fields provided.

Message Template Tab

Use the pull-down list to select from available message templates. See your document delivery system
administrator for more information on use of message templates.

If you are using a message template with your documents, you can enter text to be placed on the message
template. For faxes, you can specify up to 40 lines of text. For emails, you can specify an unlimited number
of lines of text.

Configuring Software Modules - AventX for Oracle EBS

Page 99 of 944
Proprietary to STR Software
Attachments Tab

This tab provides information regarding attachments associated with this document to be delivered by
AventX Connector. Adding attachments is only available when using AventX Interactive Delivery from an
Oracle Menu item, so if the “Add Attachments” button is greyed out then you are likely submitting the
document from “Submit Request” and not from the “Oracle Menu”. Users can delete attachments if they
don’t want them delivered with the document. To delete an attachment, click on any field in an attachment
“row” and then click the <CTRL>+<Up> keys.
Deleting attachments on this form cannot be undone on this “active” form. To regain the deleted
attachment(s), exit the form via the <Cancel> button and re-enter it. You will lose all deletions specified to
this point. The default attachment list will then be restored, and you can delete from this list as you wish.

Configuring Software Modules - AventX for Oracle EBS

Page 100 of 944
Proprietary to STR Software
Submitting Your Request

After entering or modifying the destination data, click on the <Submit> button to save the information and
return to the Upon Completion... form. Clicking on the <Cancel> button will not save any of the address
information or other changes and will return you to the Upon Completion… form.

You will notice that the Copies field on the Upon Completion form contains an unusual value and is now
inaccessible (“grayed out”). The “label” of the field may be customized (e.g. AventX). This field is used by
AventX Connector to store a unique sequence number associated with this document’s submission.
Therefore, the Copies field no longer indicates the number of copies being generated. Instead, this unique
number enables AventX Connector to synchronize your output data file with the address information that
you supplied via the AventX Interactive Delivery form earlier.

If you use the “Copy a Prior Request” from the Submit Request form and select a report that was submitted
via Interactive Delivery and change to redirect to an actual printer, remember to change the number of
copies. Otherwise, you will get more copies than you intended!

Configuring Software Modules - AventX for Oracle EBS

Page 101 of 944
Proprietary to STR Software
Submit to the Concurrent Manager

After specifying the correct style and printer you must submit the request to the concurrent manager for it to
be processed by AventX Connector. We'll continue using the example for Automatic Delivery; the steps are
the same from this point if using Interactive or Print Delivery.

Click the <Submit> button to submit the request to the concurrent manager. If you click the <Cancel > button
the report will not be run.

Make note of the Request ID assigned by the concurrent manager for this report. You can monitor the
progress of your report in the concurrent manager as with any other report request via the Reports View
Requests form. The “Running > Normal” status indicates Oracle is still running the request and it has not yet
finished creating the report output and handed the document over to AventX.

It is important to note that there are several other steps involved after completion of the report by the
concurrent manager prior to this document being delivered. There is more information on how to track the
delivery of the document later in this document.

Configuring Software Modules - AventX for Oracle EBS

Page 102 of 944
Proprietary to STR Software
Submitting from the Oracle Menu Items

This method is very similar to the Submit Request process just described. The main difference here is the
user invokes the AventX Interactive Delivery form from the Oracle Menu by clicking an icon. This section will
point out a few benefits and differences between this method and the method of submitting from Submit
Request.

You will create the document as you normally would. For this example we will use the Purchase Order as our
document; however this method can be used to submit documents to AventX for virtually any other
document type, i.e. Sales Orders, Invoices, etc.

Configuring Software Modules - AventX for Oracle EBS

Page 103 of 944
Proprietary to STR Software
The following outlines the basic steps for using this method.

Click the AventX Icon from the Menu Item

After saving final changes on the Oracle form, click the AventX icon to begin the delivery process of your
document.

Upon clicking the AventX icon, the AventX Interactive Delivery form is invoked. This form provides the
same functionality as described in using AventX Interactive delivery from Submit Request.

By default, the parameters on the form are pre-filled with data from the Oracle tables, based on the
configuration specified for AventX Connector. The only required parameter is the Destination. The other
parameters are useful for message templates, document search criteria and document delivery reporting
information. Any of the parameters may be modified prior to submission for processing.

Configuring Software Modules - AventX for Oracle EBS

Page 104 of 944
Proprietary to STR Software
Add Attachments

As previously discussed, the Attachments tab includes information regarding attachments that are associated
with this document as configured. Therefore, it is possible that the list displayed here is only a subset of
attachments that areassociated with the document.

You have the option to add attachments to be included with your document’s delivery by clicking the <Add
Attachments> button. The act of adding attachments using this button only includes the additional file(s) with
the document’s delivery for this submission. It does not store the file(s) as a permanent attachment
associated with this document. It adds it temporarily to the delivery.

Configuring Software Modules - AventX for Oracle EBS

Page 105 of 944
Proprietary to STR Software
Upon clicking the <Add Attachments> button, the standard, Oracle EBS Attachments form is displayed,
allowing you to specify new attachments to be included in your document’s delivery, just as you normally
would if you were actually adding attachments to your document. The only difference is that this is only
temporary for purposes of adding the attachment(s) to this submission of your document.

You will notice that the Entity Name on this form indicates that the documents added here are only for
AventX Stand Alone Interactive Delivery. The Category pick lists will display only those categories registered
and tied to the AventX Interactive Delivery form.

Configuring Software Modules - AventX for Oracle EBS

Page 106 of 944
Proprietary to STR Software
In this example the “Add Attachment” button was clicked and the file “test.docx” was added.

The <Add Attachments> functionality appends the newly defined attachments (as rows) to the end (as the
next row) of the existing attachments on the AventX Stand Alone Interactive Delivery form. The order of the
attachments in the submission (i.e. the fax, email, print, and/or archive destination) will be as shown, top to
bottom, on the AventX Stand Alone Interactive Delivery form. It is not possible to reorder the attachments
using the AventX Stand Alone Interactive Delivery form.

After you have specified your new attachment(s), make sure to save your changes, before exiting the
Attachments form. The AventX Stand Alone Interactive Delivery form is displayed, and now includes the
attachment(s) that you added.

Subsequent “visits” to the Oracle Attachments form (by clicking the <Add Attachments> button again) will
display all currently added attachments (from a previous <Add Attachments> operation. These attachments
may be re-adjusted, deleted, new attachments added etc., according to standard Oracle functionality.

Submit to the Concurrent Manager

Once you have specified the information for all of the desired tabs, you can submit your request. Remember,
only the Destination parameter on the Destinations tab is required; however, all of the address data is passed
to your document delivery system, and is also displayed on the message template (when used).

Sender information (such as Sender Name, Company and Email address) is automatically set based on your
AventX Connector configuration.

After entering or modifying the destination data, click on the <Submit> button to begin the delivery process
of your document. A request ID will be displayed, indicating that the information that you entered has been
submitted as a concurrent request. Make a note of this Request ID, as you will need it to track your
document’s transmission.

Configuring Software Modules - AventX for Oracle EBS

Page 107 of 944
Proprietary to STR Software
Copying a Request

AventX Connector supports the copy and existing request. When you copy a request, you may choose to
either submit the request with the existing destination information, or change the destination information
and create a new submission. If you intend to change the destination information prior to submission then
launch the Interactive Delivery form by clicking on the copies. The user now has two choices.

• Submit the request without changing any information (destination, message template, subject, etc).
This can be done simply clicking on “Submit” after the report has been select.

OR

Configuring Software Modules - AventX for Oracle EBS

Page 108 of 944
Proprietary to STR Software
 • Display the Interactive Delivery form again and verify the information is accurate. You can do this by
clicking the “Options” button and then click in the AventX field and the Interactive Delivery form will
appear. There is now a choice to use the existing data or allow AventX to run the queries again to
display the default information.

Use Existing Button

This button will remember the information used for the previous and display it on the screen for you to
validate whether you want to send it again.

Use Default Button

This button will run the default queries again.

Automatic Delivery

Using the AventX Automatic Printer involves the same basic steps as using the AventX Interactive Printer.

Users will follow these basic steps.

• Log into Oracle EBS

• Select a Responsibility that can run the desired report
• Select “Submit Request”
• Fill in the report parameters
• Select “Options”
• Select the AventX Automatic printer
• Submit to the Concurrent Manager for processing
• Concurrent Manager then hands off the document to AventX for delivery

Configuring Software Modules - AventX for Oracle EBS

Page 109 of 944
Proprietary to STR Software
The main difference is the user selects a different printer and a form to submit a single document to AventX
does not appear.

Automatic Delivery is typically used when submitting a group or "batch" of reports, all of the same document
type. The Oracle EBS concurrent manager will create one large output file (typically PDF) that will be passed
to AventX to separate into individual files. AventX then determines where to send the document based on
how the document is configured in AventX.

As a user you need to make sure the number of copies must be at least "1"; otherwise no report output will
be generated for this request. For number of copies greater than one, AventX Connector will print the
additional copies when the default delivery method is "P" (PRINT).

It is important to note that if the number of copies is greater than one, the actual number of printed copies
received will be decremented by 1, because AventX Connector must use one of the copies to generate the
deliverable document(s).

You may specify additional options to be performed upon completion. When finished, type Enter or click the
OK button to return to the Submit Request form.

If you click the Cancel button, none of your completion options will be saved and you will be returned to the
Submit Request form.

Configuring Software Modules - AventX for Oracle EBS

Page 110 of 944
Proprietary to STR Software
Scheduling a Request

This is the most common way users automate the delivery of documents. This technique will eliminate the
steps outlined above. In this method requests will automatically be submitted to AventX without any user
involvement. Use the following steps to schedule a report to automatically submit to AventX Automatic.

• Pick your report and fill in the parameters to use each time the request is submitted to AventX.

• Click “Options” and select the AventX Style and AventX Automatic printer.

• Click “Schedule”

• Create a schedule. Click “Save this Schedule,” and AventX will process this Concurrent Request
according to the configured schedule. See the example below:

Configuring Software Modules - AventX for Oracle EBS

Page 111 of 944
Proprietary to STR Software
Document Delivery Status

Once your documents have been submitted to AventX, their delivery is automatic and requires no further
user intervention. Users typically wish to know what is happening with your documents at any point in time
before you receive the notification. You need a way to be able to monitor and manage their delivery within
the document delivery system.

AventX provides several features that allow users and administrators access to information about the
document’s status.

• AventX Delivery Status Form

• AventX Delivery Status Web Client
• Email Notifications
Status Form

This form allows users to quickly query on the delivery status of a document. The AventX Delivery Status form
can be accessed from three different areas of Oracle EBS

• From the “View Request” form

• From the main “Navigator” form

• From an Oracle Menu item

These methods are discussed in detail in the “AventX Delivery Status Form” section.

Web Client

The AventX Delivery Status Web Client shares many features with the AventX Delivery Status form and allows
users to quickly query on the delivery status of a document. However, the Web Client functions outside of
the Oracle EBS Forms interface. The AventX Delivery Status Web Client can be accessed from the following
locations:

• An Oracle Menu item on the self-service page

• A button at the bottom of the Work Order Report page in Oracle Asset Management (only for
instances using a valid AventX Attachment Express license)

• Directly from a browser using http(s)://<aventx host>:<aventx port>

For directions about configuring an Oracle Menu item to this feature, see the “AventX for Oracle EBS
Installation Ugrade Guide.

Configuring Software Modules - AventX for Oracle EBS

Page 112 of 944
Proprietary to STR Software
Email Notifications

Users and Administrators can receive email delivery confirmations and notifications when documents are
transmitted successfully and unsuccessfully. The following is an example of an email delivery notification
from AventX.

The following is a description of the information in this email.

• Subject = The subject typed in by the user or automatically applied by the AventX software.

• ID Field = The unique ID assigned to the document by AventX7

Configuring Software Modules - AventX for Oracle EBS

Page 113 of 944
Proprietary to STR Software
• Company = If the AventX configuration for your document pulls this information from Oracle then the
company name for the recipient will be displayed here.

• Destination = The email address or fax number the document was sent to

• Pages = Relevant on to fax transmissions

• Organization ID = This is the Oracle EBS ORGID the document originated from

• ERP Tracking Number = The Oracle EBS concurrent manager request ID

• ERP System = A value taken from Oracle EBS that identifies the environment the document was
transmitted from. Helpful in troubleshooting problems.

• Document Type = A code assigned to each document configured in AventX. It is a unique

configuration identifier.

• Device Used = The device used in AventX UNIX to transmit the document.

• Status = The details of the transmission status.

• Need help troubleshooting? = This will only be displayed if the document encounters and error
message. Click on the link to log into the STR Software Customer Support Portal

Configuring Software Modules - AventX for Oracle EBS

Page 114 of 944
Proprietary to STR Software
If you receive an error message from an email alert and want to retransmit the document then following
these steps.

Copy the AventX ID, i.e. CAAA0000 from the email and go to the Delivery Status form in Oracle EBS

Paste the ID into the ID field and click “Find”

Highlight the record that shows the failure and click on “Modify Document”. This will launch the AventX
WebManager and allow you to send the document again.

Configuring Software Modules - AventX for Oracle EBS

Page 115 of 944
Proprietary to STR Software
Installation

Installation steps for the AventX Oracle Connector software can be found in the “AventX for Oracle EBS
Installation and Upgrade Guide”.

Configuration
Oracle EBS Configuration

Registering the AventX Forms

The AventX Oracle Connector creates several Oracle forms as part of the installation. These forms are
compiled and placed into the Oracle file system. They need to be registered in Oracle EBS so they can be used
to configure the AventX software.
Registering a form in Oracle E-Business Suite associates the form executable filename with a friendlier display
name for the form. The form must be registered before the menu item can be created. Follow these steps to
register the AventX forms:
• Log in to Oracle Applications with the Application Developer responsibility.
• Select Application, then Form to bring up the below form.

Use the following table to help with the data entry required when registering the AventX forms. For all
forms, the application should be the CUSTOM application that was created during the “Pre-Installation”
software installation steps, e.g., “AventX for Oracle EBS”. If the forms were put into $FND_TOP as part of the
software installation then you will want to use “Application Object Library” for the “Application” field.

Form Application User Form Name Description

FCOAXCFG AventX for AventX Configuration This form is used to configure the
Oracle EBS default parameters for Options,
Destinations, and Acknowledgements

Configuring Software Modules - AventX for Oracle EBS

Page 116 of 944
Proprietary to STR Software
 Form Application User Form Name Description
for each organization and each
document type.

FCOAAYOD AventX for AventX Document This form is used to define documents,
Oracle EBS Configuration including destination and
acknowledgement queries, to be
processed by AventX using Interactive
and/or Automatic Delivery.

FCOASBMT AventX for AventX Interactive Delivery This form is used for the Interactive
Oracle EBS Delivery submission method, whereby
the user may specify the destination
address(es), acknowledgement
information, message template remarks
and attachments for the current
submission of the report.

FCOASAID AventX for AventX Stand Alone This form is used for the Stand Alone
Oracle EBS Interactive Delivery Interactive Delivery submission method,
whereby the user may specify the
destination address(es),
acknowledgement information,
message template remarks, and
attachments for the current submission.

FCOASTAT AventX for AventX Delivery Status This form is used to display the delivery
Oracle EBS status of documents processed via the
AventX.

FCOATEST AventX for AventX API Test This form is used to test out calls
Oracle EBS against the AventX API (useful if this
option has been purchased). Refer to
the AventX API Resource Guide for
details.
1. Select File, then Save from the menu and close the Forms window.

Configuring Software Modules - AventX for Oracle EBS

Page 117 of 944
Proprietary to STR Software
Creating the AventX Form Functions

The structure of Oracle EBS dictates that each menu item be linked to a particular Function. This Function is
then associated with the form so that selecting the menu item ultimately causes the form to activate. Follow
these steps to define a function for the AventX forms:

As Application Developer under Application, select the Function menu item. Choose the Description tab.

Description Tab

Enter data into the Description tab according to the table below:

Function User Function Name Description

FCOA_FCOAXCFG AventX Configuration AventX Configuration

FCOA_FCOAAYOD AventX Document Configuration AventX Document Configuration

FCOA_FCOASBMT AventX Interactive Delivery AventX Interactive Delivery

FCOA_FCOASAID AventX Stand Alone Interactive Delivery AventX Stand Alone Interactive Delivery

FCOA_FCOASTAT AventX Delivery Status AventX Delivery Status

FCOA_FCOATEST AventX API Test AventX API Test

Configuring Software Modules - AventX for Oracle EBS

Page 118 of 944
Proprietary to STR Software
Form Tab

Choose the Form tab at the top of the Form Functions form. Enter data into the Form tab according to the
table below (the Application field will populate automatically when a form is selected:

Function Form Application

FCOA_FCOAXCFG AventX Configuration AventX for Oracle EBS

FCOA_FCOAAYOD AventX Document Configuration AventX for Oracle EBS

FCOA_FCOASBMT AventX Interactive Delivery AventX for Oracle EBS

FCOA_FCOASAID AventX Stand Alone Interactive Delivery AventX for Oracle EBS

FCOA_FCOASTAT AventX Delivery Status AventX for Oracle EBS

FCOA_FCOATEST AventX API Test AventX for Oracle EBS

Configuring Software Modules - AventX for Oracle EBS

Page 119 of 944
Proprietary to STR Software
Properties Tab

Choose the Properties tab at the top of the form. Under Type, select “Form” for all entries. Select File, then
Save from the top menu and close the window.

Configuring Software Modules - AventX for Oracle EBS

Page 120 of 944
Proprietary to STR Software
Displaying the AventX Forms in the Oracle Navigator Menu

You must define menu items for any AventX forms you wish to grant access to. Menu items must be defined
for each responsibility you wish to have access. Menu items may have a prompt value, or be “hidden” (two
forms are triggered by View → Zoom). A typical menu item definition for the System Administrator
responsibility is provided below as an example. Since there are a number of items associated with AventX,
we’ll use a submenu.

• As Application Developer, under Application, select the Menu item.

• Create a new menu in the form below. This will become a new submenu for the “Install Menu”.

Using the table data below, fill out the Menu form and register the appropriate values:

Menu FND_NAVAVENTX4.0

User Menu Name AventX Menu - System Administrator GUI

Menu Type Standard

Description AventX for Oracle EBS submenu

Configuring Software Modules - AventX for Oracle EBS

Page 121 of 944
Proprietary to STR Software
The following is a text view of the table information on the Oracle Menus form:

Seq Prompt Submenu Function Description

10 System Configuration <blank> AventX Configuration AventX

Configuration

20 Delivery Status <blank> AventX Delivery Status AventX Delivery

Status

30 Document Configuration <blank> AventX Document Configuration AventX

Document
Configuration

40 Test API <blank> AventX API Test AventX API Test

50 <blank> <blank> AventX Interactive Delivery AventX

Interactive
Delivery

60 <blank> <blank> AventX Stand Alone Interactive AventX Stand

Delivery Alone
Interactive
Delivery

Configuring Software Modules - AventX for Oracle EBS

Page 122 of 944
Proprietary to STR Software
Creating the AventX Administrator Responsibility

It is recommended you create an “AventX Administrator” responsibility that allows certain individuals access
to configuration and troubleshooting forms. Use the following instructions to create an “AventX
Administrator” responsibility.

• Log in as an Oracle EBS user with the “System Administrator” responsibility.

• Select Security, then Responsibility, then Define.
• Create the AventX Administrator responsibility similar to the following:

Configuring Software Modules - AventX for Oracle EBS

Page 123 of 944
Proprietary to STR Software
Add the newly created responsibility to the appropriate user(s) by selecting Security, then User, then Define,
then selecting AventX Administrator under the Responsibility field as shown below.

Configuring Software Modules - AventX for Oracle EBS

Page 124 of 944
Proprietary to STR Software
Add AventX Menu to System Administrator Responsibility (Optional)

An alternative to creating the “AventX Administrator” responsibility is to put the AventX menu items under
the System Administrator responsibility.

• Select Application, then Menu.

• Under Menu, query for FND_NAVSITE4.0. You will see several menu items listed. Begin creating a new
one just below the last item in the list as shown.

Type the next available number in the Seq column.

• Type “AventX” in the Navigator Prompt column.

• Choose AventX Menu - System Administrator GUI from the List of Values for the submenu column.
• Type “AventX Oracle Connector” in the Description column.
• Select File, then Save from the menu.
You will need to create a “hidden” menu item for the AventX Interactive Delivery form, AventX Stand Alone
Interactive Delivery form and typically a menu item for the AventX Delivery Status form. These menu items
will need to be created for each Oracle Applications responsibility that you want to have these functional
capabilities.

HINT: If you are unsure of the menu name associated with a responsibility, select Security, then
Responsibility, then Define as System Administrator, query for the responsibility, and look at the value in the
Menu field:

Configuring Software Modules - AventX for Oracle EBS

Page 125 of 944
Proprietary to STR Software
This gives a starting point of a top-level menu that you can use to narrow down the choices to the correct
menu.

Menu Names for Common Responsibilities

Document Type Responsibility Menu Name

RFQ Purchasing Super User Purchasing SuperUser GUI

Purchase Order Purchasing Super User Purchasing SuperUser GUI

Sales Order Order Management Super Order Management Requests

User (ONT_REPORTS_REQUESTS_MENU)

Invoice Receivables Manager AR_PRINT_GUI

Statement Receivables Manager AR_PRINT_GUI

Select Application then Menu as System Administrator, and query for the responsibility you desire to grant
access to the AventX Interactive Delivery, AventX Stand Alone Interactive Delivery, and AventX Delivery
Status forms. Below, we will use the PO_SUPERUSER_GUI menu as an example.

Configuring Software Modules - AventX for Oracle EBS

Page 126 of 944
Proprietary to STR Software
• Create a new record just below the last item in the list.
• Type the next available number in the Seq column.
• Leave the Navigator Prompt column blank.
• Choose AventX Stand Alone Interactive Delivery from the List of Values for the Function column.
• Type “AventX Stand Alone Interactive Delivery Form” in the Description column.
• Create a new record just below the last item in the list.
• Type the next available number in the Seq column.
• Leave the Navigator Prompt column blank.
• Choose AventX Interactive Delivery from the List of Values for the Function column.
• Type “AventX Oracle Connector Interactive Delivery Form” in the Description column.
• Create a new record just below the last item in the list.
• Type the next available number in the Seq column.
• Type “AventX Delivery Status” in the Navigator Prompt column.
• Choose AventX Delivery Status from the List of Values for the Function column.
• Type “AventX Oracle Connector Delivery Status Form in the Description column.
• Select File, then Save from the top menu and close the form.

Configuring Software Modules - AventX for Oracle EBS

Page 127 of 944
Proprietary to STR Software
Registering the AventX Web Client

The AventX Web Client currently supports AventX Delivery Status, AventX General Configuration, and
common tools such as Import/Export Config, Get Troubleshooting Log…

The AventX Web Client can be accessed from the following locations:

• An Oracle Menu item on the self-service page

• A button at the bottom of the Work Order Report page in Oracle Asset Management (only for
instances using a valid AventX Attachment Express license)

• The Web Client can also be accessed from the AventX Administrator responsibility

• Directly through a browser using http(s)://<aventx host>:<aventx port>

The following steps can be used as a guide for creating a menu item in Oracle EBS Self-Service to launch the
AventX Web Client.

Backend Installation

During Step 7 of setup.sh, instructions will be provided on how to setup the delivery status web client
backend. Step 7 will generate a tar file named `oa.jsp.tar` under $FCHOME/oa that contains xxstrJSP.tar and
`setup_web.sh`. `oa.jsp.tar` will then need to be transferred to the EBS Host Application Tier under the
AventX Custom Top. Execute the following commands to extract the TAR file and run the setup script:
$ tar -xvf oa.jsp.tar

$ cd oa/ins

$ ./setup_web.sh

Once in the setup file, follow the prompts on screen to proceed. Step 1 will unarchive and set permissions on
the necessary files. Step 2 will move the JSP script to the correct location and compile. Once setup_web.sh
completes, restart Application Tier Services on the Oracle EBS host.

Menu Item Configuration

• Log into Oracle EBS as the System Administrator responsibility.

• Navigate to Application -> Function
Select one of the 3 available setups below based on your organization infrastructure and usage:

Replacing AventX Delivery Status Form with AventX Web Client

This option will completely replace the current AventX Delivery Status Form with AventX Web Client. AventX
Web Client Main Page will serve as the new AventX Delivery Status page. Users will no longer have access to
AventX Delivery Status Form.

Requirements
Configuring Software Modules - AventX for Oracle EBS
Page 128 of 944
Proprietary to STR Software
 • Firewall access to AventX Host (Standalone or EBS Host) on AventX Port (Default: 6055) from client
PC.
• Modern browsers recommended.

Instructions
• In the Form Function form, find the current AventX Delivery Status Form function (FCOA_FCOASTAT).
• Change User Function Name and Description to remove Form reference if available.
• Navigate to Form Functions -> Properties tab. Configure the form fields according to the table below
and save your changes.

Field Description

Function Prefilled

Type SSWA jsp function – JSP

Maintenance Mode Support None

Context Dependence Responsibility

• Navigate to the Form Functions -> Web HTML tab. Configure the form fields according to the table
below and save your changes.
Field Description

Function Enter the Function name created in the previous step.

HTML Call xxstrDeliveryStatusClient.jsp

• Test your change by going to AventX Administrator responsibility and open AventX Delivery Status. A
browser window should open with the new AventX Delivery Status Web Client.
Adding AventX Web Client to be available along side AventX Delivery Status Form

This option will create a new user function to launch the AventX Web Client. Users will have access to both
AventX Delivery Status Form, and AventX Web Client.

Requirements
• Firewall access to AventX Host (Standalone or EBS Host) on AventX Port (Default: 6055) from client
PC.
• Modern browsers recommended.

Instructions

Configuring Software Modules - AventX for Oracle EBS

Page 129 of 944
Proprietary to STR Software
• In the Form Functions form, fill in the Function, User Function Name, and Description fields according to
the table below and save your changes.

Field Description

Function FCOA_AXDSWEB

User Function Name AventX Delivery Status Web

Description Navigate to AventX Delivery Status Web

Note: You may need to contact your Oracle System Administrator to verify your organization’s naming
conventions for User Function Names and Description.
• Navigate to the Form Functions -> Properties tab. Configure the form fields according to the table below
and save your changes.

Field Description

Function Prefilled

Type SSWA jsp function – JSP

Maintenance Mode Support None

Context Dependence Responsibility

• Navigate to the Form Functions -> Web HTML tab. Configure the form fields according to the table below
and save your changes.
Field Description

Function Enter the Function name created in the previous step.

HTML Call xxstrDeliveryStatusClient.jsp

• Under the System Administrator responsibility, select Applicaton -> Menu.

• In the Menus form, search for the Menu that you will add the AventX Delivery Status Web menu item.
o Select the sequence number that you will assign to the AventX Delivery Status Web menu item,
according to the desired order of all items in the menu.
o Input the prompt as it should appear on the Self-Service page.
o Select the Function name and input the Description configured in the previous step. Default is
AventX Delivery Status Web.
• After saving your changes, log out of Oracle EBS

Configuring Software Modules - AventX for Oracle EBS

Page 130 of 944
Proprietary to STR Software
• Log back into Oracle EBS and verify that the AventX Delivery Status Web menu item appears according to
the new configuration.

• Open AventX Delivery Status Web by right click and open as new Tab/Window.

Continue using AventX Delivery Status Form

This option is not recommended as AventX Delivery Status Form no longer receive improvement/feature
updates. However, if your organization does not allow Firewall access to AventX Host from Users’ PCs, then
this option is the only available option for users to check their delivery status.
There is no special instruction to follow if you prefer to keep AventX Delivery Status Form.

Creating the AventX Profile Options

AventX has several Oracle Profiles that need to be created. The following section provides information on
the purpose these profile options serve, how they are created and configured.

AventX System Profile Options

XXSTR_SEQNO

To use Automatic Delivery, Interactive Delivery (via the AventX Interactive Delivery form) or Stand Alone
Interactive Delivery (via the AventX Stand Alone Interactive Delivery form), it is necessary to create a new
profile option that will hold a unique sequence number for each report submitted to AventX via the
Concurrent Manager.

• Log in to Oracle Applications as the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.

Configuring Software Modules - AventX for Oracle EBS

Page 131 of 944
Proprietary to STR Software
• Create a new profile option as shown:

For Application, select the custom application set up for AventX Oracle Connector (usually the application
name mapped to “AventX for Oracle EBS”).
• Select File, then Save from the top menu to save your changes.
AventX Organization Configuration Profile Options

XXSTR_CONFIG_RESTRICT - Restricting Administers to Specific Organization Configuration

The AventX Configuration form is used to configure default settings for AventX for a specific organization
defined in Oracle EBS. Access to this form is performed by defining a menu item for each Oracle EBS
responsibility you wish to grant access.

Many companies define the menu item only for the System Administrator responsibility. In this case, any user
with access to the responsibility may configure AventX for any organization.

It may be desirable to allow access to more than one responsibility, and to restrict configuration of AventX
Oracle Connector to the ORG_ID (Operating Unit) of that responsibility. This restriction prevents undesired
configuration changes by Oracle EBS users outside of the organization.

Configuring Software Modules - AventX for Oracle EBS

Page 132 of 944
Proprietary to STR Software
To enable this restriction, it is necessary to create a new profile option.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown:

For Application, select the custom application set up for AventX Oracle Connector (usually the
application name mapped to XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
Values for the XXSTR_CONFIG_RESTRICT profile option can be defined at one or more of these levels: Site,
Application, Responsibility, and User. Oracle EBS handles user profile levels according to that hierarchy, with
User being the highest level and Site being the lowest level.

Oracle EBS returns a value for XXSTR_CONFIG_RESTRICT based upon the rules for processing user profile
options according to the hierarchy described above. A blank value for the highest level (USER) causes Oracle
EBS to check the next level down in the hierarchy (Responsibility), and so on, until it finds a non-blank value
for the user profile option or until it reaches the Site level. This is standard Oracle EBS functionality.

When invoked, the AventX Configuration form checks the value of XXSTR_CONFIG_RESTRICT returned by
Oracle EBS.

To grant restriction to the user’s current organization, the value of the XXSTR_CONFIG_RESTRICT profile
option returned from Oracle EBS must be “YES”. Any other value (including blank) will be treated as “NO”.
Configuring Software Modules - AventX for Oracle EBS
Page 133 of 944
Proprietary to STR Software
To further clarify, consider the following scenario for the XXSTR_CONFIG_RESTRICT settings at each of the
user profile levels:

User Value Responsibility Application Site

TSOLES NO <blank> <blank> YES
RGUSTIN <blank> <blank> <blank> YES
In the scenario above, user TSOLES will be allowed to configure AventX for any organization ID, because
XXSTR_CONFIG_RESTRICT is “NO” at the User level, which is the first level that Oracle EBS checks.

However, RGUSTIN will be restricted to configuring AventX only for his organization ID, because
XXSTR_CONFIG_RESTRICT is “YES” at the Site level (Oracle EBS gets to this level because User, Responsibility,
and Application are all blank).

Configuring Software Modules - AventX for Oracle EBS

Page 134 of 944
Proprietary to STR Software
XXSTR_ORG_ADMIN - Restricting Administers to Specific Organization Delivery Information

The AventX Delivery Status form contains document transmission information. The default behavior of this
form is when accessed by an Oracle EBS user is to restrict access document information to the Oracle user
that is currently logged in and information will only display for documents submitted as that user.

It is possible to allow System Administrator full access to XXSTR_STATUS information to view the status of all
requests generated by any Oracle user under the organization ID of the current responsibility. The
XXSTR_ORG_ADMIN profile option can be set to “YES” for any user, thereby allowing that Oracle EBS user
access to all requests and document information from any user under the organization ID of the current
responsibility.

Configuring Software Modules - AventX for Oracle EBS

Page 135 of 944
Proprietary to STR Software
To enable this restriction, it is necessary to create a new profile option.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown:

For Application, select the custom application set up for AventX Oracle Connector (usually the
application name mapped to XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
Values for the XXSTR_ORG_ADMIN profile option can be defined at one or more of these levels: Site,
Application, Responsibility, and User. Oracle EBS handles user profile levels according to that hierarchy, with
User being the highest level and Site being the lowest level.

Oracle EBS returns a value for XXSTR_ORG_ADMIN based upon the rules for processing user profile options
according to the hierarchy described above. A blank value for the highest level (USER) causes Oracle EBS to
check the next level down in the hierarchy (Responsibility), and so on, until it finds a non-blank value for the
user profile option or until it reaches the Site level. This is standard Oracle EBS functionality.

When invoked, the AventX Configuration form checks the value of XXSTR_ORG_ADMIN returned by Oracle
EBS.

To grant restriction to the user’s current organization, the value of the XXSTR_ORG_ADMIN profile option
returned from Oracle EBS must be “YES”. Any other value (including blank) will be treated as “NO”.

To further clarify, consider the following scenario for the XXSTR_ORG_ADMIN settings at each of the user
profile levels:

Configuring Software Modules - AventX for Oracle EBS

Page 136 of 944
Proprietary to STR Software
 User Value Responsibility Application Site
TSOLES YES <blank> <blank> <blank>
RGUSTIN <blank> <blank> <blank> NO
In the scenario above, user TSOLES will be allowed to view the status of all requests generated by any Oracle
user under the organization ID of the current responsibility, because XXSTR_ORG_ADMIN is “YES” at the User
level, which is the first level that Oracle EBS checks.

However, RGUSTIN will be blocked from viewing the status of all requests generated by any Oracle user
under the organization ID, because XXSTR_ORG_ADMIN is “NO” at the Site level (Oracle EBS gets to this level
because User, Responsibility, and Application are all blank).

Configuring Software Modules - AventX for Oracle EBS

Page 137 of 944
Proprietary to STR Software
XXSTR_ORG_USER - Restricting Administers to Specific Organization Delivery Information

The AventX Delivery Status form contains document transmission information. The default behavior of this
form is when accessed by an Oracle EBS user is to restrict access document information to the Oracle user
that is currently logged in and information will only display for documents submitted as that user.

It is possible to limit the user access to XXSTR_STATUS information to only view the status of requests
generated by the Oracle user under the organization ID of their current responsibility. The XXSTR_ORG_USER
profile option can be set to “YES” for any user, thereby allowing that Oracle EBS user access to only their
requests and document information submitted under the organization ID of the current responsibility.

To enable this restriction, it is necessary to create a new profile option.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown:

For Application, select the custom application set up for AventX Oracle Connector (usually the
application name mapped to XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
Values for the XXSTR_ORG_USER profile option can be defined at one or more of these levels: Site,
Application, Responsibility, and User. Oracle EBS handles user profile levels according to that hierarchy, with
User being the highest level and Site being the lowest level.

Configuring Software Modules - AventX for Oracle EBS

Page 138 of 944
Proprietary to STR Software
Oracle EBS returns a value for XXSTR_ORG_USER based upon the rules for processing user profile options
according to the hierarchy described above. A blank value for the highest level (USER) causes Oracle EBS to
check the next level down in the hierarchy (Responsibility), and so on, until it finds a non-blank value for the
user profile option or until it reaches the Site level. This is standard Oracle EBS functionality.

When invoked, the AventX Configuration form checks the value of XXSTR_ORG_USER returned by Oracle EBS.

To grant restriction to the user’s current organization, the value of the XXSTR_ORG_USER profile option
returned from Oracle EBS must be “YES”. Any other value (including blank) will be treated as “NO”.

To further clarify, consider the following scenario for the XXSTR_ORG_ADMIN settings at each of the user
profile levels:

User Value Responsibility Application Site

TSOLES NO <blank> <blank> NO
RGUSTIN <blank> <blank> <blank> YES
In the scenario above, user TSOLES will be not be restricted to viewing their own submissions within the
current organization ID, because XXSTR_ORG_USER is “NO” at the User level, which is the first level that
Oracle EBS checks.

However, RGUSTIN will be restricted to viewing their submissions within the organization ID, because
XXSTR_ORG_USER is “YES” at the Site level (Oracle EBS gets to this level because User, Responsibility, and
Application are all blank). Setting the value to “YES” at the site level is needed to make it the default
functionality.

Configuring Software Modules - AventX for Oracle EBS

Page 139 of 944
Proprietary to STR Software
AventX Security Groups Profile Options

AventX supports two security groups that provide Oracle EBS users with additional AventX features. Security
groups allow Oracle EBS users to see all, some, or just their own documents in the AventX Delivery Status
form or the AventX WebManager; except for the AventX System Administrator security group. This group
provides an Oracle EBS user access to advanced system features. The following outlines more information
about these security groups.

Security Group Profile Option Name Feature Description

AventX System Administrator XXSTR_STATUS_ADMIN AventX WebManager allows System

Administrators to perform administration
tasks for AventX, including the following:
▪ Start and stop the system
▪ Configure global AventX settings
▪ Add, delete, and modify device settings
Add, delete, and modify document
properties for all documents

AventX Document Administrator XXSTR_DOCUMENT_ADMIN AventX WebManager allows for Document

Administrators to perform limited
administration tasks for AventX. Document
Administrators can see and manage all
documents, in the same manner as a
System Administrator, but have no ability to
perform other System Administrator
functions, such as starting or stopping the
queue or changing configuration settings

AventX User Not Applicable If an Oracle EBS user does not have the
AventX System Administrator or the AventX
Document Administrator profile options set
then they will be assigned to the “AventX
User” security group. As an “AventX User”
they will be able to see and manage all the
documents they own, as well as configure
their user settings

Configuring Software Modules - AventX for Oracle EBS

Page 140 of 944
Proprietary to STR Software
XXSTR_STATUS_ADMIN - Setting the AventX System Administrator Security Group

The AventX Delivery Status form contains document transmission information. The default behavior of this
form is when accessed by an Oracle EBS user is to restrict access document information to the Oracle user
that is currently logged in and information will only display for documents submitted as that user.

It is possible to allow System Administrator full access to XXSTR_STATUS information to view the status of all
requests generated by any Oracle user. The XXSTR_STATUS_ADMIN profile option can be set to “YES” for any
user, thereby allowing that Oracle EBS user access to all requests and document information stored in
AventX. Enabling this feature will also provide that Oracle EBS user System Administrator access to the
features in the AventX WebManager.

To enable this, it is necessary to create a new profile option.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown:

For Application, select the custom application set up for AventX Oracle Connector (usually the application
name mapped to XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
Oracle EBS returns a value for XXSTR_STATUS_ADMIN based upon the rules for processing user profile
options according to the hierarchy described above. A blank value for the highest level (USER) causes Oracle
Configuring Software Modules - AventX for Oracle EBS
Page 141 of 944
Proprietary to STR Software
EBS to check the next level down in the hierarchy (Responsibility), and so on, until it finds a non-blank value
for the user profile option or until it reaches the Site level. This is standard Oracle EBS functionality.

When invoked, the AventX Delivery Status form checks the value of XXSTR_STATUS_ADMIN returned by
Oracle EBS.

To grant full access to the document transmission information stored in AventX, the XXSTR_STATUS_ADMIN
profile option value returned from Oracle EBS must be “YES”. Any other value (including blank) will be
treated as “NO”.

To further clarify, consider the following scenario for the XXSTR_STATUS_ADMIN settings at each of the user
profile levels:

User Responsibility Application Site

TSOLES – <blank> <blank> NO
XXSTR_STATUS_ADMIN=YES

RGUSTIN –
XXSTR_STATUS_ADMIN=<blank>
In the scenario above, TSOLES will have full access to document transmission information for all users and
organizations, because XXSTR_STATUS_ADMIN is “YES” at the User level, which is the first level that Oracle
EBS checks. The following configuration would allow this for TSOLES:

Configuring Software Modules - AventX for Oracle EBS

Page 142 of 944
Proprietary to STR Software
If the above configuration is implemented, then the user will be considered an Administrator and will be able
to change the LOGIN value on the AventX Delivery Status form. The field will not be locked.

However, RGUSTIN will be restricted to viewing information for only his user, because
XXSTR_STATUS_ADMIN is “NO” at the Site level (Oracle EBS gets to this level because User, Responsibility,
and Application levels are all blank). The following demonstrates this example.

If the above configuration is implemented then the user will not be able to change the LOGIN value on the
AventX Delivery Status form. The field will be locked.

Configuring Software Modules - AventX for Oracle EBS

Page 143 of 944
Proprietary to STR Software
XXSTR_DOCUMENT_ADMIN -Setting the AventX Document Administrator Security Group

The AventX WebManager allows System Administrators to manage documents as well as system
configuration and status. Additionally, normal users my access and manage their own documents without
access to administrative functions. There may be business cases where it is desirable to give normal users
access to all users’ documents but limit their ability to perform administrative functions such as starting or
stopping the queue or changing configuration settings. This may be done by giving users the role of AventX
Document Administrator via the XXSTR_DOCUMENT_ADMIN profile value. In order to configure this option,
follow these steps:

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown below.

For Application, select the custom application set up for AventX (usually the application name mapped to
XXAVENTX_TOP, e.g. AventX for Oracle EBS).

• Select File, then Save from the top menu to save your changes.
Oracle EBS returns a value for XXSTR_DOCUMENT_ADMIN based upon the rules for processing user profile
options according to the hierarchy described above. A blank value for the highest level (USER) causes Oracle
EBS to check the next level down in the hierarchy (Responsibility), and so on, until it finds a non-blank value
for the user profile option or until it reaches the Site level. This is standard Oracle EBS functionality.

Configuring Software Modules - AventX for Oracle EBS

Page 144 of 944
Proprietary to STR Software
When invoked, the AventX function that launches the AventX WebManager from Oracle EBS checks the value
of XXSTR_DOCUMENT_ADMIN returned by Oracle EBS.

To grant full access to the document transmission information stored in AventX, the
XXSTR_DOCUMENT_ADMIN profile option value returned from Oracle EBS must be “YES”. Any other value
(including blank) will be treated as “NO”.

To further clarify, consider the following scenario for the XXSTR_DOCUMENT_ADMIN settings at each of the
user profile levels:

User Responsibility Application Site

TSOLES – <blank> <blank> NO
XXSTR_DOCUMENT_ADMIN=YES

RGUSTIN –
XXSTR_DOCUMENT_ADMIN=<blank>
In the scenario above, TSOLES will have full access to document transmission information for all users and
organizations via the AventX WebManager, because XXSTR_DOCUMENT_ADMIN is “YES” at the User level,
which is the first level that Oracle EBS checks. The following configuration would allow this for TSOLES:

If the above configuration is implemented then the user will be considered a Document Administrator and
will be able to access all documents within the AventX WebManager. However, RGUSTIN will be restricted
from accessing other users’ documents within the AventX WebManager because XXSTR_DOCUMENT_ADMIN
is set to “NO” at the Site level (Oracle EBS gets to this level because User, Responsibility, and Application
levels are all blank).

Configuring Software Modules - AventX for Oracle EBS

Page 145 of 944
Proprietary to STR Software
AventX Interactive Delivery Profile Options

These profile options control the user’s experiencing on the AventX Interactive Delivery form; specifically the
areas highlighted in the following image.

This form contains the following checkboxes.

• Hold - To hold the document once it is in the delivery queue

• T&C (to append a static terms and conditions file to the document)
• XML Archive Connection (to archive a copy of the document and any attachments)
The default setting for these boxes (checked or unchecked) is specified via the AventX Configuration form for
each organization and document type. However, a user can override these settings by checking or unchecking
the boxes on the AventX Interactive Delivery form. If you would like to restrict users from checking or
unchecking these boxes, it is necessary to create the following profile options.

Configuring Software Modules - AventX for Oracle EBS

Page 146 of 944
Proprietary to STR Software
XXSTR_ID_TC_DISABLED - Setting the default Terms and Conditions Behavior

Use the following instructions to prevent users from checking or unchecking the T&C checkbox on the AventX
Interactive Delivery form. This will keep users from disabling the addition of static terms and conditions if
they are enabled, or adding terms and conditions when not desired.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown below:

For Application, select the custom application set up for AventX (usually the application name mapped to
XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
To prevent users from checking or unchecking the T&C checkbox on the Interactive Delivery form, the
XXSTR_ID_TC_DISABLED profile option value returned from Oracle EBS must be “YES”. The T&C checkbox will
appear greyed out. Any other value (including blank) will be treated as “NO”, and the T&C checkbox will
appear normal.

This profile option can be set at the User, Responsibility, Application, or Site levels according to the hierarchy
detailed above under the sections “XXSTR_CONFIG_RESTRICT” and “XXSTR_STATUS_ADMIN”.

XXSTR_ID_HOLD_DISABLED - Setting the default “Hold” Behavior

Configuring Software Modules - AventX for Oracle EBS

Page 147 of 944
Proprietary to STR Software
Use the following instructions to prevent users from checking or unchecking the Hold checkbox on the
AventX Interactive Delivery form. This will keep users from changing the default hold behavior once the
document hits the transmission queue.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown below:

For Application, select the custom application set up for AventX (usually the application name mapped to
XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
To prevent users from checking or unchecking the Hold checkbox on the Interactive Delivery form, the
XXSTR_ID_HOLD_DISABLED profile option value returned from Oracle EBS must be “YES”. The Hold checkbox
will appear greyed out. Any other value (including blank) will be treated as “NO”, and the Hold checkbox will
appear normal.

This profile option can be set at the User, Responsibility, Application, or Site levels according to the hierarchy
detailed above under the sections “XXSTR_CONFIG_RESTRICT” and “XXSTR_STATUS_ADMIN”.
XXSTR_ID_ARCHIVE_DISABLED - Setting the default Archive Behavior

Use the following instructions to prevent users from checking or unchecking the Archive checkbox on the
AventX Interactive Delivery form. This will keep users from changing the default archiving behavior.

Configuring Software Modules - AventX for Oracle EBS

Page 148 of 944
Proprietary to STR Software
• Log in to Oracle Applications with the Application Developer responsibility.
• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown below:

For Application, select the custom application set up for AventX Oracle Connector (usually the application
name mapped to XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
To prevent users from checking or unchecking the XML Archive Connection checkbox on the Interactive
Delivery form, the XXSTR_ID_ARCHIVE_DISABLED profile option value returned from Oracle EBS must be
“YES”. The XML Archive Connection checkbox will appear greyed out. Any other value (including blank) will be
treated as “NO”, and the checkbox will appear normal.

This profile option can be set at the User, Responsibility, Application, or Site levels according to the hierarchy
detailed above under the sections “XXSTR_CONFIG_RESTRICT” and “XXSTR_STATUS_ADMIN”.

AventX Interactive Attachment Profile Options

XXSTR_INTERACTIVE_ATTACHMENTS - Adding Attachments on the Interactive Delivery Form

The AventX Interactive Delivery form and the AventX Stand Alone Interactive Delivery form may allow for
deletion of attachments and/or addition of attachments (AventX Stand Alone Interactive Delivery form only)
via the Attachments tab. By default, the new Attachments tab on both forms will be disabled. This is to avoid
any issue with users trying to add attachments before properly configuring the EBS environment as outlined
previously. To enable the Attachments tab, a profile value, “XXSTR_INTERACTIVE_ATTACHMENTS”, will be
Configuring Software Modules - AventX for Oracle EBS
Page 149 of 944
Proprietary to STR Software
used. Setting this profile value to “YES” will enable the Attachments tab and accompanied functionality. To
accomplish this, it is necessary to create a new profile option.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown:

For Application, select the custom application set up for AventX (usually the application name mapped to
XXAVENTX_TOP, e.g. AventX for Oracle EBS).
• Select File, then Save from the top menu to save your changes.
Oracle EBS returns a value for XXSTR_INTERACTIVE_ATTACHMENTS based upon the rules for processing user
profile options according to the following hierarchy: Site, Application, Responsibility, and User. A blank value
for the highest level (User) causes Oracle EBS to check the next level down in the hierarchy (Responsibility),
and so on, until it finds a non-blank value for the user profile option or until it reaches the Site level. This is
standard Oracle EBS functionality.

When invoked, the AventX Interactive Delivery form checks the value of XXSTR_INTERACTIVE_ATTACHMENTS
returned by Oracle EBS.

To grant access to the Attachments tab on the AventX Interactive Delivery form and the AventX Stand Alone
Interactive Delivery form, the XXSTR_INTERACTIVE_ATTACHMENTS profile option value returned from Oracle
EBS must be “YES”. Any other value (including blank) will be treated as “NO”.

Configuring Software Modules - AventX for Oracle EBS

Page 150 of 944
Proprietary to STR Software
To further clarify, consider the following scenario for the XXSTR_INTERACTIVE_ATTACHMENTS settings at
each of the user profile levels:

User Responsibility Application Site

TSOLES – <blank> <blank> NO
XXSTR_INTERACTIVE_ATTACHMENTS
=YES

RGUSTIN –
XXSTR_INTERACTIVE_ATTACHMENTS
=<blank>
In the scenario above, TSOLES will have access to the Attachments tab on both forms, because
XXSTR_INTERACTIVE_ATTACHMENTS is “YES” at the User level, which is the first level that Oracle EBS checks.

However, RGUSTIN will not have access to the Attachments tab on either form, because
XXSTR_INTERACTIVE_ATTACHMENTS is “NO” at the Site level (Oracle EBS gets to this level because User,
Responsibility, and Application levels are all blank).

Configuring Software Modules - AventX for Oracle EBS

Page 151 of 944
Proprietary to STR Software
Creating AventX Drivers, Styles, Types and Printers

For Automatic, Interactive, Print, and PO Approval delivery, AventX uses printers to pass report output from
the Concurrent Manager to AventX for processing.

Printer configuration in consists of four parts:

• Create the Print Driver (Required for Each Document that Uses AventX)
• Create the Style (Required for Each Document that Uses AventX)
• Associate the Style with a Printer Type (Required for Each Document that Uses AventX)
• Create the AventX Printers (One Time Step)

Oracle EBS requires each PRINTER to be assigned to a specific TYPE. Any number of printers can have the
same type. The TYPE defines which STYLES can be used in creating the reports. One type may have many
different styles associated with it for the formatting of many different reports. The style defines the paper
size (e.g. letter, legal, A4), orientation (e.g. portrait or landscape), fonts, etc. Each STYLE is assigned to a
specific DRIVER. The driver defines the SRW driver to be used by Oracle Reports to format the output and the

Configuring Software Modules - AventX for Oracle EBS

Page 152 of 944
Proprietary to STR Software
command line program to be invoked when “printing” the output from the Concurrent Manager. The
command line program and its parameters are the key to AventX.

Oracle Applications users define the formatting for the report output by selecting the proper PRINTER and
STYLE parameters on the UPON COMPLETION… form. The combination of these two parameters determines
how AventX will process the documents when the Concurrent Manager has completed them.

AventX consists of four submission “methods” for standard document types: Interactive Delivery, Stand
Alone Interactive Delivery, Automatic Delivery, and Print Delivery. Interactive, Stand Alone Interactive, and
Automatic Delivery “methods” have a single associated PRINTER and several, pre-defined STYLES. For Print
Delivery, the printer is any other defined Oracle EBS printer. The configuration of these printers is described
in the sections that follow. The proper order for configuration is DRIVERS, STYLES, TYPES, and PRINTERS.

It is not necessary to configure all the DRIVERS and STYLES that are described below. Only those DRIVERS and
STYLES for the reports to be implemented need be configured.

Configuration of printers requires the System Administrator responsibility.

Creating AventX Oracle Connector Printer Driver(s)

The following provides a summary of important considerations when creating AventX Print Drivers

▪ A print driver is required for each document type in AventX

▪ Do NOT attempt to copy/paste the driver strings from this documentation directly into Oracle EBS. This
has been found to cause problems, since the quote characters are not preserved properly when pasting,
thus resulting in invalid driver strings. For example, the double quotes come through as non-ASCII
characters. You can copy and paste the values into a text editor like NOTEPAD, delete and manually re-
add all the double quotes. Having non-ASCII characters in the driver string will cause AventX documents
to value and a stop and start of the concurrent manager to fix the problem after you correct the driver
strings.
▪ Changes to print drivers after they are created and used for the first time require a “bounce of the
concurrent manager” (stop and start of standard manager) to delete the print driver cache.
To create a print driver, change responsibility to “System Administrator” and click on “Install > Print > Driver”:

Configuring Software Modules - AventX for Oracle EBS

Page 153 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 154 of 944
Proprietary to STR Software
Print Driver Field Descriptions

The following table provides an example of the values that are placed into the fields of the print driver fields.

Driver Value

Driver Name AventX <Document Name> <Format>

Example: AventX Purchase Order PDF

User Driver AventX <Document Name> <Format>

Example: AventX Purchase Order PDF

Description AventX <Document Name> <Format>

Example: AventX Purchase Order PDF

SRW Driver HPP For Portrait Reports

HPL For Landscape Reports

Deliver Spool File – Always check this check box.

Method

Arguments $XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"

"$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "[LANG= <value> ]" "<document type>" "<value>"
The values used for the arguments will vary greatly based on your user requirements.

Configuring Software Modules - AventX for Oracle EBS

Page 155 of 944
Proprietary to STR Software
Print Driver Argument Descriptions

The following table breaks down the typical “Arguments” syntax into individual parts and offers descriptions
to their purpose.

Parameter Name Description / Valid Values

Path to fcprinto.sh script If not $XXAVENTX_TOP, the variable in the table should be replaced
with the custom top environment variable that was created during
$XXAVENTX_TOP/oa/fcprinto.sh
installation. Failure to do so could result in errors when the
Concurrent Manager runs the reports or the report output could be
generated on the patch file system.

"$PROFILES$.PRINTER" Do not change this value.

The printer chosen by user on Upon Completion… form, or if using
Stand Alone Interactive Delivery, the printer is set automatically to
the value of <$cSTREAM_PRINTER>. Valid values are:
<$cSTREAM_PRINTER>
<$cGENERAL_PRINTER>
Any valid printer name

"$PROFILES$.FILENAME" The full path name of the output data file as assigned by the
Concurrent Manager.

"$PROFILES$.XXSTR_SEQNO" A sequence number for this report passed from the Concurrent
Manager. Used to link reports and Oracle EBS database table
entries.

"$PROFILES$.TITLE" A combination of the request id assigned by the Concurrent

Manager and Oracle user name that submitted the report. AventX
supports spaces in the user name portion of pTITLE whereby the
spaces are replaced by the underscore “_” character. For example,
“Brent Lowe” would be changed automatically to “Brent_Lowe”.

"$PROFILES$.ORG_ID" The Oracle EBS Organization ID associated with the Organization

(Oracle EBS) that created this document.

Configuring Software Modules - AventX for Oracle EBS

Page 156 of 944
Proprietary to STR Software
Parameter Name Description / Valid Values

"$PROFILES$.CONC_COPIES" The number of copies passed from the Concurrent Manager. For
Interactive Delivery and Stand Alone Interactive Delivery, the actual
value of this variable is set to 1.

For Automatic Delivery, this specifies the number of printed copies

to be generated, minus 1 copy that is used for processing by AventX
Oracle Connector. For example, specifying “3” for this parameter
yields 2 printed copies, as one copy was used by AventX Oracle
Connector to generate the deliverable document(s).
For Print Delivery, this specifies the number of copies to be routed
to the printer.
This parameter does not indicate the number of deliverable
documents to be created in the document delivery system.

"[LANG=PDF]" Any valid document delivery system command or string of

commands. For example, this command specifies a PDF based file
for AventX UNIX.

"<document type>" A five-character code used to define the document type.

This is the value you type in the “Document Type” field on the “Add
New Document” form. The case of the document type must match
the case in the “Add New Document” form.

"<form method>" The method used to apply the form to the report output.
Valid values are:
none
fcdi
generic
streamserve

Configuring Software Modules - AventX for Oracle EBS

Page 157 of 944
Proprietary to STR Software
Parameter Name Description / Valid Values

"<special>" Used to indicate a special condition, such as whether the file is PDF,
HTML, or whether a confirmation copy should be printed for every
document.
Valid values are:

pdf
xml
html
printcc
blank
txt
uncollated

The printed confirmation copy will be of the document only and to

the user’s default printer as specified in the Oracle EBS
configuration.
It is permissible to combine two options provided they are enclosed
in quotes (e.g. "pdf printcc")

Configuring Software Modules - AventX for Oracle EBS

Page 158 of 944
Proprietary to STR Software
Example Print Drivers
The following are example print driver configurations for various types of business situations.

Do NOT attempt to copy/paste the driver strings from this documentation directly into Oracle EBS. This has
been found to cause problems, since the quote characters are not preserved properly when pasting, thus
resulting in invalid driver strings.

For example, the double quotes come through as non-ASCII characters. You can copy and paste the values
into a text editor like NOTEPAD, delete and manually re-add all the double quotes. Having non-ASCII
characters in the driver string will cause AventX documents to value and a stop and start of the concurrent
manager to fix the problem after you correct the driver strings.

Make sure the path to “fcprinto.sh” is correct for your environment. Consult the “Detailed Descriptions for
AventX Print Driver Arguments” for the best practices on what this value should be for your Oracle EBS
version.

Business Case Example Value

PDF output from BIP ../oa/fcprinto.sh "$PROFILES$.PRINTER" $PROFILES$.FILENAME

Publisher 1 $PROFILES$.XXSTR_SEQNO "$PROFILES$.TITLE" $PROFILES$.ORG_ID
$PROFILES$.CONC_COPIES "[LANG=PDF]" <documenttype> none pdf

TEXT report output ../oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"

using AventX PCL "$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
Form Overlay "$PROFILES$.CONC_COPIES" "[LANG=PCL]" <documenttype> fcdi

TEXT report output ../oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"

using Streamserve "$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "[LANG=PCL]" <documenttype> generic

A4 Text Output with …/oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"

Initialization String "$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "[LANG=PCL]" poa4 fcdi
Initialization: /e&l0o7C/e(s0t0p11H/e&a6L/e&l26A

Text Purchase Order …/oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME" "0"

Approval Report "$PROFILES$.TITLE" "$PROFILES$.ORG_ID" "$PROFILES$.CONC_COPIES"
"[LANG=PCL]" poap fcdi
Initialization: Not Specified, as any initialization strings are stripped by the
Concurrent Manager during processing of the concurrent request for PO
Approval documents.

1
This is the most commonlycommoncommonly created AventX Print Driver

Configuring Software Modules - AventX for Oracle EBS

Page 159 of 944
Proprietary to STR Software
 PDF Purchase Order ../oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME" "0"
Approval Report "$PROFILES$.TITLE" "$PROFILES$.ORG_ID" "$PROFILES$.CONC_COPIES"
"[LANG=PDF]" "poap" "none" "pdf"

HTML BI Publisher ../oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"

Report Output "$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "[LANG=HTML]" pop none html

Work Order Report ../oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"

Output in PDF "$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
format from BI "$PROFILES$.CONC_COPIES" "[LANG=PDF]" "work:I" "none" "pdf"
Publisher
Additional Information

Language
The "[LANG= <value> ]" is used to specify the format (language) of the source Oracle report. Valid values are
PDF, TEXT, PCL, POST, and HTML.

Configuring Software Modules - AventX for Oracle EBS

Page 160 of 944
Proprietary to STR Software
Forms Method
The following provides a summary of the values that can be used with the “Forms Method” parameter.

Forms Method Value Description

fcdi fcdi (aka AventX Forms Design and Integration) is a technique whereby a PCL
form overlay is created, using standard applications such as Microsoft Word,
AventX then applies (adds) this PCL form overlay definition to the individual
documents contained in the report output. The combined file (PCL form overlay
and report output data) is then processed through AventX to the
fax/email/print destination.

generic | In these cases, AventX places the associated command file for the individual
streamserve documents from the report output (each is now a separate file) into a directory
specified by the configuration option forms.output.directory on the General
“Config” tab of the AventX Configuration Form. The filename will have the form
of <ptitle>.<doc_no>.<doc_type>.<proc_id>.CMD. This file will await return of
the matching data file from the external process. A scan block must also be
added to the AventX Unix dirscan.cfg file to scan for .DAT files in the output
directories.
AventX also places the individual documents from the report output (each is
now a separate file) into a directory specified by the configuration option
forms.input.directory on the General Config tab of the AventX Configuration
Form. For files associated with fax/email destinations, the filenames are of the
form <pTitle>.<doc_no>.<doc_type>.<proc_id>; for files associated with print
destinations, the filenames are of the form
<printer_name>.prn.<ptitle>.<doc_no.<doc_type>.<extension>
It is expected that an external process will pick up these (data) files, apply form
information to them and in the case of fax/email destinations, return that
combined file to the forms.output.directory with the same file name and an
appropriate file extension (e.g. “pdf”) where further AventX processing will
occur., Printing via AventX is not supported. The final print status that will be
displayed in the FAX_STATUS table is "Transferred to 3rd Party”.
You may also specify multiple input directories based upon the Organization ID
for your 3rd party document processing software to pick up documents. To
enable this add the token _{ORGID} to the forms.input.directory configuration
option on the General Config tab of the AventX Configuration Form. For
example, $FCHOME/mydirectory_ {ORGID}. These directories must exist,
otherwise, as a fail over, the files will be placed in $FCHOME/mydirectory. If this
directory does not exist the submission will fail.

Configuring Software Modules - AventX for Oracle EBS

Page 161 of 944
Proprietary to STR Software
Helpful Queries
You can query the Oracle Database for all of the AventX print drivers by using the following query.

Query to determine the number of and display print drivers that have the string of ‘fcprinto.sh’ in it.

select count(*) from apps.fnd_printer_drivers where arguments like '%fcprinto.sh%'

Query to display the fcprinto.sh path.

select * from apps.fnd_printer_drivers where arguments like '%fcprinto.sh%'

Creating AventX Oracle Connector Printer Style(s)

The second step is to create the printer style that will be used in passing the report output to AventX for
processing. The printer name and style, specified for the request, are what the concurrent manager uses to
map to the proper printer driver for processing by AventX.

As the System Administrator responsibility select Install > Printer > Style to get to the Print Styles form.

It is necessary to define the appropriate styles that map to the printer drivers just created. This ensures that
the Concurrent Manager properly formats report output before being processed by AventX. A sample entry
for the portrait Purchase Order report is shown below. Do not necessarily use the same values as shown in
the example screenshot. Rather go to the section with the descriptions of the fields to determine the best
values for your business needs.

Configuring Software Modules - AventX for Oracle EBS

Page 162 of 944
Proprietary to STR Software
The table below defines the various parameters’ values for the most common reports. The examples below
illustrate sample printer styles for landscape and portrait-oriented reports. If your configuration uses both
types of orientations, you will need to ensure that the style names differ.

Style Parameters

AventX RFQ Style Name: AventX RFQ

(Portrait)
Seq: Enter a unique sequence number.
User Style: AventX RFQ
Description: AventX – RFQ portrait on letter paper
SRW Driver: HPP
Columns: 80
Rows: 66
Orientation: P

AventX RFQ Style Name: AventX RFQ (Land)

(Landscape)
Seq: Enter a unique sequence number.
User Style: AventX RFQ
Description: AventX – RFQ landscape on letter paper
SRW Driver: HPL
Columns: 132
Rows: 60
Orientation: L

AventX Purchase Order Style Name: AventX Purchase Order

(Portrait)
Seq: Enter a unique sequence number.
User Style: AventX Purchase Order
Description: AventX – PO portrait on letter paper
SRW Driver: HPP
Columns: 80
Rows: 66
Orientation: P

Configuring Software Modules - AventX for Oracle EBS

Page 163 of 944
Proprietary to STR Software
Style Parameters

AventX Purchase Order Style Name: AventX Purchase Order (Land)

(Landscape)
Seq: Enter a unique sequence number.
User Style: AventX Purchase Order (Land)
Description: AventX – PO landscape on letter paper
SRW Driver: HPL
Columns: 132
Rows: 60
Orientation: L

AventX Sales Order Style Name: AventX Sales Order

(Landscape) Seq: Enter a unique sequence number.
User Style: AventX Sales Order
Description: AventX – SOA landscape on letter paper
SRW Driver: HPL
Columns: 132
Rows: 60
Orientation: L

AventX Invoice Style Name: AventX Invoice

(Landscape) Seq: Enter a unique sequence number.
User Style: AventX Invoice
Description: AventX – INV landscape on letter paper
SRW Driver: HPL
Columns: 132
Rows: 60
Orientation: L

Configuring Software Modules - AventX for Oracle EBS

Page 164 of 944
Proprietary to STR Software
Style Parameters

AventX Statement Style Name: AventX Statement

Seq: Enter a unique sequence number.
User Style: AventX Statement
Description: AventX – STMT landscape on letter paper
SRW Driver: HPL
Columns: 132
Rows: 60
Orientation: L

AventX Work Order Style Name: AventX Work Order

Seq: Enter a unique sequence number.
User Style: AventX Work Order
Description: AventX – WO landscape on letter paper
SRW Driver: HPL
Columns: 132
Rows: 60
Orientation: L

Configuring Software Modules - AventX for Oracle EBS

Page 165 of 944
Proprietary to STR Software
Creating AventX Oracle Connector Type(s)

The third step is to create the printer type that will be used in passing the report output to AventX for
processing. The printer type is what maps the printer style to the proper printer driver for processing by
AventX.

Perform the following to create the printer type.

1. Log in as an Oracle EBS user with the “System Administrator” responsibility

2. Select “Install > Printer > Type” to get to the Printer Types form.
It is necessary to define a single printer type for the AventX printers: AventX Interactive and AventX
Automatic.

This one type, AventX, maps all the different styles that may be used in either submission “method”. The
style and driver mappings will determine the formatting of the report output that the Concurrent Manager
will pass to AventX.

The TYPE configuration need only reflect the actual report output STYLES and DRIVERS that have been
implemented. For example, if you only implemented Portrait Purchase Orders, only one entry (AventX
Purchase Order – FAX: PO PORTRAIT) needs to be configured for the TYPE AventX.

Configuring Software Modules - AventX for Oracle EBS

Page 166 of 944
Proprietary to STR Software
Creating AventX Oracle Connector Printer(s)

Perform the following to create the AventX printers.

• Log in as an Oracle EBS user with the “System Administrator” responsibility

• Select “Install > Printer > Register” to get to the Printer form.
It is necessary to configure the printers for the AventX integration. Each PRINTER is mapped to a single TYPE.

More than one printer can be mapped to the same type. This is true for the two printers in the AventX
integration. This allows users to submit any supported report output (see note below) via either Interactive
Delivery (user intervention is required) or Automatic Delivery (no user intervention required).

If a user attempts to submit a request for a report output that has not been properly configured for the
AventX, the Concurrent Manager will process the report without error, but the document(s) will not be
processed correctly by the document delivery system. The result will be that the document(s) will not enter
the document delivery system’s transmission queue and an error message will be written to the AventX error
log.

After defining the printers, it may be necessary to “bounce” (restart) the Concurrent Manager for the
changes to take effect.

Use the following values to perform the data entry into the form.

Configuring Software Modules - AventX for Oracle EBS

Page 167 of 944
Proprietary to STR Software
Printer Type Description Detailed Description

AventX AventX AventX Oracle Connector Used for batch processing. The user
Automatic Automatic Delivery does not type in destination or
acknowledgement information.
Configuration settings within the
AventX Oracle Connector determine
who receives the document, what
the final document constructed
document will look, e.g. message
templates, attachments, sender
information, and who receives an
email acknowledgement on the final
status of the document.

AventX AventX AventX Oracle Connector An AventX “pop up” form that allows
Interactive Interactive Delivery user to type in document
destination, acknowledgement,
message template and remarks text,
subject, and other document
information.

AventX PO AventX_POA AventX PO Approval Printer Used only for purchase orders that
Approval are submitted from PO Workflow.

AventX API AventX AventX API Printer Used only when integrating with the
AventX Oracle Connector API.

Configuring Software Modules - AventX for Oracle EBS

Page 168 of 944
Proprietary to STR Software
AventX Configuration

This section will provide the initial setup required to get AventX to the point where it is delivering a
document via the AventX Automatic print for a Purchase Order after a new installation of the software.

Forms and Field Descriptions

The section in this guide called “AventX Form and Field Descriptions” provides detailed information on each
AventX form and the purpose of each field, tab and button. Read that section for more information.

License Key

The first step in using the AventX software is to apply a license key. See “Applying License Keys” in the
“System Administration” section of this guide. Apply the license key you received from STR Software and then
come back to this section.

Email Alerts

It is recommended to always supply values for the following fields on the “General Config” tab.

▪ error.mail.address - This email address should be one that would normally receive email alerts from the
system when there are significant issues. The alerts to this address will contain detailed information
about any problem encountered. It is recommended that the administrator performing the initial
installation and configuration set this value now so that content rich information is available when first
setting up the software. It is also recommended to use a shared email address or distribution list such as
[email protected] instead of an individual email address so that important system information
is delivered to multiple people who may support the application.
▪ error.mail.from - It is also recommended to set the “error.mail.from” value to a valid SMTP email
address. Many mail servers will block emails sent as an invalid user, and the default value of
[email protected] may prevent the email from reaching the email address defined for the
“error.mail.address”
▪ mail.smtp.host – The SMTP mail host for sending alert emails.
Optional Configuration for Secured Mail Server

▪ mail.smtp.password – Secured mail password for sending email alerts

▪ mail.stmp.port – Secured Mail port needed for sending email alerts
▪ mail.smtp.tls – Whether the smtp mail listener requires TLS
Note: For a Secured Mail Server the mail.stmp.host value must be fully qualified.

Web Management

Configure the AventX WebManager fields on the “General Config” tab.

▪ webmgr.enabled – Controls whether the AventX WebManager is enabled or not.

▪ webmgr.port – AventX WebManager application port.
▪ webmgr.system – AventX WebManager system name.
Configuring Software Modules - AventX for Oracle EBS
Page 169 of 944
Proprietary to STR Software
Document Configuration

The next step in getting a document configured for delivery via the AventX Oracle Connector is to configure a
document. Click the “Configure a Document” button on the AventX Configuration Form. The Purchase Order
document will be used throughout this section.

Perform the following basic configuration.

• Change the Subject via the “Subject Template” field to something informative like “Purchase Order #
:UID1. UID1 is an dynamically populated field and will include the PO # when the remaining
configuration is complete
Organization Configuration

The next step in getting a document configured for delivery via the AventX Oracle Connector is to configure
an organization. Click on the “Configure an Organization” field which is found on the “Configuration Form.”

AventX requires to have at least one Oracle EBS Organization configured. AventX uses ORGID “0” as the
default configuration. Meaning, even though documents may be submitted to AventX from a particular
ORGID, the AventX software will use the default settings for ORGID “0”. Other organizations can be added to
AventX if there are unique business requirements that require different configuration settings than the
ORGID “0”.

Configuring Software Modules - AventX for Oracle EBS

Page 170 of 944
Proprietary to STR Software
Click on the “Configure an Organization” form and find organization ID “0”; which the default organization
name is “Setup Business Group”. Select ORGID 0 and click the “Find/Add” button.

Upon clicking the <Find/Add Organization> button, you will be prompted to configure the settings for this
organization.

Configuring Software Modules - AventX for Oracle EBS

Page 171 of 944
Proprietary to STR Software
This form allows you to configure organization defaults, message templates, and default settings for
document types. All information for this form (and its associated tables) is based on the organization that is
being configured.

When this form is invoked for the first time for a new organization, no entries exist in the corresponding
Oracle tables; therefore, the parameters on the form should be blank, except for a default value for the Fax
Delivery Server (ANY) and Email Delivery Server (ANY) on the Organization Defaults tab.

Configuring Software Modules - AventX for Oracle EBS

Page 172 of 944
Proprietary to STR Software
These settings can be configured later. Click on “Documents” and select the “Purchase Order” document
from the list of values. On the “Options” tab, click “None” then “File > Save”. Doing this will activate the other
tabs.

Click on the “Destination” tab click the first row in the “Send To” column and select “Other”. Type in your
name, company name and email address like the example below. This is the destination we will use to send
the initial tests to. You will configure AventX to use a real destination such as the supplier associated with the
Purchase Order or the customer associated with a document like an Invoice. It is recommended to setup a
simple test email address in the very beginning.

Configuring Software Modules - AventX for Oracle EBS

Page 173 of 944
Proprietary to STR Software
Click on the “Acknowledgements” tab and configure your email address to receive document transmission
status reports during your testing of the software.

Click “File > Save” and exit the forms.

Configuring Software Modules - AventX for Oracle EBS

Page 174 of 944
Proprietary to STR Software
Digital Signatures

AventX can apply a digital signature to a document before it is sent. There are several steps and prerequisites
before this can be implemented in AventX for Oracle EBS.

The following prerequisites are necessary for AventX to apply Digital Signatures to a document:

• $FCHOME/oa/signatures directory must exist on the AventX host.

o Note: AventXPS will abort if a Digital Signature is attempted and the $FCHOME/oa/signatures
directory does not exist.
• The following files must be stored in the $FCHOME/oa/signatures directory on the AventX host:
o Each signature file to be used. Each file must be a .p12 or .pfx filetype (example:
john_doe_signature.pfx).
o Each signature file must have a password file that coincides with the signature file, and has a
matching name and .pass extension (example: john_doe_signature.pass).
▪ The file must contain the signature file’s password in plain text when first placed in
the $FCHOME/oa/signatures directory.
▪ There must only be a single line in the .pass file, at the top of the file, containing the
password and nothing more.
▪ After the .pass file and signature file have been placed in $FCHOME/oa/signatures,
bounce AventXPS and the plain text password will be replaced with an encrypted
password.

## To Bounce AventXPS, Run This Command ##

$FCHOME/oa/aventxoc restart

• Any images to be used with a digital signature must be stored in $FCHOME/oa/signatures.

Configuring Software Modules - AventX for Oracle EBS

Page 175 of 944
Proprietary to STR Software
Digital Signatures must be set up in the AventX Document Configuration and AventX Organization
Configuration forms. To configure a Digital Signature in the AventX Document Configuration form, follow
these steps:

In the AventX Document Configuration form under the doctype for which you wish to apply a Digital
Signature, navigate to the “Doc Options Query” tab and select the “New Query” button.

Note: be sure to wrap inputs in single quotes, this includes required fields that are meant to be left blank

Configuring Software Modules - AventX for Oracle EBS

Page 176 of 944
Proprietary to STR Software
The following table contains more details about the form fields above that impact Digital Signature
configuration:

Field Name Description

Signature Name This is the filename (including filetype extension) of the signature to be used,
enclosed in single quotation marks.

Signature Type There are two options for Signature Type: ‘visual’ and ‘invisible’.
‘visual’ – The Digital Signature will be visible on the first page of the final PDF.
‘invisible’ – The Digital Signature will be not visible on the page but will be in
the signature toolbar in Adobe Acrobat.

Signature Dimensions This value must be enclosed in single quotation marks and contain four comma-
(only applies to delimited numbers. The first two numbers set the location for the top-left point
visual-type Digital of a Digital Signature for placement on the first page of a document (top-left
Signatures) being 0,0). The next two numbers set the size of the digital signature. Generally,
1 inch is correlates roughly to 72 points (ex. ‘0,0,144,72’ would be top left, 2
inches wide and 1 inch tall).
The values are: ‘x-axis,y-axis,width,height’
There are also other configuration options that can be set using ‘;’ as delimiters
(ex. Below)
• '10,10,150,70;imgDim=0,0,150,35;fontSize=5;text=John Doe<br>STR
Software<br>US<br>Digitally Signed On:<br><timestamp>'
The extra avalible properties are:
• imgDim (Recommended): specifies the dimensions of the image to be
placed in the grey box (Note: 0,0 specifies the bottom left of the grey
box) – ‘x,y,width,height’
• fontSize: specified how large to make the font (default being 10). Only
integer values are accepted
• text (Recommended): specify custom signature text. If this is not
provided, we default to ‘Unknown<br>Unknown<br>Unknown’. The
text property allows two replacement tokens:
o <br>: Creates a new line.
o <timestamp>: Adds the timestamp for when the document was
signed on the AventX host.

Configuring Software Modules - AventX for Oracle EBS

Page 177 of 944
Proprietary to STR Software
 Field Name Description

Signature Image/Text There are three options for Signature Type: ‘text’, ‘text_image’, and ‘image’.
(only applies to
‘text’ – the Digital Signature will display as text over a grey box (see sample
visual-type Digital
below). See “Signature Dimensions” for more specific configuration options.
Signatures)

‘text_image’ – an image will be inserted under the text of the Digital Signature
‘image’ – the Digital Signature will display an image with no text

Signature Image This is the filename (including filetype extension) of the image to be used,
(only applies to enclosed in single quotation marks.
visual-type Digital
Note: This setting is optional even if the Signature Type is set to visual.
Signatures)
To configure a Digital Signature in the AventX Organization Configuration form, follow these steps:

In the AventX Organization Configuration form, under the doctype for which you wish to apply a Digital
Signature, navigate to the “Misc” tab. Below the “Apply Signature To” heading, place a check in the checkbox
beside “Email”, “Archive”, or in both checkboxes.

Note: In the “Options” tab, “Define Options By” must be configured to “Query”.

Configuring Software Modules - AventX for Oracle EBS

Page 178 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 179 of 944
Proprietary to STR Software
Reporting Bursting

One required step to setting up a document in AventX is to configure it for bursting. AventX supports the
ability to take large concurrent request report output files and burst them into individual documents. This
process is helpful when automating the delivery of documents is required.

This section reviews how AventX bursts formatted (PDF or HTML) output from BI Publisher and Oracle
Reports for use with AventX Automatic and for printing reports that have attachments. If you do not plan to
use Automatic (including jobs via the Delivery Manager) or Print Delivery, then you can skip this chapter.

Bursting PDF Output

AventX integrates with BI Publisher. The integration requires the implementation of an AventX “Information
Tag”. This tag contains information that AventX will use to burst the report and query for information in the
Oracle Database. AventX gathers the following types of information when it queries the Oracle Database:

• AventX document configuration contained in the AventX schema

• Recipient information like contact names, email addresses/fax numbers and printer names, i.e.,
supplier and customer information
• Oracle EBS user names and contact information

Adding the AventX Tag to a BI Publisher Layout Template

This section provides information on how to add the AventX “Information Tag” to the BI Publisher layout
template. It assumes you are familiar with BI Publisher layout templates and data definitions. Since this is a
quick reference guide, only the bare minimum steps will be outlined.

As the XML Publisher responsibility, select “Home → Templates”. Locate the template associated with the
document you wish to integrate with AventX. Download a copy of the template, and modify it to add the
AventX Information tag:

Insert an “invisible” tag, which contains the key document fields, onto the first page of the report only. The
tag can be placed anywhere on the page. Normally, this tag is embedded within a form field at the top of the
first page of each document in the report output.

The “invisible” tag must follow a specific format as noted below (note the closing colon):

FAX_INFO:Parameter1:Parameter2:Parameter3:Parameter4:Parameter5:

where <Parameter 1> is the only required parameter, usually the Oracle EBS document number and
Parameters 2-5 are any other value(s) necessary to properly identify the required information within the
Oracle database.

Configuring Software Modules - AventX for Oracle EBS

Page 180 of 944
Proprietary to STR Software
The following is a list of guidelines that should be followed when formatting the tag. Failure to follow these
rules will result in improper processing of the document(s) by AventX Oracle Connector:

▪ Each parameter returned in the string cannot contain the colon (:), which is used by AventX to separate
distinct values.
▪ The tag must appear ONLY ONCE on the first page of output. The first tag to be found in the document
will be the one that is used for processing. Any additional tags will be ignored. (Therefore, it is best
practice to only have one FAX_INFO tag per document).
▪ The entire tag must be formatted EXACTLY the same (e.g., same font, size, color, etc.). Therefore, STR
Software recommends that all formatting be removed from the tag to avoid problems (“Clear
Formatting” in Microsoft Word).
▪ The entire FAX_INFO tag must use a font with the following characteristics: Type 1 font and ANSI
Encoding. These characteristics can be verified in Adobe Acrobat by selecting File → Document
Properties → Fonts.
▪ The value for any UID parameter cannot exceed 255 characters.
▪ All leading and trailing spaces will be trimmed.
The following screen shot shows an example of the FAX_INFO tag in the report output:

Configuring Software Modules - AventX for Oracle EBS

Page 181 of 944
Proprietary to STR Software
The following represents the required syntax of the AventX tags for all seeded document types:

Document Type Example Tag Example Value

Request for FAX_INFO:RFQ_NUMBER:SUPPLIER_NUMBER: FAX_INFO:23456:1008:

Quotation (RFQ)

Standard Purchase FAX_INFO:PO_NUMBER: FAX_INFO:1169:

Order

Blanket Release FAX_INFO:PO_NUMBER-RELEASE_NUMBER: FAX_INFO:501-10:

Purchase Order

PO Approval FAX_INFO:PO_NUMBER:PO_REVISION:PO_HEADER_ID FAX_INFO:1169:0:7664

Purchase Order

PO Approval FAX_INFO:PO_NUMBER- FAX_INFO:501-10:2:572

Blanket Release RELEASE_NUMBER:PO_REVISION:PO_HEADER_ID

Sales Order FAX_INFO:ORDER_NUMBER: FAX_INFO:55443:

Acknowledgement

Invoice FAX_INFO:INVOICE_NUMBER: FAX_INFO:10007145:

Statement FAX_INFO:CUSTOMER_NUMBER:ADDRESS1 FAX_INFO:1004:1271

East Broad Street:

Work Order FAX_INFO:WO_NUMBER:WIP_ORGANIZATION_ID: FAX_INFO:57673:69074:

Additional Resources

STR Software has created several templates you may wish to use to as starter BI Publisher layout templates.
See KB Article # 16314 for these examples.

Configuring Software Modules - AventX for Oracle EBS

Page 182 of 944
Proprietary to STR Software
Testing the BI Publisher Template

One of the easiest ways to test whether you have successfully implemented the AventX tag is to use the BI
Publisher Desktop software to view the final output.

• Install BI Publisher Desktop on your computer. This software installs a plugin into Microsoft Word.
• Open the RTF layout template you integrated with the AventX tag.
• Run an Oracle Concurrent Manager request for the report you wish to integrate with AventX.
• Go to View → Requests and find your request. Next, click on Diagnostics → View XML.

• Save the XML file to your computer.

• Load the XML file into the BI Publisher Desktop software:

• Preview as PDF by selecting Preview → PDF

• You should see the AventX tag displayed with the proper format. If the tag is invisible, try searching for
FAX_INFO and it should be selected.

Configuring Software Modules - AventX for Oracle EBS

Page 183 of 944
Proprietary to STR Software
• If everything looks good, then upload the layout template back into Oracle EBS. Switch to the XML
Publisher Administrator responsibility. Select Home → Templates, find your layout template and click on
“Update” to upload the new layout template that includes the AventX tag.

• Assuming the entire AventX document configuration has been performed properly, you should now be
able to run a concurrent request to the AventX Automatic printer and burst the report output.

Configuring Software Modules - AventX for Oracle EBS

Page 184 of 944
Proprietary to STR Software
Bursting HTML Output

Separating the Batch File

HTML files, although readable to the human eye, can be quite complex, containing all kinds of different
formatting tags, making it difficult to easily discern how many documents are in a “batch”.

Although AventX uses only a FAX_INFO tag to burst and extract destination information for other formatted
documents, HTML document processing is different. AventX must know two pieces of information (rather
than just looking for a FAX_INFO tag) in order to properly burst the batch and determine document delivery
information.

• For HTML documents, AventX must be configured to look for a specific identifier that indicates the
beginning of a “logical section” within the HTML code and another identifier that indicates the end of
the “logical section” within the HTML code in order to burst the batch into individual documents. A
logical section is simply a “chunk” of HTML code which defines a potential section in which a
FAX_INFO tag may be located (see below).

• A special (FAX_INFO) tag must be included within a logical section per document to specify key
information for AventX to extract document delivery information from the Oracle database tables.

Integrating your HTML report output with AventX is therefore a two step process. The first is to configure
AventX to burst the HTML into logical sections. The second is to modify the report output to include a
FAX_INFO tag for each document created within the batch.

Configuring Software Modules - AventX for Oracle EBS

Page 185 of 944
Proprietary to STR Software
Additional AventX Configuration

As previously stated, AventX must be configured to look for a specific identifier that indicates the beginning
of the HTML logcial section and another identifier that indicates the end of the HTML logical section in order
to determine the possible sections in which a FAX_INFO tag may be located. The best practice is to format
your HTML report in such a way that each logical section is contained within a <table> </table> section within
the <body> tag of the HTML code itself. An example HTML batch file is located under
$FCHOME/oa/samples/htm_batch.htm. This file was created by BI Publisher as HTML report output. In a
viewer, the document looks like this to the person viewing it:

The sample batch actually contains three Purchase Orders: #5382, #5383, and #5384.

Configuring Software Modules - AventX for Oracle EBS

Page 186 of 944
Proprietary to STR Software
Let’s take a closer look at this file’s HTML structure:

<body>

<p class="c0"><br/></p>

<table class="c81">

<tr class="c1">

<td valign="top" colspan="4" class="c2"><p class="c3"><span class="c4">FAX_INFO:5384:</span></p>

<p class="c5"><br/></p>

</td>

<td valign="top" colspan="8" class="c6"><p class="c7"><span class="c8"><b>QA XML</b></span><span

class="c8">&nbsp; </span><span class="c8"><b>PURCHASE ORDER</b></span></p>

</td>

</tr>

<tr class="c9">

<td valign="top" colspan="4" class="c10"><p class="c11"><br/></p>

</td>

<td valign="top" colspan="3" class="c12"><p class="c13"><span class="c14">PO Number</span></p>

<p class="c15"><span class="c16">5384</span></p>

</td>

<td valign="top" colspan="3" class="c17"><p class="c18"><span class="c14">Revision</span></p>

<p class="c19"><span class="c16">0</span></p>

</td>

<td valign="top" colspan="2" class="c20"><p class="c21"><span class="c14">Page</span></p>

<p class="c22"><span class="c16">1</span><br/></p>

</td>

</tr>
Configuring Software Modules - AventX for Oracle EBS
Page 187 of 944
Proprietary to STR Software
<tr class="c23">

<td valign="top" colspan="4" class="c2"><p class="c11"><br/></p>

</td>

<td valign="top" colspan="8" class="c24"><p class="c25"><span class="c26"><b>Ship To:</b></span></p>

<p class="c25"><span class="c16">90 Fifth Avenue</span></p>

<p class="c25"><br/></p>

<p class="c25"><br/></p>

<p class="c25"><span class="c16">New York,NY 10022-3422</span></p>

<p class="c27"><span class="c16">United States</span></p>

</td>

</tr>

<tr class="c28">

<td valign="top" colspan="4" class="c29"><p class="c30"><span class="c26"><b>Vendor:</b></span></p>

<p class="c30"><span class="c16">Corporate Express Office Supply</span></p>

<p class="c30"><span class="c16">500 Lake Rd</span></p>

<p class="c30"><span class="c16">Mountain View, CA 94040</span></p>

<p class="c30"><span class="c16">United States</span></p>

</td>

<td valign="top" colspan="8" class="c6"><p class="c25"><span class="c26"><b>Bill To:</b></span></p>

<p class="c25"><span class="c16">90 Fifth Avenue</span></p>

<p class="c25"><br/></p>

<p class="c25"><br/></p>

<p class="c25"><span class="c16">New York,NY 10022-3422</span></p>

<p class="c25"><span class="c16">United States</span></p>

Configuring Software Modules - AventX for Oracle EBS

Page 188 of 944
Proprietary to STR Software
</td>

</tr>

...
<tr class="c76">

<td valign="top" colspan="6" class="c70"><p class="c71"><span class="c14"><b>Subject to attached Terms

&amp; Conditions</b></span></p>

</td>

<td valign="top" colspan="6" class="c77"><p class="c78"><span

class="c79">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n
bsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </span><span class="c14">By</span><span
class="c79">&nbsp;&nbsp; </span></p>

<p class="c80"><span class="c14">&nbsp; Authorized Signature</span></p>

</td>

</tr>

</table>

<p class="c82"><span class="c14"><b><i>This template was created by STR Software to demonstrate

document delivery of XML Publisher output using our AventX Oracle Connector. For more information
contact:&nbsp; </i></b></span><a href="mailto:[email protected]"><span
class="c83"><b><i>[email protected]</i></b></span></a><span class="c14"><b><i> or (804) 897-1600
extension 2</i></b></span><a name="page-total-master0_3" id="page-total-master0_3"></a><a
name="page-total_3" id="page-total_3"></a></p>

</body>

As you can see, within the <body> tag itself are several logical “sections”, each section defined by a starting
HTML tag of “<table class=” and an ending tag of </table>. This enforces a structured and defined logical
section, making it easier to determine the possible sections of HTML code in which a FAX_INFO tag may be
located.

The process of determining the starting/ending identifiers that define a logical block for bursting of a batch
can be a tricky process, depending upon the complexity of the HTML itself. The most important consideration
must be that the starting/ending identifier are present within the <body> tag and clearly define logical
sections within the HTML. Failure to properly define these identifiers could result in loss of data or
extraneous data within a given document. As these HTML reports can be quite complex, locating this
information can be an iterative and time-consuming process.

Configuring Software Modules - AventX for Oracle EBS

Page 189 of 944
Proprietary to STR Software
Once you have determined that your HTML report output contains these “logical” sections, you must
configure AventX to know about the starting and ending identifiers that define these sections within the
HTML code.

This information is defined in the AventX Document Configuration form for this particular document type on
the General Configuration tab, using the variables html.page.start and html.page.end:

The pager script works by creating a HTML header (or prefix) that includes everything from the <html> tag up
to the <body> tag. Next, it will create a file for each logical section and then create a footer (or suffix) file that
will include everything from the </body> tag to the </html> tag:

Configuring Software Modules - AventX for Oracle EBS

Page 190 of 944
Proprietary to STR Software
Recall that for our Purcahse Order example, we defined the start of a logical section to be “<table class=” and
the end of a logical section to be “</table>”. When htmpager.awk is executed against this htm_batch.htm

Configuring Software Modules - AventX for Oracle EBS

Page 191 of 944
Proprietary to STR Software
sample file, the resulting number of logical sections defined is three “pages” (logical sections) of HTML code.
In other words, there are three occurrences of the “<table class=” and “</table>” sections within this sample
document.

Once you have defined your starting and ending identifiers, you must next modify your report output to place
a special FAX_INFO tag within each logical document in the HTML batch to be used as a key for extracting
document delivery information (destinations, email address, etc) from Oracle tables. This is discussed in the
next section.

Adding the AventX Tag in the Report Output

Now that you have configured AventX to define the logical sections within the HTML code, the report output
must be modified to contain the key field information. This is accomplished by including an “invisible” tag,
which contains the key document fields within a logical section of the HTML code for each document within
the batch. Normally, this tag is embedded in the first logical section of each document. An example of the
$FCHOME/oa/samples/html_batch.htm file is once again displayed below, this time with the FAX_INFO tag
information highlighted. If you search through the file, you will see that the proper FAX_INFO tag is included
within a logical section for each document, for a total of three times (once for document number 5384 –
shown below as an example, once for 5382, and once for 5383).

<body>

<p class="c0"><br/></p>

<table class="c81">

<tr class="c1">

<td valign="top" colspan="4" class="c2"><p class="c3"><span class="c4">FAX_INFO:5384:</span></p>

<p class="c5"><br/></p>

</td>

<td valign="top" colspan="8" class="c6"><p class="c7"><span class="c8"><b>QA XML</b></span><span

class="c8">&nbsp; </span><span class="c8"><b>PURCHASE ORDER</b></span></p>

</td>

</tr>

<tr class="c9">

<td valign="top" colspan="4" class="c10"><p class="c11"><br/></p>

</td>

Configuring Software Modules - AventX for Oracle EBS

Page 192 of 944
Proprietary to STR Software
<td valign="top" colspan="3" class="c12"><p class="c13"><span class="c14">PO Number</span></p>

<p class="c15"><span class="c16">5384</span></p>

</td>

<td valign="top" colspan="3" class="c17"><p class="c18"><span class="c14">Revision</span></p>

<p class="c19"><span class="c16">0</span></p>

</td>

<td valign="top" colspan="2" class="c20"><p class="c21"><span class="c14">Page</span></p>

<p class="c22"><span class="c16">1</span><br/></p>

</td>

</tr>

<tr class="c23">

<td valign="top" colspan="4" class="c2"><p class="c11"><br/></p>

</td>

<td valign="top" colspan="8" class="c24"><p class="c25"><span class="c26"><b>Ship To:</b></span></p>

<p class="c25"><span class="c16">90 Fifth Avenue</span></p>

<p class="c25"><br/></p>

<p class="c25"><br/></p>

<p class="c25"><span class="c16">New York,NY 10022-3422</span></p>

<p class="c27"><span class="c16">United States</span></p>

</td>

</tr>

<tr class="c28">

<td valign="top" colspan="4" class="c29"><p class="c30"><span class="c26"><b>Vendor:</b></span></p>

<p class="c30"><span class="c16">Corporate Express Office Supply</span></p>

Configuring Software Modules - AventX for Oracle EBS

Page 193 of 944
Proprietary to STR Software
<p class="c30"><span class="c16">500 Lake Rd</span></p>

<p class="c30"><span class="c16">Mountain View, CA 94040</span></p>

<p class="c30"><span class="c16">United States</span></p>

</td>

<td valign="top" colspan="8" class="c6"><p class="c25"><span class="c26"><b>Bill To:</b></span></p>

<p class="c25"><span class="c16">90 Fifth Avenue</span></p>

<p class="c25"><br/></p>

<p class="c25"><br/></p>

<p class="c25"><span class="c16">New York,NY 10022-3422</span></p>

<p class="c25"><span class="c16">United States</span></p>

</td>

</tr>

...
<tr class="c76">

<td valign="top" colspan="6" class="c70"><p class="c71"><span class="c14"><b>Subject to attached Terms

&amp; Conditions</b></span></p>

</td>

<td valign="top" colspan="6" class="c77"><p class="c78"><span

class="c79">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&n
bsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </span><span class="c14">By</span><span
class="c79">&nbsp;&nbsp; </span></p>

<p class="c80"><span class="c14">&nbsp; Authorized Signature</span></p>

</td>

</tr>

</table>

The “invisible” tag must be inserted using the same syntax as outlined in the previous section on bursting PDF
reports.

Configuring Software Modules - AventX for Oracle EBS

Page 194 of 944
Proprietary to STR Software
Print Driver

When setting up the document for delivery by AventX Oracle Connector, the print driver line must have
‘html’ value as the last parameter and ‘[LANG=UNKNOWN]’:

/home/faxmgr/oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME" "$PROFILES$.FAX_SEQNO"

"$PROFILES$.TITLE" "$PROFILES$.ORG_ID" "$PROFILES$.CONC_COPIES" "[LANG=HTML]" "abc" "none" "html"

Bursting Excel Output

This integration relies on the BI Publisher API to burst Excel output into individual documents. The Excel
output is unique compared to the other report outputs supported by AventX Oracle Connector, and as such
requires a different approach for bursting. The FAX_INFO tag cannot be used to burst Excel output due to the
binary format of the output file. Instead, bursting control file must be created for each document type with
an Excel output along with corresponding RTF template. Bursting control file is simply a specification of how
Excel output should be burst, how the burst files should be named, where the burst files should be placed,
and which template to use.

The first step in configuring AventX Oracle Connector for processing the Excel report output is to create
bursting control file and corresponding RTF Template. Let’s look at an example bursting control file and break
it down.

Sample bursting control file:

<?xml version="1.0" encoding="UTF-8"?>
<xapi:requestset xmlns:xapi="http://xmlns.oracle.com/oxp/xapi" type="bursting">
<xapi:request select="/DEMO/LIST_G_TRAN_TYPE/G_ATTRIB2/LIST_G_LOOP/G_LOOP">
<xapi:delivery>
<xapi:filesystem output=":DIRNAME:/:FILEPREFIX:.${TRANSACTION_TYPE}.${ATTRIBUTE1}.${ATTRIBUTE2}.xls" />
</xapi:delivery>
<xapi:document output-type="excel">
<xapi:template type="rtf" location="/tmp /oa/xmlpfiles/XXEXCELBURST.rtf" filter=""></xapi:template>
</xapi:document>
</xapi:request>
</xapi:requestset>

Bursting control file must meet the following requirements:

• The file must be named in <doctype>.burst.xml format.

• It must output burst data to the file system with the name <FILEPREFIX>.UID1.UID2.UID3.xls. In the
above example TRANSACTION_TYPE, ATTRIBUTE1 and ATTRIBUTE2 are UID1, UID2, and UID3
respectively.
• :DIRNAME:/:FILEPREFIX: tokens must be included. These values are dynamically replaced by AventX
Oracle Connector at the runtime.
• The location of corresponding RTF template must be specified.
• All Excel bursting related files must be placed in the $FCHOME/oa/xmlpfiles directory.
Print Driver

Configuring Software Modules - AventX for Oracle EBS

Page 195 of 944
Proprietary to STR Software
When setting up the document for delivery by AventX Oracle Connector, the print driver line must have
‘xmlpburst’ value as the last parameter and LANG=UNKNOWN.

/home/faxmgr/oa/fcprinto.sh “$PROFILES$.PRINTER” $PROFILES$.FILENAME $PROFILES$.FAX_SEQNO

“$PROFILES$.TITLE” $PROFILES$.ORG_ID $PROFILES$.CONC_COPIES “[LANG=UNKNOWN]” abc none
xmlpburst

Document Configuration

On the Add Your Own Document Configuration form, under General Configuration Tab, set data file
extension to xls.

At this point you are all set. You can now submit batch with Excel output that AventX Oracle Connector can
pick up, detect the bursting control file to be used based on the <doctype>, replace the tokens in the bursting
control file, and submit it for bursting to BIP API. Once bursting is complete, AventX Oracle Connector will
extract the UID1, UID2, and UID3 values from the filename and use them to get the recipient info.

Bursting Text Output

For TEXT format, Automatic Delivery uses certain “key” values (i.e., the lookup key values) to separate the
report output into individual documents. These “key” values are extracted from the report output, using row,
column and length identifiers. These “key” values are also used to determine the delivery address
information for each document.

The row, column and length identifiers are defined in the General Configuration tab of the AventX Document
Configuration form for each document type.Each document type will have its own set of up to three
Configuring Software Modules - AventX for Oracle EBS
Page 196 of 944
Proprietary to STR Software
identifiers. These correspond to the :UID1, :UID2, and :UID3 parameters from the document definition. You
can determine the proper values for row, column and length using any text editor (e.g., vi, emacs, notepad)
with a sample report output file. This is the output file for our example document, Separate Remittance
Advice:

Vision Operations (USA)

Remittance Advice
Date: 08-MAR-2006 12:51

Payee:
Advantage Corp Bank Name: Bank of America
80 Long Ridge Road Account Name: BofA
Account Num: 10271-17621-619
Payment Number: 9015
Stamford
CT 06904 US

Invoice Invoice Discount

Date Number Description Value Amount

The following are sample screenshots of the uid% values as they would be configured in the AventX
Document Configuration form for this document type, where :UID1 is the payment batch and :UID2 is the
payment number (highlighted above):

Configuring Software Modules - AventX for Oracle EBS

Page 197 of 944
Proprietary to STR Software
Each page of the report output will be checked for the “key” value(s). If the “key” value(s) is the same as from
the preceding page, this page is added to the current document. If different, this is the first page of a new
document. AventX uses whatever “key” values have been defined. If only UID1 is defined, report separation
will be based solely on that “key” on each page. If both UID1 and UID2 are defined, report separation will be
based on both “keys” on each page and so forth. It is important also to note that the generic pager scripts use
information provided in the UIDs to determine when a new document starts in the batch. If all UIDs supplied
do not match the last set of UID values, a new document is assumed.

Configuring Software Modules - AventX for Oracle EBS

Page 198 of 944
Proprietary to STR Software
Delivering Documents
At this point you should now have the basic document setup configured to send a test email to your email
address. There are other features you will may wish to implement.

Automatic Delivery

Consult the section “AventX Forms and Field Descriptions” for additional configuration and setup of AventX
Automatic features.

Interactive Delivery

There are several methods for using the AventX Interactive Delivery form.

• From Submit Request

• From an Oracle Menu Item
From Oracle Submit Request

The AventX Interactive Delivery form can be used with any concurrent program that allows the user to select
the “AventX Interactive” printer from the “Submit Request” form.

Configuring Software Modules - AventX for Oracle EBS

Page 199 of 944
Proprietary to STR Software
Perform the following to configure a document for use with the AventX Interactive Delivery Printer.

• Launch the “Document Configuration” form.

• Pick your Document
• Complete the section on the form for the Interactive Delivery Properties.

Configuring Software Modules - AventX for Oracle EBS

Page 200 of 944
Proprietary to STR Software
After selecting the document type and clicking OK, the default settings for this standard document type
(Purchase Order in our example) are displayed, as below:

Field Value

Document Name This field is automatically populated with the standard document name from
AventX Oracle Connector. The value cannot be changed.

Document Defaults

Document Type This field is automatically populated and used by AventX for report separation and
document recognition when using Automatic Delivery and for form application
when using AventX Forms Design and Integration. The value cannot be changed.
For this example, the document type is “po”.

Subject Template This alpha-numeric field has a limit of 256 characters (when expanded) and
supports the use of “tokens” :UID1, :UID2,:UID3, :UID4, :UID5 and/or :ORGID.
When “tokens” are used, the token will be replaced by its value to determine the
“final” value.
For Interactive Delivery, the values for :UID1 - :UID5, :UID4 and :UID5UID5 will
come from the parameters form for the report, which is described later in this
table.
For Stand Alone Interactive Delivery, the values for :UID1 - :UID5, :UID4, :UID5
come from forms personalization parameters as set by the System Administrator
during the forms personalization configuration process.
For Automatic Delivery the values for these tokens will be extracted from the report
output and passed back into the report writer for use in the queries, or in this case,
to be used in the [SUBJECT= command.
For text report output, the ROW, COLumn and LENgth locators are specified in the
AventX document configuration.
For formatted report output (e.g. PDF or HTML), the values will be specified in the
FAX_INFO strings (e.g. FAX_INFO:<UID1>:<UID2>:<UID3>:<UID4>:<UID5>:)
For Delivery Manager functionality, the values for these tokens (:UID1 - :UID5,
:UID4, :UID5) will be extracted from the DM_FAX_INFO tag in the report output and
passed back into the command file generator for use in the queries, or in this case,
to be used in the [SUBJECT= command. For text and formatted report output (e.g.,
PDF), the values will be specified in the DM_FAX_INFO strings (e.g.
DM_FAX_INFO:<request_id>:<doc_type>:<pCOMMAND>:<pPRNFORM>:<pSPECIAL
>:<UID1>:<UID2>:<UID3>:<UID4>:<UID5>),>), which are described in Chapter 13,
“Setting up Documents for Delivery Manager Functionality”.

Configuring Software Modules - AventX for Oracle EBS

Page 201 of 944
Proprietary to STR Software
Field Value
For Delivery Manager functionality, the value for the :BI_SUBJECT token will be
extracted from FAX_DM_DATA.SUBJECT.
If the Subject value is set to :BI_SUBJECT and the document is processed using
Automatic or Interactive Delivery, the Subject value will be replaced with
"<Document Name> #<UID1>". (e.g., Purchase Order #1169)
The following characters will be stripped from the SUBJECT value before submission
to AventX UNIX: \ [ ]
The value returned, which is assigned to the [SUBJECT= command, will be truncated
to 80 characters. This value will be displayed on the AventX Interactive
Delivery/AventX Stand Alone Interactive Delivery form, in the AventX Reports and
on the AventX Delivery Status form and can be displayed on the message template.

By default, the subject values for the standard document types for both Automatic
and Interactive Delivery are as follows:
Purchase Order #:UID1
RFQ #:UID1
Sales Order #:UID1
Invoice #:UID1
Statement #:UID1
(where :UID1 by default is the document number).

Interactive Delivery Fields in this section of the canvas will apply only to Interactive Delivery and Stand
Properties Alone Interactive Delivery submissions to AventX. If you are not going to use either
or these methods for this document type, you do not need to fill out these fields.

Configuring Software Modules - AventX for Oracle EBS

Page 202 of 944
Proprietary to STR Software
Field Value

Default Picklist This field determines what the default pick list will be when the AventX Interactive
Delivery/AventX Stand Alone Interactive Delivery form is opened. Valid values are:
▪ Customers by Company – the pick list will contain all customer contacts sorted by
company.
▪ Customers by Name – the pick list will contain all customer contacts sorted by last
name
▪ Employees – the pick list will contain email addresses for all employees (as
defined in the Oracle EBS Human Resource tables) with a type of “EMP” or
“EMP_APL”. .
▪ Users – the pick list will contain all Oracle EBS users
▪ Vendors – the pick list will contain all vendors (site level) sorted by company
▪ Vendor Contacts – the pick list will contain all vendor contacts sorted by last
name.
For more information on the AventX Interactive Delivery/AventX Stand Alone
Interactive Delivery form, consult the AventX Oracle Connector User’s Guide.

Report Name This alphanumeric field has a limit of 256 characters and defines (a portion) of the
actual report name specified on the Submit Request form, to be used to match
against in the configuration.
For example, the report name on the Submit Request form for our example
Purchase Order is “Printed Purchase Order Report(Portrait)”. Therefore, the value
in this field could be “Purchase Order”, “Printed Purchase Order” etc.

If the value specified here does not match a portion of the report name on the
Submit Request form, the AventX Interactive Delivery form will open without having
the proper default configuration.

Configuring Software Modules - AventX for Oracle EBS

Page 203 of 944
Proprietary to STR Software
Field Value

Report Parameter 1 This numeric field (value1-50) specifies the position of the parameter that will be
the “FROM” value in the range for determining :UID1.
For our example for Purchase Order from the Submit Request form, we would
specify 3 (Purchase Order Numbers From).

This field is required if Report Name is specified; not used otherwise.

Configuring Software Modules - AventX for Oracle EBS

Page 204 of 944
Proprietary to STR Software
Field Value

Report Parameter 2 This numeric field (value1-50) specifies the position of the parameter that will be
the “TO” value in the range for determining :UID1. For our example for Purchase
Order from the Submit Request form, we would specify 4 (To).
Interactive Delivery is designed for use with single documents (normally a range or
batch of documents are not intended for the same supplier/customer). If this value
is different than that for Report Parameter 1, the AventX Interactive Delivery form
will post an error when opened.

This field is required if Report Name is specified; not used otherwise.

Report UID2 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID2.
For our example of Purchase Order from the Submit Request form, we do not need
this parameter, so we will leave it blank.
This field is optional if Report Name is specified; not used otherwise.

Report UID3 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID3. For our example for Purchase Order from the Submit
Request form, we do not need this parameter, so we would leave it blank.
This field is optional if Report Name is specified; not used otherwise

Configuring Software Modules - AventX for Oracle EBS

Page 205 of 944
Proprietary to STR Software
 Field Value

Report UID4 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID4. For our example for Purchase Order from the Submit
Request form, we do not need this parameter, so we would leave it blank.
This field is optional if Report Name is specified; not used otherwise

Report UID5 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID5. For our example for Purchase Order from the Submit
Request form, we do not need this parameter, so we would leave it blank.
This field is optional if Report Name is specified; not used otherwise
Make sure to click the save button in Oracle to save changes before exiting the form.

The following will allow you to setup a document for use with the AventX Interactive Delivery form. It will be
a PDF report that is not seeded in the AventX software.

Create the AventX Print Driver

Create the print driver using the same instructions as provide in earlier sections.

Create the AventX Print Style

Create the AventX print style using the same instructions as provide in earlier sections.

Update the AventX Print Type

Update the AventX print type using the same instructions as provide in earlier sections.

Configure the "Default" document type

You need to perform this only if you have not already done so.

All non-standard/non-AYOD documents are configured using the "Default" document type. This
configuration determines how AventX will pre-populate the AventX Interactive Delivery form with
information regarding the destinations, acknowledgements, message template, subject, hold and terms and
conditions.

Each organization or business entity can have its own "Default" document type configuration, or all
organizations can share a common "Default" document type configuration.

It is important to note again that only the "User's Email Address" and "Other" query type will work well with
non-standard/non-AYOD documents when configuring the destination defaults. This is because the
document number and name are not "known" to AventX for processing from the Oracle EBS database. In this
case (non-standard/non-AYOD documents), it is best to either manually enter the destination information or
use the pick list (Vendors, Vendors by name, Customers by name, Customers by company) feature of the
AventX Interactive Delivery form.

Submit the Document

Configuring Software Modules - AventX for Oracle EBS

Page 206 of 944
Proprietary to STR Software
Test the configuration.

From Oracle Menu

Watch the Video

There may be times when it is desirable to submit the document for processing by AventX during the
document creation process. This eliminates the “extra” step of having to manually submit a request for
report creation in order to have AventX process the document for delivery.

Using the Stand Alone Interactive Delivery method, after creating and saving the document, a user can fax,
email, archive, and/or print a single document directly from an Oracle form with the aid of forms
personalization.

This chapter covers the following topics regarding Stand Alone Interactive Delivery.

• Prerequisites for using Interactive Delivery from an Oracle Menu

• User Experience

• Configuration of Forms Personalization

• AventX Configuration

• Testing and Troubleshooting

Throughout this chapter, we will use a Purchase Order (via Oracle Purchasing) as an example, but keep in
mind that this method can be used from any Oracle form that has been personalized (e.g., Sales Orders,
Invoices, etc).

Configuring Software Modules - AventX for Oracle EBS

Page 207 of 944
Proprietary to STR Software
Prerequisites

The steps as outlined in this chapter are great examples of how to setup and configure this feature. The
implementation of this feature may be different for various types of business needs.

Implementation of this feature requires a working knowledge of the following areas:

Knowledge Requirements

• Oracle Forms Development

• Oracle Forms Personalization

Technical Requirements

• Oracle EBS version 11i, 11i.ATG_PF.H Rollup 7 (Patch 6241631) or greater is required for forms
personalization.

• Oracle EBS R12 already includes forms personalization, so no further patches are required.

• AventX Oracle Connector, version 7.2.00 or higher is required.

• For each document type, the parameters required to execute a recipient query (and other query
types) should be available as input values from the menu where the Interactive Delivery form is being
used from

• For each document type, ensuring the document works when submitting to the AventX Interactive
Delivery printer before attempting to enable it use from a menu item.

Configuring Software Modules - AventX for Oracle EBS

Page 208 of 944
Proprietary to STR Software
User Experience

AventX offers submitting from an Oracle Menu as an alternative, whereby the AventX Stand Alone
Interactive Delivery form can be invoked directly from an Oracle form via forms personalization. Forms
personalization will have been configured by the System Administrator. The following images provides an
example using a Purchase Order to demonstrate the user benefit of this feature.

In summary, the user clicks the AventX icon (see the screenshot below) to begin the delivery process of a
single document. Batch delivery of multiple documents is not supported via this feature.

Configuring Software Modules - AventX for Oracle EBS

Page 209 of 944
Proprietary to STR Software
Upon clicking the AventX icon, the AventX Interactive Delivery form is invoked. This is a custom form
designed by STR Software. This form allows a user to specify or modify the address information for the
document’s delivery.

By default, the parameters on the form are pre-filled with data from the Oracle tables, based on the
configuration specified for AventX.

Configuring Software Modules - AventX for Oracle EBS

Page 210 of 944
Proprietary to STR Software
Setup and Configuration

Specifying the document parameters

The user creates the document and specifies the parameters as normal. For our example of a Purchase Order,
this would be accomplished on the Purchase Orders canvas:

Configuring Software Modules - AventX for Oracle EBS

Page 211 of 944
Proprietary to STR Software
Activating the AventX Interactive Delivery form

After saving final changes on the Oracle form, the user clicks the AventX icon (see the screenshot below) to
begin the delivery process of the document. It is important to note that SAID is designed to deliver a single
document.

Configuring Software Modules - AventX for Oracle EBS

Page 212 of 944
Proprietary to STR Software
Upon clicking the AventX icon, the AventX Interactive Delivery form is invoked. This is a custom form
designed by STR Software. This form allows a user to specify or modify the address information for the
document’s delivery.

By default, the parameters on the form are pre-filled with data from the Oracle tables, based on the
configuration specified for AventX.

Once the desired information has been entered, the user clicks the <Submit> button to begin the delivery
process of the document. At this point, SAID calls Oracle’s fnd request.submit_request function to submit a
request in the background to the concurrent manager. A request ID is returned to the user, indicating that
the information that was entered has been successfully submitted as a concurrent request.

Configuring Forms Personalization

Oracle forms personalization is a powerful and flexible feature provided by Oracle which allows a System
Administrator/DBA to control the behavior of an Oracle form. More information about forms personalization
can be found in the following Oracle metalink notes:

NOTE:279034.1 - Information About the Oracle Applications Form Personalization Feature in 11i
NOTE:395117.1 - Form Personalizations in Oracle E-Business Suite (Release 12)

In this section, we will only be discussing the components of forms personalization that are required for a
proper implementation of SAID. Other rules and conditions may need to be developed via personalization to
meet the business rules of your users.
Continuing with our Purchase Order example, we will create two forms personalization rules.

Configuring Software Modules - AventX for Oracle EBS

Page 213 of 944
Proprietary to STR Software
The first rule creates a menu item called “Deliver with AventX” and associates it with the AventX icon on the
toolbar. The second rule responds to the user clicking the “Deliver with AventX” menu item (or AventX icon)
by launching the AventX Stand Alone Interactive Delivery form with the proper parameters.

Invoking Forms Personalization

Invoke the form that you will use to create your document, and select Help->Diagnostics->Custom Code->
Personalize from the menu at the top of the form, as shown in the figure below

If you do not see the Diagnostics menu, or you receive a message stating “Function not available to this
responsibility”, it is likely not enabled. Check settings for the following profiles:

“Hide Diagnostics menu entry” –should be set to “No”

“Utilities: Diagnostics” –should be set to “Yes”

Configuring Software Modules - AventX for Oracle EBS

Page 214 of 944
Proprietary to STR Software
The Forms Personalization form will be displayed. The figure below shows an example of the Forms
Personalization form for the Purchase Orders form. In our example, there is currently no forms
personalization entries for this form, however, your form may have entries already populated here.

The top part of the form specifies rules that apply either to a particular function or a form. The bottom part
of the form specifies under what condition the rule is applied, and what actions to take if the conditions are
met.

As previously mentioned, we need to define two rules. The rules can apply at either the form or function
level, depending upon your forms personalization needs. Recall that the first rule is to define a menu item
(also associated with a button on the toolbar) that the user will click on to invoke the AventX Stand Alone
Interactive Delivery form.

Defining the First Rule

To define the first rule, click in the next available row at the top of the form. Assign an unused, sequence
number in the Seq column, and type something like “Add AventX Interactive Delivery Menu Item” as the
Description.

Condition Tab
You may configure personalization to add logic to control when the button is available. In our example, we
will enable the menu item/button) as soon as the form is invoked, but you may have different “timing”
needs. This is fine, if the user has access to this menu item/button) at some point during the forms session.

Configuring Software Modules - AventX for Oracle EBS

Page 215 of 944
Proprietary to STR Software
To make the menu item/button available as soon as the form is invoked, under the “Condition” tab, ensure
that the “Trigger Event” is set to “WHEN-NEW-FORM-INSTANCE”, and the “Processing Mode” is set to “Not in
Entry-Query Mode”.

This tells Oracle that the conditions under which the rule should apply will be when a new form is launched
by the user. No other entries need to exist on the “Condition” tab for this rule, but of course, you may build
in as much personalization as you need. An example of our progress so far is illustrated below

Configuring Software Modules - AventX for Oracle EBS

Page 216 of 944
Proprietary to STR Software
Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the first rule is to add a menu item/button. Click in first row on the left-
hand side of the form. Assign a new sequence number, and for “Type”, select “Menu”, leave the
“Description” field blank, and set the language to “All”. Ensure that the “Enabled” checkbox is checked.

The right-hand side of the form specifies details regarding the actual menu item/button to be displayed when
the form is invoked. Click the arrow of the “Menu Entry” drop down box, and select the next available MENU
entry. In our example, no personalized menus exist, so we can select the MENU1 entry.

Type in a meaningful label for the menu item. For example, “Deliver with AventX”. This is the text for the
menu item as well as the “help text” that the user will see when hovering over the associated toolbar button.

Ensure that the “Render line before menu” checkbox is checked.

Configuring Software Modules - AventX for Oracle EBS

Page 217 of 944
Proprietary to STR Software
Specify the name of an icon (without the extension) that you wish to use as the toolbar button to represent
this menu item. During step 2 of setup_forms.sh (installation), a default icon was copied to
$OA_JAVA/oracle/apps/media for SAID use. You may use this icon, called str_delivery_icon,
as the representation of your menu item. No other fields are required on the “Actions” tab. Don’t forget to
save your changes!

Defining the Second Rule

So far, we have created a rule that displays a menu item/button based upon the user invoking the Purchase
Orders form. The next step is to create a second rule that is a response to the user clicking the “Deliver with
AventX” menu item/button. When this item is selected, the AventX Stand Alone Interactive Delivery form
will be launched with the defined, proper parameters passed to it.

Therefore, our second rule will have one condition associated with it (the selection of our MENU item created
in the first rule), and one Action associated with it (the launching of a function called FCOA_FCOASAID which
invokes the AventX Stand Alone Interactive Delivery form and passes the defined, proper parameters).

Click in the next available row at the top of the form. Assign an unused, sequence number in the Seq column,
and type something like “Respond to AventX Interactive Delivery Menu Item” as the Description.

Condition Tab
Under the “Condition” tab, ensure that the “Trigger Event” is set to “MENUn”, where “n” represents the new
MENU item that you created for the first rule. In our example, this is MENU1. Ensure that the “Processing
Mode” is set to “Not in Entry-Query Mode”. These settings ensure that the rule will be applied when the
menu item/button (created by the first rule) is selected by the user.
Configuring Software Modules - AventX for Oracle EBS
Page 218 of 944
Proprietary to STR Software
In the “Condition” field, enter the following:
:PO_HEADERS.SEGMENT1 is not null and :PO_HEADERS.STATUS like 'Approved%'

This ensures that a Purchase Order has been queried via the Purchase Orders form and has already been
approved before attempting to invoke the AventX Stand Alone Interactive Delivery form. An example of our
progress so far is illustrated in below.

Configuring Software Modules - AventX for Oracle EBS

Page 219 of 944
Proprietary to STR Software
Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the second rule is to launch a function called FCOA_FCOASAID which
invokes the AventX Stand Alone Interactive Delivery form with the defined, proper parameters.

It is assumed that the FCOA_FCOASAID form has already been registered during the initial setup of AventX
(specifically forms registration tasks). If you have not done so at this point, you must register this function to
make it available to forms personalization.

Click in first row on the left-hand side of the form. Assign a new sequence number, and for “Type”, select
“Builtin”. Leave the “Description” field blank, and set the “language” to “All”. Ensure that the “Enabled”
checkbox is checked.

The right-hand side of the form specifies details regarding the type of action. Click the LOV arrow of the
“Builtin Type” drop down box, and select “Launch a Function”.

Configuring Software Modules - AventX for Oracle EBS

Page 220 of 944
Proprietary to STR Software
The “Function Code” field refers the function to be launched. Enter “FCOA_FCOASAID” into the “Function
Code” field, and for the “Function Name”, enter “AventX Stand Alone Interactive Delivery”. Make sure to
save your changes! The following figure shows the progress thus far.

The final section to be completed is the “Parameters” field which is used to denote which parameters need
to be passed to the AventX Stand Alone Interactive Delivery form.

AventX pre-populates the AventX Stand Alone Interactive Delivery form based on either seeded or pre-
configured queries specified via the AventX Document Configuration form. These queries are dynamic based
on many “tokens” that are passed in to the process such as the document number, organization id, etc. For
the data to be properly populated when the form is invoked, the AventX Stand Alone Interactive Delivery
form must have access to these parameters, which are passed to it via the “Parameters” string defined for
the Actions using forms personalization. The following table describes the parameters that are available to be
passed in the “Parameters” string to the AventX Stand Alone Interactive Delivery form.

Configuring Software Modules - AventX for Oracle EBS

Page 221 of 944
Proprietary to STR Software
Forms Personalization Parameters Supported by AventX

Parameter Name Description Valid values Required?

P_STANDALONE This is a flag to denote TRUE/FALSE Yes1,

whether or not the
Failure to
AventX Stand Alone This should always be set to TRUE
include this
Interactive Delivery for SAID delivery.
parameter
form is being invoked as
will result in
SAID (stand alone
numerous
interactive delivery) or
FRM-40815
normal interactive
errors.
delivery.

P_DOCTYPE This is the document <doctype> Yes

type as specified via the
Failure to
first canvas (Document For example, pop for a Purchase
include this
Defaults section) of the Order document type.
parameter
AventX Document
will result in
Configuration form.
an error
This parameter is used
message.
to identify the proper
configuration and
queries to be used.

P_ORGID This specifies the Number Yes

Organization ID to
Failure to
associate with the For example, this could be a hard-
include this
document coded value or a query/function that
parameter
returns the proper value.
will result in
an error
message.

P_UID1 This specifies a Unique Any value up to 255 characters. No

Identifier for AventX
queries to pre-populate For example, this could be a hard-
data. coded value or a query/function that
returns the proper value.

P_UID2 This specifies a Unique Any value up to 255 characters. No

Identifier for AventX
queries to pre-populate For example, this could be a hard-
data. coded value or a query/function that
returns the proper value.

Configuring Software Modules - AventX for Oracle EBS

Page 222 of 944
Proprietary to STR Software
Parameter Name Description Valid values Required?

P_UID3 This specifies a Unique Any value up to 255 characters. No

Identifier for AventX
queries to pre-populate For example, this could be a hard-
data. coded value or a query/function that
returns the proper value.

P_UID4 This specifies a Unique Any value up to 255 characters. No

Identifier for AventX
queries to pre-populate For example, this could be a hard-
data. coded value or a query/function that
returns the proper value.

P_UID5 This specifies a Unique Any value up to 255 characters. No

Identifier for AventX
queries to pre-populate For example, this could be a hard-
data. coded value or a query/function that
returns the proper value.

P_DEBUG This controls whether or TRUE/FALSE No

not debugging
information should be For production use, this should
displayed to the user always be set to FALSE.
when the form is
invoked and the However, when first setting up
<Submit> button is forms personalization for SAID in a
pressed. Consult the test or development environment,
“Troubleshooting” this is a very useful tool in
section of this chapter troubleshooting any problems that
for examples of the type may arise, by setting the value to
of information TRUE.
displayed.

Configuring Software Modules - AventX for Oracle EBS

Page 223 of 944
Proprietary to STR Software
 Parameter Name Description Valid values Required?

P_TEMPLATE_LANG If using BI Publisher to A valid template language as defined No

apply a template to the by BI Publisher, either by hard-
data, you can specify a coding the value or returning the
template language to be proper value via a query or function.
used to override the
value being used by BI This must return the “short name”,
Publisher. for example “en” and not “English”.

For example, the default If P_TEMPLATE_LANG is specified as

value may be returning a parameter, this value will override
“en” for English, but you any existing values set via the
may want to return AventX Document Configuration
another value to denote form’s Stand Alone Interactive
a different language for Delivery canvas (discussed later).
this particular form.

P_TEMPLATE_TERR If using BI Publisher to A valid template territory as defined No

apply a template to the by BI Publisher, either by hard-
data, you can specify a coding the value or returning the
template territory to be proper value via a query or function.
used to override the
value being used by BI This must return the “short name”,
Publisher. for example “US” and not “United
States”.
For example, the default
value may be returning If P_TEMPLATE_TERR is specified as
“US” for United States, a parameter, this value will override
but you may want to any existing values set via the
return another value to AventX Document Configuration
denote a different form’s Stand Alone Interactive
territory for this Delivery canvas (discussed later).
particular form.

P_OTHER1- Ten tokens used to pass Any value up 240 characters. No

P_OTHER10 additional information
for Concurrent Program
Parameters if necessary
Failure to provide any of the required values specified in the table and clicking the <Submit> button on the
AventX Stand Alone Interactive Delivery form will yield undesired results.

Oracle forms personalization does not support the <space> character in the definition of a parameter in the
“Parameters” string.

Configuring Software Modules - AventX for Oracle EBS

Page 224 of 944
Proprietary to STR Software
Oracle forms personalization uses the <space> character to delimit individual entries in the “Parameters”
string.

To specify the <space> character for an individual parameter within the “Parameters” string, substitute
“%20”. For example, to pass “P_OTHER2=Application Object Library”, enter as
“P_OTHER2=Application%20Object%20Library” in the “Parameters” string.

AventX Oracle Connector will re-substitute the <space> character for the %20 when processing the individual
parameters.

Failure to follow this instruction will result in Oracle forms personalization not passing the proper values for
parameters when triggering the AventX Interactive Delivery form.

For these parameters, if passing values for the AYOD SAID parameters, the actual value must be the
equivalent Oracle short name. Examples of these short names can be viewed by executing the queries as
stored in the FAX_SETUP_RECORD_GROUPS table.

To help clarify the information in the table above, let’s take a look at the parameters that we need to pass for
our Purchase Order document. From the table above, we know that the following parameters are required:
P_STANDALONE (which we will set to “TRUE”), P_DOCTYPE (which we will hard-code as “pop”, and P_ORGID
(which we will obtain by calling FND_PROFILE to extract the value for ORG_ID).

For our Purchase Order example, we will be using AventX seeded queries to populate the AventX Stand Alone
Interactive Delivery form with the proper destinations, acknowledgements, and so forth.

The seeded destination query relies upon the Purchase Order number to look up the supplier associated with
this PO so that the proper delivery information (document delivery method such as email/fax/print, etc. and
the destination such as an actual email address, fax number, etc.) can be retrieved. Therefore, we will need
to supply a value for P_UID1 that will return the document number to be used by the AventX Stand Alone
Interactive Delivery form to populate, at a minimum, the destination information. This :UID1 value is also
used in our example to populate the Subject of the document as displayed on the form.

Configuring Software Modules - AventX for Oracle EBS

Page 225 of 944
Proprietary to STR Software
 UID1 is used to
populate the
Subject with
the Document
Number

Lastly, to successfully submit a concurrent request for a Purchase Order on our system, we are required to
pass the user id of the user submitting the request. This can also be provided by calling FND_PROFILE to
extract the value for ‘:USER_ID’.

For our Purchase Order, we will provide personalization parameters by entering the following SQL query in
the Parameters section of the form:
=select ' P_STANDALONE=TRUE P_DOCTYPE=pop P_ORGID=' ||
FND_PROFILE.VALUE('ORG_ID') || ' P_UID1=' || :PO_HEADERS.SEGMENT1 || '
P_OTHER1=' || FND_PROFILE.VALUE('USER_ID') from dual

Of course, your parameters will not be the exact same as what you see above for your specific document
type. This is simply an example for illustration purposes in assisting you with understanding what parameters
should be included for your specific needs.

Configuring Software Modules - AventX for Oracle EBS

Page 226 of 944
Proprietary to STR Software
Defining the Third Rule
Next, we need to add a rule to control a message being displayed to the user if they try to invoke the AventX
Stand Alone Interactive Delivery form without retrieving a document (in our example, a Purchase Order) first.
For example, under this condition, a user would see a message such as “You must first select a PO to send”
instead of just invoking the form with no Purchase Order. To define the third rule, click in the next available
row under the “Respond to AventX Interactive Delivery Menu Item” that you entered for rule 2. Enter a
sequence number, and a description such as “Respond to AventX Interactive Delivery Menu Item if no PO is
selected”.

Condition Tab
Under the “Condition” tab, ensure that the “Trigger Event” is set to “MENUn”, where “n” represents the new
MENU item that you created for the first rule. In our example, this is MENU1. Ensure that the “Processing
Mode” is set to “Not in Entry-Query Mode”. These settings ensure that the rule will be applied when the
menu item (created by the first rule) is selected by the user. In the “Condition” field, enter the following:
:PO_HEADERS.SEGMENT1 is null

Configuring Software Modules - AventX for Oracle EBS

Page 227 of 944
Proprietary to STR Software
Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the third optional rule is to display a message to the user if no Purchase
Order has been queried when the user attempts to invoke the form.

Click in first row on the left hand side of the form. Assign a new sequence number, and for “Type”, select
“Message”. Leave the “Description” field blank, and set the “language” to “All”. Ensure that the “Enabled”
checkbox is checked.

The right hand side of the form specifies details regarding the type of action. Ensure that the Message Type =
“Show” and type in a message that you would like to see displayed when this condition occurs. For example
“You must first select a PO to send”.

Defining the Fourth Rule

Lastly, we need to add a rule to control a message being displayed to the user if they try to invoke the AventX
Stand Alone Interactive Delivery form without the Purchase Order being approved. For example, under this
condition, a user would see a message such as “You must first approve the PO before it can be sent” instead
of just invoking the form with no Purchase Order. To define the fourth rule, click in the next available row
and enter a sequence number with a description such as “Respond to AventX Interactive Delivery Menu Item
if the PO is not approved”.

Condition Tab

Configuring Software Modules - AventX for Oracle EBS

Page 228 of 944
Proprietary to STR Software
Under the “Condition” tab, ensure that the “Trigger Event” is set to “MENUn”, where “n” represents the new
MENU item that you created for the first rule. In our example, this is MENU1. Ensure that the “Processing
Mode” is set to “Not in Entry-Query Mode”. These settings ensure that the rule will be applied when the
menu item (created by the first rule) is selected by the user. In the “Condition” field, enter the following:
:PO_HEADERS.SEGMENT1 is not null and :PO_HEADERS.STATUS not like
'Approved%'

Configuring Software Modules - AventX for Oracle EBS

Page 229 of 944
Proprietary to STR Software
Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the third optional rule is to display a message to the user if no Purchase
Order has been queried when the user attempts to invoke the form.

Click in the first row on the left-hand side of the form. Assign a new sequence number, and for “Type”, select
“Message”. Leave the “Description” field blank, and set the “language” to “All”. Ensure that the “Enabled”
checkbox is checked.

The right-hand side of the form specifies details regarding the type of action. Ensure that the Message Type =
“Show” and type in a message that you would like to see displayed when this condition occurs. For example
“You must first approve the PO before it can be sent”.

Configuring Software Modules - AventX for Oracle EBS

Page 230 of 944
Proprietary to STR Software
Configuration within AventX

The next step in our configuration is to provide AventX with the SAID parameters as well as the actual
parameters that will be passed to the Concurrent Manager when fnd_submit.submit_request is called. This is
accomplished via the AventX Document Configuration form.

These instructions only cover the specific features to configure AventX Interactive Delivery from an Oracle
Menu. Before attempting to specify these parameters, it is assumed all the other configuration settings for
your document type have been performed. If you have not configured your document using the AventX
Document Configuration form as described in one of these chapters, stop now and follow the steps as
outlined in the applicable chapter. Return to these instructions when you have completed setting up your
document.

As the System Administrator responsibility: Select Install, AventX Document Configuration.

This canvas is an entry/pick-list form. From the pick list, choose the document that you wish to enable for
SAID functionality. We have chosen “Purchase Order”.

Configuring Software Modules - AventX for Oracle EBS

Page 231 of 944
Proprietary to STR Software
Click the Standalone Delivery tab to proceed to the Stand Alone Interactive Delivery canvas. This canvas is
divided into two sections. The first is for the specification of Stand Alone Interactive Delivery parameters.
The second is for the specification of Program Parameters.

So far, we have discussed forms personalization parameters. Now we are adding two other types of
parameters that are needed.

To reduce confusion, let’s pause to clearly define what is meant by these different parameter types. The
following table describes the different parameter types, where they are specified, and what their purposes
are.

Parameter Type Where Specified Purpose

Forms Personalization Forms Personalization form, Provides information to the AventX Stand
Parameters specifically via the Action Alone Interactive Delivery form so that
tab for Rule 2. the proper destination (and other)
information is displayed when the form is
invoked.

Stand Alone Interactive AventX Document Provides information to the AventX Stand
Delivery Parameters Configuration form Alone Interactive Delivery form regarding
the name of the concurrent program to
run, the print style to use, BI Publisher

Configuring Software Modules - AventX for Oracle EBS

Page 232 of 944
Proprietary to STR Software
 information, etc. when using SAID and
clicking the <Submit> button.

Program Parameters AventX Document Provides the actual parameters that are
Configuration form to be passed to the Concurrent Manager
by the AventX Stand Alone Interactive
Delivery form when using SAID and
clicking the <Submit> button (which then
calls fnd_submit.submit_request.
We have already discussed Forms Personalization Parameters in the preceding section. Let’s discuss the
other two types of parameters in detail here, as they are entered via the Stand Alone Interactive Delivery
canvas.

Configuring Software Modules - AventX for Oracle EBS

Page 233 of 944
Proprietary to STR Software
Parameter Configuration
The top section of the form provides an area to enter information for the actual concurrent request to be
run. Information entered here is stored in the table FAX_SAID_INFO.

Parameter Description Required Column in FAX_SAID_INFO

Table

Application The application name Yes SAID_CP_APP_NAME

Name associated with the SAID_CP_APP_NAME_D
concurrent program to be
submitted.

For example, Purchasing

Conc. The name of the concurrent Yes SAID_CP_APP_PROG

Program program to be run by the SAID_CP_APP_PROG_D
Name concurrent manager.

For example, XML Printed

Purchase Order
Report(Portrait)

AventX Print Printer Style that corresponds Yes SAID_CP_STYLE

Style to an AventX Print Driver that SAID_CP_STYLE_D
calls AventX (via a script
named fcprinto.sh).

See “Setting Up Drivers,

Styles, Types, and Printers”
for instructions on how to
setup printer styles and
drivers.

For example, AventX

Purchase Order

Template If using BI Publisher to format Only if using BI SAID_CP_BIP_TEMP_TERR

Territory report, this is the Template Publisher to apply a SAID_CP_BIP_TEMP_TERR_D
Territory. template to the data.
1
For example, United States

Template If using BI Publisher to format Only if using BI SAID_CP_BIP_TEMP_APP

App Name your document, this is the Publisher to apply a SAID_CP_BIP_TEMP_APP_D

Configuring Software Modules - AventX for Oracle EBS

Page 234 of 944
Proprietary to STR Software
 Parameter Description Required Column in FAX_SAID_INFO
Table
Template Application Name. template to the data.
1
For example, Purchasing

Template If using BI Publisher to format Only if using BI SAID_CP_BIP_TEMP_CODE

Code report, this is the Template Publisher to apply a SAID_CP_BIP_TEMP_CODE_D
Code. template to the data.
1
For example, XML STR
Software POP

Template If using BI Publisher to format Only if using BI SAID_CP_BIP_TEMP_LANG

Language report, this is the Template Publisher to apply a SAID_CP_BIP_TEMP_LANG_D
Language template to the data.
1
For example, English

Output If using BI Publisher to format Only if using BI SAID_CP_BIP_OUTPUT_FORM

Format report, this is the Output Publisher to apply a AT
Format template to the data. SAID_CP_BIP_OUTPUT_FORM
1 AT_D
For example, PDF
1
Do not specify a value for this parameter if the concurrent program is to create text-based report output.
Doing so will cause the concurrent manager to forward the request through BI Publisher with undesirable
results.

Pick lists are available for each of the fields in this section of the canvas. When clicking the pick list, you will
notice that the list includes substitution tokens of :OTHER1 - :OTHER 10 as well as :UID1 - :UID5, :UID4, or
:UID5. These tokens represent information that can be loaded into the configuration from forms
personalization parameters.

The bottom half of this canvas specifies Program Parameters. As previously mentioned, these parameters are
the actual values that are to be passed to the concurrent program when fnd_submit.submit_request is called
by clicking the <Submit> button on the AventX Stand Alone Interactive Delivery form. Up to 100 parameters
may be specified. This information is stored in the FAX_SAID_PARAMS table. The Seq value is stored in the
SAID_PARAM_SEQNO column and the Parameter Value is stored in the SAID_PARAM_VALUE column.

If you are unsure of the required parameters for your report, run the report via the Submit Request process
through the concurrent manager and view the details of the request (View→Requests). Figure 0-13 shows an
example of the parameters required for our XML Printed Purchase Order Report(Portrait) request.

Configuring Software Modules - AventX for Oracle EBS

Page 235 of 944
Proprietary to STR Software
Now, simply fill in the parameters, giving each new row in the form a unique sequence number. The figure
below shows an example of the parameters that are required to submit our Purchase Order to the
Concurrent Manager.

Substitution Tokens

Configuring Software Modules - AventX for Oracle EBS

Page 236 of 944
Proprietary to STR Software
In the examples above, you will notice some substitution tokens in place of actual hard-coded values for the
parameters. For the Stand Alone Interactive Delivery parameters, you may use substitution tokens of
:OTHER1 - :OTHER10, :UID1 - :UID5, :UID4, or :UID5 as the values for any of the parameters. These
substitution tokens are placeholders that allow dynamic values to be used for each concurrent request
submission.

For the “Program Parameters”, you may use substitution tokens of :OTHER1 - :OTHER10, :UID1 - :UID5, :UID4,
:UID5, :ORGID, or :USERID. In our Purchase Order example, we use a substitution token of :UID1 to hold the
document number, and a substitution token of :OTHER1 to hold the user id. These values are actually set by
forms personalization parameters (remember our P_UID1= and P_OTHER1= statements in our SQL query)
when the user invokes the form.

Instead of populating P_OTHER1 (which is the USERID) to pull the USERID via a forms personalization
parameter, we could have used :USERID as a substitution token in our Program Parameters section of this
canvas. Both methods yield the same results – the USERID of the user running the request is returned as a
parameter to be used when submitting the request.

Testing and Troubleshooting

At this point, you should have completed all of the steps necessary to configure forms personalization and
AventX for SAID for at least one document type. Now it is time to run a test to ensure that the proper
parameters are populated and passed to AventX for a successful submission of the document to the
Concurrent Manager.

Enabling Debugging

Before attempting to run your test, (assuming you are in a test or development environment), it is a good
idea to turn on debugging via forms personalization. This requires that you modify forms personalization
parameters to add P_DEBUG=TRUE to the Parameters section on the “Action” tab of Rule 2 that you defined.

As described previously, setting P_DEBUG to TRUE allows debugging statements to be displayed to you as
you go through the process of invoking the AventX Stand Alone Interactive Delivery form and clicking the
<Submit> button to submit the document. We will see this “in action” shortly.

After you have set P_DEBUG=TRUE, make sure to save your changes. Exit completely out of the form back to
the Navigator menu to ensure that the changes are active the next time you invoke your form.

Configuring Software Modules - AventX for Oracle EBS

Page 237 of 944
Proprietary to STR Software
Running a Test with Debugging Enabled

Prior to running a test, you should ensure that you have performed all of the normal AventX steps required
for setting up and configuring your document type, and that you are able to submit your document using, at
a minimum Interactive Delivery. This ensures that there are no current problems with “non-SAID”
configuration items. Running the document through normal Interactive Delivery ensures that all destination,
acknowledgement, etc. queries are functioning, that the AventX Interactive Delivery form has been
registered properly, and that the document submits properly to the AventX UNIX queue. This helps to more
readily identify a problem related to your new SAID configuration when you begin testing Stand Alone
Interactive Delivery.

If you are unsure of how to submit a document via Interactive Delivery, consult the AventX Oracle Connector
User’s Guide for assistance.

Once you can successfully submit your document via Interactive delivery, you are ready to run a test for
Stand Alone Interactive Delivery for this document. Continuing with our example, we will be using the
Purchase Order that we have setup.

1. Invoke the form that has been personalized

The first step is to invoke the form that you have configured for personalization. In our example, this is the
Purchase Orders form. As Purchasing Super User, we chose “Purchase Orders” from our Navigation menu to
get to this form. We have created a new Purchase Order, number 6123, shown below.

Configuring Software Modules - AventX for Oracle EBS

Page 238 of 944
Proprietary to STR Software
2. Invoke the AventX Stand Alone Interactive Delivery form
To deliver Purchase Order number 6123, we will invoke the AventX Stand Alone Interactive Delivery form by
clicking our newly created icon, as shown below.

Configuring Software Modules - AventX for Oracle EBS

Page 239 of 944
Proprietary to STR Software
• Debug Enabled
At this point, the AventX Stand Alone Interactive Delivery form should be invoked. Due to the fact that we
enabled debugging (via the P_DEBUG=TRUE in our forms personalization parameters), we will see many
different debugging messages displayed. The first message alerts you that debugging is enabled, as shown
below.

Upon clicking <OK>, you will receive other messages, such as:

• Stand Alone Instance of FCOASAID form – this indicates that the AventX Stand Alone Interactive
Delivery form is in “Stand Alone” mode. (e.g., P_STANDALONE=TRUE in your personalization
parameters)

• Set org id: NNN – this indicates the organization ID associated with this document, and is populated
by the P_ORGID forms personalization parameter.

• Specify Recipient, Acknowledgement, and Message Template information, if desired

Upon clearing the debugging statements by clicking <OK> for each, the AventX Stand Alone Interactive
Delivery form is now displayed. The fields on the form are pre-filled with data from the Oracle tables, based
on the configuration specified for this document type in AventX.

At this point, you should see the proper destinations, acknowledgements, and other settings according to
your configuration for this document type. If you do not, this indicates a potential problem with your forms
personalization parameters, destination/acknowledgement queries, or document configuration.

You can modify or delete existing destinations/acknowledgements, add new destinations/

acknowledgements, modify message template settings, add remarks, add and/or delete attachments – the

Configuring Software Modules - AventX for Oracle EBS

Page 240 of 944
Proprietary to STR Software
form functions the exact same at this point as it would if you had invoked it from a submit request session
with the exception that the <Add Attachments> button is now available.

• Submit the document.

Once you have made any desired modifications, click <Submit>. Upon doing so, you will receive a series of
further debugging messages similar to the following (Note: The values displayed below are for illustration
purposes only, relating to a Purchase Order document. You will have different values displayed depending
upon your forms personalization, SAID parameters and program parameter settings). The following table
contains sample messages, their meanings, and what to check in case you do not see the results that you
expected.

Configuring Software Modules - AventX for Oracle EBS

Page 241 of 944
Proprietary to STR Software
Sample Debug Message Meaning Troubleshooting

Loading data from fax_said_info for This is a notification that an N/A

doc id: -1 attempt is being made to read
the FAX_SAID_INFO table for this
specific document. This table
holds the settings for the Stand
Alone Interactive Delivery
parameters that you entered via
the AventX Document
Configuration form.

Application Name: PO Program This information is the data that Ensure that the information
Name: POXPRPOPX Style: AventX was loaded from displayed matches what you
Purchase Order Template FAX_SAID_INFO, which should expected to see.
Application: PO Template Lang: en reflect the values that you chose
You will note that some of
Template Territory: US Template from the pick lists when
the values are “short name”
Code: XML_STR_POP Output: PDF specifying the Stand Alone
versions of what you
Interactive Delivery parameters
selected from the pick list.
via the AventX Document
For example, we chose
Configuration form.
“English” from the pick list
for Template Territory, but
“en” will be displayed here,
as the short name is
required when submitting
the concurrent request.

If the values are not what

you expected to see, go back
to the AventX Document
Configuration form, and
check the setting(s) in the
Stand Alone Interactive
Delivery Parameter section
of the canvas.

Configuring Software Modules - AventX for Oracle EBS

Page 242 of 944
Proprietary to STR Software
Sample Debug Message Meaning Troubleshooting

Loading parameters from This is a notification that an N/A

fax_said_params attempt is being made to read
the FAX_SAID_PARAMS table for
this specific document. This
table holds the settings for the
Program parameters that you
entered via the AventX Add New
DocumentWizard.

After token replacement – The information displayed here If the values are not what
Application Name: PO Program reflects the same type of you expected to see, go back
Name: POXPRPOPX Style: AventX information that you saw to the AventX Document
Purchase Order Template previously, however, at this Configuration form, and
Application: PO Template Lang: en point, two “behind the scenes” check the setting(s) in the
Template Territory: US Template actions have taken place. Stand Alone Interactive
Code: XML_STR_POP Output: PDF Delivery Parameter section
1. Any value specified for a forms of the canvas.
personalization parameter, such
as for P_TEMPLATE_LANG, for Also check the settings for
example, has overridden the your personalization
Stand Alone Interactive Delivery parameters. Remember, if
parameter. For example, it may you specify a personalization
be desirable to set the language parameter that also exists as
of the BI Publisher template to a parameter in the Stand
be something like ‘fr’’ for French Alone Interactive Delivery
(by setting the parameters, the value for
P_TEMPLATE_LANG the personalization
personalization parameter) from parameter overrides the
a French-based Oracle form. Stand Alone Interactive
Otherwise, for English based- Delivery parameter value.
forms, no P_TEMPLATE_LANG
would be set as a forms
personalization parameter, thus
accepting the default from the
Stand Alone Interactive Delivery
Parameters, e.g., set it to “en”,
for English.
2. Any substitution tokens
included in the Stand Alone
Interactive Delivery parameters
have been applied at this point.

Configuring Software Modules - AventX for Oracle EBS

Page 243 of 944
Proprietary to STR Software
Sample Debug Message Meaning Troubleshooting

CR Parameters: 1:R 2: 3:6123 4:6123 This information is data that was If the values are not what
5: 6: 7: 8: 9: 10: 11:Y 12: 13:1013416 loaded from FAX_SAID_PARAMS, you expected to see, go back
14:2 15:N 16: 17:Y 18:N <and so on> and shows the values (after to the AventX Document
token substitution) from the Configuration form, and
information that you entered as check the setting(s) in the
Program parameters via the Program Parameters section
AventX Document Configuration of the canvas.
form.
Additionally, check to ensure
Notice in our example, that our that your substitution tokens
values for parameters 3 and 4, are being populated with the
which we specified as :UID1, correct values, by cross-
have been replaced with ‘6123’, referencing them with your
our Purchase Order number. forms personalization
parameters.
Also, our values for parameter
number 13, which we specified The CR Parameters listed
as :OTHER1, has been replaced here in this message should
with our Oracle USER ID. match what you would see
displayed in the Parameters
field of a View Requests
form if you were to submit
the request through the
concurrent manager
“manually”.

Fax Sequence Number: 177 This is a special sequence N/A

number used by AventX to
match up the data between
tables for destinations, etc.

Submitted Concurrent Request: This the concurrent request ID as If you do not receive a
5808382 returned back from the request ID, or another type
Concurrent Manager. This of error message is
indicates that the call to displayed, it is likely that
fnd_request.submit_request something is not correctly
was successful. configured for the
parameters that are being
passed to the Concurrent
Manager. Go back to the
AventX Document
Configuration form, and

Configuring Software Modules - AventX for Oracle EBS

Page 244 of 944
Proprietary to STR Software
 Sample Debug Message Meaning Troubleshooting
check the setting(s) in the
Program Parameters section
of the canvas.

• Check on the status of your document submission and delivery

Once you have successfully submitted your document, you can check on the status of your document’s
delivery using the AventX Delivery Status form. Using your current responsibility, view your concurrent
requests. Select the proper concurrent request ID, and click the <Zoom> button to view your document’s
delivery status. An example for our request ID of 5808382 is shown below. Our document is now sitting on
Hold in the AventX queue!

• Turn off Debugging

Once you have successfully submitted your document using Stand Alone Interactive Delivery, don’t forget to
once again modify your forms personalization parameters to turn off debugging. This is accomplished by
removing the P_DEBUG= parameter from the list of forms personalization parameters, or by setting the value
to FALSE.

Message Prompts

There may be times where you may want to restrict users from submitting documents based on a specific
situation. For example, with Purchase Orders, it may be important to have the process prevent users from
submitting the document to AventX if the Purchase Order is not approved. This can be implemented using
the following technique. The end result produces the following prompt to the users if the “Status” of the
Purchase Order “Requires Re-approval”.

Configuring Software Modules - AventX for Oracle EBS

Page 245 of 944
Proprietary to STR Software
This feature can be implemented by adding a few more things to the forms personalization of the Interactive
Delivery feature in the menu item. Click on Help > Personalize >

Add the following to the “Conditions Tab”. You will to insert this after the “Add AventX Interactive Delivery
Menu Item” and before the “Respond to AventX Delivery Status Menu Item” action.

Configuring Software Modules - AventX for Oracle EBS

Page 246 of 944
Proprietary to STR Software
Add the following to the “Actions” tab.

Attachments

Configuring Software Modules - AventX for Oracle EBS

Page 247 of 944
Proprietary to STR Software
Commencing with version 7.5.00, the AventX Stand Alone Interactive Delivery form may be used to add
attachments for a given submission (i.e. “ad hoc” attachments), using standard Oracle EBS attachment
functionality. In order to provide this functionality, it is necessary to create an attachment entity within
Oracle EBS. Aside from being necessary for AventX to delete “Interactive” attachments from all affected
Oracle database tables, this attachment entity allows for easier organization and tracking of attachments.
Additionally, Oracle advises that custom functionality should be implemented with custom objects within
Oracle EBS to minimize the impact of upgrades/patches etc. If you are creating a custom entity, make sure
the Entity ID and the Entity Name are both unique values.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select “Attachments -> Document Entities” from the Navigator form window.
• Create the attachment document entity as shown.

You can use the following guide to help input the values.

Field Value

Table Value must be “FAX_ATTACHMENTS”.

Entity ID Value must be “SAID_ATTACHMENTS” to work with attachment retention algorithm.

This field needs to be unique.

Entity Name The entity name the user sees on the Oracle EBS Attachments form. Recommended
value is “AventX Stand Alone Interactive Delivery Attachments”. This field needs to be
unique.

Prompt The user’s prompt. As of EBS R12 this value was not used, although required.
Recommended value is “AventX Stand Alone Attachments”.

Configuring Software Modules - AventX for Oracle EBS

Page 248 of 944
Proprietary to STR Software
 Application The application that owns the entity or entity table. It is recommended to use a
custom application for AventX. Reusing Oracle Applications product names can cause
problems when patching or upgrading. Recommended value is “AventX Oracle
Connector”.
• Select File -> Save from the menu and close the form.
Register the attachment document entity

If using the <Add Attachments> button functionality on the AventX Stand Alone Interactive Delivery form, it is
necessary to register the newly created attachment document entity with the form, and enable the standard
Oracle attachment functionality on blocks of that form that should allow the Attachments form to be
activated.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select “Attachments -> Attachment Functions” from the Navigator form window.
• Create the attachment function as shown.

You can use the following guide to help input the values.

Field Value

Type The type of the attachment function. Value should be “Form” to tie the attachment
functionality to the AventX Stand Alone Interactive Delivery form.

Name The short name associated with the AventX Stand Alone Interactive Delivery form.
Select “FCOASAID” from the LOV.

User Name The display name of the form specified in the “Name” field. The value will be
automatically populated based on the “Name” value selected.

• Select File -> Save from the menu.

Register all desired document categories to be available on the AventX Stand Alone Interactive Delivery form.
Click the <Categories> button.
Configuring Software Modules - AventX for Oracle EBS
Page 249 of 944
Proprietary to STR Software
• Specify all desired document categories.
• Select File -> Save from the menu.
• Define the block on the AventX Stand Alone Interactive Delivery form where the <Add Attachments>
functionality should be enabled. Click the <Blocks> button and configure the block declaration as shown
below.

• Select File -> Save from the menu.

Associate the attachment document entity with the block on the AventX Stand Alone Interactive Delivery
form. Click the <Entities> button and configure the entity declaration as shown in Figure 6-nn.

Configuring Software Modules - AventX for Oracle EBS

Page 250 of 944
Proprietary to STR Software
You can use the following guide to help input the values.

Field Value

Entity The entity associated with the form block. Value should be “AventX Stand Alone
Interactive Delivery” from the LOV.

Privileges The values on this tab are used to restrict access to creating/modifying/deleting
attachments.

Primary Key This tab is used to define the unique identifier used to store attachments in the oracle
Fields database. For the AventX Stand Alone Interactive Delivery form, Key 1 will always be
“FCOA.FAX_SEQNO”. All other key values will be blank.

• Select File -> Save from the menu.

Configuring Software Modules - AventX for Oracle EBS

Page 251 of 944
Proprietary to STR Software
There is an outstanding Oracle condition with this functionality, as shown in the following figure, which is
described in metalink note #1273599.1. Should you encounter this condition, follow the Oracle note for the
work around.

Configuring Software Modules - AventX for Oracle EBS

Page 252 of 944
Proprietary to STR Software
Creating an attachment, document category

If using the <Add Attachments> button functionality on the AventX Stand Alone Interactive Delivery form, it
may be desirable to create an attachment document category within Oracle EBS to be associated with any
added attachments. This is not necessary, and existing attachment categories (e.g. "To Supplier",
“Miscellaneous” etc.) may be used.

• Log in to Oracle Applications with the Application Developer responsibility.

• Select “Attachments -> Document Categories” from the Navigator form window.
• Create the attachment document category as shown.

You can use the following guide to help input the values.

Field Value

Category The name of the custom, attachment, document category. Recommended value is
“AventX Attachment”.

Default The default datatype to be applied to any attachments add for this document category.
Datatype It is possible to change the datatype when defining the attachment (e.g. to “File” for
extraction from the database).

Application The application that is associated with this document category. It is recommended to
use a custom application for AventX. Reusing Oracle Applications product names can
cause problems when patching or upgrading. Recommended value is “AventX Oracle
Connector”.

Configuring Software Modules - AventX for Oracle EBS

Page 253 of 944
Proprietary to STR Software
• Click the <Assignments> button to associate this new document category with the AventX Stand Alone
Interactive Delivery form.
• Select File -> Save from the menu and close the form.
• Ensure the XXSTR_INTERACTIVE_ATTACHMENTS profile option is configured for the users who require
access to this feature.

Configuring Software Modules - AventX for Oracle EBS

Page 254 of 944
Proprietary to STR Software
Email

AventX offers many features and functionality regarding emailing documents. Email delivery is discussed
throughout this document. This section provides information on some of the unique features available in
AventX to email documents.

Grouping Emails

The email grouping feature is unique to AventX and allows organizations to automatically group emails
together that are being sent to the same email address. This section provides information about email
grouping that is specific for use with the AventX Oracle Connector software. For more information about this
feature please consult the AventX UNIX Resource Guide.

The following shows how email is typically handled by software applications:

With email grouping, recipients receive fewer emails because they are grouped into a single transmission:

The email grouping feature can be enabled in the AventX Oracle Connector software via the following
methods:

• Enabled globally for all documents

• Enabled for one or more document types
• Enabled conditionally based on the results of a query. For example, if only one customer or supplier
wants emails grouped then a query can be created that dynamically activates this feature.

Best Practices for Email Grouping

Configuring Software Modules - AventX for Oracle EBS

Page 255 of 944
Proprietary to STR Software
Group Send can be enabled globally for all documents within AventX UNIX (run the command fcmgr -
admin -c 'set egs=yes' for Email Group Send and fcmgr -admin -c 'set sgs=yes' for Secure
Group Send).

Group Send can also be defined on a per-document or conditional basis within the AventX Document
Configuration Form. It requires 3 additional commands to be configured: EMAILGROUPSEND, DATE, and
TIME. Select Document Configuration from the AventX menu and choose your document from the list of
values, then click Find/Add:

Navigate to the Command Query Tab, then click New Query:

Configuring Software Modules - AventX for Oracle EBS

Page 256 of 944
Proprietary to STR Software
In the Query Name field, select EMAILGROUPSEND, then enter in the details of your query:

Configuring Software Modules - AventX for Oracle EBS

Page 257 of 944
Proprietary to STR Software
To configure a query which simply groups together all emails of a specific document type, set VALUE to 'YES'
and FROM to dual. Click Validate Query to enter bind variables and then Go to test your query:

Configuring Software Modules - AventX for Oracle EBS

Page 258 of 944
Proprietary to STR Software
If the query is valid the results will be shown. Click OK, then OK again to save your changes.

To perform the same changes for Secure Group Send, be sure to select SECUREGROUPSEND from the Query
Name field instead.

Next, we set a transmission delay for each of the emails being submitted from the batch. This technique
allows the entire batch to enter the Aventx UNIX queue before any delivery is scheduled. If this is step is not
implemented the first emails from the batch may enter the queue and be sent before subsequent emails with
the same delivery address can be grouped.

This is done by first determining the maximum time (in minutes) it would take for a batch to complete
bursting the bursting process with AventX Oracle Connector (this step may take some trial and error). Next,
under the Additional Commands tab for the document type in question, configure the following queries:

TIME =

SELECT to_char(actual_completion_date + interval 'X' MINUTE, 'HH24MI')

FROM fnd_concurrent_requests
WHERE request_id=:REQUESTID

DATE =

SELECT to_char(actual_completion_date + interval 'X' MINUTE, 'MMDDYY')

FROM fnd_concurrent_requests
WHERE request_id=:REQUESTID

Where X is the number of minutes to delay transmission. See the example queries in the form below:

Configuring Software Modules - AventX for Oracle EBS

Page 259 of 944
Proprietary to STR Software
Be sure to Validate the query and click OK when done to save your command queries.

Once your command queries are saved, you must apply them to the organization configuration for them to
take effect. This is done on the Additional Commands tab of the AventX Connector Configuration Form:

Be sure to save your changes after updating these records.

Configuring Software Modules - AventX for Oracle EBS

Page 260 of 944
Proprietary to STR Software
Archiving

The AventX Oracle Connector software provides the ability to archive documents and their attachments to
remote and local file systems. The following outlines archiving features that currently exist as well as
planned future functionality.

• Archive documents along with fax, email, and print delivery to a configurable network folder.
• Archive documents to remote folders via FTP with retry configuration.
• Archive documents to remote folders via sFTP with retry configuration.
• Archive documents to multiple locations with different names
• Archive reports AND associated database attachments as individual files.
• Archive reports AND associated attachments into a single combined PDF file (requires the AventX
Translation Server)
• Automatically archive documents to a secondary failover location if primary location fails.
• Provide the ability to notify an external process that archiving jobs are complete through the use of
trigger files.
• Final status of the success or failure of the archive is provided back to the user via the AventX
Delivery Status form.
• Intelligently name archived files using data that does not exist in the report.
• Intelligently name archive file with date, time, and/or automatic counters.
• Intelligently and automatically create archive folder based on inflation tokens and data from within
the report.
• Create underlying folder structures automatically during the archive process.
The AventX archiving feature archives documents AND attachments to remote and local file systems. For the
remainder of this section, the term “archiving” will be used to denote the placement of the document plus
attachments on a file system. The following is an example of the default documents that AventX archives to
the file system without the implementation of inflation tokens.

Configuring Software Modules - AventX for Oracle EBS

Page 261 of 944
Proprietary to STR Software
The following describes the default files that are being archived in the above screenshot:

File Name File Description

DEMO.3287880.00000001.pol.SCNWRK0.PDF This file is the report output file after the report has
been split into individual documents.

DEMO.3287880.00000001.po1.SCNWRK0.*.att.pdf These file(s) are the attachments are extracted from

the Oracle database, SharePoint sites, web servers,
UNC paths, etc. that were associated with the
report/document.

DEMO.3287880. 00000001. po1.SCNWRK0.xml This file contains metadata retrieved from an archive
query.
Archiving Implementation Steps

The following steps outline what is required to successfully archive documents.

• Create an Archive Query for each Document. (Optional)

• Configure Organizations to use ’Archive’ or the Archive Query under the “Destinations” tab for any
document.

• Configure the Archive Destination.

Configuring Software Modules - AventX for Oracle EBS

Page 262 of 944
Proprietary to STR Software
Configure the Archive Destination for a Document

After selecting an archive destination, the next step is to specify the directory path in which AventX is to
place the archive file(s) for archiving. This is accomplished using the AventX Configuration form. First, select
the organization (ORGID) and document type that you wish to configure for archiving. Click the “List
Configured Organizations” button, select the organization and then click “Configure Organization”.

Select the Documents tab and then select the document type from the LOV, as shown below.

Configuring Software Modules - AventX for Oracle EBS

Page 263 of 944
Proprietary to STR Software
Use the navigation arrow on the right side of the form to access the Misc tab:

Configuring Software Modules - AventX for Oracle EBS

Page 264 of 944
Proprietary to STR Software
By default, the “None” radio button is selected, and the Options are not available for configuration.

This portion of the form specifies where documents will be archived. If the fields in the XML Archive
Connection area are greyed out or unavailable, ensure that your license key allows for archiving.

Click one of the transfer methods and then configure the archiving destination. The following are the field
descriptions for this configuration tab.

Configuring Software Modules - AventX for Oracle EBS

Page 265 of 944
Proprietary to STR Software
Feature Description

None Documents will not be archived.

Directory Drop, Specifies the filename that AventX will use when archiving documents. This field can support
sFTP, FTP - any Archive inflation token. Value may be any string of up to 512 characters, but Linux
Filename distributions only support a maximum filename size of 255 bytes. There is no default value.
To configure multiple filenames, place a semi-colon between each filename listing (ex.
PO_[UID1];PO_[UID1]_2). When AventX sees multiple files names configured, AventX
assumes that there are an equal number of destinations that equate to filenames. So, in the
example above PO_[UID1] will be used as the file name for the first destination and
PO_[UID1]_2 will be used as the filename for the second destination.

Directory Drop, Specifies the file extension that AventX will append to the name of the archive file. This field
sFTP, FTP - does not support Archive inflation tokens. Value may be any string up to 30 characters. This
File Extension value does contribute to the Linux maximum filename size. A blank value will have a .PDF
extension.

Directory Drop – Specifies the directory where AventX will place a copy of the report output and associated
Primary Directory attachments. If the specified directory does not exist AventX will attempt to create it. This
Field value is required for all transfer methods. Value may be any string of up to 512 characters.
There is no default value.
Environment variables are supported as part of the pathname. The environment variable
value will be as inflated on the AventX host. For example, if the directory value is
"$FCHOME/archive/po_204" and $FCHOME on the AventX host is "/u01/apps/xxstr", the
actual path used for the archive placement would be "/u01/apps/xxstr/archive/po_204".
The user running the AventX software must have the environment variable defined in their
profile prior to starting AventX; otherwise AventX will not know how to “inflate” that
environment variable.
To configure multiple destinations, place a semi-colon between each destination listing (ex.
/archive/primary;/archive/secondary). AventX will attempt to put copies of the archive files
to both locations.

Failover Directory Specifies a failover directory where AventX will attempt to place a copy of the report output
Field and associated attachments if the primary directory is inaccessible. If the specified directory
does not exist AventX will attempt to create it. Value may be any string of up to 255
characters. There is no default value. Environment variables are supported as part of the
pathname and will behave the same way as the “Primary Directory Field”.
To configure multiple destinations, place a semi-colon between each destination listing (ex.
/failover/archive/primary;/failover/archive/secondary). AventX will attempt to put copies of
the archive files to both locations.

Configuring Software Modules - AventX for Oracle EBS

Page 266 of 944
Proprietary to STR Software
 Feature Description

FTP or sFTP – This is the directory on the FTP server where the archive files will be placed.
Directory Field
To configure multiple destinations, place a semi-colon between each destination listing (ex.
/archive/primary;/archive/secondary). AventX will attempt to put copies of the archive files
to both locations.

FTP or sFTP – Specifies the remote host where AventX will place a copy of the report output and
Host Field associated attachments. This value is required for transfer methods of “FTP” or “SFTP”. The
value may be the IP Address or DNS name of the remote host. There is no default value

FTP or sFTP – Specifies the username on the remote host to be used for the ftp transfer. This value is
Username Field required for transfer methods of “FTP” or “SFTP”. The value must specify a valid user that
has permission for ftp and has proper permissions to the directory where AventX will place
the files. There is no default value.

FTP – Password Specifies the password for the username on the remote host to be used for the ftp transfer.
Field This value is required for transfer methods of “FTP”. The value is not echoed on the form
when entered; and is stored in the database as an encrypted string. There is no default
value.

Combine into PDF Specifying this option instructs AventX to process the archive files (consisting of the Oracle
Field report output for each document, its associated attachments, and terms and conditions, if
specified) via the AventX Translation Server (refer to the earlier “Printing Oracle
Attachments” section for details). This will combine all of the archive files into a single PDF
file which will then be placed in the archive directory as configured. The default value is
unchecked.
Configuring Multiple Destinations for Archiving

If you are configurting multiple destinations for archiving AventX expects there to be an equal number of
filenames, directories, and failover directories (if specified). So, if you have two directories configured for
archiving then there needs to be two filenames configured as well.

Also, multiple destination archiving only supports multiple destinations for the same archiving type. This
means that if you are using Local File Drop as your archiving method all destinations must be accessible
through local file drop. Mixing and matching file destinations and archiving types (Local File Drop, FTP, and
sFTP) is not supported.

Configuring Retries for FTP/sFTP

Configuring retry functionality will require access to the AventX host. In the AventX FCOA configuration file
located in $FCHOME with the naming convention of .fcoa_cfg_<instance name>, the below environment
variables can be set:

Configuring Software Modules - AventX for Oracle EBS

Page 267 of 944
Proprietary to STR Software
 cFTP_RETRY Number of retries to perform in the event of FTP
archive failure.

cFTP_DELAY Delay between retries (in miliseconds)

cFTP_RETRYFAILOVER Number of retries to perform in the event of FTP

archive failure to failover directory.

cFTP_DELAYFAILOVER Delay between retries (in miliseconds).

cSFTP_RETRY Number of retries to perform in the event of sFTP

archive failure.

cSFTP_DELAY Delay between retries (in miliseconds).

cSFTP_RETRYFAILOVER Number of retries to perform in the event of sFTP

archive failure to failover directory).

cSFTP_DELAYFAILOVER Delay between retries (in miliseconds).

Example configuration that will retry once and wait 2 seconds between retries for FTP/sFTP attempts:

export cFTP_RETRY="1"

export cFTP_DELAY="2000"

export cFTP_RETRYFAILOVER="1"

export cFTP_DELAYFAILOVER="2000"

export cSFTP_RETRY="1"

export cSFTP_DELAY="2000"

export cSFTP_RETRYFAILOVER="1"

export cSFTP_DELAYFAILOVER="2000"

Configuring Software Modules - AventX for Oracle EBS

Page 268 of 944
Proprietary to STR Software
Naming the Archive File and Folder with Inflation Tokens

The following inflation tokens exist for naming the archiving file and folder name.

Token Types Description

Date and Time • Year = [YEAR] Example = 2016

• Month = [MONTH] Example = April
• Day of Week = [DOW] Example = Friday
• Time = [TIME] Example = HHMMSS
• Date = [DATE] = YYYYMMDD
AventX Commands • Document Sequence Number = [DOCSEQNO] Example= 00000001
• Unpadded Document Sequence Number = [DOCSEQNOUNPAD] Example= 1
• ERP Login = [ERPLOGIN] Example = DEMO
• From = [FROM] Example = ‘[email protected]’
• From Company = [FROMCOMPANY] Example = ‘STR Software’
• From Name = [FROMNAME] Example = ‘John Doe’
• Subject = [SUBJECT] Example = ‘Purchase Order #1234’
• Request ID = [REQUESTID] Example = 4539294
• Owner = [OWNER] Example = DEMO
• User ID = [USERID]
• Document ID = [DOCID] Example = ‘1234’
• ERP Tracking Number = [ERPTRACKNO] Example = 4539294
• System = [SYSTEM] Example = VIS
• Org ID = [ORGID] Example = 204
• Document Type = [DOCTYPE] Example = pop
• UID1-5 = [UID1-5]
• To = [TO] Example = ‘Jane Doe’
• To Company = [TOCOMPANY] Example = ‘STR Software’
• Destination = [DEST] Example = ‘[email protected]’
• ID = [ID] Example = ‘A1’
• Sender User ID = [SENDERUSERID] Example = 1011863
• Worker = [WORKER] Example = SCNWRK0
Other This section is for AventX Additional Commands, which must be configured through a
command query and then added to a specific documents’ Additional Commands list.
• Amount = [AMOUNT] Example = $24.53

Configuring Software Modules - AventX for Oracle EBS

Page 269 of 944
Proprietary to STR Software
 Token Types Description

• Buyer Name = [BUYERNAME] Example = ‘John Doe’

• Country = [COUNTRY] Example = ‘USA’
• Device = [DEVICE] Example = “fax”; which is the device name in AventX queue
• Email Group Send = [EMAILGROUPSEND] Example = ‘YES’
• Fax Group Send = [FAXGROUPSEND] Example = ‘YES’
• Header = [HEADER]
• Locale = [LOCALE] Example “en_US”
• Priority = [PRIORITY] Example = 1
• Requestor = [REQUESTOR] Example = ‘John Doe’
• Secure Group Send = [SECUREGROUPSEND] Example = ‘YES’
• UserData2-7 = [USERDATA2-7]
• Vendor Name = [VENDORNAME] Example = ‘Vendor’s United’
• Urgency = [URGENCY] Example= 1
The following is an example of how the tokens could be implemented.

\\nas\documents\[TOCOMPANY]\[YEAR]\[MONTH]\Purchase_Order_[DOCID].pdf

Final archive file name and folder.

\\nas\documents\Vandelay Industries\2016\April\Purchase_Order_1234.pdf

Configuring Software Modules - AventX for Oracle EBS

Page 270 of 944
Proprietary to STR Software
No matter the archiving method, AventX for Oracle EBS will attempt to make all directories involved in the
archiving job on the host it’s attempting to archive to. This will allow automatic, dynamic creation of
directories with the new substituted token values to create more organized file systems.

Error Handling

If an archive job comes through and any tokens used in the Filename or Directory fields cannot be resolved
then the archiving job will be considered fatal. Also, if the directory cannot be created or the files cannot be
placed in the newly created directories the job will fail.

Assigning Archiving as a Destination

Once the location is configured, ensure the “Archive Destination” is added to the “Destinations” tab to
officially activate archiving.

This is accomplished by configuring a destination type of “XML Archive Connection” (AventX Archive
Gateway) or “Archive” on the Destinations tab. These two destinations are mutually exclusive. Click in the
next available “Send To” field and select “XML Archive Connection” (AventX Archive Gateway) or “Archive”
from the LOV, as shown below.

“Archive” will always be defined as a seeded “Send To” value for each document made. Only those
documents for which an XML Archive Connection (AventX Archive Gateway) Query has been defined will
have this “XML Archive Connection” (AventX Archive Gateway) destination in the LOV. If you do not see this
listed as a possible destination, ensure that you have created the XML Archive Connection (AventX Archive
Gateway) Query.

Configuring Software Modules - AventX for Oracle EBS

Page 271 of 944
Proprietary to STR Software
Make sure to save your settings. After completing all of the steps for configuration AventX is now ready to
process documents for archiving.

Creating an Archive Query - (Optional)

An XML Attribute file may be required by a third party archiving package in order to store information about
the document in the archiving system (e.g. to make it easier for a user to find a particular document). AventX
generates this file based upon the results of a query that is defined for the document.

This query is typically written by a DBA or System Administrator. Allowing an administrator to configure this
query affords the ultimate in flexibility because the query can be changed at any time to add or remove
attributes necessary by the third party archiving software. Additionally, the query can be dynamic based
upon information from within the document itself, therefore returning such information as the document
number and other pieces of identifying information.

This query is configured using the “Configure a Document” button. An example of using this wizard for
configuration of a Purchase Order document follows:

Configuring Software Modules - AventX for Oracle EBS

Page 272 of 944
Proprietary to STR Software
Use the navigation arrow on the right side of the form to access the Archive Query tab as shown in the
following screenshots.

Configuring Software Modules - AventX for Oracle EBS

Page 273 of 944
Proprietary to STR Software
The XML Archive Connection Query canvas, shown below, allows for the entry of the query to define the
aforementioned XML document attribute file. If the canvas is “read only”, ensure that the license key for the
software has AventX Archive Gateway enabled. Also, only one query can be defined/configured for a given
document type.

Configuring Software Modules - AventX for Oracle EBS

Page 274 of 944
Proprietary to STR Software
The following provides a summary of each field:

Field Value

SELECT This REQUIRED alphanumeric field is where the SELECT clause of the SQL query
will be entered. This alphanumeric field has a limit of 4000 characters. If you
need additional “room” for a long query, use the “Select Continued” field on the
form to continue your query.

SELECT Continued This OPTIONAL alphanumeric field is only used for an “overflow” of a query when
the SELECT clause will not fit entirely in the “Select” field. This field supports up
to 4000 characters.

Configuring Software Modules - AventX for Oracle EBS

Page 275 of 944
Proprietary to STR Software
 Field Value

FROM This REQUIRED alphanumeric field has a limit of 2000 characters. It defines the
tables, views, etc. from which the SELECT values will be returned.

WHERE This OPTIONAL alphanumeric field has a limit of 4000 characters. It defines the
conditions to be met in returning the SELECT values.
The Where clause can be made dynamic per document by using the substitution
tokens of :UID1 - :UID5, :ORGID, :REQUESTID, and :SENDER_USERID.
:UID1 – :UID5 fields may be populated from the FAX_INFO or DM_FAX_INFO tag
found in the PDF output file, or they may be extracted from the report output
when it is of TEXT format.. For example, a FAX_INFO tag for a standard Purchase
Order might look like the following:
FAX_INFO:6040:br549:
Where 6040 is the Purchase Order number, and br549 is some other significant
field value. In this instance, the Purchase Order number could be returned as
:UID1, and the other value as :UID2. The same holds true for up to 5 values (e.g.,
:UID1 - :UID5) that can be included in the FAX_INFO or DM_FAX_INFO tag.
The :ORGID is automatically populated from the organization id of the user
running the report.
The :REQUESTID is automatically determined from the value assigned by the
concurrent manager to the request.
The :SENDER_USERID is automatically determined based on who the “sender” is
for this document.
Having these dynamic tokens allows flexibility in creating joins to get the correct
information in the SELECT clause.

ORDER BY This OPTIONAL alphanumeric field has a limit of 2000 characters. It defines what
field will be used to order the rows returned in the query.

After filling out the canvas, click the <Validate Query> button. A new canvas will open form which to perform
the validation. Simply fill in the required fields with valid values that will return the expected XML tags. Then
click <Go> to see the results.

Configuring Software Modules - AventX for Oracle EBS

Page 276 of 944
Proprietary to STR Software
If the query executes properly you will see the XML tags generated as shown below. Otherwise, you will
need to correct the query and attempt validation again. To see the actual SQL statement that AventX will use
in its processing, select the <Show SQL> button. This may help in troubleshooting the problem.

Once the validation is successful, click the <OK> button to proceed.

Configuring an Archive Trigger File (Optional)

In some cases, there may be a need to do post processing of archive jobs with a 3rd party application. AventX
Oracle Connector has the ability to create a trigger file to denote that archiving is complete. To enable
archive trigger file generation the following two options must be defined:

Configuring Software Modules - AventX for Oracle EBS

Page 277 of 944
Proprietary to STR Software
 • archive.create.trigger – Create trigger file to denote archiving is complete. Valid values are “Yes”,
“No” or <blank>. A blank value will default to “No”.
• archive.trigger.destination – Directory in which the archive trigger files will be placed.
The archive trigger filename will have the following format:

• <ORACLE_USERNAME>.<REQUEST_ID>.<DOCTYPE>
The third party application is responsible for cleaning up the trigger files.

Checking the Status of Archive Requests

For each document that is archived, a status message is returned to the AventX Delivery Status form, with a
value of either “Success” or “Fatal”. Points of failure for which a ‘Fatal’ message is returned may include:

• XML File Generation failure (i.e. query fails to create output, unable to copy to destination directory).

• Data File conversion

• Data File copy to destination directory

• Attachment copy to destination directory

If a failure occurs in any of these steps, any previous steps will be “undone” and no files will be deposited to
the XML Archive Connection (AventX Archive Gateway) directory.

Configuring Software Modules - AventX for Oracle EBS

Page 278 of 944
Proprietary to STR Software
The following screenshot shows an example of a failed archive using SFTP due to a non-existent ssh trust.

The following screenshot shows an example of a successful archive for a Purchase Order document.

The ID field will contain the string “ARCn”, where ‘n’ is a sequential number for each archive associated with
this document submission. Note that the Destination field for XML Archive Connection (AventX Archive
Gateway) status messages displays as “ARCHIVE”. This helps the user to easily distinguish archived
documents from fax, emailed, or printed documents.
Configuring Software Modules - AventX for Oracle EBS
Page 279 of 944
Proprietary to STR Software
Testing
At this point, you have performed all of the steps necessary to install and configure AventX and you are ready
to test the installation. This will include invoking all of the forms that were installed, as well as testing the
printer configuration by submitting each configured document through the system.

Testing using AventX Automatic Delivery

Run a test to the AventX Automatic printer to see if your document is working properly. Pick the report, fill in
the report parameters and select the correct STYLE in the Upon Completion form and then fill in the proper
printer name for AventX Automatic delivery.

Make sure the number of copies is at least “1” and then click OK, then Submit to send the document for
processing through AventX. Make note of the REQUEST ID assigned by the concurrent manager; you’ll be
using that to test processing via the AventX Delivery Status form.

Configuring Software Modules - AventX for Oracle EBS

Page 280 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 281 of 944
Proprietary to STR Software
Click on “View Document Status” from the AventX Configuration Form or the “AventX Delivery Status” form
from the Navigator menu.

Type in your REQUESTID and click FIND. Check the fax machine or email addressed you configured in the
“Organization Configuration” form on the “Destinations” tab.

Configuring Software Modules - AventX for Oracle EBS

Page 282 of 944
Proprietary to STR Software
Stress Testing in Your Non-Production Environment

The final CRITICAL step for testing in your non-production environment is to simulate as closely as possible
the amount of volume of each document type that you expect to process through your production
environment. Companies that skip this critical step often regret it, as higher volume processing requires more
processing speed, file handles, etc. than just running a few documents through the system. Therefore, STR
Software strongly suggests that you take the time to set up your non-production system to simulate the
maximum volume as closely as possible before moving into production!

Configuring Software Modules - AventX for Oracle EBS

Page 283 of 944
Proprietary to STR Software
Moving to Production
The following is intended as a guideline to assist customers with moving an existing instance of AventX to
another environment (for example TEST to PROD).

Preparatory Steps

1. Determine the source (Non-Production) and target (Production) hosts to be used for the AventX
software.

2. Review and perform as necessary all items in the following checklist.

This checklist provides information on a few things you should review and perform prior to moving AventX
into production and informing users they can start using the system. It is designed as a generic resource and
may not be 100% applicable to your environment or your organization’s needs, and should not substitute any
internal testing or upgrade procedures that are specific to your environment.

Task Description

Data Integrity Do all Oracle EBS users have email addresses in the PER_ALL_PEOPLE_F table? The
value of checking this information is to reduce concurrent request processing
errors.
To verify, perform the following queries:
select full_name, email_address from per_all_people_f where email_address is
null;
select full_name, email_address from per_all_people_f where email_address not
like '%@%';

Data Integrity For Automatic, Interactive, Stand Alone Interactive, or Print delivery, do all
destinations, such as suppliers and customers, have the appropriate configuration,
i.e. do they have fax numbers and email addresses?
A suggestion is to take the “destination” query you are using, modify it to search
for NULL fax number and/or email address values, and determine which contacts
don’t have fax numbers or email addresses. You may wish to consider changing
the “preferred method of delivery” to “print” until the users can fill in the contact’s
fax number or email address.

Passwords Do you have all of the production passwords required to install the software?

Configuration For Automatic, Interactive, Stand Alone Interactive, or Print Delivery, if using BI
Publisher, verify that all templates have been modified to include the FAX_INFO
tag and uploaded to Oracle EBS.

Configuration For Delivery Manager functionality, verify that all templates have been modified to
include the DM_FAX_INFO tag and uploaded to Oracle EBS.

Configuring Software Modules - AventX for Oracle EBS

Page 284 of 944
Proprietary to STR Software
 Task Description

Configuration For Stand Alone Interactive Delivery functionality, verify that you have setup forms
personalization for the forms that you will be using for submission of documents
using this method.

License Keys Do you have permanent AventX license keys?

Permanent production license keys are provided once payment for the software
has been received. If you wish to move the software into production sooner than
the payment terms on the purchase, then please contact STR Software to make
special arrangements.

It is important to ensure non-production license keys with expiration dates are not
applied to the production system. Non-production keys will display a different
menu bar at the top of the AventX forms.
If you are unsure of whether your license key is a permanent production license
then send the key to STR Software so it can be decrypted.

3rd Party Are all 3rd party internet fax accounts, i.e. Easylink Fax Services and/or FAXCOM
Accounts Anywhere, upgraded from demo mode to full-featured production accounts?

STR Software is happy to check on your behalf to ensure any account is active and
ready for production use.

Test Case Have you completed all the recommended test cases in your non-production
Preparation environment? The following are a few test cases you should have performed prior
to moving the software into production.
Have you tested transmitting reports with various types of attachments, i.e. PDF,
MS Word, Excel?
Have you tested these scenarios:
- no fax number
- no email address
- no printer defined
- bad fax number
- bad email address
Have you tested Automatic Delivery submission (i.e. bursting reports) for batches
that contain multiple documents, some of which have more than one page?
Have you stress-tested the system (i.e. large batches with multiple attachments to
multiple destinations)?
Have you tested from all Oracle EBS responsibilities that will be using the
software?

Configuring Software Modules - AventX for Oracle EBS

Page 285 of 944
Proprietary to STR Software
 Task Description
Have you tested using the same hardware/software architecture as your
production environment?
Have you successfully tested email alerts when a concurrent report fails?
Have you tested document delivery email acknowledgement queries?
Acknowledgements should be delivered according to the configuration specified on
the Acknowledgement tab of the AventX Configuration form.

Personnel Have you assigned troubleshooting ownership to a group or person after the
software is moved into production?

Most organizations will assign support responsibilities to an individual or group of

individuals. It is important the support group is properly trained, especially if the
support group is a different group of people than those who moved the software
through the non-production environments.

Training Has the appropriate user and administrator training been performed?
STR Software offers training services to customers who want a tailored training
program for their staff. Consider using these services to expedite the learning
curve.

Configuration One the software has been installed on the production server have you verified the
environment file settings in $FCHOME/cfg/scripts/setenv are applicable to
production?
Have you verified the global AventX UNIX settings for Override Email Address and
Override Fax Number are set to <blank>?
All SMTP gateways and proxy servers are correct?

Configuration One the software has been installed on the production server have you verified
there are no personal email addresses hard coded in the AventX configuration?
Customers may perform initial testing after the software is moved into production.
Employees may use their personal email address for basic post-production testing.
It is important to remove these email addresses prior to turning the software over
to the users.

Execution Steps for AventX UNIX

• Create a local user account (e.g. aventx) on the target host to be used for the PROD instance of AventX.
This account should have the same characteristics (e.g. shell, group membership, environment variables)
as the corresponding account on the source TEST instance.

Configuring Software Modules - AventX for Oracle EBS

Page 286 of 944
Proprietary to STR Software
• Create a directory (e.g. /opt/aventx) on the target PROD host to serve as the “home” the AventX
installation. This directory should have the same characteristics (e.g. permissions) as the corresponding
directory on the source TEST instance.

• Stop all AventX processes on the TEST instance (e.g. $FCHOME/cfg/scripts/startup.sh stopall).

• Create a tar file of the AventX software on the source TEST instance (e.g. tar -cvf /tmp/aventx.tar
/opt/aventx/* /opt/aventx/.fc*) which will be used to create your PROD instance of AventX. This tar file
will contain both the AventX UNIX and AventX Oracle Connector software. Note: AventX UNIX will not
be included for AventX Attachment Express customers.

• Transfer the tar file (e.g. aventx.tar) to the appropriate directory (e.g. /opt/aventx) on the target PROD
host and extract..

• Edit the login profile (e.g. .bash_profile) of the ‘aventx’ user to include the following entry. This will
ensure that the $FCHOME and $PATH environment variables are properly set for the PROD instance of
AventX UNIX.

# AVENTX UNIX SETUP (BEGIN)

if test -f /opt/aventx/cfg/scripts/profile; then

. /opt/aventx/cfg/scripts/profile

fi

# AVENTX UNIX SETUP ( END )

• Determine the hostname of the target PROD instance (uname –a) and send this information to the STR
Software Technical Support Team. They will create the proper license key for the AventX UNIX software
on this host and provide it to you for registration. You will not be able to start the AventX UNIX software
until it is properly registered.

• Register the AventX UNIX software on the target PROD host using the command string provided by STR
Software Technical Support (e.g. fcmgr -admin -p <license string>). Be sure to include any additional non-
production license keys in the $FCHOME/cfg/license.txt file.

• Remove the AventX UNIX database entries that existed in the TEST instance (e.g. fcmgr -admin -c "dq all"
and fcmgr -admin -c "dd all"). This will ensure that your target AventX UNIX database will only contain
documents that originated from the PROD instance.

• Start AventX UNIX on the PROD instance (e.g. $FCHOME/cfg/scripts/startup.sh startall).

Configuring Software Modules - AventX for Oracle EBS

Page 287 of 944
Proprietary to STR Software
• Login to the PROD AventX WebManager as an Administator and verify all settings and configuration
values correctly reflect the PROD instance (e.g. System General Tab, Document Tab, Reporting Tab).

Execution Steps for AventX Oracle Connector

• Run $FCHOME/oa/ins/setup.sh (where $FCHOME/oa is the installation directory for AventX Oracle
Connector / AventX Attachment Xpress) and choose the ‘Rename’ option to rename TEST to PROD (or the
equivalent values for your environment).

• Remove $FCHOME/oa/log/*, $FCHOME/oa/*.tar, and $FCHOME/oa/database/PROD/log/*.

• Install AventX Oracle Connector / AventX Attachment Xpress by running $FCHOME/oa/ins/setup.sh

(Steps 1 – 7). Refer to the AventX for Oracle EBS Installation and Upgrade Guide for specific details.

• Configure AventX Oracle Connector / AventX Attachment Xpress by following the “Implementation
Overview” section of this document.

• Use the ‘Export Config’ button on the AventX Configuration form of the source TEST instance to create
and save off a ZIP file.

• Use the ‘Import Config’ button on the AventX Configuration form of the target PROD instance to import
the ZIP file from the previous step.

• Open and inspect AventX Configuration and AventX Document Configuration forms to verify all settings
and configuration values correctly reflect the PROD instance (e.g. General Config, Printers, Translation
Servers, Query Tabs).

• Start the AventX process for the PROD instance using “$FCHOME/oa/aventxoc start <SID>”.

Configuring Software Modules - AventX for Oracle EBS

Page 288 of 944
Proprietary to STR Software
Integrating with Oracle EBS Modules
Oracle Purchasing

This section provides some of the best practices when configuring AventX for use with the Oracle Purchasing
module. There are several approaches that administrators can use that provide value to purchasing users.

• Sending Purchase Orders using AventX Interactive from Oracle Purchasing Menu
• Sending Purchase Orders to AventX from Oracle Purchase Order Approve Document Form
• Sending Purchase orders to AventX from Oracle “Tools > Communicate> Form
Sending Purchase Orders from Oracle Menu Button

This option provides the value of the AventX Interactive form by clicking a button on the top of the Oracle
Menu from several key areas of the Oracle experience. The most common place to put the AventX button is
on the following menus in the Oracle Purchasing Module.

• Purchase Order Creation

• Purchase Order Summary Menu
User Experience

This method provides an advanced way of provide the user more features and options than the standard
Oracle forms. This method provides an “icon” at the top of the Oracle menu.

When selected the user is presented with a form that provides the ability to change the SUBJECT of the email
or fax, type or query for unlimited fax, email or print destinations, type in text in the email message body or
Configuring Software Modules - AventX for Oracle EBS
Page 289 of 944
Proprietary to STR Software
fax cover page, add or delete attachments, archive the purchase order, add or remove standard terms and
conditions or put the purchase order on hold so it can be reviewed prior to sending it to the supplier.

If the purchase order is not approved and the user tries to deliver the order to the supplier then the following
message will appear.

Configuration Steps

See “Using Interactive Delivery from Oracle Menu (Standalone Interactive Delivery)” for more information.

Configuring Software Modules - AventX for Oracle EBS

Page 290 of 944
Proprietary to STR Software
Sending Purchase Orders from Purchase Order Approve Workflow / Document Form

This option provides the users with the ability to send purchase orders using AventX from the following
Oracle form.

On the Approve Document form, the user checks one or more of the appropriate boxes for the type of
destination (fax, email and/or print), and when the request(s) are submitted to the Concurrent Manager,
AventX Oracle Connector processes each concurrent request separately to deliver the document to its
intended destination.

AventX can integrate out of the box with Purchase Order Approval for fax and print destinations. These
configuration changes are discussed later in this section. AventX also has two options integrating with
Oracle’s PO Approval Workflow Mailer for enhanced email integration. The following section talks about the
value these integration options bring to the user experience.

AventX provides the following value to companies who integrate AventX with Oracle’s Email Workflow
Mailer.

• AventX will provide a consistent look and feel for email, fax, and print. For example, PO’s to email
addresses, fax numbers and printers will all look the same.
• AventX will extract and deliver any attachments on the PO Header, PO Line, Shipment, or other entity to
print, fax, email, and archive destinations.
• All documents sent to print, fax, email and archive destinations from this workflow are managed in one
location, i.e. AventX Delivery Status form and the AventX WebManager.
• Emails can be sent to multiple email addresses and delivered through AventX email tracking technology.

User Experience

Configuring Software Modules - AventX for Oracle EBS

Page 291 of 944
Proprietary to STR Software
The first step in the document delivery process is document submission. When using the PO Approval
method of delivery, your normal approval process remains exactly the same! AventX Connector does all of
the work “behind the scenes”. After creating your document, click “Approve” to invoke the Approve
Document form.

The Approve Document form is now displayed, from which you specify approval information, and select the
destinations for delivery of the document upon approval of the Purchase Order. You may select any or all of
Print, Fax and E-Mail. Let’s take a quick look at each of these options.

Configuring Software Modules - AventX for Oracle EBS

Page 292 of 944
Proprietary to STR Software
Print Destinations

To send your approved Purchase Order to a printer, click the checkbox next to “Print”. Upon clicking “OK”
your PO document will be submitted for approval, and, once approved, your Purchase Order document will
be routed to the configured printer.

The printer to which the document is routed is dependent upon a configurable setting in AventX Connector’s
tables, as set by your System Administrator. Therefore, it is possible that the approved Purchase Order will
be routed to the default printer of the Workflow Approver, Workflow Buyer, Buyer, Workflow Preparer et. al.
for this PO. Check with your System Administrator if you are unsure of your configuration settings.

Fax Destinations

To send your approved Purchase Order to a fax destination, click the checkbox next to “Fax”. Depending
upon the configuration for the Supplier associated with this Purchase Order, you may or may not have a pre-
populated value in the FAX Number field on the form. This number represents the default fax number for the
supplier’s site associated with this Purchase Order. If this value is acceptable, click OK. Otherwise, you may
change the fax number to the desired value before submitting the document for approval.

Configuring Software Modules - AventX for Oracle EBS

Page 293 of 944
Proprietary to STR Software
Upon clicking “OK” your PO document will be submitted for approval, and, once approved, your Purchase
Order document will be faxed to the specified number by your document delivery system.

Email Destinations

Click the checkbox next to “E-Mail”.

Configuring Software Modules - AventX for Oracle EBS

Page 294 of 944
Proprietary to STR Software
Depending upon the configuration for the Supplier associated with this Purchase Order, you may or may not
have a pre-populated value in the E-Mail field on the form. This value represents the default email address
for the supplier’s site associated with this Purchase Order. If this value is acceptable, click OK. Otherwise,
you may change the email address to the desired value before submitting the document for approval.

Upon clicking “OK” your PO document will be submitted for approval, and, once approved, your Purchase
Order document will be emailed to the specified email address by your document delivery system.

Sending to Multiple Destinations

As previously mentioned, it is possible to specify more than one type of destination for delivery upon the
approval of your Purchase Order. When this occurs, Oracle’s Concurrent Manger submits a separate request
for each type of destination. For example, if you click all three (Print, Fax, and E-Mail) checkboxes on the
Approve Document form, then three different Request IDs will be generated.

Under this scenario, AventX Connector treats each request separately. Depending upon the configuration of
destinations by your System Administrator, it may be possible to receive multiple “carbon copies” of the
same Purchase Order via email to a single email address. This is because AventX Connector generates the
configured number of “carbon copies” for each type of destination. Therefore, it is possible to receive a
“carbon copy” for the printed document, a “carbon copy” for the faxed document, and a carbon copy for the
emailed document.

Once again, this is dependent upon the way that your System Administrator configured these settings, and
you should check with your System Administrator for the configuration settings for your organization.

Options for Getting Purchase Orders into AventX for Email Delivery

Configuring Software Modules - AventX for Oracle EBS

Page 295 of 944
Proprietary to STR Software
There are two options for delivering documents from Oracle Purchase Order Approval workflow. The
following section provides information on how to implement these two options. Each option is available for
Oracle EBS R12.1.X and R12.2.X.
• Do not modify the Oracle workflow and simply redirect emails to AventX
• Modify workflow to generate a concurrent request to “print” to AventX
There are different configuration requirements for each approach; however Option # 1, where workflow is
not modified, provides a quick and easy way of getting Oracle workflow emails into the AventX software.

Caveat: Option #1 does not currently support approving PO’s through the Buyer Work Center.

Option # 1- (Recommended) Redirect Emails to an Inbox and Deliver with AventX Email Poller

This option will deliver the email from Oracle Workflow using existing configuration. A simple redirect of the
Purchase Order Approval emails allows AventX to manage and deliver the emails to their end destination.

Several configuration changes are needed to implement AventX Email Poller:

Mail Server Requirements for using AventX Email Poller

• The Mailbox used by AventX Email Poller must support IMAP or IMAPS protocol
• Email server must be network accessible from AventX so AventX can log into the mailbox via IMAP or
IMAPS protocol on a particular port.
• Email server must be able to create a “rule” to redirect emails with a particular subject value into
another mailbox thereby preventing the email from being sent to the supplier.

Oracle Requirements for using AventX Email Poller

• Email subject must contain a unique “token” for polling purposes. Depending on the desired token
this may require an update to the PO Approval
• Each email must contain the Oracle Workflow Mailer Transaction ID.

Step # 1 – Create a new email inbox on the internal email server

This step is required so AventX can read the inbox for new emails and process them. As a general best
practice naming the mailbox “aventxpomail” helps identify the mailbox’s purpose.

Step # 2 - Create the Email Redirect to a Mailbox (Exchange Example)

This step is required because emails need to be redirected to an internal email address versus sending them
directly to the supplier. AventX will periodically read the emails in the inbox and grab the emails and bring
them into the AventX software.

The following is an example of how to use an email server (Exchange) to redirect an outbound email message
to another mailbox that AventX will monitor to extract and process emails from purchase order approval
workflow. Routing PO Approval emails to the AventX file system requires a small configuration change in

Configuring Software Modules - AventX for Oracle EBS

Page 296 of 944
Proprietary to STR Software
your mail server. Here are the steps needed to perform this in Microsoft Exchange. Launch Exchange and
click on “Tranport Rule” and create a new Transport Rule named “AventX PO Email Workflow” and click
“Next”

Configuring Software Modules - AventX for Oracle EBS

Page 297 of 944
Proprietary to STR Software
Select the action “redirect to message to addresses”. Edit the rule description with “Apply rule to messages
when the Subject Field contains ‘[AXWFM]’ redirect the message to aventxpomail@<yourdomain>.com. Click
“Next” to continue.

Configuring Software Modules - AventX for Oracle EBS

Page 298 of 944
Proprietary to STR Software
Select Condition “when the Subject field contains specific words” add the [AXWFM] value and click “Next”.
No expections need to be defined on the following page.

Click update to apply the change.

Configuring Software Modules - AventX for Oracle EBS

Page 299 of 944
Proprietary to STR Software
Step # 3 – Use Oracle Workflow Builder to Modify the Email Subject AventX Token

Log into Oracle Workflow Builder as the apps user.

Select PO Approval as a Visible Item Type

Configuring Software Modules - AventX for Oracle EBS

Page 300 of 944
Proprietary to STR Software
Expand the Notifications Tab and open the EMAIL_PO_PDF_SUPP Notification.

In the Activity tab, check the Message field to see which message body is assigned to this Notification. In
this example, the value is PO PDF Email.

Configuring Software Modules - AventX for Oracle EBS

Page 301 of 944
Proprietary to STR Software
Collapse the Notifications dropdown and open the Messages dropdown, then navigate to your Notification's
Message body. Again, in this example the Message is EMAIL_PO_PDF_SUPP.

Collapse the Notifications dropdown and open the Messages dropdown, then navigate to your Notification's
Message body. Again, in this example the Message is PO PDF Email.

Configuring Software Modules - AventX for Oracle EBS

Page 302 of 944
Proprietary to STR Software
Right-click, and select Properties. In the Body tab, add "[AXWFM]" to the Subject header.

Be sure to click File -> Save in Workflow Builder to save your changes.

Configuring Software Modules - AventX for Oracle EBS

Page 303 of 944
Proprietary to STR Software
The process is slightly different in R12.2.x. The following is the email template value for Oracle R12.2.x.

Configuring Software Modules - AventX for Oracle EBS

Page 304 of 944
Proprietary to STR Software
Right-click, and go to Properties.

Configuring Software Modules - AventX for Oracle EBS

Page 305 of 944
Proprietary to STR Software
Back Out Procedures
Removing this feature from production only requires a change to the SUBJECT of the email template by
removing the added token from the PO workflow template. Doing this will prevent the email relay server that
performs the email redirect from processing the rule.

Configuring Software Modules - AventX for Oracle EBS

Page 306 of 944
Proprietary to STR Software
Option # 2 – Modify Oracle Purchase Order Approval Workflow

With this option, a System Administrator modifies workflow to redirect purchase orders to the AventX
software to start a concurrent request when the email checkbox is checked on the PO Approval form (instead
of invoking the workflow notification mailer).

Consult the proper documentation for Oracle EBS for information on modifying workflow. STR Software can
provide documentation on how it has modified workflow for its internal environments. Customers using STR
Software’s default instructions should evaluate the changes first and apply those changes to their specific
environment. The instructions may not be applicable to all customer implementations.

The following are the basic steps an administrator must perform.

• Connect to the Oracle database and create the STR_WORKFLOW schema, the STR_WORKFLOW user and
create synonyms for APPS objects.

• In Oracle Worflow Builder modify the EMAIL_PO_PDF process by adding the STR_EMAIL_PO function

• Modify the PO Approval Workflow in all three instances where the supplier is emailed with the
STR_EMAIL_PO function

Reasons to Not Modify PO Approval Workflow

Some companies have corporate IT policies that prevent the modification of the standard Oracle workflows.
Assuming this is not the case, the main reason why a company would not want to modify workflow is the lack
of staff with the technical knowledge to perform the work. Another possible reason is to avoid having to
repeat the work - the same workflow modification must be performed in production as well as any non-
production environments where a company wishes to send PO Approval e-mails through AventX.

Concurrent Copies Must be Changed

AventX ultimately acts as a print destination in Oracle. Since Oracle requires a value for “copies”
greater than zero to initiate a print, you must change the concurrent copies from “0” to “1” to
generate an output file. The AventX Oracle Connector’s “PO Approval” printer requires a copies value
of “1”.. This change is required because AventX presents itself as a printer to Oracle EBS. Oracle EBS
will not print a concurrent request unless copies is greater than "0".

Patches May “Reset” Workflow Changes

In some cases, such as it is with Oracle EBS patches 5903765, 6393663, or 6737543, patches can
delete those changes by resetting the workflow. In this case, the workflow changes must be
reapplied. Upgrading Oracle EBS or applying Oracle patches may revert the PO approval workflow to
its default configuration without notification, forcing programmers to modify workflow again to re-
enable PO Approval e-mail delivery through AventX.

Configuring Software Modules - AventX for Oracle EBS

Page 307 of 944
Proprietary to STR Software
Modifying the Concurrent Program
One of the required steps is to modify the concurrent program’s definition associated with the PO Approval
method to “print” the document to the AventX PO Approval printer.

As the System Administrator responsibility: Select Concurrent, Program, Define, and search for the
concurrent program which creates the Purchase Orders for the PO Approval method:

▪ Print Purchase Orders (for text-based POs)

▪ PO Output for Communication (for PDF-based POs – 11.5.10 or R12 and R12.1 only)
▪ PO Output for Communication:FAX (for PDF-based POs – 11.5.10 or R12 and R12.1only with patch
6393663)
▪ Fax Purchase Order (for Text-based POs with patch 6737543)
The style and printer information will need to be changed. In order to select the AventX PO Approval printer,
it is first necessary to “blank out” the style, by highlighting the current value in the Style field and pressing the
<space bar>. Once the Style field is blank, navigate to the Printer field and select AventX PO Approval from
the list of available printers. After selecting the printer, navigate back to the Style field and select the
appropriate style (e.g., FAX POA Portrait) from the pick list.

Once complete, the configuration for the proper concurrent program should look similar to the one shown
the following for Print Purchase Orders (for text-based POs), or Figure 0-15 for PO Output for Communication
(for PDF-based POs – 11.5.10 or R12 and R12.1 only).

Configuring Software Modules - AventX for Oracle EBS

Page 308 of 944
Proprietary to STR Software
Once this is complete, Purchase Order documents generated using the PO Approval method will be
processed for document delivery by AventX.

Configuring Software Modules - AventX for Oracle EBS

Page 309 of 944
Proprietary to STR Software
Change the Concurrent copies
AventX ultimately acts as a print destination in Oracle. Since Oracle requires a value for “copies” greater than
zero to actually initiate a print, you must change the concurrent copies from “0” to “1” to generate an output
file.

Report Processing
The last step is to ensure that the report output is properly processed and the lookup key values are
extracted for the document. The lookup key values are used to determine delivery address information for
the document. PO Approval submission, by Oracle EBS design, results in the entire report output being a
single document to be delivered; hence only a single document will ever be contained in the submission.

The procedures necessary to ensure proper report processing and lookup key extraction differ depending on
the report output format (refer to the discussion on report output format earlier in this chapter).

TEXT Purchase Orders

For TEXT format, PO Approval Delivery uses certain “key” values (i.e. the lookup key values) to separate the
report output into individual documents. These “key” values are extracted from the report output, using
row, column and length “identifiers”. These “key” values are also used to determine the delivery address
information for each document.

The row, column and length “identifiers” are defined in the AventX configuration form under the Purchase
Order Approval Document configuration.

Each PO Approval document type (i.e. portrait and landscape) will have its own set of up to three
“identifiers”. These provide the information necessary to properly paginate and return delivery information
for each document. AventX automatically defines the “identifiers” for the PO Approval document types.

Note: You may have to change the values assigned automatically by AventX for the PO Approval documents if
your report output is not formatted the same as the Oracle EBS default for that report type.

You can determine the proper values for row, column and length using any text editor (e.g. vi, emacs,
notepad) with a sample report output file. This example is the output file for a portrait PO. AventX requires
as the lookup keys the document number (which includes the release number for releases only) and revision
number for this document type.

Configuring Software Modules - AventX for Oracle EBS

Page 310 of 944
Proprietary to STR Software
It is important to note in Multi-Org Access Control (MOAC) environments that AventX requires that one of
the “identifiers” (e.g., UID3) for the PO Approval document type provide information regarding the value
from po_headers_all.po_header_id. If this information is not supplied, AventX will rely upon the submitter’s
$PROFILES$.ORG_ID and the fnd_concurrent_requests.org_id values to determine the proper required
information. For text-based output, this means that the po_headers_all.po_header_id value must be
included in the text output somewhere, and the proper row and column entries referenced in the AventX
configuration form under the Purchase Order Approval Document configuration.

The following is a screenshot of a sample set of the “identifiers” in the PO Approval Document Configuration
Form for the portrait PO Approval document in a non-MOAC environment.

If test submissions do not have properly separated report output, you may need to adjust the “identifiers” in
the General Configuration tab of the Purchase Order Approval Document Form.

Each page of the report output will be checked for the “key” value(s). If the “key” value(s) is the same as
from the preceding page, this page is added to the current document. If different, this is the first page of a
new document. AventX uses whatever “key” values have been defined. If only UID1 is defined, report
separation will be based solely on that “key” on each page. If both UID1 and UID2 (or other) are defined,
report separation will be based on both “keys” on each page and so forth.

Submitting the PO Approval document(s) through AventX is the best method to determine the success of
report separation.

Configuring Software Modules - AventX for Oracle EBS

Page 311 of 944
Proprietary to STR Software
PDF Purchase Orders
An AventX Information tag, called the FAX_INFO tag, must be added to the report output per the
specifications outlined in the “Bursting Processing” section of this document.

Create AventX PO Approval Printer

A print driver, style, type and printer must be setup to use AventX with PO Approval. This section provides a
summary of what is required to properly configure Oracle EBS to use AventX from PO Approval.

Configure the AventX PO Approval Print Driver

Create the PO Approval print driver in the form below:

Print Driver Field Descriptions

The following table provides an example of the values that are placed into the fields of the print driver form.

Driver Value

Driver Name AventX PO Approval <Format>

Example: AventX Purchase Order PDF

User Driver AventX PO Approval <Format>

Example: AventX Purchase Order PDF

Description AventX PO Approval <Format>

Example: AventX Purchase Order PDF

Configuring Software Modules - AventX for Oracle EBS

Page 312 of 944
Proprietary to STR Software
 SRW Driver HPP For Portrait Reports

HPL For Landscape Reports

Deliver Spool File – Always check this check box.

Method

Arguments Text Purchase $XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER"

Order Approval "$PROFILES$.FILENAME" "0" "$PROFILES$.TITLE"
Report "$PROFILES$.ORG_ID" "$PROFILES$.CONC_COPIES" "[LANG=PCL]"
"poap" "fcdi"

PDF Purchase $XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER"

Order Approval "$PROFILES$.FILENAME" "0" "$PROFILES$.TITLE"
Report "$PROFILES$.ORG_ID" "$PROFILES$.CONC_COPIES" "[LANG=PDF]"
"poap" "none" "pdf"
The following provides detailed descriptions of the print driver argument components:

Parameter Description / Valid Values for PO Approval Delivery

“$PROFILES$.PRINTER” The printer specified in the concurrent report definition for the
Purchase Order approval output. More information on this setting
and how it is specified can be found later in this chapter.
Valid values for PO Approval Delivery drivers are:
<$cAPPROVAL_PRINTER>

(Substitute values for $cAPPROVAL_PRINTER as defined in

$FCHOME/.fcoa_cfg_<SID>.)

“$PROFILES$.FILENAME” The full path name of the output data file as assigned by the
Concurrent Manager.

“0” A “placeholder” for the sequence number for this report passed
from the Concurrent Manager. Used to link reports and Oracle EBS
database table entries for other Oracle EBS delivery methods. (Not
needed by PO Approval delivery method)
Valid value for PO Approval Delivery is 0.

Configuring Software Modules - AventX for Oracle EBS

Page 313 of 944
Proprietary to STR Software
Parameter Description / Valid Values for PO Approval Delivery

“$PROFILES$.TITLE” A combination of the request id assigned by the Concurrent

Manager and Oracle user name that submitted the report. AventX
Oracle Connector supports spaces in the user name portion of
pTITLE, , whereby the spaces are replaced by the underscore “_”
character. For example, “Brent Lowe” would be changed
automatically to “Brent_Lowe”.

“$PROFILES$.ORG_ID” The Oracle EBS Organization ID associated with the Organization

(Oracle EBS) that created this document.

“$PROFILES$.CONC_COPIES” For PO Approval Delivery, this specifies the number of printed

copies to be generated, minus 1 copy which is used for processing
by AventX Oracle Connector. For example, specifying “3” for this
parameter yields 2 printed copies, as one copy was used by AventX
Oracle Connector to generate the deliverable document(s).
This parameter does not indicate the number of deliverable
documents to be created in the document delivery system.

“[LANG=PDF]” Any valid document delivery system command or string of

commands. For example, this command specifies a PDF based file
for AventX UNIX.

“<document type>” The document type code. For PO Approval documents, valid values
are:
poap
poal

“<forms method>” The form printing method. Valid values are:

• none
• fcdi
• generic
• streamserve

Configuring Software Modules - AventX for Oracle EBS

Page 314 of 944
Proprietary to STR Software
Parameter Description / Valid Values for PO Approval Delivery

“<special>” Used to indicate a special condition, such as whether the file is PDF,
HTML, or whether a confirmation copy should be printed for every
document.
Valid values are:
• pdf
• html
• xml
• printcc
• blank
• uncollate
The printed confirmation copy will be of the document only and to
the user’s default printer as specified in the Oracle EBS
configuration.

Configuring Software Modules - AventX for Oracle EBS

Page 315 of 944
Proprietary to STR Software
Configure the AventX PO Approval Style
Use the form below to create the AventX PO Approval for EAM print style:

Populate the form with the following values:

Field Name Value

Style Name AventX PO Approval
Seq Enter a unique sequence number.
User Style AventX PO Approval
Description AventX PO Approval
SRW Driver HPP
Columns 80
Rows 66
Orientation P

Configuring Software Modules - AventX for Oracle EBS

Page 316 of 944
Proprietary to STR Software
Configure the AventX PO Approval Type
Add the “AventX PO Approval” style and driver to the “AventX_POA” printer type. You may need to create
the printer type called “AventX_POA” if it was not previously created.

Perform the following to create the printer type.

• Log in as an Oracle EBS user with the “System Administrator” responsibility

• Select “Install > Printer > Type” to get to the Printer Types form.
• Create the “AventX_POA” printer type and add the AventX PO Approval style and driver to it.

Configuring Software Modules - AventX for Oracle EBS

Page 317 of 944
Proprietary to STR Software
Configure the AventX PO Approval Printer

Configuring Software Modules - AventX for Oracle EBS

Page 318 of 944
Proprietary to STR Software
Back Out Procedures
It is recommended you backup your workflow prior to making modifications. The following instructions
provide a summary of how to save and backup workflow modifications, so they can be reset to older versions
or can be used to migrate changes from one Oracle EBS environment to another.

Perform a “File → Save As” of the unmodified workflow. Save it as a “Filename” by browsing to a location on
your computer and saving.

You can easily migrate changes to one Oracle EBS instance to another by performing your work in an *.wft
file and then saving the workflow changes to a “Database”.

Configuring Software Modules - AventX for Oracle EBS

Page 319 of 944
Proprietary to STR Software
AventX Configuration for Option 1 and Option 2

Configure the AventX PO Approval Tab

The Purchase Order Approval document must be configured for us with at least one organization.

Pick the default organization, which is ORGID “0”, and then the “Purchase Order Approval” document type.
Go to the “PO Approval” tab.

Configuring Software Modules - AventX for Oracle EBS

Page 320 of 944
Proprietary to STR Software
The following table defines each of the parameters on the PO Approval tab.

Parameter Description

Fax Enabled Position The position of the parameter in the concurrent request parameter listing
(viewable from the View Requests form) containing the Fax Enabled Value (see
below), which determines whether this concurrent request is for a faxed
document.
Default value is 7, based upon output generated from the default Oracle EBS
Print Purchase Order concurrent request for a faxed document. If using a
customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be 14.
This data is written to FAX_POA_CONFIG.FAX_ENABLED_POS when the entries
are saved.

Fax Enabled Value The value of the parameter at the Fax Enabled Position (see above) in the
concurrent request parameter listing, which determines whether this
concurrent request is for a faxed document.
Default value is P_FAX_ENABLE=Y, based upon output generated from the
default Oracle EBS Print Purchase Order concurrent request for a faxed
document. If using a customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be Y.
This data is written to FAX_POA_CONFIG.FAX_ENABLED_VAL when the entries
are saved.

Fax Number Position The position of the parameter in the concurrent request parameter listing which
contains the actual fax number for a faxed document.
Default value is 8, based upon output generated from the default Oracle EBS
Print Purchase Order concurrent request for a faxed document. If using a
customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be 15.
This data is written to FAX_POA_CONFIG.FAX_NUMBER_POS when the entries
are saved.

Configuring Software Modules - AventX for Oracle EBS

Page 321 of 944
Proprietary to STR Software
Parameter Description

Fax Prefix The value of the prefix at the Fax Number Position (see above) in the concurrent
request parameter listing which precedes the actual fax number itself.
Default value is P_FAX_NUM=, based upon output generated from the default
Oracle EBS Print Purchase Order concurrent request for a faxed document. If
using a customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be <blank>.
This data is written to FAX_POA_CONFIG.FAX_NUMBER_PREFIX when the
entries are saved.

Fax Suffix The value of the suffix at the Fax Number Position (see above) in the concurrent
request parameter listing which immediately follows the actual fax number
itself.
Default value is <blank>, based upon output generated from the default Oracle
EBS Print Purchase Order concurrent request for a faxed document. If using a
customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only) based upon PDF output
generated from the default Oracle EBS PO Output for Communication request
for a faxed document, this value should be <blank>.
This data is written to FAX_POA_CONFIG.FAX_NUMBER_SUFFIX when the
entries are saved.

Email Enabled The position of the parameter in the concurrent request parameter listing
Position (viewable from the View Requests form) containing the Email Enabled Value
(see below), which determines whether this concurrent request is for an email
document.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_ENABLED_POS when the
entries are saved.

Configuring Software Modules - AventX for Oracle EBS

Page 322 of 944
Proprietary to STR Software
Parameter Description

Email Enabled Value The value of the parameter at the Email Enabled Position (see above) in the
concurrent request parameter listing that determines whether this concurrent
request is for an email document.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_ENABLED_VAL when the
entries are saved.

Email Address The position of the parameter in the concurrent request parameter listing which
Position contains the actual email address for an email document.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_NUMBER_POS when the
entries are saved.

Email Prefix The value of the prefix at the Email Address Position (see above) in the
concurrent request parameter listing which precedes the actual email address
itself.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_NUMBER_PREFIX when the
entries are saved.

Email Suffix The value of the suffix at the Email Address Position (see above) in the
concurrent request parameter listing that comes after the actual email address
itself.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_NUMBER_SUFFIX when the
entries are saved.

Configuring Software Modules - AventX for Oracle EBS

Page 323 of 944
Proprietary to STR Software
 Parameter Description

Print Enabled The position of the parameter in the concurrent request parameter listing
Position (viewable from the View Requests form) containing the Print Enabled Value (see
below), which determines whether this concurrent request is for a printed
document.
Default value is 8, based upon output generated from the default Oracle EBS
Print Purchase Order concurrent request for a faxed document.
This position may differ between Oracle EBS versions.
Note: Changing this value to <blank> will result in NO PRINTED COPY from the
concurrent request, even when the Print checkbox has been checked for PO
Approval.
This data is written to FAX_POA_CONFIG.PRINT_ENABLED_POS when the
entries are saved.

Print Enabled Value The value of the parameter at the Print Enabled Position (see above) in the
concurrent request parameter listing that determines whether this concurrent
request is for a printed document.
Default value is P_PRINT_RELEASES=N. As with the Print Enabled Position
parameter, this setting may differ between Oracle EBS versions. This data is
written to FAX_POA_CONFIG.PRINT_ENABLED_VAL when the entries are saved.

View Communicate This parameter is needed only for Oracle EBS 11.5.10 or R12 or R12.1 versions
Position using PDF Output for the Approved Purchase Order.
The position of the parameter in the concurrent request parameter listing
(viewable from the View Requests form) containing the string “Communicate”.
When PDF output is generated, two concurrent requests are executed, one for
the viewing of the document itself and the other for the actual “transmission” /
“communication” of the document. AventX needs the “Communicate”
concurrent request in order to correctly determine whether the document is to
be faxed, emailed or printed.
Default value is <blank>. This value needs to be changed to 17, based upon
output created from the standard PO Output for Communication report. If you
have a customized version of this report, this value may be different.
This data is written to FAX_POA_CONFIG.VIEW_COMMUNICATE_POS when the
entries are saved.
Once complete, make sure to File -> Save to keep the newly entered information before proceeding with
further configuration.

Configure the AventX Blanket Release Tab

Configuring Software Modules - AventX for Oracle EBS

Page 324 of 944
Proprietary to STR Software
After specifying information for all of the aforementioned tabs for Purchase Order Approval documents,
proceed to configure the “PO Release Approval”. It is recommended that all sub-options for each document
type be defined prior to changing document types.

Choose the “PO Release Approval” Tab. This allows you to configure the positions and values of the
arguments as stored in the FND_CONCURRENT_REQUESTS table for each type of delivery method (fax, email,
print).

When clicking on this tab for the first time, the form will be pre-populated with default parameters, as shown
in the figure below. These default parameters are set for use with text-based Purchase Order Approval
documents created from all versions of Oracle EBS. For PDF-based output (11.5.10 or R12 or R12.1 only),
these settings will need to be changed.

Important Note: In order for AventX to process PO Approval documents for EMAIL delivery, the existing
workflow must be modified to include AventX. Additionally, new parameters must be created, as listed in
the table below, which defines that this concurrent request is for an email document. Modifying Oracle EBS
workflow and creating the new parameters is the responsibility of the System Administrator, and is beyond
the scope of this documentation. Consult the proper documentation for Oracle EBS for information on
modifying workflow.

The following table defines each of the parameters on the PO Release Approval tab.

Configuring Software Modules - AventX for Oracle EBS

Page 325 of 944
Proprietary to STR Software
Parameter Description

Fax Enabled Position The position of the parameter in the concurrent request parameter listing (viewable
from the View Requests form) containing the Fax Enabled Value (see below), which
determines whether this concurrent request is for a faxed document.
Default value is 9, based upon output generated from the default Oracle EBS Print
Purchase Order concurrent request for a faxed document. If using a customized
report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be 14.
This data is written to FAX_POA_CONFIG.FAX_ENABLED_REL_POS when the entries
are saved.

Fax Enabled Value The value of the parameter at the Fax Enabled Position (see above) in the
concurrent request parameter listing, which determines whether this concurrent
request is for a faxed document.
Default value is P_FAX_ENABLE=Y, based upon output generated from the default
Oracle EBS Print Purchase Order concurrent request for a faxed document. If using
a customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be Y.
This data is written to FAX_POA_CONFIG.FAX_ENABLED_REL_VAL when the entries
are saved.

Fax Number Position The position of the parameter in the concurrent request parameter listing which
contains the actual fax number for a faxed document.
Default value is 10, based upon output generated from the default Oracle EBS Print
Purchase Order concurrent request for a faxed document. If using a customized
report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be 15.
This data is written to FAX_POA_CONFIG.FAX_NUMBER_REL_POS when the entries
are saved.

Configuring Software Modules - AventX for Oracle EBS

Page 326 of 944
Proprietary to STR Software
Parameter Description

Fax Prefix The value of the prefix at the Fax Number Position (see above) in the concurrent
request parameter listing which precedes the actual fax number itself.
Default value is P_FAX_NUM=, based upon output generated from the default
Oracle EBS Print Purchase Order concurrent request for a faxed document. If using
a customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only), this will need to be changed.
Based upon PDF output generated from the default Oracle EBS PO Output for
Communication request for a faxed document, this value should be <blank>.
This data is written to FAX_POA_CONFIG.FAX_NUMBER_REL_PREFIX when the
entries are saved.

Fax Suffix The value of the suffix at the Fax Number Position (see above) in the concurrent
request parameter listing which immediately follows the actual fax number itself.
Default value is <blank>, based upon output generated from the default Oracle EBS
Print Purchase Order concurrent request for a faxed document. If using a
customized report, this setting may need to be changed.
Also, for PDF output (11.5.10 or R12 or R12.1 only) based upon PDF output
generated from the default Oracle EBS PO Output for Communication request for a
faxed document, this value should be <blank>.
This data is written to FAX_POA_CONFIG.FAX_NUMBER_REL_SUFFIX when the
entries are saved.

Email Enabled Position The position of the parameter in the concurrent request parameter listing (viewable
from the View Requests form) containing the Email Enabled Value (see below),
which determines whether this concurrent request is for an email document.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_ENABLED_REL_POS when the
entries are saved.

Email Enabled Value The value of the parameter at the Email Enabled Position (see above) in the
concurrent request parameter listing that determines whether this concurrent
request is for an email document.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_ENABLED_REL_VAL when the
entries are saved.

Configuring Software Modules - AventX for Oracle EBS

Page 327 of 944
Proprietary to STR Software
Parameter Description

Email Address Position The position of the parameter in the concurrent request parameter listing which
contains the actual email address for an email document.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_NUMBER_REL_POS when the
entries are saved.

Email Prefix The value of the prefix at the Email Address Position (see above) in the concurrent
request parameter listing which precedes the actual email address itself.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_NUMBER_REL_PREFIX when the
entries are saved.

Email Suffix The value of the suffix at the Email Address Position (see above) in the concurrent
request parameter listing that comes after the actual email address itself.
Default value is <blank>, as this information will differ based upon PO Approval
workflow for emailed documents.
This data is written to FAX_POA_CONFIG.EMAIL_NUMBER_REL_SUFFIX when the
entries are saved.

Print Enabled Position The position of the parameter in the concurrent request parameter listing (viewable
from the View Requests form) containing the Print Enabled Value (see below),
which determines whether this concurrent request is for a printed document.
Default value is 10, based upon output generated from the default Oracle EBS Print
Purchase Order concurrent request for a faxed document.
This position may differ between Oracle EBS versions. Note: Changing this value to
<blank> will result in NO PRINTED COPY from the concurrent request, even when
the Print checkbox has been checked for PO Approval.
This data is written to FAX_POA_CONFIG.PRINT_ENABLED_REL_POS when the
entries are saved.

Print Enabled Value The value of the parameter at the Print Enabled Position (see above) in the
concurrent request parameter listing that determines whether this concurrent
request is for a printed document.
Default value is P_PRINT_RELEASES=N. As with the Print Enabled Position
parameter, this setting may differ between Oracle EBS versions. This data is written
to FAX_POA_CONFIG.PRINT_ENABLED_REL_VAL when the entries are saved.

Configuring Software Modules - AventX for Oracle EBS

Page 328 of 944
Proprietary to STR Software
 Parameter Description

View Communicate This parameter is needed only for Oracle EBS 11.5.10 or R12 or R12.1 versions using
Position PDF Output for the Approved Purchase Order.
The position of the parameter in the concurrent request parameter listing (viewable
from the View Requests form) containing the string “Communicate”. When PDF
output is generated, two concurrent requests are executed, one for the viewing of
the document itself and the other for the actual “transmission” / “communication”
of the document. AventX needs the “Communicate” concurrent request in order to
correctly determine whether the document is to be faxed, emailed or printed.
Default value is <blank>. This value needs to be changed to 17, based upon output
created from the standard PO Output for Communication report. If you have a
customized version of this report, this value may be different.
This data is written to FAX_POA_CONFIG.VIEW_COMMUNICATE_REL_POS when the
entries are saved.
Once complete, make sure to File -> Save to keep the newly entered information before proceeding with
further configuration.

Configuring Software Modules - AventX for Oracle EBS

Page 329 of 944
Proprietary to STR Software
Sending Purchase Orders from “Tools > Communicate> Form

Oracle EBS 11.5.10 and R12 allows a user to specify a destination for a PDF-based PO that has already been
approved without having to go through the approval process once again. This requires a responsibility that is
able to work with Purchase Orders. For our example, we will use Purchasing SuperUser.

From the Navigator menu, choose Purchase Order Summary and find the Purchase Order that you wish to
send. Do not click Open. Instead, choose Tools→Communicate from the menu, as shown in the example
below.

Upon choosing Tools→Communicate, you should see a form similar to this one. Although similar to the
Approve Document form, the Communicate form allows you to select only one method of delivery. (Consult
the prior section for a detailed description of each method). Once you have made your selection and entered
the destination (if applicable), select OK to submit the approved Purchase Order to the Concurrent Manager.
A concurrent request will be generated and your document will be sent to its destination.

Configuring Software Modules - AventX for Oracle EBS

Page 330 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 331 of 944
Proprietary to STR Software
Sending Purchase Orders from Fax Enable Field from “Printed Purchase Order” Report

AventX supports the ability to configure a “fax enable” destination, whereby a user chooses “Yes” for Fax
Enable and enters a fax number in the “Fax Number” field via Submit Request on the Parameters form for the
Printed Purchase Orders parameter listing.

This results in the document being sent to this fax number for Automatic Delivery. For Interactive Delivery,
the fax number is listed as a destination when the AventX Interactive Delivery form is invoked (provided that
“Fax Enable” is configured as a destination type for the Purchase Order document type).

In order to process requests containing the Fax Enable destination, AventX must know which parameters
hold the Fax Enable and Fax Number values shown above. Typically, these settings will vary slightly
depending upon the document delivery (Interactive vs. Automatic) method. To configure these settings, click
on the Fax Enable tab for the Purchase Order document type, as shown in the figure below.

Configuring Software Modules - AventX for Oracle EBS

Page 332 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 333 of 944
Proprietary to STR Software
The form is divided into two sections. The first, Submit Request Parameters (Interactive Delivery) specifies
the settings for configuration of the parameters associated with Interactive Delivery of a Purchase Order for
Fax Enable destinations, as described in the table below. The second, Concurrent Request Parameters
(Automatic Delivery), specifies the settings for configuration of the parameters associated with Automatic
Delivery of a Purchase Order for Fax Enable destinations

Fax Enable Settings for Interactive Delivery

Parameter Description

Enable Position The position of the parameter via Submit Request on the Parameters form which
represents the value entered by the user in the “Fax Enable” field (see Enabled Value
below).
Default value is 14, based upon the parameters for the default Printed Purchase
Order Report Submit Request form. If using a customized Purchase Order, this
parameter may need to be changed.
This data is written to FAX_POA_CONFIG.SRI_ENABLED_POS when the entries are
saved.

Enabled Value The parameter on the Submit Request form that represents the value to be found at
the Enable Position that indicates that this is a fax enabled document.
Default value is Yes, based upon the parameters for the default Printed Purchase
Order Report Submit Request form. If using a customized Purchase Order, this
parameter may need to be changed.
This data is written to FAX_POA_CONFIG.SRI_ENABLED_VAL when the entries are
saved.

Number Position The position of the parameter via Submit Request on the Parameters form which
represents the actual fax number entered by the user in the “Fax Number” field.
Default value is 15, based upon the parameters for the default Printed Purchase
Order Report Submit Request form. If using a customized Purchase Order, this
parameter may need to be changed.
This data is written to FAX_POA_CONFIG.SRI_NUMBERED_POS when the entries are
saved.

Configuring Software Modules - AventX for Oracle EBS

Page 334 of 944
Proprietary to STR Software
 Parameter Description

Prefix The value of the prefix at the Number Position (see above) on the Submit Request
form that precedes the actual fax number entered by the user.
Default value is <blank>, based upon the parameters for the default Printed
Purchase Order Report Submit Request form. If using a customized Purchase Order,
this parameter may need to be changed.
The data is written to FAX_POA_CONFIG.SRI_NUMBER_PREFIX when the entries are
saved.

Suffix The value of the suffix at the Number Position (see above) on the Submit Request
form that comes directly after the actual fax number entered by the user.
Default value is <blank>, based upon the parameters for the default Printed
Purchase Order Report Submit Request form. If using a customized Purchase Order,
this parameter may need to be changed.
The data is written to FAX_POA_CONFIG.SRI_NUMBER_SUFFIX when the entries are
saved.
For Interactive Delivery, the parameters via Submit Request are actually passed to the AventX Interactive
Delivery form, and the Fax Enable destination is populated on the form based upon the configured settings in
above. Fax Enable destinations are not supported for Stand Alone Interactive Delivery submissions, and will
display an error for the configured destination when the form is invoked.

Like any other destination for Interactive Delivery, this information can then be changed or deleted from the
form before submitting the request.

Fax Enable Settings for Automatic Delivery

Parameter Description

Enable Position The position of the parameter in the concurrent request parameter listing (viewable
from the View Requests form) which represents the value entered by the user in the
“Fax Enable” field (see Enabled Value below).
Default value is 15, based upon the concurrent request parameters for the execution
of the default Printed Purchase Order Report. If using a customized Purchase Order,
this parameter may need to be changed.
This data is written to FAX_POA_CONFIG.SR_ENABLED_POS when the entries are
saved.

Configuring Software Modules - AventX for Oracle EBS

Page 335 of 944
Proprietary to STR Software
 Parameter Description

Enabled Value The parameter in the concurrent request parameter listing which represents the
value to be found at the Enable Position to indicate that this is a fax enabled
document.
Default value is Y, based upon the concurrent request parameters for the execution
of the default Printed Purchase Order Report. If using a customized Purchase Order,
this parameter may need to be changed.
This data is written to FAX_POA_CONFIG.SR_ENABLED_VAL when the entries are
saved.

Number Position The position of the parameter in the concurrent request parameter listing (viewable
from the View Requests form) which represents the actual fax number entered by
the user in the “Fax Number” field.
Default value is 16, based upon the concurrent request parameters for the execution
of the default Printed Purchase Order Report. If using a customized Purchase Order,
this parameter may need to be changed.
This data is written to FAX_POA_CONFIG.SR_NUMBERED_POS when the entries are
saved.

Prefix The value of the prefix at the Number Position (see above) in the concurrent request
parameter listing that precedes the actual fax number entered by the user.
Default value is <blank>, based upon the concurrent request parameters for the
execution of the default Printed Purchase Order Report. If using a customized
Purchase Order, this parameter may need to be changed.
The data is written to FAX_POA_CONFIG.SR_NUMBER_PREFIX when the entries are
saved.

Suffix The value of the suffix at the Number Position (see above) in the concurrent request
parameter listing that comes directly after the actual fax number entered by the
user.
Default value is <blank>, based upon the concurrent request parameters for the
execution of the default Printed Purchase Order Report. If using a customized
Purchase Order, this parameter may need to be changed.
The data is written to FAX_POA_CONFIG.SR_NUMBER_SUFFIX when the entries are
saved.
Once complete, make sure to File -> Save to keep the newly entered information before proceeding with
further configuration.

Configuring Software Modules - AventX for Oracle EBS

Page 336 of 944
Proprietary to STR Software
Additional Resources

Changing the PO Output Format to PDF

For Oracle EBS 11.5.10 and R12 or R12.1 instances with PO Approval PDF output, the PO Output Format must
be set to PDF in order for Oracle EBS and AventX to properly process PDF based Purchase Order Approval
documents. This is “verified” in two places; the first is in the PO Output for Communication concurrent
definition (as mentioned in the previous section). The second is under the Purchasing Options for
organizations.

As the Purchasing Superuser (or equivalent) responsibility: Select Setup, Organizations, Purchasing Options.
On the Control tab, verify / change the PO Output Format to PDF, as shown in the following.

Oracle Profile Changes

Oracle EBS patch #6393663, if applied, may have set a user profile option value (PO:Fax Output Directory for
the PO Document) which can adversely affect processing by AventX Oracle Connector. Check for this profile
option value (see image below); if set, simply delete the value (make it blank).

On the Approve Document form, the user checks one or more of the appropriate boxes for the type of
destination (fax, email and/or print), and when the request(s) are submitted to the Concurrent Manager,
Configuring Software Modules - AventX for Oracle EBS
Page 337 of 944
Proprietary to STR Software
AventX Oracle Connector processes each concurrent request separately to deliver the document to its
intended destination.

When the document is approved, a separate concurrent request is generated for each delivery method
requested. AventX uses the information from the parameters specified for the concurrent request (stored in
FND_CONCURRENT_REQUESTS) to determine the delivery method for this document. The information
specified on the PO Approval tab (stored in the FAX_POA_CONFIG table) specifies which concurrent request
parameters should be evaluated in determining the delivery method for the document.

Using RTF Templates from PO Approval vs XSLFO

Once of the steps required to integrate with AventX is to modify the PO Approval template used to format
the purchase order document to include the AventX FAX_INFO tag. One of the challenges companies face is
Oracle EBS uses XSLFO formatting templates by default. This type of template is difficult to update if a
formatting change is needed.

Configuring Purchase Order Expiration

AventX provides the ability to prevent the delivery of Purchase Order Approval documents if they are closed
or older than a configured number of days. Purchase orders that meet this criteria will be sent to a
configured email address instead of the set destination for the report. This can be configured using the
following options in the general configuration form.

poa.send.closed Defaults to “Yes”. If this is set to “No” then

purchase orders will not be sent if they have a
closed code of anything other than “OPEN”.

poa.age.days Defaults to “0”. Can be set to a number of days

between 0 and 365. A value of “0” means
purchase orders never expire. Any purchase order
older than this number of days will not be sent.

poa.expired.address This email address to send expired and/or closed

Purchase Orders.

Oracle Advanced Collections

This section is provided as a reference for the best practices of using AventX with Oracle EBS Advanced
Collections module. It will provide an overview of the document delivery challenges within Oracle EBS
Advanced Collections and solutions for how to overcome them with AventX.

Prior to 11.5.10 patch 11iEX.H rollup 4, the One-To-One Fulfillment server was used to deliver collections-
related correspondence to customers. Commencing with 11.5.10 patch 11iEX.H rollup 4 and continuing into
R12, the Oracle One-To-One Fulfillment server has been phased out in favor of BI Publisher. There are several
resources on the internet that help provide an introduction to Oracle Advanced Collections.

• Oracle Advanced Collections Implementation Guide

Configuring Software Modules - AventX for Oracle EBS
Page 338 of 944
Proprietary to STR Software
• Oracle Online Support
o What Notes are a MUST READ When Setting Up Collections? (Doc ID 457602.1)
o Cannot Print/Email/Fax Dunning Letters in R12, Why?? (Doc ID 726427.1)

Overview of Layout Templates and XML Data

Layout Templates for Advanced Collections are managed with standard XML Publisher Administrator
functionality, however XML data is not generated with Oracle Reports or Data Templates. XML generation is
done with individual queries that are setup in Advanced Collections and then associated with a template. To
add or edit a seeded query to modify the XML that is generated; navigate to Administration->Manage
Templates Query as Collections Administrator. This form will allow you to duplicate queries and then
associate them with a XML Publisher template.

Configuring Software Modules - AventX for Oracle EBS

Page 339 of 944
Proprietary to STR Software
Sometimes it is important to see the actual XML that is generated by a document. Unfortunately, you are not
able to just go to the REQUESTID and click “Diagnostics > View XML”. This only shows you the status report
XML and some of the delivery information. Instead, you can use the following query to view the actual report
XML.

select xml_request_id, xmldata from iex_xml_request_histories order by xml_request_id desc;

Configuring Software Modules - AventX for Oracle EBS

Page 340 of 944
Proprietary to STR Software
Delivery Configuration with AventX

To deliver documents to the user defined destinations, the BI Publisher Delivery Manager is invoked by a Java
based Concurrent Program. The delivery server parameters are determined in one of two ways.

The first method is via the definition Collections Administrator -> Setup Checklist -> Correspondence page
where there is a form to fill in the Email Host, Email From Address, Fax Host and Printer and Printing
information. You can also configure these settings via profile values.

Integration with AventX requires the use the xdodelivery.cfg file. This is because Oracle provides the
following profile values in the Advanced Collections “Correspondence” XML Publisher setup and
configuration. However, there is no default SMTP port.

• IEX: Fax IPP Host = AventX Server Name

• IEX: Fax IPP Port = Default Port of 6065
• IEX: Fax IPP printer name = AventX
• IEX: SMTP Host = AventX Server Name
• IEX: SMTP From = [email protected]
• IEX: Default Fulfillment Subject
• IEX: Print IPP Port = CUPS printer server port, default is 631
• IEX: Print IPP Host = CUPS print server name
• IEX: IPP Printer name = Default Printer

AventX has an SMTP listener that has a configurable port that it can listen on (the default is 6070). The only
way to configure the port by creating an SMTP delivery block in the $XDO_TOP/resource/xdodelivery.cfg file.
If the file exist then Advanced Collections will be used it to send faxes and emails versus the above profile
values. The following screen shot is a good example of what is recommended.

Configuring Software Modules - AventX for Oracle EBS

Page 341 of 944
Proprietary to STR Software
The email block in the xdodelivery.cfg file for Advanced collections must have the value of “mysmtp1”.
Advanced Collections hardcodes this throughout their concurrent and Java programs and expects to find it in
the xdodelivery.cfg file. The above screen shot shows how the configuration value should be implemented.

The print and fax block in the xdodelivery.cfg file must match the server name Advanced Collections >
Operations Setup > Correspondence section.

Configuring Software Modules - AventX for Oracle EBS

Page 342 of 944
Proprietary to STR Software
Sending PDF Dunning Letters from Advanced Collections through AventX

This section provides an overview of several methods administrators can use to integrate AventX with Oracle
EBS Advanced Collections. The information provided in the following sections assumes PDF attachments.
Therefore the proper Oracle EBS configuration for the “IEX: Email Delivery Format” is to have the value of
“Attachment”. This configuration will create a PDF file as the email attachment.

The primary method of integrating AventX with Advanced Collections is by using the AventX SMTP (for email)
and IPP (for fax) Listener. The first decision that needs to be made is whether an administrator will want to
“embed” AventX commands in the report output to enhance the construction of the final email or fax that is
sent to the customer.

There are two options for integrating the default AventX with the default “IEX: Send Dunnings for Delinquent
Customer” concurrent program with AventX.

• Use AventX without embedded commands

• Use AventX with embedded commands

For Dunning Letters, AventX will use the email address of the customer as displayed on the collections form
to deliver the document. The fax number will be automatically pulled from the customer standard records.

Configuring Software Modules - AventX for Oracle EBS

Page 343 of 944
Proprietary to STR Software
The following illustrates what fax number will be used if the customer prefers to receive their documents via
fax.

Configuring Software Modules - AventX for Oracle EBS

Page 344 of 944
Proprietary to STR Software
Submission

It is common for users to send “Dunning Letters” by using the following button on the “Collections” form.

Users can also submit “Dunning Letters” from the submit request form.

Configuring Software Modules - AventX for Oracle EBS

Page 345 of 944
Proprietary to STR Software
Method # 1 – Integrate with AventX UNIX without Embedded Commands

The following features and limitations exist with this option. Overall, this method is simple to implement;
however, the final email and fax output offers a few enhancements to some of the hardcoded configuration
provided by Advanced Collections.

Summary of Features and Limitations

The following table provides a summary of some of the features and limitations when integrating via this
method.

Email Construction
• HTML can be added to email message body
• Hard coded email attachment file name
• Configurable but static SUBJECT. AventX will use the default static subject provided by the
Advanced Collections profile value
• Configurable but static SENDER as defined by the Oracle profile value
• Additional attachments (static or dynamic) cannot be applied

Multiple Destinations
• One email and fax destination is supported

Configuration
• Integration is required with XDODELIVERY.CFG file

Archiving
• Documents delivered by AventX from Advanced Collections are stored in the AventX database
and automatically delivered based on a configuration timeframe
• Archiving to an alternative file system is not support.

Delivery Status
• Users cannot see the status in the AventX Delivery Status form
• Users can use the AventX WebManager can be used to see the status and resend the document.
Only basic information about the document is provided.
• Users can use the “Correspondence” tab on the “Collections” form

Email Construction without AventX Embedded Commands

This method will result in the following email if channeled through AventX without embedding commands.

Configuring Software Modules - AventX for Oracle EBS

Page 346 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 347 of 944
Proprietary to STR Software
Fax Construction without AventX Embedded Commands
Fax document creation is also limited due to the hard coded programs used by Advanced Collections. The
following key points should be noted.

• Advanced Collections will not generate a fax message template. Message Templates are applied by
AventX.
• Advanced Collections will not pass any dynamic content except the destination’sdestination’s fax
number. The customer name or contact name is not passed along to AventX unless additional AventX
commands are added to the report output.
• Advanced Collections will pass along a static FROM and SUBJECT value, which is configurable via profile
options.
• Advanced Collections hard codes the fax REMARKS. This is not configurable within Advanced Collections.

Configuring Software Modules - AventX for Oracle EBS

Page 348 of 944
Proprietary to STR Software
Email and Fax Configuration

Integration of the Dunning Letter with AventX requires the following configuration and basic setup in Oracle
EBS and AventX.

• Configure the Oracle FAX profile options to point to AventX

o IEX: Fax IPP Host = AventX Server Name
o IEX: Fax IPP Port = Default Port of 6065
o IEX: Fax IPP printer name = AventX
• Configure the xdodelivery.cfg file to point to AventX on port 6070; or the actual port of the IPP listener in
AventX if the default port is not being used.
• Start the AventX SMTP and IPP listeners. (See the AventX UNIX Resource Guide for more information on
these input channels)
• Test

Configuring Software Modules - AventX for Oracle EBS

Page 349 of 944
Proprietary to STR Software
Method # 2 – Integrate with AventX UNIX with Embedded Commands

The following features and limitations exist with each option.

Summary of Features and Limitations

The following table provides a summary of some of the features and limitations when integrating via this
method.

Summary of Features and Limitations

Email Construction
• HTML can be added to email message body along with a dynamic and configurable email
message body.
• The hard coded email message from Oracle can be suppressed and dynamic content from the
XML can be added to the message body to personalize the email.
• Dynamic subject
• Dynamic email attachment file name. The hard coded attachment name provided by Oracle can
be suppressed and a new attachment name can be applied.
• Additional static attachments from the file system can be applied if the ATTACH command is
added to the PDF output via the RTF template.
• Dynamic SENDER name and email address. The hard coded sender name from Oracle can be
suppressed and the Collector’s name and email address can be used as the SENDER allowing
customers to reply back directly to the Collector versus a [email protected] or
[email protected] generic email address.

Configuration
• Integration is required with XDODELIVERY.CFG file

Multiple Destinations
• One email and fax destination is supported

Archiving
• Documents delivered by AventX from Advanced Collections are stored in the AventX database
and automatically delivered based on a configuration timeframe
• Archiving to an alternative file system is not support.

Configuring Software Modules - AventX for Oracle EBS

Page 350 of 944
Proprietary to STR Software
Delivery Status
• Users cannot see the status in the AventX Delivery Status form
• Users can use the AventX WebManager can be used to see the status and resend the document.
Detailed information about the document will be provided.
• Users can receive summary reports via email from AventX
• Users can receive individual transmission email acknowledgements
• Users can use the “Correspondence” tab on the “Collections” form

Configuring Software Modules - AventX for Oracle EBS

Page 351 of 944
Proprietary to STR Software
Email Construction with AventX Embedded Commands
Utilizing embedded commands will result in an email similar to the following:

Fax Construction with AventX Embedded Commands

As mentioned in the previous section, fax document creation is limited due to the hard coded programs used
by Advanced Collections. By embedding commands, AventX can overcome each of the challenges mentioned
in the prior section called “Fax Construction without AventX Embedded Commands”.

Configuring Software Modules - AventX for Oracle EBS

Page 352 of 944
Proprietary to STR Software
Email and Fax Configuration

Integration of the Dunning Letter with AventX requires the following configuration and basic setup in Oracle
EBS and AventX.

• Configure the Oracle FAX profile options to point to AventX

o IEX: Fax IPP Host = AventX Server Name
o IEX: Fax IPP Port = Default Port of 6065
o IEX: Fax IPP printer name = AventX
• Configure the xdodelivery.cfg file to point to AventX on port 6070; or the actual port # if the default port
was not used.
• Start the AventX SMTP and IPP listeners. (See the AventX UNIX Resource Guide for more information on
these input channels)

AventX has around ninety (90) commands that can be added to a document to enhance the user experience.
More information about the commands and their purpose can be found in the AventX UNIX Resource Guide.

• The first step is to configure the AventX smtp.xml file to use the following “fclp” command. Edit the file
in the $FCHOME/cfg directory to look like the following.

• Now, it is time to embed commands to enhance the fax and email delivery.

Configuring Software Modules - AventX for Oracle EBS

Page 353 of 944
Proprietary to STR Software
How to embed the AventX commands in the Dunning Letter Template
KB Article # 16314 provides an example of a Dunning Letter Template modified to include AventX commands.
Consider downloading this template and using it as a starter template for your testing. The following screen
shot of the portal illustrates what file to download.

In summary, your end goal is to embed commands similar to the following screenshot. After you are finished
testing it is important to change the font to small size and color to white. The commands should all be the
same font, font size and font color. Tahoma 10 with the size of 6 is a good default approach.

The RTF template in the portal already contains the commands. If you want to use your own templatethen
just copy and paste the commands from the STR Software “IEX_Send_Dunning” template.

Configuring Software Modules - AventX for Oracle EBS

Page 354 of 944
Proprietary to STR Software
Oracle doesn’t allow you to modify the seeded template so you must create a new one. The best way do to
this is to find the seeded template duplicate it. We will use the “Dunning Hard Letter 1” as an example.

Log in as the “XML Publisher Administrator” and go to the “Templates”. Query to find the “Dunning Hard
Letter 1” template. Click the “Duplicate” button.

Fill out the information required to create the template. The values for “Code” and “Name” can be anything;
however if you use the following then it will make it easier to track your changes.

• Code = XXIEXDNHRD1AVTX
• Name = Dunning Hard Letter 1 with AventX Commands

Click “Update” and upload the Dunning Letter template from KB Article # 16314 to the new template.

Configuring Software Modules - AventX for Oracle EBS

Page 355 of 944
Proprietary to STR Software
Go back into the “Collections Administrator” responsibility and change the “Work Items” to call on the new
template. The key to updating the seeded template with the one you duplicated is to find the “Work Item”
name within the “Collection Strategy”. Collection strategies use “Work Items”. Within these work items you
can define the template that is used for correspondence email. Find the work item that is enabled within
your collections strategy and update it to use the new template that contains the AventX embedded
commands.

The following screenshot provides a quick look at how to modify the email template for a “Work Item”. As a
Collections Administrator, click on “Setup Checklists > Collections Method Setup > Create Work Items”.
Query for the work item that uses the Dunning Letter template and click “Update”.

If needed, you can find the “Collections Strategy” for a given customer by finding the customer in the
“Collections” form and clicking on “Strategy”. As seen in the screen shot below the customer called “A.C.
Networks” has a collection strategy applied called “Hard Customer Collections Strategy”.

Click “Next” until step # 3 and update the “Correspondence Letter” value to the name of the template
created in the prior steps.
Configuring Software Modules - AventX for Oracle EBS
Page 356 of 944
Proprietary to STR Software
Now you can test sending the Dunning Letter through AventX using the methods outlined in the earlier
section called “Submission”.

How to solve the hard coded SENDER email address problem

Advanced Collectors hard codes the SENDER email address via the IEX: SMTP From profile value. What if you
do not want to use a generic email address like [email protected] or
[email protected]? Some companies prefer to have communication go directly back to the
collection agent. The information in this section provides information on how to the collection agent’s email
address as the SENDER of the email.

Collectors who are assigned to a strategy are typically assigned to customers at the site level. This screen shot
shows the collector assigned to the “Hard Customer Collections Strategy” strategy for A.C. Networks.

Configuring Software Modules - AventX for Oracle EBS

Page 357 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 358 of 944
Proprietary to STR Software
Use the following information to find the customer in Oracle EBS. Click on the details of the appropriate site.

Click the “Profile’ tab and verify the “Collector” assigned to this site.

The screen shot shows how “Mr. Jamie Jones” is assigned to the customer “A.C Networks” via the customer
standard at the site level. Use the following steps to add the email address to the XML.

• Run the following query to ensure the collector’s email address is in the database
• select source_email, source_name from jtf_rs_resource_extns where SOURCE_NAME like 'Jones, Mr.
Jamie';
If the email address is blank then work with your collector’s administrator to update the email address
via the Oracle forms. STR Software was able to successfully test after performing the following manual
update to the tables in our labs environment. STR Software doesn’t recommend performing this type of
update in production unless approved by your Collections Administrator. You can update the record via
the following query.

• update jtf_rs_resource_extns

• set source_email = '[email protected]'

• where SOURCE_NAME='Jones, Mr. Jamie';

• COMMIT

• Go to the “Collector Administrator” responsibility and edit the query used for the work item associated
with the template. The table jtf_rs_resource_extns contains information about the collector. Adding the
“rs.source_email collector_email_address,” value via the “Query Editor” will get the collector’s email
address in the data.
Configuring Software Modules - AventX for Oracle EBS
Page 359 of 944
Proprietary to STR Software
• Add the “collector_email_address” to the FROM AventX command in the RTF template. If you want to
add new fields to the template then use the following steps. To help, there is a sample XML file called
“IEX_Send_Dunnings_for_delinquent_report_data_with_collector_email_address.xml” in KB Article #
16314. This file is a good reference to the XML fields that are created by Advanced Collections.

• Find the XML name you want to add to the template. We will use the “COLLECTOR_EMAIL_ADDRESS” in
this example.

• Copy an existing field, e.g. “sysdate” and paste it into the location you would like to add it. This is the
easiest way to add new fields is to just copy an existing field, rename it and change it to reference the
new XML element you want.

Configuring Software Modules - AventX for Oracle EBS

Page 360 of 944
Proprietary to STR Software
• Double click the field you just pasted and change the field name and the XML element it references.

You have now overcome one of the Oracle EBS limitations when sending email. Your customers can now
reply directly back to the collector versus a hard coded email address.

Configuring Software Modules - AventX for Oracle EBS

Page 361 of 944
Proprietary to STR Software
How to solve the hard coded attachment name problem
In order to change the attachment name the variable FORCE_FCATTACHNAME must be uncommented and
set to the desired value. This can be set to equal any inflatable value such as SUBJECT or FAXID.

This value should be set to equal the existing FCATTACHNAME variable as it will apply to every document
submitted through AventX. If the value is different, it will change the attachment name for other document
types such as Invoices as well.

Configuring Software Modules - AventX for Oracle EBS

Page 362 of 944
Proprietary to STR Software
Sending PDF Statements from Advanced Collections through AventX

Submission

Running the seeded statement report is a two-step process.

• As a “Receivables Manager” or “Collections Agent” (or other responsibility that enables the “Print
Statements” menu item, click “Print Statements”

• Fill in the report parameters and click “Printing Options”. Ensure the printer is set to “noprint”.

Configuring Software Modules - AventX for Oracle EBS

Page 363 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 364 of 944
Proprietary to STR Software
• Click “Submit” to submit the request and note the “Request ID” in the field.

• Click on “View > Requests” from the menu items and once the request completes click “Submit
Another Request”

• Choose the “XML Report Publisher” program

• Report Request = <request ID from above>

Configuring Software Modules - AventX for Oracle EBS

Page 365 of 944
Proprietary to STR Software
• Template Application = Receivables

• Template = <your template name>, i.e. XML STR Software STMT Landscape Template

• Template Locale = Blank

• Output Format = PDF

• Select the AventX Statement style and the “AventX Automatic” Printer

Configuring Software Modules - AventX for Oracle EBS

Page 366 of 944
Proprietary to STR Software
Configuration

This method requires the following basic steps. More information about how to add a new document to
AventX can be found in the “AventX Oracle Connector Add Document Quick Start Guide”.

• Add the AventX FAX_INFO tag to the Statement RTF template

• Configure the document in the “AventX Document Configuration” and “AventX Organization
Configuration” form
• Create the Statement style and driver
• Test

Delivery Status

Delivery Status is posted into the AventX Delivery Status form after AventX completes processing transmitting
the document.

Configuring Software Modules - AventX for Oracle EBS

Page 367 of 944
Proprietary to STR Software
Sending Excel Statements from Advanced Collections through AventX

Submission

When submitting statements Oracle provides the ability to select “Excel” as a format type.

Running the seeded statement is a two-step process.

• As a “Receivables Manager” or “Collections Agent” (or other responsibility that enables the “Print
Statements” menu item, click “Print Statements”

Configuring Software Modules - AventX for Oracle EBS

Page 368 of 944
Proprietary to STR Software
• Fill in the report parameters and click “Printing Options”. Ensure the printer is set to “noprint".

Configuring Software Modules - AventX for Oracle EBS

Page 369 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 370 of 944
Proprietary to STR Software
• Click “Submit” to submit the request and note the “Request ID” in the field.

• Click on “View > Requests” and once the request completes click “Submit Another Request”

• Select the “XML Report Publisher” program.

• Report Request = <request ID from above>.

• Select the AventX Statement style and the “AventX Automatic” Printer.

Configuring Software Modules - AventX for Oracle EBS

Page 371 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle EBS
Page 372 of 944
Proprietary to STR Software
Configuration

In order to delivery statements with Excel email attachments a patch is required from STR Software that
allows bursting of HTML style Excel report output. Please contact STR Software support to obtain this patch.

Once the patch is applied then the following basic steps are required. More information about how to add a
new document to AventX can be found in the “AventX Oracle Connector Add Document Quick Start Guide”.

• Add the AventX FAX_INFO tag to the Statement RTF template

• Configure the document in the AventX Document Configuration and Organization Configuration form.
Oracle doesn’t provide the email or fax number in the XML of the seeded statement report. Using
AventX to add a destination query is a quick way of retrieving fax numbers and email address from the
database without having to modify the report.
• Create the Statement style and driver
• Test using the following instructions

Delivery Status

Delivery Status is posted into the AventX Delivery Status form after AventX completes processing transmitting
the document.

Configuring Software Modules - AventX for Oracle EBS

Page 373 of 944
Proprietary to STR Software
Configuring AventX to send faxes and emails with the Invoice “Send Copy” Form

There are times where a Collector may want to send a copy of an invoice to a customer. This section
provides information about how to configure AventX to send these documents via email and fax.

How to use the “Send Copy” form to resend an Invoice with AventX UNIX

Summary of Features and Limitations

The following table provides a summary of some of the features and limitations when integrating via this
method.

Summary of Features and Limitations

Email Construction
• HTML can be added to email message body
• Hard coded email attachment file name
• Configurable but static SUBJECT. AventX will use the default static subject provided by the
Advanced Collections profile value
• Configurable but static SENDER as defined by the Oracle profile value
• Additional attachments (static or dynamic) are unable to be applied

Multiple Destinations
• One email and fax destination is supported

Configuration
• Integration is required with XDODELIVERY.CFG file

Archiving
• Documents delivered by AventX from Advanced Collections are stored in the AventX database
and automatically delivered based on a configuration timeframe
• Archiving to an alternative file system is not support.

Delivery Status
• Users cannot see the status in the AventX Delivery Status form
• Users can use the AventX WebManager can be used to see the status and resend the document.
Only basic information about the document is provided.
• Users can use the “Correspondence” tab on the “Collections” form
Submission

Collection notices in general are meant to be delivered, either by printing and stuffing them into an envelope
or by email or fax. This delivery is accomplished in Advanced Collections using the Collections form (logged in

Configuring Software Modules - AventX for Oracle EBS

Page 374 of 944
Proprietary to STR Software
as the Collections Agent responsibility). Query the collections information by customer or contact name and
then navigate to the Transaction tab.

Click on the Transaction Detail button and a new screen will be invoked that has a ‘Send Copy’ button
included.

Configuring Software Modules - AventX for Oracle EBS

Page 375 of 944
Proprietary to STR Software
A form that allows for the entry of a print, fax and email destination will be displayed and the user can
address the document.

Upon clicking Send, a Java based concurrent program is run to execute the appropriate query for the
document type to generate the XML and then apply the layout template associated with the query. This
process bypasses the normal XML generation and Layout Template application processes of the standard BI
Publisher integration. The fax and email is then passed to the AventX UNIX software. The documents will be
placed into the AventX queue and scheduled for delivery.

Configuring Software Modules - AventX for Oracle EBS

Page 376 of 944
Proprietary to STR Software
Delivery Status

Delivery status is available in two locations. Each of these options offers pros and cons.

• In the AventX WebManager

• From the “History” tab on the “Collections” form

Status via AventX WebManager

The AventX WebManager will provide the true fax delivery status and why the fax encountered a problem,
i.e. voice error, ring no busy, etc. It will also display all documents sent by the users from Oracle EBS if the
user information is passed in the AventX embedded commands. This helps the user get access to not only
invoice copies and dunning letters but any other report they would have submitted outside of Advanced
Collections. Users can resend multiple emails and faxes in bulk, change properties of the document prior to
resending and run reports within the web interface.

Status via the History tab on the Collections Form

Patch 8435600 allows for the update of fax status within Collections. The “History” tab within Advanced
Collections provides the status of the “hand off” to the email, print, or fax server. With this patch the status
can be updated to display the status that the IPP client has for the job. It is important to be clear about what
the status really means. If you are using the standard IPP functionality, it will only be the status of the ‘print
job’, indicating whether or not CUPS was able to print the document to the fax printer. This status is not the
final status of the fax job, therefore it does not indicate whether or not the fax was successfully delivered to
its final destination.

After delivering a fax via Advanced Collections, the document goes into an ‘Open’ state and prior to this
patch had no way to get out of this state. This obviously causes confusion for users as the final outcome of
the document is never reported on.

Configuring Software Modules - AventX for Oracle EBS

Page 377 of 944
Proprietary to STR Software
Configuration

All of the previous configuration performed in the “Delivery Configuration” section of this document will
allow for sending invoices via this method. No additional configuration should be required. If embedding
commands are required to enhance the email experience then what template the “Invoice Copy” uses is in a
different place than the “Dunning Letter”.

As a “Collections Administrator” go to “Setup Checklist” and click on “Set Up Correspondence”.

Configuring Software Modules - AventX for Oracle EBS

Page 378 of 944
Proprietary to STR Software
Select the XML Publisher template that you “duplicated” and embedded AventX commands.

Configuring Software Modules - AventX for Oracle EBS

Page 379 of 944
Proprietary to STR Software
Oracle Submit Request Delivery Options Button

Delivery Manager functionality is new to users of Oracle EBS 12.1.3, however it has been used for quite some
time “behind the scenes” with BI Publisher Stand Alone and BI Publisher within Oracle EBS (formerly known
as “XML Publisher”). The Delivery Manager is responsible for sending documents to a destination through a
delivery channel, such as fax, email, print, etc. Oracle EBS 12.1.3 exposes the Delivery Manager directly to the
user via the <Delivery Opts> button on the Submit Request form.

The use of AventX with Delivery Manager extends the functionality for features such as selection of a
message template, appending of terms and conditions, inclusion of Oracle attachments, and more, based
upon organization and document configuration within AventX.

To use Delivery Manager functionality, AventX needs certain information in order to extract destinations and
document delivery configuration for the associated document type from the Oracle database tables. This
information is provided in the report output via a special tag.

Configuring Software Modules - AventX for Oracle EBS

Page 380 of 944
Proprietary to STR Software
User Experience with AventX from Delivery Opts Button

The Delivery Manager is new to users of Oracle EBS 12.1.3, however it has been used for quite some time
“behind the scenes” with BI Publisher Stand Alone and BI Publisher within Oracle EBS (formerly known as
“XML Publisher”). The Delivery Manager itself is responsible for sending documents to a destination through
a delivery channel, such as fax, email, print, etc. Oracle EBS 12.1.3 exposes the Delivery Manager directly via
the <Delivery Opts> button on the Submit Request form.

The use of AventX Connector with Delivery Manager extends its functionality for features such as selection of
a message template, appending of terms and conditions, inclusion of Oracle database attachments, and
more, based upon organization and document configuration within AventX Connector.

Specifying the Report Request

When using the Delivery Manager via the <Delivery Opts> button in Oracle EBS 12.1.3, the first step, referred
to as "document submission", is very similar to your present process for printing documents.

After logging into Oracle EBS, choose to run a report. On the Submit a New Request form you can select
either the Single Request or Request Set and click OK to go to the Submit Request form.

Configuring Software Modules - AventX for Oracle EBS

Page 381 of 944
Proprietary to STR Software
Specifying a New Request

Select a report and enter the parameters as you normally would to print the report.

This example is a single report that contains a single Purchase Order (PO # 1169). It is important to note that
the Delivery Manager does not support the bursting of document batches into individual documents, since
you are specifying each destination. Therefore, specifying a range of documents would mean that the entire
batch of documents would get delivered to the same destination!

Once you have entered your report parameters, click <OK> to return to the Submit Request form.

It is now time to specify the delivery channel information for this document. Click the <Delivery Opts>
button.

Configuring Software Modules - AventX for Oracle EBS

Page 382 of 944
Proprietary to STR Software
The Deliver to… form is now displayed, with tabs for each type of delivery channel.

The IPP Printer tab allows you to specify one or more printers for printing using IPP (Internet Printing
Protocol).

The Email tab allows you to specify one or more email recipients for email delivery using SMTP (Simple Mail
Transfer Protocol).

The Fax tab allows you to specify one or more fax numbers to be sent using IPP (Internet Printing
Protocol)/CUPS (Common Unix Printing System). This requires an actual fax server for transmission of the
document.

The FTP tab allows for the secure or unsecure transfer of the finished file via FTP (File Transfer Protocol) to a
specific host with a username/password and a directory. This functionality is not handled by AventX
Connector, and will not be discussed further.

Let’s discuss the first three tabs in more detail.

Configuring Software Modules - AventX for Oracle EBS

Page 383 of 944
Proprietary to STR Software
Specifying IPP Printer Destinations

The IPP Printer tab handles the routing of the document to an IPP printer. Print Delivery is commonly used
by customers who wish to print associated attachments with the report output, or for customers who wish to
apply a form to text-based data without using a third-party forms package. This ability is not provided using
standard Oracle EBS printing techniques, but is provided via AventX Connector. For submission via AventX
Connector, specify the name of the AventX Connector IPP printer as provided by your System Administrator.
(AXOC_IPP in this example). The AventX Connector IPP printer does not require a username or password, nor
is this functionality supported by AventX Connector.

The Copies field indicates the number of copies of the document to be printed. The Orientation and For
Language fields on the form are disregarded by AventX Connector.

If you only have an IPP request, you can click OK to proceed. Otherwise, click another tab to specify
parameters for a different delivery channel type.

Specifying Email Recipients

The Email tab handles the routing of the document via an SMTP server to the email recipients specified here.
Your system administrator has configured the STMP server to point to AventX Connector, so you need only
enter the email delivery details here.

Configuring Software Modules - AventX for Oracle EBS

Page 384 of 944
Proprietary to STR Software
From Field

Upon clicking in this field, Oracle EBS populates the field with the email address associated with your user.
This can be changed to any value. You can specify both From Name and From Email address by utilizing the
following syntax: Name <email address>. For example, Tina Soles <[email protected]>.

Subject Field

This field is also pre-populated with the Oracle EBS instance, program name, and name of the user submitting
the request. (e.g., VIS : XML Printed Purchase Order Report(Portrait) : TSOLES) when you click in it. This can
be changed to any value, for example, Purchase Order Report #1169, as we have done in our example above.
To Field

This is the recipient email address. Multiple addresses can be entered here as long as they are separated by
commas.

CC Field

This is the carbon copy recipient. Multiple addresses can be entered here as long as they are separated by
commas. Should you choose to use the CC fields as secondary recipients, note that AventX Connector will
treat each destination as an individual, primary recipient. This means that the primary recipient will have
no knowledge of documents sent to secondary recipients and vice versa.

For Language Field

This is the language for the report. This parameter is disregarded by AventX Connector.

If you only have an Email request, you can click OK to proceed. Otherwise, click another tab to specify
parameters for a different delivery channel type.

Specifying Fax Destinations

Configuring Software Modules - AventX for Oracle EBS

Page 385 of 944
Proprietary to STR Software
The Fax tab handles the routing of the document via an IPP server to the fax destinations specified here.

For submission of fax destinations via AventX Connector, specify the Fax Server name of the AventX
Connector IPP printer as provided by your System Administrator. (AXOC_IPP in this example). You will note
that this is the same as the IPP printer name that you specify on the IPP tab. This is because the fax
submission is accomplished using IPP. Note: This is not the same as the actual device that delivers the
document; this is name of the IPP server as configured by your System Administrator to handle fax requests.

The AventX Connector IPP server does not require a username or password, nor is this functionality
supported by AventX Connector.

Enter the fax number of the destination in the Fax Number field.

The For Language field is disregarded by AventX Connector.

If you have more than one fax destination, you will need to specify the Fax Server and Fax Number
information on the next record. AventX Connector will process all fax numbers entered on this tab.

If you only have a Fax request, you can click <OK> to proceed. Otherwise, click another tab to specify
parameters for a different delivery channel type.

Configuring Software Modules - AventX for Oracle EBS

Page 386 of 944
Proprietary to STR Software
After specifying the Delivery Options, you are returned back to the Submit Request form.

At this point, you can specify any additional Options, and click
<Submit> to submit your request to the Concurrent Manager. Make sure to note the Request ID assigned to
your concurrent request, as it will be needed for tracking your document’s transmission through AventX
Connector.

Configuring Software Modules - AventX for Oracle EBS

Page 387 of 944
Proprietary to STR Software
Process Flow

When the Concurrent Manager runs the report, processing is passed to the proper server, depending upon
the destinations as filled out by the user on the IPP Print, Email, or Fax Server tabs via the Delivery To form.

If the request is SMTP-based (for email destinations), the smtp host and port information is extracted from
the FND: SMTP Host and FND: SMTP Port profile values in Oracle EBS.

If the request is IPP-based (for fax and print destinations), the value as specified by the user for the Printer
field of the IPP Print tab or Fax Server field on the Fax tab via the Deliver To form is used.

Oracle EBS R12 Users, Please Note: If the picklist for the Fax Server field contains no entries, you will need to
first specify a fax server name. As the System Administrator Responsibility, navigate to System
Administration→Delivery Options. Create a new server named ‘fax’, making sure to specify the proper host
and port number (e.g., 6066) of the ipp_axoc server. Ensure that the Support Fax checkbox is checked. A
sample screenshot is shown below:

When processing is handed from the Concurrent Manager to the SMTP and/or IPP server, an
acknowlegement file is generated with a status message of “Concurrent Delivery processed. Waiting for
delivery to AventX Oracle Connector”.

The SMTP/IPP server calls AventX which connects to the Oracle database and assigns a unique job sequence
number for this submission. AventX then inserts the destination information, subject, from address, and any
additional commands (for fax, email, or print channels) for each destination into the FAX_DM_DATA table
using the job sequence number. The job sequence number is used to track information for this request
which is later extracted during creating of the command file.

The AventX SMTP or IPP server then calls AventX via the $FCHOME/oa/fcprinto.sh script to process
the report output, and an acknowledgement file is generated with a status message of “Document delivered
to AventX Oracle Connector from Concurrent Delivery”.

Configuring Software Modules - AventX for Oracle EBS

Page 388 of 944
Proprietary to STR Software
AventX then parses the report output, and extracts the information embedded in the DM_FAX_INFO tag.
This information is used to query the Oracle database tables to determine the Oracle username and ORG_ID
associated with this submission. An acknowledgement file is generated with a status message of “Document
Data Successfully Extracted”.

AventX then passes all known information to AventX in a call to query for document delivery and
configuration information. If the configuration for this document type includes the “BI Publisher
Destinations” destination, the information previously written to the FAX_DM_DATA table is retrieved, and all
destinations (print, fax, or email) are processed. “Normal” AventX processing flow occurs from here.

Embedding the AventX Tag in the Report Output

Oracle EBS users produce Oracle Reports output in TEXT format or XML/BI Publisher output in PDF format.
Regardless of the format, the report output must be modified to contain the key field information.

The following is a list of guidelines to use when formatting the DM_FAX_INFO tag. Failure to follow these
rules will result in improper processing of the document(s) by AventX:

• The value of the components returned in the DM_FAX_INFO string cannot contain the colon (:),
which is used in the processing to separate distinct values, or hyphen (-) which is used in Purchase
Order processing to distinguish between the PO number and the release.
• The first DM_FAX_INFO tag to be found in the document will be the one that is used for processing.
Any additional DM_FAX_INFO tags will be ignored. (Therefore, it is best practice to only have one
DM_FAX_INFO tag per document).
• For PDF reports, the entire DM_FAX_INFO tag must be formatted EXACTLY the same (e.g., same font,
size, color, etc.) Therefore, STR Software recommends that all formatting be removed from the
DM_FAX_INFO tag to avoid problems (e.g., “Clear Formatting” in Microsoft Word).
• For PDF reports, the entire DM_FAX_INFO tag must use a font with the following characteristics -
Type 1 font and ANSI Encoding. These characteristics can be verified in Adobe Acrobat by selecting
File->Document Properties->Fonts.
• For PDF reports, it is best to format the entire DM_FAX_INFO tag such that the color of the tag
matches the background, making it “invisible” (e.g., “white on white”).
• The report output should contain only an individual document, as batches are not supported. (For
processing of batches, see chapter 11, “Setting Up Formatting of Documents for Automatic
Delivery”).
• The field separator is a colon “:” and the termination character is a colon “:”.
• For TEXT-based documents, the entire DM_FAX_INFO tag must appear on a line by itself, with no
other data. When processed, the entire line will be parsed and deleted from the data file.
• To use Delivery Manager functionality on Oracle EBS 11i instances, the <ORGID> tag is required.
The <UID1>, <UID2>, and <UID3> variables depend on the document type. These are the key fields used by
AventX Oracle Connector to obtain configuration and other delivery information from the Oracle database
tables. The table below describes the required parameters if using the AventX seeded documents.
Configuring Software Modules - AventX for Oracle EBS
Page 389 of 944
Proprietary to STR Software
TEXT Report Output

For text-based documents, the report designer must insert a special tag (DM_FAX_INFO) into the report
which contains the necessary key field information. This special tag must exist on a line by itself (no other
data can be on the same line). When processed, this entire line is parsed and then deleted from the final
output file.

When parsing for the special tag, AventX will only use the first occurrence of the tag. Any subsequent
occurences will be disregarded.

The tag must follow a specific format as noted:

DM_FAX_INFO:<Request_ID>:<doc_type>:<Command>:<form
method>:<special>:<UID1>:<UID2>:<UID3>:<ORGID>:

For example: DM_FAX_INFO:12345:pop:[LANG=TEXT]:fcdi::1169:::204:

The parameters of this tag are described a little bit later.

Required Parameters for Text Report Output

Document Type Required Parameters

(Text Report
Output)
Request for Parameter 1 = RFQ Number (e.g., 304)
Quotation Parameter 2 = Supplier Number (e.g., 1008)
For example, DM_FAX_INFO:12345:rfqp:[LANG=TEXT]:fcdi:304:1008:
Purchase Order Parameter 1 = PO Number (e.g., 1169)

For example,
DM_FAX_INFO:12345:pop:[LANG=TEXT]:fcdi::1169:
Blanket Release Parameter 1 = PO Number (e.g., 501)
Purchase Order Parameter 2 = Release Number (e.g., 10)

For example,
DM_FAX_INFO:12345:pop:[LANG=TEXT]:fcdi::501:10:
PO Approval Parameter 1 = PO Number (e.g. 1170)
Purchase Order Parameter 2 = Revision Number (e.g., 1)

For example,

DM_FAX_INFO:12345:poap:[LANG=TEXT]:fcdi::1170:1:

Configuring Software Modules - AventX for Oracle EBS

Page 390 of 944
Proprietary to STR Software
 Document Type Required Parameters
(Text Report
Output)
PO Approval Blanket Parameter 1 = PO Number-Release Number (e.g. 501-10)
Release Parameter 2 = Revision Number (e.g., 2)

For example,

DM_FAX_INFO:12345:poap:[LANG=TEXT]:fcdi::501-10:2:
Sales Order Parameter 1 = Order Number (e.g., 51320)
Acknowledgement
For example,

DM_FAX_INFO:12345:soal:[LANG=TEXT]:fcdi::51320:
Invoice Parameter 1 = Invoice Number (e.g., 10007145)

For example,

DM_FAX_INFO:12345:invl:[LANG=TEXT]:fcdi::10007145:
Statement Parameter 1 = Customer Number (e.g., 1004)
Parameter 2 = Address1 (e.g., 1271 East Broad Street)

For example,

DM_FAX_INFO:12345:stmtl:[LANG=TEXT]:fcdi::1004:1271 Broad Street:

Work Order Parameter 1 = Work Order Name

For example,

DM_FAX_INFO:12345:work:[LANG=TEXT]:fcdi::57673:

PDF Report Output

Oracle EBS users can produce Oracle Reports or BI Publisher output in in PDF format. This report output must
be modified to contain the key field information. The report designer inserts an “invisible” tag, which
contains the key document fields, onto the first page of the report. The “invisible” tag can be placed
anywhere on the page. Normally, this tag is embedded at the beginning of the first page of the report output.
An example of a Delivery Manager PDF report file with an embedded tag (circled in red below) is shown
below.

Configuring Software Modules - AventX for Oracle EBS

Page 391 of 944
Proprietary to STR Software
The “invisible” tag must follow a specific format as noted below:
DM_FAX_INFO:<Request_ID>:<doc_type>:<Command>:<form method>:<special>:<UID1>:<UID2>:<UID3>:<ORGID>:

The parameters of this tag are described below.

Configuring Software Modules - AventX for Oracle EBS

Page 392 of 944
Proprietary to STR Software
Component Description

<Request_ID> The request id as assigned by the Concurrent Manager. It is your responsibility as the
customer to provide the request ID value for this parameter.

<doc_type> A (maximum) five-character code used to define the document type.

Valid values for the standard document types are: rfqp, rfql, pop, pol, poap, poal,
soal, invl, stmtl, or work.
For Add Your Own Documents, this must match the value specified in the definition
of the associated document.
This information is used to properly retrieve configuration and document
information related to this document.

<Command> Any valid command or string of commands for the document delivery system.
For example, to specify the format (Language) of the document to be PDF, this value
would be [LANG=PDF].

<form method> The method used to apply a form to text-based report output.
Valid values are: none, fcdi, generic, streamserve
For formatted output such as PDF, this value should be “none”.

<special> Used to indicate a special condition, such as whether the file is pdf, html, or whether
a confirmation copy should be printed for every document.
Valid values are: pdf, html, pdf printcc, uncollate, xml, html printcc (both previous
conditions, separated by a space) or <blank>.
The printed confirmation copy (from the printcc value) will be of the document only
and to the user‘s default printer as specified in the Oracle EBS configuration.

<UID1> A key field parameter that may be used by AventX to retrieve information associated
with the document.
For “standard” document types, this parameter is the document number.
This parameter is required, even if it will not be used for additional processing (e.g.,
even if the value will not be used in additional queries by AventX).

Configuring Software Modules - AventX for Oracle EBS

Page 393 of 944
Proprietary to STR Software
Component Description

<UID2> A second key field parameter that may be used by AventX to retrieve information
associated with the document.
This parameter may or may not be required, depending upon whether additional
keys are required to properly extract information from the Oracle database for
processing of this document type.
For example, for Requests for Quotation, a single document number can be issued to
multiple supplier sites. In this case, an additional parameter of <Supplier Number>
must be specified, in which case this parameter would be required.

<UID3> A third key field parameter that may be used by AventX to retrieve information
associated with the document.
This parameter may or may not be required, depending upon whether additional
keys are required to properly extract information from the Oracle database for
processing of the is document type.
For example, a customized statement report may require the customer number
(supplied as parameter 1), address (supplied as parameter 2), and date (supplied as
parameter 3).

<ORGID> For Oracle EBS 11i instances, this is required to retrieve the proper information
related to the concurrent processing for this document.
This field is required only if using Delivery Manager functionality on an Oracle EBS 11i
instance. It is NOT required for use with Oracle EBS R12+ and R12.1+ instances.

Configuring Software Modules - AventX for Oracle EBS

Page 394 of 944
Proprietary to STR Software
Required Parameters for PDF Output

Document Type Required Parameters

(PDF Report Output)
Request for Parameter 1 = RFQ Number (e.g., 304)
Quotation Parameter 2 = Supplier Number (e.g., 1008)

For example,
DM_FAX_INFO:12345:rfqp:[LANG=PDF]:none:pdf:304:1008:
Purchase Order Parameter 1 = PO Number (e.g., 1169)

For example,
DM_FAX_INFO:12345:pop:[LANG=PDF]:none:pdf:1169:
Blanket Release Parameter 1 = PO Number (e.g., 501)
Purchase Order Parameter 2 = Release Number (e.g., 10)

For example,
DM_FAX_INFO:12345:pop:[LANG=PDF]:none:pdf:501:10:
PO Approval Parameter 1 = PO Number (e.g. 1170)
Purchase Order Parameter 2 = Revision Number (e.g., 1)

For example,
DM_FAX_INFO:12345:poap:[LANG=PDF]:none:pdf:1170:1:
PO Approval Blanket Parameter 1 = PO Number-Release Number (e.g. 501-10)
Release Parameter 2 = Revision Number (e.g., 2)

For example,
DM_FAX_INFO:12345:poap:[LANG=PDF]:none:pdf:501-10:2:
Sales Order Parameter 1 = Order Number (e.g., 51320)
Acknowledgement
For example,
DM_FAX_INFO:12345:soal:[LANG=PDF]:none:pdf:51320:
Invoice Parameter 1 = Invoice Number (e.g., 10007145)

For example,
DM_FAX_INFO:12345:invl:[LANG=PDF]:none:pdf:10007145:
Statement Parameter 1 = Customer Number (e.g., 1004)
Parameter 2 = Address1 (e.g., 1271 East Broad Street)

For example,
DM_FAX_INFO:12345:stmtl:[LANG=PDF]:none:pdf:1004:1271 Broad Street:

Configuring Software Modules - AventX for Oracle EBS

Page 395 of 944
Proprietary to STR Software
 Document Type Required Parameters
(PDF Report Output)
Work Order Parameter 1 = Work Order Name

For example,
DM_FAX_INFO:12345:work:[LANG=PDF]:none:pdf:57673:

Removing the Delivery Options Button from the Users View

First off, why would you want to remove the button? Well, this button shows up right in the middle of the
user experience and you likely either want your users to use it, or do not want them touching it. If it’s the
latter, you can simply use Forms Personalization to make the button disappear. Here is a great blog post on
how to do this. http://www.strsoftware.com/blog/oracle-ebs-r12-1-3-submit-request-delivery-options-
button-removing-the-button-8-of-6

Configuring Software Modules - AventX for Oracle EBS

Page 396 of 944
Proprietary to STR Software
AventX for Oracle eAM

Requirements
Oracle EBS Requirements

• Support for Oracle EBS R12+ only

• Support for Oracle self-service and Oracle forms Work Order processing

• Allows selection of Work Orders from query to define the batch (not necessarily consecutive Work
Orders)

• Allows selection of Entity/Category pairs for attachments to be included in submission

• Allows the Oracle printer to be specified

• Allows definition and configuration for Email/Fax/Print/XML Archive recipients (via “AventX
Automatic” printer)

• Requires Oracle personalization to implement

SharePoint Requirements

AventX can access and process documents that are stored in secured web applications such as SharePoint.
The following SharePoint version support is offered:

• Attachment Gathering Feature

o SharePoint Server 2010, 2013, and 2016
o SharePoint Online
• Digital Print Feature
o SharePoint Server 2010, 2013, and 2016
• Mobile Module / Feature
o SharePoint Server 2010, 2013, and 2016
o SharePoint Online
For AventX Attachment Xpress to successfully extract attachments using SharePoint Online, the following
prerequisites must be met:

• A SharePoint Online user with “Read Items in All Site Collections” application permissions.
• The Client ID created during Azure Active Directory registration.
See the AventX for Oracle EBS Resource Guide for instructions about integrating AventX Attachment Express
with SharePoint Online.

VIZIYA WorkAlign Scheduler Requirements

STR Software and VIZIYA have created a partnership to integrate AventX Attachment Xpress with VIZIYA’s
WorkAlign Scheduler. Through this integration, users are provided the functionality to print a single or
dynamic range of work orders with associated attachments directly from the Scheduler Application.

System requirements for this integration are as follows:

Configuring Software Modules - AventX for Oracle eAM
Page 397 of 944
Proprietary to STR Software
• Oracle EBS R12.1+ or R12.2+
• Oracle EBS Report Type: Seeded Maintenance Work Order Detail Report
• WorkAlign Scheduler Version 5.1 – 6.01 for AventX versions 7.7.xx through 9.1.00
• WorkAlign Scheduler Version 6.02 through 7.2.1 for AventX version 9.2.00 or greater
o The following packages must be applied:
▪ APPSPrintPackages_v9200.sql
▪ VZSchedulerPrintPackages_9200.sql
• Any applicable license key options from STR Software and VIZIYA

Configuring Software Modules - AventX for Oracle eAM

Page 398 of 944
Proprietary to STR Software
Mobile for eAM Requirements

The following are the requirements to using the AventX Mobile for eAM software

• AventX for Oracle eAM v14.3.00 or higher

• AventX Mobile for eAM Requirements - In addition to the requirements above for AventX Print Xpress,
AventX Mobile requires AventXPS to be running in SSL mode.
• SSL Certificate - Running AventXPS in SSL mode for AventX Mobile requires a signed SSL certificate to be
installed on the AventX host in a Java keystore. See Appendix A Securing AventX with SSL over HTTPS for
more information.
• Mobile Device Requirements - Both AventX Mobile applications can be used on any iPhone or iPad
running iOS 10, 11, 12, or 13.
• Attachment Upload Requirements - AventX Mobile Work Requests and Mobile Work Orders both have
the ability to upload files as attachments. The use of this feature requires a document library on
SharePoint 2010 or later, and a Windows server running AventX Translation Server 3.6.01 or later.
• BI Publisher – Modifications to the BI Publisher Layout Template are required to some of the software
features.

Configuring Software Modules - AventX for Oracle eAM

Page 399 of 944
Proprietary to STR Software
Introduction
The AventX for Oracle eAM software automates the delivery and processing of work orders and their
associated document attachments from eAM. This section provides information on how to configure the
AventX software for use with Oracle eAM.

The software processes attachments for print requests by passing the report output and associated
attachments for a given print request to a module called the “AventX Translation Server”, a Linux or
Windows-based based server used to translate all attachments in the print job to PDF format. The resulting
PDF file is then passed back to AventX for Oracle eAM for printing.

This requires the AventX Translation Server software be installed on a Linux or Windows-based server and
configured for communication to the AventX Host. The AventX Host must then be configured to pass the
document and attachments to the AventX Translation Server.

AventX Translation Server installation and configuration is outlined in the AventX Translation Server Resource
Guide and will not be discussed further here.

The AventX for Oracle eAM provides several methods for printing Work Orders.

• Interactive Work Order Printing

• Parent / Child Work Order Printing
• Workbench Printing
• VIZIYA WorkAlign Scheduler Printing

Configuring Software Modules - AventX for Oracle eAM

Page 400 of 944
Proprietary to STR Software
User Experience

There are slightly different user experiences when submitting Work Orders to AventX from Self Service and
Oracle Forms. The following provides a summary of each user experience.

Self-Service

This section describes the AventX Interactive Work Order Printing user experience. The system must be
properly configured as outlined later in this chapter before this functionality is available to the user.

After creating and saving a work order, a user can print a single or batch of work orders directly from the self-
service Work Orders tab with the aid of personalization. Using the Maintenance Super User (or equivalent
responsibility), from the standard Work Orders tab, the user searches for one or more work orders to print.

Clicking Go will return either a list of work orders or a singular work order that fits the search criteria. From
the results, the user clicks the <Print Work Orders> button

Configuring Software Modules - AventX for Oracle eAM

Page 401 of 944
Proprietary to STR Software
An AventX custom controller class is invoked that displays all the Work Orders as queried by the user, along
with several other types of information.

Configuring Software Modules - AventX for Oracle eAM

Page 402 of 944
Proprietary to STR Software
This page is divided into several sections:

The Select Work Orders section, outlined in red, contains a list of all Work Orders as displayed in the Find
Results form from the original query. The user indicates which work orders to print by clicking the checkbox
to the left of the work order. All checkboxes are ENABLED by default.

• The Parameters section, outlined in blue, contains a list of parameters to use when generating the
output data. These parameters are passed to the Concurrent Manager upon clicking the <Submit Work
Order(s) for Print> button. The user indicates which parameters to include by clicking the checkbox to the
left of the parameter. All checkboxes are ENABLED by default; however, AventX can be configured to
control the default checkbox status for the Short Text Attachments and Long Text Attachments
parameters when the form is invoked. Consult the “Modify the Document Definition” details in this
section for further information.

• The Attachment Types section, outlined in green are dynamic fields that allow users to select which
configured attachment entity and category combinations they would like to print along with the selected
Work Orders. The user indicates which attachment types to include in the printing of the Work Order
document by clicking the checkbox to the left of the attachment type.

• The appearance of these Entity/Category parings on the form is controlled by the AventX Administrator
via two configuration items (User Specified Attachments and Restrict Attachments checkboxes) on the
“Work Order UI Specific Behavior” canvas of the AventX Document Configuration form, as discussed in a
later section.

• The Printer section, outlined in orange, contains a drop-down list of available printers for this
submission. The printer list is configurable as described for the Work Order UI Specific Behavior canvas of
the AventX Document Configuration form (for the Work Order document type). The user selects the
desired printer for the output (whose contents are defined by the other parameters on this page). The
printer value is passed to the Concurrent Manager upon clicking the <Submit Work Order(s) for Print>
button.

• The BIP Formatting Options section, outlined in purple allows the user to select the template and locale
for the generated document. The format of the generated document is always PDF, regardless of the
selection made by the user on this page.

Configuring Software Modules - AventX for Oracle eAM

Page 403 of 944
Proprietary to STR Software
The buttons on the page are used to submit the work order for printing. When the <Submit Work Order(s) for
Print> button is clicked, a determination of the work orders selected by the user is made, along with the
parameters and BI Publisher settings. A Concurrent Request is then generated to submit the document for
processing by AventX.

Once you have specified the desired options, click the <Submit Work Order(s) for Print> button. This calls the
fnd_submit.submit_request Oracle API to submit a concurrent request to the Concurrent Manager, passing
the work order numbers that are checked on the page. If there are no errors with calling the
fnd_submit.submit_request Oracle API, you will receive a dialog message similar to the following.

At the top of the page, information will be displayed detailing how many work orders were submitted as well
as the Concurrent Request ID as generated by the Concurrent Manager. This area will also be used for
displaying any error messages that occur while submitting the concurrent request.

The concurrent program definition associated with this request is a copy of the seeded program
“Maintenance Work Order Detail Report” modified to accept specific Work Order numbers to generate the
appropriate output, as discussed later in this chapter.

If you do not receive a similar message, then the call to fnd_submit.submit_request has failed. You should
ensure that you have the proper BI Publisher template & locale settings, as this could likely be the problem.

Ensure that your request completes normally. If it does not, you will need to troubleshoot why the
concurrent request is not completing. Consult the “Enable Debugging” section below for additional help.

Once the Concurrent Manager generates the report, AventX is invoked to enable processing (printing) of the
Work Orders and their specified attachments. Any errors that occur during the actual generation of the data
during the concurrent request execution will need to be resolved by the System Administrator, as the
unsuccessful completion of a concurrent request is prior to any processing by AventX.

It is important to note that the time between a user clicking the <Submit Work Order(s) for Print> button and
the work orders printing depends on a number of factors since AventX will not be able to process the work
order(s) until the concurrent program completes normally. This could take considerable time, depending
upon system load, concurrent processing throughput and volume of work orders being generated in a single
submission (batch).

Oracle Forms
Configuring Software Modules - AventX for Oracle eAM
Page 404 of 944
Proprietary to STR Software
This section describes the Interactive Work Order Submission user experience from Oracle forms.

The first step using the AventX Interactive Work Order Submission form is invoked properly from the Work
Orders form.

As the Enterprise Asset Manager (or equivalent) responsibility, navigate to Work Orders→Work Orders and
perform a search for one or more Work Orders. In our example, we are searching for Work Orders based
upon the dtf35000 Asset Number.

Our results yield eight Work Orders with this Asset Number.

From the results, the user invokes the AventX Interactive Work Order Submission form by selecting Submit
Work Orders for Print from the Tools menu. Click the Tools menu, and select the “Submit Work Orders for
Print” menu item.

Configuring Software Modules - AventX for Oracle eAM

Page 405 of 944
Proprietary to STR Software
The AventX Interactive Work Order Submission form is now displayed. If the form is not invoked, double-
check your forms personalization configuration as outlined earlier in this chapter.

Configuring Software Modules - AventX for Oracle eAM

Page 406 of 944
Proprietary to STR Software
The Select Work Orders section of the form should have all of the work orders listed that were returned to
you as a result of your search for work orders. If you do not see any work orders listed here, ensure that the
configuration for Rule 2 is correct, specifically that the Action portion is configured to call the STR-WOUIPT
function using a custom library, as described in the section entitled “Defining the Second Rule” of this
chapter.

The Attachment Types section may or may not be populated with Entity/Category pairs depending upon
configuration. Recall that this ability is determined by the “User Specified Attachments” checkbox on the
Work Order UI Specified Behavior canvas for the work order document type via the AventX Document
Configuration form. If available, select the Entity/Category pairs whose attachments you would like to
include with the work order for your test. If unavailable, this part of the form is not editable by the user.

In the BIP Formatting Options section, ensure that you select the proper template and locale that has been
modified to include the AVENTX_INFO tag for AventX processing. Failure to do so will result in an error
(Unable to successfully page document) during processing by AventX for Oracle eAM.

This form is divided into a number of sections:

The Select Work Orders section, outlined in red, contains a list of all Work Orders as displayed in the Find
Results form from the original query. The user indicates which work orders to print by clicking the checkbox
to the left of the work order. All checkboxes are ENABLED by default.

• The Parameters section, outlined in blue, contains a list of parameters to use when generating the
output data. These parameters are passed to the Concurrent Manager upon clicking the “Submit
Work Order(s) for Print” button. The user indicates which parameters to include by clicking the
checkbox to the left of the parameter. All checkboxes are ENABLED by default; however, AventX can
Configuring Software Modules - AventX for Oracle eAM
Page 407 of 944
Proprietary to STR Software
 be configured to control the default checkbox status for the Short Text Attachments and Long Text
Attachments parameters when the form is invoked.

• The Attachment Types section, outlined in green are dynamic fields that allow users to select which
configured attachment entity and category combinations they would like to print along with the
selected Work Orders. The user indicates which attachment types to include in the printing of the
Work Order document by clicking the checkbox to the left of the attachment type.

The appearance of these Entity/Category parings on the form is controlled by the System
Administrator via two configuration items (User Specified Attachments and Restrict Attachments
checkboxes) on the “Work Order UI Specific Behavior” canvas of the AventX Add Your Own
Document form, as discussed in a later section of this chapter.

• The BIP Formatting Options section, outlined in purple allows the user to select the template and
locale for the generated document. The format of the generated document is always PDF, which is
accomplished automatically “behind the scenes”.

• The Printer section, outlined in orange, contains a drop-down list of available printers for this
submission. The printer list is configurable as described for the Work Order UI Specific Behavior
canvas of the AventX Document Configuration form (for the Work Order document type). The user
selects the desired printer for the output (whose contents are defined by the other parameters on
this page). The printer value is passed to the Concurrent Manager upon clicking the <Submit Work
Order(s) for Print> button.

The buttons on the form are used to submit the work order for printing or to cancel out from the form
altogether. When the <Submit Work Order(s) for Print Button> is clicked, a determination of the work orders
selected by the user is made, along with the parameters and BI Publisher settings. A Concurrent Request is
then generated to submit the document for processing by AventX.

Once you have specified the desired options, click the <Submit Work Order(s) for Print> button. This calls the
fnd_submit.submit_request Oracle API to submit a concurrent request to the Concurrent Manager, passing
the work order numbers that are checked on the form. If there are no errors with calling the
fnd_submit.submit_request Oracle API, you will receive a dialog message similar to the one below.

A dialog box will be displayed detailing how many work orders were submitted as well as the Concurrent
Request ID as generated by the Concurrent Manager. This area will also be used for displaying any error
messages that occur while submitting the concurrent request.

Configuring Software Modules - AventX for Oracle eAM

Page 408 of 944
Proprietary to STR Software
If you do not receive a dialog box similar to the one above, then the call to fnd_submit.submit_request has
failed. You should ensure that you have the proper BI Publisher template & locale settings, as this could likely
be the problem.

Ensure that your request completes normally. If it does not, you will need to troubleshoot why the
concurrent request is not completing. Consult the “Enable Debugging” section below for additional help.

The concurrent program definition associated with this request is actually a copy of the seeded program
“Maintenance Work Order Detail Report” modified to accept specific Work Order numbers to generate the
appropriate output, as discussed later in this section.

Once the Concurrent Manager generates the report, AventX is invoked to enable processing (printing,
archiving, et. al.) of the Work Orders and their specified attachments. Any errors that occur during the actual
generation of the data during the concurrent request execution will need to be resolved by the System
Administrator, as the unsuccessful completion of a concurrent request is prior to any processing by AventX.

It is important to note that the time between a user clicking the <Submit Work Order(s) for Print> button and
the work orders actually printing depends on a number of factors, as AventX will not be able to process the
work order(s) until the concurrent program completes normally. This could take considerable time,
depending upon system load, concurrent processing throughput and volume of work orders being generated
in a single submission (batch).

Parent/Child Work Order Printing

The following are the requirements for using this software feature.

• Support for Oracle EBS R12+ only

• Support for Oracle self-service

• Allows selection of Parent Work Orders from query to define the batch (to include related Child Work
Orders)

• Allows selection of Entity/Category pairs for attachments to be included in submission

• Allows the Oracle printer to be specified

• Allows definition and configuration for Email/Fax/Print/XML Archive recipients (via “AventX
Automatic” printer)

• Requires Oracle personalization to implement

Oracle Enterprise Asset Management (hereafter referred to as eAM) provides the capability for maintenance
staff to create Work Orders to report problems with assets. However, the Work Orders interface in eAM lacks
the capability for users to select Parent/Child work orders, and/or any specific attachments for printing
and/or other delivery, and/or the desired destination printer. AventX for Oracle eAM provides a solution for
the printing and/or delivery of Parent/Child Work Order documents along with their respective attachments
via the self-service (e.g. Maintenance Super User: Work Orders) interface.

Configuring Software Modules - AventX for Oracle eAM

Page 409 of 944
Proprietary to STR Software
This section describes the Parent/Child Work Order Advanced Printing user experience, and is intended to
provide an overview of the Parent/Child Work Order Advanced Printing process via self-service. The system
must be properly configured as outlined later in this chapter before this functionality is available to the user.

After creating and saving a work order, a user can create a Parent/Child relationship between work orders,
and then print a single or batch of Parent/Child work orders directly from the self-service Update Work
Hierarchy page with the aid of personalization. Using the Maintenance Super User (or equivalent
responsibility), from the standard Work Orders tab, the user searches for the Parent work order.

Once the Parent work order has been located, the user clicks on the link to open the Parent work order.

Next, the user clicks the “Work Relationships” tab to view the hierarchical relationship between the Parent
work order and its child work orders.

Configuring Software Modules - AventX for Oracle eAM

Page 410 of 944
Proprietary to STR Software
The user then clicks the “Update Work Hierarchy” button.

An AventX custom controller class (xxstrWorkOrderHierarchyCO) is invoked that displays the Parent work
order and its associated child work orders, along with several other types of information.

Configuring Software Modules - AventX for Oracle eAM

Page 411 of 944
Proprietary to STR Software
This page is divided into a number of sections:

The Select Work Orders section, the first section at the top of the form, contains a hierarchical list of the
Parent work order and its children. The user indicates which work orders to print by clicking the checkbox to
the right of the work order. All checkboxes are ENABLED by default. The Select All for Print
button will ensure that the Print checkbox is checked for every work order listed. The Select None for
Print button will ensure that the Print checkbox is unchecked for every work order listed. These buttons
are useful especially when a Parent work order has many child work orders associated with it, as it provides a
“quick” way to select or de-select the work orders as a group instead of individually.

Changing focus of the horizontal grid layout on this page does not change the context of work orders that will
be printed. Checkboxes must be used to select work orders to be printed.

All other fields / drop down boxes in this section are inherent Oracle EBS functionality, and discussion of
these components is beyond the scope of this document. Consult the proper Oracle EBS eAM technical
guides for further information regarding these components.

• The Print Parameters section, in the middle of the page, contains a list of parameters to use when
generating the output data. These parameters are passed to the Concurrent Manager upon clicking
the <Submit Selected Work Order(s) for Print> button. The user indicates which parameters to
include by clicking the checkbox to the left of the parameter. All checkboxes are ENABLED by default;
however, AventX can be configured to control the default checkbox status for the Short Text
Attachments and Long Text Attachments parameters when the form is invoked. Consult the “Modify
the Document Definition” in this section for further information.

• The next section, Attachment Types, contains dynamic fields that allow users to select which
configured attachment entity and category combinations they would like to print along with the
selected Work Orders. The user indicates which attachment types to include in the printing of the
Work Order documents by clicking the checkbox to the left of the attachment type.
Configuring Software Modules - AventX for Oracle eAM
Page 412 of 944
Proprietary to STR Software
 The appearance of these Entity/Category parings on the form is controlled by the System
Administrator via the User Specified Attachments checkbox on the “Work Order UI Specific Behavior”
canvas of the AventX Document Configuration form, as discussed in a later section. Note that
Restrict Attachment Category functionality is not enabled for Parent/Child Work Order printing and
all attachment Entity/Category pairings will be displayed on this page.

• The Print Options section at the bottom of the page contains a drop-down list of available printers for
this submission. The template and locale for the generated document are BI Publisher related fields
which specify the name of the BI Publisher template and locale information for the template. The
printer list is configurable as described for the Work Order UI Specific Behavior canvas of the AventX
Document Configuration form (for the Work Order document type). The user selects the desired
printer for the output (whose contents are defined by the other parameters on this page). The
printer value is passed to the Concurrent Manager upon clicking the <Submit Selected Work Order(s)
for Print> button.

The <Submit Selected Work Order(s) for Print> button is used to submit the selected work order(s) for
printing. The buttons below this button (Cancel, Save and Continue, Apply) are standard EBS functionality for
the Update Work Hierarchy page, and are not used for the submission of the work order(s) for printing.

When the <Submit Selected Work Order(s) for Print> button is clicked, a determination of the work orders
selected by the user is made, along with the parameters and BI Publisher settings. A Concurrent Request is
then generated to submit the document for processing by AventX.

At the top of the page, information will be displayed detailing how many work orders were submitted as well
as the Concurrent Request ID as generated by the Concurrent Manager. This area will also be used for
displaying any error messages that occur while submitting the concurrent request.

The concurrent program definition associated with this request is actually a copy of the seeded program
“Maintenance Work Order Detail Report” modified to accept specific Work Order numbers to generate the
appropriate output, as discussed later in this chapter.

Once the Concurrent Manager generates the report, AventX is invoked to enable processing (printing) of the
Work Orders and their specified attachments. Any errors that occur during the actual generation of the data
during the concurrent request execution will need to be resolved by the System Administrator, as the
unsuccessful completion of a concurrent request is prior to any processing by AventX.

It is important to note that the time between a user clicking the <Submit Selected Work Order(s) for Print>
button and the work orders actually printing depends on a number of factors, as AventX will not be able to
process the work order(s) until the concurrent program completes normally. This could take considerable
time, depending upon system load, concurrent processing throughput and volume of work orders being
generated in a single submission (batch).
Configuring Software Modules - AventX for Oracle eAM
Page 413 of 944
Proprietary to STR Software
Oracle eAM Workbench Printing

The following are the requirements for using this software feature.

• Support for Oracle EBS R12+ only

• Support for Oracle self-service
• Allows selection of individual or multiple Work Orders from the workbench to define the batch (not
necessarily consecutive Work Orders)
• Allows selection of Entity/Category pairs for attachments to be included in submission
• Allows the Oracle printer to be specified
• Allows definition and configuration for Email/Fax/Print/XML Archive recipients (via “AventX
Automatic” printer)
• Requires Oracle personalization to implement
After creating and saving a work order, a user can print a single or batch of work orders directly from the self-
service Workbench (My Work Queue) with the aid of personalization. Using the Maintenance User
Workbench (or equivalent responsibility), the “Home” page (My Work Queue) lists the work orders available
for printing.

The user may choose to print an individual Work Order via the link in the “Print Work Order” column, or print
all or some combination of the Work Orders via the <Print Work Orders> button. Either choice will redirect
the user to the “Work Order Report” page.

Configuring Software Modules - AventX for Oracle eAM

Page 414 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 415 of 944
Proprietary to STR Software
An AventX custom controller class is invoked that displays all the Work Orders as specified by the user, along
with several other types of information:

This page is divided into a number of sections:

• The Select Work Orders section, outlined in red, contains a list of all Work Orders previously
specified by the user. The user indicates which work orders to print by clicking the checkbox to the
left of the work order. All checkboxes are ENABLED by default.
• The Parameters section, outlined in blue, contains a list of parameters to use when generating the
output data. These parameters are passed to the Concurrent Manager upon clicking the <Submit
Work Order(s) for Print> button. The user indicates which parameters to include by clicking the
checkbox to the left of the parameter. All checkboxes are ENABLED by default.
• The appearance of these Entity/Category parings on the form is controlled by the System
Administrator via two configuration items (User Specified Attachments and Restrict Attachments
checkboxes) on the “Work Order UI Specific Behavior” canvas of the AventX Document Configuration
form form, as discussed in a later section of this chapter
• The Attachment Types section, outlined in green are dynamic fields that allow users to select which
configured attachment entity and category combinations they would like to print along with the
selected Work Orders. The user indicates which attachment types to include in the printing of the
Work Order document by clicking the checkbox to the left of the attachment type.
The appearance of these Entity/Category parings on the form is controlled by the System
Administrator via two configuration items (User Specified Attachments and Restrict Attachments
checkboxes) on the “Work Order UI Specific Behavior” canvas of the AventX Document Configuration
form form, as discussed in a later section of this chapter
• The Printer section, outlined in orange, contains a drop-down list of available printers for this
submission. The printer list is configurable as described for the Work Order UI Specific Behavior
canvas of the AventX Document Configuration form (for the Work Order document type). The user
selects the desired printer for the output (whose contents are defined by the other parameters on
this page). The printer value is passed to the Concurrent Manager upon clicking the <Submit Work
Order(s) for Print> button.
• The BIP Formatting Options section, outlined in purple allows the user to select the template and
Configuring Software Modules - AventX for Oracle eAM
Page 416 of 944
Proprietary to STR Software
 locale for the generated document. The format of the generated document is always PDF, regardless
of the selection made by the user on this page.
The buttons on the page are used to submit the work order for printing. When the <Submit Work Order(s) for
Print> button is clicked, a determination of the work orders selected by the user is made, along with the
parameters and BI Publisher settings. A Concurrent Request is then generated to submit the document for
processing by AventX for Oracle eAM.
At the top of the page, information will be displayed detailing how many work orders were submitted as well
as the Concurrent Request ID as generated by the Concurrent Manager. This area will also be used for
displaying any error messages that occur while submitting the concurrent request.

The concurrent program definition associated with this request is actually a copy of the seeded program
“Maintenance Work Order Detail Report” modified to accept specific Work Order numbers to generate the
appropriate output, as discussed later in this chapter.
Once the Concurrent Manager generates the report, AventX is invoked to enable processing (printing) of the
Work Orders and their specified attachments. Any errors that occur during the actual generation of the data
during the concurrent request execution will need to be resolved by the System Administrator, as the
unsuccessful completion of a concurrent request is prior to any processing by AventX for Oracle eAM.
It is important to note that the time between a user clicking the <Submit Work Order(s) for Print> button and
the work orders actually printing depends on a number of factors, as AventX for Oracle eAM will not be able
to process the work order(s) until the concurrent program completes normally. This could take considerable
time, depending upon system load, concurrent processing throughput and volume of work orders being
generated in a single submission (batch).

Configuring Software Modules - AventX for Oracle eAM

Page 417 of 944
Proprietary to STR Software
Configuration
Deploying the AventX Controllers

This step may have been performed during the installation of the software. If not then following these
instructions to extract the AventX JAVA controllers on the applications tier.

As the applmgr or equivalent user, copy the $FCHOME/oa/ins/xxstrJavaControllers.tar from the AventX
server to the Oracle Applications forms tier(s).

Log onto the Oracle Applications tier and change directory and extract the file in the $JAVA_TOP directory.

$cd $JAVA_TOP

$tar –xvf xxstrJavaControllers.tar

The following folders will be created.

Configuring Software Modules - AventX for Oracle eAM

Page 418 of 944
Proprietary to STR Software
Oracle EBS r12.2.x Implementations

The controller extraction steps need to be performed as part of a PATCH CYCLE. In addition, the execution of
Oracle’s adcgnjar utility is required to generate and sign a file called customall.jar that contains all
custom Java code and extensions. This utility does not require any parameters on the command line, but will
require the password for the APPS user at a prompt.

adcgnjar

This step will create a customall.jar file in the $JAVA_TOP directory. Next, complete the steps
necessary for finishing a patch cycle.

Oracle EBS Configuration

The following configuration is required regardless of the preferred printing method that will be implemented.

Registering the AventX for Oracle eAM Forms

AventX for Oracle eAM creates several Oracle forms as part of the installation. These forms are compiled and
placed into the Oracle file system. They need to be registered in Oracle EBS so they can be used to configure
the AventX software.
Registering the AventX Forms

Registering a form in Oracle E-Business Suite associates the form executable filename with a friendlier display
name for the form. The form must be registered before the menu item can be created. Follow these steps to
register the AventX forms:
• Log in to Oracle Applications with the Application Developer responsibility.
• Select Application, then Form to bring up the below form.

Use the following table to help with the data entry required when registering the AventX forms. For all
forms, the application should be the CUSTOM application that was created during the “Pre-Installation”
Configuring Software Modules - AventX for Oracle eAM
Page 419 of 944
Proprietary to STR Software
software installation steps, e.g, “AventX for Oracle EBS”. If the forms were put into $FND_TOP as part of the
software installation then you will want to use “Application Object Library” for the “Application” field.

Form Application User Form Name Description

FCOAXCFG AventX for AventX System Configuration This form is used to configure the
Oracle EBS default parameters for Options,
Destinations, Acknowledgements, and
Attachments for each organization
and each document type.

FCOAAYOD AventX for AventX Document This form is used to perform advanced
Oracle EBS Configuration document configuration.

FCOAWOPT AventX for AventX Work Order Print This form is used for Interactive Work
Oracle EBS Order Submission, whereby a user can
select specific work orders from the
Oracle Work Orders form for
processing by AventX.

FCOASTAT AventX for AventX Delivery Status This form is used to display the
Oracle EBS delivery status of documents
processed via AventX.

• Select File, then Save from the menu and close the Forms window.
Creating the AventX Form Functions

The structure of Oracle EBS dictates that each menu item be linked to a Function. This Function is then
associated with the form so that selecting the menu item ultimately causes the form to activate. Follow these
steps to define a function for the AventX forms:

As Application Developer under Application, select the Function menu item. Choose the Description tab.

Configuring Software Modules - AventX for Oracle eAM

Page 420 of 944
Proprietary to STR Software
Description Tab

Enter data into the Description tab according to the table below, one record for each row in the table:

Function User Function Name Description

FCOA_FCOAXCFG AventX System Configuration AventX System Configuration

FCOA_FCOAAYOD AventX Document Configuration AventX Document Configuration

FCOA_FCOAWOPT AventX Work Order Print AventX Work Order Print

FCOA_FCOASTAT AventX Delivery Status AventX Delivery Status

Configuring Software Modules - AventX for Oracle eAM

Page 421 of 944
Proprietary to STR Software
Form Tab

Choose the Form tab at the top of the Form Functions form. Enter data into the Form tab according to the
table below (the Application field will populate automatically when a form is selected:

Function Form Application

FCOA_FCOAXCFG AventX Configuration AventX for Oracle EBS

FCOA_FCOAAYOD AventX Document Configuration AventX for Oracle EBS

FCOA_FCOAWOPT AventX Work Order Print AventX for Oracle EBS

FCOA_FCOASTAT AventX Delivery Status AventX for Oracle EBS

Configuring Software Modules - AventX for Oracle eAM

Page 422 of 944
Proprietary to STR Software
Properties Tab

Choose the Properties tab at the top of the form. Under Type, select Form for all entries. Select File, then
Save from the top menu and close the window.

Configuring Software Modules - AventX for Oracle eAM

Page 423 of 944
Proprietary to STR Software
Displaying the AventX Forms in the Oracle Navigator Menu

You must define menu items for any AventX forms you wish to grant access to. Menu items must be defined
for each responsibility you wish to have access. Menu items may have a prompt value, or be “hidden” (some
forms are triggered by View → Zoom). A typical menu item definition for the System Administrator
responsibility is provided below as an example. Since there are many items associated with AventX, we’ll use
a submenu.

• As Application Developer, under Application, select the Menu item.

• Create a new menu in the form below. This will become a new submenu for the “Install Menu”.

Using the table data below continue to fill out the Menu form and register the appropriate values.

Menu FND_NAVAVENTX4.0

User Menu Name AventX Menu - System Administrator GUI

Menu Type Standard

Description AventX for Oracle EBS submenu

Configuring Software Modules - AventX for Oracle eAM

Page 424 of 944
Proprietary to STR Software
The following is a text view of the table information on the Oracle Menus form:

Seq Prompt Submenu Function Description

1 Configuration <blank> AventX Connector Configuration AventX Configuration

2 Delivery Status <blank> AventX Delivery Status AventX Delivery Status

3 Add Document <blank> AventX Document Configuration AventX Document

Configuration

• Select File, then Save from the top menu.

Configuring Software Modules - AventX for Oracle eAM

Page 425 of 944
Proprietary to STR Software
Creating the AventX Administrator Responsibility

It is recommended you create an “AventX Administrator” responsibility that allows certain individuals access
to configuration and troubleshooting forms. Use the following instructions to create an “AventX
Administrator” responsibility.

• Log in as an Oracle EBS user with the “System Administrator” responsibility.

• Select Security, then Responsibility, then Define.
• Create the AventX Administrator responsibility similar to the following. This is only an example:

Configuring Software Modules - AventX for Oracle eAM

Page 426 of 944
Proprietary to STR Software
• Add the newly created responsibility to the appropriate user(s) by selecting Security, then User, then
Define, then selecting AventX Administrator under the Responsibility field as shown below.

Configuring Software Modules - AventX for Oracle eAM

Page 427 of 944
Proprietary to STR Software
Add AventX Menu to System Administrator Responsibility (Optional)

An alternative to creating the “AventX Administrator” responsibility is to put the AventX menu items under
the System Administrator responsibility.

• Select Application, then Menu.

• Under Menu, query for FND_NAVSITE4.0. You will see several menu items listed. Begin creating a new
one just below the last item in the list as shown.

• Type the next available number in the Seq column.

• Type “AventX” in the Navigator Prompt column.
• Choose AventX Menu - System Administrator GUI from the List of Values for the submenu column.
• Type “AventX Attachment Xpress” in the Description column.
• Select File, then Save from the menu.
You will typically need to create a hidden menu item for the AventX Delivery Status form. These menu items
will need to be created for each Oracle Applications responsibility that you want to have these functional
capabilities.

Configuring Software Modules - AventX for Oracle eAM

Page 428 of 944
Proprietary to STR Software
HINT: If you are unsure of the menu name associated with a responsibility, select Security, then
Responsibility, then Define as System Administrator, query for the responsibility, and look at the value in the
Menu field:

This gives a starting point of a top-level menu that you can use to narrow down the choices to the correct
menu.

Configuring Software Modules - AventX for Oracle eAM

Page 429 of 944
Proprietary to STR Software
If printing work orders using AventX, you will need to create a “hidden” menu item for the AventX Work
Order Print form for the Enterprise Asset Management (or equivalent) responsibility. We will show the
entries for the EAM_MAIN menu as an example:

• Create a new record just below the last item in the list.
• Type the next available number in the Seq column.
• Leave the Navigator Prompt column blank.
• Choose AventX Work Order Print from the List of Values for the Function column.
• Type “AventX Work Order Print Form” in the Description column.
• Select File, then Save from the top menu to save your changes.

You can also add the AventX Delivery Status form to this menu as described above.

Configuring Software Modules - AventX for Oracle eAM

Page 430 of 944
Proprietary to STR Software
Creating the AventX Driver, Style, Types and Printers

As previously discussed in the earlier section entitled “Setting up the AventX Drivers, Styles, Types and
Printers” AventX uses printers to pass report output from the Concurrent Manager to AventX for Oracle eAM
for processing.

Please refer to this prior section if necessary and the use the following information to create the required
Driver and Style for AventX Work Order processing.

Creating AventX for Oracle eAM Printer Driver(s)

Driver Value

Driver Name AventX Work Order

User Driver AventX Work Order

Description AventX for Oracle eAM Work Order

SRW Driver HPL For Landscape Reports

Deliver Spool File – Always check this check box.

Method

Configuring Software Modules - AventX for Oracle eAM

Page 431 of 944
Proprietary to STR Software
 Arguments $XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"
"$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "[LANG=PDF]" "work:I" "none" "pdf"

Creating AventX for Oracle eAM Style(s)

Use the form below to create the AventX for Oracle eAM print style(s):

Populate the form with the following values:

Field Name Value

Style Name AventX Work Order

Seq Enter a unique sequence number.

User Style AventX Work Order

Description AventX for Oracle eAM Work Order

SRW Driver HPL

Columns 132

Rows 51

Orientation L
Creating AventX for Oracle eAM Printer Type(s)

Associate the new Style and Driver combination with the appropriate Type for Work Order printing in your
environment (for example “-PASTA Universal Printer Type”).

Configuring Software Modules - AventX for Oracle eAM

Page 432 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 433 of 944
Proprietary to STR Software
Creating the AventX Oracle Connector Profile Options

AventX has several Oracle Profiles that need to be created. The following section provides information on the
purpose these profile options serve, how they are created and configured.

AventX System Profile Options

XXSTR_SEQNO

To use Automatic Delivery, Interactive Delivery (via the AventX Interactive Delivery form) or Stand Alone
Interactive Delivery (via the AventX Stand Alone Interactive Delivery form), it is necessary to create a new
profile option that will hold a unique sequence number for each report submitted to AventX via the
Concurrent Manager.

• Log in to Oracle Applications as the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.
• Create a new profile option as shown:

For Application, select the custom application set up for AventX Oracle Connector (usually the application
name mapped to “AventX for Oracle EBS”).
• Select File, then Save from the top menu to save your changes.

Configuring Software Modules - AventX for Oracle eAM

Page 434 of 944
Proprietary to STR Software
Setting up the Work Order Concurrent Program

Requirements

Report output must provide the “Entity Name” value (document number). The chosen maintenance
organization MUST be found in the report parameters (This is standard for the seeded Oracle Maintenance
Work Order Detail Report).

Create the XXSTR_JOBIDNUMBER Value Set

Processing of the Work Orders by AventX requires the tracking of a new parameter, a job ID number. This
parameter requires a value set, as it is associated with an AventX table.

Navigate as System Administrator to Application→Validation→Set and fill in the values as shown below.

Configuring Software Modules - AventX for Oracle eAM

Page 435 of 944
Proprietary to STR Software
Click the <Edit Information> button to fill out the information for the AventX table associated with this new
value set. Fill in the values as shown below.

Configuring Software Modules - AventX for Oracle eAM

Page 436 of 944
Proprietary to STR Software
Create a new Executable

The next step in the process is to create a new executable which invokes the xxstr_aooc_wouicp package, a
PL/SQL package that is installed into the APPS schema during the execution of step 5 of setup.sh (refer to
Chapter 1, “Installing AventX Oracle Connector”), for the processing of the Work Orders.

Navigate as System Administrator to Concurrent → Program →Executable

Create a new executable with the following information as shown below.

Configuring Software Modules - AventX for Oracle eAM

Page 437 of 944
Proprietary to STR Software
Create a new Concurrent Program

The next step is to create a new concurrent program that is a copy of the seeded Maintenance Work Order
Detail Report. This is required to add a new Job ID parameter to the report for tracking of the work orders for
processing by AventX.

Ensure that the seeded Maintenance Work Order Detail Report that you copy from includes the following
parameters in this order:

p_work_order_from

p_work_order_to

p_scheduled_start_date_from

p_scheduled_start_date_to

p_asset_area_from

p_asset_area_to

p_asset_number

p_status_type

p_assigned_department

p_organization_id

p_operation

p_resource

p_material

p_direct_item

p_work_request

p_meter

p_quality_plan

p_mandatory

p_attachment

p_asset_bom
Configuring Software Modules - AventX for Oracle eAM
Page 438 of 944
Proprietary to STR Software
Once you have verified that the following parameters exist in the seeded Maintenance Work Order Detail
Report, you should make a copy of the report, as you will need to add a new Job ID parameter.

Navigate as System Administrator to Concurrent→Program→Define. Query for “Maintenance Work Order

Detail Report” and once selected, click on the <Copy To> button.

Configuring Software Modules - AventX for Oracle eAM

Page 439 of 944
Proprietary to STR Software
Fill out the information as shown below and click <OK>.

Change the “Executable Name” to the name of the new executable created in the prior section (i.e.,
XXSTREAMWOREP).

Configuring Software Modules - AventX for Oracle eAM

Page 440 of 944
Proprietary to STR Software
Click on the <Parameters> button and create the new Job ID parameter and fill out the values as shown
below.

Configuring Software Modules - AventX for Oracle eAM

Page 441 of 944
Proprietary to STR Software
Create a new BI Publisher Layout Template

AventX requires a minor BI Publisher template modification to successfully burst individual documents and
run any required queries. Using the XML Publisher Administrator responsibility, query for the seeded Oracle
Template named Maintenance Work Order Report using Code: EAMWOREPORT, Application: Enterprise
Asset Management, and Type: RTF.

Use the Duplicate option on the right side to create a new Template with Code: XXSTREAMWOREPORT,
Name: XXSTR Software Maintenance Work Order Report, Application: Enterprise Asset Management, Type:
RTF, and Default Output Type set to PDF. Note that the new Template must be associated with the seeded
Oracle Data Definition “Work Order Details” (Code: EAMWRREP and Application: Enterprise Asset
Management).

Configuring Software Modules - AventX for Oracle eAM

Page 442 of 944
Proprietary to STR Software
Download the existing Template (File Name EAMWOREPORT.rtf), rename it locally to
XXSTREAMWOREPORT.rtf, and then add the required FAX_INFO tag. The best practice is to add the FAX_INFO
tag using the following basic steps.

• Copy the NAME field from the WORK ORDER section

• Rename the new NAME field to AventX
• Double click the new AventX field name and go to the “Advanced” tab and implement the FAX_INFO tag
using the following syntax (see screen shot for example)
FAX_INFO:WO_NUMBER:WIP_ENTITY_ID:

Configuring Software Modules - AventX for Oracle eAM

Page 443 of 944
Proprietary to STR Software
Update both the Localized and Translatable Template File Name values to use the new
XXSTREAMWOREPORT.rtf template.

Make the Oracle seeded Oracle Maintenance Work Order Report Template inactive by setting an end date at
least one day older than the current date.

Configuring Software Modules - AventX for Oracle eAM

Page 444 of 944
Proprietary to STR Software
Create a Custom XML Generation Function (optional)

As previously discussed above, the integration of AventX with eAM for Self-Service printing is predicated on
the use of the seeded ‘Maintenance Work Order Detail Report’ concurrent program. For customers that
wish to modify or enhance this data, it *IS* possible to modify the XML that is generated from this program
by creating a new function; the only requirement is that it must have the *exact* parameters (in the same
order) as the seeded function contained within the EAM_WORKORDERREP_VT package:

Function getWoReportXML

p_wip_entity_id in system.eam_wipid_tab_type,

p_operation_flag in int,

p_material_flag in int,

p_resource_flag in int,

p_direct_material_flag in int,

p_short_attachment_flag in int,

p_long_attachment_flag in int,

p_file_attachment_flag in int,

p_work_request_flag in int,

p_meter_flag in int,

p_quality_plan_flag in int,

p_asset_bom_flag in int,

p_safety_permit_flag in int -- for permit report

)return CLOB;

Function getLong

p_wip_id in number,

Configuring Software Modules - AventX for Oracle eAM

Page 445 of 944
Proprietary to STR Software
 p_org_id in number,

p_media_id in number,

p_select in number

)return CLOB;

Function Convert_to_client_time

p_server_time in date

) return date;

This new package/function needs to be successfully compiled in the target instance. The AventX
$FCHOME/.fcoa_cfg_<SID> file must be modified to call a customized version of the following function for the
cEAM_WOREPORTXML_FUNC variable (In this example the package is EAM_WorkOrderRep_PVT and the
function is getWoReportXML:

cEAM_WOREPORTXML_FUNC="EAM_WorkOrderRep_PVT.getWoReportXML (wip_entity_id_tbl,
l_operation, l_material, l_resource, l_direct_item, l_short_attachment, l_long_attachment,
l_file_attachment, l_work_request, l_meter, l_quality_plan, l_asset_bom, l_safety_permit,
l_safety_clearance)"

export cEAM_WOREPORTXML_FUNC

The custom changes to cEAM_WOREPORTXML_FUNC must include the custom package and custom
procedure names along with the parameters, “l_custom1, l_custom2, l_custom3, l_custom4, l_custom5”
appended to the end of the function parameters list:

cEAM_WOREPORTXML_FUNC="<Custom Package Name>.<Custom Function Name> (wip_entity_id_tbl,

l_operation, l_material, l_resource, l_direct_item, l_short_attachment, l_long_attachment,
l_file_attachment, l_work_request, l_meter, l_quality_plan, l_asset_bom, l_safety_permit,
l_safety_clearance, l_custom1, l_custom2, l_custom3, l_custom4, l_custom5)"

export cEAM_WOREPORTXML_FUNC

Configuring Software Modules - AventX for Oracle eAM

Page 446 of 944
Proprietary to STR Software
Once this edit is made, run $FCHOME/oa/ins/setup.sh (Step 5) and confirm that it completes without error.

Configuring Software Modules - AventX for Oracle eAM

Page 447 of 944
Proprietary to STR Software
Create Custom Work Order Parameters (optional)

If your Work Order concurrent program has been modified to utilize custom (non-seeded) report parameters,
AventX supports the ability to display them in both the OAF (Oracle Application Framewok) pages and Work
Order print form via the configuration tab shown below.

Field Purpose s

Seq No This is the ranking of the Parameter as it appears in the OAF pages and the form. If
the sequence numbers are input out of order, the parameters will be re-sorted
correctly when the form is closed and reopened.

Parameter The Parameter Label will be displayed on the AventX Work Order form and the OAF
Label pages. This value can be up to 255 characters.

Checked The populated value of the checkbox on the AventX Work Order form and OAF pages.
The default value for this checkbox is ‘Checked’.

When AventX for Oracle eAM is correctly configured, the dynamic checkboxes should appear automatically
on the Work Order OAF pages and form.

This is an example of the above configuration on the main Work Order search results page:

Configuring Software Modules - AventX for Oracle eAM

Page 448 of 944
Proprietary to STR Software
Here is an example of the AventX Work Order Print form:

AventX Configuration

The first step in using the AventX software is to apply a license key. See “Applying License Keys” in the
“System Administration” section of this guide. Apply the license key you received from STR Software and then
come back to this section.

Email Alerts

Configuring Software Modules - AventX for Oracle eAM

Page 449 of 944
Proprietary to STR Software
It is recommended to always supply values for the following fields on the “General Config” tab.

▪ error.mail.address - This email address should be one that would normally receive email alerts from the
system when there are significant issues. The alerts to this address will contain detailed information
about any problem encountered. It is recommended that the administrator performing the initial
installation and configuration set this value now so that content rich information is available when first
setting up the software. It is also recommended to use a shared email address or distribution list such as
[email protected] instead of an individual email address so that important system information
is delivered to multiple people who may support the application.
▪ error.mail.from - It is also recommended to set the “error.mail.from” value to a valid SMTP email
address. Many mail servers will block emails sent as an invalid user, and the default value of
[email protected] may prevent the email from reaching the email address defined for the
“error.mail.address”
▪ mail.smtp.host – The SMTP mail host for sending alert emails.
▪ mail.smtp.password – Secured mail password for sending email alerts
▪ mail.stmp.port – Secured Mail port needed for sending email alerts
▪ mail.smtp.tls – Whether the smtp mail listener requires TLS
Note: For a Secured Mail Server the mail.stmp.host value must be fully qualified.

Configuring Software Modules - AventX for Oracle eAM

Page 450 of 944
Proprietary to STR Software
Configuring the Work Order Document

The next step is to modify the Work Order document configuration in AventX.

• Log in as a user with the AventX Administrator responsibility (or equivalent responsibility that has access
to the AventX Configuration form).
• Launch the AventX Configuration form.
• Click “Configure a Document.”
To view/edit/delete an existing document definition, use the pick list. Select “Work Order”.

The <Find/Add> button will bring up the existing document definition, or prompt you to add a new one. The
<Delete> button will prompt you to delete the existing document definition.

Configuring Software Modules - AventX for Oracle eAM

Page 451 of 944
Proprietary to STR Software
Document Info

Fill in the fields on the Document Info tab to define the “Document Information” and “Interactive Delivery
Properties.” These fields are described in the table below.

The following table provides a description of each of these fields.

Field Value

Document Name This field will be automatically populated with the value specified or selected
from the previous canvas of the wizard. It cannot be edited on this or any of the
subsequent canvases.

Document Defaults

Document Type This alphanumeric field has a limit of four characters. The value will be used by
AventX for report separation and document recognition when using Automatic
or Print Delivery and for form application when using fcdi.

Subject Template This alpha-numeric field has a limit of 256 characters (when expanded) and
supports the use of “tokens” :UID1 - :UID5, :REQUESTID, :ORGID,, :BI_SUBJECT,
and/or :SENDER_USERID. When “tokens” are used, the token will be replaced by
its value to determine the “final” value.

Configuring Software Modules - AventX for Oracle eAM

Page 452 of 944
Proprietary to STR Software
Field Value
For Automatic or Print Delivery the values for these tokens will be extracted
from the report output for use in the queries, or in this case, to be used in the
[SUBJECT= command. For formatted report output (e.g. PDF), the values will be
specified in the FAX_INFO strings (e.g. FAX_INFO:<UID1>:<UID2>:<UID3>:) as
previously described.
The :UID1 - :UID5 tokens have a maximum length of 255 characters. The
:BI_SUBJECT field has a maximum length of 80 characters. The :REQUESTID,
:ORGID, and :SENDER_USERID values are NUMBER fields.
The following characters will be stripped from the SUBJECT value before
submission to AventX UNIX:
\[]
The value returned, which is assigned to the [SUBJECT= command, will be
truncated to 80 characters. This value will be displayed on the AventX Interactive
Delivery form, in the AventX Reports and on the AventX Delivery Status form,
and can be displayed on the message template.

Email Attachment This alpha-numeric field has a limit of 256 characters (when expanded) and
Name supports the use of “tokens” :UID1 - :UID5, :REQUESTID, :ORGID,, :BI_SUBJECT,
and/or :SENDER_USERID. When “tokens” are used, the token will be replaced by
its value to determine the “final” value.
For Automatic or Print Delivery the values for these tokens will be extracted
from the report output for use in the queries, or in this case, to be used in the
[ATTACH= command. For formatted report output (e.g. PDF), the values will be
specified in the FAX_INFO strings (e.g. FAX_INFO:<UID1>:<UID2>:<UID3>:) as
previously described.
The :UID1 - :UID5 tokens have a maximum length of 255 characters. The
:BI_SUBJECT field has a maximum length of 80 characters. The :REQUESTID,
:ORGID, and :SENDER_USERID values are NUMBER fields.
The following characters will be stripped from the SUBJECT value before
submission to AventX UNIX:
\[]
The value returned, which is assigned to the [ATTACH= command, will be
truncated to 80 characters. This value will be displayed as the name of the
primary attachment for email delivery.

Printed Page Stamp This field specifies a string of up to 132 characters to be passed to AventX
Translation Server for use in the page stamp on each page of a print job.
Therefore, this field is used only for Printed Delivery and printing of Oracle

Configuring Software Modules - AventX for Oracle eAM

Page 453 of 944
Proprietary to STR Software
Field Value
Attachments.

The Printed Page Stamp field supports the use of “tokens” :UID1 through :UID5,
:REQUESTID, :ORGID, and/or:SENDER_USERID. When “tokens” are used, the
token will be replaced by their value here to determine the “final” value.
The :UID1 - :UID5 tokens have a maximum length of 255 characters, and are
extracted from the FAX_INFO tag.
The :REQUESTID, :ORGID, and :SENDER_USERID values are NUMBER fields.

Default value is <blank>.

Interactive Delivery Fields in this section of the canvas will apply only to Interactive Delivery and
Properties Stand Alone Interactive Delivery submissions to AventX. If you are not going to
use either of these methods for this document type, you do not need to fill out
these fields. These submission methods are typically not used for the Work
Order document type.

Default Picklist This field determines what the default pick list will be when the AventX
Interactive Delivery form is opened. Valid values are:
• Customers by Company – the pick list will contain all customer contacts
sorted by company.
• Customers by Name – the pick list will contain all customer contacts sorted
by last name
• Employees –the pick list will contain email addresses for all employees (as
defined in the Oracle EBS Human Resource tables) with a type of “EMP” or
“EMP_APL”.
• Users – the pick list will contain all Oracle EBS users
• Vendors – the pick list will contain all vendors (site level) sorted by company
• Vendor Contacts – the pick list will contain all vendor contacts sorted by last
name.
For more information on the AventX Interactive Delivery form, consult the
AventX Oracle Connector User’s Guide.

Report Name This alphanumeric field has a limit of 256 characters and defines (a portion) of
the actual report name specified on the Submit Request form, to be used to
match against in the configuration.
For example, if the report name on the Submit Request form is “Separate
Remittance Advice”, the value in this field could be “Remittance”, “Remittance
Advice”, “Separate” etc.

Configuring Software Modules - AventX for Oracle eAM

Page 454 of 944
Proprietary to STR Software
Field Value
NOTE: If the value specified here does not match a portion of the report name
on the Submit Request form, the AventX Interactive Delivery form will open
without having the proper default configuration.

Report Parameter 1 This numeric field (value1-50) specifies the position of the parameter that will be
the “FROM” value in the range for determining :UID1.
This field is required if Report Name is specified; not used otherwise.

Report Parameter 2 This numeric field (value1-50) specifies the position of the parameter that will be
the “TO” value in the range for determining :UID1. Interactive Delivery is
designed for use with single documents (normally a range or batch of documents
are not intended for the same supplier/customer). If this value is different than
that for Report Parameter 1, the AventX Interactive Delivery form will post an
error when opened.
This field is required if Report Name is specified; not used otherwise.

Report UID2 – UID5 This numeric field (value1-50) specifies the position of an additional parameter
that will be used for :UID2 - :UID5.
This field is optional if Report Name is specified; not used otherwise.

Configuring Software Modules - AventX for Oracle eAM

Page 455 of 944
Proprietary to STR Software
General Configuration

This tab is where you enable or disable the Attachment Printing functionality ‘print.attachments’ row as
shown in the following screenshot.

Configuring Software Modules - AventX for Oracle eAM

Page 456 of 944
Proprietary to STR Software
Work Order UI

When the <Submit Selected Work Order(s) for Print> button is clicked by the user, an Oracle API,
fnd_submit.submit_request is called to actually submit a request to the Concurrent Manager.

The next step in our configuration is to provide AventX with the actual parameters that will be passed to the
Concurrent Manager when fnd_submit.submit_request is called.

Configuring Software Modules - AventX for Oracle eAM

Page 457 of 944
Proprietary to STR Software
The following table describes the fields on the Work Order UI Specific Behavior canvas.

Field Purpose

Deselect All This feature controls whether the “Work Order Search Results” after the user clicks
Search Results “Print Work Orders” has “All” or “None” Work Orders pre-selected.

User Specified This feature controls whether the user can specify, from those Entity/Category pairs
Attachments available per the configuration, which attachments within the Entity/Category pairs
to include in the submission of the selected Work Order(s) to AventX Attachment
Xpress.

By default, this value is unchecked, meaning that the user does not have control over
which attachments, by Entity/Category pairs, are included. Rather, AventX
Attachment Xpress relies upon the attachment configuration as set for the
Organization ID for the Work Order document type to determine which attachments
are included.
When this item is unchecked, Entity/Category pairs will not be displayed. However,
attachments which match the configuration will be included with the work order
upon submission and processing by AventX Attachment Xpress.

Restrict Controls whether the Entity/Category pairs specified per the configuration (in the
Attachments AventX Configuration form) will be further filtered to only those Entity/Category pairs
for which attachments have been defined for the work orders in the original query.

This configuration setting is not incorporated into AventX WorkOrderHiearchyCO

controller functionality. However, it is used for the “standard” Work Order controller.
This feature is not applicable for Parent/Child Work Order Processing

Configuring Software Modules - AventX for Oracle eAM

Page 458 of 944
Proprietary to STR Software
Field Purpose

Uncheck Text Controls whether the “Short Text Attachments” and “Long Text Attachments”
Attachments checkboxes in the “Parameters” section of the Parent/Child Work Order self-service
page are unchecked or checked when the user first invokes the page.

Checking the “Unchecked Text Attachments” box will result in the “Short Text
Attachments” and “Long Text Attachments” checkboxes being unchecked by default
when the user invokes the page.
Leaving the “Unchecked Text Attachments” box unchecked will result in the “Short
Text Attachments” and “Long Text Attachments checkboxes being checked by default
when the user invokes the page.
The setting here applies to both short and long-term text attachment checkboxes.

Job ID Report Earlier in this chapter, you were instructed to create a new concurrent program
Parameter definition based off the seeded Maintenance Work Order Detail Report. As part of
the new concurrent program, you created an additional parameter called p_job_id, as
the last parameter to the report.

The value entered here is the number indicating the position of the p_job_id
parameter among all parameters passed to the Concurrent Manager when
fnd_submit.submit_request is called (by clicking the <Submit Work Orders for Print>
button on either the Work Order self-service page or the AventX Interactive Work
Order Submission form).
By default, this value is <blank>. When set to <blank>, the <Submit Selected Work
Orders for Print> button on the Update Work Hierarchy self-service page will not be
available

Concurrent Specifies the name of the concurrent program to be run by the concurrent manager
Program Name for the concurrent request to print the work order(s). This should be the name of the
newly created concurrent program, as described earlier in this chapter.
By default, this value is <blank>, but is required for Interactive Work Order
Submission processing of work order documents for printing by AventX Attachment
Xpress. Attempting to click the <Submit Selected Work Orders for Print> button will
result in a message displayed to the user if no value has been specified for this field.
For example, the value selected for our newly created report as described earlier is
XXSTR Maintenance Work Order Detail Report.

Print Style Specifies the print style that corresponds to a print driver that calls AventX
Attachment Xpress. This should be the print style created as described in the section
“Oracle EBS Configuration: Creating the Printer Driver and Style”.

Configuring Software Modules - AventX for Oracle eAM

Page 459 of 944
Proprietary to STR Software
Field Purpose
By default, this value is <blank>, but is required for processing of Work Order
documents for submission by AventX. Attempting to click the <Submit Selected Work
Orders for Print> button will result in a message displayed to the user if no value has
been specified for this field.
Changing the "Print Style" will clear all rows defined in the printer table. The user will
be prompted for confirmation.

Configure Specifies whether the user will have a drop-down list of printers from which to select
Printers when submitting the Work Order to AventX Attachment Xpress.
If the checkbox is unchecked, no printer drop-down list will be present, and
submission will be forced to the AventX Automatic printer.
If the checkbox is checked and no rows are defined for "Printer Name", the drop-
down list will be available, and will contain all Oracle printers that support the
specified "Print Style" (previously described). Submission will be via AventX
Attachment Xpress to the selected printer.
If the checkbox is checked and one or more rows is defined for "Printer Name", the
drop-down list will be available, and will contain only those printers that support the
specified "Print Style" (previously described) and match the defined conditions (see
the column descriptions in the next table for details). The list will always contain the
printer "AventX Automatic", and will only display unique values. Submission will be
via AventX Attachment Xpress to the selected printer.

Default This indicates the default printer that will be selected when the custom controller is
(checkbox) invoked. Check this box to indicate the printer for which you want to appear first by
default in the pick list of printers.

This box can only be checked for one of the printers as configured in this section.

It is important to note that the default printer chosen cannot be tied to a specific
maintenance organization ID, user, or Organization ID, as users will not have the
same list of printers available.
It is a good idea to select a printer that is common to all users, for example, <User
Profile Printer> (see Printer Name section below).

Printer Name A list of values of all Oracle printers that have been configured for the specified "Print
Style" (previously described).
If specified, at least one of the remaining columns must be filled in.
It is permissible to have more than one row with the same "Printer Name" value.
There are two types of “special” printers:

Configuring Software Modules - AventX for Oracle eAM

Page 460 of 944
Proprietary to STR Software
 Field Purpose
▪ <User_Profile Printer> - including this printer in the list will cause the user’s default
printer ($PROFILES$.Printer) to be displayed
▪ AventX Automatic – Use this printer to send the Work Order using Automatic
Delivery (for example, if you wanted to also email or fax the document).

User ID A list of (unique) values of all Oracle users (from fnd_users). The list is ordered
alphabetically.
If specified, the "Printer Name" printer will be available in the drop-down list for this
Oracle user.
This column is used in an "or" conjunction with the other columns and rows in
determining the entire drop-down list of available printers.
It is permissible to have more than one row with the same "User ID" value.

Maintenance A list of (unique) values of all maintenance organizations. The list is ordered
Org alphabetically.
If specified, the "Printer Name" printer will be available in the drop-down list for all
Oracle users with this Maintenance Organization.
This column is used in an "or" conjunction with the other columns and rows in
determining the entire drop-down list of available printers.
It is permissible to have more than one row with the same "Maintenance Org" value.

Org ID A list of (unique) values of all organizations. The list is ordered alphabetically.
If specified, the "Printer Name" printer will be available in the drop-down list for all
Oracle users with this Organization.
This column is used in an "or" conjunction with the other columns and rows in
determining the entire drop-down list of available printers.
It is permissible to have more than one row with the same "Org ID" value.
Changes to the printer list will be committed to the database tables when any of the buttons (<Previous>,
<Finish>, or <Next>) are clicked. The printer drop-down list on the Update Hierarchy self-service page will
only be refreshed when the Oracle cache has been reset (typically requiring a restart of the Apache web
server portion of Oracle EBS - e.g. adapcctl.sh stop/start).

After filling in the desired values, click on the Attachment Queries tab.

Attachment Queries

AventX can include attachments with the report output as described earlier in the section entitled “Oracle
Attachments”. Queries must be defined which specify the primary key necessary for AventX Attachment

Configuring Software Modules - AventX for Oracle eAM

Page 461 of 944
Proprietary to STR Software
Xpress to extract the appropriate attachments from the database or external file system. Detailed discussion
on the methodology is beyond the scope of this document.

Seeded attachment queries are provided for the Work Order document as shown in the following
screenshot. You are not restricted to using just these attachment queries. Using the attachment query
canvas, you can define your own.

Configuring an Organization

Configuration for Attachment Printing is accomplished via a series of tabs on the AventX Configuration form.

General Config Tab

This tab contains global values that will apply to all print jobs sent through AventX, whether they include
attachments or not. Highlighting each row will display a detailed description at the bottom of the form
including all possible values and their meaning. You are only required to update one or more of the rows if
the default values do not meet your needs.

Configuring Software Modules - AventX for Oracle eAM

Page 462 of 944
Proprietary to STR Software
Attachment Printing Config Tab

This tab contains global values that only apply to jobs sent through AventX that are configured to print with
attachments. Highlighting each row will display a detailed description at the bottom of the form including all
possible values and their meaning. You are only required to update one or more of the rows if the default
values do not meet your needs.

Configuring Software Modules - AventX for Oracle eAM

Page 463 of 944
Proprietary to STR Software
Printers Tab (Optional)

This tab allows you to optionally configure printers defined on the AventX host. The values are a subset of
those contained on the General Config tab; it is only necessary to add rows on this tab if a printer requires a
different configuration than the global defaults (for example, a different lp command or argument).
Highlighting each row will display a detailed description at the bottom of the form including all possible
values and their meaning. You are only required to update one or more of the configuration rows if the
default values do not meet your needs.

Configuring Software Modules - AventX for Oracle eAM

Page 464 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 465 of 944
Proprietary to STR Software
Translation Servers Tab

This tab contains a list of available AventX Translation Servers. As previously discussed, this is a Windows-
based server used to translate all files in the print job into a single PDF for printing from the AventX host. If
printing attachments, then you must define at least one AventX Translation Server. The “Translation Server
Hostname” field is free form and should contain the DNS name of the AventX Translation Server (as
resolvable from the AventX host). If the AventX Translation Server is installed on the same host as AventX for
EBS then use “localhost” as the “Translation Server Hostname”. This provides the benefit of not having to
change the translation server name during post clone procedures and is generally DNS accessible by default.
When connecting to the AventX Translation Server version 5.1.00 or greater the information for the
translation rest port will also be displayed. Note that multiple AventX Translation Servers can be defined for
High Availability (HA) and/or failover purposes.

Recommended Configuration and Best Practices

The following information provides a summary of some of the features you should consider implementing.

Printing an Error Filler Page

When processing a batch of reports, especially when attachments are included, it is possible to have one or
more of the reports encounter an error (e.g cannot find attachment) which prevents that report and its
attachments from printing. In this case, the other reports from the batch (and their attachments) do print,
with no "identifier" for the missing report(s). This can cause confusion, and tracking down the missing

Configuring Software Modules - AventX for Oracle eAM

Page 466 of 944
Proprietary to STR Software
report(s) to correct the error and get the report(s) printed may be missed. AventX supports the ability to print
an error filler page as a placeholder for any report that cannot be printed due to an error in processing.

Configuring Software Modules - AventX for Oracle eAM

Page 467 of 944
Proprietary to STR Software
Error Conditions
Error filler pages are not created for all error conditions; only those related to and affecting processing for
PRINT delivery. Once an error condition has occurred, no further "normal" processing (e.g. submission of fax
or email destinations to AventX UNIX for transmission) takes place; the error filler page is pushed through to
the point where it is printed and the proper acknowledgements are made to account for the document from
the original batch.

Error Filler Page Contents

The content of the printed error filler page is identical to that of any error email notifications. An example
error filler page:

An error occurred while processing request 5875751

The following information was known at the time of error:

Request ID: 5875751

Subject: Purchase Order #6040

From: Randy Gustin<[email protected]>

Document ID: 6040

Organization ID: 204

Errors:
Attachment Error: An unexpected I/O error has occurred trying to
retrieve \\merlin\N\Company\Project\temp\missing_file.txt. Reason:
The system cannot find the path specified.

Enabling the Error Filler Page Feature

The print error filler page feature is global; meaning it is either "on" or "off" for all document types processed
for PRINT delivery by AventX. The feature is "on" if the print.error.page value on the General tab of the
AventX Configuration form is "Yes"; it is "off" otherwise.

The error filler page contents are defined by the error.mail.template value on the General tab of the AventX
Configuration form. If the error filler page cannot be created from the template (e.g. the template does not
exist, no read permission etc.), all processing will cease. In this case, the printed output for the original batch
will be missing any evidence of this report.

Intelligent Duplexing

Work order packets are the most common documents processed by AventX for printing. A typical work order
packet may include several attachments that must be dispersed to different team members. In a duplex

Configuring Software Modules - AventX for Oracle eAM

Page 468 of 944
Proprietary to STR Software
printing situation, however, this can prove difficult, as it is probable for one attachment to begin on the back
page of the previous attachment, making it impossible to distribute the attachments to two different people.

In scenarios like that described above, the solution is to ensure that each attachment starts printing on the
front of a page. This functionality is available by incorporating the use of a filler page, whereby a “blank” page
is inserted at the end of any odd page attachment within the packet. The solution is not limited to Work
Orders, i.e., a filler page can be inserted into any print job. Consult the AventX Translation Server Resource
Guide for further information.

Interactive Work Order Printing

Oracle Enterprise Asset Management (hereafter referred to as eAM) provides the capability for maintenance
staff to create Work Orders to report problems with assets. However, the Work Orders interface in eAM lacks
the capability for users to select one or more work orders, and/or any specific attachments for printing
and/or other delivery, and/or the desired destination printer. AventX Attachment Xpress provides a solution
for the printing and/or delivery of Work Order documents along with their respective attachments via the
self-service (e.g. Maintenance Super User: Work Orders) and/or Oracle forms (e.g. Enterprise Asset
Management) interfaces.

Prerequisites

There are slightly different prerequisites for each of the (2) integration methods/interfaces as described in
the following sections. Use only the section(s) that applies to your implementation.

Self-Service

• Familiarization with self-service personalization.

• AventX Oracle Connector version 7.4.00 or higher.

• Oracle EBS R12 + is required.

Oracle Forms

Because Interactive Work Order Submission involves Oracle forms personalization, it is required that you
additionally have a working knowledge of the following areas:

• Oracle Forms Development.

• Oracle Forms Personalization.

Creating the Customized Maintenance Work Order Detail Report

Clicking the <Submit Work Order(s) for Print> button from either the self-service or Oracle forms interface
generates a concurrent request, which is tied to an AventX Attachment Xpress PL/SQL package for the
processing of the Work Orders and their associated attachments for printing. This PL/SQL package is specified
via a new Executable which is tied to a modified copy of the seeded Maintenance Work Order Detail Report
Concurrent Program.

This involves the following steps:

Configuring Software Modules - AventX for Oracle eAM

Page 469 of 944
Proprietary to STR Software
 ▪ Creation of a new value set, XXSTR_JOBIDNUMBER
▪ Creation of a new executable, XXSTR Work Order Detail Report
▪ Creation of a new concurrent program, XXSTR Work Order Detail Report
These steps for creating a customized Maintenance Work Order Detail Report are required for Interactive
Work Order, Parent/Child, and eAM Workbench printing.

Personalization for Interactive Work Order Printing

There are slightly different personalization steps for each of the two integration methods/interfaces as
described in the following sections. Use only the section(s) that applies to your implementation.

Self-Service

Advanced Printing Work Order functionality is available via a custom controller for the Oracle Applications
Framework (self-service) page that is invoked via personalization. This section describes how to put the
custom controller in place and invoke it using personalization.

Invoking the AventX Attachment Xpress Interactive Work Order Printing Controllers

To invoke this controller, you will need to personalize the Work Orders self-service page as follows:

As the Maintenance Super User (or equivalent) responsibility, navigate to the Print Work Orders page (Work
Orders tab, perform a query to find work orders, then click the <Print Work Orders> button) and click on the
‘Personalize Page’ link in the top right of the screen.

If you do not see the Personalize Page link, make sure you have the following profile options set:
FND: Personalization Region Link Enabled - Yes
Personalize Self-Service Defn - Yes
Disable Self-Service Personal - No

For Page Layout: Work Order Report, click the Personalize icon:

Configuring Software Modules - AventX for Oracle eAM

Page 470 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 471 of 944
Proprietary to STR Software
Change the controller class definition to the new controller class definition:
xxstr.oracle.apps.eam.workorder.webui.xxstrWorkOrderRepCO

Click the <Apply> button to save your changes.

Implementing with Oracle EBS 12.2.6

Early EBS releases of 12.2.6 would display a warning message when navigating to the Print Work Orders Page
unless you had a working Autovue instance configured.

This is because Oracle has added logic to their standard page to attempt to communicate with the Autovue
server regardless of whether it exists. STR Software has provided a custom controller for our customers to
disable this error message if they wish to do so. To suppress this message, the standard controller must be
extended via personalization.

Configuring Software Modules - AventX for Oracle eAM

Page 472 of 944
Proprietary to STR Software
To Enable the Controller (Suppress Error Message)
Log in to Oracle EBS as a user with the “Functional Administrator” ability. As Functional Administrator
navigate to the “Personalization” tab. Search for Application of “Enterprise Asset Management” and
Document Path of “/oracle/apps/eam/workorder/webui/EAM_PRINT_AUTOVUE”.

Click the “Personlize” icon associated with the EAM_PRINT_AUTOVUE page displayed in the search results.
When selecting the Personalization Context be sure to clear out the Organization and Responsibility fields so
the personalization changes apply to the entire EBS instance. Click the <Apply> button.

Once on the Personalization page click the top-level “Personalize” link to extend the controller.

On the Personalize page modify the Site-level value for Controller Class from the value “Inherit” to the value
“xxstr.oracle.apps.eam.workorder.webui.xxstrEamPrintPopupRNCO”. This step will disable the Autovue
functionality thus suppressing the unwanted error message for Attachment Xpress customers.

Configuring Software Modules - AventX for Oracle eAM

Page 473 of 944
Proprietary to STR Software
Oracle Forms

Oracle forms personalization is a powerful and flexible feature that allows a System Administrator/DBA to
control the behavior of an Oracle form. More information about forms personalization can be found in the
following Oracle support note:

NOTE:395117.1 - Form Personalization in Oracle E-Business Suite (Release 12)

In this section, we will only be discussing the components of forms personalization that are required for a
proper implementation of AventX Interactive Work Order Submission. Other rules and conditions may need
to be developed via personalization to meet the business rules of your users.
Continuing with our example, we will create three forms personalization rules.

The first rule creates a menu item, “Submit Work Orders for Print”, under the Tools menu. The second rule
responds to the user selecting the “Submit Work Orders for Print” item by launching the AventX Interactive
Work Order Submission form with the proper parameters. The third provides feedback to as user attempting
to invoke the print form without first selecting a Work Order.

Configuring Software Modules - AventX for Oracle eAM

Page 474 of 944
Proprietary to STR Software
Invoking Forms Personalization

Invoke the form from which you wish to query for work orders. In this case, we used the responsibility of
Enterprise Asset Management, and from the Navigator menu, chose Work Orders→Work Orders. We then
select Help→Diagnostics→Custom Code→Personalize from the menu at the top of the form, as shown
below.

If you do not see the Diagnostics menu, or you receive a message stating “Function not available to this
responsibility,” it is likely not enabled. Check settings for the following System Profiles:

“Hide Diagnostics menu entry” – should be set to “No”

“Utilities: Diagnostics” – should be set to “Yes”

Configuring Software Modules - AventX for Oracle eAM

Page 475 of 944
Proprietary to STR Software
The Forms Personalization form will be displayed. The following screenshot shows an example of the Forms
Personalization form for the Work Orders form. In our example, there are currently no forms personalization
entries, however your form may have preexistent entries.

The top part of the form specifies rules that apply either to a particular function or a form. The bottom part
of the form specifies under what condition the rule is applied, and what actions to take if the conditions are
met.

As previously mentioned, we need to define two rules. The rules can apply at either the form or function
level, depending upon your forms personalization needs. Recall that the first rule is to define a menu item
that the user will select to invoke the AventX Interactive Work Order Submission form.

Defining the First Rule

To define the first rule, click in the next available row at the top of the form. Assign an unused, sequence
number in the Seq column, and type something like “Add AventX Menu Item” as the Description.

Configuring Software Modules - AventX for Oracle eAM

Page 476 of 944
Proprietary to STR Software
Condition Tab
You may configure personalization to add logic to control when the button is available. In our example, we
will enable the menu item as soon as the form is invoked, but you may have different “timing” needs. This is
fine, if the user has access to this menu item at some point during the forms session.

To make the menu item available as soon as the form is invoked, under the “Condition” tab, ensure that the
“Trigger Event” is set to “WHEN-NEW-FORM-INSTANCE”, and the “Processing Mode” is set to “Not in Entry-
Query Mode.”

This tells Oracle that the conditions under which the rule should apply will be when a new form is launched
by the user. No other entries need to exist on the “Condition” tab for this rule, but of course, you may build
in as much personalization as you need. As shown in the following screenshot.

Configuring Software Modules - AventX for Oracle eAM

Page 477 of 944
Proprietary to STR Software
Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the first rule is to add a menu item. Click in the first available row on the
left-hand side of the form. Assign a new sequence number, and for “Type”, select “Menu”, leave the
“Description” field blank, and set the language to “All.” Ensure that the “Enabled” checkbox is checked.

The right-hand side of the form specifies details regarding the actual menu item to be displayed when the
form is invoked. Click the arrow of the “Menu Entry” drop down box, and select the next available MENU
entry. In our example, no personalized menus exist, so we can select the MENU1 entry.

Type in a meaningful label for the menu item, for example “Submit Work Orders for Print.”

Ensure that the “Render line before menu” checkbox is checked.

No other fields are required on the “Actions” tab.

Configuring Software Modules - AventX for Oracle eAM

Page 478 of 944
Proprietary to STR Software
Defining the Second Rule

So far, we have created a rule that displays a menu item based upon the user invoking the Work Orders form.
The next step is to create a second rule that is a response to the user Selection of the “Submit Work Orders
for Print” menu item. When this item is selected, the AventX Interactive Work Order Submission form will be
launched.

Therefore, our second rule will have one condition associated with it (the selection of our MENU item created
in the first rule), and one Action associated with it (calling a custom library, FCOA.pll, with an argument “STR-
WOUIPT”) to retrieve the list of work orders presently retrieved by the user and invoke the AventX
Interactive Work Order Submission form.

Click in the next available row at the top of the form. Assign an unused, sequence number in the Seq column,
and type “Respond to AventX Menu Item” as the “Description.”

Configuring Software Modules - AventX for Oracle eAM

Page 479 of 944
Proprietary to STR Software
Condition Tab
Under the “Condition” tab, ensure that the “Trigger Event” is set to “MENUn”, where “n” represents the new
MENU item that you created for the first rule. In our example, this is MENU1. Ensure that the “Processing
Mode” is set to “Not in Entry-Query Mode”. These settings ensure that the rule will be applied when the
menu item (created by the first rule) is selected by the user. In the “Condition” field, enter the following:
:EAM_WORKORDERS.WIP_ENTITY_ID is not null

This ensures that at least one work order has been displayed via the work orders form before attempting to
invoke the AventX Interactive Work Order Submission form. As shown in the following screenshot.

Configuring Software Modules - AventX for Oracle eAM

Page 480 of 944
Proprietary to STR Software
Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the second rule is to call the FCOA.pll custom library with a specific
argument to retrieve the list of work orders presently retrieved by the user and invoke the AventX Interactive
Work Order Submission form.

Click in the first row on the left-hand side of the form. Assign a new sequence number, and for “Type”, select
“Builtin.” Leave the “Description” field blank, and set the “language” to “All”. Ensure that the “Enabled”
checkbox is checked.

The right-hand side of the form specifies details regarding the type of action. Click the LOV arrow of the
“Builtin Type” drop down box, and select “Call Custom Library.”

Enter “STR-WOUIPT” in the Argument field. This specifies the name of the argument to be passed in the call
to the custom library FCOA.pll.

The last thing to consider is one final rule to control a message being displayed to the user if they try to
invoke the AventX Interactive Work Order Submission form without retrieving any work orders first. For
example, under this condition, a user would see a message such as “You must first select work orders to
print” instead of just invoking the form with no work orders.

To define the third rule, click in the next available row under the “Respond to AventX Menu Item” that you
entered for rule 2. Enter a sequence number and a description such as “Respond to AventX Menu item if No
Work Orders Selected”.

Configuring Software Modules - AventX for Oracle eAM

Page 481 of 944
Proprietary to STR Software
Under the “Condition” tab, ensure that the “Trigger Event” is set to “MENUn”, where “n” represents the new
MENU item that you created for the first rule. In our example, this is MENU1. Ensure that the “Processing
Mode” is set to “Not in Entry-Query Mode”. These settings ensure that the rule will be applied when the
menu item (created by the first rule) is selected by the user. In the “Condition” field, enter the following:
:EAM_WORKORDERS.WIP_ENTITY_ID is null

as shown in the following screenshot.

Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the third optional rule is to display a message to the user if no work
orders have been selected when the user attempts to invoke the form.

Click in first row on the left-hand side of the form. Assign a new sequence number, and for “Type”, select
“Message”. Leave the “Description” field blank, and set the “language” to “All”. Ensure that the “Enabled”
checkbox is checked.

The right-hand side of the form specifies details regarding the type of action. Ensure that the Message Type =
“Show” and type in a message that you would like to see displayed when this condition occurs. For example,
“You must first select work orders to print”.

The following screenshot shows the completion of the final rule.

Configuring Software Modules - AventX for Oracle eAM

Page 482 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 483 of 944
Proprietary to STR Software
Parent/Child Work Order Printing

Oracle Enterprise Asset Management (hereafter referred to as eAM) provides the capability for maintenance
staff to create Work Orders to report problems with assets. However, the Work Orders interface in eAM lacks
the capability for users to select Parent/Child work orders, and/or any specific attachments for printing
and/or other delivery, and/or the desired destination printer. AventX Attachment Xpress provides a solution
for the printing and/or delivery of Parent/Child Work Order documents along with their respective
attachments via the self-service (e.g. Maintenance Super User: Work Orders) interface.

Prerequisites

• Familiarization with self service personalization

• AventX for Oracle eAM version 9.1.00 or higher is required.

• Oracle EBS R12 + is required.

Personalization for Parent/Child Work Order Printing

Parent/Child Work Order Advanced Printing functionality is available via a custom controller
(xxstrWorkOrderHierarchyCO) for the Oracle Applications Framework (self-service) page that is invoked via
personalization. This section describes how to put the xxstrWorkOrderHierarchyCO custom controller in
place and invoke it using personalization.

Configuring Software Modules - AventX for Oracle eAM

Page 484 of 944
Proprietary to STR Software
Invoking the AventX Attachment Xpress Parent/Child Work Order Controller

To invoke this controller, you will need to personalize the Update Work Hierarchy self-service page as
follows:

As the Maintenance Super User (or equivalent) responsibility, navigate to the Update Work Hierarchy page
(Work Orders tab, perform a query to find Parent work order, click link to Parent work order, click Work
Relationships tab then click the <Update Work Hierarchy> button) and click on the ‘Personalize Page’ link in
the top right of the screen.

Click the pencil icon under the Personalize column of the Page Layout: Update Work Hierarchy row.

In the Custom Controller Class row, change the appropriate (Site/Organization/Responsibility) levels as
desired for each column to the following value:
xxstr.oracle.apps.eam.wolinking.webui.xxstrWorkOrderHierarchyCO

Configuring Software Modules - AventX for Oracle eAM

Page 485 of 944
Proprietary to STR Software
Click the <Apply> button to save your changes.

Enabling Foreign Character Sets for Labels and Buttons

Note: This will require database access as the aventx schema user.

In SQL Developer (or Toad) connect as the aventx schema user. Once connected run:

select * from xxstr_forms_tl where nls_language = 'EN_US' order by component;

This query will return all the possible label and button text that can be altered within the custom controller.
To add a new language set, export all the records from the previous query into insert statements, change the
NLS_LANGUAGE value to be the desired NLS_LANGUAGE code for a particular user you would like accomidate
(ex. ‘FR_CA’ for French). Then translate the English values in the VALUE column of each record to the desired
language. Once all records have had their NLS_LANGUAGE value as well as the values in the VALUE column
changed, reinsert the records into xxstr_forms_tl. An example of adding French as a supported translation for
the Printer lable (changes highlighted in Yellow):

INSERT INTO XXSTR_FORMS_TL (MODULE, COMPONENT, COMPONENT_TYPE, NLS_LANGUAGE,

VALUE, DESCRIPTION) VALUES ('XXSTRWORKORDERHELPER', 'PRINTER_LABEL', 'LABEL', 'EN_US',
'Printer', 'Printer');

INSERT INTO XXSTR_FORMS_TL (MODULE, COMPONENT, COMPONENT_TYPE, NLS_LANGUAGE,

VALUE, DESCRIPTION) VALUES ('XXSTRWORKORDERHELPER', 'PRINTER_LABEL', 'LABEL', 'FR_CA',
'Imprimante', 'Printer');

Configuring Software Modules - AventX for Oracle eAM

Page 486 of 944
Proprietary to STR Software
The AventX Custom controllers will use the logged in users preferred language when displaying text for labels
and buttons. If the users preferred language is not within the xxstr_forms_tl table then AventX will default
the translation to English (EN_US). Currently, AventX comes seeded with English and French translations.

Workbench Printing

Prerequisites

• Familiarization with self service personalization

• AventX Attachment Xpress, version 10.0.00 or higher is required.

• Oracle EBS R12 + is required

Personalization for eAM Workbench Printing

Oracle eAM Workbench Printing functionality is available via a custom controller (xxstrEamToolbeltHomeCO)
for the Oracle Applications Framework (self-service) page that is invoked via personalization. This section
describes how to put the xxstrEamToolbeltHomeCO custom controller in place and invoke it using
personalization.

Configuring Software Modules - AventX for Oracle eAM

Page 487 of 944
Proprietary to STR Software
Invoking the AventX Attachment Xpress Workbench Controller

To invoke this controller, you will need to personalize the Workbench (My Work Queue) self-service page.
As the Maintenance User WorkBench (or equivalent) responsibility, navigate to the “Home” page and click on
the ‘Personalize Page’ link in the top right of the screen.

For Page Layout: My Work Queue, click the Personalize icon:

Configuring Software Modules - AventX for Oracle eAM

Page 488 of 944
Proprietary to STR Software
Change the controller class definition to the new controller class definition:
xxstr.oracle.apps.eam.toolbelt.webui.xxstrEamToolbeltHomeCO

Click the <Apply> button to save your changes.

Configuring Software Modules - AventX for Oracle eAM

Page 489 of 944
Proprietary to STR Software
SharePoint Configuration

Extracting Attachments from SharePoint Online

The following instructions will allow AventX to extract attachments using SharePoint Online. There are two
parts to this process:

1- Adding AventX as a registered application in Azure AD.

2- Configuring AventX for Oracle eAM to use SharePoint Online for attachment extraction.
To ensure an effective configuration, please follow the instructions in the order in which they are presented
in this document.

Adding AventX as a Registered Application in Azure AD

• Login to Azure Portal, and Navigate to “All Services”

Configuring Software Modules - AventX for Oracle eAM

Page 490 of 944
Proprietary to STR Software
Search for App Registration

Select “New Application Registration”

Configuring Software Modules - AventX for Oracle eAM

Page 491 of 944
Proprietary to STR Software
Enter the AventX Attachment Xpress Information into the “Create” Form, according to the table below.
After all fields have been completed, click the <Create> button at the bottom of the form.

Field Value

Name A one-word name for the AventX Attachment Express application. (Example: AventX
SPO Integration).

Supported Can be left as default (Accounts in this organizational directory only)

Account
Types

Redirect URI Choose Public Client (mobile & desktop), and enter https://<yourdomain> as the
value

Configuring Software Modules - AventX for Oracle eAM

Page 492 of 944
Proprietary to STR Software
Select Your New App in the “App Registrations” Table

Record the “Application ID.”

Note: This Application ID will be necessary for Authentication in a later step.

Navigate to Settings -> Required Permissions -> Add

Configuring Software Modules - AventX for Oracle eAM

Page 493 of 944
Proprietary to STR Software
Microsoft APIs Consideration

AventX supports both the new Microsoft Graph API, and the traditional SharePoint Online API to extract
attachments from SharePoint Online. You may choose either implementation that suits your organizational
needs.

When using Microsoft Graph API, AventX uses the client credential flow (OAuth2) under the Microsoft v2
Endpoint. This is the current recommended API implementation by Microsoft. This implementation supports
SharePoint Online, and OneDrive for Business extraction.

When using SharePoint Online API, AventX uses the username – password flow (OAuth2) under Microsoft v1
Endpoint. This implementation only support SharePoint Online extraction.

Limitations

Because Microsoft Graph API Implementation is using application permission to authenticate, AventX will
have read access to shared files under the organization resource. If this is a conern, SharePoint Online API
Implementation provides another security layer based on the authenticated user. AventX will act on behalf of
the authenticated user (delegated permission) to request access from the resource. If the user does not have
access on this specific resource, AventX not be able to extract the attachment.

Extracting using Microsoft Graph API

o Choose “Microsoft APIs,” then Search for and Select “Microsoft Graph”
o Select “Application permissions,” and expand Files category.

Configuring Software Modules - AventX for Oracle eAM

Page 494 of 944
Proprietary to STR Software
o Select “Files.Read.All” then Add permissions.
o Click “Grant admin consent”.
o Note: The “Grant admin consent” step must be completed by an Azure Administrator.
o Select “Certificates & secrets” on the left-hand side.

• Click “New client secret,” give it a good description and set the secret expiration time to your
organization security policy requirement.
o Note: Please keep your client ID and secret pair safe and secured, as they act as the client
credential to access your Microsoft 365 Resource. If exposed, please remove the secret
and add a new one instead. The secret will only be displayed in plain-text only 1 time
after it was generated.
• Click “Add” once finished.

Configuring Software Modules - AventX for Oracle eAM

Page 495 of 944
Proprietary to STR Software
Extracting using SharePoint Online API

• Choose “Microsoft APIs,” then Search for and Select “SharePoint”

Configuring Software Modules - AventX for Oracle eAM

Page 496 of 944
Proprietary to STR Software
• Select Delegated Permissions, and refer to the table below for required Permission configuration

Configuring Software Modules - AventX for Oracle eAM

Page 497 of 944
Proprietary to STR Software
Delegated Permissions Usage

AllSites.Read Used in SharePoint Online Attachment Extraction

AllSites.Write Used by AventX Mobile for EAM and AventX Digital

Print to upload attachments to SharePoint Online

Note:
Since AventX is acting on behalf of a user (delegated permission), SharePoint Administrator can set the
user permissions specifically on any sites or libraries required. AventX will not have permission to read or
write on any location not available to the acting user.

Configuring Software Modules - AventX for Oracle eAM

Page 498 of 944
Proprietary to STR Software
• Click the “Add Permissions” Button, then “Grant admin consent”.
Note: The “Grant admin consent” step must be completed by an Azure Administrator.

Configuring Software Modules - AventX for Oracle eAM

Page 499 of 944
Proprietary to STR Software
• You may delete the Microsoft Graph User.Read Permission as it is not required for this implementation.
• Select “Authentication” on the left side and scroll down to “Default client type” section, then select Yes
to treat AventX App as a public client.

Active Directory Federation Service Consideration

If your organization is under ADFS, please ensure the following requirements are met:

• Domain AD Accounts are synced with Azure AD Accounts.

• SharePoint Online credential must have correct UPN Suffix with your organization domain.
Please contact your AD Administrator to verify these requirements.

Configuring Software Modules - AventX for Oracle eAM

Page 500 of 944
Proprietary to STR Software
Configuring AventX Attachment Xpress to Use SharePoint Online

To successfully configure AventX for Oracle eAM to use SharePoint Online for attachment extraction, the
following are prerequisites:

• SharePoint Online credentials for AventX.

• The Client ID created from Azure Active Directory Registration.
If you have not yet met these two prerequisites, please follow the instructions in the following guide, entitled
Adding AventX as a Registered Application in Azure AD, before moving forward in the AventX Attachment
Xpress configuration.

Configuration within Oracle EBS Forms for Attachment Extraction

• Login to Oracle EBS Forms as the AventX Administrator Responsibility

• Navigate to System Configuration → List Configured Organizations → Choose Organization → Configure
Organization → Documents tab → Choose Document Type.

Configuring Software Modules - AventX for Oracle eAM

Page 501 of 944
Proprietary to STR Software
• Select the Oracle Attachments tab and input the necessary information, using the table below as a guide
for completing the necessary SharePoint Online information.
Note: Correct configuration will depend on each User's environment. While the information below is a
common configuration, it may not apply to a User's specific SharePoint Online/ AventX integration.

Field Microsoft Graph API SharePoint Online

Seq Increment this to the next logical value, following the pattern of the previous sequence
numbers.

Description A brief description of the AventX SharePoint Online integration.

Class com.strsoftware.AttachmentExtraction.G com.strsoftware.AttachmentExtraction.SPO

raphFileExtraction nline

Domain <tenant> <tenant>/<clientID>

Tenant: This is the “tenant name” Tenant: This is the “tenant name”
associated with the SharePoint Online associated with the SharePoint Online
integration, including the “.com” suffix. integration, including the “.com” suffix.
(Example: strsoftware.com, (Example: strsoftware.com,
strsoftware.onmicrosoft.com) strsoftware.onmicrosoft.com)
Note: The “/” symbol must be included as
the delimiter between the <tenant> and

Configuring Software Modules - AventX for Oracle eAM

Page 502 of 944
Proprietary to STR Software
 <clientID> values. The <tenant>/<clientID>
format must be followed exactly.
ClientID: The "Application ID" associated
with the App that you created when
following the instructions in the section
above, entitled Adding AventX as a
Registered Application in Azure AD.
Full <tenant>/<clientID> Example:
strsoftware.com/xxxxxxxx-xxxx-xxxx-
xxxx-xxxxxxxxxxxxxx

Username <ClientID> The SharePoint Online user that the

customer has created specifically for AventX
ClientID: The "Application ID" associated
for Oracle eAM.
with the App that you created when
following the instructions in the section
above, entitled Adding AventX as a
Registered Application in Azure AD.

Password <Client Secret> The password for the above user’s

SharePoint Online account access.
The client secret that was generated
during step 6 and 7 of Extracting using Note: It is highly recommended that this
Microsoft Graph API password is configured such that it will
never expire, as significant downtime could
occur if it becomes invalid.

Domains/ Prefixes Section

Prefix Select the Prefix option.

Search Key Typically, the format for this URL will follow this pattern:
https://<tenant>.sharepoint.com/
In the (uncommon) event that a link is generated using the following format, this link
must be listed before the typical link mentioned above:
https://<tenant>-my.sharepoint.com/

Configuring Software Modules - AventX for Oracle eAM

Page 503 of 944
Proprietary to STR Software
Overcoming Issues Related to a SharePoint Site Certificate

When setting up a document to extract attachments from a SharePoint site, if the following error is
encountered, then the information in this section may be necessary to ensure that the AventXPS properly
handles the SharePoint site’s certificate:

(ERROR-60026) An unexpected fatal error has occurred: Exception while extracting attachment.

Unable to extract attachment <Attachment_Address> due to an unexepcted return code of 403 from the
server. Verify the attachment may be downloaded using the given address from the AventX host.

Import the SharePoint Site’s Certificate

Follow these steps to import the certificate from the SharePoint site that is used for attachment storage.
There are two options for importing the certificate, depending on available system tools.

Option 1 - Using openssl

• On the AventX host, navigate to $FCHOME.

$ cd $FCHOME

• Execute the following command to export the certificate from <SharePoint_Site_Address>:

$ vim -e +'g/BEGIN CERTIFICATE/,/END CERTIFICATE/p' <(echo |openssl s_client -showcerts -connect

<SharePoint_Site_Address>:<Port_Number>) -scq > sharepointsite.crt

• Copy the sharepointsite.crt to the /path/to/java/lib/security directory on the AventX host.

$ cp sharepointsite.crt /path/to/java/lib/security

Option 2 - Using Mozilla Firefox

• Navigate to <SharePoint_Site_Address>.
• To the left of the site address, click on the lock icon.
• In the pop-up window, click on the arrow to the right of the site's name, and select "More Information"
at the bottom of the window.
• In the "Page Info" Window, choose the "Security" tab.
• Click on "View Certificate."
• Click on "Details."
• Select "Export..."
• Specify the filename sharepointsite.crt and choose the Format "X.509 Certificate with chain (PEM)".
• Click Save.
• Copy the sharepointsite.crt to the /path/to/java/lib/security directory on the AventX host.

Configuring Software Modules - AventX for Oracle eAM

Page 504 of 944
Proprietary to STR Software
$ cp sharepointsite.crt /path/to/java/lib/security

Add the <SharePoint_Site> Certificate to the Java cacerts File

Follow these steps to add the sharepointsite.crt certificate file to existing Java cacerts file.

• Navigate to the Java security directory.

$ cd /path/to/java/lib/security

• Backup the existing Java cacerts file.

$ cp cacerts cacerts.<date>.bak

• Execute the following command to import the <SharePoint_Site> certificate into the cacerts file.

$ keytool -keystore cacerts -importcert -alias sharepointsite -file sharepointsite.crt

Test Attachment Extraction

Now that the certificate has been imported and applied to the Java cacerts file, attachment extraction from
the SharePoint site will need to be tested again following the steps below:

• Bounce the AventXPS service.

$ $FCHOME/oa/aventxoc restart

• Test attachment extraction in the Oracle Attachments tab of the AventX Configuration Oracle EBS form.
If the test successfully extracts an attachment, then you do not need to complete the final two steps in this
section. If you receive the extraction error again, then you will need to follow the next two steps in this
section, explaining how to update $FCHOME/oa/aventxoc and $HOME/.bash_profile.

Update $FCHOME/oa/aventxoc

If attachment extraction was unsuccessful after importing the SharePoint site’s certificate and applying it to
the Java cacerts file, then $FCHOME/oa/aventxoc will need to be updated. Follow the steps below to
complete this update:

• Backup the existing $FCHOME/oa/aventxoc file.

$ cd $FCHOME/oa

$ cp aventxoc aventxoc.<date>.bak

• Open the aventxoc script and search for cJAVA_EXECUTABLE

• This search will take you to the following executable string (located under the code “if test “$1” = “start”;
then):

$cJAVA_EXECUTABLE $ENTROPY_PARAM $TNS_PARAM -jar $FCHOME/oa/java/AventXPS.jar $1 &

Configuring Software Modules - AventX for Oracle eAM

Page 505 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 506 of 944
Proprietary to STR Software
• Insert $JAVA_CACERT between $cJAVA_EXECUTABLE and $ENTROPY_PARAM in the executable string.
After inserting the $JAVA_CACERT variable, the executable string will look like the following:

$cJAVA_EXECUTABLE $JAVA_CACERT $ENTROPY_PARAM $TNS_PARAM -jar $FCHOME/oa/java/AventXPS.jar

$1 &

Add the $JAVA_CACERT Environment Variable to $HOME/.bash_profile

Follow these directions to add the $JAVA_CACERT environment variable to the AventX User’s .bash_profile.

• Navigate to $HOME

$ cd $HOME

• Edit the .bash_profile by adding the following JAVA_CACERT variable to the bottom of the file:

JAVA_CACERT=-Djavax.net.ssl.trustStore=/path/to/java/lib/security/cacerts

export JAVA_CACERT

• Source the .bash_profile and test the new $JAVA_CACERT environment variable.

$ . ~/.bash_profile

$ echo $JAVA_CACERT

This should return the path to the cacerts file, that you entered into the .bash_profile.
Test Attachment Extraction

Now that the certificate has been imported and applied to the Java cacerts file, the .bash_profile has been
updated with an absolute path to the Java cacerts file, and the aventxoc script’s executable string has been
updated with the $JAVA_CACERTS variable, attachment extraction from the SharePoint site will need to be
tested again following the steps below:

• Bounce the AvnetXPS service.

$ $FCHOME/oa/aventxoc restart

• Test attachment extraction in the Oracle Attachments tab of the AventX Configuration Oracle EBS form.

Configuring Software Modules - AventX for Oracle eAM

Page 507 of 944
Proprietary to STR Software
Modules
AventX Digital Print Module
Introduction

AventX Digital Print provides the ability to generate a completed work packet, including the work order and
its attachments specified with AventX Attachment Xpress, then attaching that completed work packet back to
the Work Order header in Oracle EBS. Users can specify whether the work packet should be attached as a File
attachment, or a Web attachment uploaded to SharePoint On-Premise. The Work Packet can be generated
with a custom name, custom description, and be attached to any attachment category available to the work
order header entity. Currently AventX Digital Print supports the Work Order document type.

Requirements

• A new Printer name AventX_Digital_Print to AventX Work Order printer style is required.
• AventX Translation Server 5.3 – Note: This will require a Windows Server
Configuration

The Digital Print Configuration is found in the WorkOrder document within the Organization configuration on
the AventX Configuration Form. In that form a new tab for Digital Print is available.

Configuring Software Modules - AventX for Oracle eAM

Page 508 of 944
Proprietary to STR Software
The main interface of AventX Digital Print configuration is shown below:

The Title and Description fields are free form text and the tokens below are supported:

Supported Token Replacement Value

:UID1 – :UID7 UID1 to UID7 from FAX_INFO tag

:SUBJECT Document subject

:DOCUMENTNAME Work Order

:REQUESTID Concurrent request ID

:BUSINESSENTITY Name of the business entity as specified in the

AventX Oracle for EBS license key

:DOCTYPE work

Configuring Software Modules - AventX for Oracle eAM

Page 509 of 944
Proprietary to STR Software
 • If Print To File Attachment is selected, Digital Print will attach the work packet as a File attachment to
the Work Order header.
• If SharePoint Attachment is selected, Digital Print will upload the work packet to SharePoint On-
Premise or SharePoint Online and attach the URL as a Web page attachment to the Work Order
header.

(Optional) VIZIYA Mobile Setup for New Digital Print Attachment Category

Step 1: Query for the new Attachment Category in Oracle for Category_id and Name.

select category_id, Name from apps.FND_DOCUMENT_CATEGORIES_VL where user_name = 'Digital Print WO

Package'

Step 2: Login as administrator in to VIZIYA Mobile Manager

Navigate to Mobile Security→Mobile Restriction

Step 3: Search with Entity “WO_ATTACHMENT”, it displays all the roles having the entity

Configuring Software Modules - AventX for Oracle eAM

Page 510 of 944
Proprietary to STR Software
Step 4: Open each role and update length(file_data) to 10000000 (10MB) and add new category_id and from
the Step1, Validate the change and enable the restriction and then save.

Note: This setup has to be done to all the roles mentioned in the screenshot.

Step 5: Navigate to Mobile Configurations→Mobile Configuration

Configuring Software Modules - AventX for Oracle eAM

Page 511 of 944
Proprietary to STR Software
Step 6: Search the configuration “Where clause for work order attachment category drop down - Work
Order Management” and add the new category_id from the step1 to the value field.

AventX Preview and Print to Windows Printer Module

Previewing Work Orders with Attachments

All methods (Oracle Forms and Self-Service) allow the user to preview Work Order output (including any
configured attachments) prior to actual printing. In Self-Service this is accomplished via the “Preview Work
Order(s)” button.

Configuring Software Modules - AventX for Oracle eAM

Page 512 of 944
Proprietary to STR Software
After the request is done, the completed Work Order report (including any configured attachments) will
automatically launch a PDF viewer and present to the user.

In Oracle Forms this is accomplished via the “Preview” button on the AventX Interactive Work Order
Submission form.

Configuring Software Modules - AventX for Oracle eAM

Page 513 of 944
Proprietary to STR Software
After the request is done, the completed Work Order report (including any configured attachments) will
automatically launch a PDF viewer and present to the user.

Previewing Work Orders with attachments requires the following:

• An AventX License Key that enables the Print Xpress Preview feature.
• A new Printer (AventX_Local_Preview) and Type (AventX Local).

Configuring Software Modules - AventX for Oracle eAM

Page 514 of 944
Proprietary to STR Software
• The relevant Printer Driver Arguments string must include the value of “local” in the <special> parameter.

$XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME"

"$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID" "$PROFILES$.CONC_COPIES" ""
"work:I" "none" "local pdf"

Configuring Software Modules - AventX for Oracle eAM

Page 515 of 944
Proprietary to STR Software
• The Work Order document type must be configured to use the AventX_Local_Preview printer via the
Work Order UI tab of the AventX Document Configuration form.

Configuring Software Modules - AventX for Oracle eAM

Page 516 of 944
Proprietary to STR Software
AventX Mobile for Oracle eAM

Introduction

AventX Mobile for eAM is the ideal mobile solution for many of the problems associated with printed Work
Orders. AventX Mobile for eAM is comprised of AventX Mobile Work Orders and AventX Mobile Work
Requests.

AventX Mobile Work Orders allows maintenance users to view work order packets on the go with an iPhone
or iPad – even offline. As with paper, users can mark-up electronic work orders with the added benefit of
attaching pictures and audio files as context to the completed work. AventX also allows technicians to close
and upload completed work orders from anywhere, increasing time in the field and decreasing time spent
manually entering the same information after the work is done.

AventX Mobile Work Requests allows technicians, asset operators, supervisors, and other team members to
quickly create and submit work requests from a mobile device. Users can even attach photos to provide
clarity and context for the reported issue. This instant communication enables maintenance teams to react
promptly to issues and gives operations staff peace of mind that their requests are being addressed.

Configuration

Oracle EBS Configuration

Printer Drivers

New print drivers must be registered to support AventX Mobile Printing. At least two print drivers maybe
necessary to support portrait and landscape output. To create the new print drivers:

• Log into Oracle Applications as the System Administrator responsibility.

• Select Install, then Printer, then Driver.
• Create the new print drivers in the form shown below as described:

Configuring Software Modules - AventX for Oracle eAM

Page 517 of 944
Proprietary to STR Software
Driver Parameters

AventX Mobile Portrait Driver Name: AventX Mobile Portrait

User Driver: AventX Mobile Portrait
Description: AventX Mobile Print for Portrait Orientation
SRW Driver: HPP
Deliver Method: Command
Driver Method: Spool File
Arguments: $XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER"
"$PROFILES$.FILENAME" "$PROFILES$.XXSTR_SEQNO"
"$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "[LANG=PDF]" "work:I" "none"
"local nopasta pdf"
AventX Mobile Driver Name: AventX Mobile Landscape
Landscape User Driver: AventX Mobile Landscape
Description: AventX Mobile Print for Landscape Orientation
SRW Driver: HPL
Deliver Method: Command
Driver Method: Spool File
Arguments: $XXAVENTX_TOP/oa/fcprinto.sh
"$PROFILES$.PRINTER" "$PROFILES$.FILENAME"
"$PROFILES$.FAX_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
Configuring Software Modules - AventX for Oracle eAM
Page 518 of 944
Proprietary to STR Software
 "$PROFILES$.CONC_COPIES" "[LANG=PDF]" "work:I" "none" "local
nopasta pdf"
Some of the parameters in the Arguments field may need to be customized for your environment. A
breakdown of the parameters in the arguments string, along with default/required values, is as follows:

Parameter Name Description / Valid Values

Path to the fcprinto.sh script. If not $XXAVENTX_TOP, the default

value to the left should be replaced with the custom top
$XXAVENTX_TOP/oa/fcprinto.sh environment variable that was created during installation. Failure
to do so will result in Warning errors when the Concurrent
Manager runs the reports to AventX Print Xpress printers.

The Oracle printer name. This value must be inserted exactly as

"$PROFILES$.PRINTER"
"$PROFILES$.PRINTER".

The full path name of the output data file as assigned by the
"$PROFILES$.FILENAME" Concurrent Manager. This value must be inserted exactly as
"$PROFILES$.FILENAME".

A sequence number for this report passed from the Concurrent

"$PROFILES$.XXSTR_SEQNO" Manager. This value must be inserted exactly as
"$PROFILES$.XXSTR_SEQNO".

A combination of the request ID assigned by the

"$PROFILES$.TITLE" Concurrent Manager and Oracle user name that submitted the
report. This value must be inserted exactly as "$PROFILES$.TITLE".

The Oracle EBS Organization ID associated with the Organization

"$PROFILES$.ORG_ID" that created this document. This value must be inserted exactly as
"$PROFILES$.ORG_ID".

The number of copies passed from the Concurrent Manager. This

"$PROFILES$.CONC_COPIES"
value must be inserted exactly as "$PROFILES$.CONC_COPIES".

"<AXUX commands>" For AventX Mobile Print this parameter should be “[LANG=PDF]”.

AventX Mobile Print is only used for the work order doc type. This
"<document type>"
should always be “work:I”.

This parameter is not used with AventX Mobile Print. Use "none"
"<form method>"
as a placeholder.

Used to indicate a special condition to the AventXPS process. For

"<special>" AventX Mobile Print, this value must be set to "local nopasta pdf".

Configuring Software Modules - AventX for Oracle eAM

Page 519 of 944
Proprietary to STR Software
 For Mobile Printing with attachments the document type (pdf) and
nopasta must be specified.
Be sure to save any changes to your print drivers before closing out the form. A bounce of the Standard
Manager may be necessary to apply changes to any AventX print driver strings.

Configuring Software Modules - AventX for Oracle eAM

Page 520 of 944
Proprietary to STR Software
Printer Types

A new printer type must be created to support AventX Mobile. Existing print styles must be paired with
AventX drivers to allow access to the AventX Mobile printer. To create the new printer type:

• Log into Oracle Applications as the System Administrator responsibility.

• Select Install, then Printer, then Types.
• Create the new printer type as shown in the screenshot below, being sure to save your changes
afterward:

The styles and drivers registered under the AventX Print Xpress type may vary from customer to customer.
System administrators must register the AventX drivers and pair them within this form with existing printer
styles. The Style listed in this field must match the style defined in the Work Order Document Configuration
as shown below:

Configuring Software Modules - AventX for Oracle eAM

Page 521 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 522 of 944
Proprietary to STR Software
Printers

One new printer needs to be created to support AventX Mobile Print. To create the new printer:

• Log into Oracle Applications as the System Administrator responsibility.

• Select Install, then Printer, then Register.
• Create the new printer as shown in the screenshot below, being sure to save your changes afterward:

Configuring Software Modules - AventX for Oracle eAM

Page 523 of 944
Proprietary to STR Software
AventX Work Order App

SharePoint Configuration

Introduction
There are three methods for storing configuration when completing work orders and storing them SharePoint
on-prem and SharePoint online.

• AventX Configuration Form

• AventX File System in a text file
• AventX Work Order app on the user’s mobile device

Creating a SharePoint Library for Uploading Work Orders and Attachments

The AventX Configuration file for uploading Work Orders and attachments needs to match the SharePoint
library configuration. Here are instructions for creating a document library under SharePoint:

First, click the Create button within SharePoint. This button is available from the All Site Content page, among
other places:

You may require elevated permissions within SharePoint to access the Create button, as well as an
installation of Microsoft Silverlight to proceed.

Configuring Software Modules - AventX for Oracle eAM

Page 524 of 944
Proprietary to STR Software
Next, select Document Library:

Type in the desired name for your document library in the text field (this should match the Library value from
the .json file in $FCHOME/oa/cfg/eam), then click the Create button.

SharePoint will create your document library. By default, only the columns Type, Name, Modified, and
Modified By will be displayed:

If desired, you can add folders underneath your SharePoint library to sort your uploaded documents. Under
Library Tools, navigate to Documents, then select the New Folder Icon:

Enter the desired name for your folder and click the Save button:

Configuring Software Modules - AventX for Oracle eAM

Page 525 of 944
Proprietary to STR Software
At least one of the folder paths you create in SharePoint should match the Folder value in the .json file if
Create Folder is set to False (that is, you should manually create the folder path if AventX is not configured to
create it automatically).

To add additional columns within your SharePoint document library, select the Library tab under Library
Tools, then click the Library Settings icon as shown:

Under Columns, click Create column to create your desired column(s):

Configuring Software Modules - AventX for Oracle eAM

Page 526 of 944
Proprietary to STR Software
Enter the column details on the next page. The values entered for Column name should exactly match the
field names in the json file (special characters and spaces should be avoided). Once you have filled out all the
necessary fields, click the OK button:

Repeat the Create column task as many times as necessary until you have defined all your desired columns as
shown (column names and types may vary based on your requirements):

Configuring Software Modules - AventX for Oracle eAM

Page 527 of 944
Proprietary to STR Software
Configuring Software Modules - AventX for Oracle eAM
Page 528 of 944
Proprietary to STR Software
Configuring via AventX Text File
When uploading or printing a submission (AventX Digital Print, AventX Mobile), AventX will look for a
configured maintenance organization under the locations below.

• On AventX Server, go to $FCHOME/oa/database/<SID>/cfg/eam to configure instance specific

configuration, or go to $FCHOME/oa/cfg/eam/ to configure global (all instances of this AventX
server).
• AventX will looks for <MAINTENANCE_ORG>.json before default.json.
• Default.json can be used to be the default config for all maintenance organizations.
• To configure an EAM Org, copy template.json to <MAINTENANCE_ORG>.json, i.e. EM1.json.
• Open the newly copied file and enter configuration values.

Main Configuration
The configuration file is separated into two main sections, document types, and mobile print. See table below
for explanation.

Key Required For Explanation

Version None Version of the configuration file. Do not change.

Doc Types All Configure SharePoint Instances for Work Order,

Work Request, or Digital Print. See Upload to
SharePoint Configuration section for more
information.

Mobile Print AventX Mobile Configure required information for AventX Mobile
Print, Mobile Work Orders, and Mobile Work
Requests.

Time Zone Id All Time Zone of the EBS Database Server. If left
blank, this field will assume AventX Server has the
same time zone as EBS Database Server.

Default: Blank

Example format: “America/New_York”

Configuring Software Modules - AventX for Oracle eAM

Page 529 of 944
Proprietary to STR Software
Upload to SharePoint Configuration
AventX supports having different SharePoint OnPremise/SharePoint Online for each supported document
type. Each must be configured separatedly and may share the same configuration values. See table below
and “template.json” for more information.

Key Required For Value

Type All SP: Upload to SharePoint On-Premise.

SPO: Upload to SharePoint Online.

Authority SPO Common authority will work in most case,

however, depend on your Azure configuration, you
may need to modify this authority to:

https://login.microsoft.com/<tenant-name>/

Tenant SPO Your company tenant name. Example:

strsoftware.com, or strsoftware.onmicrosoft.com

Client ID SPO AventX SPO Integration application client ID noted

during Azure setup above.

SharePoint Host All Your SharePoint Host URL.

I.e: https://<tenant>.sharepoint.com/

Subsite Optional The subsite in which AventX will work with.

Library Optional The library in which AventX will upload attachment

and update its metadata.

Folder Optional The specific folder in which AventX will upload

attachment to.

Create Folder All True/False. If the folder specified above does not
exist, AventX will attempt to create the folder if
this was set to True.

Metadata Query All See SharePoint Metadata Query Configuration

below for explanation

Metadata String All See SharePoint Metadata Query Configuration

below for explanation

Username All An Azure Active Directory user that AventX will act
on behalf of to upload attachment.

Configuring Software Modules - AventX for Oracle eAM

Page 530 of 944
Proprietary to STR Software
 Password All Password of the above user as plain text. This
password will be encrypted on AventX Service
startup.

Note: The ‘defaultUsername’ and ‘defaultPassword’ fields can be supplied in the document types section.
These fields apply to all configured document types. However, the ‘username’ and ‘password’ fields within
each document type section will take priority if set.

Mobile Print Configuration

Key Required For Value

EAM Responsibility AventX Mobile EAM responsibility that will be used to create an
express work order.

Concurrent Request AventX Mobile Metadata required to create Express Work Order,
Metadata print Express Work Order from Mobile Work
Requests. See Concurrent Request Metadata table
below for more information.

Daily Clean Up AventX Mobiile AventX will attempt to remove staged work orders
with the specified statuses during daily
maintenance windows. This field can be left empty
to disable removing completed work order from
staging table.

Default:

["Complete", "Complete - No Charges",

"Cancelled", "Closed"]

Completion Offset AventX Mobile / Offset the actual completion time sent in by the
(Seconds) Optional user. This value can be negative or positive
number represented in offset seconds.

Default: 0

If this value is not 0, the timestamp passed in by

completion action on AventX Mobile Work Order
will be offset by this number before sending to
Oracle EBS for completion

Allowed Statuses AventX Mobile Only allowed Work Order Status from this list to be
pushed down to Mobile Work Orders.

Default: [ “Released” ]

Configuring Software Modules - AventX for Oracle eAM

Page 531 of 944
Proprietary to STR Software
 Concurrent Request Metadata Section

Responsibility All Responsibility that will be used to print an express

work order after its creation from AventX Mobile
Work Requests

Application Name All Application name of maintenance unit.

Default: “EAM”

Program Code All Short code of concurrent program used to print

work order to AventX.

Default: “XXSTREAMWOREP”

Template Code All Short code of template to be used with the

concurrent program above.

Default: “XXSTREAMWOREP”

Template Language All Code of language used in template above.

Default: “en”

Template Territory All Code of territory used in template above.

Default: “us”

Print Style All Printer style used to print work order to AventX.

Default: “AventX Work Order”

Printer All AventX_Mobile_Print

Parameters All See Express Work Order Printing Parameters

below for explanation

SharePoint Metadata Query Configuration

Metadata Query and Metadata String enable AventX to dynamically populate SharePoint library fields with
EAM data from Oracle EBS.

• In metadata query, AventX will bind the first bind variable (denoted with a question mark sign) with
the WIP Entity ID of the Work Order. A Database Administrator can modify this query to pull for any
data that the organization needs. Each returned column can be mapped with a SharePoint column
with the help of the metadata string.

Configuring Software Modules - AventX for Oracle eAM

Page 532 of 944
Proprietary to STR Software
 • In metadata string, the first character in the string denotes the separator of sets, while the second
character denotes the separator of key-value. The key will map to SharePoint column using its real ID,
while the value will be substitute with data pulled from metadata query. For example, with the
following string:
Original metadata string:

|=WorkOrderNumber=::wonumber::|Organization=::orgcode::

Query returned table below:

wonumber orgcode

WO1000 EM1

Separator of set: | character

Separator of key-value: = character

Thus, they can be understood as follows:

WorkOrderNumber Organization

WO1000 EM1

AventX will attempt to populate column with ID WorkOrderNumber with WO1000, and column with ID
Organization with EM1.

Express Work Order Printing Parameters

This parameter field can be obtained by copying the detail parameters field of the AventX Work Order
printing concurrent program. Substitute the EAM organization ID field with <ORGID>, and the AventX Job ID
field with <JOBID>

Example: ", , , , , , , , , <ORGID>, 1, 1, 1, 1, 1, 1, 2, , 1, 1, 1, 1, , , <JOBID>, 1, 1, , ,"

AventX will include any hard-coded attachment on this organization along with the Express Work Order.

Configuration via AventX Work Order App

See AventX Mobile for eAM user’s guide for information on how to configure this feature.

Configuring Software Modules - AventX for Oracle eAM

Page 533 of 944
Proprietary to STR Software
Deprecating Old Features and Modifying the Work Order Document Configuration
After modifying a configuration file for each Maintenance Organization, you will need to remove the existing
SharePoint configuration values in the Work Order Document configuration. The screenshot below shows a
typical existing configuration.

Remove all existing values in the SharePoint Fields and save the changed form.

Configuring Software Modules - AventX for Oracle eAM

Page 534 of 944
Proprietary to STR Software
AventX Work Requests App

Express Work Order Creation

Introduction

The AventX Work Requests App gives users the ability to create Work Requests and create an Express Work
Order in the field. Creating an Express Work Order allows a maintenance user to configure and submit a Work
Order immediately to expedite the Work Order creation process and return the approved Work Order to the
user’s mobile device for immediate viewing. More information about Express Work Order Creation is in the
AventX for Mobile eAM Users Guide.

Configuring AventX

When uploading or printing a submission, AventX will look for a configured maintenance organization under
the location below. The hierarchy for which configuration AventX uses is the organization specific config first,
then default.json (located in the location below).

• On AventX Server, go to $FCHOME/oa/cfg/eam.

• Copy template.json to <MAINTENANCE_ORG>.json, i.e. EM1.json.
• Open the newly copied file, enter configuration values based on the following table.
Key Value

eamResponsibility The responsibility that will be used to create the

work order. This responsibility must have
permission to create work order under this
maintenance organization.

Under the Concurrent Request Metadata Group

responsibility The responsibility that will be used to submit the

concurrent request to print to AventX. Usually field
is the same as eamResponsibility.

applicationName “EAM”

programCode The code of the concurrent program to submit

AventX Work Order Print.

Default: “XXSTREAMWOREP”

templateCode The template of the Work Order associated with the

program above.

Default: “XXSTREAMWOREPORT”

templateLanguage The template language.

Configuring Software Modules - AventX for Oracle eAM

Page 535 of 944
Proprietary to STR Software
 templateTerritory The template territory.

printStyle The printer style associated with the

“AventX_Mobile_Print” below.

Default: “AventX Work Order”

printer “AventX_Mobile_Print”

parameters See below.

To get the parameters value, print a Work Order to AventX Mobile Printer using Self Service, and then copy
the concurrent request parameters. Change the Org ID to <ORGID> token, and the STR Sequence Number to
<JOBID>, and then paste it into the configuration file.

Configuring Software Modules - AventX for Oracle eAM

Page 536 of 944
Proprietary to STR Software
System Administration
Viewing Document Status

After a “Normal” completion of the concurrent request, processing is handed off to AventX where the batch
file of work orders is separated into the individual work orders. Each work order is then processed by AventX,
which includes extracting the attachments as configured and specified by the user (if configured to do so),
combining all portions into a single, page-size limited, PDF file, and more. At that point, you can track the
printing progress using the AventX Delivery Status form.

Configuring Software Modules - AventX for Oracle eAM

Page 537 of 944
Proprietary to STR Software
Execute a query and the printing status is displayed once you click “Find”.

Configuring Software Modules - AventX for Oracle eAM

Page 538 of 944
Proprietary to STR Software
Gathering eAM Job Summary Data

Starting with version 14.3.00, AventX provides the ability to collect and display usage by individual
maintenance organizations. This data contains successful jobs submitted through AventX in the past 372
days, and can be analyzed to improve work scheduling, resource management and more.

To get this data, visit the AventX Web Delivery Status and click the eAM Job Summary button below:

Note: Only jobs that were submitted after version 14.3.00 installation will be available for data collection. The
button will only appear if AventX for Oracle eAM is enabled on your license.

Configuring Software Modules - AventX for Oracle eAM

Page 539 of 944
Proprietary to STR Software
Moving AventX to Production

The following is intended as a guideline to assist customers with moving an existing instance of AventX to
another environment (for example TEST to PROD).

1. Create a local user account (e.g. aventx) on the target host to be used for the PROD instance of AventX.
This account should have the same characteristics (e.g. shell, group membership, environment variables)
as the corresponding account on the source TEST instance.

2. Create a directory (e.g. /opt/aventx) on the target PROD host to serve as the “home” the AventX
installation. This directory should have the same characteristics (e.g. permissions) as the corresponding
directory on the source TEST instance.

3. Stop the AventXPS process on the TEST instance (e.g. $FCHOME/oa/aventxoc stop TEST).

4. Create a tar file of the AventX software on the source TEST instance (e.g. tar -cvf /tmp/aventx.tar
/opt/aventx/* /opt/aventx/.fc*) which will be used to create your PROD instance of AventX.

5. Transfer the tar file (e.g. aventx.tar) to the appropriate directory (e.g. /opt/aventx) on the target PROD
host and extract.

6. Run $FCHOME/oa/ins/setup.sh and choose the ‘Rename’ option to rename TEST to PROD (or the
equivalent values for your environment).

7. Remove $FCHOME/oa/log/*, $FCHOME/oa/*.tar, and $FCHOME/oa/database/PROD/log/*.

8. Install the AventX software by running $FCHOME/oa/ins/setup.sh (Steps 1 – 7). Refer to the AventX for
Oracle EBS Installation and Upgrade Guide for specific details.

9. Configure “Implementation Overview” section of this document.

10. Start the AventXPS process in TEST (e.g. $FCHOME/oa/aventxoc start TEST).

11. Use the ‘Export Config’ button on the AventX Configuration form of the source TEST instance to create
and save off a ZIP file.

12. Start the AventXPS process in PROD (e.g. $FCHOME/oa/aventxoc start PROD)

13. Use the ‘Import Config’ button on the AventX Configuration form of the target PROD instance to import
the ZIP file from Step 12.

14. Open and inspect AventX Configuration and AventX Document Configuration forms to verify all settings
and configuration values correctly reflect the PROD instance (e.g. General Config, Printers, Translation
Servers, Query Tabs).

15. Restart the AventX process for the PROD instance using “$FCHOME/oa/aventxoc restart <SID>”.

Troubleshooting

Enabling Debugging for further Troubleshooting

Configuring Software Modules - AventX for Oracle eAM

Page 540 of 944
Proprietary to STR Software
During the testing phase, there may be times when you need more of a “behind the scenes” look at what is
occurring during processing. This is made possible by enabling FND Debug Logging as follows:

As the System Administrator, navigate to Profile→System.

Check the User checkbox, and fill in your Oracle EBS User (login) name, for example TSOLES

In the Profile box, type “FND: Debug%” to perform a search of all FND debugging profile options.

Configuring Software Modules - AventX for Oracle eAM

Page 541 of 944
Proprietary to STR Software
A list of profile options matching the search criteria is displayed. Change the value of FND: Debug Log Enabled
to “Yes” for your user, and the FND: Debug Log Level to “Statement”. You may also wish to narrow things
down further by setting the FND: Debug Log Module to “xxstr%” for your user, such that logging only takes
place for Interactive Work Order Submission. Make sure to save your changes.

This type of logging can severely impact system performance. STR Software highly recommends that you
enable this type of logging only for a short period of time, and that you turn logging off (by setting the FND:
Debug Log Enabled back to No for your user) as soon as you are finished with troubleshooting.

Once you have submitted your request, you can view the results using the following SQL statement:

select * from fnd_log_messages where module like 'xxstr%' order by log_sequence;

For subsequent testing, you may wish to “clear out” the table for xxstr entries by running a SQL statement as
follows before each test:

delete from fnd_log_messages where module like 'xxstr%';

This way you are assured that the logging statements apply only to the latest execution of the test.

Configuring Software Modules - AventX for Oracle eAM

Page 542 of 944
Proprietary to STR Software
As a reminder, don’t forget to disable logging after you have completed your testing by setting the FND:
Debug Enabled value to “No” for your user.

AventX Print Xpress

Requirements
AventX Print Xpress provides the ability to quickly view and print report output. Users can preview reports to
their screen or print to a local or network printer defined in the Windows operating system thereby
eliminating the need to define printers in Oracle EBS or in the Unix operating system.

The following additional requirements are necessary to support AventX Print Xpress functionality from users’
desktops:

• GhostScript must be installed on the Concurrent Manager (CM) tier to support text and Postscript
output conversion to PDF.
• Oracle PASTA (FNDPSTAX) must be installed on the CM tier.
• Users must be running Windows PCs for Local Print and Local PrintTo. MacOS Supports Local Preview
only.
• Java version 8 is supported to run the AventX Print Xpress client from users’ PCs. If Java 11 is installed
on users’ PC please contact STR Software for a supported version of the AventX Print Xpress client.
• Users’ PCs must be able to connect directly via TCP to the AventX server over the AventXPS port (by
default, this is port 6055).

Introduction
The AventX Print Xpress software provides the ability for Oracle EBS users to quickly preview or print
(automatically or manually) reports and documents to network and local printers. It frees administrators
from maintaining printers on EBS backend systems. This is particularly helpful in distributed sites that have
many users and printers or with less control over the actual infrastructure. There are a few components of
the AventX Print Xpress software that provides this functionality:

1. Local Printing
2. Preview Printing
3.
AventX Print Xpress allows you to direct Oracle Concurrent Request output to your Desktop to preview or
print it directly from your PC.

Once the AventX Print Xpress Client is installed on a user’s PC, they can open it and provide their Oracle EBS
Username and Password, along with the AventX Host, Port, and whether to use SSL (this information should
be available to system administrators once the full AventX install is complete):

Configuring Software Modules - AventX Print Xpress

Page 543 of 944
Proprietary to STR Software
Users must keep this client window open
while using AventX Print Xpress. Closing the
AventX Print Xpress client will prevent
AventX Print Xpress from accessing
Concurrent Request output from Oracle. If
this happens, the client will pick up any jobs
submitted while it was not running the next
time it is started.

To invoke AventX Print Xpress, users print

concurrent requests as normal, but instead
of picking a normal printer, they should
choose one of the following:
AventX_Local_Preview,
AventX_Local_Print, or
AventX_Local_PrintTo.
• AventX_Local_Preview – Once the
concurrent request is complete and
processed by AventX, the file will
open on the user's desktop with the
application associated with the
output (Acrobat, Word, Excel, etc.).

Configuring Software Modules - AventX Print Xpress

Page 544 of 944
Proprietary to STR Software
 • AventX_Local_Print – PDF/Text/PS output only. Once the concurrent request is complete and
processed by AventX, the file will print directly to the user's default printer as defined on their local
desktop. They will not receive a prompt of any kind.
• AventX_Local_PrintTo – PDF/Text/PS output only. Once the concurrent request is complete and
processed by AventX, a simple dialog will pop on the user's desktop where they can choose the
printer (as defined on their PC) to which to send the job for printing.
Concurrent requests kick off a script on the concurrent manager tier(s) called fcprinto.sh via an AventX print
driver. If the output is Text or PS, the data is converted to PDF (via Oracle Pasta and GhostScript) before being
passed to AventX for processing.

AventX processes the document (no bursting or lookup is performed) and makes the data available for the
Print Xpress client to find.

The Print Xpress client finds the data and downloads it to the user’s PC. The client will proceed as necessary
depending on the operation (preview or print). If a user shuts down the client, they will not receive any print
or preview jobs until they restart it. Once restarted, any jobs that have not been picked up will be
printed/previewed.

User Experience
What is AventX Print Xpress?

AventX Print Xpress allows you to print reports directly to a Windows print queue on your PC.

Configuring Software Modules - AventX Print Xpress

Page 545 of 944
Proprietary to STR Software
How do I use it?

When you are selecting a printer for your report, simply choose on of the pre-configured AventX printers:
AventX_Local_Preview, AventX_Local_Print, or AventX_Local_PrintTo.

What happens if I close the client?

You will not be able to use AventX to print to your local Windows print queues. If you print to one of the
AventX printers, the print job(s) will wait for you to restart the Print Xpress client on your PC before
processing the job(s).

What is the Purpose of Each of the AventX Printers?

• AventX_Local_Preview: Pops up PDF viewer for you to review the output then choose a printer.
• AventX_Local_Print: Immediately prints to your default Windows printer.
• AventX_Local_PrintTo: Pops up a window for you to select from your Windows print queues.
• AventX_Mobile_Print: Prints a Work Order directly to a user’s iPad running the AventX Mobile Work
Orders app.

Configuring Software Modules - AventX Print Xpress

Page 546 of 944
Proprietary to STR Software
Configuring Software Modules - AventX Print Xpress
Page 547 of 944
Proprietary to STR Software
Document Print Status

The AventX Delivery Status Form is updated with information regarding the final status of the job. This form
can be added to any responsibility that requires this feature. See the section called “AventX Delivery Status”
form for detailed information about this form

Because AventX Print Xpress does not perform any lookup against concurrent request output from Oracle,
the Doc ID and Subject are not known and are not logged in the Delivery Status Form. Values of note in the
Delivery Status Form include:

• Request ID: The concurrent request ID

• Login: The Oracle user who submitted the request

• Destination: The type of the AventX Print Xpress request (more on this below)

• Date: This value reflects when the last status message for that request was posted into Oracle.

• Status: The current or final status of the job

• Status Message: An error message if any occurred, otherwise a successful status message

• Err No: This provides the error code if any occurred and is used for troubleshooting.

• Host: The server where AventX Print Xpress is running

The Destination logged in the Delivery Status Form reflects the type of AventX Print Xpress request:
AVENTX_DESKTOP_PREVIEW, AVENTX_DESKTOP_PRINT, and AVENTX_DESKTOP_PRINTTO correspond to
the AventX_Local_Preview, AventX_Local_Print, and AventX_Local_PrintTo printers respectively.
Configuring Software Modules - AventX Print Xpress
Page 548 of 944
Proprietary to STR Software
One caveat of using the Delivery Status Form in conjunction with AventX_Local_PrintTo is that the Delivery
Status Form will reflect a status of Process while waiting for a user to select their desired printer:

Configuring Software Modules - AventX Print Xpress

Page 549 of 944
Proprietary to STR Software
The Delivery Status Form will display a final status for that request only once the user has selected their
desired printer from the “AventX PrintTo Selection” prompt and pressed OK:

Supported Output Formats

The following file formats are support when printing to the AventX Print Xpress printers.

▪ Text (landscape and portrait) ▪ RTF (via BIP)

▪ PostScript ▪ Excel (via BIP)
▪ PDF ▪ HTML
▪ XML

AventX Print Xpress currently does not support PCL output.

Using AventX Local Preview Printer

To preview concurrent request output in the appropriate program on your PC before printing or saving, you
should select AventX_Local_Preview in the Printer field of the “Upon Completion…” form (accessible by
pressing Options on the Submit Request form):

Configuring Software Modules - AventX Print Xpress

Page 550 of 944
Proprietary to STR Software
Click the OK button on the Upon Completion… form, then Submit on the Submit Request form to begin your
concurrent request. After the request completes, the AventX Print Xpress client will open the output file in
the application assigned to the file’s extension on your PC (e.g., .pdf output might open in Adobe Reader).

Configuring Software Modules - AventX Print Xpress

Page 551 of 944
Proprietary to STR Software
Using AventX Local Print Printer

To print concurrent request output directly to the default printer defined on your PC, you should select
AventX_Local_Print in the Printer field of the “Upon Completion…” form (again, accessible by pressing
Options on the Submit Request form):

Configuring Software Modules - AventX Print Xpress

Page 552 of 944
Proprietary to STR Software
Click the OK button on the Upon Completion… form, then Submit on the Submit Request form to begin your
concurrent request. After the request completes, the AventX Print Xpress client will print the output file
directly to your default printer, as specified in your Devices and Printers settings:

You will receive no prompts from the AventX Print Xpress client when using AventX_Local_Print.

Configuring Software Modules - AventX Print Xpress

Page 553 of 944
Proprietary to STR Software
Using AventX PrintTo Printer

AventX Print Xpress can also send concurrent request output to your PC and prompt for the locally defined
printer you would like to use. You can accomplish this by selecting AventX_Local_PrintTo in the Printer field
of the “Upon Completion…” form (again, accessible by pressing Options on the Submit Request form):

Configuring Software Modules - AventX Print Xpress

Page 554 of 944
Proprietary to STR Software
Click the OK button on the Upon Completion… form, then Submit on the Submit Request form to begin your
concurrent request. After the request completes, the AventX Print Xpress client will pop up the following
prompt:

The AventX Print Xpress client pulls this list of printers from the Devices and Printers configured on your PC:

Select your desired printer from the list presented in the client and click the OK button. The AventX Print
Xpress client will print the concurrent request output to that printer from your PC.

Configuring Software Modules - AventX Print Xpress

Page 555 of 944
Proprietary to STR Software
Installation
AventX for Print Xpress can be installed either manually or pushed out through group policy. To install
manually, download the AventXClientInstall.<version>.msi to the user’s machine, then right-click and select
Install. To push the installation out through group policy, please consult with your Windows IT department.
The installation will automatically put a shortcut to launch the product on the user’s desktop and in the start
menu.

Note: Java Runtime Environment 1.8 is required.

Configuration
Oracle EBS Configuration

Creating the AventX Print Xpress Profile Options

AventX has several Oracle Profiles that need to be created. The following section provides information on the
purpose these profile options serve and how they are created and configured.

AventX System Profile Options

XXSTR_SEQNO

To use Automatic Delivery, Interactive Delivery (via the AventX Interactive Delivery form) or Stand Alone
Interactive Delivery (via the AventX Stand Alone Interactive Delivery form), it is necessary to create a new
profile option that will hold a unique sequence number for each report submitted to AventX via the
Concurrent Manager.

• Log in to Oracle Applications as the Application Developer responsibility.

• Select Profile in the left pane of the Navigator form window.

Configuring Software Modules - AventX Print Xpress

Page 556 of 944
Proprietary to STR Software
• Create a new profile option as shown:

For Application, select the custom application set up for AventX Oracle Connector (usually the application
name mapped to “AventX for Oracle EBS”).
• Select File, then Save from the top menu to save your changes.
Setting Up the AventX Print Xpress Forms

AventX Print Xpress creates several Oracle forms as part of the installation. These forms are compiled and
placed into the Oracle file system. They need to be registered in Oracle EBS so they can be used to configure
the AventX software.
Register the AventX Forms

Registering a form in Oracle E-Business Suite associates the form executable filename with a friendlier display
name for the form. The form must be registered before the menu item can be created. Follow these steps to
register the AventX forms:
• Log in to Oracle Applications with the Application Developer responsibility.
• Select Application, then Form to bring up the below form.

Configuring Software Modules - AventX Print Xpress

Page 557 of 944
Proprietary to STR Software
Use the following table to help with the data entry required when registering the AventX forms. For all forms,
the application should be the CUSTOM application, e.g, AventX for Oracle EBS, created in earlier steps, or if
the forms were put into $FND_TOP as part of the software installation, then you will want to use “Application
Object Library” for the “Application” field.

Form Application User Form Name Description

FCOAXCFG AventX for Oracle EBS AventX This form is used to configure common
Configuration configuration options.

FCOASTAT AventX for Oracle EBS AventX Delivery This form is used to display the delivery
Status status of documents processed via AventX.

FCOADIRP AventX for Oracle EBS AventX Direct Print This form is used to configure printers to
utilize the AventX Direct Print
functionality.
• Select File, then Save from the menu and close the Forms window.
Create the AventX Form Functions

The structure of Oracle EBS dictates that each menu item be linked to a Function. This Function is then
associated with the form so that selecting the menu item ultimately causes the form to activate. Follow these
steps to define a function for the AventX forms:

As Application Developer under Application, select the Function menu item. Choose the Description tab.

Description Tab

Configuring Software Modules - AventX Print Xpress

Page 558 of 944
Proprietary to STR Software
Enter data into the Description tab according to the table below:

Function User Function Name Description

FCOA_FCOAXCFG AventX Configuration AventX Configuration

FCOA_FCOASTAT AventX Delivery Status AventX Delivery Status

FCOA_FCOADIRP AventX Direct Print AventX Direct Print

Form Tab

Configuring Software Modules - AventX Print Xpress

Page 559 of 944
Proprietary to STR Software
Choose the Form tab at the top of the Form Functions form. Enter data into the Form tab according to the
table below (the Application field will populate automatically when a form is selected:

Function Form Application

FCOA_FCOAXCFG AventX Configuration AventX for Oracle EBS

FCOA_FCOASTAT AventX Delivery Status AventX for Oracle EBS

Configuring Software Modules - AventX Print Xpress

Page 560 of 944
Proprietary to STR Software
Properties Tab

Choose the Properties tab at the top of the form. Under Type, select Form for all entries that were added in
the steps above. Select File, then Save from the top menu and close the window.

Display the AventX Forms in the Oracle Navigator Menu

You must define menu items for any AventX forms you wish to grant access to. Menu items must be defined
for each responsibility you wish to have access. Menu items may have a prompt value, or be “hidden” (two
forms are triggered by View → Zoom). A typical menu item definition for the System Administrator
responsibility is provided below as an example. Since there are many items associated with AventX, we’ll use
a submenu.

• As Application Developer, under Application, select the Menu menu item.

Configuring Software Modules - AventX Print Xpress

Page 561 of 944
Proprietary to STR Software
• Create a new menu in the form below. This will become a new submenu for the “Install Menu”.

Using the table data below, fill out the Menu form and register the appropriate values:

Menu FND_NAVAVENTX4.0

User Menu Name AventX Menu - System Administrator GUI

Menu Type Standard

Description AventX for Oracle EBS submenu

The following is a text view of the table information on the Oracle Menus form:

Seq Prompt Submenu Function Description

10 System <blank> AventX Configuration AventX Configuration Form

Configuration

20 Delivery Status <blank> AventX Delivery Status AventX Delivery Status Form

30 Direct Printers AventX Direct Print AventX Direct Print Form

• Select File, then Save from the top menu.

Create the AventX Administrator Responsibility

Configuring Software Modules - AventX Print Xpress

Page 562 of 944
Proprietary to STR Software
It is recommended you create an “AventX Administrator” responsibility that allows certain individuals access
to configuration and troubleshooting forms. Use the following instructions to create an “AventX
Administrator” responsibility.

1. Log in as an Oracle EBS user with the “System Administrator” responsibility.

2. Select Security, then Responsibility, then Define.
3. Create the AventX Administrator responsibility similar to the following. This is only an example:

Configuring Software Modules - AventX Print Xpress

Page 563 of 944
Proprietary to STR Software
Add the newly created responsibility to the appropriate user(s) by selecting Security, then User, then Define,
then selecting AventX Administrator under the Responsibility field as shown below:

Menu Names for Common Responsibilities

Document Type Responsibility Menu Name

RFQ Purchasing Super User Purchasing SuperUser GUI

Purchase Order Purchasing Super User Purchasing SuperUser GUI

Sales Order Order Management Super Order Management Requests

User (ONT_REPORTS_REQUESTS_MENU)

Invoice Receivables Manager AR_PRINT_GUI

Statement Receivables Manager AR_PRINT_GUI

Select Application then Menu as System Administrator and query for the responsibility you desire to grant
access to the AventX Interactive Delivery, AventX Stand Alone Interactive Delivery, and AventX Delivery
Status forms. Below, we will use the PO_SUPERUSER_GUI menu as an example.

Configuring Software Modules - AventX Print Xpress

Page 564 of 944
Proprietary to STR Software
• Create a new record just below the last item in the list.
• Type the next available number in the Seq column.
• Leave the Navigator Prompt column blank.
• Choose AventX Stand Alone Interactive Delivery from the List of Values for the Function column.
• Type “AventX Stand Alone Interactive Delivery Form” in the Description column.
• Create a new record just below the last item in the list.
• Type the next available number in the Seq column.
• Leave the Navigator Prompt column blank.
• Choose AventX Interactive Delivery from the List of Values for the Function column.
• Type “AventX Oracle Connector Interactive Delivery Form” in the Description column.
• Create a new record just below the last item in the list.
• Type the next available number in the Seq column.
• Type “AventX Delivery Status” in the Navigator Prompt column.
• Choose AventX Delivery Status from the List of Values for the Function column.
• Type “AventX Oracle Connector Delivery Status Form in the Description column.
• Select File, then Save from the top menu and close the form.

Configuring Software Modules - AventX Print Xpress

Page 565 of 944
Proprietary to STR Software
AventX Configuration

The information in this section provides configuration instructions for the “Local Print” feature of the AventX
Print Xpress software.

Setting Up AventX Local Print Printers in Oracle EBS

Printer Drivers

New print drivers must be registered to support AventX Print Xpress. At least two print drivers are necessary
to support portrait and landscape output. To create the new print drivers:

• Log into Oracle Applications as the System Administrator responsibility.

• Select Install, then Printer, then Driver.
• Create the new print drivers in the form shown below as described:

Driver Parameters

AventX Local Portrait Driver Name: AventX Local Portrait

User Driver: AventX Local Portrait
Description: AventX Print Xpress for Portrait Orientation
SRW Driver: HPP
Deliver Method: Command
Driver Method: Spool File

Configuring Software Modules - AventX Print Xpress

Page 566 of 944
Proprietary to STR Software
 Arguments: $XXAVENTX_TOP/oa/fcprinto.sh
"$PROFILES$.PRINTER" "$PROFILES$.FILENAME"
"$PROFILES$.XXSTR_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "" "axlp" "none" "local" "portrait.cfg"
AventX Local Landscape Driver Name: AventX Local Landscape
User Driver: AventX Local Landscape
Description: AventX Print Xpress for Landscape Orientation
SRW Driver: HPL
Deliver Method: Command
Driver Method: Spool File
Arguments: $XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER"
"$PROFILES$.FILENAME" "$PROFILES$.FAX_SEQNO"
"$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "" "axlp" "none" "local"
"landscape.cfg"
AventX Direct Print Driver Name: AventX Direct Landscape
User Driver: AventX Direct Landscape
Description: AventX Direct Print Landscape Orientation
SRW Driver: HPL
Deliver Method: Command
Driver Method: Spool File
Arguments: $XXAVENTX_TOP/oa/fcprinto.sh
"$PROFILES$.PRINTER" "$PROFILES$.FILENAME"
"$PROFILES$.FAX_SEQNO" "$PROFILES$.TITLE" "$PROFILES$.ORG_ID"
"$PROFILES$.CONC_COPIES" "[LANG-PDF]" "invl" "none" "direct pdf"
Some of the parameters in the Arguments field may need to be customized for your environment. A
breakdown of the parameters in the arguments string, along with default/required values, is as follows:

Parameter Name Description / Valid Values

Path to the fcprinto.sh script. If not $XXAVENTX_TOP, the default

value to the left should be replaced with the custom top
$XXAVENTX_TOP/oa/fcprinto.sh environment variable that was created during installation. Failure
to do so will result in Warning errors when the Concurrent
Manager runs the reports to AventX Print Xpress printers.

The Oracle printer name. This value must be inserted exactly as

"$PROFILES$.PRINTER"
"$PROFILES$.PRINTER".

Configuring Software Modules - AventX Print Xpress

Page 567 of 944
Proprietary to STR Software
 The full path name of the output data file as assigned by the
"$PROFILES$.FILENAME" Concurrent Manager. This value must be inserted exactly as
"$PROFILES$.FILENAME".

A sequence number for this report passed from the Concurrent

"$PROFILES$.XXSTR_SEQNO" Manager. This value must be inserted exactly as
"$PROFILES$.XXSTR_SEQNO".

A combination of the request ID assigned by the

"$PROFILES$.TITLE" Concurrent Manager and Oracle user name that submitted the
report. This value must be inserted exactly as "$PROFILES$.TITLE".

The Oracle EBS Organization ID associated with the Organization

"$PROFILES$.ORG_ID" that created this document. This value must be inserted exactly as
"$PROFILES$.ORG_ID".

The number of copies passed from the Concurrent Manager. This

"$PROFILES$.CONC_COPIES"
value must be inserted exactly as "$PROFILES$.CONC_COPIES".

This parameter is not used with AventX Print Xpress. Use "" as a
"<AXUX commands>"
placeholder.

This parameter (axlp) can be arbitrary if not printing attachments.

"<document type>" If printing with attachments, the document should be configured

and the value specified should be a four letter document ID. See
section Creating a Document (Work Order).

This parameter is not used with AventX Print Xpress. Use "none" as
"<form method>"
a placeholder.

Used to indicate a special condition to the AventXPS process. For

AventX Print Xpress, this value must be set to "local".

If printing with attachments, the output type must be specified in

addition to “local”, for non-text output, and “nopasta” flag for text
output.

"<special>" Example:
• Print PDF output with attachments “local pdf”
• XML pass-through “local xml”
• Print Text output with attachments “local nopasta”. Note that
“nopasta” must be specified if printing text output with
attachments.
• Print PDF uncollated “local uncollate”

Configuring Software Modules - AventX Print Xpress

Page 568 of 944
Proprietary to STR Software
 For Text-based documents, AventX uses Oracle's Pasta executable,
FNDPSTAX, to convert the document to Postscript, which is then
converted to PDF. To supply the correct options to Pasta, this
parameter references a configuration file located in the
$FCHOME/local_print_driver directory. This directory comes with
two default configuration files which can be modified to support
your Pasta settings:
"<pasta_config_file>"
For portrait Text output, the default for this value is "portrait.cfg".
For landscape Text output, the default for this value is
"landscape.cfg".
Additional configuration files may be created in
$FCHOME/local_print_driver and referenced in the driver
argument string as necessary.
Be sure to save any changes to your print drivers before closing out the form. A bounce of the Standard
Manager may be necessary to apply changes to any AventX print driver strings.

Configuring Software Modules - AventX Print Xpress

Page 569 of 944
Proprietary to STR Software
Printer Types

A new printer type must be created to support AventX Print Xpress. Existing print styles must be paired with
AventX drivers to allow access to the AventX Print Xpress printers. To create the new printer type:

• Log into Oracle Applications as the System Administrator responsibility.

• Select Install, then Printer, then Types.
• Create the new printer type as shown in the screenshot below, being sure to save your changes
afterward:

The styles and drivers registered under the AventX Print Xpresser type may vary from customer to customer.
System administrators must register the AventX drivers and pair them within this form with existing printer
styles.

Printers

Three new printers can be created to support AventX Print Xpress. To create the new printers:

• Log into Oracle Applications as the System Administrator responsibility.

• Select Install, then Printer, then Register.
• Create the new printers as shown in the screenshot below, being sure to save your changes afterward:

Configuring Software Modules - AventX Print Xpress

Page 570 of 944
Proprietary to STR Software
Optional Miscellaneous Settings

▪ printxpress.disable.ip.check – Set to Yes if connecting via a proxy or gateway.

▪ aventxlocalprint.launch.newwindow – Set to Yes if running in mixed HTTPS mode.
▪ aventxlocalprint.auto.logout – Set to Yes if AventX users should be logged out automatically if no longer
in EBS.aventxlocalprint.minimize.on.start – Set to Yes if the AventX client should be minimized on start. 2
▪ aventxlocalprint.poll.interval – Set to value of preferred database poll interval.
▪ aventxps.use.ssl – Set to Yes if running in ssl mode (HTTPS).
▪ oracle.wallet.location – Location of the wallet if running in ssl mode (HTTPS).

2
AventX runs the following query behind the scenes to determine if <USER> has been logged out. When enabled, AventX will check
every 10 minutes. If a user has their ICX_SESSION_TIMEOUT profile value at a very high number and doesn’t log out gracefully, then
this could cause issues and potential break the auto-logout functionality because the AventX query will always return TRUE; which
indicates the user is still logged in.

SELECT CASE WHEN COUNT(distinct fu.user_name) > 0 THEN 'TRUE' ELSE 'FALSE' END user_logged_in
FROM icx_sessions icx, fnd_user fu
WHERE disabled_flag != 'Y'
AND icx.pseudo_flag = 'N'
AND ( last_connect + DECODE (fnd_profile.VALUE ('ICX_SESSION_TIMEOUT'),
NULL, limit_time, 0, limit_time, fnd_profile.VALUE ('ICX_SESSION_TIMEOUT') / 60 ) / 24
) > SYSDATE
AND icx.counter < limit_connects
AND icx.user_id = fu.user_id
AND USER_NAME != 'GUEST'
AND USER_NAME = '<USER>';
Configuring Software Modules - AventX Print Xpress
Page 571 of 944
Proprietary to STR Software
▪ webmgr.enabled – Set to No.
Concurrent Manager Tier(s) Configuration

Configure the $FCHOME/.fcoa_cfg_CMFORMHOST on the Concurrent Manager Tier(s) to have correct values
for the variables.

• cPASTA_EXE: the location of FNDPSTAX as executed by the applmgr user (or equivalent). This is likely
already in the applmgr user’s path. The default value is “FNDPSTAX”.
• cPS2PDF: location of ps2pdf as executed by applmgr (or equivalent).

Securing AventX with SSL over HTTPS

For users to run AventX Print Xpress over HTTPS, the following must be done to secure AventXPS, which runs
as a web server. See Appendix A Securing AventX with SSL over HTTPS for more information.

Preview and Printing Documents with Attachments

AventX Print Xpress also supports the ability to preview and/or print documents with attachments. This
feature allows users to store attachments with the primary document, i.e. Purchase Order, Work Order,
Invoice, Sales Order Acknowledge, etc. and have the software preview the primary document and
attachments as a PDF file before optionally printing. The user experience for AventX Print Xpress is the same
with or without attachments for submitting a request; the difference with attachments is that they will be
included in the preview/print output. (Note—Oracle eAM users should refer to “Previewing Work Orders
with Attachments” under the AventX for Oracle eAM section. The next section will provide information on
how to setup and configure this feature.

Setting Up AventX Print Xpress to Preview and Print Documents with Attachments

Using AventX Print Xpress with attachments requires the following:

• An AventX License Key that enables Attachment Xpress for EBS.

• Each unique document type must be configured to print attachments via the AventX Document
Configuration form.

Configuring Software Modules - AventX Print Xpress

Page 572 of 944
Proprietary to STR Software
Configuring Software Modules - AventX Print Xpress
Page 573 of 944
Proprietary to STR Software
• Each unique document type must be configured to extract attachment(s) via the AventX System
Configuration form.

• At least one valid AventX Translation Server host must be added to the Translation Servers tab of the
AventX System Configuration form. When connecting to the AventX Translation Server version 5.1.00 or
greater the information for the translation rest port will also be displayed.

Configuring Software Modules - AventX Print Xpress

Page 574 of 944
Proprietary to STR Software
Configuring Software Modules - AventX Print Xpress
Page 575 of 944
Proprietary to STR Software
• The relevant Printer Driver Arguments string must include the actual doctype (i.e. “pol” instead “axlp”)
and the value of “local” must be in the <special> parameter.

$XXAVENTX_TOP/oa/fcprinto.sh "$PROFILES$.PRINTER" "$PROFILES$.FILENAME" "$PROFILES$.FAX_SEQNO"

"$PROFILES$.TITLE" "$PROFILES$.ORG_ID" "$PROFILES$.CONC_COPIES" "" "pol" "none" "local pdf"

Configuring Software Modules - AventX Print Xpress

Page 576 of 944
Proprietary to STR Software
Disabling Unused Features

Some features of AventX for Oracle EBS are not applicable to stand-alone Print Xpress implementations. As
such it makes sense to disable these features when only configuring the Print Xpress module.

To disable these features, log in to Oracle EBS as the System Administrator Responsibility, select Install, then
AventX, then Configuration and navigate to the General Config tab:

Consult the following table for options that should be modified from default values. Scroll through the list of
configuration operations or query to find specific options to change and update them with the recommended
values.

Name Category Default Value Recommended Value

webmanager.enabled WEBMGR_SETUP Yes No

Configuring Software Modules - AventX Print Xpress

Page 577 of 944
Proprietary to STR Software
Configuring Software Modules - AventX Print Xpress
Page 578 of 944
Proprietary to STR Software
Uninstalling
To uninstall AventX Print Xpress, run the steps in the chapter “Removing AventX from Oracle EBS” below.
Once those steps are complete, the following additional uninstall steps are required:

From the Oracle EBS Home Page, click on the Personalize Page link in the upper right corner (Self Service
Personalization may need to be enabled):

Select the first ‘Personalize Properties’ icon on the following page:

Select the ‘Personalize’ icon next to ‘Page Layout: Oracle Applications Home Page’:

Configuring Software Modules - AventX Print Xpress

Page 579 of 944
Proprietary to STR Software
Click the ‘Inherit’ icon next to the field for Controller Class to revert to the originally defined controller class:

Click the Apply button in the upper right corner of the page, then the Return to Application link on the
bottom of the ‘Personalize Page: Oracle Applications Home Page’ page to exit self service
personalization.After removing the personalization, as the applmgr user (or equivalent), delete all files and
directories under $JAVA_TOP beginning with ‘xxstr’:
$ cd $JAVA_TOP
$ rm -rf xxstr*

It is imperative that this step be performed only after removing the self-service personalization, as doing so
beforehand will break the Oracle EBS Home Page.

To remove all front-end configurations pertaining to AventX Print Xpress:

• As Application Developer, navigate to Profile, then query for and delete all profiles matching ‘XXSTR%’.

Configuring Software Modules - AventX Print Xpress

Page 580 of 944
Proprietary to STR Software
• As System Administrator, navigate to Security, then Responsibility, then Define, query for the AventX
Administrator responsibility, then specify an end date (Oracle EBS responsibilities may not be deleted):

• As System Administrator, navigate to Install, then Printer, then Register, then query for and delete all
printers matching ‘AventX_Local%’ (this should include the AventX_Local_Preview, AventX_Local_Print,
and AventX_Local_PrintTo printers).
• As System Administrator, navigate to Install, then Printer, then Types, then query for and delete the
AventX Local printer type.
• As System Administrator, navigate to Install, then Printer, then Driver, then query for and delete all
printer drivers matching ‘AventX Local%’.
End users can remove AventX Print Xpress client files from their PCs by deleting the C:\Users\<windows-
username>\AppData\Local\Temp\AventX_tmp directory.

Configuring Software Modules - AventX Print Xpress

Page 581 of 944
Proprietary to STR Software
Troubleshooting
Server-Side General Troubleshooting

Troubleshooting AventX Print Xpress is very similar to troubleshooting the standard AventX product:

• Log files can be found within $FCHOME/oa/database/<SID>/log.

• Final delivery status (including error codes in the event of failure) is reported within the AventX
Delivery Status Form.

In addition to these troubleshooting strategies, the following are unique to AventX Print Xpress:

• The $FCHOME/oa/database/<SID>/print directory houses output files which are ready to print.
• $FCHOME/oa/database/<SID>/log/serveraccess.log contains a record of all requests to the AventX
web server, IP address and method.
• The database table XXSTR_DESKTOP_DATA records where requests to print/preview go, and
references back end file stored in $FCHOME/oa/database/<SID>/print.
• It is also possible to enable debugging of the AventX controller(s) within Oracle EBS. See the section
“Enabling Debugging for further Troubleshooting” above for instructions.

Client-Side Java Issues

The following is a list of recommended strategies if users are having trouble getting the Java client to work:

▪ Oracle EBS will install a Java plugin to launch forms if the right version is not installed. It is important to
note if EBS deployed a 32-bit or 64-bit version of the Java Runtime Environment (JRE). This will control
which version (32 or 64-bit) is launched via your browser when starting the local print client.
▪ Ensure that the version of Java used by EBS is the latest build. For instance, and EBS environment may
install Java 1.6.07 when launching forms, but the latest version from Oracle is at least 1.6.45. The local
print client may not work with the Java version installed by EBS, so the JRE will need to be manually
upgraded. When manually upgrading, match the bit-version of the plugin installed by EBS.
▪ Uninstall all unnecessary versions of Java. Users may have the latest versions of Java 6, 7, 8, etc., but
should not have 1.6.07 and 1.6.45 installed, for example.
▪ Verify no old versions of Java are in your path. Older Java binaries may remain in C:\Windows\System32
and/or C:\Windows\SysWOW64 - these should be removed.
▪ A reboot may be required after making all the Java changes.
▪ In some cases, it may be necessary to clear the Java cache. This may be done from the Java control panel
in control panels.

Configuring Software Modules - AventX Print Xpress

Page 582 of 944
Proprietary to STR Software
Client-Side General Troubleshooting

The C:\Users\<windows-username>\AppData\Local\Temp\AventX_tmp directory is created on a user’s PC

while the AventX Print Xpress client is running. This directory will contain the following:

▪ All files that have been previewed/printed

▪ aventx.log
▪ aventx_bak.log
▪ xxstrPrinter.exe (Executable to print files)
▪ xxstrPrinter.log
▪ xxstrPrinter_bak.log

A few notes regarding the lifespans of these files:

▪ Files to print and preview will be deleted when the program exits.
▪ Supporting files will be deleted upon startup.
▪ Logs will not be purged.

Handling Excel Output

When Oracle EBS generates Excel output through BI Publisher, it actually generates HTML. When the AventX
Print Xpress client tries to open the HTML, users will likely get the following warning from Excel:

Users can hit Yes and the file will open as expected. This warning can also be permanently disabled via Group
Policy or a registry edit, as described in this Microsoft Knowledge Base article:
https://support.microsoft.com/en-us/kb/948615.

Configuring Software Modules - AventX Print Xpress

Page 583 of 944
Proprietary to STR Software
Migrating from Unitask Output Director to AventX Print Xpress
Local Print

Co-Existing Applications

It is possible for AventX Print Xpress to run concurrently with Unitask Output Director in an Oracle EBS
environment. AventX Print Xpress can be invoked by submitting concurrent requests to the
AventX_Local_Preview, AventX_Local_Print, and AventX_Local_PrintTo printers instead of registered Unitask
printers and will not interrupt existing functionality.

Migrating Output Director Configuration to AventX Print Xpress

The query below can be used to determine the most commonly used Unitask printer styles in your
environment:

select distinct print_style from fnd_concurrent_requests where printer like 'LOCAL_%';

Searching for the printer type “XXLPRLOCAL” will provide a concise list of style/driver combinations that will
need to be migrated to AventX Print Xpress.

STR Software recommends copying the PASTA_PARAMS portion of each Unitask printer driver arguments
string to the configuration file referenced in the equivalent AventX Print Xpress printer driver. For example,
given the following Unitask printer driver for portrait output:

The highlighted section of text should be copied into $XXAVENTX_TOP/oa/local_print_driver/portrait.cfg on

the Concurrent Manager tier. Thus, the contents of portrait.cfg would read:
## Environment file that will allow flexibility with driver
Configuring Software Modules - AventX Print Xpress
Page 584 of 944
Proprietary to STR Software
## strings.
##
## PASTA_PARAMS: Set to parameters to use when executing PASTA
PASTA_PARAMS="-np -s12 -h0.9"
export PASTA_PARAMS

This file is referenced in the equivalent AventX Print Xpress printer driver for portrait output:

Specifying the identical SRW Driver and PASTA_PARAMS values when comparing Unitask Output Director and
AventX Print Xpress ensures consistent behavior between products during the migration. Use the query
below to determine these values for all existing Unitask printer drivers:

select printer_driver_name, user_printer_driver_name, srw_driver, arguments from apps.fnd_printer_drivers

where arguments like '%localprint.sh%';

Identifying Output Printer Usage and Deleting Output Director Printers

The following SQL may be helpful in identifying which users had Unitask printers set as their default printer:

select USR.USER_NAME from fnd_profile_option_values PFO, fnd_user USR

where PFO.level_value = USR.USER_ID

--and USR.END_DATE is null

and application_id = '0'

and PROFILE_OPTION_ID = '109'

Configuring Software Modules - AventX Print Xpress
Page 585 of 944
Proprietary to STR Software
and LEVEL_ID = '10004'

and PROFILE_OPTION_VALUE like 'LOCAL_PR%';

If your request sets were implementing using Unitask printers then the printers will have to be removed from
the requests before the printers can be deleted. The following SQL may be helpful in identifying these
request sets:

select r.user_request_set_name, s.user_stage_name,

c.user_concurrent_program_name

from fnd_request_sets_tl r, fnd_request_set_stages_tl s,

fnd_request_set_programs p,

fnd_concurrent_programs_tl c

where p.request_set_ID = r.request_set_ID

and p.request_set_stage_id = s.request_set_stage_id

and p.concurrent_program_id = c.concurrent_program_id

and printer = 'LOCAL_PREVIEW';

Uninstalling Output Director

It is recommended to uninstall the Output Director product using the software’s product documentation. If
access to the product documentation is not available then the following uninstall framework can be
considered for use in your environment.

Configuring Software Modules - AventX Print Xpress

Page 586 of 944
Proprietary to STR Software
Removing Custom Controllers

One of the concerns organizations have with running both Output Director and AventX Print Xpress together
is whether user’s will receive multiple pop ups if both applications are installed.

Most add-ons to Oracle EBS that invoke additional functionality via forms personalization do so using a
custom controller. Like AventX, custom controllers can be implemented throughout various parts of the user
experience.

The following information helps in outlining the steps to removing a custom controller that was configured
for use via personalization from the Oracle EBS home page. In this example the custom controller was
implemented on the following personalization path.

Configuring Software Modules - AventX Print Xpress

Page 587 of 944
Proprietary to STR Software
Delete the entry in “Controller Class” field if it exists. Save the changes and exit out of forms personalization
and verify the controller was deleted.

Executing Uninstall Scripts

Most third party software products for Oracle EBS have uninstall scripts that can be executed to remove its
software from Oracle EBS. Use the following to locate the uninstall script that can be used to uninstall the
Unitask application.

• Log into the file system where the Unitask software exist and execute the following find command.

$ cd /

$ find -iname "uninstall*.sh"

This command should locate any file that has the string of text of “uninstall*.sh” in the file name.

• Execute the uninstall file.

$./<filename>

Configuring Software Modules - AventX Print Xpress

Page 588 of 944
Proprietary to STR Software
Configuring Software Modules - AventX Print Xpress
Page 589 of 944
Proprietary to STR Software
System Administration
This section provides information on how to administrator the AventX for Oracle EBS software. This section
will contain information relevant to multiple product modules. Information in this section will be properly
labeled for the specific module it applies to if necessary.

Product Versions

Determining the Product Version

The version.sh script is in the $FCHOME/oa/ins directory, and is a useful tool for determining the version of
AventX Oracle Connector scripts and the version of AventX Translation Server associated with each specific
instance.

Before running version.sh, you must have run Step 2 of $FCHOME/oa/ins/setup.sh to have properly set
execute permissions on the files needed by version.sh.

version.sh does not require any parameters. A sample execution of the script is as follows;

./version.sh

<version number and name of each component appears here>

AventX Core: 1.0.14

version.sh first displays information regarding practically every component (scripts, stored procedures,
etc) of AventX. The version number and name of each component is displayed. Next, the version of AventX is
displayed. AventX does not have to be running to display the version.

Determine the AventX Forms Versions

version_forms.sh is a script used to determine the version of AventX forms that are presently in use on a
given forms server. This script is most useful when attempting to troubleshoot problems with AventX forms
after installing, upgrading, cloning, or after changing or adding a forms server.

The version_forms.sh script is included as part of the oa.formhost.tar file which is created during Step 7 of
setup.sh. The oa.formshost.tar file is located under $FCHOME/oa, and is to be manually copied to the forms
server(s) as part of the initial installation of AventX.

After the oa.formhost.tar file has been untarred on the forms server and the forms compiled and copied to
their proper location, the version_forms.sh script, located under the oa/ins directory can be run at any time.
The script does not require any parameters, but upon execution of the script you are prompted for the path
name of where the compiled forms reside. A sample execution of the script follows:

./version_forms.sh

Enter the path for the AventX(tm) forms:

System Administration - Product Versions
Page 590 of 944
Proprietary to STR Software
$FND_TOP/forms/US

By default, the script looks in $AU_TOP/resource for the FCOA.pll file. If the compiled forms do not
exist in the path specified, the following types of errors will be displayed:

strings: '/tmp/FCOAAYOD.fmx': No such file

FCOAAYOD

strings: '/tmp/FCOASAID.fmx': No such file

FCOASAID

strings: '/tmp/FCOASBMT.fmx': No such file

FCOASBMT

strings: '/tmp/FCOASTAT.fmx': No such file

FCOASTAT

strings: '/tmp/FCOATEST.fmx': No such file

FCOATEST

strings: '/tmp/FCOAXCFG.fmx': No such file

FCOAXCFG

strings: '/tmp/FCOAWOPT.fmx': No such file

FCOAWOPT

Additionally, the version_forms.sh script will only display versions of AventX forms that are version 7.10.02 or
higher. An attempt to use version_forms.sh on older versions of AventX forms will result in output like the
following:

FCOAAYOD Revision: 1.0

FCOASAID

FCOASBMT

FCOASTAT

FCOATEST Revision: 115.12

FCOAXCFG Revision: 1.0

System Administration - Product Versions

Page 591 of 944
Proprietary to STR Software
FCOAWOPT Revision: 115.12

System Administration - Product Versions

Page 592 of 944
Proprietary to STR Software
Forms and Field Descriptions
This section provides information on the details of each AventX form and the purpose of each field, tab, and
button.

Configuration Form
The information in this section will provide an overview of the tabs on the AventX Configuration form.

Tools Tab

The Tools tab is a main menu for System Administrators to perform common operations within the AventX
software. The buttons on this tab are discussed in more detail below.

Find/Add Button

This button is used to add or find an Org Id’s AventX configuration. You do not need to configure all
organizations in AventX. Only Org Id “0” (Setup Business Group) is required. See the “Setting Up Default
Organization Configuration” section of this guide for more on this topic.

Delete Button

This button is used to remove an existing Org Id’s AventX configuration.

System Administration - Forms and Field Descriptions

Page 593 of 944
Proprietary to STR Software
List Configured Organizations Button

This button is used to display a list of all configured Org Id’s and their associated document types. This is the
fastest way to see which Org Id’s are currently configured to use AventX.

Get Logs Button

This button is used to retrieve logs from the AventX host server for troubleshooting and/or diagnostic
purposes. See the “Troubleshooting” section for more on this topic.

Apply Configuration Changes Button

This button allows you to synchronize changes from the AventX configuration to the AventX document
processing engine that runs as a service in the operating system. Most configuration settings are applied
automatically by simply clicking the Oracle “Save” icon. Same configuration settings require you to click the
“Apply Configuration Changes Button” to take effect. The fields that require the action of clicking the button
should have the instructions to perform this step in the “Description” field. Click the button will trigger the
back-end process to reload configuration when it is idle.

To help be precise the following is a list of configuration settings that require you to click this button to apply
the changes.

• The “error.mail.address” parameter on the “General Config” tab.

• All configuration changes on the “AventX Translation Server” tab.
There are also a few configuration changes that will never be applied unless the back-end process is bounced
from the command line. This is because these settings are required to make the overall system work.

• HTTP port
• Number of scanner/printer/translation threads/workers
If you see the following error message then please consult KB Article # 17102 for more information how to
resolve the issue.

System Administration - Forms and Field Descriptions

Page 594 of 944
Proprietary to STR Software
Export Config Button

This button is used to export and preserve the existing AxentX schema data (e.g. XXAVENTX) into a single zip
file. See the “AventX Oracle Connector Cloning Guide” for more details.

Import Config Button

This button is used to import a previously exported AxentX schema data file. See the “AventX Oracle
Connector Cloning Guide” for more details.

Manage AventX Queue Button

This button is used to launch the AventX WebManager application to manage aspects of the AventX Queue.
See the “AventX WebManager Resource Guide” for more details.

Configure a Document

This button is used to launch the AventX Document Configuration form form. See the “Setting Up
Documents” section of this guide for more details.

View Document Status

This button is used to launch the AventX Delivery Status form. See the “Viewing Document Transmission
Status” section of this guide for more details.

View Back-End Status

This button shows a list of known AventX host servers, the port they are listening on, and their current status
as shown in the following screenshot.

System Administration - Forms and Field Descriptions

Page 595 of 944
Proprietary to STR Software
General Config Tab

This tab contains a series of global configuration parameters that control the default behavior for specific
aspects of the AventX software. Each row contains a Name, Category, and Value column. The entries are
sorted alphabetically by Category and Name. Highlighting each row will display a detailed description at the
bottom of the form explaining the functional purpose and supported values.

System Administration - Forms and Field Descriptions

Page 596 of 944
Proprietary to STR Software
Attachment Printing Config Tab

This tab contains configuration parameters specific to the printing of reports with attachments (AventX
Attachment Xpress). Each row contains a Name, Category, and Value column. The entries are sorted
alphabetically by Category and Name. Highlighting each row will display a detailed description at the bottom
of the form explaining the functional purpose and supported values.

System Administration - Forms and Field Descriptions

Page 597 of 944
Proprietary to STR Software
Printers Tab

This tab is used to optionally configure printers defined on the AventX host. The values are a subset of those
contained on the General Config tab; it is only necessary to add rows on this tab if a printer requires different
configuration than those provided by the global defaults (for example, a different lp command or argument).
Each row contains a Name, Category, and Value column. The entries are sorted alphabetically by Category
and Name. Highlighting each row will display a detailed description at the bottom of the form explaining the
functional purpose and supported values.

System Administration - Forms and Field Descriptions

Page 598 of 944
Proprietary to STR Software
Translation Servers Tab

This tab is used to define an AventX Translation Server, a Windows or Linux server used when printing reports
with attachments (AventX Attachment Xpress). The “Translation Server Hostname” field is free form and
should contain the DNS name of the AventX Translation Server (as resolvable from the AventX host). When
connecting to the AventX Translation Server version 5.1.00 or greater the information for the translation rest
port will also be displayed. Multiple AventX Translation Servers can be defined for High Availability (HA)
and/or failover purposes.

System Administration - Forms and Field Descriptions

Page 599 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 600 of 944
Proprietary to STR Software
Web Attachment Types Tab

This tab is used to associate attachment filename extensions with the appropriate MIME type. See the
“Oracle Attachments” section of this guide for more details.

License Keys Tab

AventX requires a valid license key for proper installation and execution. This key is tied to the following
pieces of information:

• Production or Non-Production License

• Database Name (select name from v$database;)
• Product Module
• Expiration Date
• Business Entity

System Administration - Forms and Field Descriptions

Page 601 of 944
Proprietary to STR Software
Document Configuration Form
There are several approaches to completing the document configuration phase of the AventX
implementation. The main decision to make at this point is to determine if you will want to use the AventX
“seeded” (aka pre-installed) document configuration information or if you will create your own document
configuration.

There are pros and cons to using the “seeded” documents and queries versus creating your own. Please read
these pros and cons prior to making a decision on which one to use.

Seeded Documents and Queries (Pros and Cons)

• Pros
o Recipient and other queries (acknowledgement, attachment, archive, and sender) do not need to
be created.
• Cons
o Seeded queries require specific data entry requirements. See the section “Seeded Queries and
Data Entry Requirements” for more information.
Creating New Documents and Queries (Pros and Cons)

• Pros
o Flexibility – using queries of your own creation will allow you to personalize them to your
company’s needs.
• Cons
o Query Creation – Recipient and other queries (acknowledgement, attachment, archive, and
sender) may need to be created and maintained. However, STR Software provides a repository of
queries in our Support Portal to help with the creation of these queries.

System Administration - Forms and Field Descriptions

Page 602 of 944
Proprietary to STR Software
Seeded Documents and Queries

AventX ships with several standard document types for both Interactive and Automatic Delivery “out of the
box”. These document types are:

▪ Default
▪ Invoice
▪ Purchase Order
▪ Purchase Order Approval
▪ Request For Quotation
▪ Sales Order Acknowledgement
▪ Statement
▪ Work Order
These documents also have “seeded” queries that help to quickly implement business requirements. Seeded
queries require specific data entry requirements. See the section “Seeded Queries and Data Entry
Requirements” for more information about the data entry that is required to use these seeded queries.

System Administration - Forms and Field Descriptions

Page 603 of 944
Proprietary to STR Software
Seeded Document Integration Requirements

The following table provides a summary of the integration requirements for using the seeded
documents/queries that come with AventX Oracle Connector.

Document Type Automatic Delivery Interactive Delivery Oracle Requirements

Requirements Requirements
Purchase Orders Report output must Report name must po_headers_all.segment1
from Submit Request provide the match a configurable must contain the document
document number. value (e.g., ‘Purchase number.
▪ Standard Order’). po_headers_all.type_lookup_c
▪ Blanket Parameter list for ode must be one of 'Standard',
▪ Contract report must provide 'Blanket', 'Contract' or
▪ Planned document number. 'Planned'.

Purchase Order Not Applicable – Not Applicable – FND_CONCURRENT_REQUESTS

from Workflow See Purchase See Purchase Orders .ArgumentN fields must
Orders from Submit from Submit Request contain a value indicating that
Request the document is enabled for
fax (or email) delivery, and
must contain the fax number
(or email address) of the
destination.

Data file must contain the

document number and revision
number.

If data file contains FCL

commands, the tags containing
the document number and
revision number must appear
on the first line of the data file.
For email delivery, Oracle
workflow must be modified to
include AventX Oracle
Connector as part of the
workflow process for Purchase
Order Approval.

System Administration - Forms and Field Descriptions

Page 604 of 944
Proprietary to STR Software
Document Type Automatic Delivery Interactive Delivery Oracle Requirements
Requirements Requirements
Sales Order Report output must Report name must oe_order_headers_all.order_n
Acknowledgements provide the match a configurable umber must contain the
document number. value (e.g., ‘Sales document number.
Order’).
Parameter list for
report must provide
document number.
Invoice Report output must Report name must ra_customer_trx_all.trx_numb
provide the match a configurable er must contain the document
▪ Standard document number. value (e.g., ‘Invoice’). number.
▪ Commercial Parameter list for
report must provide
document number.

Statement Report output must Not Applicable ar_customers.customer_numb

provide the By Oracle design – er must contain the document
customer number statements are not number.
and address1 intended to be hz_locations.address1 must
information. processed in this contain address1 for the
manner. customer site.
Request for Report output must Not Applicable po_headers_all.segment1
Quotations provide the By Oracle design – must contain the document
document number RFQs are not intended number.
▪ Standard and vendor id. to be processed in this po_headers_all.type_lookup_c
▪ Catalog manner. ode must be 'RFQ'.
po_vendors.segment1 must
contain the supplier number.

System Administration - Forms and Field Descriptions

Page 605 of 944
Proprietary to STR Software
Creating a New or Modifying an Existing Document

The Customer Support Portal provides the following knowledge base articles that will also help supplement
the information in this section.

1. KB Article # 16881 - How to determine what the seeded AventX Oracle Connector queries do
2. KB Article # 16880 – How to troubleshoot PL/SQL errors

The “AventX Document Configuration” form is used to create or modify existing documents that are
configured in AventX. It can be used if the seeded documents and their queries do not meet your
requirements or the flexibility of creating or modifying existing queries if required, then consider using this
feature to add new documents or modify configuration and queries for the following document delivery
requirements.

Query Type Description

Document Options Used to specify document delivery options such as template or form to apply,
Query(s) hold status, or Terms and Conditions file to include

Recipient Query(s) Used to extract a fax number, email address, or printer name to deliver the
document

Acknowledgement Used to extract an email address to send a report via email to acknowledge
Query(s) the delivery or failure of the document

Attachment Query(s) Used to extract attachments associated with the document

Archive Query(s) Used to extract information necessary to archive documents to a folder

Sender Query(s) Used to extract e-mail and name information regarding the sender of the
document

System Administration - Forms and Field Descriptions

Page 606 of 944
Proprietary to STR Software
 Query Type Description

Command Query(s) Used to pass additional AventX UNIX commands for advanced integrations
There are two basic requirements that are necessary for AventX to process any document type; report
output, and destination information. The report output is simply the Oracle EBS information created for the
document type, based on the report and submission parameters specified by the user. It may also include a
message template, terms and conditions, or form application for the data. The destination information
consists of, at a minimum, the fax number or email address to which the document should be delivered. It
may also include message template remarks, “from” and “to” information, subject, etc.

To specify a new document definition, type the document name in the entry box. This alphanumeric field has
a limit of 50 characters, and certain characters (~`!@#$%^&*()+=|][{}:;'"<>.,/?) are not allowed in the name.

AventX ships with pre-configured document types of Invoice, Purchase Order, RFQ, Sales Order, Statement,
and Work Order. Therefore, when creating a new document definition, if using the document names as part
of your new document, it is recommended you include a prefix string BEFORE the actual document name. For
example, creation of a new Purchase Order document called “STR Purchase Order”.

To view/edit/delete an existing document, use the list of values.

System Administration - Forms and Field Descriptions

Page 607 of 944
Proprietary to STR Software
The Find/Add button will bring up the existing document definition, or prompt you to create a new one if one
by that name does not exist (see screenshot below). The Delete button will prompt you to delete the existing
document definition. Seeded document types cannot be deleted.

Click Yes to create a new document type.

System Administration - Forms and Field Descriptions

Page 608 of 944
Proprietary to STR Software
Document Info Tab (Required)

Fill in the fields on this canvas to define the “Document Information” (required for Automatic and Interactive
Delivery) and “Interactive Delivery Properties” (required for Interactive Delivery):

Field Descriptions

The following provides the fields on this tab and their descriptions:

Field Value

Document
Information

Document Type This alphanumeric field has a limit of four characters. The value will be used by
AventX for report separation and document recognition when using Automatic
Delivery.
Document Type is discussed in further detail later in this chapter.
For our example, we’ll specify “srap” for Separate Remittance Advice, Portrait.

Subject Template This alpha-numeric field has a limit of 256 characters (when expanded) and supports
the use of “tokens” :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID, :BI_SUBJECT,
and/or :SENDER_USERID. When “tokens” are used, the token is replaced by its value
to determine the “final” value for the subject.

System Administration - Forms and Field Descriptions

Page 609 of 944
Proprietary to STR Software
Field Value
For Interactive Delivery, the values for :UID1, :UID2 and :UID3, :UID4, :UID5,will
come from the parameters form for the report, which is described later in this table.
For Stand Alone Interactive Delivery, the values for :UID1 - :UID5 come from forms
personalization parameters as set by the System Administrator during the forms
personalization configuration process.
For Automatic Delivery, the values for these tokens are extracted from the report
output and passed back to the command file generator for use in the queries, or in
this case, to be used in the subject. For formatted report output (e.g., PDF), the
values are specified in the FAX_INFO strings (e.g.
FAX_INFO:<UID1>:<UID2>:<UID3>:<UID4>:<UID5>:), which are described in the
chapter, “Setting Up Formatted Documents for Automatic Delivery”.
For Delivery Manager functionality, the values for these tokens (:UID1 - :UID5, :UID4,
:UID5) are extracted from the DM_FAX_INFO tag in the report output and passed
back to the command file generator for use in the queries, or in this case, to be used
in the [SUBJECT= command. For text and formatted report output (e.g., PDF), the
values are specified in the DM_FAX_INFO strings (e.g.
DM_FAX_INFO:<request_id>:<doc_type>:<pCOMMAND>:<pPRNFORM>:<pSPECIAL>
:<UID1>:<UID2>:<UID3>:<UID4>:<UID5>:), which are described in the chapter,
“Setting up Documents for Delivery Manager Functionality”.
For Delivery Manager functionality, the value for the :BI_SUBJECT token is extracted
from FAX_DM_DATA.SUBJECT. This value is what was provided by the Delivery
Manager, as entered on the Delivery Opts form, during the submission to AventX.
If the Subject value is set to :BI_SUBJECT and the document is processed using
Automatic or Interactive Delivery, the Subject value is replaced with "<Document
Name> #<UID1>" (e.g., Purchase Order #1169).
The :UID1 - :UID5, :UID4, and :UID5 tokens have a maximum length of 255
characters. The :BI_SUBJECT field has a maximum length of 80 characters. The
:REQUESTID, :ORGID, and :SENDER_USERID values are NUMBER values.
The following characters are stripped from the SUBJECT value before submission to
AventX UNIX:
\[]
The value returned, which is assigned to the [SUBJECT= command, is truncated to 80
characters. This value is displayed on the AventX Interactive Delivery form, in the
AventX Reports and on the AventX Delivery Status form and can be displayed on the
delivery message template as well.

Printed Page Stamp This field specifies a string of up to 132 characters to be passed to AventX
Translation Server for use (as the %u1 placeholder) in the page stamp on each page

System Administration - Forms and Field Descriptions

Page 610 of 944
Proprietary to STR Software
Field Value
of a print job. Therefore, this field is used only for Printed Delivery and printing of
Oracle Attachments.

The Printed Page Stamp field supports the use of “tokens” :UID1, :UID2,:UID3, :UID4,
:UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID. When tokens are used, they
are replaced by their value here to determine the “final” value.
The :UID1 - :UID5, :UID4, :UID5 tokens have a maximum length of 255 characters,
and are extracted from the FAX_INFO tag.
The :REQUESTID, :ORGID, and :SENDER_USERID values are NUMBER values.

Email Attachment This field is used to specify the name applied to the delivery output file when it is
Name emailed by AventX.
This field will accept all of the tokens that apply to Subject Template above: :UID1 -
:UID5, :UID4, :UID5, :REQUESTID, :ORGID, :BI_SUBJECT, and/or :SENDER_USERID.
The attachment file extension is determined by the language command passed
down in the print driver. STR Software recommends against hard-coding an
attachment extension in this field.

Interactive Delivery Fields in this section of the canvas will apply only to Interactive Delivery and Stand
Properties Alone Interactive Delivery submissions to AventX. If you are not going to use either
of these methods for this document type, you do not need to fill out these fields.

Default Picklist This field determines what the default pick list will be when the Interactive Delivery
form is opened. Valid values are:
▪ Customers by Company – the pick list will contain all customer contacts sorted by
company.
▪ Customers by Name – the pick list will contain all customer contacts sorted by last
name.
▪ Employees – the pick list will contain email addresses for all employees (as defined
in the Oracle EBS Human Resource tables) with a type of “EMP” or “EMP_APL”.
▪ Users – the pick list will contain all Oracle EBS users.
▪ Vendors – the pick list will contain all vendors (site level) sorted by company.
▪ Vendor Contacts –the pick list will contain all vendor contacts sorted by last name.
For more information on the AventX Interactive Delivery form, consult the AventX
Oracle Connector User’s Guide.

Report Name This alphanumeric field has a limit of 256 characters and defines all or a portion of
the actual report name specified on the Submit Request form, to be used to match
against in the configuration.

System Administration - Forms and Field Descriptions

Page 611 of 944
Proprietary to STR Software
Field Value
For example, if the report name on the Submit Request form is “Separate
Remittance Advice”, the value in this field could be “Remittance”, “Remittance
Advice”, “Separate”, etc.
If the value specified here does not match a portion of the report name on the
Submit Request form, the AventX Interactive Delivery form will display an error upon
opening.

Report Parameter 1 This numeric field (value 1-50) specifies the position of the parameter that will be
the “FROM” value in the range for determining :UID1.

For our example for “STR Purchase Order” the parameters from the concurrent
program for “P_po_num_from” and “P_po_num_to” will be referenced in “Report
Parameter 1” and “Report Parameter 2”.

System Administration - Forms and Field Descriptions

Page 612 of 944
Proprietary to STR Software
Field Value

This field is required if Report Name is specified; it is not used otherwise.

Report Parameter 2 This numeric field (value 1-50) specifies the position of the parameter that will be
the “TO” value in the range for determining :UID1. For our example for Separate
Remittance Advice from the Submit Request form, we would specify “1” (there is no
range).
Interactive Delivery is designed for use with single documents (normally a range or
batch of documents are not intended for the same supplier/customer). If the value
for Report Parameter 2 is different than that for Report Parameter 1, the AventX
Interactive Delivery form will display an error when opened.
This field is required if Report Name is specified; it is not used otherwise.

Report UID2 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID2. For our example for Separate Remittance Advice from the
Submit Request form, we would specify “2” (the Payment Number).
This field is optional if Report Name is specified; it is not used otherwise.

Report UID3 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID3. For our example for Separate Remittance Advice from the
Submit Request form, we do not need this parameter, so we would leave it blank.
This field is optional if Report Name is specified; it is not used otherwise

Report UID4 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID4. For our example for Separate Remittance Advice from the
Submit Request form, we do not need this parameter, so we would leave it blank.
This field is optional if Report Name is specified; it is not used otherwise

System Administration - Forms and Field Descriptions

Page 613 of 944
Proprietary to STR Software
Field Value

Report UID5 This numeric field (value1-50) specifies the position of an additional parameter that
will be used for :UID5. For our example for Separate Remittance Advice from the
Submit Request form, we do not need this parameter, so we would leave it blank.
This field is optional if Report Name is specified; it is not used otherwise

System Administration - Forms and Field Descriptions

Page 614 of 944
Proprietary to STR Software
General Configuration Tab

This canvas allows you to specify AventX configuration values specific to this document type. An explanation
of what each configuration value does (as well as possible values, where relevant) is available by selecting the
row and viewing the Description field at the bottom of the form.

The General Configuration tab comes prepopulated with default values which will work for the most common
submission types (i.e., PDF output). Contact STR Software support if you require additional assistance
configuring this tab.

For this example, we will use the default values that come prepopulated and move on to the next tab.

The AventX General Document configuration tab features a disable.print.ack.generation configuration that
allows a user to prevent an update to the delivery status table of a printed document. The reason behind this
value is to allow users to generate their own acknowledge files to decide when a document truthfully has
been delivered. This is done through the “process_ack.sh” script located in $FCHOME/oa/util. With a custom
lp.command (which can also be set on the document configuration), a user can call out to a custom script to
create an acknowledgement file to update the status in the delivery status form.

System Administration - Forms and Field Descriptions

Page 615 of 944
Proprietary to STR Software
Standalone Delivery Tab

This form addresses configuration settings for this document type related to Stand Alone Interactive Delivery.
If you will not be using Stand Alone Interactive Delivery, proceed to the next tab.

You should configure all other canvases and ensure that you have valid configuration for this document type
before proceeding to configure Stand Alone Interactive Delivery.

For instructions on how to properly configure this tab of the Add Document form, consult the section “Using
the Interactive Delivery Form from Oracle Menu”.

System Administration - Forms and Field Descriptions

Page 616 of 944
Proprietary to STR Software
Doc Option Query Tab

This tab is optional. It allows you to create queries that can be used to determine options for delivering your
document, such as a template or form to apply, whether to place the document in a hold state before
delivery, or whether to include a specified terms and conditions file. A Document Options query is only
necessary when these options can’t be set on a per organization, per user, or per buyer basis.

System Administration - Forms and Field Descriptions

Page 617 of 944
Proprietary to STR Software
To create a new Document Options query, select New Query.

System Administration - Forms and Field Descriptions

Page 618 of 944
Proprietary to STR Software
Fill in the fields on this canvas to define the document options query. Required fields are yellow. These fields
are described below:

Field Value

Query Name This (required) alphanumeric field has a limit of 16 characters and defines the value
that is displayed in the Doc Option query pick list on the AventX Configuration form
for this document type.

Query Description This (optional) alphanumeric field has a limit of 255 characters and is simply a
description for the Query Name field.

Select Distinct Use the “distinct” checkbox to specify that option to the select statement for the
query. For more information on SQL statements, refer to the appropriate Oracle
documentation.

Template Name This (required) field is used to determine the fax cover page or email body template
to be applied to the document. Valid values are the names of template files (e.g.,
COVRPAGE) without the extension(s). The SQL statement in this field can also return
“(default)” to specify that the organization’s default template should be used, or
“(none)” to specify that no template should be applied.

Form Name This (required) field is used to determine the four-letter code of the form to be
applied to text or PCL output (consult the AventX UNIX Resource Guide section on
the [FORM= command for more information). This field does not apply to
documents with formatted output such as PDF or Postscript. If submitting PDF or
Postscript output to AventX, rather than a SQL statement that returns a file name,
simply insert two single quotes ‘’.

Hold Y/N This (required) field is used to determine whether the document should be placed
into a hold state once it reaches the AventX UNIX delivery queue. Documents in a
hold state will not be delivered until the submitting user or one with
XXSTR_STATUS_ADMIN priveleges manually releases it using the AventX
WebManager. Valid values for this field are ‘Y’ and ‘N’, or a SQL statement returning
either of those letters.

T&C Y/N This (required) field is used to determine whether to include a terms and conditions
file along with the document to be delivered. Valid values for this field are ‘Y’ and
‘N’, or a SQL statement returning either of those letters. If ‘Y’, a terms and
conditions file name must be returned in the T&C Name field below.

T&C Name This (required) field is used to determine the file name, including extension of the
terms and conditions file if the value returned for T&C Y/N was ‘Y’. If the value
returned was ‘N’, simply insert two single quotes ‘’.

System Administration - Forms and Field Descriptions

Page 619 of 944
Proprietary to STR Software
Field Value

Remarks This (optional) field is used to determine what custom remarks should appear on
the template. This value is usually a combination of hardcoded text concatenated
with dynamic values selected from tables (e.g., ‘This is purchase order #’ ||
po_headers_all.segment1 || ‘.’)

Ranking <Add Content>

Watermark Name The name of the watermark pdf file to be applied to the report output pdf. This file
must exist in $FCHOME/oa/watermarks directory. See “Apply Watermarks To”
under the “Misc Tab” section on how to enable watermarks for specific delivery
types.

FROM This (required) alphanumeric field has a limit of 2000 characters. It defines the
tables, views, etc. from which the previous values are returned.
NOTE: You must grant “xxaventx” the necessary options (e.g. “select”) within the
Oracle database; otherwise your query will fail to return any useful information.
An interesting approach is to select from “dual”. Then the values that are specified
for each field will effectively be “echoed” back as the AventX Oracle Connector
command. This technique is especially useful when the desired document options
information exists in the report output and can be extracted and assigned to the
tokens :UID1 - :UID5, :UID4, :UID5.

WHERE This (optional) alphanumeric field has a limit of 4000 characters. It defines the
conditions to be met in returning the previous values. Common constructs will use
the variables :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID and/or
:SENDER_USERID.

ORDER BY This (optional) alphanumeric field has a limit of 2000 characters. It defines what
field is used to order the rows returned in the query.

System Administration - Forms and Field Descriptions

Page 620 of 944
Proprietary to STR Software
To see the actual SQL statement that AventX will use in its processing, select the Show SQL button after filling
out this form. The example below is a simple query which will pull information from the FAX_INFO tag when
delivered via AventX Automatic:

Select OK to return to the previous screen.

System Administration - Forms and Field Descriptions

Page 621 of 944
Proprietary to STR Software
Before you can save this query in your document options query list, it must be validated. Select the Validate
Query button.

A new canvas will open to perform the validation from. Simply fill in the required fields with values you know
will return the document options you desire. Then select Go to see the results.

For our example, we’ll fill in the “Payment Batch” (:UID1) and “Template” (:UID4). We get the results we
thought we should:

System Administration - Forms and Field Descriptions

Page 622 of 944
Proprietary to STR Software
If the returned values were not what you expected, you’ll need to change the query definition and validate
again.

Once you are satisfied with the query definition, select OK to return to the Document Options Query canvas.
Your query will now be displayed in the list. You can configure AventX to use your Doc Options query by
selecting the Query radio button under Define Options By on the Options tab of the AventX Connector
Configuration Form, then choosing your query from the list of values.

The Test Query button will allow you to validate the selected query without having to open it to edit. The
Copy Query button will allow you to create a selected copy of the query by a new name, keeping all the
parameters specified for the original, and opening the new query in the edit canvas. Delete Query will
prompt you to confirm before deleting the selected query. You cannot delete queries which have been used in
configuration via the AventX Configuration form.

System Administration - Forms and Field Descriptions

Page 623 of 944
Proprietary to STR Software
Destination Query Tab

This tab is optional. This tab is not available for the seeded documents. Not creating a destination query will
require you to use either the “User Query” or the “Other” destination query in your document configuration.

This canvas allows you to create queries that can be used to determine the destination(s) for your document.
It is permissible to have multiple queries defined for a given document type. For example, one query might
be for the person at the shipping dock, another might be for the person responsible for accounts payable.

The queries defined here will be available for configuration on the AventX Configuration form for this
document type. The queries will return values that are used in the AventX processing to define the delivery
address information.

Options for Creating a Destination Query

Here are two techniques companies use to implement their destination query requirements when the
“Other” and “User” query do not meet their business needs.

• Include the email address, fax number, or printer (i.e. the destination) in the FAX_INFO tag.
• Create custom SQL that returns one or more email addresses, fax numbers or printers from the Oracle
database.
The following sections describe these in greater detail.

System Administration - Forms and Field Descriptions

Page 624 of 944
Proprietary to STR Software
Option # 1: Include the Destination in the AventX Information Tag
It is possible to have AventX deliver documents to a custom email, fax, or print destination by simply
including the appropriate destination in the FAX_INFO tag. The first step is to define a query within the
Destination Query Tab by selecting the New Query button:

An example destination query is shown below:

System Administration - Forms and Field Descriptions

Page 625 of 944
Proprietary to STR Software
To save your destination query, click the Validate Query buttonand enter sample destination information
when prompted, then click Go:

The results of the query validation are displayed:

Click OK to navigate back to your destination query, then OK to save it. Your new query can be selected for
this document type under the Connector Configuration Form.

Option # 2: Creating a SQL Query for the Recipient Query (Most Common)
This option is more complex but offers the greatest flexibility. It should be implemented when you want to
define your own destination query that pulls information directly from the Oracle database tables (e.g., the
supplier or customer tables) in lieu of using a seeded document type and its associated destination queries.

A quick way to start the creation of a custom destination query is to create a simple version of your custom
destination query. This technique uses a table in the Oracle database called DUAL. The DUAL table is a special
one-column table present by default in all Oracle database installations.

System Administration - Forms and Field Descriptions

Page 626 of 944
Proprietary to STR Software
You can configure your destination query to pull a static destination from DUAL instead of from the FAX_INFO
tag. This is done by navigating to Destination Queries and clicking New Query as described in the section
above. An example query is shown below:

To save your destination query, click Validate Query and then click Go. The query should validate successfully
assuming all hardcoded values are contained within single quotes.

System Administration - Forms and Field Descriptions

Page 627 of 944
Proprietary to STR Software
The results of the query validation are displayed:

Click OK to navigate back to your destination query, then OK to save it. Your new query can be selected for
this document type under the Connector Configuration Form.

The STR Software Portal provides numerous example queries gathered from STR Software’s internal systems
and customers. These queries can be used to start you off in the right direction to creating your own custom
destination query. See KB Article # 16323 for a complete list of queries that are available.

To create a custom destination query, select the New Query button.

Fill in the fields on this canvas to define the destination query. Required fields are yellow. These fields are
described below.

Query Name Field

This (required) alphanumeric field has a limit of 24 characters and defines the value that will be displayed in
the destination pick list on the AventX Configuration form for this document type.

Query Description Field

This (optional) alphanumeric field has a limit of 255 characters and is simply a description for the Query
Name field. The value will also be displayed in the destination pick list on the AventX Configuration form.

Select Distinct Check Box

Use this checkbox to specify that option to the select statement for the query. For more information on SQL
statements, refer to the appropriate Oracle documentation.

Company Name Field

This (optional) alphanumeric field has a limit of 2000 characters. It is used in determining the “Company
Name” of the destination. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID, and/or
:SENDER_USERID may also be used here.

The following characters are valid in the value returned for “Company Name”:

` (tick) and ' (single quote)

The characters [ ] \ are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for “Company Name”.

System Administration - Forms and Field Descriptions

Page 628 of 944
Proprietary to STR Software
The value returned, which is assigned to the [TOCOMPANY= command, is truncated to 40 characters. This
value is displayed on the AventX Interactive Delivery form, in the AventX Reports and on the AventX Delivery
Status form and can be displayed on the message template.

Last Name Field

This (optional) alphanumeric field has a limit of 2000 characters. It is used in determining the “Last Name” of
the destination. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID
may also be used here.

The following characters are valid in the value returned for “Last Name”:

` (tick) and ' (single quote)

The characters [ ] \ are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for “Company Name”.

The value returned is combined with the First Name value and then assigned to the [TO= command. The
combined value is truncated to 40 characters. This value is displayed on the AventX Interactive Delivery form,
in the AventX Reports and on the AventX Delivery Status form and can be displayed on the message
template.

First Name Field

This (optional) alphanumeric field has a limit of 2000 characters. It is used in determining the “First Name” of
the destination. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID
may also be used here.
System Administration - Forms and Field Descriptions
Page 629 of 944
Proprietary to STR Software
The following characters are valid in the value returned for "First Name":

` (tick) and ' (single quote)

The characters [ ] \ are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for “Company Name”.

The value returned is combined with the Last Name value and then assigned to the [TO= command. The
combined value is truncated to 40 characters. This value is displayed on the AventX Interactive Delivery form,
in the AventX Reports and on the AventX Delivery Status form and can be displayed on the message
template.

Delivery Type Field

This (required) alphanumeric field has a limit of 2000 characters. It is used in determining the default delivery
method (fax, email, print or a combination thereof) for the destination returned. The tokens for :UID1 -
:UID5, :UID4, :UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID may also be used here.

Transmission Type Values Description

ALL Fax, Email and Print

E Email

S Secure Email

F Fax

P Print

LP Local Print

LPT Local Print To

LPV Local Preview

I or IGNORE or SKIP This type will cause the query to ignore the destination in
the query. No record of the transaction will be kept when
the document has multiple recipients. In the event this is
the only recipient and no others are pulled you will see a
record in AventX transmission status table that states, “The
request contained no destinations.”

N, NO, or NOOP This transmission type will extract the destination, log
information into the AventX transmission status tables but
not deliver the document to the recipient. The message will
read like the following: “This destination had a delivery
type of 'No Op' and was not processed.”

System Administration - Forms and Field Descriptions

Page 630 of 944
Proprietary to STR Software
 FSP Fax, Secure Email and Print

EP Email and Print

FE Fax and Email

FP Fax and Print

FS Fax and Secure

Fax Address Field

This (required) alphanumeric field has a limit of 2000 characters. It is used in determining the fax number for
the destination. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID and :SENDER_USERID may
also be used here.

The following characters are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for "Fax Address":

` (tick) and ' (single quote), [ (left square bracket), ] (right square bracket), and \ (backslash)

The value returned is truncated to 30 characters (all of which must be digits) and then assigned to the
[DESTINATION= command. This value is displayed on the AventX Interactive Delivery form, in the AventX
Reports and on the AventX Delivery Status form, and can be displayed on the message template, if the
default delivery method is “Fax”, “Fax and Email”, “Fax and Print” or “ALL”.

System Administration - Forms and Field Descriptions

Page 631 of 944
Proprietary to STR Software
Email Address Field

This (required) alphanumeric field has a limit of 2000 characters. It is used in determining the email address
for the destination. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID and :SENDER_USERID
may also be used here.

The following characters are valid in the value returned for "Email Address":

' (single quote)

The characters [ ] \ are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for “Company Name”.

The value returned is truncated to 255 characters (which must contain an @) and then assigned to the
[DESTINATION= command. This value is displayed on the AventX Interactive Delivery form, in the AventX
Reports and on the AventX Delivery Status form, and can be displayed on the message template, if the
default delivery method is “Email”, “Fax and Email”, “Email and Print” or “ALL”.

Printer Field

This alphanumeric field has a limit of 2000 characters. It is used in determining the printer for the destination.
The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID and :SENDER_USERID may also be used here.

The value returned is truncated to 255 characters. This value determines what printer is used when the
default delivery method for this destination is “P” (PRINT).

This value is displayed on the AventX Interactive Delivery form if the default delivery method for this
destination is “P” (PRINT).

If no value is returned, the printer assignment will fall through to the Oracle EBS user’s default printer (i.e.
“$PROFILES$.PRINTER”). If the Oracle EBS user has no default printer defined, the printer assignment will fall
through to the UNIX system default printer.

Returned values must not include the “%”, “`” (tick), or “]” characters. Printer name values with these
characters will cause processing errors within AventX.

EBS User Field

This (optional) alphanumeric field has a limit of 40 characters. It is used in determining the EBS User for
AventX Print Xpress destinations. This field is required when using a delivery type of “Local Print”, “Local Print
To”, or “Local Preview”.

The value specified in this field must be a valid Oracle EBS username. This username determines the recipient
of documents using any of the above delivery types.

System Administration - Forms and Field Descriptions

Page 632 of 944
Proprietary to STR Software
Ranking Field

This (optional) alphanumeric field has a limit of 2000 characters. It is used in determining the ranking for the
destination. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID and :SENDER_USERID may also
be used here. Ranking can be used in selection of a single destination from many found, or also to order
those found.

Other Field

This (optional) alphanumeric field has a limit of 4000 characters. It is an “extraneous” field designed to be
used for information within the AYOD form itself (e.g. to return an additional identifying value to ensure the
correct query has been created). The returned value is not used in the AventX Oracle Connector processing.
The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID and :SENDER_USERID may also be used here.

Add. Commands Field

Starting with version 20.1.00 (TBD), AventX allows additional commands to be included per destination using
this Add. Commands field. This field is a free-form text field with 4000 characters limit. The final string needs
to follow a specific format below to be parsed successfully by AventX:

[COMMAND1=VALUE1][COMMAND2=VALUE2]…

Example:

decode(KEY, 1, '[COMBINE=YES][EMAILGROUPSEND=YES]',

2, '[COMBINE=YES][EMAILGROUPSEND=NO]',

'[COMBINE=NO][EMAILGROUPSEND=NO]')

List of additional commands that can be used per destination:

USERDATA1 – USERDATA8, USERID, TOCOMPANY, SUBJECT, DEVICE, COMBINE, EMAILGROUPSEND

From Field

This (required) alphanumeric field has a limit of 2000 characters. It defines the tables, views, etc. from which
the previous values are returned. You must grant “xxaventx” the necessary options (e.g., “select”) within the
Oracle database; otherwise your query will fail to return any useful information.

Where Field

This (optional) alphanumeric field has a limit of 4000 characters. It defines the conditions to be met in
returning the previous values. Common constructs will use the tokens :UID1 - :UID5, :UID4, :UID5,
:REQUESTID, :ORGID, and/or :SENDER_USERID.

Order By Field

This (optional) alphanumeric field has a limit of 2000 characters. It defines what field is used to order the
rows returned by the query.

Destinations Returned Button

System Administration - Forms and Field Descriptions

Page 633 of 944
Proprietary to STR Software
This (required) radio button must be either:

• First Recipient will return the first row based on the specified query conditions – results in one
destination for the document.
• All Recipients will return all rows based on the specified query conditions – may result in many
destinations for the document.

System Administration - Forms and Field Descriptions

Page 634 of 944
Proprietary to STR Software
For our example document, Separate Remittance Advice, our destination query would look like this:

The query is pulling the destination information from a view defined by AventX (fcoa_vendor_contact_v).

It also uses the :UID2 and :UID1 substitution variables to restrict the query by specific check number
(Payment Number from the Submit Request form parameters) and check run (Payment Batch from the
Submit Request form parameters).

Because First Recipient is checked, this query will return only one destination from the vendor site.

System Administration - Forms and Field Descriptions

Page 635 of 944
Proprietary to STR Software
To see the actual SQL statement that AventX will use in its processing, select the “Show SQL” button. You can
use this SQL statement in sqlplus, Oracle SQL Developer, TOAD, or some other SQL application to see what
your results would be. This can be very helpful for troubleshooting.

Select OK to return to the previous screen.

System Administration - Forms and Field Descriptions

Page 636 of 944
Proprietary to STR Software
Select the Validate Query button. A new canvas will open to perform the validation from. Fill in the required
fields with values you know will return the destination information you desire. Then select Go to see the
results.

For our example, we’ll fill in the “Payment Batch” (:UID1) and “Payment Number” (:UID2) that should return
information for Advantage Corp.

Our destination query is good – we get the results we thought we should.

If the returned values were not what was expected, you’ll need to change the query definition and validate
again. If the validation returned no rows, you may not have the supplier or customer site (or other database
fields) properly configured.

System Administration - Forms and Field Descriptions

Page 637 of 944
Proprietary to STR Software
Once you are satisfied with the query definition, select OK to return to the Recipient Query canvas. Your
query will now be displayed in the list. Only valid queries will be available on the AventX Configuration form.

The Test Query button will allow you to validate the selected query without having to open it to edit. The
Copy Query button will allow you to create a copy of the selected query by a new name, keeping all the
parameters specified for the original, and opening the new query in the edit canvas. Delete Query will
prompt you to confirm before deleting the selected query. You cannot delete queries which have been used in
configuration via the AventX Configuration form.

System Administration - Forms and Field Descriptions

Page 638 of 944
Proprietary to STR Software
Acknowledgement Query Tab

This tab is optional. This tab is not available for the seeded documents. Not creating a destination query will
require you to use either the “User Query” or the “Other” destination query in your organization
configuration.

This canvas allows you to create queries that can be used to determine who gets an acknowledgement for
the transmission of your document. It is permissible to have multiple queries defined for a given document
definition. For example, one query might be for the buyer’s manager, another might be for the person
responsible for accounts receivable.

The queries defined here will be available for configuration on the AventX Configuration form for this
document type.

The queries will return values that are used in the AventX processing to define the acknowledgement e-mail
address information.

System Administration - Forms and Field Descriptions

Page 639 of 944
Proprietary to STR Software
To create a new acknowledgement query, select the New Query button.

Fill in the fields on this canvas to define the destination query. Required fields are yellow. These fields are
described below:

Query Name Field

This (required) alphanumeric field has a limit of 16 characters and defines the value that is displayed in the
acknowledgement pick list on the AventX Configuration form for this document type:

Query Description Field

This (optional) alphanumeric field has a limit of 255 characters and is simply a description for the Query
Name field. The value is also displayed in the acknowledgement pick list on the AventX Configuration form.

Select Distinct Field

Use the “distinct” checkbox to specify that option to the select statement for the query. For more
information on SQL statements, refer to the appropriate Oracle documentation.

Email Address Field

System Administration - Forms and Field Descriptions

Page 640 of 944
Proprietary to STR Software
This (required) alphanumeric field has a limit of 2000 characters. It is used in determining the email address
for the acknowledgement. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID, and/or
:SENDER_USERID may also be used here.

The following characters are valid in the value returned for “Address”:

' (single quote)

The characters [ ] \ are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for “Address”.

The value returned are truncated to 255 characters (which must contain an @) and then assigned to the
[PRINT= command. This value will displayed on the AventX Interactive Delivery form.

Acknowledgements are only created for the primary destination of the document. Please refer to the
chapter “Configuring Organization Specific Settings” for more details on acknowledgements.

Last Name Field

This (optional) alphanumeric field has a limit of 2000 characters. It is used in determining the “Last Name” of
the destination for the acknowledgement. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID,
and/or :SENDER_USERID may also be used here.

The following characters are valid in the value returned for “Last Name”:

` (tick) and ' (single quote)

The characters [ ] \ are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for “Last Name”.

The value returned is combined with the First Name value. The combined value is truncated to 40 characters.
This value is displayed on the AventX Interactive Delivery form.

First Name Field

This (optional) alphanumeric field has a limit of 2000 characters. It is used in determining the “First Name” of
the destination for the acknowledgement. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID,
and/or :SENDER_USERID may also be used here.

The following characters are valid in the value returned for “First Name”:

` (tick) and ' (single quote)

The characters [ ] \ are automatically stripped by the appropriate AventX view(s) during command file
generation from the value returned for “First Name”.

The value returned is combined with the Last Name value. The combined value is truncated to 40 characters.
This value is displayed on the AventX Interactive Delivery form.

Other Field

System Administration - Forms and Field Descriptions

Page 641 of 944
Proprietary to STR Software
This (optional) alphanumeric field has a limit of 4000 characters. It is an “extra” field for any use desired. The
tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID may also be used here.

From Field

This (required) alphanumeric field has a limit of 2000 characters. It defines the tables, views, etc. from which
the previous values are returned.

You must grant “xxaventx” the necessary options (e.g. “select”) within the Oracle database; otherwise your
query will fail to return any useful information.

An interesting approach is to select from “dual”. Then the values that are specified for each field will
effectively be “echoed” back as the AventX Oracle Connector command. This technique is especially useful
when the desired acknowledgement information exists in the report output and can be extracted and
assigned to the tokens :UID1 - :UID5, :UID4, :UID5.

WHERE Field

This (optional) alphanumeric field has a limit of 4000 characters. It defines the conditions to be met in
returning the previous values. Common constructs will use the variables :UID1 - :UID5, :UID4, :UID5,
:REQUESTID, :ORGID and/or :SENDER_USERID.

ORDER BY Field

This (optional) alphanumeric field has a limit of 2000 characters. It defines what field is used to order the
rows returned in the query.

System Administration - Forms and Field Descriptions

Page 642 of 944
Proprietary to STR Software
In the example below a completed Acknowledge query would look like this:

The query uses the :UID2 and :UID1 substitution variables to restrict the query by specific check number
(Payment Number from the Submit Request form parameters) and check run (Payment Batch from the
Submit Request form parameters).

To see the actual SQL statement that AventX will use in its processing, select the Show SQL button.

System Administration - Forms and Field Descriptions

Page 643 of 944
Proprietary to STR Software
You can use this SQL statement in sqlplus, Oracle SQL Developer, TOAD, or some other SQL application to see
what your results would be. This can be very helpful for troubleshooting.

Select OK to return to the previous screen.

Before you can save this query in your acknowledgement query list, it must be validated. Select the Validate
Query button.

A new canvas will open to perform the validation from. Simply fill in the required fields with values you know
will return the acknowledgement information you desire. Then select Go to see the results.

For our example, we’ll fill in the “Payment Batch” (:UID1) and “Payment Number” (:UID2) that should return
information for Advantage Corp.

Our acknowledgement query is good – we get the results we thought we should (compare to the supplier site
screen shot previously provided).

System Administration - Forms and Field Descriptions

Page 644 of 944
Proprietary to STR Software
If the returned values were not what you expected, you’ll need to change the query definition and validate
again. If the validation returned no rows, you may not have the supplier or customer site (or other database
fields) properly configured.

Once you are satisfied with the query definition, select OK to return to the Acknowledgement Query canvas.
Your query will now be displayed in the list. Only valid queries will be available on the AventX Configuration
form.

The Test Query button will allow you to validate the selected query without having to open it to edit. The
Copy Query button will allow you to create a selected copy of the query by a new name, keeping all the
parameters specified for the original, and opening the new query in the edit canvas. Delete Query will
prompt you to confirm before deleting the selected query. You cannot delete queries which have been used in
configuration via the AventX Configuration form.

System Administration - Forms and Field Descriptions

Page 645 of 944
Proprietary to STR Software
Attachment Query Tab

This canvas allows you to create queries that can be used to determine the attachment(s) for your document.
It is permissible to have multiple queries defined for a given document definition. For RFQs, Purchase Orders,
Work Orders and Invoices, this canvas is pre-populated with the seeded attachment queries.

Queries must be defined which specify the primary key necessary for AventX to extract the appropriate
attachments. Detailed discussion on the methodology is beyond the scope of this document.

System Administration - Forms and Field Descriptions

Page 646 of 944
Proprietary to STR Software
If the document you are modifying or creating does not have an attachment extraction query, then you can
create a query to extract attachments from the Oracle Database, file server, or a supported web server (e.g.,
SharePoint). The queries defined here will be available for configuration on the AventX Configuration form for
this document type. Configure a custom query by selecting the New Query button.

System Administration - Forms and Field Descriptions

Page 647 of 944
Proprietary to STR Software
Fill in the fields on this canvas to define the attachment query. Required fields are yellow. These fields are
described below.

Field Value

Entity This (required) alphanumeric field defines the entity for the attachment. This field is
a LOV (List of Values) and will contain all entities that are in the Oracle database.

For seeded attachment queries, this field cannot be modified. You cannot define
multiple attachment queries that specify the same entity (e.g. only one attachment
query for PO Header).

Description This (optional) alphanumeric field has a limit of 255 characters and is simply a
description for the Entity field. The value will also be displayed in the attachment
pick list on the AventX Configuration form.

Select Distinct Use the “distinct” checkbox to specify that option to the select statement for the
query. For more information on SQL statements, refer to the appropriate Oracle
documentation.
key1 This (required) alphanumeric field has a limit of 2000 characters. It defines the first
key to be used in extracting the attachment. The tokens for :UID1 - :UID5, :UID4,
:UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID may also be used here.

key2 This (optional) alphanumeric field has a limit of 2000 characters. It defines the
second key to be used in extracting the attachment. The tokens for :UID1 - :UID5,
:UID4, :UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID may also be used here.

key3 This (optional) alphanumeric field has a limit of 2000 characters. It defines the third
key to be used in extracting the attachment. The tokens for :UID1 - :UID5, :UID4,
:UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID may also be used here.

System Administration - Forms and Field Descriptions

Page 648 of 944
Proprietary to STR Software
 Field Value

key4 This (optional) alphanumeric field has a limit of 2000 characters. It defines the
fourth key to be used in extracting the attachment. The tokens for :UID1 - :UID5,
:UID4, :UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID may also be used here.

key5 This (optional) alphanumeric field has a limit of 2000 characters. It defines the fifth
key to be used in extracting the attachment. The tokens for :UID1 - :UID5, :UID4,
:UID5, :REQUESTID, :ORGID, and/or :SENDER_USERID may also be used here.

other This (optional) alphanumeric field has a limit of 2000 characters. It can be used as a
sort field or an indicator field (to assist in proving the query for the other
parameters is correct). The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID,
:ORGID, and/or :SENDER_USERID may also be used here.

FROM This (required) alphanumeric field has a limit of 4000 characters. It defines the
tables, views, etc. from which the previous values will be returned.
You must grant “xxaventx” the necessary options (e.g. “select”) within the Oracle
database; otherwise your query will fail to return any useful information.

WHERE This (optional) alphanumeric field has a limit of 4000 characters. It defines the
conditions to be met in returning the previous values. Common constructs will use
the tokens :UID1 - :UID5, :UID4, :UID5, :REQUESTID, :ORGID and/or
:SENDER_USERID.

ORDER BY This (optional) alphanumeric field determines the sort order of the attachment
query. It defines what column(s) will be used to order the resultant rows returned
and is restricted to standard Oracle SQL “ORDER BY” clause syntax using the six
column names of the select statement: key1, key2, key3, key4, key5 and other.
The columns key1-key5 return only the first 2000 characters of data, so sorting on
the key columns will be based only on the data returned. The other column returns
only the first 512 characters of data and sorting on this column will be based only
on the first 512 characters returned.
This controls the order of the attachments in the constructed document for this
entity.
To see the actual SQL statement that AventX will use in its processing, select the Show SQL button.

You can use this SQL statement in sqlplus, Oracle SQL Developer, TOAD, or some other SQL application to see
what your results would be. This is very helpful for troubleshooting. The SQL of the seeded PO Item
attachment query is shown:

System Administration - Forms and Field Descriptions

Page 649 of 944
Proprietary to STR Software
Select OK to return to the previous screen.

System Administration - Forms and Field Descriptions

Page 650 of 944
Proprietary to STR Software
Before you can save this query in your attachment query list, it must be validated. Select the Validate Query
button.

A new canvas will open to perform the validation. Simply fill in the required fields with values you know will
return the attachment information you desire. Then select Go to see the results.

For our example, we’ll fill in the “Purchase Order Number” (:UID1) and “Organization ID” (:ORGID).

System Administration - Forms and Field Descriptions

Page 651 of 944
Proprietary to STR Software
If your attachment query was good, you will see the attachments you expected. If the returned values were
not what you expected, you’ll need to change the query definition and validate again. If the validation
returned no rows, you may simply not have the attachments properly configured within the Oracle
framework:

System Administration - Forms and Field Descriptions

Page 652 of 944
Proprietary to STR Software
Once you are satisfied with the query definition and have validated it, select OK to return to the Attachment
Query tab. Your query should be displayed in the list. Only valid queries will be available on the AventX
Configuration form. Below are the seeded attachment queries for the Purchase Order document type:

You may modify the seeded attachment queries that come with the RFQ, Purchase Order, Work Order, and
Invoice document types, or add new queries as desired. The Test Query button allows you to validate the
selected query without having to open it to edit. The Copy Query button will allow you to create a copy of
the selected query by a new name, keeping all the parameters specified for the original, and opening the new
query in the edit canvas. Delete Query will prompt you to confirm before deleting the selected query. You
cannot delete queries which have been used in configuration via the AventX Configuration form.

System Administration - Forms and Field Descriptions

Page 653 of 944
Proprietary to STR Software
Archive Query Tab

This tab provides the structure for archiving documents, attachments, and an archive metadata file that can
be used to import documents into 3rd party archiving packages.

System Administration - Forms and Field Descriptions

Page 654 of 944
Proprietary to STR Software
Sender Query Tab

This canvas allows you to create queries that can be used to determine the sender(s) for your document. It is
permissible to have multiple queries defined for a given document definition. For example, one query might
be for the person at the shipping dock, another might be for the person responsible for accounts payable.

The queries defined here will be available for configuration on the AventX Configuration form for this
document type.

The queries will return values that will be used in the AventX processing to define the sender information.

System Administration - Forms and Field Descriptions

Page 655 of 944
Proprietary to STR Software
To create a new sender query, select the New Query button:

Fill in the fields on this canvas to define the sender query. Required fields are yellow. These fields are
described in the following table.

Field Value

Query Name This (required) alphanumeric field has a limit of 16 characters and defines the value
that will be displayed in the sender pick list on the AventX Configuration form for
this document type.

Query Description This (optional) alphanumeric field has a limit of 255 characters and is simply a
description for the Query Name field. The value will also be displayed in the pick list
on the AventX Configuration form.

Select Distinct Use the “distinct” checkbox to specify that option to the select statement for the
query. For more information on SQL statements, refer to the appropriate Oracle
documentation.

System Administration - Forms and Field Descriptions

Page 656 of 944
Proprietary to STR Software
Field Value

Last Name This required alphanumeric field has a limit of 2000 characters. It is used in
determining the “Last Name” of the sender. The tokens for :UID1 - :UID5, :UID4,
:UID5, :REQUESTID, and/or :ORGID may also be used here.
The following characters are valid in the value returned for “Last Name”:
` (tick) and ' (single quote)
The characters [ ] \ are automatically stripped by the appropriate AventX view(s)
during command file generation from the value returned for “Last Name”.
The value returned is combined with the First Name value and then assigned to the
[FROM= command. The combined value is truncated to 40 characters. This value
can be displayed on the message template, and is the value that will be identified as
the “from” for the email destination.

First Name This required alphanumeric field has a limit of 2000 characters. It is used in
determining the “First Name” of the destination. The tokens for :UID1 - :UID5,
:UID4, :UID5, :REQUESTID, and/or :ORGID may also be used here.
The following characters are valid in the value returned for “First Name”:
` (tick) and ' (single quote)
The characters [ ] \ are automatically stripped by the appropriate AventX view(s)
during command file generation from the value returned for “First Name”.
The value returned is combined with the Last Name value and then assigned to the
[FROM= command. The combined value will be truncated to 40 characters. This
value can be displayed on the message template, and is the value that will be
identified as the “from” for the email destination.

Email Address This required alphanumeric field has a limit of 2000 characters. It is used in
determining the email address for the sender. The tokens for :UID1 - :UID5, :UID4,
:UID5, :REQUESTID, and/or :ORGID may also be used here.
The following characters are valid in the value returned for “Email Address”:
' (single quote)
The characters [ ] \are automatically stripped by the appropriate AventX view(s)
during command file generation from the value returned for “Email Address”.
The value returned is truncated to 255 characters (which must contain an @) and
then assigned to the TEI address portion of the [FROM= command. This value can
be displayed on the message template, and is the value that will be used as the
“reply to” address for the email destination.

System Administration - Forms and Field Descriptions

Page 657 of 944
Proprietary to STR Software
Field Value

FROM This required alphanumeric field has a limit of 2000 characters. It defines the tables,
views, etc. from which the previous values will be returned.
You must grant the AventX database user, i.e. xxaventx, the necessary options (e.g.,
“select”) within the Oracle database; otherwise your query will fail to return any
useful information.
An interesting approach is to select from “dual”. Then the values that are specified
for each field will effectively be “echoed” back as the AventX Oracle Connector
command. This technique is especially useful when the desired sender information
exists in the report output and can be extracted and assigned to the :UID tokens.

WHERE This (optional) alphanumeric field has a limit of 4000 characters. It defines the
conditions to be met in returning the previous values. Common constructs will use
the tokens :UID1 - :UID5, :UID4, :UID5, :REQUESTID, and/or :ORGID.

System Administration - Forms and Field Descriptions

Page 658 of 944
Proprietary to STR Software
For our example document, Separate Remittance Advice, our sender query might look like this:

The query can pull the sender information from a view defined by AventX (fcoa_employees_v). It also uses
the:ORGID substitution variable to restrict the query by the organization id.

To see the actual SQL statement that AventX will use in its processing, select the Show SQL button.

System Administration - Forms and Field Descriptions

Page 659 of 944
Proprietary to STR Software
You can use this SQL statement in sqlplus, Oracle SQL Developer, TOAD, or some other SQL application to see
what your results would be. This is very helpful for troubleshooting.

Select OK to return to the previous screen. Before you can save this query in your destination query list, it
must be validated. Select the Validate Query button.

A new canvas will open to perform the validation from. Simply fill in the required fields with values you know
will return the destination information you desire. Then select Go to see the results.

System Administration - Forms and Field Descriptions

Page 660 of 944
Proprietary to STR Software
If the returned values are not what you expected, you’ll need to change the query definition and validate
again. Once you are satisfied with the query definition, select OK to return to the Sender Query tab. Your
query will now be displayed in the list. Only valid queries will be available on the AventX Configuration form.

You may modify the seeded attachment queries that come with the RFQ, Purchase Order, Work Order, and
Invoice document types, or add new queries as desired. The Test Query button allows you to validate the
selected query without having to open it to edit. The Copy Query button will allow you to create a copy of
the selected query by a new name, keeping all the parameters specified for the original, and opening the new
query in the edit canvas. Delete Query will prompt you to confirm before deleting the selected query. You
cannot delete queries which have been used in configuration via the AventX Configuration form.

System Administration - Forms and Field Descriptions

Page 661 of 944
Proprietary to STR Software
Command Query Tab

This tab is optional. It allows you to create queries that can be used to pass additional document commands
to the AventX UNIX delivery queue. This is only required when it is necessary to pass a dynamic command not
otherwise supplied via the AventX. It is permissible to have multiple queries defined for a given document
definition.

The queries defined here will be available for configuration on the AventX Configuration form for this
document type.

System Administration - Forms and Field Descriptions

Page 662 of 944
Proprietary to STR Software
To create a new command query, select the New Query button:

System Administration - Forms and Field Descriptions

Page 663 of 944
Proprietary to STR Software
The following additional commands are supported:

These commands can be used to populate more information

about the document with AventX.

Configuration settings can be applied to the VALUE field as a

hard-coded value or as the result of a query.

System Administration - Forms and Field Descriptions

Page 664 of 944
Proprietary to STR Software
The following is an example of how an administrator can set the hard-coded value of the URGENCY command
to set the email to “Important”. Hard-coding a value is as simple as putting the value of DUAL in the FROM
field.

System Administration - Forms and Field Descriptions

Page 665 of 944
Proprietary to STR Software
The following example shows how a query can be used to set the value. In this example, the GROUPSEND
value will be set to “YES” if the company is “Business World”.

See the AventX UNIX Resource Guide for more information about the possible “values” that can be set for
each “Additional Command”.

System Administration - Forms and Field Descriptions

Page 666 of 944
Proprietary to STR Software
Fill in the fields on this canvas to define the command query. Required fields are yellow. These fields are
described in the following table.

Field Value

Query Name This (required) field defines the command type that will be passed. Use the list of
values (LOV) to see all possible command types.

Query Description This (optional) alphanumeric field has a limit of 255 characters and is simply a
description for the Query Name field. The value will also be displayed in the pick list
on the AventX Configuration form.

Select Distinct Use the “distinct” checkbox to specify that option to the select statement for the
query. For more information on SQL statements, refer to the appropriate Oracle
documentation.

VALUE This (required) alphanumeric field is used to determine the value to assign to the
command. The tokens for :UID1 - :UID5, :UID4, :UID5, :REQUESTID, and/or :ORGID
may also be used here.
The characters [ ] \ are automatically stripped by the AventX during command file
generation from the value returned.

FROM This required alphanumeric field has a limit of 2000 characters. It defines the tables,
views, etc. from which the previous values will be returned.
You must grant the AventX database user, i.e. xxaventx, the necessary options (e.g.,
“select”) within the Oracle database; otherwise your query will fail to return any
useful information.
An interesting approach is to select from “dual”. Then the values that are specified
for each field will effectively be “echoed” back as the AventX Oracle Connector
command. This technique is especially useful when the desired sender information
exists in the report output and can be extracted and assigned to the :UID tokens.

WHERE This (optional) alphanumeric field has a limit of 4000 characters. It defines the
conditions to be met in returning the previous values. Common constructs will use
the tokens :UID1 - :UID5, :UID4, :UID5, :REQUESTID, and/or :ORGID.

System Administration - Forms and Field Descriptions

Page 667 of 944
Proprietary to STR Software
As an example, a simple command query might look like this:

This is a simple query to specify that the time (in HHMM) to deliver a document should be :UID5 as it is found
within the FAX_INFO tag, and the document should be delivered at 7 pm if :UID5 is NULL (blank).

System Administration - Forms and Field Descriptions

Page 668 of 944
Proprietary to STR Software
To see the actual SQL statement that AventX will use in its processing, select the Show SQL button.

Select OK to return to the previous screen.

System Administration - Forms and Field Descriptions

Page 669 of 944
Proprietary to STR Software
Before you can save this query in your destination query list, it must be validated. Select the Validate Query
button. A new canvas will open to perform the validation from. Simply fill in the required fields with values
you know will return the command you desire. Then select Go to see the results.

System Administration - Forms and Field Descriptions

Page 670 of 944
Proprietary to STR Software
If the returned values are not what you expected, you’ll need to change the query definition and validate
again. Once you are satisfied with the query definition, select OK to return to the Sender Query tab. Your
query will now be displayed in the list. Only valid queries will be available on the AventX Configuration form.

System Administration - Forms and Field Descriptions

Page 671 of 944
Proprietary to STR Software
The Test Query button allows you to validate the selected query without having to open it to edit. The Copy
Query button will allow you to create a copy of the selected query by a new name, keeping all of the
parameters specified for the original, and opening the new query in the edit canvas. Delete Query will
prompt you to confirm before deleting the selected query. You cannot delete queries which have been used
in configuration via the AventX Configuration form.

System Administration - Forms and Field Descriptions

Page 672 of 944
Proprietary to STR Software
Organization Configuration Form
Organization Defaults Tab

The Organization Defaults tab allows you to specify default settings for the fax delivery server, email delivery
server, secure delivery server, and length of time to retain Interactive Delivery address information. For “rule
set” consideration, these values are treated independently from those for Message Templates and
Documents.

The following table describes each field and its purpose.

Field Description

Fax Device Name A company may have several fax delivery servers for AventX UNIX in
different locations, each server perhaps used by an individual
organization. This field indicates the name of the fax delivery server to be
used when faxing documents from this organization.
The value specified here can be any valid servername from the AventX
UNIX configuration that can send faxes. To view the list of available
devices use the ‘Administration’ → ‘Device/Services’ page in the AventX
WebManager.
The value is case-sensitive and must match exactly. The value can also
restrict delivery to a specific port on the server (e.g. FAXSVR1:4). For
more information, consult the “Device” command in the AventX UNIX
Resource Guide.
The default value is ANY, indicating that the first available fax delivery
server will be used. A <blank> value is not allowed; hence there is no “rule
set” fall through to the value specified for ORG_ID=0.

System Administration - Forms and Field Descriptions

Page 673 of 944
Proprietary to STR Software
Field Description

Email Device Name A company may have several email delivery servers for AventX UNIX in
different locations, each server perhaps used by an individual
organization. This field indicates the name of the email delivery server to
be used when emailing documents from this organization.
The value specified here can be any valid servername from the AventX
UNIX configuration that can send emails. To view the list of available
devices use the ‘Administration’ → ‘Device/Services’ page in the AventX
WebManager.
Special Note: The “Email Delivery Server” field indicates the server that is
to be used for non-secure email delivery. For secure email delivery only,
leave the value “ANY” and fill in the “Secure Delivery Server” field below.
The value is case-sensitive and must match exactly.
The default value is ANY, indicating that the first available email delivery
server will be used. A <blank> value is not allowed; hence there is no “rule
set” fall through to the value specified for ORG_ID=0.

Secure Email Device Name This field indicates the name of the secure email delivery server to be
used when emailing to secure email destinations from this organization.
It is permissible to specify both a non-secure email delivery server (using
the Email Device Name field above) and a secure delivery server.
The value specified here can be any valid servername from the AventX
UNIX configuration that can send secure emails. To view the list of
available devices, use the ‘Administration’ → ‘Device/Services’ page in
the AventX WebManager.
The value is case-sensitive and must match exactly
The default value is <blank>, indicating that no secure delivery server is
available. A <blank> value is allowed; hence there is “rule set” fall through
to the value specified for ORG_ID=0.
Specification of secure email destinations (see the destinations discussion
for the Documents tab) without a Secure Email Device configured (either
at the specific ORG_ID or ORG_ID=0) will result in an error during
document submission.

Interactive Delivery AventX Oracle Connector can be configured to retain the delivery address
Retention information for Interactive Delivery submissions for a number of days.

Note: this value does not apply to Stand Alone Interactive Delivery
submissions.

System Administration - Forms and Field Descriptions

Page 674 of 944
Proprietary to STR Software
Field Description
This will allow for scheduled requests and copy requests to be performed
using Interactive Delivery. This value is the number of days that delivery
address information will be kept in the AventX Oracle Connector tables. It
should be set equal to or less than the number of days that concurrent
requests are retained.
A “blank” value means that no delivery address information will be kept
(after processing).
A value of “0” means that delivery address information will be kept
indefinitely; use with caution as this could cause database tablespace
problems.
The value is not an “actual” number of days. AventX Oracle Connector will
check for entries in its tables that exceed this limit each time a submission
(either Automatic or Interactive Delivery) is processed. For example, if the
value is set to “2” days, and a new submission is not performed for seven
days, it will be seven days before the records are removed from the
AventX Oracle Connector tables.
This retention period does not apply to Automatic Delivery submissions;
no delivery address information is kept for Automatic Delivery.
The default value is <blank>. There is no “rule set” fall through to the
value specified for ORG_ID=0.

System Administration - Forms and Field Descriptions

Page 675 of 944
Proprietary to STR Software
Message Templates Tab

The Message Templates tab allows you to specify the list of templates that will be available for further
configuration by document type, users, etc, as well as selected on the AventX Interactive Delivery/AventX
Stand Alone Interactive Delivery form.

Message templates are configured at the organization level, and can then be selected for use with certain
document types or users, within that organization.

The following table defines the parameters that can be entered for the configuration of message templates.

This creates the list of message templates that are available for configuration as the default message
template for each document type. This list will also be available to the user on the AventX Interactive
Delivery/AventX Stand Alone Interactive Delivery form. The user can then opt to change the message
template by selecting from this list prior to submitting the document to AventX for delivery.

There are two entries that do not display in this list, as they are required for proper operation of the AventX.
The two entries are (default) and (none - for no message template).

The (default) entry specifies that the message template used will be that specified in the AventX UNIX global
configuration. This value is applicable to all documents submitted to AventX UNIX without a [TEMPLATE=
command. The (none) entry specifies that no message template be included for the submitted document.

Document submissions via Interactive Delivery or Stand Alone Interactive Delivery will include the ability to
change the message template used and add any remarks. Document submissions via Automatic Delivery will
use the message template configured for the “rule set” that applies.

System Administration - Forms and Field Descriptions

Page 676 of 944
Proprietary to STR Software
 Field Description
Template This is the actual filename (without the extension) of the AventX UNIX
message template, as it resides in $FCHOME/cfg/templates.
“Filename” may consist of up to 16 characters. The value is entered by
clicking in the field and typing the desired information.
The following characters will be automatically stripped by the appropriate
AventX view(s) during command file generation from the value returned for
"Message Template":
[ (left square bracket), ] (right square bracket), and \ (backslash), ` (tick)
and ' (single quote)
All message template selection lists (available when configuring each
document type for each organization as well as to the user on the AventX
Interactive Delivery/AventX Stand Alone Interactive Delivery form) will
display the message template “Descriptions” (described below), not the
“Filename” and will be listed in the order in which they are entered in this
table.
The default message template, TEMPLATE, is a standard message template
containing basic information such as the TO, TOCOMPANY, FROM,
FROMCOMPANY, SUBJECT, and ADDRESS (fax number or email address)
information. For more information regarding message templates, consult
the AventX UNIX Resource Guide.

Description A description of the message template. This value is displayed in the drop-
down list on this form and on the AventX Interactive Delivery/AventX
Stand Alone Interactive Delivery form.
The description may consist of up to 128 characters. The description is
entered by clicking in the field and typing the desired information.
The description entered here should be meaningful to the user, as this will
be the only information displayed to describe the message template.

System Administration - Forms and Field Descriptions

Page 677 of 944
Proprietary to STR Software
To remove an erroneous entry, click in the field to be removed and use one of: the DELETE button from the
toolbar, EDIT->DELETE, or <CTRL>+<up arrow>. Do not use <Delete>, <Backspace> or EDIT->CLEAR to remove
an entry.

Once complete, make sure to File -> Save to keep the newly entered information before proceeding with
further configuration.

Documents Tab

AventX has several “seeded” document types that are configured after a fresh installation of the software.
They are as follows

• Request for Quotes

• Purchase Orders
• Sales Order Acknowledgements

System Administration - Forms and Field Descriptions

Page 678 of 944
Proprietary to STR Software
 • Invoices
• Statements
• Work Orders
You may also create and configure new documents using the “Configure a Document” forms. You may
configure default settings for any of these document types by selecting the document type from the pick list.
Pick the document you want to configure continue.

The Document Information form contains eight standard tabs: “Options”, “Destinations”,
“Acknowledgements”, “Attachment Types”, “Oracle Attachments”, “External Attachments”, “Additional
Commands”, and ”Misc”. These define the default configuration for the document type selected and are
explained below.

Some documents like Purchase Orders will contain an additional tab(s).

System Administration - Forms and Field Descriptions

Page 679 of 944
Proprietary to STR Software
Options Tab

If you choose to Define Options By "Buyer", "Requestor" or "User", you will need to ensure that exact
matches will be made to only one value in that field. The value for “Buyer” or “User”, to be matched in this
configuration, will be determined by the configuration for “Sender” on the Misc. tab. For example, if the
Sender configuration is for “Buyer”, the buyer value will then be matched in this configuration to determine
which message template, form etc. to be applied with the submission. Refer to the “Sender” discussion in the
Misc section for details. If no matches are found, the "Options" values will be undefined unless you define a
record for “DEFAULT” as the Buyer/Requestor/User.

Defining options by “Query” assumes you have created a ‘Doc Option Query’ via the “Configure a Document”
form.

Click File -> Save to save your changes before proceeding with further configuration.

The following table defines the available parameters for the “Options” defaults and their respective values.

System Administration - Forms and Field Descriptions

Page 680 of 944
Proprietary to STR Software
Field Description

Define Options By This specifies the query type to be used when defining the document
defaults. You may select from five values:
▪ None
▪ Buyer - use only for standard RFQ or Purchase Order document type (not
valid for Purchase Order Approval documents)
▪ Requestor - use only for standard RFQ or Purchase Order document type
(not valid for Purchase Order Approval documents)
▪ User
▪ Query
If "None" is specified, all documents of this document type for this
organization will have the values for Default Message Template, Form Name
(filename) Hold, Terms & Conditions, and Terms & Conditions Name
(filename) specified in the first (and only) record of the list.
If "Buyer", "Requestor" or "User" is specified, all documents of this
document type for this organization will have the values for Default
Message Template, Form Name (filename), Hold, Terms & Conditions, and
Terms & Conditions Name (filename) from the record that has an exact
match for this query. The query is case-sensitive. The value to be used in
the query for “Buyer” or “User” is dependent on the configuration for
Sender on the Misc tab. The “Query” option returns configuration from a
previously defined ‘Doc Option Query’.
Each of these can have a DEFAULT record specified (note this is case-
sensitive) that will be used when no match is found based on the
Buyer/Requestor/User. If no DEFAULT entry exists, the (fall-through) query
will provide an error message.

Buyer/Requestor/User/ The Buyer/Requestor/User/Query specifies the value to be used in the

Query query match to determine the defaults for Default Message Template, Form
Name (filename), Hold, Terms & Conditions and Terms & Conditions Name
(filename).
Value may consist of up to 255 characters. You may select the value for
Buyer/Requestor/User from the LOV.
To enter more than (5) values, use the File->New option.
A DEFAULT entry can be specified. The values for this entry will be used if
no match is found based on the query. If no DEFAULT entry exists, and no
match is found an error will be generated.

System Administration - Forms and Field Descriptions

Page 681 of 944
Proprietary to STR Software
Field Description

Default Template This allows you to select the name of the message template that should be
sent with this document type by default.
Contents in the list of values are those specified on the Message Template
tab for this organization.
The values displayed in the list are the “Description” from message
templates, not the message template file names as they exist in the
document delivery system.
The value "(default)" selects the default message template used by the
document delivery system.

System Administration - Forms and Field Descriptions

Page 682 of 944
Proprietary to STR Software
Field Description

Form Name (filename) The filename of the form that will be applied to the (TEXT) report output
from the Concurrent Manager. It is possible to specify customized forms
based on Buyer/Requestor/User/Query, as well as the NONE query (all
output of this document type for this Organization gets the defined form
applied). See the AventX Forms Design and Integration Resource Guide for
more information on creating and using FDI forms.
The value is the filename (including extension) of the form which must be in
the $FCHOME/oa/fcdi/forms directory.
The following characters will be automatically stripped by the appropriate
AventX view(s) during command file generation from the value returned for
"Form Name":
[ (left square bracket), ] (right square bracket), and \ (backslash), ` (tick) and
' (single quote)
If a form is specified and the file does not exist, processing will halt and an
error will be generated.
If the form field is left blank, processing will assume a form file named "str-
$doctype.pcl" or "$doctype.pcl" (where the $doctype is passed as a
parameter to the Concurrent Manager defining the document type - e.g.
"pop" for Purchase Order portrait). These files must also exist in
$FCHOME/oa/fcdi/forms. If these forms do not exist, processing will
continue with no form being applied to the data.
By default, if using Printing Delivery, a static form will be applied to the
document when routed directly to a printer. However, it is possible to
enable dynamic forms application, whereby a form can be applied based
upon the configuration specified for this document by
buyer/user/requestor. cUSEADVANCEDFORMS in .fcoa_cfg_<SID> must be
set to “Y” in order to take advantage of dynamic forms application for
Printing Delivery.

Hold (checkbox) The default setting indicating whether to place this document type on hold
once it enters the document delivery system’s queue. This feature is used
when you wish to have all documents of this type reviewed before being
transmitted.
Clicking in the checkbox will cause this box to be checked by default on the
AventX Interactive Delivery/AventX Stand Alone Interactive Delivery form,
and will cause documents submitted via Automatic Delivery to be put on
HOLD in the delivery queue by default.

System Administration - Forms and Field Descriptions

Page 683 of 944
Proprietary to STR Software
Field Description

T&C (checkbox) The default setting indicating whether to include Terms and Conditions with
this document type.
Clicking in the checkbox will cause this box to be checked by default on the
AventX Interactive Delivery/AventX Stand Alone Interactive Delivery form,
and will cause documents submitted via Automatic Delivery to have these
Terms and Conditions applied.
The Terms and Conditions data is defined by the value specified in the “T&C
Name".
If the data for the Terms and Conditions exists as part of the report output,
DO NOT SPECIFY to append them with this checkbox. This would result in
erroneous output.

T&C Name The T&C Name specifies the name of the file that you wish to have
appended as the Terms and Conditions for the specified document type.
The inclusion of Terms and Conditions for PRINT destinations
This option will not be available unless the Terms and Conditions checkbox
has been checked.
The file is generally a pre-formatted output (such as PCL or PDF) that resides
in the $FCHOME/oa/fcdi/forms directory.
If STR Software has created this file for your use, you will have been
provided the name to be entered.
The following characters will be automatically stripped by the appropriate
AventX view(s) during command file generation from the value returned for
"T&C Name":
[ (left square bracket), ] (right square bracket), and \ (backslash), ` (tick) and
' (single quote)
If T&C is specified and the file does not exist, processing will halt and an
error will be generated.

System Administration - Forms and Field Descriptions

Page 684 of 944
Proprietary to STR Software
Destinations Tab

The “Destinations” tab allows you to configure the default entries for Destinations for the selected document
type as shown below. There is a parent child relationship between top and bottom section of this form. Each
email destination in the parent section can be associated with multiple TO/CC/BCC email destinations in the
child section. Destinations in the child section and its corresponding parent section must be an email address.

Fill in the “Destinations” section of the form as desired. Once complete, make sure to File -> Save to keep the
newly entered information before proceeding with further configuration.

The following section defines the available parameters for the “Destinations” defaults and their respective
values

System Administration - Forms and Field Descriptions

Page 685 of 944
Proprietary to STR Software
Send To – Destinations

AventX comes with seeded queries you can use to quickly implement business requirements. This section
provides information about these seeded queries and the data entry requirements for using them.

AventX relies on the existence of data in certain places in Oracle EBS for AventX to “automatically” deliver
documents and to display useful information to users when AventX forms are displayed. This section helps
answer the question…

“What data entry is required to use the seeded AventX queries?”

AventX must be able to determine the preferred method of delivery and corresponding delivery address
(email, fax, print, or archive) for each destination. This is accomplished by using queries against views to
extract the necessary destination information from the proper Oracle EBS tables.

Up to ten thousand destinations can be defined in the “Send To” list. These entries will determine how the
AventX Interactive Delivery form is pre-populated for Destinations and defines the default destinations for
Automatic Delivery.
There are several seeded entries in the “Send to” list:
• Vendor, Vendor, Vendor Contact, Buyer, and Requestor - Used for Request For Quotation, Purchase
Order, and Purchase Order Approval document types. The value returned for the “Buyer” query is
dependent on the configuration for Sender on the Misc tab. Please refer to the discussion on “Sender” on
the Misc tab for more information.
• Fax Enable - is used for the Purchase Order document type.
• PO Approval - is used for PO Approval document types.
• Customer - is used for Sales Order Acknowledgement, Invoice, and Statement document types.
• User and Secure User Email Address - can be used for any document type. The value returned for this
query is dependent on the configuration for Sender on the Misc tab. Please refer to the discussion on
“Sender” on the Misc tab for more information.
• BI Publisher Destinations - are used for all document types for processing of Delivery Manager
destinations. Important Note: if other destination queries are configured with BI Publisher Destinations,
the possibility of those destinations receiving multiple “copies” of the submission exists. Delivery
Manager functionality spawns a separate call to the SMTP/IPP server for each destination specified on
the Delivery Opts form. Each of these calls to SMTP/IPP server will process all configuration items
(including each configured destination) for that submission.
Do not configure multiple queries of the same type; otherwise it will result in multiple emails, faxes, print
jobs or archive jobs going to the same destination.

The first entry in the “Send To” list is denoted the primary destination. Acknowledgements (described later)
will only be issued for delivery to the primary destination. The order of destination entries 2 through 10000 is
not significant.

System Administration - Forms and Field Descriptions

Page 686 of 944
Proprietary to STR Software
Other Destination (Name)

Specifies the "To" name for this destination. Valid values are any strings of up to 40 characters.

The following characters are valid in the value returned for "Other Name ":

` (tick) and ' (single quote)

The following characters will be automatically stripped by the appropriate AventX view(s) during command
file generation from the value returned for "Other Name ":

[ (left square bracket), ] (right square bracket), and \ (backslash)

Other Destination (Company)

Specifies the "To Company" name for this destination. Valid values are any strings of up to 40 characters.

The following characters are valid in the value returned for "Other Name ":

` (tick) and ' (single quote)

The following characters will be automatically stripped by the appropriate AventX view(s) during command
file generation from the value returned for "Other Name ":

[ (left square bracket), ] (right square bracket), and \ (backslash)

Other Fax/Email

Specifies the fax number or email address for this destination. Valid values for fax numbers are any string of
up to 40 digits. Valid values for email addresses are any string of up to 255 characters; must include
user@domain format.

The following characters will be automatically stripped by the appropriate AventX view(s) during command
file generation from the value returned for "Other Fax ":

[ (left square bracket), ] (right square bracket), and \ (backslash), ` (tick) and ' (single quote)

The following characters are valid in the value returned for "Other Email ":

' (single quote)

The following characters will be automatically stripped by the appropriate AventX view(s) during command
file generation from the value returned for "Other Email ":

` (tick), [ (left square bracket), ] (right square bracket), and \ (backslash)

System Administration - Forms and Field Descriptions

Page 687 of 944
Proprietary to STR Software
User Destination

This is the user who runs the request. If this query is used then the user’s information is pulled from the users
“Human Resources” table in the following areas of the Oracle database.

• PER_ALL_PEOPLE_F.EMAIL_ADDRESS
• PER_ALL_PEOPLE_F.FIRST_NAME+LAST_NAME
Secure Other Email Destination

A hard-coded email address that will be used for documents sent via the AventX MailSC secure document
delivery device.

BI Publisher Recipient Destination

The BI Publisher destination query queries the following location for fax, email, and print destinations.

FAX_DM_DATA.RECIPIENT

Supplier Document Destination Queries

As Requests for Quotation and Purchase Orders both use information from the Vendor Sites and Vendor
Contacts tables, their configurations for default delivery method and email address are the same.

For Requests for Quotation (RFQs) and/or Purchase Orders (POs), there are two different types of queries
that can be performed to extract the desired destination information. The type of query to be performed for
RFQs and/or POs, using the Automatic, Interactive Delivery, Stand Alone Interactive Delivery, or Delivery
Manager method is configured via the AventX Configuration form.

This section discusses each type of query and the requirements needed in setting up suppliers' (sites and/or
contacts) for AventX to properly retrieve a single destination’s information from Oracle EBS.

System Administration - Forms and Field Descriptions

Page 688 of 944
Proprietary to STR Software
Preferred Method of Delivery
The “Preferred Method of Delivery” is a concept in AventX that defines how the person in need of the
document “prefers” to receive the document. AventX supports the following values for the preferred method
of delivery.

Transmission Type Values Description

ALL Fax, Email and Print

E Email

S Secure Email

F Fax

P Print

I or IGNORE or SKIP This type will cause the query to simply ignore the
destination in the query. No record of the transaction will
be kept when the document has multiple recipients. In the
event this is the only recipient and no others are pulled you
will see a record in AventX transmission status table that
states, “The request contained no destinations.”

N, NO, or NOOP This transmission type will extract the destination, log
information into the AventX transmission status tables but
not deliver the document to the recipient. The message
will read like the following: “This destination had a delivery
type of 'No Op' and was not processed.”

FSP Fax, Secure Email and Print

EP Email and Print

FE Fax and Email

FP Fax and Print

FS Fax and Secure

Buyer Destination
The buyer query pulls the purchase order buyer name and email address from the following Oracle tables.

• PER_ALL_PEOPLE_F.EMAIL_ADDRESS
• PER_ALL_PEOPLE_F.FIRST_NAME+LAST_NAME

System Administration - Forms and Field Descriptions

Page 689 of 944
Proprietary to STR Software
Vendor Site Destination
The AventX Vendor Site Query pulls the destination information from the following location in Oracle EBS
v11.5.10 and R12.

• Fax = PO_VENDOR_SITES_ALL.FAX_AREA_CODE+FAX
• E-mail = PO_VENDOR_SITES_ALL.EMAIL_ADDRESS
• Name = PO_VENDORS.VENDOR_NAME
• Transmission type = PO_VENDOR_SITES_ALL.SUPPLIER_NOTIF_METHOD

System Administration - Forms and Field Descriptions

Page 690 of 944
Proprietary to STR Software
The AventX Vendor Site Query pulls the destination information from the following location in Oracle EBS
vR12.

The AventX Vendor Site query extracts the fax number or email address from the PO_VENDOR_SITES_ALL
table for the Supplier associated with each RFQ or PO, as shown below. The query is based on the value
found as the default delivery method for RFQs and POs. We will refer to the standard field,
SUPPLIER_NOTIF_METHOD, in our examples.

If the SUPPLIER_NOTIF_METHOD = “Fax”, the fax number is retrieved from the FAX_AREA_CODE and FAX
fields of the PO_VENDOR_SITES_ALL table.

If the SUPPLIER_NOTIF_METHOD = “E-mail”, the email address is retrieved from the EMAIL_ADDRESS field of
the PO_VENDOR_SITES_ALL table. Additionally, the ATTRIBUTE2 (flex field) is checked and if a value of “S” is
returned, the email is flagged as a secure delivery.

If the SUPPLIER_NOTIF_METHOD = “Printed Document”, the default printer name for the Oracle user is
retrieved from FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”).

If the SUPPLIER_NOTIF_METHOD = blank (null), AventX will use FAX as the default delivery method, and the
fax number is retrieved from the FAX_AREA_CODE and FAX fields of the PO_VENDOR_SITES_ALL table.

Therefore, it is necessary to set up each supplier (vendor) site with the desired Supplier Notification Method
(Fax, Email, or Printed Document), along with the necessary fax and/or email information for that site as
indicated above. An example of this is shown below.

If the appropriate field (for the specified default delivery method) is blank (null), AventX will fail to extract
any destination information and will post an error. When using Interactive Delivery or Stand Alone Interactive
Delivery, this error will appear in the Delivery Address block on the AventX Interactive Delivery form. If
desired, the user can then specify destination information and submit the document to AventX for
System Administration - Forms and Field Descriptions
Page 691 of 944
Proprietary to STR Software
processing. When using Automatic Delivery, this error will prevent the document from being submitted to
the document delivery system, and the error will be displayed in the appropriate record on the AventX
Delivery Status form.

Setting Up a Supplier for Secure and Confirmed Email Delivery (11.5.10)

For secure email delivery, it is necessary to have a flex field set aside for use in indicating whether this
supplier requires secure email delivery. Any flex field may be used. Since this is at the Vendor Site level, both
RFQs and POs will use this setting to determine if the email delivery is secure. If this flex field is populated
with an “S”, then the delivery is flagged as “secure”. Configure the flex fields following Oracle standards;
sample screen shots are provided for reference below.

System Administration - Forms and Field Descriptions

Page 692 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 693 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 694 of 944
Proprietary to STR Software
Lastly, for secure delivery only, you must also indicate if this is a secure email. This query is based on the
value found in a flex field. If the value is “S” then the email is flagged as a secure transmission. We will refer
to the flex field as ATTRIBUTE2 in our examples.

System Administration - Forms and Field Descriptions

Page 695 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 696 of 944
Proprietary to STR Software
Setting Up a Supplier for Secure and Confirmed Email Delivery (R12.x)
If the SUPPLIER_NOTIF_METHOD = “Secure”, the email address is retrieved from the EMAIL_ADDRESS field of
the PO_VENDOR_SITES_ALL table, and the email is flagged as a “secure” transmission. “Secure” is not a
standard supplier notification method for Oracle EBS. However, in R12, you can easily add this value using
the Purchasing Lookup Codes for DOCUMENT_COMMUNICATION_METHOD. As the Purchasing Super User,
Navigate to Setup→Purchasing→Lookup Codes. Search for DOCUMENT_COMMUNICATION_METHOD, and
enter a new value of “Secure” as shown below.

AventX supports the following values for the “Preferred Method of Delivery”. Any of the following values as
outlined in the “Preferred Method of Delivery” section are supported for the
“DOCUMENT_COMMUNICATION_METHOD”.

System Administration - Forms and Field Descriptions

Page 697 of 944
Proprietary to STR Software
Vendor Contact Destination
The AventX Vendor Contact works basically the same in Oracle EBS 11.5.0 and R12. The query pulls from the
following locations in the Oracle Database.

• Fax = PO_VENDOR_CONTACTS.FAX_AREA_CODE, FAX

• E-mail = PO_VENDOR_CONTACTS.EMAIL_ADDRESS
• Name = PO_VENDOR_CONTACTS.FIRST_NAME, LAST_NAME
• Company Name = PO_VENDORS.VENDOR_NAME
• Transmission Type (11i10) = PO_VENDOR_CONTACTS.TITLE (or ATTRIBUTEn*)
Transmission Type (R12) = HOC.JOB_TITLE (or ATTRIBUTEn*)
There is no place in Oracle to edit flex fields for the Vendor Contact. By default, AventX searches for title (or
attributeN) for 11i or job_title (or attributeN) value for R12 or R12.1 of one of the following transmission
types.
Value Default Delivery Method is

F / FAX Fax

E / EMAIL Email

S / SECURE Secure Email

FE / FAXEMAIL Fax and Email

FS / FAXSECURE Fax and Secure Email

FP / FAXPRINT Fax and Print

EP / EMAILPRINT Email and Print

SP / SECUREPRINT Secure Email and Print

ALL / FEP / FAXEMAILPRINT Fax, (non-secure) Email and Print (Note: All is
used for backwards compatibility for older
versions of AventX)

FSP / FAXSECUREPRINT Fax, Secure Email and Print

P / PRINT Print
The following screen shots illustrate where and how in Oracle EBS 11.5.10 the Vendor Contact is configured.

System Administration - Forms and Field Descriptions

Page 698 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 699 of 944
Proprietary to STR Software
In the following 11.5.10 example, it illustrates how a Vendor Contact of “George Caprice” contact’s TITLE is
configured with the value expected by AventX for EMAIL. The title field shows a value of EMAIL. Any value as
defined in the “Preferred Method of Delivery” section is supported in the TITLE field. This feature works the
same in R12.x; additional R12 specific screen shots are provided later.

FAX_AREA_COD FAX EMAIL_ADDRESS

E
The following screen shot shows how a Vendor Contact is configured for use with AventX in R12.x.

System Administration - Forms and Field Descriptions

Page 700 of 944
Proprietary to STR Software
For Oracle EBS R12.x, the Vendor Contacts must be properly created/defined in Oracle EBS to be available to
AventX via the standard Vendor Contact or All Vendor Contacts queries. Per Oracle EBS, the Vendor Contact
must be associated with a Vendor Site (please refer to Oracle Note: POXPOEPO Supplier Contact Field List of
Values Contains No Entries (Doc ID 455988.1)).

The default query uses the Vendor Contact’s TITLE field to define the contact’s preferred method of delivery.
This can be changed by modifying the contents of the $FCHOME/.fcoa_cfg_<SID> file to change the field the
query looks for the Vendor Contact’s preferred method of delivery.

Commencing with AventX version 7.9.00, it is a requirement that the Vendor Contact's Inactive Date not have
expired. Vendor Contacts whose Inactive Date has expired will not be included in the Vendor Contact LOV or
returned in the All Vendor Contacts destination query.

Commencing with AventX version 7.10.00, it is a requirement that the fax/email address record in Oracle EBS
be "active" for the vendor contact destination to be returned. Fax/email records in Oracle EBS that are
"inactive" (e.g. the user deleted the contact's fax number and then later added a new fax number - the
original fax number would be recorded as "inactive" by Oracle EBS) do not qualify to be returned in the
Vendor Contact destination query. Oracle EBS does not display "inactive" fax/email records on its Supplier
Contact page.

The AventX Vendor Contact Query uses the TITLE field to store the Vendor Contacts Preferred Method of
Delivery. All values as outlined the “Preferred Method of Delivery” section are supported in the TITLE field.
The following describes more about the data entry requirements for the Vendor Contact Query.

• If the TITLE_FIELD = “F” or “FAX”, the fax number is retrieved from the FAX_AREA_CODE and FAX fields of
the PO_VENDOR_CONTACTS table for this record, and the contact information is retrieved from the
LAST_NAME and FIRST_NAME fields of the PO_VENDOR_CONTACTS table for this record.

System Administration - Forms and Field Descriptions

Page 701 of 944
Proprietary to STR Software
• If the TITLE_FIELD = “E” or “EMAIL”, the email address is retrieved from the EMAIL_ADDRESS field of the
PO_VENDOR_CONTACTS table for this record, and the contact information is retrieved from the
LAST_NAME and FIRST_NAME fields of the PO_VENDOR_CONTACTS table for this record. Note: In this
case, the email will NOT be a secure transmission.
• If the TITLE_FIELD = “S” or “SECURE”, the email address is retrieved from the EMAIL_ADDRESS field of the
PO_VENDOR_CONTACTS table for this record, and the contact information is retrieved from the
LAST_NAME and FIRST_NAME fields of the PO_VENDOR_CONTACTS table for this record. Additionally,
the email destination will receive the document as a secure transmission.
• If the TITLE_FIELD = “FE” or “FAXEMAIL”, the fax number is retrieved from the FAX_AREA_CODE and FAX
fields of the PO_VENDOR_CONTACTS table for this record, the email address is retrieved from the
EMAIL_ADDRESS field of the PO_VENDOR_CONTACTS table for this record, and the contact information is
retrieved from the LAST_NAME and FIRST_NAME fields of the PO_VENDOR_CONTACTS table for this
record. Note: In this case, the email will NOT be a secure transmission.
• If the TITLE_FIELD = “FS” or “FAXSECURE”, the fax number is retrieved from the FAX_AREA_CODE and FAX
fields of the PO_VENDOR_CONTACTS table for this record, the email address is retrieved from the
EMAIL_ADDRESS field of the PO_VENDOR_CONTACTS table for this record, and the contact information is
retrieved from the LAST_NAME and FIRST_NAME fields of the PO_VENDOR_CONTACTS table for this
record. Additionally, the email destination will receive the document as a secure transmission.
• If the TITLE_FIELD = “FP” or “FAXPRINT”, the fax number is retrieved from the FAX_AREA_CODE and FAX
fields of the PO_VENDOR_CONTACTS table for this record, the default printer name for the Oracle user is
retrieved from FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”), and
the contact information is retrieved from the LAST_NAME and FIRST_NAME fields of the
PO_VENDOR_CONTACTS table for this record.
• If the TITLE_FIELD = “EP” or “EMAILPRINT”, the email address is retrieved from the EMAIL_ADDRESS field
of the PO_VENDOR_CONTACTS table for this record, the default printer name for the Oracle user is
retrieved from FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”), and
the contact information is retrieved from the LAST_NAME and FIRST_NAME fields of the
PO_VENDOR_CONTACTS table for this record. Note: In this case, the email will NOT be a secure
transmission.
• If the TITLE_FIELD = “SP” or “SECUREPRINT”, the email address is retrieved from the EMAIL_ADDRESS
field of the PO_VENDOR_CONTACTS table for this record, the default printer name for the Oracle user is
retrieved from FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”), and
the contact information is retrieved from the LAST_NAME and FIRST_NAME fields of the
PO_VENDOR_CONTACTS table for this record. Additionally, the email destination will receive the
document as a secure transmission.
• If the TITLE_FIELD = “ALL”, “FEP”, or “FAXEMAILPRINT”, the fax number is retrieved from the
FAX_AREA_CODE and FAX fields of the PO_VENDOR_CONTACTS table for this record, the email address is
retrieved from the EMAIL_ADDRESS field of the PO_VENDOR_CONTACTS table for this record, the default
printer name for the Oracle user is retrieved from FND_PROFILE_OPTION_VALUES table (where
PROFILE_OPTION_VALUE = “PRINTER”), and the contact information is retrieved from the LAST_NAME

System Administration - Forms and Field Descriptions

Page 702 of 944
Proprietary to STR Software
 and FIRST_NAME fields of the PO_VENDOR_CONTACTS table for this record. Note: In this case, the email
will NOT be a secure transmission.
• If the TITLE_FIELD = “FSP”, or “FAXSECUREPRINT”, the fax number is retrieved from the FAX_AREA_CODE
and FAX fields of the PO_VENDOR_CONTACTS table for this record, the email address is retrieved from
the EMAIL_ADDRESS field of the PO_VENDOR_CONTACTS table for this record, the default printer name
for the Oracle user is retrieved from FND_PROFILE_OPTION_VALUES table (where
PROFILE_OPTION_VALUE = “PRINTER”), and the contact information is retrieved from the LAST_NAME
and FIRST_NAME fields of the PO_VENDOR_CONTACTS table for this record. Additionally, the email
destination will receive the document as a secure transmission.
• If the TITLE_FIELD = “P” or “PRINT”, the default printer name for the Oracle user is retrieved from
FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”).
It is necessary to create an entry for the appropriate contact for each supplier (vendor) site with a Title of one
of the delivery methods mentioned above, making sure to specify the fax number or email address for the
contact if the goal is to send a copy of the document to the Supplier Contact versus the Supplier Site
company destinations.

In the example above, George Caprice is listed twice as a contact, the first with a title of “Sales Rep.”, and the
second with a title of “EMAIL”. This is perfectly acceptable, and the preferred method for the Vendor Contact
query. This method allows for the correct fax information and the correct phone information to exist for each
contact.

It is important to note that the Vendor Contact query only returns ONE destination, even if you have defined
more than one contact with the same TITLE. Consider the following contact list as an example for Supplier
Site STR Software RICHMOND:

LAST_NAME FIRST_NAME TITLE_FIELD

Gustin Randy Sales Rep.

Gustin Randy FAX

Lowe Brent Sales Rep.

Lowe Brent EMAIL

Soles Tina Sales Rep.

Soles Tina FAX

Chappell Ted Sales Rep.

Chappell Ted PRINT

Bruno Ben President

Bruno Ben FE

System Administration - Forms and Field Descriptions

Page 703 of 944
Proprietary to STR Software
In this case where there is more than one contact containing a valid preferred method of delivery in the title
field, AventX will use a ranking criterion to return the single destination. The first criterion for ordering is
ranking by default delivery method (Title in this example). Entries with the highest ranking are ordered
alphabetically ascending by last name. Ranking is determined for the default delivery method. The ranking
order is as follows:

• I or IGNORE, SKIP, N, NO, or NOOP

• F / FAX
• E / EMAIL
• S / SECURE (Email)
• FE / FAXEMAIL
• FS / FAXSECURE
• FP / FAXPRINT
• EP / EMAILPRINT
• SP / SECUREPRINT
• ALL / FEP / FAXEMAILPRINT (Note: ‘All’ is used for backwards compatibility for older versions of
AventX, and indicates fax, non-secure email, and print)
• FSP / FAXSECUREPRINT
• PRINT
The second criterion for ordering is alphabetically ascending by Last Name.

In the example above, there are two contacts with a default delivery method of FAX; Randy Gustin and Tina
Soles. In this case, AventX will extract the destination information (fax number, name, etc.) for Randy Gustin.

If no contacts are found with a specified default delivery method (Title in this example) for one of the
possible values listed above, AventX will fail to extract any destination information and will post an error.
When using Interactive Delivery or Stand Alone Interactive Delivery, this error will appear in the Delivery
Address block on the AventX Interactive Delivery form. If desired, the user can then specify destination
information and submit the document to AventX for processing. When using Automatic Delivery, this error
will prevent the document from being submitted to the document delivery system, and the error will be
displayed in the appropriate record on the AventX Delivery Status form.

System Administration - Forms and Field Descriptions

Page 704 of 944
Proprietary to STR Software
PO Approval Recipient Query (All EBS Versions)
The Approve Document form includes information specific to the faxing, emailing and printing of documents,
whereby a user can select any or all document delivery methods by clicking in the proper checkbox on the
form. AventX can be configured to deliver documents via fax, email or print using this PO Approval method.
This is accomplished by executing the PO Approval Query.

The type of information extracted (fax number, email address, printer information) is dependent upon the
information contained in document’s organization configuration. In summary, this destination query pulls
information from the following locations in the Oracle database.

• Fax = FND_CONCURRENT_REQUESTS.ARGUMENTn
• Email = FND_CONCURRENT_REQUESTS.ARGUMENTn
• Print = FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”)

System Administration - Forms and Field Descriptions

Page 705 of 944
Proprietary to STR Software
Faxing
When the document is approved, a separate concurrent request is generated for the faxed document.
AventX uses the information from the parameters specified for the concurrent request (stored in
FND_CONCURRENT_REQUESTS) to determine that this document is to be faxed. The information contained in
the FAX_POA_CONFIG table specifies which concurrent request parameters should be evaluated in
determining that this is a faxable document.

For fax documents, if the FAX_POA_CONFIG table specifies information that this document is faxable, the fax
number is extracted from the FND_CONCURRENT_REQUESTS.ARGUMENTn field, where ARGUMENTn is the
numbered field where the fax number is stored. (For the default Purchase Order Approval report, the fax
number is stored in ARGUMENT8.)

FND_CONCURRENT_REQUESTS.ARGUMENT8

System Administration - Forms and Field Descriptions

Page 706 of 944
Proprietary to STR Software
Emailing
When emailing a document, a separate concurrent request is forwarded to the Oracle Applications Workflow
Mailer.

To email a document using AventX, Oracle Applications Workflow will need to be modified to include AventX
in the workflow. Additionally, new parameters must be created (and the information entered in the
FAX_POA_CONFIG table) as a trigger that the document is to be emailed.

Once this has been accomplished, AventX uses the information from the parameters specified for the
workflow request to determine that this document is to be emailed. The information contained in the
FAX_POA_CONFIG table specifies which workflow request parameters should be evaluated in determining
that the document is to be emailed.

For email documents, if the FAX_POA_CONFIG table specifies information that this document is to be
emailed, the email address is extracted from the FND_CONCURRENT_REQUESTS.ARGUMENTn field, where
ARGUMENTn is the numbered field where the email address is stored.

Additionally, a check is made using the flex field for secure delivery (as entered during setup.sh, e.g.,
ATTRIBUTE2 of the PO_VENDOR_SITES_ALL table) to determine if this email should be a secure transmission.
If populated with an ‘S’, the email is designated as “secure”.

FND_CONCURRENT_REQUESTS.ARGUMENTn

Figure 0-1 PO Approval Emailing a Document

Printing

System Administration - Forms and Field Descriptions

Page 707 of 944
Proprietary to STR Software
When printing a document from the Approve Document form, a separate concurrent request is generated
when the document is approved. AventX uses the information from the parameters specified for the
concurrent request (stored in FND_CONCURRENT_REQUESTS) to determine that this document is to be
printed. The information contained in the FAX_POA_CONFIG table specifies which concurrent request
parameters should be evaluated in determining that this is a printable document.

When printing a document, the default printer name for the Oracle user is retrieved from
FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”).

System Administration - Forms and Field Descriptions

Page 708 of 944
Proprietary to STR Software
Fax Enable Destination
The “Fax Enable” query queries the following location.

• FND_CONCURRENT_REQUESTS.ARGUMENTn
This is the value “activated” by Oracle when the following field is set to “Yes” on the default “Printed
Purchase Order” report is run.

System Administration - Forms and Field Descriptions

Page 709 of 944
Proprietary to STR Software
Customer Document Destination Queries

Sales Order Acknowledgements, Invoices, and Statements all use information from the Customer Contacts
tables. The default delivery method is configured for each customer contact for each document type. Email
addresses are tied to the customer contacts, so they will be the same for these document types by customer
contact.

Creating the Descriptive Flex Field

One of the required steps to using the AventX seeded Customer Contact Query is to create a descriptive
flexfield that will store the customer’s preferred method (fax, email, print, etc.) of delivery. Information on
how to create descriptive flex fields is provided below. Consult Oracle’s documentation for more information
if required. https://docs.oracle.com/cd/E18727_01/doc.121/e12892/T354897T361277.htm

The flex field is attached to the Contact Roles portion at the Customer Site level. Any flex field may be used;
the restriction is that the name of the flex field segment be "Transmission Type". Since the flex field is
attached to the Contact Role, there can be separate Customer Contacts for sales order acknowledgements,
invoices, and statements. There may be multiple Customer Contacts for each type of document as well. It is
not necessary to have the email address for Customer in a flex field set aside for that use. The
"email_address" field must contain the email address. This destination applies to SOAs, INVs and STMTs for
this Customer Contact.

The following provides a screen shot walk through of creating the descriptive flex field. The steps provided
are the same steps for Oracle EBS 11i and R12.

System Administration - Forms and Field Descriptions

Page 710 of 944
Proprietary to STR Software
Log into Oracle EBS as a user that has the System Administrator responsibility. Navigate to the “Application >
Flexfield > Descriptive > Segments” menu item.

Launch the form and query for the “Receivables” application and the title of “Contact Role Information”.
Uncheck the “Freeze Flexfield Definition”

System Administration - Forms and Field Descriptions

Page 711 of 944
Proprietary to STR Software
Click on “Segments” and then click the “New” button to create a new segment named “Transmission Type”
based on the following screen shot.

Click “Value Set”. If you see the following warning then it is ok. You will fix this later. Click “Ok”

System Administration - Forms and Field Descriptions

Page 712 of 944
Proprietary to STR Software
Ensure the “Transmission Type” form looks like the following screenshot and click “Ok”.

Click “Save” and close the form. You should now be back on the “Segments (Contact Role Information) form.
Fill in the value for “Value Set” with the “Transmission Type” value set that was just created. Click “Save”.

System Administration - Forms and Field Descriptions

Page 713 of 944
Proprietary to STR Software
Close the forms until you are back at the main “Descriptive Flexfield Segments” form. Make sure the “Freeze
Flexfield Definition” is checked and then “Compile”.

A similar screenshot to the following should be displayed.

System Administration - Forms and Field Descriptions

Page 714 of 944
Proprietary to STR Software
You can view your request to ensure the request completed successfully.

Exit out to the “System Administrator” menu and click the “Values” menu item. Query for the recently
created “Descriptive Flex Field” value.

For R12.2, new security measures are in place to only allow certain user’s access to specific transmission
types. Your user will need this access to add values to the new value set. Oracle documentation discusses
this new security feature in more detail. See “Flexfield Value Set Security” in the “Oracle E-Business Suite
Flexfields Guide” for more information on this topic. One approach, although it is not recommended for
production use, is to enable the “Flexfield Value Set Security: All Privileges” to your user. This is done by going
to the “User Management” responsibility and adding this role to your user.

System Administration - Forms and Field Descriptions

Page 715 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 716 of 944
Proprietary to STR Software
Enter in the values per the screen shot and table below.

The following is a representation of the transmission types that are available for this descriptive flex field.

Transmission Type Description Comments

Values

ALL Email, Fax, and Print

E Email Only via Standard Email

S Email Only via Secure and Confirmed

Email

F Fax Only

P Print

I or IGNORE or SKIP Ignore or Skip Transmitting to this This type will cause the query to
Person simply ignore the destination in
the query. No record of the
transaction will be kept when the
document has multiple recipients.

System Administration - Forms and Field Descriptions

Page 717 of 944
Proprietary to STR Software
 In the event this is the only
recipient and no others are pulled
you will see a record in AventX
transmission status table that
states, “The request contained no
destinations.”

N, NO, or NOOP No delivery. Appears in AventX but will This transmission type will extract
not be delivered the destination, log information
into the AventX transmission
status tables but not deliver the
document to the recipient. The
message will read like the
following: “This destination had a
delivery type of 'No Op' and was
not processed.”

FSP Fax, Secure Email Delivery, and Print

EP Standard Email and Print

FE Fax and Standard Email

FP Fax and Print

FS Fax and Secure

System Administration - Forms and Field Descriptions

Page 718 of 944
Proprietary to STR Software
Customer Contact Destination
Sales Order Acknowledgements, Invoices, and Statements all use information from the Customer Contacts
tables. The default delivery method is configured for each customer contact for each document type. Email
addresses are tied to the customer contacts, so they will be the same for these document types by customer
contact.

The query used is based on the Customer (contact) tables. This section discusses the customer (contact)
query and the requirements needed in setting up customer contacts for AventX to properly retrieve a single
from Oracle EBS.

In summary the customer contact query queries for information in the following Oracle database tables.

• Fax = AR_PHONES_V.AREA_CODE+PHONE_NUMBER
• Email = AR_PHONES_V.EMAIL_ADDRESS
• Name = AR_CONTACTS_V.FIRST_NAME+LAST_NAME
• Company Name = AR_CUSTOMERS.CUSTOMER_NAME
• Transmission Type = AR_CONTACT_ROLES_V.ATTRIBUTEn

System Administration - Forms and Field Descriptions

Page 719 of 944
Proprietary to STR Software
Oracle EBS 11.5.10
There are several "pre-requisites" necessary for a customer (contact) to be valid for use with AventX.

1. The site_use_code="Bill To". The “Identifying Address” flag must be set. These are requirements only for
SOAs. They do not apply to nor affect INVs or STMTs.
2. The desired customer contact must have a status of “Active" (the record for the contact must have the
"Active" checkbox checked).
3. The desired customer contact must have the appropriate role (i.e. "Acknowledgments", "Invoices" or
"Statements"). The contact_id with the document is used, when specified. The default delivery method
must be specified in the flex field for the appropriate role.
4. For each customer contact, the fax number or email address must be both of purpose="Business" and
"preferred", as shown below.

The Customer (contact) query extracts the fax number from the AR_PHONES_V view or the emailaddress
from the AR_CONTACTS_V view for the Customer Contact associated with each SOA, INV, or STMT. The query
is based on the value found in a flex field attached to a specific Contact Role
(Acknowledgments/Invoices/Statements) at the Customer Site level. Any flex field may be used; the
restriction is that the name of the flex field segment be "Transmission Type". The flex field name is chosen
during the execution of setup.sh.

System Administration - Forms and Field Descriptions

Page 720 of 944
Proprietary to STR Software
The flex field (hereafter referred to as “Transmission Type”) in the AR_CONTACT_ROLES_V view defines the
default delivery method to be used with AventX. An example is shown in the figure below.

If Transmission Type = “F” or “FAX”, the fax number is retrieved from the AREA_CODE and PHONE_NUMBER
fields of the AR_PHONES_V table where the purpose="Business" and "preferred", and the contact
information is retrieved from the LAST_NAME and FIRST_NAME fields of the AR_CONTACTS_V table for this
record, as shown in the figure below.

System Administration - Forms and Field Descriptions

Page 721 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 722 of 944
Proprietary to STR Software
If Transmission Type = “E” or “EMAIL”, the email address is retrieved from the EMAIL_ADDRESS field of the
AR_CONTACTS_V table for this record where the purpose="Business" and "preferred", and the contact
information is retrieved from the LAST_NAME and FIRST_NAME fields of the AR_CONTACTS_V table for this
record, as shown below. In this case, the email will NOT be a secure transmission.

System Administration - Forms and Field Descriptions

Page 723 of 944
Proprietary to STR Software
Oracle EBS R12.x
All requirements for Oracle EBS 11.5.10 must be met with the following exception. For each customer
contact, the fax number or email address must be a purpose="Business" and "Primary", as shown below.

System Administration - Forms and Field Descriptions

Page 724 of 944
Proprietary to STR Software
The following is where the flex field value is configured for an R12 customer.

System Administration - Forms and Field Descriptions

Page 725 of 944
Proprietary to STR Software
The following shows where fax number information is obtained if the transmission type is “F” or “FAX”.

If Transmission Type = “E” or “EMAIL”, the email address is retrieved from the EMAIL_ADDRESS field of the
AR_CONTACTS_V table for this record where the purpose="Business", and the contact information is
retrieved from the LAST_NAME and FIRST_NAME fields of the AR_CONTACTS_V table for this record, as
shown below.

With version 12.0.0, there is no “Preferred” checkbox displayed on the Customer self-service form, even
though the field still exists in the database. This is metalink bug #6022394. Therefore, AventX Oracle
Connector does NOT check this condition.

System Administration - Forms and Field Descriptions

Page 726 of 944
Proprietary to STR Software
For All Oracle EBS Versions
If Transmission Type = “S” or “SECURE”, the email address is retrieved from the EMAIL_ADDRESS field of the
AR_CONTACTS_V table for this record where the purpose="Business", and the contact information is
retrieved from the LAST_NAME and FIRST_NAME fields of the AR_CONTACTS_V table for this record.
Additionally, the email destination will receive the document as a secure transmission.

If Transmission Type = “FE” or “FAXEMAIL”, the fax number is retrieved from the AREA_CODE and
PHONE_NUMBER fields of the AR_PHONES_V table where the purpose="Business", the email address is
retrieved from the EMAIL_ADDRESS field of the AR_CONTACTS_V table for this record where the
purpose="Business" and "preferred", and the contact information is retrieved from the LAST_NAME and
FIRST_NAME fields of the AR_CONTACTS_V table for this record. Note: In this case, the email will NOT be a
secure transmission.

If Transmission Type = “FS” or “FAXSECURE”, the fax number is retrieved from the AREA_CODE and
PHONE_NUMBER fields of the AR_PHONES_V table where the purpose="Business", the email address is
retrieved from the EMAIL_ADDRESS field of the AR_CONTACTS_V table for this record where the
purpose="Business" and "preferred", and the contact information is retrieved from the LAST_NAME and
FIRST_NAME fields of the AR_CONTACTS_V table for this record. Additionally, the email destination will
receive the document as a secure transmission.

If Transmission Type = “FP” or “FAXPRINT”, the fax number is retrieved from the AREA_CODE and
PHONE_NUMBER fields of the AR_PHONES_V table where the purpose="Business", the default printer name
for the Oracle user is retrieved from FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE =
“PRINTER”), and the contact information is retrieved from the LAST_NAME and FIRST_NAME fields of the
AR_CONTACTS_V table for this record.

If Transmission Type = “EP” or “EMAILPRINT”, the email address is retrieved from the EMAIL_ADDRESS field
of the AR_CONTACTS_V table for this record where the purpose="Business", the default printer name for the
Oracle user is retrieved from FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE =
“PRINTER”), and the contact information is retrieved from the LAST_NAME and FIRST_NAME fields of the
AR_CONTACTS_V table for this record. Note: In this case, the email will NOT be a secure transmission.

If Transmission Type = “SP” or “SECUREPRINT”, the email address is retrieved from the EMAIL_ADDRESS field
of the AR_CONTACTS_V table for this record where the purpose="Business", the default printer name for the
Oracle user is retrieved from FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE =
“PRINTER”), and the contact information is retrieved from the LAST_NAME and FIRST_NAME fields of the
AR_CONTACTS_V table for this record. Additionally, the email destination will receive the document as a
secure transmission.

If Transmission Type = “ALL”, “FEP”, or “FAXEMAILPRINT”the fax number is retrieved from the AREA_CODE
and PHONE_NUMBER fields of the AR_PHONES_V table where the purpose="Business", the email address is
retrieved from the EMAIL_ADDRESS field of the AR_CONTACTS_V table for this record where the
purpose="Business" and "preferred", the default printer name for the Oracle user is retrieved from
FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”), and the contact
information is retrieved from the LAST_NAME and FIRST_NAME fields of the AR_CONTACTS_V table for this
record. Note: In this case, the email will NOT be a secure transmission.

System Administration - Forms and Field Descriptions

Page 727 of 944
Proprietary to STR Software
If Transmission Type = “FSP”, or “FAXSECUREPRINT”the fax number is retrieved from the AREA_CODE and
PHONE_NUMBER fields of the AR_PHONES_V table where the purpose="Business", the email address is
retrieved from the EMAIL_ADDRESS field of the AR_CONTACTS_V table for this record where the
purpose="Business" and "preferred", the default printer name for the Oracle user is retrieved from
FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”), and the contact
information is retrieved from the LAST_NAME and FIRST_NAME fields of the AR_CONTACTS_V table for this
record. Additionally, the email destination will receive the document as a secure transmission.

If Transmission Type = “P” or “PRINT”, the default printer name for the Oracle user is retrieved from
FND_PROFILE_OPTION_VALUES table (where PROFILE_OPTION_VALUE = “PRINTER”).

If Transmission Type = blank (null), AventX will use FAX as the default delivery method, and the fax number is
retrieved from the AREA_CODE and PHONE_NUMBER fields of the AR_PHONES_V table.

Therefore, it is necessary to create an entry for the appropriate contact for each customer (site) using one of
the transmission type values listed above, making sure to specify the fax number or email address for the
contact.

It is important to note that the Customer (contact) query only returns ONE destination, even if you have
defined more than one contact with the appropriate role (i.e. “Acknowledgments”, "Invoices", or
"Statements"), a flex field value of one of the aforementioned values, and more than one fax number or
email address for the chosen contact. Consider the following contact list as an example for Customer STR
Software RICHMOND, where ATTRIBUTE1 is used as the flex field:

LAST_NAME FIRST_NAME ATTRIBUTE1 ROLE

Gustin Randy F Acknowledgements

Lowe Brent E Invoices

Soles Tina E Statements

Soles Tina <blank> Bill To

Chappell Ted F Invoices

Chappell Ted E Statements

Adams Jane P Statements

Bruno Ben ALL Statements

For SOAs, INVs and STMTs, where there is more than one contact with the appropriate role and containing a
valid delivery method for ATTRIBUTE1, the destination information is retrieved as follows:

The first criterion for ordering is the contact role (i.e. "Acknowledgments", "Invoices" or "Statements").

System Administration - Forms and Field Descriptions

Page 728 of 944
Proprietary to STR Software
The second criterion for ordering is ranking by default delivery method (ATTRIBUTE1 in this example).
Ranking is determined for the default delivery method. The ranking order is as follows.
• I or IGNORE, SKIP, N, NO, or NOOP
• F / FAX
• E / EMAIL
• S / SECURE (Email)
• FE / FAXEMAIL
• FS / FAXSECURE
• FP / FAXPRINT
• EP / EMAILPRINT
• SP / SECUREPRINT
• ALL / FEP / FAXEMAILPRINT (Note: ‘All’ is used for backwards compatibility for older versions of
AventX, and indicates fax, non-secure email, and print)
• FSP / FAXSECUREPRINT
• PRINT
Entries with the highest ranking are ordered alphabetically ascending by last name. The fax number or email
address will then be selected from those for the contact based on purpose="Business".

In the example above, there is only one contact with a role of “Acknowledgements”: Randy Gustin. Based on
the criteria as listed above, AventX will extract the destination information (fax number, name, etc.) for SOAs
for the contact Randy Gustin. In the example above, there are two contacts with a role of “Invoices”: Brent
Lowe and Ted Chappell. Based on the criteria as listed above, AventX will extract the destination information
(fax number, name, etc.) for INVs for the contact Ted Chappell, as his default delivery method is "F" and
Brent Lowe's is "E". In the example above, there are four contacts with a role of “Statements”: Tina Soles, Ted
Chappell, Ben Bruno and Jane Adams. Based on the criterion as listed above, AventX will extract the
destination information (email address, name, etc.) for Ted Chappell, as his default delivery method is
populated with an E, and his name is listed ahead of Tina Soles when sorted alphabetically by last name.

If no contacts are found with the proper contact role and a specified, valid, default delivery method
(ATTRIBUTE1 in this example), AventX will fail to extract any destination information and will post an error.
When using Interactive Delivery or Stand Alone Interactive Delivery, this error will appear in the Delivery
Address block on the AventX Interactive Delivery form. If desired, the user can then specify destination
information and submit the document to AventX for processing. When using Automatic Delivery, this error
will prevent the document from being submitted to the document delivery system, and the error will be
displayed in the appropriate record on the AventX Delivery Status form.

System Administration - Forms and Field Descriptions

Page 729 of 944
Proprietary to STR Software
Acknowledgements Tab

An acknowledgement consists of a simple report and is issued to an email address. Acknowledgements may
be issued for only the primary destination (see the “Destination” section for more information), or for all
destinations.

Fill in the “Acknowledgements” section of the form as desired. The following table defines the available
parameters for the “Acknowledgements” defaults and their respective values.

Field Description

Acknowledgement Acknowledgements can be issued under one of four conditions: All, Success, Failure
Level or None. The condition is specified by selection in the “Acknowledgement Level”
drop-down list.
• A level of “All” indicates that the acknowledgement will be issued (from your
document delivery system) for both successful and unsuccessful transmissions.
• A level of “Success” indicates that the email report will be issued only for
successful transmissions.
• A level of “Failure” indicates that the email report will be issued only for
unsuccessful transmissions.
• A level of “None” indicates that no email report will be issued.

System Administration - Forms and Field Descriptions

Page 730 of 944
Proprietary to STR Software
 Field Description

Acknowledgements can be issued for either just the primary

destinationdeatinationdestinationdestinationdeatinationdestinationdeatinationdest
ination, or for all destinations.
The checkbox unchecked indicates that acknowledgements will be issued for only
the primary destination.
The checkbox checked indicates that acknowledgements will be issued for all
destinations.

Send To The name and email address that will receive the document transmission report.
Once complete, make sure to File -> Save to keep the newly entered information before proceeding with
further configuration.

Send To - Seeded Acknowledgement Queries

Up to five destinations of the acknowledgement can be defined in the “Send To” list. These entries will
determine how the AventX Interactive Delivery/AventX Stand Alone Interactive Delivery form is pre-
populated for Acknowledgements. It also defines the default acknowledgements for Automatic Delivery.

There are three standard Oracle Applications entries for the “Send To” list:

• Buyer
• Requestor
• User’s Email Address
“Buyer” is used for Request for Quotation, Purchase Order, and Purchase Order Approval document types.
The value returned for this query is dependent on the configuration for Sender on the Misc tab. Please refer
to the discussion on “Sender” on the Misc tab for more information.

“Requestor” is used for Purchase Order and Purchase Order Approval document types.

“User’s Email Address” can be used for any document type. The value returned for this query is dependent
on the configuration for Sender on the Misc tab. Please refer to the discussion on “Sender” on the Misc tab
for more information.

There should only be one entry each for “Buyer”, “Requestor” or “User’s Email Address”, when used.

Another entry, “Other”, is provided to define any other destination. When “Other” is specified, the "Other
Name", and "Other Email" fields are available for input. It is acceptable to have more than one “Other” entry.

Add Your Own Documents may result in additional acknowledgement queries being displayed in the pick list.
These specially defined queries are only available for the document type with which they were defined.

System Administration - Forms and Field Descriptions

Page 731 of 944
Proprietary to STR Software
Any combination of these values may be manually entered or selected from the Edit -> List of Values. The
order of acknowledgement entries is not significant.

Other Name Acknowledgement Query

This query requires you to hard code a name. Using this seeded query will result in the acknowledgement
going to the same destination every time.

You can specify the "To" name for this feature. Valid values are any strings of up to 40 characters.

The following characters are valid in the value returned for "Other Name ":

` (tick) and ' (single quote)

The following characters will be automatically stripped by the appropriate AventX view(s) during command
file generation from the value returned for "Other Name ":

[ (left square bracket), ] (right square bracket), and \ (backslash)

Other Email Acknowledgement query

You can specify the email address for this feature. Valid values are any string of up to 255 characters; must
include user@domain format.

The following characters are valid in the value returned for "Other Email ":

' (single quote)

The following characters will be automatically stripped by the appropriate AventX view(s) during command
file generation from the value returned for "Other Email ":

` (tick), [ (left square bracket), ] (right square bracket), and \ (backslash)

User Acknowledgement Query

User acknowledgement queries will send emails transmission reports to the user who submitted the request.
The AventX “User's Email Address” query pulls its value from “Email_Address” field in the HR tabled called
“per_all_people_f”. Use the following query to view the contents of the table.

select email_address from per_all_people_f;

You can use these steps to change the email address for the employee in the per_all_people_f table.

1. Set the responsibility to HRMS Management in Oracle EBS,

2. Select People > Enter and maintain, Find the Employee, Click on "Office Details" and update the Email
address.
OR
3. You can execute the following statement if you want to update the information using SQL.

update per_all_people_f

System Administration - Forms and Field Descriptions

Page 732 of 944
Proprietary to STR Software
set email_address = '[email protected]'

where full_name = 'Software, STR';

4. Commit the change to the database (Click Commit (F11) in SQL Developer)
The user query may also be dependent on configuration for “Sender” on the Misc tab
Requestor Acknowledgement Query

The requestor query pulls the purchase order requestor name and email address from the following Oracle
tables

• PER_ALL_PEOPLE_F.EMAIL_ADDRESS
• PER_ALL_PEOPLE_F.FIRST_NAME+LAST_NAME
Buyer Acknowledgement Query

The buyer query pulls the purchase order buyer name and email address from the following Oracle tables

• PER_ALL_PEOPLE_F.EMAIL_ADDRESS
• PER_ALL_PEOPLE_F.FIRST_NAME+LAST_NAME
Attachment Types Tab

AventX supports Oracle database attachments for all document types as configured via the AventX Document
Configuration form (Add Document) form. AventX must be configured for these attachments to be included
in the document submission. Any attachments that exist, but are not configured, will not be included in the
document submission.

System Administration - Forms and Field Descriptions

Page 733 of 944
Proprietary to STR Software
After specifying the “Acknowledgements”, proceed to configure the “Attachment Types”. It is recommended
that all sub-options for each document type be defined prior to changing document types.

Choose the “Attachment Types” tab. This allows you to configure the default entries for attachments from
the Oracle database for the selected document type as shown below. If no attachment queries are defined
for the document type (via the AventX Document Configuration form form), the “Attachment Types” tab will
be greyed out (inaccessible).

AventX supports attachments for all document types. On the “Attachment Types” tab, you may configure the
Oracle attachment data types (File or Web Page), and the attachment entity(ies) and associated category(ies)
assigned to that entity for this document type.

Oracle Data Type

The “Oracle Data Type” section contains checkboxes for File and Web Page data types described in the
following table.

Field Description

File This checkbox specifies whether to include attachments of type “File,” which match the
Entity/Category configuration, with the report output.
If unchecked, attachments of this type, though defined/configured for the document within
Oracle EBS, will not be included with the report output processing by AventX.
If checked, attachments of this type, which are defined/configured for the document within
Oracle EBS, will be included with the report output processing by AventX.

Web Page This checkbox specifies whether to include attachments of type “Web Page,” which match the
Entity/Category configuration, with the report output.
If unchecked, attachments of this type, though defined/configured for the document within
Oracle EBS, will not be included with the report output processing by AventX.
If checked, attachments of this type, which are defined/configured for the document within
Oracle EBS, will be included with the report output processing by AventX.
For Oracle EBS, Web Page attachments may be of the following sub-types:
- valid UNC path (CIFS) of format:
\\<domain>\<path>\<filename>
for example:
\\merlin\n\Company\Temp\Part_Diagram.vsd
- valid URL path (CIFS) of formats:
file://<domain>/<path>/<filename>
file://<domain>\<path>\<filename>
smb://<domain>/<path>/<filename>
smb://<domain>\<path>\<filename>

System Administration - Forms and Field Descriptions

Page 734 of 944
Proprietary to STR Software
Field Description
where "file" and "smb" are not case-sensitive
for example:
file://devpc3.strsoftware.com/temp/AXOC_7201.txt
Important Note: Do not use the "\" character for this type of entry. It will cause processing
errors.
HTTP path (non-authenticated); for example:
http://rgts2.gustinlan/str/Product_Installation_Checklist.xls
Important Note: Do not use the "\" character for this type of entry. It will cause processing
errors.
HTTP path (authenticated); for example:
http://sharepoint.str.com/XLS/Product_Specifications.docx
Important Note: Do not use the "\" character for this type of entry. It will cause processing
errors.

System Administration - Forms and Field Descriptions

Page 735 of 944
Proprietary to STR Software
Attachment Entity/Category Mapping

Configuration requires specification of "Attachment Entity"/"Attachment Category" pairs on the form. Values
may be typed or selected from the LOVs. The order of the entries on this form, top to bottom, represent the
order that the attachments will be added to the constructed document (meaning this controls the order
within the delivered document). The parameters and values are described in the following table.

Field Description

Attachment Entity Defines the Oracle EBS entity where the attachment has been
associated with the report output. The LOV contains the valid
entities for the present document type. AventX provides seeded
entities for the RFQ, Purchase Order, Invoice and Work Order
standard document types. The LOV will contain all
defined/configured entity values for any AYOD document types,
as specified via the AventX Document Configuration form form.

Attachment Category Defines the Oracle EBS category to which the attachment applies.
The LOV is as defined for the associated entity by Oracle EBS.

Preselected (Work Orders Only) Defines whether the checkbox next to the Entity/Category pair
for printing of Work Orders functionality should be checked or
unchecked when the user first invokes the form (or custom
controller page) for the printing of attachments.

This applies to Work Order document types only.

System Administration - Forms and Field Descriptions

Page 736 of 944
Proprietary to STR Software
Oracle Attachments Tab

The Oracle Attachments tab specifies extraction methods, authentication information, and search criteria for
web page attachments. If you do not intend to extract web page attachments, no further attachment
configuration is required, and you can proceed to configuring options on the Misc tab, as described in the
next section.

The Oracle Attachments tab is arranged into two sections. The top section allows you to specify and order (by
sequence number) the extraction method(s) and associated authentication information (i.e. Domain, User
Name, and Password. Note: Password is stored in the database as an encrypted string). The bottom section
allows you to specify Domain or Prefix values for the associated extraction method selected in the top
section. The Domain or Prefix values are used to determine for each qualifying web page attachment (i.e.
those that match the Entity/Category specifications from the Attachment Types tab), which extraction
method will be used in retrieving the attachment (file).

By default, three seeded extraction entries are provided:

• NTLMHTTP: HTTP Protocol using NTLM authentication.

• NTLMCIFS: CIFS Protocol using NTLM authentication.
• NTLMSMB2: SMB2 Protocol using NTLM authentication.
Special extraction classes that can be added:

• CifsAxtsExtraction: provided for use in extracting attachments from DFS (and other CIFS) systems when
the seeded CIFS extraction class does not work. This special class is not seeded (i.e. it must be manually
added to the configuration). For this special extraction class, AventX passes all information (e.g.

System Administration - Forms and Field Descriptions

Page 737 of 944
Proprietary to STR Software
 attachment URL, Domain, User Name and Password) to AventX Translation Server, which retrieves and
returns the attachment. This requires AventX Translation Server 5.3.0.0.
• CifsNoAuth: provided for use in extracting attachments from CIFS (SMBv1) with guest access.
• HTTPNoAuth: provided for use in extracting attachments from HTTP Host with no authentication
requirement.
• SPOnline: provided for use in extracting attachments from SharePoint Online. Please see Configuring
AventX Attachment Xpress to Use SharePoint Online for more information.
• GraphFileExtractor: provided for use in extracting attachments from SharePoint Online, and OneDrive for
Business. Please see Configuring AventX Attachment Xpress to Use SharePoint Online for more
information.
Commencing with version 7.4.00 of AventX, it is also possible to specify any number of custom Java classes,
which follow the noted API requirements, to extract attachments. The creation of custom java class is
something customers can perform and use within the software. If you would like STR Software to create a
custom java class for you then please contact our support team and a professional services arrangement can
be considered. This is discussed later in this section.

Commencing with version 8.4.00, AventX Oracle Connector has been updated to allow administrators to
define the order that the configured extraction classes will be evaluated to determine which will be used in
retrieving each web page attachment.

Considerations when using NTLMCIFS – NTLMSMB2:

Both extraction classes are used to extract attachments from SMB protocol host, however NTLMCIFS only
supports SMBv1 and NTLMSMB2 only supports SMBv2 and partial support for SMBv3. STR Software
recommends upgrading your SMBv1 server to at least SMBv2 because CIFS / SMBv1 is no longer supported
and carries a high security risk. NTLMSMB2 may support some DFS configuration.

Considerations when using CifsAxtsExtraction:

This special extraction class should only be used if other classes do not work for your DFS host configuration.

The following tables describe the parameters for the Oracle Attachments tab.

Field Description AventX Table

Seq This value defines the order that AventX will use in FAX_ATT_CLASSES.SEQ
determining which extraction class to execute in
retrieving each web page attachment. Each web page
attachment will be checked against the defined
Domains/Prefixes value(s) for each extraction class by
sequence number. The first match will determine
which extraction class will be executed. This allows for
a hierarchical ordering of extraction classes.

System Administration - Forms and Field Descriptions

Page 738 of 944
Proprietary to STR Software
Field Description AventX Table
With this ordering, it is permissible to have multiple
rows defined using the same extraction class, but
different authentication credentials. An example is
provided later in this section.

Default values are assigned for the two seeded

extraction classes.
If adding a new row, a value is required. Valid values
are any number (e.g. 0.1, 55 etc.).
After data entry for the extraction class, saving the
changes will cause the form canvas to refresh the
listing order by the Seq value.

Description A 256-character field containing a description of the FAX_ATT_CLASSES.DESCRIPTIO

extraction class. N

Default value for the seeded (HTTP) NTLM class is

Seeded AventX NTLM Authenticated Web
Attachment Extraction
Default value for the seeded CIFS class is Seeded
AventX CIFS Attachment Extraction with NTLM
Authentication
Default value for the seeded SMB2 class is Seeded
AventX NTLM Authenticated SMB2 Attachment
Extraction
There is no default value for new entries.
This field is not required and is not modifiable for
seeded entries.

Class A 512-character field containing the full class name. FAX_ATT_CLASSES.CLASS

The extraction class will be used by AventX to retrieve
only those Web Page attachments which match the
specified domain/prefix search key values.
Default value for the seeded NTLM attachment type is
com.strsoftware.AttachmentExtraction.NTLMHTTP
Default value for the seeded CIFS attachment type is
com.strsoftware.AttachmentExtraction.NTLMCIFS
Default value for the seeded SMB2 attachment type is
com.strsoftware.AttachmentExtraction.NTLMSMB2

System Administration - Forms and Field Descriptions

Page 739 of 944
Proprietary to STR Software
Field Description AventX Table
Value for the special extraction class start with
com.strsoftware.AttachmentExtraction + . + the
name of the special extraction class listed above.

There is no default value for new entries.

This is a required field. This field is not modifiable for
the seeded entries.
All custom extraction classes must be located in
$FCHOME/oa/java/lib/custom. These classes are
loaded into AventX each cycle; therefore,
changes/additions to classes do not require a restart
of AventX.
All custom classes must be compatible with the
version of java being used by AventX.
Custom classes may not be contained in jar files.

Domain A 256-character field that specifies the domain on FAX_ATT_CLASSES.DOMAIN

which the attachment file exists, and which will
request and authenticate user credentials when
AventX (via AventX or AventX Translation Server - a
special extraction class) attempts to retrieve a Web
Page attachment using the associated extraction class.
This field is required if authentication is to be
requested.
This information is passed to the java authentication
handler for the seeded HTTP/CIFS extraction classes.
This information is passed to AventX Translation
Server for the special extraction class (included but
not seeded).
Failure by AventX to present the proper
authentication credentials will result in the
attachment not being retrieved, and subsequent
processing of this document submission by AventX
will be aborted. AventX will register the error
condition and write the acknowledgement
information to the FAX_STATUS table.

System Administration - Forms and Field Descriptions

Page 740 of 944
Proprietary to STR Software
Field Description AventX Table

User Name A 256-character field that specifies the domain user FAX_ATT_CLASSES.USERNAME
account that will be provided by AventX with the
"Domain" and "Password".
This field is required if authentication is to be
requested.
Failure by AventX to present the proper
authentication credentials will result in the
attachment not being retrieved and subsequent
processing of this document submission by AventX
will be aborted. AventX will register the error
condition and write the acknowledgement
information to the FAX_STATUS table.

Password A 256-character field that specifies the password for FAX_ATT_CLASSES.PASSWORD

the domain user defined via the User Name field that
will be provided by AventX with the "Domain" and
"User Name".
This password is stored in the database as an
encrypted string
Failure by AventX to present the proper
authentication credentials will result in the
attachment not being retrieved and subsequent
processing of this document submission by AventX
will be aborted. AventX will register the error
condition and write the acknowledgement
information to the FAX_STATUS table.

Enabled Checking this box instructs AventX to include this FAX_ATT_CLASSES.ENABLED

extraction class when determining which class to use
Value of ‘1’ indicates the box is
for the web page file extraction.
checked.

Default value is unchecked for the seeded entries. Value of ‘0’ indicates the box is
unchecked.
If adding a new, custom extraction class, the default is
checked.

System Administration - Forms and Field Descriptions

Page 741 of 944
Proprietary to STR Software
Field Description

Domains (Search Key) Defines the domains for the associated extraction class. There may be any
number of domain search keys for a given extraction class.
Valid values are any domain.
These values are not validated by AventX.
Wildcards are not supported.
Values are case-insensitive and the domain must match exactly the domain
portion of the URL in the Oracle EBS attachment definition.
For example:
Oracle EBS attachment definition:

AventX Configuration:

The domain portion of the URL is defined as follows for the supported URL
formats:
HTTP
http://<domain>/<path>/<filename>

System Administration - Forms and Field Descriptions

Page 742 of 944
Proprietary to STR Software
Field Description
HTTPS
https://<domain>/<path>/<filename>
CIFS
file://<domain>/<path>/<filename>
\\<domain>\<path>\<filename>

Prefixes (Search Key) Defines the prefix string for the associated extraction class. There may be any
number of prefix search keys for a given extraction class.
Valid values are any string. Use caution in specifying the prefix value, that it
ensures a match only for the circumstances desired. For example, a value of "h"
would match all attachments that begin "http://", or a prefix value of "\\" would
match all UNC attachments. Use the Seq value to ensure proper sort order for
determining the extraction class to be used.
These values are not validated by AventX.
Wildcards are not supported.
Values are case-insensitive and the prefix must match exactly the beginning
portion of the URL in the Oracle EBS attachment definition.
For example:
Oracle EBS attachment definition:

AventX Configuration:

System Administration - Forms and Field Descriptions

Page 743 of 944
Proprietary to STR Software
 Field Description

Only one type of search key can be specified for a given extraction class row. For example, if you have already
configured the com.strsoftware.AttachmentExtraction.NTLMHTTP class (for NTLM attachment types) to
search by domain, and you then select the Prefix radio button, you will receive a warning that all existing
domain search keys will be discarded as shown below.

System Administration - Forms and Field Descriptions

Page 744 of 944
Proprietary to STR Software
Clicking Yes will allow you to now configure search keys based upon prefixes instead of domains. Clicking No
will retain your present configuration.

It is permissible to have multiple rows have the same extraction class with different authentication and/or
Domains/Prefixes values. The sequence value will determine the order that is used to find the proper match
for which extraction class to use in retreiving the attachment.

Once changes are complete, make sure to File -> Save to keep the newly entered information before
proceeding with further configuration.

URL Testing

Watch the Video

Each individual extraction class may be tested from the form as shown in the following screenshot.

System Administration - Forms and Field Descriptions

Page 745 of 944
Proprietary to STR Software
A successful test will result in the document being retrieved and presented for viewing in the web browser.
Any errors in extracting the attachment will also be displayed in the web browser as shown below.

Custom Extraction Classes

You can use a custom java extraction class that implements the AttachmentExtractionInterface method to
retrieve the attachment.

Custom Extraction Class Parameters

Parameter Meaning

URL A string of up to 2048 characters specifying the entire URL of the

attachment. For example,
http://mytest.strsoftware.com/files/myattachment.pdf

Destination Path The full path and file name where the file should be placed on the AventX
host file system once retrieved. Maximum length of the string is 2048.

Domain A string of up to 256 characters specifying the domain used for

authentication when retrieving the attachment.
Note: This value may be <null> if not needed.

User A string of up to 256 characters specifying the user name used for
authentication when retrieving the attachment.
Note: This value may be <null> if not needed.

System Administration - Forms and Field Descriptions

Page 746 of 944
Proprietary to STR Software
 Password A string of up to 256 characters specifying the password used for
authentication when retrieving the attachment.
Note: This password is stored in the database as an encrypted string
Note: This value may be <null> if not needed.
The extraction method must return a valid, appropriate value for the delivery name of the attachment (this
will be the file name portion of the Destination Path value). The delivery name for the attachment is
specified as the third parameter of the AventX UNIX [ATTACH= command. Consult the AventX UNIX Resource
Guide [ATTACH= command for guidelines on naming attachments.

The extraction method may also throw an exception as defined in the com.strsoftware.AttachmentExtraction
package called AttachmentExtractionException. If an exception is thrown during this method its text should
contain a valid, understandable message describing the error that was encountered. This text will be
captured in the aventx.log and will be used for troubleshooting purposes.

All custom extraction classes must meet the specifications described earlier for the “Class” parameter.
AventX will automatically search for custom extraction classes in $FCHOME/oa/java/lib/custom for
each attachment retrieval cycle.

The following is an example of implementing a custom attachment extraction class. This should cover all
steps from compilation to configuration. PLEASE NOTE THIS IS ONLY AN EXAMPLE AND SHOULD NOT BE
USED AS ACTUAL CODE IN ANY ENVIRONMENT!

Create the custom extraction class (a *.java file), which implements the AttachmentExtractionInterface
included in the AventX jar file.

import com.strsoftware.AttachmentExtraction.AttachmentExtractionInterface;

import com.strsoftware.AttachmentExtraction.AttachmentExtractionException;

import java.io.*;

public class InterfaceTest implements AttachmentExtractionInterface {

public String getAttachment(String sURL, String sDestPath, String sDomain,

String sUser, String sPassword)

throws AttachmentExtractionException {

try {

Runtime rt = Runtime.getRuntime();

String[] cmdArray = {"/home/xxaventx/java/MyTest/script.sh",

System Administration - Forms and Field Descriptions
Page 747 of 944
Proprietary to STR Software
 sDestPath};

Process pr = rt.exec(cmdArray);

int exitVal = pr.waitFor();

} catch (Exception ex) {

throw new AttachmentExtractionException(ex.getMessage(), ex);

return sURL.substring(sURL.lastIndexOf(“/”)+1);

Our example calls a Unix shell script, /home/aventx/java/MyTest/script.sh, which copies a random file to the
specified destination filename. It then returns the delivery name of the attachment, by extracting it from the
passed in URL value. NOTE: DO NOT ATTEMPT TO COPY AND PASTE THE ABOVE CODE AS YOUR JAVA
PROGRAM. IT IS NOT COMPLETE AND SHOULD NOT BE USED IN ANY ENVIRONMENT. IT IS PROVIDED HERE
ONLY FOR INSTRUCTIONAL PURPOSES.

Compile the custom extraction class. The above example is a file called InterfaceTest.java You should compile
using the same version of java that is used to run AventX and the file must be in the $CLASSPATH.

Copy the extraction class file to the proper directory:

$cp InterfaceTest.class $FCHOME/oa/java/lib/custom

Configure the custom extraction class via the AventX Configuration form for each document type which will
utilize it. In this example we specify a prefix search key,

System Administration - Forms and Field Descriptions

Page 748 of 944
Proprietary to STR Software
Note: The Prefix radio button is checked and the only defined search key is “mytest-”. This means AventX will
use the custom extraction class “InterfaceTest” to retrieve all qualifying attachments that start with “mytest-
”.

Add any attachments you may have at the document level using standard Oracle EBS functionality:

Authenticated HTTP NTLM Domains

System Administration - Forms and Field Descriptions

Page 749 of 944
Proprietary to STR Software
HTTP NTLM Authentication is server driven; the server (resource which has the attachment file) will request
credentials only when they are required. Any server can request authentication, regardless of whether it is
SharePoint, or listed in the authenticated domains on the AventX Configuration form. This includes extracting
attachments from HTTP NTLM systems that require cookies to be enabled (e.g. SharePoint services).

AventX registers an authentication handler with the “Domain”, “User Name” and “Password” values defined
for the HTTP NTLM extraction class when it will be used for retrieving the attachment.

HTTP servers may cache authentication credentials (see

http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6626700). In this case, customers who want to use
different HTTP NTLM authentication credentials (domain, user and/or password) across different
organizations for auditing purposes may find the HTTP NTLM server doesn't ask for authentication (it already
has this information cached) and all users can therefore access the files being requested. This is HTTP NTLM
server functionality over which AventX has no control.

To help alleviate confusion, AventX will register an invalid authentication handler after extracting each HTTP
attachment. This will ensure an error is thrown if AventX were not expecting an authentication request from
the server.

System Administration - Forms and Field Descriptions

Page 750 of 944
Proprietary to STR Software
HTTPS (Secure) Attachment Retrieval

It is possible to store attachments in HTTPS locations allowing AventX to access and process documents from
secure web applications (i.e., SharePoint). The key to successful extraction is that the HTTPS server must be a
site that has been secured using a valid root certificate from a certificate authority, signed with a public key.

Attachments stored on HTTPS servers with self-signed certificates will NOT be extracted.

If you are unsure of if the attachment(s) stored on an HTTPS server is valid for extraction, type the entire URL
into a web browser. Browsers connecting to servers that use self-signed certificates will display something
like the following:

If you receive a notification like the one above, then you must either move the attachment to a site that has
been secured using a valid root certificate, or you must obtain a valid root certificate for this HTTPS server.

System Administration - Forms and Field Descriptions

Page 751 of 944
Proprietary to STR Software
Hierarchal Order for Extraction Classes

Suppose your site has different authentication requirements for the different repositories where
attachments may reside. In this case, it is necessary that AventX can determine the appropriate extraction
class to use in retrieving the attachment, as well as provide the proper credentials to be able to retrieve the
attachment.

This simple example will show how to handle the case where some attachments (identified by their domain)
are in one of two SharePoint repositories (requiring HTTP NTLM authentication as one domain user) and all
others are in a repository accessed by HTTP NTLM with different credential requirements. The following two
screenshots show the proper configuration.

System Administration - Forms and Field Descriptions

Page 752 of 944
Proprietary to STR Software
The extraction class with the less stringent matching (using the prefix "http://") has the higher sequence
number to ensure that the attachments for domains "vm-sharepoint10" and "jester" (e.g. http://vm-
sharepoint10/Documents/attachment1.pdf) are matched first. Otherwise, the wrong credentials would be
provided by AventX, and the attachments would fail to be retrieved.

System Administration - Forms and Field Descriptions

Page 753 of 944
Proprietary to STR Software
External Attachments Tab

The External Attachments tab specifies extraction methods and authentication information for the
attachments that are configured and stored outside EBS. All attachments not referenced in Oracle EBS fall
into External Attachments category.

The External Attachments tab has a single section that allows you to specify a custom Java class for retrieving
external attachments. AventX will execute all the enabled external attachment classes in the list. The class
will be responsible for downloading attachments, and returning a list of downloaded attachments to AventX.

The Java class must satisfy the following requirements:

• It must implement ExternalAttachmentExtractionInterface. This interface is form of a contract

between AventX software and custom Java class. It specifes what input should custom class expect,
and what output it should produce. This interface will be provided by STR Software.
• On error, it must throw AttachmentExtractionException. The exception will be provided by STR
Software.

System Administration - Forms and Field Descriptions

Page 754 of 944
Proprietary to STR Software
Field Description AventX Table

Seq Seqence number used for querying the database. XXSTR_EXETRNAL_ATT_CLASSE

S.SEQ

Description A 256-character field containing a description of the XXSTR_EXTERNAL_ATT_CLASSE

extraction class. S.DESCRIPTION

This field is not required, and is not modifiable for

seeded entries.

Class A 512-character field containing the full class name. XXSTR_EXTERNAL_ATT_CLASSE

The extraction class will be used by AventX to retrieve S.CLASS
external attachments.

There is no default value for new entries.

This is a required field. This field is not modifiable for
the seeded entries.
All custom extraction classes must be located in
$FCHOME/oa/java/lib/custom/<classfqdn>. For
example:
$FCHOME/oa/java/lib/custom/com/strsoftware.
These classes are loaded into AventX each cycle;
therefore, changes/additions to classes do not require
a restart of AventX.
All custom classes must be compatible with the
version of java being used by AventX.
Custom classes may not be contained in jar files.

Domain A 256-character field that specifies the domain on XXSTR_EXTERNAL_ATT_CLASSE

which the attachment file exists, and which will S.DOMAIN
request and authenticate user credentials when
custom attachment class execute.
This field is required if authentication is to be
requested.

User Name A 256-character field that specifies the domain user XXSTR_EXTERNAL_ATT_CLASSE
account that will be provided by AventX with the S.USERNAME
"Domain" and "Password".
This field is required if authentication is to be
requested.

System Administration - Forms and Field Descriptions

Page 755 of 944
Proprietary to STR Software
Field Description AventX Table

Password A 256-character field that specifies the password for XXSTR_EXTERNAL_ATT_CLASSE

the domain user defined via the User Name field that S.PASSWORD
will be provided by AventX with the "Domain" and
"User Name".
This password is stored in the database as an
encrypted string

Enabled Checking this box instructs AventX to execute this XXSTR_EXTERNAL_ATT_CLASSE

extraction class. S.ENABLED
Value of ‘1’ indicates the box is
checked.
Value of ‘0’ indicates the box is
unchecked.

System Administration - Forms and Field Descriptions

Page 756 of 944
Proprietary to STR Software
Additional Commands Tab

This tab is used to optionally configure AventX UNIX commands to be included with each submission. Refer to
the “Setting Up Documents” section for a complete list of available commands.

System Administration - Forms and Field Descriptions

Page 757 of 944
Proprietary to STR Software
Misc Tab

The Misc tab supports the configuration for Sender and Archiving information.

Sender Field

AventX supports the configuration of a default value for Sender information, which determines the FROM
name and email address value for a document type. This Sender configuration can be specified for any
document type. Additionally, certain Sender queries affect the “calculated” Oracle username to be associated
with the document. Ramifications of this are described later.

If no Sender query is specified, the Sender information will be extracted from the PER_ALL_PEOPLE_F (HR)
table (equivalent to the EMPLOYEE query). Otherwise, this information can be extracted based on a defined
query, or can be set to a hard-coded value. The defined query can be one of the pre-seeded queries, or a
user-defined query via the AventX Document Configuration form form. The SENDER effects on returned
values are described in the following table.

System Administration - Forms and Field Descriptions

Page 758 of 944
Proprietary to STR Software
Sender Values

Specifies the query to be executed to retrieve the sender information for this document. The Sender value
populates the [FROM=].

Value Description

Employee Employee name and email address extracted from PER_ALL_PEOPLE_F

User (Email Only) User email address extracted from FND_USER. Value is used for both name and email
address.

Employee Employee name extracted from PER_ALL_PEOPLE_F and User email address extracted from
Name/User Email FND_USER

Other Hardcoded name and user email address extracted from FND_USER
Name/User Email

Other Hardcoded name and employee email address extracted from PER_ALL_PEOPLE_F
Name/Employee
Email

Employee Employee name extracted from PER_ALL_PEOPLE_F and Hardcoded email address
Name/Other
Email

Other (Name and Specifies a hardcoded FROM name and email address for this destination. Valid values are
Email) any strings of up to 40 characters.
The following characters are valid in the value returned for "Other Name ":
` (tick) and ' (single quote)
The following characters will be automatically stripped by the appropriate AventX view(s)
during command file generation from the value returned for "Other Name ":
[ (left square bracket), ] (right square bracket), and \ (backslash)
Specifies a hardcoded email address for the sender. Valid values are any string of up to 255
characters and must include user@domain format.
The following characters are valid in the value returned for "Other Email ":
' (single quote)
The following characters will be automatically stripped by the appropriate AventX view(s)
during command file generation from the value returned for "Other Email ":
` (tick), [ (left square bracket), ] (right square bracket), and \ (backslash)

System Administration - Forms and Field Descriptions

Page 759 of 944
Proprietary to STR Software
 Value Description

BI Publisher This is the sender as specified via the Delivery Opts button on the Email tab from a Delivery
Sender Manager concurrent request.
If FAX_DM_DATA.RECIPIENT_TYPE is populated with an ‘E’, (indicating an Email) the sender
will be extracted from FAX_DM_FROM_ADDRESS.
For all other possible FAX_DM_DATA.RECIPIENT_TYPE values, (e.g., ‘F’ for Fax or ‘P’ for Print)
the sender is the user’s email address extracted from FND_USER.
In each of these cases, the “calculated” Oracle username is the actual Oracle username (e.g.
if logged into Oracle EBS as RGUSTIN, the username value is RGUSTIN).
An additional valid value for the Purchase Order document type is:

Buyer Name and email address extracted from PER_ALL_PEOPLE_F (by PERSON_ID) based on the
buyer defined in PO_HEADERS_ALL( by AGENT_ID) for the document.
In this case, the “calculated” Oracle username is the Oracle username of the buyer if one
exists; otherwise the “calculated” Oracle username is the actual Oracle username (e.g. if
logged into Oracle EBS as RGUSTIN, but the buyer of the Purchase Order is TSOLES, the
username value is TSOLES).

WF-Approver Name and email address extracted from Workflow tables based on the Approver of the
Purchase Order.
In this case, the “calculated” Oracle username is the Oracle username of the Workflow
approver if one exists; otherwise the query will return an error 8420 “Internal Error: Unable
to retrieve Username”(e.g. if logged into Oracle EBS as RGUSTIN, but the workflow approver
is TSOLES, the username value is TSOLES).

WF-Buyer Name and email address extracted from Workflow tables based on the Buyer of the
Purchase Order.
In this case, the “calculated” Oracle username is the Oracle username of the Workflow buyer
if one exists; otherwise the query will return an error 8420 “Internal Error: Unable to
retrieve Username” (e.g. if logged into Oracle EBS as RGUSTIN, but the workflow buyer is
TSOLES, the username value is TSOLES).

WF-Buyer -> Name and email address extracted from Workflow tables based on the Buyer of the
Buyer Purchase Order. If the Workflow tables are blank, name and email address extracted from
PER_ALL_PEOPLE_F based on the buyer defined in PO_HEADERS_ALL for the document.
In this case, the “calculated” Oracle username is the Oracle username of the Workflow buyer
if one exists; otherwise, the “calculated” Oracle username is the Oracle username of the
buyer if one exists; otherwise the query will return an error 8420 “Internal Error: Unable to
retrieve Username” (e.g. if logged into Oracle EBS as RGUSTIN, but the workflow buyer is
TSOLES, the username value is TSOLES).

System Administration - Forms and Field Descriptions

Page 760 of 944
Proprietary to STR Software
 Value Description

WF-Buyer -> Name and email address extracted from Workflow tables based on the Buyer of the
Other Purchase Order. If the Workflow tables are blank, name and email address are as defined in
the fields for “Other Name” and “Other Email” on this form.
In this case, the “calculated” Oracle username is the Oracle username of the Workflow buyer
if one exists; otherwise the “calculated” Oracle username is the actual Oracle username (e.g.
if logged into Oracle EBS as RGUSTIN, but the workflow buyer is TSOLES, the username value
is TSOLES)
The “calculated” Oracle username affects the following commands at submission (listed in
the order that they appear in <USER>.<request_id>.log):
• [TEMPLATE=
• [HOLD=
• [COMMENT=TC:<value>
• [COMMENT=TCNAME:<value>
• [COMMENT=FORM:<value>
• [FROM=<TEI name><TEI address>
• [ERPLOGIN=<value>
• [LOGIN=<value>
• [COMMENT=USERPRINTER:<value>
Of importance here are the ERPLOGIN and LOGIN commands which assign ownership of the
documents in the document delivery system. Only the owner of the document will be able
to modify the document via the AventX Delivery Status form.

System Administration - Forms and Field Descriptions

Page 761 of 944
Proprietary to STR Software
 Value Description

WF-Preparer Name and email address extracted from Workflow tables based on the Preparer of the
Purchase Order.
In this case, the “calculated” Oracle username is the Oracle username of the Workflow
preparer if one exists; otherwise the query will return an error 8420 “Internal Error: Unable
to retrieve Username” (e.g. if logged into Oracle EBS as RGUSTIN, but the workflow preparer
is TSOLES, the username value is TSOLES).
Additional valid values for any document type are based on the query(ies) defined for that
document type via the “Configure a Document” form.
In these cases, the “calculated” Oracle username is the actual Oracle username.
The “calculated” Oracle username value is used to determine:
• From the Options tab, the values returned for Default Message Template, Form Name,
Hold, T&C and T&C Name if Define Options By is “Buyer” or “User” (see the associated
section above for a detailed description).
• From the Destinations tab, the value returned by the “Buyer query” if the Sender is one of
“Buyer”, “WF-Buyer”, “WF-Buyer->Buyer”, or “WF-Buyer->Other” (see the associated
section above for a detailed description)
• From the Destinations tab, the value returned by the “User’s Email Address” query and by
the ”Secure User’s Email Address” query if Sender is one of “Buyer”, “WF-Approver”, “WF-
Buyer”, “WF-Buyer->Buyer”, “WF-Buyer->Other”, or “WF-Preparer” (see the associated
section above for a detailed description).
• From the Acknowledgements tab, the value returned by the “Buyer query” if the Sender is
one of “Buyer”, “WF-Buyer”, “WF-Buyer->Buyer”, or “WF-Buyer->Other” (see the
associated section above for a detailed description)
From the Acknowledgements tab, the value returned by the “User’s Email Address” query if
Sender is one of “Buyer”, “WF-Approver”, “WF-Buyer”, “WF-Buyer->Buyer”, “WF-Buyer-
>Other”, or “WF-Preparer” (see the associated section
Once complete, make sure to File -> Save to keep the newly entered information before proceeding with
further configuration.

System Administration - Forms and Field Descriptions

Page 762 of 944
Proprietary to STR Software
XML Archive Connection Fields

See the section entitle “Archiving” for more information about this form.

Apply Watermark To

This specifies the delivery type to which watermarks should be applied. This setting is used in conjunction
with Watermark Name value on the Doc Options Query. The file name returned by the Doc Options Query
will be used as the watermark and applied to the output file for selected delivery type.

• Fax/Email – apply watermark to fax and email deliveries.

• Print – apply watermark to Print job via AventX Attachment Xpress.
• Archive – apply watermark to Archive Job.
See section “Doc Option Query Tab Field Descriptions” under “Setting Up Documents” for more information
about Watermark name.

System Administration - Forms and Field Descriptions

Page 763 of 944
Proprietary to STR Software
Removing an Organization’s Configuration

Once the AventX for an organization has been configured, there should be no reason to ever remove the
settings. However, in the rare case in which you would need to perform this function, follow the steps as
described below. Before doing so, however, you should first understand that all information for that
organization would be lost.

After logging into Oracle Applications with the proper responsibility that has access to the form, choose
Install ->AventX->Configuration menu item to invoke the "Configure an Organization" canvas of the AventX
Configuration form.

Select the <List Configured Organizations> button to get to the "Configured Organizations" canvas. Select the
(row of the) organization that you wish to delete. Select the <Delete Organization> button to delete the
settings for this organization. You will be prompted to confirm the deletion of the configuration settings for
this organization. All records for this organization will be removed from all AventX tables.

System Administration - Forms and Field Descriptions

Page 764 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 765 of 944
Proprietary to STR Software
Delivery Status Form

AventX provides a form called the “AventX Delivery Status” form that users and administrators access to
document transmission information. This section describes how to use, setup and configure these forms. The
AventX Delivery Status form can be accessed from three different locations within Oracle EBS.

• From an Oracle Menu

• From the Oracle Navigator Form
• From the Oracle “View Requests” menu using the “Zoom” button
The list of values available within these fields will only display the documents that are still in the AventX
transmission tables. AventX will clean up records in the document transmission status tables based on
configuration set in the product.

System Administration - Forms and Field Descriptions

Page 766 of 944
Proprietary to STR Software
Parameter Request

Request ID The Request ID assigned by the Concurrent Manager.

For example, 12345678.

Document Type The type of document that you are searching for. For approved Purchase Orders, enter
the document type of poa.

Doc ID The document number (in this case the PO number) associated with the document.
For example, 4501.

System Administration - Forms and Field Descriptions

Page 767 of 944
Proprietary to STR Software
Parameter Request

Status The current state/status of the document in AventX. Possible values and their meanings
are:
Accepted - documents sent via AventX Email Tracker, and the recipient clicked an
“Accept” button in the email message body.
Active - documents in the delivery queue that are actively being transmitted.
AwtngCnfrm - documents in the delivery queue that are waiting to receive status back.
This status applies to customers who use AventX Email Tracker, EasyLink, AventX MailSC,
FTP devices, or FAXCOM Anywhere to deliver their documents.
AwtgStat - documents have been sent by AventX Email Tracker, and AventX is waiting to
receive the first status (AventX Email Tracker only).
Confirmed - documents sent via an AventX Email Tracker that have been opened and
viewed by the recipient.
Delivered - fax documents that have successfully completed transmission. This can also
apply to documents that were sent via an AventX Email Tracker device and successfully
reached the recipient’s mail server but remained unopened for a specified number of
days (default is 10 days).
Failure - documents that have encountered an irrecoverable transmission error.
Hold - documents in the delivery queue that have been placed on HOLD. These
documents will not be transmitted until they have been released by user intervention.
Process - documents actively being processed by AventX for Oracle EBS.
Ready - documents in the delivery queue ready to be transmitted.
Recover - a fax transmission experienced a recoverable, “Page quality is unacceptable
(FXERR 452),” error and the transmission will be reattempted.
Rejected - documents sent via AventX Email Tracker, and the recipient clicked an
“Reject” button in the email message body.
Sent - email documents (non-secure) that have successfully completed transmission.
Transmit - documents sent down to AventX UNIX or AventX Translation Server for
delivery.
Wait - documents in the delivery queue that are scheduled for transmission in the
future.

Destination The fax number, email address, or printer of the destination.

For example, "804-897-1638"

System Administration - Forms and Field Descriptions

Page 768 of 944
Proprietary to STR Software
 Parameter Request

ID A unique 8-character ID that has been assigned automatically by AventX for each
document.
For example, AAAA0000.

Start Date The starting date, in the form of DD-MMM-YYYY. Clicking on the pick list will bring up the
calendar.
For example, 16-FEB-2006.

End Date The ending date, in the form of DD-MMM-YYYY. Clicking on the pick list will bring up the
calendar.
For example, 17-FEB-2006.

To Name A 40-character string indicating the recipient's name.

For example, “Tina Soles”.

To Company A 40-character string indicating the destination company name.

For example, “STR Software”.

Org ID The Organization ID value for the current Oracle EBS user.
For example, 204.

Login The Oracle EBS login user name for the current Oracle EBS user.
For example, TSOLES.
Depending upon your configuration, this field may be “grayed out” on the form. Consult
your System Administrator if this is the case and you need to search for documents
created by other users.
The information displayed here is taken from the FAX_STATUS table. There may be a slight delay from the
submission of the request to the concurrent manager to data showing on this form, depending on the
processing steps necessary to submit the document(s) to the delivery queue. For example, if the documents
must be processed by a forms package prior to submission to the document delivery system, it may take
longer for the information to show up on the AventX Delivery Status form than if there is a direct
submission.

The Display Control section of the AventX Delivery Status form defines the content and display order. By
default, the view is non-verbose; as such any error conditions dealing with processing of the document are
suppressed from the display. It is important to note that this does NOT suppress document delivery status.
For example, documents that failed transmission are still displayed in non-verbose mode. Verbose mode
enables a user to view all records, including processing errors (as indicated by a Status of RecErr, CmdErr, or
ProcErr), that are associated with this request ID.

System Administration - Forms and Field Descriptions

Page 769 of 944
Proprietary to STR Software
If setting up the XXSTR_STATUS_ADMIN profile option for your present login/responsibility (i.e. the value is
“YES”), a parameter list will open without the Login forced to the current user.

Without the XXSTR_STATUS_ADMIN profile option set to “YES”, you are only allowed to access documents
that matches your Oracle USERID. If it is set to “YES”, you will be allowed to access all information about all
documents from all users.

Document Status from a Responsibility’s Navigator Menu

The most common way users use the AventX Delivery Status form is from a responsibility’s main menu.

System Administration - Forms and Field Descriptions

Page 770 of 944
Proprietary to STR Software
Querying for Your Document

This form contains many fields from which you can specify “lookup criteria” to locate your approved Purchase
Order documents. The following table provides an explanation and example of each field.

System Administration - Forms and Field Descriptions

Page 771 of 944
Proprietary to STR Software
Field Descriptions for Query Form

Parameter Request

Request ID The Request ID assigned by the Concurrent Manager.

For example, 12345678.

Document Type The type of document that you are searching for. For approved Purchase Orders, enter
the document type of poa.

Doc ID The document number (in this case the PO number) associated with the document.
For example, 4501.

System Administration - Forms and Field Descriptions

Page 772 of 944
Proprietary to STR Software
Parameter Request

Status The current state/status of the document in AventX. Possible values and their meanings
are:
Accepted - documents sent via AventX Email Tracker, and the recipient clicked an
“Accept” button in the email message body.
Active - documents in the delivery queue that are actively being transmitted.
AwtngCnfrm - documents in the delivery queue that are waiting to receive status back.
This status applies to customers who use AventX Email Tracker, EasyLink, AventX MailSC,
FTP devices, or FAXCOM Anywhere to deliver their documents.
AwtgStat - documents have been sent by AventX Email Tracker, and AventX is waiting to
receive the first status (AventX Email Tracker only).
Confirmed - documents sent via an AventX Email Tracker that have been opened and
viewed by the recipient.
Delivered - fax documents that have successfully completed transmission. This can also
apply to documents that were sent via an AventX Email Tracker device and successfully
reached the recipient’s mail server but remained unopened for a specified number of
days (default is 10 days).
Failure - documents that have encountered an irrecoverable transmission error.
Hold - documents in the delivery queue that have been placed on HOLD. These
documents will not be transmitted until they have been released by user intervention.
Process - documents actively being processed by AventX for Oracle EBS.
Ready - documents in the delivery queue ready to be transmitted.
Recover - a fax transmission experienced a recoverable, “Page quality is unacceptable
(FXERR 452),” error and the transmission will be reattempted.
Rejected - documents sent via AventX Email Tracker, and the recipient clicked an
“Reject” button in the email message body.
Sent - email documents (non-secure) that have successfully completed transmission.
Transmit - documents sent down to AventX UNIX or AventX Translation Server for
delivery.
Wait - documents in the delivery queue that are scheduled for transmission in the
future.

Destination The fax number, email address, or printer of the destination.

For example, "804-897-1638"

System Administration - Forms and Field Descriptions

Page 773 of 944
Proprietary to STR Software
Parameter Request

ID A unique 8-character ID that has been assigned automatically by AventX for each
document.
For example, AAAA0000.

Start Date The starting date, in the form of DD-MMM-YYYY. Clicking on the pick list will bring up the
calendar.
For example, 16-FEB-2006.

End Date The ending date, in the form of DD-MMM-YYYY. Clicking on the pick list will bring up the
calendar.
For example, 17-FEB-2006.

To Name A 40-character string indicating the recipient's name.

For example, “John Doe”.

To Company A 40-character string indicating the destination company name.

For example, “STR Software”.

Org ID The Organization ID value for the current Oracle EBS user.
For example, 204.

Login The Oracle EBS login user name for the current Oracle EBS user.
For example, JDOE.
Depending upon your configuration, this field may be “grayed out” on the form. Consult
your System Administrator if this is the case and you need to search for documents
created by other users.

System Administration - Forms and Field Descriptions

Page 774 of 944
Proprietary to STR Software
The easiest way to locate your document is by the Document ID. This is what we will use for our example as
illustrated below.

System Administration - Forms and Field Descriptions

Page 775 of 944
Proprietary to STR Software
Search Results

Your results are now displayed, and all the documents associated with your search criteria (Purchase Order
for our example) are listed. The form contains information for each document resulting from your search
criteria.

Field Descriptions for Search Results

Request ID Column

This column displays the Oracle Request ID associated with the document.

ID Column

The ID represents a unique "key" used by AventX to track this document. Each AventX UNIX instance assigns
appropriate ID values that are specific to it; for this reason, it is possible to see two identical IDs, each
processed by a different instance of AventX Connector/AventX UNIX. The “Manage Documents” button will
access the correct instance of AventX UNIX. See your System Administrator for details.

Login Column

This is the Oracle EBS user who submitted the request.

Destination Column

This is the fax number, email address, printer, or archive destination. This column may also contain
information about errors.

Doc ID Column

This is the document number assigned by Oracle EBS, i.e. Purchase Order # 6040.

System Administration - Forms and Field Descriptions

Page 776 of 944
Proprietary to STR Software
Subject Column

This value is what your system administrator configured for the subject of the email or fax cover page.

Date Column

This is the date and time of the document’s last know status.

Status Column

The following provides a description of the values that might be displayed in the Status column.

• Accepted - documents sent via AventX Email Tracker, and the recipient clicked an “Accept” button in
the email message body.
• AckErr – indicates a problem with extraction of acknowledgement information. Check the error
message details and click the “Troubleshoot” button to see if there is a knowledge base article in the
Support Portal that can help you resolve the issue.
• AwtngCnfrm - documents in the delivery queue that are waiting to receive status back. This status
applies to customers who use AventX Email Tracker, EasyLink, AventX MailSC, FTP devices, or
FAXCOM Anywhere to deliver their documents.
• CmdErr – indicates a problem with command file generation. Check the error message details and
click the “Troubleshoot” button to see if there is a knowledge base article in the Support Portal that
can help you resolve the issue.
• Confirmed – Email documents sent via an AventX Email Tracker that have been opened and viewed
by the recipient.
• Delivered - fax documents that have successfully completed transmission. This can also apply to
documents that were sent via an AventX Email Tracker device and successfully reached the
recipient’s mail server but remained unopened for a specified number of days (default is 10 days).
• Fatal – There was an error condition that caused the delivery of the document to fail. Check the error
message details and click the “Troubleshoot” button to see if there is a knowledge base article in the
Support Portal that can help you resolve the issue.
• Hold - documents in the delivery queue that have been placed on HOLD. These documents will not be
transmitted until they have been released by user intervention.
• ProcErr – indicates a problem with general processing flow (such as paging errors when processing
batches, etc.). Check the error message details and click the “Troubleshoot” button to see if there is a
knowledge base article in the Support Portal that can help you resolve the issue.
• Process – AventX Oracle Connector is processing the request.
• Ready – The document is waiting to be delivered within AventX UNIX.
• RecErr – indicates a problem with extraction of destination information. Check the error message
details and click the “Troubleshoot” button to see if there is a knowledge base article in the Support
Portal that can help you resolve the issue.

System Administration - Forms and Field Descriptions

Page 777 of 944
Proprietary to STR Software
• Recover - a fax transmission experienced a recoverable, “Page quality is unacceptable (FXERR 452),”
error and the transmission will be reattempted.
• Rejected - documents sent via AventX Email Tracker, and the recipient clicked an “Reject” button in
the email message body.
• Sent - The email was successfully sent to the destination.
• Success - the document successfully delivered to its archive or print destinations.
• Transmit - AventX Oracle Connector has finished processing the request and is waiting on AventX
UNIX to deliver it.

System Administration - Forms and Field Descriptions

Page 778 of 944
Proprietary to STR Software
Status Message Column

This column will provide more details about the status of the document. Click on “View Details” to see more
information.

Err No Column

This is the error number associated with the problem. If there is no error number, then the document was
delivered successfully, or the document is waiting to be delivered.

Host Column

This column represents the AventX server that processed the document. This value exists because you can
have multiple AventX server processing documents for load balancing and failover situations.

Sort Results by Field

It is also possible to sort the entries, ascending or descending, based upon many different fields by using the
“Sort Results By” List of Values. This is shown in the example below:

System Administration - Forms and Field Descriptions

Page 779 of 944
Proprietary to STR Software
After specifying a change in either the “Sort Results By” or “Ascending / Descending” values, it is necessary to
click the <Refresh Data> button to resort the display. For transmission status information, the verbose view is
not needed; it is very useful when attempting to troubleshoot processing issues.

Refresh Button

The refresh button allows you to reload the search results and display the information based on the values
select for the “Verbose” checkbox and the “Sort Results By” field.

System Administration - Forms and Field Descriptions

Page 780 of 944
Proprietary to STR Software
Verbose Check Box

The AventX Delivery Status form includes the ability to filter the view of documents displayed. By default, the
view is non-verbose. As such, any error conditions resulting from processing of the document are suppressed
from the display. It is important to note that this does NOT suppress document delivery status. For example,
documents that failed transmission are still displayed in non-verbose mode. To enable the verbose view, click
the checkbox in the Display Control section on the form. This enables a user to view all entries that are
associated with this request ID.

System Administration - Forms and Field Descriptions

Page 781 of 944
Proprietary to STR Software
Troubleshoot Button

The troubleshoot button is a great way to learn more about an error. Clicking this button will launch your
default web browser and attempt to log you into the STR Software Customer Support Portal. If you have a
valid username and password, then a search results page will display all information about the specific error
you are for the record you are on in the search results.

System Administration - Forms and Field Descriptions

Page 782 of 944
Proprietary to STR Software
View Details Button

To view the details of a document, select the row from the list and click on the “View Details” button.

System Administration - Forms and Field Descriptions

Page 783 of 944
Proprietary to STR Software
Manage Documents Button

This button will launch a web browser and take you to the AventX WebManager. It will pass all valid
documents from the search results page and display them in this web application. Some documents from the
search results page will not be displayed in the AventX WebManager. Only fax and email transmissions will be
displayed in the AventX WebManager. Print jobs, archive jobs, and processing errors (ProcErr, RecErr) will not
be displayed.

System Administration - Forms and Field Descriptions

Page 784 of 944
Proprietary to STR Software
This web application provides the ability for users to perform more advanced querying of documents, cancel
pending documents, resend successful and unsuccessful documents, and even view the document contents.

System Administration - Forms and Field Descriptions

Page 785 of 944
Proprietary to STR Software
Modify Documents Button

This will open a new browser window that brings you directly to the Modify Document page in AventX
WebManager for the row you select on the search results page. You can then proceed to modify the
information for this ID and click Submit when ready to submit your changes.

System Administration - Forms and Field Descriptions

Page 786 of 944
Proprietary to STR Software
Using the Delivery Status Form from “View Requests”

From the Find Requests form, we will specify the selection criteria (in this example, we will view all requests)
to display the Requests form. Click on “View > Request” in the menu and the following form will appear.

Click “Find” to search for your request. The below screen shot shows that Oracle is still running the report
and nothing yet been submitted to AventX for processing.

System Administration - Forms and Field Descriptions

Page 787 of 944
Proprietary to STR Software
From the list displayed, select your request ID, by clicking on the rectangle next to the actual ID. Only one
Request ID may be selected at a time. Once selected, we choose “View > Zoom” from the menu on the
Requests form.

The AventX Delivery Status form is displayed and lists all the documents associated with this Request ID.

The AventX Delivery Status form cannot be invoked from View Requests for requests that have been
generated using the Print delivery method of AventX. For request send to a non-AventX printer, i.e. print
delivery requests, the form must be invoked from a menu item.

System Administration - Forms and Field Descriptions

Page 788 of 944
Proprietary to STR Software
Using the Delivery Status form from an Oracle Menu

This section describes how to configure Oracle EBS personalization to allow access to this form via a button
on the toolbar.

• Prerequisites

• User Experience

• Configuration of Forms Personalization for Use

• AventX Configuration

• Testing and Troubleshooting

Throughout this chapter, we will use a Purchase Order (via Oracle Purchasing) as an example, but keep in
mind that this method can be used from any Oracle form that has been personalized (e.g., Sales Orders,
Invoices, etc).

System Administration - Forms and Field Descriptions

Page 789 of 944
Proprietary to STR Software
Prerequisites

Configuring this feature involves Oracle forms personalization, it is required that you have a working
knowledge of the following areas:

• Oracle Forms Development

• Oracle Forms Personalization

Without the above prerequisites, you could severely impact the functionality of existing Oracle forms,
possibly resulting in undesirable functionality. Therefore, it is imperative that someone with the proper
qualifications perform the setup.

• In addition to proper personnel qualifications, for Oracle EBS version 11i, 11i.ATG_PF.H Rollup 7
(Patch 6241631) or greater is required for forms personalization.

• Oracle EBS R12 already includes forms personalization, so no further patches are required.

• AventX Oracle Connector, version 7.3.00 or higher is required.

User Experience

As an example, we will assume the users wish to access the AventX Delivery Status form from the standard
Purchase Orders form (via Oracle Purchasing) via a button on the toolbar. The configuration steps to enable
this functionality for any other form would be the same.

The user accesses the Purchase Orders form via normal procedures. In this example, a query was performed
to retrieve a Purchase Order number (3434) of which the user would like to know the delivery status.

The AventX Delivery Status form will only display the last known state for the document's submission and
delivery by AventX Oracle Connector. Therefore, if the document has not yet been processed by AventX
Oracle Connector, no information will be available, though the AventX Delivery Status form will open using
this technique.

System Administration - Forms and Field Descriptions

Page 790 of 944
Proprietary to STR Software
Activating the Form

The user clicks the AventX Delivery Status icon (see the screenshot below) to access the AventX Delivery
Status form. The form canvas will allow the user to specify any query values and then execute that query and
return the results.

For example, the user might want to query on the present Purchase Order number. The AventX Delivery
Status form is discussed in detail in the AventX Oracle Connector Users Guide.

Once the desired query information has been entered, the user clicks <Find> and the results are displayed on
the subsequent canvas.

Configuring Forms Personalization

Oracle forms personalization is a powerful and flexible feature provided by Oracle which allows a System
Administrator/DBA to control the behavior of an Oracle form. More information about forms personalization
can be found in the following Oracle metalink notes:

NOTE:279034.1 - Information About the Oracle Applications Form Personalization Feature in 11i
NOTE:395117.1 - Form Personalizations in Oracle E-Business Suite (Release 12)

In this section, we will only be discussing the components of forms personalization that are required for a
proper implementation. Other rules and conditions may need to be developed via personalization to meet
the business rules of your users.
Continuing with our Purchase Order example, we will create two forms personalization rules.

The first rule creates a menu item called “AventX Delivery Status” and associates it with the AventX Delivery
Status icon on the toolbar. The second rule responds to the user clicking the “AventX Delivery Status” menu
item (or AventX Delivery Status icon) by launching the AventX Delivery Status form.

System Administration - Forms and Field Descriptions

Page 791 of 944
Proprietary to STR Software
Invoking Forms Personalization

Invoke the form that you will use to create your document and select Help->Diagnostics->Custom Code->
Personalize from the menu at the top of the form, as shown below:

If you do not see the Diagnostics menu, or you receive a message stating “Function not available to this
responsibility,” it is likely not enabled. Check settings for the following profiles:

• “Hide Diagnostics menu entry” should be set to “No”.

• “Utilities: Diagnostics” should be set to “Yes”.

System Administration - Forms and Field Descriptions

Page 792 of 944
Proprietary to STR Software
The Forms Personalization form will be displayed. The following screen shot shows an example of the Forms
Personalization form for the Purchase Orders form. In our example, there are currently forms personalization
entries for this form, however, your form may not have entries already populated here.

The top part of the form specifies rules that apply either to a function or a form. The bottom part of the form
specifies under what condition the rule is applied, and what actions to take if the conditions are met.

As previously mentioned, we need to define two rules. The rules can apply at either the form or function
level, depending upon your forms personalization needs. Recall that the first rule is to define a menu item
(also associated with a button on the toolbar) that the user will click on to invoke the AventX Delivery Status
form.

Defining the First Rule

To define the first rule, click in the next available row at the top of the form. Assign an unused, sequence
number in the Seq column, and type something like “Add AventX Delivery Status Menu Item” as the
Description.

System Administration - Forms and Field Descriptions

Page 793 of 944
Proprietary to STR Software
Condition Tab
You may configure personalization to add logic to control when the button is available. In our example, we
will enable the menu item/button as soon as the form is invoked, but you may have different “timing” needs.
This is fine, if the user has access to this menu item/button at some point during the forms session.

To make the menu item/button available as soon as the form is invoked, under the “Condition” tab, ensure
that the “Trigger Event” is set to “WHEN-NEW-FORM-INSTANCE”, and the “Processing Mode” is set to “Not in
Entry-Query Mode”.

This tells Oracle that the conditions under which the rule should apply will be when a new form is launched
by the user. No other entries need to exist on the “Condition” tab for this rule, but of course, you may build
in as much personalization as you need. An example of our progress so far is illustrated in the screenshot
below

System Administration - Forms and Field Descriptions

Page 794 of 944
Proprietary to STR Software
Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the first rule is to add a menu item/button. Click in first row on the left-
hand side of the form. Assign a new sequence number, and for “Type”, select “Menu”, leave the
“Description” field blank, and set the language to “All”. Ensure that the “Enabled” checkbox is checked.

The right-hand side of the form specifies details regarding the actual menu item/button to be displayed when
the form is invoked. Click the arrow of the “Menu Entry” drop-down menu and select the next available
MENU entry. In our example, personalized menus exist, so we will select the MENU2 entry.

Type in a meaningful label for the menu item. For example, “AventX Delivery Status”. This is the text for the
menu item as well as the “help text” that the user will see when hovering over the associated toolbar button.

Ensure that the “Render line before menu” checkbox is checked.

System Administration - Forms and Field Descriptions

Page 795 of 944
Proprietary to STR Software
Specify the name of an icon (without the extension) that you wish to use as the toolbar button to represent
this menu item. During step 2 of setup_forms.sh (installation), a default icon was copied to
$OA_JAVA/oracle/apps/media for SADS use. You may use this icon, called
str_doc_status_check_icon, as the representation of your menu item. No other fields are required
on the “Actions” tab. Don’t forget to save your changes!

The following shows our progress so far:

Defining the Second Rule

So far, we have created a rule that displays a menu item/button based upon the user invoking the Purchase
Orders form. The next step is to create a second rule that is a response to the user clicking the “AventX
Delivery Status” menu item/button. When this item is selected, the AventX Delivery Status form will be
launched.

Therefore, our second rule will have one condition associated with it (the selection of our MENU item created
in the first rule), and one Action associated with it (the launching of a function called FCOA_FCOASTAT which
invokes the AventX Delivery Status form).

Continuing with where we left off, you should have one rule defined at this point. Click in the next available
row at the top of the form. Assign an unused, sequence number in the Seq column, and type something like
“Respond to AventX Delivery Status Menu Item” as the “Description”.

System Administration - Forms and Field Descriptions

Page 796 of 944
Proprietary to STR Software
Condition Tab
Under the “Condition” tab, ensure that the “Trigger Event” is set to “MENUn”, where “n” represents the new
MENU item that you created for the first rule. In our example, this is MENU2. Ensure that the “Processing
Mode” is set to “Not in Entry-Query Mode”. These settings ensure that the rule will be applied when the
menu item/button (created by the first rule) is selected by the user. No other entries need to exist on the
“Condition” tab for this rule. An example of our progress so far is illustrated in Figure 27-6.

Actions Tab
Click the “Actions” tab. The bottom half of the form will change so that you may specify what actions are
associated with this rule. Recall that the second rule is to launch a function called FCOA_FCOASTAT which
invokes the AventX Delivery Status form.

It is assumed that the FCOA_FCOASTAT form has already been registered during the initial setup of AventX
(specifically forms registration tasks). If you have not done so at this point, you must register this function to
make it available to forms personalization.

Click in first row on the left-hand side of the form. Assign a new sequence number, and for “Type”, select
“Builtin”. Leave the “Description” field blank and set the “language” to “All”. Ensure that the “Enabled”
checkbox is checked.

The right-hand side of the form specifies details regarding the type of action. Click the LOV arrow of the
“Builtin Type” drop-down box and select “Launch a Function”.

System Administration - Forms and Field Descriptions

Page 797 of 944
Proprietary to STR Software
The “Function Code” field refers the function to be launched. Enter “FCOA_FCOASTAT” into the “Function
Code” field, and for the “Function Name”, enter “AventX Delivery Status”.

The following shows the completed configuration. Make sure to save your changes!

System Administration - Forms and Field Descriptions

Page 798 of 944
Proprietary to STR Software
Testing and Troubleshooting

At this point, you have completed all the steps necessary to configure forms personalization for this Oracle
form (Purchase Orders). To make the personalization "active", exit the form to the Navigator menu and then
re-enter the form. The new personalization should appear as soon as the form is opened. Our example is
shown below.

Invoke the AventX Delivery Status form by clicking the new icon. Then enter in any query values you desire
and click the <Find> button to retrieve the results.

Invoke the AventX Delivery Status form by clicking the new icon. Then enter in any query values you desire
and click the <Find> button to retrieve the results.

System Administration - Forms and Field Descriptions

Page 799 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 800 of 944
Proprietary to STR Software
System Administration - Forms and Field Descriptions
Page 801 of 944
Proprietary to STR Software
AventX Delivery Status Web Client
The AventX Delivery Status Web Client shares many features with the AventX Delivery Status form and allows
users to quickly query on the delivery status of a document. However, the Web Client functions outside of
the Oracle EBS Forms interface. The AventX Delivery Status Web Client can be accessed from the following
locations:

• An Oracle Menu item on the self-service page

• The Web Client can also be accessed from the AventX Administrator responsibility

• A button at the bottom of the Work Order Report page in Oracle Asset Management (only for
instances using a valid AventX Attachment Express license)

• A browser by navigating directly to http(s)://<aventx host>:<aventx port>

When logging into Oracle EBS and switching to the AventX Administrator Responsibility you will see a link to
access the AventX Delivery Status Web Client:

System Administration - AventX Delivery Status Web Client

Page 802 of 944
Proprietary to STR Software
Accessing the AventX Administrator Responsibility through forms also provide a clickable link to access the
AventX Delivery Status Web Client:

System Administration - AventX Delivery Status Web Client

Page 803 of 944
Proprietary to STR Software
The AventX Delivery Status Web Client can be accessed from a button at the bottom of the Work Order
Report page in Oracle Asset Management (only for instances using a valid AventX Attachment Express
license)

System Administration - AventX Delivery Status Web Client

Page 804 of 944
Proprietary to STR Software
Accessing the AventX Delivery Status Web Client will go to a Web Page that is very similar to the AventX
Delivery Status Form. Much of the same information is displayed and some quick filter options are available
as well as an option to export the current view or entire table in a CSV format.

View Archive
AventX Delivery Web Client adds ability to view archived files on the browser. This feature requires Archiving
module enabled, and only supports jobs that were processed after version 14.1.00 was applied.

Single Archive

To view a specific archived document, select the Archive row, and click View Archive. Archive row should
have ID starts with letter “A”.

Combined Archive

To view multiple archived documents, first enable Archive filter. This will enable multiple rows selection using
checkboxes. To select all or deselect all filtered rows, click the checkbox in the header row. Once selected,
click View Combined Archive to view the output. There may be some delay while AventX processes archived
files and combines them.

Requirements

• AventX for Oracle Connector version 20.2.00 or later.

• Combine archive files into single PDF enabled.

Configuration
The AventX Delivery Status Web Client can also be used to configure some aspects of the software. The
following table describes what can be configured:

System Administration - AventX Delivery Status Web Client

Page 805 of 944
Proprietary to STR Software
 General Configuration Contains a series of global configuration parameters
that control the default behavior for specific aspects
of the AventX software

Attachment Printing Contains configuration parameters specific to the

printing of reports with attachments (AventX
Attachment Xpress).

Printers Optionally configure printers defined on the AventX

host. The values are a subset of those contained on
the General Config tab; it is only necessary to add
rows on this tab if a printer requires different
configuration than those provided by the global
defaults (for example, a different lp command or
argument).

Translation Servers Define an AventX Translation Server, a Windows or

Linux server used when printing reports with
attachments (AventX Attachment Xpress).

Web Attachment Types Associate attachment filename extensions with the

appropriate MIME type.

License Keys Apply license keys. AventX requires a valid license

key process and delivery documents.

License Keys

Applying a License Key

The first step to using AventX is to apply a license key. The license key is obtained from STR Software, and is
applied via the AventX Configuration form from Oracle EBS. When first accessing the AventX Configuration
Form, you will be prompted to apply a valid license key. Copy and paste the license key into the form and
click “Save”. You can use the “Check for Valid Key” button to make sure that the key entered is valid. STR
Software recommends all production and non-production license keys are stored in the production database.
This will save time performing manual steps in the non-production environment after a production clone
because all of the license keys will be clone from production to the non-production server.

System Administration - License Keys

Page 806 of 944
Proprietary to STR Software
Here are some important considerations:

• The “search” order for a key match is top to bottom. It is recommended that the “most important” key
(e.g. PROD) be entered first, the next “most important” key (e.g. UAT) second and so forth.

• Be sure to add a Description for each License Key row (e.g. Permanent production key for FINPROD) as a
means to more easily understand which key is being applied.

• The first match found is the one applied.

Invalid License Keys

The license key is checked during the initial access of the AventX Configuration Form, and is also checked
when operating in the following circumstances:

• When the AventX Interactive Delivery/AventX Stand Alone Interactive Delivery, AventX Delivery Status,
and AventX Document Configuration forms are invoked.

• When a Concurrent Request is executed for Automatic, Stand Alone Interactive, or Interactive Delivery.

There are several scenarios for invalid license keys:

• License expired. System has passed the expiration date.

System Administration - License Keys

Page 807 of 944
Proprietary to STR Software
• Invalid database name

• Invalid length of license key

• Feature used that is not activated by a valid license key

If your license key is invalid, you will be notified when invoking a form (as shown in the figure below), and/or
will be notified in the AventX logs.

A common cause of invalid license keys occurs when the PROD instance of Oracle EBS is migrated/cloned to
the DEV/TEST et. al. instances. The PROD license key will likely not have the correct characteristics (e.g.
database name) to match the DEV/TEST et. al. instances.

Monitoring the Software

Email Alerts
There are two types of email alerts that can be delivered from the AventX software.

• System and Document Processing Alerts

• Document Delivery Notifications
System Alerts

System Alerts are configured on the “Genera Config” tab of the “System Configuration” form.

System Administration - Monitoring the Software

Page 808 of 944
Proprietary to STR Software
It is recommended to always supply values for the following fields on the “General Config” tab.

▪ error.mail.address - This email address should be one that would normally receive email alerts from the
system when there are significant issues. The alerts to this address will contain detailed information
about any problem encountered. It is recommended that the administrator performing the initial
installation and configuration set this value now so that content rich information is available when first
setting up the software. It is also recommended to use a shared email address or distribution list such as
[email protected] instead of an individual email address so that important system information
is delivered to multiple people who may support the application.
▪ error.mail.from - It is also recommended to set the “error.mail.from” value to a valid SMTP email
address. Many mail servers will block emails sent as an invalid user, and the default value of
[email protected] may prevent the email from reaching the email address defined for the
“error.mail.address”
▪ mail.smtp.host – The SMTP mail host for sending alert emails.
Document Delivery Notification Emails

Users and Administrators can receive email delivery confirmations and notifications when documents are
transmitted successfully and unsuccessfully. The following is an example of an email delivery notification
from AventX.

System Administration - Monitoring the Software

Page 809 of 944
Proprietary to STR Software
The email address that receives this notification is based on the Organization and Document configuration.
Any email address, either from a query or a hard coded “Other” entry on the “Acknowledgements” tab will
receive an email that looks like the above image. The “Acknowledgement Level” determines whether the
email will be generated on “Success” or “Failed” delivery of the document.

System Administration - Monitoring the Software

Page 810 of 944
Proprietary to STR Software
The following is a description of the information in this email.

• Subject = The subject typed in by the user or automatically applied by the AventX software.

• ID Field = The unique ID assigned to the document by AventX

• Company = If the AventX configuration for your document pulls this information from Oracle then the
company name for the recipient will be displayed here.

• Destination = The email address or fax number the document was sent to

• Pages = Relevant on to fax transmissions

• Organization ID = This is the Oracle EBS ORGID the document originated from

• ERP Tracking Number = The Oracle EBS concurrent manager request ID

• ERP System = A value taken from Oracle EBS that identifies the environment the document was
transmitted from. Helpful in troubleshooting problems.

• Document Type = A code assigned to each document configured in AventX. It is a unique

configuration identifier.

• Device Used = The device used in AventX UNIX to transmit the document.

• Status = The details of the transmission status.

System Administration - Monitoring the Software

Page 811 of 944
Proprietary to STR Software
 • Need help troubleshooting? = This will only be displayed if the document encounters and error
message. Click on the link to log into the STR Software Customer Support Portal

The notification template can be modified to change the contents of the email message body for these types
of alerts. The global template file for these alerts can be found in
$FCHOME/oa/util/notif_templates/template.txt.

Document specific template files can be configured. Go to the “Document Configuration > Document Name >
General Configuration” and locate the following features.

error.mail.subject

error.mail.template

System Administration - Monitoring the Software

Page 812 of 944
Proprietary to STR Software
External 3rd Party Monitoring Tools
The AventX software’s central component called “AventXPS” can be monitored by third party applications. It
is recommended to monitor this component by performing periodic HTTP GET requests to the server and
port on which AventXPS is running. Since the embedded web server is also used for the processing of
documents it is recommended to check the status as infrequently as possible based on your monitoring
needs. An interval of five minutes is recommended for checking the health of the back-end process. You
should avoid checking more frequently than every two minutes. The following URL can be used to determine
the status of the AventXPS webserver:

http://aventxservername:port/getStatus.do

The following image illustrates how this is configured within one of many 3rd party monitoring software
products (Webmin):

System Administration - Monitoring the Software

Page 813 of 944
Proprietary to STR Software
AventX System Status Web Page
The AventX Delivery Status Web Client provides access to to the AventX System Status Web Page. This web
page provides a real time document history summary and the current system status information. The AventX
System Status Web Page is a tool for administrators to quickly check the resource usage of the AventX
applications and a delivery history summary.

The AventX System Status Web page is accessed from within the AventX Delivery Status Web Client by
navigating to Configuration -> Tools -> System Status.

The summary tab displays a quick review of document delivery activity along with a snapshot of jobs waiting
to be processed in the AventX queues. Additional information is available on the System Status and History
Detail Tabs. All data shown in the tabs can also be exported as a .csv file.

System Administration - Monitoring the Software

Page 814 of 944
Proprietary to STR Software
Troubleshooting
AventX is a highly configurable product. As such, it could be difficult to determine the cause of and proper
solution for errors encountered during the processing cycle. To alleviate this, AventX has been designed with
specific “break points” and corresponding troubleshooting “tools”. A high-level diagram of AventX data flow
is provided below. This may help in determining the “break points” to check for when troubleshooting.

AventX Oracle Connector – Data Flow Diagram

Concurrent Manager
Step # 1. The concurrent manager, when the request completes, passes
parameters from the driver string to the …/oa/fcprinto.sh script. The
call to this script is in the “driver” string that is called when the
Internet
appropriate STYLE is selected for a concurrent request. This script will Fax
create two files that will be transferred via (sFTP or CP) to the
$FCHOME/oa/database/<dbname>/dropoff directory. The two files are
as follows. FAX

<hostname>.<username>.<requestid>.<seqno>.scan = command file

<username>.<requestid>.<seqno> = the report output

AventX
Oracle
Email
AventX Mail
Connector - Uses proprietary email agent to
Network Fax Server
send traditional email with all
Step # 2. AventXPS picks up the files from the $FCHOME/oa/ attachments in a single PDF file.
database/<databasename>/dropoff directory and begins AventX (FAXCOM Servers Only)
processing the information in the command file. UNIX Queue FAX

Open the command file and you will see the following example.
- FAXCOM (Windows or Linux) – TCP/IP Communication
/home/aventx/oa/fcprinto.sh "AventX Interactive" "/home/aventx/ - Rightfax (Windows Only) – FTP Communication
oa/database/VIS/dropoff/DEMO.3003237.2708" "2607"
"DEMO.3003237" "204" "2607" "[LANG=POSTSCRIPT]" "pol"
"none" "pdf" "1"
Email AventX Mail Plus
- Uses sendmail or other mail agent on host
server to send traditional email with individual
$FCHOME/oa/database/<dbname>/dropoff document attachments

Windows Application /
DB Server Firewall Windows Web Server
Step # 3. AventXPS executes queries against the Oracle database to http or https
extract information from Oracle and AventX tables and burst the report
output. When it finishes processing, AventXPS will place all documents
and the commands files associated with those documents into the Secure
$FCHOME/oa/database/<dbname>/scan directory. The AventX UNIX Email
FCSCAND process uses the $FCHOME/cfg/scripts/.dirscan.cfg
configuration file to pick up the files from this directory and submits them
to the AventX UNIX queue.
Firewall must be configured
for inbound and outbound on
a specific port. The default
port is 8009
$FCHOME/oa/database/<dbname>/scan

Troubleshooting tools include email notifications, log files, and database tables, which will be the topics
discussed in this chapter. For more information on troubleshooting 6000/7000/8000 level errors reference
this KB article in the STR Software Customer Support Portal.

AventX can be configured to provide email notifications to the “Submitter” of requests and/or to a hard-
coded email address. The subject and content of these email notifications is completely configurable. These
email notifications provide information on processing errors encountered prior to submission to the
document delivery system.

The following files are located in the $FCHOME/oa/database/<SID>/log directory:

System Administration - Troubleshooting

Page 815 of 944
Proprietary to STR Software
▪ aventx.log = the log for the master thread, which contains information such as startups, shutdowns,
aborts, attachment printing, etc.
▪ submit.log = the log for processing of documents from the point a document is found in the "pickup"
directory to the point the document is submitted into the document delivery system. This log is typically
only available for AventX configurations that use a 3rd party application for applying forms to the report
output prior to being submitted to the document delivery system.
▪ setup.log = the log file that is created when the AventX software is installed.
▪ control.log = information from the AventXPS process
The concurrent request submission log is retained in
$FCHOME/oa/database/<SID>/log/history/<USER>.<request_id>.log. These logs are automatically purged
based on a configured maximum total log size.

The log content is also now available from the AventX Delivery Status form via the <View Log> button.
Clicking that button will submit a request to the AventX http server for the log, which will be displayed in a
browser:

System Administration - Troubleshooting

Page 816 of 944
Proprietary to STR Software
In the event that the AventX server cannot be reached (e.g. it is down, or incorrect values for host or port are
in the FAX_SETUP table), the http request will post an error similar to this:

In the event that the associated log file cannot be found (e.g. it has been purged by automatic maintenance,
this request was handled by a failover AventX host), AventX will post the following:

System Administration - Troubleshooting

Page 817 of 944
Proprietary to STR Software
AventX does not support the <View Log> functionality from the AventX Delivery Status form under failover
conditions. This is because the AventX host and port information are written to the FAX_SETUP table each
time AventX performs a command file generation. The logs themselves will be available on the proper
AventX host provided all other setup is correct. The http URL is created based on the values configured in the
software.

System Administration - Troubleshooting

Page 818 of 944
Proprietary to STR Software
AventX includes two tables in the database, FAX_STATUS and FAX_ERROR, in which are recorded processing
information for each report request. The contents of the FAX_STATUS table are viewable from within Oracle
EBS using the AventX Delivery Status form. The contents of the FAX_ERROR table can be accessed for ad hoc
reporting using standard SQL.

Log Files
AventX uses a number of log files to assist in troubleshooting the processing cycle. Each of the logs
previously identified will be discussed in the sections that follow.

Concurrent Request Logs

Oracle EBS creates and provides the concurrent request log, available via the View Log button on the View
Requests form. This log provides information specific to the Oracle EBS concurrent processing of the request.
This log may also include the transfer to the AventX host as shown:

System Administration - Troubleshooting

Page 819 of 944
Proprietary to STR Software
Document Transaction Logs

AventX creates temporary log files for each concurrent request as it is being processed. These files show the
record of processing (in history/<USER>.<request_id>.log). Document Submission to the Queue
Logs

In cases where AventX forwards the report output to a 3rd party application for forms processing, the
command file and attachment files are placed in a configured directory
($FCHOME/oa/database/<SID>/scan) to wait for the returned report output file. When a 3rd party
application for forms processing is not used, the command file, report output file, and attachment files are
placed in the configured directory ($FCHOME/oa/database/<SID>/scan) Once the command and
report output files exist, the document delivery system automatically picks them up and processes them for
submission to the delivery queue.

This process is logged in the $FCHOME/oa/database/<SID>/log/submit.log. Here is an example

of the contents:

######### SUBMIT.SH ###############

DATE: Wed Jan 21 17:04:16 EST 2015

System Administration - Troubleshooting

Page 820 of 944
Proprietary to STR Software
 VERSION: 10.0.00

DATAFILE: DEMO.5912453.00000001.pol.DAT

DATABASENAME: TCHAPPELL

FAXFILE: DEMO.5912453.00000001.pol.CMD

Removing COMMENT= from command file

Submit command:/home/ted/bin/fclp -b DEMO.5912453.00000001.pol.CMD

submitted

Submitted successfully

Processing attachment: /home/ted/oa/database/TCHAPPELL/scan/DEMO.5912453.00000001.pol.DAT

Removed attachment /home/ted/oa/database/TCHAPPELL/scan/DEMO.5912453.00000001.pol.DAT

Processing attachment: /home/ted/oa/database/TCHAPPELL/scan/web_att.120.7

Removed attachment /home/ted/oa/database/TCHAPPELL/scan/web_att.120.7

######## SUBMIT.SH COMPLETE ##########

Advanced Logging Options

Procedure Logging is a great new feature added in version 10.0.0. By default, the Procedure Logging is set to
No. In general, it is recommended to leave Procedure Logging disabled, unless otherwise instructed by the
STR Software Support Team. You can enable Procedure Logging at either the document level or organization
level. You can enable it at the organization level by navigating to the General Config tab on the AventX
Configuration Form and then setting enable.procedure.logging to Yes. Likewise, you can enable it at the
document level by navigating to the General Configuration tab on the AventX Document Configuration Form,
after searching for a specific document type, and then setting enable.procedure.logging to Yes. This will add a
new section to the $FCHOME/oa/database/<SID>/log/history/<USER>.<request_id>.log file indicated by a
tombstone.

As its name suggests, the Procedure logging logs data being passed in procedures involved with document
processing. This logging section contains detailed error messages and data flow which is particularly useful
for troubleshooting documents that have a status of RecErr, AckErr, CmdErr etc. Each document in a batch
will have its own section in the log and will be clearly marked in the tombstone. This ensures that you can
easily troubleshoot individual documents.

As with any additional advanced logging, this will have some impact on performance, as there is more
information being written to the logs. The processing hit will be minimal though, and due to the logs
System Administration - Troubleshooting
Page 821 of 944
Proprietary to STR Software
containing more data in them, this will mean less logs are stored in the
$FCHOME/oa/database/<SID>/log/history directory before the configured maximum space is reached.

Below is an example of the log section.

****************************************************************************

** Procedure logging document 1

*****************************************************************************

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport BeforeReport, incoming

parameters:

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport printer: AventX

Automatic

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport isPdf: 1

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport interactiveDataExists: 0

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport printonly: 0

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport docType: invl

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport userName: DEMO

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport UID1: 10007140

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport UID2:

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport UID3:

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport UID4:

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport UID5:

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport orgId: 204

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport requestId: 5919553

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport interactiveSeqNo: -1

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport docSeqNo: 1

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport biSeqNo: -1

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport interactiveWO: 0

System Administration - Troubleshooting
Page 822 of 944
Proprietary to STR Software
03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Copying incoming params

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Using impspec org ID: 204

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Detected Automatic

Delivery

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Advanced forms not found

at doctype level.

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Checking default document

type configuration for advanced forms

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Print attachments not

found at doctype level.

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Checking default document

type configuration for print attachments

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Calculated userid: 1013417

03/05/15 05:59:36.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Calling GetDocInfo

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo GetDocInfo, incoming

parameters:

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo params.docType: invl

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo params.uid1From:

10007140

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo params.uid1To:

10007140

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo params.isInteractiveWorkOrder:

0

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo

params.documentSequenceNumber: 1

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo Determined document name:

Invoice

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo Cleaning up transient tables:

APPS.fax_header, APPS.fax_recipient, APPS.fax_acknowledgement, APPS.fax_attachment

System Administration - Troubleshooting

Page 823 of 944
Proprietary to STR Software
03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo APPS.FAX_DOC_CONFIG
query(204:Invoice)

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo TryDocConfig returns actual

docName: Invoice, configuration docName: (Default), actual orgId: 204, configuration orgId: 0

03/05/15 05:59:36.000 [SCNWRK1] AOOC_DISPATCH:GetDocInfo EXCEPTION: Caught zzNone

03/05/15 05:59:37.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport After GetDocInfo

03/05/15 05:59:37.000 [SCNWRK1] AOOC_COMMANDFILE:BeforeReport Copying outgoing params

03/05/15 05:59:37.669 [SCNWRK1] processDoc (ProcessDocuments.java:151)

Gathering Logs and Configuration Data

As previously discussed, all log (and configuration) files are stored on the actual AventX host where AventX
resides. Depending upon availability of your staff, this sometimes presents a challenge for retrieval of the
files from the actual UNIX host. For this reason, an Oracle EBS user with access to the AventX Configuration
form can select the proper AventX host via the LOV on the Tools tab of the form, followed by selecting an
AventX host and then clicking on the “Get Logs” button. This will retrieve the log and configuration files for
the selected AventX host.

System Administration - Troubleshooting

Page 824 of 944
Proprietary to STR Software
Upon clicking the button, the user is directed to a web page where the browser will prompt the user to save
the file with a .zip extension. This file can then be sent to STR Software for evaluation by Technical Services.

AventX must be running in order for the zip file to be created.

System Administration - Troubleshooting

Page 825 of 944
Proprietary to STR Software
Error Messages
AventX is designed to provide as much information as possible when an error condition has occurred. AventX
categorizes errors into the following types:

▪ Installation Errors – These errors occur during the installation of AventX, namely, during the execution of
the setup.sh script. A complete list of installation errors can be found Chapter 3, "Installation Error
Messages" and will not be discussed any further here.
▪ Stored Procedure Errors – AventX uses a set of stored procedures to process documents through the
Interactive and Automatic Delivery methods. Any errors that occur during the execution of stored
procedures for the Interactive Delivery or Stand Alone Interactive Delivery method are posted directly to
the AventX Interactive Delivery/AventX Stand Alone Interactive Delivery form. Any errors that occur
during the execution of stored procedures for the Automatic Delivery method are posted directly to the
AventX Delivery Status form.
▪ General Errors – AventX, by default, writes to a log file called
$FCHOME/oa/database/<SID>/log/history/<USER>.<request_id>.log. This log file can contain a number
of general error messages that have occurred as a result of general processing between the scripts.
All error messages are documented in the STR Software Customer Portal at https://portal.strsoftware.com.

System Administration - Troubleshooting

Page 826 of 944
Proprietary to STR Software
Stored Procedure Error Messages

Any errors that occur during the execution of stored procedures for the Interactive Delivery or Stand Alone
Interactive Delivery method are posted directly to the AventX Interactive Delivery/AventX Stand Alone
Interactive Delivery form. Error messages are returned to the related record in the delivery address field. For
example, failing destination queries are returned in the 'destinations' list, and failing acknowledgement
queries are returned in the 'acknowledgements' list. Figure 0-1 shows a warning message of WRN-7001 for a
failed query relating to the Requestor of the document when using the Interactive Delivery method. The
complete error message can be viewed by clicking in the Email field and scrolling to the right.

Any errors that occur during the execution of stored procedures for the Automatic Delivery method are
posted directly to the AventX Delivery Status form. The text of the message is placed in the delivery address
field on the AventX Delivery Status form. Because a single automatic delivery request can have multiple
documents, it is possible to have “duplicate” dummy fax-ids.

System Administration - Troubleshooting

Page 827 of 944
Proprietary to STR Software
Resubmitting Concurrent Manager Requests to AventX
There may be a time when a concurrent request completes normally, but then the document(s) fail on the
AventX side. If a processing error occurs within AventX, it will require the concurrent request to be processed
again. And sometimes you will not be able to resubmit the document again from Oracle. In previous versions
of the software, this task would be very difficult as it would require the manual recreation of a .scan file to
accompany the Oracle output file. However, starting with version 10.0.00 of the AventX Oracle Connector,
this task is now much simpler.

AventX stores previous .scan files in $FCHOME/oa/database/<SID>/log/history which can be used to resubmit
documents. To resubmit concurrent requests, simply copy the .scan file for the appropriate request ID into
the $FCHOME/oa/database/<SID>/dropoff directory. You will also need to copy the output file from Oracle,
matching the naming convention of the aventx.datafile parameter in the .scan file. Once both files have been
placed in the $FCHOME/oa/database/<SID>/dropoff directory, AventX will pick them up to be processed
again.

AventX Thread Manager Architecture

Starting with AventX for Oracle EBS Version 20.4.00, the architecture was changed to improve severe error
handling and fatal recovery. The AventX thread pools (job processing, translation, print pool, etc.) now have
their own managing threads that will collect errors and attempt to restart aborted workers. This prevents
AventX from completely going down due to an individual worker thread aborting.

In this scenario, if the AventX administrator only wants to receive severe or fatal error event notifications, set
error.mail.verbose to “No” in the General Configuration. This will disable all general processing error
notifications that would have otherwise be sent to the email address defined in error.mail.address .

If this behavior does not fit your organization’s needs, you can revert to the old behavior as follow:
cd $FCHOME/oa

vi features.properties

Add the following line:

legacy.thread.handler=true

A restart on the AventX process is required. To revert the change above, either remove the added line, or set
it to false and restart AventX process.

System Administration - Troubleshooting

Page 828 of 944
Proprietary to STR Software
Stopping and Starting
This section provides information on manually and automatically stopping and starting the AventX for Oracle
EBS processes.

Manually Starting AventX for Oracle EBS

Use the following command to manually start the AventX for Oracle EBS software. Substitute “VIS” in the
example below with your Oracle EBS instance’s SID.

$FCHOME/oa/aventxoc start VIS

Manually Stopping AventX for Oracle EBS

The entire AventX for Oracle EBS software is dependent upon the AventXPS process to scan a specified
directory for dropoff files within AventX to start the processing. Once the command is executed to stop
AventX, all AventX processes will eventually come down gracefully. There are a number of factors involved in
how long all processes will take to come down, i.e. the size of the current batch of documents that AventXPS
may currently be processing. For example, if there are thousands of documents within one batch, the
process may take longer to come down than it would for processing of a single document or a small batch of
documents.

To stop AventXPS, execute the following command. Substitute “VIS” in the example below with your <SID>.:

$FCHOME/oa/aventxoc stop VIS

You will see output similar to the following:

Stopping AventXPS

Requesting stop. This may take a while depending on load...

Connecting to database to retrieve control port

Loading configuration from database

Verifying http port

Using port 6055

Requesting stop...

Server: received stop request from client

Server: Sent stop signal. Waiting to stop

Server: All threads appear to have stopped

System Administration - Stopping and Starting

Page 829 of 944
Proprietary to STR Software
It could take some time before these processes complete.

Manually Checking the Status of AventX for Oracle EBS

To monitor whether or not AventXPS is running, execute the following command (Note: Substitute “VIS” in
the example below with your <SID>):

$FCHOME/oa/aventxoc status VIS

If the process is running, the output will be “Running”. If the process is topped, the output will be “Stopped”.

Administrators can also check the status of the AventX software from the “front end” via the AventX
Configuration form.

Automatically Starting the AventXPS Process

Linux < v7.x (init.d)

Copy $FCHOME/oa/aventx_for_oracle_ebs into /etc/init.d as root.

System Administration - Stopping and Starting
Page 830 of 944
Proprietary to STR Software
chown root:root /etc/init.d/aventx_for_oracle_ebs

chmod 755 /etc/init.d/aventx_for_oracle_ebs

Add the script to init.d (chkconfig --add aventx_for_oracle_ebs) and verify the configuration change took
place.

chkconfig --list | grep aventx

Linux v7+ (systemd)

Copy $FCHOME/oa/[email protected] into /etc/systemd/system as root

chown root:root /etc/systemd/system/[email protected]

chmod 755 /etc/system/system/[email protected]

For each instance of AventX Oracle Connector, run this command and replace ‘INSTANCE’ with the Instance
name as configured in AventX:

systemctl enable [email protected]

Verify the change was enabled.

systemctl list-unit-files --type=service | grep aventx

Oracle Database and Database Server Maintenance Considerations

AventX proactively connects to the Oracle Database once a day to perform system maintenance. By default
this maintenance occurs at 12:00 AM; however if this coincides with a time when the Oracle Database is
unavailable it will cause the AventX for Oracle EBS software to shut down. The AventX maintenance check
time can be configured as shown below.

System Administration - Oracle Database and Database Server Maintenance Considerations

Page 831 of 944
Proprietary to STR Software
Data Cleanup
AventX can be configured to automatically clean up document transmission information. Use the following
settings on the “General Config” tab to implement the desired features.

System Administration - Data Cleanup

Page 832 of 944
Proprietary to STR Software
Oracle Attachments
One of the powerful features of AventX is its ability to extract and deliver attachments users add to
documents in Oracle EBS.

Documents are becoming more complex in their overall content. It is no longer sufficient to deliver the
document by itself. Documents are typically constructed of various parts, and attaching documents has
become commonplace. This is true also with Oracle. Oracle EBS allows native documents to be attached to
documents.

In this section, we'll look at a typical scenario using a Purchase Order, with the desire to attach a Terms and
Conditions file that was created in Microsoft Word, an IRS form in PDF format, a part diagram created in
Microsoft Visio, and lastly, another Microsoft Word document, sample.doc. The sample images are taken
from Oracle EBS 11i10; similar methodologies exist for other versions.

Any file that can be uploaded to the database or stored on a file system that is accessible via a UNC (Universal
Naming Convention) or URL (Universal Resource Locator) path can be attached to report output. This means
that information from all sorts of applications can become part of the constructed document. Everything
from PDFs, to HTML pages, Word documents, CAD drawings etc. can be attached.

Attaching Files to Oracle Documents

Oracle provides an easy-to-use interface to add the attachments to the report. Access to this interface is
achieved via the toolbar "paperclip" button. To add attachments to the PO Header, click in one of its fields
on the form, and then select the paperclip button.

System Administration - Oracle Attachments

Page 833 of 944
Proprietary to STR Software
To add attachments to a PO Line, click in one of its fields and then select the paperclip button. Item level
attachments will have already been added to the item itself, therefore you cannot add any attachments to an
item using this canvas (more on Item level attachments later). Other areas for adding database attachments
are beyond the scope of this document; refer to the appropriate Oracle EBS documentation for more
information.

The paperclip also indicates whether or not attachments already exist for the report. There is no limit to the
number of attachments you can have with any given report.

Once you have selected the paperclip, a new form opens up where you can specify the attachments,
including their order (more on ordering later). Oracle also provides a handy "Document Catalog" to make
adding "common" attachments easier. This form indicates the entity to which the attachment will be added.
Also note the Category and Data Type fields.

AventX supports “File” (where you can upload a file from a file system to the Oracle database as an
attachment to the document), or “Web Page”, where you can enter a UNC or URL path (such as shown in the
System Administration - Oracle Attachments
Page 834 of 944
Proprietary to STR Software
screenshot below) to specify the location and name of the attachment to be retrieved from a file system
during processing of the document. The order of the entries is important to AventX Oracle Connector, with
regards to what the constructed document looks like.

When you select "File" for the Data Type, a new dialog will open to assist you in uploading the file as the
attachment to the database.

When you select “Web Page” for the Data Type, you must specify a valid UNC or URL path and filename in the
“File or URL” field, as shown in the screenshot below. This path is case sensitive. 3

Database Attachment
CIFS Attachment UNC
HTTP(S) NTLM Attachment URL1
CIFS Attachment URL1

Web Page data type attachment filenames must include the proper file extension in order to be properly
processed by AventX.

Starting with 9.2.00 patch #1066 and 10.0.00+ the following algorithm is used to determine the delivered
attachment name for Web based attachments:

1. The Content-Disposition HTTP header "filename" parameter will be the trump/highest level.

3
Do not use the "\" character for this type of entry. It will cause processing errors.

System Administration - Oracle Attachments

Page 835 of 944
Proprietary to STR Software
 2. Next, AventX will check the Content-Type header and attempt to guess an extension based on this value
from the mime.types file.
3. If Content-Disposition filename parameter is not set but Content-Type is, name the file "unknown.<ext>".
This will ensure appropriate translation.
4. If neither Content-Type or Content-Disposition are set, extract "filename" portion of URL and
a) If filename does not contain an extension and mime type is set, call it url.<ext>
b) If filename does contain extension just call it filename
5. If still unknown, call the attachment “unknown”

Retrieving Documents from Secure HTTPS Web Servers

It is possible for customers to store attachments in HTTPS locations allowing AventX to access and process
documents from secure web applications (i.e., SharePoint). The key to successful extraction is that the HTTPS
server must be a site that has been secured using a valid root certificate from a certificate authority, signed
with a public key.

Attachments stored on HTTPS servers with self-signed certificates will NOT be extracted.

If you are unsure of whether or not the attachment(s) stored on a particular HTTPS server is valid for
extraction, type the entire URL into a web browser. Browsers connecting to the servers that use self-signed
certificates will display something similar to the following:

If your receive a notification similar to the one above, then you must either move the attachment to a site
that has been secured using a valid root certificate, or you must obtain a valid root certificate for this HTTPS
server.

System Administration - Oracle Attachments

Page 836 of 944
Proprietary to STR Software
AventX also supports Item Level attachments. These types of attachments are added to an actual item as
defined per organization. In the previous example, our Purchase Order #1172 contained one line item for the
PO. The item # on the line item was CM51562. As shown below, this item itself has a database attachment
for the Category “To Buyer” called sample.doc.

Therefore, Purchase Order #1172 has three kinds of AventX supported entities with attachments: PO Header,

PO Lines, and Item attachments.

System Administration - Oracle Attachments

Page 837 of 944
Proprietary to STR Software
Hard-Coded Attachments
AventX also supports the configuration of hard-coded attachments. This feature allows users to upload
standard attachments for a given document type per organization just one time and include them for
processing by AventX at the time of the concurrent request submission. For example, when using this
feature, users no longer need to attach the same file to each Purchase Order.

Configuration of Hard-Coded attachments is described below as a series of steps. Upon completion of these
steps, you should be able to attach any document to the “AventX Attachments” entity, using any of the
categories that you define.

The first step is for you to configure the AventX Attachments entity (and any desired categories) in Oracle
EBS.

Using the Application Developer responsibility, navigate to Attachments→Document Entities

Fill in the information as shown in the screenshot below:

System Administration - Oracle Attachments

Page 838 of 944
Proprietary to STR Software
Table = FAX_ATT_CONFIG
Entity_ID = AVENTX_ATTACHMENTS
Entity Name = AventX Attachments
Prompt = AventX Attachments
Application = XXSTR Software Custom Application (or your other custom application as appropriate)

Click Save.

From the Application Developer navigation menu, choose Attachments→Attachment Functions

Fill in the information as shown in the screenshot below:

Type = Function
Name=FCOA_FCOAXCFG
User Name = AventX Configuration

Click the Blocks button and fill in the information as shown in the screenshot below:

System Administration - Oracle Attachments

Page 839 of 944
Proprietary to STR Software
Click the Entities button.

Entity = AventX Attachments

Display Method = Main Entity
Include in Indicator = checked
Indicator in View = checked

System Administration - Oracle Attachments

Page 840 of 944
Proprietary to STR Software
On the Privileges tab, ensure that the Query, Insert, Update, and Delete fields are set to Always.

Click the Primary Key Fields tab, and enter the information as shown below:

System Administration - Oracle Attachments

Page 841 of 944
Proprietary to STR Software
Since there is no SQL Statement associated with this configuration, click the Save button to save your
changes.

From the Application Developer navigation menu, choose Attachments→Document Categories button.

At this point you may define as many categories as you would like. You can define categories that are more
high-level in nature, such as “Work Order Hardcoded Attachments”, or more granular in nature, such as
“Burn Permit” or “Drill Permit”. The choice is up to you, and is dependent upon the types and number of
attachments that you want to include. In our example, we will define a number of different, more granular
type of attachments of Burn Permit, Drill Permit, Excavating Permit, and Safety Standards.

Insert a new record, and fill in the name of your new category.

System Administration - Oracle Attachments

Page 842 of 944
Proprietary to STR Software
Click the Assignments Button, and enter the information as shown below.

Type=Function
Name=AventX Configuration
System Administration - Oracle Attachments
Page 843 of 944
Proprietary to STR Software
Format = not specified
Enabled = checked

Save your changes.

For NON-Seeded Document Types (Add Your Own Document), define the AventX Attachment Query as
shown below. For Seeded Documented Types, proceed on to the next step (attaching the actual documents).

The next step is to define the actual AventX Attachment Query if your document type is not seeded. This
query is necessary in order for AventX to actually extract the attachment from its location.

Use the “Configure a Document” feature and navigate to the Attachment Queries canvas, and click the New
Query button. A sample query is displayed below:

Entity=AventX Attachments
Description = Any value
key1 = :ORGID
key2 = Document Name as specified when the AYOD document was created. This must be an exact match.

System Administration - Oracle Attachments

Page 844 of 944
Proprietary to STR Software
(If unsure, look at the values listed for the Document Name LOV associated when you first invoke the AventX
Document Configuration form)

select from dual where 1=1.

Click the Validate Query button, and enter a valid organization ID to validate the query. Ensure that the value
that you entered for Organization ID is displayed for key1 and that the document name is displayed for key2.

Once complete, make sure to File -> Save to keep the newly entered information before proceeding with
further configuration.

System Administration - Oracle Attachments

Page 845 of 944
Proprietary to STR Software
The next step is to attach the documents that are to be hard-coded for each document type. In our example
above, we created categories that are very granular and are specific to our Work Order document type.
Open the AventX Organization Configuration form. Select the organization, and then the document type.

From the Attachment Types tab, place your cursor in any of the Category or Entity fields and click the Paper
Clip icon to invoke the Attachments form.

Notice that the Entity Name is AventX Attachments. Upon clicking the LOV button for the Category, you
should see all of the categories that you defined to be associated with the AventX Attachments entity.

Upload/Specify the documents associated with each category for this document type within this
Organization. You may upload/specify as many documents as you would like for any given category that you
had previously defined.

It is a good idea to upload all possible hard-coded attachments that could be associated with this document
type for this Organization. You can restrict which attachments are extracted during Step D.

As previously mentioned, the Attachments Tab allows you to configure the default entries for attachments
from the Oracle database for the selected document type by mapping attachment entity and categories.

To include a specific category as a hard-coded attachment, click in a new row on the form, and select the
AventX Attachments entity. Select the desired Attachment Category that you wish to have AventX extract
during processing.
System Administration - Oracle Attachments
Page 846 of 944
Proprietary to STR Software
In the example below, we have included two (out of a possible four) categories, Burn Permit and Safety
Standards to be extracted. Therefore, any Work Order document processed by AventX will by default include
attachments associated with these two categories for the AventX Attachment entity.

Specifically for Work Orders, if using Interactive Attachment functionality, a user will see these hardcoded
attachment entity/category pairs listed when invoking the controller form, but has the option to exclude
them in the final output by “un-checking” the checkbox for the entity/category pair before submitting the
job.

Attachments can be added to report output at any time during its existence in the Oracle database. In our
Purchase Order example, some attachments may be "known" and added during the creation of the PO;
others may become necessary later in the process and added at that time. Obviously, if the attachment is
not defined when a request is made for report output, it won't be included in the constructed document!

The ability to delete attachments “on the fly” (i.e. in an ad hoc fashion) is provided for Interactive Delivery,
and the ability to add and/or delete attachments “on the fly” is provided for Stand Alone Interactive Delivery.
For details on this functionality, please refer to the “AventX Oracle Connector User’s Guide”.

The "where" question can be a bit confusing and complicated and is well beyond the scope of this document.
Refer to the Oracle documentation for a deeper understanding of "where". Reports typically consist of
different "sections". In our Purchase Order example, there is the "header" information, the line item
information, and then a possible attachment to the item itself. Oracle classifies these sections by entity.
AventX supports database attachments for all documents for all entities. Please refer to the appropriate
chapter for information on configuring AventX for inclusion of database attachments.

The files are attached to the report entities by category (more on this later).

System Administration - Oracle Attachments

Page 847 of 944
Proprietary to STR Software
Seeded AventX Attachment Extraction Queries
AventX provides “seeded” attachment extraction queries to assist with the implementation of business
requirements.

Document Type Entity Data Type

Request For Quotation PO Header File

Web Page
PO Lines
Short Text
Item Long Text
AventX Attachment

Purchase Order PO Header File

Web Page
PO Lines
Short Text
Item Long Text
AventX Attachment

Invoice Transaction File

Web Page
AventX Attachment
Short Text
Long Text

System Administration - Oracle Attachments

Page 848 of 944
Proprietary to STR Software
 Work Order Maintenance Work Orders File
Web Page
EAM_DISCRETE_OPERATIONS
Short Text
CSI_ITEM_INSTANCES Long Text
AventX Attachment
There is no restriction on the categories for these entities.

AventX supports attachments for all document types and all entities via the AventX Document Configuration
form form. Refer to the appropriate chapter for information on setting up attachments. AventX Oracle
Connector must be configured to define what Oracle attachments are to be included in document
construction. This is accomplished on an organization and document type basis via the AventX Configuration
form and is discussed in the “Setting up Default Organization Configuration” section. Supported attachments
that are not configured will not be included in the constructed document.

Configuring the Order of the Attachments

It may be desirable to have a specific order the attachments are displayed when emailed, faxed or printed.
The order of the attachments can be controlled based on the AventX and Oracle EBS configuration.

As mentioned previously, the AventX Configuration form is used to specify what attachments will be
included in processing. Additionally, the form specifies which data types will be extracted (File and/or Web
Page), along with the domain, user name, and password information for accessing web page attachments, if
checked.

System Administration - Oracle Attachments

Page 849 of 944
Proprietary to STR Software
The form also will define the order of the attachments to the category level.

Let's look at the AventX Oracle Connector configuration for our Purchase Order example.

Here we see that the PO Header entity has two categories, "To Supplier", and “To Buyer” configured. As
such, any attachments to the PO Header for other categories will not be included in the constructed
document.

Also, note that the PO Line entity is configured after the PO Header entity. As a result of this configuration,
attachments to the PO Header entity for the category "To Supplier" will be first in the constructed document,
attachments to the PO Header entity for the category “To Buyer” will be next, and attachments to the PO
Line entity for the category "To Receiver" will follow. Lastly, note that the Item entity is configured after the
PO Line entity. As a result of this configuration, attachments to the Item entity for the category “To Buyer”
will be last.

The final "ordering" falls to the category level. That ordering is defined by the order of the entries in the
Oracle EBS configuration.

An important thing to note is the name of the attachments as email attachments. These values come directly
from Oracle, including the mime-types value, which determines what application will be associated with the
attachment. Oracle uses the Description value for the name of the email attachment.

Certain characters used in the name of the attachment can cause problems during processing. For this
reason, the following characters – “(“, “)”, “[“ “]” - will be stripped out of the attachment name prior to
submission to the document delivery system. Additionally, the space character will be replaced with an
underscore “_”. For example, an Oracle attachment named “sample diagram[1].pdf” would be processed as
“sample_diagram1.pdf”.

One final note on the filenames of the attachments. Prior to Oracle database version 9iR2, patch #3054247 is
required to get the correct value from the database for the filename. If this patch is not in place, all email
attachment names will be "INTERNAL".

Excluding Attachments
AventX has ability to exclude attachments with exclusion patterns. When the attachment’s name or URL
match one of the exclusion patterns, the attachment will not be included with the final delivery). Exclusion
configuration will affect all configured document types in an AventX instance.

To configure exclusion patterns, go to AventX server, open up “$FCHOME/.fcoa_cfg_<DATABASE_NAME>”,

and add below:

cATT_EXCLUDE_PATTERNS="<pattern1>;<pattern2>"

export cATT_EXCLUDE_PATTERNS

cATT_EXCLUDE_PATTERNS key accepts patterns in Java REGEX format, case sensitive, and separate by a
semicolon. Special characters will need to be escape by “\\” characters. In general, you should escape all
special characters whether they are part of an unescaped construct.

System Administration - Oracle Attachments

Page 850 of 944
Proprietary to STR Software
Note: You may not use “;” as a part of an exclusion pattern, since AventX reserves it for separation between
patterns.

Some common pattern examples:

• .*Internal.* -- This will ignore all attachments contains “Internal”.

• .*Internal\\-Only\\.PDF -- This will ignore all attachments ending with “Internal-Only.PDF”.
• \\.DOCM;\\.docm;\\.XLSM;\\.xlsm – This will ignore all attachments with extensions DOCM and
XLSM, both all uppercased and lowercased.

Exporting and Importing Data

Due to the nature of Oracle EBS environments, companies are often moving AventX from one instance to
another; for example, from a development environment to a UAT (User Acceptance Testing) environment,
and finally, to a production environment. This feature has a few requirements that must be met to use it.

• Exact same version of the AventX Oracle EBS Connector software on the source and target system.

Exporting and Importing Via Forms

Exporting and importing configurations has been made much simpler starting with version 10.0.00. Instead of
having to use scripts on the backend, you can now accomplish this through the Oracle front end. Simply
navigate to the AventX Configuration form under the Tools tab and locate the Resources section in the
middle of the form. There you will find two buttons, one to export configuration and one to import. You must
first select the instance you would like to export/import configurations for.

An important note before performing any exporting or importing, the AventXPS.jar process MUST be running
in order for this functionality to work. You can check the status of the process by running the
$FCHOME/oa/aventxoc script and passing a status command, i.e. ‘$FCHOME/oa/aventxoc statu <SID>s’. If it
is not started, you will need to perform the command ‘$FCHOME/oa/aventxoc start <SID>’.

System Administration - Exporting and Importing Data

Page 851 of 944
Proprietary to STR Software
When clicking the Export Config button, a zip file will be downloaded through the internet browser, where
you can choose a download location if you wish. When clicking the Import Config button, a message prompt
will appear saying “Proceeding with the import will close the configuration form discarding unsaved changes
and will truncate AventX transient tables for the <SID> instance. Continue?” Select “Yes” and a browser tab
will open asking you to browse to the location of the zip file for importing.

Exporting and Importing from the Command Line

You can also export and import the schema via the command line. Some customers may wish to script this
process to help in the automation of post clone procedures. You can use the following command to
accomplish this:
java -cp <install_path>/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN
com.strsoftware.SchemaUtil.SchemaUtil import|export <path_to_file>/<filename> <SERVICE_NAME>
<schema_name> <truncate transient tables (yes|no)> [username] [password]

Here is an example of the command:

java -cp $FCHOME/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil export ./export_VIS_TEBS1.zip TEBS1 no xxaventx xxaventx

System Administration - Exporting and Importing Data

Page 852 of 944
Proprietary to STR Software
The second method is preferable because it can use the service name and does not require the full connect
string. Performing this task from the command line does not require the AventXPS.jar process to be running.

After Importing
After successfully importing configuration, there are a few follow-up tasks to be performed. Some of these
may or may not be required, depending upon your installation, however, please review each step carefully to
determine whether or not action is required.

• Adjust AventX WebManger settings, if needed.

The AventX WebManager is installed by default with the AventX UNIX software. To ensure that the AventX
Oracle Connector is configured for use with the WebManager,we will need to check the General Config tab of
the AventX Configuration Form. webmgr.enabled needs to be set to “Yes”, webmgr.system needs to be set to
the system name you want displayed, and webmgr.port needs to be set to the port being used to connect to
the Apache Tomcat web server (default is 8675).

• Update the AventX license, if needed.

AventX stores one or more license keys in the FAX_LICENSE table to be used in ensuring that the software is
licensed to run on a particular Oracle EBS instance. Since the FAX_LICENSE table was imported from the
“source” (e.g. UAT) system, it is possible that the key(s) stored in the FAX_LICENSE table is invalid.

Ensure that you have a valid key for your target instance. This key can be obtained by contacting STR
Software Technical Services at (804) 897-1600 extension 3 or [email protected].

To update the FAX_LICENSE table to contain the proper license key, navigate to the License Key tab of the
AventX Configuration form to make sure valid license keys are listed. You can use the “Check for Valid Key”
button to check if a valid key is already listed. If not, add a valid key and then save the changes.

• Ensure Validity of Directory Paths in the Configuration

AventX needs to know the pathnames for the processing of archived documents. The path(s) used for
archiving of documents is stored in the FAX_DOC_CONFIG_MISC table.

If you do not use archiving, then you may skip this step.

If you do use archiving, then you need to ensure that the directory paths specified in your present target
(e.g., Production) database are valid for this instance of AventX. This is accomplished by simply checking
these values via the AventX Configuration form.

From the AventX Configuration form, for each organization, for each document type that uses archiving,
ensure that the value for Directory (and Failover Directory, if desired) under the XML Archive Connection
section of the Misc tab for that document type is valid. Make any changes necessary and make sure to save
your changes.

Repeat this step for each document type within each organization that uses archiving.

System Administration - Exporting and Importing Data

Page 853 of 944
Proprietary to STR Software
• Re-add the AventX Attachments Entity/Category pairs under Attachment Types tab
This step is only required if using Hard-Coded Attachments, and if the target environment is not a clone or
refresh of the source environment. It is possible for the ID of the “AventX Attachments” entity to differ
between non-identical environments. For this reason, all references to the AventX Attachments entity in the
AventX configuration must be dropped and re-added. To do this, open the AventX Configuration Form and
click the List Configured Organizations button. Select a configured organization and select the Configure
Organization button. From there, navigate to the Documents tab and select a document type from the list of
values that uses Hard-Coded Attachments, then select the Open button. Navigate to the Attachment Types
tab:

System Administration - Exporting and Importing Data

Page 854 of 944
Proprietary to STR Software
Every Attachment Entity/Category pair with an entity of AventX Attachments must be deleted, re-added into
this form, and saved. Be sure to perform these steps for every organization and document type which use
Hard-Coded attachments. Failure to do so can cause certain attachment functionality to work improperly
within AventX.

System Administration - Exporting and Importing Data

Page 855 of 944
Proprietary to STR Software
Cloning

Cloning Oracle EBS with AventX on a Remote Server

The following figure shows a typical implementation with AventX installed on a remote server. For detailed
information on this implementation configuration, please refer to the AventX Oracle Connector
Implementation Requirements Guide.

Cloning Prerequisites

There are two prerequisites which must be met on the source and/or target instance as follows:

1. All AventX Oracle Connector licenses (keys for source and target instances) must be registered in the
source instance per instructions found in the AventX Oracle Connector Resource Guide section titled
“License Keys”.
2. The presently installed version of AventX Oracle Connector on the source and target systems must be the
same. This ensures that the database schema (tables, synonyms, grants, etc.) matches what the files in
the installation directory would create/update.

System Administration - Cloning

Page 856 of 944
Proprietary to STR Software
The AventX host is not cloned; all directories, files and configuration on the target instance will remain as
they were prior to the Oracle EBS cloning. This is possible as the Oracle EBS instance to which the target
instance of AventX is “attached” will not change as a result of the clone.

To determine the installed version of AventX Oracle Connector on the source instance, perform the following:

On the source instance AventX host as the login account that owns the AventX software (e.g., aventx):

$ $FCHOME/oa/fcprinto.sh -v

Perform the same command on the target instance AventX host as the login account that owns the AventX
software (e.g., aventx). If the source and target versions are not the same, contact STR Software Technical
Services for instructions prior to performing the clone.

Pre-Clone Steps

Prior to starting the clone, perform the following:

1. Stop AventX UNIX and AventX WebManager. (This step is not required for AventX Attachment Xpress for
eAM and AventX Print Xpress only implementations. Only perform this step if either faxing or emailing
from Oracle using AventX).
During the cloning process, no submissions to AventX Oracle Connector from Oracle EBS should be allowed.
No documents will be transmitted by the AventX software.

Perform on the target instance AventX host as the login account that owns the AventX software (e.g.,
aventx):

$ FCHOME/cfg/scripts/startup.sh stopall

$ ps –ef | grep <AventX login account> | grep fc

Ensure there are no AventX processes still active; repeat the process listing as necessary until there are none.
Example output:

$ ps -ef | grep aventx | grep fc

aventx 19223 18172 0 10:29 pts/3 00:00:00 grep fc

2. Export the AventX Oracle Connector configuration.

Within Oracle EBS, as System Administrator or the AventX Administrator responsibility, open the AventX
Connector Configuration form (Install → AventX → Configuration). On the Tools tab, select the appropriate
instance name from the list of values next to the Export Config button, then click the Export Config button to
save the export_<SID>_<host>.zip file to your local machine. Note: the AventX Oracle Connector process,
AventXPS, must be running on the AventX host for the Export Config button to work. Click the View Back-End
Status button to verify that this process is running.

System Administration - Cloning

Page 857 of 944
Proprietary to STR Software
The AventX Oracle Connector configuration can also be exported from the command line of the AventX host.
This command may be included in a script and does not require the AventXPS process to be actively running:

java -cp <install_path>/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil export <path_to_file>/export_<SID>_<host>.zip <SERVICE_NAME>
<schema name> <truncate transient tables (yes|no)> <username> <password>

Where <install_path> is the installation directory of AventX Oracle Connector ($FCHOME), <path_to_file> is
the location of the export file (the executing user must have write permissions), <SERVICE_NAME> is the
service name as found in tnsnames.ora, (yes|no) is the option to truncate transient tables, <aventx_user> is
the AventX schema owner, and <password> is that user’s password. For example:

java -cp $FCHOME/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil export ./export_VIS_TEBS1.zip TEBS1 no xxaventx xxaventx

System Administration - Cloning

Page 858 of 944
Proprietary to STR Software
3. Stop the AventX Oracle Connector process.

Perform on the target instance AventX host as the login account that owns the AventX software (e.g.,
faxmgr):

$ $FCHOME/oa/aventxoc stop

Ensure there are no AventX Oracle Connector processes active; repeat the process listing as necessary until
there are none. Example output:

$ ps –ef | grep aventx | grep -i AventX

aventx 19223 18172 0 10:29 pts/3 00:00:00 grep AventX

4. Back up the file $XXAVENTX_TOP/.fcoa_cfg_CMFORMHOST on the concurrent manager tier(s).

Migrate a copy of this file to another server or your local machine if it will be overwritten or deleted during
the cloning process.

Perform the Clone

Perform the clone from the source instance to the target instance(s) as per your normal procedures.

Post-Clone Steps

Upon completion of the clone, perform the following:

1. (Conditional – only necessary if the target schema password differs from the source schema password)
Reset the Oracle database AventX schema password on the target instance.

Determine the correct target instance AventX schema and password. To do this, perform on each target
instance AventX host as the login account that owns the AventX software (e.g., aventx):

$ cd $FCHOME

$ grep cORACLE_LOGIN= $FCHOME/.fcoa_cfg_<SID>

Where <SID> is the instance name used for the specific AventX instance, e.g. “DEV”. Example output:

$ grep cORACLE_LOGIN= $FCHOME/.fcoa_cfg_DEV

cORACLE_LOGIN="xxaventx/xxaventx"

Perform as a user with sufficient privileges (e.g., oracle):

$ sqlplus /nolog

> connect as sysdba (provide credentials)

System Administration - Cloning

Page 859 of 944
Proprietary to STR Software
> alter user <AventX schema> identified by <AventX schema password>;

> quit

System Administration - Cloning

Page 860 of 944
Proprietary to STR Software
2. (Conditional – only necessary if not using the Import Config technique discussed in step 7 below ) Purge
transaction records by truncating the source data from AventX Oracle Connector FAX_STATUS table on
the target instance.

These entries have <View Log> links to the source instance of AventX Oracle Connector; those logs will not be
available on the target instance.

Perform on each target instance AventX host as the login account that owns the AventX software (e.g.,
aventx):

$ sqlplus <AventX schema>/<AventX schema password>@<SID>

> truncate table FAX_STATUS;

> truncate table FAX_ERROR;

> truncate table FAX_HEADER;

> truncate table FAX_RECIPIENT;

> truncate table XXSTR_DESKTOP_DATA;

(The above table may not exist, depending on your AventX version)

> quit

3. Restore $XXAVENTX_TOP/.fcoa_cfg_CMFORMHOST from the backup taken in step 4 of the pre-clone

steps above.
4. (Conditional – only necessary if a hostname.override value is defined in the source ) Reset the
hostname.override value on the target instance.

5. Start AventX Oracle Connector on the target instance as the login account that owns the AventX software
(e.g., aventx):

$ $FCHOME/oa/aventxoc start

6. Start AventX UNIX and AventX WebManager on the target instance as the login account that owns the
AventX software (e.g., aventx) (This step is not required for AventX Attachment Xpress for eAM and
AventX Print Xpress only implementations. Only perform this step if either faxing or emailing from Oracle
using AventX).

$ $FCHOME/cfg/scripts/startup.sh startall

$ ps –ef | grep <AventX login account> | grep fc

System Administration - Cloning

Page 861 of 944
Proprietary to STR Software
Ensure all AventX processes have started; repeat as necessary. Example output:

Contact STR Software Technical Support if any error messages or warnings are displayed by either of the start
scripts.

7. Import the target instance AventX Oracle Connector Configuration.

Within Oracle EBS, as System Administrator or the AventX Administrator responsibility, open the AventX
Connector Configuration form (Install → AventX → Configuration). On the Tools tab, select the appropriate
instance name from the list of values next to the Export Config button, then click the Import Config button:

Note: Importing the Configuration File automatically creates a backup of the existing FAX_STATUS table.

This will launch a webpage with displaying the following:

System Administration - Cloning
Page 862 of 944
Proprietary to STR Software
Click browse and navigate to the export_<SID>_<host>.zip file from step 2 of the pre-clone steps above. Click
Submit to perform the import, after which AventX should display the message “Import completed
successfully.”

Once the Import is complete the AventX backend-process must be bounced to correctly reflect the imported
environment configuration:
$ $FCHOME/oa/aventxoc restart

The AventX Oracle Connector configuration can also be imported from the command line of the AventX host.
This command may be included in a script and does not require the AventXPS process to be actively running:

java -cp <install_path>/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil import <path_to_file>/export_<SID>_<host>.zip <SERVICE_NAME>
<user> <password>

Where <install_path> is the installation directory of AventX Oracle Connector ($FCHOME), <path_to_file> is
the location of the export file (the executing user must have read permissions), <SERVICE_NAME> is the
service name as found in tnsnames.ora, <aventx_user> is the AventX schema owner, and <password> is that
user’s password. For example:

java -cp /home/aventx/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil import /tmp/export_<SID>_<host>.zip VIS xxaventx xxaventx

System Administration - Cloning

Page 863 of 944
Proprietary to STR Software
Cloning Oracle EBS with AventX on the Concurrent Manager Tier(s)
The following diagram shows a typical implementation with AventX installed on the Concurrent Manager(s)
or a shared file system. For detailed information on this implementation configuration, please refer to the
AventX Oracle Connector Architecture Deployment Guide.

Cloning Prerequisites

There are two prerequisites which must be met on the source and/or target instance as follows:

1. All AventX Oracle Connector licenses (keys for source and target systems) must be registered in the
source instance per instructions found in the AventX Oracle Connector Resource Guide section titled
“License Keys”.
2. The presently installed version of AventX Oracle Connector on the source and target systems must be the
same. This ensures that the database schema (tables, synonyms, grants, etc.) matches what the files in
the installation directory would create/update.
The AventX software is cloned; all directories, files and configuration on the target system(s) will become the
same as the source instance. It is imperative that the post-clone steps are performed to “reset” the target
instance.

System Administration - Cloning

Page 864 of 944
Proprietary to STR Software
To determine the installed version of AventX Oracle Connector on the source instance, perform the following:

On the source instance CM host(s) as the login account that owns the AventX software (e.g., applmgr)

$ $FCHOME/oa/fcprinto.sh -v

Perform the same command on the target instance CM host(s) as the login account that owns the AventX
software (e.g., applmgr). If the source and target versions are not the same, contact STR Software Technical
Services for instructions prior to performing the clone.

Pre-Clone Steps

Prior to starting the clone, perform the following:

1. Stop AventX UNIX and AventX WebManager. (This step is not required for AventX Attachment Xpress for
eAM and AventX Print Xpress only implementations. Only perform this step if either faxing or emailing
from Oracle using AventX).
During the cloning process, no submissions to AventX Oracle Connector from Oracle EBS should be allowed.
No documents will be transmitted by the AventX software.

Perform on each source and target instance AventX host as the login account that owns the AventX software
(e.g., applmgr):

$ $FCHOME/cfg/scripts/startup.sh stopall

$ ps –ef | grep <AventX login account> | grep fc

Ensure there are no AventX processes; repeat the process listing as necessary until there are none. Example
output:

$ ps –ef | grep applmgr | grep fc

applmgr 19223 18172 0 10:29 pts/3 00:00:00 grep fc

2. Export the AventX Oracle Connector configuration.

Within Oracle EBS, as System Administrator or the AventX Administrator responsibility, open the AventX
Connector Configuration form (Install → AventX → Configuration). On the Tools tab, select the appropriate
instance name from the list of values next to the Export Config button, then click the Export Config button to
save the export_<SID>_<host>.zip file to your local machine. Note: the AventX Oracle Connector process,
AventXPS, must be running on the AventX host for the Export Config button to work. Click the View Back-End
Status button to verify that this process is running.

System Administration - Cloning

Page 865 of 944
Proprietary to STR Software
The AventX Oracle Connector configuration can also be exported from the command line of the AventX host.
This command may be included in a script and does not require the AventXPS process to be actively running:

java -cp <install_path>/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil export <path_to_file>/export_<SID>_<host>.zip <SERVICE_NAME>
<user> <password>

Where <install_path> is the installation directory of AventX Oracle Connector ($FCHOME), <path_to_file> is
the location of the export file (the executing user must have write permissions), <SERVICE_NAME> is the
service name as found in tnsnames.ora, <aventx_user> is the AventX schema owner, and <password> is that
user’s password. For example:

java -cp /home/aventx/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil export /tmp/export_<SID>_<host>.zip VIS xxaventx xxaventx

3. Stop the AventX Oracle Connector process.

System Administration - Cloning

Page 866 of 944
Proprietary to STR Software
Perform on each source and target instance AventX host as the login account that owns the AventX software
(e.g., applmgr):

$ $FCHOME/oa/aventxoc stop

For <instance name>, insert the name of the Oracle EBS instance, for example “PROD”.

$ ps –ef | grep <AventX login account> | grep –i AventX

Ensure there are no AventX Oracle Connector processes active; repeat the process listing as necessary until
there are none. Example output:

$ ps –ef | grep applmgr | grep AventX

applmgr 19223 18172 0 10:29 pts/3 00:00:00 grep AventX

4. Back up the AventX file system.

The AventX $FCHOME directory will be overwritten during a clone if it is on the concurrent manager tier. Use
the following commands to completely back up the AventX file system:

$ cd $FCHOME

$ tar –cvf aventx_backup.tar * .pid .usage .fcoa_cfg*

(You may receive a warning that the .pid directory does not exist if AventX UNIX is not installed.)

Migrate a copy of the aventx_backup.tar file to another server or your local machine if it will be deleted
during the cloning process.

5. Back up the file $XXAVENTX_TOP/.fcoa_cfg_CMFORMHOST on the concurrent manager tier(s).

Migrate a copy of this file to another server or your local machine if it will be overwritten or deleted during
the cloning process.

Perform the Clone

Perform the clone from the source system to the target instance(s) as per your normal procedures.

Post-Clone Steps

Upon completion of the clone, perform the following:

1. (Conditional – only necessary if the target schema password differs from the source schema password)
Reset the Oracle database AventX schema password on the target instance.

System Administration - Cloning

Page 867 of 944
Proprietary to STR Software
Determine the correct target instance AventX schema and password. Perform on each target instance AventX
host as the login account that owns the AventX software (e.g., applmgr):

$ cd $FCHOME

$ grep cORACLE_LOGIN= .fcoa_cfg_<SID>

Where <SID> is the instance name used for the specific AventX instance, e.g. “DEV”. Example output:

$ grep ORACLE_LOGIN= $FCHOME/.fcoa_cfg_DEV

cORACLE_LOGIN="xxaventx/xxaventx"

Perform as a user with sufficient privileges (e.g., oracle):

$ sqlplus /nolog

> connect as sysdba (provide credentials)

> alter user <AventX schema> identified by <AventX schema password>;

> quit

2. Purge transaction records from AventX Oracle Connector FAX_STATUS table on the target instance.

These entries have <View Log> links to the source instance of AventX Oracle Connector; those logs will not be
available on the target instance.

Perform on each target system AventX host as the login account that owns the AventX software (e.g.,
faxmgr):

$ sqlplus <AventX schema>/<AventX schema password>

> truncate table FAX_STATUS;

> truncate table FAX_ERROR;

> truncate table FAX_HEADER;

> truncate table FAX_RECIPIENT;

> truncate table XXSTR_DESKTOP_DATA;

(The above table may not exist, depending on your AventX version)

> quit

System Administration - Cloning

Page 868 of 944
Proprietary to STR Software
3. Restore $FCHOME from the backup taken in step 4 of the pre-clone steps above. First, you will want to
remove any .fcoa_cfg* files that were copied into $FCHOME from the source instance:

$ cd $FCHOME

$ rm .fcoa_cfg*

Next, migrate the aventx_backup.tar file into $FCHOME and perform the following command:

$ tar –xvf aventx_backup.tar

This will restore the AventX file system as it existed before the clone, including the .fcoa_cfg_CMFORMHOST
file.

4. (Conditional – only necessary if a hostname.override value is defined in the source ) Reset the
hostname.override value on the target instance.
5. Start AventX Oracle Connector on the target instance.

$ $FCHOME/oa/aventxoc start

This will allow normal AventX processing to commence on the target instance. Perform on each target
instance AventX host as the login account that owns the AventX software (e.g., applmgr).

6. Start AventX UNIX and AventX WebManager on the target instance. (This step is not required for AventX
Attachment Xpress for eAM and AventX Print Xpress only implementations. Only perform this step if
faxing and emailing from Oracle using AventX).

$ $FCHOME/cfg/scripts/startup.sh startall

$ ps –ef | grep <AventX login account> | grep fc

System Administration - Cloning

Page 869 of 944
Proprietary to STR Software
Ensure all AventX processes have started; repeat as necessary. Example output:

Contact STR Software Technical Support if any error messages or warnings are displayed by either of the start
scripts.

System Administration - Cloning

Page 870 of 944
Proprietary to STR Software
7. Import the target instance AventX Oracle Connector Configuration.
Within Oracle EBS, as System Administrator or the AventX Administrator responsibility, open the AventX
Connector Configuration form (Install → AventX → Configuration). On the Tools tab, select the appropriate
instance name from the list of values next to the Export Config button, then click the Import Config button:

Note: Importing the Configuration File automatically creates a backup of the existing FAX_STATUS table.

This will launch a webpage with displaying the following:

Click browse and navigate to the export_<SID>_<host>.zip file from step 2 of the pre-clone steps above. Click
Submit to perform the import, after which AventX should display the message “Import completed
successfully.”

Once the Import is complete the AventX backend-process must be bounced to correctly reflect the imported
environment configuration:
$ $FCHOME/oa/aventxoc restart

System Administration - Cloning

Page 871 of 944
Proprietary to STR Software
The AventX Oracle Connector configuration can also be imported from the command line of the AventX host.
This command may be included in a script and does not require the AventXPS process to be actively running:

java -cp <install_path>/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil export <path_to_file>/export_<SID>_<host>.zip <SERVICE_NAME>
<user> <password>

Where <install_path> is the installation directory of AventX Oracle Connector ($FCHOME), <path_to_file> is
the location of the export file (the executing user must have read permissions), <SERVICE_NAME> is the
service name as found in tnsnames.ora, <aventx_user> is the AventX schema owner, and <password> is that
user’s password. For example:

java -cp /home/aventx/oa/java/AventXPS.jar -Doracle.net.tns_admin=$TNS_ADMIN

com.strsoftware.SchemaUtil.SchemaUtil export /tmp/export_<SID>_<host>.zip VIS xxaventx xxaventx

Multiple Oracle EBS Instances with one AventX Instance

Most customer Oracle EBS implementations have many Oracle EBS instances on many different hosts. These
Oracle EBS instances normally break down into a single “production” instance (PROD) and any number of
non-production instances (e.g. DEV, TEST, UAT, QAT etc). The non-production instances are where testing
and training take place as well as development of new functionality to be applied in production once ready.

While the PROD instance of Oracle EBS should have a separate PROD instance of AventX, the non-production
instances of Oracle EBS usually can all be funneled through a single instance of AventX. It is true that this
implementation will have documents for delivery within AventX UNIX from many different sources.
However, AventX is designed to support this configuration while keeping the transmission information and
control of the individual Oracle EBS instances separate.

Using this implementation, fewer Unix hosts and login accounts are necessary to support the various Oracle
EBS instances. This reduces the complexity of the AventX infrastructure as well as significantly reducing
normal maintenance (e.g. software upgrades, database maintenance, Unix account maintenance etc).

AventX installation supports multiple Oracle EBS instances by prompting for the particular instance while
running the various support scripts. Each Oracle EBS instance is identified by a <SID> value. This <SID> value
must be resolvable to the correct Oracle database for that Oracle EBS instance, normally via the Oracle
network utilities associated with tnsnames.ora and sqlnet.ora.

One of the requirements for having the AventX instance on a separate host from any of the Oracle EBS hosts
is that the full Oracle client tools must be installed and available to the AventX login account (e.g.
“xxaventx”). These Oracle tools allow AventX to communicate with the Oracle database.

System Administration - Multiple Oracle EBS Instances with one AventX Instance
Page 872 of 944
Proprietary to STR Software
AventX tracks each <SID> instance separately; with each <SID> that has been configured processed through
its own directory structure. AventX maintains a list of the <SID>s that have been at least partly configured in
the $FCHOME/oa/.database file. A separate AventX configuration file is created for each configured
Oracle EBS instance as $FCHOME/.fcoa_cfg_<SID>. The appropriate configuration file is sourced by
AventX for each report output submission.

Installation and configuration for each Oracle EBS instance uses the same methodology as described in
previous chapters in this guide. Let’s take a look at the installation of AventX for (2) Oracle EBS instances;
we’ll name them “DEV” and “TEST”.

The first item to be accounted for is that the AventX account can resolve these (2) Oracle EBS instances
(actually, the databases for these instances). Using standard Oracle procedures, an entry for each would be
placed into the $TNS_ADMIN/tnsnames.ora file. Here are the entries for our example scenario:

##

## 11.5.10 - DEV on GRIMLOCK

##

DEV=

(DESCRIPTION=

(ADDRESS=(PROTOCOL=tcp)(HOST=grimlock.mydomain)(PORT=1521))

(CONNECT_DATA=

(SERVICE_NAME=DEV)

(INSTANCE_NAME=DEV)

##

## R12 - TEST on SILVERBOLT

##

TEST=

(DESCRIPTION=

System Administration - Multiple Oracle EBS Instances with one AventX Instance
Page 873 of 944
Proprietary to STR Software
 ADDRESS=(PROTOCOL=tcp)(HOST=silverbolt.mydomain)(PORT=1521))

(CONNECT_DATA=

(SERVICE_NAME=TEST)

(INSTANCE_NAME=TEST)

From the Unix command line, a check to the (2) Oracle EBS instances should be done using the tnsping utility:

$tnsping DEV

Attempting to contact (ADDRESS=(PROTOCOL=tcp)(HOST=grimlock.mydomain)(PORT=1521))

OK (50 msec)

$tnsping TEST

Attempting to contact (ADDRESS=(PROTOCOL=tcp)(HOST=silverbolt.mydomain)(PORT=1521))

OK (50 msec)

The next item to be accounted for is that AventX is properly installed under each Oracle EBS instance using
the $FCHOME/oa/ins/setup.sh script.

The results of this installation should be that there are (2) AventX configuration files at $FCHOME:

$ ls .fcoa_cfg*

.fcoa_cfg_DEV

.fcoa_cfg_TEST

System Administration - Multiple Oracle EBS Instances with one AventX Instance
Page 874 of 944
Proprietary to STR Software
Each with a separate file system under $FCHOME/oa/database.

Submissions to AventX from each Oracle EBS instance will follow the same flow:

• The concurrent manager will run the concurrent request, which will be complete when the report output
and parameter files have been transferred to the AventX host into the
$FCHOME/oa/database/<SID>/dropoff directory. The concurrent request log will show this
transfer.

• The Scanner thread of the back-end process will look in the dropoff directory for files to process. When
the file is found the job is added to the scanner queue. One of the scanner workers picks up the job from
the queue and starts processing (bursting, merging, getnum, archiving etc.)

• Legacy processing scripts getnum.awk and pager.awk can be used to maintain custom bursting and
document number requirements. To enable this functionality the scripts must be placed in
$FCHOME/oa/util directory with the filename form of <doc_type>-getnum.awk and <doc_type>-
pager.awk. For example, to process invoices with these scripts, the filenames would be invl-getnum.awk
and invl-pager.awk. You may also specify the location of the awk binary in the awk.command option on
the General Config tab of the AventX Configuration Form.

• Acknowledgements are posted directly into the FAX_STATUS table.

• For email and fax documents, the resulting command, data and attachment files (from the first AventX
UNIX processing cycle – call to AventX) will be placed in the $FCHOME/oa/database/<SID>/scan
directory.

• AventX UNIX will periodically look for files to process from the “scan” directories. Matching files will be
processed for submission into AventX UNIX for transmission. At that point, Oracle EBS users will be able
to manage these documents via the link to AventX WebManager on the AventX Delivery Status form.

• The various log files associated with a given AventX cycle will be placed in the
$FCHOME/oa/database/<SID>/log directory. Individual concurrent request submission logs are
located in $FCHOME/oa/database/<SID>/log/history/<request_id>.log.

System Administration - Multiple Oracle EBS Instances with one AventX Instance
Page 875 of 944
Proprietary to STR Software
Failover and High Availability Options

Introduction
Please note that not all features support high availability features. The following features are available for
the following products

• AventX Oracle Connector

• AventX for Oracle eAM
For many companies, high availability is a desired, if not required, aspect for server applications to ensure a
minimum of down-time when system components fail. AventX supports high availability ("Failover")
configurations that also provide a measure of load-balancing ("Intelligent Routing"). These features may be
used independently or combined.

AventX supports different hardware/software architectures. The recommended architecture involves AventX
residing on a different host than the Oracle Concurrent Manager host. In this case, when a concurrent
request is submitted, a “scan” file (special file used by AventX), and the report output are transferred via FTP
or SFTP from the Concurrent Manager host to the AventX (i.e. "AventX") host for processing, as shown below.

The previously described scenario depends heavily upon the successful transfer of the file(s) to the AventX
host and does not meet the requirements of high availability. In the event of a problem with the file transfer,
the concurrent request completes with a warning, and the submission terminates. No status information for
the request is ever created so the AventX Delivery Status form would show nothing. Only the concurrent
request log would show the source of the processing error (see the images below).

In this case, the user must resubmit the concurrent request once again after the file transfer issues have been
resolved. This, of course, is quite inconvenient for the user, as each report that failed must be tracked down
and resubmitted, costing the user valuable time.

Commencing with version 7.3.00 of AventX, the scenario described above (i.e. high availability) is addressed
using the failover functionality. Commencing with version 8.2.00 of AventX, a measure of load-balancing
("Intelligent Routing") is also addressed. This chapter describes the process flow for failover and intelligent
routing as well as how to configure the AventX host(s) to support such.

If implementing both the failover and intelligent routing features, define the intelligent routing environment
variables as described in the section on AventX Intelligent Routing, and then perform the steps described in
the section on AventX Failover.
System Administration - Failover and High Availability Options
Page 876 of 944
Proprietary to STR Software
Commencing with version 20.4.00 of AventX, there will be an option to check if AventXPS is running on your
host before the files are transferred. If not, AventX will attempt to submit to the next failover host.. This
setting is disabled by default and the environment variable must be changed in order to enable the check. To
enable the check you must go into .fcoa_cfg_CMFORMHOST and change the cCHECK_AVENTXPS
environment variable to = ‘Y’.

System Administration - Failover and High Availability Options

Page 877 of 944
Proprietary to STR Software
Remote Server High Availability

The AventX Oracle Connector provides the ability to failover to one or more secondary AventX instances as
well as a measure of load balancing via “intelligent routing”. These features apply to AventX Oracle
Connector and AventX Attachment Xpress only.

For failover, when the primary instance is unable to fulfill the sFTP or FTP transfer request, the AventX Oracle
Connector will attempt to transfer the Oracle concurrent request files to one or more secondary instances.
Additional licensing may be required.

Concurrent Manager Tier and High Availability Options

The following provides information on options for ensuring the availability of AventX in a concurrent manager
tier implementation.

For companies who have multiple concurrent manager teirs and wish to ensure AventX is available if one of
the tiers is offline, STR Software recommends installing multiple instances of AventX on each concurrent
manager tier’s local disk or have separate SAN disks for each AventX installation. See “Distributed File system
on a SAN” and “Separate AventX Installations on Multiple CMs on Local Disk”

The following information is important when considering this option:

• The AventX configuration settings, file system paths, and software versions on the secondary, failover
servers must be exactly the same as production.
• The appropriate licensing must be available.
The transmission history in each AventX instance will not be the same across all instances. Users will be able
to log into a single instance of the AventX WebManager from Oracle EBS and see the document regardless of
the individual concurrent manager and AventX queue that processed the document. Administrators who
access the software from the “command line” will only see documents processed on the host they log in to.

For high availability, all AventX instances will have to maintain the same configuration settings and software
versions. Configuration settings are NOT copied over automatically.

The following information is important when considering the high-availability option:

• The configuration settings, file system paths, and software versions on all AventX instances must be
exactly the same.
• A license key for each AventX instance in the cluster must be available to start the software. If a
permanent license key is not available, then a phone call can be made to STR Software’s Technical
Support team and a temporary license key can be provided as part of STR Software’s “Temporary License
Key” policy.
• The transmission history from the "primary" AventX instance will not be available to the users when a
secondary AventX instance is activated.
• Any document in the “queue” waiting to be transmitted or waiting on delivery status on the primary
AventX instance at the time of failover will need to be manually re-transmitted from Oracle EBS.
For companies with a single Concurrent Manager tier and a Concurrent Manager implementation of AventX,
the AventX software does not provide any native failover or High Availability options. In this setup, STR

System Administration - Failover and High Availability Options

Page 878 of 944
Proprietary to STR Software
Software recommends performing periodic file system backups of the entire AventX file system. This may
require a stop of the application prior to performing a backup depending on the technology being used.

Process Flow
To enable failover functionality, AventX is configured with a list of “failover AventX hosts” that are used if the
file transfer to the primary AventX host fails. Each failover AventX host is tried in succession until either a
successful transfer occurs, or all defined failover AventX hosts have been exhausted, at which point an error
is generated.

This flow is illustrated in the figure above. In this scenario, there is one primary AventX host and three
failover AventX hosts.

The following table describes the exact conditions under which failover occurs. These conditions are
dependent upon error messages received from FTP/SFTP. Any other conditions are not checked and have no
bearing on failover strategy.

Failover Conditions

Condition Meaning

Login fails An attempt was made to login to the specified host. One or more
of the criteria used for login information failed.

Failure to change directory / No Although the login was successful, a permissions issue exists or the
such file or directory directory specified does not exist on the specified host.

Authentication Failure The connection information as supplied for the FTP/SFTP session
was invalid, resulting in authentication failure of some kind.

Not Connected There is no active connection to the specified host.

If AventX is not actively running on the failover server, the files will remain in the directory in which they
were deposited, i.e., the failover strategy does not check to see if AventX is actively running on the failover
host. It simply performs the FTP/SFTP, and if successful, does not try any other failover hosts.

Pre-Requisites
For a successful failover environment, the following pre-requisites must exist:

• All AventX hosts must be running the same version of AventX Oracle Connector (version 7.3.00 or
higher).

• All AventX hosts must be configured exactly the same with respect to AventX Oracle Connector.

• All AventX hosts must have licensed and fully functional AventX instances (consists of AventX Oracle
Connector and for fax/email document processing, AventX UNIX)
System Administration - Failover and High Availability Options
Page 879 of 944
Proprietary to STR Software
 • Ensure that any trusted relationships (SFTP) between the concurrent manager host(s) and each
AventX host are fully functional and have been tested.

• Prior to configuring this feature in AventX Oracle Connector, gather a recent list of FTP/SFTP logins
and passwords for each failover AventX host.

Once the pre-requisites have been satisfied, proceed with configuring AventX on the primary and failover
AventX hosts, as described in the "Configuration" section.

System Administration - Failover and High Availability Options

Page 880 of 944
Proprietary to STR Software
Configuration
AventX can be configured or un-configured for the failover functionality at any time. The processing flow
change will take effect immediately upon completion of all the configuration steps.

AventX is configured on the primary AventX host for the failover functionality, including defining the failover
AventX hosts, by running $FCHOME/oa/ins/setup.sh. When starting this script, answer the following question
appropriately:

Is this a failover AventX Host?(Yes,[No])

At the Main Menu, select option 1, "Create the .fcoa_cfg file". This is the same script used to
install the AventX software.

If the software was previously installed, each prompt will be pre-populated with the present value - changing
these values may disrupt the present working condition of AventX. Eventually the following prompt will be
displayed:

The concurrent request parameters (in a file) and the report output

file need to be transferred to the AventX(tm) host. The following

methods are available for transferring the data.

A. ftp (ftp to AventX(tm) Host (grimlock))

B. sftp (secure ftp to AventX(tm) Host (grimlock))

C. cp (AventX(tm) products installed on CM host)

Current value is: A

[A/(p)revious]:

The failover functionality is not supported (does not make sense) for the cp transfer method.

The failover functionality is not supported for the <View Log> functionality from the AventX Delivery Status
form.

Upon entering A (indicating an FTP transfer), the prompt for the user's password to the primary AventX host
is displayed; enter the proper value and continue. If entering B (indicating an SFTP transfer), no prompt for
the user's password is displayed. The subsequent prompt for the failover feature will be displayed:

System Administration - Failover and High Availability Options

Page 881 of 944
Proprietary to STR Software
AventX Oracle supports failover AventX Hosts for ftp/sftp transfer.

Would you like to enable this feature?

Y. Yes

N. No

Current value is: N

Would you like to change the current value [y/N/(p)revious]:

Changing the current value to "Y" (Yes) will enable the failover feature and allow failover AventX hosts to be
defined. If you specify "N" (No), the failover feature will not be used in AventX processing.

On the first "visit" to the next prompt, no failover AventX hosts will have been defined and the prompt will
indicate such as follows:

No failover AventX Hosts are presently configured.

To add a new failover AventX host, enter 'N'

To delete an existing failover AventX host, enter 'D'

If finished with failover AventX Host configuration, enter 'F'

Enter your selection from one of the above:

On subsequent "visits" to this prompt, any failover AventX hosts which have been defined will be indicated as
follows:

The following is a list of presently configured failover hosts.

1. rgts3-vm-rhel37.gustinlan

2. rgts3-vm-rhel51.gustinlan

System Administration - Failover and High Availability Options

Page 882 of 944
Proprietary to STR Software
3. bad_entry (this is a purposeful "bad entry" as an example)

4. rgts2.gustinlan

To change information about an existing failover AventX host, enter the menu item number.

To add a new failover AventX host, enter 'N'

To delete an existing failover AventX host, enter 'D'

If finished with failover AventX Host configuration, enter 'F'

Enter your selection from one of the above:

AventX supports an unlimited number of failover AventX hosts. The order of failover AventX hosts
determines the order followed under a failure condition. Re-ordering failover AventX hosts is not simple;
therefore, carefully consider the desired order before adding them.

When specifying "N" (to add a new host) or the failover AventX host number (to edit an existing host),
subsequent prompts for the host, user, password (for FTP transfers only), and directory will be presented.
Enter the proper value for each.

Specify "D" to delete an existing failover AventX host. The subsequent prompt will ask which of the entries
(from the list above) to delete. Use caution when deleting entries as the change is effected in the
.fcoa_cfg_<SID> file immediately.

When finished defining failover AventX hosts, enter "F" to continue with the remainder of the questions for
option 1 of setup.sh. Move the changes to all the concurrent manager tiers. This is accomplished by executing
option 7 (Prepare Concurrent Manager and forms scripts) from the setup.sh Main Menu; make sure to follow
all instructions for the Concurrent Manager host(s) presented by this option.

Creating another AventX Server(s) for Failover

As noted in the section "Pre-Requisites", each failover AventX host must have a licensed and fully-functional
AventX instance, which includes AventX Oracle Connector and AventX UNIX. There are (2) main methods of
creating a failover AventX instance:

Perform fresh installations of the AventX software on each failover AventX host (Follow the instructions
provided the chapter “Installing AventX UNIX” of the AventX UNIX Resource Guide followed by Chapter 1,
"Installing AventX Oracle Connector" of this document. When installing AventX Oracle Connector, answer
"Yes" to the following prompt:

System Administration - Failover and High Availability Options

Page 883 of 944
Proprietary to STR Software
Is this a failover AventX Host?(Yes,[No])

This will adjust the completion values for options 3 through 6 upon completion of option 2, "Prepare
connector scripts for execution" to reflect "OK"; these steps do not need to (read must not) be
performed on the failover AventX host, as this AventX instance is connected to the same Oracle EBS instance
(database) as the primary AventX instance.

At the Main Menu, select option 1, "Create the .fcoa_cfg file". Provide the exact same values for
each prompt as was specified for the primary AventX host..

At the Main Menu, select option 2, " Prepare connector scripts for execution". It is not
necessary to (read do not) perform option 7, "Prepare Concurrent Manager and forms
scripts", as this step was accomplished from the primary AventX host.

Copy the primary AventX instance to each failover AventX host. The steps defined there will capture and copy
both the AventX Oracle Connector software and the AventX UNIX software as the AventX Oracle Connector
software is installed in $FCHOME (the installation directory of AventX UNIX). After completing step 8 of those
instructions, perform the following:

$FCHOME/oa/ins/setup.sh

At the Main Menu, select option 1, "Create the .fcoa_cfg file". Provide the same values for each prompt as
was specified for the primary AventX host.

At the Main Menu, select option 2, "Prepare connector scripts for execution".

It is not necessary to perform steps 9 - 11 of those instructions as the failover AventX instance is required to
match the primary AventX instance.

Maintenance
There may be times after initial configuration when you need to add, change information for, or delete a
failover AventX host. This should only be accomplished by using option 1 of the setup.sh script on the primary
AventX host (changes must be propagated to the Concurrent Manager host(s) as previously noted).

Troubleshooting Failover Situations

Troubleshooting file transfer issues consists of reviewing the Concurrent Request log to determine which of
the failover AventX hosts were attempted and what the failure conditions for each were. This log will also
show which AventX host received the files in the case of successful completion. Once the file(s) have been
located, use the standard troubleshooting techniques.

System Administration - Failover and High Availability Options

Page 884 of 944
Proprietary to STR Software
Performance Tuning for High Volumes
This section is only applicable to the AventX Oracle Connector software module.

There are many ways to performance tune the AventX application. This section provides some information
on how to performance tune and enhance the AventX implementation to scale the software to process high
document volumes. Every AventX implementation is different and a discussion with a STR Software Support
Engineer is always a great way to obtain the best recommendation for performance tuning an
implementation of AventX.

The following may be considered to improve performance.

• Multi-threading – Consideration can be given to increasing the value for the number of workers
assigned to processing concurrent requests. Batch size and frequency may also need to be evaluated
in order to maximize the throughput if the value is increased. Breaking large batches into more,
smaller batches increasing the effectiveness of the multi-threading feature.

• Email grouping – Email grouping *may* help organize emails into a single email when multiple emails
are put into the delivery queue.

• For email, consideration can be given to adding more AventX Mail Plus email devices to multi-thread
the execution of the SENDMAIL binary. More than five (5) email devices typically does NOT increase
throughput.

• Query optimization – Test recipient (and other) queries to determine if they are efficient

System Administration - Performance Tuning for High Volumes

Page 885 of 944
Proprietary to STR Software
Load Balancer
A software or hardware load balancer can be deployed to distribute load between two AventX servers.
Additional AventX licensing may be required for this option.

AventX
Production
Server 1

Production
Oracle EBS Instance Email
F5
Load
Balancer

AventX
Production
Server 2

Email

Known Issues when using a Load Balancer

• The load is balanced by concurrent request only. Therefore, individual document types (from separate
concurrent requests) have the potential to be spread across various AventX UNIX/Webmanager instances
making centralized document management more difficult.
• Clicking on "Modify Document" for a single row in the AventX Delivery Status form will navigate to the
correct AventX instance that the document was sent from; however, clicking on "Manage Documents"
will show only those documents sent from the FAX_HOSTNAME column of the highlighted row. A best
practice recommendation would be to always search/filter on Request ID before attempting to use the
"Manage Documents" functionality.
• In some scenarios it may be necessary to disable SSH host key verification from the client (Oracle CM tier)
to allow successful sftp connections to more than one AventX node. See How to disable SSH host key at
http://linuxcommando.blogspot.com/2008/10/how-to-disable-ssh-host-key-checking.html for more
information.

System Administration - Performance Tuning for High Volumes

Page 886 of 944
Proprietary to STR Software
Intelligent Routing to another AventX Server
Intelligent routing is a feature of AventX that can distribute the work load between multiple AventX
production servers. To enable intelligent routing, AventX is configured with a list of AventX hosts and their
associated sort values and connection information. When the concurrent request is run calling AventX, the
appropriate AventX host is determined, and the *.scan and report output are transferred (via either ftp or
sftp) for further processing. This flow is illustrated in the figure below. In this scenario, there are two AventX
hosts, but AventX supports an unlimited number of AventX hosts.

System Administration - Performance Tuning for High Volumes

Page 887 of 944
Proprietary to STR Software
 AventX
Production
Server #1
(av1-prod.domain)
AXOC processing by number of workers in
$FCHOME/cfg/scripts/dirscan.cfg:
<Scan>
Path $FCHOME/oa/database/PROD/dropoff
Pattern *.scan
Purchase Orders Workers 12
Requests for Quotation Execute $FCHOME/oa/axoc_submit.sh PROD
</Scan>

Production AventX
Oracle EBS Instance sFTP
Production
FTP Server #2
(av2-prod.domain)
Sales Order Acks AXOC processing by number of workers in
Database # 1 Invoices $FCHOME/cfg/scripts/dirscan.cfg:
“PROD” sFTP Statements <Scan>
FTP Path $FCHOME/oa/database/PROD/dropoff
Pattern *.scan
Workers 12
AventX schema is CR print driver calls
Execute $FCHOME/oa/axoc_submit.sh PROD
“faxmgr/PRODpass” <$FCHOME>/oa/fcprinto.sh
</Scan>
And fcprinto.sh sources
$FCHOME/.fcoa_cfg_CMFORMHOST

which defines the Intelligent Routing:

cREMOTE_AXOC_LIST_PARAMETER={8}

cREMOTE_AXOC_LIST_1="pop rfqp"
cREMOTE_AXOC_LIST_HOST_1=av1-prod.domain
cREMOTE_AXOC_LIST_LOGIN_1=faxmgr
cREMOTE_AXOC_LIST_PASS_1=<pass>
cREMOTE_AXOC_LIST_DIR_1=/home/faxmgr/oa/database/PROD/dropoff

cREMOTE_AXOC_LIST_2="invl soal stmt"

cREMOTE_AXOC_LIST_HOST_2=av2-prod.domain
cREMOTE_AXOC_LIST_LOGIN_2=faxmgr
cREMOTE_AXOC_LIST_PASS_2=<pass>
cREMOTE_AXOC_LIST_DIR_2=/home/faxmgr/oa/database/PROD/dropoff

And points to the AventX host:

cREMOTE_AXOC_HOST=av1-prod.domain

Some of the advantages of this feature are:

• Increased concurrent transmissions from AventX UNIX instances, especially for email delivery using
AventX MailPlus devices. Each AventX UNIX instance can have a number of AventX MailPlus devices;
the larger the number of AventX UNIX instances, the greater the number of concurrent email
transmissions.

• Shorter end-to-end (Concurrent request execution to delivery to the destination) processing times for
documents with immediate delivery requirements.

System Administration - Performance Tuning for High Volumes

Page 888 of 944
Proprietary to STR Software
The following table describes the parameters used for this feature. These parameters are defined as blocks
of environment variables in the $FCHOME/.fcoa_cfg_CMFORMHOST (created from the
$FCHOME/.fcoa_cfg_<SID> file during execution of setup.sh STEP7).

Environment Variable Description

cREMOTE_AXOC_LIST_PARA Defines which parameter from the call to fcprinto.sh is used to

METER
determine which AventX instance should perform the processing.
The typical fcprinto.sh call is:
<$FCHOME>/oa/fcprinto.sh "AventX Automatic"
"<$FCHOME>/oa/database/<SID>/dropoff/RGUSTIN.2971340.21976" "103"
"RGUSTIN.2971340" "204" "1" "[LANG=PCL]" "pop" "fcdi" "" "1"

With the parameters in order being (including the value from the example):

“$PROFILES$.PRINTER” "AventX Automatic"

$PROFILES$.FILENAME
"FCHOME>/oa/database/<SID>/dropoff/RGUSTIN.2971340.21976"
$PROFILES$.XXSTR_SEQNO "103"
“$PROFILES$.TITLE” "RGUSTIN.2971340"
$PROFILES$.ORG_ID "204"
$PROFILES$.CONC_COPIES "1"
AventX UNIX commands "[LANG=PCL]"
AventX doctype "pop"
AventX form method "fcdi"
AventX special ""
AventX host "1"

Of course, additional parameters may be specified via the print driver

argument string. The most commonly-used parameter is the eighth, doctype.
The proper format of the entry is "{n}", where 'n' is the number of the
parameter. For example:
cREMOTE_AXOC_LIST_PARAMETER={8}

cREMOTE_AXOC_LIST_<n> Defines the values of the specified parameter which should be matched
against to route submission to the associated AventX host. Individual values
must be separated by <space>.
For example, if using doctype as the sorting parameter, the value might be:
cREMOTE_AXOC_LIST_1="pop rfqp"
To route submission of Purchase Orders and Requests for Quotation to the
associated AventX host. There is no limit to the number of values to be
contained in the sort list.

cREMOTE_AXOC_LIST_HOST_ Defines the DNS name or IP Address of the AventX host where matching
<n>
submissions will be transferred for further processing by AventX. For
example:
cREMOTE_AXOC_LIST_HOST_1=vm-qa-1213.strsoftware.com

System Administration - Performance Tuning for High Volumes

Page 889 of 944
Proprietary to STR Software
 Environment Variable Description

cREMOTE_AXOC_LIST_LOGIN Defines the Unix login account on the AventX host where matching
_<n>
submissions will be transferred for further processing by AventX. This login
will be used in the ftp | sftp session. For example:
cREMOTE_AXOC_LIST_LOGIN_1=xxaventx

cREMOTE_AXOC_LIST_PASS_< Defines the password for the cREMOTE_AXOC_LIST_LOGIN_<n> Unix

n>
account.. For example:
cREMOTE_AXOC_LIST_PASS_1=password

cREMOTE_AXOC_LIST_DIR_<n Defines the directory on the AventX host where matching submissions will be
>
transferred for further processing by AventX. Valid values must be absolute
paths without environment variables. For example:
cREMOTE_AXOC_LIST_DIR_1=/home/xxaventx/oa/database/VI
S/dropoff
If AventXPS is not actively running on the remote server, the files will remain in the directory in which they
were deposited, i.e., the Intelligent Routing strategy does not check to see if AventXPS is actively running on
the remote host. It simply performs the FTP/SFTP transfer.

Pre-Requisites

For a successful Intelligent Routing environment, the following pre-requisites must exist:

• All AventX hosts must be running the same version of AventX Oracle Connector (version 8.2.00 or
higher).

• All AventX hosts must be configured exactly the same with respect to AventX Oracle Connector.

• All AventX hosts must have licensed and fully functional AventX instances (consists of AventX Oracle
Connector and, for email/fax document processing, AventX UNIX)

• Ensure that any trusted relationships (SFTP) between the concurrent manager host(s) and each
AventX host are fully functional and have been tested.

• Prior to configuring this feature in AventX Oracle Connector, gather a recent list of FTP/SFTP logins
and passwords for each Intelligent Routing AventX host.

Once the pre-requisites have been satisfied, proceed with configuring AventX on each AventX host, as
described in the "Configuration" section.

Configuration

AventX can be configured or un-configured for the Intelligent Routing functionality at any time. To disable
the feature, simply comment out the cREMOTE_AXOC_LIST_PARAMETER entry in the
$FCHOME/.fcoa_cfg_CMFORMHOST file. The processing flow change will take effect immediately upon
completion of all of the configuration steps.
System Administration - Performance Tuning for High Volumes
Page 890 of 944
Proprietary to STR Software
AventX is configured via the $FCHOME/.fcoa_cfg_CMFORMHOST file called by the concurrent manager for
the Intelligent Routing functionality. Entries are made as previously described. There should be (1) block of
the previously described environment variables for each AventX host in the cluster.

AventX supports an unlimited number of Intelligent Routing AventX hosts. Matching is performed "top
down" in the $FCHOME/.fcoa_cfg_CMFORMHOST file, with the first match determining which AventX
host the submission will be transferred to (and subsequently processed by). If there is no match found,
submission will be to the AventX host specified by cREMOTE_AXOC_HOST (this is the standard, default
behavior when not using the Intelligent Routing feature).

Important Notes:

• The Intelligent Routing functionality is not supported for the cp transfer method.
• The Intelligent Routing functionality is not supported for the <View Log> functionality from the
AventX Delivery Status form.
The "modified" .fcoa_cfg_CMFORMHOST file must be propagated to the Concurrent Manager host(s) for this
feature to take effect. This is accomplished by executing option 7 (Prepare Concurrent Manager and forms
scripts) from the setup.sh Main Menu; make sure to follow all instructions for the Concurrent Manager
host(s) presented by this option.

Creation of Intelligent Routing AventX instances

As noted in the section "Pre-Requisites", each Intelligent Routing AventX host must have a licensed and
fully-functional AventX instance, which includes AventX Oracle Connector and, for processing of email/fax
documents, AventX UNIX. There is (1) method of creating the Intelligent Routing AventX instances:

Create the first AventX instance per the installation instructions for AventX UNIX and AventX Oracle
Connector. Make sure to configure the Intelligent Routing environment variables as previously described.

Copy the first AventX instance to each additional Intelligent Routing AventX host. Follow the instructions
provided in Chapter 5, "Copying AventX UNIX to Another Host", of the AventX UNIX Resource Guide. The
steps defined there will capture and copy both the AventX Oracle Connector software and the AventX UNIX
software as the AventX Oracle Connector software is installed in $FCHOME (the installation directory of
AventX UNIX).

After completing step 8 of those instructions, perform the following:

$FCHOME/oa/ins/setup.sh

At the Main Menu, select option 1. Provide the appropriate values for each prompt. In most cases, the values
will be the same as was specified for the first AventX instance.,

It is not necessary to perform steps 9 - 11 of those instructions as each AventX instance is required to match
the first AventX instance.

Maintenance

There may be times after initial configuration when you need to add, change information for, or delete an
Intelligent Routing AventX host. This must only be accomplished by manually editing the
System Administration - Performance Tuning for High Volumes
Page 891 of 944
Proprietary to STR Software
$FCHOME/.fcoa_cfg_<SID> file on one of the Intelligent Routing AventX hosts, and then propagating these
changes to all other Intelligent Routing AventX hosts and to the Concurrent Manager host(s) as previously
noted. Failure to properly update all AventX hosts may result in improper configuration for the Concurrent
Manager host(s), causing improper processing by AventX.

Troubleshooting

Troubleshooting file transfer issues consists of reviewing the Concurrent Request log to determine which of
the Intelligent Routing AventX hosts was selected and what the failure condition was. This log will also show
which AventX host received the files in the case of successful completion.

Database Pool Configuration

AventX creates a database connection pool on start to limit the total number of connections that can be
opened at any given time. The total number of connections that pool can consist of is configurable along with
other connection pool properties shown below using environment variables within
$FCHOME/.fcoa_cfg_<instance name>:

cDB_POOL_MIN_SIZE Sets the minimum connection pool size (integer

value) – defaults to 1

cDB_POOL_MAX_SIZE Sets the maximum connections allowed to be open

(integer value) – defaults to 20

cDB_POOL_WAIT_TIMEOUT The connection wait timeout specifies how long an

application request waits to obtain a connection if
there are no longer any connections avaliable in the
pool (in seconds) – defaults to 120

cDB_POOL_MAX_IDLE_TIME This timeout determines how long an available

connection remains in the connection pool before it
is removed from the pool (in seconds) – defaults to
1800

cDB_POOL_GET_CONNECTION_ATTEMPTS How many attempts to make retrieving a

connection from the pool (integer value) – defaults
to 1

cDB_POOL_MAX_CONNECTION_REUSE_COUNT This property specifies the maximum time any

connection can potentially be reused after which
the pool removes and closes a connection. Value of
0 indicates reuses as infinite. Generally, this is set to
mitigate memory leaks – Contact STR Software
before changing this default value. Integer value –
defaults to 0.

System Administration - Performance Tuning for High Volumes

Page 892 of 944
Proprietary to STR Software
If you find that AventX is running into UniversalConnectionPoolExceptions, you may consider increasing the
pool size (ex. From 20 to 30), increasing the the number of connection attempts (ex. From 1 to 3), and
increasing the wait timeout (ex. From 120 to 240).

Uninstalling the Software

For Oracle EBS version v12.1.3 and earlier, AventX provides a script to assist in removing previous versions or
instances (identified by <SID>) of AventX Oracle Connector. This can be used during upgrades or in cleaning
up no longer used Oracle instances. Of course, before performing these activities, you should ensure that you
have a reliable backup of AventX.

The remove.sh script will remove all associated tables, their data, views, synonyms, and stored procedures
for the apps (or xxaventx) database user and drop the "xxaventx" database user. The setup.sh "Delete"
option will remove all associated files and configuration from the $FCHOME installation for a given AventX
instance.

Regardless of which version you are removing, these scripts should be run by the UNIX login that owns
AventX. This login normally has all the required Oracle Applications environment variables, as well as access
to SQLPLUS. Additionally, you will need to know the SYSTEM and APPS passwords to access your Oracle
database.

Deleting an AventX Instance

This menu is only displayed if there are more than (1) AventX instance configured1. Caution should be
exercised when using this option as the results are irreversible except from the restoration from a backup.

The setup.sh script should only be run to delete an AventX instance for versions 8.2.00+. If you need to
remove an AventX instance prior to this version, it will have to be accomplished manually.

To run setup.sh, login as the user that owns AventX and execute the following statement from the UNIX
shell prompt:
$ $FCHOME/oa/ins/setup.sh

System Administration - Uninstalling the Software

Page 893 of 944
Proprietary to STR Software
Running remove.sh
To run remove.sh, first make sure the AventXPS process is not running and that there are no active
connections established as the xxaventx user. Then login as the user that owns AventX and execute the
following statement from the UNIX shell prompt:

$ $FCHOME/oa/ins/remove.sh

The following is an example of remove.sh execution (user responses are indicated in bold):

Enter complete system login: EG: system/manager@myinstance:system/manager@VIS

Enter complete apps login: EG: apps/apps@myinstance:apps/apps@VIS

Connecting as apps

Removing SAID_ATTACHMENTS from FND Tables

Dropping xxaventx user

Dropping table synonyms

Dropping other synonyms

Dropping aooc_api packages.

Removing temporary setup files...

After the script completes, you will be brought back to the UNIX shell prompt. Please note that this script
does NOT remove the directory structure for AventX. If you are removing the AventX entirely, you will need
to manually remove the oa directory and all associated files. Otherwise, if you are simply performing an
upgrade, you should leave everything intact.

File System Configuration Files

The AventX installation and configuration depends on system specific information that is contained in the
$FCHOME/.fcoa_cfg_<SID> file. The following table describes each ENV variable in that file, including the
valid (supported) values and defaults. Any environment variable added to .fcoa_cfg_<SID> should also be
exported using anexport statement in the file.

#cVARIABLE_NAME

#export cVARIABLE_NAME

The $FCHOME/.fcoa_cfg_<SID> file can be edited with any text editor. If you make changes to the values for
the ENV variables, you will need to re-run portions of the $FCHOME/oa/ins/setup.sh script (step 1) to
implement these changes in the AventX.

System Administration - File System Configuration Files

Page 894 of 944
Proprietary to STR Software
Global Constant Description / Default Value
Internal Variables The following variables are used internally by the software and
should not be modified.
DELIVERY_SYSTEM This is an internal variable and should not be modified.
cFNDREQUEST_ADDLAYOUT Specifies whether the Oracle function fnd_request.add_layout
exists. This is detected during the execution of setup.sh, and is
needed when calling the CreateQuickDocument and Submit
functions of the AventX API Connector.
If the function exists, this variable will be set to 1.
FCOA_HOME This variable should point to the installation directory of the
software, which should not be modified.
Default value is "$FCHOME/oa"
cORACLE_IMPLEMENTATION Specifies the version of Oracle on which you are installing
AventX. This value must be correctly specified before
proceeding with setup.sh.
Values are as follows:

H = 11i (11.5.10)
I = R12
J = R12.1
K=R12.2

Default value is H, 11.5.10.

cDATABASE_VERSION Specifies the version of the Oracle Database that AventX will
use when attaching documents to Oracle EBS reports for
document delivery. Values are as follows:

D = 9iR2
E = 10g
F = 11g
cORACLE_LOGIN Specifies the AventX user name and password in the Oracle
database.

This can be any value.

Default is xxaventx/xxaventx.

For Oracle EBS R12.2+ environments this MUST be changed to

reflect the Custom Top user and password that you created
prior to running setup.sh (e.g., xxaventx/xxaventx)

cFAXMGR_TABLESPACE Specifies the table space name in the Oracle database in which
to create the tables needed by AventX.
You may specify any table space desired.

System Administration - File System Configuration Files

Page 895 of 944
Proprietary to STR Software
Global Constant Description / Default Value
For Oracle versions 11.5.10 and R12, default is
APPS_TS_TX_DATA.
For Oracle version R12.2+, this parameter is not used, as the
table space was referenced during execution of the Custom
Top creation.

cFAXMGR_WORKSPACE Specifies the workspace name in the Oracle database (e.g.

TEMP).
You may specify any temporary table space desired. Default is
TEMP.
For Oracle version R12.2+, this parameter is not used, as the
temporary table space was referenced during execution of the
Custom Top creation.

cSTREAM_PRINTER This variable is used internally and should not be changed.

cGENERAL_PRINTER Name of Interactive Delivery and Stand Alone Interactive

Delivery printer defined in Oracle E-Business Suite. Oracle users
will select this printer when requesting report output.
Valid printer names are limited to 30 characters with the
characters limited to:

A-Z (upper and lower case permitted)

0-9
_ (underscore)
- (hyphen)
(space)

This value may be changed. If changed prior to installation and

configuration of AventX, this value will be stored in the
FAX_SETUP table.
If changed after installation, the FAX_SETUP table must be
manually edited to match the new value. Default value is
AventX Interactive.This variable is used internally and should
not be changed.
cAPPROVAL_PRINTER This variable is used internally and should not be changed.
cAPI_PRINTER Specifies the name of the printer used by the AventX API.
Consult “AventX Oracle Connector API Resource Guide” for
further information.
Default value is “AventX API”
cCONNECTOR_NAME Specifies the product name throughout the installation scripts.
This variable should not be modified.

System Administration - File System Configuration Files

Page 896 of 944
Proprietary to STR Software
Global Constant Description / Default Value
cREMOTE_AXOC Defines whether this host is the AventX host (“N”) or the Oracle
concurrent manager host (“Y”)
cWEBMGR_URL Defines the proper URL string, with variables, to be used from
the AventX Delivery Status form in accessing AventX UNIX via
AventX WebManager.
This string is generated during execution of setup.sh with the
proper information to connect to AventX UNIX via AventX
WebManager. It is NOT recommended that this string be
manually edited.
This value is read by setup.sh in populating the appropriate
field in the FAX_SETUP table. It is not read during use of the
AventX Delivery Status form.
cREPLACESPACE This variable is deprecated and should not be used. It will be
removed in a future version.
System Configuration The following configuration variables may be fine-tuned
manually. When possible, these values should be modified via
Step 1 of the setup.sh script.
iMAX_LOG Defines the maximum size of the submission log in bytes used
by the submit.sh script. This script is responsible for submitting
output to the delivery queue.
The default value is 500000.
cSQLPLUS Specifies the program name for SQLPLUS.
Default value is sqlplus.
cSOA_PARMDOC1 Specifies the location of the SOA parameters for Interactive
Delivery. These values are only referenced by the installation
scripts and must be changed before installation.
The default value is 4.
cSOA_PARMDOC2 Specifies the location of the SOA parameters for Interactive
Delivery. These values are only referenced by the installation
scripts and must be changed before installation.
The default value is 5.
cINTERACTIVE_FORM Specifies the value of the title to be displayed on the
Interactive Delivery form. Valid values are limited to 256
characters, but the form size restriction will support
approximately 50.
This value may be changed. If changed prior to installation and
configuration of AventX, this value will be stored in the
FAX_SETUP table.
If changed after installation, the FAX_SETUP table must be
manually edited to match the new value.
Default value is AventX Interactive Delivery.

System Administration - File System Configuration Files

Page 897 of 944
Proprietary to STR Software
Global Constant Description / Default Value
cSTATUS_FORM Specifies the value of the title to be displayed on the Delivery
Status form.
Valid values are limited to 256 characters, but the form size
restriction will support approximately 50.
This value may be changed. If changed prior to installation and
configuration of AventX, this value will be stored in the
FAX_SETUP table.
If changed after installation, the FAX_SETUP table must be
manually edited to match the new value.
Default value is AventX Delivery Status.
cCONFIG_FORM Specifies the value of the title to be displayed on the AventX
Configuration form. Valid values are limited to 256 characters,
but the form size restriction will support approximately 50.
This value may be changed. If changed prior to installation and
configuration of AventX, this value will be stored in the
FAX_SETUP table. If changed after installation, the FAX_SETUP
table must be manually edited to match the new value. Default
value is AventX Configuration.
cAYOD_FORM Specifies the value of the title to be displayed on the AventX
Document Configuration form form. Valid values are limited to
256 characters, but the form size restriction will support
approximately 50. This value may be changed. If changed prior
to installation and configuration of AventX, this value will be
stored in the FAX_SETUP table. If changed after installation,
the FAX_SETUP table must be manually edited to match the
new value. Default value is AventX Document Configuration
form.
cAWK Specifies the Unix awk command to be used during execution
of AventX scripts. Values are as supported by the Unix O/S.
For Sun systems, use "nawk". Default value is awk.
cTR Specifies the Unix tr command to be used during execution of
AventX. Values are as supported by the Unix O/S. For Sun
systems, use "/usr/xpg4/bin/tr".
Default value is tr.
cSED Specifies the Unix sed command to be used during execution of
AventX.
Values are as supported by the Unix O/S.
Default value is sed.
cREMOTE_AXOC_SUBMISSION Specifies the method used by the Oracle concurrent manager
host to transfer the report output and parameter files to the
AventX host.

System Administration - File System Configuration Files

Page 898 of 944
Proprietary to STR Software
Global Constant Description / Default Value
Valid values are:
• ftp
• sftp
• cp (used when the AventX host is the concurrent manager
host)

Default value is “ftp”.

cREMOTE_AXOC_HOST Specifies the AventX host (IP Address or DNS name). Used
when cREMOTE_AXOC_SUBMISSION is “ftp” or “sftp”.
No default value.
cREMOTE_AXOC_LOGIN Specifies the login account to be used on the AventX host when
cREMOTE_AXOC_SUBMISSION is “ftp” or “sftp”.
No default value.
cREMOTE_AXOC_PASS Specifies the password for cREMOTE_AXOC_LOGIN when
cREMOTE_AXOC_SUBMISSION is “ftp”.
No default value
cREMOTE_AXOC_DIR Specifies the directory on the AventX host where the report
output and parameter files will be placed when
cREMOTE_AXOC_SUBMISSION is “ftp” or “sftp”.
Default value is $FCHOME/oa/database/<SID>/dropoff
cREMOTE_AXOC_FULL_PATH Specifies the absolute full path directory on the AventX host
where the report output and parameter files will be placed
when cREMOTE_AXOC_SUBMISSION is “ftp” or “sftp”.
This environment variable, when used, must exist in the
$FCHOME/.fcoa_cfg_CMFORMHOST file on the concurrent
manager tier. If specified, this value will be used by AventX
instead of cREMOTE_AXOC_DIR.
In some cases, the cREMOTE_AXOC_DIR may be different than
the actual full path that is necessary for AventX to run on the
AventX host. Use this variable if cREMOTE_AXOC_DIR is NOT
the true full path on the AventX host. Note that you will still
need to use cREMOTE_AXOC_DIR regardless to ensure the FTP
is successful.
Default value is <blank>.
cREMOTE_AXOC_FAILOVER_HOST Specifies whether failover functionality is active.

Possible values are “Y” indicating that the functionality is

active, or “N” indicating that the functionality is inactive.

Default value is N.

System Administration - File System Configuration Files

Page 899 of 944
Proprietary to STR Software
Global Constant Description / Default Value
cREMOTE_AXOC_FAILOVER_HOSTNAME_<n> Specifies the IP address or DNS name of an AventX host to be
used in failover conditions, where <n> is a number indicating
the order in which this host will be used.

No default value.

cREMOTE_AXOC_FAILOVER_LOGIN_<n> Specifies the login account of the corresponding

cREMOTE_AXOC_FAILOVER_HOST_<n> entry to be used in
failover conditions.

No default value.

cREMOTE_AXOC_FAILOVER_PASS_<n> Specifies the password correspoinding to the

cREMOTE_AXOC_FAILOVER_HOST_<n> entry to be used in
failover conditions.

No default value.

cREMOTE_AXOC_FAILOVER_DIR_<n> Specifies the directory on the

cREMOTE_AXOC_FAILOVER_HOST_<n> where the report
output and parameter files will be placed in a failover
condition.

Default value is $FCHOME/oa/database/<SID>/dropoff

cREMOTE_AXOC_LIST_PARAMETER Defines which parameter from the call to fcprinto.sh is used to

determine which AventX instance should perform the
processing.
The typical fcprinto.sh call is:
<$FCHOME>/oa/fcprinto.sh "AventX Automatic"
"<$FCHOME>/oa/database/<SID>/dropoff/RGUSTIN.2971340.2
1976" "103" "RGUSTIN.2971340" "204" "1" "[LANG=PCL]"
"pop" "fcdi" "" "1"
With the parameters in order being (including the value from
the example):

“$PROFILES$.PRINTER” "AventX Automatic"

$PROFILES$.FILENAME
"FCHOME>/oa/database/<SID>/dropoff/RGUSTIN.2971340.219
76"
$PROFILES$.XXSTR_SEQNO "103"
“$PROFILES$.TITLE” "RGUSTIN.2971340"

System Administration - File System Configuration Files

Page 900 of 944
Proprietary to STR Software
Global Constant Description / Default Value
$PROFILES$.ORG_ID "204"
$PROFILES$.CONC_COPIES "1"
AventX UNIX commands "[LANG=PCL]"
AventX doctype "pop"
AventX form method "fcdi"
AventX special ""
AventX host "1"
Of course, additional parameters may be specified via the print
driver argument string. The most commonly-used parameter is
the eighth, doctype. The proper format of the entry is "{n}",
where 'n' is the number of the parameter. For example:
cREMOTE_AXOC_LIST_PARAMETER={8}
cREMOTE_AXOC_LIST_<n> Defines the values of the specified parameter which should be
matched against to route submission to the associated AventX
host. Individual values must be separated by <space>.
For example, if using doctype as the sorting parameter, the
value might be:
cREMOTE_AXOC_LIST_1="pop rfqp"
To route submission of Purchase Orders and Requests for
Quotation to the associated AventX host. There is no limit to
the number of values to be contained in the sort list.
cREMOTE_AXOC_LIST_HOST_<n> Defines the DNS name or IP Address of the AventX host where
matching submissions will be transferred for further processing
by AventX. For example:
cREMOTE_AXOC_LIST_HOST_1=vm-qa-1213.strsoftware.com
cREMOTE_AXOC_LIST_LOGIN_<n> Defines the Unix login account on the AventX host where
matching submissions will be transferred for further processing
by AventX. This login will be used in the ftp | sftp session. For
example:
cREMOTE_AXOC_LIST_LOGIN_1=xxaventx
cREMOTE_AXOC_LIST_PASS_<n> Defines the password for the
cREMOTE_AXOC_LIST_LOGIN_<n> Unix account. For example:
cREMOTE_AXOC_LIST_PASS_1=password
cREMOTE_AXOC_LIST_DIR_<n> Defines the directory on the AventX host where matching
submissions will be transferred for further processing by
AventX. Valid values must be absolute paths without
environment variables. For example:
cREMOTE_AXOC_LIST_DIR_1=/home/xxaventx/oa/database/VI
S/dropoff
cRAHOST When setting up the software for connecting directly to the
Oracle Database using the host, port and SID this value should
be set to the hostname of the Oracle database.

System Administration - File System Configuration Files

Page 901 of 944
Proprietary to STR Software
Global Constant Description / Default Value
This value will be ignored if cJAVA_CONNECTION_STRING is set.
Default value is localhost.
cRASID When setting up the software for connecting directly to the
Oracle Database using the host, port and SID this value should
be set to the SID or SQL*Net service name of the Oracle
database.
This value will be ignored if cJAVA_CONNECTION_STRING is set.
Default value is VIS.
cRAPORT When setting up the software for connecting directly to the
Oracle Database using the host, port and SID this value should
be set to the database listener port of the Oracle database.
This value will be ignored if cJAVA_CONNECTION_STRING is set.
Default value is 1521.
cJAVA_CONNECTION_STRING Specifies the complete, Oracle connect descriptor for more
complex operations with remote database attachments, such
as in RAC systems.
When specified, this value will replace the cRAHOST, cRASID,
and cRAPORT information in the java call to the remote
database.
For example:
(DESCRIPTION=
(ADDRESS_LIST=

(ADDRESS=(PROTOCOL=TCP)(HOST=rgts2.gustinlan)(PORT=152
3)
)
)
(CONNECT_DATA=(SERVICE_NAME=VIS2)
)
)
cFCLPNAME Specifies the path and name of the program used to submit
documents to the document delivery system.

The default program is automatically determined by

.fcoa_cfg_<SID>. No changes are necessary.
MULTIORG (Version 4.1.03+) Defines whether the configuration of Oracle EBS uses more
than one Organization ID value.
Valid values are:
Y – More than one Organization ID value exists.
N – Only a single Organization ID value exists, specified by
DEFAULTORG.
Default value is Y.

System Administration - File System Configuration Files

Page 902 of 944
Proprietary to STR Software
Global Constant Description / Default Value
DEFAULTORG (Version 4.1.03+) This is used only if a single organization ID value is being used in
a multi-org environment. In this case the MULTIORG value is
set to N, and the DEFAULTORG value is set to the Organization
ID value to be used.
Default value is 0.
cREPLACEESCDELIM These variables are used to replace escaped delimiters within a
parameter string that is passed into the ID form for parsing.
Oracle standard functionality dictates that if a parameter's text
contains the same delimiter as the delimiters that separate the
parameters, it will escape it with a \.
cREPLACEESCDELIM will replace those escaped characters (ex
\:) with cREPLACEESCDELIM's contents so that the parser is not
confused when it sees the potential delimiter. Additionally, the
variable cREPLACEESCESC will replace escaped \'s, as those are
also escaped by Oracle (\ = \\).
Note that these strings can be 2 characters long, should not be
the same and must not be a character that can exist in the
parameter strings.
Note: If you change either of these parameters, you also need
to run Step 5 of setup.sh.
cREPLACEESCESC See cREPLACEESCDELIM description.
cJAVA_EXECUTABLE Defines the path/filename for the java executable to be used
by the software.
The default value is "jre".
cCOPIES_TEXT When using the Interactive Delivery form the Copies field on
the Upon Completion form is used to store a special sequence
number. This “strange” number can be quite confusing to a
user, in that it appears that the number of copies is now set to
an undesirable number!
Setting this ENV to a non-blank value will change the label from
“Copies” to another six-character string (e.g. “AventX”) such
that upon returning to the Upon Completion form from an
Interactive Delivery Submission, the label will be changed to
this value.
This setting can be changed after initial installation by
executing oa/ins/update_copies.sh.
Default value is “Copies”.
cDAEMON_PORT This value defines the TCP/IP port that the back-end process
will listen for incoming control requests on. It must be a
dedicated port.

System Administration - File System Configuration Files

Page 903 of 944
Proprietary to STR Software
Global Constant Description / Default Value
This value is populated by a question in STEP1 of the setup.sh
script. If manual changes to this value are madethe back-end
process must be restarted to reflect the change.
cEAM_WOREPORTXML_FUNC Defines the package.and function that will be called by the
Work Order output concurrent program when using the Work
Order User Interface submission to generate the raw XML
Output. This function is only responsible for generating the
Work Order XML output and should not be set to the
concurrent program procedure.
Default value is "EAM_WorkOrderRep_PVT.getWoReportXML"
In some cases customers may want to customize XML output.
They may do so by writing their own function, with the same
parameters and updating this environment variable.
cEAM_WOREPORT_SUPPRESS_XML Specifies if the Work Order output concurrent program
XXSTR_Work_Order_CP should suppress the creation of XML
output. This may be useful when using a custom
cEAM_WOREPORTXML_FUNC function that generates the XML
output itself.
Default value is "N".
cORACLE_OLS_ENABLED Specifies whether or not Oracle Label Security is being used to
provide additional security to the database. If this variable is
set to "Y" we will attempt to load the appropriate user profile.
In most cases this variable should be set to "N".
Default value is "N".
cRPARAMS Specifies the flags that are passed to the sftp command during
the initial delivery of Concurrent Manager output to the AventX
host. This variable is only used for sftp delivery. In most cases it
is used to turn on extra logging for troubleshooting issues with
trust relationships between the Concurrent Manager and the
AventX host.
Default value is "-v".
Data Control Variables The following configuration variables control what type and
where destination data variables may be returned from the
Oracle database. Step 5 of setup.sh must be run after changing
these variables. Note that running Step 5 will require restarting
the back-end service.
cEMAIL_RECIPIENTS Specifies whether or not to include e-mail addresses in Oracle
pick lists when using the AventX Interactive Delivery form.
Valid values are:
Y (to include email addresses)
N (to exclude email addresses)

System Administration - File System Configuration Files

Page 904 of 944
Proprietary to STR Software
Global Constant Description / Default Value
If cEMAIL_RECIPIENTS and cFAX_RECIPIENTS are both specified
as “N”, the AventX Interactive Delivery form will display both
fax numbers and email addresses.
The document delivery system must support destinations to
email addresses if this is enabled.
Default value is Y.
cFAX_RECIPIENTS Specifies whether or not to include fax numbers in Oracle pick
lists when using the AventX Interactive Delivery form. Valid
values are:
Y (to include fax numbers)
N (to exclude fax numbers)
If cEMAIL_RECIPIENTS and cFAX_RECIPIENTS are both specified
as “N”, the AventX Interactive Delivery form will display both
fax numbers and email addresses.
The document delivery system must support destinations to fax
addresses if this is enabled.
Default value is Y.
cCR_DESTTYPE_FLEX Specifies the field in the Oracle database table
AR_CONTACT_ROLES_V that will define the default delivery
method for the Customer.

Values for this flex field are described previously in the

appropriate chapter on “Setting Up Suppliers and Customers”
for your Oracle EBS version
Default value is attribute1.
cVC_DESTTYPE_FLEX Specifies the field in the Oracle database table that will define
the default delivery method for the Vendor Contact.

Values for this flex field are described previously in the

appropriate chapter on “Setting Up Suppliers and Customers”
for your Oracle EBS version.
Default value is title.
cVS_DESTTYPE_FLEX Specifies the flex field (attribute field) in the Oracle database
table that will define the default delivery method for the
Vendor Site. During the execution of setup.sh, the user is
prompted for the name of the flex field.
For Oracle EBS versions 11.5.10 and later, the field name used
will often be supplier_notif_method, but any flex field name
can be entered here.
Values for this flex field are described previously in the
appropriate chapter on “Setting Up Suppliers and Customers”
for your Oracle EBS version

System Administration - File System Configuration Files

Page 905 of 944
Proprietary to STR Software
 Global Constant Description / Default Value
Default value is supplier_notif_method.
cVS_DESTTYPE_SECURE_FLEX Specifies the Oracle EBS flex field that will be used to define
whether email delivery will be by secure email server when the
Vendor (Site) default delivery method is “EMAIL”.
Values for this field should be “S” for secure email delivery or
blank for non-secure email delivery.
cVS_RANK_SECURE_HIGHER This value defines whether Secure Email should rank higher
than “regular” email, when cVS_SECURE_INSTALLED = Y.

If this value is changed, STEP5 of setup.sh must be run

manually.
cVC_EMAIL_FLEX Specifies the flex field in the Oracle database table that will
define the email address for the Vendor Contact.
Default value is mail_stop.
cVS_EMAIL_FLEX Specifies the flex field (attribute field) in the Oracle database
table that will define the email address for the Vendor Site.
During the execution of setup.sh, the user is prompted for the
name of the flex field.
For Oracle E-Business Suite versions 11.5.10 and later, the flex
field name used will often be email_address.
Default value is email_address.

Organization Configuration Algorithm

The AventX can be configured in many ways to handle all of the needs of your organization. This chapter will
describe the algorithm used to determine the "rules" for the default configuration that will be used for each
organization, document type, and sender. Specific examples will be provided for each rule set as well.

In order to provide flexibility for the configuration under all circumstances, AventX uses an algorithm to
determine which default configuration to use for each document submission.

The algorithm is four-part, with the rule sets being evaluated from "top to bottom" in the hierarchy until a
match is found. The first match from the rule set will determine the default configuration used in processing
the document. If no match is found, document processing will not be possible. An appropriate error
message will be provided. If using Interactive Delivery or Stand Alone Interactive Delivery, in the destination
block of the AventX Interactive Delivery/AventX Stand Alone Interactive Delivery form. If using Automatic
Delivery, in the delivery address block on the AventX Delivery Status form.

All rule sets are based on two values: the Organization (ORG_ID = OPERATING UNIT) and document type
(DOCUMENT_NAME). As noted earlier in this document, it is possible to define the default configuration for
each Organization for each document type. For sites with many organizations and document types, this may
become a tedious task. Therefore, the rule sets will also allow for all document types for a specific
System Administration - Organization Configuration Algorithm
Page 906 of 944
Proprietary to STR Software
organization to share the same default configuration, all documents of a given document type for all
organizations to share the same default configuration, and all document types for all organizations to share
the same default configuration. These four scenarios describe the four rule sets in their "top to bottom"
order.

To achieve this end, a "special" organization, "Setup Business Group" (ORG_ID=0), is used. Therefore, the
rule sets are summarized "top to bottom" as follows:

1. ORG_ID=<user's org_id> and DOCUMENT_NAME=<specific document type> 4 5

2. ORG_ID=<user's org_id> and DOCUMENT_NAME='Default' 6
3. ORG_ID='0' and DOCUMENT_NAME=<specific document type> 7
4. ORG_ID='0' and DOCUMENT_NAME='Default'8
You must use the document type 'Default' for the configuration of all non-specific document types. These
documents must also be processed using Interactive Delivery ONLY as there is no way to retrieve address
information for them.

4
There is an important “fall through” to this rule set. If there are no destinations configured at the active
ORG_ID, the recipient and acknowledgement configuration will “fall through” to each successive rule set until
a recipient is found. See Rule Set #1 – Example #2 later in this chapter.
5
There is an important “fall through” to this rule set. If there is no Secure Delivery Server configured at the
ORG_ID=<user’s org_id> (i.e. the value is <blank>), the configuration for Secure Delivery Server will “fall
through” to that specified at ORG_ID=0. See Rule Set #2 – Example #2 later in this chapter
6
Same comments as foot note 1 and 2.
7
commencing with version 6.6.01, there is an important exception to this rule set that allows the “Fax
Device Name”, “Email Device Name” and “Secure Email Device Name” parameters of the “Organization
Defaults” portion of the configuration to be specified at ORG_ID=<user’s org_id> while the “Document”
portion of the configuration is specified at ORG_ID=0. See Rule Set #3 – Example #2 later in this chapter.
8
Same as foot note 3.

System Administration - Organization Configuration Algorithm

Page 907 of 944
Proprietary to STR Software
Converting PDF to PostScript for Printing
AventX uses the pdftops utility (provided with AventX Oracle Connector as $FCHOME/oa/util/pdftops) for
conversion of PDF to PostScript before printing the document. AventX Oracle Connector also supports the
use of Adobe Acrobat Reader (for Unix). In this case, Adobe Acrobat needs to be on the path with a
reference to the path created by APPSORA.env for PDF output to be processed correctly.

Depending upon the type of output, different configuration settings may be needed for each document type
when converting PDF to PostScript format. AventX Oracle Connector includes the capability of using a
configuration file for each type of document processed using pdftops. A sample configuration file is located
under $FCHOME/oa/util/pdftops/cfg/sample_str_xpdfrc.

Specific configuration files for different document types can be created by copying str_xpdfrc to
<doctype>.cfg. For example, to create a specific configuration file for a Purchase Order Portrait document,
copy str_xpdfrc to pop.cfg. AventX Oracle Connector will automatically look for this file by the name
<doctype>.cfg, where <doctype> is derived from the print driver setup in Oracle EBS.

There are many options available for use with pdftops. However, the most applicable setting in the
configuration file is the psImageableArea setting.

Most printers are unable to print right up to the edge of the paper. If necessary, the print area for the image
can be modified by changing the psImageableArea setting. The four integers are the coordinates of the
lower-left and upper-right corners of the imageable region, specified in points (with the origin being the
lower-left corner of the paper). This defaults to the full paper size. One square inch = 72 pixels x 72 pixels.

The example below leaves a 0.5" margin on all sides of letter-size paper.

psImageableArea 36 36 576 756

If no configuration file exists for this document type, pdftops is called without specifying a configuration file.
Otherwise, pdftops is called using the <doctype>.cfg file as the configuration file.

Special Note: AventX Oracle Connector provides the capability of using any other PDF to PostScript
conversion utility (such as acroread, for example). This is specified in .fcoa_cfg_<SID> via the cPDFTOPS
variable. If using a utility other than pdftops, make sure that the utility is in the path with a reference to the
path created by APPSORA.env.

System Administration - Converting PDF to PostScript for Printing

Page 908 of 944
Proprietary to STR Software
Appendix A: Miscellaneous
Securing AventX with SSL over HTTPS
For users to run AventX ver HTTPS the following must be done to secure AventXPS, which runs as a web
server:

• Obtain an SSL certificate from a trusted certifying authority

• Create a Java keystore either by importing the trusted certificate or creating a new self-signed certificate
for testing. Note: this keystore must be named exactly “aventxps_keystore.jks” and must have a keystore
and key password of “aventx”.

Generate a Self-Signed certificate/keystore

To generate a self-signed certificate and keystore, your $PATH variable must include the bin directory of the
Java used to run AventXPS (cJAVA_EXECUTABLE as defined in $FCHOME/.fcoa_cfg_<SID>). Run the
highlighted commands on the AventX host:

$ cd $FCHOME/oa

$ keytool -genkey -alias aventxps -keyalg RSA -keysize 2048 -keystore aventxps_keystore.jks

Enter keystore password: aventx

Re-enter new password: aventx

What is your first and last name?

[Unknown]:

What is the name of your organizational unit?

[Unknown]:

What is the name of your organization?

[Unknown]:

What is the name of your City or Locality?

[Unknown]:

What is the name of your State or Province?

[Unknown]:

What is the two-letter country code for this unit?

Appendix A: Miscellaneous - Securing AventX with SSL over HTTPS
Page 909 of 944
Proprietary to STR Software
 [Unknown]:

Is CN=vm-ebs-1213-2, OU=VM-EBS-1213-2, O=STR Software, L=Richmond, ST=VA, C=US correct?

[no]: yes

Enter key password for <aventxps>

(RETURN if same as keystore password):

For keystore password, enter “aventx”.

For first and last name, this must match the host name where AventXPS is running, otherwise you may
receive a client error.

For organizational unit, enter “Production”, “Development”, etc.

For organization, enter your company name.

Enter the appropriate answers when prompted for city/locality, state/province, and country code, then type
out “yes” when prompted to verify your responses.

Finally, press return to use the same password as the keystore password, then verify the file
aventxps_keystore.jks exists in $FCHOME/oa.

Generate Certificate Signing Request and Import Signed Certificate

To use a signed certificate, your $PATH variable must include the bin directory of the Java used to run
AventXPS (cJAVA_EXECUTABLE as defined in $FCHOME/.fcoa_cfg_<SID>). Run the following commands on
the AventX host:

$ cd $FCHOME/oa
$ keytool -genkey -alias aventxps -keyalg RSA -keysize 2048 -keystore
aventxps_keystore.jks

For first and last name, this must match the host name where AventXPS is running, otherwise you may
receive a client error.

For organizational unit, enter “Production”, “Development”, etc.

For organization, enter your company name.

Enter the appropriate answers when prompted for city/locality, state/province, and country code, then type
out “yes” when prompted to verify your responses.

Finally, press return to use the same password as the keystore password, then verify the file
aventxps_keystore.jks exists in $FCHOME/oa.

Appendix A: Miscellaneous - Securing AventX with SSL over HTTPS

Page 910 of 944
Proprietary to STR Software
Create the Certificate Signing Request. This file will be used by the certificate authority to sign your
certificate.

$ keytool -certreq -keyalg RSA -alias aventxps -file aventxps.csr -keystore aventxps_keystore.jks

Send this file to the certificate authority of your choice for signing. You will be provided with signed
certificate by signing authority. You will have to import the root and any intermediate certificates:

$ keytool -import -alias root -keystore aventxps_keystore.jks -trustcacerts -file <name of the root cert>
$ keytool -import -alias intermed -keystore aventxps_keystore.jks -trustcacerts -file <name of the
intermediate cert>
$ keytool -import -alias aventxps -keystore aventxps_keystore.jks -trustcacerts <name of the certificate>

Use existing certificate with AventXPS keystore

If you already have certificate signed by certificate authority, you will need to create a keystore with existing
certificate and private key. For this, you will need a certificate file and a private key file. Place them in the
directory of your choice on the AventX host and execute following commands:
openssl pkcs12 -export -in certificate.crt -inkey private.key -certfile
certificate.crt -name "aventxps" -out keystore.p12

keytool -importkeystore -srckeystore keystore.p12 -srcstoretype pkcs12 -

destkeystore aventxps_keystore.jks -deststoretype JKS

keytool -keypasswd -alias [Alias name for private key] -keystore

aventxps_keystore.jks

keytool -storepasswd -new aventx -keystore aventxps_keystore.jks

Appendix A: Miscellaneous - Securing AventX with SSL over HTTPS

Page 911 of 944
Proprietary to STR Software
Generate Oracle Wallet and Import root certificate
To send HTTP requests from forms to AventXPS web server, Oracle Wallet is required to hold the root
certificate of the Certificate Authority the AventXPS certificate was signed by. Oracle Wallet must be on the
database tier or on the file system accessible to the oracle user (or equivalent). To do this, follow the steps
below:

• Logon to the database host.

• Generate a new wallet:
$ orapki wallet create -wallet /home/username/wallet -pwd aventx2015 -
auto_login

• Add the root certificate of your signing Certificate Authority to the wallet:
$ orapki wallet add -wallet /home/username/wallet -trusted_cert -cert <root
certificate> -pwd aventx2015

• Confirm that the certificate has been added:

orapki wallet display -wallet /home/oracle/wallet

• Set oracle.wallet.location to the path of the new wallet on the database host.

Appendix A: Miscellaneous - Securing AventX with SSL over HTTPS

Page 912 of 944
Proprietary to STR Software
Configuring AventX for SSL
To configure AventX to use SSL, log into Oracle EBS as the System Administrator Responsibility, select Install,
then AventX, then Configuration and navigate to the General Config tab, then set aventxps.use.ssl to “Yes”
(being sure to save afterward):

Appendix A: Miscellaneous - Securing AventX with SSL over HTTPS

Page 913 of 944
Proprietary to STR Software
Appendix B: Release Notes
Version 20.4.00 (December 31st, 2020)

New Features
• Added a “Combine and View” option for Archive deliveries in the Web Delivery Status page.
• Now allow users to log into the Web Client without logging into Oracle EBS.
• Now allow access to general configuration setup through the Web Client.
• Added the the ability to rename, suppress, and create new Address Book picklists for the AventX
Interactive Delivery form.

Improvements
• Added an option to make the printer timeout value configurable.
• Architecture changes in AventXPS to make it more resistant to failure and allow “continue on error”.
• Improved Web Delivery Status load times for large volumes of records.
• Added support for responsibility and application level profile values in the Web Client.
• Added the ability to offset the actual time on completion in the Mobile Work Orders app.
• Added support for tabs and spaces in the “To Name” field.
• Added option to define specific statuses to be downloaded to the Mobile Work Orders app.
• Added additional log statements that include the AventX remote host username and local Unix
username when fcprinto.sh is executed.
• Added the ability to explicitly exclude attachments based on regex pattern matching.
• Additional commands can now be defined and configured within the destination queries uniquely per
recipient.

Defects Resolved
• Fixed an issue where log statements for the REST AventX Translation Server incorrectly stated port
3195.
• Fixed an issue where AventXPS did not recognize AventX Translation Server version 20.x.xx.
• Fixed an issue where AventXPS would abort when translation conversion timed out.
• Fixed an issue where Documents with no header information would cause AventXPS to crash.
• Fixed an issue where the Web Client History did not reflect the correct totals.
• Fixed an issue with the SchemaExporter class so it now correctly handles theTimestamp SQL Type.

Appendix B: Release Notes - Version 20.4.00 (December 31st, 2020)

Page 914 of 944
Proprietary to STR Software
Version 14.4.00 (December 31st, 2019)

Improvements
• Implement a daily cleanup for orphaned PDF print files.
• Respect ARCHIVE recipient for all print destinations including Print Xpress.

Defects Resolved
• HttpUrlConnection connection without a timeout causes thread to hang indefinitely.
• Upgrading from version 13.2.00 and below causes Oracle EBS form error.
• Set SMTP timeouts as java properties in start scripts for AventXPS.
• AventXPS does not resume translation jobs when the AventX Translation Servers stops and restarts.
• AventX Local Print causes AventXPS to crash.
• AventX for Oracle EBS disables AventX Translation Server max pages configuration.
• Terms and Conditions are not being applied as expected.

Version 14.3.00 (September 30th, 2019)

AventX Oracle Connector

New Features
• Implemented SharePoint Online attachment extraction using Microsoft Graph API.

Improvement
• Documented the steps for resolving Java pop-ups asking "Block potentially unsafe components from
being run?" when using Standalone Interactive Delivery.
• Added the NTLMSMB2 method as a seeded extraction class for upgrades and fresh installs.
• Added ability to export usage information per eAM Maintenance Organization.
• Added the new command COMBINE to the Command Query functionality.

Defects Resolved
• Zip/php files incorrectly showed as success in Table of Contents even though conversion fails.
• Digital Print packages could not be installed under EBS 11i.
• Table of Contents was incorrectly counted as an extra document in the Usage Tracker.
• Corrected the schema import/export CLI syntax.
• Corrected the Oracle Doc ID referenced for R12.2x implementations.

Appendix B: Release Notes - Version 14.4.00 (December 31st, 2019)

Page 915 of 944
Proprietary to STR Software
AventX Print Xpress

Improvement
• Intelligent duplexing for print jobs using AventX Local Preview.
• Added ability to print raw output formats (i.e. XML/TXT).
• Added ability to print jobs using uncollated logic.

AventX Mobile for eAM

New Features
• Added ability to upload completed Work Packets to SharePoint Online from AventX Mobile. Please
see the SharePoint Online Integration section in the Resource Guide for more information.

Version 14.2.00 (July 12, 2019)

AventX Oracle Connector

Improvements

• Certified AventX for Oracle EBS Product Suite against OpenJDK 11.
• Certified the AventX Oracle Connector against EBS R12.2.8
• Added SUBJECT as a valid command query

Defects Resolved

• Installing AXOC under R12.2 may fail while executing Step 5 of $FCHOME/oa/ins/setup.sh.

AventX Attachment Xpress for eAM

New Features

• Added ability to submit a completed work pack as attachment to the work order header entity. See
AventX Digital Print section in the Resource Guide for more information.
• Support for SMB2-only file sharing host with the new attachment extraction NTLMSMB2 class.

Improvements

• Work Order Printing will now respect the sort order from the search result page.
• Deselect all option for Work Order Printing page will automatically select the single result if there is
only one result returned.

Appendix B: Release Notes - Version 14.2.00 (July 12, 2019)

Page 916 of 944
Proprietary to STR Software
AventX Print Xpress
Improvements

• The AventX Local Print Client will stay signed in even after the user’s session with Oracle EBS is
expired.

AventX Mobile for eAM

Defects Resolved

• AventX Mobile Work Requests crashed randomly on start up.

Version 14.1.00 (April 19, 2019)

AventX Oracle Connector

New Features

• When connecting to AventX Translation Server Version 5.1.00 or greater the REST listening port
(3195) is used by default.
• Two new profile options are now available: XXSTR_ORG_ADMIN and XXSTR_ORG_USER. These
profile options can limit Administrator and User access to documents from a specific Organization.
• A Table of Contents can be added to print before all Work Orders in a batch.
• Additional Parameters have been added for mail server setup within the AventX Configuration Form.
• Suppressing extraction of duplicate attachments based on file name and byte size is now available.
• Email submissions from Oracle PO Approval no longer require any modifications to standard
workflows.

Improvements

• When reimporting an AventX Oracle Connector configuration the BACK files in the schema are no
longer imported.
• The FAX_AXD_DATABASE value in FAX_STATUS.csv is validated against the instance name from
v$database before starting an import/export of the schema.
• The naming convention of the export file created in the export process has been changed to
export_<SID>_<host>.zip
• When a configuration file is imported a backup of the FAX_STATUS table is automatically made.

AventX Attachment Xpress for eAM

New Features

• A new attachment.continue.on.error parameter has been added to the AventX General Configuration
form. Enabling this feature will allow AventX Attachment Xpress for eAM to continue processing a job
in the event of an attachment error during extraction or conversion.

Appendix B: Release Notes - Version 14.1.00 (April 19, 2019)

Page 917 of 944
Proprietary to STR Software
 • Communications with the AventX Translation Server can use a REST listener for more reliable and
stable communication.

Defects Resolved

The following defects have been resolved:

• SharePoint Online links that contained a space in the URL were encountering errors during
processing.

AventX Print Xpress

New Features

• The AventX Print Xpress Local Print Client can be installed on Windows, Mac and Linux hosts (Linux
needs a Graphical Interface for Installation)

Improvements

• The AventX Print Xpress Local Print Client is compatible when Java 11 is installed on users’ PCs.

Version 13.4.00 (December 24th, 2018)

AventX Oracle Connector

New Features

• The new AventX Delivery Status Web Client allows users to view the status of documents without
being required to open the AventX Delivery Status form in EBS.
• AventX Oracle Connector can now dynamically insert a digital signature to a document when
processing a request.

Improvements

• To support AventX Email Tracker’s “Accept” and “Reject” functionality, “Accept” and “Reject” have
been added as available final statuses in the AventX Delivery Status form.
• The version of the AventX fcprinto script used to process a request will now appear in the Concurrent
Request log, and the version of AventXPS used for processing will appear in the AventX history log.
• When Stand-Alone Interactive Delivery is used to send a request to multiple recipients via AventX
Email Tracker, AventX Oracle Connector will now update the unique delivery status for each
recipient.

Defects Resolved

The following defects have been resolved:

Appendix B: Release Notes - Version 13.4.00 (December 24th, 2018)

Page 918 of 944
Proprietary to STR Software
 • When a request was submitted, and the Oracle username contained a space, AventXPS was not
properly executing shell-out fcpdfextract and fcpdfit.
• The transient “Process” status was persisting in the AventX Delivery Status form, for some documents
submitted through batch processing, even after all documents in the batch reached a final status.
• USERDATA1 was incorrectly included in the Command Query list of values in the AventX Document
Configuration form.
• AventX Oracle Connector was failing with a misleading error message when use.pdfa.standard was
enabled in the global AventX Configuration form (and was not disabled at the document-level) and a
non-PDF doctype was being processed.
• In certain circumstances, AventXPS would skip a print job when the designated printer was busy but
would not attempt to reprocess the job when the printer became available.
• In AventX for Oracle EBS version 13.2.00, the “lp” command was missing from the AventX request
log.
• The AventX Email Tracker transient statuses, “Delayed” and “AwtgStat,” were not populating
correctly in the AventX Delivery Status form.
• Document-specific configurations were not being applied to requests processed through Delivery
Manager and passed to the SMTP_AXOC listener.

AventX Attachment Xpress for eAM

New Features

• A new attachment.continue.on.error parameter has been added to the AventX General Configuration
form. Enabling this feature will allow AventX Attachment Xpress for eAM to continue processing a job
in the event of an attachment error during extraction or conversion.

Defects Resolved

The following defects have been resolved:

• SharePoint Online links that contained a space in the URL were encountering errors during
processing. This defect has been resolved.

Appendix B: Release Notes - Version 13.4.00 (December 24th, 2018)

Page 919 of 944
Proprietary to STR Software
Version 13.2.00 (July 9th, 2018)

AventX Oracle Connector

Improvements

• An AventX Administrator will now be able to receive an email, when the AXOC license is nearing its
expiration date, based on the address used in the “error.email.address” parameter.
• When performing a “Rename” during the setup.sh process, the original instance name will no longer
be required to have a valid TNS entry in tnsnames.ora.
• The configured error.email.address will now receive an email alert when a license key is 60 days, 30
days, and 15 or less days from its expiration date.
• After an AventX Oracle Connector instance has been cloned to another host, it will not be necessary
for the instance name to be a valid TNS entry when performing a rename with the setup.sh script.

Defects Resolved

• In previous versions, an incorrect pdftops_Linux binary was packaged with the AXOC product, causing
problems when converting PDF files to Postscript. This defect has been resolved.
• A 0-byte ACK file will no longer cause AventXPS to abort.
• The “Sender LOV” query has been reconfigured to eliminate an “ORA-01722: invalid number” error
that was occurring in certain Oracle database versions.
• An issue where ACK files were being processed out of order, ultimately causing AventXPS to abort,
has been resolved.
• An incorrect number of copies will no longer be printed when a destination query returns multiple
rows containing the same printer value.
• In very rare cases, certain databases were incorrectly executing the Sender List of Values query in the
document configuration form. This issue has been resolved.
• General bug fixes have been completed to decrease AventXPS abort instances.
• AventX was erroneously printing only one copy of a document if the Destination Query returned
multiple rows that contained the same Printer value. This defect has been resolved.
• Some batch print jobs were failing with an “ORA-20100: FND_FILE could not write to file…” error. This
issue has been fixed.
• There was a problem occurring where logging was being written to aventx_bak.log instead of
aventx.log. This has been resolved, and logging has been improved for the AventX Oracle Connector.

AventX Attachment Xpress for eAM

New Features

• AventX Attachment Xpress for eAM can now be integrated with SharePoint Online for attachment
extraction.

Appendix B: Release Notes - Version 13.2.00 (July 9th, 2018)

Page 920 of 944
Proprietary to STR Software
Improvements

• Intelligent Duplexing functionality is now configurable both globally (via the trans.use.filler)
configuration value on the Attachment Printing tab or at the printer level. This will allow Users to
override Intelligent Duplexing that has been enabled via AventX Translation Server.

Defects Resolved

• In previous versions, the Work Orders listed in the Print Work Orders self-service page were unable
to be sorted by column value. This issue has been resolved.

Appendix B: Release Notes - Version 13.2.00 (July 9th, 2018)

Page 921 of 944
Proprietary to STR Software
Version 12.3.00 (September 1, 2017)

AventX Oracle Connector

Defects Resolved

• [AXOC-1291] – Work Order Operation attachments order is incorrect for print and mobile.
• [AXOC-1387] – Usage tracker link in WebManager and forms not working properly.
• [AXOC-1393] – When Passing in a .WRI Extension, Output Defaults to PCL Instead of TXT.

AventX Attachment Xpress for eAM

New Features

• [AXOC-1122] – Provide the ability to pass up data for up to five new parameters in Work Order report
submission to AventX.

Improvements

• [AXOC-779] – Defensively code against print jobs failing with ORA-06502: PL/SQL: numeric or value
error: character string buffer too small.

Appendix B: Release Notes - Version 12.3.00 (September 1, 2017)

Page 922 of 944
Proprietary to STR Software
Version 12.2.00 (July 10th, 2017)

AventX Oracle Connector

New Features

• [AXOC-1339] - Ability to do batch printing of PDFs without Attachment Printer

• [AXOC-1336] - Keep Copy of scan file for use if AventXPS aborts during processing

Improvements

• [AXOC-1355] - Update AventXPS SharePoint upload protocol for AXTS-116

• [AXOC-1276] - Add config parameter to specify Oracle output file minimum byte size

Defects Resolved

• [AXOC-1358] - ProcessACKDaily only cleans up FAX_STATUS for some statuses

• [AXOC-1303] - Timing issue when sorting files

AventX Mobile for eAM

Defects Resolved

• [AXOC-1308] - Mobile Workflow doesn't take user end date into account
• [AXOC-1307] - Mobile Print w/ AventX Automatic goes through Mobile Workflow

Appendix B: Release Notes - Version 12.2.00 (July 10th, 2017)

Page 923 of 944
Proprietary to STR Software
Version 12.1.00 (February 8th, 2017)

AventX Oracle Connector

Improvements

• [AXOC-1222] - Increase the size of TC_NAME field in FAX_DOC_INFO and FAX_HEADER tables

Defects Resolved

• [AXOC-1283] - AventXPS orphans database cursor when querying for child recipient info
• [AXOC-1279] - 11i WOUICP does not compile
• [AXOC-900] - Doc Options Query will validate with a T&Cs file name longer than is supported

AventX Mobile for eAM

New Features

• [AXOC-1075] - Close Operations for WO

• [AXOC-1072] - Upload Queue for Offline Upload and Completion of Work Orders

Version 12.0.01 (January 1st, 2017)

AventX Oracle Connector

Defects Resolved

[AXOC-1275] - AventXPS cannot process files with ackformat 14

Appendix B: Release Notes - Version 12.1.00 (February 8th, 2017)

Page 924 of 944
Proprietary to STR Software
Version 12.0.00 (December 30th, 2016)

AventX Oracle Connector

New Feature(s)

• Provide ability to configure recipients with multiple TO, CC, and BCC email recipients
• Certify the AventX for Oracle EBS product suite against 12.2.6

Improvements

• [AXOC-974] - Suppress visible apps password when prompting for it during step 5 of setup.sh
• [AXOC-1128] - Allow AventXPS to start when forms.input.directory and/or forms.output.directory are
not accessible
• [AXOC-1228] - Failed Document if type is Secure and multiple EMAIL recipients

Defects Resolved

• [AXOC-1036] - AventXPS does not overwrite Process status with final status of jobs received via
IPP_AXOC listener
• [AXOC-1168] - Clear Printer field of FCOASBMT and FCOASAID forms when Destination changes from
"PRINT ONLY"
• [AXOC-1171] - PrepareHeader throws an exception if UID1 is more than 80 characters
• [AXOC-1172] - %s token not replaced in the HtmlGetNume
• [AXOC-1195] - Remarks text does not correctly preserve line break characters
• [AXOC-1201] - ERPLOGIN values of more than 16 characters cause ORA-12899: value too large for
column
• [AXOC-1210] - AventXPS process aborts when path for archive cannot be created
• [AXOC-1224] - DesktopDataInsert adding OutputType instead of DesktopFileType
• [AXOC-1230] - AventXPS always passes FILLERPAGE=FALSE to AXTS
• [AXOC-1233] - Awk bursting does not take place if a period is in ERP login name
• [AXOC-1252] - Query retry algorithm results in infinite loop if query is never successful.
• [AXOC-1258] - reprint.use.new.values config option not put in place on new install
• [AXOC-1264] - AventXPS let's you grab files outside of the history directory via getHistoryFile.do URL
• [AXOC-1269] - "Other" destination fields remain when destination is changed (and cannot be
removed)

AventX Attachment Xpress for eAM

New Feature(s)

• Provide the ability to specify additional work order report parameters (up to five) on user interface.

Defects Resolved

• [AXOC-1158] - RepCo controller not passing Inventory Items flag correctly

Appendix B: Release Notes - Version 12.0.00 (December 30th, 2016)

Page 925 of 944
Proprietary to STR Software
 • [AXOC-1117] - Improve functionality of Disable AventX Local Print profile at Application and
Responsibility level

AventX Print Xpress

Improvements

• [AXOC-1117] - Improve functionality of Disable AventX Local Print profile at Application and
Responsibility level
• [AXOC-1153] - Issue with AventX Print Xpress when using Tools >> Reprint feature in Oracle EBS

Appendix B: Release Notes - Version 12.0.00 (December 30th, 2016)

Page 926 of 944
Proprietary to STR Software
Version 11.7.00 (October 25th, 2016)

AventX Oracle Connector

Defects Resolved

• [AXOC-899] - Setup incorrectly asks questions about user creation in R12.2.+

• [AXOC-905] - Typo in error message for (JOBERR-50003)
• [AXOC-991] - AYOD doctypes have print.attachments incorrectly set to Yes after upgrade
• [AXOC-1059] - Typo in upgrade script during driver verification
• [AXOC-1126] - Password validation during install/upgrade can return false positive.
• [AXOC-1149] - AventXPS Process crashing when Delivery Manager / Delivery Options used for
submission
• [AXOC-1158] - RepCo controller not passing Inventory Items flag correctly
• [AXOC-1175] - Tile view shows cached images from incorrect work order in Mobile App
• [AXOC-1194] - AventX Interactive doesn't work on fresh install

AventX Print Xpress

Improvements

• [AXOC-1117] - Improve functionality of Disable AventX Local Print profile at Application and
Responsibility level
• [AXOC-1153] - Issue with AventX Print Xpress when using Tools >> Reprint feature in Oracle EBS.

AventX Mobile for eAM

Defects Resolved

• [AXOC-1175] - Tile view shows cached images from incorrect work order in Mobile App

Appendix B: Release Notes - Version 11.7.00 (October 25th, 2016)

Page 927 of 944
Proprietary to STR Software
Version 11.6.00 (September 9th, 2016)

AventX for Oracle EBS

New Feature(s)

• [AXOC-1114] - Ability to print all documents in the batch with a single call to lp.

Improvements

• [AXOC-1013] - Provide the ability to print to Direct Print and Local Print printers when using AventX
Automatic

Defects Resolved

• [AXOC-1088] - Maintenance Time config option missing from 11.2.00 -> 11.3.00 upgrade
• [AXOC-1124] - Multiple rows with same username in XXSTR_DESKTOP_SESSIONS prevents user from
logging in

Appendix B: Release Notes - Version 11.6.00 (September 9th, 2016)

Page 928 of 944
Proprietary to STR Software
Version 11.5.00 (June 13th, 2016)

AventX for Oracle EBS

New Features

▪ [AXOC-1042] - Add new tab in forms for configuring attachment extraction of external attachments
▪ [AXOC-1043] - Database changes for storing external attachment extraction configuration
▪ [AXOC-1044] - Create public interface for downloading external attachments.
▪ [AXOC-1045] - Back-end changes to support external attachment download

Appendix B: Release Notes - Version 11.5.00 (June 13th, 2016)

Page 929 of 944
Proprietary to STR Software
Version 11.4.00 (June 10th, 2016)

AventX for Oracle EBS

New Features

▪ [AXOC-948] - Record the AXOC License Event at command file submission, archive, OS print, forms
submission.
▪ [AXOC-949] - Start license server when AXPS starts.
▪ [AXOC-951] - Record the AXAXEBS license event when printing attachments but not "Enterprise Asset
Management."
▪ [AXOC-953] - Generate error email to admin if can't connect during event recording.
▪ [AXOC-954] - Detect license server port.
▪ [AXOC-955] - Run usage tracker installation during install/upgrade.
▪ [AXOC-956] - Configuration form link to license report at usage tracker URL on license keys page.
▪ [AXOC-957] - Record AXDP license event on direct print transmission.

Improvements

▪ [AXOC-354] - As an administrator, I would like the ability to dynamically name archive file names AND
dynamically name the archive folder location.
▪ [AXOC-651] - Add validation of AXTS configuration before allowing Combine into PDF when archiving.
▪ [AXOC-958] - Add archive file name field to Misc tab of FCOAXCFG.
▪ [AXOC-959] - Support AYOD Style Replacement tokens in archive path and file name.
▪ [AXOC-960] - Replace FAX_HEADER tokens in archive file path and file name.
▪ [AXOC-961] - Replace additional commands in archive path and filename.
▪ [AXOC-962] - Support java Date format token expansion in archive file path and file name.
▪ [AXOC-964] - Auto create archive directory if it doesn't exist.
▪ [AXOC-965] - Fail job if any replacement tokens don't resolve/are missing.
▪ [AXOC-966] - Remove Ignore XML check box from Misc tab.
▪ [AXOC-967] - During upgrade, convert "Ignore XML" customers to new format of just archive
destination.
▪ [AXOC-968] - Make sure XML Archive Recipient always in destination LOV.
▪ [AXOC-969] - Update back-end to archive if configured and no XML query, just don't post XML.
▪ [AXOC-980] - Rename "XML Archive Connection" to "Archiving" on Misc tab of document
configuration form.
▪ [AXOC-994] - Add LOGIN= as an additional command.
▪ [AXOC-996] - Add ERPLOGIN= as an additional command.
▪ [AXOC-998] - Use POM version for AventXPS version number.
▪ [AXOC-943] - As an administrator, I would use the archiving feature more if I didn't have to create an
archive query just to save a copy of the report file into a directory.
▪ [AXOC-1002] - Add Locale as Additional Command.
▪ [AXOC-1018] - Add DEVICE as an option for Command Query.

Appendix B: Release Notes - Version 11.4.00 (June 10th, 2016)

Page 930 of 944
Proprietary to STR Software
 ▪ [AXOC-1019] - Change AventXPS command file generation to make additional commands apply to
every recipient.
▪ [AXOC-1033] - Increase lp timeout to 10 minutes.

Defects Resolved

▪ [AXOC-993] - AYOD Doc Options Query and Additional Commands incorrectly use Configuration Org
as Replacement Token.
▪ [AXOC-995] - URGENCY additional command causes AventXPS abort.
▪ [AXOC-1001] - XXSTR_DOCUMENT_ADMIN enabled should unlock full search on Login in Delivery
Status.
▪ [AXOC-1012] - EN_US fall-through for work order custom controllers doesn't work.

AventX Attachment Xpress for eAM

New Features

▪ [AXOC-950] - Record the AXAXeAM license event based on concurrent request application.

Defects Resolved

▪ [AXOC-981] - FCOAWOPT submission does not respect Deselect All Search Results option.

AventX Print Xpress

New Features

▪ [AXOC-952] - Record the AXPX License Event when Local Print, Local Preview, Local PrintTo printer
used and posted to directory.
▪ [AXOC-975] - Record AventX Local Preview license event separately from AventX Local Print/PrintTo.

Appendix B: Release Notes - Version 11.4.00 (June 10th, 2016)

Page 931 of 944
Proprietary to STR Software
Version 11.3.00 (April 11th, 2016)

AventX for Oracle EBS

New Features

▪ [AXOC-48] - Add Quality Results as a seeded attachment query

▪ [AXOC-125] - Add [SYSTEM] as a valid token for use in $FCHOME/oa/util/notif_template files
▪ [AXOC-903] - The aventx_for_oracle_ebs wrapper script is incompatible with systemd init (support
for RHEL 7 services)

Improvements

▪ [AXOC-868] - As an Oracle EBS user, I want the ability to view documents submitted in batch by a
generic user.
▪ [AXOC-850] - As a functional user, I would like to see a better error message if the error template
does not exist
▪ [AXOC-876] - Improve description for archive.private.key.path setting
▪ [AXOC-880] - Change default error.mail.subject to include [SYSTEM] token
▪ [AXOC-883] - Provide the ability to set the URGENCY command as a supported value for Command
Queries
▪ [AXOC-884] - Improvement to Archive XML and Data file naming syntax
▪ [AXOC-891] - AventXPS call to ProcessAckDaily times out if the Oracle Database is down
▪ [AXOC-894] - Add orai18n.jar as a dependency to AventXPS to support broader set of DB character
sets
▪ [AXOC-944] - As an administrator, why do I have to log into the Oracle EBS just to use the AventX
WebManager?
▪ [AXOC-971] - Change requested to upgrade verbiage in setup.sh

Defects Resolved

▪ [AXOC-697] - Log statement for trigger file creation is incorrect

▪ [AXOC-702] - Automatically set Template to NO if null returned from Document Options Query
▪ [AXOC-738] - Typo in AventX process error message subject
▪ [AXOC-826] - Failure to create Archive Trigger file does not post error or alert via email
▪ [AXOC-834] - The version_forms.sh script is broken if $FCHOME is not defined
▪ [AXOC-842] - $FCHOME/oa/database/SID/log/serveraccess.log file grows unchecked
▪ [AXOC-862] - USERDATA2 being populated with USERDATA1 value in additional commands
▪ [AXOC-887] - Email attachment name and Deselect all attachments sharing same column in fax_setup
▪ [AXOC-897] - Compile fcdfextract/fcpdfit against new libstdc++ libraries
▪ [AXOC-973] - AventXPS does not default to user's profile printer when none is specified in custom
destination query
▪ [AXOC-907] - setup.sh errors out after failover question

Appendix B: Release Notes - Version 11.3.00 (April 11th, 2016)

Page 932 of 944
Proprietary to STR Software
AventX Attachment Xpress for eAM
New Features

▪ [AXOC-51] - Add ORDER BY clause to seeded EAM_DISCRETE_OPERATIONS query

▪ [AXOC-54] - Extend Restrict Attachment concept to Parent/Child OAF screen
▪ [AXOC-219] - Make attachment display order on Self-Service page consistent with configured order
▪ [AXOC-904] - Give the ability to translate the Work Order Controller into French Canadian

Improvements

▪ [AXOC-848] - Add default entry for Work Order Printed Page Stamp
▪ [AXOC-859] - Inconsistencies in Work Order Preview process in Forms and Self-Service
▪ [AXOC-878] - Gray out Preview Button in Work Order Print form if not licensed
▪ [AXOC-901] - After submitting a WO from OAF page don't jump to the last page of search results
▪ [AXOC-902] - Consolidate all custom controllers into a single tar file

Defects Resolved

▪ [AXOC-864] - Attachment Xpress for EAM license option skips creating rows in FAX_DOC_CONFIG
▪ [AXOC-871] - Work Order Preview Defaults tab incorrectly visible on Document Configuration form
▪ [AXOC-892] - Work Order search results incorrectly starts on the final page
▪ [AXOC-895] - XXSTR_WOREP_PUB package needs to set the proper encoding when generating XML

AventX Print Xpress

Improvements

▪ [AXOC-890] - Change AventXPS to set the Content-disposition for localPrint.jnlp

Appendix B: Release Notes - Version 11.3.00 (April 11th, 2016)

Page 933 of 944
Proprietary to STR Software
Version 11.2.00 (February 29th, 2016)

AventX for Oracle EBS

Improvements

▪ [AXOC-743] - Local Print: Run Java client minimized

▪ [AXOC-846] - Add AventX Local Polling Interval as configurable parameter on the General Config tab
▪ [AXOC-847] - Change Step 1 of setup.sh to prompt for and detect Java 8 or greater
▪ [AXOC-109] - Troubleshoot button should not be available if the status is SUCCESS or error code 0
▪ [AXOC-93] - Make Delete Button position consistent across all forms

Defects Resolved

▪ [AXOC-95] - The Value for Form Product Name does correctly reflect license key type
▪ [AXOC-104] - Upgrade does not grant execute on SYS.DBMS_OBFUSCATION_TOOLKIT
▪ [AXOC-636] - Typo in aventx.log
▪ [AXOC-700] - Order of configured attachments is reversed in final delivery
▪ [AXOC-728] - Usage example for $FCHOME/oa/aventxoc lacks option for version
▪ [AXOC-851] - Copyright date on FCOAXCFG form is incorrect
▪ [AXOC-852] - APPS password is stored in upgrade.output.audit.log

AventX Attachment Xpress for eAM

Improvements

▪ [AXOC-644] - Provide ability to have Work Order Results Table checkbox default to off or on

AventX Print Xpress

Defects Resolved

▪ [AXOC-844] - (JOBERR-50074) Direct Print error does not properly inflate %s with printer name

Appendix B: Release Notes - Version 11.2.00 (February 29th, 2016)

Page 934 of 944
Proprietary to STR Software
Version 11.1.00 (February 8th, 2016)

AventX Oracle Connector

New Features

▪ [AXOC-825] - Send old and closed POs to hard coded email address.
▪ [AXOC-787] - Add support for attachment printing via AXPX functionality.
Improvements

▪ [AXOC-604] - Provide option to control the size of aventx.log, aventx_bak.log, and control.log.
Defects Resolved

▪ [AXOC-829] - Startup of multiple connections errors out after using all system entropy.
▪ [AXOC-824] - The wrapper script for AventXPS is named incorrectly.

AventX Attachment Xpress for eAM

New Features

▪ [AXOC-18] - Provide the ability to select within the custom AventX WO print screen in forms and OAF
which attachments do and do not print and have 'Preview WO' functionality respect the selections.
▪ [AXOC-19] - Provide the ability to print 'Preview WO' work order packages from a PDF viewer (e.g. Adobe
Reader) to any printer configured to my PC.
▪ [AXOC-20] - I want batches of WOs submitted to 'Preview WO' to print to one PDF (i.e., WO#1 and WO#1
Attachments, WO#2 and WO#2 Attachments, and on and on).
▪ [AXOC-21] - Provide the ability to click the 'Preview WO' button within the AventX parent/child WO
screen. Test Greyed out License
▪ [AXOC-22] - I want a shortcut in the form of a button within Oracle eAM that kicks off
AventX_Local_Preview functionality to generate a PDF including the work order report & any associated
attachments (functionality known as 'Preview WO').
▪ [AXOC-23] - I want to see a notification within EBS when a WO fails to print preview.
▪ [AXOC-26] - Provide the ability to email 'Preview WO' output from a PDF viewer (e.g. Adobe Reader).
▪ [AXOC-27] - Provide the ability to print preview complete work order packages from eAM without having
to submit an Oracle print job/concurrent request.
▪ [AXOC-29] - I want PDF printed work order package (WO and attachments) output to automatically open
in my default PDF reader (e.g., Adobe Reader, etc.).
▪ [AXOC-30] - As a technical support analyst and STR Support engineer, Provide the ability to troubleshoot
Print Preview generated WO packages within AventX Delivery Status.
▪ [AXOC-31] - Provide the ability to select one or more WO from the custom AventX WO print screen for
print with AXPX printer options.
▪ [AXOC-32] - Provide the ability click the 'Preview WO' button within the custom AventX WO print screen
(on the Oracle WO Print Screen) in the self-service/OAF/Web interface.
▪ [AXOC-33] - As a maintenance planner Provide the ability to save 'Preview WO' output from a PDF viewer
(e.g. Adobe Reader) to my PC or to any network location configured to my PC.

Appendix B: Release Notes - Version 11.1.00 (February 8th, 2016)

Page 935 of 944
Proprietary to STR Software
▪ [AXOC-37] - Provide the ability click the 'Preview WO' button within the custom AventX WO print screen
(on the Oracle WO Print screen) in the Forms interface.
▪ [AXOC-614] - I want any error messages associated with a WO package (WO and attachments) print job
to print the selected printer.
▪ [AXOC-776] - As a product development company we are only supporting the 'Preview WO' button
functionality in Oracle EBS R12.0 and above.
▪ [AXOC-780] - Provide the ability to select 'AventX_Local_Preview' as a printer option from within eAM.
▪ [AXOC-781] - Provide the ability to select the 'AventX_Local_Print' as a printer option from within eAM.
[AXOC-782] - Provide the ability to select the 'AventX_Local_PrintTo' as a printer option from within eAM.
▪ [AXOC-785] - Provide the ability for AventX Print Xpress print functionality to support attachments for
printing from eAM.
▪ [AXOC-786] - Provide the AXPX output options part of the list of printer values in the AventX Parent/Child
WO screen.
▪ [AXOC-827] – Configuration changes for Work Order UI to support default options for preview request
Improvement

▪ [AXOC-53] - Make version font and location consistent on Interactive and Parent/Child OAF pages.
▪ [AXOC-764] - Support AXAX for eAM attachment printing via Direct Print functionality.
▪ [AXOC-830] - Move Work Order Printing custom controller logic into library.

AventX Print Xpress

New Features

▪ [AXOC-783] - AventX Print Xpress printers only accept interactive print selections (e.g., selection of WO,
and/or attachment categories) when printing is submitted from the Oracle Print WO screen in OAF or
Forms.
▪ [AXOC-828] - AYOD Form changes to include print styles for AXPX options
Improvement

▪ [AXOC-831] - Change error message for 60032 to include printxpress.disable.ip.check config option.
Defects Resolved

▪ [AXOC-821] - The hostname.override value is not being preserved for Local Print submissions.
▪ [AXOC-832] - Typo in seeded $FCHOME/oa/local_print_driver file for A4_lanscape.cfg

Appendix B: Release Notes - Version 11.1.00 (February 8th, 2016)

Page 936 of 944
Proprietary to STR Software
Version 11.0.00 (December 17th, 2015)

AventX Print Xpress

New Features

▪ New software module for the AventX for Oracle EBS product. AventX Print Xpress provides flexible
document print and onscreen viewing options to Oracle EBS users without the IT hassle of configuring
and maintaining backend UNIX OS printers and queues.

AventX Oracle Connector

New Features

▪ [AXOC-124] - Exclude $FCHOME/oa/database/SID/log/history when running setup.sh Step 2

▪ [AXOC-513] - Forms InQueue/OutQueue customization
▪ [AXOC-640] - Add "Awk Command" field AXOC DB configuration
▪ [AXOC-687] - Add support for XML/Excel bursting.
▪ [AXOC-688] - Ability to add dynamic watermarks to incoming documents
▪ [AXOC-689] - Add ability to disable print ack generation.
▪ [AXOC-690] - Create trigger file to denote archiving is complete.
▪ [AXOC-691] - Add support for legacy getnum and pager awk scripts
▪ [AXOC-758] - New Form to Support Direct Print Printers
▪ [AXOC-759] - fcprinto.sh changes to support direct print
▪ [AXOC-760] - AventXPS back-end changes to support Direct Print
▪ [AXOC-768] - Restrict Direct Print functionality to new license key option
▪ [AXOC-772] - Fork AventXPS Logic For Direct Print Functionality
▪ [AXOC-797] - Replace AventX Oracle Connector name with AventX
Improvements

▪ [AXOC-97] - Import Zip process fails if source and target systems have tables with different column orders
▪ [AXOC-599] - Import Config fails if source schema contains tables that don't exist in target schema
▪ [AXOC-652] - Incorrect sorting of work orders when printing from VIZIYA Work Align Scheduler
▪ [AXOC-709] - Add support for new Additional Commands in AXOC
▪ [AXOC-805] - Change the name of the "AventX New Document Wizard" form to "AventX Document
Configuration" form

Defects Resolved

▪ [AXOC-12] - fcpdfit core dumping on Solaris 10 64-bit

▪ [AXOC-38] - Selecting more than 1000 Work Orders causes exception
▪ [AXOC-94] - View Log functionality is broken when using a dynamic Sender Value
▪ [AXOC-96] - Auto stop and start of AventXPS does not work. $FCHOME/oa/aventx script is lacking the
chkconfig command
▪ [AXOC-99] - lp.command does not allow use of environment variable when calling a script
▪ [AXOC-102] - Typo in $FCHOME/oa/database/<SID>/log/aventx.log

Appendix B: Release Notes - Version 11.0.00 (December 17th, 2015)

Page 937 of 944
Proprietary to STR Software
▪ [AXOC-577] - Certain statuses cannot be found in Delivery Status Form
▪ [AXOC-596] - Manage documents fails with com.vaadin.server.ServiceException error when using date as
search parameter
▪ [AXOC-600] - Archive creates invalid PDF when the archive connection is FTP
▪ [AXOC-601] - Interactive Work Order Self Service print page may cache printer list
▪ [AXOC-603] - Log not written properly due to a lost file handles when renaming the file
▪ [AXOC-605] - Manage AventX Queue button should be disabled if webmgr.enabled = No
▪ [AXOC-606] - Setup Step 1 question Specify the Oracle Database Version lacks option for v12c
▪ [AXOC-642] - Incorrect html.page.start or html.page.end values cause AventXPS to crash
▪ [AXOC-643] - Certain objects for online patching compliance failing (ADZDDBCC.sql)
▪ [AXOC-646] - FCHOME not set correctly for Attachment Printer only installs on non-Linux OS
▪ [AXOC-714] - When changing Define Options By to Query blanks out destinations
▪ [AXOC-770] - Attachment Entities are listed multiple times after being deleted.
▪ [AXOC-771] - Attachment Type categories return wrong values in LOV in FCOAXCFG form.
▪ [AXOC-792] - Clicking "Print Work Orders" button from workbench controller with 0 work orders throws
NullPointerException
▪ [AXOC-814] - AventXPS aborts if header object is null.

Appendix B: Release Notes - Version 11.0.00 (December 17th, 2015)

Page 938 of 944
Proprietary to STR Software
Version 10.0.00 (Released April 14th, 2015)
This is a major release of the product, incorporating new underlying architecture of the product to address
approximately one hundred bug fixes and enhancements. Prior to upgrading an existing installation of
AventX Oracle Connector, please consult STR Software Technical Services to ensure you have the proper
information and steps for performing your upgrade.

Enhancements Delivered
• Enhancement (E3630 - High Priority) - Use actual printer name instead of PRINTJOB for destination in
AventX Delivery Status form
• Enhancement (E3607 - Normal Priority) - Deprecate forms submission methods other than FCDI,
Generic, Streamserve
• Enhancement (E3606 - Normal Priority) - Merge R12.2 procedures with R12.1 procedures using APPS
synonyms
• Enhancement (E3603 - Normal Priority) - Defaxify AventX Interactive Delivery and AventX Standalone
Interactive Delivery forms
• Enhancement (E3601 - Normal Priority) - Deprecate QueryTest.sh script
• Enhancement (E3597 - Normal Priority) - Defaxify AventX Delivery Status form
• Enhancement (E3569 - Normal Priority) - Deprecate driver string "special" parameter of printcc
• Enhancement (E3550 - Normal Priority) - Update remove-faxmgr.sh to fully remove product
• Enhancement (E3549 - Normal Priority) - Ensure upgrade path to latest version from all supported
versions
• Enhancement (E3548 - Normal Priority) - Update import/export_schema.sh scripts to account for
new tables
• Enhancement (E3541 - Normal Priority) - Ability to create queries that populate specific document
commands
• Enhancement (E3503 - Normal Priority) - Ensure URL to AventX WebManager is functional
• Enhancement (E3502 - Normal Priority) - Encode AventX WebManager URL
• Enhancement (E3476/E3450 - Normal Priority) - Ensure AventX Delivery Status form properly displays
new document states from AventX UNIX
• Enhancement (E3458 - Normal Priority) - Allow more flexibility in naming the primary attachment
when sending the document to an email address
• Enhancement (E3444/E3343 - Normal Priority) - Mime types configuration moved to a table within
the Oracle database
• Enhancement (E3421 - Normal Priority) - Ensure copyright information conforms to proper standards
• Enhancement (E3412 - Normal Priority) - Add the ability to specify an alternate location if archiving
on the same machine and the initial archive fails
• Enhancement (E3411 - Normal Priority) - Ensure the use of the proper organization id from
fnd_concurrent_requests after procedures have been called
• Enhancement (E3410 - Normal Priority) - Include latest version of pdftops
• Enhancement (E3409 - Normal Priority) - Ability to extract the last FAX_INFO tag from a document

Appendix B: Release Notes - Version 10.0.00 (Released April 14th, 2015)

Page 939 of 944
Proprietary to STR Software
• Enhancement (E3408 - Normal Priority) - Move configuration for SKIP_FIRSTPAGES and
SKIP_LASTPAGE from configuration file to AventX Connector Configuration form
• Enhancement (E3407 - Normal Priority) - Add functionality for UID4 and UID5, providing more user
fields
• Enhancement (E3406 - Normal Priority) - Add functionality for OLS (Oracle Label Security) as an
optional method when accessing tables
• Enhancement (E3404 - Normal Priority) - Increase length of all UIDs to 255 characters
• Enhancement (E3403 - Normal Priority) - Ensure special characters of %, &, and ^ are supported
• Enhancement (E3361 – Normal Priority) – After installation, ensure that Administrators change
axapi.xml to support Oracle security model for access to AventX WebManager
• Enhancement (E3351 – Normal Priority) – Automatically update dirscan.cfg during installation with
proper file extensions
• Enhancement (E3348/E2020/E960 – Normal Priority) – Make documentation accessible using Help
button on forms
• Enhancement (E3347 – Normal Priority) – Move logging from all processes to one log per request ID
• Enhancement (E3346 – Normal Priority) – Build portal redirect proxy to keep control of portal error
code request formats
• Enhancement (E3345/E990 – Normal Priority) – Provide more help for troubleshooting error
messages by linking to STR Software portal
• Enhancement (E3342/E2026 – Normal Priority) – Streamline setup.sh for fresh installation, upgrade,
or post-cloning and to run as few steps as possible
• Enhancement (E3332 – Normal Priority) – Change name of AventXDaemon
• Enhancement (E3330 – Normal Priority) – Remove Attachment Path from Organization Defaults tab
of the AventX Connector Configuration form
• Enhancement (E3324 – Normal Priority) – Use bulk insert and updates when processing
acknowledgement files
• Enhancement (E3320 – Normal Priority) – Simplify resubmission process
• Enhancement (E3319 – Normal Priority) – Deprecate orasync.sh as AventX UNIX now includes
capability to regenerate acknowledgement files
• Enhancement (E3313 – Normal Priority) – Ability to launch AventX WebManager from the AventX
Connector Configuration form
• Enhancement (E3312 – Normal Priority) – Remove dependency upon AventX UNIX for AventX
Attachment Printer customers
• Enhancement (E3310 – Normal Priority) – Rename profile options to use prefix of XX_STR
• Enhancement (E3307 – Normal Priority) – Replace boilerplate text items with non-delivery words
• Enhancement (E3297 – High Priority) – Prompt for webserver host information during installation for
view log functionality
• Enhancement (E3278/E2039 – Normal Priority) – AventXPS stop.sh script should not return back to
prompt until all related processing has terminated
• Enhancement (E3268 - Normal Priority) - Use PTITLE.THREADID to ensure unique file naming
convention
• Enhancement (E3204 – Normal Priority) – Change comments for iDEFAULT_MAXDOCS= to indicate
applies to all submissions
Appendix B: Release Notes - Version 10.0.00 (Released April 14th, 2015)
Page 940 of 944
Proprietary to STR Software
• Enhancement (E3159 – Normal Priority) – Provide a 'test' button on the Attachments tab of the
AventX Connector Configuration form to test attachment authentication and extraction classes
• Enhancement (E3158 – Normal Priority) – Ability to retrieve AventX Translation Server log files via
existing get log functionality
• Enhancement (E3124 – High Priority) – Include support for Blanket Purchase Orders in PO Approval
Item Attachment Query
• Enhancement (E3093 – Low Priority) – Ability to turn off email alerting feature
• Enhancement (E2938 - Normal Priority) - Allow custom Work Order XML creation functions to output
their own data
• Enhancement (E2676 – High Priority) – Add cPARAMS="-v" to fcoa_cfg for all new installs/upgrades
• Enhancement (E2647 – Normal Priority) – Don’t require restart of AventXDaemon if changes are
made to the configuration
• Enhancement (E2557 – Normal Priority) – Make cTYPE42_CONVERT_TOPDF="Y" by default for new
installs
• Enhancement (E2456 – Normal Priority) – Seeded database attachment queries now use “select
distinct” statement as part of SQL
• Enhancement (E2424 - Normal Priority) - Display warning message if licensing does not allow use of
List Of Values for a specific recipient/acknowledgement in the AventX Connector Configuration form
• Enhancement (E2419/E1108/E836 – Normal Priority) – Ability to specify a query to extract values for
document options
• Enhancement (E2271 – Normal Priority) – Ability to test http connection directly from the AventX
Connector Configuration form
• Enhancement (E2115/E582/E573/E500 – Normal Priority) – AventX Connector Configuration form
now includes ability to configure most product settings (formerly stored in .fcoa_cfg file)
• Enhancement (E2060 – Normal Priority) – Change wording for AventXDaemon port question in
setup.sh
• Enhancement (E2039/E1475 – Normal Priority) – Change the way AventXDaemon reconnects to the
Oracle database in the event of a broken connection or bounced database
• Enhancement (E2036 - Normal Priority) - Make AventXDaemon shutdown process more robust
• Enhancement (E2031 – Normal Priority) – Validation of Oracle database information immediately
when provided by user during setup.sh.
• Enhancement (E1242 – Normal Priority) – Clarify wording for question that prompts for table space
and work space in setup.sh
• Enhancement (E1183 – Normal Priority) – When validating a query using the AventX Add Document
form, include verbiage to indicate that the query is being executed by the AventX Oracle Connector
database user
• Enhancement (E1125/E788 – Normal Priority) – Provide transmission type of SKIP/ IGNORE/N for a
given recipient
• Enhancement (E1112 – Normal Priority) – Include the original printer name associated with the
concurrent request in FAX_STATUS table
• Enhancement (E992 – Normal Priority) – Display FILE_ID for each attachment when an attachment
query is validated via the AventX Add Document form

Appendix B: Release Notes - Version 10.0.00 (Released April 14th, 2015)

Page 941 of 944
Proprietary to STR Software
 • Enhancement (E985 – Normal Priority) – Change label from “Keep ID Records” to “Interactive
Delivery Retention Days” on AventX Connector Configuration form
• Enhancement (E961 – Normal Priority) – Restructure AventX Add Document form to use Tabs
• Enhancement (E929 – Normal Priority) – Convert use of scripts to java in product
• Enhancement (E890 – Normal Priority) – Change label from “Address” to “Email Address” for
Acknowledgement Query canvas in the AventX Add Document form
• Enhancement (E610 – Normal Priority) – Allow optional debugging for stored procedure execution
• Enhancement (E421 - Normal Priority) - Ability to handle multiple instances of Streamserve running
simultaneously (multiple InQueue/OutQueue directories)

Defects Resolved
• Problem Report (B3628 - Normal Priority) - FCOASTAT - Refresh causes ORA-00904: IFAX_ID: invalid
identifier
• Problem Report (B3627 - Normal Priority) - FCOAAYOD - Test Query button for Attachment Queries
does not work correctly for rows 2-n
• Problem Report (B3624 - Low Priority) - .fcoa_cfg file contains typo for the product name (first line of
text)
• Problem Report (B3623 - Normal Priority) - FCOAAYOD Form - Adding any new query allows
validation without entering required field of Query Name
• Problem Report (B3577 - Normal Priority) - setup_forms.sh still echoes 'apps' password to the log file
• Problem Report (B3561 - High Priority) - HTTP Attachment extraction does not respect content type
header if content-disposition is blank
• Problem Report (B3560 - Normal Priority) - Values in "Licensed For" field in FCOAAYOD form gets
cleared when Edit→Clear Record is executed
• Problem Report (B3479 - High Priority) - Attachments not found for WO Print or ID when non English
language
• Problem Report (B3436 - Normal Priority) - PDF Bursting leaves behind temporary files that should be
cleaned up automatically after processing
• Problem Report (B3413 - Normal Priority) - Additional commands included for Delivery Manager
functionality are pre-pended to the command file rather than appended
• Problem Report (B3402 - Normal Priority) - Potential for FAX_SEQNO to use a duplicate value if using
the API
• Problem Report (B3383/B3381 - Normal Priority) - Processing for Purchase Order Approval HTML-
based documents is not supported
• Problem Report (B3382 - Normal Priority) - Potential for temporary files being left behind during
processing of Purchase Order Approval documents
• Problem Report (B3371 – Normal Priority) – Insertion of default cover page data can fail in cases
where the default date format is not dd/mm/yyyy
• Problem Report (B3341/B2662 – Normal Priority) – setup.sh does not prompt for certain vendor site
flex fields depending upon version of Oracle EBS
• Problem Report (B3298 – Normal Priority) – Remove cTYPE42_CONVERT_TOPDF and cPSTOPDF
variables from configuration (no longer used)

Appendix B: Release Notes - Version 10.0.00 (Released April 14th, 2015)

Page 942 of 944
Proprietary to STR Software
• Problem Report (B3282 – High Priority) – Count in TRIGGER file is incorrect when command file fails
to be generated during processing
• Problem Report (B3279 – Normal Priority) – Communication of multibyte characters between scripts
and AXD can result in incorrect characters
• Problem Report (B3251 – Normal Priority) – version.sh does not correctly report AventXDaemon.jar
file version
• Problem Report (B3230 – Normal Priority) – fcpdfextract incorrectly logs incoming burst parameters
• Problem Report (B3225 – Low Priority) – .fcoa_cfg - incorrect information in comments regarding
iDEFAULT_MAXDOCS
• Problem Report (B3221 – Low Priority) – Values in "Licensed For" field in FCOAXCFG form gets
cleared
• Problem Report (B3108 - Normal Priority) - XML Archive Connection Options Available with No
License
• Problem Report (B3047 – Normal Priority) – Running step 1 of setup.sh still displays \n on some
operating systems
• Problem Report (B3017 – High Priority) – System/Apps passwords are echoed in setup.log when
prompted during setup.sh step 3 for upgrade.
• Problem Report (B2992 – Normal Priority) – setup_forms.sh does not indicate a problem when Step 1
is unable to modify permissions
• Problem Report (B2968 – Normal Priority) – remove-faxmgr.sh does not remove all synonyms
• Problem Report (B2882 – Normal Priority) – setup.sh script can return an error on specific file
systems
• Problem Report (B2880 – High Priority) – Step1 of setup_forms.sh displays error for *.fmx for new
installs
• Problem Report (B2762 – Normal Priority) – Terms and Conditions functionality does not include logic
to search for Office 2007+ documents (e.g., docx, xlsx, etc.)
• Problem Report (B2741 - Normal Priority) - Cannot access recipient's LOV on FCOAXCFG when AXOC
license key includes only PO Approval and XML Archive Gateway options
• Problem Report (B2727 – Normal Priority) – Setup.sh error messages contain '\n' on some operating
systems
• Problem Report (B2693 – Normal Priority) – AventX Connector Configuration form - Attempt to add a
fax or email recipient when not allowed by license key results in confusing error message
• Problem Report (B2685 – Normal Priority) – Copy Query button does not preserve all parameters
• Problem Report (B2664 - Normal Priority) - fcconclient - Printing Same Document to More than One
Printer Fails for any Printer After the First
• Problem Report (B2662 - Normal Priority) - Question for supplier site in R12.1.3 is not asked
• Problem Report (B2616 – Critical Priority) – Unable to save changes after modifying data on the
"Attachment Location" tab.
• Problem Report (B2507 – High Priority) – Submission error not trapped when configured Attachment
Query does not run
• Problem Report (B2480 – High Priority) – setup.sh allows you to enter a value for the SYSTEM=
greater than 16 characters.
• Problem Report (B2427 – Normal Priority) – Error 9999 is used for multiple errors, need to separate
Appendix B: Release Notes - Version 10.0.00 (Released April 14th, 2015)
Page 943 of 944
Proprietary to STR Software
• Problem Report (B2374 – Normal Priority) – AventX Connector Configuration form connector
disabled in license key generates "invalid SQL statement" error when attempting to select a recipient
• Problem Report (B2296 – High Priority) – XML Publisher Incorrectly detected during setup.sh
fcstep2.sql script for 11i10
• Problem Report (B2284 – Normal Priority) – AventX Connector Configuration form - AYOD Sender
Query Description is not displayed in pick list for sender on Miscellaneous tab
• Problem Report (B2283 – High Priority) – Setup should not ask for AventXDaemon port on installs of
systems 2-N
• Problem Report (B2281 – Normal Priority) – AventX Connector Configuration form - Attachments tab
- Web Page Attachment Options - can’t update values on the form under a certain scenario.
• Problem Report (B2193 – Normal Priority) – AventX Interactive Delivery Form - Printer field
misaligned with the rest of the fields
• Problem Report (B2094 – Normal Priority) – $FCHOME/oa/util/fcconclient/cfg/mime.types is
overwritten during upgrade
• Problem Report (B2005 – Normal Priority) – setup.sh incorrectly thinks the password is valid if sqlplus
cannot connect to the $TWO_TASK
• Problem Report (B1835 – Normal Priority) – AventX Connector Configuration form - Print
Attachments License Option ONLY Causes Error when adding a recipient
• Problem Report (B1783 – Normal Priority) – upgrade_db.sh (upgrade script) still references .fcoa_cfg
in export step instead of .fcoa_cfg_<SID>

- Version 10.0.00 (Released April 14th, 2015)

Page 944 of 944
Proprietary to STR Software