Changes between Version 11 and Version 12 of RdsSpreadsheetBatchUpload

Show
Ignore:
Timestamp:
09/04/08 08:30:28 (16 years ago)
Author:
margs (IP: 193.212.132.34)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • RdsSpreadsheetBatchUpload

    v11 v12  
    1  
    2 = Working with Reference Data = 
    3  
    4 Creating and maintaining reference data is a primary goal of the SIG activities. 
    5  
    6 == Batch upload == 
    7  
    8 The following text provides a practical guide to working with the RDS Editor to submit ''batches'' of reference data, as prepared in spreadsheets. Data can be uploaded to the Reference Data Library using the [http://rds.posccaesar.com/apps/rdsclient108.html Reference Data Work-In-Progress Editor] (draft version). 
    9  * [http://www.posccaesar.com/intra/portals/0/pca_sig_mmt_model/PCA_SIG_MMT_model_files/Columns_in_RDS_Import.htm How to maintain and extend the ISO 15926-4 Reference Data Library] (also available in [source:"common/work/Columns in RDS Import.doc" MS Word format]) 
    10  * [RdsMaintenanceProcedure Proposed procedure for Maintenance of ISO 15925-4 Reference Data in database format] 
    11  * [source:"SIG/common/work/Columns in RDS import export.xls" A spreadsheet template, suitable for preparing batches of reference data] (MS Excel format) 
     1     
     2 
     3 
     4= Spreadsheet Batch Upload = 
     5 
     6Status of this document: Working draft 
     7 
     8Authors: 
     9 * [mailto:[email protected] Tore Christiansen] 
     10 
     11[[PageOutline(2-4,Contents,inline)]] 
     12 
     13== Abstract == 
     14 
     15This note describes how to use the import facility of the [wiki:ISO15926 ISO 15926] based [http://193.212.132.108/apps/rdsclient.html Reference Data Editor] (RDE) from [http://www.posccaesar.com/ POSC Caesar] to insert, update and delete various types of Reference Data (RD) objects (classes and relationships) according to the  [wiki:ISO15926 ISO 15926-2 Data Model], as a part of, or an extension to, [wiki:ISO15926 ISO 15926-4 Reference Data Library] (RDL). 
     16 
     17See also:  
     18 * [wiki:RdsMaintenanceProcedure Proposed procedure for Maintenance of ISO 15925-4 Reference Data in database format]  
     19 * [downloads:"RDS/Columns in RDS import export.xls" A spreadsheet template, suitable for preparing batches of reference data] (MS Excel format) 
     20 
     21 
     22 
     23The RDE is intended as an introductory overview for users who possess domain knowledge in their field of application, and also have a basic understanding of the concept, content and structure of reference data libraries. 
     24 
     25Section 2 outlines the overall structure of the different import sheets, and how they should be filled with parameters to create and describe various types of reference data objects. 
     26 
     27Sections 3, 4 and 5 outline the process to insert new, update existing and delete existing reference data objects, respectively. 
     28 
     29Section 6 describes parameters that are common to all import sheets, while Section 7 gives examples of typical parameters for different types of reference data objects. Finally, section 8 contains a list of explanations for all parameters. 
     30 
     31== 2. Overview of import functionality == 
     32In the current version of the RDE, new RD objects, as well as modifications to existing RD, can be entered by either interactive editing or in batch. This note describes batch input by means of tabular worksheets. 
     33 
     34The batch input facility, currently consists of seven worksheets for different types of RD. The worksheets are placed on tabs in the lower right hand part of the RDE user interface, and consist of – 
     35 
     36 * The ''Object sheet'' is used to define and/or modify all (instances of) ISO 15926-2 Thing. That is, data about any type of class, relationship, individual (or instances of any other legal entity type can be specified here. 
     37 
     38 * The ''Relationship sheet'' is used to add necessary information for (instances of) ISO 15926-2 Relationship (as well as Class of Relationship and Class of Class of Relationship). Note that these Relationships can already be defined in the Object sheet, or be defined directly in the Relationship sheet. 
     39 
     40 * The ''Representation sheet'' is used to add the value of (instances of) ISO 15926-2) Express String, Express Real, Express Integer, Gregorian Date and UTC Time, etc. Note that these Representations can already be defined in the Object sheet, or be defined directly in the Representation sheet. 
     41 
     42 * The ''Role sheet'' is used to add information about (instances of) ISO 15926-2 Role and Domain, used in Multidimensional objects. Note that these Roles must already be defined in the Object sheet. 
     43 
     44 * The ''Parameters sheet'' is used to add information about (the classes that are used as) Parameters in (instances of) ISO 15926-2 Class of Multidimensional object. Note that these Parameters (classes) must already be defined in the Object sheet. 
     45 
     46 * The ''Dimension sheet'' is used to add necessary information about (the class instances that are used as) Parameters in (instances of) ISO 15926-2 Multidimensional object.. Note that these Dimensions must already be defined in the Object sheet. 
     47 
     48 * The ''Cardinality sheet'' is used to add necessary information about (the instances of) ISO 15926-2 Cardinality. Note that these Cardinalities must already be defined in the Object sheet.[[BR]] 
     49 
     50The sheets are organized with one row for each Reference Data object, and with each column holding a given RD parameter. The result is (of course) that each cell holds one parameter value for one RD object. 
     51 
     52== 3. Inserting new Reference Data == 
     53To create new Reference Data, describe it by filling out parameter values for all (mandatory and relevant non-mandatory) fields in the worksheets of the Excel template. 
     54 
     55See Section 7 for illustrative examples and Section 8 for a full explanation of all Parameters. Note that the Action command (first column) in all rows should contain the value INSERT. 
     56 
     57The Excel worksheet values should be “cut and pasted” into the corresponding worksheets in the lower right hand part of the RDE interface. The import data should then be validated (by pressing the “validate” button in the RDE User Interface) which will go through each row and report any errors in the last two columns. After all reported errors are corrected the data can be imported into RDE (by pressing the “update” button). 
     58 
     59== 4. Updating existing Reference Data == 
     60To modify existing Reference Data the changes should be described by filling out relevant parameter values for all relevant fields in all affected worksheets of the Excel template. 
     61 
     62See section 7 for illustrative examples and Section 8 for a full explanation of all Parameters. Note that the Action command (first column) in all rows should contain the value UPDATE. Note also that all parameter values that are not modified must be filled in with their current value (since blank values lead to the corresponding parameters being set to “null”). For Reference Data that shall be updated, it is therefore advisable to first export it from the RDE and paste it into a copy of the Excel template, in order to create a starting point for the import template. 
     63 
     64The Excel worksheet values should then be “cut and pasted” into the corresponding worksheets in the lower right hand part of the RDE interface. The import data should then be validated (by pressing the “validate” button in the RDE User Interface) which will go through each row and report any errors in the last two columns. After all reported errors are corrected the data can be imported into RDE (by pressing the “update” button). 
     65 
     66== 5. Deleting existing Reference Data == 
     67To delete existing Reference Data the relevant objects should be uniquely referenced by filling out either the PCA ID or the RDL Designation. 
     68 
     69See Section 7 for illustrative examples and Section 8 for a full explanation of all Parameters. Note that the Action command (first column) in all rows should contain the value DELETE. Note that only ID or Designation need to be filled in. 
     70 
     71The Excel worksheet values should then be “cut and pasted” into the corresponding worksheets in the lower right hand part of the RDE interface. The data should then be validated (by pressing the “validate” button in the RDE User Interface) which will go through each row and report any errors in the last two columns. After all reported errors are corrected the data can be deleted from RDE (by pressing the “update” button). Note that in order to delete RD classes, all relationships connected to those classes must be deleted first. It is therefore often easier to delete classes interactively using the RDE UI. 
     72 
     73== 6. Common fields for all types of Reference Data == 
     74In the description of all Reference Data (i.e., in all worksheets) there are some parameters that are used for the same purpose - 
     75 * Action: The action to be performed by the RDE (if Action is not set, no evaluation of the data will be performed). Use INSERT for new classes, UPDATE for changing data of existing classes, DELETE for removing classes. 
     76 * PCA ID: Unique identification for all RD objects in a given Reference Data Library (i.e., on a given Reference Data Server). Leave blank when importing new classes. 
     77 * RDL Designation: Unique name for all RD objects in a given Reference Data Library (i.e., on a given Reference Data Server). 
     78 * Entity type: The ISO 15926-2 entity type from which the current RD object is instantiated. 
     79 * Error code: A numerical code returned from the RDE in case of errors. 
     80 * Error description: A textual description returned from the RDE corresponding to the Error code. 
     81 
     82== 7. Example parameters for defining Reference Data == 
     83This section gives examples of typical parameters for different reference data types. The examples (first) give the row of parameters as they appear in the import sheet, and (then) each parameter name (column header) and value (cell).  A full explanation of all parameters is given in chapter 8. 
     84 
     85=== 7.1 Defining classes and relationships === 
     86In order to change the description of the RDL class named Pump the imported values in the Object sheet might be like the example below. The text string (value) of the RDL Definition parameter is changed; the other parameter values are included unchanged. 
     87 * Action: UPDATE 
     88 * PCA ID: 327239 
     89 * RDL Designation: PUMP 
     90 * Entity type: CLASS_OF_INANIMATE_PHYSICAL_OBJECT 
     91 * Registration status: Recorded 
     92 * RDL Description: A physical object that is a driven piece of equipment in which energy is either constantly or periodically added to an amount of pumped liquid in order to increase the pressure required for the process in which the pump is in operation. 
     93 
     94In order to define a new RDL class named Activated Sludge Pump the imported values in the Object sheet might be like the example below. 
     95 * Action: INSERT 
     96 * RDL Designation: ACTIVATED SLUDGE PUMP 
     97 * Entity type: CLASS_OF_INANIMATE_PHYSICAL_OBJECT 
     98 * Registration status: Incomplete 
     99 * RDL Definition: A pump that pumps activated sludge. 
     100 * Note(s):  'Biological sludge pump' is a synonym. 
     101 
     102In order to define that Activated Sludge Pump is a subclass of pump we use the Specialization relationship. 
     103 * Action: INSERT 
     104 * RDL Designation: (leave blank for unnamed relationship) 
     105 * Entity type: SPECIALIZATION 
     106 * 1. Role: SUBCLASS 
     107 * 1. Entity type: CLASS_OF_INANIMATE_PHYSICAL_OBJECT 
     108 * 1. PCA ID: (leave blank since class is uniquely defined by RDL designation) 
     109 * 1. RDL Designation: ACTIVATED SLUDGE PUMP 
     110 * 2. Role: SUPERCLASS 
     111 * 2. Entity type: CLASS_OF_INANIMATE_PHYSICAL_OBJECT 327239 
     112 * 2. PCA ID: (leave blank, alternatively give PCA ID, and leave RDL Designation blank) 
     113 * 2. RDL Designation: PUMP 
     114 
     115In order to make Pump a member of the Epistle Rotating Equipment Core RDL Classes we use the Classification relationship 
     116 * Action: INSERT 
     117 * Entity type: CLASSIFICATION 
     118 * 1. Role: CLASSIFIED 
     119 * 1. Entity type: CLASS_OF_INANIMATE_PHYSICAL_OBJECT 
     120 * 1. RDL Designation: PUMP 
     121 * 2. Role CLASSIFIER 
     122 * 2. Entity type: CLASS_OF_CLASS_OF_INDIVIDUAL 
     123 * 2. RDL Designation: EPISTLE ROTATING EQUIPMENT CORE RDL CLASS 
     124 
     125In order to give Pump the property Design Pressure             we use the Class_of_indirecct_property relationship 
     126 * Action: INSERT 
     127 * Entity type: CLASS_OF_ASSEMBLY_OF_INDIVIDUAL 
     128 * 1. Role: CLASS_OF_PART 
     129 * 1. Entity type: CLASS_OF_INANIMATE_PHYSICAL_OBJECT 
     130 * 1. RDL Designation: PUMP 
     131 * 1. Cardinality name: Zero to Many 
     132 * 2. Role: CLASS_OF_WHOLE 
     133 * 2. Entity type: CLASS_OF_INANIMATE_PHYSICAL_OBJECT 
     134 * 2. RDL Designation: COOLING SYSTEM 
     135 * 2. Cardinality name: [ One to Many] 
     136 
     137===  7.2 Defining Express strings and numbers ===  
     138 * Action: INSERT 
     139 * RDL Designation: (normally not given for parameters) 
     140 * Entity type: EXPRESS_STRING 
     141 * Value: ID number of driven unit as text 
     142 
     143===  7.3 Defining Multidimensional objects === 
     144 
     145'''Class of Multidimensional object –''' 
     146 
     147In order to define a new instance of ISO 15926-2 Class_of_multidimensional_object named ST3401 PROPERTY the imported values in the Object sheet might be like the example below. Note that this is an example of an implementation of so-called ISO 15926-7 templates. 
     148 * Action: INSERT 
     149 * PCA ID: RDS403754361 
     150 * RDL Designation: ST 3401 PROPERTY 
     151 * Entity type: CLASS_OF_MULTIDIMENSIONAL_OBJECT 
     152 * Registration status: Incomplete 
     153 * RDL Description: A Shorthand Template for representing possession of property by a Thing 
     154 * Administrative note(s): This Class_of_multidimensional_object is a generic template used in ISO 15926-7 
     155 * Explanatory comment: A Class of Multidimensional Object that specifies the roles used in ST 3401 
     156 * Unresolved issue: Use of this template within ISO 15926-7 is not yet standardized 
     157 * RDS Adapted definition: This is the template specification for describing assignment relationships 
     158 * Abbreviation: ST 3401 
     159 * Submitting organization: DNV IQM 
     160 * Submitter: TCHR 
     161 * Registrar: tchr 
     162 * Registration authority: RDS 
     163 
     164In order to define a new instance of ISO 15926-2 Class_of_multidimensional_object named ST 3401 RICH GAS ALLOCATED VOLUME the imported values in the Object sheet might be like the example below. Note that this is a subclass of ST 3401 PROPERTY above. 
     165 * Action: INSERT 
     166 * PCA ID: RDS409581711 
     167 * RDL Designation: ST 3401 RICH GAS ALLOCATED VOLUME SM3 
     168 * Entity type: CLASS_OF_MULTIDIMENSIONAL_OBJECT 
     169 * Registration status: Incomplete 
     170 * RDL Description: A Shorthand Template for representing possession of property by a Thing 
     171 * Administrative note(s): This Class_of_multidimensional_object is a generic template used in ISO 15926-7 for |Representation of NPD report templates in the RDS 
     172 * Explanatory comment: A Class of Multidimensional Object that specifies the roles used in ST 3401 
     173 * Unresolved issue: Use of this template within ISO 15926-7 is not yet standardized 
     174 * RDS Adapted definition: This is the template specification for describing assignment relationships 
     175 * Submitting organization: DNV IQM 
     176 * Submitter: TCHR 
     177 * Registrar: tchr 
     178 * Registration authority: RDS 
     179 
     180'''Multidimensional object -''' 
     181 
     182In order to define a new instance of ISO 15926-2 Multidimensional_object named SD 3401 EKOFISK A INJECTION RICH GAS MONTHLY ALLOCATED VOLUME SM3 FEBRUARY 2007 the imported values in the Object sheet might be like the example below. Note that this is an instance of ST 3401 RICH GAS ALLOCATED VOLUME above. 
     183 * Action: INSERT 
     184 * PCA ID: RDS409942781 
     185 * RDL Designation: SD 3401 EKOFISK A INJECTION RICH GAS MONTHLY ALLOCATED VOLUME SM3 FEBRUARY 2007 
     186 * Entity type: 2007 MULTIDIMENSIONAL_OBJECT 
     187 * Registration status: Incomplete 
     188 * Administrative note(s): Representation of NPD report templates in the RDS 
     189 * Registrar: tchr 
     190 * Registration authority: RDS 
     191 
     192'''Roles –''' 
     193 
     194In order to define Roles for ISO 15926-2 Class_of_multidimensional_object named ST 3401 RICH GAS ALLOCATED VOLUM the imported values in the Role sheet might be like the example below. Note that these Roles (classes) must already be defined in the Object sheet. 
     195 * PCA ID: RDS40375437260 
     196 * RDL Designation (KEY): POSSESSOR 
     197 * Entity type: ROLE 
     198 * MC PCA ID: RDS409581711 
     199 * MC RDL Designation: ST 3401 RICH GAS ALLOCATED VOLUME SM3 
     200 * Role position: 1 
     201 * Mandatory: TRUE 
     202 * Cardinality: ECH10050 
     203 * PCA ID: RDS40375437280 
     204 * RDL Designation (KEY): PROPERTY TYPE 
     205 * Entity type: ROLE 
     206 * MC PCA ID: RDS409581711 
     207 * MC RDL Designation: ST 3401 RICH GAS ALLOCATED VOLUME SM3 
     208 * Role position: 2 
     209 * Mandatory: FALSE 
     210 * Cardinality: ECH10050 
     211 
     212'''Parameters –''' 
     213 
     214In order to define Parameters for ISO 15926-2 Class_of_multidimensional_object named ST 3401 RICH GAS ALLOCATED VOLUM the imported values in the Parameter sheet might be like the example below. Note that these Parameters (classes) must already be defined in the Object sheet. 
     215 * PCA ID: 16229440 
     216 * RDL Designation: (may be left blank, since the RDL class already exists, and is uniquely identified by PCA ID) 
     217 * Entity type: CLASS_OF_COMPOUND 
     218 * Role Position: 1 
     219 * Role PCA ID: RDS40375437260 
     220 * Role RDL Designation: (may be left blank, since the RDL class already exists, and is uniquely identified by PCA ID) 
     221 * MC PCA ID: RDS409581711 
     222 * MC RDL Designation: ST 3401 RICH GAS ALLOCATED VOLUME SM3 
     223 * PCA ID: RDS409510451 
     224 * RDL Designation: (may be left blank, since the RDL class already exists, and is uniquely identified by PCA ID) 
     225 * Entity type: SINGLE_PROPERTY_DIMENSION 
     226 * Role Position: 2 
     227 * Role PCA ID: RDS40375437280 
     228 * Role RDL Designation: (may be left blank, since the RDL class already exists, and is uniquely identified by PCA ID) 
     229 * MC PCA ID: RDS409581711 
     230 * MC RDL Designation: ST 3401 RICH GAS ALLOCATED VOLUME SM3 
     231 
     232'''Dimensions –''' 
     233 
     234In order to define Parameters for ISO 15926-2 Multidimensional_object named 
     235 
     236SD 3401 EKOFISK A INJECTION RICH GAS MONTHLY ALLOCATED VOLUME SM3 FEBRUARY 2007 the imported values in the Parameter sheet might be like the example below. These Dimensions correspond to the above Parameters for ST 3401 RICH GAS ALLOCATED VOLUM E SM3. Note that these Dimensions (classes) must already be defined in the Object sheet. 
     237 * PCA ID: 16229440 
     238 * RDL Designation: RICH GAS 
     239 * Entity type: CLASS_OF_COMPOUND 
     240 * Role Position: 1 
     241 * Position: 1 
     242 * MO PCA ID: RDS409942781 
     243 * MO RDL Designation: SD 3401 EKOFISK A INJECTION RICH GAS MONTHLY ALLOCATED VOLUME SM3 FEBRUARY 2007 
     244 * Role PCA ID: RDS40375437260 
     245 * Role RDL Designation: POSSESSOR 
     246 * PCA ID: RDS409510451 
     247 * RDL Designation: ALLOCATED AMOUNT 
     248 * Entity type: SINGLE_PROPERTY_DIMENSION 
     249 * Role Position: 2 
     250 * Position: 2 
     251 * MO PCA ID: RDS409942781 
     252 * MO RDL Designation: SD 3401 EKOFISK A INJECTION RICH GAS MONTHLY ALLOCATED VOLUME SM3 FEBRUARY 2007 
     253 * Role PCA ID: RDS40375437280 
     254 * Role RDL Designation: PROPERTY TYPE 
     255 
     256==  8. Explanation of all parameters == 
     257This section contains explanations for all parameters in the various sheets. 
     258 
     259===  8.1 The Object sheet === 
     260This subsection contains a commented list of all parameters in the Object sheet, listed in the same order as the columns in the worksheet. 
     261    
     262 Action :: 
     263   Action to be performed by the RDS (use INSERT for new classes, UPDATE for changing data of existing classes, DELETE for removing classes).  
     264 
     265 PCA ID :: 
     266     Unique ID of the class (leave blank for new classes). 
     267 
     268 RDL Designation :: 
     269     The name of the object (class, relationship or individual). 
     270 
     271 RDL Designation (KEY) :: 
     272    Optional means of identifying existing class If changing RDL Designation of the object, without defining PCA ID, this field should hold the old RDL Designation. 
     273 
     274 Entity type :: 
     275     The entity type (in ISO 15926-2) that this class is an instance of). 
     276 
     277 Creator :: 
     278  The (editor) user who created the Reference Data object. Leave blank when importing new data, leave unchanged when updating or deleting data. 
     279 
     280 Creation date :: 
     281  The date and time that the Reference data object was first imported (or manually created in the RDE). Leave blank when importing new data, leave unchanged when updating or deleting data. 
     282 
     283 Deleted :: 
     284  The time that the Reference Data object was deleted (this is only set when Reference data is imported with the Action set to DELETE). 
     285 
     286 Registration status :: 
     287     Choose from set of statuses according to ISO 11179 (use INCOMPLETE for new classes). 
     288 
     289 Alternative designation :: 
     290     Alternative class name (can be ignored). 
     291 
     292 RDL Definition :: 
     293     Definition of the class (not mandatory - but probably the most important field for creating meaningful reference data ;-) 
     294 
     295 Administrative note(s) :: 
     296     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     297 
     298 Change description :: 
     299     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     300 
     301 Explanatory comment(s) :: 
     302     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     303 
     304 Unresolved issue :: 
     305     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     306 
     307 RDL adapted definition :: 
     308     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     309 
     310 Abbreviation :: 
     311     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     312 
     313 Note(s) :: 
     314     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     315 
     316 Examples :: 
     317     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     318 
     319 Submitting organization :: 
     320     Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     321 
     322 Submitter :: 
     323   Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     324 
     325 Registrar :: 
     326   Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     327 
     328 Registration Authority :: 
     329    Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     330 
     331 Stewardship :: 
     332    Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     333 
     334 Stewardship contact :: 
     335    Meta-data field specified by ISO 11179 (can be ignored if no relevant data to record). 
     336 
     337 Error code :: 
     338     Added by the RDS if errors in there are errors in import data (leave blank). 
     339 
     340 Error Description :: 
     341     Added by the RDS if errors in there are errors in import data (leave blank). 
     342 
     343===  8.2 The Relationship sheet ===   
     344 
     345This subsection contains a commented list of all parameters in the Relationship sheet, listed in the same order as the columns in the worksheet. 
     346 
     347 Action :: 
     348     Action to be performed by the RDS (use INSERT for new relationships, UPDATE for changing data of existing relationships, DELETE for removing relationships). 
     349 
     350 PCA ID :: 
     351     Unique ID of the relationship (leave blank for new relationships). 
     352 
     353 RDL Designation :: 
     354     The name of the Relationship. 
     355 
     356 Entity type :: 
     357   The entity type (in ISO 15926-2) of the relationship. 
     358 
     359 1.Role :: 
     360     The role of "class 1" 
     361 
     362 1.Entity type :: 
     363     The entity type (in ISO 15926-2) of "class 1" (NOTE that the choice of class 1 and class 2 is arbitrary, but specified by 1.Role and 2.Role below). 
     364 
     365 1.PCA ID :: 
     366     Unique ID of "class 1" 
     367 
     368 1.RDL Designation :: 
     369     The name of the "class 1" 
     370 
     371 1.Cardinality ID :: 
     372   The PCA ID of the Cardinality of 1.Role 
     373 
     374 1.Cardinality Name :: 
     375   The RDL Designation of the cardinality of 1.Role 
     376 
     377 2.Role :: 
     378   The role of "class 2" (NOTE that the choice of class 1 and class 2 is arbitrary, but specified by 1.Role and 2.Role below). 
     379 
     380 2.Entity type :: 
     381     The entity type (in ISO 15926-2) of "class 2" 
     382 
     383 2.PCA ID :: 
     384     Unique ID of "class 2" 
     385 
     386 2.RDL Designation :: 
     387     The name of the "class 2" 
     388 
     389 2.Cardinality ID :: 
     390   The RDL Designation of the cardinality of 2.Role 
     391 
     392 2.Cardinality Name :: 
     393   The PCA ID of the Cardinality of 2.Role 
     394 
     395 Error code :: 
     396     Added by the RDS if errors in there are errors in import data (leave blank). 
     397 
     398 Error Description :: 
     399     Added by the RDS if errors in there are errors in import data (leave blank). 
     400 
     401===  8.3 The Representation sheet ===   
     402 
     403This subsection contains a commented list of all parameters in the Representation sheet, listed in the same order as the columns in the worksheet. 
     404 
     405 Action :: 
     406   Action to be performed by the RDS (use INSERT for new relationships, UPDATE for changing data of existing relationships, DELETE for removing relationships). 
     407 
     408 PCA ID :: 
     409    Unique ID of the Representation (leave blank for new Representations).  
     410 
     411 RDL Designation :: 
     412  The name of the Representation. 
     413 
     414 Entity type :: 
     415   The entity type (in ISO 15926-2) that this representation object is an instance of).  
     416 
     417 Value :: 
     418   The value of the Representation. 
     419 
     420 Error code :: 
     421     Added by the RDS if errors in there are errors in import data (leave blank). 
     422 
     423 Error Description :: 
     424     Added by the RDS if errors in there are errors in import data (leave blank). 
     425 
     426===  8.4 The Role sheet === 
     427This subsection contains a commented list of all parameters in the Role sheet, listed in the same order as the columns in the worksheet. 
     428 
     429 Action :: 
     430  Action to be performed by the RDS (use INSERT for new relationships, UPDATE for changing data of existing relationships, DELETE for removing Roles). 
     431 
     432  PCA ID :: 
     433    Unique ID of the Role (leave blank for new Roles).  
     434 
     435 RDL Designation (KEY) :: 
     436   The name of the Role. This should be the same as the RDL Designation given to the Role object when defining it through the Object sheet (and can most easily be found by searching in the RDE). 
     437 
     438 Entity type :: 
     439    The entity type (in ISO 15926-2) that this Role is an instance of). 
     440 
     441 MC PCA ID :: 
     442   The PCA of the Class of Multidimensional Object that includes the Role (this is a reference to the PCA ID of the Class of Multidimensional Object defined in the Object sheet). 
     443 
     444 MC RDL Designation ::  
     445   The RDL Designation of the Class of Multidimensional Object that includes the Role (this is a reference to the RDL Designation of the Class of Multidimensional Object defined in the Object sheet). Note that either MC PCA ID or MC RDL Designation must be specified. 
     446 
     447 Role Position :: 
     448   The  position (order) of the Role within the Class of Multidimensional Object  The same Role could be used in more than one Position (and this should be specified in different rows). This field is not required for the DELETE action. 
     449 
     450 Mandatory :: 
     451   Boolean value that specifies whether or not the Role is mandatory in the Class of Multidimensional Object that includes this Role. 
     452 
     453 Cardinality ID :: 
     454   PCA ID of the Cardinality of the Role in the Class of Multidimensional Object that includes the Role. 
     455 
     456 Error code :: 
     457     Added by the RDS if errors in there are errors in import data (leave blank). 
     458 
     459 Error Description :: 
     460     Added by the RDS if errors in there are errors in import data (leave blank). 
     461 
     462===  8.5 The Parameter sheet === 
     463This subsection contains a commented list of all parameters in the Parameter sheet, listed in the same order as the columns in the worksheet. 
     464 
     465 Action :: 
     466   Action to be performed by the RDS (use INSERT for new relationships, UPDATE for changing data of existing relationships, DELETE for removing Parameters). 
     467 
     468 PCA ID :: 
     469    Unique ID of the Parameter (leave blank for new Parameters).  
     470 
     471 RDL Designation :: 
     472  The name of the Parameter. 
     473 
     474 Entity type :: 
     475    The entity type (in ISO 15926-2) that this Parameter is an instance of). 
     476 
     477 Role Position :: 
     478   The Position of the parent Role of the Parameter in the Class of Multidimensional Object that includes the Parameter. Note that one of Role Position, Role PCA ID or Role RDL Designation must be given. 
     479 
     480 Role PCA ID :: 
     481  The PCA ID of the parent Role of the Parameter in the Class of Multidimensional Object that includes the Parameter. 
     482 
     483 Role RDL Designation :: 
     484  The RDL Designation of the parent Role of the Parameter in the Class of Multidimensional Object that includes the Parameter. 
     485 
     486 MC PCA ID :: 
     487   The PCA of the Class of Multidimensional Object that includes the Parameter (this is a reference to the PCA ID of the Class of Multidimensional Object defined in the Object sheet). 
     488 
     489 MC RDL Designation :: 
     490   The RDL Designation of the Class of Multidimensional Object that includes the Parameter (this is a reference to the RDL Designation of the Class of Multidimensional Object defined in the Object sheet). Note that either MC PCA ID or MC RDL Designation must be specified. 
     491 
     492 Error code :: 
     493     Added by the RDS if errors in there are errors in import data (leave blank). 
     494 
     495Error Description :: 
     496     Added by the RDS if errors in there are errors in import data (leave blank). 
     497 
     498===  8.6 The Dimension sheet ===   
     499 
     500This subsection contains a commented list of all parameters in the Dimension sheet, listed in the same order as the columns in the worksheet. 
     501 
     502 Action :: 
     503   Action to be performed by the RDS (use INSERT for new relationships, UPDATE for changing data of existing relationships, DELETE for removing Dimensions). 
     504 
     505 PCA ID :: 
     506    Unique ID of the Dimension (leave blank for new Dimensions). 
     507 
     508 RDL Designation :: 
     509  The name of the (ISO 15926-4) Dimension. 
     510 
     511 Entity type :: 
     512    The entity type (in ISO 15926-2) that this Dimension is an instance of). 
     513 
     514 Role Position :: 
     515  The Position of the parent Role of the Parameter that instantiates the Dimension in the Class of Multidimensional Object that classifies the Multidimensional Object. This is optional. 
     516 
     517 Position :: 
     518   The Position of Dimension in the Multidimensional Object that instantiates the Class of Multidimensional Object that includes the Parameter corresponding to the Dimension. Note that this has too be specified in INSERT mode. 
     519 
     520 MO PCA ID :: 
     521   The PCA ID of the Multidimensional Object that includes the Dimension (this is a reference to the PCA ID of the Multidimensional Object defined in the Object sheet). 
     522 
     523 MO RDL Designation :: 
     524  The RDL Designation of the Multidimensional Object that includes the Dimension (reference to the RDL Designation of the Multidimensional Object defined in the Object sheet). 
     525 
     526 Role PCA ID :: 
     527  The PCA ID of the Role that classifies the Dimension in the Class of Multidimensional Object instantiating the Multidimensional Object (this is an optional reference to the PCA ID of the Role defined in the Object sheet). 
     528 
     529 Role RDL Designation :: 
     530  RDL Designation of the Role that classifies the Dimension in the Class of Multidimensional Object instantiating the Multidimensional Object (this is an optional reference to the PCA ID of the Role defined in the Object sheet). 
     531 
     532 Error code :: 
     533     Added by the RDS if errors in there are errors in import data (leave blank) 
     534 
     535 Error Description :: 
     536     Added by the RDS if errors in there are errors in import data (leave blank) 
     537 
     538===  8.7 The Cardinality sheet === 
     539This subsection contains a commented list of all parameters in the Cardinality sheet, listed in the same order as the columns in the worksheet. 
     540 
     541 Action :: 
     542   Action to be performed by the RDS (use INSERT for new relationships, UPDATE for changing data of existing relationships, DELETE for removing Cardinalities). 
     543 
     544 PCA ID :: 
     545    Unique ID of the Cardinality (leave blank for new Cardinalities). 
     546 
     547 RDL Designation :: 
     548   The name of Cardinality. 
     549 
     550 Min :: 
     551  The  minimum value allowed in the referenced Cardinality. 
     552 
     553 Max :: 
     554  The  maximum value allowed in the referenced Cardinality. 
     555 
     556 Error code :: 
     557     Added by the RDS if errors in there are errors in import data (leave blank). 
     558  
     559 Error Description :: 
     560     Added by the RDS if errors in there are errors in import data (leave blank). 
     561 
     562== Spreadsheets illustrated == 
    12563 
    13564The following table lists the columns in each worksheet of the spreadsheet template. Note that most columns are optional. 
    14 || '''Object'''                   || '''Relationship'''             || '''Representation'''           || '''Role'''                     || '''Dimension'''                || '''Cardinality'''              || 
    15 || Action                         || Action                         || Action                         || Action                         || Action                         || Action                         || 
    16 || PCA ID                         || PCA ID                         || PCA ID                         || PCA ID                         || PCA ID                         || PCA ID                         || 
    17 || RDL Designation                || RDL Designation (Key)          || RDL Designation (Key)          || RDL Designation (Key)          || RDL Designation (Key)          || RDL Designation (Key)          || 
    18 || RDL Designation (Key)          || Entity type                    || Entity type                    || Entity type                    || Entity type                    || Min                            || 
    19 || Entity type                    || 1. ROLE                        || Value                          || MC PCA ID                      || Role Position                  || Max                            || 
    20 || Creator                        || 1. Entity type                 || Error Code                     || MC RDL Designation             || Position                       || Error Code                     || 
    21 || Creation Date                  || 1. PCA ID                      || Error Description              || Role Position                  || MO PCA ID                      || Error Description              || 
    22 || Deleted                        || 1. RDL Designation             ||                                   Mandatory                      || MO RDL Designation             || 
    23 || Registration status            || 1. Cardinality ID              ||                                   Cardinality ID                 || Role PCA ID                    || 
    24 || Alternative designation        || 1. Cardinality Name            ||                                   Cardinality Name               || Role RDL Designation           || 
    25 || RDL Definition                 || 2. ROLE                        ||                                   Error Code                     || Error Code                     || 
    26 || Administrative note(s)         || 2. Entity type                 ||                                   Error Description              || Error Description              || 
    27 || Change description             || 2. PCA ID                      || 
    28 || Explanatory comment(s)         || 2. RDL Designation             || 
    29 || Unresolved issue               || 2. Cardinality ID              || 
    30 || RDL adapted definition         || 2. Cardinality Name            || 
    31 || Abbreviation                   || Error Code                     || 
    32 || Note(s)                        || Error Description              || 
    33 || Examples                       || 
    34 || Submitting organisation        || 
    35 || Submitter                      || 
    36 || Registrar                      || 
    37 || Registrar Authority            || 
    38 || Stewardship                    || 
    39 || Stewardship contact            || 
    40 || Error Code                     || 
    41 || Error Description              || 
     565 
     566||'''Object'''||'''Relationship'''||'''Representation'''||'''Role'''||'''Dimension'''||'''Cardinality'''|| 
     567||Action||Action||Action||Action||Action||Action|| 
     568||PCA ID||PCA ID||PCA ID||PCA ID||PCA ID||PCA ID|| 
     569||RDL Designation||RDL Designation (Key)||RDL Designation (Key)||RDL Designation (Key)||RDL Designation (Key)||RDL Designation (Key)|| 
     570||RDL Designation (Key)||Entity type||Entity type||Entity type||Entity type||Min|| 
     571||Entity type||1. ROLE||Value||MC PCA ID||Role Position||Max|| 
     572||Creator||1. Entity type||Error Code||MC RDL Designation||Position||Error Code|| 
     573||Creation Date||1. PCA ID||Error Description||Role Position||MO PCA ID||Error Description|| 
     574||Deleted||1. RDL Designation||Mandatory||MO RDL Designation|| 
     575||Registration status||1. Cardinality ID||Cardinality ID||Role PCA ID|| 
     576||Alternative designation||1. Cardinality Name||Cardinality Name||Role RDL Designation|| 
     577||RDL Definition||2. ROLE||Error Code||Error Code|| 
     578||Administrative note(s)||2. Entity type||Error Description||Error Description|| 
     579||Change description||2. PCA ID|| 
     580||Explanatory comment(s)||2. RDL Designation|| 
     581||Unresolved issue||2. Cardinality ID|| 
     582||RDL adapted definition||2. Cardinality Name|| 
     583||Abbreviation||Error Code|| 
     584||Note(s)||Error Description|| 
     585||Examples|| 
     586||Submitting organisation|| 
     587||Submitter|| 
     588||Registrar|| 
     589||Registrar Authority|| 
     590||Stewardship|| 
     591||Stewardship contact|| 
     592||Error Code|| 
     593||Error Description|| 
Home
About PCA
Reference Data Services
Projects
Workgroups