Active Promotion JumpStart Guide
This guide is designed to get you a basic promotion setup that is useful without going through the different parts of the documentation. At the end of this walk through you will find links to relevant topics for each step, should you wish to customize the setup.
Prerequisites
- The URL to the source and target systems.
- Credentials and permissions to create Remote System objects and Process Definitions in both systems; for cloud environments, technical user credentials are required.
Conventions
In this JumpStart scenario, promotion is performed from the development environment to the test environment (cloud environments).
- Source system:
https://dublin.runmyjobs.cloud/jumpstart/dev
- Target system:
https://dublin.runmyjobs.cloud/jumpstart/test
In on-premises environments with an example URL of https://server1.example.com/redwood
, the name of the Source remote System would be redwood
.
Process Flow
- Create Destination Remote System in Development Environment.
- Create Source Remote System in Test Environment.
- Promote to Test Environment.
- Create a Promotion Workflow with Review.
- Enable Lockdown.
Create Destination Remote System in Development Environment
- In the development environment, navigate to Promotion > Remote Systems.
- Choose New Remote System from the context-menu. Fill
jumpstart_test
into the Name field, selectDestination
in the Type field, enter the URL to the system, fill in the username and password. - Choose Save & Close.
Create Source Remote System in Test Environment
- In the test environment, navigate to Promotion > Remote Systems.
- Choose New Remote System from the context-menu. Fill
jumpstart_dev
into the Name field (URL wasjumpstart/dev
, for the name we replace/
with_
), selectSource
in the Type field. - Choose Save & Close.
Promote to Test Environment
- In the development environment, navigate to Processes > Definitions to create a dummy definition to promote.
- Choose New Process Definition from the context-menu, select RedwoodScript and choose Next, fill
A_JumpStart_Definition
in the Name field, and{}
in the Source field. - Choose Save & Close
- Choose Promote > Promote to System from the context-menu of A_JumpStart_Definition and select jumpstart_test as Remote System.
Create a Promotion Workflow with Review
- In the test environment, navigate to Promotion > Remote Systems.
- Rename the jumpstart_dev Remote System to jumpstart_old and create a new Remote System of type source named
*
; this is a catch all Remote System, it will be used for any incoming promotion requests for which no Remote System exists. - Select System_Import_Archive_WithApproval in the Push Acceptor Process Definition field.
- Choose Save & Close.
- In the development environment, navigate to Processes > Definitions.
- Choose Promote > Promote to System from the context-menu of A_JumpStart_Definition and select jumpstart_test as Remote System.
- In the test environment, navigate to Monitoring > Operator Messages.
- Locate the operator message Should the car file that is attached to this chain definition be imported into this system?, choose 1234 - Raise an operator message in the Send Object column (the id of the process
1234
will differ for each import). - A new tab will open with a process of definition System_OperatorMessage, choose Show in diagram from the context-menu, a new tab is opened with diagram of the chain. On the chain process, left-most box, choose Files (Open folder icon) and choose the
carin.car
file. You can open this file with any program that can open ZIP files and inspect its contents. - On the Operator Messages tab, choose Reply in the context-menu of the operator message in question, decide if you want to import the CAR file by choosing the corresponding reply, default reply is No (do not import the CAR file).
Enable Lockdown
- In the test environment, navigate to Processes > Definitions.
- Select Submit from the context-menu of System_Import_Settings, select Yes in the Lockdown parameter and submit the definition.
- Navigate to Promotion > Remote Systems, rename the Remote System * to *invalid.
- In the development environment, navigate to Processes > Definitions.
- Choose Promote > Promote to System from the context-menu of A_JumpStart_Definition and select jumpstart_test as Remote System.
- Choose Monitor related processes from the context-menu of System_Promote, note that the last execution reached Completed
- In the test environment, navigate to Monitoring > Processes, select Custom Maintenance (Background) Processes.
- The Import definitions from: System_12345_1234567.car process has reached Error (the numbers in the file name are generated). Inspect the process'
stderr.log
file, notice the exceptionjava.lang.RuntimeException: Lockdown is enabled
. - Navigate to Promotion > Remote Systems.
- Rename the jumpstart_old Remote System to jumpstart_dev.
- Perform steps 4. to 7. once more, notice that this time, the Import process reaches Completed.
- Navigate to Promotion > Remote Systems, rename the Remote System *invalid back to * if you want to allow promotion requests from other systems.
- Note that the person must have credentials with all required permissions to create the objects that are to be imported.
Further Reading
- Migrating Objects with the Promotion Module
- Creating Export Rule Sets
- Export Rule Sets
- Exporting Redwood Server Objects
- Importing Objects
- Using Import Rule Sets to Customize Imports
- Importing Objects with Import Rule Sets
- Importing Redwood Server Objects with Imports
- Promotion Reaction Processes
- Creating Remote Systems