Security

The query service uses j-guar user security. The username and password information of a j-guar user, which is valid and can be connected to the system (uninhibited, un-expired, etc.), must be defined in the SOAP messages sent to the Service. This service can only be used by j-guar users and the query returning values are authorized for the user who uses the service. It is not possible to disable authorization.

Service Access Address

To access this service, the address of the j-guar system is as follows:

http://<sunucu>:<port>/logo/services/DataQueryService?wsdl

Example address: http://172.16.12.53:9080/logo/services/DataQueryService?wsdl

Service Methods

• test (DataQueryParams params) -> DataQueryResult : Servise is a method that is used to test the parameters that are dispatched and the objects that are returned. It has no meaningful function. It is used only to test whether the objects used in other methods can be imported correctly. The result is a sample query that returns from the method. The return value is obtained by running any query, a sample result is generated with fictitious values and returned.
• getBrowserQueryInfo (String browserName, int firm, int period, String language) -> DataQueryBrowserInfo : It is a method used to retrieve query and filter definitions of a data list (browser) form used in j-guar. In this case, the form name (browser name) is given with mode information (MMXFItemBrowser.jfm, MMXFItemBrowser% 0.jfm is invalid). The company to be used and the period information are given in the form of company and period numbers. The final parameter, the language parameter, is used to determine the filter values from which to draw the form. The valid values for the language parameter are "TRTR", "ENUS", "DEDE".
• first(String queryName, DataQueryParams params, int maxCount, boolean reverse) -> DataQueryResult : It is the method used to execute the first one of the queries defined in the xml files in j-guar and get the first page records. The meta query name, the query settings to use when running the query, the number of requested records, and the parameters to which records are requested in reverse order are given. The number of records must be a positive number and the maximum value is 50. Even if a value greater than 50 is given, this service brings up the first 50 registers. To retrieve the other records, the next method is used to continue the interrogation point. If the records are to be retrieved from the reverse of the sequence used in the query, the last parameter is set a true value.
• last(String queryName, DataQueryParams params, int maxCount, final boolean reverse) -> DataQueryResult : It is the method used to run one of the queries defined in j-guar and get the last page records. The meta query name, the query settings to use when running the query, the number of requested records, and the parameters to which records are requested in reverse order are given. The number of records must be a positive number and the maximum value is 50. Even if a value greater than 50 is given, this service brings the last 50 registers. To retrieve other records, the previous method is used to resume from the point where the query is held. If the records are to be retrieved from the reverse of the sequence used in the query, the last parameter is set a true value. This method does not work by calculating how many records remain on the last page. For example, if the total number of records is 55 and the records are retrieved with 10 queries, this method returns the number of records from this method, not the last 5 records. For example, if 10 records are requested from the method, the last 10 records are returned.
• next(String queryName, DataQueryParams params, int maxCount, boolean reverse, int refPrimaryKey) -> DataQueryResult: It is the method used to run one of the queries defined in the j-guar and get the next records starting from the given record. The meta query name, the query settings to use when running the query, the number of records requested, the order in which records are requested in reverse order, and the records from which record is requested are given. The number of records must be a positive number and the maximum value is 50. Even if a value greater than 50 is given, this service brings up the first 50 registers. To retrieve the other records, the next method is used to continue the interrogation point. If the records are to be retrieved from the reverse of the sequence used in the query, a true value is sent to the reverse parameter. The last parameter specifies the record from which record is requested and must be the primary key value of a record. For example, if the first page records are retrieved by the first method, and the last key value of the returning records from this method is sent to the next method, records after that record are returned from this method except for that record.
• previous(String queryName, DataQueryParams params, int maxCount, boolean reverse, int refPrimaryKey) -> DataQueryResult: It is the method used to run one of the queries defined in j-guar and retrieve the records from the given record. The meta query name, the query settings to use when running the query, the number of records requested, the order in which records are requested in reverse order, and the parameters from which record previous records are requested are given. The number of records must be a positive number and the maximum value is 50. Even if a value greater than 50 is given, this service brings up the first 50 registers. To retrieve other records, the previous method is used to resume from the point where the query is held. If the records are to be retrieved from the reverse of the sequence used in the query, a true value is sent to the reverse parameter. The last parameter specifies the record from which the previous record is requested, and it must be the primary key value of a record. For example, if the last page records are retrieved by the last method, if the primary key value of the first returning records from this method is sent to the previous method, records that precede that record is returned from this method except for that record
• search(String queryName, DataQueryParams params, int maxCount, boolean reverse, int refPrimaryKey, int searchComparison) -> DataQueryResult:It is the method used to execute records from the queries defined in the j-guar and to retrieve the records determined according to the comparison criteria given relative to the given record. The meta query name, the query settings to be used when executing the query, the number of records requested, the order in which records are requested in reverse order, which record is to be referenced, and the comparison criterion based on the reference record are given. The number of records must be a positive number and the maximum value is 50. Even if a value greater than 50 is given, this service brings up the first 50 registers. To retrieve the other records, the search method is used to continue from the point of questioning. If the records are to be retrieved from the reverse of the sequence used in the query, a true value is sent to the reverse parameter. The ref primary key parameter specifies which record to refer to and must be the primary key value of a record. The last parameter, the comparison criterion, is a numeric value and specifies how to perform a comparison based on the reference record. Accepted values and meanings are as follows:
                              0 : Records previous to this entry (less than the reference record)
                              1 : Records less than or equal to this record, including the reference record,
                              2 : Equal to reference records
                              3 : Records from this record, including the reference record (greater than or equal to)
                              4 : Excluding reference records, records after this record (greater than)

