Updated P2881 support

README.md

@@ -25,20 +25,6 @@ The OpenLXP-XIA implements five core workflows after extracting metadata from th
 `Python >=3.7` : Download and install python from here [Python](https://www.python.org/downloads/).
 
 
-## Environment Variables
-
-To run this package along with your project, you will need to add the following environment variables to your .env file
-
-
-`BUCKET_NAME` - S3 Bucket name where schema files are stored
-
-`AWS_ACCESS_KEY_ID` - AWS access keys
-
-`AWS_SECRET_ACCESS_KEY` - AWS access password
-
-`AWS_DEFAULT_REGION` - AWS region
-
-
 # Installation
 
     $ python -m pip install OpenLXP-XIA (use the latest package version)
@@ -61,13 +47,12 @@ INSTALLED_APPS = [
 
     `Xis metadata api endpoint`: API endpoint for XIS where metadata will get stored.
 
-     Example:  
+    Example:  
     `Xis metadata api endpoint`: http://localhost:8080/api/metadata/
 
     `Xis supplemental api endpoint`: API endpoint for XIS where supplemental metadata will get stored.
 
-    Example: 
-
+    Example:  
     `Xis supplemental api endpoint`: http://openlxp-xis:8020/api/supplemental-data/
 
     (Note: Replace localhost with the XIS Host)
@@ -76,14 +61,17 @@ INSTALLED_APPS = [
 3.  `Add xia configuration` : Configure Experience Index Agents(XIA):
 
     `Publisher`: Agent Name
+
+    `Xss api`: API endpoint for XSS where schemas will be retrieved from.
+
+    Example:  
+    `Xss api`: https://localhost:8000/api/
 
-    `Source metadata schema`: Schema file name for source metadata validation
-
-    `Source target mapping`: Schema file name for source to target mapping schema file
+    `Source metadata schema`: Schema iri or name for source metadata validation
 
-    `Target metadata schema`: Schema file name for target metadata validation
+    `Target metadata schema`: Schema iri or name for target metadata validation
 
-    (Note: Please make sure to upload schema files in the Experience Schema Server (XSS). In this case, upload schema files into the S3 bucket. )
+    (Note: Please make sure to upload schema files in the Experience Schema Server (XSS). )
 
 
 4. `Add metadata field overwrite`: Here, we can add new fields and their values or overwrite values for existing fields.

app/README.md

@@ -1 +1,112 @@
-# openlxp-xia
+
+# OPENLXP-XIA
+## What is it?
+OpenLXP XIA is a Python package that provides the validation functionality of extracted metadata from the source. In addition, it helps transform metadata into target metadata and further load it into indexing services. The OpenLXP XIA package does not include the metadata extraction process because extraction methods can be different for different sources. But once metadata gets extracted from the source, OpenLXP-XIA continues the V-T-V-L  (Validate-Transform-Validate-Load) cycle. 
+
+The schema files used for validation can be placed on the schema server. Currently, OpenLXP-XIA uses AWS S3 buckets as a schema server. 
+
+Below are the workflow which are performed by the OpenLXP-XIA after package installation.
+
+
+## Workflows
+The OpenLXP-XIA implements five core workflows after extracting metadata from the Specifiec source, as follows:
+
+1. `Validate`: Compares extracted learning experience metadata against the configured source metadata reference schema stored in the Experience Schema Service (XSS).
+
+2. `Transform`: Transforms extracted+validated source learning experience metadata to the configured target schema using the "XSR-to-Target" transformation map stored in the Experience Schema Service (XSS)
+
+3. `Validate`: Compares transformed learning experience metadata against the configured target metadata reference schema stored in the Experience Schema Service (XSS).
+
+4. `Load`: Pushes transformed and validated learning experience metadata to the target Experience Index Service (XIS) for further processing.
+
+5. `Log`: Records error, warning, informational, and debug events which can be reviewed and monitored.
+
+## Prerequisites
+`Python >=3.7` : Download and install python from here [Python](https://www.python.org/downloads/).
+
+
+## Installation
+
+    $ python -m pip install OpenLXP-XIA (use the latest package version)
+
+Add OpenLXP-XIA in the setting.py in your project.
+
+INSTALLED_APPS = [
+        ...
+
+        'openlxp_xia',
+
+        ....
+]
+
+## Configuration
+
+1. On the Admin page, log in with the admin credentials 
+
+2. `Add xis configuration`: Configure Experience Index Services (XIS): 
+
+    `Xis metadata api endpoint`: API endpoint for XIS where metadata will get stored.
+
+    Example:  
+    `Xis metadata api endpoint`: http://localhost:8080/api/metadata/
+
+    `Xis supplemental api endpoint`: API endpoint for XIS where supplemental metadata will get stored.
+
+    Example:  
+    `Xis supplemental api endpoint`: http://openlxp-xis:8020/api/supplemental-data/
+
+    (Note: Replace localhost with the XIS Host)
+
+
+3.  `Add xia configuration` : Configure Experience Index Agents(XIA):
+
+    `Publisher`: Agent Name
+
+    `Xss api`: API endpoint for XSS where schemas will be retrieved from.
+
+    Example:  
+    `Xss api`: https://localhost:8000/api/
+
+    `Source metadata schema`: Schema iri or name for source metadata validation
+
+    `Target metadata schema`: Schema iri or name for target metadata validation
+
+    (Note: Please make sure to upload schema files in the Experience Schema Server (XSS). )
+
+
+4. `Add metadata field overwrite`: Here, we can add new fields and their values or overwrite values for existing fields.
+
+    `Field name`: Add new or existing field Name
+
+    `Field type`: Add date type of the field
+
+    `Field value`: Add corresponding value
+
+    `Overwrite`: Check the box if existing values need to be overwritten.
+
+## Running ETL Pipeline:
+
+ETL or EVTVL (Extract-Transform-Load) Pipeline can be run through two ways:
+
+1. Through API Endpoint:
+To run ETL tasks run below API:
+
+    http://localhost:8000/api/xia-workflow
+(Note: Change localhost with XIA host)
+
+2. Periodically through celery beat: 
+ On the admin page add periodic task and it's schedule. On selected time interval celery task will run.
+
+
+## Logs
+To check the running of celery tasks, check the logs of application and celery container.
+
+## Documentation
+
+## Troubleshooting
+
+
+## License
+
+ This project uses the [MIT](http://www.apache.org/licenses/LICENSE-2.0) license.
+

app/openlxp_xia/admin.py

@@ -1,10 +1,13 @@
 from django.contrib import admin
 
-from .models import MetadataFieldOverwrite, XIAConfiguration, XISConfiguration
+from .models import (MetadataFieldOverwrite, SupplementalLedger,
+                     XIAConfiguration,
+                     XISConfiguration, MetadataLedger)
 
 
 def marked_default(MetadataFieldOverwriteAdmin, request, queryset):
     queryset.filter(field_type="str").update(field_value='Not Available')
+    queryset.filter(field_type="URI").update(field_value='Not Available')
     queryset.filter(field_type="datetime").\
         update(field_value='1900-01-01T00:00:00-05:00')
     queryset.filter(field_type="INT").update(field_value=0)
@@ -22,14 +25,13 @@ def unmarked_default(MetadataFieldOverwriteAdmin, request, queryset):
 @admin.register(XIAConfiguration)
 class XIAConfigurationAdmin(admin.ModelAdmin):
     list_display = (
-        'publisher',
+        'publisher', 'xss_api',
         'source_metadata_schema',
-        'source_target_mapping',
         'target_metadata_schema',)
-    fields = ['publisher',
-              'source_metadata_schema',
-              ('source_target_mapping',
-               'target_metadata_schema')]
+    fields = ['publisher', 'xss_api',
+              ('source_metadata_schema',
+               'target_metadata_schema'),
+              'key_fields']
 
     def delete_queryset(self, request, queryset):
         metadata_fields = MetadataFieldOverwrite.objects.all()
@@ -39,10 +41,12 @@ def delete_queryset(self, request, queryset):
 
 @admin.register(XISConfiguration)
 class XISConfigurationAdmin(admin.ModelAdmin):
-    list_display = ('xis_metadata_api_endpoint',
+    list_display = ('publisher',
+                    'xis_metadata_api_endpoint',
                     'xis_supplemental_api_endpoint',)
-    fields = ['xis_metadata_api_endpoint',
-              'xis_supplemental_api_endpoint']
+    fields = ['publisher',
+              'xis_metadata_api_endpoint',
+              'xis_supplemental_api_endpoint', 'xis_api_key']
 
 
 @admin.register(MetadataFieldOverwrite)
@@ -56,3 +60,27 @@ class MetadataFieldOverwriteAdmin(admin.ModelAdmin):
               'field_value',
               'overwrite']
     actions = [marked_default, unmarked_default]
+
+
+@admin.register(MetadataLedger)
+class MetadataLedgerAdmin(admin.ModelAdmin):
+    list_display = ('metadata_record_uuid',
+                    'source_metadata_key',
+                    'source_metadata_validation_status',
+                    'target_metadata_validation_status',
+                    'record_lifecycle_status',)
+
+    list_filter = ('record_lifecycle_status',
+                   'target_metadata_validation_status')
+    search_fields = ('metadata_record_uuid',
+                     'source_metadata_key',)
+
+
+@admin.register(SupplementalLedger)
+class SupplementalLedgerAdmin(admin.ModelAdmin):
+    list_display = ('metadata_record_uuid',
+                    'supplemental_metadata_key',
+                    'record_lifecycle_status',)
+
+    list_filter = ('record_lifecycle_status',)
+    search_fields = ('supplemental_metadata_key',)