Configure a class-based data capture template

The Data Capture Templates view allows you to configure data capture templates to capture data for each relevant object class, reference array as well as application costs and project costs. This process is involved and requires a good understanding of the class model and how classes reference other classes.

Configure class-based data capture templates to collect data about object classes including which object class properties, indicator types, role types, lifecycle phases, and generic attributes to capture. A data capture template must be explicitly configured for each object class, reference array, application cost type, and project cost type.

You can generate an XLSX file for each data capture template you configure. Each data capture template describes the data to capture for one class. Object hierarchies such as an application group hierarchy can be created via the BelongsTo property available for such an object class.

1. Go to Data Import > Data Capture Templates.
2. Click New > Create New Data Capture Template.

   You can create a copy of an existing data capture template via New > Create Data Capture Template as Copy. The fields defined in the data capture template will be copied to the new data capture template. For a class-based data capture template, the Class field will be copied and cannot be edited but all other aspects of the data capture template may be modified, as needed.

3. In the Stereotype Selector, select Class-Based Data Capture Template. The Data Capture Template - Class editor opens.
4. In the Basic Data tab, specify basic information about the class-based data capture template. Define the following fields as needed:
   • Name: (Mandatory) Provide a meaningful name for the data capture template.
   • File Name Base: Provide a string that will be used as the first part of the file name of the file that is generated based on the data capture template. The string will be appended with a GUID to assure that the file name is unique.
   • Release Status: Select a predefined release status for the data capture template.
   • Class: (Mandatory) Select the object class for which the data shall be collected in the data capture template.
     • To capture business capabilities or IT capabilities, select Domain in the Class field and then either Business Capability or IT Capability in the Applicable Stereotype field.
     • To capture physical devices or virtual devices, select Device in the Class field and then either Physical Device or Virtual Device in the Applicable Stereotype field.
   • Dataset Provider: Specify the method to export the object data to the XLSX file. The objects will be displayed as records in the Export tab in the XLSX file. You can do one of the following:
     • Select All Records to populate the XLSX file with all relevant objects of the class.
     • Select No Records to generate an XLSX that has no instance data exported. The XLSX file will contain columns as defined in the data capture template but no records that have been exported from the Alfabet FastLane database. Exporting a file without instance data might be used, for example, if only new objects shall be created via the XLSX file. In this case, you must ensure that Create is selected in the Permitted Operations field.
     • Select a configured report to populate the XLSX file with objects found by the report query.
   • Description: Enter a meaningful description that will clarify the purpose of the data capture template.
   • Sample Record Provider: Sample data may be exported to the XLSX file to provide examples of existing data for users to understand how to create new data in the XLSX file. The sample data is exported to a Sample Data tab in the XLSX file where users can experiment with the data. The sample data will not be reimported to Alfabet FastLane and therefore the Alfabet FastLane database will not be impacted by changes made to the sample data.
   • Permitted Operations: (Mandatory) Specify the operations that shall be permissible in the XLSX file. Each row in the Operations column will have a drop-down list that allows the user to specify which operation shall be applied to the record. The follow operations are permissible:
     • Create: Allows a new object to be created. Users must define the new object in an empty row in the XLSX file and define the relevant columns as needed.
     • Update: Allows one or more properties, role types, indicator types, or lifecycle phases to be modified for the object.
     • Delete: Allows the entire object to be deleted.
     • No Change: Allows no modification to be made to the object. Please note that if No Change is not selected, users must modify the record in some way.
   • Primary Language: (Mandatory) Select the primary language to be used to generate the information in the XLSX file. If a primary language other than English is specified for the data capture template, the data in the XLSX file will be displayed in the specified language if a translation is available for the string. Date property values will be generated in the Excel file based on the format configured for the specified primary language. A validation of the formatting of the data loaded with the XLSX file will be executed for the primary language specified in the data capture template.
   • Other Supported Languages: Select the additional languages in which the data shall be captured. A column will be added to the XLSX file to capture the relevant data for each language selected in the Other Supported Languages field. The column header will display <Property Name> <( Language Culture Name)>

     If both the Primary Language and Other Supported Languages fields are specified, than the language English must be selected in one of the fields. If no value is imported for the language of the primary culture, an error will occur.

   • Capture Lifecycle: Select the checkbox if lifecycle information shall be captured for the objects targeted by the data capture. If the Capture Lifecycle checkbox is selected, the lifecycle phases specified for the relevant object will be automatically displayed in the Lifecycle tab for the object class specified in the data capture template.
   • Capture Generic Attribute: Select the checkbox if generic attributes shall be captured for the objects targeted by the data capture. If the Capture Generic Attribute checkbox is selected, the generic attributes specified for the relevant object will be automatically displayed in the Generic Attributes tab in the data capture template.
   • Max. Number of Rows: Enter the maximum number of records that may be imported via the XLSX file. The number of valid records starting with the first valid record in the XLSX file will be imported.
   • User Loading the Data is the Responsible User: Select the checkbox if the user importing the XLSX file shall be the responsible user for objects created via the data upload. If the checkbox is selected, the ResponsibleUser property will not be displayed in the Class Properties tab. If the User Loading the Data is the Responsible User attribute is not selected, the ResponsibleUser property must be explicitly selected in the Class Properties tab if the authorized user shall be available in the XLSX file.
   • Status Report Scope: Specify which type of records shall be displayed in the status report (XLSX file) that provides information about the results of the import. The following is possible:
     • Total Records: Select if all processed and discarded records shall be included in the status report. The discarded records displayed in the status report can be corrected and reimported to the Alfabet FastLane database.
     • Processed Records: Select if only records that were successfully imported shall be included in the status report.
     • Discarded Records: Select if only records that failed the validation process and were discarded during the import shall be included in the status report. The discarded records displayed in the status report can be corrected and reimported to the Alfabet FastLane database.
   • Validate: Select one or more validation scenarios that shall be executed in addition to the standard validation rules when the XLSX file is imported to Alfabet FastLane. This field will only be displayed if a relevant object class is selected in the Class field. Please note the following:
     • If you select either the classes Domain (with Applicable Stereotype = Business Capability or IT Capability ) and Business Process in the Class field, a validation rule for the Level ID property can be selected. Select if the defined value must be valid for the business capabilities, IT capabilities, or business processes based on the Level ID values for its parent-child relationships.
     • If you select either the classes Information Flow or Operational Business Support, in the Class field, a validation rule for date properties can be selected. Please note the following:
       • If the start date of the information flow is earlier than the start date of the source or target object of the information flow, then the information flow will not be created or updated. If the end date of the information flow is later than the end date of the source or target object of the information flow, then the information flow will not be created or updated.
       • If the start date of the business support is earlier than the start date of either of the referenced objects, then the business support will not be created or updated. If the end date of the business support is later than the end date of either of the referenced objects, then the business support will not be created or updated.
