Dokumentation gbrma: Unterschied zwischen den Versionen

Aus Wikizone
Wechseln zu: Navigation, Suche
 
(19 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 +
== Geräte verwalten ==
 +
gbdevices
 +
== RMAs anlegen ==
 +
gbrma
 +
 +
== Status einer RMA ==
 +
siehe Technische Dokumentation
 +
 +
== Status Update über Uploadmodul und ERP Import Modul ==
 +
Die Extension gbrma kann bestimmte Files einlesen und die enthaltenen Daten werden anschließend für den Statusupdate der RMAs genutzt. Das Importmodul kann auf fremde Server zugreifen. Es gibt aber auch ein Modul zum hochladen von Dateien.
 +
 +
 +
 +
===rmaupload===
 +
Um ERP Dateien hochzuladen gibt es die kleine rmaupload Extension. Sie stellt im Prinzip ein Hochladeformular zur Verfügung.
 +
 +
===Beispielkonfiguration===
 +
rmaupload in der Standardkonfiguration
 +
 +
== rmaupload doku ==
 +
'''Constants'''
 +
<pre>
 +
 +
plugin.tx_rmaupload {
 +
view {
 +
# cat=plugin.tx_rmaupload/file; type=string; label=Path to template root (FE)
 +
templateRootPath = EXT:rmaupload/Resources/Private/Templates/
 +
# cat=plugin.tx_rmaupload/file; type=string; label=Path to template partials (FE)
 +
partialRootPath = EXT:rmaupload/Resources/Private/Partials/
 +
# cat=plugin.tx_rmaupload/file; type=string; label=Path to template layouts (FE)
 +
layoutRootPath = EXT:rmaupload/Resources/Private/Layouts/
 +
}
 +
persistence {
 +
# cat=plugin.tx_rmaupload//a; type=string; label=Default storage PID
 +
storagePid =
 +
}
 +
}
 +
</pre>
 +
'''Setup'''
 +
 +
plugin.tx_rmaupload {
 +
view {
 +
templateRootPath = {$plugin.tx_rmaupload.view.templateRootPath}
 +
partialRootPath = {$plugin.tx_rmaupload.view.partialRootPath}
 +
layoutRootPath = {$plugin.tx_rmaupload.view.layoutRootPath}
 +
}
 +
persistence {
 +
storagePid = {$plugin.tx_rmaupload.persistence.storagePid}
 +
}
 +
features {
 +
# uncomment the following line to enable the new Property Mapper.
 +
# rewrittenPropertyMapper = 1
 +
}
 +
settings{
 +
uploadPath=fileadmin/user_upload/rma/
 +
}
 +
}
 +
 
== Einrichtung ==
 
== Einrichtung ==
 +
=== Installation ===
 +
* Extensions installieren:
 +
** gbdevices
 +
** gbrma
 +
** rmaupload (wenn benötigt)
 +
 +
* Devices Datensätze falls vorhanden importieren
 +
* Benutzergruppen anlegen:
 +
** RMA Gruppe für Generellen Zugang zu den Seiten
 +
** Allow xyz Family Access (wenn man den Zugang zu bestimmten Gerätefamilen restriktieren will.
 +
* Konfiguration s.u.
 +
* Speicherordner in Konstanten
 +
plugin.tx_gbdevices.persistence.storagePid = 49
 +
plugin.tx_gbrma.persistence.storagePid = 49
 +
* Speicherordner in Seiten anlegen (für Verbundene Datensätze)
 +
* Für jeden RMA Typ einen Eintrag mit Basis Nr.
 +
* Scheduler
  
 
=== TS Configuration ===
 
=== TS Configuration ===
Konstanten
+
'''Konstanten'''
 
<pre>
 
<pre>
 
plugin.tx_gbdevices.persistence.storagePid = 49 # gbdevices wird benötigt für gbrma
 
plugin.tx_gbdevices.persistence.storagePid = 49 # gbdevices wird benötigt für gbrma
 
plugin.tx_gbrma.persistence.storagePid = 49 # Speicherort der RMA Daten
 
plugin.tx_gbrma.persistence.storagePid = 49 # Speicherort der RMA Daten
 
</pre>
 
</pre>
Setup
+
'''Setup'''
 
<pre>
 
<pre>
senderMail = test@example.com
+
senderMail = test@example.com //na
senderMailName = Test Mailer
+
senderMailName = Test Mailer //na
adminMail = email@example.com
+
adminMail = email@example.com // Adresse für Admin Mails
adminMailName = Test Admin
+
adminMailName = Test Admin // Name des Admins in E-Mails
mailSubject = RMA Request
+
mailSubject = RMA Request // Betreffzeile der Admin Mails wenn nicht anders im Code definiert evtl. rauswerfen TODO
superuserId = 1
+
superuserId = 1 // na
nbmClassId = 7
+
nbmClassId = 7 // Geräteklassen ID für nbm Geräte (für Sonderregelung bei der Auswahl)
nbm520Id = 104
+
nbm520Id = 104 // Geräte ID für nbm 520 wegen Sonderregelung
nbm550Id = 103
+
nbm550Id = 103 // Geräte ID für nbm550 wegen Sonderregelung
 
multipleBaseDevicesAllowedClassIds =  
 
multipleBaseDevicesAllowedClassIds =  
restrictFamilyAccessToFegroups = 0  
+
restrictFamilyAccessToFegroups = 0 // Schalter - beschränkt Zugriff auf bestimmte Gerätefamilien
 
// Wenn an dann muß die Familie einer Usergruppe zugeordnet sein. Nur User dieser Gruppe stehen Geräten dieser Familie für RMAs zur Verfügung
 
// Wenn an dann muß die Familie einer Usergruppe zugeordnet sein. Nur User dieser Gruppe stehen Geräten dieser Familie für RMAs zur Verfügung
 
#pdf_css = EXT:gbrma/Resources/Public/Css/pdf.css // Not used
 
#pdf_css = EXT:gbrma/Resources/Public/Css/pdf.css // Not used
 
#pdf_html = EXT:gbrma/Resources/Private/Templates/Pdf/pdf.html // Not used
 
#pdf_html = EXT:gbrma/Resources/Private/Templates/Pdf/pdf.html // Not used
 +
retourRmaAllowedGroupId = 0
 
</pre>
 
</pre>
 +
 +
=== Zugriff auf RMA Plugin schützen ===
 +
Das Plugin erlaubt generell jedem FE-User RMAs anzulegen. Welche Art von RMAs wird durch die weitere Konfiguration geregelt (s.u.). Wenn Nur bestimmte Benutzer das Plugin benutzen sollen kann man eine '''normale FE-User Gruppe''' (z.B. mit dem Namen RMA) anlegen und für die Seite auf der das Plugin liegt einen FE-User Zugriff einrichten.
  
 
=== Family Access ===
 
=== Family Access ===
 
  restrictFamilyAccessToFegroups = 1
 
  restrictFamilyAccessToFegroups = 1
Wenn dieser Wert im Setup gesetzt wird, dann kann der Benutzer nur noch bestimmte Gerätefamilien für RMAs auswählen. Wenn es nicht gesetzt ist können die Benutzer alle Familien nutzen.
+
Wenn dieser Wert im Setup gesetzt wird, dann kann der '''Benutzer nur noch bestimmte Gerätefamilien für RMAs auswählen'''. Wenn es nicht gesetzt ist können die Benutzer alle Familien nutzen.
  
 
Durch die Installation von gbrma wird gbdevices um ein Feld erweitert.  
 
Durch die Installation von gbrma wird gbdevices um ein Feld erweitert.  
 
* GB Devices -> Familie auswählen und Benutzergruppe im Feld Allowed FE-User Group setzen
 
* GB Devices -> Familie auswählen und Benutzergruppe im Feld Allowed FE-User Group setzen
 
* Dem FE User diese Gruppe zuordnen.
 
* Dem FE User diese Gruppe zuordnen.
 +
 +
=== Retour RMAs ===
 +
==== Konfiguration ====
 +
* Gruppe anlegen z.B. "Erlaube Retour RMAs"
 +
* ID der Gruppe merken
 +
* TypoScript konfigurieren
 +
# Feature einschalten
 +
restrictRetourAccessToFegroups = 1
 +
# Gruppen ID eintragen (mehrere mit Komma trennen)
 +
retourRmaAllowedGroupIds = 4,5,6
 +
* Gruppe dem gewünschten Benutzer zuordnen
 +
 +
=== Client Mode ===
 +
In diesem Modus dient die Client ID (im User unter RMA hinterlegt) als Zugriffsmerkmal für die RMAs. D.h. mehrere User können auf die selben RMAs zugreifen
 +
 +
=== Modifications ===
 +
Manche Geräte können modifiziert werden.
 +
Hartkodiert in gbdevices im Model und in den Sprachdateien
  
 
=== Model / Fields Dokumentation ===
 
=== Model / Fields Dokumentation ===
Zeile 85: Zeile 182:
 
)
 
)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
== RMA Types ==
 +
