Modules

todo

SCP enables you to customize nearly everything which forms the platform as it is – this requires an extensive and flexible configuration which is not easy to handle right from the beginning.

Most features require you to configure different things in parallel keeping in mind that they have to work together which makes it even harder to get started with SCP.

Modules will help you by combining configuration sets by just a single line of configuration. They are fully managed by the system and easy to use but don't offer the flexibility a traditional configuration would bring to you.

WARNING

SCP transforms configuration in-memory before your own configuration will be loaded – please ensure to not set up contrary rules as this might break your configuration.

Enabling Modules

Place the configuration file config/modules.php to your client config repository.

<?php

// CLIENT_CONFIG/config/modules.php

return [
    // add the name of the module and return
    // necessary configuration data
    'set_date_on_status' => [],
];

Every item inside the modules array will be loaded by SCP.

Module List

todo

• Content Builders
  • AE Builder
  • AC Builder
  • PPTX Builder
• Veeva Vault Fields
• Set Live Date
• Approver E-Mail
• Aprimo Content Service
• Material Expiry
• Scope By Country

Set Date on Status Change

Module Name: set_date_on_status

If you want SCP to update a date field to the current date when the Material has been moved to a given Status, use this Module.

Configuration

status

Set the name of the status where the Action will be listen on.

date_field

The name of the Field where the date should be stored in. If the Field is not already configured, the Module will create a predefined field for you with the given name.

Enable Standard Transitions

Module Name: enable_standard_transitions

By default SCP offers default configuration for fields and some additional parts but no transitions. If you want to enable best-practice standard Transitions you can easily use the module.

Configuration

The module offers no configuration.

Setting Field Values with External References

Module Name: update_fields_with_external_reference_data

If you want to set a specific field based on data stored inside an external reference, you can use this module instead of writing your own Action.

The underlying action will run every time the reference get updated.

Configuration

reference_keys

An array of reference keys this module should work on.

update_map

A key/value array setting the target dot-notated path to the external reference data object and the value reference the field name where the action should store the value

Example

<?php

// CLIENT_CONFIG/config/modules.php

return [
    'update_fields_with_external_reference_data' => [
        'reference_keys' => [
            'vault_mlr',
            'medvault_mlr'
        ],
        'update_map' => [
            'document.document_number__v' => 'zinc_code', // will push the data to the field zinc_code
        ]
    ]
];