• select(String queryName, DataQueryParams params, int maxCount) -> DataQueryResult : It is the method used to run unsupported navigation from queries defined in j-guar. The meta query name, the query settings to be used when running the query, and the desired number of records are given. The number of records must be a positive number and the maximum value is 50. Even if a value greater than 50 is given, this service brings up the first 50 registers. It is not possible to get more than 50 records for this kind of cold. Since these queries do not support navigation, it is not possible to retrieve subsequent records. Such queries do not already return a large number of records and are usually defined for purposes such as calculation, aggregate retrieval, or a number of records.
• getRowCount(final String queryName, DataQueryParams params) -> DataQueryCountResult : It is the method used to retrieve the number of records returned by the query from one of the queries defined in j-guar. The meta query name and query execution settings parameters are given.

Data Structure Used in Service

DataQueryResult

The DataQueryResult object is an object that contains the results returned by the query. The message describing the failure if the query was unsuccessful, the query returning rows, if successful, includes:

•   successful : Specifies whether the query is successful.
•   errorMessage : Contains the error message if the query failed.
•   rows : The query result contains returning rows. This value is an array of DataQueryResultRow objects. Each element of the Array contains the DataQueryResultRow object.

DataQueryResultRow

The DataQueryResultRow object is the object corresponding to each row returned by the query:

• primaryKey : The primary key value of the record.
• columns : Record columns. This value is an array of DataQueryRowProperty objects. Each element of the array contains the DataQueryRowProperty object.

DataQueryRowProperty

The DataQueryRowProperty object is the counterpart of a column of each record returned by the query:

• columnAlias : It's the name of the colony. It is the unique column name defined for the column in question.
• columnValue : The value of the column is expressed as a string / String. The object-to-string conversion rules here are the same as those applied to SOAP messages. More information can be found in the Axis library.
• columnType : Column is the data type. Possible types used here are defined type definitions in the XML schema. For type definitions, refer to the XML schema definitions at http://www.w3.org/2001/XMLSchema.

DataQueryBrowserInfo

The DataQueryBrowserInfo object is an object that contains query and filter definitions for a data browser form used in j-guar.

• successful : Specifies whether the operation was successful. This may fail if the requested form is not found, or if the form is not a data list form, or if the form is not defined in the form.
• errorMessage : Contains the error message if the operation was unsuccessful.
• queryName : It is the query name of the form.
• filters : These are the filters defined on the form. This value is an array of DataQueryBrowserFilter objects. Each element of the Array contains the DataQueryBrowserFilter object.

DataQueryBrowserFilter

The DataQueryBrowserFilter object is the object that corresponds to the filter object that is defined in the data list forms.

type : Specifies the type of filter. Possible values:

•  string : Type filter
•  string-range : String spacing filter. Two values can be given in the range filters and the records between these two values can be filtered.
•  date : Date filter
•  date-range : Date range filter
•  numeric : Digital field filter
•  numeric-range : Number range filter
•  time :Time filter
•  time-range : Time interval filter
•  group-selection :A group filter that filters out records that match more than one of the list elements. Each selected value is searched in the query with OR. For example, invoice type: all listed types are fetched.
•  list-selection : A selection filter that allows only one of the list elements to be selected and constrained according to this value. For example, the recording status is: out of use - only the records matching the selected one are used.