5. Go to the Class Properties tab. This displays a row for each object class property.

   To change the sequence of the properties, select a row and click either the Move Up or Move Down button in the toolbar of the dataset. The sequence specified in the data capture template will also be the sequence of the properties in the XLSX file.

   You must set a checkmark in the Included column for the property to be included in the data capture template. Selecting the checkbox in the first column of a row is not relevant.

   Please note that in order to prevent the ID of objects being erroneously changed, the ID property can not be enabled as a class property.

   • Drag the horizontal scrollbar at the bottom of the dataset in order to view all columns in the Class Properties tab.
   • Define the following columns in the Class Properties tab:
     • Name: Displays the name of the data capture template record.
     • Caption: If necessary, change the caption that shall be displayed as the column header in the XLSX file.
     • Mandatory: Set a checkmark to specify that the property is mandatory and must be defined in the XLSX file in order for the record to be imported to the Alfabet FastLane database. Any object class property that is specified as mandatory in the class model will automatically have the checkmark set in the Mandatory column. This can be changed, as needed. If the property is set as mandatory, the checkmark in the Include column will also be set. The Mandatory column in the Help tab of the XLSX file will be set to True for a mandatory property.
     • Property: Displays the name of the property targeted by the record.
     • Include: Set a checkmark to specify that the property shall be included in the XLSX file. A mandatory property must be included in the XLSX file.

       To set the checkmark in the Include column for all properties, select the Select All button above the dataset. To clear the checkmark in the Include column for all properties, select the Exclude All button above the dataset.

     • Property Type: Displays the property type of the property.
     • Property Details: For properties of type Reference or ReferenceArray: Displays the referenced property. If multiple object classes are referenced by the property of type Reference or ReferenceArray , a multi-select combo box will be displayed in the column and the referenced classes that are relevant for the data capture can be selected. If the All Records in the Basic Data tab and the Property Details tab is specified, only the relevant records will be included in the generated XLSX file.
     • Reference Class Filter Type: For properties of type Reference or ReferenceArray: Select All to export all objects of the class specified in the Property Details column, select Stereotype to export all objects of the object class stereotype that you will specify in the Reference Class Stereotype column, or select Report to specify all objects found by the configured report that you will specify in the Reference Class Filter column.
     • Reference Class Filter: For properties of type Reference or ReferenceArray: If you have selected Report in the Reference Class Filter Type column, select the configured report that shall find the objects targeted by the reference. The objects found by the configured report can be selected in a drop-down list in the XLSX file.
     • Reference Class Stereotype: For properties of type Reference or ReferenceArray: If you have selected Stereotype in the Reference Class Filter Type column, select the object class stereotype of the objects targeted by the reference. The objects based on the specified stereotype will be sorted lexicographically and can be selected in a drop-down list in the XLSX file.
     • Editor Hint: Enter text to assist the user in defining the property in the XLSX file. If no hint is defined, the value specified for the Hint attribute of the property in the class model will be displayed. The hints will be available in the Help tab of the XLSX file.
     • Allow Delta Objects: For properties of type Reference or ReferenceArray: Set a checkmark to allow new referenced objects to be specified in the XLSX file. The new referenced objects are objects that did not exist at the time that the XLSX file was generated but have in the meantime been added to the Alfabet FastLane database. The user must type in the exact name of the referenced object. If the name is correctly entered for the referenced object, the reference will be created between the base object and the new reference object upon import of the XLSX file.
     • Replace on Data Load: For properties of type ReferenceArray: Role types where the Person Plurality and Organization Plurality attributes are set to True for the role type configuration can be updated via the data capture template. Set a checkmark to specify that existing all existing roles of the property shall be deleted and only one role will be added upon import. If a checkmark is not set, existing records will not be deleted in the Alfabet FastLane database and the new roles will be added to the existing roles upon import.
