### Example URL for Validating Standard File Manager Installation

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_6.htm

This is an example URL to validate a standard Agile File Manager installation. Accessing this URL in a web browser should display the File Manager Configuration page, which tests connections to the File Manager and Application Server. A 'Success' status for all connections confirms a successful installation.

```URL
http://filevault.mycompany.com:8080/Filemgr/Configuration
```

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

### Example URL for Launching Agile Java Client

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_7.htm

An illustrative example of the URL used to launch the Agile Java Client, demonstrating a typical hostname, domain, and the default path for the Java Web Start application. This helps users understand the structure of the required URL for their specific environment.

```URL
http://plmserver.mycompany.com/JavaClient/start.html
```

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

### Configuring Oracle Environment Variables in .profile (UNIX Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_5.htm

This snippet provides example environment variables to be set in the Oracle user's `.profile` file. It configures `PATH`, `ORACLE_HOME`, `SHLIB_PATH`, `ORACLE_BASE`, `ORACLE_SID`, and `NLS_LANG` to ensure proper functioning of Oracle database commands and Agile database utilities. Users must adjust these example paths and values to match their specific installation.

```Shell
PATH=$PATH:/usr/local/bin:/usr/ccs/bin:/usr/openwin/bin:/usr/bin/X11
export PATH
ORACLE_HOME=/u01/app/oracle/product/11.1.0/db_1;export ORACLE_HOME
SHLIB_PATH=$ORACLE_HOME/lib
export SHLIB_PATH
ORACLE_BASE=/u01/app/oracle;export ORACLE_BASE
PATH=$PATH:$ORACLE_HOME/bin;export PATH
ORACLE_SID=agile9;export ORACLE_SID
NLS_LANG=AMERICAN_AMERICA.AL32UTF8;export NLS_LANG
```

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

### Agile Install Directory Example - Unix Path

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/tools/html_agaan/output/chapter_2.htm

This snippet shows an example of the default installation directory for the ACP utility on a Unix-like system. The <version> placeholder indicates where the specific Agile PLM version (e.g., '936') would be inserted.

```Unix Path
/opt/agile/acp<version>
```

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

### Example URL for Validating File Manager with Web Proxy

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_6.htm

This example URL demonstrates how to validate an Agile File Manager installation when a Web proxy server is in use. The URL points to the proxy server's hostname and port. Accessing this URL should display the File Manager Configuration page, allowing verification of connections through the proxy.

```URL
http://webproxy.mycompany.com:80/Filemgr/Configuration
```

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

### Agile Install Directory Example - Windows Path

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/tools/html_agaan/output/chapter_2.htm

This snippet shows an example of the default installation directory for the ACP utility on a Windows system. The <version> placeholder indicates where the specific Agile PLM version (e.g., '936') would be inserted.

```Windows Path
D:\Agile\ACP<version>
```

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

### Generic URL for Launching Agile Java Client

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_7.htm

This is the standard URL pattern used to launch the Agile Java Client via Java Web Start. Users access this URL in a web browser to initiate the download and installation of the client application, requiring specific hostname, domain, and port details of the Agile PLM server.

```URL
http://<hostname>.<domain>:<port>/JavaClient/start.html
```

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

### Running Web Service Client from Command Line

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaaq/output/appendix_d.htm

These command-line examples illustrate how to invoke the 'MyFirstClient' web service client. The first command prints usage information, while the subsequent commands demonstrate querying a specific attribute ('TitleBlock.Description') of an item ('1000-02') using various parameters like host, port, and authentication credentials.

```Shell
>runner client.MyFirstClient

>runner client.MyFirstClient -T 15000 -a "attribute_name"
-e virtual_path -h host -l port_no. -n item_number -p password -u username 

>runner client.MyFirstClient -T 15000 -a "TitleBlock.Description"                -e Agile -h  -l 80 -n 1000-02 -p agile -u jeffp
```

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

### Executing Oracle Database Installation Script (Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_5.htm

This command executes the `agile9database.sh` script from the current directory. This script initiates the Oracle database instance creation process, prompting the user for installation mode, Oracle SID, schema name, and various passwords.

```Shell
$ ./agile9database.sh
```

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

### Starting Agile PLM Managed Server - Batch

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_5.htm

This script starts a specific Agile PLM managed server instance. It should be executed from the AGILE_HOME\agileDomain\bin folder on the machine where the managed server is installed. For multiple managed servers on one machine, scripts are numbered (e.g., startAgileManagedServer1, startAgileManagedServer2).

```Batch
startAgileManagedServer1
```

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

### Running ACP Installation Script on Windows

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/tools/html_agaan/output/chapter_6.htm

Execute the specific installation script 'install_win' to begin the ACP installation process on Windows systems. A splash screen will indicate the installer's progress.

```Batch
install_win
```

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

### Generic URL for Validating File Manager Installation

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_6.htm

This generic URL template is used to verify the successful installation of the Agile File Manager. Replace placeholders like `<fileserver_home>`, `<port>`, and `<fileserver_virtual_path>` (default `Filemgr`) with your specific server details. Accessing this URL should display the File Manager Configuration page, indicating connection status and confirming installation.

```URL
http://<fileserver_home>:<port>/<fileserver_virtual_path>/Configuration
```

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

### Starting Node Manager (Batch)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/administration/html_agaah/output/appendix_a.htm

This command starts the Node Manager, which is a WebLogic Server utility used to start, stop, and monitor server instances. It must be run from the `$OHS_HOME\user_projects\domains\base_domain\bin` directory.

```Batch
startNodeManager.cmd
```

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

