Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update(policy): more descriptions added in add/edit policy overlay #74

Merged
merged 3 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions src/assets/locales/de/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,17 +61,19 @@
},
"policies": {
"title": "Policies",
"subtitle": "Auf dieser Seite müssen Sie die 'Policy' (Richtlinie) festlegen, die Sie für Ihren 'Recurring Upload' -Prozess (automatische upload von CSv-Files) verwenden möchten. Der Name dieser Richtlinie sollte in Ihrer Upload-Datei enthalten sein und muss eindeutig sein. Bitte verwenden Sie keine kurzen Begriffe wie 'sh' oder 'pa', die in einem neutralen Dateinamen vorkommen könnten.",
"addPolicy": "Richtlinie hinzufügen",
"EditPolicy": "Richtlinie bearbeiten",
"description": "Hier legen Sie fest mit wem sie die Daten teilen möchten (via „Access Policies“) und mit welchen Einschränkungen (via „Usage Policies“).",
"description_1": "Wählen Sie die Geschäftspartner aus, mit denen die Daten geteilt werden sollen (Suche via BPN oder über Name).",
"description_1_1": "Uneingeschränkt: Jeder im Netzwerk kann die Daten sehen",
"description_1_2": "Eingeschränkt: nur für die ausgewählten Unternehmen sichtbar (Suche nach Name oder BPN)",
"description_2": "Legen Sie fest für welche Dauer die Daten eingesehen werden dürfen (optional)",
"description_3": "Legen Sie fest für welchen Nutzen, die Daten eingesehen werden dürfen (optional)",
"description_2": "Legen Sie fest für welchen Nutzen, die Daten eingesehen werden dürfen (optional)",
"description_3": "Die Rolle des Erstellers hat die Freiheit, Richtlinien ohne Einschränkungen zu erstellen.",
"description_4": "Angesichts der fehlenden Einschränkungen sollte jeder Ersteller vor der Erstellung von Richtlinien die Unternehmensregeln konsultieren.",
"configure": "Nächster Schritt - Policies konfigurieren",
"accessPolicy": "Zugriffsrichtlinien",
"restricted": "eingeschränkt",
"unrestricted": "uneingeschränkt",
"note": "Hinweis: Ihre Organisation gehört stets zu den berechtigten Empfängern.",
"note": "Hinweis: Wenn Sie keine BPN vergeben, sind die Daten nur für Ihre Organisation zugänglich.",
"unAccess": "Uneingeschränkter Zugang!",
"warningText": "Wenn Sie keine BPN vergeben, sind die Daten nur für Sie zugänglich.",
"usagePolicy": "Nutzungsrichtlinien",
Expand Down Expand Up @@ -179,7 +181,8 @@
"agree": "Ich stimme zu",
"ownConnector": "Connector der eigenen Organisation:",
"collapseSidebar": "Seitenleiste einklappen",
"introduction": "Einleitung"
"introduction": "Einleitung",
"moreSubmodelInfo": "Weitere Informationen zu Untermodellen"
}
},
"dialog": {
Expand Down Expand Up @@ -241,4 +244,4 @@
"incorrectColumns": "Spaltenname/n sind nicht korrekt!",
"bpnValidation": "BPN sollte 16 Zeichen lang sein!"
}
}
}
22 changes: 14 additions & 8 deletions src/assets/locales/en/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
"description_1": "At first you need to select the data model you want to upload from 'Select Submodel'.",
"description_2": "As second step you must select the way of uploading data:",
"description_2_1": "Upload File (via .csv-upload)",
"description_2_2": "Manual Upload (via direct input in table-format)",
"description_2_2": "Manual Entry (via direct input in table-format)",
"placeHolder": "Please select a submodel (use case) for creating data.",
"selectSubmodel": "Select Submodel",
"uploadFile": "Upload File",
Expand All @@ -59,19 +59,24 @@
"manualInfo_1": "For creating new data leave the field 'UUID' empty.",
"manualInfo_2": "For updating existing data you need to enter the respective 'UUID' of the digital twin."
},
"recurringUpload": {
"description": "You can utilize the SDE for automated CSV file uploads. You must use the SFTP/ObjectStorage (e.g. S3, Minio) interface to transfer your CSV files to cloud storage. The SDE will then upload the CSV files according to the parameters here."
},
"policies": {
"title": "Policies",
"subtitle": "On this page, you need to define the policy to be used for your 'Recurring Upload' process. The policy name should be included in your upload file, and it must be unique. Please refrain from using short phrases like 'sh' or 'pa' that could be part of a generic file name.",
"addPolicy": "Add Policy",
"editPolicy": "Edit Policy",
"description": "Here you can manage the access policies with which partner you want to share your data.",
"description_1": "Select with whom you want to share the uploaded data",
"description_1_1": "Unrestricted: everybody within the network can see the data",
"description_1_2": "Restricted: only visible to the selected companies (search by name or BPN)",
"description_2": "Select the duration for how long you want to share the data",
"description_3": "Define the usage-purpose for the shared data (select via dropdown)",
"description_2": "Define the usage-purpose for the shared data",
"description_3": "The creator role has the freedom to generate policies without any limitations.",
"description_4": "Given the absence of limitations, each creator should consult the company rules before creating policies.",
"configure": "Next Step - Configure Policies",
"accessPolicy": "Access Policies",
"restricted": "Restricted",
"unrestricted": "Unrestricted",
"note": "Note: Your own organization will always be allowed to access the data",
"note": "Note: If you do not assign a BPN, the data can only be accessible to your own organisation.",
"unAccess": "Unrestricted Access!",
"warningText": "If you do not assign a BPN, the data can only be accessible to you.",
"usagePolicy": "Usage Policies",
Expand Down Expand Up @@ -179,7 +184,8 @@
"agree": "I agree",
"ownConnector": "Connector of own organization:",
"collapseSidebar": "Collapse sidebar",
"introduction": "Introduction"
"introduction": "Introduction",
"moreSubmodelInfo": "More info about submodels"
}
},
"dialog": {
Expand Down Expand Up @@ -241,4 +247,4 @@
"incorrectColumns": "Column name/s are not correct!",
"bpnValidation": "BPN should be 16 characters!"
}
}
}
17 changes: 9 additions & 8 deletions src/components/policies/AddEditPolicy.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -85,18 +85,17 @@ function AddEditPolicy() {
title={t(policyDialogType === 'Edit' ? 'content.policies.editPolicy' : 'content.policies.addPolicy')}
/>
<DialogContent>
<Typography variant="body2">
<b>{t('content.policies.description')}</b>
<Typography variant="body2" fontWeight={'bold'}>
{t('content.policies.description')}
</Typography>
<ol style={{ padding: '0 0 0 16px' }}>
<li>
<Typography variant="body2">{t('content.policies.description_1')}</Typography>
</li>
<li>
<Typography variant="body2">{t('content.policies.description_2')}</Typography>
</li>
<li>
<Typography variant="body2">{t('content.policies.description_3')}</Typography>
<Typography variant="body2">{t('content.policies.description_4')}</Typography>
</li>
</ol>
<form>
Expand All @@ -122,8 +121,10 @@ function AddEditPolicy() {
</FormControl>
)}
{/* access policy starts */}
<Typography fontWeight={'bold'}>{t('content.policies.accessPolicy')}</Typography>
<Divider sx={{ mt: 2 }} />
<Typography fontWeight={'bold'} variant="body2">
{t('content.policies.accessPolicy')}
</Typography>
<Divider sx={{ mt: 1 }} />
<ValidateBpn
control={control}
watch={watch}
Expand All @@ -145,10 +146,10 @@ function AddEditPolicy() {
))}
{/* access policy ends */}
{/* usage policy starts */}
<Typography fontWeight={'bold'} mt={3}>
<Typography fontWeight={'bold'} variant="body2" mt={3}>
{t('content.policies.usagePolicy')}
</Typography>
<Divider sx={{ my: 2 }} />
<Divider sx={{ my: 1 }} />
{CHECKBOXES.map((item: any) => (
<FormControl fullWidth key={item.name}>
<Controller
Expand Down
2 changes: 1 addition & 1 deletion src/components/policies/ValidateBpn.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ function ValidateBpn({ control, resetField, getValues, setValue, inputBpn }: any
</Grid>
<Box sx={{ my: 2 }}>
<Typography variant="body2" mb={2}>
<i> {t('content.policies.note')}</i>
{t('content.policies.note')}
</Typography>
<Stack direction="row" spacing={1} sx={{ flexWrap: 'wrap', gap: 1 }}>
{getValues('access_policies.bpn_numbers.value')?.map((bpnNum: string) => (
Expand Down
Loading