ADD-ON VERSION 200
The hereby described customizing transaction enables parallel usage of three storage type solutions - GOS, BDS and DMS. Starting from FSM Cloud Connector Add-On version 200, the entire attachment configuration should be maintained here. DMS- and BDS-specific transactions (folder DMS/ArchiveLink (obsolete)) should no longer be used, as well as attachment-related fields in company configuration transactions (/PACG/ECM_COMP - Company definition, /PACG/ECM_CPROP - General Properties of FSM Cloud Connector).
Required actions to perform before usage:
Class assignment update
Redesigned attachment handling is implemented in new idoc classes which should be adjusted in transactions /PACG/ECM_CLSASSIG - FSM Connector's Outgoing Messages Configuration and /PACG/ECM_CLSASSIGIN - FSM Connector's Incoming Messages Configuration.
Transaction | Message type | Field name | Idoc class |
---|---|---|---|
/PACG/ECM_CLSASSIG | /PACG/ECM_ATTCHMOUT | IDOC Class | /PACG/ECM_CL_S_IDOC_O_ATTCHM2 |
/PACG/ECM_CLSASSIGIN | /PACG/ECM_ATTCHMIN | Inb. Data Creat. | /PACG/ECM_CL_S_IDOC_I_ATTCHM2 |
/PACG/ECM_CLSASSIGIN | /PACG/ECM_SIGNATURE | Inb. Data Creat. | /PACG/ECM_CL_S_IDOC_I_ATTCHM2 |
Table of contents
General overview
Collective attachment configuration has been designed to enable parallel usage of all three storage type solutions (GOS, BDS or DMS), depending on company, related ERP object type or file type.
Additional attachment enhancements
Along with introduction of the combined configuration transaction, additional attachment-related features have been added to FSM Cloud Connector, including:
Automatic transfer of GOS and BDS attachments to SAP FSM after creating them in SAP ECC/S4. Automatic transfer of DMS attachments to SAP FSM after checking in and saving in SAP ECC/S4.
Reconstruction of DMS attachment keys. Learn more: Migration of DMS attachments (due to key change).
A BAdI for adding UDFs to attachments (/PACG/ECM_UDF_IN_ATTM, called in method /PACG/ECM_IF_A_ATTACHMENTS~RECEIVE_SAVE of class /PACG/ECM_CL_A_ATTACHMENTS).
Correspondence to obsolete transactions
Obsolete transaction | New attachment configuration |
---|---|
SAP standard transactions OAC2 and OAC3 available as links in folder SAP standard attachment configuration | |
DMS configuration (default or company-dependent) | |
No direct correspondence. Certain attachments can be restricted from transfer to SAP FSM based on object type and/or file type in Outbound configuration | |
/PACG/ECM_CDMS - Set folder path to store inbound attachments for DMS | Field ‘Folder path’ in DMS configuration |
📁 SAP standard attachment configuration
Use these links to navigate to SAP standard attachment configurations - OAC2, OAC3 and DC10. These system configurations should be maintained for proper processing of DMS and BDS attachments.
🔗 OAC2 - SAP ArchiveLink: Global doc. types
Maintain global document types for BDS attachments.
🔗 OAC3 - SAP ArchiveLink: Links
Link object types with document types and content repository ID for BDS attachments.
🔗 DC10 - Define document types
Define document types and object links for DMS attachments.
📁 Default configuration
Maintain a set of default (global) attachment configurations. This data will be used if no company-dependent configuration is found (see folder Company dependent configuration).
📁 Company Dependent configuration
The set of configuration transactions (General attachment configuration, Inbound configuration, Outbound configuration and DMS configuration) can be maintained on company level. If a company-dependent configuration is found, it will be used instead of the global default (configurations in folder Default configuration).
🕑 General Attachment configuration
Customize general attachment settings, such as maximal allowed attachment size, default storage type for inbound attachments or if inbound/outbound attachment transfer should be blocked.
Max. attachment size | Enter the maximal allowed attachment size for outbound attachments. If no value is entered, the value of 5242880 bytes will be used. Attachment size should be also adjusted in SAP FSM company settings - ‘CompanySettings.MaxAttachmentSize’. |
---|---|
Allow attachment deletion | Allow deletion of attachments from SAP FSM after deleting related GOS attachments from SAP ECC/S4. |
Storage type | Storage type for inbound attachments. Available storage types are:
|
Block IN | Block (do not save) inbound attachments. |
Block OUT | Block (do not transfer) outbound attachments. |
Link SAP SO Atta | Activities can inherit attachments from the related service orders. When an attachment is created for a service order and this field is checked, attachment reference will be created for the related activities in SAP ECC/S4. Such activity attachments will be automatically transferred to SAP FSM, if not blocked by the outbound configuration (e.g. setting ‘block out’ in the General configuration). |
Link SAP Notif Atta | Activities can inherit attachments from the related notifications. When an attachment is created for a notification and this field is checked, attachment reference will be created for the related activities in SAP ECC/S4. Such activity attachments will be automatically transferred to SAP FSM, if not blocked by the outbound configuration (e.g. setting ‘block out’ in the General configuration). |
Company-dependent general attachment configuration
If General attachment configuration is maintained for a specific company, it will be used instead of the default.
Overwrite rules for storage type configuration
The storage type maintained in the default (global) General Attachment configuration has the least priority and will be used only if none of the below is maintained for a given company/object/file type pattern.
- The storage type set in the default General Attachment configuration will be overwritten by Company-dependent inbound configuration (object- or file type-specific).
If not found…
- It will be overwritten by General inbound configuration (object- or file type-specific).
If nout found…
- It will be overwritten by Company-dependent General attachment configuration.
🕑 Inbound configuration
Certain object types and file types can be stored differently. Customize default storage types for specific ERP objects (e.g. SERVICECALL) and/or file types (e.g. PDF).
If an inbound attachment matches the entered patterns (ERP object ID and/or file type), it will be stored as defined in ‘Inbound configuration’. If no ERP object ID is entered, an entry will be relevant for all objects of a given file type (similarly, if only file type is entered, it will be relevant for all ERP objects).
Notice that one field functions different than the field with the same name placed in the General attachment configuration (see the table below).
Link SAP SO Atta | If a service call attachment is received from SAP FSM and this field is set, attachment reference will be added to the related activities and the new activity attachment will be transferred to SAP FSM. Keep in mind that this setting can be effected by the General/Inbound attachment configuration for SERVICECALL objects. If an attachment is relevant for saving for SERVICECALL objects, the attachment reference will be created for the related activities as well, regardless of the customizing for ACTIVITY objects. Similarly, if an attachment is not relevant for saving for SERVICECALL objects, the attachment reference will not be created for activites. |
---|
Company-dependent inbound configuration
Company-dependent inbound configuration has priority over the default Inbound Configuration and will be searched for first. Only if no matching pattern is found, other configurations will be searched.
Storage type priority rules
As stated before in this document, storage type determination for inbound attachments follows certain priority rules.
- 1. Storage type for inbound attachments is always first searched for in the company-dependent Inbound configuration - based on company ID and ERP object ID and/or file type.
- 2. If the attachment’s company, object type and file type won’t match any pattern found in the configuration, customizing will be searched for in the default Inbound configuration - based on ERP object ID and/or file type.
- 3. If no relevant entry is found, it will be searched for in the company-dependent General attachment configuration - based on company ID.
- 4. If not found, a storage type would be taken from the default General attachment configuration.
An example of inbound configuration - different effect depending on a company, object or file type
The following configuration is maintained:
📁 Default configuration
🕒 General attachment configuration
Max Att size | Allow atta deletion | Storage type | Block in | Block out | Link SAP SO Atta | Link SAP Notif Atta |
---|---|---|---|---|---|---|
52428800 | x | G |
🕒 Inbound configuration
ERP Object ID | File Type | Storage type | Link SAP SO Atta | Link SAP Notif Atta |
---|---|---|---|---|
ACTIVITY | G |
📁 Company-dependent configuration
🕒 0001 - General attachment configuration
Max Att size | Allow atta deletion | Storage type | Block in | Block out | Link SAP SO Atta | Link SAP Notif Atta |
---|---|---|---|---|---|---|
52428800 | x | B |
🕒 Inbound configuration
ERP Object ID | File Type | Storage type | Link SAP SO Atta | Link SAP Notif Atta |
---|---|---|---|---|
SERVICECALL | B | |||
SERVICECALL | D | |||
EQUIPMENT | D |
🕒 DMS configuration
DMS configuration for company 1 | |||||
---|---|---|---|---|---|
ERP object ID | Document Type | Document status | Cumulated | DefStorageCat DMS | Folder path |
ZPK | MU | DMS_C1_ST | /tmp/ | ||
SERVICE CALL | ZXK | MS | DMS_C1_ST | /tmp/ |
Service call attachments created in FSM company 1
According to the inbound configuration for company 1 (which is used first):
Service call attachments of file type other than PDF will be stored as BDS attachments.
Service call attachments of file type PDF, will be stored as DMS attachments.
According to the DMS configuration for company 1:
Service call attachments stored as DMS will use document type ‘ZXK’, status ‘MS’ and default storage category ‘DMS_C1_ST’.
Equipment attachments created in FSM company 1
According to the inbound configuration for company 1:
Equipment attachments will be stored as DMS attachments, regardless of their file type.
According to the DMS configuration for company 1:
Equipment attachments stored as DMS will use document type ‘ZPK’, status ‘MU’ and default storage category ‘DMS_C1_ST’ (this setting is relevant for all objects other than service calls).
Activity attachments created in FSM company 1
Since no company-specific inbound configuration is maintained for Activities, the Default inbound configuration is used:
Activity attachments will be stored as GOS.
Item attachments created in FSM company 1
Since no company-specific and default inbound configuration is maintained for object ‘ITEM’, the General attachment configuration for company 1 will be used:
Item attachments will be stored as BDS.
Item attachments created in FSM company 2
Since no company 2-specific and default inbound configuration is maintained for object ‘ITEM’, and the General attachment configuration is only maintained for company 1, the default General attachment configuration will be used:
Item attachments will be stored as GOS.
🕑 Outbound configuration
Specify which ERP objects and/or file types should be restricted from transfer to SAP FSM. E.g., do not transfer activity attachments to SAP FSM if their file type is ‘PDF’.
If no ERP object ID is entered, an entry will be relevant for all objects of a given file type. If no file type is entered, an entry will be relevant for all objects with a given ERP object ID.
Company-dependent outbound configuration
A blocklist can also be maintained for specific companies.
If company-dependent configuration is maintained, keep the default Outbound configuration empty, otherwise it will add up to the company-dependent blocklist as shown in example 4.
Example 1
Outbound configuration for company 1 | |
---|---|
ERP Object ID | File Type |
EQUIPMENT |
PDF files attached to equipment will not be transferred to FSM company 1.
Example 2
Outbound configuration for company 1 | |
---|---|
ERP Object ID | File Type |
EQUIPMENT |
No equipment attachment will be transferred to FSM company 1.
Example 3
Outbound configuration for company 1 | |
---|---|
ERP Object ID | File Type |
No PDF attachment will be transferred to FSM company 1.
Example 4
Default outbound configuration | |
---|---|
ERP Object ID | File Type |
EQUIPMENT |
PDF files attached to equipment will not be transferred to any FSM company, regardless of company-dependent outbound configuration.
🕑 DSM configuration
Make sure to run the following report, if DMS storage type is planned to be used: Migration of DMS attachments (due to key change)
This node will appear, if the storage type is set to ‘D’ (DMS) in General attachment configuration or Inbound configuration. Make sure to customize which document type, document status and storage category should be assigned to inbound attachments. It can be done based on the related object’s cloud message type. If no ERP object ID is entered, an entry will be relevant for all objects (unless the attachment matches another, more specific pattern).
ERP object ID | Object to which a file is attached to. |
---|---|
Document type | DMS document type to be used. |
Document status | Status to be set for the document. |
Cumulated | It controls if for every new attachment a new DMS document should be created, otherwise attachments are added to the existing one. DMS creates its own documents to which attachments are added and then these documents are linked with other documents in the system and not attachments themselves |
Default storage category DMS | Storage category links logical storage location with physical one. |
Folder path | Specify path for document storage. |
Company-dependent DMS configuration
DMS configuration can be maintained for a specific company. If such an entry is found, it will be used instead of the default.
🕑 Cloud Message to DMS object configuration
Inbound configuration - process example
DMS
According to the company-dependent Inbound configuration below, all service call attachments from company 1 will be saved as DMS attachments.
The DMS configuration is set as follows:
Add an attachment of any file type for a service call in SAP FSM.
An inbound idoc of type /PACG/ECM_ITYPE_ATTCHM_IN should be generated.
Navigate to transaction CV03N. Enter the document number and type. The document number may be filled automatically, if not, it can be found in the idoc’s log.
Notice that the document type, status and storage category correspond to the maintained configuration.
The service call for which the attachment was created can be found under the ‘Object links’ tab.
GOS
According to the company-dependent General attachment configuration below, all inbound attachments from company 1 will be stored as GOS attachments.
The company-dependent general attachment configuration will not be overwirtten by object- or file type-specific inbound configuration in this case.
Create an attachment for a service call in SAP FSM.
An inbound idoc of type /PACG/ECM_ITYPE_ATTCHM_IN should be generated.
Navigate to the corresponding service order’s attachment list in transaction IW33.
Notice that the attachment can be found in SAP as a GOS attachment.
Outbound configuration - process example
BDS
According to the default outbound configuration below, PDF files attached to service call objects will not be transferred to SAP FSM.
Create a BDS attachment for a service order.
The attachment should be of type PDF.
Save the attachment and service order. Notice that no outbound attachment idoc is generated.
Technical overview
Sending process
General process
BAdI diagram
Receiving process
BAdI diagram
DMS key
New DMS key structure is as seen below. It provides unique key for each file from DMS document. This key is built based on SAP data element: /PACG/ECM_DMS_KEY