uc_client_info Class
Use uc_client_info from an OpenROAD client only. Use an instance of this user class as a parameter to system SCP CreateASOSession. It passes basic client identification details. Attribute i_client_type is mandatory and at least one of i_user_id, v_user_name, v_ip_address is mandatory. Use these attributes for manual identification purposes only (for example, when using the Server Manager). Also, use attribute i_client_type to determine the session dormant timeout period.
This class has no methods.
Attributes
i_client_type Attribute
Data Type: integer
Use i_client_type for manual identification and to determine the session dormant timeout period. This attribute specifies what the client program type is. Valid values include:
GC_I_CT_OR
Specifies that the client is an OpenROAD GUI
GC_I_CT_ASO
Specifies that the client is another OpenROAD Server for OpenROAD application
GC_I_CT_ASP
Specifies that the client is an Active Server Page (ASP) web server
GC_I_CT_JASMINE
Specifies that the client is a Jasmine ii server
GC_I_CT_OTHERCOM
Specifies that the client is a COM or DCOM client, but none of the above
Most client types have an associated session dormant timeout value. You can override these values by changing the associated global constant with a valid time interval. The default session timeout intervals follow:
GC_I_CT_OR
Determined by global constant GC_V_OR_DORMANT_LIMIT
Default value: 1 hour
GC_I_CT_ASP
Determined by global constant GC_V_ASP_DORMANT_LIMIT
Default value: 30 minutes
GC_I_CT_OTHERCOM
Determined by global constant GC_V_OTHERCOM_DORMANT_LIMIT
Default value: 30 minutes
GC_I_CT_ASO
Determined by catch-all global constant GC_V_STOB_DORMANT_LIMIT
Default value: 24 hours
GC_I_CT_JASMINE
Determined by catch-all global constant GC_V_STOB_DORMANT_LIMIT
Default value: 24 hours
i_user_id Attribute
Data Type: integer
Use i_user_id attribute to specify a numeric user identifier. Use this attribute for manual identification purposes only (for example, when using the Server Manager).
v_ip_address Attribute
Data Type: varchar(15)
Use v_ip_address to specify a client machine name, IP address. Use this attribute for manual identification purposes only (for example, when using the Server Manager).
Example—4GL Client:
myClientInfo = uc_client_info.Create();
myClientInfo.i_client_type = GC_I_CT_OR;
myClientInfo.v_user_name = CurSession.GetEnv('USERNAME');
myClientInfo.v_ip_address = '\\' + CurSession.GetEnv('COMPUTERNAME');
/* i_user_id omitted in this example */
i_status = CurRemoteServer.Call4GL ('CreateASOSession',
b_osca = BYREF(OSCA),
p_UCClientinfo = myClientInfo);
i_status = OSCA.CheckAndHandleError (p_i_aso_retval = i_status);
v_user_name Attribute
Data Type: varchar(32)
Use v_user_name to specify a varchar user name. Use this attribute for manual identification purposes only (for example, when using the Server Manager).