CCS Directory Structure

Minimal/fixed directory structure

CCS Directory Structure

Model This has a unique folder name for each model
Working directory/scenario directory

Apps
Model script file and catalog information (.xml)

Inputs
All inputs (scenario specific, fixed inputs)

Outputs
Empty and used to store fixed outputs when model is run

CCS Directory Structure

CCS Export
Compile model scripts and model catalog Create one model script and a .xml file in web\apps Copy input files to web\inputs Compress web folder for upload

CCS Model Run

Each scenario run gets its own copy of the model folder All outputs are saved in the Outputs folder or the Model folder (scenario/working directory)

Scenario Specific Input files

FILEI ZONEI[1]={SCENARIO_DIR}\Zones\ZoneData.DBF results in: Warning: Scenario Specific Inputs. The Application scripts are valid, but there is currently no interface to this data in CCS.

CCS exporter does not recognize scenario specific inputs (it worries it cant find them all to export). Use file keys
e.g., FILEI ZONEI[1]={zonedata}

Fixed Input Files

FILEI statements with fixed file path
FILEI RECI = C:\Model\Parameters\MC_PAR.DBF

CCS exporter will copy these files to the Inputs folder The CCS model script will be updated as
FILEI RECI = {SCENARIO_DIR}\Inputs\MC_PAR.DBF

CCS user will not be able to update a new version or edit this file
If this is a problem, use a file key to input this file

Internal Input Files

FILE= statements for PRINT, READ, RENUMBER, LOOKUP statements. CCS Exporter can not trace this because it is not a part of Application Monitor. Non-Standard file paths will not be packaged during export Standard file paths will be blindly included.
e.g., READ FILE ="{SCENARIO_DIR}\INPUT\ACCESS.PRN

Use a user defined key for these types of files or reference these files using {CATALOG_DIR} key.
e.g., READ FILE ="{ACCESS}"

Warning. The following Internal "FILE=" entries are present in the model. They have been associated with the VOYAGER command shown below, and copied to the appropriate folder. Note that for CCS Publish, the best and safest approach is to avoid use of FILE=,and use an alternative VOYAGER construct if available; e.g. for PRINT commands, use PRINTO=.

Output File References

FILEO, PRINT FILE= and COPYENDCOPY statements
e.g., FILEO MATO[1] = "{SCENARIO_DIR}\OUTPUT\MATRIX\OUTPUT.MAT

CCS model run will output these files to the outputs (working) directory unless the file is made scenario specific. Subsequent steps reading these files internally will fail in CCS. Output all scenario specific files directly to {SCENARIO_DIR}
e.g., FILEO MATO[1] = "{SCENARIO_DIR}\OUTPUT.MAT

Output to Internal Input File

FILEO/COPY/PRINTO to READ, RENUMBER,LOOKUP (FILE=) statements
Program 1-Matrix:
FILEO PRINTO[1] = "{SCENARIO_DIR}\READ_OUT.PRN"

Program2-Matrix:
READ FILE = "{SCENARIO_DIR}\READ_OUT.PRN

CCS Exporter will show a error message

Warning: The following Internal files (defined via FILE=) could not be found, so the Applications will not run correctly

It is a good practice to directly link output files to inputs in subsequent programs rather than reading internally

File Path Keys

FILEI statements with user defined file path keys
FILEI MATI[1] = "{LOCATION}\AllWalk.MAT"

CCS exporter does not accept any keys (other than {CATALOG_DIR}) in file PATH of FILEI statements.
Error: The following files have Keys in their Path. This construct is incompatible with CCS.

Use the {CATALOG_DIR} key to refer to this file as shown below or use file keys as discussed above
FILEI MATI[1] = "{CATALOG_DIR}\Base\Input\AllWalk.MAT"

File Tokens
File references using tokens
e.g., READ FILE = "@CPI_FILE@"

CCS exporter does not give any warnings or errors CCS model script is updated to read
READ FILE = {CATALOG}\OUTPUTS\@CPI_FILE@

