Home

IUCLID 5 Query Tool Plugin User manual

1. 5 e InventoryEngineNotAvailableFault Is thrown when e g the service is not available to fulfil the request e InventoryEngineFault 15 thrown if Inventory Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 8 1 6 deleteLiteraturelnventoryEntries Purpose Deletes the given list of literature inventory entries IN e The open logged in session as lt tns Session gt e List of Literature Inventory entries as lt tns literaturelnventoryList gt e Boolean direct Boolean xml binding True to explicitly notify that everything was OK Exceptions e InventoryEngineNotAvailableFault Is thrown when e g the service is not available to fulfil the request e InventoryEngineFault 15 thrown if Inventory Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 48 65 Web Service Technical Manual 9 Messaging Engine 9 1 Interface Methods This section describes the operations of the Messaging Engine The Messaging Engine can be used to show a document on all IUCLID 5 clients where a given user is logged in 9 1 1 broadcastShowDocument This operation sends a message to all logged in IUCLID 5 clients and requests that clients that are operated by the given user specified as receiver open the specified document Purpose e The open logged in session as lt tns Session gt e receiver specifies the user that
2. double the length of the output array final char out new char currenLength 2 take always two characters form the hex value to get the double length of the hashed byte array for int i 0 0 i lt currenLength i calculate the used two hex values final int high int hash i gt gt gt 4 amp Oxf final int low int hash i amp Oxf j DIGITS high j DIGITS low return new String out Code 0 1 Create MD5 Hex Password 5 65 Web Service Technical Manual 2 1 2 Logout Purpose Close the IUCLID 5 session and release each held locks Be careful if you have uncommitted changes this call will not take care of them and the changes will be lost e The open logged in session as lt tns Session gt This method do not define output parameters Prerequisites You have a valid and existing session token 5 SessionEngineNotAvailableFault Is thrown when the back end service is not available to fulfil the request e SessionEngineFault Is thrown for all occurred exception during the web service call 3 Query Engine The Web Service exposes an interface to IUCLID standard queries It is possible to ask the Web Service for the available query and its query definitions in order to fill up the correct query parameter and query ID Name This Interface enables other IT System to execute the standard IUCLID
3. Cognis Deutschland GmbH Duesseldorf E mail 438 company italy Milano Italy Degussa Duesseldorf Germany Dow Corning Corporation Midland MI Contact persons Epona Associates LLC Willington CT ol 38 EUROPEAN COMMISSION European Ch EUROPEAN COMMISSION European Dn 5 aum Information 1 lanai antinen sha currant near Figure 0 10 Country Phrase List Web site 52 65 Web Service Technical Manual Besides the phrase content it might also be necessary to load the layout information which defines the endpoint structures and the definition of the legislation sections The following list shows the available resource ID s e phrases xml e layout xml e legislation sections xml 11 1 Short Introduction to Data Model The Resource Engine defines two important data structures luclidbResource A iuclidbResource object contains the requested resource as content and the ResourceDefinition as meta data ResourceDefinition A ResourceDefinition object contains the ID of the resource and the optional language o ResourcelD the resource id specifies the requested resource phrases xml Jjayout xml lJegislation sections xml o Language the language for the requested resource If you have installed the correct languages it might be possible to load the phrases xml for several languages P
4. aci eie 30 5 1 6 d lete Endpoints au ENTE SE 30 5 1 7 reference Endpoint zs istae eer ee DR Ee ore Et Ree 31 5 1 8 reference Endpoints s isa etre RETIRER RE sheets oan Ep 32 5 1 9 NN ED 33 320 detach Nd Pointe uui e Ree e E EEG de rere RR HE HER 34 52 HOW TO USE THE ENDPOINT ACCESS 34 6 REFERENTIAL INTEGRITY ENGINE eere eren eene tn etn tn ntn sesto 35 6 1 INTERFACE METHODS e 36 6 1 1 CROCK is so isa fe ee ERR RR OR RASEN pe tr AEA CIA ate 36 6 2 HOW TO USE THE REFERENTIAL INTEGRITY ENGINE 36 Web Service Technical Manual 7 QUERY TOOL ENGINE 37 7 1 GINTERPAGE METHODS ener eo ever Potete cte toc overall 37 7 1 1 COUNTOUETY Aiea EE 7 1 2 38 3 2 STRUCTURES enne etn 39 7 2 1 Query EXPOS SION si uicti ett eet dee sea td 39 7 252 QUE TY EE 41 7 3 HOW TO USE THE QUERY TOOL ENGINE 41 8 INVENTORY ENGIN Y O 45 Seki INTEREACE METHODS 1 siepe er TOI E e ei eiu depo eer
5. DocumentReferencePKWs eris mm private String documenti ederencePK StringQueryField Fram Figure 0 9 Structure Query Result 7 3 How to use the Query Tool Engine The recommended approach for building query expression is to use the IUCLID 5 query tool on the IUCLID 5 client to create the query expression Then export the created query expression and translate the query expression to program for the Query Tool Engine web service This approach is recommended because the exact naming for indexed IUCLID 5 data fields and the rules applied when indexing IUCLID 5 data as well as data type information about the index entries are information only available to the query tool itself Exporting the queries and using the exported queries as input for implementation ensures that the correct naming is applied as the exported file contains the fieldnames and phrase information for units as well as string constants necessary for logical expressions and operators This section shows how to translate a query from an export file to program code accessing the web service Example a query that finds all substances in the raw data layer which contain a melting point of 100 C and a boiling point of 100 C 41 65 Numeric QueryField Web Service Technical Manual The exported query in XML format contained in a file with extension i5q looks like lt xml version 1 0 gt lt Created 2008 10 20 12 17 01 by Q
6. IUCLID 5 Guidance and Support Web Service Technical Manual for developers HTPUNATIDMAL CHEMICAL IMPORTA CUT prd May 2009 EH 9 Version 1 0 OECD IUCLID 5 has been developed by the European Commission in association with the OECD Web Service Technical Manual Table of contents T ANTRODUCTION Pct 1 le o TECHNOLOGY grann e e ewe eeeu bue ieluae ib Rea RS 1 12 SAMPLE PROGRAMS e NIS RENE EI Exe REED ERR 2 2 SESSION ENGINE 3 221 INTERFACE METHODS eere trennt rre RR EE Fee D mt Mare mte 3 2 1 1 4 2 1 2 TOS 6 Ser QUERY ENGINE semen 6 3 1 SHORT INTRODUCTION TO DATA MODEL 6 3 22 INTERFACE METHODS tice ote e d 9 3 2 1 getAllQueryNames i pP E 9 3 22 getAllQueryResultTypes 5i cce o e e EXER ee PRSE 11 3 2 3 getAllQueryDefiniloTis eie 11 3 2 4 getQueryDefinitionByName 12 3 2 5 12 3 2 6 getQueryDefinitionsByResultDocumentType 12 3 2 7 13 3 3 HOW TO USE THE QUERY ENGINE 14 4 DOCUMENT ACCESS ENGIN
7. 45 6 1 1 getLiteratureInventoryQuery i uice er e e Poe P e ehe death e 45 6 1 2 executeLiteratureInventory Query 47 8 1 3 putLiteratureInventoryEntry eet tei 47 8 1 4 putLiteratureInventoryEntries cet eee rege ren o ehe ee eg uua 46 6 1 5 deleteLiteratureInventoryEntry eee eee eee teet 46 8 1 6 delete Literature NventOryEN tries 48 9 MESSAGING DEEM I DANSE 49 91 INTERBACE METHODS 49 9 1 1 DrOAACAStSHOW DOCUMENL 49 10 REFERENCE TRACKER ENGINE ccssssscssssscccsssscccsssscccssssccccssseccsssscccsesssccsesscsccscssssccessessccssnaes 50 10 1 INTERFACE METHODS iieri ret re ERE ste GE Re rev ERR tr EE RN PARARE ER od 50 LOD queryInbo hd eR p ED ape enu 50 10 1 2 query Quibound s REA ene end 51 11 RESOURCE 6d fees ei feo ap oou Yo e eV YE Oa o e aUe UE 52 11 1 SHORT INTRODUCTION TO DATA 53 11 2 INTERFACE METHODS RET 54 LIZA lt getAvadilable Languages i ee ee die agree shag 54 122 Aa BA ah 55 12 CONTAINER ENGINE OR M 55 12 1 INTRODUGTION c o iei teet e eue deer tate bee reed equ 55 IDE BTREMEELOIIDOKISERERRESRE 56 12 1 2 Technical
8. A B TOT IDE JE JEN Encrypts the given password param decryptedPassword yi the password return encrypted Password il protected String encryptPassword final String decryptedPassword try Generates a java MessageDigest object that implements MD5 algorithm final MessageDigest md5 MessageDigest getInstance get the byte array of the password using UTF 8 encoding final byte pwdByte decryptedPassword getBytes UTF 8 create the MD5 for the given password byte array final byte md5Byte md5 digest pwdByte 4 65 Web Service Technical Manual compute the hex representation return encodeHex md5Byte catch final NoSuchAlgorithmException ex throw new RuntimeException ex catch final UnsupportedEncodingException e catch this one because it would be a developer s error in the hardcoded encoding string and should never happen throw new RuntimeException e Converts an array of bytes into an link String of characters representing the hexadecimal values of each byte order lt br gt The returned array will be double the length of the passed array as it takes two characters to represent any given byte Oparam hash Array of bytes to convert to hex string return Generated hex string public String encodeHex final byte hash get the current length final int currenLength hash length
9. The endpoint access engine commits changes to endpoint container and endpoint documents to the database 34 65 Web Service Technical Manual 6 Referential Integrity Engine The referential integrity engine is typically needed in an import scenario The referential integrity engine is then used as a last step after all documents have been created in the IUCLID 5 database and ensures that a set of documents is linked correctly Additionally it updates the dossier search index for finding dossiers through queries if dossiers are created handled The referential integrity engine executes the following checks Checks for endpoints endpoint records endpoint study records endpoint summaries o Check if ownerRef is resolvable If not delete the endpoint o Check if ownerRef points references a valid type substance mixture or template If not delete the endpoint o Check if the endpoint container that is referenced by the ownerRef references the endpoint Checks endpoint containers substance micture or templates if they correctly reference endpoints that reference the endpoint container through their ownerRef If not correct the ownerRef Update the dossier search index Check if attachments are correctly linked Delete orphaned attachments Check if annotations are correctly linked Delete orphaned attachments If the check fails the referential integrity engine corrects the detected problem
10. countQuery OUT The expected number of result items that will be found when the query expression specified will be executed r3 specified query expression can only contain simple query blocks and no logical operations 5 e QueryToolEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request e QueryToolEngineFault Is thrown if the Query Tool Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 37 65 Web Service Technical Manual 7 1 2 executeQuery Execute the given query expression which may contain simple blocks as well as block conjunction logic and return the found query result The open logged in session as tns session gt The query expression to execute as tns QueryExpression gt The query result which contains a list of query result items containing the lt tns documentReferencePK gt of indexed items parent documents dossiers etc as well as original values as stored in the query index and the query fields in the query expression that produced the result item DITS CTS ISI Exceptions QueryToolEngineNotAvailableFault 15 thrown when e g the back end service is not available to fulfil the request QueryToolEngineFault Is thrown if the Query Tool Engine is not able to fulfil your request This may happen if the Engine caught a back end Excep
11. tns queryDefinitionList of Query Definitions which defines the requested DocumentType tns documentType docType LegalEntity gt as result document Exceptions e QueryEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request e QueryEngineFault Is thrown if an internal error occurred 12 65 Web Service Technical Manual 3 2 7 executeQuery Purpose Execute the given query execution definition see Figure 0 3 Query Execution Definition Structure IN e open logged in session as lt tns Session gt The Query Execution Definition which defines o Query Name o Query Parameter List Query parameter name Query parameter value A list lt tns queryResultList gt of Document References containing Document Type Last Modification Date Unique Key Description Notes Exceptions QueryEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request QueryEngineFault Is thrown if an internal error occurred QueryDeliveredTooManyHitsException This indicates a recoverable error while executing a query E g this could be a too huge number of hits or errors resulting from other parameters the user was entered QueryTimeoutException The query reached its timeout limit before it completed Query timeouts are generally enforced to prevent long running query to completely stall the system This cannot fix the real culprit the sl
12. which could accomplish at the marked The two technologies SwA SOAP Messages with Attachments and DIME Direct Internet Message Encapsulation where developed by different industry consortia and are not compatible with each other If you are using the By value approach an ordinary XML Infoset is used which could be processed by a standard XML parser To satisfy the interoperability requirement of web services we used the by value approach to send the binary data The following XSD snipped illustrate this message definition lt xml version 1 0 encoding UTF 8 gt lt xsd schema xmins xsd http www w3 org 2001 XMLSchema xmins tns http echa europa eu schemas iuclid5 iswebservice types ore 1 INPUT gt lt xsd element namez uploadContainer lt xsd complexType gt lt xsd sequence gt g the sender session gt lt xsd element namez session type tns Session gt lt xsd element name i5zContainer typez tns ibzContainer lt xsd sequence gt lt xsd complexT ype gt lt xsd element gt lt OUTPUT gt lt xsd element namez uploadContainerResponse 57 65 Web Service Technical Manual lt xsd complexType gt lt xsd sequence gt lt xsd element namez resultReport typez tns resultReport lt xsd sequence gt lt xsd complexT ype gt lt xsd element gt IUCLID 5 external container gt lt xsd complexType name i5zContainer gt lt xsd sequence gt lt xsd element name
13. 5 queries which are accessible via the user interface 3 1 Short introduction to data model The query engine defines three important data structures e QueryDefinition A query definition contains the meta data for one specific IUCLID 5 query and defines o Resulting document type each query have only one define document type as result o Query Name the name ID to reference the query at the IUCLID 5 server o List of Query Parameter Definitions list of parameters which have an optional list of phrase values List Phrase Values 6 65 Web Service Technical Manual The following diagram illustrates this structure DocumentTypeWs From document Attributes private String docType Operations resultDocumentTyp Q QueryDefinition Attributes QueryParameterDefinition Attributes queryParameterDefinitionList 0 7 private String queryParameterName private String queryParameterDisplayType private String queryParameterDataType Operations lt queryName QueryName Attributes private String queryName Attributes private String phraselD private String phraseText private String additionalText Figure 0 2 Query Definition Structure Within the delivery you will find the document QueryDefinitions xls which contains list of available queries and query parameters The same list as XML would be returned by getAllQ
14. Endpoint Access Engine The Endpoint Access Engine offers convenient operations for endpoint endpoint record endpoint study record and endpoint summary handling Normally endpoint operations modify the endpoint document and the enclosing container template substance mixture The operations of the Endpoint Access Engine take care of all necessary steps when handling endpoints 5 1 Interface Methods This section describes the operations of the Endpoint Access Engine 5 1 1 createNewEndpoint Purpose Create a new endpoint of the given type and add the created endpoint to an endpoint container document substance mixture or template IN The open logged in session as tns session gt Endpoint container document substance mixture or template lt tns document gt The valid endpoint kind e g EC ABOVE GROUND TOX as string according to the IUCLID 5 format The name of the endpoint document as string The updated endpoint container document substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls To finalize the creation of the endpoint this document has to be committed The reference of created endpoint document as lt tns documentReference gt Prerequisites The endpoint container document substance mixture or template must be open for writing for the session that is used to create a new endpoint 5 EndpointAccessEngineNotAva
15. execution definition 4 Process the result list which contains the document reference 4 Document Access Engine All data object in the IUCLID database are uniquely identified by a pair of UUIDs which are known as DocumentReferencePK and DocumentReferencePKWs respectively If you know this key for a single data object you can e read get the document via the web service interface e delete drop the document via the web service interface It is also possible to write a document with a DocumentReferencePK into the IUCLID database e update overwrite a document in the IUCLID database if the UUID already exists e insert create a document in the IUCLID database if the UUID not yet already This service is very powerful as it exposes a very generic internal This internal is designed to manage all types of documents that pass through the system substances reference substances templates endpoints dossiers etc However with great power comes great responsibility Being a system no interactive safeguards like when importing an i5z archive is available Instead while the can take precautions it still has to allow operations that can cause data loss if applied carelessly This means also that it is very important for developers to be conversant with the official IUCLID 5 XML Format which could be downloaded from the official IUCLID 5 website see http iuclid eu index php fuseaction home format amp type p
16. generation method of these uniqueness properties over the whole data lifetime Therefore a legacy system can do something like myUUID UUID generateSpecial IUC4 i new String Company companyPIN or lt pre gt UUID myUUID UUID generateSpecial PRFX new String Substance substanceType substancelD uniquelDs array of uniqueness properties return a new generated UUID 5 public static UUID generateSpecial final Object uniquelDs final StringBuilder sb new StringBuilder for int i 0 i lt uniquelDs length i final Object obj uniquelDs i J sb append obj toString append final java util UID javaUUID java util UUID nameUUIDFromBytes sb toString getBytes Utils UTF8 final StringBuilder sb2 new StringBuilder sb2 append append javaUUID toString final eu iuclid UUID retUUID new eu iuclid UUID sb2 toString return retUUID Code 0 2 Create Special UUID 65 65 European Chemicals Agency IUCLID 5 Support Web Service Technical Manual May 2009 v 1 0 http iuclid eu
17. the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 30 65 Web Service Technical Manual 5 1 7 referenceEndpoint Purpose Reference the specified endpoint to the specified new owner substance mixture or template document by copying it and establishing a special local reference to the original filling in the origin attribute The open logged in session as tns session gt The endpoint container document substance mixture or template lt tns document gt The unique key of the endpoint to be referenced the source of the reference as lt tns documentReferencePK gt A note to be added to the origin reference The updated endpoint container document substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls The unique keys of the endpoint reference as tns documentReferencePK Prerequisites The endpoint container document substance mixture or template must be open for writing for the session The specified endpoint document to be referenced and all associated attachments must be readable Exceptions EndpointAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Acce
18. 32 65 Web Service Technical Manual 5 1 9 updateEndpoint Purpose Update the specified referencing endpoint document accordingly to the content of its original endpoint IN The open logged in session as tns session gt The endpoint container document substance mixture or template lt tns document gt The endpoint reference document to be updated as lt tns document gt The modified endpoint container document substance mixture or template as lt tns document gt The modified endpoint reference document as lt tns document gt Prerequisites The endpoint container document substance mixture or template must be open for writing for the session The specified endpoint documents to be updated must be open for writing for the session Exceptions EndpointAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 33 65 Web Service Technical Manual 5 1 10 detachEndpoint Purpose Detach the referencing endpoint from its original endpoint document The reference to the endpoint is also automatically updated and the endpoint container document substance mixture or template is modified After the operation two separated independent endpoints exist The open logged in session as tns sessi
19. Conditions 56 1253 Transferring Binary D ld iii deese e IRE tases ca FERE FEE 57 12 2 CONTAINER ENGINE s scccsccecssssssnccececsessnseaecececscssssaaecececsceesaaeaecececsessaaeaecececeessnaaaecececsensnaaaeeecees 58 12 2 1 Short Introduction to Data Model 58 12 2 2 Interface Methods ainean e RR RE RH n ERE 59 2 2 2 1 uploudContather eee eiie eee herbe 59 12 2 2 2 importExternalContainer iu sese tei bee ie I piri ne 59 12 2 2 3 60 12 3 ADDITIONAL CONFIGURATION 60 13 SOAP 1 1 61 14 e 62 14 1 DOCUMENT IDENTIFIERS DOCUMENTREFERENCEPKWNS 62 14 2 RANDOM UUIDS 2 ended GU d E E que 63 14 3 SPECIAL UTD dee 64 1 Introduction The web service standard is the industry s choice for interfacing a software product with external systems A web service provides platform neutral and language neutral interfaces that are self describing WSDL and leverage a variety of supporting tools This documentation gives you a detailed description of the available web service endpoints and how you have to use them and interact with your cli
20. D URN http www ietf org rfc ric4122 txt IUCLID 5 uses type 4 UUIDs pseudo randomly generated They convey no traceable information about who created the identifier Hence it is impossible to identify the original author of a document by reverse engineering the UUID The random UUIDs carry a prefix IUC5 serving as a namespace It separates the random UUIDs from special UUIDs The prefix does not and must not be used in any business logic It is purely abstract Pseudo code to generate a random UUID Factory method for new UUIDs return a new generated UUID 5j public static eu iuclid UUID generateNew final java util JUID javaUUID java util UUID randomUUID final StringBuilder sb new StringBuilder IUC5 sb append append javaUUID toString final eu iuclid UUID retUUID new eu iuclid UUID sb toString return retUUID Code 0 1 Generate New UUID 63 65 Web Service Technical Manual 14 3 Special UUIDs For special purposes like migration of data from previous IUCLID versions a mechanism was needed that conveys the uniqueness of the previous identifiers to the new IUCLID 5 system Moreover the uniqueness had to be enhanced from the local system to the global IUCLID data realm The resulting identifiers had to be deterministic and repeatable as multiple migration runs over the same data should not result in duplicates in IUCLID 5 documents with the same co
21. E e eeeee cesses essen tn sten 15 4 SHORT INTRODUCTION TO DATA 16 42 INTEREACEMETHODS tete e eiie ODER OU GIORNI RE ES 16 4 2 1 exists Document RE 16 4 2 2 determineDocumentTEype 5 2 OAS 17 4 2 3 17 ADA JetchDocument c E EOE 18 4 2 5 openDocumentForReading ttr RERO Ep 19 4 2 6 comp reDOocutenis sia EAR E RENS FERRO A REN RES EVEN SERE 20 4 2 7 openDocumentForWrillng ee beet trae et E EXER 2l 4 2 6 EE 22 4 2 9 deleteDocument cie ER RR TRE RU On RR RERO 23 4 2 10 CredteDOoCumetit siae RENE PARERE PRETERITO NEA UNE 24 4 3 HOW TO USE THE DOCUMENT ACCESS 25 5 ENDPOINT ACCESS ENGINE 26 Dili INTERFACE METHODS 3135 iet hne remp EAR AREE peres 26 5 1 1 createNewEndpoiht e oae are ese peii Ye De ERU E Eee T 26 5 1 2 createNewEndpointSummary 27 5 1 3 0 EE 26 5 1 4 via sas ean badass soy 29 5 1 5 deleteEndpoint
22. The unique key of the endpoint to be deleted as lt tns documentReferencePK gt e The updated endpoint container document Substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls Prerequisites e The endpoint container document substance mixture or template must be open for writing for the session 5 e EndpointAccessEngineNotAvailableFault 15 thrown when e g the back end service is available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 5 1 6 deleteEndpoints Purpose Delete a multiple endpoint from persistence The reference to the endpoint is also automatically removed from its parent document substance mixture or template e The open logged in session as tns session gt e The endpoint container document substance mixture or template lt tns document gt e The unique keys of the endpoints to be deleted as lt tns documentReferencePK gt e updated endpoint container document substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls Prerequisites e The endpoint container document substance mixture or template must be open for writing for the session Exceptions e EndpointAccessEngineNotAvailableFault Is thrown when e g
23. arameter as list of lt tns documentReference gt 5 ReferenceTrackerEngineNotAvailableFault thrown when e g the service is not available to fulfil the request ReferenceTrackerEngineFault thrown if the Service is not able to fulfil your request This may happen if the Engine caught a back end Exception 50 65 Web Service Technical Manual 10 1 2 queryOutbound This operation answers all references from the given document reference to other document The open logged in session as tns session gt The unique keys of document for which to query the outbound references as tns documentReferencePK Purpose IN parameter as list of lt tns documentReference gt 5 ReferenceTrackerEngineNotAvailableFault thrown when e g the service is not available to fulfil the request ReferenceTrackerEngineFault thrown if the Service is not able to fulfil your request This may happen if the Engine caught a back end Exception A list of all documents that are referenced by the document given in the IN 51 65 Web Service Technical Manual 11 Resource Engine IUCLID 5 defines several server based resource files e g phrases xml which depends on the installed server version of IUCLID 5 One example for such a resource is the file phrase xml which contains the language depending text for the so called Pick List values see Figure 0 10 Country Phrase List A Web Service Clie
24. at this might be lt tomcat install dir gt work Catalina localhost ibwsruntime containerEngine externalUpload Set to true if the web service should delete the uploaded external file after it was processed If container engine clean external upload dir value is false each uploaded file would remain at the file system Default value is true Table 0 15 Additional Configuration 60 65 Web Service Technical Manual 13 SOAP 1 1 Binding The IUCLID 5 Web Service using WSDL 1 1 to describe the interface and SOAP 1 2 released in June 2003 as message format There are some frameworks which are used by the industry that do not support SOAP 1 2 In addition a binding for SOAP 1 1 is available Nevertheless the default binding is SOAP 1 2 and if someone would like to use SOAP 1 1 he has to download the WSDL files separately The SOAP 1 1 files are also part of the IUCLID 5 Web Service Runtime application They can be accessed via the web interface by using the corresponding link see Figure 0 1 IUCLID 5 Web Service Start Page Software Foundation http www apache org Welcome Welcome to the new generation of Axis If you can see this page you have successfully deployed the Axis2 Web Applic working we encourage you to click on the validate link e Services View the list of all the available services deployed in this server e Validate Check the system to see whether all the required libraries are in place and
25. automatically 35 65 Web Service Technical Manual 6 1 Interface Methods This section describes the operations of the Referential Integrity Engine 6 1 1 check Purpose Check the referential integrity of the given documents IN e The open logged in session as tns session gt e A list of items to include in the referential integrity check The items contain The unique keys of the documents to check as tns documentReferencePK gt and the type of the documents to check as lt tns documentType gt Ji No document contained in the list of items to check must be locked by the web service during the operation All documents to be checked have to be closed All locking and modification operations are completely handled by the server 5 ReferentiallntegrityEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request ReferentiallntegrityEngineFault Is thrown if Referential Integrity Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 6 2 Howto use the Referential Integrity Engine The purpose of the referential integrity engine is to provide operations to be used in a typical import scenario where it might be necessary to do some corrective actions after the imported documents have been created in the database It ensures that orphaned links between documents are handled correctly and that the linkage between d
26. ce type LegalEntity gt lt tns content gt lt i5 LegalEntity lt tns content gt lt tns document gt Exceptions DocumentAccessEngineNotAvailableFault Is thrown when e g the service is not available to fulfil the request DocumentAccessEngineFault Is thrown if Document Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found DocumentAccessFault 5 a tagged exception used to tell the caller that the desired access to a document is prohibited due to sharing restriction 19 65 Web Service Technical Manual 4 2 6 compareDocuments Purpose Compare the specified remote Document to the local server content As result you will get a simple notification which declares the state OUT 5 INDETERMINATE The comparison status has not yet been determined NOTFOUND The remote document does not have a local counterpart with the same identifier IDENTICAL The documents are absolutely identical OLDER The documents are unequal the remote document is older than the local document NEWER The documents are unequal the remote document is newer than the local document CONFLICT The documents are unequal although the last modification are identical filtered documents LOCKED The documents could not be compared because
27. cument Reference PK tns documentReferencePK uniqueKey UUID SnapshotUUID gt The Web service document lt tns document gt contains o The Document Reference o ThelUCLID 5 document content lt tns document gt lt tns documentReference type LegalEntity gt lt tns content gt lt i5 LegalEntity lt tns content gt lt tns document gt Exceptions DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request DocumentAccessEngineFault Is thrown if Document Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found DocumentAccessFault 5 a tagged exception used to tell the caller that the desired access to document is prohibited due to sharing restriction 18 65 Web Service Technical Manual 4 2 5 openDocumentForReading Purpose Open a document for read only access and acquiring the read lock at the server The read lock would be present until you call closeDocument see 4 2 3 The open logged in session as lt tns Session gt The Document Reference PK tns documentReferencePK uniqueKey UUID SnapshotUUID gt The Web service document lt tns document gt contains o The Document Reference o ThelUCLID 5 document content lt tns document gt lt tns documentReferen
28. e query block SimpleEndpointQueryBlock or SimpleQueryBlock depends on the information that is searched and where this information is stored SimpleEndpointQueryBlock search in endpoint records endpoint study records and endpoint summaries SimpleQueryBlock search in substances mixtures templates The simple query blocks also specify which type of index items they are scanning by specifying the document type This allows e g to build SimpleEndpointQueryBlock queries that only search for endpoint summaries Please note that string query values might specify special query expression values in the exported XML that have first to be translated in multiple query values Additionally wildcard translation has to be done string id S01 01 0100 R00 00 0120 3 fieldname referenceSubstanceRef ecSubstancelnventoryEntryRef casNumber gt value operator LIKE expression 2 3 gt lt string gt XML file 0 4 Special String Query Expressions The expression 2 3 translates into a StringQueryField that has two StringQueryValue items The first StringQueryValue is specifying 2 wildcard translated to database wildcard as search expression whereas the second StringQueryValue is specifying 3 as search expression 44 65 Web Service Technical Manual 8 Inventory Engine The inventory engine enables you to read write update and create Literature Inventory Entries 8 1 Interface Methods This section de
29. ecified by the given UniqueKey Note Uncommitted changes will be lost from the server side point of view The open logged in session as lt tns Session gt The Document Reference PK tns documentReferencePK uniqueKey UUID SnapshotUUID gt Boolean direct Boolean xml binding lt tns success gt true lt tns success gt o True to explicitly notify that everything was OK otherwise will throw a detailed exception Exceptions DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found DocumentAccessFault 5 a tagged exception used to tell the caller that the desired access to a document is prohibited due to sharing restriction 17 65 Web Service Technical Manual 4 2 4 fetchDocument Purpose Fetch a document without setting any access locks This means that no lock would be created on the server side Obviously this might return the same result as 4 2 5 openDocumentForReading but fetchDocument will close the document immediately and the web service customer does not have to do this If you are using openDocumentForReading you have to call closeDocument after you have finished your process The structure of the XML document fits to the official public export format of the IUCLID 5 System The open logged in session as lt tns Session gt The Do
30. ell the caller that the desired creation process of a document had an error DocumentAccessFault 5 a tagged exception used to tell the caller that the desired access to a document is prohibited due to sharing restriction 24 65 Web Service Technical Manual 4 3 Howto use the Document Access Engine The following UML Sequence Diagram demonstrates one possible usage case scenario WebServiceClient DocumentAccessEngine createVl ebSerriceSession Session DocumentTypewWs validateSession Session The returned document has a apen write 10 affer successtul called fis method addDocumentValues Documents ee a SS Boolean commitDocument Session Documents validateSession Session closeBackendSession Session Figure 0 7 Create and Commit New Document 1 Obtain a web service session and authenticate with an existing IUCLID 5 user account 2 Call the Document Access Engine to create the Document As result you will get an empty document structure for the requested document type 3 This document has already a read write lock so you can exclusively change the content 4 Commit the document so your changes will be come persistent Note after committing a document no lock will be released 25 65 Web Service Technical Manual 5 Close the document to release all held locks 6 Call logout to close the back end connection 5
31. ent application This document does not explain the web service technology or other technical topics It covers the usage of the IUCLID 5 web service interface and the dependencies between its different endpoints In addition to this manual a detailed understanding of the web service technology is needed IUCLID 5 is a complex Software System which is used to store and manage a large number of chemical data based on the OECD Harmonised Templates structure A web service interface cannot reduce the complexity of the software 1 1 Technology To implement the IUCLID 5 web service interface the AXIS2 web service framework was used which can be downloaded from the AXIS2 project website http ws apache org axis2 The used SOAP version is 1 2 and the WSDL are defined by using the version 1 1 During the development phase it was realised that the tool support for WSDL 2 0 was not as good as initially expected which caused many problems in generating stable web service stubs 1 65 Web Service Technical Manual 1 2 Sample Programs For each web service endpoint you will find one sample program which should be used as reference implementation They are included under Sample Programs in the Web Service installation package and implemented as JUnit test cases Web Service Sample Program point Session Engine eu eca iuclid webservice service sessionengine SessionEngineTest Query Engine eu eca iuclid webservice service queryen
32. est ContainerEngineFault Is thrown if Container Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception IllegalContentTypeFault This exception is thrown if the received container content type application zip is not allowed ContainerContentFault This exception is thrown if the processing of an import container fails 12 2 22 importExternalContainer Purpose Call the web service to import an external uploaded i5z container The client has to upload the external container file by himself e g via ftp After the web service is called to importExternalContainer it scans the external upload directory for the specified file name lt tns importContainerlnformation The open logged in session as lt tns Session gt The import container information containing the filename lt tns importContainerlnformation tns fileName String gt The import result report tns resultReport tns resultFlag SUCCESS gt 5 ContainerEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request ContainerEngineFault Is thrown if Container Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception IllegalContentTypeFault This exception is thrown if the received container content type application zip is not allowed ContainerContentFault This exception is thrown if the processing o
33. f an import container fails 59 65 Web Service Technical Manual 12 2 2 3 downloadContainer IN The open logged in session as lt tns Session gt The download container information containing document reference pk oft he requested document tns downloadContainerlnformation tns uniqueKey 0 0 0 0 0 0 gt The download container lt tns downloadContainer gt wich contains the i5z container lt tns iszContainer gt the export resutl report tns resultReport Exceptions ContainerEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request ContainerEngineFault 15 thrown if Container Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception ExportDocumentFault This exception is thrown if the processing of an export container fails OutOfDiskSpaceFault This exception is thrown if the export cache has not enough disk space to write the export container 12 3 Additional configuration The following table shows the IUCLID 5 web service configuration options For more information on how to change the web service configuration please refer to chapter 1 5 Advanced Deployment of the Web Service Installation documentation Configuration Key Description The external upload directory Default settings lt java io tmpdir gt containerEngine externalUpload container engine external upload directory For apache tomc
34. gine QueryEngineTest Document eu eca iuclid webservice service documentaccessengine Access Engine DocumentAccessEngineTest Endpoint Access eu eca iuclid webservice service endpointaccessengine Engine EndpointAccessEngineTest Inventory Engine eu eca iuclid webservice service inventoryengine InventoryEngineTest ERR ical eu eca iuclid webservice service querytoolengine Query ToolEngineTest ET ue eu eca iuclid webservice service messagingengine MessagingEngineTest Container Engine eu eca iuclid webservice service containerengine ContainerEngineTest Table 0 1 List of Sample Programs 2 65 Web Service Technical Manual 2 Session Engine 2 1 Interface Methods The session engine service is used to handle the user authentication and session management Some web service interactions require the saving of the client state For instance if you want to change an existing substance you have to obtain a read write lock at the IUCLID 5 server These session states are managed by the Session Engine This means that a web service interaction always starts with a SessionEngine login and ends with a SessionEngine logout WebServiceClient lt Arbitary WebService gt IUCLID 5 I5Session authenticate UsernamePassword Session login Credentials invokeBackend Parameters processResult 2 7 closeBackengdSession Figure 0 1 General Web Service Interaction 3 65 Web Service Technica
35. gt The Web service document lt tns document gt contains o The Document Reference o ThelUCLID 5 document content lt tns document gt lt tns documentReference type LegalEntity gt lt tns content gt lt i5 LegalEntity lt tns content gt lt tns document gt 5 DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request DocumentAccessEngineFault Is thrown if Document Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found DocumentAccessFault 5 a tagged exception used to tell the caller that the desired access to a document is prohibited due to sharing restriction 21 65 Web Service Technical Manual 4 2 8 commitDocument Purpose Commit the specified document to the IUCLID 5 Server The requestor must have the exclusive write lock on the Document which could be obtained via open the document for writing see 4 2 7 openDocumentForWriting Note the lock state will not be modified by this call The document remains open after the operation If you like to release the write lock you have to call closeDocument The open logged in session as lt tns Session gt The Web service document lt tns document gt o ThelUCLID 5 document content lt tns docu
36. h included document separately As you commit each single document you have to take care of the whole procedure and it is necessary to log each committed document If one commit fails you have to do the rollback via the web service by yourself An additional Web Service has been provided as API for developers to import such i5z Container using one single call The problems like the logging of each containing document are still the same but each operation is performed at the server side and not at the client side 55 65 Web Service Technical Manual 12 1 1 Limitations The transactional dossier upload is subject to some restrictions Asynchronously post status information back to the caller e g no progress bar on the status of a single import operation can be displayer it is all or nothing No filtering or processing steps during import that modify the inbound data The upload service only guarantee the complete import of a new i5z dataset no update guarantee could be foreseen The IUCLID 5 server as it is implemented know do not support transactional operations across multiple documents Each document e g one Substance Template or Endpoint Study Record is treated as a separate object If you save one of these objects only one transaction is created for it If you save the next linked document you will execute this within a new transaction As IUCLID 5 does not support the transactions across multiple documents we ca
37. he web service respectively the used web service framework According the expected size it may take a long time to perform the import therefore the timeout value of a web service client has to the increased 56 65 Web Service Technical Manual 12 1 3 Transferring Binary Data The IUCLID 5 export container is an ordinary ZIP Container therefore the API has to provide messages that accept binary data via SOAP A SOAP message contains an XML document definition that can be used to exchange structured and typed information between peers in a decentralized distributed environment As described above we need to send binary data to the Web Service but XML may contain only printable characters In general there are two ways of embedding binary data into an SOAP message e value the binary data are converted into a textual representation e g Base64 Encoding and than added to the content of an xml element or attribute e reference instead of converting the binary data into a different format this approach add the data as additional content besides the SOAP message Within the SOAP Part of the message you will find an URI Reference that points the added Attachment Part SwA MIME or DIME are known techniques which are using this approach The second approach might be the right choice if you emphasise on performance because you do not have to convert the binary data But for this approach there is no exiting technology
38. iers to objects in the database must not be unique to the local system only but they have to be universally unique Because the identifier travels unchanged with the document through all the data interchange channels it must remain unique in whatever location the document gets stored For instance when a joint submission consortium shares data the documents in each member s local database share the same identifiers A great benefit of this approach is the possibility of distributed version tracking 62 65 Web Service Technical Manual Schema prefix UUID prefix UUID e first prefix UUID identifies the current document e The second prefix UUID is either 0 or the so called Dossier Snapshot Key that groups together all documents included in a certain dossier e The prefix is a four letter acronym Prefixes in use are for example IUC4 and IUC5 However the prefixes are not supposed to have any behavioural consequences they are completely abstract identifiers Example document identifier Raw data IUC5 98c376e7 a74c 4913 b818 16ccda4d3344d 0 e Dossier data IUC5 98c376e7 a74c 4913 b818 16ccda4d334d IUC5 12345678 abcd 1234 abcd 1 12233445566 14 2 Random UUIDs The standard document identifiers are built from random UUIDs A UUID is an abstract value with the purpose of being universally unique More technical background information is available at RFC 4122 Universally Unique Identifier UUI
39. ilableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 26 65 Web Service Technical Manual 5 1 2 createNewEndpointSummary Purpose Create a new endpoint summary of the given type and add the created endpoint summary to an endpoint container document substance mixture or template The open logged in session as tns session gt Endpoint container document substance mixture or template lt tns document gt The valid endpoint summary kind e g EC_ABOVE_GROUND_TOX as string according to the IUCLID 5 format The name of the endpoint summary document as string The updated endpoint container document substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls To finalise the creation of the endpoint summary this document has to be committed The reference of the created endpoint summary document as lt tns documentReference gt Prerequisites The endpoint container document substance mixture or template must be open for writing for the session that is used to create a new endpoint 5 EndpointAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoi
40. ion combine query blocks final LogicalExpressionQueryBlock logicBlock new LogicalExpressionQueryBlock expression setQueryBlock logicBlock 42 65 Web Service Technical Manual fill query blocks index types and parent types final ArrayList lt DocumentTypeWs gt indexTypes new ArrayList lt DocumentTypeWs gt indexTypes add new DocumentTypeWs EndpointStudyRecord final DocumentTypeWs parentType new DocumentTypeWs Substance melting point meltingQueryBlock setIndexTypes indexTypes meltingQueryBlock setParentType parentT ype meltingQF setID melting meltingQV setOp ONLY_EXACT_MATCH inal UnitValue meltingUnit new UnitValue meltingUnit setPhraseGroupld A102 meltingUnit setPhraseld 2493 meltingQV setUnit meltingUnit meltingValues add meltingQV meltingQF setValues meltingValues meltingQueryFields add meltingQF boiling point boilingQueryBlock setIndexTypes indexTypes boilingQueryBlock setParentType parentType boilingQF setID boiling boilingQV setOp ONLY EXACT MATCH inal UnitValue boilingUnit new UnitValue boilingUnit setPhraseGroupld A102 boilingUnit setPhraseld 2493 boilingQV setUnit boilingUnit boilingValues add boilingQV boilingQF setValues boilingValues boilingQueryFields add boilingQF Code 0 3 Query as Pseudo Code 43 65 Web Service Technical Manual The type of the simpl
41. ion 54 65 Web Service Technical Manual 11 2 2 getResource Purpose This operation returns the requested IUCLID 5 resource as SOAP content IN e The open logged in session as tns session gt e The requested resource definition as lt tns resourceDefinition gt which contains o resource id o Optional language if null or empty the web service using the default language associated which the specified user session OUT e requested resource as lt tns i5resource gt this response is similar to 4 2 4 fetchDocument Exceptions e ResourceEngineNotAvailableFault thrown when e g the service is not available to fulfil the request ResourceEngineFault thrown if the Service is not able to fulfil your request This may happen if the Engine caught a back end Exception 12 Container engine 12 1 Introduction The current IUCLID 5 Web Service Interface is very powerful as it exposes a very generic set of internal API This internal API is designed to manage and query all types of documents that pass through the system substances reference substances templates endpoints dossiers etc The Document Access Engine is responsible to save the documents at the IUCLID 5 server Therefore it receives the content as XML validate it against its official format and then commit it against the server If you want to implement a dossier import you have to extract the container document and call the commit message for eac
42. isplay as string STRING referenceReportDate display as date range STRING remarks display as string STRING Table 0 13 Query Literature Inventory Parameters The next following table shows the phrase values for Phrase Group ID Z31 phraselD phraseText NOT_SPECIFIED 1586 study report en_GB 266 company data en_GB 1443 publication en_GB 1486 review article or handbook en_GB 1542 secondary source en_GB 811 grey literature en_GB 1342 other en_GB Table 0 14 Query Literature Inventory Phrase Values 46 65 Web Service Technical Manual 8 1 2 executeLiteraturelnventoryQuery Purpose Execute the given literature inventory query see Figure 0 3 Query Execution Definition Structure IN e open logged in session as lt tns Session gt e The Query Execution Definition which defines o Query Name o Query Parameter List Query parameter name Query parameter value A list lt tns queryResultList gt of Document References containing o Document Type Last Modification Date Unique Key Description Notes 5 InventoryEngineNotAvailableFault Is thrown when e g the service is not available to fulfil the request InventoryEngineFault 15 thrown if Inventory Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 8 1 3 putLiteraturelnventoryEntry Purpose Stores the given literature inventory entry IN e The open l
43. ission find complex substance by impurity find complex substance by referencesubstance find complex substance by substancecomposition constituent Table 0 3 Substance Query IDs e Mixture find all mixtures find complex mixtures constituent find complex mixtures by impurity find complex mixtures by related substance Table 0 4 Mixture Query IDs Site find all sites find complex site Table 0 5 Site Query IDs 9 65 Web Service Technical Manual e Category find all categories find complex categories by legalentity Table 0 6 Category Query IDs e Template find all templates find complex template Table 0 7 Template Query IDs e Reference Substance find all referencesubstances find complex referencesubstance Table 0 8 Reference Substance Query IDs e Legal Entity find_all_legalentities find_complex_legalentity Table 0 9 Legal Entity Query IDs e Unknown find_complex_document_by_uuid Table 0 10 Unknown Document Type Query IDs e Dossier find all dossiers find dossier by legal entity find dossier by substance find dossier by constituents find dossier by additive zh find dossier by classification and labelling Table 0 11 Dossier Query IDs 10 65 Web Service Technical Manual 3 2 2 getAllQueryResultTypes Purpose Returns a list of available and supported Document Result Types IUCLID 5 defines several document types e g Substance Category Mixture see http
44. iuclid eu index php fuseactionzhome format amp type public Each IUCLID 5 Query defines one Document Result Type e The open logged in session as lt tns Session gt e List lt tns queryResultTypeList gt of avalable document types e g lt tns documentType docType Substance gt 5 e QueryEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request e QueryEngineFault Is thrown for all occurred exception during the web service call The following table shows the available query result types Template ReferenceSubstance LegalEntity Table 0 12 Query Result Types 3 2 3 getAllQueryDefinitions Purpose Returns all available Query Definitions this call might take some time A Query Definition contains the meta data of an IUCLID 5 query like name Document Result Type and the list of Query Parameter Definitions A Query Parameter Definition contains the name of the query parameter the data type the display type the IUCLID 5 phrase group id and the corresponding list of phrases The open logged in session as lt tns Session gt A List lt tns queryDefinitionList gt of all available query definitions Exceptions QueryEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request QueryEngineFault Is thrown if an internal error occurred 11 65 Web Service Technical Manual 3 2 4 getQueryDefi
45. l Manual The web service session has a time out period If a session has not been used for the specified time the user will be logged out automatically In that case each non committed change will be lost The default time out period is 7 200 seconds 22 hours 2 1 1 Login Purpose Obtain a web service session and login at the back end system IN e The users credential as lt tns Credentials gt contains existing username password The password has to be sent as MD5 hash which was converted to its hex representation e new created Session contains the session token lt tns Session gt Prerequisites You have an existing user at the connected IUCLID 5 server 5 SessionEngineNotAvailableFault Is thrown when the back end service is not available to fulfil the request SessionEngineFault Is thrown for all occurred exception during the web service call It is prohibited to send a password as clear text IUCLID 5 will not accept it The password has to be sent as MD5 hash which was converted to its hex representation The following code snipped shows one way of how to create such a hashed password The Apache codec library was also tried which created the correct password hash except that the letters were lower case and IUCLID requires an upper case style p Used building output as Hex private static final char DIGITS 0 1 2 3 4 5 6 7 8 9
46. lease refer to the official IUCLID 5 web side for more information about released languages 53 65 Web Service Technical Manual The following diagram illustrates this structure Language Attributes LanguageList languageList private String language Attributes private String country private ArrayList langList private String variant language EjResourceDefinition rssourcepefinitio Ej luclid5Resource Attributes Attributes private String resourcelD lt private String content package Language lang private ResourceDefinition i resoureceDefinition Figure 0 11 Structure of the Resource Engine Object 11 2 Interface Methods This section describes the operations of the Reference Tracker Engine The Reference Tracker Engine can be used to get the inbound and outbound references of a IUCLID 5 document 11 2 1 getAvailableLanguages Purpose This operation returns a list of available languages The languages are installed by using the resource plug ins at the IUCLID 5 server IN The open logged in session as tns session gt e A list of all available languages lt tns languageList gt 5 e ResourceEngineNotAvailableFault thrown when e g the service is not available to fulfil the request ResourceEngineFault thrown if the Service is not able to fulfil your request This may happen if the Engine caught a back end Except
47. ment gt lt tns content gt lt i5 LegalEntity lt tns content gt lt tns document gt Boolean direct Boolean xml binding True to explicitly notify that everything was OK otherwise will throw a detailed exception lt tns success gt true lt tns success gt Exceptions DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request DocumentAccessEngineFault Is thrown if Document Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found DocumentAccessFault Is a tagged exception used to tell the caller that the desired access to a document is prohibited due to sharing restriction 22 65 Web Service Technical Manual 4 2 9 deleteDocument Purpose Delete the document referenced by the specified document reference Note the server call can only be successful if no lock remains on the requested document Therefore no such lock can be present in the local handle table if the server call succeeds and this manager works correctly 5 The open logged session as lt tns Session gt The Document Reference PK tns documentReferencePK uniqueKey UUID SnapshotUUID gt Boolean direct Boolean xml binding lt tns success gt true lt tns success gt o True to explicitl
48. mentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request e DocumentAccessEngineFault Is thrown if Document Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception e DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found e DocumentAccessFault 5 a tagged exception used to tell the caller that the desired access to document is prohibited due to sharing restriction 16 65 Web Service Technical Manual 4 2 2 determineDocumentType Purpose Return the Type of the associated document by its UniqueKey IN e open logged in session as lt tns Session gt e The Document Reference PK tns documentReferencePK uniqueKey UUID SnapshotUUID gt e The document type of the given DocumentReferencePK lt tns documentType type LegalEntity gt Exceptions e DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request e DocumentAccessEngineFault Is thrown if Document Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception e DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found 4 2 3 closeDocument Purpose Release the reader or writer lock of the current session on document the sp
49. nitionByName Purpose Return the specified Query Definitions by its name IN The open logged in session as lt tns Session gt The requested query name lt tns queryName id find_all_legalentities gt The found query Query Definition see Figure 0 2 Query Definition Structure lt tns queryDefinition gt Exceptions QueryEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request QueryEngineFault Is thrown if an internal error occurred 3 2 5 getQueryDefinitionsByName Purpose Return the requested list of Query Definitions by the requested list of query If you need to load more than one query definition which has different Document Result Type you could use this method It takes a list of Query Names and return the corresponding List of Query Definitions e The open logged in session as lt tns Session gt Alist lt tns queryNameList gt of query names e Alist lt tns queryDefinitionList gt of Query Definitions Exceptions QueryEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request e QueryEngineFault Is thrown if an internal error occurred 3 2 6 getQueryDefinitionsByResultDocumentType Purpose Returns all Query Definitions which fit to the given Document Result Type IN The open logged in session as lt tns Session gt The requested DocumentTypeWs lt tns documentType docType LegalEntity A list
50. nnot perform a transactional update for ibz container Dossiers are always a closed collection of documents Every document can be identified by the dossier UUID If a dossier already exists in the system the import will be rejected If a problem occurs during the import of a dossier all documents which have been imported up to this time will be removed by the Web Service So the integrity on dossier data can be fully ensured On importing raw data it will be more complex Before the import starts it will be verified if the 154 file contains any substance category mixture or template that is already in the database In this case the import will be fully rejected The import Web Service for raw data will only add additional documents No documents will be overwritten e g Reference Substance Legal Entity If a problem occurs during the import of a raw data all already imported documents will be removed by the web service So the integrity on raw data can be fully ensured EC Substance Inventory ibi is not supported 12 1 2 Technical Conditions The maximum size of a SOAP attachment dossier ibz files can grow very large In general 152 files do not exceed 20MB but exceptions are expected Due to their internal structure standard ZIP format and the expected size they need to be stored to the local file system in order to be decompressed Where and how temporary ibz files are stored is an encapsulated implementation detail of t
51. nt Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 27 65 Web Service Technical Manual 5 1 3 copyEndpoint Purpose Copies an endpoint from one endpoint container document substance mixture or template to another endpoint container document IN The open logged in session as lt tns session gt The target endpoint container document substance mixture or template as lt tns document gt The unique key of the source endpoint as lt tns documentReferencePK gt The updated endpoint container document substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls To finalize the copying of the endpoint this document has to be committed The reference of the copied endpoint document as lt tns documentReference gt Prerequisites The target endpoint container document substance mixture or template must be open for writing for the session that is used to copy an endpoint 5 EndpointAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 28 65 Web Service Technical Manual 5 1 4 copyEndpoints Purpose Copies multiple endpoints from one endpoint container document subs
52. nt also needs the information of the phrase xml because the official xml export format only contains the PhraselD The Web Service Client developer has to create his own Phrase Manager in order to get the language depending text of the PhraselD The interface allows Web Service clients to access the phrases xml via the Web Service and in that case they always getting the correct phrases xml file of the current IUCLID 5 server Otherwise they have to manually download the file from the IUCLID web side to getting the phrase content File Edit Go Window Help Plugins 2 als Query results Generalinformation Identifiers Contact information 51185 Query Contact address z Address flags P dt ADBAC Quat Joint Venture Chemical Spec Address b Pick list Akzo Nobel Salt and Basic Chemical Divisiq Address Select a Country 38 All companies listed under Section 1 0 1 Postal code 51368 Association of Synthetic Amorphous Silica Atofina Paris La D fense Cedex France Town Leverkusen 4H BASF AG Ludwigshafen Germany 8 Bayer AG Leverkusen Germany BUA TU M nchen Freising Germany Country 48 Spezialit tenchemie GmbH Lampert Phone Region State JH Ciba Spezialitotenchemie GmbH Lampert Fax 48 Clariant Service GmbH Sulzbach am Taur
53. ntent but different identifiers Please note that generating special UUIDs comes with the responsibility to seamlessly interact with the existing mechanisms and systems Appropriate quality assurance and testing is obligatory and the IMG IUCLID Management Group at the European Chemicals Agency should be contacted The chosen approach for these special UUIDs is as follows e Collect those identifiers from the legacy system that can be used to uniquely identify the concerned object in a global scope E g the IUCLID 5 Migration Tool uses the IUCLID 4 Company PIN to generate the identifier for a migrated legal entity object Further immutable properties could also have been considered like the company s central telephone number VAT DUNS number the company s name etc e Optionally chose a different 4 letter prefix namespace than 0 5 Please note that there is no managing body that controls or assigns prefixes Collisions same prefix used by more than once cannot be prevented This does not harm as the prefixes must not be used in any business logic e Generate the document identifier 64 65 Web Service Technical Manual Pseudo code to generate a special UUID Factory method for new special UUIDs from IUCLIDA etc The method will concatenate string representations of all uniqueness properties and calculate hashcode MD5 SHA1 etc from this long string Callers of this method MUST commit to the same
54. ocuments especially endpoints and their containers is valid The referential integrity engine is used for maintaining referential integrity across document boundaries e g if a company is deleted also its associated sites have to be deleted also The referential integrity engine must always be called after the web service has committed the contents of an IUCLID 5 i5z file as documents to the IUCLID 5 database i e if the web service client is implementing an import operation 36 65 Web Service Technical Manual 7 Query Tool Engine Please note that the web service interface for the Query Tool Engine will only work when the IUCLID 5 Query Tool server side plug in is installed on the IUCLID 5 distributed version server Otherwise the interface methods of the Query Tool Engine will abort with an exception 7 1 Interface Methods This section describes the operations of the Query Tool Engine 7 1 1 countQuery Purpose Count the number of result items that are produced when the specified query expression is executed Note that counting does not support the block combination logic so only simple query blocks can be contained in the query expression to be counted e The open logged in session as tns session gt e The query expression to count as tns QueryExpression gt Note that a query expression specified can only contain simple query blocks Logical operations that are combining query blocks are not supported by
55. ogged in session as lt tns Session gt e Literature Inventory Entry as lt tns literaturelnventoryEntry gt e Boolean direct Boolean xml binding True to explicitly notify that everything was OK Exceptions e InventoryEngineNotAvailableFault Is thrown when e g the service is not available to fulfil the request e InventoryEngineFault 15 thrown if Inventory Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 47 65 Web Service Technical Manual 8 1 4 putLiteraturelnventoryEntries Purpose Stores the given list of inventory entries This could be used as bulk upload IN e open logged in session as lt tns Session gt e List of Literature Inventory Entries as lt tns literaturelnventoryList gt e Boolean direct Boolean xml binding True to explicitly notify that everything was OK Exceptions InventoryEngineNotAvailableFault Is thrown when e g the service is not available to fulfil the request InventoryEngineFault Is thrown if Inventory Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 8 1 5 deleteLiteraturelnventoryEntry Purpose Deletes the given literature inventory entry IN e The open logged in session as lt tns Session gt e Literature Inventory Entry to delete as lt tns literaturelnventoryEntry gt e Boolean direct Boolean xml binding True to explicitly notify that everything was OK
56. on gt The endpoint container document substance mixture or template lt tns document gt The endpoint reference document to be detached as lt tns document gt The modified endpoint container document substance mixture or template as lt tns document gt The modified endpoint reference document as lt tns document gt Prerequisites The endpoint container document substance mixture or template must be open for writing for the session The specified endpoint documents to be updated must be open for writing for the session 5 EndpointAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 5 2 Howto use the Endpoint Access Engine The purpose of the endpoint access engine is to provide convenient operations for endpoint handling The operations of the endpoint access engine typically modify the endpoint container document substance mixture or template and one or more endpoint documents or the references of the endpoint documents It is important to use the references and documents returned in the results of these operations to ensure that the IUCLID 5 database stays in a consistent state Always make sure to update your endpoint container documents and endpoint documents from the results
57. ow query but is kind of a parachute to keep the system operational MissingQueryParameterException This exception is thrown if the list of parameters does not fit the recommended list from the QueryParameterDefinition You do not have to fill in all defined parameters but you should never put an undefined parameter into the list 13 65 Web Service Technical Manual 3 3 How to use the Query Engine The following UML Sequence Diagram demonstrates one possible usage of the Query Engine WebServiceClient Session createWebSericeSessionO validateSession Session M QueryDefinition createQueryDefinition Query QueryResult executeQuent closeBackendSession Session Figure 0 5 Execute Query Call Sequence 1 Obtain a web service session and authenticate with an existing IUCLID 5 user account 2 Select the query you wish to execute To create a query you have these options a Load the query definition by its name id see 3 2 1 getAllQueryNames Load the query definition by its resulting document type see getQueryDefinitionsByResultDocumentType b Create you own query execution definition if you know exactly what you have to do You need to know the query name the exact parameter names and display type see the Query Definitions for details 14 65 Web Service Technical Manual 3 Execute the query by using the received Session and the newly create
58. pe type of the target document Last modification date last modification date of the target document Unique Key unique identifier of the target document contains the DocumentReferencePK Description the alphanumeric description field which is displayed Screen as indicator where the document reference points to Notes a free text field for user convenience to attach additional text DocumentReferenceWs Attributes QueryResultList private String docType From list documentReferenceList Figure 0 4 Query Result List Structure 8 65 Web Service Technical Manual 3 2 Interface Methods 3 2 1 getAllQueryNames Purpose Returns all available query names Each query could identified by its query name e g find_complex_substance Before you can execute a query you need the Query Definition which defines the meta data of a query To get this Query Definition you could use its query name e open logged in session as lt tns Session gt A List lt tns queryNameList gt of query names e g tns queryName id find_complex_substance gt 5 e QueryEngineNotAvailableFault Is thrown when the back end service is not available to fulfil the request e QueryEngineFault Is thrown for all occurred exception during the web service call The following table shows the available query name IDs Substance find all substances find complex substance by jointsubm
59. rch and an ID which can be used for identification purposes Note that the fieldname which specifies the index field to search can contain database wildcards This makes it possible to build queries like search for all annotations to endpoint documents without specifying the section endpoint kind Each of the query fields specifies the possible query values If a query field specifies more than one query value the values are automatically combined with operation when searching the query tool index 39 65 Web Service Technical Manual values 0 2 queryFields Altribules DocumentTypeWs From document Figure 0 8 Structure of Query Expression 40 65 Web Service Technical Manual 7 2 2 Query Result The following figure shows the structure of the query result The query result contains query result items that can be used to access the documents that contain the found data The query result items reference the values that were found in the index when executing the query These values are referencing the fields contained in the executed query expression that found this value in the query index QueryResult Value Fram querytodiengne QueryResultitem From Fram querytodiengine values Range QueryFi eld Fram querytodiengine Fram querytodengne dossierPk Date QueryField Fram querytociengine
60. receives the message as lt tns Receiver gt The unique key of the document to be shown in the receivers IUCLID 5 client as tns documentReferencePK gt OUT Exceptions MessagingEngineNotAvailableFault thrown when e g the service is not available to fulfil the request MessagingEngineFault thrown if the Service is not able to fulfil your request This may happen if the Engine caught a back end Exception 49 65 Web Service Technical Manual 10 Reference Tracker Engine The reference tracker engine tracks the linkage between IUCLID 5 documents The methods of the Reference Tracker Engine can be used to find out which documents reference a document and which documents are referenced by a document The Reference Tracker Engine offers a very convenient way to get information on the relations between documents without the need to scan the XML of the documents for references 10 1 Interface Methods This section describes the operations of the Reference Tracker Engine The Reference Tracker Engine can be used to get the inbound and outbound references of a IUCLID 5 document 10 1 1 queryInbound This operation answers all references from other documents to the given document reference IN The open logged in session as tns session gt Purpose The unique keys of document for which to query the inbound references as tns documentReferencePK A list of all documents that reference the document given in the IN p
61. scribes the operations of the Inventory Engine 8 1 1 getLiteraturelnventoryQuery Purpose Return the QueryDefinition see 3 1 Short introduction to data model for the Literature Inventory e The open logged in session as lt tns Session gt e The Query Definition lt tns queryDefinition gt of the Literature Inventory see Figure 0 2 Query Definition Structure Exceptions e InventoryEngineNotAvailableFault Is thrown when e g the service is not available to fulfil the request e InventoryEngineFault Is thrown if Inventory Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 45 65 Web Service Technical Manual The following table shows the query definition see also Table 0 2 Mapping Query Parameter Display Type Query Parameter Value Type Query Name find complex literatureinventoryentries e Document Type Unknown queryParameterName queryParameterDisplayType queryParameterDataType phraseGroupID display as picklist STRING Z31 referenceType othervalue display as string STRING referenceAuthor display as string STRING year display as integer STRING referenceTitle display as string STRING referenceSource display as string STRING referenceTestLab display_as_ string STRING referenceReportNo display_as_ string STRING referenceLegalEntityld display as string STRING referenceLegalEntityStudyNo d
62. ss Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 31 65 Web Service Technical Manual 5 1 8 referenceEndpoints Purpose Reference the specified endpoints to the specified new owner substance mixture or template document by copying it and establishing a special local reference to the original filling in the origin attribute The open logged in session as tns session gt The target endpoint container document substance mixture or template as lt tns document gt The unique keys of the endpoinst to be referenced the source of the reference as tns documentReferencePK A note to be added to the origin references The updated endpoint container document substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls The unique keys of the endpoint references gt as tns documentReferencePK Prerequisites The endpoint container document substance mixture or template must be open for writing for the session The specified endpoint documents to be referenced and all associated attachments can be read Exceptions EndpointAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception
63. tance mixture or template to another endpoint container document IN The open logged in session as tns session gt The target endpoint container document substance mixture or template as lt tns document gt The unique keys of the source endpoints as tns documentReferencePK The updated endpoint container document substance mixture or template as lt tns document gt The caller must make sure to use this in subsequent calls To finalize the copying of the endpoints this document has to be committed The references of the copied endpoint documents as lt tns documentReference gt Prerequisites The target endpoint container document substance mixture or template must be open for writing for the session that is used to copy endpoints 5 EndpointAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request EndpointAccessEngineFault Is thrown if Endpoint Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception 29 65 Web Service Technical Manual 5 1 5 deleteEndpoint Purpose Delete a single endpoint from persistence The reference to the endpoint is also automatically removed from its parent document substance mixture or template IN e The open logged in session as tns session gt e The endpoint container document substance mixture or template lt tns document gt e
64. the local document was currently locked ACCESSDENIED The documents could not be compared because the local document is access protected VALIDATION VIOLATION The documents could not be compared because validation detected a violation ERROR The documents could not be compared because of an unexpected error The open logged in session as lt tns Session gt The Web service document lt tns document gt o ThelUCLID 5 document content lt tns document gt lt tns content gt lt i5 LegalEntity lt tns content gt lt tns document gt Document Comparison State lt tns documentComparisonStatus comparisonStatus IDENTICAL gt DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request DocumentAccessEngineFault Is thrown if Document Access Engine is not able to fulfil your request This may happen if the Engine caught a back end Exception DocumentAccessFault Is a tagged exception used to tell the caller that the desired access to a document is prohibited due to sharing restriction 20 65 Web Service Technical Manual 4 2 7 openDocumentForWriting Purpose Open a document for read write access and acquiring the write lock at the server The write lock would be present until you call closeDocument see 4 2 3 The open logged in session as lt tns Session gt The Document Reference PK tns documentReferencePK uniqueKey UUID SnapshotUUID
65. tion 38 65 Web Service Technical Manual 7 2 Data Structures 7 2 1 Query Expression The following figure shows the structure of the query expression A QueryExpression is built with QueryBlock items that can be SimpleEndpointQueryBlock items or SimpleQueryBlock items The SimpleEndpointQueryBlock items find endpoint and endpoint summary related data The SimpleQueryBlock items find non endpoint related data The query blocks can be combined with LogicalExpressionQueryBlock items that support the block conjunction logic as applied by the IUCLID 5 query tool offering AND OR and NOT operations between blocks SimpleEndpointQueryBlock items specify the document type of endpoint searched Endpoint record endpoint study record or endpoint summary record the endpoint kind e g PC BOILING and field restriction criteria that can be used to restrict the query result items in case no query field is specified and thus no field names are available otherwise SimpleQueryBlock items specify the document type of the document searched and a field restriction criterion that can be used to restrict the query result items in case no query field is specified and thus no field names are available otherwise The simple query blocks consist of QueryField items possible types are strings which also represent the IUCLID 5 pick list values in clear text dates numeric values and ranges The field item specifies which index field to sea
66. ublic This format describes e g how to link an Annotation to its parent document Substance Mixture etc Note For more information on how to create these identifiers please refer to section 14 1 Document Identifiers DocumentReferencePKWs which is part of chapter 14 Annex 15 65 Web Service Technical Manual 4 1 Short Introduction to Data Model DocumentWS contains the IUCLID 5 document o documentReference the document reference of the containing XML document see Figure 0 4 Query Result List Structure o Content the XML representation of the IUCLID 5 document DocumentReferenceWs Attributes private String docType documentReference DocumentWs private Date lastModificationDate le Attributes private String uniqueKey private String content private String description Susa private String notes Figure 0 6 Document WS Structure 4 2 Interface Methods This section describes each single method of the Document Access Engine These descriptions do not explain any use case scenarios such information can be found in section 4 3 4 2 1 existsDocument Purpose Verify if the Unique Key points to an existing document IN e open logged in session as lt tns Session gt The Document Reference PK tns documentReferencePK uniqueKey UUID SnapshotUUID gt Boolean flag lt tns isExisting gt true lt tns isExisting gt Exceptions e Docu
67. ueryDefinitions QueryExecutionDefiniton Contains the meta data to execute a query o Query Name defined by its corresponding query definition o List of query parameters Query parameter name defined by its corresponding query definition Query parameter value the concrete parameter value to insert in the standard query See Table 0 2 for details on the expected mapping between the specified query parameter display type and its query parameter value type Query Parameter Display Type Query Parameter Value Type DISPLAY AS CHECKBOX BooleanParameterValue DISPLAY AS DATE DateParameterValue DISPLAY AS DATE RANGE DateRangeParameterValue DISPLAY AS INTEGER IntegerParameterValu DISPLAY AS PICKLIST PicklistParameterValue DISPLAY AS UUID DISPLAY AS STRING TextParameterValue Table 0 2 Mapping Query Parameter Display Type Query Parameter Value Type 7 65 Web Service Technical Manual The following diagram illustrates this structure PicklistParameterValue QueryName TextParameterValue From definition DateRangeParameterValue Attributes private String queryParameterValue QueryExecutionDefinition From definition DateParameterValue parameterValue QueryParameter From definition BooleanParameterValue Figure 0 3 Query Execution Definition Structure QueryResultList Contains the list of Document References o List of document references Document ty
68. ueryUlPlugin 5 0 0 gt lt expression gt lt version gt 5 0 0 lt version gt lt comment gt lt datalayer gt RAWS DATA lt datalayer gt lt level 1 gt lt path gt lt pathelement id TR SE00 00 gt lt pathelement id TR SU SE00 00 gt pathelement id Q S 04 00 00 gt lt pathelement id SE04 02 gt lt path gt lt criteria gt lt id SE04 02 00 0470 lt value unit phrasegroup A102 phrase 2493 gt lt value gt lt range gt lt criteria gt lt query gt Aes gt lt level 1 gt lt path gt lt pathelement id TR SE00 00 gt lt pathelement id TR SU SE00 00 gt lt pathelement id Q S 04 00 00 gt pathelement id SE04 03 gt lt path gt lt criteria gt amp range id SE04 03 00 0470 lt value e T RE unit phrasegroup A102 phrase 2493 gt lt value gt lt range gt lt criteria gt lt query gt lt expression gt XML file 0 2 Query Export The information highlighted in the file contents above are necessary for building the query expression program code for the web service The following code highlights the places where this information is needed in the same colour build a melting point and a boiling point endpoint query block build executable query expression final QueryExpression expression new QueryExpression expression setComment test express
69. view the system informat e Administration Figure 0 1 IUCLID 5 Web Service Start Page After you have clicked at Additional WSDL SOAP1 1 you will enter the SOAP 1 1 download section This site displays a list of WSDL files which are using SOAP 1 1 binding see Figure 0 2 SOAP 1 1 Download Section 61 65 Web Service Technical Manual Software Foundation http www apache org WSDL files for SOAP 1 1 binding The list below displays all WSDL files which using SOAP 1 1 binding instead of the default 2 binding DocumentAccessEngine EndpointAccessEngine InventoryEngine MessagingEngine QueryEngine QueryToolEngine ReferenceTrackerEngine ReferentiallntegrityEngine ResourceEngine SessionEngine The list below displays all XML Schema files which are used at the above listed WSDL files e Types You can download all these files as SOAP 1 1 bundle e iws 1 1 bundle Figure 0 2 SOAP 1 1 Download Section 14 Annex 14 1 Document Identifiers DocumentReferencePKWs Each document carries a universally unique identifier UUID more precisely this document identifier is a combination of two parts where both consist of a prefix and a UUID A document identifier is generated when the document is initially created and remains unchanged for the lifetime of the document In contrast to earlier releases of IUCLID IUCLID 5 has been designed as a distributed database system This means that identif
70. y notify that everything was OK otherwise will throw a detailed exception DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request DocumentNotFoundFault Is a tagged exception used to inform the caller that the requested document cannot be found DocumentAccessFault Is a tagged exception used to tell the caller that the desired access to a document is prohibited due to sharing restriction 23 65 Web Service Technical Manual 4 2 10 createDocument Purpose Creates a new Document object for the given document type Note The document has open write access to the document after successful call to this method so to finish working with the document a call to 4 2 3 closeDocument is required The created document would only be saved at the database layer if you call 4 2 8 commitDocument The open logged in session as lt tns Session gt Document Tye Substance Mixture Dossier tns documentType type LegalEntity gt The Web service document lt tns document gt contains o The Document Reference o ThelUCLID 5 document content lt tns document gt lt tns documentReference type LegalEntity gt lt tns content gt lt i5 LegalEntity lt tns content gt lt tns document gt Exceptions DocumentAccessEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the request DocumentCreationFault is thrown to t
71. z dataContent typez xsd base64Binary lt xsd sequence gt xsd attribute namez fileName typez xsd string usez required lt xsd complexType gt lt xsd schema gt Code 0 5 MTOM Message Definition 12 2 Container Engine 12 2 1 Short Introduction to Data Model The following diagram illustrates the data structure of the container engine enumerstion ResultReport ImportContainerlnformation fileName String ResultFlag enum SUCCESS REJECTED ABORT ROLLBACK UNKNOWN ResultReport I5zContainer message String dstsContent byte resuttFiag ResultFisg f eName String 5zContsmer esultReoon DownloadContainer i5zContaier l5zContsiner resultReport ResultReport Figure 0 12 Data Structure of Container Engine 58 65 Web Service Technical Manual 12 2 2 Interface Methods The container engine service is used to upload and download a complete IUCLID 5 export container i5z file 12 2 2 1 uploadContainer Purpose Send a binary IUCLID 5 export container to the web service and starts the transactional import IN The open logged in session as lt tns Session gt The ibzContainer tns ibzContainer tns fileName String gt The import result report tns resultReport tns resultFlag SUCCESS gt 5 ContainerEngineNotAvailableFault Is thrown when e g the back end service is not available to fulfil the requ

IUCLID 5 Query Tool Plugin User manual

Contents

Download Pdf Manuals

Related Search

Related Contents