'EDIT - WEB Services' - circabc.europa.eu · Commission européenne, B-1049 Bruxelles / Europese...

Commission européenne, B-1049 Bruxelles / Europese Commissie, B-1049 Brussel - Belgium. Telephone: (32-2) 299 11 11.

Commission européenne, L-2920 Luxembourg. Telephone: (352) 43 01-1.

EUROPEAN COMMISSION DIRECTORATE-GENERAL INFORMATICS Information systems Directorate

EUROPEAN COMMISSION DIRECTORATE-GENERAL INFORMATICS Information systems Directorate

European Commission

Specific Contract Fixed Price 002060, EDIT –

Progressive maintenance and implementation

"EDIT - WEB Services" under framework contract DI/07343-00

Date: 14/03/2016

Version: 03.00

Authors: Valentin BACIU, Adrian DUTA,

Alexandru DOBRE, Dragos-

Alin.LAPUSNEANU

Revised by: Gheorghe MORARU

Approved by: Theodoros MIGLAKIS

Public: No

Reference Number: n/a

Commission européenne, B-1049 Bruxelles / Europese Commissie, B-1049 Brussel - Belgium. Telephone: (32-2) 299 11 11.

Commission européenne, L-2920 Luxembourg. Telephone: (352) 43 01-1.

TABLE OF CONTENTS

1. TERMINOLOGY ....................................................................................................................................16

1.1. Abbreviations and Acronyms ..................................................................................................................16

2. OVERVIEW .............................................................................................................................................17

3. WHAT’S NEW ........................................................................................................................................17

4. API OVERVIEW ....................................................................................................................................17

5. GENERIC CONSIDERATIONS ............................................................................................................18

5.1. Credentials ..............................................................................................................................................18

5.2. Messages .................................................................................................................................................19

6. DETAILED API DESCRIPTION ..........................................................................................................19

6.1. Server Message Source ...........................................................................................................................20

6.1.1. Get Messages .......................................................................................................................................20

6.2. Admin Service ........................................................................................................................................20

6.2.1. Find Domain by Id ...............................................................................................................................20

6.2.2. Find all domains ..................................................................................................................................20

6.2.3. Find Domain by Name .........................................................................................................................21

6.2.4. Search Domains ...................................................................................................................................21

6.2.5. Find Domain BY Id .............................................................................................................................21

6.2.6. Save Domain ........................................................................................................................................22

6.2.7. Delete Domain .....................................................................................................................................22

6.2.8. Delete Domains ...................................................................................................................................22

6.2.9. Search User ..........................................................................................................................................23

6.2.10. Find All Users ....................................................................................................................................23

6.2.11. Find User By ID ................................................................................................................................24

6.2.12. Find User By Credentials ...................................................................................................................24

6.2.13. Find All User’s Domains ...................................................................................................................24

6.2.14. Find All User and Domain’ groups ....................................................................................................24

6.2.15. Add user .............................................................................................................................................25

6.2.16. Delete User ........................................................................................................................................25

6.2.17. Delete Users .......................................................................................................................................25

6.2.18. Find Group .........................................................................................................................................26

6.2.19. Search Groups....................................................................................................................................26

6.2.20. Get All Groups ...................................................................................................................................26

6.2.21. Add Group .........................................................................................................................................27

"EDIT - WEB Services" / 140 Document Version 03.00. dated 14/03/2016

6.2.22. Delete Group .....................................................................................................................................27

6.2.23. Delete Groups ....................................................................................................................................27

6.2.24. Find All Roles ....................................................................................................................................27

6.2.25. Search Roles ......................................................................................................................................28

6.2.26. Find All Roles For Domain................................................................................................................28

6.2.27. Find Roles For User And Domain .....................................................................................................28

6.2.28. Find Menu Permission .......................................................................................................................29

6.2.29. Change Current Password ..................................................................................................................29

6.2.30. Authenticate User ..............................................................................................................................29

6.2.31. Authenticate User On Domain ...........................................................................................................30

6.2.32. Current Domain Users .......................................................................................................................30

6.2.33. Retrieve Application Settings ............................................................................................................30

6.2.34. Set Default Execution Queue .............................................................................................................31

6.2.35. Audit User Disclaimer .......................................................................................................................31

6.2.36. Search Audit Disclaimer ....................................................................................................................31

6.2.37. Last Audit Disclaimer ........................................................................................................................31

6.2.38. Get Domain News ..............................................................................................................................32

6.2.39. Get News By ID .................................................................................................................................32

6.2.40. Search News ......................................................................................................................................33

6.2.41. Delete News .......................................................................................................................................33

6.2.42. Publish News .....................................................................................................................................33

6.2.43. Unpublish News .................................................................................................................................33

6.2.44. Delete News .......................................................................................................................................34

6.2.45. Save News .........................................................................................................................................34

6.2.46. Refresh Domain Export Status ...........................................................................................................34

6.2.47. Remove Export ..................................................................................................................................35

6.2.48. Import Domain...................................................................................................................................35

6.2.49. Export Domain ..................................................................................................................................35

6.2.50. View Objects Description ..................................................................................................................36

6.2.50.1. ApplicationSettingsVO ...................................................................................................................36

6.2.50.2. DisclaimerAuditTrailVO ................................................................................................................36

6.2.50.3. DomainVO ......................................................................................................................................36

6.2.50.4. GroupVO ........................................................................................................................................36

6.2.50.5. NewsVO .........................................................................................................................................36

6.2.50.6. PermissionInfoVO ..........................................................................................................................36

6.2.50.7. RoleVO ...........................................................................................................................................36

6.2.50.8. RoleInfoVO ....................................................................................................................................37

6.2.50.9. UserVO ...........................................................................................................................................37


6.2.50.10. UserDetailsVO ..............................................................................................................................37

6.2.50.11. DomainIOTaskVO ........................................................................................................................37

6.3. DatasetDefinitionService ........................................................................................................................37

6.3.1. Find Dataset Definition by Name ........................................................................................................37

6.3.2. Find Dataset Definition by ID ..............................................................................................................37

6.3.3. Find All Dataset Definitions ................................................................................................................38

6.3.4. Search Dataset Definition ....................................................................................................................38

6.3.5. Import Dataset Definition ....................................................................................................................39

6.3.6. Import Required Dataset Definition .....................................................................................................39

6.3.7. Export Dataset Definition ....................................................................................................................39

6.3.8. Save Dataset Definition .......................................................................................................................40

6.3.9. Delete Dataset Definition .....................................................................................................................40

6.3.10. Check Dataset Definition Syntax .......................................................................................................40

6.3.11. Dataset Definition Filtered .................................................................................................................40

6.3.12. Delete Dataset Definitions .................................................................................................................41

6.3.13. Import GESMES Dataset Definition..................................................................................................41

6.3.14. Synchronize Selected List ..................................................................................................................42

6.3.15. Load SDMX registry .........................................................................................................................42

6.3.16. Check Missing Values .......................................................................................................................42


6.3.17.1. GESMESUpload .............................................................................................................................43

6.3.17.2. SDMXUpload .................................................................................................................................43

6.4. DatasetService ........................................................................................................................................43

6.4.1. Find Dataset .........................................................................................................................................43

6.4.2. Search Datasets ....................................................................................................................................44

6.4.3. Find Dataset Instance ...........................................................................................................................44

6.4.4. Find Dataset Instances .........................................................................................................................44

6.4.5. EDAMIS Tokens .................................................................................................................................45

6.4.6. EDAMIS Metadata ..............................................................................................................................45

6.4.7. Chek auto process ................................................................................................................................45

6.4.8. Update Dataset Metadata .....................................................................................................................46

6.4.9. Find Dataset Instance By Dataset Definition .......................................................................................46

6.4.10. Find Dataset Instance By Dataset Definition And Type ....................................................................47

6.4.11. Find Dataset Instance Content And Dataset Definition .....................................................................47

6.4.12. Retrieve Dataset Row Or Partition ....................................................................................................47

6.4.13. Retrieve Partition Values ...................................................................................................................48

6.4.14. Retrieve Hierarchical Dataset Instance ..............................................................................................48


6.4.15. Finds If A Dataset Is Hierarchical .....................................................................................................49

6.4.16. Check The Existance Of A Dataset Insance.......................................................................................49

6.4.17. Set Dataset Owner Group ..................................................................................................................49

6.4.18. Add Dataset .......................................................................................................................................50

6.4.19. Delete Dataset By Id ..........................................................................................................................50

6.4.20. Delete Dataset By Name ....................................................................................................................50

6.4.21. Retrieve Dataset Line Chart ...............................................................................................................50

6.4.22. Delete Datasets ..................................................................................................................................51

6.4.23. Find Hierarchical Structures ..............................................................................................................51

6.4.24. Find Hierarchical Breakdowns ..........................................................................................................52

6.4.25. Generate Breakdown .........................................................................................................................52


6.4.26.1. AutoProcessibleStatus ....................................................................................................................53

6.4.26.2. DatasetRowVO ...............................................................................................................................53

6.4.26.3. DatasetInfoVO ................................................................................................................................53

6.4.26.4. DatasetInstanceVO .........................................................................................................................53

6.4.26.5. DatasetInstanceType .......................................................................................................................53

6.4.26.6. PartitionValuesVO ..........................................................................................................................53

6.4.26.7. HierarchicalOptionsVO ..................................................................................................................53

6.5. ImportExportService...............................................................................................................................54

6.5.1. Start Import ..........................................................................................................................................54

6.5.2. Start Export ..........................................................................................................................................54

6.5.3. Retrive Import Plugin Names ..............................................................................................................54

6.5.4. Retrieve Export Plugin Names .............................................................................................................55

6.5.5. Search Tasks ........................................................................................................................................55

6.5.6. Find Task Status ..................................................................................................................................56

6.5.7. Delete Task ..........................................................................................................................................56

6.5.8. Cancel Task .........................................................................................................................................56

6.5.9. Export Task or Start New ....................................................................................................................56

6.5.10. Delete Tasks ......................................................................................................................................57

6.5.11. Start Preediting ..................................................................................................................................57

6.5.12. Find SDMX Key Families .................................................................................................................57


6.5.13.1. ExportOptionsVO ...........................................................................................................................58

6.5.13.2. ImportOptionsVO ...........................................................................................................................58

6.5.13.3. PreeditingOptionsVO .....................................................................................................................58

6.5.13.4. TaskInfoVO ....................................................................................................................................58

6.5.13.5. TaskUpdateStatusVO .....................................................................................................................58


6.6. JobService...............................................................................................................................................59

6.6.1. Find Job ...............................................................................................................................................59

6.6.2. Find Job Details ...................................................................................................................................59

6.6.3. Search Jobs ..........................................................................................................................................59

6.6.4. Find Job Statistics ................................................................................................................................60

6.6.5. Add Job ................................................................................................................................................60

6.6.6. Delete Job ............................................................................................................................................60

6.6.7. Retrieve Job Status ..............................................................................................................................61

6.6.8. Start Job ...............................................................................................................................................61

6.6.9. Start Job Synchronized ........................................................................................................................61

6.6.10. Stop Job .............................................................................................................................................62

6.6.11. Retrieve Job Script.............................................................................................................................62

6.6.12. Job Details with Reports ....................................................................................................................62

6.6.13. Job Statistics Aggregation .................................................................................................................63

6.6.14. Delete Jobs.........................................................................................................................................63

6.6.15. Publish Report ...................................................................................................................................63

6.6.16. Get Default Name Prefix ...................................................................................................................64

6.6.17. Find Job Naming Rule .......................................................................................................................64

6.6.18. Update Job Naming Rule ...................................................................................................................64

6.6.19. Trigger Auto Processing ....................................................................................................................65

6.6.20. Change Executin Queue .....................................................................................................................65

6.6.21. Change Execution Queue ...................................................................................................................65

6.6.22. Reject High Priority Request .............................................................................................................66

6.6.23. Get Default Name Prefix External .....................................................................................................66


6.6.24.1. ColumnAggregationVO ..................................................................................................................66

6.6.24.2. JobVO .............................................................................................................................................67

6.6.24.3. JobDetailsVO .................................................................................................................................67

6.6.24.4. JobDetailsReportsVO .....................................................................................................................67

6.6.24.5. JobInfoVO ......................................................................................................................................67

6.6.24.6. JobNamingRuleVO .........................................................................................................................67

6.6.24.7. JobStatisticsVO ..............................................................................................................................67

6.6.24.8. JobUpdateVO .................................................................................................................................67

6.7. ProgramService ......................................................................................................................................67

6.7.1. Find Program .......................................................................................................................................68

6.7.2. Search Programs ..................................................................................................................................68

6.7.3. Import Program ....................................................................................................................................68

6.7.4. Export Program....................................................................................................................................69


6.7.5. Delete Program ....................................................................................................................................69

6.7.6. Get Program Details ............................................................................................................................69

6.7.7. Retrieve the program Schedule ............................................................................................................70

6.7.8. Verify Program Script ..........................................................................................................................70

6.7.9. Retrieve Program Dataset References ..................................................................................................70

6.7.10. Verify if a program can be deleted ....................................................................................................71

6.7.11. Get Unique Suffix ..............................................................................................................................71

6.7.12. Delete Programs ................................................................................................................................71

6.7.13. Import And Rename Program ............................................................................................................71

6.7.14. Synchronized Selected List ................................................................................................................72

6.7.15. Import EVE program .........................................................................................................................72

6.7.16. Retrieve Details for Export Program With Dependencies .................................................................73

6.7.17. Export Program With Dependencies .................................................................................................73

6.7.18. Create Import Program With Dependencies From File .....................................................................73

6.7.19. Import Program With Dependencies .................................................................................................74

6.7.20. Get Program List................................................................................................................................74


6.7.21.1. ProgramWithDsdInfoVO ................................................................................................................75

6.7.21.2. ProgramInfoVO ..............................................................................................................................75

6.7.21.3. ProgramViewVO ............................................................................................................................75

6.7.21.4. ProgramScheduleVO ......................................................................................................................75

6.7.21.5. SerialUpload ...................................................................................................................................75

6.8. ProgramEditorService.............................................................................................................................75

6.8.1. Retrieve Program For Edit ...................................................................................................................75

6.8.2. Retrieve Program For Edit ...................................................................................................................76

6.8.3. Retrieve The Keysets For A Dataset Definition ...................................................................................76

6.8.4. Retrieve The Keysets For Template ....................................................................................................76

6.8.5. Validate A Program .............................................................................................................................77

6.8.6. Save Program .......................................................................................................................................77

6.8.7. Program Parameter Sets .......................................................................................................................78

6.8.8. View Objects Description ....................................................................................................................78

6.8.8.1. KeysetsTemplateVO .........................................................................................................................78

6.8.8.2. KeySetVO .........................................................................................................................................78

6.8.8.3. PdtProgramVO .................................................................................................................................78

6.8.8.4. PdtProgramInfoVO ...........................................................................................................................78

6.8.8.5. PdtTemplateVO ................................................................................................................................79

6.8.8.6. TemplateType ...................................................................................................................................79

6.9. DataRepositoryService ...........................................................................................................................79


6.9.1. Upload File ..........................................................................................................................................79

6.9.2. Download File .....................................................................................................................................79

6.9.3. Download File .....................................................................................................................................80

6.9.4. Delete File ...........................................................................................................................................80

6.9.5. Get Property .........................................................................................................................................81

6.9.6. Publish To Secure Channel ..................................................................................................................81

6.10. FieldSetService .....................................................................................................................................81

6.10.1. Find FieldSet By ID ...........................................................................................................................81

6.10.2. Find FieldSet By Name ......................................................................................................................82

6.10.3. Find FieldSet By Dataset Definition ..................................................................................................82

6.10.4. Search FieldSets ................................................................................................................................82

6.10.5. Add FieldSet ......................................................................................................................................83

6.10.6. Delete FieldSet ..................................................................................................................................83

6.10.7. Export FieldSet ..................................................................................................................................84

6.10.8. Import Field Set .................................................................................................................................84


6.10.9.1. FieldSetVO .....................................................................................................................................84

6.10.9.2. FieldSetInfoVO ..............................................................................................................................84

6.11. PropertySetService ...............................................................................................................................84

6.11.1. Find PropertySet By Name ................................................................................................................85

6.11.2. Find PropertySet By Type .................................................................................................................85

6.11.3. Find PropertySet By ID .....................................................................................................................85

6.11.4. Search PropertySets ...........................................................................................................................86

6.11.5. Add PropertySet ................................................................................................................................86

6.11.6. Delete PropertySet .............................................................................................................................87

6.11.7. Export Property Set ...........................................................................................................................87

6.11.8. Import Property Set ...........................................................................................................................87


6.11.9.1. PropertySetVO................................................................................................................................88

6.11.9.2. PropertySetInfoVO .........................................................................................................................88

6.12. DBConnTemplateService .....................................................................................................................88

6.12.1. Retrieve Connection ..........................................................................................................................88

6.12.2. Retrieve Connections .........................................................................................................................88

6.12.3. Save Connection ................................................................................................................................89

6.12.4. Delete Connection .............................................................................................................................89

6.12.5. Delete Connections ............................................................................................................................90

6.12.6. Find All Connections .........................................................................................................................90



6.12.7.1. DBConnectionDetailsVO ...............................................................................................................90

6.12.7.2. DBConnectionVO...........................................................................................................................90

6.13. DBStmtTemplateService ......................................................................................................................90

6.13.1. Retrieve Statement .............................................................................................................................91