6. Go to the Role Type tab. This tab displays a row for each permissible role type available for the object class/object class stereotype targeted by the data capture template. All role types assigned to the relevant class in the Class Configuration functionality will be displayed in the Role Types tab. Please note the following:
   • The data capture template will include a row for each possible role type available for the targeted class/stereotype. Therefore, all role types that may reference a person as well as all role types that may reference an organization stereotype will be displayed in the Role Type tab.
   • Role types may be configured so that only one person or organization may be specified for a role for an object or multiple persons or organizations may be specified for a role for an object. If multiple persons are allowed, the Person Plurality attribute for the role type will be set to True and if multiple organizations are allowed, the Organization Plurality attribute for the role type will be set to True.
     • If the Organization Plurality attribute for a role type is set to False for a role and the role is updated via the imported XLSX file, the old role definition will be deleted and a new role with the specified organization will be created. If the Organization Plurality attribute is set to True, a new role will be created for each specified organization.
     • If the Person Plurality attribute for a role type is set to False for a role and the role is updated via the imported XLSX file, the old role definition will be deleted and a new role with the specified person will be created. If the Person Plurality attribute is set to True, a new role will be created for each specified person.
   • Roles can be deleted for objects in the context of a data capture template for roles based on role types where the Person Plurality and Organization Plurality attributes are set to False in the role type configuration.
   • The role types defined in the XLSX file must exist in Alfabet FastLane at the time of import. A record will not be imported to Alfabet FastLane if the defined role type has been deleted from the Alfabet FastLane database at the time of import.

   The following is possible:

   • Drag the horizontal scrollbar at the bottom of the dataset in order to view all columns in the Role Type tab.
   • Define the following columns in the Role Type tab:
     • Name: Displays the name of the data capture template record. The name is a concatenation of <Class>:<Stereotype>:<Role Type>. In the XLSX file, the role types will be listed in the sequence <Class>:<Stereotype>:<Role Type>. The sequence can be changed via the Move Up   or Move Down   buttons, as needed.
     • Caption: If necessary, change the caption that shall be displayed as the column header in the XLSX file. The following default syntax may be displayed:
       • Role types for the class Person where the person is based on the stereotype User: Person:User:<Name of Role Type>
       • Role types for the class OrgaUnit: OrgaUnit:<Name of Role Type>
     • Mandatory: Set a checkmark to specify that the role type is mandatory and must be defined in the XLSX in order for the record to be imported to the Alfabet FastLane database. This can be changed, as needed. If a checkmark is set in the Mandatory column, the checkmark in the Include column will automatically be set. The Mandatory column in the Help tab of the XLSX file will be set to True for a mandatory role type.
     • Include: Set a checkmark to specify that the role type shall be included in the XLSX file. A mandatory role type must be included in the XLSX file.

       To set the checkmark in the Include column for all role types, select the Select All button above the dataset. To clear the checkmark in the Include column for all role types, select the Exclude All button above the dataset.

     • Property Details: Displays the details of the role type. This will be a concatenation of OrgaUnit or Person and the name of the role type.
     • Reference Class Filter: Select the configured report that shall find the specific subset of role types that the objects targeted by the data capture template may be assigned to. The role types found by the configured report shall be available in the drop-down list to define the referenced object in the XLSX file.
     • Reference Class Stereotype: Displays the stereotype of the class OrgaUnit or Person that is referenced by the role type.
     • Editor Hint: Enter text to assist the user in defining the role type in the XLSX file. If no hint is defined, the value specified for the Description attribute of the role type will be displayed. The hints will be available in the Help tab of the XLSX file.
     • Allow Delta Objects: Set a checkmark to allow new referenced role types to be specified in the XLSX file. The new referenced role types are role types that did not exist at the time that the XLSX file was generated but have in the meantime been added to the Alfabet FastLane database. The user must type in the exact name of the referenced role types. If the name is correctly entered for the referenced role types, the reference will be created between the base object and the new role type upon import of the XLSX file.

       To set the checkmark in the Allow Delta Objects column for all role types, select the Select All Delta Objects button above the dataset. To clear the checkmark in the Allow Delta Objects column for all role types, select the Exclude All button above the dataset.