=== Code Hints ===
 +
Definiert in:
 +
* Template: ListRmas.html
 +
* Template: NewFormFields.html
 +
* Template: Mail.html
 +
 +
 +
== Fehler beheben ==
 +
=== Scheduler Probleme ===
 +
importFile gesetzt und vorhanden?

Aktuelle Version vom 18. Mai 2016, 13:12 Uhr

Geräte verwalten[Bearbeiten]

gbdevices

RMAs anlegen[Bearbeiten]

gbrma

Status einer RMA[Bearbeiten]

siehe Technische Dokumentation

Status Update über Uploadmodul und ERP Import Modul[Bearbeiten]

Die Extension gbrma kann bestimmte Files einlesen und die enthaltenen Daten werden anschließend für den Statusupdate der RMAs genutzt. Das Importmodul kann auf fremde Server zugreifen. Es gibt aber auch ein Modul zum hochladen von Dateien.


rmaupload[Bearbeiten]

Um ERP Dateien hochzuladen gibt es die kleine rmaupload Extension. Sie stellt im Prinzip ein Hochladeformular zur Verfügung.

Beispielkonfiguration[Bearbeiten]

rmaupload in der Standardkonfiguration

rmaupload doku[Bearbeiten]

Constants


plugin.tx_rmaupload {
	view {
		# cat=plugin.tx_rmaupload/file; type=string; label=Path to template root (FE)
		templateRootPath = EXT:rmaupload/Resources/Private/Templates/
		# cat=plugin.tx_rmaupload/file; type=string; label=Path to template partials (FE)
		partialRootPath = EXT:rmaupload/Resources/Private/Partials/
		# cat=plugin.tx_rmaupload/file; type=string; label=Path to template layouts (FE)
		layoutRootPath = EXT:rmaupload/Resources/Private/Layouts/
	}
	persistence {
		# cat=plugin.tx_rmaupload//a; type=string; label=Default storage PID
		storagePid =
	}
}

