Home

SchemaProf 4.5

1. IMS schemaprof file zip Abbrechen Figure 11 Saving a profile under a different name Please note that a copy of the base schema XSD file and of each referenced XSD file is saved together with the application profile file in the ZIP archive 2 1 5 Closing a Profile A profile s closed for editing f the user chooses Close from the file menu or f a new profile is created or opened or if the user quits the program Prior to closing the profile JMS SchemaProf will check for any changes made since the last saving and ask the user to save the profile or confirm to discard the last changes made 2 1 6 Annotations for Profiles IMS SchemaProf supports both global and local annotations Global annotations that refer to the application profile as a whole can be entered when the root element on the left side is selected It is recommended to make annotations and provide descriptions and explanations to the users of the profile whenever possible For more details please read section 2 4 1 Global Annotations Local annotations are attached to modifications see section Modifications and provide a possibility to explain and document the intention of this specific modification This can become very useful when editing a profile possibly created by someone else and the idea behind a modification it is not obvious The following sections on modification show how to make local annotations We recommend using annotations exten
2. previous section mentions that in rare situations extensions are necessary but have not been foreseen by the schema designer To allow future extension to the schema profiling as used and supported by IMS SchemaProf the profiling schema has some extension point that are not used by the JMS SchemaProf profiling tool itself They are intended to be used for community specific extensions IMS SchemaProf although not able to semantically understand the meaning of the profiling extensions allows the user to enter them at the pre defined extension point This can be done by selecting the root element in the navigation tree on the left side The working area on the right side now show five tabs apart from the Global Schema Annotations tab Select a tab and enter your extensions by pressing the button and entering the XML code as described in the previous section 2 3 8 Assertions IMS SchemaProf allows the definition of assertions in profiles that can be used as a further instrument to ensure compliance and consistency of document instances with profile and specifications respectively Assertions are specified in form of XPath expressions that are evaluated to either true or false The possibilities what kind of conditions can be expressed are the same as for the conditions from conditional modifications But the logic behind them is different Assertions are not tied to a particular definition of the base schema but not to a schema mod
3. CardinalityElement Edit Le item CardinalityElement le metadata CardinalityElement 7 Move Up Delete H sequence grpStrict any CardinalityElement D Hank ur Move Down identifier WalueTypeElemeni identifierref ValueTypeElement isvisible ValueTypeElement parameters ValueTypeElement 8 anyAttribute AnyAttributeElement fa Manifest Type H ManifestMetadata Type E Metadata Type lemme m F Deactivate Mode i Schema Profiling C wD zu Eee Figure 16 The Modifications Dialog www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 23 If modifications are applied to an element this element is highlighted in red colour in the navigation tree The order of the modifications is important If more than one modification is made only the first valid modification is applied See section Order of Modifications Reordering Modifications for more information 2 3 1 New Edit Delete Modifications To enter a new modification select some element on the navigation tree on the left side and click the New button This will open a wizard dialog specific to the current element type For details on the possible values and meaning for specifying the modifications please refer to the following sections Cardinality Type Modifications and Value Type Modifications Elements denoted with a folder symbol 2 in the navigation tree can not
4. Figure 33 Inserting a New Annotation Annotations can be edited and deleted by marking them in the list and clicking the or button 2 4 2 Modification Annotations For all types of modifications it is possible to make annotations Annotations for modification can be categorised to be either explanation or rationale and the language of the annotation can be specified by selecting one of the languages from the dropdown list or write your own language in this box For every combination of category and language string only one annotation is allowed 2 5 Profile Extension Points Most specifications include extension points at several positions of the XML schema for specific and unforeseen information that must be include in a document apart from the foreseen basic data structure The application profiling XML format is also defined as an open format with several extension points This preserves the flexibility to inserting data into profiles that was not foreseen while developing the application profiling specification or is specific to your local requirements and or may be supported by your own tools Since this is a very advanced idea than will probably be used by very few people and may confuse less experienced users the control extension of the extension points must be enabled in the preferences Open the preferences and enable the checkbox Extension Points under the Global Setting tab to make the extension points visible in
5. MB or any user defined divisor Setting one or both of these definitions prevents the use of the FileSize definition absolute size FileDirectory This definition defines a directory where the file is expected This can be a document attribute within the document instance or a user defined and therefore fixed value If defined the file must exist in this directory FileMimetype With this definition a list of MIME types can be specified e g application pdf or text xml If more than one MIME type 1s given they are considered to be alternatives If defined the file of this constraint is expected to comply with one of the given MIME types File Validation The File Validation setting allows you to specify a XML schema or a DTD file The actual file in the document instance in then expected to be compliant to this XML schema or DTD and it s the task of the test system or other tools to verify the compliance Vocabulary Constraints Vocabulary request the use of particular external vocabularies at particular places NOTE While vocabulary constraints can be defined in SchemaProf the IMS Test System will not check them There is ongoing work to extend the IMS Test System with a vocabulary tester For now it is recommended to define the permitted values for a vocabulary entry in the profile using a newly defined simple type that enumerates all permitted values Vocabulary constraints define a schema element and a vocabulary The
6. Prof and related documentation the Product is made available to you under the terms of this IMS SCHEMA PROF END USER SOFTWARE LICENSE AGREEMENT THE AGREEMENT BY INSTALLING OR USING THE IMS SCHEMA PROF TOOL YOU ARE CONSENTING TO BE BOUND BY THE AGREEMENT IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT DO NOT INSTALL OR USE ANY PART OF THE IMS SCHEMA PROF TOOL INSTALLATION AND USE OF THIRD PARTY COMPONENTS MAY BE GOVERNED BY ADDITIONAL LICENSE AGREEMENTS 1 LICENSE GRANT IMS Global Learning Consortium Inc grants you a non exclusive license to use the executable code version of the Product This Agreement will also govern any software upgrades provided by IMS GLC that replace and or supplement the original Product unless such upgrades are accompanied by a separate license in which case the terms of that license will govern 2 TERMINATION If you breach this Agreement your right to use the Product will terminate immediately and without notice but all provisions of this Agreement except the License Grant Paragraph 1 will survive termination and continue in effect Upon termination you must destroy all copies of the Product 3 PROPRIETARY RIGHTS You may not remove or alter any trademark logo copyright or other proprietary notice in or on the Product This license does not grant you any right to use the trademarks service marks or logos of IMS Global Learning Consortium Inc or its licensors 4 DISCL
7. The seconds row of tabs is only visible when the Categories tab is activated and will disappear when switching from the default view Now a different navigation tree is displayed and below two buttons are shown to add or delete new constraint IMS Schemaprof 2 0 tutorialProfile zi p P File Manager Plugins Window Help ma W o z Categories Constraints Additional Constraints i imscp_vip2 xsd File Constraint Eid Constraints oo Name Connecting QTI GE imsmanifest exists FileConstraini FE Connecting QTI Filet traint Condition AssesmentResource Constraint Definitions FileURI location file href relative path 3 New Definition FileValidation value profile _1 qti1p2zip pes Edit Definition XE Delete Definition Delete Constraint Tito ff Schema Profiling Compatibiity E restrictive IE O O Figure 29 Adding and Deleting Constraints in IMS SchemaProf Click the button New constraint to start a new constraint In the dialog opening now choose whether to add a file constraint or a vocabulary constraint and give the constraint a name www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 40 Then click to continue For file constraints a file URI must be defined immediately since this is a mandatory definition that may be modified but never deleted Then click to get back to the main window where further constraint definitions can be inse
8. Type Figure 3 The Schema Navigation Tree The types of elements in the navigation tree are signalled by different icons 4 A compound element that is made up of one or several sub elements e g complex types E Click on those symbols to expand or collapse this element in the tree with the details of the element Sequence element Contains several subelements and the order of the subelements 1s relevant E Choice element Only one of the subelements may be chosen in the target document Element Definition of a schema element Simple Content A tree leaf that will hold a simple type value in any target document www imsglobal orgO 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 9 Attribute Definition of an attribute of an element Table 1 Navigation Tree Icons Additionally the cardinality elements those elements who s subelements may occur several i e a Sequence show the cardinality of the original definition in the icon e g n shows the cardinality one or many elements See Table 3 for details on cardinality symbols 1 5 Working Area The right side of the program windows show the working area The content of the working area s adapted according to the element that s currently selected in the navigation tree on the left side Depending on the type of selected element and whether a constraint file or profile s opened different actions are available and
9. a global annotation select the root element of the base specification in the navigation tree The working area on the right side will show several tabs on top please select the tab Global schema Annotations and click on the button EJ IMS Schemaprof 2 0 tutorialProfile zip File Manager Plugins Window Help Global Schema Annotations pi imscp_vip2 xsd Modification Annotations S d Constraints EE imsmanifest exists FileConstraint JAE ETRE EEE Category Language Content New name en schemaProf Tutori Edit Delete Pode ff Schema Profiling Compatibiity E restrictive N a A Figure 32 Global Annotations Now one or several annotations can be entered by clicking on the button and entering the information An annotation consists of the annotat on text bound to a category and a language The categories available for the global annotations are name scope policy conformance and general It s important to define the name of the profile precisely as this will allow later to determine what a specific test system is for The language can basically be any language string as defined n http www w3 org TR xmlschema 2 language based on RFC 1766 The most common language strings are available in the drop down box but can be overwritten www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 45 J Annotation editor A schemaProf Tutorial Profile ok Cancel
10. and validation is specified in the W3C document XML Schema Part 2 Datatypes http www w3 org TR xmlschema 2 Step 1 Select the element you want to modify in the navigation tree on the left side Then press the button on the right side Step 2 Select Restriction and press the button Step 3 Enter the restrictions needed Depending on the element type different facets restrictions are available Leave all other fields untouched to not change the current values e The tab length allows restricting the number of characters for a value A fixed length a minimum and a maximum length can be entered More details on http www w3 org TR xmlschema 2 rf length e The tab pattern allows entering of a pattern constraining the lexical value space of a data type to literals which match the given pattern The pattern is given as a regular expression according to http www w3 org TR xmlschema 2 rf pattern www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 27 e The tab enumeration makes it possible to define a set of values The value space of the current element are then restricted to the values of this set only See http www w3 org TR xmlschema 2 rf enumeration for more information e The tab whitespace can be used to specify the handling of whitespaces in values of this element Allowed values are preserve replace and collapse The meaning of the values is given in http www w
11. are explained in detail in the following Create new type from a restriction of an existing type Step 1 Enter a name for the new type you are creating now Step 2 Select Restriction Step 3 To define a new type based on a restriction of an existing type you must now choose the base type from the drop down box below Then press the button Step 4 Enter the restrictions to be made to the basic type Leave all other fields untouched to not overwrite the current values The restrictions available depend on the base type you have chosen in the previous step The following restrictions are possible e The tab length allows restricting the number of characters for a value A fixed length a minimum and a maximum length can be entered More details on http www w3 org TR xmlschema 2 rf length e The tab pattern allows entering of a pattern constraining the lexical value space of a data type to literals which match the given pattern The pattern is given as a regular expression according to http www w3 org TR xmlschema 2 rf pattern e The tab enumeration makes it possible to enter a set of values The values of this element are then restricted to this set of values See http www w3 org TR xmlschema 2 rf enumeration for more information e The tab whitespace can be used to specify the handling of whitespaces in values of this element Allowed values are preserve replace and collapse The meaning of the values is given in http www w3
12. be able to add any further namespace the user can namespace type any namespace into the dropdown filed and add it to the list Table 4 Possible values for namespaces Cardinality only type any elements The cardinality of this element can be modified by entering new values for the minOccurs and maxOccurs values Condition A condition can be chosen from the dropdown list This condition must be satisfied to activate this modification Use the button to enter a new condition or modify an existing condition Conditions are XPath expressions which are evaluated in the instance document at test time All elements in these XPath expressions must have a prefix which is defined in the Namespace Manager Only if the XPath expression in the condition evaluates to true in a file to be tested validation for the respective modification will be triggered The conditions are used to determine whether a modification is applied at all and respectively which modification is applied when several modifications are given see section Order of Modifications Reordering of Modifications above for more information While unconditional modifications are translated by SchemaProf into modifications of the base XML Schema this is not possible for conditional modifications Such conditional modifications are represented as Schematron rules http www w3 org TR xmlschema 0 nsTable www imsglobal orgO 2009 IMS Global Learning Consortium Inc IMS Sch
13. can be accessed through the buttons on the right side Others might be disabled or not available E IMs Schemaprof 2 0 tutorialProfile zip File Manager Plugins Window Help Ras BR Categori esl Constraints Additional Constraints pi imscp vip2 xsd File Constraint ER Constraints Name Connecting QTI BE imsmanifest exi Connecting QTI FileCon l Condition AssesmentResource Constraint Definitions FileURI location file href relative path D New Definition FileValidation value profile_1 qtidp2 zip ee ne Edit Definition we Delete Definition 5 New Constraint X Delete Constraint Mode ffi Schema Profiing Compatibilty E restrictive Figure 4 The IMS SchemaProf Working Area On top one or more tabs are available Normally they show the element type of the selected element e g Cardinality Element Below additional information about the element is displayed if available e g element facets or constraint details The lower part of the working area shows a list of the modifications made to this element when working with the profile or the constraint definitions when working with constraint files The buttons on the right are used to add delete or edit modifications or constraint definitions The second tab gives access to the assertions that may be defined through XPath expressions These assertions are tied to the current element The assertions are defined in the profile and can only be v
14. conrains additional constraints e Schema Validation this shall be required in most cases e Schematron Validation this is always required if conditions or assertions are used In the following steps it can be determined for which files in a package which tests are executed This is done by giving regular expressions for the file name for example xml will select all xml files and for the namespace we only want files of our particular namespace http www imsglobal org schemaprof tutorial tested so this can be taken as a regular expression for the namespace In the next steps it can be selected which schema 1s to be used to define which namespace In most cases SchemaProf will select the correct schema schematron or constraint file automatically but in some cases when a specification defines the same namespace in several schemas your help may be needed Make sure that you select one of the offered schema files with ocalised in their name since these will be the ones that have been modified according to your profile In this tutorial SchemaProf can determine the correct schemas for all namespaces except for http Itsc ieee org xsd LOM for which many defining files exist We select the localized version of the IEEE LOM root schema 1 e domainProfile_O lomLoose_localised xsd Then we are taken to configuring the reference tests We only want references in the file imsmanifest xml be tested So we enter imsmanifest xml as regular expr
15. course has impact on all referring elements When a modification must be made to the referring element a decision must be made whether to do a global and local modification Global Modification When the referred element is modified this is a global modification This modification will affect any other schema element that has a reference to this element Local Modification This modification is made to a referring element It will modify only this schema element It leaves the referred element untouched thus having no influence on all other elements referring to the referred element IMS SchemaProf s able to make local and global modifications for an application profile If a schema element in the navigation tree is shown in grey coloured text this means that this is a referring element By default no modification can be made to this element This forces the user to decide whether to make a global or a local modification at this point To make a global modification the user must switch to the position in the navigation tree where the referred element is found The easiest way to find the global definition is right clicking the referring element and clicking Focus Global Element from the context menu Now you can modify this global definition Making a modification to this referred element will affect all XSD elements referring to this element To make a local modification the user must toggle the activation state of the referring
16. element first This 1s done by right clicking on the referring element in the navigation tree and selecting Activate This changes the text colour to black and allows from now on making local modification to this XSD element These modifications will be realized as local modification in the application profile influencing only the current element and leaving the referred element and any other XSD elements untouched _ zen El IMS Schemaprof 2 0 tutorialProfile zip gt a u too File Manager Plugins Window Help Ra ms Categories Constraints Assertion i Modification Elements ComplexTypes AttributeGroups Model Groups el imscp_ vip xsd New Dependency Type Edit File Type tem Type Delete le title fCardinality lement T Epe seauenc CardinalityElement Move Up a item CardinalityElement Move Down g E lel metadata CardinalityElement Ud Metadata Type Els ze sequenc e CardinalityElement fe schema Cardinal Element E TE sche H lel schema 7 Activate ai Su H H sequent Focus Global Element 5 J E seguente grpStrice ZT LE STONE OS Terie 8 identifier ValueTypeElement e identifierref ValueTypeElement ln m En Le Le ES me ni EEE TEE EEEEEETETERTN 25 Deciding for a local or global modification of a referring element www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 33 T
17. from organizations other than the IMS Global Learning Consortium please contact the Knowledge Media Institute of the University in Koblenz at iwm uni koblenz de Even without a dedicated test system the profiles created by IMS SchemaProf can be used for testing though not with full comfort and power In particular these will not test for additional constraints and for conditional modifications of simple XML types They will also not do reference testing and testing of many test items for the constituents of a domain profile in one test run as do dedicated test systems To do some conformance tests nevertheless you will need an XML validator and a Schematron validator Unzip the profile that has been saved by SchemaProf Locate the subdirectory named derived_schema In this subdirectory you will find a new XML schema which has the same name as the base schema of the profile with _localised appended to the file name root This schema can be used with an XML validator to test for those parts of the profile that can be expressed in an XML Schema In the same directory you may find a file with the file name extension scmt This file can be used by a Schematron validator to do further tests The root directory of the IMS SchemaProf generated domain profile will also contain a number of directories whose names start with profile_ These contain the auxiliary profiles which are used in the domain profile aside of the main profile Tests for those auxiliar
18. in the left part of the SchemaProf window The second requirement poses a challenge since there is only one definition of the type of the item element which has an optional title but requirement 2 comes in two variants depending on the context in which the element is used Let us for the moment defer handling the exceptional case of the root item We select the title element which appears when the sequence below the item Type node is opened by left clicking it The right panel shows on top the original definition minOccurs 0 1 e the title element 1s optional We change this by clicking New to start a new modification and set minOccurs to 1 we have made title unique and mandatory in item You may note that SchemaProf would not allow to increase the maxOccurs value This is because we are working in the default restrictive mode of SchemaProf which does not allow for modifications that would break the original specification Using the New button we add a comment that explains this modification Note that the path towards the title element in the left panel has become red and the fitle element name is in italic This indicates a place where our profile contains a modification with respect to the base schema Please close now the unfolded item Type node in the hierarchy In order to handle the exceptional case of the root item element we have to access the definition of item Type used in the context of the organization element as this elem
19. org TR xmlschema 2 rf whiteSpace www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 18 Press the button to continue when all restrictions are entered Step 5 Press the button to finish this type Create a new type from a union of existing types Step 1 Enter a name for the new type you are creating now and press Next to continue Step 2 Select Union and press to continue Step 3 To add a type to the list of types to unify select the type from the drop down list and press the button The type w ll now appear on the l st below To remove a type from the list select the type from the list and press the button Press when all required types are on the list Step 3 Press the OK button to finish this type Create a new type from a list of existing types Step 1 Enter a name for the new type you are creating now and press to continue Step 2 Select List and press to continue Step 3 Select the type from the drop down list the new list element should be based on Press to continue Step 4 Press the OK button to finish this type Edit Type To edit a previously user defined type select the type from the list of available types Then press the button Depending on the nature of the type atomic union or list a different dialog window will open The information you can enter in the fields of this dialog are a combination of the fields offered in step 2 and step 3 of
20. the GUI www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 46 en m 5 Global Settings Internationalization Plugins Compability Extension Points Res fictive Look amp Feel Windows Proxy Settings Enable Proxy Proxy Host Proxy Port Figure 34 Enabling of Profile Extension Point Once enable the extension points are visible for these elements Root element of the profile the new tabs Annotation Extension Definition Extension Mapping Extension Modification Extension and Section Extension are now available on top of the right side El IMs Schemaprof 2 0 tutorialProfilezif eof hom File Manager Plugins Window Help Les pai Le Sun categories Constraints Global Schema Annotation amp TAnnotation Extension Definition Extension Mapping Extension Modifications Extension Section Extension D Modification Annotations Pi imscp_vip2 xsd Constraints BE imsmanifest exists FileConstraint BE Connecting QTI FileConstraint Add edit or remove global Annotations Deter ee Dantant Nau Figure 35 Extension points of the root element For each of the complex types a Modification Extension tab is now available To enter your own XML data at these positions please enter the appropriate XML code into the text boxes and don t forget to declare any namespaces and prefixes to be used in the
21. the current profile If the same profile is referenced at more than one extension point of the current profile it will still appear only once in the profile manager Please note than that the profile manager will only show those profiles that are referenced directly from the current profile If a referenced profile again references further profiles therefore indirectly referenced by the current profile they are not shown in the list fj Profile Manager Profile Manager Information Open and replace referenced profiles CJUsers dahn AppData Local TempimpLoadedProfiles LoadedProfilet profile_O ieeeLom Open Replace Close Figure 15 The Profile Manager Despite giving an overview over the referenced profiles the profile manager profiles the following functionality Open Profile A profile referenced by the current profile can be opened for editing using the profile manager Select the profile to open from the profile manager list and press the button This supports the concept of domain profiling where several specifications are used n combination and therefore should be profiled together Prior to closing the current profile IMS SchemaProf will ask the user to save the current profile f any changes have been made that are unsaved To come back to the previous profile please use the functionality of the file history Replace Profile It is possible to modify all references of a profile to reference another profile
22. the root of the package takes us to additional constraints Additional constraints require specific test systems They are defined through the right tab Constraints in the left part of the SchemaProf window After clicking on this tab there is a new button New Constraint available at the bottom of the window We go for the definition of a file constraint with a user defined value imsmanifest xml which is entered as the URI I1 The second part of Requirement 5 Assessment Resources must contain a single File object which references the QTI XML file This file must conform to the IMS QTI 1 2 1 specification requires a dynamic additional constraint 1 e the constraint in particular the location of the QTI XML file depends on values to be found in the instance document s resource elements the Aref attribute of an assessment resource must point to a file which is valid w r t the QTI specification First we select the definition of a file constraint But this time we don t use user defined value but value stored in an attribute The respective href attribute is determined in two steps First we select from the complexType group resource Type as the relevant context and then the Aref attribute of this type as the attribute which holds the location of the file to be tested After ticking that the file location is relative leave the file name format at any and we can finish But this test should be don
23. then composed of a finite length sequence of values of the specified type Step 1 Select the element you want to modify in the navigation tree on the left side Then press the button on the right side Step 2 Select List and press the button Step 3 Select the base type of the list from the drop down list Press to continue Step 4 Enter further facet information as explained in Step 3 above Then press the button Step 5 Enter a meaningful name for this modification and press the button Step 6 Enter annotations conditions usage information and default value as explained in Step 5 above if required and click button Step 7 Finalize this entry by clicking the button Create a new Mod hcaton SES List Type Selection Please choose an item Type for the List Type List Type Choose Item Type for List Type PermittedResources PermittedResources xs all NI ks anySimpleType xs anyURI MS baseb4binary ks blockSet MS boolean xs date Time Figure 24 The Replace with List Type Modification www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 32 2 3 5 Global and Local Modifications Sometimes an element of a base XML schema referring element s defined using a reference to another schema element referred element More than one referring element can exist pointing to the same referred element If the referred element is modified this of
24. 3 org TR xmlschema 2 rf whiteS pace Create a new Modification a e Type Restriction Please restrict the choosen Base Type length minLength maxLength Finish Cancel Figure 20 The Facets Modification Dialog Press the button to continue when all needed restrictions are entered Step 4 Enter a meaningful name for the new type that will be created based on the setting Step 5 In this step of the wizard the following information can be entered e One or more annotations may be entered for this modification To enter a new annotation use the button on the right side In the opening dialog the text can be entered Each annotat on s bound to a category and a language which can be selected below The category can be selected to be explanation or rationale The language can basically be any language string as defined in http www w3 org TR xmlschema 2 language based on REC 1766 The most common language strings are available in the drop down box but t can also be overwritten Corrections are possible using the and buttons www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 28 e A condition that must be satisfied to activate this modification Use the button to enter a new condition or modify an existing condition The conditions are used to determine whether a modification is applied at all and respectively which modification is applied when several modif
25. AIMER OF WARRANTY THE SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM DAMAGES OR OTHER LIABILITY WHETHER IN AN ACTION OF CONTRACT TORT OR OTHERWISE ARISING FROM OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 55 5 EXPORT CONTROLS This license 1s subject to all applicable export restrictions You must comply with all export and import laws and restrictions and regulations of any United States or foreign agency or authority relating to the Product and its use 6 MISCELLANEOUS a This Agreement constitutes the entire agreement between IMS Global Learning Consortium Inc and you concerning the subject matter hereof and it may only be modified by a written amendment s gned by an authorized executive of IMS b Except to the extent applicable law if any provides otherwise this Agreement will be governed by the laws of the state of Florida U S A excluding its conflict of law provisions c This Agreement will not be governed by the United Nations Convention on Contracts for the International Sale of Goods d If any part of this Agreement is held invalid or unenforceable th
26. Constraint Definition To add a constraint definition first select the constraint in the navigation tree on the left side The constraint must exist already see section Adding a new constraint on how to create a constraint On the right side you can see the existing definitions of that constraint if any exist Now click the button on the right side to add a new definition to the list Depending on the constraint type file constraint vocabulary constraint different definitions will be available It is possible that some definitions are disable if they are is use already or conflict with definitions in use www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 41 x El IMS Schemaprof 2 0 tutorialProfile zip File Manager Plugins Window Help Es ER Categories Constraints Additional Constraints Bi imscp_vip2xsd File Constraint GE imsmanifest exists FileConstraini EE Connecting QTI FileConstraint Condition AssesmentResource Constraint Definitions FileURI location file hreP relative path FileValidation value profile _1 qt1p2zip X Delete Definition ne Bi Schema Profiling Compatibility Compatbiny Ej resticive Figure 30 Adding Editing and Deleting a new constraint definition Deleting or Editing a Constraint Definition To delete a constraint definition select the constraint first in the navigation tree on the left side Now you
27. IMS Schema Profiling Tool MS Version 2 0 Innovation Adoption Learning SchemaProf User Manual 8 N 2 Institut f r Wissensmedien IMS Schema Profiling Tool User Manual 2 INTRODUCTION de ne a ane 4 1 IMS SCHEMAPROF USER INTERFACE 22220 20022000200n00nnnnn nn 5 1 1 Menu Bar een a aaa 5 1 2 OS en 7 1 3 SEIECHON TADS aa en 7 1 4 NAVIGATION VCC SPRBESENERRERERRERENEENEEEOEEEEBEEFEEEEUERESEEEEFDEEENFERESEEER SEEEEEDEEEEHBEEEEESDEEBERERE 7 1 5 WOKING ATEA irira aE aa 9 1 6 Pror OS aa E R 10 161i Gl obal Sellings sisean ee ass ed 10 1 62 INT MATONANZAION 85 ressens benne cent 11 1 053 PUOI EP Re RS Eee 12 1 7 Command Line Sade 2 2 2 en 12 1 8 Help and BUG RED OMING seciscccseccectccasessnctectesedeccasixecensectssecececadexcesassecsttectenss 12 2 SCHEMA PROFILING wissscwesccccsiennccsncctantanscanasetudanadewcatecentseeetienevdssiets 12 2 1 File Handling sieisen aeee a nee ende denen 12 2 1 1 Creating a new Profile uuu020000000000000nnanan00nnnnnnnnnnnnnnnnnnn0 12 2 1 2 Opening an existing Profile 14 2 1 3 Using the File History ssssncnemsonsenrens 14 21 4 Saving 3 ProNle c uem nissan us 15 2 1 5 Closing a PrOMI nn mnnn 16 2 1 6 Annotations for Profiles auu0022220000200000n000nnnn0nnnnunnnnnnnnn 16 2 2 Managers se A 17 2 2 1 FYD Manage oesie E ENa 17 2 2 2 Condition Manager 18 2 2 3 Namespace Ma
28. Prof window Now you are ready to begin with the actual profiling work It is good practice to define as a first step the namespace of the profile through the namespace manager By default the profile shall inherit the namespace of the base schema Once being in the namespace manager it is recommended as well to declare prefixes for all namespaces which you intend to use In particular each namespace to be used in a condition or assertion must have a nonempty prefix assigned The following modification can be made to the schema e Make global and local annotations to the profile e Modifications to existing types e Creation of new types e Usage of conditions e Use further XML namespaces or Profiles e Add or modify additional constraints 2 1 2 Opening an existing Profile To open an existing application profile use the menu item File Open or the corresponding toolbar button Then choose the file containing your IMS application profiling compliant schema profile from the local file system This is a ZIP file containing all profile information This file and can be opened directly from the IMS SchemaProf file open dialog No unzipping or uncompressing 1s needed Loading and parsing of the profile will take a few seconds The profile structure is then shown on the left side of the program windows in the navigation tree KE IMS Schemaprof 2 0 SE i O File Manager Plugins Window Help Figure 8 Opening an existing profile using t
29. Space preserve a Figure 1 The IMS SchemaProf main window layout For many operations pop up dialog boxes will open to request the information needed from the user some of them guide the user through several dialogs with a wizard interface 1 1 Menu bar The IMS SchemaProf menu provides access to the following menu items www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 6 File Menu New Open Save Save as Close 1 lt filename gt Quit Manager Type Manager Condition Manager Namespace Manager Profile Manager Constraint Manager Test System Bundle Manager Test Configuration Manager Plugins Starts a new profile or constraint file based on an XML base schema to be specified by the user Prior to that JMS SchemaProf will ask the user to Save any unsaved changes to the current profile Open an existing profile or constraint file Save the current file If the file name is not specified the user must enter it now Save the current profile or constraint file into another file or directory Close the currently opened file If latest changes have not been saved IMS SchemaProf will ask to save or discard the changes The file history that shows the last five files that have been opened Select any of the files to open it directly Quit JMS SchemaProf If latest changes have not been save
30. This functionality is provided to allow easy replacement of a profile by a new version of the profile This will hopefully improve consistency of a profile when a profile is referenced more than once Even if the profile is referenced only once access to it is much easier through the profile manager instead of having to locate the extension point in the depth of the navigation tree first To replace all occurrences of a profile select the profile from the profile manager list and press the button This will open a file selection dialog where you choose the new profile XML file to be used After pressing Open all occurrences are replaced www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 22 2 2 4 Test Configuration Manager The Test Cofiguration Manager is accessible from the menu item Edit Test Configuration It s used to create a configuration file for the test system to be generated for the profile This configuration specifies for which type of file given by file name or namespace schema validation and schematron validation should be done SchemaProf will guess reasonable settings but it s strongly recommended to inspect these In particular f the same namespace is defined in several schemas you shall need to select manually which schema is to be taken as the main schema defining this namespace SchemaProf will offer you a dropdown list which lists all that are availabl
31. alidated for document instances of the current profile which can be checked with the TELCERT test system See section Assertions for more information www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 10 1 6 Preferences The IMS SchemaProf preferences dialog is available by clicking the toolbar button HS or selecting the menu entry Windows Preferences The preferences dialog window show three main categories that are available through the tabs on top see Figure 5 Global Settings Internationalization Plugins Compability Extension Points Restrictive Enable Look amp Feel Proxy Settings L Enable Proxy Proxy Host Proxy Port OK Cancel ER EEE Figure 5 The preferences dialog window 1 6 1 Global Settings Extension Points IMS SchemaProf provides extensive support for extension point In addition to letting you control the extension points predefined in the base schema through any elements and anyAttributes it is possible to extend the profile definition format Enabling this setting gives you access to this functionality If disable this functionality is hidden for simplicity Look and Feel The Look amp Feel setting allows switching between some visual appearances of JMS SchemaProf Windows Metal and CDE Motif are available This setting has no i
32. at part will be construed to reflect the parties original intent and the remaining portions will remain in full force and effect e A waiver by either party of any term or condition of this Agreement or any breach thereof in any one instance will not waive such term or condition or any subsequent breach thereof f Except as required by law the controlling language of this Agreement is English g You may assign your rights under this Agreement to any party that consents to and agrees to be bound by its terms IMS Global Learning Consortium Inc may assign its rights under this Agreement without condition h This Agreement will be binding upon and will inure to the benefit of the parties their successors and permitted assigns COPYRIGHT Copyright notice applicable to IMS Global Learning Consortium Inc s IMS Schema Prof Software and Documentation Copyright 2004 2006 Universit t Koblenz Landau Institut f r Wissensmedien IWM This product includes software developed by the Eclipse Foundation http www eclipse org This product includes software developed by the Apache Software Foundation http www apache org Copyright c 2006 by IMS Global Learning Consortium Inc All Rights Reserved www imsglobal org 2009 IMS Global Learning Consortium Inc
33. be modified Still Assertions and if extension points are enable in the preferences Modification Extensions are possible for those elements To edit a modification select the element in the navigation tree on the left side first Modified elements are highlighted in the navigation tree Then select the modification you want to edit in the working area on the right side Now press the button to edit the selected modification For details on the possible values and meaning for specifying the modifications please refer to the following sections Cardinality Type Modifications and Value Type Modifications To delete a modification select the modified element in the navigation tree on the left side first then select the modification you want to modify on the right side Now press the Delete button with the modification selected and confirm the deletion 2 3 2 Order of Modifications Reordering of Modifications For a single element more than one modification can be specified But only one modification will be applied for each element Which modification will be applied is determined by the order in which the modifications are given and by the conditions given for the modifications The first modification whose condition is evaluated to true will be applied All modifications following this modification in the list of modification are ignored This means that the order in which the modifications are arranged n the list is important Modificat
34. ce Then we set its minOccurs and maxOccurs both to Now we have to capture that this modification is only applied under the condition that the resource is of type assessment Note that there is a button which takes you right to the condition manager We use it to define a new condition www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 49 containing the XPath expression type assessment We select this as a condition for our modification and close the condition manager Now we can select this condition from the drop down list add an explanatory comment and finish This completes capturing the first part of Requirement 5 The second part shall be handled by additional constraints below Requirement 6 says If an item references a resource then there cannot be subitems An item references a resource if it has an identifierRef attribute We select the identifierRef attribute of item Type This makes sure that the following requirement shall be applied only if this attribute exists In this case we can express our requirement there cannot be subitems as the XPath assertion count tut item 0 Assertions are entered through an additional tab Assertion of the right part of the SchemaProf window Note that tut is the prefix that we have defined for our profile namespace earlier on in the namespace manager Requirement 7 The file imsmanifest xml must exist at
35. ces given in the list of types Step 1 Select the element you want to modify in the navigation tree on the left side Then press the button on the right side Step 2 Select Union and press the button Step 3 Compile a set of type to be joint in a union To add a type to the set of types select the type from the drop down list and press the button The type will now appear on the list below To remove a type from the list select the type from the list and press the button Press when all required type are on the list Step 4 Enter further information if required as described above and press the button Step 5 Enter a meaningful name for the new union type and press the button Step 6 Enter annotations conditions usage information and a default value as explained above and press Next Step 7 Finalize this modification by clicking the button Create a new Modification el Select Union Types PermittedResources PermittedResources XS alINN s anySsimpleType MS anyURI xs baseb4dBinarny xsblockSet xs boolean xs byte xs date S date Time lt Hack Next Finish Cancel Figure 23 The Replace with Union Modification www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 31 Replace by a list of existing types Use this option to define a data type that will be derived from an atomic or union data type The value space of this element 1s
36. d IMS SchemaProf will ask to save or discard the changes The type manager gives an overview over the user defined type of the current profile and allows deletion or editing A type is defined globally and may be used at several positions of a profile The condition manager gives an overview over the user defined conditions of this profile and allows deletion or editing A condition is defined globally and may be used at several positions of a profile The namespace manager is the place where you can set the target namespace for your profile It also gives an overview of all namespaces used in the profile The profile manager shows all the profiles referenced by the current profile This is important for domain profiles The constraint manager gives an overview of the constraint file used and allows adding or removing constraint files This item allows extending SchemaProf with support for new specific test systems Extension of SchemaProf shall be handled in another document The Test Configuration Manager allows to determine which tests are to be applied to which files in a package IMS SchemaProf has a plug in interface to allow specific extension to the program If you intend to develop plugins please contact schemaprof uni koblenz de Windows Preferences Opens the preferences dialog windows that will allow you to change www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manua
37. d has assigned this new type to the root item Now we can set maxOccurs for this copy of the title element to 0 This declares that title must not be used for items which are directly below the organization element Capturing of Requirement 2 is complete Requirement 3 allows only two values for the type attribute of a resource element We select this attribute in the definition of resource Type and click New to start our modification As we need a new simple type with just two elements we start a new modification of this definition and select a Restriction of the existing simple type string From the available modification facettes we select the Enumeration tab We enter our two permitted values webcontent and assessment Our newly defined simple type gets a name say PermittedResources In a next step we check that the use of the type attribute is required This is a good time to go to the Manager menu and open the Type Manager You will find your newly defined type listed there ready for further modifications in case you want to add another resource type Now let us look at Requirement 4 The manifest must have metadata which conform to the IEEE LOM metadata specification Our IMS Content Packaging base specification does not prescribe the use of a particular metadata specification or profile It just provides an extension point in the type definition of ManifestMetadata This extension point is a reference to grpStrictAny Since we
38. e If you select schemas from auxiliary profiles you should select those with _localised in their names since these are the ones modified for the specific auxiliary profile Some specifications for example IMS Content Packaging request that all files in a package are referenced at particular locations in a particular file Using the Test Configuration Manager you can determine this location with an XPath expression or deactivate reference testing 2 3 Modifications To make edit delete or rearrange modification to your specification s XML schema you must first locate and select the element to be modified in the navigation tree on the left side of the program window The right side of the windows then shows the list of all modification of the currently marked element if any exist already On top of the right side you see the default settings of the element as given in the base schema On the rightmost side of the program window you find buttons to create new modifications edit or delete existing modifications and to rearrange the modifications i u j IMS Schemaprof 2 0 tutoralProfile zir P P m File Manager Plugins Window Help Ras B amp G Categories Constraints Cardinality Element Assertion CardinalityElement Elements GomplexTypes AttributeGroups ModelGroups i mindccurs 0 maxOccurs 1 Bi imscp_vip2 xsd File Type CardinalityModification minOccurs 1 maxOccurs 1 Ege Item Type Ere sequence
39. e only for assessment resources Therefore we let this test depend on the already defined condition that the resource element which defines the context of the condition has a type attribute with value assessment This condition can be selected from the condition dropdown list So far we have only required that the referenced file exists We still need to require that it is a QTI file To do this we select the constraint that we just defined and click on the right side New Definition We want to request a validation against another profile and so we select File Validation as type of the new definition We the user want to determine the profile to be used for validation so we select user defined value Then we can browse for the QTI profile to be used for validation We select the QTI profile ieeeLom zip from the AuxiliaryProfiles folder This completes capturing Requirement 5 The last step in the creation of a profile is the configuration of the test system using the Test Configuration Manager After saving the profile the Test Configuration Manager takes you through a number of steps The first of these steps allows disabling some of the following test types e Reference tests 1 e testing that all files in a package are referenced as in our Requirement 8 www imsglobal orgO 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 50 e Constraints Validation this is only needed if the profile
40. e toolbar provides quick access to most often used functions 3 The selection tabs switch between schema modifications and constraint and group the schema components into top level categories 4 The navigation tree shows the schema structure and components and allows the selection of components for modification and annotation 5 The working area shows information on the currently selected element and allows the user to apply operations on that element 6 The status bar shows the operation mode and compatibility level 2 IMS Schemaprof 2 0 tutonialProfile zip File Man Plu Help Toolbar 3 Selection Tabs Attribute Properties Element Assertion AttributePropertiesElement Elements ComplexTypes AttriputeGroups ModelGrou g R Type xs string Base Type xs anySimpleType Bi imscp_vip2xsd Ex di Dependency Type Hl File Type Elo Item Type wa E eee sequence CardinalityElement rentes 8 identifier ValueTypeElement New lidentifieref ValueTypeElement isvisible ValueTypeElement Edit parameters ValueTypeElement aa Delete anyAttribute AnyAttributeElement 4 Navigation Tree dJ Manifest Type Move Up ManifestMetadata Type l Metadata Type 5 Working Area Move Down Organization Type Organizations Type Resource Type 6 Status Bar u Resources Type F Deactivate Mode fi Schema Profiling Compatibility EE restrictive white
41. ema Profiling Tool User Manual 36 Edit the selected any element modification rg Namespace profile list and process content Edit namespace profile list and process content Namespace Profile List Frany Frocess Content lt Back Next gt Finish Cancel Figure 27 Extension point modification window Modification Annotations One or more annotations may be entered for this modification To enter a new annotation use the button on the right side In the opening windows the text can be entered Each annotation s bound to a category and a language which can be selected below The category can be selected to be explanation or rationale The language can basically be any language string as defined in http www w3 org TR xmlschema 2 language based on RFC 1766 The most common language strings are available in the drop down box but can be overwritten Corrections are possible using the Edit and buttons Click the OK button when all information is entered The modification can be edited later on using the button or removed using the button and rearranged using the and buttons Modifications should be always annotated with explanations This is particularly important for conditional modifications Wild Extensions An XML schema should only be extended at pre defined extension points that are foreseen by the schema developer and identified in the schema by the names any and anyAttribute T
42. ent is supposed to keep the hierarchy of items We can unfold organization Type in order to see the item Type definition on which it relies The item element definition is the second node within the sequence The first title element in the sequence 1s the title of the organization but Requirement 2 concerns only titles of item elements Therefore we don t have to change this www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 48 first title One further click on the item element gives access to its definition in item Type If there is too little space on your screen for the hierarchy of definitions you may move the border between the left and right part of the SchemaProf window with the mouse We unfold item T ype further until we reach its title element Note that item Type and everything below it is greyed out It can be inspected but cannot be modified This is because it is not defined within this local context but is instead included by reference to the global type definition for the item element When you click on the greyed title element whose multiplicity we want to set to 0 a new button Activate appears in the lower part of the screen alternatively you may right click on the title When you now use this button to activate title the grey color disappears and title is now available for modification internally SchemaProf has created a modifiable copy of the original item Type an
43. er true or false See http www w3 org TR xpath booleans for further information on Boolean objects and their evaluation according to the W3C recommendations Expressions evaluating to any other value e g to or O are not allowed You may e g use functions refer to schema elements and their values or use Boolean and comparison operators For an authoritative and up to date explanation on XPath expressions always refer to the W3C recommendations given above For a simple and quick overview on the XPath expression elements you can also use some quick reference available on the internet e g http gordon inf ethz ch lectures isk2003 XPath pdf Make sure you prefix all element names with prefixes defined in the Namespace Manager Whitespaces can be used for better readability and are preserved They should not influence the evaluation of the condition but this depends on the program working with your profile According to W3C recommendations all of the following expressions should be evaluated to the same value myAttribute lt count tut someStructure myAttribute lt count tut someStructure myAttribute lt count tut someStructure myAttribute lt count tut someStructure Examples of Conditions e true This s a valid condition making use of the Boolean function true that will always evaluate to the Boolean value true The condition will therefore always be satisfied e true T
44. error is reported skip No validation of the element will be performed during schema validation Table 4 Processing options for extension points any elements Namespace Application Profile List This list contains the allowed namespaces and or application profiles The document instances will be restricted to contain only those elements from the defined namespace and profiles at the position of the current extension point More than one namespace or profile may be defined namespaces and profiles can be mixed In the list of allowed namespaces and profile the namespaces are identified by the icon and application profiles are identified by the il icon Using other application profiles while profiling a specification s extension point is one form of domain profiling For more information on domain profiling please refer to the Telcert website or the IMS Abstract Framework Glossary Use the first dropdown list to select whether you want to add a namespace or an application profile to the list The second dropdown list offers the options which differ for regular namespaces and application profiles See Table 4 and Table for the list of available values and their meaning Use the button to add the currently selected chose of a namespace or profile to the list Use the button to start the profile manager for the management of profiles used and possibility to quickly switch editing to the other profile Browse Selectin
45. ession for matching files We can also enter http www imsglobal org schemaprof tutorial as namespace of files to be tested Now a little more XPath is needed to describe the location of the references in the manifest file It 1s the href attribute of the file element so we enter tut file href the two initial slashes indicate that all file elements in the manifest file should be considered Don t forget to enter imsmanifest xml under Exclusion filter since this file must not be referenced A final page summarizes our settings and clicking Finish completes the capturing of our requirements The only thing that remains to be done is saving the profile 4 Using Profiles for Conformance Testing Your SchemaProf generated application profile or domain profile can be used to create a conformance test system to test data for compliance with your profile Test systems are not part of the SchemaProf software They come with their own user manual 4 1 IMS Approved Conformance Test Systems For profiles based on IMS specifications IMS Global Learning offers a service to provide such specific conformance test systems To use this service you must register your profile at IMS Please see http www imsglobal org sdan for the IMS profile registration procedures In order to obtain a test system for profiles based on other specifications please contact schemaprof uni koblenz de The following figure shows the main screen of a test syste
46. finalize this assertion Editing an Assertion To edit an existing assertion select it from the list of assertions and click Edit or double click the assertion in the list E IMS Schemaprof 2 0 tutorialProfile zip File Manager Plugins Window Heip m Ral m Categories Constraints Attribute Properties Eleme t Assertion i Modification Elements GomplexTypes AttributeGroups ModelGroups Bi imscp_vip2xsd Assertion count Autitem 0 Dependency Type Edit File Type p ltem Type Err sequence CardinalityElement Move Up jel title CardinalityElement lel item CardinalityElement RENE lel metadata CardinalityElement EM sequence grpStrict any CardinaliyElement S grpStrict any sequence Delete identifier ValueTypeElemeni 8 isvisible ValueTypeElement parameters ValueTypeElement 8 anyAttribute AnyAttributeElement HI Manifest Type A In F Deactivate Mode ff Schema Profiling Compatibity restrictive Figure 28 Adding a new Assertion Deleting an Assertion Select the assertion from the list click and confirm the deletion Moving Assertions Up Down If more than one assertion is defined it is possible to rearrange the assertions This may be important for conditional assertions Select an assertion and press the and buttons to rearrange www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool U
47. ft side of the program window below the rows of tabs The root element of the tree 1s labelled with the file name of the base XML schema The type of file currently edited is show by the icon of the root element www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 8 i indicates an additional constraint AC file pi Indicates an application or domain profile The root element expands to folders showing all the elements of the current element type selected by the second row of tabs Because of references in the XML schemas sub elements may appear at more than one location of the navigation tree Especially when selecting the schema root element under Elements you will find all of the elements used in this schema Unfolding the elements of the tree shows the next nesting level subelements This way it s possible to descent into the schema until you reach a tree leaf which is typically a s mpleContent or attr bute other types are possible Elements ComplexTypes attributeGroups ModelGroups Bi imscp_vip2xsd Dependency Type H File Type D Item Type a sequence CardinalityElement identifier ValueTypeElement lidentifierref ValueTypeE isvisible WalueTypeElemeni parameters ValueTypeElement anyAttribute AnyAttributeElement Manifest Type ManifestMetadata Type Metadata Type Organization Type Organizations Type Resource Type Resources
48. g this line will open a file dialog to choose an application profile XML file from the local file system Choose profile Any application profile used before in this profile from list will be offered to the user in the dropdown list for easy re use Table 3 Possible values for profiles http www opengroup org telcert http www imsglobal org af afv 1 p0 imsafglossaryv 1 p0 html 1523383 www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 35 Any well formed XML from any namespace default This namespace makes no restrictions at all therefore no other namespaces or profiles are allowed in JMS SchemaProf when any 1s on the list Local Any well formed XML that is not qualified i e not declared to be in a namespace trother Any well formed XML that is from a namespace other than the target namespace of the type being defined unqualified elements are not allowed Like any including this namespace in the list will prevent adding any other namespace or profile trtargetNamespace Any well formed XML belonging to any namespace in the whitespace separated list targetNamespace is shorthand for the target namespace of the type being defined Choose namespace Any namespace used before in the current profile and from list thus known will be display in the list for re use at another location and can be selected Typing another To
49. he internal realization of the local modification is done by defining a new XSD element type making a copy of the referred element under a different name and replace the reference of the with a type attr bute pointing to the new XSD element type All modifications made are applied to this new XSD element type only This leaves the referred element and all elements referring to it untouched Note A local modification is always based on a copy of the original specifications type that is referred referred element If this type definition of the referred element was modified in your profile before this modification is not considered in any local modification of this type The local modification is always based on a copy of the unchanged type definition as found in the original specification 2 3 6 Extending a specification Mild Extensions and Domain Profiling Extensions Modifications on wildcard elements are possible where the wildcard elements any and anyAttribute signal a foreseen extension point in the XML schema Selecting an any or anyAttribute element in the navigation tree on the left side shows the configuration of this element in the base specification on top of the right side of the window Press the button on the right side to modify this extension point EJ IMS Schemaprof 2 0 tutorialProfile zip File Manager Plugins Window Help Ra W o Bz Categories Constraints Any Element Assertion i AnyElement Elements ComplexTypes At
50. he toolbar Any XSD schema file base schema namespaces or profile XML file referenced in the profile will be searched for locally in the same directory if no other location is specified This gives you the possibility to a work with locally modified copies of the XSD files specified and b work offline with a local copy of that file in the directory The XSD files not found in this directory will be loaded from the URL location This requires a working Internet connection When loading a profile IMS SchemaProf does an integrity check If the profile has been changed outside SchemaProf this shall be reported This does not imply any restrictions to the further editing of the profile unless it has been corrupted 2 1 3 Using the File History To open the most recent files IMS SchemaProf offers a file history in the file menu that will show the file names of the last five file than have been opened This provides quick access to www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 15 those profiles and avoids having to choose the correct directory first Hovering the mouse pointer over a file name will reveal the complete path to the file RAE OOOO O O Manager Plugins Window Help New Strg N Open Sirg O Save Strg S M Save as Close 0 tutorialProfile zip Tiee CUS ers dahr Desktop SchemaProffutorial utorialProfile zip 2 imscc_m zip 3imscceV1p1 091113 2i
51. his is also a valid condition but does not refer to the Boolean value true but to an element with name true in the current element structure e myAttribute myValue This condition will evaluate to true if the value of the attribute myAttribute of the current element is set to my Value Otherwise it will evaluate to false namel iten or mame 7 item This condition evaluates to true if the name function name parent element or the grandparent element of the current element is item Otherwise it evaluates to false Assuming that the current element is also called item this condition can be used to www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 20 detect it some elements are iterated in the profile structure that is the element item contains other elements called item e count someListElement lt 5 This condition evaluates to true 1f the list element someListElement located one level above the current element in the element hierarchy of the profile consists of no more than 5 list element Otherwise it evaluates to false 2 2 3 Namespace Manager The namespace manager gives you an overview of the namespaces used in your profile and the namespace prefixes they are mapped to Here you may add other namespaces and define prefixes for them Additiona
52. hose www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 37 legal extensions are denoted as mild extensions and their usage s described in the previous section Unfortunately there are rare situations where extensions to a schema are necessary and no extension points have been foreseen by the schema designers For these cases it 1s possible to extend the schema at other positions making a so called wild extension We strongly discourage the usage of wild extensions Using wild extensions will destroy any compatibility to the base specification and software that is not fault tolerant might behave unexpectedly or even crash when wild extensions are used If the usage of wild extension can not be avoided select the element that is considered the predecessor element of the extension element in the navigation tree Press the New button on the right side to enter an extension at this point This will pop up a window for text input where you can enter the new element in pure XML code Entries made for wild extensions are not checked at all except for being well formed Since wild extensions are beyond any specification or standard only very experienced users are expected to use this feature and no further support is provided 2 3 Profiling Extensions The use of this feature is NOT recommended The XML file format of the application profile is also specified by an XML schema The
53. ications are given see section Order of Modifications Reordering of Modifications above for more information and section Condition Manager for more details e The usage declaration of attributes allows the values optional prohibited and required See http www w3 org TR xmlschema 1 for further explanations e An initial value for this element can be used If it is given as a default value the user of this profile can overwrite this value entering an own value If the value is given as fixed value no changes are allowed by the user Click button to continue Create a new Modification gg Modification Attributes Optional further details Annotations explain and document this modification Conditions make this modification conditional Usage how to use Value is uded for preset values Modification Annotations Add edit or remove global Annotations Category Language Content Condition p MONES Condition Manager Usage REQUIRED Value Figure 21 The modification attributes dialog for value type modification Step 6 Enter Attribute Extensions if needed and click button Step 7 Finalize this entry by clicking the button www imsglobal orgO 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 29 Replace by an existing type Use this option to replace the predefined type with some other type The value space of this element 1s then set to the value space allo
54. ides modified schemas also Schematron rules and so called additional constraints which capture requirements to the structure of packages of multiple files IMS SchemaProf supports domain profiling 1 e profiles that consist of a number of application profiles together with descriptions how these profiles are to be used in an interrelated way in conformant data packages IMS SchemaProf can be used to create application profiles for upload to the IMS Application Profile Registry See http www imsglobal org sdan for the IMS profile definition registration and maintenance procedures While it is possible to use the derived schemas and Schematron rules with any XML schema or Schematron validator the main intended use is for the production of profile specific test systems Such test systems can go beyond schema and Schematron validation and test also the additional constraints mentioned above IMS SchemaProf originates from the European project TELCERT and has been further developed by the Knowledge Media Institute of the University Koblenz Landau IWM Koblenz with support from the IMS Global Learning Consortium Version 1 of IMS SchemaProf was released in 2007 The current version 2 0 differs from version 1 mostly in allowing the user to set details of test system configurations Section of this document provides a global overview of IMS SchemaProf If you wish to jumpstart profiling you may start reading Section 2 and then follow the hy
55. ification The XPath expression of an assertion must be evaluated by a tool e g the TELCERT test system for a specific document instance If it evaluates to true this consistency check is satisfied what should hopefully happen for all your document instances But if it evaluates to false then this consistency check failed and the www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 38 whole document instance is considered to be invalid For conditional modifications the XPath expression triggers a modification when evaluated to true and nothing happens if it evaluates to false Creating a new Assertion Assertions can be defined for most of the elements shown in the navigation tree Make sure that the Categories tab is selected on the left side and select the element from the navigation tree where you want to attach the assertion to Now a second tab labelled Assertion should be visible on top of the right side Click it to get the assertions view To create a new assertion now click the button on the right side A new dialog will open now with a text field where you can enter the XPath expression to be evaluated Please refer to the section Declaring XPath Conditions for help on how to specify XPath expression Click to continue On the next panel it is possible to make annotations and even to use a condition thus making it a conditional assertion Click Next to continue and Finish to
56. in one single element schema more than one element conforming to another profile than only the first of these elements will be validated against the profile References IMS Application Profile Guidelines http www imsglobal org ap index html IMS SchemaProf http www imsglobal org profile IMS Specification Adoption Note 11 Profile Definition Registration and Maintenance Procedures http www imsglobal org sdan IMS TELCERT Information Page http www imsglobal org telcert html XML Schema Part 1 Structures W3C Recommendation 2 May 2001 http www w3 org TR xmlschema 1 XML Schema Part 2 Datatypes W3C Recommendation 2 May 2001 http www w3 org TR xmlschema 2 XML Path Language XPath Version 1 0 W3C Recommendation 16 November 1999 http www w3 org TR xpath About this Document IMS Schema Profiling Tool User Manual Editor Hans Christian Herrmann Ingo Dahn University Koblenz Landau Summary This document describes how to use the IMS Approved Schema Profiling Tool to profile the XML schema bindings of IMS specifications http www imsglobal org profile www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 54 Appendix A SchemaProf Software License IMS Global Learning Consortium Inc Schema Prof Tool END USER SOFTWARE LICENSE AGREEMENT The accompanying executable code version of IMS Schema
57. ions that are not bound to a condition unconditional are treated as having a true condition Any modification appearing after an unconditional modification will never be applied To change the order of the modifications select a modification from the list and use the and buttons to move it up or down in the list 2 3 3 Cardinality Type Modifications Cardinality Modifications are possible for the cardinality elements that are denoted different icon symbols and the description CardinatilityElement in the navigation tree on the left side The icon symbols also indicate the cardinality of the unmodified element Mandatory single element of this type Mandatory element that must occur at least once but is limited to a maximum number of occurrences u Mandatory element that must occur once and may occur as many times as wanted unbounded Forbidden element that may not be used Optional element that may or may not be used If used only a single occurrence is allowed www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 24 Optional element that may or may not be used If used only a limited number of occurrences are allowed Element that must have a fixed number of occurrences gt l Mandatory element that has a minimum and a maximum number of occurrences set Mandatory element that must have a minimum number of occurrences no maximum number of occurrences set unbo
58. l 7 several setting See section 2 2 Preferences for more details Help About Shows some information about the software 1 e the software version license information and contacts 1 2 Toolbar The toolbar provides quick access to the most frequently used operations ci Start new profile or constraint file Open existing file Save file lis Save file as Preferences El IMs Schemaprof 2 0 tutorialProfilezip File Manager Plugins Window Help Hs BB ae Figure 2 The IMS SchemaProf toolbar and menu 1 3 Selection Tabs The selection tabs give access to the two main areas of work schema modification and schema constraint editing If schema modification 1s selected a second row of tabs 1s displayed grouping the schema components into Elements ComplexTypes AttributeGroups and ModelGroups Each of these tabs shows the schema elements of this type and all of its subelements in the navigation tree To see the schema structure in hierarchical view which is possibly the most natural way to start please select the schema root element under elements If the Constraints tab is selected no second row of tabs is displayed The navigation tree now shows a simple tree that holds all the constraints currently defined See section Additional Constraints for more information on profile constraints 1 4 Navigation Tree IMS SchemaProf shows the structure of the base XML schema currently in use in a navigation tree on the le
59. l the XML schemas referenced by the current profile and by the XML schemas Most of them will probably be available through web locations and accessed via HTTP protocol To support those network configurations that require the use of a HTTP proxy server IMS SchemaProf will use the proxy server and port specified f the checkbox Enable Proxy is checked 1 6 2 Internationalization IMS SchemaProf s currently only available in English Please contact IMSschemaprof imsglobal org if you are interested to provide support for other languages www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 12 1 6 3 Plugins IMS SchemaProf functionality can be extended using plugins The plugin support feature 1s provided for future extensibility 1 7 Command Line Usage IMS SchemaProf can be started from the command line as path to java jar IMSSchemaProf 2 0 jar 1 8 Help and Bug Reporting The user manual is provided online in PDF format Please check the IMS website for the latest version of the documentation http www imsglobal org profile There 1s also a screencast tutorial available on th s site If you find bugs in the program or documentation please commit them to our Bugzilla system with a detailed description and include the release number of SchemaProf If available please provide your SchemaProf log files from the directory of your local SchemaProf installation and any
60. lly t let s you control the target namespace of your profile Profiling a specification does make changes to the original and therefore the original namespace should not be used although the compatibility to the original specification is preserved especially in the restrictive mode of IMS SchemaProf By default the IMS SchemaProf will keep the original namespace as target namespace for the profile RE Namespace Manager Namespace Information Add new Namespaces here or edit delete exisiting Namespaces Edit Target Namespace Target Namespace ofthe base schema are vipi Awww ims global org schemapr offtutorial Further Namespaces Prefix maps to fittpviwww imsglobalorg xsd imscp vipixsd which isnt cached yet Prefix ac maps to http iwm uni koblenz de xsd tel addc_vip2 xsd which isnt cached Prefix 50 maps to http iwm uni koblenz de xsd ims_apvip xsd which isnt cached yet Prefix tut maps to htfp wwnw imsglobal org schemaprofitutonalxsd which isn t cached Prefix xs maps to http 3 072001 MLSchema xs d Prefix xsi maps to httpywwew ew3 org 001 3MLSchema instance xsd New Edit Delete Download Close Figure 14 The Namespace Manager www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 21 Profile Manager The profile manager provides the user a complete list of all the profiles that are used at the extension points and additional constraints of
61. m based on a SchemaProf profile www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 51 Profile Test System Test Confiqurator This test system is configured for the profile SchernaProf Tutorial Profile Test Packages Configuration Logging Help Test Packages Please choose test packages to validate Figure 36 A SchemaProf based Test System The following figure gives an impression of test reports from such test systems Schematron Report jasmani O EE Detailed schematron validation report Assertions m Pattern pattern 1 d tutitem identifierref tutitem identifierref count tutiitem 0 Assertion failed for pattern_1 Requirement 6 says If an item references a resource then there cannot be subitems manifest organizations 1 organization 1 J item 1 J item 2 identifierref m Pattern pattern 2 not type assessment or count tut file gt 1 and count tut file lt 1 Condition name AssesmentResource Error Cardinality validation failed for pattern_2 manifest resources 1 resource 3 file 1 manifest resources 1 resource 3 file 2 Fertig Computer Geschiitzter Modus Inaktiv Ar 100 v Figure 37 A Test System Report www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 52 4 2 Other Test Systems In order to obtain test systems for profiles of specifications
62. more commonly used option The static definition on the other hand is more intuitively used for profiling and less abstract to understand The FileURI is mandatory FileExtension Definition With the FileExtension definition it s possible to define a list of file extensions e g html htm php The file extensions are of course alternatives and each filename in a document instance must end on one of the file extensions Example http mydomain org index html is a valid filename while myScript pl is no allowed FileSize Definition This definition specifies the absolute size of a file This definition typically points to an attribute where a system is expected to continuously update the exact file size as meta data Setting a user defined value in the profile is probably unrealistic but still allowed www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 43 Additionally a divisor must be set defining whether the given size is expected to be byte divisor 1 kilobyte 1024 or megabyte 1024x1024 A user defined divisor is also possible The FileSize definition cannot be used in combination with the FileMinSize and FileMaxSize definitions If FileSize is defined FileMinSize and FileMaxSize are not available and vice versa FileMinSize FileMax Size These definitions allow you to set a minimum or maximum file size The size can be given as for fileSize in byte KB
63. n http www imsglobal org profile Bug Reports and Suggestions info imsglobal org www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 3 www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 4 Introduction IMS SchemaProf is an XML schema profiling tool that is used to localize XML schemas typically the XML binding of a specification or standard This schema is modified to reflect the specific usage of the specification by a community The result of this process is a community application profile A discussion of the principles and technical details of application profiling is beyond the scope of this user manual A discussion of these subjects is provided in the JMS Application Profile Guidelines which are available at http www imsglobal org ap IMS SchemaProf has been designed to support the implementation of these guidelines An application profile contains only the differences made to the base schema and is intended to be used in combination with the base schema During the work with XML schema profiling it was noticed that most specifications define data structures and constraints in text documents XML bindings of the specification in form of XML schemas cannot express all constraints of a specification IMS SchemaProf allows capturing such modifications beyond the expressive power of XML schemas IMS SchemaProf profiles contain bes
64. nager uuuuunnaaneonnnnnnnonnnnnnnnnnunnonnunnnunnnnnnnnnnnnnnn 20 2 2 4 Prole Manager nannten een nennen 21 2 2 5 Test Configuration Manager 22 2 3 MOdilicallonSs 2 ee 22 2 3 1 New Edit Delete Modifications sr 23 2 3 2 Order of Modifications Reordering of Modifications 23 2 3 3 Cardinality Type Modifications sms 23 2 3 4 Value Type Modifications mm smsmnrrremmmnnnnnnnne 25 2 3 5 Global and Local Modifications ss 32 2 3 6 Extending a specification 55 50 m n css cenemencteneessnnessnnegcncense 33 2 3 7 Profiling EXI NSIONS nun ee 37 200 JASSELLONS cs se engere een 37 2 3 9 Additional Constraints 2aa2220020 aan0000nnnnnnnnnnnn anne 39 2 4 ADHOlSAl0O0S isses een een 44 2 4 1 Global Annotations ueuza2002an002ann0nnnnnunnnnunnnnnunnnnnnunn ann 44 2 4 2 Modification Annotations uus uauu00002a2000nannnoonnnnnnnnnnnnnn 45 2 5 Profile Extensi n POINIS anna ae eene 45 OR OR a 46 4 USING PROFILES FOR CONFORMANCE TESTING 50 4 1 IMS Approved Conformance Test Systems 50 4 2 Other Test Sysiems un une a een 52 5 KNOWN ISSUES AND WORKAROUNDS 2z2222220000000n000n0nnn0nnn0n 52 R F RENCES aa benennen wena euere rer nee 53 ABOUT THIS DOCUMENT 2 222 200000000000n0n ann nun nun nnun nun nnun nun nun nn 53 APPENDIX A SCHEMAPROF SOFTWARE LICENSE 54 Date 30 November 2009 Software and Documentatio
65. nality min ccurs maxOccurs Figure 17 The Cardinality Element Editor 2 3 4 Value Type Modifications Value type modifications are possible for the value type elements denoted with the respective description ValueTypeElement in the navigation tree on the left side Simple content elements icon and attribute elements icon are valid value type elements Modifying a value type opens a wizard that offers four different replacements for the current value type and will take you step by step through all possible modifications Value Type Modification Replace Type Restriction List Modification Modification Modification Figure 18 Value Type Modifications Union Modification www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 26 Create a new Modificat on SES Choose below how to modify the element you selected Replace with another already defined type Restric the type using facets replace with a List of a type or replace with a Union of several types Replace Type Restriction Union Back Next gt Finish Cancel Figure 19 The new modification dialog for value types Restriction of the selected type This type of modification does not modify the base type itself but makes it possible to enter several restrictions facets on the value space of current type Further information on the restrictions the syntax
66. namespace manager NOTE Currently Test Systems don t support the use of these extensions 3 Tutorial In this Section we demonstrate the usage of IMS SchemaProf to develop a domain profile based on the IMS Content Packaging specification and using predefined profiles of the IEEE LOM Metadata specification and the QTI Test and Assessment specification All required files are located in the SchemaProfTutorial directory The profile which we are going to define in SchemaProf requires the following modifications of the IMS Content Packaging specification schema 1 Files conforming to the profile must have the namespace http www imsglobal org schemaprof tutorial www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 47 2 Each item must have exactly one title except for the root item element which must have no title 3 Resources must have one of the two types webcontent and assessment 4 The manifest must have metadata which conform to the IEEE LOM metadata specification 5 Assessment Resources must contain a single File object which references the QTI XML file This file must conform to the IMS QTI 1 2 1 specification If an item references a resource then there cannot be subitems The file imsmanifest xml must exist at the root of the package 8 Every file except the file imsmanifest xml must be referenced in a resource and every file referenced in a resource must exi
67. nfluence on the functionality of the program Compatibility level IMS SchemaProf can switch between three different compatibility levels Changing the compatibility levels is done in the preferences window The levels must always be set by the user Please note that IMS will only accept restrictive profiles in the profile registry The compatibility level chosen by the user influences the possibilities offered to the user to modify a base schema So it is one of the most important tasks to set the correct compatibility level for your application www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 11 When loading a profile that is not compatible to the current level JMS SchemaProf will refuse to load this profile IMS SchemaProf does not switch the compatibility level automatically when loading a profile Restrictive compatibility is the default compatibility level The domains of predefined types may only be restricted but not extended The set of possible document instances based on the resulting profile will therefore be a subset of the set of possible instances of the base schema This ensures read compatibility of the application profile with the base schema Programs capable of working with instances of the base schema will be able to work with all instances of the application profile Extensive compatibility allows only extensions of the domains of predefined types but no restriction
68. other files used XML Schema Profiles etc You can attach files to the bug report after committing the initial description Bugzilla is available at http iwm uni koblenz de bugzilla Within Bugzilla select the product Telcert SchemaProf with the component IMS SchemaProf If you need further assistance please contact us directly via email to IMSschemaprof imsglobal org Any feedback and suggestions concerning SchemaProf are welcome under this email address as well The version number and license of the program can be found in the about screen that is shown during program start and is available using the menu entry Help gt About 2 Schema Profiling This chapter gives information on how to create and edit application profiles Detailed information on the user interface is given in the previous chapter 2 1 File Handling 2 1 1 Creating a new Profile To start a new profile use the menu item File New or the corresponding toolbar button This will open a wizard dialog that allows the user in the first step to choose between creating a new profile or a constraint file Choose profile here www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 13 Ess see 20 DE File Manager Plugins Window Help Create a new profile or constraint file Create a new Profile or Constraint File Please select either to create a new profile or a new constraint file For both of them
69. p 4 gtilp2 zip Quit AIt Q Figure 9 Opening a Profile from the File History 2 1 4 Saving a Profile To save an existing application profile use the menu item File Save to save under the already given filename or File gt Save as to save under a different filename or directory Alternatively you can use the corresponding toolbar buttons IMS Schemaprof 2 0 tutonalProfile zip P aE File Manager Plugins Window Help Categories Constraints Figure 10 Save Profile Save Profile as Toolbar Buttons Your application profile is saved as a ZIP file The ZIP format includes all local files and directories of the profile in a single archive file which can be opened directly with JMS SchemaProf for editing or be extracted with any ZIP tool Remote files like XML schemas refered to by a URI are not included in the ZIP file When opening a profile that uses remote files a network connection is expected The ZIP file is easy to handle e g to send via email For inclusion into the profile registry IMS will only accept profiles provided as ZIP files www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 16 RE Save as Speichern in m schemaProfT utorial on di AuxiliaryProfiles en Ee di BaseSchema Zuletzt Ji Testsystem verwendet 4 tutorialProfile zip Desktop H Eigene Dokumente Computer a Dateiname Mental Speichern Netzwerk Dateityp
70. perlinks embedded into the descriptions of the particular modifications you want to make as needed The last profiling step should be crosschecking the test system configuration created by IMS SchemaProf In case you intend to develop a domain profile combining one main profile with one or more auxiliary profiles you should make the auxiliary profiles first in order to re use them in the main profile Section 2 explains the operations that are available for profiling a specification It s also suitable as a reference during your profiling activities Section 3 leads in a tutorial through a profiling exercise to give an impression of the features provided by SchemaProf It is a good starting point for readers which are new to application profiling EU funded research project Contract No 507128 see http www opengroup org telcert www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 5 The following Section 4 describes the possibilities to use SchemaProf profiles for Conformance Testing The final Section describes known issues and gives recommendations how to deal with them 1 IMS SchemaProf User Interface The IMS SchemaProf user interface starts with a splash screen that shows the software logo and current version number while loading the program in background The main program window is divided into these main areas 1 The menu bar gives access to the top level functionality 2 Th
71. rted Deleting a Constraint To delete an additional constrain select the constraint in the navigation tree and then click the Delete Constraint button below the navigation tree If the Categories tab is currently selected it is necessary to click on the tab before to get the correct view of the navigation tree Constraint Definitions Each constraint defined n a profile consists of one or several definitions Each definition specifies a specific property that any document instance must satisfy e g a certain file type or file size A document instance can only be considered a valid document if all constraint definitions are satisfied e g the file type must be HTML and the size must be less then 1 MB Within the definitions alternative value may be possible e g the file type restricted to DOC or PDF Each definition can occur only once within the same constraint e g it makes no sense to have two declarations of a maximum file size Additional constraints can be static or dynamic Parameters of static constraints are defined by the author of the application profile For example a static constraint can require that there is a file named imsmanifest xml at the root of a data package In contrast parameters of dynamic constraints are defined as values of specific attributes in instance documents For example a dynamic constraint can require that the href attribute of a specific element points to a file with a specific mime type Adding a
72. s The set of possible instances of the application profile will be a superset of the set of instances of the base schema This ensures write compatibility of the application profile to the base schema Any instance generated written by programs capable of working with instances of the base schema will be compatible with the application profile Choosing Not compatible allows the user to enter any restrictions or extensions to the predefined types No checking is done at all on the modifications entered A simple example some profile element is assumed to have 2 3 4 or 5 instances in an application It is therefore specified in the application profile with the cardinalities of minOccurs 2 and maxOccurs 5 The modification that are possible according to the different compatibility levels for minOccurs and maxOccurs are given n the following table extensive not compatible 0 unbounded 0 unbounded Table 2 Compatibility Level Settings Please note that despite the compatibility checking the minOccurs value must of course always be les than or equal to the maxOccurs value Even with the setting Not compatible the program will not accept e g the values minOccurs 4 and maxOccurs 3 For more technical details on the concept of application profiling please look at the JMS Application Profiling Guidelines available at the IMS website http www imsglobal org ap index html Proxy Settings IMS SchemaProf requires access to al
73. see the list of existing definitions in the list on the right side Select the constraint definition you want to delete from the list and click the or Edit Definition Jbutton File Constraints File constraints define the location of a file and several expected properties of that file All values can be defined by pointing either to a schema element value type or attribute or by setting a user defined value Each setting made is called a constraint definition Several constraint definitions can be combined but not all combinations are allowed JMS SchemaProf will only offer you those constraints that are allowed at the current stage www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 42 a sn EE New Definition Wizard Select Definition Type Choose the type of constraint definition you want to add Not all types might be available due to dependencies between the definitions Consult the IMSSchemaerProf user manual for details Select File URI FileDirectory FileExtension FileMimetype FileSize FileMinSize FileMaxSize FileValidation Figure 31 The Definitions of a File Constraint FileURI Definition The FileURI definition declares the actual file location As explained above this can be done statically with a user defined URI value or dynamically by choosing a schema element that will later hold the file location The dynamic definition is probably the
74. ser Manual 39 2 3 9 Additional Constraints The modifications introduced so far restrict the structure of XML documents However data are frequently delivered in packages Additional constraints are the method to pose conditions on the structure of these packages Therefore additional constraints have global character With additional constraints it is possible to define extra information that is used in other tools to check constraints that are often found in the information model of specifications but which are not found in machine readable form in the XML binding If for example an attribute fileURI is supposed to point to an existing file that must be an HTML file and of the size defined in the further attribute fileSize this can be expressed by additional constraints The main advantage of defining constraints in a machine readable form is their automated verification of the constraint through appropriate tools like the IMS test systems Currently two types of constraints are supported by IMS SchemaProf File constraints define the location of a file and several properties this file must comply to like file extensions file size or file type Vocabulary constraints make it possible to tie certain element values to a vocabulary internal or external where this value must be contained Adding a new constraint To define new constraints please click on the Constraints tab above the navigation tree in the upper tabs row
75. sively since this provides a way of inline documentation that can be extracted later on In fact annotations shall be included into the derived schemas and Schematron rules generated by IMS SchemaProf In particular annotations of conditional modifications are important since the Test System shall use them as explanations for the user n case the restrictions set by these modifications are violated in a document under test www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 17 2 2 Managers Managers from the Manager menu allow for the provision of reusable resources beyond the base XML schemas that are needed for a profile You may return to the appropriate manager whenever you need to add another resource 2 2 1 Type Manager The type manager 1s the user interface to manage user defined simple types for your currently opened application profile You can enter a new type and edit or delete existing types The type manager is started by the menu entry Manager Type Manager E Type Manager Enter or modify a type PermittedResources atomic New Edit Delete Close Figure 12 The Type Manager New Type To add a new type to your application profile press the button This opens a dialog window offering three basic possibilities to derive a new type make a restriction to an existing type create a union of several existing types or create a list of existing types They
76. st eed To start capturing this profile we launch SchemaProf with a doubleclick on IMSSchemaProf 2 0 jar We open the IMS Content Packaging specification schema from the SchemaProfTutorial BaseSchema folder as base schema for a new profile With a click on the top node of the profile we get the possibility to add global annotations Clicking the New button in the right part of the window opens the dialog for entering a new annotation We chose name as type of the annotation and en for the language and enter a convenient name for our profile say SchemaProf Tutorial Profile Next we define the profile namespace with the Namespace Manager Selecting this from the Manager menu we see under the heading Target Namespace of the profile that SchemaProf by default preserves the namespace of the base schema for the profile According to our Requirement 1 we override this with http www imsglobal org schemaprof tutorial That completes capturing requirement 1 For the convenience of referring to elements in our profile we also define the prefix tut as an abbreviation for this namespace Then we can Close the Namespace manager After these preparatory steps we start adding to our profile modifications of the base schema which reflect the changes described in the requirements above This is done by modifying the type definitions provided by the schema These definitions can be accessed after clicking the Complex Types tab
77. the New Type operation above Please refer to the description above for further explanations Delete Type To delete a previously user defined type select the type from the list of available types Then press the button This will delete the currently selected type To close the Type Manager use the button or the X symbol 2 2 2 Condition Manager The Condition Manager is the user interface to manage the conditions defined by the user The window shows a list of all defined conditions A condition has an ID a name and the condition declaration The ID is set by the system and must be unique It is used to identify the condition internally the user may not change this ID himself The name s given by the user and should be a meaningful name to identify the condition The name is presented to the user whenever he has to select a condition The condition declaration can be any valid XPath expression that is evaluated to the Boolean values See below for further explanations on declaration of conditions www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 19 E Condition Manager Enter or modify a condition Condition AssesmentResource type assessment New Edit Delete Close Figure 13 The Condition Manager Declaring XPath Conditions A condition for JMS SchemaProf is generally any valid XPath expression that is evaluated to the Boolean values of eith
78. triputeGroups ModelGroups Process Content strict Bi imscp_vip2xsd Namespace Profile List Dependency Type other File Type Ef Item Type Erp sequence CardinalityElement nie lel tite CardinalityElement le item CardinalityElement fel metadata CardinalityElement Edit Er sequence grpStrict any CardinalityElement grpStrict any sequence Move Up identifier ValueTypeElement identifierref ValueTypeElement isvisible ValueTypeElement parameters ValueTypeElement anyAttribute AnyAttributeElement jb Manifest Type Delete Move Down IM Figure 26 Extension Point Modification The modification dialog allows redefining the following setting for this extension point Process Content This value specifies how the XML processor should handle validation against the elements specified by this any element See Table 4 for the possible values and their meaning www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 34 The document processor must validate the given document element against the allowed namespaces and profiles If the schemas and profiles are not available and no validation is possible the validation will fail The document processor will try to validate the element against the namespace or profile If the schema or profile is not available no validation
79. unded Table 3 Cardinality Symbols Clicking the new button will open a dialog box that allows modifying the minOccurs and the maxOccurs values Compatibility is preserved according to the current compatibility level The drop down boxes for the minimum and maximum number of occurrences show only the values allowed in the current compatibility level See section Compatibility levels for further details on the available compatibility levels and associated restrictions Optionally an annotation and a condition may be entered Annotations consist of a category a language and the annotation text Use the button to enter your annotation The condition is chosen with the drop down list that shows all conditions specified for the profile by the user If a condition is chosen the modification will only be applied if the given condition evaluates to true Use the condition manager to view edit or create conditions To change a conditional modification back to an unconditional modification select the top element none from the drop down list of conditions www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 25 J Cardinality element editor Bu Cardinality element editor Modify the cardinality element Modification Annotations Add edit or remove global Annotations Category Language Content explanation en Per Requireme Condition none i Condition Manager Cardi
80. value of the schema element in a document instance must then be contained in the given vocabulary Only these two constraint definitions are available VocabularyElement This definition specifies the actual schema element that will later hold the actual value Here a user defined value makes no sense and is not allowed The schema element can be an attribute or a value type element VocabularySource The definition specifies the actual vocabulary The vocabulary must be of the format IMS VDEX or XVD The locat on where the vocabulary can be found is defined through a schema element or a user defined value Additionally the vocabulary type must be set Editing of additional constraints is handled in greater detail in Section 3 www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 44 2 4 Annotations IMS SchemaProf allows the user to make annotations at different levels and positions of the profile The extensive usage of the annotation feature is recommended to improve the understanding and correct usage of the profile by users that are not involved n to profiling process The annotations can always be made in one or more languages supporting multilingual applications The following subsections describe the available positions for your annotations 2 4 1 Global Annotations Global annotations are available to enter annotations that concern the application profile as a whole To make
81. want to modify only the use of this group within ManifestMetadata we have to activate the greyed out any element below ManifestMetadata Type first as described above After this activation we can define a new modification of this local copy of this any wildcard element As a first step we must remove the original definition of allowing all other namespaces since we want to be more specific Since we require the use of a particular specification and not only of a particular namespace we select Profile from the drop down box Then using the dropdown list on the right we browse for our pre build IEEE LOM profile which we request to be used in this place It is in the file SchemaProfTutorialNAuxiliaryProfiles ieeeLom zip To make sure that the metadata extension is in fact evaluated we set process content to strict Requirement 5 is complex and we deal with its more basic part first Assessment Resources must contain a single File object The key point to note is that this requirement applies to assessment resources only 1 e to resources whose type attribute has the value assessment Unlike the case of the root item element resource is not referenced in a context which determines whether Requirement 5 applies Therefore we cannot use activation to restrict our intended modification to assessment resources only But we can use conditions instead The rest is easy We open resource Type and select the file element in the sequen
82. wed for the new type Step 1 Select the element you want to modify in the navigation tree on the left side Then press the button on the right side Step 2 Enter a meaningful name for this modification and press the button Step 3 Select Replace Type and press the Next button Step 4 Select the new base type you want to use instead of the current base type from the drop down list and press to continue Step 5 Enter or modify if required the settings for annotations conditions usage and default value See Step 5 of the previous section for details Press button when done Step 6 Enter Attribute Extensions if needed and click button This is only visible if extension points are enabled in the preferences Step 7 Finalize this entry by clicking the button Create a new Modification a a Type Selection Please choose the item type that will replace the current type Replace ltem Type Select the Item Type ee PermittedResources xs allNNI ks an ySimpleType xs anyURI xs baseb4Binary xs blockSet xs boolean KS dateTime Finish Cancel Figure 22 The Replace Type Modification Dialog www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 30 Replace by a union of existing types Use this option to replace the current type with a union of several base types The value space of this element will then be changed to the union of all value spa
83. y profiles can be set up in the same way 5 Known Issues and Workarounds IS Recommendation Vocabulary constraints can be Model vocabularies only as enumeration types defined but cannot be handled by the test system SchemaProf makes only basic Be careful plausibility checks on XPath expressions entered by the user Wrong XPath expressions and missing namespace prefixes are major sources of errors in profiles All elements in XPath expressions Respect this as good practice use the SchemaProf must have a non empty namespace namespace manager to define prefixes prefix Auxiliary Profiles cannot refer to If an auxiliary profile uses another secondary other auxiliary profiles Only the auxiliary profile the derived schema of the auxiliary main profile can refer to auxiliary profile should be taken as the base schema of a new profiles profile thus integrating the auxiliary profile and the secondary profile Conditional modifications and assertions concerning elements defined in the secondary profile should be defined in this new auxiliary profile Different application profiles inthe Respect this restriction as good practice same domain profile must utilize www imsglobal org 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 53 different top level namespaces If an nstance document contains at Collect elements to be used at an extension point an extension point of the base with
84. you must select the base XML schema file to use Create a new i Profile Compatibilty restrictive E gi Constraint File Choose the base XML schema file Figure 7 New file wizard Then select the compatibility level you need If unsure restrictive is recommended For details on the compatibility level please refer to the section Compatibility level Now choose the base XML schema file you want to profile This is typically the XSD file of a specification you are using You may choose a local file by choosing browse from the drop down list or enter an URI directly The drop down list also shows the last used schema files Then click to start profiling After closing the new file wizard with the finish button IMS SchemaProf will parse the selected base XSD file This can take a few seconds and includes the reading of any files included or imported by the base schema Warnings that appear during loading the base schema indicate problems with the schema which don t affect the profiling process If however SchemaProf signals Errors it is recommended to validate the schemas with another tool and to correct any errors www imsglobal orgO 2009 IMS Global Learning Consortium Inc IMS Schema Profiling Tool User Manual 14 Alternatively you may load an already existing profile When the analysis of the schema file is done the schema structure is displayed in the navigation tree on the left side of the JMS Schema

SchemaProf 4.5

Contents

Download Pdf Manuals

Related Search

Related Contents