Preface: Utilizing CA Certificates is the best practice for Anaplan Data Integrations. The wake-up script is best leveraged with CA Certificate authentication in the individual scripts for security purposes. If you would like to learn more about CA Certificates, click on this guide. Note: Basic Authentication used for demo purposes.
Additionally, the wake-up script is not intended to be run 24x7x365, only during business workdays. The script should only be run to open the model for the first time. It is recommended that the script be run at most once per working day. It is important that the model goes to "sleep" when not in use to do garbage collection.
Imagine this scenario: You have a new Anaplan ecosystem as part of your organization. When you come in the morning to log into your Anaplan App or Model, you are met with a loading screen. This loading screen often takes 10 plus minutes.
Solution: Create a wake-up script! With the power of Anaplan Connect, you can automate your model to “wake up” before you arrive to log in for the day. This can save you time every morning you spend waiting for your large model to open.
Here's how: Creating a wake-up script is a simple process!
- In your Anaplan model, create a process under the Actions menu.
- Rename the process to “Wake Up Model”.
- Do not add any actions to the process; this will be a blank “dummy” process. (For an alternative method see the Appendix).
It should look something like this:
Your Anaplan model is now ready to leverage Anaplan Connect!
Next, you should:
- Download Anaplan Connect onto your local machine or server environment.
- Create your Wake Up Model script.
- Save your script in your Anaplan Connect folder.
- A scheduler will be needed to run this action on a consistent basis.
Example Script:
set Certificate="your Certificate Path"
set PrivateKey="yourprivatekeypath:"
set WorkspaceId="YourWorkspaceID"
set ModelId="YourModelID"
set ServiceUrl="https://api.anaplan.com"
set AuthUrl="https://auth.anaplan.com"
set ProcessName="Wake Up Model"
set Chunksize=1
set Operation= -debug -service %ServiceUrl% -auth %AuthUrl% -process %ProcessName% -execute
set Credentials=-certificate %Certificate% -pkey %PrivateKey%
rem *** End of settings - Do not edit below this line ***
setlocal enableextensions enabledelayedexpansion || exit /b 1
cd %~dp0
set Command=.\AnaplanClient.bat %Credentials% -workspace %WorkspaceId% -model %ModelId% %Operation%
@echo %Command%
cmd /c %Command%
pause
Your end result should look something like this when you run the script:
Use cases:
- Any large Anaplan model that takes a long time to open or load the first time during the day.
- Help your data integrations load faster by opening the model and getting it ready to receive data.
Things to consider:
- If your model is taking a long time due to performance or long nested formulas/calculations, consider addressing those first.
- Think of it like starting your car in the cold; it usually is a good idea to warm up your car before you go out and drive it.
- If your car takes too long to warm up, there may be another underlying issue that needs to be looked at by a mechanic.
Appendix
An alternative method to the wake-up script method is by utilizing the "-P" operator instead of creating a blank dummy process. The "-P" method will return a list of processes available in the model upon execution. In doing so, the model will wake up. In this method, you are not required to do any additional setup in the model, there is no requirement to create a blank process. There is also no requirement to include a process in your script. Simply running the script with the "-P" operator instead of "-process" will achieve a similar result as the wake-up script, with a slightly different output.
Example Script:
set Certificate="your Certificate Path"
set PrivateKey="yourprivatekeypath:"
set WorkspaceId="YourWorkspaceID"
set ModelId="YourModelID"
set ServiceUrl="https://api.anaplan.com"
set AuthUrl="https://auth.anaplan.com"
set Chunksize=1
set Operation= -debug -service %ServiceUrl% -auth %AuthUrl% -P -execute
set Credentials=-certificate %Certificate% -pkey %PrivateKey%
rem *** End of settings - Do not edit below this line ***
setlocal enableextensions enabledelayedexpansion || exit /b 1
cd %~dp0
set Command=.\AnaplanClient.bat %Credentials% -workspace %WorkspaceId% -model %ModelId% %Operation%
@echo %Command%
cmd /c %Command%
pause