### Starting Agile PLM Server on UNIX Command Line

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_4.htm

This script starts the Agile PLM Application Server from the UNIX command line. Upon successful execution, a message 'Agile PLM Server Starting Up' will appear in the command window or application server log file.

```Shell
startAgile.sh
```

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

### Verifying Apache Ant Installation on Windows

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaat/output/chapter_2.htm

This command is used to verify the successful installation of Apache Ant on a Windows system. It executes the 'ant' command from the 'bin' directory within the 'ANT_HOME' environment variable and displays the installed Ant version.

```Shell
%ANT_HOME%\bin\ant -version
```

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

### Running Oracle Fusion Middleware Infrastructure Installer

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_4.htm

This command executes the Oracle Fusion Middleware Infrastructure installer, which is provided as a JAR file. It requires the JAVA_HOME environment variable to be set to the location of a compatible JDK installation. The command initiates the graphical installer for Oracle Fusion Middleware Infrastructure 12.2.1.1.

```Shell
%JAVA_HOME\bin\java -jar fmw_12.2.1.1.0_instrastructure.jar
```

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

### Configuring Ant for JAX-WS Client Generation

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This Ant build configuration defines the classpath for WebLogic web service client JARs and registers the `ClientGenTask`. It includes a target `wsdl2java-Generate-Client` that uses `clientgen` to generate JAX-WS client-side stubs from a WSDL URL, saving them to the `./src` directory.

```XML
<path id="build.classpath">
  <fileset dir="${wlslib.dir}">
    <include name="\*\*/ com.oracle.webservices.wls.jaxws-wlswss-client.jar" />
  </fileset>
</path>
 
<taskdef name="clientgen" classname="weblogic.wsee.tools.anttasks.ClientGenTask" classpathref=" build.classpath"/>
<target name="wsdl2java-Generate-Client">
  <echo message="Generating all the client side stubs"/>
    
       <clientgen wsdl="http://<host>:<port>/core/services/<serviceName>?wsdl" destDir="./src" type="JAXWS" fork="true"/>
</target>
```

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

### Installing 32-bit libXp Library

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agabp/output/prerequisites.htm

This command installs the 32-bit libXp library (libXp.i686), which provides X Print Extension client library. It is a required dependency for AutoVue on 64-bit Linux systems, supporting printing functionalities.

```Linux Shell
yum install libXp.i686
```

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

### Verifying Apache Ant Installation on UNIX

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaat/output/chapter_2.htm

This command verifies the successful installation of Apache Ant on a UNIX-like system. It executes the 'ant' command located in the 'bin' directory relative to the 'ANT_HOME' environment variable, confirming the installed Ant version.

```Shell
$ANT_HOME/bin/ant -version
```

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

### Initializing Agile Business Object Web Service Client Stubs

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This Java code snippet demonstrates how to initialize a JAX-WS client stub for the Agile Business Object Web Service. It sets the server URL, username, and password, then obtains the `BusinessObjectPortType` stub and configures the request context with authentication credentials for secure communication.

```Java
String SERVER_URL = "http://<host>:<port>/core/services/BusinessObject";
String USERNAME = "admin";
String PASSWORD = "agile";
BusinessObjectService locator = new BusinessObjectService(new java.net.URL(SERVER_URL));
BusinessObjectPortType businessObjectStub = (BusinessObjectPortType)locator.getBusinessObject();
Map<String, Object> reqContext = ((javax.xml.ws.BindingProvider)businessObjectStub).getRequestContext();
reqContext.put(BindingProvider.USERNAME_PROPERTY, USERNAME);
reqContext.put(BindingProvider.PASSWORD_PROPERTY, PASSWORD);
```

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

### Verifying Ant Installation on Windows

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaaq/output/chapter_2.htm

This command verifies that Apache Ant is correctly installed and accessible from the command prompt on a Windows system. It checks if the ANT_HOME environment variable is set and if the Ant executable is in the PATH, displaying the installed Ant version.

```Batch
%ANT_HOME%\bin\ant -version
```

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

### Example Command for Full Oracle Database Export - Windows

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_7.htm

This example 'exp' command performs a full Oracle database export on Windows, logging in as 'system/manager'. It specifies the output dump file and log file paths within the 'D:\Agile9Tmp' directory, using triple quotes for paths containing backslashes. Ensure all system users are logged off before execution.

```Batch
exp system/manager full=y file="""d:\\Agile9Tmp\\expfull.dmp""" log="""d:\\Agile9Tmp\\expfull.log"""
```

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

### Example Command for Full Oracle Database Export - UNIX

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_7.htm

This example 'exp' command performs a full Oracle database export on UNIX, logging in as 'system/manager'. It specifies the output dump file and log file paths within the '/home/oracle/agile9350db' directory. Ensure all system users are logged off before execution.

```Shell
exp system/manager full=y file=/home/oracle/agile9350db/expfull.dmp log=/home/oracle/agile9350db/expfull.log
```

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

### Running MyFirstClient with Placeholder Arguments (Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaaq/output/chapter_2.htm

This command demonstrates the full set of command-line arguments available for `MyFirstClient`, using placeholder values. It illustrates how to specify transaction type, attribute name, virtual path, host, port, item number, password, and username for a Web service request.

```Shell
runner client.MyFirstClient -T 15000 -a "attribute_name" \
-e virtual_path -h host -l port_no. -n item_number -p password -u username
```

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

### Example: Get Specific File from File Folder Version - HTTP URL

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/user/html_agaae/output/chapter_10.htm

This example demonstrates retrieving the abc.txt file from version 1 of Folder0001 using a file folder Smart URL. The default action is GET, meaning the file will be downloaded in its native format.