7. Go to the Indicator Type tab. This tab displays a row for each permissible indicator type available for the object class targeted by the data capture template. All relevant indicator types associated with evaluation types that are assigned to the relevant class in the Class Configuration functionality will be displayed in the Indicator Type tab.

   Please note the following:

   • Indicator types that allow a value to be explicitly defined or a value to be selected from a configured range will be included in the data capture template.
   • Indicator types based on a computation rule will not be included in the data capture template.
   • If the Hide Numbers checkbox is selected for an indicator type in the Indicator Types editor, then only the semantic value will be displayed in the drop-down field in the XLSX file.
   • The indicator types defined in the XLSX file must exist in Alfabet FastLane at the time of import. A record will not be imported to Alfabet FastLane if the defined indicator type has been deleted from the Alfabet FastLane database at the time of import.

   The following is possible:

   • Drag the horizontal scrollbar at the bottom of the dataset in order to view all columns in the Indicator Type tab.
   • Define the following columns in the Indicator Type tab:
     • Name: Displays the name of the data capture template record. The name is a concatenation of <Evaluation Type Name>:<Indicator Type Name>. he indicator types will be lexicographically sorted in the XLSX file according to <Evaluation Type Name>:<Indicator Type Name>.

       The sequence can be changed via the Move Up   or Move Down   buttons in the toolbar, as needed.

     • Caption: If necessary, change the caption that shall be displayed as the column header in the XLSX file.
     • Mandatory: Set a checkmark to specify that the indicator type is mandatory and must be defined in the XLSX in order for the record to be imported to the Alfabet FastLane database. This can be changed, as needed. If a checkmark is set in the Mandatory column, the checkmark in the Include column will automatically be set. The Mandatory column in the Help tab of the XLSX file will be set to True for a mandatory indicator type.
     • Include: Set a checkmark to specify that the indicator type shall be included in the XLSX file. A mandatory indicator type must be included in the XLSX file.

       To set the checkmark in the Include column for all indicator types, select the Select All button above the dataset. To clear the checkmark in the Include column for all indicator types, select the Exclude All button above the dataset.

     • Editor Hint: Enter text to assist the user in defining the indicator type in the XLSX file. If no hint is defined, the value specified for the Description attribute of the indicator type will be displayed. The hints will be available in the Help tab of the XLSX file.
