Stat 6.3 - System Administration Guide

File Types

Stat provides change management support for file types in PeopleSoft, Oracle Applications, and Generic Application environments. To avoid confusion, file types for the three change management modules are defined and maintained separately in the Object Type Maintenance window. Generally, the maintenance procedures are the same, except that additional parameters are required for Oracle Applications.


	NOTE: By default, Stat supports the following predefined file types for PeopleSoft: SQR, SQC, COBOL, and COBOL Copy.


Value	Description
Active	Indicates if this file type is activated in Stat
File Type (Key Value)	The name of the type of file, for example, COBOL and SQL
File Extension (Required Value)	The suffix following a filename that identifies the file type, for example, .cbl and .sql NOTE: For Oracle Applications only, generic and custom file types can be associated with multiple file extensions, separated by commas.
File Format (Required Value)	The file type format. Options include ASCII, EBCDIC, and Image. NOTE: FTP inserts carriage returns into ASCII-type file objects when they are migrated from a Windows environment to a Unix environment. For this reason it is recommended you base file objects on the Image format if you plan on migrating them from Windows to Unix environments.
Database Script (Required Value)	Indicates if the file type is a database script. Objects marked as database scripts may be parsed by the Impact Analysis Wizard.
Files to all Paths (Required Value)	If selected, indicates that when a file of this type is migrated to an environment, Stat copies the file to all the predefined source file locations for the environment. If not selected, Stat copies the file only to those defined locations where it already exists. If the file exists in none of the defined locations, Stat copies it to the default location.
File Permission	For Unix-style file types, the file permission mask in octal for files of this type. NOTE: Selecting Unix File Permission in the File Server tab overrides any value you specify in this field.
Migr. Order	(Oracle Applications only) For schema object, file object, and setup object types. Indicates the order in which objects of this type are migrated relative to other file object, schema object, and setup (AOL) object types in an archive set. The values specified here override the default values displayed in the Default Order field. Object types assigned a lower number are migrated before object types assigned higher numbers. The highest number you can assign an object type is 999 and two object types can be assigned the same migration order number.
Default Order	(Oracle Applications only) For schema object, file object, and setup object types. The default order in which objects of this type are migrated relative to other file object, schema object, and setup (AOL) object types in an archive set. These values are read-only and can be overridden by values in Migr. Order field.
Filter	(Oracle Applications Setup Objects only) Allow users to filter the returned objects, for that Setup Object, in the CSRs’ Objects screen. This feature is especially useful for Setup Objects that return a large number of objects from the OA environments. Filtering reduces the number of objects returned and thereby reduces the amount of time required to retrieve the object list. For object types where this checkbox is unchecked, Stat users will not have the ability to filter the retrieved objects list.
Create Path on Migr.	(Oracle Applications only) For custom and generic file object types. If selected, creates the file path of the object on the target environment prior to migrating the object.
Last Update (Read Only)	The date and time this record was last updated
Updated By (Read Only)	The user who last updated this record

In addition to the file type maintenance values common to all modules, generic and custom file types defined for Oracle Applications include the following maintenance values:


Value	Description
Custom Type (Required Value)	Indicates the file type. Options include Predefined, Generic, Custom with Language, and Custom w/o Language.
For Web (Required Value)	Indicates that the file type is managed within the Web partition of the Oracle file server
For Form (Required Value)	Indicates that the file type is managed within the Form partition of the Oracle file server
For Db (Required Value)	Indicates that the file type is managed within the Database partition of the Oracle file server
For Concurrent Mgr (Required Value)	Indicates that the file type is managed within the Concurrent Manager partition of the Oracle file server

File Types for Oracle Applications

Stat supports different types of file objects for Oracle Applications. These include:

•

Predefined file types are proprietary, such as forms and reports, and cannot be modified

•

Generic file types are user-defined file types that exist outside the Oracle Applications file structure but which can still be archived and migrated.


	NOTE: Generic file types are supported for backward compatibility. For new objects that exist outside the Oracle Applications file system, it is recommended that you use custom file types instead of generic file types.

•

Custom file types are user-defined file types that exist within or outside of the Oracle Applications file system. There are three types of Custom file types:

•

Custom with Prod file types that exist within the Oracle Applications file system and are associated with Products.

•

Custom with Prod/Lang file types that exist within the Oracle Applications file system and are associated with a Products and Language.

•

Custom file types that exist outside the Oracle Applications file system.

NOTE: Be aware of the following regarding generic and custom file types:

•

All generic and custom file types must be associated with at least one of the services (form, web, concurrent managers or database). The Stat Oracle Agent defined for the selected service(s) processes the archiving and migrating requests for the generic file type.

•