```HTTP URL
http://myappserver/mycompany/viewer/FileFolder/Folder0001/files/abc.txt/1
```

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

### Enabling Specific Warnings While Disabling Others in Agile Web Services (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This Java example illustrates how to enable a specific set of warnings while disabling all others. It first calls setDisableAllWarnings() and then uses setWarningResolution() with ENABLE for the desired warning ID (e.g., 182). This provides a flexible way to manage warning visibility, allowing only critical warnings to be reported.

```Java
approveRObjectRequestType.setDisableAllWarnings(); AgileWarningResolutionType warningRes[] = new AgileWarningResolutionType[1]; warningRes[0] = new AgileWarningResolutionType();warningRes[0].setId(182); warningRes[0].setResolution(AgileWarningResolutionConstantsType.ENABLE); approveRObjectRequestType.setWarningResolution(warningRes);
```

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

### Example: Get All Files from Item Folder

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/user/html_agaae/output/chapter_10.htm

This example demonstrates a Smart URL to retrieve all files from 'Folder001' attached to the latest released revision of 'DOC0001'. The files are returned as a zipped file named 'Download.zip' because the URL points to a collection of files within a folder, and no specific file action is specified (defaulting to GET).

```URL
http://myappserver/mycompany/viewer/Document/DOC0001/files/Folder/Folder001
```

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

### Installing 32-bit libXt Library

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agabp/output/prerequisites.htm

This command installs the 32-bit libXt library (libXt.i686), which provides X Toolkit Intrinsics. It is a required dependency for AutoVue on 64-bit Linux systems, facilitating GUI interactions.

```Linux Shell
yum install libXt.i686
```

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

### Copying Agile Profile Template (UNIX Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_5.htm

This command copies the `profile.txt` template, provided with the Agile database utilities, to the user's `.profile` file. This action sets up the initial Oracle environment variables required for the Agile database installation. This step is typically performed when configuring the host computer as a database server for the first time.

```Shell
$ cat agile9350db/profile.txt > .profile
```

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

### Installing 32-bit Bzip2 Libraries

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agabp/output/prerequisites.htm

This command installs the 32-bit Bzip2 compression libraries (bzip2-libs.i686), a necessary prerequisite for AutoVue on 64-bit Linux machines, supporting various compression and decompression operations.

```Linux Shell
yum install bzip2-libs.i686
```

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

### Extracting Agile Database Utilities (UNIX Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_5.htm

These commands navigate to the 'agile9350db' directory and then extract the contents of the 'agile9360db.tar.gz' archive. The `gunzip -c` command decompresses the gzipped tarball to standard output, which is then piped to `tar xvf -` to extract the files. This step makes the Agile database utilities available for installation.

```Shell
$ cd /home/oracle/agile9350db
$ gunzip -c agile9360db.tar.gz|tar xvf -
```

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

### Installing 32-bit Zlib Library

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agabp/output/prerequisites.htm

This command installs the 32-bit Zlib compression library (zlib.i686), which is a required dependency for AutoVue on 64-bit Linux systems, providing necessary data compression functionalities.

```Linux Shell
yum install zlib.i686
```

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

### Verifying Ant Installation on Solaris/Linux

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaaq/output/chapter_2.htm

This command verifies that Apache Ant is correctly installed and accessible from the command line on a Solaris or Linux system. It checks if the ANT_HOME environment variable is set and if the Ant executable is in the PATH, displaying the installed Ant version.

```Shell
$ANT_HOME/bin/ant -version
```

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

### Building MyFirstWebService Sample on Windows

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaaq/output/chapter_2.htm

This command invokes Apache Ant from the command prompt on Windows to build the MyFirstWebService sample. It executes the default target defined in the build.xml file located in the current directory, compiling Java code and generating necessary client files.

```Batch
%ANT_HOME%/bin/ant
```

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

### Accessing First Item Attachment via Attachments Table in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_14.htm

This example illustrates the process of retrieving an Agile PLM item by its number, accessing its Attachments table, and then obtaining the content of the first attachment found. It demonstrates the use of IAgileSession to get an object, IDataObject.getAttachments() to get the table, and ITable.getTableIterator() to navigate rows, finally casting to IAttachmentFile to get the file content. Error handling for missing files is also included.

```Java
try {// Get Item P1000
   Map params = new HashMap();
   params.put(ItemConstants.ATT_TITLE_BLOCK_NUMBER, "P1000");
   IItem item =
      (IItem)m_session.getObject(IItem.OBJECT_TYPE, params);// Get the attachment table for file attachments
   ITable attTable = item.getAttachments();// Get a table iterator
   ITwoWayIterator it = attTable.getTableIterator();// Get the first attachment in the table
   if (it.hasNext()) {
      IRow row = (IRow)it.next();// Read the contents of the stream
   InputSteam stream = ((IAttachmentFile)row).getFile();
   }
   else {
      JOptionPane.showMessageDialog(null, "There are no files listed.",
         "Error", JOptionPane.ERROR_MESSAGE);
   }} catch (APIException ex) {
      System.out.println(ex);
}
```

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

### Getting and Setting SingleList Cell Values in Agile PLM (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_5.htm

This example demonstrates how to retrieve and update the value of a SingleList cell, specifically the 'Part Category' for an item, using the Agile PLM API. It shows how to get the current selection from an IAgileList object and how to set a new selection by providing an array of objects.