6.13.2. Retrieve Statements ...........................................................................................................................91

6.13.3. Save Statement ...................................................................................................................................91

6.13.4. Delete Statement ................................................................................................................................92

6.13.5. Delete Statements ..............................................................................................................................92

6.13.6. Find All Statements By Type .............................................................................................................92

6.13.7. return –return a list with all the statements by its type. View Objects Description ..........................93

6.13.7.1. DBStmtDetailsVO ..........................................................................................................................93

6.13.7.2. DBStmtVO .....................................................................................................................................93

6.14. DatasetFilteringService .........................................................................................................................93

6.14.1. Save Filtering Template .....................................................................................................................93

6.14.2. Load Filtering Template ....................................................................................................................93

6.14.3. Search For Filtering Templates ..........................................................................................................94

6.14.4. Delete Filtering Template ..................................................................................................................94

6.14.5. Read a Page From the Dataset Contents ............................................................................................95


6.14.6.1. DatasetFilteringTemplateVO ..........................................................................................................95

6.14.6.2. DatasetFilteringTemplateListVO ....................................................................................................95

6.14.6.3. FieldVO ..........................................................................................................................................95

6.15. ArchiveRestoreService .........................................................................................................................95

6.15.1. Archive Dataset .................................................................................................................................96

6.15.2. Restore Dataset ..................................................................................................................................96

6.15.3. Archive Datasets ................................................................................................................................96

6.15.4. Restore Datasets ................................................................................................................................97

6.15.5. Search Archive/Restore Jobs For Dataset Instance ............................................................................97

6.15.6. Search Archive Jobs For Dataset Instance .........................................................................................97

6.15.7. Search Restore Jobs For Dataset Instance .........................................................................................97

6.15.8. Search Logs By Job ...........................................................................................................................98

6.16. AutodomainDefinitionService ..............................................................................................................98

6.16.1. Search For Current Domain ...............................................................................................................98

6.16.2. Automate Current Domain .................................................................................................................98

6.16.3. Find Autodomains For File ................................................................................................................99

6.16.4. Find Autodomains For File In Folder ................................................................................................99

6.16.5. Search For Domain ..........................................................................................................................100

6.16.6. Domain Automation Definition .......................................................................................................100


6.16.7. View Objects Description ................................................................................................................100

6.16.7.1. AutodomainDefinitionVO ............................................................................................................100

6.16.7.2. AutodomainWithDomainVO ........................................................................................................100

6.17. AutodomainProgramService ...............................................................................................................101

6.17.1. Edamis Metadata Tokens .................................................................................................................101

6.17.2. Verify Autodomain Program Condition ...........................................................................................101

6.17.3. Find Autodomain Program ..............................................................................................................101

6.17.4. Autodomain Program For Filename.................................................................................................102

6.17.5. Search Autodomain Programs .........................................................................................................102

6.17.6. Save Autodomain Program ..............................................................................................................103

6.17.7. Delete Autodomain Program ...........................................................................................................103

6.17.8. Delete Autodomain Programs ..........................................................................................................103


6.17.9.1. AutodomainProgramVO ...............................................................................................................104

6.18. ContactsService ..................................................................................................................................104

6.18.1. Search External Contacts .................................................................................................................104

6.18.2. Check verification code ...................................................................................................................105

6.18.3. Verify E-mail ...................................................................................................................................105

6.18.4. Save external contact .......................................................................................................................105

6.18.5. Delete external contact ....................................................................................................................106

6.18.6. Delete external contacts ...................................................................................................................106

6.18.7. Search External Contact...................................................................................................................107

6.18.8. Assign External Contact To Key .....................................................................................................107

6.18.9. Search External Contact Key ...........................................................................................................107

6.18.10. Search External Contact Key By ID ..............................................................................................108

6.18.11. Save External Contact Key ............................................................................................................108

6.18.12. Delete External Contact Key .........................................................................................................109

6.18.13. Delete External Contact Keys ........................................................................................................109

6.18.14. Send Verification Code ..................................................................................................................109

6.18.15. Send E-mail to External Contact ....................................................................................................110

6.18.16. View Objects Description ..............................................................................................................110

6.18.16.1. ExternalContactVO .....................................................................................................................110

6.18.16.2. ExternalContactKeyVO ..............................................................................................................110

6.19. SystemMonitoringService ...................................................................................................................110

6.19.1. Job Status Overview ........................................................................................................................111


6.19.2.1. JobStatusOverviewVO ..................................................................................................................111

6.20. UserPreferenceService ........................................................................................................................111


6.20.1. Retrieve User Preferences List.........................................................................................................111

6.20.2. Retrieve User Preferences By Key...................................................................................................112

6.20.3. Save User Preference .......................................................................................................................112

6.20.4. Delete User Preference ....................................................................................................................112


6.20.5.1. UserPreferenceVO ........................................................................................................................113

6.21. ValidationFlowService .......................................................................................................................113

6.21.1. Create Validation Flow ....................................................................................................................113

6.21.2. Update Validation Flow ...................................................................................................................113

6.21.3. Search Validation Flow ...................................................................................................................114

6.21.4. Load Validation Flow ......................................................................................................................114

6.21.5. Delete Validation Flow ....................................................................................................................114

6.21.6. Get Import Templates ......................................................................................................................115


6.21.7.1. ValidationFlowVO .......................................................................................................................115

6.21.7.2. SearchValidationFlowVO .............................................................................................................115

6.22. LanguageService .................................................................................................................................115

6.22.1. Get All Languages ...........................................................................................................................116

6.22.2. Get Language ...................................................................................................................................116

6.22.3. Save Language .................................................................................................................................116

6.22.4. Export Translations ..........................................................................................................................117

6.22.5. Import Translations ..........................................................................................................................117

6.22.6. Get Available Languages .................................................................................................................117

6.22.7. Delete Language ..............................................................................................................................118

6.22.8. Delete Languages .............................................................................................................................118

6.22.9. Find Language By Locale ................................................................................................................118

6.22.10. View Objects Description ..............................................................................................................119

6.22.10.1. LanguageVO ...............................................................................................................................119

6.22.10.2. LanguageUploadVO ...................................................................................................................119

6.23. ContentImageService ..........................................................................................................................119

6.23.1. Search Images ..................................................................................................................................119

6.23.2. Delete Image ....................................................................................................................................120

6.23.3. Upload Image ..................................................................................................................................120

6.23.4. Get Image ........................................................................................................................................120

6.24. QueueService ......................................................................................................................................121

6.24.1. Search Queues .................................................................................................................................121

6.24.2. Save Queue ......................................................................................................................................121

6.24.3. Check if queue exists .......................................................................................................................122


6.24.4. Delete Queues ..................................................................................................................................122

6.24.5. Search Queue ...................................................................................................................................123

6.24.6. Search All Queues ...........................................................................................................................123

6.24.7. Search Queue By Name ...................................................................................................................123

6.24.8. Search All Enabled Queues .............................................................................................................124

6.24.9. Search Enabled Queues For Current User .......................................................................................124

6.24.10. Default Queue For Job ...................................................................................................................124

6.24.11. Eligible Queues For Job.................................................................................................................125

6.25. ScriptTemplateService ........................................................................................................................125

6.25.1. Get Script Templates .......................................................................................................................125

6.25.2. Get Script Template .........................................................................................................................126

6.25.3. Get Hierarchical Instances ...............................................................................................................126

6.25.4. Generate Program ............................................................................................................................127

7. WEB SERVICE SAMPLE WORKFLOW ..........................................................................................127

7.1. Import Format .......................................................................................................................................127

7.1.1. Import Format ....................................................................................................................................127

7.1.2. Search Dataset Format ID ..................................................................................................................128

7.2. Import Dataset ......................................................................................................................................128

7.2.1. Upload Dataset ..................................................................................................................................128

7.2.2. Start Import Task ...............................................................................................................................129

7.2.3. Monitor Import Task .........................................................................................................................129

7.3. Import Program .....................................................................................................................................130

7.4. Execute Job ...........................................................................................................................................130

7.4.1. Search Program By Name ..................................................................................................................130

7.4.2. Save Job .............................................................................................................................................130

7.4.3. Start Job .............................................................................................................................................131

7.4.4. Monitor Job Status .............................................................................................................................131

7.5. View Job Details ...................................................................................................................................131

7.6. Export Dataset ......................................................................................................................................131

7.6.1. Start Export Dataset ...........................................................................................................................131

7.6.2. Monitor Export Task Status ...............................................................................................................132

7.6.3. Export Dataset File ............................................................................................................................132

8. OTHER WEB SERVICE SAMPLES ..................................................................................................132

8.1. DatasetDefinitionService calls ..............................................................................................................133

8.1.1. Import Format ....................................................................................................................................133

8.1.2. Search Format ....................................................................................................................................133


8.1.3. View Format ......................................................................................................................................133

8.1.4. Export Format ....................................................................................................................................133

8.1.5. Delete Format ....................................................................................................................................134

8.2. ImportExportService calls ....................................................................................................................134

8.2.1. Import Dataset ...................................................................................................................................134

8.2.2. Verify Import Dataset Status .............................................................................................................134

8.3. DatasetService calls ..............................................................................................................................135

8.3.1. Search Dataset ...................................................................................................................................135

8.3.2. View Dataset Instance Definition ......................................................................................................135

8.3.3. Export Dataset ...................................................................................................................................135

8.4. DataRepositoryService calls .................................................................................................................135

8.4.1. Upload File ........................................................................................................................................135

8.5. ProgramService calls ............................................................................................................................136

8.5.1. Import Program ..................................................................................................................................136

8.5.2. View Program Definition ...................................................................................................................136

8.5.3. Search Programs ................................................................................................................................136

8.5.4. Export Program..................................................................................................................................136

8.5.5. Export Program With Dependencies .................................................................................................137

8.5.6. Delete Program ..................................................................................................................................137

8.5.7. Import Program With Dependencies .................................................................................................137

8.5.8. Schedule Program For Job Execution ................................................................................................137

8.6. JobService calls ....................................................................................................................................137

8.6.1. Create Job ..........................................................................................................................................138

8.6.2. Start Job .............................................................................................................................................138

8.6.3. Search Jobs ........................................................................................................................................138

8.6.4. View Job Details ................................................................................................................................138

8.6.5. Delete Job ..........................................................................................................................................138

9. WEB SERVICE OBJECTS DESCRIPTION ......................................................................................139

9.1. Generic Java Objects ............................................................................................................................139

9.1.1. Credentials .........................................................................................................................................139

9.1.2. SearchResult ......................................................................................................................................139

9.1.3. EditHashMap .....................................................................................................................................139

9.1.4. SearchInfo ..........................................................................................................................................139

9.1.5. DataHandler .......................................................................................................................................140

9.2. Generic View Objects ...........................................................................................................................140

9.2.1. DatasetDefinitionVO .........................................................................................................................140

9.2.2. FileInfoVO.........................................................................................................................................140


9.2.3. DatasetVO .........................................................................................................................................140

9.2.4. ExecutionQueueVO ...........................................................................................................................140


Document History

Version Date Comment Modified Pages

00.10 11/01/2010 Initial version

01.00 13/08/2010 Applied Review Comments, added

WSDL files

01.10 07/03/2012 Added new services, and old services

modifications.

01.11 13/03/2012 DataRepositoryService changes added.

01.20 15/03/2012 Added WSDL files

01.30 07/04/2014 Complete Web Services description for

EBB2012 compliance

Added samples for testing

01.40 14/04/2014 Complete Web Services description for

EBB2013 compliance

03.00 14/03/2016 Added Script Template Service and

updated old services.

34-36, 42, 51,

58, 74, 81, 100,

125-127


1. TERMINOLOGY

1.1. Abbreviations and Acronyms

Terms/Abbreviation Description


2. OVERVIEW

The EDIT Web Services allow the user to perform a set of predefined operations inside EDIT

by performing API calls through a Web Services client.

3. WHAT’S NEW

Summary of operations added in different versions.

Since v15.0.0.1 new methods are available in AdminService and DataRepositoryService.

In AdminService the methods are aimed to deal with domain data. These methods offer

the functionality to export the domain of the currend logged in user and all its dependent data

to a zip file (exportDomain), import domain information from a zip file (importDomain),

remove an export task for the current user and delete the exported file (removeExport) and

refresh an export domain task state.

In DataRepositoryService a new method is available to publish an internal file data to

the confidential domain outgoing folder (publishToSecureChannel).

Since v15.0.0.2 AutodomainDefinitionService offers 2 new methods: searchForDomain is used

to search for a specific domain name and domainAutomationDefinition is used to update

information of a domain.

4. API OVERVIEW

EBB 2013 exposes to the user the following web services:

1. MessageSource

2. AdminService

3. DatasetDefinitionService

4. DatasetService

5. ImportExportService

6. JobService

7. ProgramService

8. ProgramEditorService

9. DataRepositoryService

10. FieldSetService

11. PropertySetService

12. DBConnTemplateService

13. DBStmtTemplateService


14. DatasetFilteringService

15. ArchiveRestoreService

16. AutodomainDefinitionService

17. AutodomainProgramService

18. ContactsService

19. SystemMonitoringService

20. UserPreferenceService

21. ValidationFlowService

22. LanguageService

23. ContentImageService

24. QueueService

25. ExternalService

26. ScriptTemplateService

27. ServerMessageSource

28. UserPreferenceService

5. GENERIC CONSIDERATIONS

5.1. Credentials

EBB Web-Service calls require that credentials are provided, indicating the username,

password and domain name. The server will check that the provided credentials have the

necessary permissions to access the desired functionality.

The credentials needs to be placed in the header of the SOAP message, as in the following

example:

<?xml version="1.0" encoding="UTF-8"?>

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

xmlns:ser="http://edit.estat.ec/services/">

<soap:Header>

<ser:credentials>

<domain>DEMO</domain>

<password>programmer</password>

<username>programmer</username>

</ser:credentials>

</soap:Header>

<soap:Body>


<ser:getUserDetails/>

</soap:Body>

</soap:Envelope>

5.2. Messages

EBB allows external applications to access the messages bundle used by the application, in

order to provide localization for error messages or labels used by the web client application.

The full list of messages (key and text) can be obtained by calling the MessageSource service,

described in this document.

The following example illustrates an error code returned by the server on a delete program call:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">

<soap:Body>

<soap:Fault>

<soap:Code>

<soap:Value>soap:Receiver</soap:Value>

</soap:Code>

<soap:Reason>

<soap:Text xml:lang="en">Failed to delete program</soap:Text>

</soap:Reason>

<soap:Detail>

<ns2:editServiceException xmlns:ns2="http://edit.estat.ec/services/"

xmlns:ns3="http://security.edit.estat.ec/entities/">

<errorMessage>

<errorKeyMessage>program.delete.failed.invalid.id</errorKeyMessage>

</errorMessage>

</ns2:editServiceException>

</soap:Detail>

</soap:Fault>

</soap:Body>

</soap:Envelope>

It is up to the third party application to localize the message, either by using the bundle

provided by EBB or a local one.

6. DETAILED API DESCRIPTION


6.1. Server Message Source

The Message Source Service gives access to the message bundle and follows the definitions

from the following WSDL file:

messageSource.xml

6.1.1. Get Messages

EditHashMap<String, String> getMessages(String locale);

Returns a map of key-text messages association for a specified locale. If the locale is not found,

the default locale (en) is returned.

locale – the desired locale

6.2. Admin Service

The Admin Service handles administration functions and follows the definitions from the

following WSDL file:

adminService.xml

6.2.1. Find Domain by Id

DomainVO getDomain(Credentials cred,

Long id)

throws EditServiceException;

Retrieves a domain by given credentials and id

cred – login credentials

id – domain id

return the requested domain

throws EditServiceException if the operation fails

6.2.2. Find all domains

List<DomainVO> getAllDomains(Credentials cred)



Retrieves all the domains in the system

cred – login credentials; the user must have the DOMAIN_SEARCH or

NEWS_DOMAIN_SEARCH permission

return – a list containing all the domains in the system


6.2.3. Find Domain by Name

DomainVO findDomainByName(Credentials cred, String name)


Returns a domain by given its name

cred – login credentials; the user must have the DOMAIN_VIEW permission

id – domain id

return the requested domain or null


6.2.4. Search Domains

SearchResult<DomainVO> getDomains(Credentials cred,

EditHashMap<String,Object> filterMap,

SearchInfo searchInfo)


This method is used to retrieve a domain list based on search criteria. The search will be

performed using the value under key=DOMAIN_NAME in the filterMap parameter as a

substring.

cred – login credentials; the user must have the DOMAIN_SEARCH permission

filterMap – A map containing under the key AdminService.DOMAIN_NAME the name of

the domains to search for.

searchInfo – SearchInfo object containing information about searching like: startIndex,

maxResult, a list of fields on which the result will be sorted.

return SearchResult object containing info about result and a list with all domain matching the

searc criteria

throws EditServiceException if the operation fails.

6.2.5. Find Domain BY Id

DomainVO findDomainById( Credentials cred,


Long domainId)


Returns a domain by given its id.

cred – login credentials; the user must have the DOMAIN_VIEW permission

domainId – domain id

return the requested domain


6.2.6. Save Domain

DomainVO saveDomain(Credentials cred,

DomainVO domain)


Saves a domain.

cred - login credentials; the user must have the DOMAIN_ADD permission

domain to be persisted