After you define a generic or custom file type or edit the definition of an existing one, shut down and re-start the Stat Oracle Agent for the environment in which the object type is defined. This allows the agent to register the new or modified object type.

Custom File Types

As with predefined file types, when a user adds a Custom with Prod/Lang file type object to a CSR, they are prompted to specify the object's product and language. With Custom with Prod file type objects, users are only prompted to specify the product.

When defining a custom file type, you can specify a set of commands that you want the Stat Oracle Agent to execute after migrating objects of that type to a selected environment.

To define a custom file type:

In the Custom Type field, do one of the following:

•

Select Custom with Prod to create a custom file type that is associated with a product.

•

Select Custom with Prod/Lang to create a custom file type that is associated with a product and language.

•

Select Custom to create a custom file type that is outside the Oracle Applications file structure.

Specify the file type properties you want, including file extensions, format, services, source file locations, and migration order.

Separate multiple file extensions with a comma.


	NOTE: After you have defined a custom file type, you need to specify where files of this type are located. See the section Source File Locations for more information. Be aware that the value in the Custom Type field cannot be modified after source file locations have been set or after an object of that custom file type has been added to a CSR (e.g., a Custom with Prod file type cannot be changed to a Custom with Prod/Lang file type).

(Optionally) If you want to associate the file type with a file template, or if you want the Stat Oracle Agent to execute commands after migrating file objects of the selected type, click Templates/Generate.

This opens the File Template Maintenance window for the selected file type.

Associating a file type with a file template helps standardize development by defining the basic characteristics and structure of new file objects in a reusable format. See the section File Templates for more information.

In the Define Generate Command tab, you can specify commands that you want the Stat Oracle Agent to execute after migrating objects of the file type to a selected environment. After selecting the environment, define the command in the Command field. You can use any of the predefined parameters in the following table used to login into an environment during a migration.


	NOTE: For R12.2, certain parameters are “Edition Aware,” meaning that when migrating to Run Edition, these parameters refer to corresponding values from the Run Edition and when migrating to Patch Edition, they refer to corresponding values from the Patch Edition.


Parameter	Description
DB_CONNECTION	Refers to the AD_APPS_JDBC_URL variable for the environment. Edition Aware for R12.2.
LANGUAGE	Language associated with the file name being migrated
PRODUCT	Product associated with the file name being migrated
TARGET_APPLSYS_PASSWORD	APPLSYS password
TARGET_APPLSYS_USERNAME	APPLSYS user name
TARGET_APPS_PASSWORD	APPS password
TARGET_APPS_USERNAME	APPS user name
TARGET_DB_LISTENER_PORT	Port defined in the Environment Connection Maintenance
TARGET_DB_NAME	Database Name defined in the Environment Connection Maintenance
TARGET_EDITION	run or patch depending on which Edition is being processed
TARGET_ENV_CD	Environment Code defined in the Environment Connection Maintenance
TARGET_HOSTNAME	Host Name defined in the Environment Connection Maintenance
TARGET_OBJECT_NAME	The file name being migrated
TARGET_OBJECT_NAME_FULL_PATH	The full path of file name being migrated. Edition Aware for R12.2.
TARGET_OBJECT_NAME_FULL_PATH_NE	The full path of file name without extension. Edition Aware for R12.2.
TARGET_OBJECT_NAME_NE	The file name without extension
TARGET_SERVICE_NAME	Service Name defined in the Environment Connection Maintenance
TARGET_SYSTEM_PASSWORD	SYSTEM password
TWO_TASK	Refers to the TWO_TASK variable for the environment. Edition Aware for R12.2.


	NOTE: As an example note how TARGET_OBJECT_NAME_FULL_PATH_NE parameter could be used to create a soft link to a file name being migrated: ln -s %%FND_TOP%%/bin/fndcpesr %%TARGET_OBJECT_NAME_FULL_PATH_NE%%

In addition to predefined parameters, you can also specify your own parameters, the values of which Stat retrieves from the stat.conf file. For example, if you use %%param1%%, you need to define the value for param1 in stat.conf as follows: <env>.env.PARAM1: <value for param1>. After defining a command, click Interpret to see how the command is interpreted by the client server.

Click Ok or Apply.

Generic File Types

You can define generic file types that you want to associate with a CSR, but which do not exist in an Oracle Applications environment. For example, you may want to manage on a CSR design and training documents, but these documents do not exist in any environment.


	NOTE: If setting up new file objects that exist outside the Oracle Application file system, it is recommend that you use Custom file types instead of Generic.

The following example illustrates how to create generic file types:

Create base directory “DOC_TOP” in the OraApps Base Directories tab.

See Case Sensitivity and File Name Conversion for more information.

Define the base directory in the configuration for each Stat Oracle Agent:

•

DEV.env.DOC_TOP=/mnt/oracle/documents

•

TEST.env.DOC_TOP=/mnt/oracle/documents

•

PROD.env.DOC_TOP=/mnt/oracle/documents

You can define a different directory for each agent, such as:

•

DEV.env.DOC_TOP=/mnt/oracle/documents/dev

•

TEST.env.DOC_TOP=/mnt/oracle/documents/test

•

PROD.env.DOC_TOP=/mnt/oracle/documents/prod

See the document, Stat Install Notes for more information on configuring the Stat Oracle Agent.

Create “Design Documents” and “Training Documents” generic file types and associate both file types with the “Web” service.


	NOTE: When creating a generic file type, do not to use the same name as one of the Oracle proprietary file types supported by Stat.

Define source file locations using the DOC_TOP base directory and “design” and “training” relative directories, respectively.

See the next section for information on defining source file locations.

Make sure each Stat Oracle Agent running on the web server has read/write access to the /mnt/oracle/documents file system.

Source File Locations

After you have defined a file type, you need to specify where files of this type are located by selecting the file type and clicking File Location. This opens the File Locations window. Here you specify per environment the server and pathway where files of the selected type are stored. In this window you can also specify a different working directory for each user.

For Oracle Applications, you need to specify the source locations only for generic and custom file types. Remember that proprietary file types are managed by Stat automatically. The procedure for defining source locations is similar to that of PeopleSoft or generic applications, except instead of servers, you specify base directories.

The Source File Locations tab shows a list of all the active environments connected to Stat (as defined in the environment connection maintenance tables corresponding to the change management modules supported by Stat). For each environment, you can specify an unlimited number of source file locations. Source files can be located on different servers (base directories in Oracle Applications), or they can be located on the same server but in different file pathways.


	NOTE: In the case of PeopleSoft, the list of environments does not include those that have been designated as staging databases.

When creating an archive set that includes a file object, Stat searches for the file in the first location you specified for the environment (for example, Path ID = 1). If the file is not there, Stat searches in the second location, and so on.


	TIP: You can also specify source file locations by environment. For more information, see the environment connection sections in this chapter for PeopleSoft, Oracle Applications, and generic applications.

To define a source file location:

Click New. Stat activates a new row in the Source File Locations tab.

In the Environment field, select the environment in which you want to define a source file location.

In the Path ID field, Stat displays a unique ID number that it assigns to each source file location you define per environment. Path IDs determine the order in which file locations are searched during the file archive process. The path with the ID 1 is searched first, and so on.

Do one of the following:

•

For PeopleSoft and generic application file types, select the server where the source file resides in the File Server field

•

For Oracle Applications generic file types, select the base directory where the source files reside in the OA Base Directory field

•

For Oracle Applications custom file types, specify the directory where the source files reside in the Directory field

(Optional) Do one of the following:

•

For PeopleSoft and generic application file types, type the file pathway where the files are located in the File Path field

•

For Oracle Applications generic file types, type the directory path where the source files are located in the Directory field

Make sure you use the proper syntax when specifying source file locations. For more information, see File Path Syntax .

(Optional) Select Default Path if you want this to be the file type’s default source file location.

This is where Stat will copy file objects of the selected type during a migration. Each file type must have one of its source file locations designated as the default.

Click Test Connection.

See the section, Testing File Locations, Servers, and Default Directory Locations .

Click OK or Apply to save your changes.

File Type User Directories

In the File Type User Directories tab, you can specify for each active Stat user a separate working directory for the selected file type. This way, whenever an archive set containing a file object of a certain type is migrated to the working directories of the Development environment, Stat migrates the file object in the archive set to the assigned user’s working directory defined for that type. From there it can then be modified as needed.

If you don’t define a separate file type working directory for a user, whenever a file object of that type is assigned to the user and migrated to the “working directory,” Stat places the file object in the user’s default working directory. See the following section for more information on user default directories.

When defining file type user directories, keep in mind the following considerations:

•

User can define their own working directories in the Stat User Options window. For more information, see the “Object Management” sections in the change management chapters of the Stat User Guide.

•

You can also define working directories by user in the User File Directories tab of the Other User Information window. For more information, see Defining Stat Users .

•

Make sure you use the proper syntax when specifying directories. For more information, see File Path Syntax .


Value	Description
Stat User (Key Value)	The Stat user’s ID
Working File Server	Server where the working folder is located
Working File Path	File server path where the working folder is located
Last Update (Read Only)	The date and time this record was last updated
Update By (Read Only)	The user who last updated this record

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Stat 6.3 - System Administration Guide

File Types

File Types for Oracle Applications

Source File Locations

File Type User Directories