```Java
private static String getPartCatValue(IItem item) throws APIException {
// Get the Part Category cell   ICell cell = item.getCell(ItemConstants.ATT_TITLE_BLOCK_PART_CATEGORY);

// Get the current IAgileList object for Part Category   IAgileList cl = (IAgileList)cell.getValue();

// Get the current value from the list   String value = null;   IAgileList[] selected = cl.getSelection();   if (selected != null && selected.length > 0) {      value = (selected[0].getValue()).toString();   }      return value;   }

private static void setPartCatValue(IItem item) throws APIException {
// Get the Part Category cell   ICell cell = item.getCell(ItemConstants.ATT_TITLE_BLOCK_PART_CATEGORY);

// Get available list values for Part Category   IAgileList values = cell.getAvailableValues();

// Set the value to Electrical   values.setSelection(new Object[] { "Electrical" });   cell.setValue(values);}
```

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

### Getting Agile PLM Cell Value by Attribute ID in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_5.htm

This example shows how to retrieve a cell's value from an Agile PLM 'item' object using its attribute ID constant. It attempts to get the value and includes basic error handling to catch an APIException if the operation fails, printing the exception to the console.

```Java
Object v;try {  v = item.getValue(attrID);} catch (APIException ex) {  System.out.println(ex);}
```

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

### Building MyFirstWebService Sample on Solaris/Linux

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaaq/output/chapter_2.htm

This command invokes Apache Ant from the command line on Solaris or Linux to build the MyFirstWebService sample. It executes the default target defined in the build.xml file located in the current directory, compiling Java code and generating necessary client files.

```Shell
$ANT_HOME/bin/ant
```

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

### Matching 'P00' followed by '20' with optional characters

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/user/html_agaau/output/chapter_9.htm

This regular expression matches strings that start with 'P00', followed by zero or more of any character, and then end with '20'. Examples include P020, P0020.

```Regular Expression
P00*20
```

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

### Querying with SQL-like Syntax - Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_3.htm

This snippet demonstrates the use of SQL-like syntax for constructing a query in the Agile API. It combines the selection of attributes, the target class, and the search condition directly within the query creation, offering improved readability for SQL-familiar users.

```Java
try {
IQuery query = (IQuery)m_session.createObject(IQuery.OBJECT_TYPE,"SELECT " +"[Title Block.Number],[Title Block.Description], " +"[Title Block.Lifecycle Phase] " +"FROM " +"[Items] " +"WHERE " +"Page Two.Numeric01 between (1000, 2000)");
//Run the query
ITable results = query.execute();
} catch (APIException ex) {
System.out.println(ex);
}
```

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

### Getting Subclasses of a Specific Class in Agile PLM (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_3.htm

This example demonstrates how to use the getSubClasses operation to retrieve all subclasses of a particular class, such as 'Changes', by specifying its class identifier. The response will contain ClassType objects representing the subclasses.

```Java
GetSubClassesRequestType getSubClassesRequestType = new GetSubClassesRequestType();
agileGetSubClassesRequestType[0].setClassIdentifier("Changes");
```

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

### Getting an Item (Part) in Agile PLM - Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_3.htm

This example illustrates how to use the `getObject` operation to retrieve a specific 'Part' object from Agile PLM. It sets the `classIdentifier` to 'Part' and the `objectNumber` to 'P00001', demonstrating a concrete use case for fetching an item.

```Java
GetObjectRequestType getObjectRequestType = new GetObjectRequestType();
AgileGetObjectRequest agileGetObjectRequest[] = new AgileGetObjectRequest[1];
agileGetObjectRequest[0] = new AgileGetObjectRequest();
agileGetObjectRequest[0].setClassIdentifier("Part");
agileGetObjectRequest[0].setObjectNumber("P00001");
```

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

### Querying with Standard Agile API Syntax - Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_3.htm

This example illustrates how to construct a query using the standard Agile API query syntax. It sets criteria for a numeric range and specifies the result attributes before executing the query.

```Java
try {
IQuery query = (IQuery)m_session.createObject(IQuery.OBJECT_TYPE, "Items");
query.setCriteria("[Page Two.Nummeric01] between (1000, 2000)");
//Set result attributes
String[] attrs = { "Title Block.Number", "Title Block.Description" };
query.setResultAttributes(attrs);
//Run the query
ITable results = query.execute();
} catch (APIException ex) {
System.out.println(ex);
}
```

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

### Getting All Attachments of an Object - Agile PLM Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_6.htm

This example illustrates how to retrieve all file attachments associated with a specific Agile PLM object. It configures the request to fetch all files by setting the 'setAllFiles' property to 'true' for the given class identifier and object number.

```Java
agileGetFileAttachmentRequest[0].setClassIdentifier("Part");
agileGetFileAttachmentRequest[0].setObjectNumber(partNumber);
agileGetFileAttachmentRequest[0].setAllFiles(true);
AgileFileAttachmentRequestType attachments[] = new AgileFileAttachmentRequestType[1];
attachments[0] = new AgileFileAttachmentRequestType();
agileGetFileAttachmentRequest[0].setAttachments(attachments);
GetFileAttachmentRequestType.setRequests(agileGetFileAttachmentRequest);
```

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

### Executing Agile Database Configuration Script on UNIX

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_7.htm

These commands first grant execute permissions to the `agile9database.sh` script and then run it. The script prompts the user to choose a database size (D, S, M, L, X) and generates necessary SQL and Bourne shell scripts for schema creation in the specified directory.

```Shell Script
$ chmod u+x agile9database.sh
$ ./agile9database.sh
```

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

### Getting AutoNumbers for Part and ECO Classes in Agile PLM (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_3.htm