caption : It is the head of the filtrate. In the data list form, this header contains the header of this filter.

id : The unique key value of the filtration. This value should not be lost because it is used to apply this filter to the query.

range : Specifies whether the filter is a range filter. In range filters, it is possible to filter for two value ranges.

list : If the filter is using a list (group or selection filter), it is the selection list of the filter. A sample selection list is All ~ 0 | In use ~ 1 | Disable ~ 2 This example lists every option |. Each option (Option) is written as ~ (Value). The value must be used to open an option. OptionID is only used to give a meaningful explanation to the user.

DataQueryParams

The DataQueryParams object is an object that contains query settings. This is the most complex object in the service.

• disableAllTerms :Enables closing of all restriction expressions used in the query. When this property is true, only the constraint statements specified with enabled teams remain open in the query, all remaining constraint statements are closed.
• disabledTerms :Indicates which constraints are used in the query (term). The restriction words to be closed are separated by "," (comma). Example value: "T1, T5, T40"
• enabledTerms : Indicates which constraints are used in the query (term). The restriction words to be opened are separated by "," (comma). Example value: "T1, T5, T40"
• mainTableParams : It includes the column and sort settings of the main column of the query.
• tableLinksParams : The link used in the query (join) contains the column and sort settings of the table. This value is an array of DataQueryTableParams objects. Each element of the Array contains the DataQueryTableParams object.
• disableAllLinks : All link (join) tables used in the query are closed. When this property is true, only the tables specified by enabled table links are joined in the query, all the remaining tables are closed.
• disabledTableLinks : The link used in the query (join) specifies which of the tables will be closed. The tables to be closed are separated by "," (comma). Example value: "Link1, Link2, Link5"
• enabledTableLinks : The link used in the query (join) specifies which of the tables should be opened. The tables to be opened are separated by "," (comma). Example value: "Link1, Link2, Link5"
• negateAllTerms : Indicates that the entire restriction expression used in the query will be reversed. For example, if the constraint expression is "COL = 3" then this value is true and the expression is "COL <> 3". This way all restrictions are reversed.
• negatedTerms :Specifies which of the restriction expressions used in the query will be reversed. Restrictions to be reversed are separated by "," (comma). Example value: "T1, T5, T40"
• globalOrderName : SIt specifies which of the global sequences defined in the ORGD will be used.
• userOrder : The query allows a user to identify the query. It allows sorting through columns that are not defined as sorting in the query. Example value: "Col1, Col5" Col1, Col5 comes in ORDER BY.
• customization : If the working query is an adaptation query, then the GUID field of the adaptation project defined in the query.
• maxRowCount : The maximum number of rows that the query will return.
• firm : Specifies which institution to use when connecting to j-guar to run the query (login). The nature of the institution. This value must be a valid corporate entity or the connection to the j-guar will fail and the query will not be executed.
• period : Specifies the time period (login) to use when connecting to j-guar to run the query. The end of the loop. This value must be a valid period name or the connection to the j-guar (login) will fail and the query can not be executed.
• setValue : If the set variable is used in the tables used in the query, this variable specifies which value to use.
• parameterValues : Contains objects for which the values of the parameters defined in the query are defined. This value is an array of DataQueryParameterValue objects. Each element of the Array contains the DataQueryParameterValue object.
• variableValues : Contains objects for which the values of the variables defined in the query are defined. This value is an array of DataQueryVariableValue objects. Each element of the array contains the DataQueryVariableValue object.
• columnFilters : Column filters to be sent to the sorghum. These filters allow filtering on a colony even if no definition is given in the query. This value is an array of DataQueryColumnFilter objects. Each element of the Array contains a DataQueryColumnFilter object.
• browserFilters : If the query belongs to a data list form, the filter defined in that form is the object used to apply the query.
• forceSubqueryRownum : Enables the RowNum constraint to be used as the inner query to be used for the query. This feature is usually reserved for performance bottlenecks in Oracle. If this value is true, a query that restricts the number of records in the query will work in the inner query to limit the number of records in the query. For example, SELECT * FROM (SELECT .... WHERE .....) WHERE ROWNUM <50. Here is the actual query in parentheses. The outer query only limits the number of records.
• forceWhereRownum : The RowNum constraint to be used for the query allows the query to be added to the WHERE portion. For example SELECT ..... WHERE .... AND ROWNUM <50
• forceNoHint : It allows to close the use of Indian for queries and joins in the query.
• noOrder : It allows the ORDER BY part of the query to be removed. The query runs in the record order in the database.
• noSqlRowlimit : It allows closing SqlRowLimit in the query.
• noJoins :Sorgun does not join at all.
• onlyKeys : It allows only primary key values to be returned in the query. All other columns are removed from the interrogation.