8. Go to the Lifecycle tab. This tab displays a row for each lifecycle phase specified for the object class targeted by the data capture template and allows you to specify the lifecycle phase to include in the XLSX file. Please consider the following:
   • The Capture Lifecycle attribute must be set to True in the Basic Data tab to display the lifecycle phases in the Lifecycle tab.
   • Users will be able to define a start date for each lifecycle phase included in the XLSX file and the end date of the last lifecycle phase. A user can delete a lifecycle phase for an object by selecting Update in the Operations column and leaving the lifecycle phase's start date empty when the XLSX file is imported.
   • At least one lifecycle phase's start date and the lifecycle end date must be defined at the time of import.

   Define the following columns in the Lifecycle tab:

   • Name: Displays the name of the data capture template record. The name will be displayed as a column caption in the XLSX file as a concatenation of <Lifecycle Phase> Start Date for all lifecycle phases except for the last lifecycle phase. The column caption for the last lifecycle phase will be Lifecycle End Date for the last lifecycle phase.
   • Caption: If necessary, change the caption that shall be displayed as the column header in the XLSX file.
   • Mandatory: Set a checkmark to specify that the lifecycle phase is mandatory and must be defined in the XLSX in order for the record to be imported to the Alfabet FastLane database. This can be changed, as needed. If a checkmark is set in the Mandatory column, the checkmark in the Include column will automatically be set. The Mandatory column in the Help tab of the XLSX file will be set to True for a mandatory lifecycle phase.
   • Include: Set a checkmark to specify that the lifecycle phase shall be included in the XLSX file. A mandatory lifecycle phase must be included in the XLSX file.
   • Editor Hint: Enter text to assist the user in defining the lifecycle phase in the XLSX file. Please note that the default hint for the lifecycle end date is the end date of the final lifecycle phase defined for the record. The hints will be available in the Help tab of the XLSX file.
9. The Import/Export Asynchronously tab allows the asynchronous import and export of data via data capture templates to be specified for the import/export of large sets of data. If asynchronous execution is activated, it will be implemented when the following actions are triggered:
   • Create MS Excel File from Data Capture Template
   • Download Data Capture Template
   • Import MS Excel File for Data Capture Template

   To activate asynchronous import and export for a data capture template, select the Import/Export Asynchronously checkbox. In the dataset, select the folder in the Internal Document Selector that the export file shall be created in. If the Import/Export Asynchronously checkbox is selected, the event feedback message will be displayed to the user triggering the import or export of the data capture template.

10. Go to the Data Roundtrip tab. Select the Use for Data Roundtrip checkbox if this data capture template should replace the default template used to generate the XLSX file in the Data Roundtrip view.
11. Click the OK button to save the data capture template configuration and close the editor.