This example illustrates how to request auto-generated numbers for 'Part' and 'ECO' classes using the getAutoNumbers operation. It specifies the auto-number source for 'Part' and requests all sources for 'ECO', along with the desired number of sequences.

```Java
GetAutoNumbersRequestType getAutoNumbersRequestType = new GetAutoNumbersRequestType();
AgileGetAutoNumbersRequestType agileGetAutoNumbersRequestType[] = new AgileGetAutoNumbersRequestType[2];
agileGetAutoNumbersRequestType[0].setClassIdentifier("Part");
agileGetAutoNumbersRequestType[0].setAutoNumberIdentifier( new String[]{"PartNumber"} );
agileGetAutoNumbersRequestType[0].setSize(3);
agileGetAutoNumbersRequestType[1].setClassIdentifier("ECO");
agileGetAutoNumbersRequestType[1].setIncludeAllAutoNumberSource(true);
agileGetAutoNumbersRequestType[1].setSize(2);

getAutoNumbersRequestType.setRequests(agileGetAutoNumbersRequestType);
AgileGetSubClassesRequestType agileGetSubClassesRequestType[] = new AgileGetSubClassesRequestType[1];
```

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

### Executing All Java Samples Sequentially via Batch File

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/appendix_d.htm

When no arguments are passed to 'run.bat', this command executes all available Java samples sequentially. This is useful for comprehensive testing or initial setup verification, relying on the 'custom.properties' file for server details.

```Batch
run
```

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

### Getting a Change (ECO) in Agile PLM - Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_3.htm

This snippet provides an example of retrieving a 'Change' object, specifically an 'ECO' (Engineering Change Order), using the `getObject` operation. It configures the request with 'ECO' as the `classIdentifier` and 'ECO-0001' as the `objectNumber` to fetch a particular change order.

```Java
GetObjectRequestType getObjectRequestType = new GetObjectRequestType();
AgileGetObjectRequest agileGetObjectRequest[] = new AgileGetObjectRequest[1];
agileGetObjectRequest[0] = new AgileGetObjectRequest();
agileGetObjectRequest[0].setClassIdentifier("ECO");
agileGetObjectRequest[0].setObjectNumber("ECO-0001");
```

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

### Setting JAVA_HOME for ACP Installer (Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/tools/html_agaan/output/chapter_6.htm

Before running the ACP Installer, the JAVA_HOME environment variable must be set to the directory where Java JRE is installed. This is a prerequisite for the installer to function correctly.

```Shell
JAVA_HOME=<Java JRE Directory>
```

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

### Importing Agile Database on UNIX (Traditional)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_7.htm

These commands first grant execute permissions and then run the `agile9imp.sh` script for traditional database imports on UNIX. This script imports the database and recreates indexes and statistics. Ensure import parameters in `agile9imp.par` are checked.

```Shell Script
$ chmod u+x agile9imp.sh
$ ./agile9imp.sh
```

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

### Importing Agile Database on Windows (Traditional)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_7.htm

This batch file initiates the traditional import of the Agile database on Windows, including the recreation of indexes and statistics. Before running, ensure that the import parameters in `agile9imp.par` are correctly configured.

```Batch
agile9imp.bat
```

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

### Setting JAVA_HOME for ACP Installer on Windows

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/tools/html_agaan/output/chapter_6.htm

Before running the ACP Installer on Windows, the JAVA_HOME environment variable must be set to the installation directory of the Java JRE. This is a prerequisite for the installer to function correctly.

```Batch
SET JAVA_HOME=<Java JRE Directory>
```

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

### Starting Agile File Manager on UNIX

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_6.htm

This command is used in a UNIX terminal to initiate the Agile File Manager service. It should be executed from the `AGILE_HOME/FileManager/bin` directory. Successful execution starts the Apache Tomcat AgileFM service, enabling file management capabilities.

```Shell
./startup.sh
```

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

### Disabling All Warnings in Agile Web Services (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This concise Java snippet demonstrates how to disable all warnings for an Agile Web Service request. By calling setDisableAllWarnings() on the request object, the client can prevent any warnings from being returned in the response. This is useful when a blanket suppression of warnings is desired.

```Java
approveRObjectRequestType.setDisableAllWarnings();
```

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

### Unmarshalling XML Element to Java Object using JAXB

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This method converts an XML Element object back into an AgileListEntryType Java object using JAXB. It creates a JAXBContext and Unmarshaller to perform the conversion, extracting the value from the JAXBElement to return the desired Java object.

```Java
// Sample method to unmarshall a XML Element object into an 
// AgileListEntryType object 
public static Object unmarshal(Element element) {
    try {
        JAXBContext jc = JAXBContext.newInstance(AgileListEntryType.class);
        Unmarshaller unmarshaller = jc.createUnmarshaller();
        Object obj = unmarshaller.unmarshal(element);
        JAXBElement<?> jaxbEle = (JAXBElement<?>) obj;
        return jaxbEle.getValue();
    }catch (Exception e) {
        e.printStackTrace();
        return null;
    }
}
```

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

### Configuring JNLP Codebase in pcclient.jnlp

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaaw/output/chapter_7.htm

This XML tag within the `pcclient.jnlp` file defines the base URL from which the Java Web Start application downloads its resources. It must be updated to point to the correct proxy server, load balancer, or application server's JavaClient path, including the appropriate protocol, hostname, domain, and port.

```XML
<jnlp spec="1.0+" codebase="http://<proxy/loadbalancer>.<domain>:<port>/JavaClient">
```

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

### Creating ObjectReferentIdType for Customer in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This Java snippet illustrates the creation and JAXB marshalling of an ObjectReferentIdType instance for a 'Customer' entity. It configures the object identifier and class identifier, then marshals the object into an XML Element, ensuring proper XML namespace attributes for Agile PLM are applied.