DataQueryTableParams

The DataQueryTableParams object is the object that provides the column and sort settings for the table used in the query.

• tableAlias : It is the table name that specifies the table for which the settings for the tables other than the main table are made. Here, the alias (nickname) defined in the query is used, not the physical name of the table.
• disableAllColumns : It allows all columns belonging to the table to be closed. If this value is true, only the columns specified by enabled columns are selected.
• disabledColumns : The table defines which columns will be closed. Columns to be closed are separated by "," (comma). Example value: "Col1, Col5, Col23"
• enabledColumns : The table defines which columns are to be opened. Columns to be opened are separated by "," (comma). Example value: "Col1, Col5, Col23"
• orderName : Specifies which order to use from the order defined in the query definition of the table. Example value: "byOrder1"
• orderDescending :If the definition of the sort to be used for the table is given, it indicates that this definition is to be decremented.

DataQueryParameterValue

The DataQueryParameterValue object is an object that allows you to define the values to be passed to the parameters defined in the query.

• parameterName :It is the name of the parameter. This name must be the name of the parameter used in the query definition. Example value: "P_1" or "P_STATUS"
• parameterType :The parameter specifies the type. Possible types used here are defined type definitions in the xml schema. For type definitions, refer to the XML schema definitions at http://www.w3.org/2001/XMLSchema.
• parameterValue : Parameter value is expressed as string / String. The object-to-string conversion rules here are the same as those applied to SOAP messages. More information can be found in the Axis library.

DataQueryVariableValue

The DataQueryVariableValue object is an object that allows you to define values to be sent to variables defined in the query.

• variableName : It is the name of the variable. This name should be the variable name used in the query definition. Example value: "V_1" or "V_STATUS"
• variableType : Specifies the type of the variable. Possible types used here are defined type definitions in the xml schema. For type definitions, refer to the XML schema definitions at http://www.w3.org/2001/XMLSchema.
• variableValue : Variable value is expressed as string / String. The object-to-string conversion rules here are the same as those applied to SOAP messages. More information can be found in the Axis library.

DataQueryColumnFilter

The DataQueryColumnFilter object is a filter statement that allows filtering on any column if the query has no constraint expression or parameter is defined.

• tableAlias : The nickname of the table belonging to the column used for filtering. This value may be empty if the column belongs to the main table.
• columnName : The name of the column used for filtering. Here is the alias defined in the question, not the physical name of the column.
• value : The value to be used for filtering.
• operator : The comparison process to use when filtering. Possible values and meanings of this numerical property are:

 1 : Bigger or equal (>=)

 2 : great than (>)

 3 :it is similar(LIKE)

 4 : It is in the given values (IN)

 5 : Equal (==)

 6 : Less or equal (<=)

 7 : smaller than (<)

 9 : It is not equal(<>) (!=)

DataQueryBrowserFilters

If the DataQueryBrowserFilters object belongs to a data list form, the filter defined in that form is the object that provides the application to query.

• browserName : The name of the data list form that Sorgun belongs to. This value is the name of the form without mode information. For example MMXFItemBrowser.jfm is valid while MMXFItemBrowser% 0.jfm is invalid. Filters can not be applied to filters given without this form name, so no equivalents can be found. So, if you want to apply filtering, you have to specify the names of these filters.
• filters : The values of the filters. This value is an array of DataQueryBFilterValue objects. Each element of the Array contains the DataQueryBFilterValue object.

DataQueryBFilterValue

The DataQueryBFilterValue object is the object corresponding to each of the filters from the data list form.

• id : The primary key value of the filter. This value corresponds to the id field of the DataQueryBrowserFilter object that contains the data list form information. If the form does not have a filter for this value, this filter can not be applied.
• value : It is the value of the filtrate. In the case of range filters, filter values are separated by "," (comma). For example, for the value "A, C", the range filter filters for values from A to C. The expected value for the date filters should match the format "yyyy-MM-dd HH: mm: ss". For example: "2009-12-31 23:59:12" (31 December 2009, corresponding to the value of 23:59:12).
• type : It's the type of filter. It can take the same values as the type field of the DataQueryBrowserFilter object.