Setup

plugin.tx_rmaupload { view { templateRootPath = {$plugin.tx_rmaupload.view.templateRootPath} partialRootPath = {$plugin.tx_rmaupload.view.partialRootPath} layoutRootPath = {$plugin.tx_rmaupload.view.layoutRootPath} } persistence { storagePid = {$plugin.tx_rmaupload.persistence.storagePid} } features { # uncomment the following line to enable the new Property Mapper. # rewrittenPropertyMapper = 1 } settings{ uploadPath=fileadmin/user_upload/rma/ } }

Einrichtung[Bearbeiten]

Installation[Bearbeiten]

  • Extensions installieren:
    • gbdevices
    • gbrma
    • rmaupload (wenn benötigt)
  • Devices Datensätze falls vorhanden importieren
  • Benutzergruppen anlegen:
    • RMA Gruppe für Generellen Zugang zu den Seiten
    • Allow xyz Family Access (wenn man den Zugang zu bestimmten Gerätefamilen restriktieren will.
  • Konfiguration s.u.
  • Speicherordner in Konstanten
plugin.tx_gbdevices.persistence.storagePid = 49
plugin.tx_gbrma.persistence.storagePid = 49
  • Speicherordner in Seiten anlegen (für Verbundene Datensätze)
  • Für jeden RMA Typ einen Eintrag mit Basis Nr.
  • Scheduler

TS Configuration[Bearbeiten]

Konstanten

plugin.tx_gbdevices.persistence.storagePid = 49 # gbdevices wird benötigt für gbrma
plugin.tx_gbrma.persistence.storagePid = 49 # Speicherort der RMA Daten

Setup

senderMail = test@example.com //na
senderMailName = Test Mailer //na
adminMail = email@example.com // Adresse für Admin Mails
adminMailName = Test Admin // Name des Admins in E-Mails
mailSubject = RMA Request // Betreffzeile der Admin Mails wenn nicht anders im Code definiert evtl. rauswerfen TODO
superuserId = 1 // na
nbmClassId = 7 // Geräteklassen ID für nbm Geräte (für Sonderregelung bei der Auswahl)
nbm520Id = 104 // Geräte ID für nbm 520 wegen Sonderregelung
nbm550Id = 103 // Geräte ID für nbm550 wegen Sonderregelung
multipleBaseDevicesAllowedClassIds = 
restrictFamilyAccessToFegroups = 0 // Schalter - beschränkt Zugriff auf bestimmte Gerätefamilien 
// Wenn an dann muß die Familie einer Usergruppe zugeordnet sein. Nur User dieser Gruppe stehen Geräten dieser Familie für RMAs zur Verfügung
#pdf_css = EXT:gbrma/Resources/Public/Css/pdf.css // Not used
#pdf_html = EXT:gbrma/Resources/Private/Templates/Pdf/pdf.html // Not used
retourRmaAllowedGroupId = 0

Zugriff auf RMA Plugin schützen[Bearbeiten]

Das Plugin erlaubt generell jedem FE-User RMAs anzulegen. Welche Art von RMAs wird durch die weitere Konfiguration geregelt (s.u.). Wenn Nur bestimmte Benutzer das Plugin benutzen sollen kann man eine normale FE-User Gruppe (z.B. mit dem Namen RMA) anlegen und für die Seite auf der das Plugin liegt einen FE-User Zugriff einrichten.

Family Access[Bearbeiten]

restrictFamilyAccessToFegroups = 1

Wenn dieser Wert im Setup gesetzt wird, dann kann der Benutzer nur noch bestimmte Gerätefamilien für RMAs auswählen. Wenn es nicht gesetzt ist können die Benutzer alle Familien nutzen.

Durch die Installation von gbrma wird gbdevices um ein Feld erweitert.

  • GB Devices -> Familie auswählen und Benutzergruppe im Feld Allowed FE-User Group setzen
  • Dem FE User diese Gruppe zuordnen.

Retour RMAs[Bearbeiten]

Konfiguration[Bearbeiten]

  • Gruppe anlegen z.B. "Erlaube Retour RMAs"
  • ID der Gruppe merken
  • TypoScript konfigurieren
# Feature einschalten
restrictRetourAccessToFegroups = 1
# Gruppen ID eintragen (mehrere mit Komma trennen) 
retourRmaAllowedGroupIds = 4,5,6
  • Gruppe dem gewünschten Benutzer zuordnen

Client Mode[Bearbeiten]

In diesem Modus dient die Client ID (im User unter RMA hinterlegt) als Zugriffsmerkmal für die RMAs. D.h. mehrere User können auf die selben RMAs zugreifen

Modifications[Bearbeiten]

Manche Geräte können modifiziert werden. Hartkodiert in gbdevices im Model und in den Sprachdateien

Model / Fields Dokumentation[Bearbeiten]

Beispiel Array einer RMA mit untergeordneten Models für Metadevice, Device, DeviceClass, DeviceFamily

array(rma => Geobit\Gbrma\Domain\Model\Rmaprototypepersistent entity (uid=11, pid=53)
      rmaNumber => '8' (1 chars)
      rmaType => 1 (integer)
      locked => 0 (integer)
      state => 0 (integer)
      orderExpress => 0 (integer)
      additionalInformation => '' (0 chars)
      rmaUser => 1 (integer)
      crdate => 1443778492 (integer)
      tstamp => 1443783879 (integer)
      uid => 11 (integer)
      pid => 53 (integer)
      metadevice => TYPO3\CMS\Extbase\Persistence\ObjectStorageprototypeobject (2 items)
         0000000002d804830000000151a56f69 => Geobit\Gbrma\Domain\Model\Metadeviceprototypepersistent entity (uid=12, pid=53)
            uid => 12 (integer)
            pid => 53 (integer)
            serial => 'aewtqwer' (8 chars)
            description => '' (0 chars)
            jsondata => '{"none":"1"}' (12 chars)
            serviceRepair => 0 (integer)
            serviceCalibration => 0 (integer)
            serviceModification => 0 (integer)
            serviceNone => 1 (integer)
            device => Geobit\Gbdevices\Domain\Model\Deviceprototypepersistent entity (uid=3, pid=49)
               uid => 3 (integer)
               pid => 49 (integer)
               deviceTitle => '2138/01 EMD-100' (15 chars)
               deviceDescription => '' (0 chars)
               deviceType => 1 (integer)
               isBaseDevice => FALSE
               accPossible => FALSE
               repairDiscontinued => TRUE
               modification => 0 (integer)
               deviceImage => NULL
               deviceClass => Geobit\Gbdevices\Domain\Model\DeviceClassprototypepersistent entity (uid=2, pid=49)
                  classTitle => 'EMD Series' (10 chars)
                  classDescription => '' (0 chars)
                  classFamily => 0 (integer)
                  accPossible => FALSE
                  uid => 2 (integer)
                  pid => 49 (integer)
               deviceFamily => Geobit\Gbdevices\Domain\Model\DeviceFamilyprototypepersistent entity (uid=1, pid=49)
                  familyTitle => 'Safety' (6 chars)
                  familyDescription => 'NARDA Safety Product Family' (27 chars)
                  familyFegroupAccess => 2 (integer)
                  uid => 1 (integer)
                  pid => 49 (integer)
)

RMA Types[Bearbeiten]

Code Hints[Bearbeiten]

Definiert in:

  • Template: ListRmas.html
  • Template: NewFormFields.html
  • Template: Mail.html


Fehler beheben[Bearbeiten]

Scheduler Probleme[Bearbeiten]

importFile gesetzt und vorhanden?