```Java
ObjectReferentIdType customer = new ObjectReferentIdType(); customer.setObjectIdentifier("DEMO CUSTOMER 1"); customer.setClassIdentifier("customer");
Element element = createMessageElement("customer");             
JAXBContext jc = JAXBContext.newInstance(ObjectReferentIdType.class);
Marshaller marshaller = jc.createMarshaller();
JAXBElement<ObjectReferentIdType> jaxbEl = new JAXBElement<ObjectReferentIdType>(new QName("",element.getNodeName()),
      ObjectReferentIdType.class, customer);
marshaller.marshal(jaxbEl, element);
element =  (Element) element.getFirstChild();
element.setAttribute("xmlns:xsi","http://xmlns.oracle.com/AgileObjects/Core/Common/V1");
element.setAttribute("xsi:type", "ObjectReferentIdType");
```

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

### Loading Oracle Environment Variables (UNIX Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_5.htm

This command sources the `.profile` file, which loads the newly configured Oracle environment variables into the current shell session. This is a crucial step to ensure that subsequent commands recognize the Oracle home, SID, and other necessary settings.

```Shell
$ . ./.profile
```

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

### Creating ObjectReferentIdType for User in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This Java snippet demonstrates how to create and marshal an ObjectReferentIdType instance for a 'User' entity using JAXB. It sets the object identifier and class identifier, then marshals the object into an XML Element, adding necessary XML namespace attributes for Agile PLM.

```Java
ObjectReferentIdType user = new ObjectReferentIdType(); user.setObjectIdentifier("EMS1"); user.setClassIdentifier("supplier");
Element element = createMessageElement("supplier");             
JAXBContext jc = JAXBContext.newInstance(ObjectReferentIdType.class);
Marshaller marshaller = jc.createMarshaller();
JAXBElement<ObjectReferentIdType> jaxbEl = new JAXBElement<ObjectReferentIdType>(new QName("",element.getNodeName()),
      ObjectReferentIdType.class, user);
marshaller.marshal(jaxbEl, element);
element =  (Element) element.getFirstChild();
element.setAttribute("xmlns:xsi","http://xmlns.oracle.com/AgileObjects/Core/Common/V1");
element.setAttribute("xsi:type", "ObjectReferentIdType");
```

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

### Creating and Permissioning Oracle Data Directory (Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_5.htm

These shell commands create the `/u01/oradata` directory and then assign ownership to the `oracle` user and `dba` group. This is a critical prerequisite for Oracle database installation, ensuring the database has proper write access to its data files.

```Shell
# mkdir -p /u01/oradata
# chown oracle:dba /u01/oradata
```

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

### Creating a Single List Element in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This snippet demonstrates how to create an AgileListEntryType object for a single-select list attribute. It adds a single SelectionType value ("Alternate") to the list and then marshals the object into an XML element, ensuring the correct namespace and type attributes are applied.

```Java
AgileListEntryType list01 = new AgileListEntryType(); SelectionType[] selection = new SelectionType[1]; selection[0] = new SelectionType(); selection[0].setValue("Alternate"); 
list01.getSelection().add(selection[0]);
Element element = createMessageElement("list01");             
JAXBContext jc = JAXBContext.newInstance(AgileListEntryType.class);
Marshaller marshaller = jc.createMarshaller();
JAXBElement<AgileListEntryType> jaxbEl = new JAXBElement<AgileListEntryType>(new QName("",element.getNodeName()),
    AgileListEntryType.class, list01);
marshaller.marshal(jaxbEl, element);
element =  (Element) element.getFirstChild();
element.setAttribute("xmlns:xsi","http://xmlns.oracle.com/AgileObjects/Core/Common/V1");
element.setAttribute("xsi:type", "AgileListEntryType");
```

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

### Creating a Unit of Measure Element in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This snippet demonstrates how to create and marshal an AgileUnitOfMeasureType object into an XML element using JAXB. It sets the unit name and value, then attaches the required xmlns:xsi and xsi:type attributes for proper serialization within the Agile system.

```Java
AgileUnitOfMeasureType uom = new AgileUnitOfMeasureType(); uom.setUnitName("Kilogram");
uom.setUnitValue(1000.0);
Element element = createMessageElement("mass");             
JAXBContext jc = JAXBContext.newInstance(AgileUnitOfMeasureType.class);
Marshaller marshaller = jc.createMarshaller();
JAXBElement<AgileUnitOfMeasureType> jaxbEl = new JAXBElement<AgileUnitOfMeasureType>(new QName("",element.getNodeName()),
     AgileUnitOfMeasureType.class, uom);
marshaller.marshal(jaxbEl, element);
element =  (Element) element.getFirstChild();
element.setAttribute("xmlns:xsi","http://xmlns.oracle.com/AgileObjects/Core/Common/V1");
element.setAttribute("xsi:type", "AgileUnitOfMeasureType");
```

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

### Printing Usage Statements for AIS Java Clients

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaat/output/chapter_2.htm

These commands show how to invoke various Agile Integration Services (AIS) Java client samples using the 'runner' script to display their respective usage statements. This helps in understanding the required parameters and functionality of each sample application.

```Shell
runner export.ExportData
runner export.ExportPartlist
runner importer.ImportData
runner importer.ImportSupplierResponse
runner importer.ValidateData
```

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

### Creating and Permissioning Oracle Admin Directory (Shell)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/install/html_agaba/output/chapter_5.htm

