AddEntSvrEnvDefinition

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400C - Enterprise Server Environment Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnterpriseServerNameMKEYcharREQINPUT

The Location or Machine Key indicates the name of the machine on the network (server or workstation).

mnPortNumberPORTNUMMATH_NUMERICREQINPUT

Identifies the port for a given instance of OneWorld. Because the JDE.ini file controls the port to which a workstation will connect, for 
workstations this port number is for reference only.

szEnvironmentNameENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cServerMapOCMYNPARMcharREQINPUT

Return as parameter

cLogicMappingsYNPARMcharREQINPUT

Return as parameter

Related Functions

None

Related Tables

None
ChangeOCMDataSourceByEnv

ChangeOCMDataSourceByEnv

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400H - Change OCM Data Source By Environment Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentNameENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

szExistingDataSourceDATPcharREQINPUT

The name that identifies the data source.

szNewDataSourceDATPcharREQINPUT

The name that identifies the data source.

cDataClassCLDFcharOPTINPUT

A code that classifies the type of data that is stored in a J.D. Edwards table.  The standard classes are System, Data Dictionary, Object 
Librarian, Business Data, Control Tables, Central Objects, and Versions. When you create or modify OCM mappings for an environment, this 
value is used to associate this table to a J.D. Edwards data source (DATUSE).

Related Functions

None

Related Tables

None
CopyEnvEntSvrDefinitions

CopyEnvEntSvrDefinitions

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400E - Copy Environment Definition Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szExistingEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

szNewEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cSuccessPARMcharREQOUTPUT

Return as parameter

Related Functions

None

Related Tables

None
CopyEnvironmentDefinition

CopyEnvironmentDefinition

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400E - Copy Environment Definition Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szExistingEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

szNewEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cSuccessPARMcharREQOUTPUT

Return as parameter

Related Functions

None

Related Tables

None
CopyEnvironmentOCM

CopyEnvironmentOCM

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400E - Copy Environment Definition Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szExistingEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

szNewEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cSuccessPARMcharREQOUTPUT

Return as parameter

Related Functions

None

Related Tables

None
CreateEnvironmentOCM

CreateEnvironmentOCM

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400D - Create Environment OCM Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentNameENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cSuccessPARMcharOPTOUTPUT

Return as parameter

Related Functions

None

Related Tables

None
DeleteEntSvrEnvDefinition

DeleteEntSvrEnvDefinition

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400C - Enterprise Server Environment Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnterpriseServerNameMKEYcharREQINPUT

The Location or Machine Key indicates the name of the machine on the network (server or workstation).

mnPortNumberPORTNUMMATH_NUMERICREQINPUT

Identifies the port for a given instance of OneWorld. Because the JDE.ini file controls the port to which a workstation will connect, for 
workstations this port number is for reference only.

szEnvironmentNameENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cServerMapOCMYNPARMcharREQINPUT

Return as parameter

cLogicMappingsYNPARMcharREQINPUT

Return as parameter

Related Functions

None

Related Tables

None
DeleteEnvironmentDefinition

DeleteEnvironmentDefinition

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400G - Delete Environment Definition Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentNameENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cOCMYNPARMcharREQINPUT

Return as parameter

cUsersYNPARMcharREQINPUT

Return as parameter

cMachinesYNPARMcharREQINPUT

Return as parameter

cDataSourceTemplatePARMcharREQINPUT

Return as parameter

Related Functions

None

Related Tables

None
GetEnvironmentPathCode

GetEnvironmentPathCode

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400F - Environment Path Code Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

szPathCodePATHCDcharREQBOTH

The path code is a pointer to a set of OneWorld objects, and is used to keep track of sets of objects and their locations within OneWorld.

cSuccessPARMcharOPTOUTPUT

Return as parameter

Related Functions

None

Related Tables

None
GetEnvironmentProperties

GetEnvironmentProperties

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400A - Environment Properties Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentNameLLcharREQINPUT

The name associated with a specific list of libraries. The J98INITA initial program uses these library list names to control environments that 
a user can sign on to.  These configurations of library lists are maintained in the Library List Master File table (F0094). This field represents a 
valid environment that can be used to run in PeopleSoft EnterpriseOne.  The environment encompasses both a path code (objects), and a 
data source (data).  When put together, users have a valid workplace within the system.

szDescriptionDL01charOPTBOTH

A user defined name or remark.

szReleaseRLScharOPTBOTH

For World, the release number as defined in the Software Versions Repository. For OneWorld, the release number as defined in the 
Release Master.

cJustInTimeInstallationJITINSTcharOPTBOTH

Use this field to turn ON/OFF just-in-time installation for anyone signed onto this environment. Consider turning just-in-time installation OFF 
before you transfer modified applications into the production path code. Once you have fully tested the applications and are ready for 
production users to receive the changes, you can turn just-in-time installation back ON.

szWANEnvironmentENHV01charOPTBOTH

This code allows the user to indicate that this environment is an environment that is configured for the WAN.    1       WAN Configured 
Environment    Blank Not Configured for WAN

szDetachedEnvironmentENHV02charOPTBOTH

cDeveloperINST1charOPTBOTH

A one byte field for the Install Group. Future use.

szEnvironmentAbbreviationECTKNVALcharOPTBOTH

A value that the system substitutes for a token when the system creates a new environment from a template.

Related Functions

None

Related Tables

None
IsEnvironmentDefined

IsEnvironmentDefined

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400B - Is Environment Defined Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentNameENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

cIsEnvironmentDefinedYNPARMcharOPTOUTPUT

Return as parameter

Related Functions

None

Related Tables

None
SetEnvironmentPathCode

SetEnvironmentPathCode

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400F - Environment Path Code Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentENHVcharREQINPUT

For World, the Environment name is also called the Plan Name, and is used to uniquely identify an upgrade environment for 
Install/Reinstall. For EnteriseOne (Install Applications), the environment name is also called the Plan Name, and is used to uniquely identify an upgrade 
environment for Install/Reinstall. For EnterpriseOne (Environment or Version Applications), this is the path code that identifies the location of the 
application or version specification data. 

szPathCodePATHCDcharREQBOTH

The path code is a pointer to a set of OneWorld objects, and is used to keep track of sets of objects and their locations within OneWorld.

cSuccessPARMcharOPTOUTPUT

Return as parameter

Related Functions

None

Related Tables

None
SetEnvironmentProperties

SetEnvironmentProperties

Environment Definition

Minor Business Rule

Object Name: B989400

Parent DLL: CINSTALL

Location: Client

Language: C

Data Structure

D989400A - Environment Properties Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
szEnvironmentNameLLcharREQINPUT

The name associated with a specific list of libraries. The J98INITA initial program uses these library list names to control environments that 
a user can sign on to.  These configurations of library lists are maintained in the Library List Master File table (F0094). This field represents a 
valid environment that can be used to run in PeopleSoft EnterpriseOne.  The environment encompasses both a path code (objects), and a 
data source (data).  When put together, users have a valid workplace within the system.

szDescriptionDL01charOPTBOTH

A user defined name or remark.

szReleaseRLScharOPTBOTH

For World, the release number as defined in the Software Versions Repository. For OneWorld, the release number as defined in the 
Release Master.

cJustInTimeInstallationJITINSTcharOPTBOTH

Use this field to turn ON/OFF just-in-time installation for anyone signed onto this environment. Consider turning just-in-time installation OFF 
before you transfer modified applications into the production path code. Once you have fully tested the applications and are ready for 
production users to receive the changes, you can turn just-in-time installation back ON.

szWANEnvironmentENHV01charOPTBOTH

This code allows the user to indicate that this environment is an environment that is configured for the WAN.    1       WAN Configured 
Environment    Blank Not Configured for WAN

szDetachedEnvironmentENHV02charOPTBOTH

cDeveloperINST1charOPTBOTH

A one byte field for the Install Group. Future use.

szEnvironmentAbbreviationECTKNVALcharOPTBOTH

A value that the system substitutes for a token when the system creates a new environment from a template.

Related Functions

None

Related Tables

None