Use valid file paths instead of tokens

Input Files With Similar Names

CCS exporter appends a suffix (_cw#) input files with similar names. It also updates the catalog key values for these files with updated file names
e.g., {File1} = C:\Model\Base\ZoneData.dbf {File2} = C:\Model\Base\Parameters\ZoneData.dbf
Exporter will copy 2 files to the inputs folder with the names ZoneData.dbf & ZoneData_cw1.dbf and update the file key values as follows
{File1}=inputs\ZoneData.dbf {File2}=inputs\ZoneData_cw1.dbf

Built-in User Programs

e.g., TRCOPY, TRDEL

CCS exporter will show a warning

Warning: User Programs currently require some manual intervention to implement in CCS.

Built-in user programs will work without any problems in CCS (because they are simple dos commands).

User supplied user programs

e.g., any .exe files to perform special functions

All input files and output files to/from the user program should be referenced to the {SCENARIO_DIR} Update any control files/input files with file paths Execute the user programs from {SCENARIO_DIR}

User programs requiring special set-up

User programs that have to be installed or started before a run (e.g., SAS or JPPF) might require additional folder set-up and special configuration for running Citilabs will create a new CCS image to handle these special cases (e.g., CT-RAMP) according to each clients needs

System Commands
Any MS-DOS system commands
e.g., COPY, DEL etc.

CCS Exporter will show a warning message

Only copy system commands with no wildcards are currently supported by CCS for file name conversion.

It is recommended to copy the individual files using one copy command for each file as shown below.
E.g., *COPY {SCENARIO_DIR}\INPUTS\*.csv {SCENARIO_DIR} - Will not work *Copy {SCENARIO_DIR}\INPUTS\File1.csv {SCENARIO_DIR}

CCS Cluster Setup

CCS provides scalability of available cluster nodes for each model run ProcessNum/ProcessList for DistributeMultistep and DistributeIntrastep statements should be calculated within the script based on the number of cores available for that run The number of cores available for the model run is input using a scenario key. No need for cluster commands to start and close cluster nodes.
e.g., *Cluster Test 1-10 start exit

Multiple Applications Output/Input

From Application 1
FILEO MATO[3]="{SCENARIO_DIR}\OUTPUT.MAT

In Application 2
FILEI MATI[1]="{SCENARIO_DIR}\OUTPUT.MAT

Multiple applications are not recommended in CCS CCS Exporter will show a warning message
Warning: The following files require a previous Application to be run first in order to create them

Reports & Applier Groups

CCS does not currently allow uploading models with reports or more than one applier groups Uploading a model with reports will cause an error in the uploading process CCS has in-built analysis tools to do charts and maps Delete reports and applier groups before uploading

Best Practices
Use file keys for input files Use unique file names for scenario specific input files Reference all model run outputs to the {SCENARIO_DIR} Directly link output files in application manager instead of reading the file internally Always use double quotes for file paths and names Execute user programs from scenario dir

What is CCS exporter?

Built-in CUBE 6.0 tool Prepares your model for CCS Uploads the model to CCS Lists your existing CCS models (pending/active) Located at File>Export>Upload a Catalog

Register/Log-in
Requires a CCS account to access the functions of exporter Same user name/password as www.planthecity.com

Exporter

Export/Upload

Models

Errors, Warnings & Logs

Status

Exporting
SM and AM should be open Check the catalog name Export
Compiles model scripts Build CCS script Build catalog information (.xml) Copy inputs Compress upload folder

Creates web and web.zip file Lists errors and warnings from the export process

Handling Errors and Warnings

Errors Critical issues which have to be addressed before uploading the model Warnings Possible issues to be reviewed by the user Details
Error or Warning Description Number of instances
Location of each instance

Uploading
Title Name of the model in CCS Description A brief description of the model. This description will be listed in www.planthecity.com Check upload log to confirm model upload

Whats Next?
Model will be listed as Pending on www.planthecity.com Review and Approve Assign admin privileges to the user Invite user to edit/run model