These commands establish the Oracle administration directory structure under `$ORACLE_BASE` (e.g., `/u01/app/oracle/admin`) and recursively set its ownership to the `oracle` user and `dba` group. This ensures the Oracle user has the necessary permissions for administrative tasks and log file generation.

```Shell
$ mkdir -p /u01/app/oracle/admin
chown -R oracle:dba /u01/app/oracle
```

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

### Creating XML Element with Tag Name in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This utility method creates a new XML Element with a specified tag name. It uses DocumentBuilderFactory and DocumentBuilder to create a new XML Document and then an Element within that document, ensuring namespace awareness for proper XML structure.

```Java
// Sample method to create a XML element with specified tag name
public static Element createMessageElement(String tagName) {
    Document document = null;
    try {
        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        dbf.setNamespaceAware(true);
        DocumentBuilder docBuilder = dbf.newDocumentBuilder();
        document = docBuilder.newDocument();
    } catch (ParserConfigurationException e) {
        return null;
    }
    return document.createElement(tagName);
}
```

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

### Launching ACP Scripts with acp Utility - Shell

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/tools/html_agaan/output/appendix_d.htm

This command illustrates the general usage of the `acp` launcher script, which is installed in the project directory for convenience. It allows users to execute any ACP script by name, avoiding the need to specify the full path to the `bin` directory, and accepts optional script-specific parameters.

```Shell
acp <script name> [<script parameters>]
```

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

### Processing Dirty Rows with IUpdateTableScriptObj - Groovy

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaaq/output/chapter_5.htm

This Groovy example demonstrates how to use IUpdateTableScriptObj to retrieve the table ID and iterate through all dirty row IDs. For each dirty row, it gets the associated action and conditionally calls testIEventDirtyRowFileUpdate for file-related actions or testIEventDirtyRowUpdate for other row actions.

```Groovy
// IUpdateTableScriptObj: get table id and Dirty row ids   void testIUpdateTableScriptObj(IBaseScriptObj obj){
//getTableId()  int table_id= obj.getTableId();  obj.logMonitor("Table Id" + table_id); 

// getDirtyRowIds()  rowIDs =obj.getDirtyRowIds();  rowIDs.each{rID-> //loop through Dirty rows  obj.logMonitor("rowID is " + rID);

//getDirtyRow()  row = obj.getDirtyRow(rID);

// getAction  action = row.getAction();  obj.logMonitor ("Action" + action);  if ((action == EventConstants.DIRTY_ROW_ACTION_ADD_FILE) || (action 
      ==  EventConstants.DIRTY_ROW_ACTION_REPLACE_FILE))  testIEventDirtyRowFileUpdate(obj,row,rID); // user methodelse  testIEventDirtyRowUpdate(obj,row,rID); // user method }
}
```

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

### Naming and Saving a Query to a Folder in Agile PLM (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_3.htm

This snippet shows how to create an `IQuery`, set its criteria, assign a name using `setName()`, and then add it to a specific folder (e.g., "Personal Searches") using `folder.addChild()`. This allows the query to be retrieved and reused later.

```Java
IQuery query =(IQuery)session.createObject(IQuery.OBJECT_TYPE,ItemConstants.CLASS_ITEM_BASE_CLASS);
query.setCaseSensitive(false);
query.setCriteria("[Title Block.Number] starts with 'P'");
query.setName("Items Whose Number Starts with P");
IFolder folder =(IFolder)m_session.getObject(IFolder.OBJECT_TYPE,"/Personal Searches");
folder.addChild(query);
```

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

### Building AIS Java Samples on Windows

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaat/output/chapter_2.htm

This command builds the Agile Integration Services (AIS) Java samples on a Windows environment using Ant. It requires specifying the AIS URL, username, password, and an optional build target (export, import, or all). The %ANT_HOME% environment variable must be set to the Ant installation directory.

```Shell
%ANT_HOME%\bin\ant -Dais.url=https://<hostname:port/virtualPath>/ws -Dusername= <username> -Dpassword= <password target>
```

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

### Loading Design Object Structure Table in Agile PLM (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_14.htm

This example shows how to load the structure table of an existing Design object in Agile PLM. It retrieves the Design object by its class and number, then accesses its TABLE_STRUCTURE to get the table and its descriptor ID, preparing it for further operations.

```Java
public void testLoadingDesignStructureTable() throws Exception {// assuming Design object Design00004 existed with some data in StructureIFileFolder obj = (IFileFolder) m_session.getObject(FileFolderConstants.CLASS_DESIGN, "Design00004");// load Structure tableITable table = obj.getTable(FileFolderConstants.TABLE_STRUCTURE);Integer tableId = (Integer) table.getTableDescriptor().getId();// ITable performs related tasks}
```

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

### Agile PLM User Attribute IDs in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This snippet provides a list of Agile PLM User-related attribute IDs, defined as Integer constants in Java. These identifiers are essential for accessing or manipulating user attributes that lack explicit API names, requiring their internal integer representation.

```Java
ATT_LOGIN_PASSWORD
new Integer(-1);
ATT_APPROVAL_PASSWORD
new Integer(-2);
ATT_SUPPLIER
new Integer(-3);
ATT_LOCALE
new Integer(-4);
ATT_TIMEZONE
new Integer(-5);
ATT_DATEFORMAT
new Integer(-6);
ATT_DATETIMEFORMAT
new Integer(-7);
```

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

### Using Criteria Library in Agile PLM SDK Queries (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_3.htm

This Java SDK example demonstrates how to retrieve a predefined ICriteria object from the Agile PLM Criteria Library and apply it to an IQuery object. It initializes a query, accesses the admin instance, fetches the criteria library node, loads a specific criteria ("All Released Items"), and then sets this criteria for the query. This allows reusing pre-configured search logic.