return the domain entity after saving (it will contain the new id if it's a newly created entity)

throws EditServiceException if a domain with the same name already exists or if the database

operation fails

6.2.7. Delete Domain

boolean deleteDomain(Credentials cred,

Long id)


This method will delete the domain with provided ID

cred - login credentials; the user must have the DOMAIN_DELETE permission

Id - id of the domain to be deleted

return true if the domain was deleted or false otherwise

throws EditServiceException if the domain contains data or if the database opration fails

6.2.8. Delete Domains

void deleteDomains(Credentials cred,


Set<Long> ids)


This method will delete the domains with provided IDs

cred - login credentials; the user must have the DOMAIN_DELETE permission

ids - list of IDs for domains to be deleted

throws EditServiceException if the database opration fails

6.2.9. Search User

SearchResult<UserVO> getUsers(Credentials cred,

EditHashMap<String,Object> filterMap, SearchInfo searchInfo)


This method is used to retrieve a list of users. The search will be performed using the following

filters in the filter map:

User Name Filter: key = AdminService.USER_NAME

Domain Name Filter: key = AdminService.DOMAIN_ID

Login Name Filter: key = AdminService.LOGIN_NAME

cred – login credentials; the user must have the USER_SEARCH permission

filterMap – A map containing the filter values



return SearchResult object containing info about result and a list with all users matching the

search criteria


6.2.10. Find All Users

List<UserVO> getAllUsers(Credentials cred)


This method returns all users from the system.

cred – login credentials; the user must have the USER_SEARCH or NEWS_USER_SEARCH

permission.

return – returns a list with all the users from the system.



6.2.11. Find User By ID

UserDetailsVO getUser( Credentials credentials,

Long id)


This method returns a user by given credentials and id.

cred – login credentials; the user must have the USER_VIEW permission.

return –returns the user.


6.2.12. Find User By Credentials

UserDetailsVO getUserDetails(

Credentials credentials)


Returns a user details, the filtering is made by the user name from the credentials bean.

cred – login credentials;

return –returns the user details.


6.2.13. Find All User’s Domains

List<DomainVO> getAllUserDomains(Credentials credentials)


Returns a list with the user’s domains, user is given by the user name from the credentials bean.


return –returns the list of user’s domains.


6.2.14. Find All User and Domain’ groups

List<GroupVO> getUserDomainGroups(



Returns the list of groups for a user and domain. The user and domain are given by the

credential bean attributes.


cred – login credentials; the user must have the GROUP_SEARCH permission.

return –returns the list of groups.


6.2.15. Add user

UserDetailsVO saveUser(Credentials cred,

UserDetailsVO user)


This method saves and returns the persisted user.

cred - login credentials; the user must have the USER_ADD permission.

user – user to be persisted.

return the user entity after saving (it may contain an id if it's a newly created entity)

throws EditServiceException if user name is not a valid name or if another user with the same

name already exists

6.2.16. Delete User

boolean deleteUser(Credentials cred,

Long id)


Delete a user from the system.

cred - login credentials; the user must have the USER_DELETE permission.

id – the id of the user to be deleted.

return true if the user was deleted or false otherwise


6.2.17. Delete Users

void deleteUsers(Credentials cred,

Set<Long> ids)


Delete a set of users from the system.

cred - login credentials; the user must have the USER_DELETE permission.

ids – the list of IDs of the users to be deleted.



6.2.18. Find Group

GroupVO getGroup(Credentials cred,

Long id)


Returns a group by given credentials and group ID.

cred - login credentials; the user must have the GROUP_VIEW permission.

id – id of the group to be searched for.


6.2.19. Search Groups

SearchResult<GroupVO> getGroups(Credentials cred,

EditHashMap<String, Object> filterMap,



This method is used to retrieve groups. The search will be performed using the key =

AdminService.GROUP_NAME in the filter map.


filterMap – A map containing under the keys AdminService.GROUP_NAME the names of

the groups to be searched for.



return SearchResult object containing info about result and a list with all groups matching the

search criteria


6.2.20. Get All Groups

List<GroupVO> getAllGroups(Credentials credentials)


Retrieve all the groups in the system.


return – the list with all the groups from the system.



6.2.21. Add Group

GroupVO saveGroup(Credentials cred, GroupVO group)


Saves a group and returns the persisted group.

cred – login credentials; the user must have the GROUP_ADD

group - group to be persisted

return the group entity after saving.

throws EditServiceException if group already exists or database operation fails

6.2.22. Delete Group

boolean deleteGroup(Credentials cred,

Long id)


Delete a group from the system.

cred – login credentials; the user must have the GROUP_DELETE permission.

id - id of the group to be deleted

return - true if the group was deleted or false otherwise


6.2.23. Delete Groups

void deleteGroups(Credentials cred,

Set<Long> ids)


Delete groups from the system.

cred – login credentials; the user must have the GROUP_DELETE permission.

ids - list of IDs of the groups to be deleted


6.2.24. Find All Roles

List<RoleInfoVO> getAllRoles(Credentials cred)



Retrieve all the roles from the system.

cred – login credentials; the user must have the ROLE_SEARCH permission.

return – the list containing all the roles.


6.2.25. Search Roles

SearchResult<RoleInfoVO> getRoles(Credentials cred,




This method is used to retrieve roles. The search will be performed using the key =

AdminService.ROLE_NAME in the filter map.


filterMap – A map containing under the keys AdminService.ROLE_NAME the names of the

roles to be searched for.



return SearchResult object containing info about result and a list with all roles matching the

search criteria


6.2.26. Find All Roles For Domain

List<RoleInfoVO> getRolesForDomain(Credentials cred,

Long domainId)


Retrieve all the roles used by the users from the given domain (domain is given by domainid).


domainId – the given domain id.


6.2.27. Find Roles For User And Domain

List<RoleVO> getRolesForUserAndDomain(Credentials cred)



Retrieve all the roles for the user and domain found in the credentials bean.



6.2.28. Find Menu Permission

List<PermissionInfoVO> getMenuPermissions(Credentials credentials)


Retrieve a list of permissions for the user and domain found in credentials bean.



6.2.29. Change Current Password

UserDetailsVO changeCurrentPassword( Credentials credentials,

String oldPassword,

String newPassword)


Changes the password for the current user (Given by credentials).


oldPassword – old password.

newPassword – new password.


6.2.30. Authenticate User

void authenticateUser(String username,

String password)


Verifies the validity of the username and password. . If there are not valid the method will

throw an appropriate Exception.

username – User name.

password – User’s password


throws EditServiceException if the user or password is invalid.

6.2.31. Authenticate User On Domain

DEPRECATED

UserDetailsVO authenticateUserDomain( String username,

String password,

String domain)


Verifies the validity of the username and password for a given domain.

This method is deprecated.

username – User name.

password – User’s password

domain – Domain.

throws EditServiceException if the user , password or domain is invalid.

6.2.32. Current Domain Users

List<UserVO> getCurrentDomainUsers(Credentials credentials)


Retrieve a list of users for the current domain of the credentials.

credentials – login credentials;

return – a list of users


6.2.33. Retrieve Application Settings

ApplicationSettingsVO getApplicationSettings (Credentials credentials)


Retrieve a application settings.

credentials – login credentials; user must have the APPLICATION_SETTINGS permission

return – application settings



6.2.34. Set Default Execution Queue

void setDefaultExecutionQueue(Credentials credentials,

Long id)


Set default execution queue for jobs.

credentials – login credentials; user must have the APPLICATION_SETTINGS permission


6.2.35. Audit User Disclaimer

void disclaimerAuditUser(Credentials credentials,

DisclaimerAuditTrailVO audit)


Audit user interaction with the disclaimer.

credentials – login credentials;


6.2.36. Search Audit Disclaimer

SearchResult< DisclaimerAuditTrailVO> searchDisclaimerAudit(Credentials credentials,




This method is used to search for user audit on the disclaimer.

credentials – login credentials; the user must have the DISCLAIMER_AUDIT_VIEW

permission.

filterMap – A map containing under the filters to be applied for searching.



return - SearchResult object containing info about result and a list with all audit registers


6.2.37. Last Audit Disclaimer


DisclaimerAuditTrailVO getLastAuditDisclaimer (Credentials credentials,



This method is used to retrieve the latest audit information about user interaction with the

disclaimer.

credentials – login credentials; the user must have the ALL_USERS_IN_DOMAIN

permission.



return - lastest audit information about the disclaimer


6.2.38. Get Domain News

SearchResult< NewsVO> getDomainNews(Credentials credentials,



This method is used to retrieve news for the current domain.

credentials – login credentials; the user must have the NEWS_SEARCH permission.



return - SearchResult object containing info about result and a list with the news


6.2.39. Get News By ID

NewsVO getNews(Credentials credentials, Long id)


This method is used to retrieve news from the ID.


id - ID of the news to search for

return - news entity



6.2.40. Search News

SearchResult< NewsVO> searchNews(Credentials credentials,




This method is used to search for news.


filterMap – A map containing under the filters to be applied for searching.



return - SearchResult object containing info about result and a list with all the news found


6.2.41. Delete News

boolean deleteNews(Credentials credentials, Long id)


This method is used to delete news.

credentials – login credentials; the user must have the NEWS_CRUD permission.

id - ID of the news to be deleted

return - true if the news was deleted otherwise false


6.2.42. Publish News

void publishNews(Credentials credentials, Set<Long> id)


This method is used to publish a set of news.

credentials – login credentials; the user must have the NEWS_PUBLISH permission.

id - set of IDs for the news to be published


6.2.43. Unpublish News


void unpublishNews(Credentials credentials, Set<Long> id)


This method is used to unpublish a set of news.

credentials – login credentials; the user must have the NEWS_PUBLISH permission.

id - set of IDs for the news to be unpublished


6.2.44. Delete News

void deleteNewsList(Credentials credentials, Set<Long> ids)


This method is used to delete a set of news.


ids - set of IDs for the news to be deleted


6.2.45. Save News

NewsVO saveNews(Credentials credentials, NewsVO news)


This method is used to save news.


news - news to be saved

return - the persisted entity


6.2.46. Refresh Domain Export Status

Since v15.0.0.1

DomainIOTaskVO refreshDomainExportStatus(Credentials credentials);

This method is used to refresh the status of the domain export process that is running for the

current user.


credentials – login credentials; the user must have the DOMAIN_EXPORT permission.

6.2.47. Remove Export

Since v15.0.0.1

void removeExport(Credentials credentials) throws EditServiceException;

This method is used to remove the last domain export task and delete the exported zip file

associated with the domain export for the current user.

credentials – login credentials; the user must have the DOMAIN_EXPORT permission.


6.2.48. Import Domain

Since v15.0.0.1

void importDomain(Credentials credentials, String name,FileInfoVO fileInfo)


This method is used to import a domain from a given zip file. The method will import all

information found in the file (formats, field templates, dataset instances, programs, user

information and autodomain information).

credentials – login credentials; the user must have the .DOMAIN_IMPORT permission.

name – the name of the domain

fileInfo – FileInfoVO object containing information abouth the domain files.


6.2.49. Export Domain

Since v15.0.0.1

This method is used to export the current user’s domain. A zip file with all the domain

information (like formats, property sets, field sets, programs, datasets) is created and added to

the file repository.


void exportDomain(Credentials credentials,Long domainId)


credentials – login credentials; the user must have the .DOMAIN_ EXPORT permission.

6.2.50. View Objects Description

6.2.50.1. ApplicationSettingsVO

This object contains informations about application settings : ID and a reference to an

execution queue(ExecutionQueueVO).

6.2.50.2. DisclaimerAuditTrailVO

This object contains informations about the disclaimer audit : ID, user, domain, login date and

disclaimer type(DisclaimerAcceptationType).

6.2.50.3. DomainVO

This object contains informations about an user domain : ID, name, description and execution

queue admin mail.

6.2.50.4. GroupVO

This object contains informations about a group of users : ID, name, domain name, description

and flags for UI interaction.

6.2.50.5. NewsVO

This object contains informations about a news item :ID, headline, summary, image, type,

publish date, expiration date and domains(List<DomainVO>).

6.2.50.6. PermissionInfoVO

This object contains the name of the permission.

6.2.50.7. RoleVO

This object contains informations about a role : ID, name and the permissions that define

it(List<PermissionInfoVO>).


6.2.50.8. RoleInfoVO

This object contains the name of the role.

6.2.50.9. UserVO

This object contains the informations about an user : ID, name, domain roles

(List<DomainRoleVO>) and groups(List<UserGroupVO>).

6.2.50.10. UserDetailsVO

This object contains the details of the user : ID, name, first name, last name, password and

domain roles(List<DomainRoleDetailsVO>).

6.2.50.11. DomainIOTaskVO

This object contains information about the task: domainId, taskStateType, result.

6.3. DatasetDefinitionService

The Dataset Definition Service handles dataset format related functions and follows the

definitions from the following WSDL file:

datasetDefinitionService.xml

6.3.1. Find Dataset Definition by Name

DatasetDefinitionVO findByName(

Credentials cred,

String name)


This method is used to retrieve a format by name.

cred – login credentials; the user must have the FORMAT_VIEW

name – name of the format to be searched

return – format with provided name or null


6.3.2. Find Dataset Definition by ID


DatasetDefinitionVO getDatasetDefinition(

Credentials cred,

Long id)


This method is used to retrieve a format by ID

cred – login credentials; the user must have the FORMAT_VIEW

id - id of the format to be searched

return – format with provided id or null


6.3.3. Find All Dataset Definitions

List<DatasetDefinitionVO> getAllDatasetDefinitions(

Credentials cred)


This method is used to retrieve all datasets definition

cred - login credentials; the user must have the FORMAT_SEARCH

Return – a list containing all the formats in the system


6.3.4. Search Dataset Definition

SearchResult<DatasetDefinitionInfoVO> getDatasetDefinitions(

Credentials cred,




This method is used to retrieve the format list. The search will be performed using the value

under key= DatasetDefinitionService.DATASET_DEFINITION_NAME in the filterMap as

a substring.

cred - login credentials; the user must have the FORMAT_SEARCH

filterMap – A map containing under the keys

DatasetDefinitionService.DATASET_DEFINITION_NAME the names of the formats to be

searched for.



return SearchResult object containing info about result and a list with all formats matching the

search criteria



6.3.5. Import Dataset Definition

void importDatasetDefinition(

Credentials cred,

String fdlContent)


Load a format written in dataset definition language.

cred – login credentials; the user must have the FORMAT_IMPORT

fdlContent – format definition in the format definition language

throws EditServiceException – if the FDL string is empty or if another format with the same

name already exists or if the database operation fails.

6.3.6. Import Required Dataset Definition

void importRequiredDatasetDefinition(

Credentials cred)


Import the error and statistical dataset definition on the user, given by credentials, domain.

cred – login credentials; the user must have the FORMAT_IMPORT

throws EditServiceException – if the operation fails.

6.3.7. Export Dataset Definition

String exportDatasetDefinition(

Credentials cred,

Long dsdId)


Export a format in dataset definition language syntax.

cred - login credentials; the user must have the FORMAT_EXPORT

dsdName – the name of the format to be exported

return – a string describing the format in the dataset definition language

throws EditServiceException if a format with provided name is not found.


6.3.8. Save Dataset Definition

void saveDatasetDefinition(

Credentials cred,

DatasetDefinitionVO formatVO) throws EditServiceException;

Save a dataset definition given by formatVO.

cred - login credentials. ; the user must have the FORMAT_ADD permission

formatVO – the format which will be saved.

throws EditServiceException – if the operation fails.

6.3.9. Delete Dataset Definition

void deleteDatasetDefinition(

Credentials cred,

Long id)


Delete the format with given id.

cred - login credentials; the user must have the FORMAT_DELETE

id – the id of the format to be deleted

throws EditServiceException if a format with provided name is not found or database

operation fails

6.3.10. Check Dataset Definition Syntax

void checkDatasetDefinitionScript(

Credentials cred,

String fdlContent)


Verify the syntax of a script written in dataset definition language.

cred - login credentials; the user must have the FORMAT_CHECK_SCRIPT

fdlContent – script content written in dataset definition language

throws EditServiceException if the script is empty or the content of the script is not a valid

dataset definition

6.3.11. Dataset Definition Filtered

DatasetDefinitionContentVO


getDatasetDefinitionFiltered(Credentials credentials,

Long id, SearchInfo searchInfo)


Used to retrieve a format by ID using SearchInfo searchInfo

credentials - login credentials; the user must have the FORMAT_VIEW permission

id - dataset definition id



return – dataset definition content


6.3.12. Delete Dataset Definitions

void deleteDatasetDefinitions (Credentials credentials,

Set<Long> ids)


Used to delete a set of dataset definitions.

credentials - login credentials; the user must have the FORMAT_DELETE permission

ids - dataset definition IDs to be deleted


6.3.13. Import GESMES Dataset Definition

GESMESUpload importGESMESDatasetDefinition (Credentials credentials,

GESMESUpload gesmesUpload)


Loads the GESMES definition.


credentials - login credentials; the user must have the FORMAT_GESMES_IMPORT

permission

gesmesUpload - GESMES definition to be uploaded

return – persisted entity


6.3.14. Synchronize Selected List

Set<Long> synchronizeSelectedList(Credentials credentials,

Set<Long> formatIds)


Checks if the IDs from the parameter exist in the database.

credentials - login credentials; the user must have the FORMAT_SEARCH permission

formatIds - IDs to be checked

return – list of IDs found in the database


6.3.15. Load SDMX registry

void importSDMXDatasetDefinition(Credentials credentials,

SDMXUpload sdmxUpload)


Loads a SDMX registry.

credentials - login credentials; the user must have the FORMAT_SDMX_IMPORT permission

sdmxUpload - SDMX to upload


6.3.16. Check Missing Values


Since v14.0.0.0

public List<String> checkMissingValues(Credentials credentials, String missingValue)


This method is used to extract missing values.

credentials - login credentials; the user must have the FORMAT_IMPORT permission

missingValue – the value to check

return – list of missing values



6.3.17.1. GESMESUpload

This object contains informations about GESMES upload result : format name, program name

and uploaded file ID.

6.3.17.2. SDMXUpload

This object contains informations about SDMX import options : dataset name and version.

6.4. DatasetService

The Dataset Service handles dataset related functions and follows the definitions from the


datasetService.xml

6.4.1. Find Dataset

DatasetDefinitionVO getDatasetInstanceDefinition(

Credentials cred,

Long datasetId)


This method is used to retrieve dataset format associated with the given dataset

cred - login credentials; the user must have the FORMAT_VIEW

DatasetId – the ID of the dataset for which the format is searched

Return – the format associated with the dataset


throws EditServiceException – id the database operation fails

6.4.2. Search Datasets

SearchResult<DatasetInfoVO> getDatasets(

Credentials cred,




This method is used to retrieve the datasets list. The search will be performed using the value

under key= DatasetService.DATASET_ NAME in the filterMap as a substring.

cred - login credentials; the user must have the DATASET_SEARCH permission.

filterMap – A map containing under the keys DatasetService.DATASET_ NAME the names

of the datasets to be searched for.



return SearchResult object containing info about result and a list with all datasets matching the

search criteria


6.4.3. Find Dataset Instance

DatasetInstanceVO getDatasetInstance(

Credentials cred,

Long id)


Retrieve the dataset instance having the provided ID.

cred - login credentials. the user must have the DATASET_VIEW permission.

Id – the ID of the dataset to be searched

Return – the dataset instance with provided ID

throws EditServiceException if no dataset is found or database operation fails

6.4.4. Find Dataset Instances

List<DatasetInstanceVO> getDatasetInstances(

Credentials credentials,

Set<Long> datasetInstanceIds)



Retrieve a list of dataset instances from the list of IDs.

credentials - login credentials. the user must have the DATASET_VIEW permission.

datasetInstanceIds – the list of IDs to be searched

return – list of dataset instances


6.4.5. EDAMIS Tokens

Set<String> edamisTokens (Credentials credentials)


Retrieve a list of strings as the tokens for EDAMIS.

credentials - login credentials. the user must have the EDAMIS_TOKENS_VIEW permission.

return – list of EDAMIS tokens


6.4.6. EDAMIS Metadata

Map<String, String> datasetEdamisMetadata(Credentials credentials,

Long datasetId,

boolean partialOk)


Retrieve a map of strings as the EDAMIS metadata for a dataset instance.

credentials - login credentials. the user must have the DATASET_METADATA_VIEW

permission.

datasetId - the dataset instance to search for EDAMIS metadata

partialOk - true if should return only the known types, false if it should return all of them

return – map of EDAMIS tokens


6.4.7. Chek auto process

AutoProcessibleStatus isAutoProcessPossible (Credentials credentials,

Long datasetId)



Check if the dataset instance can be processed automatically.

credentials - login credentials. the user must have the DATASET_METADATA_VIEW

permission.

datasetId - the ID of the dataset instance to be checked for auto processing.

return – the auto processing status


6.4.8. Update Dataset Metadata

void updateDatasetMetadata (Credentials credentials,

Long datasetId,

EditHashMap<String, String> metadata,

boolean verifyAllMandatory)


Update the corresponding dataset metadata with the given values.

credentials - login credentials. the user must have the DATASET_METADATA_EDIT

permission.

datasetId - the ID of the dataset instance to be searched for metadata.

metadata - map of values that should update the corresponding metadata definition

verifyAllMandatory - flag to indicate if the new metadata values has the mandatory fields


6.4.9. Find Dataset Instance By Dataset Definition

List<DatasetInfoVO> getDatasetInstanceByDatasetDefintionId(

Credentials cred,

Long id)


Retrieve all the datasets associated with provided format.

cred - login credentials; the user must have the DATASET_VIEW

Id – the ID of the format

Return – list of the datasets associated with the given format



6.4.10. Find Dataset Instance By Dataset Definition And Type

List<DatasetInfoVO> getDatasetInstanceByDatasetDefintionIdAndType(


Long id,

DatasetInstanceType type)


Retrieve all the datasets associated with provided format and has one of the

DatasetInstanceTypes: IMPORTED, OUTPUT, ERROR_REPORT, VALID_DATA,

INVALID_DATA

cred - login credentials; the user must have the DATASET_VIEW

id – the ID of the format

type – One of the DatasetInstanceTypes: IMPORTED, OUTPUT, ERROR_REPORT,

VALID_DATA, INVALID_DATA

return – list of the datasets associated with the given format


6.4.11. Find Dataset Instance Content And Dataset Definition

DatasetVO getDataset(Credentials cred,

Long datasetId,



Retrieve a dataset instance, its rows and dataset definition according to searchInfo.


datasetId– the ID of the dataset instance

return – dataset details page


6.4.12. Retrieve Dataset Row Or Partition

DatasetRowVO getDatasetRow(Credentials cred,

Long datasetId,


Long rowId,

SearchInfo searchInfo,

List<String> columns)


Retrieve a dataset instance’s row, identified by its datasetId and rowed. The method can

retrieve also a partition, for this is needed searchInfo argument.


datasetId– the ID of the dataset instance.

rowid – the id of the row.

searchInfo – search information for partition.

return – dataset details page.


6.4.13. Retrieve Partition Values

PartitionValuesVO getPartitionValues(Credentials cred,

List<String> partition,

Long datasetId ) throws EditServiceException;

Retrieve all the partitions defined by List<String> partition columns from the dataset instance

identified by its datasetId.



partition – partition columns.

return – partions columns and values.


6.4.14. Retrieve Hierarchical Dataset Instance

DatasetVO getDatasetHierarchical(

Credentials cred,

Long datasetId,



The method retrieve a hierarchical dataset instance.






return DatasetVO object containing info about hierarchical dataset result.


6.4.15. Finds If A Dataset Is Hierarchical

boolean getDatasetIsHierarchical(

Credentials cred,

Long id)


The method checks if a dataset is hierarchical.



return – true or false as dataset is hierarchical or not.


6.4.16. Check The Existance Of A Dataset Insance

boolean datasetExists(Credentials cred,

String domain,

String datasetName)


Tests if the named dataset instance exists in the given domain.


domain – the domain name.

datasetName– the name of the dataset instance.

return – true or false as dataset exists or not.


6.4.17. Set Dataset Owner Group

void setOwnerGroupsDataset(Credentials cred,

Long datasetId,

Long owner)


The method sets dataset owner group.

cred - login credentials. the user must have the DATASET_ADD permission.



owner – the Id of the owner group.


6.4.18. Add Dataset

Long saveDataset(Credentials cred, DatasetInstanceVO datasetInstance,

boolean createTable)


Save a dataset instance.

cred – login credentials; the user must have the DATASET_ADD permission.

datasetInstance – the dataset instance to be persisted.

createTable – if true a new table will be created for storing dataset instance data.

return – the ID of the newly added dataset instance.


6.4.19. Delete Dataset By Id

void delete(Credentials cred, Long datasetId) throws EditServiceException;

Delete the dataset instance with the provided ID.

cred – login credentials. the user must have the DATASET_DELETE permission.

datasetId – the ID of the dataset to be deleted.


6.4.20. Delete Dataset By Name

void deleteByName (Credentials cred, String name) throws EditServiceException;

Delete the dataset instance with the provided name.

cred – login credentials. the user must have the DATASET_DELETE permission.

name – the name of the dataset instance to be deleted.


6.4.21. Retrieve Dataset Line Chart


String getReportString(Credentials cred,

List<String> trkey,

List<String> valueColumns,

List<String> partition,

Object[] partitionValues,

Long datasetId,



The method returns a line chart as a JSON string.

Used for graphical reports, the method provide a way to display dataset parts of a dataset

filtering the content by partitions, columns, values of the partions or the columns.

cred – login credentials. the user must have the DATASET_GRAPHICS_VIEW permission.

trkey – columns displayed on the ox axes, can be seen as transpositions on a partition display.

valueColumns – columns display on the oy axes, this can be only columns of numeric type.

partition – the graphic can be split into partitions, this are the partition columns.

partitionValues – the values for each partition if the graphic is split on partitions.

searchInfo – not used in the current implementation.

return – an OpenLineChart object as JSON string.

throws EditServiceException if the operation fails, or the graphic is too large and cannot be

displayed.

6.4.22. Delete Datasets

void deleteDatasets(Credentials credentials, Set<Long> datasetIds)


Deletes a set of datasets.

cred – login credentials. . the user must have the FORMAT_VIEW permission.

datasetIds - set of ids that should be deleted


6.4.23. Find Hierarchical Structures

Since v14.0.0.0

List<DatasetInfoVO> getHierarchicalStructures(Credentials credentials);

This method is used to retrieve all the datasets that qualify as hierarchical structures.


credentials – login credentials. . the user must have the FORMAT_VIEW permission.

return – a list of DatasetInfoVO objects

6.4.24. Find Hierarchical Breakdowns

Since v14.0.0.0

List<DatasetInfoVO> getHierarchicalBreakdowns(Credentials credentials, Long id)


Retrieves a list of hierarchical breakdowns for a specific hierarchical structure.

credentials – login credentials. . the user must have the DATASET_VIEW permission.

id – dataset instance id

return – a list of DatasetInfoVO objects


6.4.25. Generate Breakdown

Since v14.0.0.0

Long generateBreakdown(Credentials credentials,

HierarchicalOptionsVO hierarchicalOptions)


Initiates a Generate Breakdown task if it doesn't exist / retrieves a Generate Breakdown status /

result if it was already submitted.

credentials – login credentials. . the user must have the DATASET_VIEW permission.

hierarchicalOptions – HierarchicalOptionsVO object with information of the breakdown

return – of the new hierarchical breakdown object




6.4.26.1. AutoProcessibleStatus

This enumeration contains the possible statuses of a dataset related to the auto process:

PROCESSIBLE - Dataset can be submitted for auto-process

MISSING_METADATA - Dataset cannot be submitted for auto-process, because

metadata are missing, totally or partially

NO_AUTO_PROGRAM - Dataset cannot be submitted for auto-process, because there

is no dynamic program to handle it

ALREADY_PROCESSED - Dataset cannot be submitted for auto-process, because it

has already been auto-processed

6.4.26.2. DatasetRowVO

This object contains informations about a row in a dataset : ID, a map of key/value pairs

representing the values in the row and a reference to partition data.

6.4.26.3. DatasetInfoVO

This object contains informations about the dataset instance : ID, name, original file name,

owner group, format name, number of records and online status(DatasetInstanceStatus).

6.4.26.4. DatasetInstanceVO

This object contains details about the dataset instance : ID, name, description, table name,

dataset definition name and status(DatasetInstanceStatus).

6.4.26.5. DatasetInstanceType

This enumeration contains the types of dataset instances: IMPORTED (Imported by the User),

OUTPUT(Generated by the execution of a dataset operation), ERROR_REPORT(Error report

generated by a validation step), VALID_DATA(Valid data generated by a validation step),

INVALID_DATA(Invalid data generated by a validation step), OUTPUTCHIFFRIERTOT,

OUTPUTCHIFFRIERVAL, OUTPUTERRORREPORT, OUTPUTCHIFFRIERERR,

OUTPUTSSS, OUTPUTBRE, OUTPUTBRI, OUTPUTMAJPREV, OUTPUTPREV,

OUTPUTCHIFFRIERREF, OUTPUTPUB, OUTPUTVALIDDATA, OUTPUTCH9899.

6.4.26.6. PartitionValuesVO

This object contains informations about a dataset partition : dataset definition name, partition

fields(ArrayList<String>) and partition fields values(ArrayList<Object[]>).

6.4.26.7. HierarchicalOptionsVO

This object contains information about a hierarchical breakdown : hierarchicalStructure,

repopulateDataset, createDataset.


6.5. ImportExportService

The Import Export Service handles import/export related functions and follows the definitions


importExportService.xml

6.5.1. Start Import

Long startImport(Credentials credentials,

ImportOptionsVO importOptions)


This method is used to start a task that import file data with different data formats into datasets

tables.

credentials - login credentials; the user must have the DATASET_IMPORT

importOptions – options of the import task

return - the task ID that perform the import

throws EditServiceException if dataset already exists or the task fails to start

6.5.2. Start Export

Long startExport(


ExportOptionsVO exportOptions)


Start a task that will export dataset table’s data into files based on provided options.

credentials - login credentials; the user must have the DATASET_EXPORT

exportOptions - options of the export task

return - the task ID that perform the export

throws EditServiceException if the task fails to start

6.5.3. Retrive Import Plugin Names

List<String> getImportPluginNames(




This method retrieves available import plug-ins.

credentials - login credentials; the user must have the GET_IMPORT_PLUGIN_NAMES

return - a list with import plug-in names


6.5.4. Retrieve Export Plugin Names

List<String> getExportPluginNames(



This method gets available export plug-ins.

credentials - login credentials; the user must have the GET_EXPORT_PLUGIN_NAMES

return a list with export plug-in names


6.5.5. Search Tasks

SearchResult<TaskInfoVO> getTasks(


Map<String, Object> filterMap,


throws EditServiceException

This method is used to retrieve a list of tasks that performs import/export operations.The search

will be performed using the following filters:

Task Type filter: key= TaskService.FILTER_TASK_TYPE in the filterMap

User Name filter: key= TaskService.FILTER_USER_NAME in the filterMap

Dataset Name filter: key= TaskService.FILTER_DATASET_NAME in the filterMap

credentials - login credentials; the user must have the TASK_SEARCH

filterMap – A map containing under the keys TaskService.FILTER_TASK_TYPE the type of

the tasks to be searched for.



return SearchResult object containing info about result and a list with all tasks matching the

search criteria



6.5.6. Find Task Status

List<TaskUpdateStatusVO> getTaskStatus(


ArrayList<Long> ids)


Retrieve the status of the given tasks.

credentials - login credentials; the user must have the TASK_SEARCH.

ids – list of task’s ID for which the status is searched.

return – list with status of each task.


6.5.7. Delete Task

void deleteTask(Credentials credentials,

Long taskId)

throws EditServiceException, EditServiceAuthenticationException;

Delete a task given by its taskid.

credentials – login credentials; user must have PermissionName.TASK_DELETE.

taskId – the ID of the task that will be deleted.


6.5.8. Cancel Task

void cancelTask(Credentials cred,

Long taskId)


The method stops a task given by its taskId.

credentials – login credentials. user must have PermissionName.TASK_CANCEL.

taskId – the ID of the task that will be canceled.

throws EditServiceException if the cancel operation fails.

6.5.9. Export Task or Start New

Long getExportTaskOrStartNew(Credentials credentials,

ExportOptionsVO exportOptions)



If the corresponding task exists the method will return the task, else a new task is created.

credentials – login credentials. user must have PermissionName.DATASET_EXPORT.

exportOptions - options used to search for the export task

return – the id of the task


6.5.10. Delete Tasks

void deleteTasks(Credentials credentials, Set<Long> taskIds)

throws EditServiceException, EditServiceAuthenticationException;

Delete a set of tasks

credentials – login credentials. user must have PermissionName.TASK_DELETE.

taskIds - set of task ids

throws EditServiceException, EditServiceAuthenticationException if the operation fails.

6.5.11. Start Preediting

void startPreediting (Credentials credentials,

PreeditingOptionsVO options)


Start a preediting task based on an existing preediting job.

credentials – login credentials. user must have PermissionName.JOB_ADD.

options - options to start the task


6.5.12. Find SDMX Key Families

Since v14.0.1.0

EditHashMap<String, String> getSDMXKeyFamilies Credentials credentials)



This method is used to retrieve a map of files and their paths from the SDMX key families

repository folder.

credentials – login credentials. user must have PermissionName.

GET_IMPORT_PLUGIN_NAMES.

return – key value map of the files and their path.



6.5.13.1. ExportOptionsVO

This object contains the informations related to export of a file : ID, file type, property set

(PropertySetVO), compress, max errors, sorted fields(List<SortField>), emails(List<String>),

publish informations(List<PublishInfoVO>) and contact keys(List<String>).

6.5.13.2. ImportOptionsVO

This object contains informations related to import of a file: ID, file type, dataset definition id,

dataset instance name, field set(FieldSetVO) and property set(PropertySetVO).

6.5.13.3. PreeditingOptionsVO

This object contains the id of the job.

6.5.13.4. TaskInfoVO

This object contains informations about a task : ID, username, file name, dataset instance name,

dataset definition name, ID of the job, type, start time, end time, error count, state, data file ID

and log file ID.

6.5.13.5. TaskUpdateStatusVO

This object contains informations related to the updated status of a task; status, start time, end

time, error count, task ID, data file ID, log file ID and dataset instance ID.


6.6. JobService

The Job Service handles job related functions and follows the definitions from the following

WSDL file:

jobService.xml

6.6.1. Find Job

JobVO getJob(Credentials cred,

Long id)


Retrieve the job with the given ID or null.

cred– login credentials. user must have PermissionName.JOB_VIEW.

id – the ID of the job to be searched.

return – the job with provided ID or null.


6.6.2. Find Job Details

JobDetailsVO getJobDetails(Credentials cred,

Long id)


Retrieve details about the job with the given ID.

cred– login credentials. user must have PermissionName.JOB_VIEW

id – the ID of the job to be searched

return – details about the job with provided ID or null


6.6.3. Search Jobs

SearchResult<JobInfoVO> getJobs(Credentials cred,

EditHashMap<String,Object> filterMap, SearchInfo searchInfo)


This method is used to retrieve a list of jobs. The search will be performed using the value

under

key= JobService.JOB_NAME in the filterMap as a substring.


cred - login credentials; the user must have the JOB_SEARCH

filterMap – A map containing under the keys JobService.JOB_ NAME the names of the jobs

to be searched for.



return SearchResult object containing info about result and a list with all jobs matching the

search criteria


6.6.4. Find Job Statistics

List<JobStatisticsVO> getJobStatistics (Credentials cred,

Long datasetInstanceId) throws EditServiceException;

Retrieve statistics of a job performed on a given dataset instance.

cred - login credentials; the user must have the JOB_ VIEW

datasetInstanceId – ID of the dataset instance

return - list of statistics of jobs associated with the dataset instance


6.6.5. Add Job

Long saveJob(Credentials cred,

JobVO jobVO)


The method persist the job given by jobVO.

cred - login credentials; the user must have the JOB_CREATE.

jobVO – details about the job to be persisted.

return – the ID of the newly created job.

throws EditServiceException if a job with the same name already exists or database operation

fails.

6.6.6. Delete Job

boolean deleteJob(Credentials cred,

Long id,

Boolean deleteDatasets)


Delete the job with the given ID.

cred– login credentials. user must have PermissionName.JOB_DELETE

id – the ID of the job to be deleted

return – true if the job was successfully deleted


throws EditServiceException if a job with the given name is not found or database operation

fails.

6.6.7. Retrieve Job Status

List<JobUpdateVO> getStatusJob(


ArrayList<Long> ids)


The method retrieve a list of the statuses of all the given jobs ids.

cred - login credentials; the user must have the JOB_SEARCH permission.

ids – a list of job ids.

return - list of jobs statuses.


6.6.8. Start Job

void startJob( Credentials cred,

Long id)


Start the job with given ID.

cred– login credentials.

id – the ID of the job to be started.

throws EditServiceException if the job fails to start.

6.6.9. Start Job Synchronized

void startJobSync(Credentials cred,

Long id)


Start job with given ID. The caller will be blocked until the job ends.

cred– login credentials. the user must have the JOB_EXECUTE permission.

id – the ID of the job to be started

throws EditServiceException if the job fails to start


6.6.10. Stop Job

void stopJob( Credentials cred,

Long id)


Stop the job with given ID.

cred– login credentials. the user must have the JOB_CANCEL permission.

id – the ID of the job to be stoped.

throws EditServiceException if the job fails to stop.

6.6.11. Retrieve Job Script

String getJobPdlScript(Credentials cred, Long id)


Return a string containing the job script written in Program Definition Language

cred– login credentials. user must have PermissionName.JOB_VIEW

id – the ID of the job to be searched

return – the string representation of the job written in Program Definition Language


6.6.12. Job Details with Reports

JobDetailsReportsVO getJobDetailsWithReports(Credentials credentials,

Long id)


Returns the details of the job execution, including any generated reports

credentials – login credentials. user must have PermissionName.JOB_VIEW

return – the details report of the job



6.6.13. Job Statistics Aggregation

List<JobStatisticsVO> getJobStatisticsAggregation(Credentials credentials,

Long datasetInstanceId,

List<ColumnAggregationVO> columnAggregation)


Retrieve statistics of a job performed on a given dataset instance with aggregation on custom

column.

credentials – login credentials. user must have PermissionName.JOB_VIEW

datasetInstanceId - dataset instance id on which the job has been performed

columnAggregation - list of the columns for which will be computed the aggregation

return – the list of statistics for the aggregation


6.6.14. Delete Jobs

void deleteJob(Credentials credentials,

Set<Long> jobIds,

Boolean deleteDatasets)


Delete the jobs with the given IDs.

credentials – login credentials. user must have PermissionName.JOB_DELETE permission

jobIds – the IDs of the jobs to be deleted

deleteDatasets - flag for deleting the related datasets of the jobs


6.6.15. Publish Report

void publishReport(Credentials credentials,

Long id,

String referenceName)


Publish informations from a job file.


credentials – login credentials. user must have PermissionName.REPORT_PUBLISH

permission

id – the ID of the job

referenceName - the reference name of the file from the job to be published


6.6.16. Get Default Name Prefix

String defaultNamePrefix (Credentials credentials,

Long programId,

String datasetName)


Returns the name prefix of the job in order to start the program.

credentials – login credentials. user must have JOB_EXECUTE permission

programId – the ID of the program

datasetName - the name of the dataset that will be the input for the program

return - job prefix


6.6.17. Find Job Naming Rule

JobNamingRuleVO findJobNamingRule(Credentials credentials)


Returns the job naming rule for the current domain.

credentials – login credentials. user must have

PermissionName. JOB_NAMING_RULE_EDIT permission

return - job naming rule


6.6.18. Update Job Naming Rule

JobNamingRuleVO updateJobNamingRule (Credentials credentials,

JobNamingRuleVO jobNamingRuleVO)


Update job naming rule for the current domain.



PermissionName. JOB_NAMING_RULE_EDIT permission

jobNamingRuleVO - job naming rule update

return - the updated job naming rule


6.6.19. Trigger Auto Processing

void triggerAutoProcessing(Credentials credentials,

long datasetInstanceId)


Trigger auto processing for the dataset instance.


PermissionName. DATASET_AUTO_PROCESS_START permission

datasetInstanceId - ID of the dataset to be triggerd for auto processing


6.6.20. Change Executin Queue

void requestChangeExecutionQueue (Credentials credentials,

long jobId)


Send an email for requesting to change the execution queue of a job.

credentials – login credentials. user must have PermissionName.JOB_ADD permission

jobId - ID of the job for which the execution queue will be changed


6.6.21. Change Execution Queue

ExecutionQueueVO changeExecutionQueue (Credentials credentials,

long jobId,

String executionQueue)


Change the execution queue for a job.


jobId - ID of the job for which the execution queue will be changed

executionQueue - name of the new queue for the job



6.6.22. Reject High Priority Request

void rejectHighPriorityRequest(Credentials credentials,

long jobId)


Change job execution queue request status as rejected.


jobId - ID of the job


6.6.23. Get Default Name Prefix External

Since v14.0.2.1

String defaultNamePrefixExt (Credentials credentials,

Long programId,

String datasetName,

String externalFilename)


Returns the name prefix of the job based on an external file in order to start the program.

credentials – login credentials. user must have JOB_EXECUTE permission

programId – the ID of the program

datasetName - the name of the dataset that will be the input for the program

externalFilename – external file name used to extract metadata

return - job prefix



6.6.24.1. ColumnAggregationVO

This object contains informations about the aggregation on a column : column name,

aggregation type(AggregateToVariableType) and value.


6.6.24.2. JobVO

This object contains informations about a job : ID, name, execution queue

(ExecutionQueueVO), execution queue status request(JobExecutionQueueStatusRequest),

schedule start date, start date, end date, summary, program ID, status(JobStatus), dataset

references(List<JobDatasetReferenceVO>) and parameter set(JobParameterSetVO).

6.6.24.3. JobDetailsVO

This object contains informations about the details of a job : ID, name, schedule start date, start

date, end date, summary, program name, status(JobStatus), program type(ProgramType), job

dataset references(List<JobDatasetReferenceDetailsVO>), parameter set (JobParameterSetVO)

, log file name, number of fatal errors.

6.6.24.4. JobDetailsReportsVO

This object contains a list of job reports(List<JobReportVO>).

6.6.24.5. JobInfoVO

This object contains informations about a job: ID, name, start date, end date, summary, user,

program, status, execution queue name, execution queue description, change queue request

status name and change queue request status description.

6.6.24.6. JobNamingRuleVO

This object contains the informations about job naming rule : ID and rule details.

6.6.24.7. JobStatisticsVO

This object contains informations about job statistics : rule name, number of failures,

expression message and column aggregations(List<ColumnAggregationVO>).

6.6.24.8. JobUpdateVO

This object contains informations about job update status : ID of the job, status, start time, end

time and message in case of failure.

6.7. ProgramService

The Program Service handles program related functions and follows the definitions from the


programService.xml


6.7.1. Find Program

ProgramWithDsdInfoVO getProgram(

Credentials cred,

Long programId)


Search for a program with provided ID.

cred– login credentials. user must have PermissionName.PROGRAM_VIEW

programId – the ID of the program to be searched

return - the program with the given ID or null if the program does not exists


6.7.2. Search Programs

SearchResult<ProgramInfoVO> getPrograms(

Credentials cred,

EditHashMap<String, Object> filterMap, SearchInfo searchInfo)


This method is used to retrieve the program list

The search will be performed using the value under key=

ProgramService.PROGRAM_NAME in the filterMap as a substring.

cred - login credentials. user must have PermissionName.PROGRAM_SEARCH

filterMap – A map containing under the keys ProgramService.PROGRAM_ NAME the names

of the programs to be searched for.



return SearchResult object containing info about result and a list with all programs matching

the search criteria


6.7.3. Import Program

List<Long> importProgram(Credentials cred, String fileContent, Boolean simplified

) throws EditServiceException, EditParserException;

Load a program written in Program Definition Language.

cred - - login credentials. user must have PermissionName.PROGRAM_IMPORT.

fileContent – string representation of a program written in Program Definition Language


simplified - is true if the program is in simplified style.

return – the list of the imported programs ids.

throws EditServiceException if the script is not valid or database operation fails.

6.7.4. Export Program

String exportProgram(Credentials cred,

Long programId,

Boolean xmlExport

) throws EditServiceException;

Export a program object in Program Definition Language

cred - login credentials. user must have PermissionName.PROGRAM_EXPORT

programId – the ID of the program to be exported

xmlExport – if true the export will generate a simplified version of the program.

return - representation of the program written in Program Definition Language


6.7.5. Delete Program

void deleteProgram(Credentials cred, Long id)


This method is used to delete a program given by its id.

cred - login credentials. user must have PermissionName.PROGRAM_DELETE

id – the ID of the program that will be deleted

throws EditServiceException if the program does not exists or database operation fails

6.7.6. Get Program Details

ProgramViewVO getProgramView(Credentials cred, Long programId)


Retrieve details about a program with given ID.

cred - login credentials. user must have PermissionName.PROGRAM_VIEW

programId – the program id.

return – program details.



6.7.7. Retrieve the program Schedule

ProgramScheduleVO getProgramSchedule(Credentials cred, Long programId)


Get the program schedule.

cred - login credentials. user must have PermissionName.PROGRAM_SEARCH.

programId - the ID of the program .

return – the schedule of the job on which the program will be executed.

throws EditServiceException if the database operation fails.

6.7.8. Verify Program Script

void checkProgramScript(Credentials cred, String pdlContent)


This method is used to check a program script.


pdlContent – the string representation of the program written in Program Definition Language

throws EditServiceException if script is not a valid program

6.7.9. Retrieve Program Dataset References

List<DatasetReferenceDetailsVO> getProgramDatasetReferences(

Credentials cred,

Long programId)


Retrieve the program’s dataset references.



return – the list of dataset references.



6.7.10. Verify if a program can be deleted

boolean canDeleteProgram(

Credentials cred,

Long programId)


This method checks that a program can be deleted.

cred - login credentials. user must have PermissionName.PROGRAM_VIEW or

PermissionName.PROGRAM_EDIT


return – true if the program can be deleted.


6.7.11. Get Unique Suffix

String getUniqueSuffix(Credentials cred) throws EditServiceException;

This method returns the unique suffix for job creation.

cred - login credentials.

return – the unique suffix


6.7.12. Delete Programs

void deletePrograms(Credentials credentials,

Set<Long> ids)


This method is used to delete more programs given a set IDs.

credentials - login credentials. user must have PermissionName.PROGRAM_DELETE

ids - the IDs of the programs to delete.


6.7.13. Import And Rename Program

EditHashMap<String, String> importRenameProgram (



String fileContent,

Boolean simplified,

Boolean rename)

throws EditServiceException, EditParserException;

Imports the program in a simplified form or not and with the possiblity to rename it if exists.

credentials - login credentials. user must have PermissionName.PROGRAM_IMPORT

fileContent - the content of the program

simplified - import in a simplified form

rename - rename the existing program

return – map of the renamed programs


6.7.14. Synchronized Selected List

Set<Long> synchronizeSelectedList(


Set<Long> programIds);

Returns a list of the existing programs from the list received as parameter.

credentials - login credentials. user must have PermissionName.PROGRAM_SEARCH

permission

programIds - a set of program IDs

return – set of existing program IDs

6.7.15. Import EVE program

List<Long> importEBBEVEProgram(Credentials credentials,

String fileContent,

SerialUpload serialUpload)


Imports the EVE program given in the fileContent

credentials - login credentials. user must have PermissionName.PROGRAM_IMPORT

fileContent - content of the file


serialUpload - program details

return – ids of the programs


6.7.16. Retrieve Details for Export Program With Dependencies

ProgramWithDepsVO getExportProgramWithDependencies(Credentials credentials,

Long programId)


Creates the VO for the export program with dependencies

credentials - login credentials. user must have

PermissionName.PROGRAM_EXPORT_WITH_DEPENDENCIES

programId - id of the program

return – the VO for the exported program


6.7.17. Export Program With Dependencies

DataHandler exportProgramWithDependencies (Credentials credentials,

Long programId)


Creates a DataHandler for the export program with dependencies


PermissionName.PROGRAM_EXPORT_WITH_DEPENDENCIES

programId - id of the program

return – the DataHandler for the exported program


6.7.18. Create Import Program With Dependencies From File

ProgramWithDepsVO getImportProgramWithDependencies (Credentials credentials,


Long fileInfoId)


Creates a VO for program import with dependencies from the archive file


PermissionName.PROGRAM_IMPORT_WITH_DEPENDENCIES

fileInfoId - id of the program

return – the VO for import (including the incompatibilites and overwrites)


6.7.19. Import Program With Dependencies

void importProgramWithDependencies (Credentials credentials,

ProgramWithDepsVO programWithDepsVO)


Import program with dependencies from VO.


PermissionName.PROGRAM_IMPORT_WITH_DEPENDENCIES

programWithDepsVO - program with dependencies VO


6.7.20. Get Program List

Since v14.0.0.0

List<ProgramInfoVO> getPrograms(Credentials credentials)

The method is used to retrieve a list of programs belonging to the logged in user’s domain.

credentials - login credentials. user must have PermissionName.PROGRAM_SEARCH

return - a list with all programs with the same domain id as the logged in user.



6.7.21.1. ProgramWithDsdInfoVO

This object contains informations about a program and its related formats and has the following

fields : program(ProgramVO), dataset definitions(List<DatasetDefinitionVO>) and key

sets(List<KeySetVO>).

6.7.21.2. ProgramInfoVO

This object contains informations about a program : ID, name and description.

6.7.21.3. ProgramViewVO

This object contains the details of a program : ID, name, description and the content of the

script.

6.7.21.4. ProgramScheduleVO

This object contains the informations related to program schedule : ID of the program, name,

description, parameter sets(List<ParameterSetVO>), parameters(List<ParameterVO>), dataset

references(List<ScheduleDatasetReferenceVO>), steps(List<ProgramStepVO>) and type.

6.7.21.5. SerialUpload

This object contains informations about the upload of a program : program name, dataset

definition ID and simplified form(boolean).

6.8. ProgramEditorService

The Program Editor Service handles program editor related functions and follows the


programEditService.xml

6.8.1. Retrieve Program For Edit

PdtProgramInfoVO getProgramEditInfo(

Credentials cred,

Long programId)



This method is used to retrieve the program for edit.

cred - login credentials. the user must have the PROGRAM_VIEW permission.


return – the program.


6.8.2. Retrieve Program For Edit

List<PdtTemplateVO> getTemplates(

Credentials cred,

TemplateType type)


This method retrieves the templates for: DATAOPERATION, FUNCTION, OPERATION,

HORIZONTAL_RULE.

cred - login credentials. the user must have the SL_TEMPLATES_VIEW permission

type – the type of template: DATAOPERATION, FUNCTION, OPERATION,

HORIZONTAL_RULE.

return – the list of tempalates.


6.8.3. Retrieve The Keysets For A Dataset Definition

List<KeySetVO> getKeysetsForDsd(

Credentials cred,

String dsdName)


Retrieve the list of keysets for a give dataset definition.

cred - login credentials. The user must have the KEYSETS_VIEW permission.

dsdName –The name of the dataset definition.

return – the list of keysets.


6.8.4. Retrieve The Keysets For Template


List<KeySetVO> getKeysetsForTemplateName(

Credentials cred,

String name)


Retrieve a list of keysets for a given keyset template name.

cred - login credentials. The user must have the KEYSETS_VIEW permission.

name –The name of the keyset template name.

return – the list of keysets.


6.8.5. Validate A Program

PdtProgramInfoVO validateProgram(

Credentials cred,

PdtProgramVO program,

EditHashMap<String, DatasetDefinitionVO> assumedRefsVO,

EditHashMap<String,KeysetsTemplateVO[]> dsdKeysets,

EditHashMap<String, PdtProgramInputDatasourceVO> assumedTypes)


Validate the given program.

cred - login credentials. The user must have the PROGRAM_VALIDATE permission.

program –the program which will be validate.

assumedRefsVO – the program dataset references.

dsdKeysets – the program keysets

assumedTypes – dataset types

return – the validated program.


6.8.6. Save Program

Long saveProgram(Credentials cred,

PdtProgramVO program)


Save the given program.

cred - login credentials. The user must have the PROGRAM_ADD permission.

program –the program.

return – the program id.



6.8.7. Program Parameter Sets

List<ParameterSetVO> getProgramParameterSets(Credentials credentials,

Long id)


Return the parameter sets for the given program ID.

credentials - login credentials. The user must have the SL_TEMPLATES_VIEW permission.

id –the ID of the program to search for.

return – the parameter sets.



6.8.8.1. KeysetsTemplateVO

This object contains informations about a template : ID, name, dataset instances

(List<DatasetInstanceVO>) and key sets(List<KeySetVOInfo>).

6.8.8.2. KeySetVO

This object contains informations about a key set : ID, name, fields(List<FieldVO>) and key

sets template(KeysetsTemplateVO).

6.8.8.3. PdtProgramVO

This object contains the informations needed by the program editor : ID of the program, name,

description, parameters(List<ParameterVO>), parameter sets(List<ParameterSetVO>),

constants(List<PdlVariableVO>), input reference map(EditHashMap<String, String>), input

instances map(EditHashMap<String, PdtProgramInputDatasourceVO>), reference

map(EditHashMap<String, String>), temporary datasets(List<String>) and steps

(List<PdtStepVO>).

6.8.8.4. PdtProgramInfoVO

This object contains informations about editing a program : program(PdtProgramVO), the

details of dataset definitions used in the program(EditHashMap<String, DatasetDefinitionVO>)

, list of key sets(EditHashMap<String, KeysetsTemplateVO[]>) and list of dataset definition

names (List<String>).


6.8.8.5. PdtTemplateVO

This object contains informations about a template : name, title and text.

6.8.8.6. TemplateType

This enumeration contains the types of a template : DATAOPERATION, FUNCTION,

OPERATION, HORIZONTAL_RULE,

DSFILTERING_OPERATOR, DSFILTERING_FUNCTION.

6.9. DataRepositoryService

The Data Repository Service handles file transfer related functions and follows the definitions


dataRepositoryService.xml

6.9.1. Upload File

Long upload(Credentials credentials,

FileInfoVO uploadInfoFile)

throws EditServiceException,

EditServiceAuthenticationException,

EditServiceInvalidParameterException;

Upload a file to internal repository.

Credentials - login credentials. user must have PermissionName.FILE_UPLOAD

UploadInfoFile – info about file to be uploaded

Return – the ID of the newly imported file. The info contains a stream from which the file will

be readed


6.9.2. Download File

FileInfoVO download(


Long downloadInfoFileId)





Download a file from internal repository.

Credentials - login credentials. user must have PermissionName.FILE_DOWNLOAD

downloadInfoFileId – the ID of the file to be downloaded

return - info about file to be downloaded. The info contains a stream from which the client can

read the file


6.9.3. Download File

FileInfoVO downloadByTaskId( Credentials credentials,

Long taskId)


Download a file from internal repository by its export task id.

Credentials - login credentials. user must have PermissionName.FILE_DOWNLOAD.

taskId – the ID of the file to be downloaded.

return - info about file to be downloaded. The info contains a stream from which the client can

read the file.


6.9.4. Delete File

void delete(Credentials credentials,

Long infoFileId)




Delete a file from the internal repository.

Credentials - login credentials. user must have PermissionName.FILE_DELETE

infoFileId - the ID of the file to be deleted



6.9.5. Get Property

String getProperty(Credentials credentials, String property);

Returns a property of the repository.

credentials - login credentials. user must have PermissionName.FILE_DOWNLOAD

permission

property - the property to retrieve

6.9.6. Publish To Secure Channel

Since v15.0.0.1

void publishToSecureChannel(Credentials credentials,Long publishInfoFileId)


Publish a file from internal repository to the domain’s confidential data outgoing folder.

credentials - login credentials. user must have PermissionName.FILE_DOWNLOAD

publishInfoFileId – the ID of the file to be published


6.10. FieldSetService

The Field Set Service handles field set templates related functions and follows the definitions


fieldSetService.xml

6.10.1. Find FieldSet By ID

FieldSetVO getFieldSet(

Credentials cred,

Long fieldSetId )



Retrieve a field set with given ID.

cred - login credentials. user must have PermissionName.FIELDSET_VIEW.

fieldSetId – the id of the Field Set to be searched.

return – the Field Set with the given ID.

throws EditServiceException if no filed set with the ID is found.

6.10.2. Find FieldSet By Name

FieldSetVO findFieldSetByName (

Credentials cred,

String name)


Retrieve a Field Set with given name.

cred - login credentials. user must have PermissionName.FIELDSET_VIEW

name – the iname of the Field Set to be searched

return – the Field Set with the provided name

throws EditServiceException if no filed set with the provided name is found

6.10.3. Find FieldSet By Dataset Definition

List<FieldSetInfoVO> getFieldSetsByDatasetDefinition(

Credentials cred,

Long dsdId)


Retrieve a list of FieldSet associated with the provided format.

cred - login credentials. user must have PermissionName.FIELDSET_SEARCH

dsdId – the ID of the format

return - a list of FieldSet associated with the provided format


6.10.4. Search FieldSets

SearchResult<FieldSetInfoVO> getFieldSets(


Credentials cred,

Map<String,Object> filterMap,

SearchInfo searchInfo )


This method is used to retrieve the FieldSet list

The search will be performed using the value under

key=FieldSetService.DATASET_DEFINITION_NAME in the filterMap as a substring.

cred - login credentials. user must have PermissionName. FIELDSET_SEARCH

filterMap – A map containing under the keys FieldSetService.

DATASET_DEFINITION_NAME the names of the Field Sets to be searched for.



return SearchResult object containing info about result and a list with all Field Sets matching

the search criteria


6.10.5. Add FieldSet

Long saveFieldSet(

Credentials cred,

FieldSetVO fieldSet)


Persist the given fieldset.

cred - login credentials. user must have PermissionName. FIELDSET_ADD

fieldSet – filed set to be created.

return – the ID of the newly created Field Set

throws EditServiceException if a Field Set with the same name already exists or database

operation fails.

6.10.6. Delete FieldSet

void delete(Credentials cred,

Long fieldSetId )


This method will delete a Field Set with provided ID

cred - login credentials. user must have PermissionName. FIELDSET_DELETE

fieldSetId – the ID of the Field Set to be deleted


throws EditServiceException if a filed set with the given ID is not found or database operation

fails.

6.10.7. Export FieldSet

FileInfoVO exportFieldSet(Credentials credentials,

Long fieldSetId )


Export a FieldSet to a file.

credentials - login credentials. user must have PermissionName. FIELDSET_EXPORT

permission

fieldSetId – the ID of the FieldSet to export


6.10.8. Import Field Set

void importFieldSet(Credentials credentials,

String fileContent)


Import a Field Set.

credentials - login credentials. user must have PermissionName. FIELDSET_IMPORT

permission

fileContent – the content of the Field Set to be imported



6.10.9.1. FieldSetVO

This object contains details about a field set : ID, name, dataset definition ID and

fields(List<FieldVO>).

6.10.9.2. FieldSetInfoVO

This object contains informations about a field set: ID, name and dataset definition name.

6.11. PropertySetService


The Property Set Service handles file property set templates related functions and follows the


propertySetService.xml

6.11.1. Find PropertySet By Name

PropertySetVO findPropertySetByName (Credentials cred, String name)


Retrieve the Property Set with the given name.

cred - login credentials. user must have PermissionName.FILE_PROPERTIES_VIEW.

name – the name of the Property Set to be searched.

return – the Property Set name.

throws EditServiceException if the Property Set does not exists.

6.11.2. Find PropertySet By Type

List<PropertySetInfoVO> getPropertySetsByType(

Credentials cred,

String fileType)


Retrieve a list of Property Sets having the provided type.

cred - login credentials. user must have PermissionName.FILE_PROPERTIES_SEARCH

fileType – the type of the Property Set to be searched

return - a list of Property Sets with the provided type


6.11.3. Find PropertySet By ID

PropertySetVO getPropertySet(

Credentials cred,

Long propertySetId)



Return the Property Set having the provided ID.

cred - login credentials. user must have PermissionName.FILE_PROPERTIES_ SEARCH

propertySetId – the ID of the Property Set to be searched

return - the Property Set with the given ID

throws EditServiceException if the Property Set does not exists

6.11.4. Search PropertySets

SearchResult<PropertySetInfoVO> getPropertySets(

Credentials cred,

Map<String, Object> filterMap,



This method is used to retrieve the Property Set list. The search will be performed using the

value under key= PropertySetService.PROPERTY_SET_TYPE in the filterMap as a

substring.

cred - login credentials. user must have PermissionName.FILE_PROPERTIES_SEARCH

filterMap – A map containing under the keys PropertySetService.PROPERTY_SET_TYPE

the types of the Property Sets to be searched for.



return SearchResult object containing info about result and a list with all Property Sets

matching the search criteria


6.11.5. Add PropertySet

Long savePropertySet ( Credentials cred,

PropertySetVO propertySetVO)


Persist a new Property Set.

cred - login credentials. user must have PermissionName.FILE_PROPERTIES_ADD

propertySetVO – property set to be created

return – the ID of the newly created Property Set


throws EditServiceException if a Property Set with the same name already exists or database

operation fails.

6.11.6. Delete PropertySet

void delete( Credentials cred,

Long propertySetId)


This method will delete a Property Set with provided ID.

cred - login credentials. user must have PermissionName.FILE_PROPERTIES_DELETE

propertySetId – the ID of the Property Set to be deleted

throws EditServiceException if a property set with the given ID is not found or database

operation fails.

6.11.7. Export Property Set

FileInfoVO exportPropertySet(Credentials credentials,

Long propertySetId )


Export a Property Set to a file.

credentials - login credentials. user must have PermissionName.

FILE_PROPERTIES_EXPORT permission

propertySetId – the ID of the Property Set to export


6.11.8. Import Property Set

void importPropertySet(Credentials credentials,

String fileContent)


Import a Property Set.


PermissionName. FILE_PROPERTIES_IMPORT permission

fileContent – the content of the Property Set to be imported




6.11.9.1. PropertySetVO

This object contains details about a property set : ID, name, file type and properties

(List<PropertyVO>)

6.11.9.2. PropertySetInfoVO

This object contains informations about a property set : ID, name and file type.

6.12. DBConnTemplateService

The DB Connection Template Service handles connection templates related functions and

follows the definitions from the following WSDL file:

dbConnTemplateService.xml

6.12.1. Retrieve Connection

DBConnectionDetailsVO getConnection(

Credentials cred,

Long id)


Return a connection by given id.

cred - login credentials. The user must have the DB_CONNECTION_VIEW permission.

id – the ID of the connection.

return – the connection.


6.12.2. Retrieve Connections

SearchResult<DBConnectionVO> getConnections(

Credentials cred,





This method is used to retrieve the connection templates list. The search will be

performed using the value under key=CONNECTION_TEMPLATE_NAME in the

filterMap as a substring.

cred - login credentials. The user must have the DB_CONNECTION_SEARCH permission.

filterMap – A map containing under the key CONNECTION_TEMPLATE_NAME the name

of the connections to be searched for.



return – the list of connections templates.


6.12.3. Save Connection

DBConnectionDetailsVO saveConnection(


DBConnectionDetailsVO conn)


Persist the given connection ant return it.

cred - login credentials. The user must have the DB_CONNECTION_ADD permission.

conn – the connection that will be persisted.

return – the persisted connection.


6.12.4. Delete Connection

boolean deleteConnection(


Long id)


Detele the connection with the provided id.

cred - login credentials. The user must have the DB_CONNECTION_DELETE permission.

id – the id of the connection.

return – true if the delete succeeded.



6.12.5. Delete Connections

void deleteConnections(Credentials credentials,

Set<Long> ids)


Detele a set of connections.

credentials - login credentials. The user must have the DB_CONNECTION_DELETE

permission.

ids – the IDs of the connections to delete.


6.12.6. Find All Connections

List<DBConnectionVO> findAll(Credentials credentials);

Return all the connections.

cred - login credentials. The user must have the DB_CONNECTION_SEARCH permission.

return –return a list with all the connections.


6.12.7.1. DBConnectionDetailsVO

This object contains the details of a database connection : ID, name, user, password, URL,

details, type and driver class name.

6.12.7.2. DBConnectionVO

This object contains informations about a database connection : ID, name, selected(boolean),

creation user, creation time and description.

6.13. DBStmtTemplateService

The Database Statement Service handles databse statements related functions and follows the



dbStmtTemplateService.xml

6.13.1. Retrieve Statement

DBStmtDetailsVO getStatement(Credentials cred,

Long id)


Returns a statement by given id

cred - login credentials. The user must have the DB_STATEMENT_VIEW permission.

id – the id of the statement.

return –the statement.


6.13.2. Retrieve Statements

SearchResult<DBStmtVO> getStatements(

Credentials cred,

String type,




This method is used to retrieve the statement templates list. The search will be

performed using the value under key=STATEMENT_TEMPLATE_NAME in the filterMap

as a substring.

cred - login credentials. The user must have the DB_STATEMENT_SEARCH permission.

type – the type of the statement.

filterMap – A map containing under the key STATEMENT_TEMPLATE_NAME the name

of the statement to be searched for.



return – the list of connections templates.


6.13.3. Save Statement


DBStmtDetailsVO saveStatement(

Credentials cred,

DBStmtDetailsVO stmt)


Persist the given statement.

cred - login credentials. The user must have the DB_STATEMENT_ADD permission.

stmt – the given statement.

return – the persisted statement.


6.13.4. Delete Statement

boolean deleteStatement(

Credentials cred,

Long id)


Delete the statement given by its id.

cred - login credentials. The user must have the DB_STATEMENT_DELETE permission.

id- the statement id.

return - true if the delete succeeded.


6.13.5. Delete Statements

void deleteStatements(Credentials credentials,

Set<Long> ids)


Delete the statements given by their IDs.

credentials - login credentials. The user must have the DB_STATEMENT_DELETE

permission.

ids - the IDs of the statements to be deleted.


6.13.6. Find All Statements By Type

List<DBStmtVO> findByType(Credentials credentials,


String type);

Return all the statements by type.

cred - login credentials.

type – statement type.

6.13.7. return –return a list with all the statements by its type. View Objects Description

6.13.7.1. DBStmtDetailsVO

This object contains the details of a database statement : ID, name, statement, details and type.

6.13.7.2. DBStmtVO

This object contains informations about a database statement : ID, name, selected(boolean),

creation user, creation time and description.

6.14. DatasetFilteringService

The Dataset Filtering Service handles dataset filtering and follows the definitions from the


datasetFilteringService.xml

6.14.1. Save Filtering Template

DatasetFilteringTemplateVO saveTemplate(Credentials credentials,

DatasetFilteringTemplateVO filteringTemplate)


Saves the filtering template.

credentials - login credentials. The user must have the

DATASET_FILTERING_TEMPLATE_EDIT permission.

filteringTemplate - filtering template options

return - returns the saved entity


6.14.2. Load Filtering Template

DatasetFilteringTemplateVO loadTemplate(Credentials credentials,

Long templateId)



Loads a filtering template from the given ID.


DATASET_FILTERING_TEMPLATE_SEARCH permission.

templateId - filtering template ID

return - returns the filtering template entity


6.14.3. Search For Filtering Templates

List<DatasetFilteringTemplateListVO>

searchTemplates(Credentials credentials,

EditHashMap<String, Object> filterCriteria)


Search for filtering templates


DATASET_FILTERING_TEMPLATE_SEARCH permission.

filterCriteria - search criteria for filtering templates

return - returns a list of filtering template entities


6.14.4. Delete Filtering Template

void deleteTemplate(Credentials credentials,

Long templateId)


Delete the filtering template for the given ID.


DATASET_FILTERING_TEMPLATE_DELETE permission.

templateId - filtering template ID



6.14.5. Read a Page From the Dataset Contents

DatasetVO readPage(Credentials credentials,

Long datasetInstanceId,

List<FieldVO> fields,

DatasetFilteringTemplateVO filteringTemplate,


throws InvalidFilterException, EditServiceException;

Read a page from the dataset contents.

credentials - login credentials. The user must have the DATASET_VIEW permission.

datasetInstanceId - the ID of the dataset instance to be read

fields - fields to be read

filteringTemplate - filtering template options



return - returns the page result

throws InvalidFilterException if filtering options are invalid,

EditServiceException if the operation fails.


6.14.6.1. DatasetFilteringTemplateVO

This object contains informations about the dataset filtering template : ID, name and format

(DatasetDefinitionInfoVO).

6.14.6.2. DatasetFilteringTemplateListVO

This object is used to retrieve a list of dataset filtering templates and contains : ID, name and

filter type(DatasetFilterType).

6.14.6.3. FieldVO

This object contains informations about a field : name, caption, description, length,

mandatory(Boolean), default value, type(FieldType) and precision.

6.15. ArchiveRestoreService

The Archive Restore Service handles archiving and restoring dataset instances and follows the



archiveRestoreService.xml

6.15.1. Archive Dataset

void archiveDataset(Credentials credentials,

Long datasetInstanceId)


Archive a dataset

credentials - login credentials. The user must have the DATASET_ARCHIVE permission.

datasetInstanceId - the ID of the dataset instance to be archived


6.15.2. Restore Dataset

void restoreDataset(Credentials credentials,



Restore a dataset from the archive.

credentials - login credentials. The user must have the DATASET_RESTORE permission.

datasetInstanceId - the ID of the dataset instance to be restored


6.15.3. Archive Datasets

String archiveDatasets(Credentials credentials,



Archive datasets

credentials - login credentials. The user must have the DATASET_ARCHIVE permission.

datasetInstanceIds - the set of IDs of dataset instances

return - comma separated list of dataset instances that cannot be archived



6.15.4. Restore Datasets

String restoreDatasets(Credentials credentials,



Restore datasets from the archive

credentials - login credentials. The user must have the DATASET_RESTORE permission.

datasetInstanceIds - the set of ID of the dataset instance to be restored


6.15.5. Search Archive/Restore Jobs For Dataset Instance

SearchResult<JobVO> findByDataset(Credentials credentials,

Long datasetInstanceId);

Search for archive/restore jobs that have been run on the dataset instance.


ARCHIVE_RESTORE_JOB_VIEW permission.

datasetInstanceId - the ID of the dataset instance

return - list of archive/restore jobs

6.15.6. Search Archive Jobs For Dataset Instance

SearchResult<JobVO> listArchiveJobsByDataset (Credentials credentials,


Search for archive jobs that have been run on the dataset instance.




return - list of archive jobs

6.15.7. Search Restore Jobs For Dataset Instance

SearchResult<JobVO> listRestoreJobsByDataset (Credentials credentials,


Search for restore jobs that have been run on the dataset instance.





return - list of restore jobs

6.15.8. Search Logs By Job

SearchResult<JobLogVO> listLogsByJob (Credentials credentials,

Long jobId)

Search for job logs.



jobId - the ID of the job to search for logs

return - list of job logs

6.16. AutodomainDefinitionService

The Autodomain Definition Service handles autodomain definition related functions and

follows the definitions from the following WSDL file:

autodomainDefinitionService.xml

6.16.1. Search For Current Domain

AutodomainDefinitionVO searchForCurrentDomain(Credentials credentials)

throws DomainNotAutomatedException;

Searches the autodomain definition of the current (according to the credentials) domain.

credentials - login credentials. The user must have the AUTODOMAIN_VIEW permission.

return - the audotomain definition corresponding to the current (credentials) domain

throws DomainNotAutomatedException if the current domain is not automated

6.16.2. Automate Current Domain


AutodomainDefinitionVO

currentDomainAutomationDefinition(Credentials credentials,

AutodomainDefinitionVO autodomainDefinitionVO)


Sets the parameters to automate (insert or update) the current domain.

credentials - login credentials. The user must have the AUTODOMAIN_EDIT permission

autodomainDefinitionVO - the autodomain definition

return - The VO of the autodomainDefinition (new if the domain was not automated, the

updated one otherwise)


6.16.3. Find Autodomains For File

List<AutodomainWithDomainVO>

autodomainsRecognizingFilename(Credentials credentials,

String filename);

Finds the autodomains that will recognize a file with the given filename in one of the folders

of the current domain.

credentials - login credentials. The user must have the AUTODOMAIN_TEST permission

filename - the file name to be searched

return - the autodomains that will recognize the file

6.16.4. Find Autodomains For File In Folder

List<AutodomainWithDomainVO> autodomainsRecognizingFilenameInFolder(


String folder,

String filename);

Finds the autodomains that will recognize a file with the given filename in the given folder.

credentials - login credentials. The user must have the AUTODOMAIN_TEST permission

folder - folder in which to search for

filename - the file name to be searched

return - the autodomains that will recognize the file


6.16.5. Search For Domain

Since v15.0.0.2

AutodomainDefinitionVO searchForCurrentDomain(Credentials credentials, String name)

throws DomainNotAutomatedException;

Searches the autodomain definition of the current (according to the credentials) domain.

credentials - login credentials. The user must have the DOMAIN_IMPORTpermission.

name – domain name

return - the audotomain definition corresponding to the current (credentials) domain

throws DomainNotAutomatedException if the current domain is not automated

6.16.6. Domain Automation Definition

Since v15.0.0.2

AutodomainDefinitionVO

domainAutomationDefinition (Credentials credentials,

AutodomainDefinitionVO autodomainDefinitionVO)


Sets the parameters to automate (insert or update) the current domain.

credentials - login credentials. The user must have the DOMAIN_IMPORT permission

autodomainDefinitionVO - the autodomain definition

return - The VO of the autodomainDefinition (new if the domain was not automated, the

updated one otherwise)



6.16.7.1. AutodomainDefinitionVO

This object contains informations about an autodomain : folder full path, masks,

enabled(boolean), email and extractor options(List<ExtractorOptionsVO>).

6.16.7.2. AutodomainWithDomainVO

This object contains the domain name for an autodomain.


6.17. AutodomainProgramService

The Autodomain Program Service handles autodomain program related functions and follows

the definitions from the following WSDL file:

autodomainProgramService.xml

6.17.1. Edamis Metadata Tokens

List<String> edamisMetadataTokens (Credentials cred);

Returns the names of the metadata tokens which can be recognized by edamis metadata

extractor

cred - login credentials. The user must have the AUTODOMAIN_PRG_VIEW permission

return - the names of the metadata tokens

6.17.2. Verify Autodomain Program Condition

boolean isAutodomainProgramConditionValid(Credentials cred,

String condition)


Verify the syntax of the condition given as parameter


condition - condition to be verified

return - true if the condition is valid, false otherwise


6.17.3. Find Autodomain Program

AutodomainProgramVO getAutodomainProgram (Credentials cred,

Long id)



Returns the dynamic domain program for a given automatic domain program id.


id - ID of the automatic domain

return - the autodomain program


6.17.4. Autodomain Program For Filename

AutodomainProgramVO

getAutodomainProgramsForFileName (Credentials credentials,

String fileName)


Returns the program which responds to a given file name.

credentials - login credentials. The user must have the AUTODOMAIN_PRG_VIEW

permission

fileName - the name of the file to search for a program

return - the autodomain program


6.17.5. Search Autodomain Programs

SearchResult<AutodomainProgramVO >

getAutodomainPrograms (Credentials credentials,




Returns the list of the programs which correspond to the criteria given by the filerMap.

The name of the auto domain programs will be under the key = AUTODOMAIN_PRG_NAME

credentials - login credentials. The user must have the AUTODOMAIN_PRG_VIEW

permission

filterMap – A map containing filters to search for autodomains.




return - SearchResult object containing info about result and a list with all programs in



6.17.6. Save Autodomain Program

Long saveAutodomainProgram (Credentials credentials,

AutodomainProgramVO autodomainProgram)


Save a dynamic domain program

credentials - login credentials. The user must have the AUTODOMAIN_PRG_EDIT

permission

autodomainProgram – the autodomain program to be saved

return - the ID of the saved entity


6.17.7. Delete Autodomain Program


Long autodomainProgramId)


Delete an autodomain program

credentials - login credentials. The user must have the AUTODOMAIN_PRG_DELETE

permission

autodomainProgramId – the autodomain program to be deleted


6.17.8. Delete Autodomain Programs

void deletePrograms(Credentials credentials,

Set<Long> ids)



Delete a set of autodomain programs

credentials - login credentials.

ids – a set of autodomain program s to be deleted



6.17.9.1. AutodomainProgramVO

This object contains informations about an autodomain program : ID of the autodomain, name,

description, program(ProgramInfoVO), dataset definition(DatasetDefinitionVO), parameter set

(ParameterSetVO), field set template(FieldSetVO), file type, property set template

(PropertySetVO), enabled(Integer), priority, condition, email, program parameters

(List<AudotomainProgramParameterVO>) and execution queue ID.

6.18. ContactsService

The Contacts Service handles contacts related functions and follows the definitions from the


contactsService.xml

6.18.1. Search External Contacts

SearchResult<ExternalContactVO>

searchExternalContact (Credentials credentials,




Returns the list of external contacts which correspond to the criteria given by the filerMap.

credentials - login credentials. The user must have the EXT_CONTACT_VIEW permission

filterMap – A map containing filters to search for autodomains.



return - SearchResult object containing info about result and a list with all the contacts in




6.18.2. Check verification code

ExternalContactVO verifyGsm (Credentials credentials,

Long externalContactId,

String verificationCode)


Verify the external contact.

credentials - login credentials. The user must have the EXT_CONTACT_EDIT permission

externalContactId – external contact ID to be verified.

verificationCode – verification code for the external contact

return - the external contact entity


6.18.3. Verify E-mail

ExternalContactVO verifyEmail (Credentials credentials,


String verificationCode)


Verify the email for the external contact.


externalContactId – external contact ID to be verified.

verificationCode – verification code for the external contact



6.18.4. Save external contact

ExternalContactVO saveExternalContact (Credentials credentials,


ExternalContactVO externalContactVO)


Save the external contact


externalContactIVO – external contact to be saved

return - the external contact persisted entity


6.18.5. Delete external contact

void deleteExternalContact (Credentials credentials,

Long id)


Delete the external contact.


id – ID of the external contact to be deleted


6.18.6. Delete external contacts

void deleteExternalContacts(Credentials credentials,

Set<Long> ids)


Delete the external contacts.


ids – the IDs of the external contacts to be deleted



6.18.7. Search External Contact

ExternalContactVO getExternalContact (Credentials credentials,

Long id)


Search external contact from the ID.

credentials - login credentials. The user must have the EXT_CONTACT_VIEW permission

id – ID of the external contact to be searched


6.18.8. Assign External Contact To Key

void assignExternalContactToKey(Credentials credentials,


Long keyId)


Assign the key with an external contact.

credentials - login credentials. The user must have the EXT_CONTACT_KEY_CREATE

permission

externalContactId – ID of the external contact

keyId - ID of the key to be assigned to the external contact


6.18.9. Search External Contact Key

SearchResult<ExternalContactKeyVO>

searchExternalContactKey (Credentials credentials,

String key,

String description)



Returns the list of external contacts keys

credentials - login credentials. The user must have the EXT_CONTACT_KEY_VIEW

permission

key – key to be searched

description - description of the key

return - SearchResult object containing info about result and a list with all the keys matching

the search criteria


6.18.10. Search External Contact Key By ID

ExternalContactKeyVO getExternalContactKey(Credentials credentials,

Long id)


Search external contact key from the ID.

credentials - login credentials. The user must have the EXT_CONTACT_KEY_VIEW

permission

id – ID of the external contact key to be searched

return - the external contact key entity


6.18.11. Save External Contact Key

ExternalContactKeyVO saveExternalContactKey (Credentials credentials,

ExternalContactKeyVO key)


Save external contact key.

credentials - login credentials. The user must have the EXT_CONTACT_KEY_CREATE

permission

key – external contact key to be searched

return - the persisted external contact key entity



6.18.12. Delete External Contact Key

void deleteExternalContactKey(Credentials credentials,

Long id)


Delete external contact key.

credentials - login credentials. The user must have the EXT_CONTACT_KEY_DELETE

permission

id – ID of external contact key to be deleted


6.18.13. Delete External Contact Keys

void deleteExternalContactKeys(Credentials credentials,

Long id)


Delete external contact keys.

credentials - login credentials. The user must have the EXT_CONTACT_KEY_DELETE

permission

ids – IDs of external contact keys to be deleted


6.18.14. Send Verification Code

ExternalContactVO sendGsmVerificationCode(Credentials credentials,

Long id)


Sends the verification code by SMS.


credentials - login credentials. The user must have the EXT_CONTACT_SEND_CODE

permission

id – ID of the external contact to be sent by SMS



6.18.15. Send E-mail to External Contact

ExternalContactVO sendEmailVerificationCode (Credentials credentials,

Long id)


Sends an email to the external contact.

credentials - login credentials. The user must have the EXT_CONTACT_SEND_CODE

permission

id – ID of the external contact to send email




6.18.16.1. ExternalContactVO

This object contains informations about an exeternal contact : ID, name, gsm, gsm verification

code, gsm verified(boolean), email, email verification code, email verified(boolean),

active(boolean) and external contact keys list(List<ExternalContactKeyVO>).

6.18.16.2. ExternalContactKeyVO

This object contains informations about the external contact key : ID, key and description.

6.19. SystemMonitoringService

The System Monitoring Service handles system monitoring functions and follows the


systemMonitoringService.xml


6.19.1. Job Status Overview

JobStatusOverviewVO getJobStatusOverview(Credentials credentials);

Returns an overview of the Jobs Execution system, including information for the overall

credentials - login credentials. The user must have the JOB_STATUS_OVERVIEW

permission

return - the job status overview entity


6.19.2.1. JobStatusOverviewVO

This object contains details about job execution status : status overview

(EditHashMap<JobStatus, Long>), overall status and overall status summary.

6.20. UserPreferenceService

The User Preferences Service handles user preferences related functions and follows the


userPreferenceService.xml

6.20.1. Retrieve User Preferences List

List<UserPreferenceVO> getUserPreferences (Credentials credentials)


Retrieve user preferences list

credentials - login credentials. The user must have the VIEW_USER_PREFERENCE

permission

return - the list of user preferences



6.20.2. Retrieve User Preferences By Key

UserPreferenceVO getUserPreferences(Credentials credentials,

String key)


Retrieve user preferences for the given key.

credentials - login credentials. The user must have the VIEW_USER_PREFERENCE

permission

key - the key to search for preferences

return - user preferences


6.20.3. Save User Preference

void saveUserPreference(Credentials credentials,

UserPreferenceVO userPrefVo)


Save user preferences

credentials - login credentials. The user must have the EDIT_USER_PREFERENCE

permission

userPrefVo - the user preferences to be saved


6.20.4. Delete User Preference

UserPreferenceVO deleteUserPreference(Credentials credentials,

Long prefernceId)


Save user preferences

credentials - login credentials. The user must have the EDIT_USER_PREFERENCE

permission

preferenceId - ID of the preference to be deleted

return - the deleted preferences entity




6.20.5.1. UserPreferenceVO

This object contains informations about user preferences : ID, user ID, key and value.

6.21. ValidationFlowService

The Validation Flow Service handles validation flow related functions and contains the


validationFlowService.xml

6.21.1. Create Validation Flow

ValidationFlowVO create(Credentials credentials,

ValidationFlowVO validationFlowVO)


Create a validation flow.


PermissionName. VALIDATION_FLOW_ADD permission

validationFlowVO - validation flow to persist

return - persisted validation flow


6.21.2. Update Validation Flow

ValidationFlowVO update(Credentials credentials,

ValidationFlowVO validationFlowVO)


Updates a validation flow.


PermissionName. VALIDATION_FLOW_EDIT permission


validationFlowVO - validation flow to update

return - updated validation flow


6.21.3. Search Validation Flow

SearchResult<ValidationFlowVO> search (Credentials credentials,

SearchValidationFlowVO criteria,



Returns the list of validation flows which correspond to the criteria.

credentials - login credentials. The user must have the VALIDATION_FLOW_VIEW

permission

criteria –criteria to search for validation flows.



return - SearchResult object containing info about result and a list with all the validation flows



6.21.4. Load Validation Flow

ValidationFlowVO load(Credentials credentials,

Long id)


Loads the validation flow from the ID.


PermissionName. VALIDATION_FLOW_VIEW permission

id - the ID of the validation flow to load

return - validation flow

6.21.5. Delete Validation Flow



Long... ids)


Delete the validation flows received as a list of IDs.


PermissionName.VALIDATION_FLOW_EDIT permission

ids - the IDs of the validation flow to delete


6.21.6. Get Import Templates

List<ValidationFlowVO> getImportTemplates(Credentials credentials)


Retrieve a list of import templates.


PermissionName.IMPORT_TEMPLATE_VIEW permission

return - a list with import templates



6.21.7.1. ValidationFlowVO

This object contains informations about validation flow : ID, name, description, file type,

property set ID, property set name, auxiliary options, dataset definition ID, dataset definition

name, field set ID, field set name, program ID, program name, parameter set name and run

parameters(List<FlowRunParameterVO>).

6.21.7.2. SearchValidationFlowVO

This object contains informations about search options for validation flows : name, description,

file type, format name, program name, program(boolean), IDs(List<Long>).

6.22. LanguageService


The Language Service handles language related functions and contains the definitions from the


languageService.xml

6.22.1. Get All Languages

List<LanguageVO> getAllLanguages(Credentials credentials)


Return a list with all the languages defined in the application.


PermissionName.LANGUAGE_SEARCH permission

return - list with all the languages


6.22.2. Get Language

LanguageVO getLanguages(Credentials credentials,

Long id)


Return a language from its ID.


PermissionName.LANGUAGE_EDIT permission

id - the ID of the language

return - the language found


6.22.3. Save Language

LanguageVO create(Credentials credentials,

LanguageVO languageVO)



Saves a new language / updates an existing one.


PermissionName.LANGUAGE_EDIT permission

languageVO - language to save/update

return - persisted language


6.22.4. Export Translations

FileInfoVO exportTranslations(Credentials credentials,

String locale)


This method exports a specified language into .xlsx format.


PermissionName.LANGUAGE_EXPORT permission

locale - the locale for which the translations will be exported

return - packed translations


6.22.5. Import Translations

void importTranslations(Credentials credentials,

LanguageUploadVO translationUploadVO)


This method reads an input stream of .xlsx data and imports the translations from it.


PermissionName.LANGUAGE_IMPORT permission

translationUploadVO - the translations file to be imported


6.22.6. Get Available Languages

List<LanguageVO> getAvailableLanguages(Credentials credentials)



This method returns the available language list used to populate the change language

dropdown.


PermissionName.LANGUAGE_CHANGE permission

return - list with the available languages


6.22.7. Delete Language

void deleteLanguage(Credentials credentials,

Long id)


This method deletes the specified language.


PermissionName.LANGUAGE_DELETE permission

id - ID of the language to delete


6.22.8. Delete Languages

void deleteLanguages(Credentials credentials,

Set<Long> ids)


This method deletes the specified languages.


PermissionName.LANGUAGE_DELETE permission

ids - IDs of the languages to delete


6.22.9. Find Language By Locale

LanguageVO findLanguageByLocale(Credentials credentials,


Locale locale)


This method finds language by locale.


PermissionName.LANGUAGE_CHANGE permission

locale - the locale to search for language



6.22.10.1. LanguageVO

This object contains informations about a language : ID, short code, name, available(boolean)

and last import(Date)

6.22.10.2. LanguageUploadVO

This object contains informations about uploading a language into the system: langauage code

and the data file that should be uploaded as a stream(DataHandler).

6.23. ContentImageService

The Content Image Service handles image related functions and contains the definitions from

the following WSDL file:

contentImageService.xml

6.23.1. Search Images

List<String> searchImages(Credentials credentials,

String filter)


Search for images that match file name filter.



PermissionName.IMAGE_FILE_SEARCH permission

return - list with found images


6.23.2. Delete Image

void deleteImage(Credentials credentials,

String filename)


Delete image that has the given filename.


PermissionName.IMAGE_FILE_DELETE permission

filename - name of the file to delete


6.23.3. Upload Image

String uploadImage(Credentials credentials,

FileInfoVO uploadedFile)


Upload image.


PermissionName.IMAGE_FILE_UPLOAD permission

uploadedFile - the file to be uploaded


6.23.4. Get Image

FileInfoVO getImage(Credentials credentials,

String filename)


Return image by filename.



PermissionName.IMAGE_FILE_SEARCH permission

filename - name of the file to search for


6.24. QueueService

The Queue Service handles queue related functions and contains the definitions from the


queueService.xml

6.24.1. Search Queues

SearchResult<ExecutionQueueVO>

getQueues (Credentials credentials,




Returns the list of queues which correspond to the criteria given by the filterMap.

credentials - login credentials. The user must have the PermissionName.QUEUE_SEARCH

permission

filterMap – map containing filters to search for queues



return - SearchResult object containing info about result and a list with all the queues



6.24.2. Save Queue


void saveQueue(Credentials credentials,

ExecutionQueueVO executionQueueVO)


Save the queue.

credentials - login credentials. The user must have the PermissionName.QUEUE_ADD

permission

executionQueueVO - queue to be saved


6.24.3. Check if queue exists

boolean queueExists(Credentials cred,

String name)


Check if exists a queue with the given name.

cred - login credentials. The user must have the PermissionName.QUEUE_ADD

permission

name - name of the queue


6.24.4. Delete Queues

void deleteQueues(Credentials cred,

Set<Long> ids)


Delete queues from a set of IDs.

cred - login credentials. The user must have the PermissionName.QUEUE_DELETE

permission

ids - set of IDs of the queues



6.24.5. Search Queue

ExecutionQueueVO getQueue(Credentials cred,

Long id)


Retrieve the queue from the given ID.

cred - login credentials. The user must have the PermissionName.QUEUE_SEARCH

permission

id - the ID of the queue to search for


6.24.6. Search All Queues

List<ExecutionQueueVO> getAllQueues(Credentials cred)


Retrieve a list with all the queues.


permission


6.24.7. Search Queue By Name

ExecutionQueueVO getQueueByName(Credentials cred,

String defaultExecutionQueue)


Retrieve a queue by its name.


permission

defaultExecutionQueue - name of the queue to be searched



6.24.8. Search All Enabled Queues

SearchResult<ExecutionQueueVO> getAllEnabledQueues (Credentials cred)


Search for all the enabled queues.


permission

return - SearchResult object containing info about result and a list with all the enabled queues


6.24.9. Search Enabled Queues For Current User

SearchResult<ExecutionQueueVO> getEnabledQueuesForCurrentUser (Credentials cred)


Search for all the enabled queues for the current user.


permission

return - SearchResult object containing info about result and a list with all the enabled queues

for the current user


6.24.10. Default Queue For Job

ExecutionQueueVO defaultQueueForJob (Credentials cred,

Set<String> datasetNames,

long programId)


Search for the default queue for execution of a job.


permission

datasetNames - dataset names that will be used for the program execution

programId - ID of the program that will be executed


return - the default queue for execution of the program


6.24.11. Eligible Queues For Job

SearchResult<ExecutionQueueVO> enabledQueuesForJob(Credentials cred,

Set<String> datasetNames,

long programId)


Search for all the eligible queues for the job.


permission

datasetNames - dataset names that will be used for the program execution

programId - ID of the program that will be executed

return - SearchResult object containing info about result and a list with all the eligible queues

for the job


6.25. ScriptTemplateService

Since v14.0.0.0

The Script Template Service handles script template related functions and contains the


scriptTemplateService.xml

6.25.1. Get Script Templates

Since v14.0.0.0

SearchResult<ScriptTemplateVO>

getScriptTemplates(Credentials credentials,





This method is used to retrieve all the script templates that match the given criteria.

credentials - login credentials. The user must have the. SCRIPT_TEMPLATE_VIEW

permission

filterMap – A map containing the filter values



return - SearchResult object containing info about result and a list with all script templates


throws - EditServiceException if the operation fails.

6.25.2. Get Script Template

Since v14.0.0.0

ScriptTemplateVO getScriptTemplate(Credentials credentials,Long id);

This method is used to retrieve the script template for the given id.


permission

id – the id of the script template

return - ScriptTemplateVO object containing info about the script template: id, name, script,

tokens, type, description

6.25.3. Get Hierarchical Instances

Since v14.0.0.0

List<DatasetInstanceVO> getHierarchicalInstances(Credentials credentials, String type);

This method is used to retrieve a list of DatasetInstanceVO object based on a specified type.


permission

type – dataset instance type

return – a list of DatasetInstanceVO for the specified type


6.25.4. Generate Program

Since v14.0.0.0

Long generateProgram(Credentials credentials,

ScriptTemplateGenerationVO templateGeneration)


This method is used to generate a program based on the ScriptTemplateGenerationVO

information.


permission

templateGeneration – ScriptTemplateGenerationVO object that contains the information to

generate a program

return - the id of the new program

throws - EditServiceException if the operation fails.

7. WEB SERVICE SAMPLE WORKFLOW

This chapter presents the complete workflow for executing jobs. In the first step the

supported formats of the program need to be uploaded, then the datasets and finally the

program. All these scripts have been tested using soapUI and the archive with the projects is

attached.

7.1. Import Format

7.1.1. Import Format

This step requires DatasetDefinitionService. The request contains format definition

and the response should not contain any errors in order to complete successfully.


1_1_importFormatRequest.xml

1_1_importFormatResponse.xml

7.1.2. Search Dataset Format ID

This step requires DatasetDefinitionService. The request contains the name of the

format and the response contains the detailed formats found.

1_2_searchFormatRequest.xml

1_2_searchFormatResponse.xml

7.2. Import Dataset

7.2.1. Upload Dataset

This step requires DataRepositoryService.The request contains the binary data that

will be uploaded into the repository. The response contains the id of the uploaded file into the

repository.

For testing this request there need to be made some changes :

- in request properties "Enable MTOM" and "Disable multiparts" set to "true".

- added the dataset file from attachments tab

- in " xop:Include" tag we should have something like href="cid:TESTER.csv" as a reference

for the file.


TESTER.csv

2_uploadDatasetRequest.xml

2_uploadDatasetResponse.xml

7.2.2. Start Import Task

This step requires ImportExportService. In order to finish the upload process, an

import task should be started having as parameter the ID of the uploaded file(dataFileId), the

format of the file(dsdId) and the import options(fieldSet, propertySet, datasetInstanceName).

The response contains the id of the task created for this operation.

3_startImportDatasetRequest.xml

3_startImportDatasetResponse.xml

7.2.3. Monitor Import Task


This step requires ImportExportService. After starting the import task this should be

monitored to be completed in order to be able to use the dataset. The request contains the id of

the tasks and the reponse returns the status of the tasks.

4_getTasksStatusRequest.xml

4_getTasksStatusResponse.xml

7.3. Import Program

This step requires ProgramService.

The request contains the definition of the program and the response shouldn't contain

any error messages.

5_importProgramRequest.xml

5_importProgramResponse.xml

7.4. Execute Job

7.4.1. Search Program By Name

This step requires ProgramService because the next steps require the ID of the

program that should be executed. The request contains the name of the program to be searched

and the response will return the details of the program including the ID.

6_searchProgramByNameRequest.xml

6_searchProgramByNameResponse.xml

7.4.2. Save Job

This step requires JobService. The main parameters are for dataset references, job

name and program ID. Response will return the ID of the job.

7_saveJobRequest.xml

7_saveJobResponse.xml


7.4.3. Start Job

This step requires JobService. The request receives as parameter the ID of the saved

job and response shouldn't contain any error messages.

8_startJobRequest.xml

8_startJobResponse.xml

7.4.4. Monitor Job Status

This step requires JobService. The request receives as parameter the ID of the job and

the response contains the status of the job.

9_getJobStatusRequest.xml

9_getJobStatusResponse.xml

7.5. View Job Details

This step requires JobService. The request receives as parameter the ID of the job and

the response contains the details of the job.

10_jobDetailsRequest.xml

10_jobDetailsResponse.xml

7.6. Export Dataset

7.6.1. Start Export Dataset


This step requires ImportExportService. The request receives as parameter the export

options for the dataset instance and the response contains the ID of the task created for this

operation.

11_startExportDatasetRequest.xml

11_startExportDatasetResponse.xml

7.6.2. Monitor Export Task Status

This step requires ImportExportService. After starting the export task this should be

monitored to be completed in order to be able to download the content. The request contains

the id of the tasks and the reponse returns the status of the tasks containing the id of the file to

be downloaded(dataFileId).

12_getExportTasksStatusRequest.xml

12_getExportTasksStatusResponse.xml

7.6.3. Export Dataset File

This step requires DataRepositoryService. The request contains the id of the file

returned from the previous step and the response contains the file content as attachment.

13_exportDatasetRequest.xml

13_exportDatasetResponse.xml

8. OTHER WEB SERVICE SAMPLES

In this chapter are presented most used services and the way they can be called using SOAP

messages. Each function call is detailed for the proper usage of parameters and an example for

a request call with the corresponding response is presented. Most of the responses are

completed successfully if they have no content.


8.1. DatasetDefinitionService calls

Using DatasetDefinitionService the user can manage file formats.

8.1.1. Import Format

This function loads the content of the format into the system and if it is valid the

response should not contain any error messages as the following example. The request contains

the definition of the format.

importFormatRequest.xml

importFormatResponse.xml

8.1.2. Search Format

This function is used to search formats and it can contain filters which are applied to

format name and creation user. Searching allows to retrieve only a few results defined as a

"results page". The following example shows how to search formats.

searchFormatRequest.xml

searchFormatResponse.xml

8.1.3. View Format

Based on the results from seaching the formats the content of the format can be

retrieved using the id from the result list as shown below.

viewFormatDefinitionRequest.xml

viewFormatDefinitionResponse.xml

8.1.4. Export Format

A format can be exported using the id as the parameter as shown below.


exportFormatRequest.xml

exportFormatResponse.xml

8.1.5. Delete Format

A format can be deleted and the call is made using the id as the parameter.

deleteFormatRequest.xml

deleteFormatResponse.xml

8.2. ImportExportService calls

8.2.1. Import Dataset

This function has to be called in order to import a dataset into the system. The request

contains the format of the dataset, the fields contained in the dataset and the property set used

for parsing the values. The response contains the id of the import task.

startImportRequest.xml

startImportResponse.xml

8.2.2. Verify Import Dataset Status

After the dataset import task is launched the status of the execution can be verified

using this function.

taskStatusRequest.xml

taskStatusResponse.xml


8.3. DatasetService calls

8.3.1. Search Dataset

Searching for datasets can be performed using this function and it allows criteria fields

like name, format, interval for creation date(startDate and endDate), user and owner group. If a

dataset is searched after an import was performed then the user must check that the import was

completed with no errors.

searchDatasetRequest.xml

searchDatasetResponse.xml

8.3.2. View Dataset Instance Definition

This function is called in order to view the dataset instance definition.

viewDatasetInstanceDefRequest.xml

viewDatasetInstanceDefResponse.xml

8.3.3. Export Dataset

Export dataset content based on corresponding ID and options. The response returns the

task created for it.

exportDatasetRequest.xml

exportDatasetResponse.xml

8.4. DataRepositoryService calls

8.4.1. Upload File

Uploads a file into the data repository returning the ID as a result

uploadFileRequest.xml

uploadFileResponse.xml

.


8.5. ProgramService calls

8.5.1. Import Program

A program can be created using the import function as in the following example.

importProgramRequest.xml

importProgramResponse.xml

8.5.2. View Program Definition

Program definition can be retrieved using the following sample from the file. It needs

only the ID of the program as the input.

programViewRequest.xml

programViewResponse.xml

8.5.3. Search Programs

Programs can be found using this function for searching. It can also contain filters

which can applied to program name, creation date and others. Searching allows to retrieve only

a few results defined as a "results page".

The sample is detailed in the following files.

searchProgramsRequest.xml

searchProgramsResponse.xml

8.5.4. Export Program

Export program definition as text

exportProgramRequest.xml

exportProgramResponse.xml


8.5.5. Export Program With Dependencies

Export program with dependencies including file formats and lookups.

exportProgramWithDepsRequest.xml

exportProgramWithDepsResponse.xml

8.5.6. Delete Program

Delete the program having the corresponding ID.

deleteProgramRequest.xml

deleteProgramResponse.xml

8.5.7. Import Program With Dependencies

In order to make this call, an archive containing the program with dependencies should

be uploaded into the system and after this the import function may be called using the id of the

uploaded file.

importProgramWithDepsRequest.xml

importProgramWithDepsResponse.xml

8.5.8. Schedule Program For Job Execution

Schedule program execution

programScheduleRequest.xml

programScheduleResponse.xml

8.6. JobService calls


8.6.1. Create Job

Create a job from a program execution.

createJobRequest.xml

createJobResponse.xml

8.6.2. Start Job

Start job execution for the corresponding ID.

startJobRequest.xml

startJobResponse.xml

8.6.3. Search Jobs

Jobs can be found using the following function for searching. It can contain filters

which apply to job name, status, start date, end date and creation user.

searchJobsRequest.xml

searchJobsResponse.xml

8.6.4. View Job Details

Job details can be retrieved using this function which gets as parameter job ID.

jobDetailsRequest.xml

jobDetailsResponse.xml

8.6.5. Delete Job

Delete job function which gets as parameter job ID, it can also delete error/output

datasets related to job execution.


deleteJobRequest.xml

deleteJobResponse.xml

9. WEB SERVICE OBJECTS DESCRIPTION

These objects are used in more than one web service.

9.1. Generic Java Objects

9.1.1. Credentials

This class is used for web service call authentication. Each web service method has as the first

parameter an instance of this class which should have filled the following properties : domain,

username and password.

9.1.2. SearchResult

An instance of this class is used for returning search results because it contains informations

about the count of available elements and a list with all the elements matching the search

criteria

9.1.3. EditHashMap

This class is a custom map, implementing Map interface and having an adapter of type

HashMapAdapter which is used for custom marshaling.

9.1.4. SearchInfo

An instance of this classt contains information about general searching options. It is used for

pagination and has fields for the start index and the number of results that should be returned.

Also it stores the sort fields and thier ordering.


9.1.5. DataHandler

The DataHandler class provides a consistent interface to data available in many different

sources and formats. It manages simple stream to string conversions and related operations

using DataContentHandler.

Instances of this class are used for the transfer of files between the client and the server.

9.2. Generic View Objects

9.2.1. DatasetDefinitionVO

This is used to store the definition of a dataset format having members for : id, name,

description and a list of fields that create a format(List<FieldVO>).

9.2.2. FileInfoVO

This class represents the minimal information for a field : name and field type(FieldType). It is

used to describe a dataset format.

9.2.3. DatasetVO

Instances of this class are used to populate the dataset details page and contains the following

fields : id, name, original file name, dataset content(DatasetContentVO), dataset

definition(DatasetDefinitionVO), group(GroupVO) and keys(List<String>).

9.2.4. ExecutionQueueVO

This object contains informations about an execution queue : ID, name, description, selection

order, minimum input range, maximum input range, accept verticals(boolean),

domains(List<Long>), available to users(boolean).

'EDIT - WEB Services' - circabc.europa.eu · Commission européenne, B-1049 Bruxelles / Europese...

Documents

Transcript of 'EDIT - WEB Services' - circabc.europa.eu · Commission européenne, B-1049 Bruxelles / Europese...