Major API Changes from PCRE v2.5 to v2.6

Download PDF version of this faq: 2_5 to 2_6 API_Changes.pdf

1. Use getConnectedClient() instead of the deprecated API getReportServerName( ).The getReportServerName( ) API was earlier used in 2.5. The problem with the getReportServerName method is that the report server corresponding to the returned value may shut down before the application calls client.connect(). This means that the client application would need to write retry code to handle this case. With the getConnectedClient method, the method will automatically retry a configurable number of times to get a PCREApplicationClient object which is connected. The report server will not shut down until all connected clients have been closed using the client.Quit()call.
   
2. SetJobTitle() is a new API added that can be used to log any custom string to the server.log file so that it can be used by someone reviewing the logs to match a server log entry with a responsible party. E.g. SetJobTitle(“Joe Smith, Marketing Dept. ext. 5533”)
   
3. The following methods have been added to the PCREJob class:
   • a) Set/GetParameterPickListOption() Used to set information regarding the pick list for parameters.
   • b) Set/GetNthParameterValueDescripton() Used to obtain the descriptive text for a parameter.
   • c) Get/SetGraphAxisInfo( ) Used to obtain information regarding the axis of the graph.
   • d) Get/SetGraphFontInfo() Used to obtain information regarding the font for the specified part of the graph such as the subtitle font.
   • e) Get/SetGraphOptionInfo() Used to obtain information regarding various graph properties such as graph type, legend position, etc.
   • f) Get/SetGraphTextInfo() Used to get the text for various elements of the graph such as the subtitle etc.
   • g) Get/SetGraphTypeinfo() Used to obtain infomation on the type of graph which will be displayed. such as bar graph, line graph etc.
   
   
4. The following methods have been removed from the PCREJob class: Please note that application programs that use graphing will have to make changes to their code to include and shift to the Graphing API’s listed above.
   • a) Get/Set GraphData
   • b) Get/SetGraphOptions
   • c) Get/SetGraphText
   • d) Get/SetGraphType

Parallel Crystal v2.4 users: Please refer to the FAQ "Major API Changes from PCRE v2.4 to v2.5".