```Java
IQuery query = (IQuery) session.createObject(IQuery.OBJECT_TYPE, ItemConstants.CLASS_ITEM_BASE_CLASS);
IAdmin admin = session.getAdminInstance();
// Get the Criteria Library node
INode criteriaLibrary = admin.getNode(NodeConstants.NODE_CRITERIA_LIBRARY);
// Load the Criteria relevant to the query class (For example it is Items base class)     ICriteria criteria = (ICriteria) criteriaLibrary.getChild("All Released Items");
// Set the ICriteria in SDK Query Criteria 
query.setCriteria(criteria);
```

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

### Agile PLM Item Attribute IDs in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This snippet lists various Agile PLM Item-related attribute IDs, represented as Integer constants in Java. These IDs are used when interacting with Agile PLM attributes that do not have direct API names, requiring the use of their internal integer identifiers.

```Java
TABLE_REDLINEBOM
new Integer(-803);
TABLE_REDLINEMANUFACTURERS
new Integer(-1491);
TABLE_REDLINETITLEBLOCK
new Integer(-801);
TABLE_REDLINEPAGETWO
new Integer(-810);
TABLE_REDLINEPAGETHREE
new Integer(-1501);
FLAG_IS_REDLINE_MODIFIED
new Integer(-101);
FLAG_IS_REDLINE_REMOVED
new Integer(-102);
FLAG_IS_REDLINE_ADDED
new Integer(-103);
```

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

### Testing Agile Web Client Setup URL (HTTP)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agaap/output/chapter_1.htm

This URL format is used to test the Agile Web client setup and verify the application server connection. It requires replacing placeholders such as `application_server_hostname`, `port`, and `virtual_path` with the actual values for your environment. It is important to note that the URL is case-sensitive.

```HTTP
http://application_server_hostname:port/virtual_path/PLMServlet
```

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

### Marshalling Java Object to XML using JAXB

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This method converts an AgileListEntryType Java object into an XML Element representation using JAXB. It initializes a JAXBContext, creates a Marshaller, and marshals the Java object into the provided XML element, setting specific XML attributes for namespace and type.

```Java
// Sample method to marshal a AgileListEntryType list Object into XML
// Element object
public static Element marshal(Element element, AgileListEntryType agileListEntryType) {
    JAXBContext jc;
    try {
      jc = JAXBContext.newInstance(AgileListEntryType.class);
      Marshaller marshaller = jc.createMarshaller();
      JAXBElement<AgileListEntryType> jaxbEl = new JAXBElement<AgileListEntryType>(new QName("",element.getNodeName()), AgileListEntryType.class, agileListEntryType);
      marshaller.marshal(jaxbEl, element);
      element = (Element) element.getFirstChild();
    } catch (JAXBException e) {e.printStackTrace();}    element.setAttribute("xmlns:xsi", "http://xmlns.oracle.com/AgileObjects/Core/Common/V1");
    element.setAttribute("xsi:type", "AgileListEntryType");
  return element;
}
```

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

### Configuring DocumentGenerationJavaOpen PX web.xml

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/whitepapers/html_agaar/output/agaar.htm

This XML snippet configures the web.xml file for the DocumentGenerationJavaOpen Process Extension. It defines the servlet 'PX' and its class 'samples.DocumentGeneration.DocumentGenerationJavaPxOpen.DocumentGenerationJavaPxOpen'. Crucially, it includes initialization parameters for 'URL', 'USERNAME', and 'PASSWORD', which must be customized to enable the PX to run in a specific environment.

```XML
<?xml version="1.0" encoding="ISO-8859-1" ?><web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" version="2.4"><display-name>Agile933 Doc-Publishing URL PX</display-name><description>URLPX Servlet</description><servlet><servlet-name>PX</servlet-name><servlet-class>samples.DocumentGeneration.DocumentGenerationJavaPxOpen.DocumentGenerationJavaPxOpen</servlet-class><init-param><param-name>URL</param-name><param-value> http://<your-server>.us.oracle.com:7001/Agile</param-value></init-param><init-param><param-name>USERNAME</param-name><param-value>admin</param-value></init-param><init-param><param-name>PASSWORD</param-name><param-value>agile1</param-value></init-param></servlet><servlet-mapping><servlet-name>PX</servlet-name><url-pattern>/PX</url-pattern></servlet-mapping></web-app>
```

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

### Disabling a Specific Warning in Agile Web Services (Java)

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This Java code shows how to selectively disable a particular warning by setting its resolution. It creates an AgileWarningResolutionType object, sets its ID (e.g., 182) and resolution to DISABLE, and then applies it to the request object. This allows fine-grained control over which warnings are reported.

```Java
AgileWarningResolutionType warningRes[] = new AgileWarningResolutionType[1]; warningRes[0] = new AgileWarningResolutionType();warningRes[0].setId(182); warningRes[0].setResolution(AgileWarningResolutionConstantsType.DISABLE); approveRObjectRequestType.setWarningResolution(warningRes);
```

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

### Setting Text Content of an XML Element in Java

Source: https://github.com/ukhack/agile-lifecycle-management-documentation/blob/master/pdf/integration/html_agabd/output/chapter_2.htm

This snippet demonstrates how to create an XML element named "description" using the createMessageElement utility and then set its text content to a specific string value. This approach is typically used when an API name serves as the tag name for the element.

```Java
Element element = createMessageElement("description");      
element.setTextContent("Updated value of Doc Description");
```